umamusu-translate

An overview of the full translation process.

For existing content you only wish to translate, TLC, or edit, skip to Translating.

Prerequisites

Needed:

• If you haven’t read the main readme, please check that first.
• Install dependencies
  • From project root: pip install -r src\requirements.txt
• If you want to contribute: fork the project on github and clone that fork to work in

Recommended:

• Git or a GUI client like GitHub Desktop
  • git comes with git-gui so you don’t need a separate client

Extracting text

• Open a shell in the project root (the umamusu-translate folder)
  • tip: type cmd in explorer’s address bar on windows when in said folder
• Run python src/extract.py -g <group> -id <id>
  • See id-structure.md for help choosing what to extract
• Files will be created in the translations folder

Translating

Manual

Open the files in a text editor or edit them on github and write the translations in the provided enText or enName fields. There is a script for names which you probably want to run first for QoL, see below. BlockIdx is sequential and can help you follow a route through choices.

“jpText”: “日本語”,
“enText”: “<tl goes here>”,

Don’t change anything else. It’s there so text can be put back in the right place. (Title can be translated for completion if you want but isn’t currently used.)
Unity Rich Text should be supported but I advice against adding custom markup at the current time.

For those unfamiliar; \n and \r\n are line breaks. Both essentially mean the same thing.
As you can see, the game uses both. It doesn’t seem to make a difference so just use \n.
If you see \\n please use that in your english text as well. It means the game expects to see the \n literally in the text, rather than it being turned into a linebreak immediately.

MTL using DeepL

• Install the deepl-translator.user.js script in your browser
  • This requires a userscript manager with menu support, like Violentmonkey
• Run python src\machinetl.py with any options you want (refer to main readme)
• Navigate your browser to deepl’s site
• Open the userscript menu and click Connect WebSocket
• If all is well translation will automatically start and the python script will exit when done
  • This will take some time. Press ctrl+c in your terminal to force quit. Progress will be saved per file.

Further processing

• When done with either method, run any extra processing on the file
  • python src\textprocess.py to apply some automatic formatting (line length in particular) and edits
    • This is run by the translation script (if you used that), but you can rerun it with custom settings if you like
    • Useful line length for vertical screens is ~43, and for horizontal ~63
  • python src\names.py -n <path/to/db-translate/data/uma-name.csv> to translate many names automatically

Finishing up

Use the import.py script to get your translations in the game. See the main readme or the scripts themselves for details.

Sharing

If you used git; commit your changes (in organized chunks) and make a Pull Request once all done.
If not; upload your new files somewhere and open an Issue. Or DM me on discord.