KF3_TranslationUpdater/README.md

21 lines
1003 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<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.
<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!)
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>
Additional .dll's are required to build this addon from source. They can be found in `BepInEx\core\` and in `KFP2G\けもフレ_Data\Managed\` directories.