Skip to content

Getting Started

Jump to bottom
Ali Arslan edited this page Apr 11, 2026 · 4 revisions

Getting Started

This page walks you through installing uxmDiscordSync on a Paper server from scratch.

Requirements

Requirement Version
Paper / Spigot 1.21+
Java 21+
Discord Bot Any (requires Admin intent or specific permissions)
LuckPerms Optional — required for rank synchronization
PlaceholderAPI Optional — enables %statistic_*% and third-party placeholders in custom commands

Step 1 — Create a Discord Bot

  1. Go to the Discord Developer Portal and create a new Application.
  2. Navigate to Bot and click Add Bot.
  3. Under Privileged Gateway Intents, enable:
    • Server Members Intent
    • Message Content Intent
  4. Copy the Token — you will need it for config.yml.
  5. Navigate to OAuth2 → URL Generator. Select the bot and applications.commands scopes, then check at minimum: Manage Roles, Manage Nicknames, Kick Members, Ban Members, Moderate Members, Send Messages, Embed Links, Read Message History, Use Slash Commands.
  6. Open the generated URL to invite the bot to your Discord server.

Step 2 — Install the Plugin

  1. Download the latest uxmDiscordSync-x.x.x.jar from the releases page.
  2. Drop the JAR into your server's plugins/ folder.
  3. Start the server once to generate the default configuration files under plugins/uxmDiscordSync/.
  4. Stop the server before editing the configuration.

Step 3 — Minimum Configuration

Open plugins/uxmDiscordSync/config.yml and fill in at minimum:

discord:
  token: "YOUR_BOT_TOKEN_HERE"
  guild-id: "YOUR_GUILD_ID_HERE"

To find your Guild ID: in Discord, go to User Settings → Advanced and enable Developer Mode. Then right-click your server and choose Copy Server ID.

Step 4 — Configure the Linking Channel

The plugin posts a persistent "Link Account" button embed in a dedicated channel.

discord:
  linking:
    channel-id: "CHANNEL_ID_HERE"

Create a private channel in Discord (visible only to members who need to link), then right-click it and Copy Channel ID.

Step 5 — Start the Server

Start your server. You should see log messages like:

[uxmDiscordSync] Connecting to Discord...
[uxmDiscordSync] Discord bot connected as YourBot#0000
[uxmDiscordSync] Plugin enabled successfully!

If you see warnings about a missing token or guild ID, double-check config.yml.

Step 6 — Link Your Account (Test)

  1. Join your Minecraft server and run /link.
  2. You will receive a 6-digit code in chat.
  3. In Discord, go to the linking channel and click Link Account.
  4. Enter the 6-digit code in the modal that appears.
  5. You should receive a confirmation message.

Directory Structure

After the first start, the plugin creates:

plugins/uxmDiscordSync/
├── config.yml                  # Main configuration
├── commands.yml                # Command aliases and permissions
├── advanced.yml                # Performance, cache, security
├── boost-rewards.yml           # Boost reward commands
├── rank-sync.yml               # Rank-to-role mappings
├── level-system.yml            # Level system XP and rewards
├── two-factor.yml              # 2FA configuration
├── punishment-sync.yml         # Punishment sync settings
├── logging.yml                 # Webhook logging configuration
├── discord-custom-commands.yml # Enable/disable custom commands
├── languages/
│   ├── en_US.yml
│   └── tr_TR.yml
└── discord-commands/           # Custom Discord command definitions
    ├── ip.yml
    ├── profile.yml
    ├── stats.yml
    ├── balance.yml
    └── store.yml

Reload

After making configuration changes, run in-game or in console:

/uxmdiscordsync reload

This reloads all config files without restarting the server. Note: some settings (database type, bot token) require a full server restart to take effect.

Next Steps

🏠 Home

⚙️ Setup

🔗 Core Systems

✨ Features

📋 Logging

💬 Commands

🔧 Advanced

Clone this wiki locally