games/vcmi
1
0
Fork 0
mirror of https://github.com/vcmi/vcmi.git synced 2024-12-24 22:14:36 +02:00
Code Issues Releases Activity

Updated docs

Browse Source
This commit is contained in:
Ivan Savenko 2024-04-08 14:05:49 +03:00
parent 050157db9d
commit 719b61bb9f
2 changed files with 22 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/modders/Translations.md
View File

@ -38,10 +38,12 @@ VCMI allows translating game data into languages other than English. In order to
If you have already existing Heroes III translation you can:
- Install VCMI and select your localized Heroes III data files for VCMI data files
- Launch VCMI_Client.exe directly from game install directory
- In console window, type `convert txt`
- Launch VCMI and start any map to get in game
- Press Tab to activate chat and enter '/translate'
This will export all strings from game into `Documents/My Games/VCMI/VCMI_Client_log.txt` which you can then use to update json files in your translation
This will export all strings from game into `Documents/My Games/VCMI/extracted/translation/` directory which you can then use to update json files in your translation.
To export maps and campaigns, use '/translate maps' command instead.
## Translating VCMI data
@ -111,7 +113,15 @@ If everything is OK, your changes will be accepted and will be part of next rele
### Exporting translation
TODO
If you want to start new translation for a mod or to update existing one you may need to export it first. To do that:
- Enable mod(s) that you want to export and set game language in Launcher to one that you want to target
- Launch VCMI and start any map to get in game
- Press Tab to activate chat and enter '/translate'
After that, start Launcher, switch to Help tab and open "log files directory". You can find exported json's in 'extracted/translation' directory.
If your mod also contains maps or campaigns that you want to translate, then use '/translate maps' command instead.
### Translating mod information
In order to display information in Launcher in language selected by user add following block into your mod.json:
@ -127,6 +137,12 @@ In order to display information in Launcher in language selected by user add fol
```
However, normally you don't need to use block for English. Instead, English text should remain in root section of your mod.json file, to be used when game can not find translated version.
### Tranlating in-game strings
After you have exported translation and added mod information for your language, copy exported file to `<mod directory>/Content/config/<mod name>/<language>.json`.
Use any text editor (Notepad++ is recommended for Windows) and translate all strings from this file to your language
# Developers documentation
### Adding new languages

3
docs/players/Cheat_Codes.md
View File

@ -114,7 +114,8 @@ Below a list of supported commands, with their arguments wrapped in `<>`
`bonuses` - shows bonuses of currently selected adventure map object
#### Extract commands
`convert txt` - save game texts into json files
`translate` - save game texts into json files
`translate maps` - save map and campaign texts into json files
`get config` - save game objects data into json files
`get scripts` - dumps lua script stuff into files (currently inactive due to scripting disabled for default builds)
`get txt` - save game texts into .txt files matching original heroes 3 files