https://github.com/urpagin/syncchat
Small Minecraft plugin linking a Discord channel & Minecraft.
https://github.com/urpagin/syncchat
bot chat discord light minecraft plugin spigot
Last synced: about 2 months ago
JSON representation
Small Minecraft plugin linking a Discord channel & Minecraft.
- Host: GitHub
- URL: https://github.com/urpagin/syncchat
- Owner: Urpagin
- License: gpl-3.0
- Created: 2024-06-19T00:16:39.000Z (12 months ago)
- Default Branch: 1.21.4
- Last Pushed: 2024-12-22T22:59:19.000Z (5 months ago)
- Last Synced: 2025-02-12T10:53:26.238Z (4 months ago)
- Topics: bot, chat, discord, light, minecraft, plugin, spigot
- Language: Java
- Homepage:
- Size: 110 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# SyncChat
[
Also available on SpigotMC.
](https://www.spigotmc.org/resources/syncchat-discord-link.121376/)
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):
[Demo Video](https://github.com/Urpagin/DiscordLink/assets/72459611/ea6bf913-1dd4-4ba0-9f50-2040549207d3)
## 🏃♂️ 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](https://github.com/discord-jda/JDA) library.
## 📝 Todo
- [x] "Cannot reply to a system message" (e.g.: pinned messages)
- [x] Use Discord server nicknames in MC chat instead of the handle
- [x] Custom description?
- [x] Custom Rich Presence
- [x] Customize prefixes in `config.yml` (e.g.: [";", ":", "."])
- [x] Death logging in the Discord channel
- [x] `/playing` slashcommand
- [x] `/deaths` slashcommand
- [x] Version check at start: checks this repo for newer releases
- [x] MC & Discord message format customizable in config
- [x] `/playing` message format customizable in config
- [x] `/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