# ferris-bot
[![pipeline status](https://gitlab.sokoll.com/moritz/ferris-bot/badges/master/pipeline.svg)](https://gitlab.sokoll.com/moritz/ferris-bot/-/commits/master)
## a discord bot written in rust
This bot is a rewrite of [my first bot](https://gitlab.sokoll.com/moritz/discord-bot).
It aims to improve performance, usability and configuration for different parts of the bot.
## planned features
- configuration (TOML)
- extensibility
- dockerizing
- database (preferably MariaDB or PostgreSQL) for storing user data

## Setup
To setup `ferris-bot` follow the steps below:
1. clone the repository: `git clone https://gitlab.sokoll.com/moritz/ferris-bot.git`
2. run the container: `make run` (if you are on the dev branch use `make dev-run`)

after some time the bot will come online and you can use simple commands for him.


## configuration
See the [example_config.toml](/example_config.toml) for an example configuration.