diff --git a/readme.md b/readme.md index bfa3408..b836d62 100644 --- a/readme.md +++ b/readme.md @@ -1,35 +1,39 @@ ## Real git +### [**Gitea**](https://mintyserver.net/git/poslop/Mindustry-Server-Discord-Bot) -https://mintyserver.net/git/poslop/Mindustry-Server-Discord-Bot - -This is the actual git for this project where releases are made +> This is the actual git for this project where **Releases** for **Download** are made ## Discrod -https://discord.gg/sRKCKQAdU4 + +### [**Discrod**](https://discord.gg/sRKCKQAdU4) ## Usage -Download the executable from releases +Download the executable from **Releases** -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 called config.toml +This will generate a default config file called **config.toml** -Or you can download the template from the git +Or you can download the [template](config.toml) from the git -Check the template for details about each setting +Check the [template](config.toml) for details about each setting ## Commands -; is the default bot prompt -- ;console (command to send to mindustry server console) +- **console:** used to send a command to the mindustry server console -- ;git (post git link) +- **auth:** used for authentication on the ECAN servers -- ;discord (post discord link) +- **git:** post git link -(parenthesis not needed) +- **discord:** post discord link ## Todo - Better error handling - make things modular + +## Notes + Ping me on **Discord** if you need a **Windows** version or about any other problems + +![Alt text](https://cdn.discordapp.com/emojis/699037458532139068.gif?quality=lossless&size=48 "riii") \ No newline at end of file