172 lines
5.4 KiB
Markdown
172 lines
5.4 KiB
Markdown
[](http://discord.gg/Fm5EST)
|
||
[](https://discord.gg/hXqNgq5)
|
||
[](https://curse.nikky.moe/api/url/287323?version=1.12.2)
|
||
[](https://ci.elytradev.com/job/elytra/job/MatterLink/job/master/lastSuccessfulBuild/artifact/)
|
||
[](https://www.patreon.com/NikkyAi)
|
||
|
||
# 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
|
||
|
||
includes pass-through to Minecraft commands!
|
||
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
|
||
}
|
||
}
|
||
```
|
||
|
||
### Acount Linking
|
||
|
||
To link your chat account to your minecraft uuid
|
||
execute `!auth Username`
|
||
make sure to use the proper username and command prefix, the system will then guide you through
|
||
|
||
internally the identity links are stored like so:
|
||
|
||
```json
|
||
{
|
||
/* username: NikkyAi */
|
||
"edd31c45-b095-49c5-a9f5-59cec4cfed8c": {
|
||
/* discord id */
|
||
"discord.game": [
|
||
"112228624366575616"
|
||
]
|
||
}
|
||
}
|
||
```
|
||
|
||
### Command permissions
|
||
|
||
Higher numbers mean more permissions. Configured per uuid.
|
||
|
||
```json
|
||
{
|
||
"edd31c45-b095-49c5-a9f5-59cec4cfed8c": 9000
|
||
}
|
||
```
|
||
|
||
### Reload
|
||
|
||
Edit and reload the config file without restarting the server!
|
||
```
|
||
/ml <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:
|
||
|
||
### Local
|
||
|
||
If ou know the matterbridge will run on the same machine as the Minecraft Server
|
||
```
|
||
[api]
|
||
[api.local]
|
||
BindAddress="127.0.0.1:4242" // Listens only for localhost
|
||
#OPTIONAL (no authorization if token is empty)
|
||
Token="" # Token left empty
|
||
Buffer=1000
|
||
RemoteNickFormat="{NICK}"
|
||
ShowJoinPart = true
|
||
```
|
||
|
||
With this you need no extra configuration steps.. just run matterbridge and then start the minecraft server (or reload matterlink with command if it runs already)
|
||
|
||
### Remote
|
||
|
||
If the matterbridge runs on a different machine
|
||
|
||
```
|
||
[api]
|
||
[api.local]
|
||
BindAddress="0.0.0.0:4242"
|
||
#OPTIONAL (no authorization if token is empty)
|
||
Token="mytoken"
|
||
Buffer=1000
|
||
RemoteNickFormat="{NICK}"
|
||
ShowJoinPart = true
|
||
```
|
||
|
||
you need to know the ip / domain of the matterbridge and the token used,
|
||
enter them in the ´connection' section in the config and reload matterlink
|
||
|
||
|
||
### 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 |