SyncCord

SyncCord

The Modern Minecraft-Discord Integration Plugin

SyncCord is a high-performance, deeply customizable plugin that builds a bridge between your Minecraft server and your Discord community. It seamlessly connects the two platforms in real-time, from chat messages to administrative commands.

---

Key Features

• Two-Way Chat Relay: Minecraft chat messages instantly appear in a dedicated Discord channel, and vice-versa. The plugin handles formatting, colors, and ping prevention.
• Advanced Command Relay: Execute server commands directly from Discord! Using the ? prefix, you can issue any console command if you have the required Discord role.
• Secure Account Linking: A simple, code-based system (/discord link -> ?dclink <code>) allows players to securely link their Minecraft and Discord accounts.
• Automatic Role Synchronization: The plugin uses the LuckPerms API to automatically synchronize player ranks. Upon account linking and rank changes, the corresponding Discord role is assigned automatically.
• Event Notifications: Important server events (server start/stop, player join/leave) are displayed as formatted, embedded messages in Discord.
• Console Relay: Server console log messages (INFO, WARN, ERROR) can be forwarded to a separate Discord channel, aiding in server administration.
• Extreme Customization: In the config.yml file, nearly every message, format, color, and operational parameter can be customized, from the appearance of the Minecraft-Discord chat to the messages posted after moderation commands.
• Reload Command: The plugin can be reloaded without a server restart using the /synccord reload command.

---

Installation and Setup

Step 1: Create a Discord Bot

1. Go to the Discord Developer Portal and create a New Application.
2. In the Bot menu, click the Add Bot button.
3. Under the bot's settings, enable the following Privileged Gateway Intents:
   • SERVER MEMBERS INTENT
   • MESSAGE CONTENT INTENT
4. Click the Reset Token button, then copy the token that appears. Treat this token like a password and never share it with anyone!
5. In the OAuth2 -> URL Generator menu, select the bot and applications.commands scopes.
6. In the Bot Permissions section, grant the necessary permissions (minimum: Send Messages, Read Message History, Manage Roles, Embed Links).
7. Copy the generated URL and use it to invite the bot to your Discord server.

Step 2: Configure the Plugin

1. Place the SyncCord.jar file into your server's plugins folder.
2. Start the server to generate the plugins/SyncCord/config.yml file.
3. Stop the server.
4. Open the config.yml file and fill in the required fields:

   # The token you copied from the Discord Developer Portal
   BotToken: "PASTE_YOUR_BOT_TOKEN_HERE"
   
   Channels:
     # Where chat and events will appear
     chat: "DISCORD_CHAT_CHANNEL_ID"
     # Where console logs and commands are handled
     console: "DISCORD_CONSOLE_CHANNEL_ID"
   
   RoleSync:
     enabled: true
     roles:
       # Minecraft Group Name: "Discord Role ID"
       default: "123456789012345678"
       admin: "098765432109876543"
   
   ConsoleRelay:
     commands:
       enabled: true
       allowedRoles:
         # Discord roles that can use commands
         - "SERVER_ADMIN_ROLE_ID"
   

5. Start the server again. If everything is configured correctly, your bot will be online and the plugin will be operational!

---

Commands

Minecraft Commands

• /discord link - Generates a one-time code to link your account.
• /discord unlink - Unlinks your Minecraft and Discord accounts.
• /synccord reload - Reloads the plugin's configuration files.

Discord Commands

The commands use the prefix set in config.yml (default: ?).

• ?dclink <code> - Links your account using the code received in Minecraft.
• ?dcunlink - Unlinks your account.
• ?<command> [arguments] - Executes any server command if you have the required Discord role (e.g., ?kick Steve, ?say Hello World).

---

Permissions

• synccord.reload - Allows the use of the /synccord reload command.

Dependencies

• LuckPerms: Required for role synchronization. The plugin will run without it, but rank-related features will be disabled.