document video directive

botisimo · Jun 25, 2022 · e76ebce · e76ebce
1 parent 652b6ca
commit e76ebce
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/docs/directives/index.rst b/docs/directives/index.rst
@@ -27,5 +27,6 @@ Response directives are used to make dynamic actions for your `custom commands <
    predelay
    prehours
    transfer
+   video
    whisper
    advanced
diff --git a/docs/directives/video.rst b/docs/directives/video.rst
@@ -0,0 +1,20 @@
+$[video]
+========
+
+Sends a video to play in the `video overlay <https://botisimo.com/account/overlays>`_.
+
+Usage:
+    $[video ``<name>``]
+
+Arguments:
+    * ``name`` **<required>** - The name of the video to play
+
+Example Command:
+    **name**: !video
+
+    **response**: $[video my video] This command will trigger the video named "my video"
+
+    **output**::
+
+        user:     !video
+        botisimo: This command will trigger the video named "my video"