@@ -5,13 +5,12 @@ Including a custom help command and ping command, utils for easy embed creation,
5
5
## setup
6
6
` pip install -r requirements.txt `
7
7
` export TOKEN="your-key" `
8
- ` python3 main.py `
9
- _ Remember using a virtual environment!_
8
+ ` python3 main.py `
10
9
11
10
#### optional env variables
12
11
| parameter | description |
13
12
| ------ | ------ |
14
- | ` export Prefix ="b!" ` | Command prefix |
13
+ | ` export PREFIX ="b!" ` | Command prefix |
15
14
| ` export VERSION="unknown" ` | Version the bot is running |
16
15
| ` export OWNER_NAME="unknwon" ` | Name of the bot owner |
17
16
| ` export OWNER_ID="100000000000000000" ` | ID of the bot owner |
@@ -22,13 +21,23 @@ The shown values are the default values that will be loaded if nothing else is s
22
21
This bot does 'nothing' but is completely functional!
23
22
_ What is does:_
24
23
* setup logging
24
+ * scan env variables for a more customizable behaviour
25
25
* overwrite ` on_ready() ` function for information at startup
26
+ * make bot react to custom prefix and mention
27
+ * add more advanced help command
26
28
* register example cog with ` b!ping ` command
27
- * util function for easy embed creation
29
+ * util functions for easy embed creation, id extraction and more
30
+
31
+ Note:
32
+ The bot uses all intents by default, those are required for such simple things like 'display member-count at startup'.
33
+ You need to enable those intents in the discord developers portal under "Application/Bot/Privileged Gateway Intents".
34
+ It's possible reconfigure the requested intents in ` main.py ` if you don't need them.
35
+ But I'd suggest using them all for the beginning, especially if you're relatively new to discord.py.
28
36
29
37
## about
30
38
This repository contains code that was written by me across various bot-projects, like:
31
39
https://github.com/nonchris/discord-fury
40
+ https://github.com/nonchris/quiz-bot
32
41
https://github.com/Info-Bonn/poll-bot
33
42
34
43
I collected the most useful and generic functions to save me some time when starting the next bot-project.
0 commit comments