Skip to content

docs: document bot .env.example and required environment variables #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DeadIndian merged 1 commit into from
Jun 3, 2026
+14 −6
Merged

docs: document bot .env.example and required environment variables #118

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions bot/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,22 @@ npm run start
```

### Environment
Create a `.env` file in `bot/` with:

```
DISCORD_TOKEN=your_bot_token_here
CLIENT_ID=your_bot_client_id_here
GUILD_ID=your_test_server_id_here
Copy `bot/.env.example` to `bot/.env` and fill in the values.

```env
DISCORD_TOKEN=your_discord_bot_token
DISCORD_CLIENT_ID=your_discord_application_client_id
GUILD_ID=your_optional_guild_id_for_guild_scoped_command_deploy
API_URL=http://localhost:5000
BOT_API_KEY=your_bot_api_key
```

- `DISCORD_TOKEN` is required to log in the bot.
- `DISCORD_CLIENT_ID` is used by `npm run deploy:commands`.
- `GUILD_ID` is optional and can be used for instant guild-scoped command registration.
- `API_URL` should point to your running backend.
- `BOT_API_KEY` must match `BOT_API_KEY` on the backend server for authenticated bot API requests.

### Scripts
- `npm run start`: start the bot
- `npm run dev`: start with auto-reload (nodemon)
Expand Down