savannstm / rpg-maker-translation-tools

Репозиторий с инструментами, позволяющими редактировать текст RPG Maker VX/MV/VXAce и компилировать его в обратно в оригинальные файлы

RU

Строение репозитория и использование программы

Директория cli

В данной директории хранится бинарный файл json-writer, позволяющий парсить текст игр на движках RPG Maker MV/MZ, а затем записывать его обратно в рабочие игровые .json файлы.

Получить справку по его использованию можно с помощью json-writer -h.

В директории ruby-writer хранятся TypeScript файлы утилиты ruby-writer, позволяющей парсить текст игр на движках RPG Maker XP/VX/VX Ace, а затем записывать его обратно в рабочие игровые .rxdata, .rvdata или .rvdata2 файлы.

Тип движка игры, текст которой парсится и записывается, утилита определяет автоматически.

Для использования, вам необходим Bun. После его установки, вам необходимо выполнить команду bun i для установки зависимостей утилиты, а затем вы можете получить справку по ней, используя bun run ruby-writer.ts -h.

Директория gui

В этой директории хранится исходный код новой версии программы, написанной на Tauri.

Сообщения об ошибках и коммиты приветствуются.

Скачать последнюю версию можно из вкладки Releases.

Билдинг приложения

Клонируйте репозиторий с помощью
git clone https://github.com/savannstm/rpg-maker-translation-tools.git.

Перейдите в директорию gui и установите все необходимые Node.js библиотеки с помощью
npm install.

Запустите
npm run tauri dev,
чтобы запустить приложение в девелопер режиме, либо
npm run tauri build,
чтобы забилдить приложение под вашу текущую ОС.

Если вы хотите внести какие-то изменения в код проекта - вносите его в фронтенд файлы из директории src, либо бэкенд файлы из директории src-tauri/src.

После билдинга в директории gui/src-tauri появится директория target, содержащая бинарный файл с билдом программы и распространяемые пакеты в директории target/bundle.

EN

Repository order and program usage

cli Directory

This directory contains a binary file json-writer, which allows you to parse the text of games on the RPG Maker MV/MZ engine, and then write it back to the working game.json files.

You can get help using it using `json-writer -h'.

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.

The utility automatically determines the type of the game engine, the text of which is parsed and written.

To use it, you need Bun. 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.

gui Directory

This directory contains the source code of new program version, written with Tauri.

Issues and commits are welcome.

Program manual building

Clone the repository with
git clone https://github.com/savannstm/rpg-maker-translation-tools.git.

cd to the gui directory and install all needed node.js dependencies with
npm install.

Run
npm run tauri dev,
to run the program in dev mode, or
npm run tauri build,
to build the program for your current OS.

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.

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.

rpg-maker-translation-tools's Issues

Добавление редактора тем в GUI-программу

Связан ли ваш запрос с проблемой? Пожалуйста, опишите.
Недостаток тем и невозможность создания собственных.

Опишите решение, которое вы хотели бы получить
Простой редактор тем с понятным интерфейсом, способный предпоказывать темы.

Опишите альтернативы, которые вы рассматривали
Никаких.

Дополнительный контекст
Никакого.

Добавить в GUI-программу возможность открывать папки с играми, текст которых не был предварительно распарсен CLI-инструментом

Связан ли ваш запрос с проблемой? Пожалуйста, опишите.
Необходимость использовать CLI-инструмент для того, чтобы распарсить файлы той или иной игры перед их редактированием в GUI-программе.

Опишите решение, которое вы хотели бы получить
При открытии папок с помощью GUI-программы, она проверяет, есть ли в папке директория original. Если нет, то она ищет директорию data, из которой парсит файлы игры, а затем открывает их в программе.

Опишите альтернативы, которые вы рассматривали
Никаких.

Дополнительный контекст
Никакого.

CLI-инструмент не парсит названия карт в файл names

Опишите ошибку
При чтении .json файлов с опцией read, CLI-инструмент НЕ парсит названия карт в файл names.txt.

Для воспроизведения
Прочитать .json файлы maps с помощью CLI-инструмента с опцией read.

Ожидаемое поведение
Вывод файла names.txt.

Скриншоты
Не нужны.

Дополнительный контекст
Никакого.

Убрать необходимость перезагружать GUI-программу для смены языка

Связан ли ваш запрос с проблемой? Пожалуйста, опишите.
При смене языка, необходимо сохранять прогресс и перезагружать программу. Это раздражает.

Опишите решение, которое вы хотели бы получить
Мгновенная смена языка.

Опишите альтернативы, которые вы рассматривали
Никаких.

Дополнительный контекст
Никакого.

Неверная локализация CLI-инструмента при использовании любой локали, кроме английской

Опишите ошибку
При использовании CLI-инструмента, его локализация частично остаётся на английском языке.

Для воспроизведения
Запустить CLI-инструмент используя систему с русской локалью, и ввести флаг -h.

Ожидаемое поведение
Полная русская локализация инструмента.

Скриншоты
Не нуждаются.

Окружение (пожалуйста, заполните следующую информацию):
Не нуждается.

Дополнительный контекст
Никакого.

Улучшить документацию кода CLI-инструмента

Связан ли ваш запрос с проблемой? Пожалуйста, опишите.
Недостаток документации кода CLI-инструмента; отсутствие комментирования неинтуитивных частей кода.

Опишите решение, которое вы хотели бы получить
Комментирование неинтуитивных частей кода.

Опишите альтернативы, которые вы рассматривали
Никаких.

Дополнительный контекст
Никакого.

Добавить возможность открывать папки с файлами перевода в GUI-программу

Связан ли ваш запрос с проблемой? Пожалуйста, опишите.
Невозможность работать над несколькими проектами в GUI-программы, путём открывания разных папок с файлами перевода.

Опишите решение, которое вы хотели бы получить
Добавить функцию по открыванию папок с файлами в GUI-программе.

Опишите альтернативы, которые вы рассматривали
Никаких.

Дополнительный контекст
Никакого.

Добавить аргумент --language в CLI-инструмент

Связан ли ваш запрос с проблемой? Пожалуйста, опишите.
Нехватка аргумента --language, который будет задавать язык локализации CLI-инструмента.

Опишите решение, которое вы хотели бы получить
Добавить в CLI-инструмент аргумент --language, меняющий его локализацию на основе заданного языка.

Опишите альтернативы, которые вы рассматривали
Никаких.

Дополнительный контекст
Таким образом, было бы намного легче пользоваться инструментом на желаемом языке и отлаживать его.

Добавить возможность компиляции RPG Maker XP/VX/VXAce в GUI-программу

Связан ли ваш запрос с проблемой? Пожалуйста, опишите.
Невозможность записывать файлы вышеназванных движков в GUI-программе, и необходимость использовать CLI для этой цели.

Опишите решение, которое вы хотели бы получить
Рабочую компиляцию вышеназванных движков в GUI-программе.

Опишите альтернативы, которые вы рассматривали
Никаких.

Дополнительный контекст
Сделать это нужно после того, как разработка парсера/компилятора файлов вышеназванных движков в ветке vx-parser будет завершена. Затем, нужно будет встроить его в GUI-программу.

Добавить возможность указывать папки для парсинга текста из них/записи текста из них в CLI-инструменте

Связан ли ваш запрос с проблемой? Пожалуйста, опишите.
Невозможность распарсить перевод из других папок, кроме original, а также невозможность записать перевод из других папок, кроме translation.

Опишите решение, которое вы хотели бы получить
Добавить аргументы input_dir и output_dir к CLI инструменту, чтобы указывать директории ввода и вывода при парсинге и записи файлов.

Опишите альтернативы, которые вы рассматривали
Никаких.

Дополнительный контекст
Никакого.

Добавить .psd файлы отредактированных спрайтов игры в репозиторий

Связан ли ваш запрос с проблемой? Пожалуйста, опишите.
Невозможность коллективной работы над переводом игровых картинок.

Опишите решение, которое вы хотели бы получить
Добавить .psd файлы спрайтов игры, которые были переведены на русский, в репозиторий.

Опишите альтернативы, которые вы рассматривали
Никаких.

Дополнительный контекст
Так как .psd файлы были утеряны мной, их нужно воссоздать повторно.

Добавить аргумент --drunk, перемешивающий строки текста, в CLI-инструмент

Связан ли ваш запрос с проблемой? Пожалуйста, опишите.
Нет.

Опишите решение, которое вы хотели бы получить
Аргумент для CLI-инструмента, который будет случайно перемешивать строки между собой, на выходе создавая практически неиграбельные файлы перевода.

Опишите альтернативы, которые вы рассматривали
Никаких.

Дополнительный контекст
Было бы весело.

Добавить парсер текста для файлов RPG Maker VX/VX Ace и XP

Связан ли ваш запрос с проблемой? Пожалуйста, опишите.
Невозможность перевода игр, написанных на RPG Maker VX Ace. К примеру, LISA: The Painful.

Опишите решение, которое вы хотели бы получить
Добавить парсер текста для файлов вышеназванных RPG Maker движков в CLI инструмент, желательно написанный на Rust.

Опишите альтернативы, которые вы рассматривали
Включение в этот репозиторий инструмента rvpacker, способного парсить файлы вышеназванных движков в .YAML файлы.

Дополнительный контекст
Включение инструмента rvpacker высоко нерекомендуется, так как это станет слабой точкой в плане производительности (вызов интерпретатора Ruby) и в плане редактируемости (Ruby - непопулярный язык).
Стоит переписать парсер rvpacker, используя JavaScript или Rust, для включения в этот проект.