Sodium Options API Mod FAQ

It reorganizes and extends the Sodium options menu so mods can add their own settings pages directly inside it instead of opening separate config screens. You get a cleaner layout with dropdown categories and better-organized pages.

Open Sodium's video settings the same way you normally would, and the API-driven layout will appear in place of the default one. Any mod that supports the API will have its pages listed alongside Sodium's own categories.

That mod likely doesn't use the Sodium Options API, so it still opens its own separate config screen. Only mods built against the API appear as pages inside Sodium's menu.

Categories in the options menu can collapse into dropdowns, so you expand only the section you want instead of scrolling through everything. This makes long option lists much faster to navigate.

No, it's an extension of Sodium's options menu, so Sodium needs to be present for it to do anything. Without Sodium there's no menu for it to modify.

It's designed to integrate mods into Sodium's menu rather than replace them, so most config mods coexist fine. If a mod has its own separate settings screen, that screen simply stays separate.

It only changes how the options menu is laid out and organized, so it doesn't touch rendering during gameplay. Any performance impact is limited to the menu itself, not in-world play.

Register your page through the API's events so it appears as a category inside Sodium's menu. The API handles the layout and dropdown behavior for you once your page is registered.

Usually the mod isn't registering its page through the API, or the API itself isn't loaded alongside Sodium. Check that both Sodium and the API are present and that the mod supports the API.

Only if that mod supports the Sodium Options API — you can't force an unsupported mod's screen into Sodium. For supported mods, the page shows up automatically once registered.