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.
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.
You can download binary files in the Releases section.
Files with the .exe extension are designed for Windows x64, while files without an extension are designed for Linux x64.
You can get help on usage by calling rvpacker-txt-rs -h.
This tool allows to parse RPG Maker XP/VX/VXAce/MV/MZ games text to .txt files and write them back to their initial
form. The program will always use "original" or "data" directories for original files, and "translation" directory to
operate with translation files. It will also decrypt any .rgss encrypted archive if it's present.
Usage: rvpacker-txt-rs COMMAND [OPTIONS]
Commands:
read
Parses game files, and decrypts .rgss archive if it's present.
write
Writes translated game files to the "output" directory.
purge
Purges lines from ".txt" translation files.
json
Provides the commands for JSON generation and writing.
Options:
-i, --input-dir <INPUT_PATH>
Input directory, containing game files.
-o, --output-dir <OUTPUT_PATH>
Output directory to output files to.
--disable-processing <FILES>
Skips processing specified files. plugins can be used interchangeably with scripts.
Example: --disable-processing=maps,other,system
[Allowed values: maps, other, system, plugins, scripts]
[Aliases: no]
-r, --romanize
If you parsing text from a Japanese game, that contains symbols like 「」, which are just the Japanese quotation
marks, it automatically replaces these symbols by their roman equivalents (in this case, '').
This argument will automatically be set on write/read with --mode append/purge commands if you parsed game
text with it.
-v, --version
Show program's version.
--disable-custom-processing
Disables built-in custom processing, implemented for some games.
This argument will automatically be set on write/read with --mode append/purge commands if you parsed game
text with it.
[Aliases: no-custom]
-l, --language <LANGUAGE>
Sets the localization of the tool to the selected language.
Example: --language en
[Allowed values: en, ru]
--log
Enables logging.
-h, --help
Prints the program's help message or for the entered subcommand.
Examples:
rvpacker-txt-rs read -i "E:/Documents/RPGMakerGame" parses the text of the game into the translation folder of the specified directory.
rvpacker-txt-rs write -i "E:/Documents/RPGMakerGame" writes the translation from .txt files of the translation folder to RPG Maker files in the output folder.
The repository is licensed under WTFPL.