Skip to main content

​
Using plugins in Scope

The Scope plugin system enables third-party extensions to provide custom pipelines. Install plugins to access additional models, preprocessors, and capabilities beyond the built-in pipelines.

​
Plugin Sources

Plugins can be installed from three sources:
SourceFormatDescription
Git (Recommended)https://github.com/user/repoInstall directly from a Git repository
PyPImy-scope-pluginInstall from the Python Package Index
Local/path/to/pluginInstall from a local directory (development)

​
Git Installation

You can paste the URL directly from your browser: 
https://github.com/user/plugin-repo
Optionally specify a branch, tag, or commit: 
https://github.com/user/plugin-repo@v1.0.0
https://github.com/user/plugin-repo@main
https://github.com/user/plugin-repo@abc1234

​
PyPI Installation

my-scope-plugin
my-scope-plugin==1.0.0

​
Local Installation

/path/to/my-plugin
C:\Users\username\projects\my-plugin
Local plugins are installed in editable mode, meaning code changes take effect after reloading the plugin.

​
Installing Plugins

1

Open Plugin Settings

Click the gear icon in the app header to open the Settings dialog.Settings gear buttonNavigate to the Plugins tab.Plugins tab
2

Enter package spec

In the installation input field, enter the plugin source (Git URL, PyPI package name, or local path).You can also click Browse to select a local plugin directory.Install button
3

Install

Click the Install button and wait for installation to complete.Install progressThe server will restart automatically to load the new plugin.
4

Verify installation

The plugin should appear in the installed plugins list, and its pipelines will be available in the pipeline selector.

​
Managing Plugins

​
Viewing Installed Plugins

The Plugins tab in Settings displays all installed plugins with their source information.

​
Uninstalling a Plugin

1

Find the plugin

In the Plugins tab, locate the plugin you want to remove.
2

Uninstall

Click the trash icon next to the plugin.Uninstall button
3

Wait for restart

The server will restart to unload the plugin.

​
Updating a Plugin

Scope automatically checks for updates when you open the Plugins tab.
1

Open the Plugins tab

Any plugin with a newer version available shows an Update button.
2

Update

Click the Update button next to the plugin.
3

Wait for restart

The server will restart to load the updated plugin.
Local plugins do not support update detection. To pick up code changes for a local plugin, use Reload instead.

​
Reloading a Plugin (Local Only)

When developing a local plugin, you can reload it after making code changes without reinstalling:
1

Make your code changes

Edit the plugin source files.
2

Reload

Click the reload icon next to your locally installed plugin.Reload button
3

Wait for restart

The server will restart to pick up the changes.
The reload button only appears for plugins installed from local paths.
External sources can facilitate plugin installation via protocol URLs: 
daydream-scope://install-plugin?package=<spec>
When you click a deep link:
  1. The desktop app opens (or launches if not running)
  2. The Settings dialog opens with the Plugins tab selected
  3. The package spec is pre-filled in the input field
  4. You confirm to begin installation
Deep links are only supported in the Desktop App, not manual installations.

​
CLI Commands

The daydream-scope CLI provides commands for managing plugins directly from the terminal.

​
Listing Installed Plugins

uv run daydream-scope plugins
Shows all installed plugins with their name, version, source, and registered pipelines.

​
Installing a Plugin

uv run daydream-scope install <package>
Examples for each source type: 
# From a Git repository
uv run daydream-scope install https://github.com/user/plugin-repo

# From PyPI
uv run daydream-scope install my-scope-plugin

# From a local directory (editable mode)
uv run daydream-scope install -e /path/to/my-plugin
OptionDescription
--upgradeUpgrade the plugin to the latest version
-e, --editableInstall a project in editable mode from a local path

​
Uninstalling a Plugin

uv run daydream-scope uninstall <name>
Removes the plugin and unloads any active pipelines it provided.

​
Troubleshooting

  • Check that the package spec is correct (valid Git URL or PyPI package name)
  • Verify your internet connection
  • Check for dependency conflicts in the installation error message
  • Ensure the server restarted after installation
  • Check that the plugin implements the register_pipelines hook correctly
  • Verify the plugin’s pipelines meet your GPU’s VRAM requirements
  • The plugin may have introduced a dependency conflict
  • Try uninstalling the plugin via the Settings dialog
  • If that fails, manually remove the plugin from ~/.daydream-scope/plugins/plugins.txt

​
See Also

Developing Plugins

Create your own custom pipelines

Plugin Architecture

Technical details of the plugin system

Tutorial: Build a VFX Plugin

Step-by-step tutorial building a complete plugin from scratch