ArchiSteamFarm/tools/crowdin-cli/README.md

Crowdin CLI

Latest release

Source

Help

---

This tool is being used by ASF developers for synchronization of strings/translations between GitHub and Crowdin. If you're not ASF developer that has access to our localization platform, then you won't find anything interesting here.

---

Before you begin

• Make sure that your crowdin_identity.yaml file exists - this is the file with login credentials that is not being committed to GitHub. If it doesn't exist yet (e.g. because you've just cloned the repo), create it from crowdin_identity_example.yaml and fill api_key that can be found here.

• Ensure that crowdin command is recognized by your OS.

---

Windows

• Install Java JDK.
• Set JAVA_HOME properly.
• Launch setup_crowdin.bat as administrator.
• Open new cmd prompt and verify that crowdin help indeed works.

---

Usage

• archi_upload.bat for pushing strings to Crowdin (when any *Strings.resx file gets modified).

• archi_download.bat for downloading translations from Crowdin (typically last commit before release).

• archi_sync.bat for upload + download (tree sync, e.g. when modifying/removing original strings).