https://github.com/programie/matterbukkit

A Minecraft Bukkit plugin which sends chat messages from/to MatterBridge
https://github.com/programie/matterbukkit

bukkit bukkit-plugin minecraft spigot spigot-plugin

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/programie/matterbukkit
• Owner: Programie
• License: mit
• Created: 2019-09-24T21:42:55.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2025-07-06T15:27:32.000Z (6 months ago)
• Last Synced: 2025-09-25T09:36:07.850Z (4 months ago)
• Topics: bukkit, bukkit-plugin, minecraft, spigot, spigot-plugin
• Language: Java
• Homepage:
• Size: 309 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# MatterBukkit

A Minecraft Bukkit plugin which sends chat messages from/to [MatterBridge](https://github.com/42wim/matterbridge).

[![actions status](https://github.com/Programie/MatterBukkit/actions/workflows/build.yml/badge.svg)](https://github.com/Programie/MatterBukkit/actions/workflows/build.yml)

[![download from GitHub](https://img.shields.io/badge/download-Releases-blue?logo=github)](https://github.com/Programie/MatterBukkit/releases/latest)

[![download from Modrinth](https://img.shields.io/badge/download-Modrinth-blue?logo=modrinth)](https://modrinth.com/mod/matterbukkit)

[![download from CurseForge](https://img.shields.io/badge/download-CurseForge-blue?logo=curseforge)](https://www.curseforge.com/minecraft/bukkit-plugins/matterbukkit)

## Setup

First, install the plugin onto your Bukkit/Spigot/Paper server, and start it to generate [`config.yml`](src/main/resources/config.yml). Then, configure it:

- Set [`url`](src/main/resources/config.yml#L3) 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`](src/main/resources/config.yml#L6) to the name of your MatterBridge gateway.

- Set a [`token`](src/main/resources/config.yml#L9) 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:

```toml

[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](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config).

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](docker-dev/docker-compose.yml) from the [docker-dev](docker-dev) folder.

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

## My other plugins

You can find them on [my website](https://selfcoders.com/projects/minecraft-plugins).