|
1 | | -# RU |
| 1 | +# rvpacker-json-txt |
2 | 2 |
|
3 | | -# Строение репозитория и использование программы |
| 3 | +[README на русском](https://github.com/savannstm/rpg-maker-translation-tools/blob/main/README-ru.md) |
4 | 4 |
|
5 | | -## Директория cli |
| 5 | +## General |
6 | 6 |
|
7 | | -В данной директории хранится бинарный файл `json-writer`, позволяющий парсить текст игр на движках RPG Maker MV/MZ, |
8 | | -а затем записывать его обратно в рабочие игровые .json файлы. |
| 7 | +This tool is designed to read RPG Maker game files into .txt files and write them back to .json. |
9 | 8 |
|
10 | | -Получить справку по его использованию можно с помощью `json-writer -h`. |
| 9 | +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. |
11 | 10 |
|
12 | | -В директории `ruby-writer` хранятся TypeScript файлы утилиты `ruby-writer`, позволяющей парсить текст игр на движках RPG Maker XP/VX/VX Ace, а затем записывать его обратно в рабочие игровые .rxdata, .rvdata или .rvdata2 файлы. |
| 11 | +This tool for RPG Maker XP, VX and VX Ace engines that don't use .json files can be found in [this repository](https://github.com/savannstm/rvpacker-txt). |
13 | 12 |
|
14 | | -Тип движка игры, текст которой парсится и записывается, утилита определяет автоматически. |
| 13 | +[A GUI](https://github.com/savannstm/rpgm-translation-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 .json with a single button click) (and it also supports RPG Maker XP, VX and VX Ace!) |
15 | 14 |
|
16 | | -Для использования, вам необходим [Bun](https://bun.sh/). После его установки, вам необходимо выполнить команду `bun i` для установки зависимостей утилиты, а затем вы можете получить справку по ней, используя `bun run ruby-writer.ts -h`. |
| 15 | +## Installation |
17 | 16 |
|
18 | | -## Директория gui |
| 17 | +You can download binary files in the Releases section. |
19 | 18 |
|
20 | | -В этой директории хранится исходный код новой версии программы, написанной на Tauri. |
| 19 | +Files with the .exe extension are designed for Windows of any architecture, while files without an extension are designed for Linux x64. |
21 | 20 |
|
22 | | -Сообщения об ошибках и коммиты приветствуются. |
| 21 | +## Usage |
23 | 22 |
|
24 | | -**Скачать последнюю версию можно из вкладки Releases.** |
| 23 | +You can get help on usage by calling `json-writer -h.` |
25 | 24 |
|
26 | | -### Билдинг приложения |
| 25 | +``` |
| 26 | +A tool that parses .json files of RPG Maker MV/MZ games into .txt files and vice versa. |
27 | 27 |
|
28 | | -Клонируйте репозиторий с помощью\ |
29 | | -`git clone https://github.com/savannstm/rpg-maker-translation-tools.git`. |
| 28 | +Usage: rvpacker-json-txt.exe [OPTIONS] [COMMAND] |
30 | 29 |
|
31 | | -Перейдите в директорию `gui` и установите все необходимые Node.js библиотеки с помощью\ |
32 | | -`npm install`. |
| 30 | +Commands: |
| 31 | + read Parses files from "original" or "data" folders of input directory to "translation" folder of output |
| 32 | + directory. |
| 33 | + write Writes translated files using original files from "original" or "data" folders of input directory and |
| 34 | + writes results to "output" folder of output directory. |
33 | 35 |
|
34 | | -Запустите\ |
35 | | -`npm run tauri dev`,\ |
36 | | -чтобы запустить приложение в девелопер режиме, либо\ |
37 | | -`npm run tauri build`,\ |
38 | | -чтобы забилдить приложение под вашу текущую ОС. |
| 36 | +Options: |
| 37 | + -i, --input-dir <INPUT_PATH> Input directory, containing folders "original" or "data" and "translation", with |
| 38 | + original game text and .txt files with translation respectively. |
| 39 | + -o, --output-dir <OUTPUT_PATH> Output directory, containing an "output" folder with folders "data" and "js", |
| 40 | + containing compiled .txt files with translation. |
| 41 | + -l, --language <LANGUAGE> Sets the localization of the tool to the selected language. Example: --language en. |
| 42 | + [Allowed values: ru, en] |
| 43 | + --log Enables logging. |
| 44 | + --disable-custom-parsing Disables built-in custom parsing for some games. |
| 45 | + -h, --help Prints the program's help message or for the entered subcommand. |
| 46 | +``` |
39 | 47 |
|
40 | | -Если вы хотите внести какие-то изменения в код проекта - вносите его в фронтенд файлы из директории `src`, либо бэкенд файлы из директории `src-tauri/src`. |
| 48 | +Examples: |
41 | 49 |
|
42 | | -После билдинга в директории `gui/src-tauri` появится директория `target`, содержащая бинарный файл с билдом программы и распространяемые пакеты в директории `target/bundle`. |
| 50 | +`rvpacker-json-txt read --input-dir "E:/Documents/RPGMakerGame"` parses the text of the game into the `translation` folder of the specified directory. |
43 | 51 |
|
44 | | -## Лицензия |
| 52 | +`rvpacker-json-txt write --input-dir E:/Documents/RPGMakerGame"` will write the translation from the \_trans files of the `translation` folder to .the json files to the `output` folder. |
45 | 53 |
|
46 | | -Репозиторий лицензирован под [WTFPL](http://www.wtfpl.net/). |
47 | | -Это означает, что вы можете безнаказанно использовать и модифицировать программу в каком угодно виде. Вы можете делать всё, что захотите. |
48 | | - |
49 | | -# EN |
50 | | - |
51 | | -# Repository order and program usage |
52 | | - |
53 | | -## cli Directory |
54 | | - |
55 | | -This directory contains a binary file `json-writer`, which allows you to parse the text of games on the RPG Maker MV/MZ engine, |
56 | | -and then write it back to the working game.json files. |
57 | | - |
58 | | -You can get help using it using `json-writer -h'. |
59 | | - |
60 | | -The `ruby-writer` directory stores TypeScript files of the `ruby-writer` utility, which allows you to parse the text of games on RPG Maker XP/VX/VX Ace engines, and then write it back to working game .rxdata, .rvdata or .rvdata2 files. |
61 | | - |
62 | | -The utility automatically determines the type of the game engine, the text of which is parsed and written. |
63 | | - |
64 | | -To use it, you need [Bun](https://bun.sh/). After installing it, you need to run the `bun i` command to install the utility's dependencies, and then you can get help on it using `bun run ruby-writer.ts -h`. |
65 | | - |
66 | | -## gui Directory |
67 | | - |
68 | | -This directory contains the source code of new program version, written with Tauri. |
69 | | - |
70 | | -Issues and commits are welcome. |
71 | | - |
72 | | -### Program manual building |
73 | | - |
74 | | -Clone the repository with\ |
75 | | -`git clone https://github.com/savannstm/rpg-maker-translation-tools.git`. |
76 | | - |
77 | | -cd to the `gui` directory and install all needed node.js dependencies with\ |
78 | | -`npm install`. |
79 | | - |
80 | | -Run\ |
81 | | -`npm run tauri dev`,\ |
82 | | -to run the program in dev mode, or\ |
83 | | -`npm run tauri build`,\ |
84 | | -to build the program for your current OS. |
85 | | - |
86 | | -If you want to make some edits to the source code - edit frontend files in `src` directory, or backend files in `src-tauri/src` directory. |
87 | | - |
88 | | -After the build, `target` directory will be created in the `gui/src-tauri` path, containing binary file with program build and distributable bundled packages in the `target/bundle` directory. |
| 54 | +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. |
89 | 55 |
|
90 | 56 | ## License |
91 | 57 |
|
|
0 commit comments