diff --git a/README.md b/README.md new file mode 100644 index 0000000..3aaa080 --- /dev/null +++ b/README.md @@ -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. + +

Usage

+ +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. + +

Build

+ +Additional .dll's are required to build this addon from source. They can be found in `BepInEx\core\` and in `KFP2G\けもフレ3_Data\Managed\` directories. \ No newline at end of file