106,033
edits
Changes
no edit summary
Adding new NPCs involves editing a number of files:
Adding new NPCs involves editing a number of files:
* New file: Characters\Dialogue\<name>
* New file: [[Modding:Dialogue|Characters\Dialogue\<name>.json]] (See also [[Modding:Event data]])
* New file: Characters\schedules\<name>
* New file: [[Modding:Schedule data|Characters\schedules\<name>.json]] (Note that the "s" in the "schedules" folder is lowercase!)
* New file: Portraits\<name>
* New file: [[Modding:NPC data#Portraits|Portraits\<name>.png]]
* New file: Characters\<name>
* New file: [[Modding:NPC data#Overworld sprites|Characters\<name>.png]]
* Add entries Data\EngagementDialogue for NPCs that are marriable
* Add entries [[Modding:Dialogue#Engagement dialogue|Data\EngagementDialogue]] for NPCs that are marriable
* Add entry to Data\NPCDispositions
* Add entry to [[Modding:NPC data#Basic info|Data\NPCDispositions]]
* Add entry to Data\NPCGiftTastes
* Add entry to [[Modding:Gift taste data|Data\NPCGiftTastes]]
* Add entries to Characters\Dialogue\rainy
* Add entries to [[Modding:Dialogue#Rain dialogue|Characters\Dialogue\rainy]]
* Add entries to Data\animationDescriptions (if you want custom animations in their schedule)
* Add entries to [[Modding:Schedule data#Schedule points|Data\animationDescriptions]] (if you want custom animations in their schedule)
All of the above can be done with IAssetLoaders/IAssetEditors or Content Patcher. Finally, spawn the NPC with a SMAPI mod. The different constructors are:
All of the above can be done with an AssetRequested event or Content Patcher. If you did all of this correctly, the game will spawn the NPC in for you. (If you didn't, it swallows the error)
==User-interface (UI)==
==User-interface (UI)==
Types available:
Types available:
#Achievement (HUDMessage.achievement_type)
#New Quest (HUDMessage.newQuest_type)
#Error (HUDMessage.error_type)
#Stamina (HUDMessage.stamina_type)
#Health (HUDMessage.health_type)
===DialogueBox===
===DialogueBox===
[[File:DialogueBox_NoChoices_Example.jpg|200px|thumb|right|Example of DialogueBox without choices.]]A '''DialogueBox''' is a text box with a slightly larger, slightly boldfaced text, with "typewriter-like" effect.
[[File:DialogueBox NoChoices Example.jpg|200px|thumb|right|Example of DialogueBox without choices.]]A '''DialogueBox''' is a text box with a slightly larger, slightly boldfaced text, with "typewriter-like" effect.
There are several variants, including ones with a dialogue/conversation choices.
There are several variants, including ones with a dialogue/conversation choices.
namespace MyMod
namespace MyMod
{
{
internal sealed class ModEntry: Mod
{
{
public MyModMail()
public override void Entry(IModHelper helper)
{
{
helper.Events.Content.AssetRequested += this.OnAssetRequested;
}
}
private void OnAssetRequested(object? sender, AssetRequestedEventArgs e)
{
{
if (e.NameWithoutLocale.IsEquivalentTo("Data/mail"))
{
e.Edit(this.EditImpl);
}
}
}
public void Edit<T>(IAssetData asset)
public void EditImpl(IAssetData asset)
{
{
var data = asset.AsDictionary<string, string>().Data;
var data = asset.AsDictionary<string, string>().Data;
===Send a letter (using static content)===
===Send a letter (using static content)===
Now that you have your letter loaded, it's time to send it to the player. There are a couple different methods available to accomplish this as well, depending on your need. Two examples are shown below. The distinction between the two methods will be explained below:
Now that you have your letter loaded, it's time to send it to the player. There are a couple different methods available to accomplish this as well, depending on your need. Two examples are shown below. The distinction between the two methods will be explained below:
namespace MyMail
namespace MyMail
{
{
internal sealed class ModEntry: Mod
{
{
// This collection holds any letters loaded after the initial load or last cache refresh
// This collection holds any letters loaded after the initial load or last cache refresh
private Dictionary<string, string> dynamicMail = new Dictionary<string, string>();
private Dictionary<string, string> dynamicMail = new();
public MailData()
public override void Entry(IModHelper helper)
{
{
helper.Events.Content.AssetRequested += this.OnAssetRequested;
}
}
private void OnAssetRequested(object? sender, AssetRequestedEventArgs e)
{
{
if (e.NameWithoutLocale.IsEquivalentTo("Data/mail"))
e.Edit(this.EditImpl);
}
}
public void Edit<T>(IAssetData asset)
public void EditImpl(IAssetData asset)
{
{
var data = asset.AsDictionary<string, string>().Data;
var data = asset.AsDictionary<string, string>().Data;
if (!string.IsNullOrEmpty(mailId))
if (!string.IsNullOrEmpty(mailId))
{
{
dynamicMail[mailId] = mailText;
}
}
}
}
You will notice that there is really very little difference in the code used for static mail and dynamic mail. The class that supports dynamic mail has a private dictionary collection for holding on to any mail content waiting to be injected. It could have been made public to allow mail to be added directly into the collection, but that is not good practice. Instead a public Add method was provided so that mail could be sent, so to speak, to the collection. This code is for a specific MOD, not a robust framework, so it isn't overly concerned with error handling. You can improve that based on your needs.
You will notice that there is really very little difference in the code used for static mail and dynamic mail. The class that supports dynamic mail has a private dictionary collection for holding on to any mail content waiting to be injected. It could have been made public to allow mail to be added directly into the collection, but that is not good practice. Instead a public Add method was provided so that mail could be sent, so to speak, to the collection. This code is for a specific MOD, not a robust framework, so it isn't overly concerned with error handling. You can improve that based on your needs.
Notice the additional code in the Edit method, where any mail in the dynamicMail collection is injected into Stardew Valley's content. There will be no mail in the dynamicMail collection when the MOD is loaded (in this case) the first time. If you add mail after the original load, then the content will have to be reloaded by invalidating the cache. Refer to [[Modding:Modder_Guide/APIs/Content#Cache invalidation|Cache invalidation]] for more details.
Notice the additional code in the Edit method, where any mail in the dynamicMail collection is injected into Stardew Valley's content. There will be no mail in the dynamicMail collection when the MOD is loaded (in this case) the first time. If you add mail after the original load, then the content will have to be reloaded by invalidating the cache. Refer to [[Modding:Modder Guide/APIs/Content#Cache invalidation|Cache invalidation]] for more details.
===Send a letter (using dynamic content)===
===Send a letter (using dynamic content)===
You can hook into other events, such as "Day Starting" or "Day Ending" to generate the letter you want to send. Consider this simple example, that is only for illustration purposes.
You can hook into other events, such as "Day Starting" or "Day Ending" to generate the letter you want to send. Consider this simple example, that is only for illustration purposes.
Game1.mailbox.Add("MyModMailWool"); // Add to mailbox and we don't need to track it
Game1.mailbox.Add("MyModMailWool"); // Add to mailbox and we don't need to track it
this.Helper.GameContent.InvalidateCache("Data\\mail"); // note that as of SMAPI 3.14.0, this only invalidates the English version of the asset.
}
}
</syntaxhighlight>
</syntaxhighlight>