Skip to content

Small Minecraft plugin linking a Discord channel & Minecraft.

License

Notifications You must be signed in to change notification settings

Urpagin/SyncChat

Repository files navigation

SyncChat

Also available on SpigotMC.

SyncChat provides an interface between the chat functionality of a Minecraft server and a Discord channel.

Everything is configurable through the plugin.yml file. Nearly all text sent to either Minecraft or Discord can be tweaked in the config.

Here is an (old) demo (no slash-commands):

dinglenut_demo_good.mp4

🏃‍♂️ Getting Started

Important

  • Currently, SyncChat is built & tested for Minecraft 1.21.4 (it may not work for prior versions)
  • SyncChat is built with the Spigot API and is compatible with Spigot and PaperMC servers onwards.

👍 Installation Steps

  1. Download the .jar release file and place it in the plugins directory on your server.
  2. Launch the server once to generate the config file at ./plugins/SyncChat/config.yml.
  3. Populate the config.yml with your Discord bot token and a channel ID.
  4. Restart the server.
  5. Enjoy!

🛠️ Additional Information

The plugin interacts with Discord through the JDA library.

📝 Todo

  • "Cannot reply to a system message" (e.g.: pinned messages)
  • Use Discord server nicknames in MC chat instead of the handle
  • Custom description?
  • Custom Rich Presence
  • Customize prefixes in config.yml (e.g.: [";", ":", "."])
  • Death logging in the Discord channel
  • /playing slashcommand
  • /deaths slashcommand
  • Version check at start: checks this repo for newer releases
  • MC & Discord message format customizable in config
  • /playing message format customizable in config
  • /deaths message format customizable in config
  • Send a Discord message when a player joins (+ toggle in config)
  • Send a Discord message when a player exits (+ toggle in config)
  • Send a Discord message when a player earns an achievement (+ toggle in config)
  • Change Discord bot username + icon to use the in-game name and skin face
  • Update demo video