Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Configuration

This section will cover how to get Dissonance running in it’s default configuration. If you’ve already done that, skip to the Extra Setup section.

What you need

  • Administrator access to the Minecraft and Discord servers you are connecting
    • On Minecraft, you need editing access to the config/dissonance-server.toml file (and access to the console, preferably)
    • On Discord, you need permissions to invite the bot and give it several permissions (send messages, manage webhooks, etc.)

Installing the Mod

Head over to the Modrinth page and download the latest release for either NeoForge or Fabric, then drop it in your server’s mods folder.


Discord Preparation

  1. Go to the Discord Developer Portal and sign in
  2. Click the New Application button and name it whatever you want

While you’re in the General Information tab, you can set the bot’s description, which will show up in its About Me tab.

Creation of the Bot
  1. On the left-hand side, click Bot.

While you’re here, you can set the bot’s profile picture and banner if you’d like!

  1. Click Reset Token, make sure to write this down somewhere since we’ll need it later

Result of resetting token

  1. Find the Privileged Gateway Intents section and check both the Server Members Intent and the Message Content Intent
  2. Click Save Changes at the bottom.

  1. Again, on the left sidebar, navigate to OAuth2.

  2. Find the OAuth2 URL Generator and check the bot scope in the large grid of checkboxes.

Scopes menu

  1. Scroll to the Bot Permissions section and enable the following permissions:
  • Manage Channels (required for proximity chat)
  • Manage Webhooks (required to setup webhooks automatically)
  • View Channels
  • Send Messages
  • Manage Messages (required for /dissonance purge)
  • Embed Links
  • Move Members (required for proximity chat)

Permissions menu

Although, it’ll work fine if you just give it Administrator, it’s generally good practice to be specific with permissions. I won’t stop you, though.

Install URL

  1. Copy and open the Generated URL
Adding the bot
  1. Select your Discord server, select Continue, then Authorize
  2. Open Discord and navigate to your server
  3. Go to User Settings (the cog towards the bottom left), scroll down to Advanced (under App Settings), and check Developer Mode if it’s not enabled already.

Developer Mode

  1. Create or select a text channel and right-click the channel. Click Copy Channel ID and write it down
Channel ID

Configuring the mod

  1. Either start the server once or create config/dissonance-server.toml with this snippet:
[credentials]
	token = "DISCORD_TOKEN"

[discord]
	input_channels = [CHANNEL_ID]
	output_channel = CHANNEL_ID

Don’t worry, there are plenty more configuration options available! This is just the minimum you need to get everything working.

  1. Fill out the options listed above, replacing DISCORD_TOKEN with the one we got in step 4 and CHANNEL_ID with the one we got in step 14.
  2. Your base configuration is complete! If you are just looking for a basic bridge, you can stop here. Otherwise, continue to the Extra Setup section.