Modding

From Binding of Isaac: Rebirth Wiki
Jump to: navigation, search

Modding, or creating mods, is the act of modifying graphics and/or gameplay elements of the base game.

Removed in Afterbirth † Modding with Rebirth & Afterbirth[edit | edit source]

Modding Rebirth & Afterbirth is limited to editing and replacing existing assets, unless you hack the exe yourself.

Installing Mods[edit | edit source]

Mods made for Rebirth & Afterbirth must be installed manually into the game's resources folder.

On Windows, this should be in steamapps/common/The Binding of Isaac Rebirth/resources, which is located in your Steam folder.

Added in Afterbirth † Modding with Afterbirth †[edit | edit source]

The Binding of Isaac: Afterbirth † introduced official modding support, allowing users to mod the game using the Lua programming language and to upload their creations to the Steam Workshop.

Installing Mods[edit | edit source]

Mods can be installed in a few different ways, depending on how the author chose to share it. Mods can typically be found in the Steam Workshop or in various community sources.

Steam Workshop[edit | edit source]

Mods found in the Steam Workshop can be installed by navigating to the mod's page and clicking Subscribe.

Manual installation[edit | edit source]

Mods that do not use the Steam Workshop can be installed by downloading them and extracting them to the appropriate location.

On Windows, this should be in My Games/Binding of Isaac Afterbirth+ Mods, which is located in the Documents folder.

On Linux, this should be in ~/.local/share/binding of isaac afterbirth+ mods.

On Mac, this should be in ~/Library/Application Support/Binding of Isaac Afterbirth+ Mods

Modding Resources[edit | edit source]

Listed below are resources that can assist you in making your own mods.

A built-in console to use various commands to test mods: give items, go to stage x, reload lua script and so on.

User updated Doxygen lua reference for The Binding of Isaac Afterbirth + Lua API based on the official lua reference, useful when coding mods.

User made reference for The Binding of Isaac Afterbirth + Lua API hosted on this wiki.

A list of tools that can help in mod creation and debugging (Official and unofficial tools are included).

Links to external tutorials about modding, ranging from animations to spriting and Lua programming.

Information about modding XML files. This is needed for examples to add new costumes, items or player types to mods.

Community & Mod Releases[edit | edit source]

A service by the community to host mods created primarily for Rebirth and Afterbirth.

A subreddit to discuss mods and modding.

A Discord server to discuss mods and modding.

The official mod repository, these mods only work for Afterbirth+.

A section of NexusMods which is home to Isaac mods. Not very active.

Dataminer Icon.png Modding Dataminer Icon.png

References Modding Tutorials - XML Modding - Added in Afterbirth † Lua Reference - Added in Afterbirth † Modding of Isaac Lua Reference
Tools Added in Afterbirth † Debug Console - Modding Tools - Basement Renovator
Releases Modding of Isaac - Added in Afterbirth † Steam Workshop - NexusMods
Community Modding of Isaac Subreddit - Modding of Isaac Discord Server