-
Notifications
You must be signed in to change notification settings - Fork 0
Getting Started
This page walks you through installing uxmDiscordSync on a Paper server from scratch.
| 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 |
- Go to the Discord Developer Portal and create a new Application.
- Navigate to Bot and click Add Bot.
- Under Privileged Gateway Intents, enable:
- Server Members Intent
- Message Content Intent
- Copy the Token — you will need it for
config.yml. - Navigate to OAuth2 → URL Generator. Select the
botandapplications.commandsscopes, then check at minimum:Manage Roles,Manage Nicknames,Kick Members,Ban Members,Moderate Members,Send Messages,Embed Links,Read Message History,Use Slash Commands. - Open the generated URL to invite the bot to your Discord server.
- Download the latest
uxmDiscordSync-x.x.x.jarfrom the releases page. - Drop the JAR into your server's
plugins/folder. - Start the server once to generate the default configuration files under
plugins/uxmDiscordSync/. - Stop the server before editing the 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.
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.
Start your server. You should see log messages like:
[UxmDiscordSync] [6/10] Starting Discord bot...
[UxmDiscordSync] Starting Discord bot...
[UxmDiscordSync] Connected to Discord guild: YourServerName
[UxmDiscordSync] Discord bot connected successfully!
[UxmDiscordSync] ╔══════════════════════════════════════════════════════════╗
[UxmDiscordSync] ║ UxmDiscordSync enabled successfully in 1234ms! ║
[UxmDiscordSync] ╚══════════════════════════════════════════════════════════╝
If you see warnings about a missing token or guild ID, double-check config.yml.
- Join your Minecraft server and run
/link. - You will receive a 6-digit code in chat.
- In Discord, go to the linking channel and click Link Account.
- Enter the 6-digit code in the modal that appears.
- You should receive a confirmation message.
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
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.
- Database Setup — Switch from the default Flatfile storage to MySQL or PostgreSQL
- Rank Synchronization — Map your LuckPerms groups to Discord roles
- Configuration Overview — Full breakdown of every config file
⚙️ Setup
🔗 Core Systems
✨ Features
📋 Logging
💬 Commands
🔧 Advanced