Documentation5 min read

Systems

Effect Packs

Portable bundles of effects, policies, scores, and assets that work together. Install, export, share, and compose.

In this doc

  1. 01What Is an Effect Pack
  2. 02Pack Structure
  3. 03Installing Packs
  4. 04Creating & Exporting Packs
  5. 05Pack Composition
  6. 06Sharing & Marketplace
01

What Is an Effect Pack

An effect pack is a self-contained bundle that includes: named effects (with all their layers), policy rules (conditions and actions), assets (video files, audio clips, images), and optionally custom score formulas.

Packs are the unit of sharing and composition in VPE. Instead of configuring effects one by one, you install a pack and get a complete automation setup — like installing a theme for your stream automation.

VPE ships with a default 'Starter Pack' that covers common automation scenarios: donation celebrations, raid welcomes, follow notifications, and BRB transitions.

02

Pack Structure

A pack is a directory (or .vpepack archive) containing: manifest.json (metadata, version, dependencies), effects/ (named effect definitions), policies/ (policy rules that reference the effects), and assets/ (media files).

The manifest declares compatibility (version requirement), authorship, description, and which channels it uses. This lets VPE validate a pack before installation.

Assets are referenced by relative path in effect definitions. When a pack is installed, assets are copied to VPE's asset directory and paths are resolved automatically.

my-pack/
├── manifest.json
├── effects/
│   ├── celebration.json
│   └── raid_welcome.json
├── policies/
│   └── triggers.json
└── assets/
    ├── confetti.webm
    ├── airhorn.mp3
    └── welcome_banner.png
03

Installing Packs

Install a pack from the Effects tab → Packs section. You can install from a local .vpepack file or from the future VPE marketplace (coming post-launch).

Installation validates the pack against your current setup: checks for effect ID conflicts, verifies asset formats are supported, and confirms OBS source requirements are met.

Only one pack can be 'active' at a time (determines the primary effect set), but multiple packs can be installed simultaneously. Inactive packs' effects are available but not auto-triggered by policies.

04

Creating & Exporting Packs

Create a pack from your existing effects. In the Effects tab, select effects to bundle, click 'Export as Pack', and VPE packages the effects, their referenced policies, and all required assets.

Exported packs are portable — they include everything needed to work on another machine. Asset paths are relativized, effect IDs are preserved, and policy references are maintained.

Version your packs with semantic versioning. When you update a pack, VPE can detect changes and offer to update installations. Breaking changes (removed effects, renamed IDs) bump the major version.

Try it yourself

See the difference on your own stream

VPE's free tier includes scene switching, moment detection, and chat moderation. Connect OBS, link your platform, stream smarter in 15 minutes.

Get Early Access
05

Pack Composition

Multiple installed packs coexist via normal priority and slot rules. If Pack A and Pack B both define effects for raids, the one with higher priority in its policy rule wins.

Packs can declare dependencies on other packs. A 'Halloween Overlay' pack might depend on the 'Base Alerts' pack for sound effects, only adding visual layers on top.

Conflict resolution is predictable: same effect ID = later-installed pack wins. Same policy trigger = both fire, subject to budget limits. Same asset filename = namespaced by pack ID to avoid collisions.

06

Sharing & Marketplace

Packs can be shared directly as .vpepack files — send to a friend, post on Discord, distribute however you want. They're self-contained and require no external dependencies.

A VPE marketplace is planned for post-launch where creators can publish, discover, and download community packs. This enables a creator ecosystem around stream automation.

Pack ratings and usage statistics will be visible in the marketplace. Popular packs (high install count, positive ratings) get featured. Creators can monetize premium packs (pricing TBD).

Get Early Access — Add Intelligence to Your OBS Setup

VPE connects to your existing OBS and adds the layer that plugins can't: moment scoring, intent classification, and context-aware decisions. Free tier available.