Skip to content

RPG-Maker-Translation-Tools/rvpacker-txt-rs

Repository files navigation

rvpacker-txt-rs

README на русском

General

This tool is designed to read RPG Maker game files into .txt files and write them back to their initial form.

This tool inherits its name from the original rvpacker tool, which was created for those versions of RPG Maker that did not use .json files, and parsed files into YAML. Now, rvpacker's repository is deleted.

The same deprecated tool, written in Ruby, can be found in rvpacker-txt repository.

There's a GUI, that allows you comfortably edit files. An underlying library for this CLI can be found here.

The format of output files

rvpacker-txt-rs parses all the original text from the game's files, and inserts it on each new line of a text file. All line breaks (new lines, \n) are replaced by \# symbols. At the end of each original line, <#> is inserted. This is a delimiter after which translated text should start. Removing it or erasing one of its symbols will lead to crashes, or worse, undefined behavior. So remember: your translated text goes after the <#> delimiter.

For an example on how to properly translate the .txt files, refer to My Fear & Hunger 2: Termina Russian translation. Translation is Russian, but the point is to get how to properly translate this program's translation files.

Installation

You can download executable for your system in Releases section.

Usage

You can get help on usage by calling rvpacker-txt-rs -h.

Examples:

rvpacker-txt-rs read -i "C:/Game" parses the text of the game into the translation folder of the specified directory.

rvpacker-txt-rs write -i "C:/Game" writes the translation from .txt files of the translation folder to RPG Maker files in the output folder.

License

The repository is licensed under WTFPL.