Skip to content

Commit 999f0ba

Browse files
committed
Update readme
1 parent f946fb4 commit 999f0ba

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,12 @@ Including a custom help command and ping command, utils for easy embed creation,
55
## setup
66
`pip install -r requirements.txt`
77
`export TOKEN="your-key"`
8-
`python3 main.py`
9-
_Remember using a virtual environment!_
8+
`python3 main.py`
109

1110
#### optional env variables
1211
| parameter | description |
1312
| ------ | ------ |
14-
| `export Prefix="b!"` | Command prefix |
13+
| `export PREFIX="b!"` | Command prefix |
1514
| `export VERSION="unknown"` | Version the bot is running |
1615
| `export OWNER_NAME="unknwon"` | Name of the bot owner |
1716
| `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
2221
This bot does 'nothing' but is completely functional!
2322
_What is does:_
2423
* setup logging
24+
* scan env variables for a more customizable behaviour
2525
* overwrite `on_ready()` function for information at startup
26+
* make bot react to custom prefix and mention
27+
* add more advanced help command
2628
* 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.
2836

2937
## about
3038
This repository contains code that was written by me across various bot-projects, like:
3139
https://github.com/nonchris/discord-fury
40+
https://github.com/nonchris/quiz-bot
3241
https://github.com/Info-Bonn/poll-bot
3342

3443
I collected the most useful and generic functions to save me some time when starting the next bot-project.

0 commit comments

Comments
 (0)