Skip to content

A CLI tool that allows you to parse RPG Maker MV/MZ games' text to .txt files and write them back

License

Notifications You must be signed in to change notification settings

savannstm/rvpacker-txt-rs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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.

The same deprecated tool, written in Ruby, can be found in this repository.

A GUI that allows comfortably edit parsed files (and it also automatically parses unparsed games when you select their folder) (and you also can easily write files back to their initial with a single button click).

Installation

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.

Usage

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.

Usage: rvpacker-txt-rs COMMAND [OPTIONS]

Commands:
  read
          Parses files from "original" or "data" ("Data") folders of input directory to "translation" folder of output
          directory.
  write
          Writes translated files using original files from "original" or "data" ("Data") folders of input directory and
          writes results to "output" folder of output directory.

Options:
  -i, --input-dir <INPUT_PATH>
          When reading: Input directory, containing folder "original" or "data" ("Data") with original game files.
          When writing: Input directory, containing folder "original" or "data" ("Data") with original game files, and
          folder "translation" with translation .txt files.
  -o, --output-dir <OUTPUT_PATH>
          When reading: Output directory, where a "translation" folder with translation .txt files will be created.
          When writing: Output directory, where an "output" folder with "data" ("Data") and/or "js" subfolders with game
          files with translated text from .txt files will be created.
      --disable-processing <FILENAMES>
          Skips processing specified files.
          Example: --disable-processing=maps,other,system.
          [Allowed values: maps, other, system, plugins]
  -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 flag will
          automatically be used when writing if you parsed game text with it.
      --disable-custom-processing
          Disables built-in custom processing, implemented for some games. This flag will automatically be used when
          writing if you parsed game text with it.
  -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 --input-dir "E:/Documents/RPGMakerGame" parses the text of the game into the translation folder of the specified directory.

rvpacker-txt-rs write --input-dir "E:/Documents/RPGMakerGame" will write the translation from the _trans files of the translation folder to compatible files in the output folder.

The tool does not parse text from a plugins.js file since it is very difficult to isolate the text displayed in the game from the plugins.

License

The repository is licensed under WTFPL. This means that you can use and modify the program in any way. You can do what the fuck you want to.