From 6da4e2e54bc2b2f5a1e262889cfc74ebc5788113 Mon Sep 17 00:00:00 2001 From: Mylloon Date: Fri, 17 Sep 2021 10:51:47 +0200 Subject: [PATCH] Update feature list --- README.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 6f554f3..15819e4 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,28 @@ [![Version](https://img.shields.io/badge/version-1.6-green?style=for-the-badge)](https://gitlab.com/ConfrerieDuKassoulait/KassouBot/-/releases) [![Build](https://img.shields.io/gitlab/pipeline/ConfrerieDuKassoulait/KassouBot/dev?style=for-the-badge)](https://gitlab.com/ConfrerieDuKassoulait/KassouBot/container_registry) + +## __Features__ + +- First, there is a strong `help` command who explain every single commands. +- Slash commands support (use [Discord Interactions](https://github.com/goverfl0w/discord-interactions)). +- Party games activities support (use [Discord Together](https://github.com/apurv-r/discord-together)). +- Music support (use [Lavalink](https://github.com/freyacodes/Lavalink) with the [Wavelink](https://github.com/PythonistaGuild/Wavelink) client). +- Reminders and Todos list support. +- Poll support. +- Meme from reddit and NSFW pictures support. +- Basics commands and simple games, don't mind on opening an issue if you wan't your idea to be added to the bot. +- Use [discord.py](https://github.com/Rapptz/discord.py) (rewrite). +- Use [SQLite](https://www.sqlite.org/index.html) for the database. + + ## __Setting up__ You have to replace `TOKEN_DISCORD`, `PREFIX`, `TOKEN_GENIUS`, `TOKEN_REDDIT_CLIENT_ID`, `TOKEN_REDDIT_CLIENT_SECRET`, `TOKEN_REDDIT_USER_AGENT` and [`TIMEZONE`](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) with your desired values. You must also specify a path to the folder where the database will be. With a [docker-compose](https://gitlab.com/ConfrerieDuKassoulait/KassouBot/-/blob/main/docker-compose.yml) or in command line: -First we need to create a dedicated network for our containers: +First you need to create a dedicated network for our containers: On Debian-based distro: ```batch @@ -19,7 +34,7 @@ On Windows: docker network create -d bridge default-kassoubot 2> NUL || REM ``` -Then we can create our containers: +Then you can create our containers: ```batch docker run -d \ --name="Lavalink" \ @@ -59,13 +74,6 @@ To find Genius token, go to [this site](https://genius.com/api-clients), `login - You have the link to copy above between the two blocks `scopes` and `permissions`. - If you need help, you can [join my Discord](https://discord.gg/Z5ePxH4). -## __Features__ - -- Using [discord.py](https://github.com/Rapptz/discord.py) (rewrite) -- Everything is explained by doing the `help` command. -- Using [SQLite](https://www.sqlite.org/index.html) for the database. -- Using [Lavalink](https://github.com/freyacodes/Lavalink) with the client [Wavelink](https://github.com/PythonistaGuild/Wavelink). - ## __Launching locally__ If you want to run it without Docker, clone the repo and his submodules by doing this command in the git folder: ```batch