2018-01-27 03:08:17 +00:00
|
|
|
# MatterLink
|
2018-01-24 14:40:38 +00:00
|
|
|
|
2018-02-15 22:56:54 +00:00
|
|
|
A MatterBridge endpoint for MC servers!
|
2018-01-27 03:08:17 +00:00
|
|
|
|
2018-02-15 22:56:54 +00:00
|
|
|
THIS MOD REQUIRES YOU TO ALSO RUN A MATTERBRIDGE RELAY
|
2018-01-27 03:08:17 +00:00
|
|
|
https://github.com/42wim/matterbridge
|
|
|
|
|
|
|
|
|
|
requires api section to be setup along these lines
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
[api]
|
|
|
|
|
[api.local]
|
2018-02-12 16:41:07 +00:00
|
|
|
BindAddress="0.0.0.0:4242" # or listen only to localhost: 127.0.0.1:4242
|
2018-01-27 03:08:17 +00:00
|
|
|
|
|
|
|
|
#Bearer token used for authentication
|
|
|
|
|
#curl -H "Authorization: Bearer testtoken" http://localhost:4343/api/messages
|
|
|
|
|
|
|
|
|
|
#OPTIONAL (no authorization if token is empty)
|
2018-02-12 16:41:07 +00:00
|
|
|
Token="mytoken"
|
2018-01-27 03:08:17 +00:00
|
|
|
|
|
|
|
|
Buffer=1000
|
|
|
|
|
|
|
|
|
|
RemoteNickFormat="{NICK}"
|
|
|
|
|
|
|
|
|
|
ShowJoinPart = true
|
|
|
|
|
```
|
|
|
|
|
|
2018-02-15 22:56:54 +00:00
|
|
|
## Features
|
|
|
|
|
|
|
|
|
|
* Individually configurable relaying of player deaths, achievements/advancements, server join, and server leave
|
|
|
|
|
* Configurable bridge commands sent from chat to MC:
|
|
|
|
|
```
|
|
|
|
|
help: Lists all commands with no arguments,
|
|
|
|
|
or displays help for a command
|
|
|
|
|
players: Lists online players
|
|
|
|
|
uptime: Print server uptime
|
|
|
|
|
```
|
2018-02-15 23:00:56 +00:00
|
|
|
* Edit and reload the config file without restarting the server!
|
2018-02-15 22:56:54 +00:00
|
|
|
```
|
|
|
|
|
/config <connect|disconnect|reload>
|
|
|
|
|
Connect or disconnect the bridge,
|
|
|
|
|
or cycle the connection and reload the config file
|
|
|
|
|
```
|
2018-02-15 23:00:56 +00:00
|
|
|
* Pass through commands to MineCraft! Fully configurable.
|
2018-02-15 22:56:54 +00:00
|
|
|
```
|
|
|
|
|
# MC commands that can be executed through the bridge
|
|
|
|
|
# Separate bridge command and MC command with '=',
|
|
|
|
|
# separate multiple values with spaces
|
|
|
|
|
# [default: [tps=forge tps]]
|
|
|
|
|
S:commandMapping <
|
|
|
|
|
tps=forge tps
|
|
|
|
|
>
|
|
|
|
|
```
|
|
|
|
|
This default example allows you to run `/forge tps` on the server by typing `$tps` in the chat
|
|
|
|
|
(replace $ with whatever you've configured as the command prefix).
|
|
|
|
|
|
|
|
|
|
**WARNING: There is *NO* permissions checking of any kind for command passthrough!
|
|
|
|
|
Do not configure passthrough for any commands you would not be comfortable
|
|
|
|
|
with anyone on your IRC/Discord/etc. executing!**
|
|
|
|
|
|
|
|
|
|
|
2018-02-08 21:08:35 +00:00
|
|
|
## Downloads
|
|
|
|
|
|
2018-02-12 16:41:07 +00:00
|
|
|
https://github.com/elytra/MatterLink/releases
|
|
|
|
|
|
2018-02-15 22:56:54 +00:00
|
|
|
https://ci.elytradev.com/job/elytra/job/MatterLink/job/master/lastSuccessfulBuild/ - may be unstable
|
2018-02-12 16:41:07 +00:00
|
|
|
|
|
|
|
|
## Dependencies
|
|
|
|
|
|
|
|
|
|
- forgelin: https://minecraft.curseforge.com/projects/shadowfacts-forgelin
|
|
|
|
|
|
|
|
|
|
## Setup
|
|
|
|
|
|
2018-02-15 22:56:54 +00:00
|
|
|
Install matterbridge and try out the basic sample:
|
2018-02-12 16:41:07 +00:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
go get github.com/42wim/matterbridge
|
|
|
|
|
mv matterbridge-sample.toml matterbridge.tom
|
|
|
|
|
matterbridge
|
|
|
|
|
```
|
|
|
|
|
|
2018-02-15 22:56:54 +00:00
|
|
|
Now you just need to run MatterBridge on the server, the default configuration works with the provided sample.
|
2018-02-12 16:41:07 +00:00
|
|
|
|
|
|
|
|
and then [RTFM!!!](https://github.com/42wim/matterbridge#configuration)
|
