From 13a607fcd196ae6afec2c1dc1a87316e2b4b7850 Mon Sep 17 00:00:00 2001 From: nikky Date: Sun, 8 Jul 2018 02:46:15 +0200 Subject: [PATCH] update README --- README.md | 97 ++++++++++++++----- .../matterlink/command/CommandCoreML.kt | 2 +- core/src/main/resources/mcmod.info | 6 +- 3 files changed, 76 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 7916926..2684ba7 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ Chat with us on IRC: [#matterlink @ irc.esper.net](irc://irc.esper.net/matterlin ### Custom bridge commands -including passthrough to MC! +includes pass-through to Minecraft commands! Default commands: `help, tps, list, seed, uptime` Commands are specified in JSON format as follows: @@ -50,43 +50,66 @@ 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 +{ + "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 +{ + "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 on a network-by-network basis. -For IRC, this is your hostmask. -For Discord, this is your userid (NOT the four-digit number.) +Higher numbers mean more permissions. Configured per uuid. ```json { - "irc.esper": { - "~DaMachina@hostname.com":1000 - } + "edd31c45-b095-49c5-a9f5-59cec4cfed8c": 9000 } ``` -* Edit and reload the config file without restarting the server! + +### Reload + +Edit and reload the config file without restarting the server! ``` -/bridge +/ml 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, @@ -97,18 +120,42 @@ For Discord, this is your userid (NOT the four-digit number.) 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="0.0.0.0:4242" # or listen only to localhost: 127.0.0.1:4242 + BindAddress="127.0.0.1:4242" // Listens only for localhost #OPTIONAL (no authorization if token is empty) - Token="mytoken" # leave this empty if you know its going to run on localhost only + Token="" # Token left empty Buffer=1000 RemoteNickFormat="{NICK}" ShowJoinPart = true ``` -Now you just need to run MatterBridge on the server, the default configuration works with the provided sample. +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: @@ -118,7 +165,7 @@ mv matterbridge-sample.toml matterbridge.toml matterbridge ``` -now start the server with matterlink (and forgelin )in the mods folder +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 diff --git a/core/src/main/kotlin/matterlink/command/CommandCoreML.kt b/core/src/main/kotlin/matterlink/command/CommandCoreML.kt index 89b91a1..796550a 100644 --- a/core/src/main/kotlin/matterlink/command/CommandCoreML.kt +++ b/core/src/main/kotlin/matterlink/command/CommandCoreML.kt @@ -11,7 +11,7 @@ object CommandCoreML { val aliases = listOf("matterlink") - val usage = "ml " + val usage = "ml " fun execute(args: Array, user: String, uuid: String?): String { val cmd = args[0].toLowerCase() diff --git a/core/src/main/resources/mcmod.info b/core/src/main/resources/mcmod.info index 33764a4..722e474 100644 --- a/core/src/main/resources/mcmod.info +++ b/core/src/main/resources/mcmod.info @@ -1,11 +1,11 @@ [{ "modid": "matterlink", "name": "MatterLink", - "description": "Minecraft Server Matterbridge link", + "description": "Minecraft Server Matterbridge link, Multi-Platform chat", "version": "${version}", "mcversion": "${mcversion}", "url": "https://github.com/elytra/MatterLink", - "authorList":["Arcanitor", "NikkyAi"], - "credits": "Blame Nikky for talking me into this.", + "authorList":["NikkyAi", "Arcanitor"], + "credits": "Blame Nikky for talking me into this. \n42wim for creating matterbridge \nUna, Falkreon and capitalthree's patience", "dependencies": ["forgelin"] }] \ No newline at end of file