R3EXS 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de2534679ea7494f92b68a8a2c2cb9c891fad4aa9eb4f6944bcf17df32eaf007
+  data.tar.gz: 17c75c67f0480d827ff5ad1793719055393cecca2b8c254f9ba2e2e2a28ddd75
+SHA512:
+  metadata.gz: 8b7d2535642547ebcebc92cb04588453712b60dfb4ae2f1d82240758b522909fcb562928c50790a9629be99bb6651e60d9c338c986de6343f2bb6d4eaf216a3b
+  data.tar.gz: 13bac017d05e9ff48326045d31d90ddec86b6ea964f5e250833bda5a99f7c9088c6fcbbe887f7e877b531885061185a6952aec65d99bcb79a09c9541eeb0e472

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 LuoTat
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,260 @@
+# R3EXS
+
+RGSS3_Extract_Strings_Tool
+
+<p style="text-align: center;">一个用来提取和翻译 RGSS3 游戏引擎的字符串的工具</p>
+
+[**简体中文**](README.md)&nbsp;&nbsp;&nbsp;[**English**](README_EN.md)
+
+## 目录
+
+-   [简介](#简介)
+-   [特点](#特点)
+-   [功能列表](#功能列表)
+-   [安装方法](#安装方法)
+-   [使用方法](#使用方法)
+-   [项目构建](#项目构建)
+-   [项目文档](#项目文档)
+-   [友情链接](#友情链接)
+
+## [简介](#目录)
+
+R3EXS 是一个基于 Ruby 语言，用来提取和翻译 RGSS3 游戏里字符串的 gem
+
+## [特点](#目录)
+
+使用 [Prism](https://github.com/ruby/prism) 实现了对 Ruby 脚本中的字符串和符号的精准提取
+
+## [功能列表](#目录)
+
+1. [解包 Game.rgss3a 文件](#解包-Game.rgss3a-文件)
+2. [序列化 rvdata2 文件为 json 格式](#序列化-rvdata2-文件为-json-格式)
+3. [反序列化 json 文件为 rvdata2 格式](#反序列化-json-文件为-rvdata2-格式)
+4. [提取所有的字符串](#提取所有的字符串)
+5. [注入所有的字符串](#注入所有的字符串)
+
+## [安装方法](#目录)
+
+### 使用 RubyGems 安装
+
+1. 安装 [Ruby](https://www.ruby-lang.org/zh_cn/) (要附带安装 Devkit 来支持编译 C 扩展)
+2. 安装 [R3EXS](https://rubygems.org/gems/r3exs) gem
+
+```bash
+gem install R3EXS
+```
+
+### 直接下载 exe 可执行文件
+
+点击下载 [R3EXS.exe](https://github.com/LuoTat/R3EXS/releases)
+
+使用 [Ocran](https://github.com/Largo/ocran) 和 [Tebako](https://github.com/tamatebako/tebako) 两个打包工具
+
+`Windows` 环境提供 `R3EXS_Ocran` 和 `R3EXS_Tebako`
+
+`Linux (GLIBC>=2.31)` 环境提供 `R3EXS_Tebako`
+
+在首次运行时会解压 Ruby 环境，所以首次运行会比较慢
+
+## [使用方法](#目录)
+
+以下代码均假设在游戏根目录下运行，确保 `./Game.rgss3a` 文件存在，或者已经解包到 `./Data` 文件夹下
+
+~~如果你喜欢疯狂输出的控制台或者觉得运行太快~~，请开启 `--verbose` 选项
+
+### [解包 Game.rgss3a 文件](#功能列表)
+
+```bash
+NAME
+    decrypt - 解码 Game.rgss3a 文件
+
+SYNOPSIS
+
+    R3EXS [global options] decrypt [command options] <Game.rgss3a file path>
+
+COMMAND OPTIONS
+    -o, --output_dir=DIRECTORY -  *.rvdata2 文件的输出目录 (默认: ./)
+```
+
+示例代码
+
+```bash
+R3EXS decrypt ./Game.rgss3a
+```
+
+### [序列化 rvdata2 文件为 json 格式](#功能列表)
+
+```bash
+NAME
+    rvdata2_json - 将 rvdata2 文件序列化为 json 格式
+
+SYNOPSIS
+
+    R3EXS [global options] rvdata2_json [command options] <the *.rvdata2 dir>
+
+COMMAND OPTIONS
+    -c, --[no-]complete        - 开启完全序列化
+    -n, --[no-]with_notes      - 开启注释序列化
+    -o, --output_dir=DIRECTORY - *.json 文件的输出目录 (默认: ./JSON)
+    -s, --[no-]with_scripts    - 开启 Scripts 脚本序列化
+```
+
+示例代码
+
+```bash
+// 只序列化可翻译部分
+R3EXS rvdata2_json ./Data
+
+// 完全序列化
+R3EXS rvdata2_json -c ./Data
+```
+
+### [反序列化 json 文件为 rvdata2 格式](#功能列表)
+
+```bash
+NAME
+    json_rvdata2 - 将 json 文件反序列化为 rvdata2 文件
+
+SYNOPSIS
+
+    R3EXS [global options] json_rvdata2 [command options] <the *.json dir>
+
+COMMAND OPTIONS
+    -c, --[no-]complete          - 开启完全反序列化
+    -o, --output_dir=DIRECTORY   - 新的 *.rvdata2 文件的输出路径 (默认: ./Data_NEW)
+    -r, --original_dir=DIRECTORY - 原始的 *.rvdata2 文件路径 (默认: ./Data)
+    -s, --[no-]with_scripts      - 开启 Scripts 脚本反序列化
+```
+
+示例代码
+
+```bash
+// 如果在 rvdata2_json 时没有开启 --complete 选项
+// 则必须提供 --original_dir 或是当前目录下存在 ./Data 文件夹
+R3EXS json_rvdata2 ./JSON
+
+// 如果在 rvdata2_json 时开启 --complete 选项
+// 则不需要提供 --original_dir 选项
+R3EXS json_rvdata2 -c ./JSON
+```
+
+### [提取所有的字符串](#功能列表)
+
+```bash
+NAME
+    ex_strings - 提取所有的字符串
+
+SYNOPSIS
+
+    R3EXS [global options] ex_strings [command options] <the *.json dir>
+
+COMMAND OPTIONS
+    -o, --output_dir=DIRECTORY       - ManualTransFile.json 或 ManualTransFile_scripts.json 文件的输出目录 (默认: ./)
+    -p, --[no-]with_scripts_separate - 开启 Scripts 脚本单独提取到 ManualTransFile_scripts.json 文件
+    -s, --[no-]with_scripts          - 开启 Scripts 脚本提取
+    -y, --[no-]with_symbol           - 开启 Scripts 脚本中的 Symbol 提取
+```
+
+示例代码
+
+```bash
+// 不提取 Scripts 脚本
+R3EXS ex_strings ./JSON
+
+// 提取 Scripts 脚本
+R3EXS ex_strings -s ./JSON
+
+// 提取 Scripts 脚本并单独提取到 ManualTransFile_scripts.json 文件
+R3EXS ex_strings -s -p ./JSON
+```
+
+### [注入所有的字符串](#功能列表)
+
+```bash
+NAME
+    in_strings - 注入所有的字符串
+
+SYNOPSIS
+
+    R3EXS [global options] in_strings [command options] <the *.json dir>
+
+COMMAND OPTIONS
+    -m, --manualtransfile_path=FILE - ManualTransFile.json 文件路径 (默认: ./ManualTransFile.json)
+    -o, --output_dir=DIRECTORY      - 新的 *.json 文件的输出目录 (默认: ./JSON_NEW)
+    -s, --[no-]with_scripts         - 开启 Scripts 脚本注入
+```
+
+示例代码
+
+```bash
+// 不注入到 Scripts 脚本
+R3EXS in_strings ./JSON
+
+// 注入到 Scripts 脚本
+R3EXS in_strings -s ./JSON
+```
+
+---
+
+想要获取更多帮助，使用
+
+```bash
+R3EXS help
+```
+
+## [项目构建](#目录)
+
+如果想要构建项目并运行，首先克隆整个项目
+
+```bash
+git clone git@github.com:LuoTat/R3EXS.git
+```
+
+然后使用 `bundle` 安装依赖
+
+```bash
+bundle install
+```
+
+最后编译 C 扩展即可
+
+```bash
+rake compile
+```
+
+---
+
+构建本地文档
+
+```bash
+yardoc
+```
+
+构建 `R3EXS_Ocran.exe` 可执行文件
+
+```bash
+rake ocran
+```
+
+查看所有 rake 任务
+
+```bash
+rake -T
+```
+
+## [项目文档](#目录)
+
+[R3EXS Api 文档](https://rubydoc.info/gems/R3EXS)
+
+## [友情链接](#目录)
+
+-   [oj](https://github.com/ohler55/oj)
+-   [gli](https://github.com/davetron5000/gli)
+-   [Prism](https://github.com/ruby/prism)
+-   [Ocran](https://github.com/Largo/ocran)
+-   [Tebako](https://github.com/tamatebako/tebako)
+-   [RGSS3](https://github.com/taroxd/RGSS3)
+-   [rvdata2json](https://github.com/DICE2000/rvdata2json)
+-   [VX-Ace-Translator](https://github.com/AhmedAhmedEG/VX-Ace-Translator)
+-   [RPGMakerDecrypter](https://github.com/uuksu/RPGMakerDecrypter)
+-   [RPGMaker VX Ace F1-Manual](https://miaowm5.github.io/RMVA-F1)

data/README_EN.md

@@ -0,0 +1,260 @@
+# R3EXS
+
+RGSS3_Extract_Strings_Tool
+
+<p style="text-align: center;">A tool for extracting and translating strings from the RGSS3 game engine.</p>
+
+[**English**](README_EN.md)&nbsp;&nbsp;&nbsp;[**简体中文**](README.md)
+
+## Contents
+
+-   [Synopsis](#synopsis)
+-   [Features](#features)
+-   [Function List](#function-list)
+-   [Installation](#installation)
+-   [Usage](#usage)
+-   [Project Build](#project-build)
+-   [Documentation](#documentation)
+-   [Links](#links)
+
+## [Synopsis](#contents)
+
+R3EXS is a gem built using Ruby, designed to extract and translate strings in RGSS3 games.
+
+## [Features](#contents)
+
+It uses [Prism](https://github.com/ruby/prism) to accurately extract strings and symbols from Ruby scripts.
+
+## [Function List](#contents)
+
+1. [Unpack Game.rgss3a file](#unpack-game-rgss3a-file)
+2. [Serialize rvdata2 files to JSON file](#serialize-rvdata2-files-to-json-file)
+3. [Deserialize JSON files to rvdata2 file](#deserialize-json-files-to-rvdata2-file)
+4. [Extract all strings](#extract-all-strings)
+5. [Inject all strings](#inject-all-strings)
+
+## [Installation](#contents)
+
+### Install using RubyGems
+
+1. Install [Ruby](https://www.ruby-lang.org/en/) (make sure to install Devkit to support compiling C extensions)
+2. Install the [R3EXS](https://rubygems.org/gems/r3exs) gem
+
+```bash
+gem install R3EXS
+```
+
+### Download executable file directly
+
+Click to download [R3EXS.exe](https://github.com/LuoTat/R3EXS/releases)
+
+Since the R3EXS.exe file is packaged using [Ocran](https://github.com/Largo/ocran) and [Tebako](https://github.com/tamatebako/tebako)
+
+The `Windows` environment provides `R3EXS_Ocran` and `R3EXS_Tebako`
+
+The `Linux (GLIBC >= 2.31)` environment provides `R3EXS_Tebako`
+
+it will extract the Ruby environment the first time it runs, so the first run may be slower.
+
+## [Usage](#contents)
+
+The following commands assume they are run in the game’s root directory, ensuring the `./Game.rgss3a` file exists or has already been unpacked into the `./Data` folder.
+
+~~If you enjoy a crazy amount of console output or feel like the execution is too fast~~, please enable the `--verbose` option.
+
+### [Unpack Game.rgss3a file](#function-list)
+
+```bash
+NAME
+    decrypt - Decrypt the Game.rgss3a file
+
+SYNOPSIS
+
+    R3EXS [global options] decrypt [command options] <Game.rgss3a file path>
+
+COMMAND OPTIONS
+    -o, --output_dir=DIRECTORY - The *.rvdata2 output dir (default: ./)
+```
+
+Example code:
+
+```bash
+R3EXS decrypt ./Game.rgss3a
+```
+
+### [Serialize rvdata2 files to JSON file](#function-list)
+
+```bash
+NAME
+    rvdata2_json - Serialize rvdata2 files into JSON
+
+SYNOPSIS
+
+    R3EXS [global options] rvdata2_json [command options] <the *.rvdata2 dir>
+
+COMMAND OPTIONS
+    -c, --[no-]complete        - Enable complete serialization
+    -n, --[no-]with_notes      - Enable notes attribute serialization
+    -o, --output_dir=DIRECTORY - The *.json output dir (default: ./JSON)
+    -s, --[no-]with_scripts    - Enable Scripts.rvdata2 serialization
+```
+
+Example code:
+
+```bash
+// Serialize only translatable parts
+R3EXS rvdata2_json ./Data
+
+// Complete serialization
+R3EXS rvdata2_json -c ./Data
+```
+
+### [Deserialize JSON files to rvdata2 file](#function-list)
+
+```bash
+NAME
+    json_rvdata2 - Deserialize JSON files back into rvdata2
+
+SYNOPSIS
+
+    R3EXS [global options] json_rvdata2 [command options] <the *.json dir>
+
+COMMAND OPTIONS
+    -c, --[no-]complete          - Enable complete deserialization
+    -o, --output_dir=DIRECTORY   - The NEW *.rvdata2 output dir (default: ./Data_NEW)
+    -r, --original_dir=DIRECTORY - The ORIGINAL *.rvdata2 dir (default: ./Data)
+    -s, --[no-]with_scripts      - Enable Scripts JSON deserialization
+```
+
+Example code:
+
+```bash
+// If --complete was not enabled in rvdata2_json
+// Provide --original_dir or ensure ./Data folder exists in the current directory
+R3EXS json_rvdata2 ./JSON
+
+// If --complete was enabled in rvdata2_json
+// --original_dir is not required
+R3EXS json_rvdata2 -c ./JSON
+```
+
+### [Extract all strings](#function-list)
+
+```bash
+NAME
+    ex_strings - Extract all strings
+
+SYNOPSIS
+
+    R3EXS [global options] ex_strings [command options] <the *.json dir>
+
+COMMAND OPTIONS
+    -o, --output_dir=DIRECTORY       - The ManualTransFile.json or ManualTransFile_scripts.json output dir (default: ./)
+    -p, --[no-]with_scripts_separate - Enable Scripts extraction into a separate ManualTransFile_scripts.json
+    -s, --[no-]with_scripts          - Enable Scripts extraction
+    -y, --[no-]with_symbol           - Enable Symbol extraction in Scripts extraction
+```
+
+Example code:
+
+```bash
+// Do not extract Scripts
+R3EXS ex_strings ./JSON
+
+// Extract Scripts
+R3EXS ex_strings -s ./JSON
+
+// Extract Scripts and separate them into ManualTransFile_scripts.json
+R3EXS ex_strings -s -p ./JSON
+```
+
+### [Inject all strings](#function-list)
+
+```bash
+NAME
+    in_strings - Inject all strings
+
+SYNOPSIS
+
+    R3EXS [global options] in_strings [command options] <the *.json dir>
+
+COMMAND OPTIONS
+    -m, --manualtransfile_path=FILE - The ManualTransFile.json path (default: ./ManualTransFile.json)
+    -o, --output_dir=DIRECTORY      - The NEW *.json output dir (default: ./JSON_NEW)
+    -s, --[no-]with_scripts         - Enable Scripts Injection
+```
+
+Example code:
+
+```bash
+// Do not inject into Scripts
+R3EXS in_strings ./JSON
+
+// Inject into Scripts
+R3EXS in_strings -s ./JSON
+```
+
+---
+
+For more information, use
+
+```bash
+R3EXS help
+```
+
+## [Project Build](#contents)
+
+To build and run the project, first clone the entire repository:
+
+```bash
+git clone git@github.com:LuoTat/R3EXS.git
+```
+
+Then use `bundle` to install dependencies:
+
+```bash
+bundle install
+```
+
+Finally, compile the C extension:
+
+```bash
+rake compile
+```
+
+---
+
+Build the local documentation:
+
+```bash
+yardoc
+```
+
+Build the `R3EXS_Ocran.exe` file:
+
+```bash
+rake ocran
+```
+
+View all rake tasks:
+
+```bash
+rake -T
+```
+
+## [Documentation](#contents)
+
+[R3EXS Api Documentation](https://rubydoc.info/gems/R3EXS)
+
+## [Links](#contents)
+
+-   [oj](https://github.com/ohler55/oj)
+-   [gli](https://github.com/davetron5000/gli)
+-   [Prism](https://github.com/ruby/prism)
+-   [Ocran](https://github.com/Largo/ocran)
+-   [Tebako](https://github.com/tamatebako/tebako)
+-   [RGSS3](https://github.com/taroxd/RGSS3)
+-   [rvdata2json](https://github.com/DICE2000/rvdata2json)
+-   [VX-Ace-Translator](https://github.com/AhmedAhmedEG/VX-Ace-Translator)
+-   [RPGMakerDecrypter](https://github.com/uuksu/RPGMakerDecrypter)
+-   [RPGMaker VX Ace F1-Manual](https://miaowm5.github.io/RMVA-F1)