Skip to content

Commit e21c6f6

Browse files
committed
Update documentation
1 parent c1b6645 commit e21c6f6

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,23 @@
11
# discord-bot-template
22
Generic, functional bot based on discord.py
3-
Including logging configuration, some utils and a general bot setup
3+
Including a custom help command and ping command, utils for easy embed creation, logging configuration, and a general bot setup
44

55
## setup
66
`pip install -r requirements.txt`
77
`export TOKEN="your-key"`
88
`python3 main.py`
99
_Remember using a virtual environment!_
1010

11+
#### optional env variables
12+
| parameter | description |
13+
| ------ | ------ |
14+
| `export Prefix="b!"` | Command prefix |
15+
| `export VERSION="unknown"` | Version the bot is running |
16+
| `export OWNER_NAME="unknwon"` | Name of the bot owner |
17+
| `export OWNER_ID="100000000000000000"` | ID of the bot owner |
18+
19+
The shown values are the default values that will be loaded if nothing else is specified.
20+
1121
## features
1222
This bot does 'nothing' but is completely functional!
1323
_What is does:_

src/utils.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
import discord
22
from discord.errors import Forbidden
33

4+
"""
5+
The color presets, send_message() and make_embed() functions are included in the discord-bot template by nonchris
6+
https://github.com/nonchris/discord-bot
7+
"""
8+
9+
410
# color scheme for embeds as rbg
511
blue_light = discord.Color.from_rgb(20, 255, 255) # default color
612
green = discord.Color.from_rgb(142, 250, 60) # success green

0 commit comments

Comments
 (0)