Shared Mod Menu

SharedModMenu

One (optional) ingame settings menu that every mod can plug into.

Integrating mods keep working with or without this menu installed.

ACTIVELY DEVELOPED 

the API may still change and a new version may contain breaking changes. Even tho I try not to. This mod is thin for a reason, and its intended to stay that way.

Controllers currently - NOT - supported.

---

UE4SS Latest Experimental Build needs to be installed!

(last tested on: 3. 0. 1-1003)

For players

• []Install: drop the SharedModMenu folder into ...\Gothic 1 Remake\G1R\Binaries\Win64\ue4ss\Mods\[/]

  []Open: press F2[/]

  []Numpad: 8/2 select, 4/6 change value, 7/9 sub-tab, 1/3 mod tab, 5 confirm[/]

  []or use your mouse to control the menu[/]

Everything is rebindable, check it in Scripts\config.lua.

---

For mod authors

Copy modmenu.lua (from this mod's Scripts\) into your own Scripts\. 

You are gonna vendor/release this file with your own mod.

Thats basically your Schema File.

New Additions are not treated as breaking, however you might wanna still update and support new features at some point.

When something is about to be removed, it will be announced to mods having a requirement on this Mod in advance.

v1 - Initial Release

v2 - added item descriptions

v3 - added refresh api

Quick Start

local ok, modmenu = pcall(require, "modmenu")

if ok and modmenu then

modmenu.register("MyMod", {

{ name = "God Mode", kind = "bool", desc = "Take no damage",

get = function() return cfg.god end,

set = function(v) cfg.god = v end },

{ name = "Move Speed", kind = "num", min = 0. 1, max = 5, step = 0. 1,

get = function() return cfg.speed end,

set = function(v) cfg.speed = v; applySpeed() end },

{ name = "Reset", kind = "action", set = function() resetAll() end },

you can register sub-tabs/sections like this:

modmenu.register("MyMod", {

{ title = "Combat", items = { ... } },

{ title = "World",  items = { ... } },

Dynamic Menus: requestRefresh

Use it when your mod's menu items change at runtime, for example a list that grows or entries that appear after a load.

The contract is three steps: update your state, re-register your spec, then request the refresh.

modmenu.register("MyMod", buildSpec())

if modmenu.requestRefresh then modmenu.requestRefresh() endUpdates are polled the same way as initial registering, a very small delay upon registering and refreshing is currently not preventable.

State Handling

Your mod is supposed to stay the single source of truth.

The menu does not handle any kind of persistence layer.

Values are not saved unless you allow them to be. Thats your domain.

Supported Types

• []bool - an on/off toggle.[/]

  []num - a [-]/[+] stepper, plus a click-to-set bar when you give min+max (with step).[/]

  []action - a [ RUN ] button, set is called when clicked.[/]

---

How it works

UE4SS runs each Lua mod in its own isolated state, so modmenu.lua bridges registrations through UE4SS shared variables and a light per-mod poll applies your menu edits. That single file is fully self-contained, standard Lua plus the UE4SS globals it needs.

The panel itself is plain UMG, just built at runtime from Lua through UE4SS reflection instead of loaded from a cooked .pak. That means no Unreal Editor, no Blueprint assets and nothing to repackage. Change the Lua, hotreload, see it changed. Rather than recooking and shipping a widget each time with Blueprint Injection.

Until official Modding SDKs arrive, I figured this is the simplest and most maintainable way to give people a shared mod menu. And by keeping the menu fully separated from the mods code, it will be easy to move away from l