Add README.md

This commit is contained in:
katboi01 2023-10-11 23:00:07 +08:00
parent fcdd9d670d
commit 132f57e268
1 changed files with 17 additions and 0 deletions

17
README.md Normal file
View File

@ -0,0 +1,17 @@
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.
<h2>Usage</h2>
Most recent build is packaged with KF3TL's main download.
Upon starting the game, if a new update is available, a button will appear at the top of the screen that can be clicked.
Clicking the button will begin to download and extract the translation files (existing files will be overwritten!)
If there are no new updates, or when the update finishes, the plugin disables itself and does not affect the game.
<h2>Build</h2>
Additional .dll's are required to build this addon from source. They can be found in `BepInEx\core\` and in `KFP2G\けもフレ_Data\Managed\` directories.