Mods localization helper (for mods hosted on github)

[diraria]

I've written a helper for simplifying mods translation by providing synchronization between mod repository (on GitHub) and Crowdin. Synchronization is two-way, which means that:

• changes of english strings on github mod repository are automatically applied to crowdin
• new or updated translations on crowdin are automatically pushed to your github mod repository

To start using helper you only need to install this github app. After installation helper will upload all existing strings of your mod (both english and translations) to our crowdin project, and then will start continuous synchronization.

Motivation

There are a lot of Factorio mods hosted on GitHub. Most of them are translated using pull requests. I think that it is not very convenient (because it is not clear which strings are untranslated yet and also translators have to know how to use git). So I decide to create helper tool for configuring translation process on Crowdin, powerful localization platform.

Installation

1. Go to this GitHub app page
2. Click install button
3. Choose repository with your Factorio mod
4. Click install button

You are done! Now share link to this Crowdin project with translators

Please note that in order to correctly upload your existing translations to Crowdin, files in any localization folder (such as /locale/de) must have same names as files in /locale/en folder.

How to translate on Crowdin

We have single Crowdin project. It consists of several folders, each folder corresponds to one mod. So, here are instructions how to translate specific mod:

1. Go to Crowdin project page
2. Select language
3. Find folder with your mod
4. Open menu (click to three points) right of the folder name
5. Click "Translate"

Then Crowdin translation interface will be opened where you can translate strings.

Detailed description of how it works

1. Mod author has mod repository on GitHub
2. Mod author installs GitHub app (for mod repository)
3. Our service creates subdirectory in our Crowdin project and upload original english strings and existing translations into it
4. Every week our service takes translated strings from Crowdin and make commit to GitHub repository (if there are any changes)
5. Every time original (locale/en) strings are changed, our service changes appropriate strings on Crowdin

I am not sure if my helper is good (maybe you want that helper will create pull requests to your github repository instead of direct commits to master?), so any feedback would be greatly appreciated.