!promotion-img

XzCore

Shared configuration, storage and diagnostics for the XzPlugin suite.

XzCore provides common services used by dependent XzPlugins: loading configuration, rendering messages, storing data, scheduling tasks and checking service health. Install it when another plugin requires it. Gameplay features and economy rules belong to the dependent plugins.

What XzCore provides

• Configuration and messages: shared loading helpers and MiniMessage formatting.
• Storage: plugin-owned SQLite databases and migration helpers.
• Shared services: a registry that dependent plugins can access through the XzCore API.
• Items and menus: item templates, persistent item data and inventory layout utilities.
• Task scheduling: helpers that associate scheduled work with its owning plugin.
• Server diagnostics: readiness, database, registered-service and health information for administrators.

Installation

1. Check the required XzCore version in your dependent plugin's documentation.
2. Stop the server and back up existing plugin files, configuration and data.
3. Place the compatible XzCore JAR in the server's plugins folder. Keep only one active XzCore JAR.
4. Preserve existing configuration and data folders when upgrading.
5. Start the server, inspect the startup log, then run /xzcore info and /xzcore health.

Activate JAR updates with a full server restart. Players do not install XzCore on their clients.

Requirements and compatibility

• Minecraft server: 1.21.11.
• Server software: Paper or Purpur.
• Java: 21 minimum

Administrative commands

Command	Purpose
/xzcore info	Show version, readiness, database backend and services.
/xzcore health	Check core services and database availability.
/xzcore services	List registered services.
/xzcore data	Show storage diagnostics.
/xzcore reload	Reload supported configuration and messages. This does not replace a JAR restart.
/xzcore debug [on|off|toggle|status]	Manage debug logging.
/xzcore shutdown	Stop the entire server. Reserve this command for trusted administrators.

For developers

Declare XzCore as a dependency and access XzCore.getApi() after it has enabled. Use core.storage() for plugin-owned SQLite storage and migrations. Match the API version your plugin was built against with the installed XzCore release.