¶ Introduction
This page will show you how to mod the languages within Elegos.
¶ How do I mod the game languages?
Create a folder called languages inside of a mod folder. You should end up with a structure like <mod name>/languages.
- Create a
.jsonfile named with the name of the language that you are creating (i.e.polish.json) and place inside of the<mod name>/languagesfolder. - Not all keys have to be in the JSON. Anything ommited then default values are used or if overriding then original values are used.
- JSON Reference and Example.
- See below for a complete String ID reference.
¶ Secret other way but good for quick testing...
A bit of a legacy thing but useful for quick testing, /data/languages is still a 'magic' folder and so will be processed in the same way as the languages folder inside of mods. I discourage adding stuff to the data folder as it's not easily or formally shared like a mod is, but it is there for quick iteration on language files before you have to create a complete and valid mod folder/zip.
The naming convention that we have agreed on is {screen}.{section or type}.{subsection}.{name}_description_if_needed. For instance, if we are on the menu screen all the keys will start with menu., if we are on the settings then the key will be something as menu.settings this will help to keep the keys isolated and easier to debug
¶ Supported Character Sets
We are using Google's Noto Sans font family and currently support the following Unicode scripts/characters sets:
- Latin
- Greek
- Cyrillic
- Japanese
- Korean
- Chinese (Simplified)
- Chinese (Traditional)
- Thai
¶ String ID Reference
Whilst a String ID is essentially a string that references an underlying text field, the String IDs in Elegos follow a standardised naming convention for ease of reference and organisation:
See below for a full list of String IDs currently available in Elegos.
¶ Splash
| ID | Description |
|---|---|
splash.alpha_welcome |
Brief text shown before the menu |
splash.accept |
Close the splash screen |
splash.known_issues |
Show the list of known issues |
| ID | Description |
|---|---|
menu.splash.alpha_welcome |
Brief text shown before the menu |
menu.splash.button_accept |
Close the splash screen |
menu.splash.button_issues |
Show the list of known issues |
| ID | Description |
|---|---|
menu.splash.alpha_welcome |
Brief text shown before the menu |
menu.splash.button_issues |
Show the list of known issues |
¶ Generic buttons
| ID | Description |
|---|---|
menu.button.ok |
Generic OK button. Close the splash screen |
menu.button.back |
Generic back button. |
menu.button.save |
Generic save button. |
menu.button.cancel |
Generic cancel button. |
¶ Example file
NEW FILE FORMAT! The dialogue is unused for the moment
{
"name":"English",
"description": "This is a translation for GB English",
"countrycode":"en",
"ui":{
"menu.splash.alpha_welcome":"Welcome to Elegos...",
"menu.button.ok":"Ok",
"menu.splash.button_issues":"Known issues"
},
"dialogue":{
"S1_d1_s4": "Greetings!",
"S1_d1_s5": "You are still not a citizen?",
"S1_d1_s6": "For Zeus!!"
}
}