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

1. Make a folder for your custom character.
2. Inside that folder, make another folder named plugins.
3. Put all of the files for your custom character into the plugins folder.
4. 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.
5. 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)

2.2.8

• Fixed issue with Foyer / Punchout face card sprites overwriting UI sprites added by other mods
• Added Alexandria dependency for helping coordinate UI sprite usage with other mods

2.2.7

• Fixed a bug where being near non-character NPCs would cause exceptions.
• Updated plugin version.

2.2.6

• Added the ability to fix punchout sprites getting stretched if their size does not match the size of the original sprite by adding the line punchout sprite fix: true to the character data file.

2.2.5

• Fixed custom characters not loading on Linux and Mac.

2.2.4

• Fixed outlines breaking when using individual sprites with a robot base.
• Rewritten the readme.
• Added the changelog.

2.2.3

• Removed unnecessary excessive logging.

2.2.2

• Fixed punchout sprites being trimmed.

2.2.1

• Initial release for BepInEx.