MineBot/README.md
2024-04-10 16:13:00 -07:00

47 lines
1.3 KiB
Markdown

# MineBot
A Discord bot for managing your Minecraft server via [Minecraft Minder](https://git.zyphon.com/will/minecraft-minder)
Forked from [SparkBot](https://github.com/jkkicks/SparkBot)
## Prerequisites
- Go to https://discord.com/developers/applications and make an application
- Go to the Bot page.
- Copy `env.dist` to `.env` and add the Bot Token to this file.
- Choose what channels you want the bot to operate in on your server and add their IDs to the file as well.
## Installation
Requires Python 3.
- Run `pip install -r requirements.txt`
## Running
Run `python3 main.py`
## Usage
### Command Tree
```
/addserver - Add a Minecraft server to the bot (global)
/adduser - Add a user to a Minecraft server (global)
/removeuser - Remove a user from a Minecraft server
/listservers - List the Minecraft servers you have access to
/status - Get the status of the first Minecraft server you have acces to
/start - Start the first Minecraft server you have acces to
```
#### Hidden commands
```
/99 - Brooklyn 99 Quotes
/shutdown - Kill the bot (global)
/sync - Sync the slash-command tree with Discord
```
## Database
Initialization of the structure is automatically handled inside `main.py` and
creates the SQLITE3 file `bot_data.db`.