Skip to content

Connect a Minecraft Forge server to Matterbridge

License

Notifications You must be signed in to change notification settings

raws/minecraft-forge-mattercraft

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mattercraft

Mattercraft is a Minecraft Forge mod that relays chat messages between a Minecraft server and Matterbridge. It uses Matterbridge's HTTP API.

Mattercraft aims to be simple and lightweight. It relays all chat messages from your Minecraft server to Matterbridge, and vice-versa. Messages are sent and received on dedicated threads to avoid impacting the main server thread.

If you're looking for a comparable mod for a Fabric server, check out Fabricbridge. MatterLink is a feature-rich Forge alternative.

Usage

To use Mattercraft, install a release on your Minecraft Forge server. (It doesn't need to be installed on clients. It even works great with vanilla Minecraft clients connected to a Forge server!)

The next time you start your server, Forge will automatically create serverconfig/mattercraft-server.toml in your world directory. It'll look like this:

[matterbridge]
  # Your Matterbridge API token
  api_token = "s3cr3t"
  # Matterbridge API base URL, including protocol
  base_url = "https://matterbridge.example.com"
  # Matterbridge gateway name
  gateway = "example"

Configure Mattercraft to connect to your Matterbridge API server. Then, fire up your server and start chatting!

Contributing

Contributions are welcome! Feel free to open a pull request on GitHub.

License

MIT