Description of the image

Mod Menu Documentation

Mod Menu

Is designed to provide ONE configuration UI for in-game settings across mods. It is OPT-IN (meaning mod authors need to integrate our example mod in order for their settings to show up). Mod Menu is designed to allow for seamless setting changes without requiring server restarts, and to allow console players access to mod configuration options.

How To Use

Simply open the pause menu (ESC on PC) and navigate to the Mod Menu button. Interacting with this button will open the UI, where you can then search, sort by mod, and configure as much as you want. Simply hit the Save button once to save before closing the UI.

Mod Integration

Mod authors can navigate to our open source example mod here to learn how to integrate Mod Menu into their mods!