Important
This project is not actively being maintained.
If you need more help than the documentation can provide, please refer to the Team Reptile Discord server's modding channel.
I am only one person and will not be able to help you individually.
This is a repository for a BepInEx plugin to load custom characters for the game Bomb Rush Cyberfunk
The plugin allows for the following:
- Custom character name/title
- Custom character model (gameplay & cutscenes)
- Custom outfits (up to four)
- Custom outfit names
- Multiple meshes and materials per outfit
- Custom character graffiti
- Custom character voice clips
- Multiple skins at once (for different characters and per character)
- Additional character slots for any character bundle
Note
To create a character mod you will need both the plugin and the Unity project. If you just want to use a character you downloaded, you only need the plugin.
This plugin requires BepInEx, a plugin framework for Unity games. The easiest way to get BepInEx going for Bomb Rush Cyberfunk is to use the r2modman mod manager.
r2modman was used to test this plugin, so other solutions may not work
To install BepInEx, follow these steps:
- Open r2modman and select Bomb Rush Cyberfunk as the game and choose any profile
- Navigate to the Online tab
- Find BepInEx Pack by BepInEx and install it
To install the plugin for BepInEx, follow these steps:
Automatic Install
Crew Boom is also available on the Thunderstore to download directly from r2modman.
Manual Install
- Download the plugin
- Open r2modman and select Bomb Rush Cyberfunk as the game and choose any profile
- Navigate to the Settings tab
- Find the option labeled "Browse profile folder" and click it
- Navigate to the folder
BepInEx/plugins/
- Copy the folder
CrewBoom
from the plugin archive toBepInEx/plugins/
- Navigate to your BepInEx installation for the game and open the
BepInEx/config/CrewBoom/
folder - Copy your character files (.cbb and .json) into the
CrewBoom
folder - Optionally, you can put the character files in
BepInEx/config/CrewBoom/no_cypher
to have characters only show up when synced via the API (SlopCrew) and not in your cypher selection.
Optionally, you can edit/create a json file for your character to change whether they replace a character or not.
You can find instructions on how to do this here
This pertains to if you want to build the plugin yourself, not the Unity project.
Note
You will need to copy Bomb Rush Cyberfunk's Assembly-CSharp.dll
into the Libraries
folder of the project, as it is not provided.
It can be found at <path to where your games are stored>\BombRushCyberfunk\Bomb Rush Cyberfunk_Data\Managed
- Programming and Unity SDK: LunaCapra
- Test model and assets: minty_cups
This project was loosely based on BRCModelReplacement by TheSmallBlue
and BRCMods by Ikeiwa & TheSmallBlue
This project is licensed under the GNU General Public License v3.0