Modding

From Enter the Gungeon Wiki
Jump to navigation Jump to search
Mod-the-gungeon.png

There are many community-made mods for Enter the Gungeon. Mods may add new guns, items, characters, enemies and floors, or change existing behaviour, HUD elements, and more.

Mods are installed separately from the base game, using a mod launcher called BepInEx, which can be installed manually or using mod managers like r2modman or the Thunderstore Mod Manager.

Installing BepInEx & Mods

Consider reading this short guide for manual installation here or simply use/download one of the mod managers listed (r2modman or Thunderstore Mod Manager) both mod managers are safe to use.

Dodgeroll has aided in the development of the old mod loader Mod The Gungeon, which has been re-assembled into a more advanced version for use with BepInEx.

Manual or automatic installations will not work for:

  • Consoles (Xbox, PS4, Switch, etc.)

Creating Gungeon Mods

Creating Gungeon mods is not the best documented process, but modders have been improving accessibility. Join the Official Gungeon Modding server and ask in the support channel if you have any questions. Alternatively, you can also ask in the modding channel of the Enter the Gungeon server.

The first of the resources is a guide on setting your mod documenting how to set up your mod project and how to get it to run in the game.

The second resource covers more topics but not by any means completed: https://mtgmodders.gitbook.io/etg-modding-guide/

MTGAPI Console

BepInEx does not come with any tools by itself, but installing Mod the Gungeon API (via through manual installation or via a mod manager) gives you access to a debug console that lets you run a lot of different commands, including spawning items, altering your stats, spawning enemies, godmode, instant room clear, full map view, teleporting to other floors and many other commands.

An in-depth, but somewhat outdated guide to the console by Nevernamed can be found here. You can also use MTGAPIs "help" command to see all the commands and what their functionality is.

  • When using the give command with modded items, you must use a given mod's custom prefix before each item name. For example: give ck:a_rock gives you the Rock Gun from Children of Kaliber (while using the mod The Children of Kaliber, which has the prefix of ck:), but give a_rock without the prefix does nothing.
  • When using the character command to switch to a modded character, the name listed in the command console must be used.

Types of Mods

There are 5 types of Gungeon mods:

  • Custom Character, which adds in a new Gungeoneer to the game. Requires Kyle's Custom Character mod to function. (Most custom characters are recolors of other characters and feature no unique items or mechanics. When referring to custom character mods on this wiki, please only use characters that have their own custom items, mechanics, or spritework put into them.)
  • Item Mod, the most common type of mod, which adds custom items and guns.
  • Utility Mod, which adds quality of life features.
  • Room Pack, which adds new rooms to the various floors in the game.
  • Expansion Mod, which adds in entirely new floors, ways to play the game, new mechanics, or enemies.

Most mods fit into more than one of the types, adding various new things to the game.

List of Most Downloaded Mods

Here is a list of several popular mods for Gungeon, in no particular order. Mods that are available for BepInEx will be listed here.

The mods listed here are not available for BepInEx, but will stay on this page either due to a wiki page existing or as a public resource for other modders.

Note: The content on the above pages is NOT official or canon to Enter the Gungeon, or any other Dodge Roll property, and has not been created or reviewed by Dodge Roll.

Retrieved from "https://enterthegungeon.wiki.gg/index.php?title=Modding&oldid=53550"