Skip to content

TeamREPENTOGON/REPENTOGON

Repository files navigation

Steam Downloads Github Downloads Github Latest Downloads

Language:English | 简体中文

logo

A new era for Isaac modding begins now.

REPENTOGON is a mod for The Binding of Isaac: Repentance+ version v1.9.7.12.J273 (installation can also be performed using the current latest version of Repentance+ from Steam) that extends the Lua API with much-needed bug fixes, extra functionality, and performance enhancements.

Generally referred to as an "EXE mod" by the community, REPENTOGON works very differently than a traditional mod. Powered by LibZHL, the same framework used by Antibirth, REPENTOGON hooks directly into the game, allowing direct control over functionality which was previously impossible to replicate in mods, or would require significant performance-intensive hacks or rewrites to replicate.

LUA API Documentation

REPENTOGON makes additions and modifications to the Lua API and adds tons of new features. You can find the documentation here: https://repentogon.com/docs.html

Installing

Refer to our website for comprehensive installation instructions.

Building

(Unless you're a developer, we recommend following the installation instructions on our website instead.)

Requirements

The nature of this project requires that we use the same compiler as the game. As a result, a Windows system is explicitly required, along with the following:

  • CMake 3.13 or above
  • Git
  • Visual Studio 2019 or above

Steps

We assume Git Bash for the duration of this tutorial, as well as CMake GUI.

  1. Recursively clone the repository: git clone --recursive https://github.com/TeamREPENTOGON/REPENTOGON
  2. Launch CMake.
  3. Under "Where is the source code", navigate to the root directory of the cloned repository (in most cases named REPENTOGON).
  4. Under "Where to put the binaries", choose any folder. This is where the generated files will live. cmake1
  5. At the bottom of the CMake GUI, hit "Configure".
    • If this is the first build, you will be prompted for more information.
    • Compiler must match your Visual Studio version.
    • Platform MUST be Win32.
    • Leave all other options as default, and press Finish. cmake2
  6. Once configuration is done, hit "Generate". This will create a .sln in the folder you specified before.
  7. Open the generated .sln in Visual Studio.
  8. Build the project. Unless you're a developer, we recommend Release mode for performance.
  9. When the build is finished, copy resources, resources-repentogon, dsound.dll, freetype.dll, libzhl.dll, Lua5.4.dll, and zhlREPENTOGON.dll and to the game's folder.
  • Optionally, the ISAAC_DIRECTORY setting can be set to the game's root directory to automatically copy these files after a build.

License

REPENTOGON is licensed under the GNU General Public License version 2.

LibZHL is licensed under the MIT license. All contents in the libzhl and libzhlgen folders are therefore licensed under MIT, with the exceptions of the following files and folders, which are components of REPENTOGON:

  • libzhl/functions and its contents
  • libzhl/IsaacRepentance_static.cpp

Folders in the libs folder are external dependencies and have their own licensing information. Check those folder (or, in the case of submodules, their respective dependencies) for further information.

Sponsors

Signpath is providing us with free code signing for our releases, thanks!

signpath

Privacy Notice

REPENTOGON does not collect or transmit any user data without explicit consent. We have an opt-in update mechanism that will transmit the user's IP address to GitHub on launch to determine if there is a new version available, but otherwise, absolutely zero data is processed or stored.