Skip to main content

Paper / Spigot Installation

Install XDiscordUltimate on a standalone Paper or Spigot server. The steps are identical for both platforms - the plugin ships as a single universal JAR.

Prerequisites

  • Paper or Spigot running Minecraft 1.16.5-1.21.x
  • Java 17 or higher on the server host
  • Server administrator access (console or op)
  • The XDiscordUltimate JAR from GitHub Releases

Installation Steps

1

Stop the server

Stop your server before adding the plugin:
stop
2

Copy the JAR into plugins

Place the JAR in the plugins directory:
cp XDiscordUltimate.jar /path/to/server/plugins/
3

Start once to generate config

Start the server. XDiscordUltimate generates its default config at:
plugins/XDiscordUltimate/config.yml
This file contains every module and setting with documented defaults. Stop the server again once it has generated.
First startup is slower because Libby downloads JDA, HikariCP, and the database drivers. See Installation Overview.
4

Set bot token and guild ID

Open plugins/XDiscordUltimate/config.yml and set the two required values:
discord:
  bot-token: "YOUR_BOT_TOKEN_HERE"
  guild-id: "123456789012345678"
  • bot-token - the token from the Discord Developer Portal
  • guild-id - right-click your server in Discord (Developer Mode on) and Copy ID
5

Restart

Start the server. The bot comes online in your guild within a few seconds. Confirm with /xdiscord status in console or in-game.

Platform Notes

Folia is not supported. XDiscordUltimate reports folia-supported: false. If you are running a Folia-based fork, switch to Paper or Spigot before installing.

Optional Plugin Hooks

XDiscordUltimate detects the following plugins as soft-dependencies. Install them before first start for the cleanest hook detection:
PluginUsed for
LuckPermsPermission groups, Discord role sync
PlaceholderAPIPlaceholders in chat bridge and embeds
VaultEconomy bridge module
Already running the server? Install the optional plugins, then run /xdiscord reload - the hooks are picked up on the next enable cycle.
XDiscordUltimate works in both online-mode=true and online-mode=false. Set it to whatever your network uses:
# server.properties
online-mode=true
There are no other Paper-specific settings required. The plugin reads what it needs at runtime.

Log Location

Server logs (including XDiscordUltimate output) are written to:
logs/latest.log
For verbose plugin output during setup, temporarily set general.debug: true in config.yml.

Next Steps

Bot Setup

Create the Discord application and grant privileged intents.

Configuration

Tune the 19 feature modules.