the-programmers-hangout/swiftspiracy-bot
1
0
Fork 0
mirror of https://github.com/the-programmers-hangout/swiftspiracy-bot.git synced 2026-09-04 01:06:01 +02:00
Code Issues 1 Packages Projects Releases Wiki Activity

add basic readme to explain .env

Browse Source
This commit is contained in:
Khinshan Khan
2025-03-28 17:52:52 -04:00
parent a4af597c2f
commit 422bf3c546
1 changed files with 27 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+27
View File
@@ -1 +1,28 @@
# swiftspiracy
A playful Discord bot that sends random praises and (occasionally) a conspiracy theory — and cleans up after itself.
## Setup
### Configuration
Create a `.env` file in the root of your project with the following keys:
- `DISCORD_BOT_TOKEN`: Your bot token from the Discord developer portal.
- `DISCORD_CHANNEL_ID`: The ID of the channel where the bot should send messages.
- `SEND_MESSAGE_INTERVAL_MIN`: Minimum interval between messages (as an integer).
- `SEND_MESSAGE_INTERVAL_MAX`: Maximum interval between messages (as an integer).
- `SEND_MESSAGE_UNIT`: Time unit for the interval. Acceptable values: "second", "seconds", "minute", "minutes",
"millisecond", "milliseconds".
- `DELETE_CONSPIRACY_DELAY`: Time to wait before deleting a conspiracy message. Use Go duration format (eg "3s",
"500ms", "1m").
- `CONSPIRACY_PROBABILITY`: Probability (from 0.0 to 1.0) that a conspiracy message is sent after a praise. Eg, 0.4 =
40% chance.
You can view the [.env-sample](./.env-sample) as an example.
## Notes
- The bot gracefully shuts down on CTRL+C.