119 lines
3.8 KiB
Markdown
119 lines
3.8 KiB
Markdown
# MatterLink
|
|
|
|
- [Downloads](#downloads)
|
|
- [Dependencies](#dependencies)
|
|
- [Features](#features)
|
|
- [Setup](#setup)
|
|
|
|
A Matterbridge endpoint for MC servers!
|
|
|
|
THIS MOD REQUIRES YOU TO ALSO RUN A MATTERBRIDGE RELAY
|
|
https://github.com/42wim/matterbridge
|
|
|
|
Chat with us on IRC: [#matterlink @ irc.esper.net](irc://irc.esper.net/matterlink)
|
|
|
|
## Downloads
|
|
|
|
[](https://github.com/elytra/MatterLink/releases)
|
|
|
|
[](https://ci.elytradev.com/job/elytra/job/MatterLink/job/master/lastSuccessfulBuild/artifact/)
|
|
|
|
[](https://minecraft.curseforge.com/projects/287323/files)
|
|
|
|
[](https://curse.nikky.moe/api/url/287323?version=1.12.2)
|
|
|
|
[](https://curse.nikky.moe/api/url/287323?version=1.11.2)
|
|
|
|
[](https://curse.nikky.moe/api/url/287323?version=1.10.2)
|
|
|
|
[](https://curse.nikky.moe/api/url/287323?version=1.7.10)
|
|
|
|
## Dependencies
|
|
|
|
[](https://minecraft.curseforge.com/projects/248453/files)
|
|
|
|
## Features
|
|
|
|
### Custom bridge commands
|
|
|
|
including passthrough to MC!
|
|
Default commands: `help, tps, list, seed, uptime`
|
|
|
|
Commands are specified in JSON format as follows:
|
|
|
|
Passthrough command (executes the configured command from the MC server console)
|
|
|
|
```json
|
|
"tps": {
|
|
"type": "PASSTHROUGH",
|
|
"execute": "forge tps",
|
|
"permLevel": 0,
|
|
"help": "Print server tps",
|
|
"allowArgs": false
|
|
}
|
|
```
|
|
|
|
Response command
|
|
|
|
```json
|
|
"uptime": {
|
|
"type": "RESPONSE",
|
|
"response": "{uptime}",
|
|
"permLevel": 1,
|
|
"help": "Print server uptime",
|
|
"allowArgs": false
|
|
}
|
|
```
|
|
|
|
### Command permissions
|
|
|
|
Higher numbers mean more permissions. Configured on a network-by-network basis.
|
|
For IRC, this is your hostmask.
|
|
For Discord, this is your userid (NOT the four-digit number.)
|
|
|
|
```json
|
|
{
|
|
"irc.esper": {
|
|
"~DaMachina@hostname.com":1000
|
|
}
|
|
}
|
|
```
|
|
* Edit and reload the config file without restarting the server!
|
|
```
|
|
/bridge <connect|disconnect|reload>
|
|
connect: Connects the MC chat to the MatterBridge server
|
|
disconnect: Disconnects the chat from the MatterBridge server
|
|
reload: Disconnects, reloads the config and custom command files,
|
|
then reconnects.
|
|
```
|
|
|
|
## Setup
|
|
|
|
Requires the matterbridge config api section to be setup along these lines:
|
|
|
|
```
|
|
[api]
|
|
[api.local]
|
|
BindAddress="0.0.0.0:4242" # or listen only to localhost: 127.0.0.1:4242
|
|
#OPTIONAL (no authorization if token is empty)
|
|
Token="mytoken" # leave this empty if you know its going to run on localhost only
|
|
Buffer=1000
|
|
RemoteNickFormat="{NICK}"
|
|
ShowJoinPart = true
|
|
```
|
|
|
|
Now you just need to run MatterBridge on the server, the default configuration works with the provided sample.
|
|
|
|
Install matterbridge and try out the basic sample:
|
|
|
|
```
|
|
go get github.com/42wim/matterbridge
|
|
mv matterbridge-sample.toml matterbridge.toml
|
|
matterbridge
|
|
```
|
|
|
|
now start the server with matterlink (and forgelin )in the mods folder
|
|
|
|
and then [RTFM!!!](https://github.com/42wim/matterbridge#configuration) and configure all your needed gateways, endpoints etc
|
|
|
|
powered by wishful thinking |