Getting Started¶

This mod isn't exactly plug and play, you'll need to do a bit before it's ready. Thankfully, most of it is pretty easy!

Making a bot account¶

Before your bot can bridge chat, it needs to get a bot account to represent itself when communicating. Making a bot account is pretty easy, and costs nothing. All you need is an existing Discord account!

1. Firstly, you need to log in into the Discord Developer portal with your Discord account: https://discord.com/developers/applications

   

   

2. Now click "New Application" to make an application and give it a name.

   You'll see this name on top of all system messages, and if you're not using webhook mode, all chat messages as well. Don't worry too much about it, you can change it at any time!

   Example

   If you're stumped for naming ideas, you could name your bot after your server name. For example, a server named the "Vanilla SMP" could have a bot called "Vanilla SMP".

3. You should now be at the bot's General Information tab.

   Here you can give your bot an App Icon and fill in its Description. You'll see the App Icon when you see the bot, and you'll see the description whenever you click the bot's name.

   

4. Now, head over to the Bot tab.

   Here you can click Reset Token and then note down the Bot Token somewhere safe. You will need it soon!

   Danger

   Do not, under any circumstances, share this Bot Token with anyone you do not trust to control the bot. The Bot Token is like a password for your Discord Bot. Anyone who has access to it can control the Bot. If a bot breaks community guidelines, there's a good chance the bot owner (YOU!) will be the one who is punished.

   If you ended up accidentally exposing the Bot Token, generate a new one by clicking Reset Token again as soon as possible. You will have to change the mod's config to use the new token.

   

Now that you've got a bot token, you can move on to setting up the mod.

Setting up the mod¶

1. Firstly, if you haven't already, download the latest release of this mod from Modrinth, CurseForge or GitHub Releases. Place the mod (like any other mod) into the mods folder of your server.

2. Now start the server once, let it finish starting and then immediately shut it down.

   Info

   This will generate the default configuration files.

3. Find the config file at config/APDiscordIntegration/main.yaml and then open it in your favourite text or config editor (or your host's web editor). You should see something like the below:

   config/APDiscordIntegration/main.yaml

   #   Main Configuration
   #   Please read this entire configuration page before using the mod
   
   # You will most likely need to change all settings in this section
   general:
   # Bot Token:
   # This is what the mod uses to control the Discord bot account.
   # DO NOT SHARE WITH ANYONE!
   botToken: BOT TOKEN GOES HERE
   
   # Channel ID to work in:
   # To obtain this, turn on developer mode in your discord client
   # then right-click the channel and choose 'Copy Channel ID'
   channelID: CHANNEL ID GOES HERE
   
   # Whether or not to use Webhooks:
   # Using webhooks makes chat messages look like they came from the attached player
   # (but with a BOT tag next to their name)
   # Not using webhooks make chat messages come directly from the bot account
   useWebhooks: false
   

4. Replace BOT TOKEN GOES HERE with the Bot Token you got from above!

5. Replace CHANNEL ID GOES HERE with the Channel ID of the channel you want to bridge to Minecraft.

   a. To find your Channel ID, first you need to go into your Discord Settings. Then go to the Advanced settings tab and enable Developer Mode

   Tip

   Developer mode is a feature that allows you to see extra information like the IDs of various entities, like channels. If you must, you can turn it off after getting your channel ID.

   

   

   b. After enabling Developer Mode, open up your server and right-click the channel you want to link. In the context menu, you should now see a new item called Copy Channel ID. Click it to copy your Channel ID.

   c. After copying your Channel ID, paste it into the config replacing CHANNEL ID GOES HERE.

6. If you would like to use Webhook Mode, set useWebhooks to true, otherwise, keep it at false.

7. Now, start the server once. Look in the server logs for something like a Invite URL.

   

   a. Copy this Invite URL and either send it to whoever's adding the bot, or open it in a new tab. This is the link you use to add the bot.

8. After adding the bot, restart the server.