viliger-CharacterAPI_BRCCCLoader icon

CharacterAPI BRCCCLoader

Loader of BrcCustomCharacters for CharacterAPI.

Last updated a year ago
Total downloads 11511
Total rating 2 
Categories Mods
Dependency string viliger-CharacterAPI_BRCCCLoader-1.0.5
Dependants 1 other package depends on this package

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2100 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2100
viliger-CharacterAPI-0.9.3 icon
viliger-CharacterAPI

API for loading custom characters.

Preferred version: 0.9.3

README

CharacterAPI_BRCCCLoader (what a mouthful)

Loader of BrcCustomCharacters for CharacterAPI.

How It Works

By default loader loads all compatible asset bundles from "BepInEx\CharacterAPI\BrcCustomCharacters" folder inside your r2modman profile folder or game folder (if you install everything manually). If you don't have the folder starting the game once with mod installed will create it. If character comes with multiple asset bundles (for different characters to replace), you need to put only one asset bundle inside the folder, otherwise separate character will be created for each asset bundle. Asset bundles need to be just inside the folder, not inside any sub folder. Anything that is not asset bundle will be ignored, so manifest and guid files are not needed. This mode can be disabled by changing "Load BRCCustomCharacters" option in the config file. This mode is enabled by default. You don't need BrcCustomCharacters for this mode.

Another mode loads characters directly from BrcCustomCharacters memory. HOWEVER, and this is important, replacements will still be in place. Let's say you have a character that replaces Red, his voice and his personal graffiti and then decide to enable this option. Then Red will be replaced by new character, his voice and graffiti also will be replaced AND you will get a new character separate from Red's replacement. In essence, you will get two characters. This mode is here mostly for compatibility and maybe SlopCrew. This mode is disabled by default and can be enabled by changing "Load BRCCustomCharacters from Plugin" option in the config file. You need BrcCustomCharacters for this mode.

Credits

Plugin comes with precompiled version of BrcCustomCharactersLib made by SGiygas. It is licensed under GPL-3.0 license.