Changes

__TOC__

__TOC__

==Content pack format==

==Content pack format==

A content pack is a folder containing a <tt>manifest.json</tt> file which specifies your mod in its <tt>ContentPackFor</tt> field (see [[../Manifest|manifest]]). The format beyond that is up to you to define. For example, {{nexus mod|1915|Content Patcher}} requires a <tt>content.json</tt> file, but that's not validated by SMAPI itself. Instead, SMAPI provides an API you can use to read any other file you need from the content pack.

A content pack is a folder containing a <samp>manifest.json</samp> file which specifies your mod in its <samp>ContentPackFor</samp> field (see [[../Manifest|manifest]]). The format beyond that is up to you to define. For example, {{nexus mod|1915|Content Patcher}} requires a <samp>content.json</samp> file, but that's not validated by SMAPI itself. Instead, SMAPI provides an API you can use to read any other file you need from the content pack.

See [[Modding:Content packs]] for more info about content packs.

See [[Modding:Content packs]] for more info about content packs.

==Content pack API==

==Content pack API==

===Get owned content packs===

===Get owned content packs===

To get the content packs installed for your mod (including a <tt>Manifest</tt> field with the content pack's [[Modding:Modder Guide/APIs/Manifest|full manifest info]]):

To get the content packs installed for your mod (including a <samp>Manifest</samp> field with the content pack's [[Modding:Modder Guide/APIs/Manifest|full manifest info]]):

<syntaxhighlight lang="c#">

<syntaxhighlight lang="c#">

foreach(IContentPack contentPack in this.Helper.ContentPacks.GetOwned())

foreach(IContentPack contentPack in this.Helper.ContentPacks.GetOwned())

===Check if a file exists===

===Check if a file exists===

You can check if a file exists in the content pack folder using <tt>HasFile</tt>. You can specify a relative path like <tt>data/content.json</tt>.

You can check if a file exists in the content pack folder using <samp>HasFile</samp>. You can specify a relative path like <samp>data/content.json</samp>.

<syntaxhighlight lang="c#">

<syntaxhighlight lang="c#">

===Read a JSON file===

===Read a JSON file===

You can read a JSON file from a content pack folder into [[Modding:Modder Guide/APIs/Data#Data model|a data model]] (<tt>YourDataModel</tt> in the example below) using <tt>ReadJsonFile</tt>. You can specify a relative path like <tt>data/content.json</tt>. This will return <tt>null</tt> if the file doesn't exist.

You can read a JSON file from a content pack folder into [[Modding:Modder Guide/APIs/Data#Data model|a data model]] (<samp>YourDataModel</samp> in the example below) using <samp>ReadJsonFile</samp>. You can specify a relative path like <samp>data/content.json</samp>. This will return <samp>null</samp> if the file doesn't exist.

<syntaxhighlight lang="c#">

<syntaxhighlight lang="c#">

===Write a JSON file===

===Write a JSON file===

You can write a JSON file in a content pack folder using <tt>WriteJsonFile</tt>, using a [[Modding:Modder Guide/APIs/Data#Data model|data model]] (<tt>YourDataModel</tt> in the example below). You can specify a relative path like <tt>data/content.json</tt> (subdirectories will be created automatically if needed). This will create the file if it doesn't exist, or overwrite it if it does.

You can write a JSON file in a content pack folder using <samp>WriteJsonFile</samp>, using a [[Modding:Modder Guide/APIs/Data#Data model|data model]] (<samp>YourDataModel</samp> in the example below). You can specify a relative path like <samp>data/content.json</samp> (subdirectories will be created automatically if needed). This will create the file if it doesn't exist, or overwrite it if it does.

'''Note:''' this is best used for generated files. Overwriting the original files isn't recommended, since a bug in your mod which changes an original file might permanently break the content pack and require the player to reinstall it.

'''Note:''' this is best used for generated files. Overwriting the original files isn't recommended, since a bug in your mod which changes an original file might permanently break the content pack and require the player to reinstall it.

===Read content asset===

===Read content asset===

You can read [[Modding:Modder Guide/APIs/Content|a content asset]] from the content pack folder using <tt>LoadAsset</tt>. You can optionally specify a relative path to read from a subfolder.

You can read [[Modding:Modder Guide/APIs/Content|a content asset]] from the content pack folder using <samp>LoadAsset</samp>. You can optionally specify a relative path to read from a subfolder.

<syntaxhighlight lang="c#">

<syntaxhighlight lang="c#">

Texture2D image = contentPack.LoadAsset<Texture2D>("image.png");

Texture2D image = contentPack.LoadAsset<Texture2D>("image.png");

</syntaxhighlight>

</syntaxhighlight>

If you need to pass an asset name to game code, you can use the <tt>GetActualAssetKey</tt> method:

If you need to pass an asset name to game code, you can use the <samp>GetActualAssetKey</samp> method:

<syntaxhighlight lang="c#">

<syntaxhighlight lang="c#">

tilesheet.ImageSource = contentPack.GetActualAssetKey("image.png");

tilesheet.ImageSource = contentPack.GetActualAssetKey("image.png");

===Get translations===

===Get translations===

You can read translations from the content pack's <tt>i18n</tt> folder. This is identical to the [[Modding:Modder Guide/APIs/Translation|translation API]], but accessed through <tt>contentPack.Translations</tt>:

You can read translations from the content pack's <samp>i18n</samp> folder. This is identical to the [[Modding:Modder Guide/APIs/Translation|translation API]], but accessed through <samp>contentPack.Translations</samp>:

<syntaxhighlight lang="c#">

<syntaxhighlight lang="c#">

string text = contentPack.Translation.Get("item-type.label");

string text = contentPack.Translation.Get("item-type.label");