Optional API

Are you a developer looking to partially integrate your mod into Horrible Menu's interface without the need of a required dependency? Well, you found the right place! The following guide teaches you how to register the metadata and handle toggling for your options.

Let's start off by adding this mod as a dependency in your mod.json!

"dependencies": {
    "cubicstudios.horriblemenu": {
        "version": ">=1.0.0",
        "required": false
    }
}

Tip

We recommend shortening include paths in your code by adding the the full path as a private include directory through your project's CMakeLists.txt file. The rest of the documentation will use this practice in its code samples.

target_include_directories(${PROJECT_NAME} PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/geode-deps/cubicstudios.horriblemenu/include)

You can directly access the Horrible Menu mod menu optional API by including the OptionalAPI.hpp file in your code. Make sure to include the horrible namespace to directly access all needed classes and methods.

#include <horrible/OptionalAPI.hpp>

using namespace horrible;

TODO