Skip to content

Commit 6e1d981

Browse files
committed
update readme and add .env.example
1 parent a315994 commit 6e1d981

File tree

2 files changed

+24
-5
lines changed

2 files changed

+24
-5
lines changed

.env.example

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
ENVIORNMENT=dev # dev, prod
2+
3+
TOKEN=Bot 12ab3dc # The "Bot" prefix is required
4+
DEV_TOKEN=Bot 12ab3dc # Optional if you want to use a separate bot for development
5+
6+
APP_ID=12345 # ID of the app, found in the Discord Developer Portal
7+
DEV_APP_ID=12345 # Optional if you want to use a separate bot for development
8+
9+
REGISTER_CMDS=false # Set this to true if you want to register all commands on startup (recommended for development)
10+
MAIN_COLOR=#FFFFFF # The color of the bot's embeds
11+
OWNER_ID=12345 # The ID of the bot owner
12+
WEBHOOK_URL=... # Optional Webhook for console logs
13+
14+
# Redis
15+
REDIS_URL=redis://... # Redis URL
16+
17+
# Database
18+
DATABASE_DSN=... # Postgre DSN for the database

README.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 🦆 Quack
22

3-
*Formerly Seeds*
3+
_Formerly Seeds_
44

55
A Discord bot focused on making Discord safer. Providing exceptional tools for moderation and community protection.
66

@@ -26,17 +26,18 @@ cd bot
2626

2727
2. Set up environment variables.
2828

29-
- Create a `.env.local` in the root of the project.
30-
- Refer to [`config.ts`](./config.ts) to see all the required enviornment variables.
31-
- Feel free to omit any for testing.
29+
- Create a `.env.local` in the root of the project.
30+
- Refer to [`.env.example`](./env.example) to see all the required enviornment variables.
31+
- Refer to [`config.json`](./config.json) to see more configuration options.
32+
- Feel free to omit any for testing.
3233

3334
3. Start the bot!
3435

3536
```
3637
go run .
3738
```
3839

39-
- This will run the bot.
40+
- This will run the bot.
4041

4142
## Contributing
4243

0 commit comments

Comments
 (0)