add translation guidelines/steps

This commit is contained in:
Mister_Nebula 2022-06-27 18:10:12 +01:00
parent ed74b78cb3
commit 49db44a28c
3 changed files with 44 additions and 0 deletions

View File

@ -10,6 +10,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
.gitignore = .gitignore
LICENSE = LICENSE
README.md = README.md
TRANSLATING.md = TRANSLATING.md
EndProjectSection
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MirrorWeaver", "MirrorWeaver\MirrorWeaver.csproj", "{DA8A467E-15BA-456C-9034-6EB80BAF1FF9}"

View File

@ -87,6 +87,10 @@ Let me know if you find an answer.
**Update**: a plausible answer is the enjoyment you get seeing/hearing about others playing with their friends :)
## Translating
See [TRANSLATING.md](TRANSLATING.md)
## Development Setup
- [Download the Outer Wilds Mod Manager](https://github.com/raicuparta/ow-mod-manager) and install it anywhere you like;

39
TRANSLATING.md Normal file
View File

@ -0,0 +1,39 @@
# Translating QSB
## Progress :
QSB can only be translated to the languages Outer Wilds supports - so if you don't see your language here, contact Mobius Digital about translating the game to that language.
### Translated languages :
- English
- French
- Russian
### Un-translated languages :
- Spanish (Latin American)
- German
- Italian
- Polish
- Portuguese (Brazil)
- Japanese
- Chinese (Simplified)
- Korean
- Turkish
## Translating
### Creating the translation file
Create a new file, and name it `(language).json`. For example, you could have `de.json` or `german.json`. The name doesn't have to follow any rules, just as long as it's recognisable as that language.
Copy the contents of `en.json` into your file. `en.json` can be found [here](https://github.com/misternebula/quantum-space-buddies/blob/dev/QSB/Translations/en.json) on GitHub, or alternatively in the mod install - `Mods\QSB\Translations\en.json`
Go through each of the English items and translate them into your language.
You can test your translation by putting your file in `Mods\QSB\Translations\`, alongside the other translation files.
Once you are happy with it, go to [this page](https://github.com/misternebula/quantum-space-buddies/new/dev/QSB/Translations) to create a PR with your translation file. In the "Name your file..." box put your file name and extension (e.g. `de.json`), and in the text box copy and paste the contents of your translation file.
Scroll down to the "Propose new file" box. In the title box (default "Create new file") write something along the lines of "Add translation for (language)".
Press the big green "Propose new file", and we'll review it soon!