RacesOfValheim/TRANSLATING.md
2026-10-06 13:46:00 +02:00

55 lines
2.2 KiB
Markdown

# Translating Races of Valheim
Thanks for helping. This page covers the rules for translations.
## Where to work
- Each language has its own branch, `localisation-<language>` (for example `localisation-russian`). Work only on that branch.
- When you're done, open a pull request into `localisation`. Never open one into `main`.
- Edit only the files under `JotunnModStub/Translations/<Language>/`. Leave every other file alone.
If your language has no branch yet, ask for one.
## The files
Each file is a JSON list of key/value pairs:
```json
"rov_race_furling_desc": "Cunning goblin-like creatures. Agile and resourceful."
```
- **Never change a key.** Keys look like `rov_<section>_<thing>`. Translate only the value on the right.
- **Keep placeholders exactly as they are.** `$1`, `$2` and any other `$word` inside a value get replaced by numbers or names in game. You can move them around in the sentence, but don't rename, translate or delete them.
- Keep `\n` line breaks where they are.
## What not to translate
- **Race IDs.** These are the internal race names the code uses, and they never change. Race display names, such as the value of `rov_race_furling_name`, are translated.
- **Ability names that are quotes or song titles.** These stay in the original language:
- Purple Rain
- Weight of Shadows
- Like a Bat out of Hell
- Vae Victis
- Swarm of Terror
- The Furling passives: Master of Shadows, Dance of the Dead, Through Fire and Flames, The Wickerman
If one of these names appears inside a longer sentence, translate the sentence and leave the name as it is.
- Translate every other, purely functional, ability name (for example "Combat Mastery").
## Keep the JSON valid
- Save files as UTF-8 **without** a BOM.
- No trailing comma after the last entry.
- Escape double quotes inside values as `\"`.
Check each file before you push:
```
python -m json.tool JotunnModStub/Translations/<Language>/races.json
```
If it prints the file back, it's fine. If it prints an error, it shows the line to fix.
## Partial translations are fine
Any key missing from your files, or still in English, falls back to the English text in game. You can translate a file at a time and push as you go.