From 826ef693f8ab29cb7bb6c0d7697dbfbd857b1e55 Mon Sep 17 00:00:00 2001 From: Steven <9684760+DeadlyKitten@users.noreply.github.com> Date: Wed, 6 Oct 2021 16:45:08 -0700 Subject: [PATCH] Create README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..42586d5 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# NASB Voice Mod + +This mod allows you to add custom voice lines to all characters! + +## Installation + +The easiest way to install this is to use the [Slime Mod Manager](https://github.com/legoandmars/slimemodmanager/releases/latest). + +----- + +#### Manual Installation +*If your game isn't modded with BepinEx, DO THAT FIRST!* +Simply go to the [latest BepinEx release](https://github.com/BepInEx/BepInEx/releases) and extract `BepinEx_x64_VERSION.zip` directly into your game's folder, then run the game once to install BepinEx properly. + +Then, go to the [latest release of this mod](https://github.com/DeadlyKitten/NickVoiceMod/releases/latest) and extract the zip in your game's install directory. + +## Usage + +Place voicepacks in `BepInEx/Voicepacks` (run the game with the mod installed if you don't see this folder). + +**Voicepacks must be in ZIP format!** Use the [Voicepack Packer](https://github.com/DeadlyKitten/NickVoicepackPacker) to create your own custom voicepacks. + +Only use one per character, additional voicepacks will be ignored! + +For info on what IDs to use for characters and their various actions, go [here](https://github.com/DeadlyKitten/NASB-Mod-Info/blob/master/Resources/CharacterIDs.md).