Getting Started

Overview

XCore is the central framework that powers all X addons. It provides shared infrastructure so addons don't need to implement their own database, cache, sync, GUI, or economy systems.

What XCore provides

  • 3-Layer Cache — Caffeine (L1 local) → Redis (L2 shared) → Database (L3 persistent)
  • Cross-Server Sync — Redis Pub/Sub or database polling, multiplexed for all addons
  • Multi-Database — MySQL, PostgreSQL, SQLite with HikariCP pooling
  • GUI Framework — YAML-driven inventories with pagination, animations, sounds, actions
  • Language System — Per-addon MiniMessage lang files with automatic default merging
  • Built-in Economy — Multi-currency with Vault provider, exchange, history
  • Web Dashboard — HTTP server with REST API, module system for addons
  • Addon System — Load/enable/disable/reload addons from plugins/XCore/addons/
  • Folia Compatible — Full region threading support via SchedulerAdapter

Requirements

  • Paper 1.21.1+ (or Folia)
  • Java 21+
  • Vault — Required for the economy system
  • PlaceholderAPI — Optional, for placeholders

Installation

  1. Place XCore.jar in your server's plugins/ folder.
  2. Place addon JARs in plugins/XCore/addons/.
  3. Start the server. XCore generates plugins/XCore/config.yml.
  4. Configure the database, Redis, economy, and web dashboard.
  5. Each addon gets its own config at plugins/XCore/addons/<name>/config.yml.
Configuration