GTNH Translations

中文 / 日本語 / 한국어 / Português brasileiro / Français / Español / Türkçe / Deutsch / Polski /Русский язык

This is a repository managing all the translations for GTNH.

For translators

Why?

We decided to manage all the translations under this repository for these reasons:

• Each language has one central team so that everyone can collaborate.
• We can share workflows to manage all the translations, information on changes made to mods, etc.
• Managing translations on external website is by far convenient than on GitHub.

I want to make contribution to existing language

Each project has its own ParaTranz project. You can join there with your GitHub account.

• zh_CN
• ja_JP
• ko_KR
• pt_BR
• fr_FR
• es_ES
• tr_TR
• de_DE
• pl_PL
• ru_RU

I want to make contribution to language that is not listed here

If you have 3 or more translators for the language, please contact boubou_19.

For translation managers / GTNH members

Policies

1. All the work about translations will go through ParaTranz, and exported to GTNH-Translations repository via automated commits thanks to ParaTranz API.
2. To have an lang file on the repo, we need to have at least 3 translators for the language, so the review can be less biased.
3. Same goes for the language threads in #translation-dev channel on Discord.
4. Each translating community must have a translator in chief, which will be the lead on the ParaTranz project. He/she has the final word on whatever issue(s) there might be.
5. To avoid a ParaTranz project to ever go static because the lead became unreachable, each project must add a special GTNH account so the GTNH Team can always take over on the project, to nominate another lead, etc.
6. Any issue within the pack about translation, being it either wrong translation, missing translation, or localization requests, must go to GTNH-Translations repository.

When adding new language

1. Add new language entry for scripts and workflows. Searching for pl_PL for example could help. (see commit ea67c0e for reference)
2. Add new README_xx_XX.md with a mention from README.md.
3. Add new issue template.
4. Add new label for issue.
5. Run Sync all to ParaTranz workflow with the new language code.
6. Run Publish nightly lang pack workflow with the new language code.
7. (Optional) Run Upload mod jar translations workflow to import existing translations in mod jars. You can skip this if you don't want. Or you can run Python script locally to choose which mod to upload, see List of available actions.

How workflows work

All workflows under ./.github/workflow directory can also be triggered manually. Go to Actions tab, select workflow, (select language) and run it. (Only project owners have permission to do this.)

• nightly-schedule This is where the nightly schedule is triggered. 3 workflows are called sequentially, due to the way syncing to ParaTranz is written.
  • save-nightly-modpack-history Downloads nightly modpack build from DAXXL, unzips, and commits to this repository. The result of the commit will be used by the next workflow.
  • conditional-sync-to-paratranz-parallel Calls the following workflow for all the languages in parallel.
    • conditional-sync-to-paratranz Syncs mod lang and questbook to ParaTranz for specific language. It does not try to send all the files; Instead, it uses commit from save-nightly-modpack-history to see which files have been actually changed and sends only them. This way the workflow can be faster. However, it has major flaw; It requires the specific commit to present before this workflow runs. Hence, nobody should (in theory) push commit between save-nightly-modpack-history and conditional-sync-to-paratranz runs, nor rerun the former before the latter runs. If something goes wrong, sync-all-to-paratranz can force all the files to be synced. If this behavior turns out to be messy, we can stop it and switch to always uploading all the files.
  • publish-all-nightly-lang-packs Calls the following workflow for all the languages sequentially.
    • publish-nightly-lang-pack Pulls latest translation data from ParaTranz, commits them to this repository, and publishes as a lang pack for specific language. Anyone can download it and put it into the modpack.
• sync-gt-lang-to-paratranz-all-langs Calls the following workflow for all the languages sequentially.
  • sync-gt-lang-to-paratranz Syncs GregTech.lang to ParaTranz for specific language. Due to the way GT lang is generated, it cannot be automatically uploaded as a part of nightly workflow. Contributor needs to manually upload lang file under nightly-history directory and run this workflow if they want to update.
• sync-all-to-paratranz-all-langs Calls the following workflow for all the languages sequentially.
  • sync-all-to-paratranz Syncs mod lang, questbook, and GT lang to ParaTranz for specific language.
• upload-jar-translations Uploads existing translations in mod jars to ParaTranz for specific language. If you want to choose which mod to upload, you can run it locally. Refer to List of available actions.

These workflows are not for running manually:

• ensure-dependencies Setups Poetry environment for workflows.
• get-project-id Binds lang name (zh_CN for example) and ParaTranz project ID.

How Python script works

This repository uses Python scripts for communicating with ParaTranz API.

Run locally

Even though primary use is for GitHub workflows, you can also run it locally. Be careful, simple misoperation might ruin your entire ParaTranz project!
In order to run it,

1. Install Python (>= 3.11.0)
2. Install Poetry
3. Set environmental variables PARATRANZ_TOKEN, PARATRANZ_PROJECT_ID, and TARGET_LANG
4. Run poetry install
5. Run poetry run python main.py action <your favorite action>

List of available actions

ParaTranz -> Local

• sync-from-paratranz

Local/Nightly -> ParaTranz

• gt-lang-to-paratranz
• save-nightly-modpack-history
• conditional-sync-to-paratranz
• sync-all-to-paratranz

Translations in mod jars -> ParaTranz

• list-jar-translations
  • Prints all the jar names that contain lang file for your language. This does not upload files.
    • --modpack_path Path to the modpack. It needs to be unzipped.
• view-jar-translations
  • Prints the content of translations in mod jars. You can view one by one. This does not upload files.
    • --modpack_path Path to the modpack. It needs to be unzipped.
• upload-jar-translations
  • Uploads existing translations in mod jars to ParaTranz.
    • --modpack_path Path to the modpack. It needs to be unzipped.
    • (Optional)--interactive True by default. It prints the contents of the translation and asks you whether to adopt it or not, for each jar. Setting False means it uploads all the translations without asking you, which is the same behavior as upload-jar-translations workflow.

Other available Python scripts

• future_mc_lang_diff
  • Fetches vanilla translations from future version and compares to 1.7.10. You can put the resulting lang file to config/txloader/load/lang folder to include in the pack.

Things to be done

• Add support for IC2
• Support some config files for ParaTranz
• Figure out what to do with BLS translation
• pt_BR to pt_PT conversion script
• Refine the way conditional sync works
• Eliminate GregTech.lang
• Automatically backup ParaTranz project just in case?

Credit

MuXiu1997 for original workflows and scripts!