Custom In-Game Mod Menu API

This was a tricky project for sure

This bad boy has so much black magic in it. Slaps the GitHub Repo

~What Does It Do?~

Well, not much on its own.

But in the hands of mod authors, settings menus can be added directly to the in-game options menu through a simple API.

The API functions are very similar to imgui, with a few caveats

~What Do I Have To Do?~

Just install the mod like any other REFramework mod.

If you don't know how to do that, this probably shouldn't be your first rodeo.

Once in the right place, it should automatically add a "Mods" category to the options menu.

Then simply by using other supported REF mods, settings will show up there.

For Mod Authors:

Download the example mod implementation from the files and that should get you started pretty easily.

For more API detail you can look at the GitHub page.

I promise it's almost as easy to use as the built in imgui functions, and it'll be really cool to see the community add menus!

Just require the package and use the API like imgui.

You can optionally check to see if the user has the package installed, and optionally support the menus so you don't have to force people to install it. But it'd be nice if you could still mark this as a required file.

I ask that you don't redistribute this mod along with your mods, at convenient as that'd be.

I worked hard on this, but also I might need to update things here, and you wouldn't want conflicting versions in various mods.

Do let me know if you release a mod using this menu so I can add it to the list of supported mods!

Limitations

Unfortunately, because this uses the games own menus, we're limited to what the game can do natively.

There's no advanced drawing functionality obviously.

It only mimics an imgui, really the "draw" functions are callbacks to grab data from the games UI, you can have dynamic menus but try not to do anything too crazy.

It won't be a good fit for every mod, but if all you need is some simple settings, please consider it!

~Credits~

Thanks to Stracker for (making cool mods but also ) letting me reference one of their mods for the coroutines and system message prompts. And also like, actually adding the coroutines to REF.

And of course, thanks to praydog for all the work they do on