From 6e1950535e1eab20b3029c89f989470da503d5ae Mon Sep 17 00:00:00 2001
From: metamuffin <metamuffin@disroot.org>
Date: Fri, 23 May 2025 14:35:35 +0200
Subject: document the remaining workers

---
 scripts/ytdlp_flatten.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'scripts/ytdlp_flatten.md')

diff --git a/scripts/ytdlp_flatten.md b/scripts/ytdlp_flatten.md
index e69de29..97ffb39 100644
--- a/scripts/ytdlp_flatten.md
+++ b/scripts/ytdlp_flatten.md
@@ -0,0 +1,22 @@
+# yt-dlp Playlist Flattener
+
+Transforms a playlist-like object into the media items that make it up.
+
+Currently supported task kinds are `youtube-channel` and `bilibili-channel`.
+Where task ids are the ids assigned by the respective platform.
+
+## Configuration
+
+- `ytdlp_flatten`
+  - `filters`: Map from flag to filter. Flags are taken from the `flag`
+    attribute in task data. Filters are passed straight to yt-dlp's
+    `--match-filter` flag.
+
+Sample configuration:
+
+```yaml
+ytdlp_flatten:
+    filters:
+        notlive: live_status=not_live
+        short: duration<300
+```
-- 
cgit v1.2.3-70-g09d2