Regenerate PLUGINS.md

PLUGINS.md

@@ -1,5 +1,5 @@
 
-<!-- This file is autogenerated as part of avtdl at 2024-07-26 11:38:45.265035 -->
+<!-- This file is autogenerated as part of avtdl at 2024-08-10 18:17:01.661303 -->
 
 ## Description and configuration of available plugins
 
@@ -840,11 +840,20 @@ Depending on the tweet type (regular, retweet, reply, quote) some fields might b
 
 ### `rplay` - Monitor livestreams on RPLAY
 
-Work in progress, functionality and configuration format
-are subjects to change.
+Monitors users with `creator_oid` listed in `creators`, produces a record
+when any of them starts a livestream. When `creators` list is not provided,
+every livestream on the site will generate a record. `creator_oid` is the
+unique part of the user's home or livestream url.
+For example, `creator_oid` is `6596e71c04a7ea2fd7c36ae7`
+for the following urls:
+
+- `https://rplay.live/creatorhome/6596e71c04a7ea2fd7c36ae7`
+- `https://rplay.live/live/6596e71c04a7ea2fd7c36ae7`
 
-Checks all listed streams at once, does not support providing
-credentials, does not try to retrieve playlist url.
+This monitor checks all creators with a single request,
+however, because of that it does not try to retrieve the
+direct `playlist url` for livestreams, and therefore does
+not support providing login credentials.
 
 
 #### Plugin configuration options:
@@ -862,6 +871,7 @@ database is kept in memory and not stored on disk at all, providing a clean data
 * `headers`: custom HTTP headers as pairs "key": value". "Set-Cookie" header will be ignored, use `cookies_file` option instead. Default value is `"Accept-Language": "en-US,en;q=0.9"`.
 * `quiet_start`: throw away new records on the first update after application startup. Default value is `false`.
 * `quiet_first_time`: throw away new records produced on first update of given url. Default value is `true`.
+* `creators`: list of IDs of the users to monitor. Entity with no IDs will report on every user going live. Not required.
 
 
 #### Produced records types:
@@ -929,6 +939,7 @@ database is kept in memory and not stored on disk at all, providing a clean data
 * `headers`: custom HTTP headers as pairs "key": value". "Set-Cookie" header will be ignored, use `cookies_file` option instead. Default value is `"Accept-Language": "en-US,en;q=0.9"`.
 * `quiet_start`: throw away new records on the first update after application startup. Default value is `false`.
 * `quiet_first_time`: throw away new records produced on first update of given url. Default value is `true`.
+* `creators`: list of IDs of the users to monitor. Entity with no IDs will report on every user going live. Not required.
 
 
 #### Produced records types: