CrucialLib¶
CrucialLib is an open-source Spigot library that simplifies plugin development. It is maintained under ChafficPlugins as a fork of the no longer maintained CrucialAPI.
Features¶
| Feature | Description |
|---|---|
| Custom Items | Items with unique IDs, crafting recipes, and interaction control |
| Custom GUIs | Clickable inventory UIs with prefab components (toggles, yes/no buttons) |
| Localization | Key-based translations with YAML files and {0} placeholder substitution |
| JSON & YAML I/O | One-line file read/write for JSON objects and Bukkit YAML configs |
| Player Effects | Titles, tablist customization, blood screen effects, particles |
| Boss Bars | Timed boss bars with auto-removal |
| Server Utilities | Version compatibility checking and console logging |
| Auto-Updater | Automatic update checking and downloading via Spiget |
| bStats | Pie chart metrics wrapper |
Requirements¶
- Java 21 or higher
- Spigot/Paper 1.21 or higher
Quick Start¶
- Add CrucialLib as a dependency in your build tool
- Add
depend: [CrucialLib]to yourplugin.yml - Use any CrucialLib API in your plugin -- see the API Guide
Documentation¶
- Setup Guide -- Installation for server admins and developers
- API Guide -- Code examples for all major APIs
- Javadoc -- Generated API reference
- Migration Guide -- Upgrading from CrucialAPI or older versions
Supported Versions¶
| Version | Supported |
|---|---|
| 3.0.x | Yes |
| 2.2.x | No |
| 2.1.x | No |
| 2.0.x | No |
| 1.x.x | No |
Links¶
- Source code: github.com/ChafficPlugins/CrucialLib
- Releases: GitHub Releases
- License: GPL-3.0
- Discord: ChafficPlugins Discord
- Discussions: GitHub Discussions