tienducle/sv-i18n-translator

SV i18n Translator

This project was created to translate large i18n files of Stardew Valley mods to german.

I've used it to create translations for Stardew Valley Expanded and Ridgeside Village.

The tool is meant to be used as a dev tool by mod creators. It still has some rough edges and may or may not work for you.

⚠️ Disclaimer ⚠️

In any case, as with every content created using LLM/GPT, you should always double-check the results. They're often "good enough" but by no means perfect.

Features

• Automatically synchronizes added/removed keys of source file to target file
• Retains formatting of source file
• Configurable validations
  • Checks for dialogue control sequences (see src/main/resources/validation/stardewvalley.json)
• Uses OpenAI API for translations
  • Currently uses simple zero-shot prompting
  • If a validation fails, it will retry with higher temperature
• Preliminary support for Ollama (via Rest API) and DeepL API
  • Initial results were not satisfying, this would need more work

Usage

Requirements

• JDK >11
• Maven 3.x
• OpenAI API key

Run using scripts

Clone repository or download repository as zip. A jar file is included under /target/sv-i18n-translator.jar.

The bundled scripts are configured to translate the input text to german using OpenAI API (gpt-4-turbo-preview). Therefore, you must obtain an API key first. Since OpenAI switch to a prepaid model, you may need to charge your account first.

The system message can be found and modified in the translate.sh script.

cd scripts/stardewvalley

Sync

This will synchronize the keys of the source file to the target file.

New keys will be added to the target file and keys that are not present in the source file will be removed from the target file.

# Usage:
# ./sync.sh "/path/to/source/default.json" "Language"

./sync.sh "../../src/test/resources/data/text/default.json" "German"

Example

In the example below, the sync step is executed. Since the target file doesn't exist yet, all keys are considered "<MISSING>".

Translate

This will translate the target file using the OpenAI API.

The OpenAI API key must be additionally provided here.

# Usage (with Open AI API key set as environment variable):
# ./translate.sh "/path/to/source/default.json" "Language"

export OPEN_AI_API_KEY="sk-..."
./translate.sh "../../src/test/resources/data/text/default.json" "German"

# Usage (with Open AI API key as 3rd parameter):
# ./translate.sh "/path/to/source/default.json" "Language" "Open AI API Key"

./translate.sh "../../src/test/resources/data/text/default.json" "German" "sk-..."

Example

In the example below, the translate step is executed. All keys that are tagged with <ERROR> or <MISSING> are picked up for translation.

Revalidate

This will revalidate the target file with the current validation configuration.

Use this, if the code or the validation configuration has changed. If a translation is not accepted by the current validation anymore, it will be tagged with and will be picked up during translation again.

# Usage:
# ./revalidate.sh "/path/to/source/default.json" "Language"

./revalidate.sh "../../src/test/resources/data/text/default.json" "German"

Reformat

This will reformat the target file to match the source file.

# Usage:
# ./reformat.sh "/path/to/source/default.json" "Language"

./reformat.sh "../../src/test/resources/data/text/default.json" "German"