Minecraft Server Status Bot

A simple Discord bot that displays the status of a Minecraft server in the sidebar.

If you have any issues, join the support server on Discord.

Features

Make sure to remove <> and [] when using a command.

;help - View all commands
- ;help <command> - Get help on a specific command or category
;server - View info about the current Minecraft server
- ;server set <ip> - Set the current Minecraft server
;players - Get a list of all players on the Minecraft server

Online - Minecraft server is online and joinable
Idle - Minecraft server is online, but full
DND - Minecraft server is offline or closed

The activity shows the current player count. Ex: 77/100 online

If you have any issues during installation, join the support server on Discord.

Clone the repository (as a Git repo)
- You must have Git installed to install and run the bot
  - Download Git here
- Once you have Git installed, download the bot with a command (in CMD or a terminal):
  - git clone https://github.com/Fyssion/mc-status-bot.git
- If you don't download the bot as a Git repo (using the steps above), you will not be able to run the bot
Install dependencies and setup the bot
- Python 3.6+ is required to run the bot. Python 3.7+ is recommended. Download Python here
- Once you have python installed, run updater.bat on Windows or updater.sh on Mac/Linux.
  - The updater will download all the dependencies for the bot and update you to the latest version.
    Run the updater whenever you need to update the bot or need help changing config options.
- When the updater is done updating the bot, it will initiate the setup.
  - The token is the how the bot logs into Discord, which you get from a bot application.
    - If you're unsure on how to create a bot application, visit this website.
  - Check the table below for more info on the rest of the options.
Run the bot
- On Windows, run run.bat and on Mac/Linux run run.sh
  - Note that you need to keep the bot running in order for it to keep displaying the status.
    If you can't host the bot on your machine, I recommend renting a cheap VPS to run the bot on.

The table below describes each option in the setup config. If you are confused, please ask in the support server.

Option	Description	Default
`bot-token`	This is the how the bot logs into Discord, which you get from a bot application. If you're unsure on how to create a bot application, visit this website.	No Default (required)
`prefix`	The prefix for the bot. This is used at the beginning of each command.	;
`server-ip`	The Minecraft server IP to display the status for.	No Default (required)
`refresh-rate`	The time in seconds in between status refreshes. Cannot be less than 30.	60
`maintenance-mode-detection`	Whether or not to run maintenance mode detection. This essentially looks for the specified word in the server's MOTD, and if it is found it sets the status to maintenance mode (DND). Example: setting the value to `maintenance` will look for the word "maintenance" in the server's MOTD.	Disabled

Just-Some-Bots/MusicBot for run and updater scripts. Copyright (c) Just-Some-Bots