|
4 | 4 |
|
5 | 5 | ## General
|
6 | 6 |
|
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. |
8 | 8 |
|
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. |
10 | 10 |
|
11 | 11 | The same deprecated tool, written in Ruby, can be found in [rvpacker-txt repository](https://github.com/savannstm/rvpacker-txt).
|
12 | 12 |
|
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). |
16 | 15 |
|
17 | 16 | ## The format of output files
|
18 | 17 |
|
19 | 18 | `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.
|
20 | 19 | 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.**
|
21 | 20 |
|
22 | 21 | 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. |
24 | 23 |
|
25 | 24 | ## Installation
|
26 | 25 |
|
27 | 26 | You can download binary files in the Releases section.
|
28 | 27 |
|
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. |
30 | 29 |
|
31 | 30 | ## Usage
|
32 | 31 |
|
@@ -83,11 +82,10 @@ Options:
|
83 | 82 |
|
84 | 83 | Examples:
|
85 | 84 |
|
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. |
87 | 86 |
|
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. |
89 | 88 |
|
90 | 89 | ## License
|
91 | 90 |
|
92 | 91 | 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