Build powerful addons
for StreamCube

Compatibility Matrix

Quick Start

Every StreamCube addon starts with a manifest. Here's the fastest path to a working addon.

Copy{
  "id": "com.example.my-streams",
  "version": "1.0.0",
  "name": "My Stream Addon",
  "description": "Provides streams from my source",
  "types": ["movie", "series"],
  "resources": ["stream"],
  "catalogs": [],
  "streamcube": {
    "manifestVersion": 1,
    "addonType": "stream",
    "capabilities": ["stream"],
    "minAppVersion": "2.0.0"
  }
}

Copyconst express = require('express');
const app = express();

app.get('/manifest.json', (req, res) => {
  res.json(manifest);
});

app.get('/stream/:type/:id.json', (req, res) => {
  const streams = getStreams(req.params.type, req.params.id);
  res.json({ streams });
});

app.listen(3000);

Copyfrom flask import Flask, jsonify

app = Flask(__name__)

@app.route('/manifest.json')
def manifest():
    return jsonify(MANIFEST)

@app.route('/stream/<type>/<id>.json')
def stream(type, id):
    streams = get_streams(type, id)
    return jsonify({'streams': streams})

app.run(port=3000)

Manifest Format

The manifest is a JSON document describing your addon's identity, capabilities, and configuration. It extends the Stremio manifest with the streamcube extension.

Full Example

Copy{
  "id": "com.example.my-addon",
  "version": "1.0.0",
  "name": "My Addon",
  "description": "A short description",
  "logo": "https://example.com/logo.png",
  "types": ["movie", "series"],
  "resources": ["catalog", "meta", "stream", "subtitles"],
  "catalogs": [
    {
      "type": "movie", "id": "my-movies", "name": "My Movies",
      "extra": [
        { "name": "search", "isRequired": false },
        { "name": "genre", "isRequired": false, "options": ["Action", "Comedy", "Drama"] },
        { "name": "skip", "isRequired": false }
      ]
    }
  ],
  "streamcube": {
    "manifestVersion": 1,
    "addonType": "stream",
    "capabilities": ["stream"],
    "minAppVersion": "2.0.0",
    "permissions": ["stream"],
    "configSchema": [
      { "key": "api_key", "type": "password", "label": "API Key", "required": true }
    ]
  }
}

Standard Fields (Stremio-compatible)

StreamCube Extension

Capabilities

capabilities are optional hints. Use them when you want to describe finer-grained behavior for tooling, validators, or future compatibility checks. The runtime decisions in StreamCube are based primarily on Stremio resources plus the StreamCube addonType and type-specific config.

Config Schema

Define user-configurable fields and StreamCube generates the settings UI. Config values are encrypted at rest (AES-256-GCM). Password fields are masked in API responses.

Copy{
  "configSchema": [
    {
      "key": "api_key",
      "type": "password",
      "label": "API Key",
      "description": "Get your key from the provider dashboard",
      "required": true
    },
    {
      "key": "quality",
      "type": "select",
      "label": "Preferred Quality",
      "options": [
        { "value": "4k", "label": "4K Ultra HD" },
        { "value": "1080p", "label": "Full HD" },
        { "value": "auto", "label": "Automatic" }
      ],
      "default": "auto"
    }
  ]
}

Validation rules: min (min value/length), max (max value/length), pattern (regex for text fields).

Addon Types

StreamCube supports 11 addon types organized into three execution models.

Lifecycle

Installation: User provides URL or .stcb file → manifest parsed → permissions approved → config dialog shown → addon registered in DB → WASM compiled and cached (if applicable).

Runtime: HTTP addons called on demand. WASM loaded into Wazero runtime. JSON configs applied directly.

Uninstallation: Config values deleted. WASM unloaded. IPTV/EPG data cleaned up. Theme/filter/overlay reverts to defaults.

Architecture