https://wiki.shroudforge.net/index.php?action=history&feed=atom&title=Translate_mod_text%2Fen-gbTranslate mod text/en-gb - Revision history2026-11-07T23:23:22ZRevision history for this page on the wikiMediaWiki 1.46.2https://wiki.shroudforge.net/index.php?title=Translate_mod_text/en-gb&diff=463&oldid=prevFuzzyBot: Updating to match new version of source page2026-11-06T21:48:50Z<p>Updating to match new version of source page</p>
<p><b>New page</b></p><div><languages /><br />
<br />
<!-- ShroudForge Modloader Wiki Post<br />
title: Translate mod text<br />
description: Translate visible Modloader text and Lua text from the same locale files in the mod folder. Read the Modloader language through shroudforge.locale(), added by PR #42.<br />
language: en-GB<br />
picture:ShroudForge-Wiki-modding-locales.svg<br />
creator: Bonsaibauer<br />
--><br />
<br />
[[File:ShroudForge-Wiki-modding-locales.svg|thumb|left|600px|Translate mod text]]<br />
<br />
<br style="clear:both;" /><br />
<br />
<br />
Translate visible Modloader text and Lua text from the same locale files in the mod folder. Read the Modloader language through <code>shroudforge.locale()</code>, added by PR #42.<br />
<br />
== Locale files ==<br />
<br />
Add one file under <code>locales/&lt;code&gt;.json</code> for each language. Current codes from the Modloader language selector are <code>de</code>, <code>de-AT</code>, <code>de-CH</code>, <code>en-GB</code>, <code>en-US</code>, <code>es</code>, <code>fr</code>, <code>hi</code>, <code>it</code>, <code>ja</code>, <code>nl</code>, <code>pl</code>, <code>sv</code>, and <code>zh</code>. The filename matches its code exactly. These files sit beside <code>mod.json</code> and <code>extended.mod.json</code>.<br />
<br />
The schema is published as [https://bonsaibauer.github.io/shroudforge/schemas/mod-locale.schema.json <code>mod-locale.schema.json</code>]. A locale catalog can translate <code>mod.name</code> and <code>mod.description</code>, setting and option labels, groups, actions, changelog lines, and Lua <code>strings</code>. Catalogs may be partial. Entries without a translation keep their source text.<br />
<br />
<pre><br />
{<br />
"$schema": "https://bonsaibauer.github.io/shroudforge/schemas/mod-locale.schema.json",<br />
"settings": {<br />
"severity": {<br />
"label": "Log level",<br />
"options": { "info": "Information", "warn": "Warning" }<br />
}<br />
},<br />
"groups": [<br />
{ "label": "Logging", "actions": { "write": { "label": "Write message" } } }<br />
],<br />
"strings": { "overlay.ready": "Ready" }<br />
}<br />
</pre><br />
<br />
Setting and option keys stay the same as in <code>extended.mod.json</code>. Group translations follow that file's group order. Action translations use the existing action ID. Saved values do not change.<br />
<br />
== Use the same text in Lua ==<br />
<br />
<pre><br />
local locale = shroudforge.locale()<br />
local ready = shroudforge.i18n.get("overlay.ready", locale, "Ready")<br />
</pre><br />
<br />
<code>shroudforge.i18n.get(key, locale, fallback)</code> uses the same loaded catalog as the Modloader. It checks a regional code such as <code>de-AT</code> first, followed by its language <code>de</code>. A missing string returns the fallback text, or the key when no fallback is provided. The lookup does not read files again. PR #42 supplies the language API, and this feature connects it to each mod's catalog.<br />
<br />
If <code>shroudforge.locale()</code> returns <code>en</code> because the configuration cannot be read, catalog lookup checks <code>en-GB.json</code> first and then <code>en.json</code>. <code>en-GB</code> is the Modloader's English default. <code>en-US</code> remains available as an explicitly selected variant.<br />
<br />
Locale files do not require the runtime capability. ShroudForge interface text stays in the shared Modloader translations.<br />
<br />
<br />
[[Category:guide:Shroudforge]]</div>FuzzyBot