Skip to content

Commit ea89966

Browse files
committed
Update README
1 parent 79f3ce7 commit ea89966

File tree

2 files changed

+15
-18
lines changed

2 files changed

+15
-18
lines changed

README-ru.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22

33
## Основная информация
44

5-
Этот инструмент предназначен для чтения файлов RPG Maker игр в .txt файлы и записывания их обратно в изначальную форму.
5+
Этот инструмент предназначен для чтения файлов RPG Maker игр в `.txt` файлы и записывания их обратно в изначальную форму.
66

7-
Своё имя этот инструмент наследует от оригинального инструмента `rvpacker`, который был создан ещё для тех версий RPG Maker, что не использовали .json файлы, и который парсил файлы в YAML. В данный момент, репозиторий rvpacker удалён либо скрыт, а страница его автора также удалена.
7+
Своё имя этот инструмент наследует от оригинального инструмента `rvpacker`, который был создан ещё для тех версий RPG Maker, что не использовали `.json` файлы, и который парсил файлы в YAML. В данный момент, репозиторий rvpacker удалён.
88

99
Устаревший инструмент с тем же функционалом, написанный на Ruby, можно найти в [репозитории rvpacker-txt](https://github.com/savannstm/rvpacker-txt).
1010

11-
[Графический интерфейс](https://github.com/savannstm/rpgmtranslate), позволяющий удобно редактировать обработанные файлы (а также автоматически парсящий нераспарсенные игры, когда вы выбираете их папку) (и вы также можете легко записывать файлы обратно в изначальный вид одним нажатием кнопки).
11+
Также разрабатывается [графический интерфейс](https://github.com/savannstm/rpgmtranslate), позволяющий удобно переводить игры.
1212

13-
Библиотека, лежащая в основе этого интерфейса может быть найдена [здесь](https://github.com/savannstm/rvpacker-txt-rs-lib);
13+
Библиотека, лежащая в основе этого интерфейса, может быть найдена [здесь](https://github.com/savannstm/rvpacker-txt-rs-lib).
1414

1515
## Формат выходных файлов
1616

1717
`rvpacker-txt-rs` парсит весь оригинальный текст из файлов игры, и помещает его на каждую линию текстового файла. Все переносы линий (переносы строк, новые линии, `\n`) заменяются на символы `\#`.
1818
В конце каждой оригинальной строки, программа вставляет символы `<#>`. Это - разделитель, после которого должен начинаться переведённый текст. Удаление этого разделителя или нарушение его символов может привести к ошибкам, или хуже, неопределённому поведению программы. **Помните: ваш переведённый текст всегда должен начинаться после разделителя `<#>`.**
1919

20-
Для примера, как правильно переводить .txt файлы, обратитесь к моему [Русскому переводу на Fear & Hunger 2: Termina](https://github.com/savannstm/fh2-termina-translation).
20+
Для примера, как правильно переводить .txt файлы, обратитесь к моему [русскому переводу на Fear & Hunger 2: Termina](https://github.com/savannstm/fh2-termina-translation).
2121

2222
## Установка
2323

@@ -85,11 +85,10 @@
8585

8686
Например:
8787

88-
`rvpacker-txt-rs read --input-dir "E:/Documents/RPGMakerGame"` распарсит текст игры в папку `translation` указанной директории.
88+
`rvpacker-txt-rs read -i "E:/Documents/RPGMakerGame"` распарсит текст игры в папку `translation` указанной директории.
8989

90-
`rvpacker-txt-rs write --input-dir "E:/Documents/RPGMakerGame"` запишет перевод из \_trans файлов папки `translation` в совместимые файлы в папке `output`.
90+
`rvpacker-txt-rs write -i "E:/Documents/RPGMakerGame"` запишет перевод из `.txt` файлов папки `translation` в файлы RPG Maker в папке `output`.
9191

9292
## Лицензия
9393

9494
Репозиторий лицензирован под [WTFPL](http://www.wtfpl.net/).
95-
Это означает, что вы можете безнаказанно использовать и модифицировать программу в каком угодно виде. Вы можете делать всё, что захотите.

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,28 @@
44

55
## General
66

7-
This tool is designed to read RPG Maker game files into .txt files and write them back to their initial form.
7+
This tool is designed to read RPG Maker game files into `.txt` files and write them back to their initial form.
88

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, and parsed files into YAML. Now, rvpacker's repository is deleted/privated and the page of the author of this repository is not available as well.
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, and parsed files into YAML. Now, `rvpacker`'s repository is deleted.
1010

1111
The same deprecated tool, written in Ruby, can be found in [rvpacker-txt repository](https://github.com/savannstm/rvpacker-txt).
1212

13-
[A GUI](https://github.com/savannstm/rpgmtranslate) 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).
14-
15-
An underlying library for this CLI can be found [here](https://github.com/savannstm/rvpacker-txt-rs-lib);
13+
There's [a GUI](https://github.com/savannstm/rpgmtranslate), that allows you comfortably edit files.
14+
An underlying library for this CLI can be found [here](https://github.com/savannstm/rvpacker-txt-rs-lib).
1615

1716
## The format of output files
1817

1918
`rvpacker-txt-rs` parses all the original text from the game's files, and inserts it on each new line of a text file. All line breaks (new lines, `\n`) are replaced by `\#` symbols.
2019
At the end of each original line, `<#>` is inserted. This is a delimiter after which translated text should start. Removing it or erasing one of its symbols will lead to crashes, or worse, undefined behavior. **So remember: your translated text goes after the `<#>` delimiter.**
2120

2221
For an example on how to properly translate the .txt files, refer to [My Fear & Hunger 2: Termina Russian translation](https://github.com/savannstm/fh2-termina-translation).
23-
Yeah, translation is Russian, but the point is to get how to properly translate this program's output files.
22+
Translation is Russian, but the point is to get how to properly translate this program's translation files.
2423

2524
## Installation
2625

2726
You can download binary files in the Releases section.
2827

29-
Files with the .exe extension are designed for Windows x64, while files without an extension are designed for Linux x64.
28+
Files with the `.exe` extension are designed for Windows x64, while files without an extension are designed for Linux x64.
3029

3130
## Usage
3231

@@ -83,11 +82,10 @@ Options:
8382

8483
Examples:
8584

86-
`rvpacker-txt-rs read --input-dir "E:/Documents/RPGMakerGame"` parses the text of the game into the `translation` folder of the specified directory.
85+
`rvpacker-txt-rs read -i "E:/Documents/RPGMakerGame"` parses the text of the game into the `translation` folder of the specified directory.
8786

88-
`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.
87+
`rvpacker-txt-rs write -i "E:/Documents/RPGMakerGame"` writes the translation from `.txt` files of the `translation` folder to RPG Maker files in the `output` folder.
8988

9089
## License
9190

9291
The repository is licensed under [WTFPL](http://www.wtfpl.net/).
93-
This means that you can use and modify the program in any way. You can do what the fuck you want to.

0 commit comments

Comments
 (0)