diff --git a/bot/README.md b/bot/README.md index bf4c725..a254331 100644 --- a/bot/README.md +++ b/bot/README.md @@ -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)