DazedTL/README.md

DazedMTLTool - A script that translates RPGMaker JSON files using ChatGPT API

Currently in development. Goal is to eventually have ChatGPT nicely translate all dialogue when given a specific file or list of files.

Currently Supported:

• RPGMaker MV & MZ
• CSV Files

Required:

• API Key: https://platform.openai.com/account/api-keys
• Organization Key: https://platform.openai.com/account/org-settings
• Python3: https://www.python.org/downloads/

Setup:

1. cd to the project folder and install the dependencies with pip install -r requirements.txt
2. Add your API key and Organization Key to a .env file. An example can be found in the repo.
3. Add a prompt.txt file using prompt.example as a template. (See ChatGPT Prompt Section)
4. Untranslated JSON files go in /files. Anything translated will end up in /translated
5. Run start.py script either with VSCode or by running python .\start.py in a CLI.

ChatGPT Prompt:

prompt.txt will decide what and how ChatGPT translates the text. This is where you can customize it's output. This is extremely useful for when ChatGPT gives you a translation that you don't want. You can use this to tell him what to do, give examples of how you want things translated, etc. The example included is what I use currently, but you should tailor it to the game you are trying to translate.

Note that the bigger the prompt, the more $ its going to cost to translate.

Troubleshooting Errors:

In its current state, you will very likely run into errors. There hasn't been enough testing with enough games to get it in a stable state. Often ChatGPT won't know how to translate something and will timeout. Currently the timeout is pretty long so the program may hang for a while. NEVER CLOSE THE PROGRAM FORCEFULLY unless you wish to lose your translation data, which might as well be you losing money.

If the ChatGPT times out or hits any other error, what has already been translated will always be saved as long as you let it fail on its own. The file will still be placed in /translated on success or fail. That way you don't have to worry about the program failing and you wasting money on bugs.

Common Errors:

ChatGPT timing out due to not knowing how to translate something

1. Go into ChatGPT Playground https://platform.openai.com/playground?mode=chat and enter the text it failed on. If it comes out clean, likely the prompt may just need some adjusting or the string may need to be formatted in some way.
2. Create an example for that specific text. At the bottom of prompt.txt are examples you can enter which will give the AI training data on how to translate. This pretty much works 100% of the time but the downside is it will make your prompt.txt file bigger and your translation more expensive.

ChatGPT randomly hangs

1. Unsure what causes this. I recommend you just let it fail on its own and give you the error message. The error handler will tell you what line of text threw the error and what error it received.

General Debugging:

You'll need VSCode or something similar:

See what text is being translated

• Place a breakpoint on this line return [response.choices[0].message.content, response.usage.total_tokens] and run the code in debugging mode. Everytime a request comes back you should be able to view the response object to see what text got translated and what the response was.

How I Translate Games

The goal of this section is to get you learnt and ready to translate the game of your choice. I'll be walking you through every step of my process so that you can get an idea of what I do to get things working. This will not go over setup, go do the setup steps at the top to make sure everything works.

A couple of requirements.

• VSCode (It's going to be be your main tool for running the scripts. When installing make sure you enable the context menu options)
• Python 3
• API Key
• PowerToys (Very useful for non-japanese speakers)

1. First download the repository. You can do this by just downloading the zip on the main page or using Git to clone it, either works.
2. Right click on the project folder and click Open with Code.

3. Here is where the magic happens. This will be your main workspace which you can use to do everything you need to MTL a game.

A breakdown of what all the different files are, this is important.

• /files - Where you place files that need to be translated.
• /translated - Where files go after they are translated.
• /scripts - ignore (This is old stuff and will be deleted soon)
• /src - The script files, the cogs of the machine, what creates the translation.
  • main.py - Responsible for determining what engine gets run based on user choices
  • rpgmakermvmz.py - Translation Script for the RPGMaker MV/MZ Engine.
  • rpgmakerace.py - Translation Script for the RPGMaker MV/MZ Engine. (WIP)
  • csvtl.py - Translation Script for CSV Files. Requires at least 2 columns to work.
  • textfile.py - Translation Script for Other game engines. (More of a custom script I change depending on the game)
• .env.example - An example env file. This gets renamed to .env and holds your PRIVATE API and Organization key. Do not EVER upload this information.
• RPGMakerEventCodes.info - Information on the various types of event codes in RPGMaker. More on this later.
• prompt.example - Holds an example prompt ChatGPT uses to determine what to do with text you give it. Change this as you please.
• requirements.txt - Used for setup, ignore.
• start.py - Used as a starting point for running the script. This is what you run to start everything up.

4. Now that you have an idea of what each file does, lets decide on a game to translate. For this guide I'm going to stick with a game I've done before to make things easy. Bounty Hunter Kyouka.

First lets analyze what type of game this is. It's made using RPGMaker MZ which is basically the same as MV. You can tell by the game.exe icon. The two main folders we care about for MTL purposes are data and js.

• data - Will have all the main text files where majority of stuff will need to be translated.
• js - Will have the scripts the game uses to run. This is how you can change certain things like the font, size of windows, etc.

Rule of thumb, always backup the game folder. When you mess something up its nice to be able to go back and reference the original files. It will also be helpful when something breaks to have something to fallback on.

5. So the first thing I always translate with a new game are the menus. To do this go into /data and find System.json. (Sort by name while you are at it too.) Copy this file, and place it in your project /files folder. Then open VSCode and look to see that its there. I like to translate things step by step. It will make it way easier to debug when things break.

6. Now we are ready to translate System.json. But wait, before you do a tip.

PRO TIP: Sometimes, you want to make sure that things are getting translated RIGHT before you invest into the translation. To do this, open up rpgmakermvmz.py in VSCode. There's a lot of code in here, ignore it and scroll all the way down until you find the function def translateGPT(t, history, fullPromptFlag):. This is what actually sends text to the API for translation.

• t - Text that is going to be translated
• history - Previously translated text OR context (Improves translation)
• fullPromptFlag - Decides whether to use prompt.txt (True) or to ignore it (False). Ignore this for now.

In order to check what is getting translated, click LEFT of the line number with the following text return [translatedText, tokens]

This tells the program "Hey, when you get to this line STOP everything and show me the goods.". We are going to use this to check text after it's translated. Now we can start the translation.

In VSCode Click Terminal > New Terminal to open up the terminal. Open up start.py by double clicking it. Then press F5 and select Python file to startup the program. Then in the tool select Translate and MV/MZ to start the translation. The tool will begin translating everything inside. As soon as it hits that line it will stop like so.

Couple of things to notice here.

• At the top right are your debug options. Press play to have the program continue, F5 also works.
• At the bottom left is your text thats being translated. t is the original text and translatedText is your translated text. This is how I QA to make sure translation looks good before I continue.

Anyway, if you are satisfied with the results, click the breakpoint again to remove it and press F5 to continue with the translation. You can add that breakpoing anywhere in the code at anytime, its very helpful for learning what does what.

7. Now that System.json is finished translating, I like to go through it and fix any obvious issues I see. It will be in /translated. Lets open it up in VSCode and take a look.

You can see that some things didn't translate. This happens sometimes as a safe guard when the API returns something that is clearly wrong. You can either manually fix these or adjust to prompt. I'm just going to manually fix them. Also notice Translation: and Translated Text: which we don't want. You can use CTRL+F to find how many instances of this issue we have and fix them.

8. After you fix everything, move System.json back to /files and add the breakpoint. This time add two like so.

This will ensure that no matter what translation pops up the program stops first so you can check it. return [t, response.usage.total_tokens] essentially runs IF the API returns some garbage. Our goal for rerunning System.json is to have it finish with a cost of 0.00 so that we know everything is translated.

As you can see that's exactly what I got when I tried running it again, which tells me there isn't anymore untranslated text in the file. This one is good to go and you can go ahead and copy it back to the /data folder in the game project. Restart the game by either closing it, or hitting F5 while it's open.

9. Tadah! Translated text. Baby Steps... Baby Steps... However notice that piece of text that isn't translated? That means that text is located somewhere other than System.json. We have to find it, but there are so many files... how are we supposed to find something like that? The easiest way to do this is using a Text Scanner like PowerToys.

Using this, we can simply use Windows+Shift+T to scan the text. But first, in your game folder, right click on the /data folder and click Open in VSCode. Then Click Search at the top left and now scan the text in the game. Paste that text into the search bar.

Uh oh, no results found means its not anywhere in data either. Usually that means there's only one other place it could be. Right click on the /js folder and open in VSCode. Follow the same steps.

2 results! Much better. Check them both to see which one is the culprit. Usually it's the one in plugins.js (Which holds the settings for all of the plugins in the game).

As you can see this is a custom menu option added by the plugin. Lets go ahead and translate that and see if it changes.

Yup! That did the trick. Now we can move onto the next one.

10. Starting the game, there are still a couple of menu options to translate. None of these are in System.json so they must be in /js. Go ahead and manually fix those using the same method as before. Since I've already done this game, I'm going to go ahead and skip this step.

11. Lets try doing list items. This means Actors, Armors, Classes, Enemies, Items, Skills, States, Weapons. No need to think to hard for these, move them out of the /data folder and into the files folder in the project. Then simply start the translation up like you did with System.json.

12. Once again repeat the process of checking for mistakes /translated, moving them back to /files, and trying to hit the goal of getting a 0 for every file. You can make whatever improvments you like to the prompts, you can find them scattered around in the different functions of the code. For example

Adjusting these when you get bad responses helps.