Developer API
Adding XCore as Dependency
XCore is available via JitPack:
Gradle
repositories {
maven { url 'https://jitpack.io' }
}
dependencies {
compileOnly 'com.github.Xyness:XCore:LATEST'
}Creating an Addon
Addons extend the XAddon class with lifecycle methods:
public class MyAddon extends XAddon {
@Override
public void onEnable() {
// Addon startup logic
getLogger().info("MyAddon enabled!");
}
@Override
public void onDisable() {
// Cleanup
}
@Override
public void onReload() {
// Handle config reload
}
}
Addons have full access to XCore's caching, database, GUI, language, and scheduler APIs.
GUI Framework
XCore provides a YAML-based GUI framework with:
- Pagination with customizable navigation buttons
- Per-item permissions and click actions
- Custom skulls, model data, and 1.20.5+ item models
- Sound effects and blink animations
- MiniMessage lore templates
Use GuiUtils helper methods for item creation, head textures, custom model data, and sound playback.