Sands of Salzaar: Translate Workshop Mods

This guide focuses on the English translation of Sands of Salzaar and demonstrates one method for translating existing Excel-based mods from Chinese to any other language without affecting the Chinese language setting. If you’d prefer to use the Chinese language setting instead of English, use the tchinese files and directories instead of the english ones in the included steps.

Several manual steps are included due to the data files being located in another mod. This guide should not be followed when creating or maintaining a standalone mod.

In order to translate a mod, it must either be released as open source or the author must provide the necessary Excel files or data. A mod can be determined to be open source if the Open source button is visible when viewing a mod from the in-game mod browsers.

Starting from the main menu:

1. Press Game Mods to open a popup window.
2. Press Develop Mods to navigate to the Sands of Salzaar Mod Editor window.
3. Press New Project.
4. Select Simple Mod Project for Project Type, input your project name and directory, and press Confirm.
5. Press Build.

Starting from the Sands of Salzaar Mod Editor window:

1. Press Project Configuration.
2. Press the Required DLC/mods button on the Project Configuration popup window.
3. Select each mod to be translated and press Save.

Starting from the Sands of Salzaar Mod Editor window:

1. Press Open Project Directory to open your translation mod’s root directory. Leave this window open as it will be needed throughout the rest of the guide.
2. Delete the following files:
   • Excel\C传承.xlsx
   • Excel\J剧情内文字翻译.xlsx
   • Excel\Localization\english\J剧情内文字翻译_hotfix.xlsx
   • Excel\Localization\tchinese\J剧情内文字翻译_hotfix.xlsx
   • valuebundle\INDEX_Source.xml
   • valuebundle\TranslateTask.xlsx
   • valuebundle\TranslateTaskTemplate.xlsx
3. Delete each line between <root…> and </root> in the following files:
   • valuebundle\default_english.xml
   • valuebundle\default_tchinese.xml
   • valuebundle\default.xml
   • valuebundle\Index.xml

1. Browse to the workshop mod’s root directory by pressing the Open source button when viewing a mod from the in-game mod browser. This can also be accomplished by navigating to:
   • X:\\…\Steam\steamapps\workshop\content\1094520\<MOD_ID>
2. In the SourceProject\Excel directory:
   1. Copy each .xlsx file to be translated and paste them into your new mod’s Excel\Localization\english directory.
   2. Append _hotfix to each pasted file. For example:
      • Old:
        • C传承_Legacy.xlsx
      • New:
        • C传承_Legacy_hotfix.xlsx
3. In the SourceProject\valuebundle directory:
   1. In the default.xml file:
      1. Copy each <include file…/> line containing a filename to be translated and paste them between <root…> and </root> in your translation mod’s valuebundle\default_english.xml file. Do not copy the lines for files that will not be translated.
      2. Append _hotfix to the filename for each pasted line. For example:
         • Old:
           • <include file=”C传承_Legacy.xlsx”/>
         • New:
           • <include file=”C传承_Legacy_hotfix.xlsx”/>
      3. Prepend Localization/english/ to the filename for each pasted line. For example:
         • Old:
           • <include file=”C传承_Legacy_hotfix.xlsx”/>
         • New:
           • <include file=”Localization/english/C传承_Legacy_hotfix.xlsx”/>
   2. In the INDEX.xml file:
      1. Copy each <convert reg…/> line containing a filename to be translated and paste them between <root…> and </root> in your translation mod’s valuebundle\Index.xml file. Do not copy the lines for files that will not be translated.
      2. Append _hotfix to the filename for each pasted line. For example:
         • Old:
           • <convert reg=”…” from=”C传承_Legacy.xlsx”/>
         • New:
           • <convert reg=”…” from=”C传承_Legacy_hotfix.xlsx”/>
      3. Prepend Localization/english/ to the filename for each pasted line. For example:
         • Old:
           • <convert reg=”…” from=”C传承_Legacy_hotfix.xlsx”/>
         • New:
           • <convert reg=”…” from=”Localization/english/C传承_Legacy_hotfix.xlsx”/>
4. Navigate to the Sands of Salzaar Mod Editor window and press Build to ensure that changes were made correctly.

Starting from your translation mod’s root directory:

1. For each .xlsx file in the Excel\Localization\english directory:
   1. Open the file.
   2. Ignore the first column for any further steps as it should always be an ID and should never be deleted or translated.
   3. Delete any columns (at the top) that aren’t going to be translated.
   4. Copy and paste each remaining column next to itself. For example:
      • Old:
        显示名称_DisplayName

        描述_Description
      • New:
        显示名称_DisplayName

        显示名称_DisplayName

        描述_Description

        描述_Description
   5. Append (Origin) to the leftmost column for each set of columns. For example:
      • Old:
        显示名称_DisplayName

        显示名称_DisplayName

        描述_Description

        描述_Description
      • New:
        显示名称_DisplayName(Origin)

        显示名称_DisplayName

        描述_Description(Origin)

        描述_Description
   6. Translations should be made to the rightmost column for each set of columns. These are the columns that weren’t appended with (Origin).
2. Navigate to the Sands of Salzaar Mod Editor window and press Build to ensure that changes were made correctly.
3. Press one of the Debug icons/buttons, enable the base mod and translation mod, and play the game to quickly test changes.