Skip to content

SCANsat Localization File

DMagic edited this page Jan 13, 2016 · 5 revisions

Contents

🔝 Localization File

Included in the GameData/SCANsat/Resources folder is a file called SCANlocalization.cfg. This file contains all of the text for the in-game help tooltips.

Rather than hard-coding these help strings they are loaded from a config file to allow for customization and translations.

The config file uses the following layout:

  SCAN_Localization
  {
       Language_Packs
       {
            Item
            {
                 activePack = True
                 language = English (USA)
                 settingsHelpAnomalies = Select the marker used to display\nanomalies on the map.
                 settingsHelpBackground = Toggle background scanning on\nsome or all celestial bodies.
                 ......
            }
       }
  }
  • The activePack field marks which language pack will be used
    • Only one pack can be marked as active, if there is more than one only the first will be used
    • If the localization file fails to load for any reason, the default, English strings will be used
  • The language field is non-functional and is only included for reference
  • The following fields are the actual strings used for in-game tooltips
    • The first section of each field marks which window it will be used for
    • The last section should be a self-explanatory marker of which button or option the string is to be used for

🔝 Adding Translations

Multiple Language_Packs can be added by copying and pasting a new Item {} node, then filling out all of the fields with the translated values. Such a pack could be added to the game by manually adding a new node to the existing file, replacing the existing file, or using Module Manager. But the preferred method is to send such translations to me and I will include them in the file; users can then select a translation by setting the default pack to activePack = false, and setting the desire pack to activePack = true.