Skip to main content

​
Installation Overview

XDiscordUltimate is a single universal JAR that runs on Spigot and Paper 1.16.5-1.21.x. This page covers prerequisites and how to obtain the JAR; the platform-specific pages cover the rest.

​
Prerequisites

  • Java 17 or higher on the server host
  • Spigot or Paper running Minecraft 1.16.5-1.21.x
  • A Discord bot application with its token and privileged intents (see Bot Setup)
  • Internet access on first boot - the plugin downloads its runtime libraries via Libby

​
Get the JAR

1

Choose a source

Option A: Download from Releases (recommended)Download the latest JAR from GitHub Releases.Option B: Build from sourceClone the repository and build the shadow JAR. You need a Java 17 toolchain for the build:
git clone https://github.com/xreatlabs/XDiscordUltimate.git
cd XDiscordUltimate
./gradlew shadowJar
The built JAR is written to:
build/libs/XDiscordUltimate-1.2.0.jar
The Gradle build targets Java 16 bytecode for broader compatibility, but the compiler toolchain itself must be Java 17 or newer.
2

Drop into plugins

Copy the JAR into your server’s plugins directory:
cp XDiscordUltimate.jar /path/to/server/plugins/
3

Start once to generate config

Start the server. XDiscordUltimate creates plugins/XDiscordUltimate/config.yml with default values and the full module catalog, then disables itself until you provide credentials.
First boot takes longer. The plugin uses Libby to download its runtime dependencies - JDA 5.0.0-beta.18, HikariCP, and the database drivers - on startup. The first launch downloads these once and caches them. Subsequent starts are fast, but the first start requires internet access and a few extra seconds.

​
Platform Support

PlatformSupport
Spigot 1.16.5-1.21.x✅ Supported
Paper 1.16.5-1.21.x✅ Supported (recommended)
Folia❌ Not supported (folia-supported: false)
Folia is not supported. The plugin declares folia-supported: false and will not run correctly on Folia-based forks. Use Paper or Spigot.

​
Next Steps

Paper / Spigot

Server-side installation and minimal config.

Bot Setup

Create the Discord application and grant privileged intents.

Database

SQLite, MySQL, or PostgreSQL.

First Run

Verify everything is wired up.