trinitrotoluene / mcmirror

A Discord <-> Minecraft message bridge for Spigot

MC Mirror

Shaded binaries can be downloaded from the releases page. There is a spigot resource page to which download links and changelogs are also posted.

If you're reporting a bug or requesting a feature (see below for more details on that), open an issue.

Features

• Reliable Discord <-> Minecraft message mirroring powered by Discord4J
• Restrict mirroring to a specific channel in your guild
• Access control via permission mcmirror.mirror on your server, and role & user ID whitelisting on Discord
• Uses webhooks to ensure user interactions are conversational
  • Supports rotating through multiple webhooks for high-frequency conversations
• Easy to set up, but extensively customisable

Versioning

This software is semantically versioned. Any changes which would cause the public facing API to change in a backwards-incompatible way will correspond to a bump in major version.

major.minor.patch

Examples

• Changes to config.yml or plugin.yml (permissions)
• Changes to command names, behaviour or syntax

Since this may cause major version numbers to increment frequently, recent but non-current versions will still receive support and bug-fixes. Should the version you're currently using not be listed, follow the update migration instructions in the associated SpigotMC resource update to move to a newer version.

Supported Versions

• 3.x (1.14+)
• 2.x (1.14+)

Current Version

• 3.0.0

Future

• TBC

mcmirror's Issues

Using Discord presences for Minecraft messages

Description
Allow users to verify their identity on Discord and use their display name & avatar for minecraft messages sent there.

Requirements

• Generate and send a random code in-game to a user in response to a command
• Listen for a DM command that includes this code on Discord
• Assocate the user's ID with their Mojang UUID
• Persist stored assocations and load them when building webhook presences

[Discord -> Minecraft] Command execution

Description

Users should be able to execute and view the returned message of a command by sending a Discord message.

Requirements

• Access control
  Administrators should have the ability to restrict who can execute commands. This could be accomplished by linking the ID of a Discord role to a list of permissions this role should have access to. (As well as optionally whether they should be opped)
• Prefix
  / is a common prefix and may be reserved by other bots- the prefix should be / by default and configurable.
• Channel restrictions
  Administrators may wish commands to be executable in channels which are not mirrored. Will use the bot API instead of the webhooks for this, and optionally accept a channel ID as a configurable option.

Review dependency licenses & select a license

Description
Ensure all dependencies are used correctly under their respective licenses

Requirements

• Include licenses
  All relevant license files should be included in the project root and in built JARs.
• License the project
  The project should be licensed in a way which is compatible with the licensing requirements of its dependencies.

Config

• Channel id for message mirroring
• Channel id for ban/kick/whitelist alerts

Move commands into subcommands

Description
The current commands list is opaque and requires use of the /help command to see which are available.

Requirements

• Group commands
  Commands should be grouped as subcommands under /mirror.
• Help
  Users should still be able to access help messages for these subcommands to learn more about their functionality.

[Discord -> Minecraft] Strip mention and emote metadata

Description
Mentions are currently sent as-is and create ugly and difficult to read messages.

Requirements

• Resolve all role, channel and user mentions where possible while building Messages
• Strip all parts of guild emote mentions not including :name:

Chat commands

Discord

• /list
• /tps

Minecraft

• /shrug

Server information in bot presence

Description
Show information about the server in the Discord bot presence

Requirements

• Cycle between MOTD and online/capacity display, maybe also server version

Small extra that should hopefully catch the 3.0.0 release train, otherwise making it into a minor patch after that release.