Skip to content

Commit dccea12

Browse files
committed
Add docs for seabird-adventofcode-plugin
1 parent 5ef0a0b commit dccea12

2 files changed

Lines changed: 28 additions & 1 deletion

File tree

src/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
- [seabird-irc-backend](admin/seabird-irc-backend.md)
1515
- [seabird-minecraft-backend](admin/seabird-minecraft-backend.md)
1616
- [Plugins]()
17-
- [seabird-adventofcode-plugin]()
17+
- [seabird-adventofcode-plugin](admin/seabird-adventofcode-plugin.md)
1818
- [seabird-datadog-plugin]()
1919
- [seabird-github-plugin]()
2020
- [seabird-plugin-bundle]()
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# seabird-adventofcode-plugin
2+
3+
[![Static Badge](https://img.shields.io/badge/repository-blue?logo=git&label=%20&labelColor=grey&color=blue)](https://github.com/seabird-chat/seabird-adventofcode-plugin)
4+
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/seabird-chat/seabird-adventofcode-plugin/docker-publish.yml)](https://github.com/seabird-chat/seabird-adventofcode-plugin/actions/workflows/docker-publish.yml)
5+
6+
## Dependencies
7+
8+
- `seabird-core`
9+
10+
## Configuration
11+
12+
### Environment Variables
13+
14+
{{#include _common_plugin_settings.md}}
15+
16+
Advent of Code-specific settings
17+
18+
- `AOC_SESSION` (required) - the session cookie, usually manually obtained from
19+
a valid login. This must be updated once monthly to ensure it continues to
20+
work.
21+
- `AOC_LEADERBOARD` (required) - leaderboard ID from Advent of Code to report
22+
updates from. Note that the user the bot is logged in as must be joined to the
23+
leaderboard.
24+
- `AOC_CHANNEL` (required) - the ID of the seabird channel which notifications
25+
should be sent to.
26+
- `TIMESTAMP_FILE` (optional, defaults to `./aoc_timestamp.txt`) - path to the
27+
file which is used to track the last timestamp we've processed from AOC.

0 commit comments

Comments
 (0)