43 lines
1.3 KiB
Markdown
43 lines
1.3 KiB
Markdown
|
# game-bot
|
||
|
|
This is a Bot by @lauralani to let her friends start, stop and display the status of various game servers.
|
||
|
|
|
||
|
|
## Prerequisites
|
||
|
|
Get the Discord Bot token by following this guide https://discordpy.readthedocs.io/en/stable/discord.html
|
||
|
|
|
||
|
|
Discord privileges needed:
|
||
|
|
Privileged Permissions:
|
||
|
|
- Message Content
|
||
|
|
Bot Permissions:
|
||
|
|
- Send Message Bot permission
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
```bash
|
||
|
|
# clone this repo
|
||
|
|
cp example/config.example.py config.py
|
||
|
|
|
||
|
|
# edit and fill config.py
|
||
|
|
python3 -m venv venv
|
||
|
|
source venv/bin/activate
|
||
|
|
pip3 install -r requirements.txt
|
||
|
|
|
||
|
|
python3 app.py
|
||
|
|
```
|
||
|
|
|
||
|
|
For setting this bot up as a systemd service, you can take a look at the
|
||
|
|
systemd service file in the example directory.
|
||
|
|
|
||
|
|
## Features
|
||
|
|
- modular configuration of services/game servers
|
||
|
|
- use chat commands in DM and in channels
|
||
|
|
|
||
|
|
## Commands
|
||
|
|
The bot has the following commands:
|
||
|
|
- __help__: Get help for the commands
|
||
|
|
- __info__: List all available games, their status and their _<slug>_
|
||
|
|
- __start__ _<slug>_: Start game with slug _<slug>_
|
||
|
|
- __stop__ _<slug>_: Stop game with slug _<slug>_
|
||
|
|
- __restart__ _<slug>_: Stop game with slug _<slug>_
|
||
|
|
- __status__ _<slug>_: Show status for game with slug _<slug>_
|
||
|
|
|
||
|
|
## License
|
||
|
|
`discord-bot` is available under the MIT license. See the [LICENSE](LICENSE) file for more info.
|