translators.md

Translator Instructions

This file contains details for people who want to help translate the game.

Prerequisites

1. You will need a github account for editing the files here, if you do not already have one you can sign up here
2. Log into your account and create a fork of this repo click here

Creating a new branch for changes

First, make sure you are on your develop branch (use branch selector in top left), and it is up date by using the "sync fork" button

Click the Update Fork button, and if it asks about conflicting changes, you should discard your conflicting changes

Next click the branch selector and type in a name for your new branch. An option will appear to create a branch with this name and switch you onto it

Making Changes

1. Create a new branch
2. Find the file with the content you want to translate. Translation files are inside the /locales/{lang}/ folders
3. Click the edit button at the top right of the file
4. Make your changes in the web editor
5. Check what you have changed on the preview tab
6. Below the editor, add a short description of what you have changed, make sure the option "Commit directly to the your-branch-name branch" option is selected, and click "Commit changes"
7. Repeat steps 2-6 as many times as needed, then click the "Code" tab above the files. There should be a box telling you your branch has had recent changes and gives you a button to "Compare & pull request". Click the button if you are ready to submit your edits.
8. Confirm that the changes are being compared to repo pokeclicker/pokeclicker-translations branch develop, and then click "Create Pull Request"
9. Add any additional comments you want, and then click "Create Pull Request"
10. Someone will review your changes and either accept them or request you make some changes

Updating a pull request with new changes

1. On your repo, switch to the branch you made for your pull request
2. Make any additional changes you want and commit them directly to the branch
3. After commiting, your Pull Request should automatically pick up your new changes

Other Notes

Any content which is an empty string ("") will fallback to the english translation string. If you need your language to actually return nothing for this key, you can use the unqouted value null

You can reference another translation key within your content like this [[other_key]] There are other features of the translation system you can read about here

This referencing of other keys is used extensively in the pokemon.json file, many languages will be able to get translations for all of some variant types (eg, Megas) by only translating the alt.mega key. This is achieved by having the english translation for mega pokemon set up like this:

{
  "alt": {
    "mega": "Mega"
  },
  "Venusaur": "Venusaur",
  "Mega Venusaur": "[[alt.mega]] [[Venusaur]]",
  "Blastoise": "Blastoise",
  "Mega Blastoise": "[[alt.mega]] [[Blastoise]]"
}

Note that these are also referencing the translation for the base pokemon name as well as the mega key, so the french file can simply be this:

{
  "alt": {
    "mega": "Méga",
  },
  "Venusaur": "Florizarre",
  "Mega Venusaur": "",
  "Blastoise": "Tortank",
  "Mega Blastoise": ""
}

and the Mega Venusaur and Mega Blastoise keys are still properly translated as "Méga Florizarre" and "Méga Tortank"

If you think a translation key is missing (eg, a new pokemon has been added to the game but you can't find it in pokemon.json), please create an issue listing anything missing and someone will make sure it gets added to all language files.