The Binding of Isaac: Rebirth
0 of 0

File information

Last updated

Original upload

Created by

umKrampus

Uploaded by

umKrampus

Virus scan

Safe to use

Tags for this mod

About this mod

Mod Config Menu is a library to that allows other mods to have a settings menu. This specific version of Mod Config Menu removes all of the hacky API overrides that the original author used, which is a terrible programming practice and can cause problems with other things in the Isaac ecosystem. For this reason, I call it the "Pure" version.

Permissions and credits
Disclaimer: I am not the author of this mod, I'm only posting here, if you want me to delete this mod page, just text me on discord: Krampus#2007.

Disclaimer 2: If you are downloading from here, you are not using the steam version, but, yes, it does work, matter of fact, you can download my vortex support extension here.

Before posting a comment, read the FAQ below. Comments asking questions that have already been covered will be deleted.

Introduction
Mod Config Menu is a library to that allows other mods to have a settings menu. You should only subscribe to this mod if you have other mods that use it.
This specific version of Mod Config Menu removes all of the hacky API overrides that the original author used, which is a terrible programming practice and can cause problems with other things in the Isaac ecosystem. For this reason, I call it the "Pure" version.
This mod is open-source. You can help with development by contributing on GitHub[github.com].
Credit goes to piber20 for originally creating this library and Chifilly for updating it for Repentance.
Using Mod Config Menu
In order to use Mod Config Menu Pure, do not use the "require" or "dofile" or "pcall" functions. Rather, simply check to see if the global variable of "ModConfigMenu" exists, with something along the lines of:
local MOD_NAME = "My Mod" local VERSION = "1.0" local function setupMyModConfigMenuSettings() if ModConfigMenu == nil then return end ModConfigMenu.AddSpace(MOD_NAME, "Info") ModConfigMenu.AddText(MOD_NAME, "Info", function() return MOD_NAME end) ModConfigMenu.AddSpace(MOD_NAME, "Info") ModConfigMenu.AddText(MOD_NAME, "Info", function() return "Version " .. VERSION end) end

Troubleshooting
Note that the "Pure" version of Mod Config Menu will not work properly if:
– you subscribed to the "Pure" version and you subscribed to a different version at the same time, which will cause a conflict
– you are subscribed to a mod that uses a standalone version of Mod Config Menu, which will cause a conflict
– you are subscribed to a mod uses the "require" or "dofile" or "pcall" functions to initialize or invoke Mod Config Menu
Navigation
Keyboard:
– Use the arrow keys or WASD keys to move around.
– Esc, backspace, or Q can be used to go back.
– E, space, or enter can be used to select an item.
– By default you can open the menu by pressing L.
– F10 will also always open the menu; this cannot be changed.
Controller:
– Both control sticks can be used to move around.
– Press B to go back.
– Press A to select an item.
– You can open the menu by pressing down the right control stick.
FAQ
Q: Does it work with Repentance?
A: Yes.
Q: Does it work with Afterbirth+?
A: No, because it uses Repentance-only features for getting the HUD offset.
Q: What do I do if Mod Config Menu Pure does not work properly with a particular mod?
A: This is probably because the mod is using the "require" or "dofile" or "pcall" functions to initialize or invoke Mod Config Menu. Contact the individual mod author to fix this and do not post a comment here.
Q: What is Mod Config Menu Continued?
A: The original version of Mod Config Menu was made by piber20. Mod Config Menu Continued is an updated version made by Chifilly with the goal of making it work with the Repentance DLC and fixing some bugs. Mod Config Menu Pure is an updated version of Mod Config Menu Continued with the goal of fixing yet more bugs. Thus, Mod Config Menu Continued is not the same thing as Mod Config Menu Pure.
Q: What are the differences between the original Mod Config Menu and Mod Config Menu Continued and Mod Config Menu Pure?
A: There are some small technical differences. But as a normal player, there are no differences that you would ever be able to notice, besides the fact that some versions will work with some mods, and others won’t. Thus, you should use whichever version will result in the lowest amount of bugs for the specific combination of mods that you want to play with. (Or contact the authors of the other mods you play with to make them work with Mod Config Menu Pure, if they don’t already.)
Q: As a player, do I need to subscribe to this mod and other versions of Mod Config Menu at the same time?
A: No. You should only subscribe to one specific version of Mod Config Menu at a time.
Q: What do I do if saving settings for a mod does not work between game launches?
A: Mod Config Menu is not in charge of saving any data besides the ones in the "General" and "Mod Config Menu" pages. If an individual mod does not properly save its data, then you should contact the author of that mod.
Q: Does this have the same functionality (i.e. API) as the other versions of Mod Config Menu?
A: Yes. However, it might not work as a drop-in replacement for mods that use the "require" or "dofile" or "pcall" functions to initialize or invoke Mod Config Menu. Another common issue is using deprecated properties like "ModConfigMenuOptionType.BOOLEAN" instead of "ModConfigMenu.OptionType.BOOLEAN". If you are a mod author and you want to switch to the pure version, you should test everything thoroughly.
Q: What does it mean to "remove API overrides"?
A: The original version overwrote some of the Lua and Isaac API functions, such as "pcall" and "RequireMod". This version does not overwrite any API functions.
Q: How do I tell what version of Mod Config Menu Pure I have?
A: There are 3 ways. First, you can see the version in the console. Second, you can see the version in the game’s "log.txt" file. Third, you can see the version at the top of the "C:Program Files (x86)SteamsteamappscommonThe Binding of Isaac Rebirthmods!!mod config menu_2681875787scriptsmodconfig.lua" file.
Q: Where is the game’s "log.txt" file located?
A: By default, it is located at the following path: C:UsersjamesDocumentsMy GamesBinding of Isaac Repentancelog.txt
Q: Where is the save data for Mod Config Menu located?
A: By default, it is located at the following path: C:Program Files (x86)SteamsteamappscommonThe Binding of Isaac Rebirthdata!!mod config menusave#.dat
Q: Why doesn’t Mod Config Menu work for me?
A: It works for everyone else, so it has to be something wrong with you. Start by uninstalling the game, completely removing all leftover game files, reinstalling the game, and then only subscribing to this mod on the workshop and nothing else. For more information on where the various game files are located, see my directories and save files explanation[github.com].
Q: What changed in the last update?
A: Like any other open source piece of software, you can find the changes on GitHub[github.com].