Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

String Customization

Some mod features allow for custom string translations, so that players can see text in their preferred languages. These features expect strings of a certain format to be included in a separate mod. This could be an unlisted mod used by a single server, or an extension mod that adds default content for servers.

Note

These translations are not defined using the game’s usual translation system. See the information about contributing translations for details.

The comment ### @bundle OmiChat must be included at the top of translation files for them to be included.

Dialogue Tags

Custom dialogue tags can be specified for narrative style using the Dialogue Tag Format option.

When defining a custom dialogue tag, the string unknown-language-[tag] should also be defined. This is used when the player’s character doesn’t speak the language used for a message with the given tag. It must include the variables $name and $language.

A string for signed languages can also be specified with unknown-language-signed-[tag]. This will be used when the language is a signed language.

For example, if the dialogue tag mutters were used, the strings could be defined in English as:

### @bundle OmiChat

unknown-language-mutters = { $name } mutters something in { $language }.

unknown-language-signed-mutters = { $name } subtly signs something in { $language }.

# or, since it's the same as the built-in string for 'whispers':
unknown-language-signed-mutters = { unknown-language-signed-whispers }

If a string is not defined for the tag, it will default to the translation for says or signs, depending on whether the language is signed.

Roleplay Languages

Roleplay languages allow translations for language names. These can be defined with a language-[name] string. For example, language-english defines the translation used for the English roleplay language.

When retrieving translations, language names will be converted to lowercase and spaces will be replaced with hyphens. Translations for Haitian Creole, for example, should be defined using language-haitian-creole.

If the translation is absent, the language name will be used as-is regardless of a player’s language. Translations are provided by the mod for the following roleplay languages:

  • ASL
  • Arabic
  • Bengali
  • Cantonese
  • Catalan
  • Danish
  • Dutch
  • English
  • Finnish
  • French
  • German
  • Gujarati
  • Hausa
  • Hawaiian
  • Hindi
  • Hungarian
  • Italian
  • Japanese
  • Javanese
  • Korean
  • Latvian
  • Malay
  • Mandarin
  • Marathi
  • Norwegian
  • Persian
  • Polish
  • Portuguese
  • Punjabi
  • Romanian
  • Russian
  • Shanghainese
  • Spanish
  • Tagalog
  • Tamil
  • Telugu
  • Thai
  • Turkish
  • Ukrainian
  • Urdu
  • Vietnamese