Wiki 9Minecraft Wiki 9Minecraft

Configuration API Wiki & Guide

Java EditionModGuides 4FAQ 10Related mods 48

Configuration API introduces annotation based configs which can use various file formats such as yaml, json or properties.

DownloadConfiguration API

Get the files on 9Minecraft

Contents (6)
  1. Guides
  2. Configuration
  3. Description
  4. Frequently asked questions
  5. Gallery
  6. You May Also Like

Guides

Step-by-step, in-game.

Editing Config Files by Hand (YAML, JSON, and Properties)Where the Files Live Configuration API stores each mod's settings in a file whose format the mod author chose: YAML ,…How to Open and Edit a Mod's Config Screen In-GameFinding the Config Button On Forge and NeoForge, open the Mods menu from the main menu or pause screen. Each…Resetting a Config to Defaults or Recovering a Broken ConfigResetting Through the GUI Most Configuration API screens include a reset action in the Footer . Depending on the mod,…Understanding Server-to-Client Config Sync (Why Some Options Are Greyed Out)What Synchronization Does Configuration API can automatically push server-side config values to every connected…

Configuration

Every setting in the mod config file, with what it changes.

OptionWhat it does
add_elementAdd element
advanced_modeAdvanced modeWill toggle rendering of advanced configuration fields for all mods
applyApply
backBack
character_value_emptyCharacter field cannot be empty!
configurationConfiguration options
configuration-testDevelopment-only test config
falseDisabled
trueEnabled
hide_backgroundHide backgroundHides config screen background, can be useful for various HUD element configuration adjustments. Does nothing in main menu
not_enough_argumentsNot enough command arguments
openOpen
restart_requiredRequires game restart to be applied
revertRevert changes
revert_defaultRevert to default
save_and_closeSave & Close
configs_savedSaved successfully
color_dialogSelect color
select_configSelect config
synchronizedServer-side controlled

Description

OptionWhat it does
advancedAdvanced
game_restartAfter game restart
noneAlways
main_menuIn main menu

See all 32 settings →

Frequently asked questions

How do I open a mod's config screen in-game?
Open the Mods menu, then click the Config button next to the mod (Forge/NeoForge) or use ModMenu and click the config icon on the mod's entry (Fabric). The screen opens with Header, Content, and Footer sections for editing that mod's options.
Why is the Config button missing for some mods?
Only mods that actually use the Configuration API and register a config screen will show a Config button. If a mod has no config or doesn't use this API, there's nothing to open, so no button appears.
Why are some options greyed out and I can't change them?
Those options are server-synchronized, meaning the server's value overrides yours while you're connected. Disconnect from the server (or change them in singleplayer) to edit them, since the server pushes its values to clients on join.
What does @Configurable.Synchronized actually do?
It marks a config field so the server automatically sends its value to every connecting client. Clients then display and use the server's value instead of their own local one, which is why the option becomes read-only in-game.

See all 10 Configuration API questions ›