sorceress
/
MatterLink
mirror of https://github.com/AgathaSorceress/MatterLink.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
126 Commits 1 Branch 19 Tags 720 KiB
Kotlin 98.5%
Shell 1.5%
Go to file
DaMachinator d93e0249b2 Update README.MD 2018-02-15 18:00:56 -05:00
1.10.2 fixed oversight in refactor 2018-02-15 23:20:01 +01:00
1.11.2 fixed oversight in refactor 2018-02-15 23:20:01 +01:00
1.12.2 because ForgeGradle sucks.. at least before 2.3-SNAPSHOT 2018-02-15 23:03:52 +01:00
core Update README.MD 2018-02-15 17:56:54 -05:00
gradle/wrapper oops 2018-01-19 17:19:56 -05:00
.gitignore because ForgeGradle sucks.. at least before 2.3-SNAPSHOT 2018-02-15 23:03:52 +01:00
Jenkinsfile versioning scheme change 2018-02-11 17:23:52 +01:00
LICENSE Initial commit 2018-01-19 16:29:50 -05:00
README.md Update README.MD 2018-02-15 18:00:56 -05:00
build.gradle adding changelog to cursegradle config 2018-02-14 06:26:12 +01:00
gradle.properties add proper required-after forgelin and forge version, improves to the build.gradle 2018-02-15 16:51:30 +01:00
gradlew make gradlew exutable 2018-01-27 04:22:43 +01:00
gradlew.bat oops 2018-01-19 17:19:56 -05:00
matterbridge-sample.toml add sample and update README 2018-02-12 17:41:07 +01:00
settings.gradle release 1.2.2 2018-02-11 16:33:19 +01:00

README.md

MatterLink

A MatterBridge endpoint for MC servers!

THIS MOD REQUIRES YOU TO ALSO RUN A MATTERBRIDGE RELAY https://github.com/42wim/matterbridge

requires 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

    #Bearer token used for authentication
    #curl -H "Authorization: Bearer testtoken" http://localhost:4343/api/messages
    
    #OPTIONAL (no authorization if token is empty)
    Token="mytoken"
    
    Buffer=1000
    
    RemoteNickFormat="{NICK}"
    
    ShowJoinPart = true

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
  • Edit and reload the config file without restarting the server!
/config <connect|disconnect|reload>
Connect or disconnect the bridge, 
or cycle the connection and reload the config file
  • Pass through commands to MineCraft! Fully configurable.
# 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!

Downloads

https://github.com/elytra/MatterLink/releases

https://ci.elytradev.com/job/elytra/job/MatterLink/job/master/lastSuccessfulBuild/ - may be unstable

Dependencies

Setup

Install matterbridge and try out the basic sample:

go get github.com/42wim/matterbridge
mv matterbridge-sample.toml matterbridge.tom
matterbridge

Now you just need to run MatterBridge on the server, the default configuration works with the provided sample.

and then RTFM!!!