Skip to content

docs: add reference to default options list #680

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hesreallyhim wants to merge 5 commits into
base: main
Choose a base branch
from
Open

docs: add reference to default options list #680

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e33b4bf
docs: document default values
hesreallyhim Nov 29, 2025
b65fbf8
docs: add min and max
hesreallyhim Nov 29, 2025
c81cdb8
docs: link in README to DEFAULTS
hesreallyhim Nov 29, 2025
b73137c
chore: spacing
hesreallyhim Nov 29, 2025
037d437
chore: remove unused defaults file
hesreallyhim Nov 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions DEFAULTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# VHS Default Options

This document lists the default values for VHS configuration options.

## Terminal Settings

| Option | Default Value | Notes |
|--------|---------------|-------|
| FontFamily | JetBrains Mono, DejaVu Sans Mono, Menlo, Bitstream Vera Sans Mono, Inconsolata, Roboto Mono, Hack, Consolas, ui-monospace, monospace | Comma-separated font stack with Apple Symbols fallback |
| FontSize | 22 | |
| LetterSpacing | 1.0 | |
| LineHeight | 1.0 | |
| TypingSpeed | 50ms | |
| Shell | bash (Unix) / cmd (Windows) | Valid: bash, zsh, fish, powershell, pwsh, cmd, nu, osh, xonsh |
| CursorBlink | true | |

## Video Settings

| Option | Default Value | Notes |
|--------|---------------|-------|
| Width | 1200 | Pixels |
| Height | 600 | Pixels |
| Padding | 60 | Pixels |
| Framerate | 50 | Frames per second |
| PlaybackSpeed | 1.0 | Multiplier (0.5 = half speed, 2.0 = double speed) |
| MaxColors | 256 | For GIF output |
| LoopOffset | 0 | Percentage (0-100%) for GIF loop start position |

## Window Styling

| Option | Default Value | Notes |
|--------|---------------|-------|
| Margin | 0 | Pixels |
| MarginFill | #171717 | Hex color or image path |
| WindowBar | *(empty)* | Valid: Colorful, ColorfulRight, Rings, RingsRight |
| WindowBarSize | 30 | Pixels (when WindowBar is enabled) |
| WindowBarColor | #171717 | |
| BorderRadius | 0 | Pixels |
| BackgroundColor | #171717 | |

## Wait Command Settings

| Option | Default Value | Notes |
|--------|---------------|-------|
| WaitTimeout | 15s | Must be positive |
| WaitPattern | `>$` | Regex pattern |

## Default Theme Colors

| Option | Default Value | Notes |
|--------|---------------|-------|
| Background | #171717 | |
| Foreground | #dddddd | |
| Cursor | #dddddd | |
| CursorAccent | #171717 | |
| Black | #282a2e | ANSI 0 |
| BrightBlack | #4d4d4d | ANSI 8 |
| Red | #D74E6F | ANSI 1 |
| BrightRed | #FE5F86 | ANSI 9 |
| Green | #31BB71 | ANSI 2 |
| BrightGreen | #00D787 | ANSI 10 |
| Yellow | #D3E561 | ANSI 3 |
| BrightYellow | #EBFF71 | ANSI 11 |
| Blue | #8056FF | ANSI 4 |
| BrightBlue | #9B79FF | ANSI 12 |
| Magenta | #ED61D7 | ANSI 5 |
| BrightMagenta | #FF7AEA | ANSI 13 |
| Cyan | #04D7D7 | ANSI 6 |
| BrightCyan | #00FEFE | ANSI 14 |
| White | #bfbfbf | ANSI 7 |
| BrightWhite | #e6e6e6 | ANSI 15 |
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,9 @@ Setting must be administered at the top of the tape file. Any setting (except
`TypingSpeed`) applied after a non-setting or non-output command will be
ignored.

> [!Note]
> Default values for all options can be found in [DEFAULTS.md](./DEFAULTS.md).

#### Set Shell

Set the shell with the `Set Shell <shell>` command
Expand Down