
Butterfly API
An API to simplify Math and Registries.
About this Mod
Butterfly API
Butterfly API is a simple helper API for my Fabric 1.20.1 mods.
It mostly exists to keep shared code in one place, instead of rewriting the same registry helpers, item group setup, client setup, math utilities, and plush systems for every mod I make.
What It Adds
Butterfly API adds helper systems for common modding tasks like registering items, blocks, sounds, entities, particles, enchantments, recipes, status effects, and other basic content.
It also includes helper code for creative tabs, client setup, simple gameplay math, and reusable plush blocks.
Plushes
Butterfly API includes a shared plush system used by some of my mods.
This makes it easier to add small placeable plush blocks with things like direction, waterlogging, honk sounds, squish behavior, and optional GeckoLib Animations.
For Developers
Butterfly API can be used by other Fabric mod developers who want access to the same helper systems I use in my own mods.
The GitHub page includes more information about the API, setup, usage, and examples for using it in your own project.
GitHub 1.20.1: https://github.com/SyntaxyBoi/Butterfly-API
GitHub 1.21.11: https://github.com/SyntaxyBoi/Butterfly-API-1.21.11
Also, Butterfly was recently moved to 1.21.11, and that is the version that future updates will be on. Some of my mods will still require 1.20.1 or older versions, but all new features and API updates will be on the 1.21.11 version.
Extra's
Butterfly API is not meant to be a huge library. It is just a small API made to support my mods, make repeated code cleaner, and give other developers access to some of the same tools I use.
Use this mod if another mod requires it, or if you want to use its helper systems in your own Fabric mod.
Available Versions
How to Install Butterfly API on Your Server
Order Server
Order a Minecraft Java server with at least 3 GB RAM (4 GB recommended).
Set fabric Loader
In the panel under "Egg", select the fabric loader and matching Minecraft version (1.21.11).
Install Mod
Open the mod browser in the dashboard and search for "Butterfly API". Click "Install" – done! Alternatively, upload the .jar via SFTP to the /mods folder.
Compatibility
Mod Loaders
Minecraft Versions
1.21.11, 1.21.1, 1.20.1
Server-side
✓ RequiredRecommended RAM
4 GB(min. 3 GB)Frequently Asked Questions
Butterfly API server crashes on startup – what to do?
Most common cause: wrong fabric version or insufficient RAM. Check the server log (latest.log) for "OutOfMemoryError" or "Mixin" errors. With Mado Hosting: ensure at least 3 GB RAM is allocated and the loader matches the mod version (1.21.11). You can switch loaders with one click in the panel.
Is Butterfly API compatible with fabric?
Butterfly API officially supports fabric for Minecraft 1.21.11, 1.21.1, 1.20.1. The Mado dashboard automatically detects incompatible loader combinations.
Server lagging with Butterfly API – how to optimize performance?
Recommended RAM: 4 GB (per 8 players). Use /spark profiler to check if Butterfly API consumes the most tick time. Common fixes: reduce server view-distance to 8-10, install "performant" or "starlight" as supplementary mods on Forge. With Mado Hosting, your server runs on NVMe SSDs with dedicated CPU cores for minimal latency.
Similar Mods
Rent Modded Server
Install Butterfly API with just one click on your server.