Compatibility
Minecraft: Java Edition
Platforms
Creators
Details
Foundry is a plugin framework containing utilities for other plugins.
Users
You should only download Foundry if a plugin author has said you need it, they might compile their plugin with it already included! Please check the version your plugin requires before downloading.
Plugin Authors
Foundry is a system built for plugin authors, this version is for when you'd like to compile without Foundry.
We typically recommend shipping Foundry alongside your plugin in a single jar but if this is not an option for you, you can ask your users to download the plugin from here. It's easier to upgrade your version of Foundry if you ship it with your plugin and more user friendly but results in larger jar file sizes which won't be ideal if you develop multiple plugins that use Foundry, hence this version!
Before starting developing with Foundry you should check if you'd like to require users to download this plugin with yours, or if you'd like to ship them together in a single jarfile. Learn more on our Wiki.
Features
- File handling, a simpler interface for managing .yml files in your server.
- Plugin modules, allowing you to split your plugin into smaller sub-sections, allowing for easier code management. To the user, the plugin works the exact same. For you, it's easier to find and diagnose issues with your plugin.
- Simpler logging, improve your console outputs with simple log, warning, and error messages.
- Robust permissions handling
- Watchdog security system, keeping an eye out for potentially breaking reloads and shouting at admins to restart instead!
Requirements
- Foundry is designed to be used by plugin developers, some develop against specific versions of Foundry. You should check with them which version you need.
- Essence supports CraftBukkit, Spigot, Paper, and Folia; as well as forks of these.
- For specific Minecraft versions, please see the versions tab.
Wiki and Support
We have an open wiki available if you need help with anything, it contains information regarding all aspects of Essence and how to use it. Simply visit lewmc.net/wiki!
Not into Wikis? No problem! We also have a community Discord server that we regularly provide support in - visit lewmc.net/discord to join!
Contributing
If you like Foundry and you'd like to add something, feel free to contribute! We're over on GitHub at github.com/lewmc/foundry.