Modrinth · Fabric, Forge, NeoForge · Client mod

Sodium Options API

Sodium Options API is a client-side mod. Install it on your computer; the server does not need it.

Config API for adding Sodium options with a better categories menu

Downloads
21.6M
Author
Txni
Loader
Fabric, Forge, NeoForge
Minecraft
1.20 – 1.21.5
Updated
–

Screenshots

What Sodium Options API looks like

Images: Sodium Options API on Modrinth, published by the project team.

Setup

Install Sodium Options API on your client

Client-side mods only run on your computer. More server RAM does not change their performance.

  1. 01

    Install the loader locally

    Install Fabric or Forge or NeoForge for your Minecraft version in your launcher.

  2. 02

    Download the file

    Download the Sodium Options API file for your loader and your exact Minecraft version, for example 1.21.5.

  3. 03

    Add it to the mods folder

    Put the .jar file in your local .minecraft/mods folder and remove older duplicates.

  4. 04

    Launch

    Launch Minecraft with the loader profile. Nothing needs to change on the server.

On the server
Not needed
On the client
Required
Loader
Fabric, Forge, NeoForge
Minecraft
1.21.5, 1.21.4, 1.21.1 +2 more
License
GNU Lesser General Public License v3.0 only

Releases

Published releases

Pick the file that matches your server’s loader and Minecraft version. The server and players need the same release.

Sodium Options API · Modrinth
Original description by the project author

banner

This mod adds cross-platform events for adding Sodium/Embeddium options menu integration. For example, you can add an option page to Embeddium on Forge, Fabric Sodium 0.5 on 1.20.1, and Fabric/NeoForge Sodium 0.6 on 1.21.1 with one event:

OptionGUIConstruction.EVENT.register((pages) -> pages.add(new TestOptionPage()));

If you're an end user, and you don't have this mod installed already as a library for another Sodium addon, you can install it alongside Reese's Options to get improved category menu, with drop-down support so that it's easier to navigate. This will take effect even for mods that don't use this API and inject into Sodium options directly.

demo

This mod is partially a fork of the Embeddium categories API and options events, with heavy changes to support upstream Sodium. While it makes changes to the Reese's Sodium Options menu, it does so via mixin for compatibility reasons, so you will need to install both.

Using the API

First, you will need to add this mod to your dev environment, using the Maven release for Curseforge or Modrinth.

modImplementation("maven.modrinth:sodium-options-api:version")

Then, this mod provides three events in toni.sodiumoptionsapi.api:

  • OptionGUIConstruction.EVENT, called once in the GUI constructor, allows adding entire pages. This is probably the one you want.
  • OptionPageConstruction.EVENT, called for each OptionPage. Use this if you want to add a group of toggles to the performance tab or something.
  • OptionGroupConstruction.EVENT, called for each group of options. Use this if you want to insert a single option into an existing group, or modify the vanilla ones.

FAQ

Sodium Options API questions

Question not listed? Ask our team.

Does Sodium Options API need to be installed on the Minecraft server?

No. Modrinth marks Sodium Options API as unsupported on the server side. Install it only in your local mods folder. Your server can stay unchanged unless the project page lists an additional dependency.

Which version and loader does Sodium Options API require?

Use a file for Fabric, Forge, NeoForge and your exact Minecraft version. Supported versions include 1.21.5, 1.21.4, 1.21.1. Files for different loaders are not interchangeable.

Sodium Options API is not working – what should I check?

First check the Minecraft version, loader version and required dependencies. Because the mod is client-side, more server RAM will not fix it.

Looking for mods for your own server?

The catalog lists mods that run on Minecraft servers.

Browse all mods