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 Use
[list]
[*]Install the mod (instructions below) and[color=#ff3333] [b]make sure you delete mods.txt if it exists[/b][/color]
[*] Launch the game. This will create a folder in your Enter The Gungeon directory (NOT MODS, ONE FOLDER UP) called [b]CustomCharacterData[/b]
If it does not create the folder when you launch the game, you have installed incorrectly. Please read the instructions again thoroughly.
[*][b]Put the character's zip file 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 [color=#66cc33]character [/color][color=#ffcc33]<characterName>[/color][color=#33cc33] [/color]to switch characters. For example: "character bartender"
[*]You can also use [color=#cc66ff]character2 [/color][color=#ffcc33]<characterName>[/color] to switch the second player's character. This is pretty buggy so don't whine to me if it doesn't work right
[/list]
### [Video tutorial of character installation](https://i.imgur.com/nCui1Ro.mp4)
[b]I've included a guide [/b]on how to install/create custom characters in the file download section. Please read it! It took a long time to write.
# Where to get sprites
Farewell to Arms TK2DSprite Dump [url=https://www.dropbox.com/s/tgkoj4xha5lkghy/DUMPsprites%28May%202019%29.zip?dl=0]here[/url] (Most sprites in the game are in here)
Farewell to Arms DFSprite Dump [url=https://www.dropbox.com/s/jxk0i6s22pziufz/DFDUMPSPRITES.zip?dl=0]here[/url]. (UI sprites like Bosscards are in here)
# Mod Installation
[b]Get MTG:[/b]
[list]
[*]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
[/list]
[b]Installing mods:[/b]
[list]
[*]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
[*][b][color=#ff3333]If there is a "mods.txt" file in the Mods folder, delete it[/color][/b]
[*]The directory should look like this: "Enter The Gungeon/Mods/CustomCharacters.zip
[/list]
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.
[color=#cc66ff][b]If you're having issues[/b][/color], you can post a question in the [url=https://discord.gg/etg]Enter the Gungeon discord server[/url]'s #modding channel, where I'm most active.
[color=#66cc33]This mod works with the Farewell to Arms update[/color]
Source code: https://github.com/KyleTheScientist/GungeonCharacters
# Credits
Thanks to SpecialAPI for maintaining the codebase while I enjoy retirement
Thanks to [color=#33aaff]Neighborino[/color] for coming up with the idea for the random character shrine and helping me make it!
Nevernamed (after whom my firstborn shall be named) [url=https://www.youtube.com/watch?v=cQ-FpJ79kLE]made a video feature of this mod[/url]!
Links to the streamers for whom I made these characters!
[url=https://twitch.tv/rufusmckain]RufusMckain - The Bartender[/url]
[url=https://twitch.tv/wonderis_]Wonderis - The Speedrunner[/url]
Main
Custom Character Guide.txt
Instructions on how to install/create characters
06-01-2019, 01:37 AM By Kyle
Custom Characters Mod_2.3.1.zip
The mod itself
03-19-2021, 07:22 PM By scionofmemory
Addon
The Speedrunner
Custom character of Wonderis_
06-03-2019, 08:19 AM By Kyle
The Bartender
Custom character of RufusMckain
06-04-2019, 11:23 AM By Kyle
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 [b]more[/b] foyer bugs
-I don't even know what else I did I haven't touched this in weeks. Hopefully it works.
v2.0.4
- Fixed lag when using an infinite ammo dueling laser
- Fixed issue where guns marked as infinte on one custom character would remain infinte on other characters
- Fixed issue where starter guns could be dropped
- Fixed issue where co-op players would lose their starter guns on death and supply crates would rain from the sky in each room entered while dead
v2.1.0
- Added the random character shrine to the breach (Thanks Neighborino for the idea and help making it!)
v2.1.1
- Fixed bug where the randomizer shrine would pick any of the base characters regardless of whether or not you had unlocked them
v2.1.2
[*] Fixed black screen bug on restart run
[*] Fixed bug where the randomizer shrine would put you at negative hegemony credits if you couldn't afford to play a character (now it just won't pick paradox or gunslinger if you don't have the cash
v2.2.0
[*] Added **Franseis**, a new breach NPC who randomizes your stats and loadout
v2.2.1
[*] Fixed Franseis not doing his idle animation
[*] Fixed Franseis giving an unreasonable amount of high tier items
[*] Fixed Fran's interactions with robot
[*] Fixed the colors in the stat report.
[*] Health modifer now only goes from -1 to +1 heart containers as opposed to 2
[*] Fixed character randomizer shrine not being interactable
[*] Don't code while tired, kids.
v2.3.0
[*] SpecialAPI has added functionality to the nickname option in the characterdata.txt file!
[*] Scion of Memory (Glorinfidel) has added the ability to load custom characters from zip files! Woo!
[*] I have not reviewed or tested any of this code so if there are any problems don't blame me.
v2.3.1
[*] Scion of Memory (Glorinfidel) removed a change that accidentally disabled the character2 command
Comments