Skip to main content

​
uxmDiscordSync Plugin Guide

This guide provides comprehensive instructions for setting up and configuring the uxmDiscordSync plugin for your Minecraft server, creating a seamless integration between your Minecraft server and Discord community.

​
What is uxmDiscordSync?

uxmDiscordSync is a powerful Minecraft plugin that connects your Minecraft server with your Discord server, offering features like:
  • Account linking between Minecraft and Discord
  • Role synchronization between Discord roles and Minecraft ranks
  • Discord presence showing your server status
  • In-game commands to manage Discord features
  • Special rewards for Discord server boosters
  • Custom Discord commands for server information

​
Prerequisites

Before installing uxmDiscordSync, you’ll need:
  • A Minecraft server running Spigot, Paper, or a compatible fork (1.19.4 or newer)
  • A Discord server where you have Administrator permissions
  • A Discord bot application (we’ll help you create one)
  • Basic understanding of file editing

​
Step-by-Step Installation Guide

​
1. Creating a Discord Bot

First, you need to create a Discord bot application:
  1. Go to Discord Developer Portal
  2. Click “New Application” and give it a name (like “MyServerBot”)
  3. Navigate to the “Bot” tab and click “Add Bot”
  4. Under the “Privileged Gateway Intents” section, enable:
    • Presence Intent
    • Server Members Intent
    • Message Content Intent
  5. Under “TOKEN” section, click “Copy” to copy your bot token (keep this secret!)
  6. Go to the “OAuth2” tab, then “URL Generator”
  7. Select scopes: bot and applications.commands
  8. Select permissions:
    • Manage Roles
    • Manage Nicknames
    • Read Messages/View Channels
    • Send Messages
    • Read Message History
    • Add Reactions
  9. Copy the generated URL and open it in your browser
  10. Select your Discord server and authorize the bot

​
2. Installing the Plugin

  1. Download uxmDiscordSync plugin from a trusted source
  2. Place the plugin JAR file in your server’s plugins directory
  3. Start your server once to generate default configuration files
  4. Stop your server after files are generated

​
3. Basic Configuration

  1. Open the plugins/uxmDiscordSync/config.yml file
  2. Set your Discord bot token in the token field
  3. Find your Discord server (guild) ID:
    • Enable Developer Mode in Discord (User Settings → Advanced → Developer Mode)
    • Right-click on your Discord server icon → “Copy ID”
    • Paste this ID in the discord-guild-id field
  4. Create a channel for account linking:
    • Create a new channel in your Discord server (e.g., #minecraft-link)
    • Right-click the channel → “Copy ID”
    • Paste this ID in the discord-link-channel-id field
  5. Create a role for linked accounts:
    • Create a new role in your Discord server (e.g., “Minecraft Player”)
    • Right-click the role → “Copy ID”
    • Paste this ID in the discord-linked-role-id field
  6. Save the configuration file
  7. Start your server

​
Configuration Files Explained

​
Main Configuration (config.yml)

token: "YOUR_BOT_TOKEN_HERE"  # Your Discord bot token
presence: '%server_online% players are online'  # Bot status message
presence-type: playing  # Bot status type (playing, watching, listening)

broadcast-prefix: '&8[&bAnnouncement&8]&r '  # Prefix for broadcast messages

database:
  enabled: true
  database-type: FLAT  # FLAT for file storage, MYSQL for database
  auto-save-interval: 30  # Save data every 30 minutes
  mysql-settings:  # Only needed if using MYSQL
    user: <user>
    url: jdbc:mysql://localhost:3306/<databasename>?useSSL=false&autoReConnect=true
    password: <password>
    table: discord

# Discord server configuration
discord-guild-id: YOUR_GUILD_ID_HERE  # Your Discord server ID
discord-link-channel-id: YOUR_CHANNEL_ID_HERE  # Channel for account linking
discord-linked-role-id: YOUR_ROLE_ID_HERE  # Role given to linked accounts

# Optional reward for Discord boosters
boost-prize-cooldown: 1440  # in minutes (24 hours)
boost-prize-commands:
  - 'give %player% diamond 5'  # Example command

# Rank synchronization
rank-sync:
  vip:  # In-game rank name
    discord-role-id: YOUR_ROLE_ID_HERE  # Discord role ID for VIP
    commands:
      - 'lp user %player% parent add vip'  # Example command
  vip+:
    discord-role-id: YOUR_ROLE_ID_HERE
    commands:
      - 'lp user %player% parent add vipplus'

​
Custom Commands (customcmds/server.yml)

uxmDiscordSync allows you to create custom Discord commands that display server information: 
data:
  name: 'server'  # Command name
  command-description: 'Sends info about server'  # Command description
  color: '#42bff5'  # Embed color
  title: 'Server Info'  # Embed title
  thumbnail: ''  # Optional thumbnail image URL
  description: ''  # Optional description
  footer: ''  # Optional footer
  footer-icon: ''  # Optional footer icon
  sent-message: 'Info sent!'  # Message shown after command use

  fields:  # Information fields in the embed
    1:
      name: Our web site
      value: 'example.com'
    2:
      name: IP Address
      value: 'play.example.com'
    3:
      name: Online player count
      value: '%server_online%'  # PlaceholderAPI support

​
Features and Usage

​
Account Linking

Players can link their Minecraft accounts to Discord:
  1. In Minecraft, run /discord link
  2. A unique code will be generated for the player
  3. The player sends this code in the Discord link channel
  4. Upon successful verification, accounts are linked
  5. The player receives the linked role in Discord

​
Commands

​
Minecraft Commands:

  • /discord link - Start the linking process
  • /discord unlink - Remove your Discord link
  • /discord info [player] - View link info for yourself or another player
  • /discord boostprize - Claim your Discord booster reward (if available)
  • /discord nick <options> - Change your Discord nickname:
    • /discord nick <new name> - Set custom nickname
    • /discord nick matchIngame - Match Discord name to Minecraft name
    • /discord nick addAsSuffix - Add Minecraft name as suffix

​
Discord Commands:

  • /info [minecraft_username] - Show link information for a player
  • /server - Display server information (if configured)
  • Other custom commands as configured in your setup

​
Rank Synchronization

When properly configured, the plugin can:
  • Give Discord roles to players based on their in-game ranks
  • Execute commands when a linked player receives specific Discord roles

​
Booster Rewards

Players who boost your Discord server can claim in-game rewards:
  1. The player boosts your Discord server
  2. In Minecraft, they use /discord boostprize
  3. If eligible, they receive the configured rewards

​
Troubleshooting

​
Common Issues:

ProblemSolution
Bot doesn’t come onlineCheck if your token is correct and the bot has proper permissions
Can’t link accountsEnsure the link channel ID is correct and the bot has access to read messages there
Role sync not workingVerify role IDs are correct and the bot has “Manage Roles” permission
Commands don’t workCheck if the plugin is properly installed and the bot has necessary permissions
Database errorsIf using MySQL, verify connection details are correct

​
Still Having Issues?

  • Check console for error messages
  • Ensure all IDs in config are correct
  • Verify the bot has all required permissions
  • Make sure the bot’s role is higher than roles it needs to assign

​
Support and Contact

For additional assistance with uxmDiscordSync configuration: