Update README.md

This commit is contained in:
katboi01 2023-10-11 23:05:42 +08:00
parent 132f57e268
commit e21bb722af
1 changed files with 4 additions and 0 deletions

View File

@ -1,3 +1,5 @@
<h1>KF3 Tranlsation Updater</h1>
This is a translation updater created for Vorked's KF3 Tranlsation project [KF3TL](https://github.com/Vorked/KF3TL)
It provides a simple UI for updating the translation files for when new updates are published.
@ -10,6 +12,8 @@ Upon starting the game, if a new update is available, a button will appear at th
Clicking the button will begin to download and extract the translation files (existing files will be overwritten!)
After the update, the game has to be restarted for the changes to take effect. This is a limitation of XUnity which loads translation files on startup.
If there are no new updates, or when the update finishes, the plugin disables itself and does not affect the game.
<h2>Build</h2>