Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 2.75 KB

README.md

File metadata and controls

53 lines (36 loc) · 2.75 KB
Raw

MatterBukkit

A Minecraft Bukkit plugin which sends chat messages from/to MatterBridge.

actions status download from GitHub download from Modrinth download from CurseForge view on Website

Setup

First, install the plugin onto your Bukkit/Spigot/Paper server, and start it to generate config.yml. Then, configure it:

  • Set url to the URL where you're running MatterBridge, with port 4242 or whatever you'd like to use (if you're running it on the same server, you can use http://localhost:4242).
  • Set gateway to the name of your MatterBridge gateway.
  • Set a token to secure the API. This is optional, but heavily recommended.
  • Configure all other settings to your liking.

Add an API protocol and gateway to matterbridge.toml. Here is an example:

[api]
[api.minecraft]
Token="pasteTokenHere"
# Set BindAddress to "0.0.0.0:port" if your Minecraft server is running on a different server, and you're not using a reverse proxy
BindAddress="127.0.0.1:4242"
Buffer=1000
RemoteNickFormat="[{PROTOCOL}] {NICK}"

[[gateway.inout]]
account="api.minecraft"
channel="api"

Add any other protocols and gateways you would like to use, following MatterBridge's documentation.

If necessary, open your desired port in your firewall, then start MatterBridge and restart your Minecraft server.

Build

You can build the project in the following 2 steps:

  • Check out the repository
  • Build the jar file using maven: mvn clean package

Note: JDK 1.8 and Maven is required to build the project!

Testing

You can start a local test server including a Matterbridge instance using Docker and Docker Compose. For that, use the docker-compose.yml from the docker-dev folder.

Copy the MatterBukkit.jar to docker-dev/data/plugins and restart the Minecraft container.