Description
📖 About
Compat API is a lightweight and universal compatibility framework for the entire “Compat” ecosystem by fixerlink — including Compat Delight, the upcoming Compat Artifacts, Compat Decor, and any third-party mod that wants an easy, automated way to add cross-mod integrations.
Instead of hardcoding compat logic or manually managing data packs, Compat API handles everything for you:
auto-loading compat code, injecting data packs, wrapping loot modifiers, applying conditions, and enabling integrations only when the required mods are installed.
***
📃 Features
- Smart Compat Scanner: Loads integrations only from mods that explicitly depend on Compat API.
- Automatic Compat Code Loading:
Detects compat modules in `net...compats.` and runs their register, init, or bootstrap hooks automatically.
- Automatic Data Pack Injection:
Loads content from `data///compats/` as built-in data packs — only when the target mod exists.
- Universal Loot Modifier System:
Adds compat conditions automatically and generates the global loot modifier list.
- Compatibility Conditions:
Built-in condition `compatapi:compat_enabled` ensures integrations load safely and only when appropriate.
- Per-Target Config Toggles:
Every compat module can be enabled or disabled individually via config.
- Safe & Clean System:
Compat errors never crash the game — they’re logged and gracefully skipped.
***
### 📝 Description
How it works:
You install Compat API.
That’s it.
If a mod depends on Compat API and includes compat modules, the API will:
- detect its compat code
- inject its compat data packs
- wrap its loot modifiers
- apply conditions
- and enable integrations automatically
If the target mod is missing — the compat simply won’t load. No errors, no crashes, no manual setup needed. Mods can freely add compat folders and classes — Compat API does all the heavy lifting. And of course, every integration can be toggled via config.
***
🎁 Bonus Info
- Mods that do not depend on Compat API are fully ignored
- All integrations load only when their target mods are present
- Errors in compat code never break the game
- Fully automated system: code, data packs, conditions, loot modifiers
- Supports thousands of integrations with minimal boilerplate
***
### 🧾 Credits
Compat API is developed by fixerlink as a universal standard for all Compat-series mods
and for developers who want clean, modular, and automated cross-mod integrations.
***
Feedback is welcome!
