VapourSynth Preview
A VS Code extension for recognizing and previewing VapourSynth scripts (.vpy files).
Features
- File Recognition: Automatically associates
.vpy files with Python language for syntax highlighting and IntelliSense
- vspreview: Preview VapourSynth script output with vspreview (
Ctrl+F5)
- Execute Script: Run
.vpy scripts directly in the terminal (Ctrl+F6)
- Script Info: View script output info with vspipe -i (
Ctrl+F7)
- Benchmark: Run performance benchmarks with vspipe -p (
Ctrl+F8)
Getting Started
- The extension requires the Python extension for syntax highlighting and IntelliSense (will be installed automatically as a dependency)
- After installing, open VS Code settings and set
vapoursynth.vspipePath to the full path of the vspipe executable (e.g. C:\tools\vapoursynth\vspipe.exe). You may also set vapoursynth.pythonPath to a specific Python executable.
- Open a
.vpy file and use the keybindings to start working
Keybindings
| Shortcut |
Action |
Description |
Ctrl+F5 |
Preview |
Launch vspreview |
Ctrl+F6 |
Execute |
Run script in terminal |
Ctrl+F7 |
Info |
Show script output info |
Ctrl+F8 |
Bench |
Run performance benchmark |
Keybindings are only active when editing .vpy files.
Configuration
Configure in VS Code settings:
| Setting |
Default |
Description |
vapoursynth.vspipePath |
"" |
Full path to the vspipe executable (for example C:\\tools\\vapoursynth\\vspipe.exe). This is required for vspipe-based commands. |
vapoursynth.pythonPath |
"" |
Path to Python executable. If empty, defaults to python from the vspipe path. You can still set this manually. |
Example:
{
"vapoursynth.vspipePath": "C:\\tools\\vapoursynth\\vspipe.exe",
"vapoursynth.pythonPath": ""
}
If vapoursynth.vspipePath is not configured, the extension will search your system PATH for a vspipe executable and use the first match found. If neither a configured path nor a PATH entry is available, set vapoursynth.vspipePath manually.
Additionally, if you prefer not to set pythonPath, the extension will attempt to use the interpreter from the vspipe path. If that inference fails, set vapoursynth.pythonPath explicitly.
Directory Structure Reference
Typical VapourSynth directory layout:
vapoursynth/
├── python.exe
├── vspipe.exe
├── vapoursynth64/
│ └── plugins/
└── ...
Build & Install
npm install -g @vscode/vsce
npm install
npm run compile
vsce package
Then install the generated .vsix file in VS Code via "Install from VSIX...".
