Modding:Modder Guide/APIs/Translation - Revision history

imported>Margotbean: ru link

2026-01-07T18:55:34Z

ru link

← Older revision		Revision as of 18:55, 7 January 2026
Line 127:		Line 127:
	[https://gist.github.com/Pathoschild/4e0af42158583983a4206d4d734bfc0b LINQ script] to format an event for translations		[https://gist.github.com/Pathoschild/4e0af42158583983a4206d4d734bfc0b LINQ script] to format an event for translations

	[[ru:Модификации:Руководство мододела/API/~~Translation~~]]		[[ru:Модификации:Руководство мододела/API/Перевод]]
	[[tr:Modlama:Mod Rehberi/API'ler/Çeviri]]		[[tr:Modlama:Mod Rehberi/API'ler/Çeviri]]
	[[zh:模组:制作指南/APIs/Translation]]		[[zh:模组:制作指南/APIs/Translation]]

imported>Sunbeam135: /* See also */

2026-01-02T10:11:47Z

imported>Pathoschild: remove {{SMAPI upcoming}} for released versions

2025-05-31T17:49:34Z

remove {{SMAPI upcoming}} for released versions

← Older revision		Revision as of 17:49, 31 May 2025
Line 60:		Line 60:
	\|}		\|}

	~~{{SMAPI upcoming\|4.1.0\|~~For large mods, you can optionally have a folder for each language containing any number of <samp>.json</samp> files. This isn't recommended for most mods though, since it's harder to keep in sync between languages and is less supported by translation tools. For example:		For large mods, you can optionally have a folder for each language containing any number of <samp>.json</samp> files. This isn't recommended for most mods though, since it's harder to keep in sync between languages and is less supported by translation tools. For example:
	<pre>		<pre>
	YourMod/		YourMod/
Line 75:		Line 75:

	You can't have both top-level files (like <samp>fr.json</samp>) and folders (like <samp>fr/dialogue.json</samp>), so you'll need to use one pattern consistently.		You can't have both top-level files (like <samp>fr.json</samp>) and folders (like <samp>fr/dialogue.json</samp>), so you'll need to use one pattern consistently.
	}}

	For a [[Modding:Custom languages\|custom language]], use its <samp>LanguageCode</samp> value in the filename.		For a [[Modding:Custom languages\|custom language]], use its <samp>LanguageCode</samp> value in the filename.
Line 112:		Line 111:
	</syntaxhighlight>		</syntaxhighlight>

	~~{{SMAPI upcoming\|4.1.0\|~~All translations can use [[Modding:Dialogue#Gender switch\|gender switch blocks]]. They'll be formatted based on the player's gender each time you fetch the translation.}}		All translations can use [[Modding:Dialogue#Gender switch\|gender switch blocks]]. They'll be formatted based on the player's gender each time you fetch the translation.

	===Strongly-typed API===		===Strongly-typed API===

imported>Pathoschild: /* Built-in API */ + gender switch support in SMAPI 4.1.0

2024-10-28T01:02:30Z

Built-in API: + gender switch support in SMAPI 4.1.0

← Older revision		Revision as of 01:02, 28 October 2024
Line 111:		Line 111:
	string text = helper.Translation.Get(key).Tokens(tokens).Tokens(moreTokens).Default("missing translation?");		string text = helper.Translation.Get(key).Tokens(tokens).Tokens(moreTokens).Default("missing translation?");
	</syntaxhighlight>		</syntaxhighlight>

			{{SMAPI upcoming\|4.1.0\|All translations can use [[Modding:Dialogue#Gender switch\|gender switch blocks]]. They'll be formatted based on the player's gender each time you fetch the translation.}}

	===Strongly-typed API===		===Strongly-typed API===

imported>Peaw at 10:28, 15 September 2024

2024-09-15T10:28:50Z

← Older revision		Revision as of 10:28, 15 September 2024
Line 126:		Line 126:
	[https://gist.github.com/Pathoschild/4e0af42158583983a4206d4d734bfc0b LINQ script] to format an event for translations		[https://gist.github.com/Pathoschild/4e0af42158583983a4206d4d734bfc0b LINQ script] to format an event for translations

			[[tr:Modlama:Mod Rehberi/API'ler/Çeviri]]
	[[zh:模组:制作指南/APIs/Translation]]		[[zh:模组:制作指南/APIs/Translation]]

imported>Pathoschild: /* i18n folder */ + translation subfolders in SMAPI 4.1.0

2024-08-18T19:31:03Z

i18n folder: + translation subfolders in SMAPI 4.1.0

← Older revision		Revision as of 19:31, 18 August 2024
Line 14:		Line 14:
	default.json		default.json
	es.json		es.json
	pt.json		fr.json
	manifest.json		manifest.json
	YourMod.dll		YourMod.dll
	</pre>		</pre>

	The <samp>default.json</samp> file ~~includes~~ the default text ~~that will be~~ shown if a more specific translation isn't available, and you create a separate file for each language. Each translation file should have one of these file names:		The <samp>default.json</samp> file has the default text shown if a more specific translation isn't available, and you create a separate file for each language. Each translation file should have one of these file names:

	{\| class="wikitable"		{\| class="wikitable"
Line 59:		Line 59:
	\| <samp>tr.json</samp>		\| <samp>tr.json</samp>
	\|}		\|}

			{{SMAPI upcoming\|4.1.0\|For large mods, you can optionally have a folder for each language containing any number of <samp>.json</samp> files. This isn't recommended for most mods though, since it's harder to keep in sync between languages and is less supported by translation tools. For example:
			<pre>
			YourMod/
			i18n/
			default/
			dialogue.json
			events.json
			fr/
			dialogue.json
			events.json
			manifest.json
			YourMod.dll
			</pre>

			You can't have both top-level files (like <samp>fr.json</samp>) and folders (like <samp>fr/dialogue.json</samp>), so you'll need to use one pattern consistently.
			}}

	For a [[Modding:Custom languages\|custom language]], use its <samp>LanguageCode</samp> value in the filename.		For a [[Modding:Custom languages\|custom language]], use its <samp>LanguageCode</samp> value in the filename.

imported>Margotbean at 17:18, 3 April 2024

2024-04-03T17:18:46Z

← Older revision		Revision as of 17:18, 3 April 2024
Line 108:		Line 108:
	==See also==		==See also==
	[https://gist.github.com/Pathoschild/4e0af42158583983a4206d4d734bfc0b LINQ script] to format an event for translations		[https://gist.github.com/Pathoschild/4e0af42158583983a4206d4d734bfc0b LINQ script] to format an event for translations

			[[zh:模组:制作指南/APIs/Translation]]

imported>LenneDalben: added See Also section to include link to Pathoschild script on formatting events for translations

2022-07-20T22:43:05Z

added See Also section to include link to Pathoschild script on formatting events for translations

← Older revision		Revision as of 22:43, 20 July 2022
Line 105:		Line 105:

	If a translation breaks, you'll know immediately since it won't compile.		If a translation breaks, you'll know immediately since it won't compile.

			==See also==
			[https://gist.github.com/Pathoschild/4e0af42158583983a4206d4d734bfc0b LINQ script] to format an event for translations

imported>Pathoschild: /* File structure */ add note for custom languages

2022-01-25T18:33:43Z

File structure: add note for custom languages

← Older revision		Revision as of 18:33, 25 January 2022
Line 59:		Line 59:
	\| <samp>tr.json</samp>		\| <samp>tr.json</samp>
	\|}		\|}

			For a [[Modding:Custom languages\|custom language]], use its <samp>LanguageCode</samp> value in the filename.

	===File format===		===File format===

imported>Margotbean: Text replacement - "''e.g.''," to "''e.g.,''"

2021-11-08T00:40:00Z

Text replacement - "''e.g.''," to "''e.g.,''"

← Older revision		Revision as of 00:40, 8 November 2021
Line 4:		Line 4:

	==Overview==		==Overview==
	SMAPI reads translations from files in your mod folder. When you request a translation, it will automatically handle locale fallback (''e.g.'', if a translation isn't available in <samp>pt-BR.json</samp>, SMAPI will check <samp>pt.json</samp> and <samp>default.json</samp>). Translations can be a simple string, or they can include tokens to inject values into the translation.		SMAPI reads translations from files in your mod folder. When you request a translation, it will automatically handle locale fallback (''e.g.,'' if a translation isn't available in <samp>pt-BR.json</samp>, SMAPI will check <samp>pt.json</samp> and <samp>default.json</samp>). Translations can be a simple string, or they can include tokens to inject values into the translation.

	==i18n folder==		==i18n folder==

← Older revision		Revision as of 10:11, 2 January 2026
Line 127:		Line 127:
	[https://gist.github.com/Pathoschild/4e0af42158583983a4206d4d734bfc0b LINQ script] to format an event for translations		[https://gist.github.com/Pathoschild/4e0af42158583983a4206d4d734bfc0b LINQ script] to format an event for translations

			[[ru:Модификации:Руководство мододела/API/Translation]]
	[[tr:Modlama:Mod Rehberi/API'ler/Çeviri]]		[[tr:Modlama:Mod Rehberi/API'ler/Çeviri]]
	[[zh:模组:制作指南/APIs/Translation]]		[[zh:模组:制作指南/APIs/Translation]]