diff --git a/README.md b/README.md index 35a820b..e275059 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,22 @@ -# Kiwami-2-Model-Replacer +# Kiwami 2 Model Replacer Utility + +Before you get started, please run `npm install` in this directory to have the required packages installed. Any config modifications are to be done in the `config.js` file. -To build the new `character_character_data.bin` file just run `npm start` afterwards. +If the file doesn't exist it will be created upon first launch. Please try not to edit the `config.default.js` file. + +To build the new model file(-s) just run `npm start` after doing your modifications in the config. +The will be generated into a subfolder called `output`. + +## Examples + + + Kiryu as Majima + + + Jin Goda enjoying a cold drink + + + "Be My Kiryu" +