games/vcmi
1
0
Fork 0
mirror of https://github.com/vcmi/vcmi.git synced 2025-11-23 22:37:55 +02:00
Code Issues Releases Activity

Updated localization docs

Browse Source
This commit is contained in:
Ivan Savenko
2023-09-23 16:38:17 +03:00
parent 9f894d6ca0
commit ddda6c0c01
2 changed files with 115 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/modders/Mod_File_Format.md
View File

@@ -32,6 +32,9 @@
// Type of mod, list of all possible values:
// "Translation", "Town", "Test", "Templates", "Spells", "Music", "Sounds", "Skills", "Other", "Objects",
// "Mechanics", "Interface", "Heroes", "Graphical", "Expansion", "Creatures", "Artifacts", "AI"
//
// Some mod types have additional effects on your mod:
// Translation: mod of this type is only active if player uses base language of this mod. See "language" property.
"modType" : "Graphical",
// Base language of the mod, before applying localizations. By default vcmi assumes English
@@ -178,6 +181,22 @@ These are fields that are present only in local mod.json file
}
```
## Translation fields
In addition to field listed above, it is possible to add following block for any language supported by VCMI. If such block is present, Launcher will use this information for displaying translated mod information and game will use provided json files to translate mod to specified language.
See [Translations](Translations.md) for more information
```
"<language>" : {
"name" : "<translated name>",
"description" : "<translated description>",
"author" : "<translated author>",
"translations" : [
"config/<modName>/<language>.json"
]
},
```
## Mod repository fields
These are fields that are present only in remote repository and are generally not used in mod.json