Create and share custom characters with friends!

How To

• Install the mod (instructions below) and make sure you delete mods.txt if it exists
  
• Launch the game. This will create a folder in your Enter The Gungeon directory called CustomCharacterData
  
• Unzip your custom character file and put the character's folder into the CustomCharacterData folder
  
• Launch the game, and open the console with ~, /, or F2. A list of available characters should appear in green.
  
• Use the command character  to switch characters. For example: "character bartender"
  
• You can also use character2 to switch the second player's character. This is pretty buggy so don't whine to me if it doesn't work right
  

I've included a guide on how to install/create custom characters in the file download section. Please read it! It took a long time to write.

Nevernamed (after whom my firstborn shall be named) made a video feature of this mod! 

Farewell to Arms TK2DSprite Dump here (Most sprites in the game are in here)
Farewell to Arms DFSprite Dump here. (UI sprites like Bosscards are in here)


Installation
Get MTG:

• Download Mod the Gungeon at: http://modthegungeon.eu/#download
  
• Make sure Enter the Gungeon is closed
  
• Open ETGMod.Installer.exe and press "Step 3: Install ETGMod"
  
• Close dat thang
  

Installing mods:

• Go to your Enter the Gungeon Steam directory, usually located at:
  "C:\Program Files (x86)\Steam\steamapps\common\Enter the Gungeon\"
  
• If there is not one already, create a folder called "Mods"
  
• Drag CustomCharacters.zip into the Mods folder
  
• If there is a "mods.txt" file in the Mods folder, delete it
  
• The directory should look like this: "Enter The Gungeon/Mods/CustomCharacters.zip
  

Then launch the game. If Mod the Gungeon installed correctly, you can press F1 to see the list of active mods. 

Open the console with ~ or / to enter commands.
Type help for a list of commands.

If you're having issues, you can post a question in the Enter the Gungeon discord server's #modding channel, where I'm most active. 

This mod works with the Farewell to Arms update

Links to the streamers for whom I made these characters!
RufusMckain - The Bartender
Wonderis - The Speedrunner

v0.5 - created
v0.6 - fixed bug where marine and pilot were unusable bases
v0.7 - Added support for face cards, fixed bugs
v1.0 - Added support for punchout related sprites
v1.1 - Added support for the punchout face cards at different health stages, and increased the number of custom characters that can be installed
v1.1.1 - Made it so an error is thrown if you specify a invalid item in the loadout of your character
v1.1.2 
    -Made it so a warning is thrown if you put a questionable line in your characterdata.txt
    -Fixed a bug with convict's spritesheets (UnityEngine.Material errors)
v1.2a
    -Added the character2 command. Allows you to change the second player's character. This is still buggy
v1.2
    -Fixed bugs with infinite ammo weapons
    -Added the "armor" field to the characterdata.txt
    -Made it so individual sprites can be whatever size. This does not affect your hitbox!
    -You now add several of the same item to a loadout
v1.2.1
    -Fixed bug where only the first weapon in a loadout could be loaded as infinite
v2.0a - Experimental Build
    -Fixed bug with the gunslinger's sprite
    -Fixed bug with hand sprites
    -Added custom characters to foyer. For now, maximum of 9!
        +Put foyer card sprites in a folder called "foyercard"
v2.0c - Experimental Build
    -HUGELY improved load times
    -Fixed bug with black screen on entering Gungeon
    -Added more positions to the list of Foyer spawns. Now you can have up to 23!
    -Made it so that characters load after all other mods so that custom items will load first
    ~Still need to fix bugs with foyer cards
v2.0
    -Fixed foyer bugs
    -Finally ready for a full release! 
v2.0.1
    -Fixed more foyer bugs
    -Fixed bug where the console would spit endless messages if you didn't specify a loadout
v2.0.2
    -Fixed more foyer bugs
    -I don't even know what else I did I haven't touched this in weeks. Hopefully it works.