Installation & Setup

Welcome to the DiscordFlow Wiki. This guide will walk you through the entire process of setting up the plugin, from creating your Discord Bot to configuring it on your server.

Requirement: Java 11 or Newer
DiscordFlow requires your Minecraft server to be running on Java 11 or a newer version. This is necessary to support the modern Discord API library.

Step 1: Create Your Discord Bot

Before installing the plugin, you need to create a "Bot Application" on Discord's website.

  1. Go to the Discord Developer Portal and log in.
  2. Click the "New Application" button in the top right and give it a name (e.g., "My Server Bot").
  3. Navigate to the "Bot" tab on the left-hand menu.
  4. Click "Add Bot", then confirm by clicking "Yes, do it!".
  5. Get Your Token: Under the bot's username, click "Reset Token". Copy this token and save it somewhere safe. You will need it for the secret.yml file.
    Never share your bot token. It is a password.
  6. Enable Privileged Intents: Scroll down to the "Privileged Gateway Intents" section. You MUST enable these three intents for the plugin to function correctly:
    • PRESENCE INTENT
    • SERVER MEMBERS INTENT
    • MESSAGE CONTENT INTENT

Step 2: Invite The Bot to Your Server

Now you need to generate an invite link to add the bot to your Discord server.

  1. In the Developer Portal, go to "OAuth2" -> "URL Generator".
  2. In the "Scopes" box, check the box for bot.
  3. A new "Bot Permissions" box will appear below. Check the following permissions:
    • Send Messages
    • Embed Links
    • Read Message History
    • Manage Webhooks (For player avatars in chat)
    • Connect (For Proximity Voice)
    • Move Members (For Proximity Voice)
  4. Scroll to the bottom, copy the Generated URL, and paste it into your browser.
  5. Select your Discord server from the dropdown and click "Authorize". The bot will now appear in your server's member list (offline).

Step 3: Install and Configure the Plugin

The final step is to install the plugin on your Minecraft server.

  1. Download the appropriate DiscordFlow-Spigot.jar, -Bungee.jar, or -Velocity.jar file.
  2. Place the JAR file in your server's /plugins directory.
  3. Start your server once. This will generate the necessary configuration files in the /plugins/DiscordFlow/ folder.
  4. Stop your server.
  5. Add Your Token: Open the secret.yml file and paste the bot token you copied in Step 1.
    bot-token: "YOUR_BOT_TOKEN_HERE"
  6. Set Your Channel ID: Open config.yml. You need to tell the plugin which Discord channel to use for chat.
    • In Discord, go to User Settings -> Advanced and enable Developer Mode.
    • Right-click on the text channel you want to use for chat and click "Copy Channel ID".
    • Paste this ID into the main-channel-id setting in config.yml.
    discord:
      main-channel-id: "123456789012345678"
  7. Start your server again. If everything is configured correctly, your bot will come online in Discord, and you will see a "Successfully logged in" message in your server console.
Setup Complete!
Your basic chat bridge is now working. You can now explore the other configuration files like discord-messages.yml, console.yml, and role-sync.yml to enable and customize more advanced features.