Class Mod

Get the Mod of the current mod being developed

Get the path to the mod’s platform binary (.dll on Windows, .dylib on Mac & iOS, .so on Android)

Get the path to the mod’s runtime resources directory (contains all of its resources)

Get the dependency settings for a specific dependency via its ID. For example, if this mod depends on Custom Keybinds, it can specify the keybinds it wants to add in mod.json under dependencies."geode.custom-keybinds".settings.keybinds

Check if this Mod has updates available on the mods index. If you’re using this for automatic update checking, use openInfoPopup from the ui/GeodeUI.hpp header to open the Mod’s page to let the user install the update

Get the mod’s save directory path

Get the mod’s config directory path

Get the mod’s persistent directory path This directory is not deleted even when Geode/mod is uninstalled

Returns true if this mod has any settings

Get a list of all this mod’s setting keys (in the order they were declared in mod.json)

Get the definition of a setting, or null if the setting was not found, or if it’s a custom setting that has not yet been registered using Mod::registerCustomSettingType

Register a custom setting type. See the setting docs for more

Returns a prefixed launch argument name. See Mod::getLaunchArgument for details about mod-specific launch arguments.

Returns the names of the available mod-specific launch arguments.

Equivalent to a prefixed Loader::hasLaunchArgument call. See Mod::getLaunchArgument for details about mod-specific launch arguments.

Get a mod-specific launch argument. This is equivalent to Loader::getLaunchArgument with the argument name prefixed by the mod ID. For example, a launch argument named mod-arg for the mod author.test would be specified with --geode:author.test.mod-arg=value.

Equivalent to a prefixed Loader::getLaunchFlag call. See Mod::getLaunchArgument for details about mod-specific launch arguments.

Equivalent to a prefixed Loader::parseLaunchArgument call. See Mod::getLaunchArgument for details about mod-specific launch arguments.

Get the value of a setting. To use this for custom settings, first specialize the SettingTypeForValueType class, and then make sure your custom setting type has a getValue function which returns the value

Set the value of an automatically saved variable. When the game is closed, the value is automatically saved under the key

Create a hook at an address. Call the original function by calling the original function – no trampoline needed

Claims an existing hook object, marking this mod as its owner. If the hook has “auto enable” set, this will enable the hook.

Disowns a hook which this mod owns, making this mod no longer its owner. If the hook has “auto enable” set, this will disable the hook.

Get all hooks owned by this Mod

Write a patch at an address

Claims an existing patch object, marking this mod as its owner. If the patch has “auto enable” set, this will enable the patch.

Disowns a patch which this mod owns, making this mod no longer its owner. If the patch has “auto enable” set, this will disable the patch.

Get all patches owned by this Mod

Enable this mod

Disable this mod

Delete the mod’s .geode package.

Check whether or not this Mod depends on another mod

Check whether all the required dependencies for this mod have been loaded or not

Check whether none of the incompatibilities with this mod are loaded

Get info about the mod as JSON

If this mod is built for an outdated GD or Geode version, returns the LoadProblem describing the situation. Otherwise nullopt if the mod is made for the correct version of the game and Geode