Description

This is a tool for extracting RPG(Role Playing Game) related data that has .rxdata, .rvdata, .json and .js ext. The structure is extensible as you can add your 'processer' to src/processers.

Environment

The tool need Python and Ruby installed.

Version requirements:

• Python >= 3.12.9
• Ruby >= 3.4.5

Usage

• Pull down submodules first:

bash ./submodule_clear_cache.sh && bash ./submodule_init.sh && bash ./submodule_update.sh

Config file

bash ./init_dev_env.sh # prepare environment for script to run
# edit config.json to set the game data you want to extract from
python ./run.py

Command line arguments

# prepare environment for script to run
bash ./init_dev_env.sh
# command to extract data
python ./run.py --extract --dataFolder <path_of_folder_contains_data_file> --outputFolder <destination_the_extraction_files_will_put> --title [just_write_your_games_title] --format
# command to inject data
python ./run.py --inject --dataFolder <path_of_folder_contains_extracted_data_file> --outputFolder <destination_the_injection_files_will_put> --trFolder <path_of_folder_contains_translated_data_file> --title [just_write_your_games_title]

Note: Command line arguments' priority is higher than config file.

3. GUI

Under construction

Get process result online

Go to Actions - Test extractor function, click latest workflow and get extraction file.

Supported game data file type

• Rxdata

• Rvdata

• Json

• Plugins with .js ext

Todo

• Multi-threaded file-writing

• Decode Scripts.rxdata

• Merge my another format module into this

• Command line

• Make reader module more extensible to support other format like json

• Auto guessing the main file type under the set path

• Support cli arguments, see argParser.py

• Github actions to generate artifacts of extraction files

• Inject translation data back to .rxdata files

  • Implement rgss tool caller in Python

  • Use rgss tool convert rxdata file into yaml file

  • Convert yaml file to single json file to translate using AiNiee

  • Use translation json file as dictionary to replace original content in yaml file

  • Use rgss tool convert yaml file back to rxdata file

• GUI

• Parse Scripts.rxdata

• Recognizing illegal words and phrases