Locales

Locales add new language translations to Overseer. Locales are simple Fluent syntax files that override the default Overseer English (en_US) language file.

Locales are not required to define every key, only keys defined will be overridden if a user chooses your customized language.

Creating a locale

You can create a locale by creating a definition in the plugin manifest.json file.

Example:

{
  // [...]
  "locales": [
    { 
      "id": "pt_PT",
      "label": "Portuguese",
      "src": { "$ref": "locales/pt_PT/main.ftl" }
    }
  ]
}

Locale definition

A locale is defined by a main.ftl file (or really any .ftl file.)

Reference

Please reference https://overseer.studio/schemas/locale/en_US.ftl for a complete list of translations.

References

Message and term references such as { app-name } or { -brand } only resolve within your own locale file. If a translation references another message, define that message in your locale too.

Finding missing translations

Select your language in Settings > Language, then turn on Settings > Developer > Show missing translations. Any text your locale doesn’t translate shows its translation ID (for example, help-section-creating-tiles-title) instead of falling back to English, ready to copy into your .ftl file.

Each missing ID is also written once to the log file. English is unaffected by this setting.

Fluent syntax

See the Fluent Syntax Guide for more information on how to configure and use Fluent translations.