Ash API — Configuration

Configuration Files

Every mod that uses Ash API's options system gets its own JSON file in the game's config folder, named after that mod's id — for example config/examplemod.json.

The file is written the first time the mod runs, so you will not see it until you have launched the game once with the mod installed. You can edit it with any text editor while the game is closed.

Each file carries a version number. When a mod updates and raises that number, Ash API notices the file is out of date, replaces it with fresh defaults, and notes this in the log. That is expected behaviour, not an error — but it does mean a settings file can be reset by a mod update, so keep a copy if you have tuned it heavily.

If a file cannot be read at all — bad JSON after a manual edit, for instance — Ash API falls back to defaults and rewrites the file rather than crashing the game.

The In-Game Options Screen

Mods that register an options screen through Ash API can be configured without leaving the game. Open the mod list from the main menu, select the mod, and use its config button; the screen Ash API built for that mod opens directly.

The screen is a normal Minecraft options list, so it behaves like the vanilla Video or Controls screens: toggles cycle on click, sliders drag, and the changes are held until you leave the screen.

When you close it, Ash API writes the mod's config file, so what you set in-game and what is on disk stay in step. There is no separate save button.