Update README.MD
This commit is contained in:
parent
901e5378c1
commit
740e967a90
46
README.md
46
README.md
|
@ -1,10 +1,8 @@
|
||||||
# MatterLink
|
# MatterLink
|
||||||
|
|
||||||
THIS MOD REQUIRES YOU TO ALSO RUN A MATTERBRIDGE
|
A MatterBridge endpoint for MC servers!
|
||||||
https://github.com/42wim/matterbridge
|
|
||||||
|
|
||||||
connect matterbridge to MC servers
|
|
||||||
|
|
||||||
|
THIS MOD REQUIRES YOU TO ALSO RUN A MATTERBRIDGE RELAY
|
||||||
https://github.com/42wim/matterbridge
|
https://github.com/42wim/matterbridge
|
||||||
|
|
||||||
requires api section to be setup along these lines
|
requires api section to be setup along these lines
|
||||||
|
@ -27,11 +25,45 @@ requires api section to be setup along these lines
|
||||||
ShowJoinPart = true
|
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 config settings 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 MC! 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
|
## Downloads
|
||||||
|
|
||||||
https://github.com/elytra/MatterLink/releases
|
https://github.com/elytra/MatterLink/releases
|
||||||
|
|
||||||
https://ci.elytradev.com/job/elytra/job/MatterLink/job/master/lastSuccessfulBuild/
|
https://ci.elytradev.com/job/elytra/job/MatterLink/job/master/lastSuccessfulBuild/ - may be unstable
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
|
@ -39,7 +71,7 @@ https://ci.elytradev.com/job/elytra/job/MatterLink/job/master/lastSuccessfulBuil
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
install matterbridge and try out the basic sample
|
Install matterbridge and try out the basic sample:
|
||||||
|
|
||||||
```
|
```
|
||||||
go get github.com/42wim/matterbridge
|
go get github.com/42wim/matterbridge
|
||||||
|
@ -47,6 +79,6 @@ mv matterbridge-sample.toml matterbridge.tom
|
||||||
matterbridge
|
matterbridge
|
||||||
```
|
```
|
||||||
|
|
||||||
now you just need to run matterbridge on the server, the default configuration works with the provided sample
|
Now you just need to run MatterBridge on the server, the default configuration works with the provided sample.
|
||||||
|
|
||||||
and then [RTFM!!!](https://github.com/42wim/matterbridge#configuration)
|
and then [RTFM!!!](https://github.com/42wim/matterbridge#configuration)
|
|
@ -58,7 +58,7 @@ abstract class IMatterLink {
|
||||||
val hr = (total/3600)%24
|
val hr = (total/3600)%24
|
||||||
val day = total/86400
|
val day = total/86400
|
||||||
|
|
||||||
return "${day}d${hr}hr${min}m${sec}s"
|
return "${day}d ${hr}hr ${min}m ${sec}s"
|
||||||
}
|
}
|
||||||
|
|
||||||
fun registerBridgeCommands() {
|
fun registerBridgeCommands() {
|
||||||
|
|
Loading…
Reference in New Issue