Ash API — Guide

What It Provides

Ash API groups its services into a small number of areas:

• Loader information — which loader is running, whether a given mod is installed, whether the game is in a development environment, and where the game and config folders live.
• Mod options — a small JSON config system that reads and writes a file per mod, falls back to defaults when the file is missing or damaged, and replaces the file automatically when a mod raises its config version.
• Options screen — a ready-made screen class for showing a mod's settings, plus a registry so that screen can be opened straight from the in-game mod list.
• Key bindings — registering a key that shows up in the normal Controls screen under the category the mod chooses.
• Client tick events — callbacks that run before and after each client tick.
• Resource loading — registering a listener that runs whenever resource packs are reloaded.
• Block interaction — a callback that fires when a player right-clicks a block, which can allow or cancel the interaction.

Key Bindings

Keys registered through Ash API appear in Options → Controls → Key Binds, in whichever category the mod picked. Vanilla category names such as Movement, Gameplay, Inventory, Multiplayer and Miscellaneous are reused where a mod asks for them, and a mod can also create its own category, which then appears as its own heading in the list.

Rebinding works exactly as it does for vanilla keys — click the binding, press the new key, and use Reset to return it to the mod's default. Conflicts are shown the same way too.

Frequently Asked Questions

Does Ash API add anything to the game? No. It has no items, blocks, mobs, recipes or world generation, and it does not alter game balance.

Will it affect performance? No measurably. It registers a few callbacks and reads small config files at startup.

Do I need it if none of my mods mention it? No. It is only useful to mods built against it.

Is it safe to remove? Yes, as long as you also remove the mods that require it. Removing it while such a mod is still installed will stop the game from loading.

Can it be used on a server? Yes. Install it on the server whenever a mod that depends on it is installed there.

Where are its own settings? It has none. The config files it manages belong to the mods that use it.