Update 'readme.md'

This commit is contained in:
poslop
2022-12-05 09:09:45 -06:00
parent 325d5fbd40
commit 6360f329a6

View File

@@ -4,20 +4,19 @@ https://discord.gg/FaXKDWQ9
## Usage ## Usage
Download the executable from releases 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) 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: 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 - discordToken = the discord bot token (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 - ip = Ip address of your mindustry server. Usually leave as localhost if running the bot on the same machine as the mindustry server (required)
- trigger = The single letter or character that will be used to call the bot (ex. ;command !command ?command mcommand) - 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)
- roles = Not currently implemented - 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 ## Commands
; is currently the default bot prompt ; is currently the default bot prompt