TranslationZed User Guide

Getting Started With TranslationZed

Hello there intrepid tester! Allow me to introduce the first version of TranslationZed, a rather bare bones translation tool that will hopefully aid in the task of translating Project Zomboid. The most important thing at this juncture, is that I don’t necessarily expect this tool to fully replace the workflow that you already use in translating. I would of course like it to, but at this point I am acutely aware of the fact that the tool is not perfect. I need information about how people use the tool, what things they want added, so be sure to let me know of any Quality of Life changes you would like in order to improve the tool.

First things first, boot up TranslationZed.exe to see what we have. First thing you will see is some GitHub information, that has been disabled in this version so you can ignore it for now.

From here you want to go to “File” and “Open” Navigate to the folder that lists all the languages for Project Zomboid. This may be in your media/lua/shared/Translate or if you downloaded the GitHub repo for translations, that will be wherever you placed the folder you downloaded. Click select folder.

Make sure you don’t open your own language folder, otherwise the program will fail to load! With this, the left box should now be populated with languages and you should be able to click on your language of choice. A popup will tell you if it successfully loaded, but the dashboard will not change much in information. I’m still trying to figure out what I want to do with the dashboard, so it’s in a bit of an unfinished state. Clicking on the Translate tab should show you the main thing you will be working with.

Icons to the left of files should tell you what has changed in the file. Only one icon will show up at any one time, but it doesn’t mean that other things haven’t changed. A green plus icon will indicate that translation strings have been added to the file. If the file didn’t exist in the directory, but a file was detected in the English Folder, it will automatically create a file in this view to be worked on.

A red cross indicates that a string has been removed from the English file, that should be reviewed. Keep in mind the program might not necessarily be right, so be wary if it indicates large number of Strings being removed. Since this will be the first time you booted up the program, there should be no removed strings warning. Now, this doesn’t mean that they haven’t been removed, but in order to track changes the English folder is cached in relation to the language folder you have opened. On first run, this file won’t exist and so will be generated based on the current state of English translations.

A pencil on paper indicates there has been modifications in the file. Again there shouldn’t be any in this instance due to the reasons stated above. Again though, it doesn’t mean there hasn’t been any.

Clicking on a file should populate the table.

You can change the size of each column by dragging the divider at the top between “Key” and “Value” this is more important in full screen mode, where you will most likely want to dedicate more space to the Value column. Double clicking on a value column field will allow you to edit the value. Make sure to hit the ENTER/RETURN key after editing, as clicking away from the cell will revert the value to what it was before.

Going to the bottom with the scrollbar will show some of the newly added strings in green. Modified will be orange and deleted strings will be red.

Once you have translated the String right click on the cell and click “Mark Resolved” Click on file and save will save the translation.

The program will endeavour only to save files that have had changes in them. Added strings will not be saved until they have been marked as resolved, so keep that in mind!

Remember this is an alpha version of a tool, so be sure to save regularly! The third tab allows you to generate full empty files for Items and Recipes since they are not included in the English files and so don’t get matched against for the language folders. It should be somewhat self explanatory, you can find recipe and item files in your media/scripts folder and can add the entire scripts folder and parse out the recipes and items or individually add files. Whatever you want to do.

If your files appear or save in corrupted characters, odds are it means the encoding is incorrect and needs to be changed. Go talk to Connall if you encounter any problems. Keep him in the loop on everything! Remember, provide copious amounts of feedback even if you think the tool sucks, say how it could be improved!