From 6360f329a61f5516f8590b21fb8dcff20853264d Mon Sep 17 00:00:00 2001 From: poslop Date: Mon, 5 Dec 2022 09:09:45 -0600 Subject: [PATCH] Update 'readme.md' --- readme.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/readme.md b/readme.md index 1d8a758..f6ca46a 100644 --- a/readme.md +++ b/readme.md @@ -4,20 +4,19 @@ https://discord.gg/FaXKDWQ9 ## Usage Download the executable from releases -Create a file where the bot will be run called .env - -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. +This will generate a default config file called config.toml + +Or you can download the template from the git The available 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 +- discordToken = the discord bot token (required) +- ip = Ip address of your mindustry server. Usually leave as localhost if running the bot on the same machine as the mindustry server (required) +- 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 (required) +- trigger = The single letter or character that will be used to call the bot (ex. ;command !command ?command mcommand) (optional) +- roles = Not currently implemented (optional) ## Commands ; is currently the default bot prompt