Skip to content

Commit ae44800

Browse files
committed
Updated README to show configurable env variables and their defaults
1 parent 959a6a8 commit ae44800

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,21 @@ This bot requires the `Manage Messages` permission to control reactions. To gran
77
`https://discordapp.com/oauth2/authorize?&client_id=<CLID>&scope=bot&permissions=8192`
88

99
Alternatively, invoke `!wobabout` to get an invite link.
10+
11+
## Configuration
12+
13+
Additional environment variables can be used to configure the bot's various aspects.
14+
15+
| Name | Default | What? |
16+
| ---- | ------- | ----- |
17+
| DISCORD_TOKEN | n/a; Required variable | Discord token to connect to the bot |
18+
| ARCANUM_TOKEN | | Token for unlimited API calls to the archive |
19+
| BRANDONSANDERSON_URL | | The homepage URL to extract progress information |
20+
| ARCANUM_URL | https://wob.coppermind.net | The base URL for API interactions |
21+
| WIKI_URL | coppermind.net | The wiki URL |
22+
| WIKI_COMMAND | coppermind|cm | The wiki interaction command |
23+
| WOB_COMMAND | wob | The WoB interaction command |
24+
| ARCANUM_ICON | ![](https://cdn.discordapp.com/emojis/373082865073913859.png?v=1) | The URL of the Icon to use for archive responses |
25+
| WIKI_ICON | ![](https://cdn.discordapp.com/emojis/432391749550342145.png?v=1) | The URL of the Icon to use for wiki responses |
26+
| ARCANUM_COLOR | ![#003A52](https://via.placeholder.com/15/003A52/000000?text=+) | The color to use in the WoB interactions |
27+
| WIKI_COLOR | ![#CB6D51](https://via.placeholder.com/15/CB6D51/000000?text=+) | The color to use in the Wiki interactions |

0 commit comments

Comments
 (0)