Metadata-Version: 2.1
Name: vspreview
Version: 0.11.3
Summary: Previewer for VapourSynth scripts
Author: Endilll
Author-email: 
Maintainer: Setsugen no ao
Maintainer-email: setsugen@setsugen.dev
Project-URL: Source Code, https://github.com/Jaded-Encoding-Thaumaturgy/vs-preview
Project-URL: Contact, https://discord.gg/XTpc6Fa9eB
Classifier: Topic :: Multimedia :: Graphics
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyQt6 (>=6.6.1)
Requires-Dist: PyYAML (>=6.0)
Requires-Dist: QDarkStyle (>=3.1)
Requires-Dist: VapourSynth (>=68)
Requires-Dist: jetpytools (>=1.2.3)
Requires-Dist: matplotlib (>=3.7.1)
Requires-Dist: numpy (>=1.24.3)
Requires-Dist: requests-toolbelt (>=1.0.0)
Requires-Dist: requests (>=2.31.0)
Requires-Dist: vsengine (>=0.2.0)
Requires-Dist: Pillow (>=9.4.0) ; platform_system == "Windows"
Requires-Dist: pywin32 (>=306) ; platform_system == "Windows"

# Standalone previewer for VapourSynth scripts

Fork of Endilll's [vapoursynth-preview](https://github.com/Endilll/vapoursynth-preview) (not maintained anymore)

This program is meant to be paired with a code editor with integrated terminal like Visual Studio Code.

# Prerequisites

1. [Python](https://www.Python.org/downloads) (3.12+ required)
   - Make sure to install Python to your `PATH`.
1. [VapourSynth](https://github.com/vapoursynth/vapoursynth/releases) (R65+ required)

# Installation

Install latest stable via pypi:

```bash
pip install vspreview
```

Install latest git:

```bash
pip install -U git+https://github.com/Jaded-Encoding-Thaumaturgy/vs-preview.git
```

# Usage

It can be used by running `vspreview script.vpy` or your preferred way in [your IDE](#ide-integration).

[Keyboard Shortcuts](https://github.com/Jaded-Encoding-Thaumaturgy/vs-preview/blob/master/docs/accessibility/keybinds.rst)

[Saved Frame Filename Variables](https://github.com/Jaded-Encoding-Thaumaturgy/vs-preview/tree/master/docs/save_frame_placeholders.md)

# IDE Integration

- [Visual Studio Code](https://github.com/Jaded-Encoding-Thaumaturgy/vs-preview/tree/master/docs/installation/install_vscode.rst)
- [Vim](https://github.com/Jaded-Encoding-Thaumaturgy/vs-preview/tree/master/docs/installation/install_vim.rst)
- [Notepad++](https://github.com/Jaded-Encoding-Thaumaturgy/vs-preview/tree/master/docs/installation/install_notepad++.rst)

# Plugins

You can install external plugins by using the following command:

```bash
vspreview install [plugin-name]
```

A list of plugins can be found in [this repo](https://github.com/Jaded-Encoding-Thaumaturgy/vs-preview-plugins). `plugin-name` is the name of the plugin directory in the repo.

To develop new plugins or manually install them, create a .ppy file inside the global plugins directory. You can find the path to that in the storage file. You can add additional search paths by adding them to a .pth file inside the global plugins directory, just like you can with python path and site-packages.
