README.md

MatterLink

• Downloads
• Dependencies
• Features
• 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

Downloads

Dependencies

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)

{
    "tps": {
        "type": "PASSTHROUGH",
        "execute": "forge tps",
        "permLevel": 0,
        "help": "Print server tps",
        "allowArgs": false
    }
}

Response command

{
    "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:

{ 
    /* username: NikkyAi */ 
    "edd31c45-b095-49c5-a9f5-59cec4cfed8c": { 
        /* discord id */ 
        "discord.game": [ 
            "112228624366575616"
        ]
    }
}

Command permissions

Higher numbers mean more permissions. Configured per uuid.

{
  "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!!! and configure all your needed gateways, endpoints etc

powered by wishful thinking