- General Info
- Features
- Commands
- Installation
- Configuring
- Building from source
- Warnings
- Dependencies and Credits
- Contributing
- License
- Others
The plugin's purpose is to connect the discord text channel with Minecraft chat.
The project was done for the 1.19.2 Minecraft version.
The plugin will display messages from Minecraft on the discord channel and vice versa.
The project was done purely for learning and fun purposes. Do not take this plugin seriously.
- Displays join/leave message on the discord channel
- Displays player deaths
- Displays player advancements
- Displays player messages on discord
- Displays discord messages on Minecraft chat
- Commands
- Status of discord server on minecraft chat
- Configure options of the plugin from minecraft chat
Command Name | Usage | Example |
---|---|---|
Status | /status | /status |
Config | /config [enable-tag \ enable-console \ channel] | /config enable-tag true |
You need a 1.20.1 papermc server.
When the server is installed place the freshly downloaded plugin in the plugins/
folder.
Start a server to generate needed files (Don't worry about errors for now).
You need a discord bot for this.
-
Create one at Discord Developer Portal.
Make sure to invite the bot to your server!
-
Copy the bot token to your clipboard.
-
Go to
plugins/dcmchat/
and open theconfig.yml
file with a text editor. -
Replace
"server"
with your server name (the server with the bot). -
You need to set the channel.
There are two options:
- Create a text channel with a "mc-chat" name.
- Change the "mc-chat" to your channel name.
-
If you want the plugin to display discord messages in the console or show the discord user's tag choose an option and change "false" to "true"
-
Lastly add a line to
config.yml
saying:BOT_TOKEN: YOUR_BOT_TOKEN
Replace the "YOUR_BOT_TOKEN" with the actual token.
-
Clone the repository.
$ git clone https://github.com/Zielin0/Dcmchat.git
-
Open created folder with IntelliJ IDEA.
-
Install all maven dependencies.
- If you want the jar to be compiled directly to your plugins
directory add this to
pom.xml
inmaven-jar-plugin
section:
<configuration> <outputDirectory>C:\path\to\plugins</outputDirectory> </configuration>
- If you want the jar to be compiled directly to your plugins
directory add this to
-
Run maven scripts first
clean
thenpackage
. -
Plugin should appear in the
target/
directory (only if you skippedoutputDirectory
configuration).
The plugin is not recommended for discord and Minecraft servers more significant than 75 users/players.
- urlregex.com for URL regex pattern
Contributions are welcome just make sure the code works.
Also, please describe your changes / added features if you want to contribute.
The project is under the MIT License.
If the plugin throws an unexpected error PLEASE report it!
You can report issues and errors at Issues Page.