username/derp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: document YouTube follow plugin

Browse Source
This commit is contained in:
user
2026-02-15 14:34:24 +01:00
parent 3955935da4
commit e6419c1ffc
2 changed files with 49 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/CHEATSHEET.md
View File

@@ -303,6 +303,19 @@ Default time: 12:00. Timezone: `bot.timezone` config (default UTC).
Names: lowercase alphanumeric + hyphens, 1-20 chars. Max 20 feeds/channel. Names: lowercase alphanumeric + hyphens, 1-20 chars. Max 20 feeds/channel.
Polls every 10min. Announces max 5 new items per cycle. Persists across restarts. Polls every 10min. Announces max 5 new items per cycle. Persists across restarts.
## YouTube
```
!yt follow <url> [name] # Follow YouTube channel (admin)
!yt unfollow <name> # Unfollow channel (admin)
!yt list # List followed channels
!yt check <name> # Force-poll now
```
Accepts any YouTube URL: video, channel, handle, shorts, embed.
Names: lowercase alphanumeric + hyphens, 1-20 chars. Max 20 channels/channel.
Polls every 10min. Announces max 5 new videos per cycle. Persists across restarts.
## Plugin Template ## Plugin Template
```python ```python

36
docs/USAGE.md
View File

@@ -562,3 +562,39 @@ Polling and announcements:
- Supports HTTP conditional requests (`ETag`, `If-Modified-Since`) - Supports HTTP conditional requests (`ETag`, `If-Modified-Since`)
- 5 consecutive errors doubles the poll interval (max 1 hour) - 5 consecutive errors doubles the poll interval (max 1 hour)
- Feed subscriptions persist across bot restarts via `bot.state` - Feed subscriptions persist across bot restarts via `bot.state`
### `!yt` -- YouTube Channel Subscriptions
Follow YouTube channels and announce new videos in IRC channels. Accepts any
YouTube URL (video, channel, handle, shorts, embed) and resolves it to the
channel's Atom feed.
```
!yt follow <url> [name] Follow a YouTube channel (admin)
!yt unfollow <name> Unfollow a channel (admin)
!yt list List followed channels
!yt check <name> Force-poll a channel now
```
- `follow` and `unfollow` require admin privileges
- All subcommands must be used in a channel (not PM)
- If `name` is omitted on `follow`, it is derived from the channel title
- Names must be lowercase alphanumeric + hyphens, 1-20 characters
- Maximum 20 channels per IRC channel
URL resolution:
- `/channel/UCXXX` URLs extract the channel ID directly
- All other YouTube URLs (handles, videos, shorts) fetch the page to resolve
- Constructs the YouTube Atom feed URL from the resolved channel ID
Polling and announcements:
- Channels are polled every 10 minutes by default
- On `follow`, existing videos are recorded without announcing (prevents flood)
- New videos are announced as `[name] Video Title -- https://www.youtube.com/watch?v=ID`
- Maximum 5 videos announced per poll; excess shown as `... and N more`
- Titles are truncated to 80 characters
- Supports HTTP conditional requests (`ETag`, `If-Modified-Since`)
- 5 consecutive errors doubles the poll interval (max 1 hour)
- Subscriptions persist across bot restarts via `bot.state`