Custom Characters Mod
EtG mod that allows you to create and share custom characters with friends!
Screenshots 2 screenshots
About this mod Author’s original text
Custom Characters Mod
Create and share custom characters with friends!
Also adds Franseis, an NPC who randomizes your loadout and stats, and a character randomizer shrine to the breach.
How to Port your Custom Character to BepInEx
- Make a folder for your custom character.
- Inside that folder, make another folder named plugins.
- Put all of the files for your custom character into the plugins folder.
- Inside of your custom character folders (not plugins) make the following files:
- manifest.json: This file contains the main information about your mod - the name, short description, dependencies and version. A more detailed guide on the manifest.json (plus an example manifest) can be found here. You can see if your manifest is valid or not here.
- README.md: This file contains the description for your mod that users will see on your mod page (for example, this guide is written in the mod's README.md). The readme can be previewed here.
- icon.png: The thumbnail for your mod users will see while browsing mods. Must be 256x256 pixels.
- CHANGELOG.md (optional): This file contains the changelog for your mod. Unlike the rest of the files, this one isn't required, but it's still good to have a changelog. Just like the readme, you can preview your changelog here.
- Make a zip of all the files in your custom character folder (NOT a zip of the folder itself) and upload it here.
An example of how the custom character folder should look like:
An example of how the plugins folder should look like:
Credits
- KyleTheScientist - original mod for Mod the Gungeon.
- An3s - original port to BepInEx.
- SpecialAPI - minor bug fixes and updates.
- Captain Pretzel - minor bug fixes and updates.
- Neighborino - idea for the random character shrine and help with making it.
- Nevernamed - making a video feature of this mod! (slightly outdated though, as it's for Mod the Gungeon)
Install & use Install: BepInEx plugin
- The archive from playbuff is the mod itself — usually a BepInEx plugin (a .dll or a plugin folder once unzipped).
- Recommended: use a community mod manager (such as r2modman) — pick this game, import the mod, and the manager sets up BepInEx and its dependencies for you.
- Manual route: install the BepInEx loader in the game folder, then drop the unzipped .dll or plugin folder into BepInEx/plugins/.
- Launch the game — the BepInEx console logs every plugin it loads; seeing this mod in the log means it is installed.
Mods with listed dependencies need those installed too, or they will not load. Options are usually changed in-game or in the plugin's config file.
Dependencies
Install these first, or the mod will not work:
BepInEx-BepInExPack_EtGMtG_API-Mod_the_Gungeon_APIAlexandria-Alexandria