From b8d6420ab06c93b63a752feebcb411020ffd4a80 Mon Sep 17 00:00:00 2001 From: poslop Date: Sun, 4 Dec 2022 15:51:52 -0600 Subject: [PATCH] Update 'readme.md' --- readme.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 12d0ea3..b35c523 100644 --- a/readme.md +++ b/readme.md @@ -10,8 +10,17 @@ Inside of this file set DISCORD_TOKEN= to your bot token Run the bot (usually ./MSDB in a terminal on linux) +This will generate a default config file. + +The availible options are: + +- ip = Ip address of your mindustry server. Usually leave as localhost if running the bot on the same machine as the mindustry server +- port = Port of the socket used by the mindustry server. It is set to the default port used by the mindustry server but you can check which port is in use by useing the "config socketInputPort" command in the server console +- trigger = The single letter or character that will be used to call the bot (ex. ;command !command ?command mcommand) +- roles = Not currently implemented + ## Commands -; is currently the bot prompt +; is currently the default bot prompt - ;console (command to send to mindustry server console) @@ -20,5 +29,4 @@ Run the bot (usually ./MSDB in a terminal on linux) ## Todo - Role Permission for send command -- Tcp Socket config - Remove ansi encoding so mobile users can also clearly see console output \ No newline at end of file