6 releases

0.2.6 Jul 13, 2021
0.2.5 Jul 11, 2021
0.1.3 Jul 5, 2021

#6 in #ferris

Custom license

27KB
331 lines

ferris-bot

pipeline status

a discord bot written in rust

This bot is a rewrite of my first 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 for an example configuration.


lib.rs:

ferris bot is a discord bot written in rust. this library contains some basic things for the bot like commands. you should refer to this documentation if you want to extend the bot. since the bot uses serenity you should also refer to its documentation.

Examples

loading a config file

use ferris_bot::config::conf::load_config;

fn main() {
    let config = load_config("example_config.toml").unwrap();
}

Dependencies

~20–33MB
~603K SLoC