Skip to content

Vanilla Options API

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

Fabric
Loaders
Fabric
Downloads on Modrinth
394
Followers on Modrinth
1
versions
3
Updated
May 28, 2026May 28
Published
in 2026
This is a library — other mods need it, and it adds nothing to the game by itself

At a glance

A library: other mods need it
Runs on Fabric
For Minecraft 26.1–26.3
Client only — no need to install it on the server
Latest version — 1.2.0 from May 28, 2026
Requires Fabric API
Where it's needed
In gamerequiredOn servernot needed

Install in the game only; not needed on the server

Game versions26.1–26.3

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.

FAQ

How to install Vanilla Options API?

Install Fabric for your Minecraft version, download Vanilla Options API for the same version and loader, put the file into the mods folder and launch the game with the loader profile.

Which Minecraft versions does Vanilla Options API support?

Vanilla Options API has builds for Minecraft 26.1–26.3.

Is Vanilla Options API needed on the server?

Client only — no need to install it on the server

License and source
Creative Commons Zero v1.0 Universalfree to use and share with credit to the author
Original — Modrinth↗Files unchanged, verified with SHA-512Is this your mod? For rights holders

The site uses cookies: the necessary ones for sign-in and the theme, plus the Yandex Metrica and LiveInternet visit counters — they show us how the site is used. We have no advertising cookies. More