Skip to content

Commit 1aa519e

Browse files
committed
Update README and screenshots
1 parent df49599 commit 1aa519e

5 files changed

+15
-7
lines changed

README.md

+15-7
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,32 @@ The bot has the following extensions ("Cogs"):
1515
* Registration: On startup, the bot posts a registration form. New users must register using their Pretix ticket data. On success, the bot assigns the appropriate roles.
1616
* Programme Notifications: Before each session, the bot posts a session summary and updates the livestream URLs.
1717

18-
![registration_view.png](./img/registration_view.png)
18+
## Screenshots
19+
Registration Channel:
20+
![Registration Channel](./img/registration-channel.png)
1921

20-
## Configuration
22+
Registration Form:
23+
![Registration Form](./img/registration-form.png)
2124

22-
All configuration is server-agnostic. You can set up your own Discord server and use the included configuration.
25+
Programme Notification:
26+
![Programme Notification](./img/programme-notification.png)
2327

24-
Configuration files:
28+
## Configuration
2529

26-
* [`prod-config.toml`](./prod-config.toml) or [`test-config.toml`](./test-config.toml): Prod/Test configuration
27-
* [`test-livestreams.toml`](./test-livestreams.toml): Test livestream URL configuration
30+
All configuration is server-agnostic. You can set up your own Discord server and use the included configuration.
2831

2932
Arguments and environment variables:
3033

3134
* Argument `--config-file`: Path to .toml configuration file
3235
* Environment variable `DISCORD_BOT_TOKEN`: Discord bot auth token (with Admin and `GUILD_MEMBERS` privileges)
3336
* Environment variable `PRETIX_TOKEN`: Pretix access token (preferably read-only)
3437

35-
Files expected in the current directory (may be empty):
38+
Included example configuration files:
39+
40+
* [`prod-config.toml`](./prod-config.toml) or [`test-config.toml`](./test-config.toml): Prod/Test configuration
41+
* [`test-livestreams.toml`](./test-livestreams.toml): Test livestream URL configuration
42+
43+
Used cache and log files (will be created if necessary):
3644

3745
* `pretix_cache.json`: Local cache of Pretix ticket data
3846
* `registered_log.txt`: Log of registered users

img/programme-notification.png

24.4 KB
Loading

img/registration-channel.png

90.4 KB
Loading

img/registration-form.png

28 KB
Loading

img/registration_view.png

-389 KB
Binary file not shown.

0 commit comments

Comments
 (0)