Back to 9Minecraft
Wiki 9Minecraft Wiki 9Minecraft
Sodium Options Api Wiki › Guides › How to Add a Custom Options Page to Sodium's Menu

How to Add a Custom Options Page to Sodium's Menu

What the API Gives You

Sodium Options API lets other mods register their own pages inside the Sodium video/options screen, so you don't have to fight Sodium's own layout. If you're a mod developer or you're configuring a mod that ships an integration, this is the path the page takes to appear.

Registering a Page

1. Make sure your mod depends on the Sodium Options API (and Sodium itself) in its metadata, otherwise the registration call will be ignored or crash on load.

2. Build an options page object using the API's page builder rather than constructing a raw Sodium screen. The builder handles the header, scroll area, and dropdown grouping for you.

3. Add your option groups to that page. Each group becomes a collapsible dropdown section, which is the main visual improvement over vanilla Sodium.

4. Register the page through the API's registration entry point during client initialization, not during common setup — the menu only exists on the client.

5. Launch the game and open Sodium's options. Your page should appear as a tab or entry alongside the built-in pages.

Common Pitfalls

  • Registering too early (before Sodium's screens are constructed) causes the page to silently not show.
  • Forgetting the client-only guard will crash dedicated servers.
  • If your page appears but options don't save, check that each option is bound to a real config value, not a local variable.