Intro

Minecordbot is a plugin for Bukkit-based Minecraft servers (Spigot, CraftBukkit, etc.), and Discord. It allows Discord and Minecraft users to communicate with each other. It also allows logging commands, private chats and more on your Discord server. Users with the proper access can also send commands to the Minecraft server from Discord.

Features

  • Sync your Discord and Minecraft accounts with MCBSync™
  • Simple and Lightweight Installation
  • Intuitive command usage
  • Capable of Explicit Configuration
  • Bind many channels, or one
  • Cross-server command execution
  • Localized in English, Polish, German, Romanian, French and Pirate YARRRR!
  • Compatibility with many other chat plugins
  • Sleek command response interface
  • Tab auto-completion for in-game mentions
  • Four levels of permissions

Installation

Minecordbot is both a Discord bot, and a plugin for Minecraft servers. Being such, it will require configuration on both ends. Hopefully, this guide will help you get up and running smoothly

Creating the Bot User

  1. Go to the Discord Developer Page and click My Apps

  2. Log in with your Discord account

  3. Create a new application by clicking New App

  4. Fill out the form and click Create App

  5. Click Create a Bot User and then confirm it by clicking Yes, do it!

Invite the Bot to your Discord Server

  1. Note down, or copy to a file or editor, your bot's Client ID. This will be under "App Details" at the top of the App's Dev Page

    • You may also wish to grab your bot's Token at this time, as it will be used later for configuration.
  2. Copy the link below into your browser's address bar, replacing BOT_ID with your bot's Client ID:

    https://discordapp.com/oauth2/authorize?client_id=BOT_ID&scope=bot&permissions=1609821188
  3. Click the selection menu and choose the server where you want the bot - click Authorize.

Installing Minecordbot plugin

  1. Grab the latest version of the plugin from Spigot repositories. You can also check the announcements channel in our Discord Server

  2. Place the MineCordBot.jar you downloaded into your server's plugins directory.

  3. Start or Restart your server to generate MineCordBot's files.

  4. Edit the configuration files (Located at /plugins/MineCordBot) to configure the bot to your liking.

    • We recommend against using Window's Notpad for working with json - Atom, Notepad++, and Sublime Text are good alternatives.
  5. Save, and upload (if necessary), the changed configurations and restart your server.

You can refer to our Configuration page for help.

Permissions

Permissions are handled differently for Discord and Minecraft. For Discord commands, permissions are handled through permission flags. In-game commands are handled with the native Bukkit permission system.

Permission Guides

Permission Flags

What Are Permission Flags?

Permission flags can be assigned to a Discord role or a text channel to give or limit user's access to a specific command or command category.

Structure

Basic Format

A permission flag is surrounded by an opening{ and closing} curly brackets. Inside of the bracket is the access modifier followed by the target.

{access modifier + target}

Access Modifier

There are two access modifier. Negative- and Positive+. Pretty straight forward, negative will prevent someone from executing the target and positive will allow someone to execute the target.

Target

The target will actually specify what command or what category you are modifying. A target can be any Minecordbot commands or any Minecordbot command category. There is also a primitive target and that is all. This primitive target will modify the access for all commands.

How To Use Permission Flags

Permission flags can be set for a specific role or a specific text channel.

Permission flags on roles

To add a permission flag to a role, you can either do it by command or manually add it on Minecordbot's PermissionConfig.yml

Configuring a role's permission using the permission command.

  • To set a flag for a role, you execute (You can add multiple flags)
    !!permission set <role> <flag1>|<flag2>...
  • To remove a permission, you execute (You can add multiple flags)
    !!permission remove <role> <flag1>|<flag2>...
  • To check for a role's permission flags, you execute
    !!permission check <role>

Configuring a role's permission manually in PermissionConfig.yml

You have to open PermissionConfig.yml located in /plugins/MineCordBot/ with a more advanced text editor like Atom, Notepad++, or SublimeText.

After that, just follow the default format that have been generated. But please do enclose the role id with an apostrophe '

Examples

  • Allow access to tps and info command
    {+tps}, {+info}
  • Allow access to tps command and deny access to info command
    {+tps}, {-info}
  • Deny access to all commands except tps and info command
    {-all}, {+tps}, {+info}
  • Allow access to all commands except tps and info command
    {+all}, {-tps}, {-info}

In-game Permission Nodes

Permission Nodes for the in-game commands are as follows.

Node Command
minecordbot.dme /dme
minecordbot.reload /minecordbot reload
minecordbot.dcmd /dcmd
minecordbot.discordsync allows players to use /mcbsync and /syncconfirm
minecordbot.incognito No Command; hides event messages (leave/join) from Discord about the player