Vanilla Options API

Allow mods to use vanilla's systems to add custom options

173 Downloads

fabriclibraryutility

About this Mod

Library that easily allows mod developers to create custom options using vanilla's systems, and add options to vanilla's option screens.

Code example:

public class MyMod implements ClientModInitializer {
  private static final OptionInstance<Boolean> OPTION = ...;

  public static OptionInstance<Boolean> option() {
    return OPTION;
  }

  @Override
  public void onInitializeClient() {
    Identifier optionId = Identifier.fromNamespaceAndPath("modid", "custom_option");
    VanillaOptionsAPI.register(optionId, OptionsMenuLocation.ACCESSIBILITY, MyMod::option);
  }
}

The following would add a boolean option that saves to options.txt as modid.custom_option, appearing in the accessibilty options menu.

Available Versions

Vanilla Options API 1.2.0release

MC 26.2-pre-2, 26.2-pre-3, 26.2-pre-4, 26.2-pre-5, 26.2-pre-6, 26.2-rc-1, 26.2-rc-2, 26.2fabric

May 28, 2026

Vanilla Options API 1.1.0release

MC 26.1-pre-3, 26.1-rc-1, 26.1-rc-2, 26.1-rc-3, 26.1, 26.1.1-rc-1, 26.1.1, 26.1.2-rc-1, 26.1.2fabric

March 22, 2026

How to Install Vanilla Options API on Your Server

Order Server

Order a Minecraft Java server with at least 3 GB RAM (4 GB recommended).

Set fabric Loader

In the panel under "Egg", select the fabric loader and matching Minecraft version (26.2).

Install Mod

Open the mod browser in the dashboard and search for "Vanilla Options API". Click "Install" – done! Alternatively, upload the .jar via SFTP to the /mods folder.

Compatibility

Mod Loaders

fabric

Minecraft Versions

26.2, 26.2-rc-2, 26.2-rc-1 (+18 more)

Server-side

✗ Unsupported

Recommended RAM

4 GB(min. 3 GB)

Frequently Asked Questions

Vanilla Options API server crashes on startup – what to do?

Most common cause: wrong fabric version or insufficient RAM. Check the server log (latest.log) for "OutOfMemoryError" or "Mixin" errors. With Mado Hosting: ensure at least 3 GB RAM is allocated and the loader matches the mod version (26.2). You can switch loaders with one click in the panel.

Is Vanilla Options API compatible with fabric?

Vanilla Options API officially supports fabric for Minecraft 26.2, 26.2-rc-2, 26.2-rc-1. The Mado dashboard automatically detects incompatible loader combinations.

Server lagging with Vanilla Options API – how to optimize performance?

Recommended RAM: 4 GB (per 8 players). Use /spark profiler to check if Vanilla Options API consumes the most tick time. Common fixes: reduce server view-distance to 8-10, install "performant" or "starlight" as supplementary mods on Forge. With Mado Hosting, your server runs on NVMe SSDs with dedicated CPU cores for minimal latency.