mika/pokerogue
1
0
Fork 0
mirror of https://github.com/pagefaultgames/pokerogue.git synced 2025-06-21 09:02:47 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update localization.md .8

Browse Source
This commit is contained in:
Bertie690 2025-06-16 14:14:19 -04:00
parent 922572fb3e
commit 91d13acfd5
1 changed files with 43 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
docs/localization.md
View File

@ -8,7 +8,7 @@ This document aims to cover everything you need to know to help keep the integra
# Stupid Assumptions
Before you continue, this document assumes:
<!-- TODO: Change to mention contributing.md once that released -->
- You have already forked the repository and set up a development environment according to the [respository README] (https://github.com/pagefaultgames/pokerogue/blob/beta/README.md).
- You have already forked the repository and set up a development environment according to the [respository README](https://github.com/pagefaultgames/pokerogue/blob/beta/README.md).
<!-- TODO: Get @SirsBenjie to add a good Git/GH tutorial for noobs -->
- You have a basic level of familiarity with Git commands and GitHub repositories.
- You have joined the [community Discord](https://discord.gg/pokerogue) and have access to `#dev-corner` and related channels via **[#select-roles](https://discord.com/channels/1125469663833370665/1194825607738052621)**. This is the easiest way to keep in touch with both the Translation Team and other like-minded contributors!
@ -25,7 +25,7 @@ From the perspective of the main project, the locales submodule is fairly simple
#### Fetching Changes from Submodules
Once you have set up your fork, run the following command to integrate the latest locales changes into your branch:
Once you have set up your fork or whenever it gets out of date, run the following command to integrate the latest locales changes into your branch:
```bash
git submodule update --init --recursive
```
@ -35,11 +35,10 @@ This is run automatically after merge or switching branches, so you _usually_ wo
[^1]: If you run into issues with your development environment afterwards, try deleting the `.git/modules/public` and `public/locales` folders before re-running the command.
## Adding Translated Text
### How Are Translations Integrated?
This project uses the [i18next library](https://www.i18next.com/) to integrate translations from `public/locales` into the source code based on the user's settings or location. The basic process for fetching translated text is as follows:
This project uses the [i18next library](https://www.i18next.com/) to integrate translations from `public/locales` into the source code based on the user's settings or location.
The basic process for fetching translated text goes as follows:
1. The source code fetches text by a given key, e.g.
```ts
i18next.t("fileName:keyName", { arg1: "Hello", arg2: "an example", ... })
@ -55,41 +54,62 @@ This project uses the [i18next library](https://www.i18next.com/) to integrate t
"Hello! This is an example of translated text!"
```
### Requirements for Adding Translated Text
## Submitting locales changes.
If you have a feature or enhancement that requires additions or changes to in-game text, you will need to make a fork of the `pokerogue-locales` repo and submit your text changes as a pull request to that repo _in addition_ to your pull request to the main project.
Since these two PRs aren't technically linked, it's important to coordinate with the Translation Team to ensure that both PRs are integrated safely into the project.
As the developer, you are responsible for creating or adjusting English keys (or your mother language) in support of your feature or enhancement; the Translation Team will take care of the rest.
When your new feature or enhancement requires a new key **without changing text in existing keys**, we require the following workflow with regards to localization:
1. You (the developer) make a pull request to the main repository for your new feature. If this feature requires new text, the text should be integrated into the code with a new `i18next` key pointing to where you plan to add it into the locales repository. **DO NOT HARDCODE PLAYER-FACING TEXT INTO THE CODE!**
2. You then make another pull request -- this time to the `pokerogue-locales` repository -- adding a new entries to the JSON files with text for each key you added to your main PR.
<!-- TODO: add some pics of vscode's git integration -->
## Requirements for Adding Translated Text
When your new feature or enhancement requires adding a new locales key **without changing text in existing keys**, we require the following workflow with regards to localization:
1. You (the developer) make a pull request to the main repository for your new feature.
If this feature requires new text, the text should be integrated into the code with a new `i18next` key pointing to where you plan to add it into the locales repository. **DO NOT HARDCODE PLAYER-FACING TEXT INTO THE CODE!**
2. You then make another pull request -- this time to the `pokerogue-locales` repository -- adding a new entry with text for each key you added to your main PR.
- You only need to change **English keys** when making the PR; the Translation Team will take care of the rest.
- For any feature pulled from the mainline Pokémon games (e.g. a Move or Ability implementation), it's best practice to include a source link for any added text.
[Poké Corpus](https://abcboy101.github.io/poke-corpus/) is a great resource for finding text from the mainline games; otherwise, a video (YouTube or otherwise) showing the text in mainline should suffice.
- You should also [notify the current Head of Translation](#Contacting Translation Staff) to ensure a fast response.
3. You can now [test locales integration](#Filming Locales Changes) in your main PR.
[Poké Corpus](https://abcboy101.github.io/poke-corpus/) is a great resource for finding text from the mainline games; otherwise, a video/picture showing the text in mainline should suffice.
- You should also [notify the current Head of Translation](#Notifying Translation) to ensure a fast response.
3. At this point, you may begin [testing locales integration in your main PR](#Filming Locales Changes).
4. The Translation Team will approve the locale PR (after corrections, if necessary), then merge it into `pokerogue-locales`.
5. The Dev Team will approve your main PR for your feature, then merge it into PokéRogue's beta environment.
### Requirements for Modifying Translated Text
PRs that modify existing text have different risks with respect to coordination between development and translation, so their requirements are slightly different:
- As above, you set up 2 PRs: one for the feature itself in the main repo, and another for the associated locales changes in the locales repo.
- As above, you set up 2 PRs: one for the feature itself in the main repo, and another for the associated locales changes in the locale repo.
- Now, however, you need to have your main PR be approved by the Dev Team **before** your corresponding locale changes are merged in.
- After your main PR is approved, the Translation Team will merge your locale PR, and you may update the submodule and post video evidence of locale integration in the **locales PR**.
- After your main PR is approved, the Translation Team will merge your locale PR, and you may update the submodule and post video evidence of locale integration into the **locales PR**.
<!-- - A Lead or Senior Translator from the Translation Team will then approve your main PR (if all is well), clearing your feature for merging into beta. -->
## Filming Locales Changes
TODO mention obs
## Contacting Translation Staff
It is much easier for someone to merge a PR if they know it exists.
After making a PR involving any outwards-facing behavior (but _especially_ locales-related ones), it's generally considered good practice to attach a video of those changes working in-game.
The best way to notify Translation staff of an impending Locales PR is by **pinging the current Head of Translation** in the community discord.
Basic procedure:
<!-- TODO: Update links after contributing.md PR -->
1. Update your locales submodule to use the latest locales from the remote.
Many code editors with `git` integration allow for checking out submodules directly from the UI, or you can run `git submodule update --remote --recursive`.
- If the locales PR hasn't been
2. Set some of the [in-game overrides](../README.md#-faq) inside `overrides.ts` to those corresponding to the Moves and Abilities being tested.
3. Start a local dev server (`npm run start:dev`).
4. Film the locales change being displayed in the recording software of your choice[^2].
Here are a few guidelines to bear in mind when recording:
- **1 change = 1 video**. GitHub has a hard 10mB limit on video uploads, so prefer splitting individual interactions into individual recordings.
- **Keep videos short**. Nobody wants to watch a 5-minute film for 10 seconds of content. Around 1 turn of content is good enough.
[^2]: For those lacking a screen capture device, [OBS Studio](https://obsproject.com) is a popular open-source option.
# Notifying Translation
Put simply, stating that a PR exists makes it much easier to review and merge.
The easiest way to do this is by **pinging the current Head of Translation** in the [Discord](https://discord.gg/pokerogue) (ideally in `#dev-corner` or similar).
The current Head of Translation is:
<!-- Remember to update this everytime the head of translation changes -->
** @lugiadrien **
# Closing Remarks
If you have any questions about the developer process for localization, don't hesitate to ask someone in `#dev-corner`!
The Dev Team and Translation Team will be happy to answer any questions.
If you have any questions about the developer process for localization, don't hesitate to ask!
Feel free to contact us on [Discord](https://discord.gg/pokerogue) - the Dev Team and Translation Team will be happy to answer any questions.