ConfrerieDuKassoulait/KassouBot
ConfrerieDuKassoulait/KassouBot
Archived
2
0
Fork 0
Code Issues 3 Pull requests Projects Releases Wiki Activity

Update feature list

Browse source
This commit is contained in:
Mylloon 2021-09-17 10:51:47 +02:00
parent e015ca8ae8
commit 6da4e2e54b
1 changed files with 17 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -2,13 +2,28 @@
[![Version](https://img.shields.io/badge/version-1.6-green?style=for-the-badge)](https://gitlab.com/ConfrerieDuKassoulait/KassouBot/-/releases) [![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) [![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__ ## __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. 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: 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: On Debian-based distro:
```batch ```batch
@ -19,7 +34,7 @@ On Windows:
docker network create -d bridge default-kassoubot 2> NUL || REM docker network create -d bridge default-kassoubot 2> NUL || REM
``` ```
Then we can create our containers: Then you can create our containers:
```batch ```batch
docker run -d \ docker run -d \
--name="Lavalink" \ --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`. - 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). - 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__ ## __Launching locally__
If you want to run it without Docker, clone the repo and his submodules by doing this command in the git folder: If you want to run it without Docker, clone the repo and his submodules by doing this command in the git folder:
```batch ```batch