···11+# VHS documentation
22+#
33+# Output:
44+# Output <path>.gif Create a GIF output at the given <path>
55+# Output <path>.mp4 Create an MP4 output at the given <path>
66+# Output <path>.webm Create a WebM output at the given <path>
77+#
88+# Require:
99+# Require <string> Ensure a program is on the $PATH to proceed
1010+#
1111+# Settings:
1212+# Set FontSize <number> Set the font size of the terminal
1313+# Set FontFamily <string> Set the font family of the terminal
1414+# Set Height <number> Set the height of the terminal
1515+# Set Width <number> Set the width of the terminal
1616+# Set LetterSpacing <float> Set the font letter spacing (tracking)
1717+# Set LineHeight <float> Set the font line height
1818+# Set LoopOffset <float>% Set the starting frame offset for the GIF loop
1919+# Set Theme <json|string> Set the theme of the terminal
2020+# Set Padding <number> Set the padding of the terminal
2121+# Set Framerate <number> Set the framerate of the recording
2222+# Set PlaybackSpeed <float> Set the playback speed of the recording
2323+# Set MarginFill <file|#000000> Set the file or color the margin will be filled with.
2424+# Set Margin <number> Set the size of the margin. Has no effect if MarginFill isn't set.
2525+# Set BorderRadius <number> Set terminal border radius, in pixels.
2626+# Set WindowBar <string> Set window bar type. (one of: Rings, RingsRight, Colorful, ColorfulRight)
2727+# Set WindowBarSize <number> Set window bar size, in pixels. Default is 40.
2828+# Set TypingSpeed <time> Set the typing speed of the terminal. Default is 50ms.
2929+#
3030+# Sleep:
3131+# Sleep <time> Sleep for a set amount of <time> in seconds
3232+#
3333+# Type:
3434+# Type[@<time>] "<characters>" Type <characters> into the terminal with a
3535+# <time> delay between each character
3636+#
3737+# Keys:
3838+# Escape[@<time>] [number] Press the Escape key
3939+# Backspace[@<time>] [number] Press the Backspace key
4040+# Delete[@<time>] [number] Press the Delete key
4141+# Insert[@<time>] [number] Press the Insert key
4242+# Down[@<time>] [number] Press the Down key
4343+# Enter[@<time>] [number] Press the Enter key
4444+# Space[@<time>] [number] Press the Space key
4545+# Tab[@<time>] [number] Press the Tab key
4646+# Left[@<time>] [number] Press the Left Arrow key
4747+# Right[@<time>] [number] Press the Right Arrow key
4848+# Up[@<time>] [number] Press the Up Arrow key
4949+# Down[@<time>] [number] Press the Down Arrow key
5050+# PageUp[@<time>] [number] Press the Page Up key
5151+# PageDown[@<time>] [number] Press the Page Down key
5252+# Ctrl+<key> Press the Control key + <key> (e.g. Ctrl+C)
5353+#
5454+# Display:
5555+# Hide Hide the subsequent commands from the output
5656+# Show Show the subsequent commands in the output
5757+5858+Output demo.gif
5959+6060+Require echo
6161+6262+Set Shell "bash"
6363+Set FontSize 24
6464+Set Width 1200
6565+Set Height 600
6666+6767+Type "./licker" Sleep 500ms Enter
6868+Type "GPL" Sleep 2.2s
6969+Type " 3.0" Sleep 1.2s Enter
7070+7171+Sleep 5s