ChatBridge is a 1.8.9 (forge) / 1.19.3 (fabric) Minecraft mod that enables bidirectional IRC between your own Minecraft client and Discord (or your own chat server!).
- Install Python 3.8+ and then install the discord.py module.
> pip install discord.py
- Download the latest release or build it yourself.
- Copy the mod to your mods folder (.minecraft/mods).
- Start your instance of Minecraft. ChatBridge will automatically create a configuration file in .minecraft/config. Edit this configuration file accordingly (see the configuration section for more information).
- Run the Minecraft command
/chatbridgereload
to force ChatBridge to reload its configurations. You have successfully installed ChatBridge!
Aliases: bind
Set the bind option via a command.
Aliases: online
Sends the /online
command to ChatBridge's server. All other ChatBridge clients will reply with their in game usernames.
Aliases: None Force ChatBridge to reload its configurations.
Aliases: send
Send a message only to the Minecraft server. ChatBridge will ignore the message.
Aliases: raw
Send a message only to ChatBridge's server. The message will not be recieved by the Minecraft server.
Once you've launched Minecraft, ChatBridge will automatically create a configuration file in .minecraft/config. The file is called chatbridge.cfg
if you're using Forge with 1.8.9 and chatbridge.json
if you're using Fabric with 1.19.3.
To configure ChatBridge, open the configuration file with any text editor and modify the values.
The chat bind option. Possible values are
SERVER
: the client's chat messages go straight to the Minecraft server. ChatBridge is essentially disabled when this value is set.CHATBRIDGE
: the client's chat messeges only go to ChatBridge's server and do not get sent to the Minecraft server.CHATBRIDGE_AND_SERVER
: the client's chat messages get sent to both the Minecraft server as well as ChatBridge's server.
The chat message format option. ChatBridge will display messages that it recieves from ChatBridge's server using this format. {0}
represents the name of the sender and {1}
represents the sender's message.
The Discord relay channel ID. ChatBridge will route messages to and from this Discord channel. To get the ID of a channel, first enable "Developer Mode" in Discord by going to Settings > Advanced > Developer Mode. Then, right click the channel you want to copy the ID for and press Copy Channel ID.
The Discord bot token. To obtain a Discord bot token, follow the steps here. Make sure the bot has access to the channel that you set the Channel ID for.
Once you've made your changes, save the file. Then, go back to Minecraft and run the command /chatbridgereload
for your changes to take effect.
- Install Git and JDK 8. Make sure the environment variable,
JAVA_HOME
, is set to the JDK 8 installation path. - Clone this repository.
> git clone https://github.com/sbplat/ChatBridgeMod.git
- Navigate into the
ChatBridgeMod
directory.
> cd ChatBridgeMod
- Switch the branch to
forge-1.8.9
.
> git checkout forge-1.8.9
- Build ChatBridge.
> gradlew build
- Install Git and JDK 17. Make sure the environment variable,
JAVA_HOME
, is set to the JDK 17 installation path. - Clone this repository.
> git clone https://github.com/sbplat/ChatBridgeMod.git
- Navigate into the
ChatBridgeMod
directory.
> cd ChatBridgeMod
- Switch the branch to
fabric-1.19.3
.
> git checkout fabric-1.19.3
- Build ChatBridge.
> gradlew build
The chat server implementation is located in src/main/resources/assets/chatbridge/bot.py
. This file can be modified to use a different chat server. Once you've made the changes, build the project again.
ChatBridge will output errors to the console.