Lordmau5/Kiwami-2-Model-Replacer
Lordmau5/Kiwami-2-Model-Replacer
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README with examples

Browse Source
This commit is contained in:
Lordmau5 2020-05-21 15:34:17 +02:00
parent 05a3dfb44f
commit 32156b09bb
1 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -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. 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
<a href="https://i.imgur.com/hH6yfFM.png" target="_blank">
<img src="https://i.imgur.com/hH6yfFM.png" alt="Kiryu as Majima" width="350"/>
</a>
<a href="https://i.imgur.com/a3x0urF.png" target="_blank">
<img src="https://i.imgur.com/a3x0urF.png" alt="Jin Goda enjoying a cold drink" width="350"/>
</a>
<a href="https://i.imgur.com/1SeZbAd.png" target="_blank">
<img src="https://i.imgur.com/1SeZbAd.png" alt='"Be My Kiryu"' width="350"/>
</a>