Skip to content

Commit

Permalink
<docs> update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
anonymousException committed Jan 21, 2024
1 parent 1241f11 commit 2612c0f
Showing 1 changed file with 23 additions and 73 deletions.
96 changes: 23 additions & 73 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

------

img:interface
![img](https://github.com/anonymousException/renpy-translator/blob/main/docs/img/interface.png)

------

Expand Down Expand Up @@ -48,35 +48,19 @@ It's **strongly not recommended** for translators to make translation through un

Download the [UnRen-ultrahack.bat]() and copy it to the game directory (where game.exe locates)



img:move_unren


![img](https://github.com/anonymousException/renpy-translator/blob/main/docs/img/move_unren.png)

Double-Click the UnRen-ultrahack.bat and the following console will show



img: unren_console


![img](https://github.com/anonymousException/renpy-translator/blob/main/docs/img/unren_console.png)

Input 9 and then Enter and then Enter y



img: unren_console2


![img](https://github.com/anonymousException/renpy-translator/blob/main/docs/img/unren_console2.png)

Wait for a moment and then the unpack will be over



img:unren_console3


![img](https://github.com/anonymousException/renpy-translator/blob/main/docs/img/unren_console3.png)

------

Expand All @@ -101,53 +85,35 @@ you can forward to https://www.renpy.org/ and then download the latest version

Unzip the ren'py engine you download



img: renpy_folder


![img](https://github.com/anonymousException/renpy-translator/blob/main/docs/img/renpy_folder.png)

Click "preferencs" in the lower right corner

img: renpy_interface


![img](https://github.com/anonymousException/renpy-translator/blob/main/docs/img/renpy_interface.png)

Reset the "Projects Directory" to the parent directory of the game you want to translate



img:renpy_preference


![img](https://github.com/anonymousException/renpy-translator/blob/main/docs/img/renpy_preference.png)

Return back to the last interface and Click "Generate Translations"



img: renpy_interface2


![img](https://github.com/anonymousException/renpy-translator/blob/main/docs/img/renpy_interface2.png)

Fill the "Language" , this is just a tag (It's related to the "tl name" label in this tool) used for the translation that you can name whatever you want. But it's recommended to name the target language you want to translate. Such as "japanese" or "chinese" etc.

It would be alright to keep other options default ,Especially for "Generate Translations" option , do not tick the "Generate empty strings for translations"



img: renpy_gen_translate


![img](https://github.com/anonymousException/renpy-translator/blob/main/docs/img/renpy_gen_translate.png)

After all options have been set . Click the "Generate Translations" and wait to complete

img: renpy_gen_tranlate_over
![img](https://github.com/anonymousException/renpy-translator/blob/main/docs/img/renpy_gen_tranlate_over.png)

And then you can close the software , the official extract is done

You can see the generated folder , remember the path

img : renpy_gen_translate_folder
![img](https://github.com/anonymousException/renpy-translator/blob/main/docs/img/renpy_gen_translate_folder.png)

The folder path in this tutorial is :

Expand All @@ -159,11 +125,7 @@ F:\Games\RenPy\DemoGame\game\tl\japanese

Fill (input,drag or brower) the directory that generated by Official Extract before and just tap the extract buttion , and then extraction will be done



img : renpy_translator_extract


![img](https://github.com/anonymousException/renpy-translator/blob/main/docs/img/renpy_translator_extract.png)

Quite easy, right ? That's why I made this tool.

Expand All @@ -173,21 +135,13 @@ You need to add an entry to change the language in game

Open the game directory and then enter subfolder "game", open the "screens.rpy" file (you can use notepad to open it)



img: screens.rpy_folder.png


![img](https://github.com/anonymousException/renpy-translator/blob/main/docs/img/screens.rpy_folder.png)

Search the key words:"game_menu(_("Preferences")" (usually the words do effect if not you may need to explore what the game use to replace "Preferences")

Normally you will found many "vbox:" like this:



img: screens_notepad.png


![img](https://github.com/anonymousException/renpy-translator/blob/main/docs/img/screens_notepad.png)

Try to find a vbox that contains "Language" or some other words can replace "Language"

Expand All @@ -204,11 +158,7 @@ vbox:

Pay attention to the indentation to keep it aligned. After edit it should be like this



img: screens_notepad_edit.png


![img](https://github.com/anonymousException/renpy-translator/blob/main/docs/img/screens_notepad_edit.png)

------

Expand All @@ -223,7 +173,7 @@ textbutton "LanguageName" action Language("The Tag you fill in official Extract"

After the file saved,open the game and make sure the preference show the content you just edit

img : game_language
![img](https://github.com/anonymousException/renpy-translator/blob/main/docs/img/game_language.png)

------

Expand All @@ -239,26 +189,26 @@ For other language , you can find relative font files using search engine easily

Open the ren'py translator and fill the following blanks

directory : the path generated during Official Extract before
directory : the path generated during [Official Extract](#jump_official_extract) before

font: the font file you downloaded

target : the target language you want to translate (input the letter in front of the target language to search is supportable , need not to scroll to search)

img:renpy_translator_translate
![img](https://github.com/anonymousException/renpy-translator/blob/main/docs/img/renpy_translator_translate.png)

Wait until the translation done:

img : renpy_translator_translate_over.png
![img](https://github.com/anonymousException/renpy-translator/blob/main/docs/img/renpy_translator_translate_over.png)

So far , the translation is done , you can open game and check it :

img:game_language_translated
![img](https://github.com/anonymousException/renpy-translator/blob/main/docs/img/game_language_translated.png)

### <span id = "jump-update-translation"> UpdateTranslation </span>

Update-Translation is quite easy, directly refers to the [Official Extract](#jump_official_extract) (optional) and [Tool Extarct](#jump-tool-extract)

After extraction , just input the directory generated during Official and choose the target , font can leave empty because it has been replaced before
After extraction , just input the directory generated during [Official Extract](#jump_official_extract) and choose the target , font can leave empty because it has been replaced before

img : renpy_translator_update_translate
![img](https://github.com/anonymousException/renpy-translator/blob/main/docs/img/renpy_translator_update_translate.png)

0 comments on commit 2612c0f

Please sign in to comment.