Lumia Stream Plugin SDK

Official TypeScript/JavaScript SDK for developing plugins for Lumia Stream.

Installation

npm install @lumiastream/plugin-sdk

Usage

import {
	Plugin,
	type PluginManifest,
	type PluginContext,
} from "@lumiastream/plugin-sdk";

export default class MyPlugin extends Plugin {
	constructor(manifest: PluginManifest, context: PluginContext) {
		super(manifest, context);
	}

	async onload(): Promise<void> {
		this.lumia.addLog("Plugin loaded successfully!");
	}

	async onunload(): Promise<void> {
		this.lumia.addLog("Plugin unloaded");
	}
}

Plugin Manifest

Every plugin requires a manifest.json file that describes your plugin, its metadata, and configuration:

{
	"id": "my-awesome-plugin",
	"name": "My Awesome Plugin",
	"version": "1.0.0",
	"author": "Your Name",
	"description": "A brief description of what your plugin does",
	"lumiaVersion": "^9.0.0",
	"category": "utilities",
	"config": {
		"settings": [
			{
				"key": "apiKey",
				"label": "API Key",
				"type": "text",
				"required": true
			}
		]
	}
}

Lifecycle Hooks

• onload() – invoked when the plugin is enabled inside Lumia Stream.
• onunload() – called when your plugin is disabled or unloaded.
• onupdate(oldVersion, newVersion) – triggered after version upgrades.
• onsettingsupdate(settings, previousSettings) – called whenever settings change.
• actions(config) – handle custom actions invoked from Lumia automations.

Lumia API Highlights

Interact with Lumia Stream using the strongly typed ILumiaAPI helper on the plugin context:

await this.lumia.triggerAlert({
	alert: "follow",
	extraSettings: { username: "StreamerFan" },
});
await this.lumia.playAudio({ path: "alert.mp3", volume: 0.7 });
this.lumia.setVariable("follower_count", 1337);

See the API reference for the full surface area.

Scripts

• npm run build – compile the SDK to the dist folder.
• npm run lint – type-check the source without emitting output.

CLI Helpers

The CLI is distributed separately via @lumiastream/plugin-cli. Use it with npx (requires npm 7+).

• npx @lumiastream/plugin-cli create my-plugin scaffold a feature-rich sample plugin showing logging, variables, and alerts
• npx @lumiastream/plugin-cli validate ./path/to/plugin check manifest.json, entry files, and config for common mistakes
• npx @lumiastream/plugin-cli build ./path/to/plugin --out ./plugin.lumiaplugin bundle the directory into a distributable archive

Documentation

• Getting Started
• API Reference
• Manifest Guide

Examples

• examples/basic-logger – Smallest possible plugin: logs lifecycle events and handles a single action.
• examples/toast-notifier – Demonstrates settings + actions to trigger Lumia toast notifications.
• examples/variable-counter – Shows how to persist state via Lumia variables and support multiple actions.
• examples/rumble – Plain JavaScript Rumble livestream plugin that polls the API, updates variables, and fires alerts.

License

The SDK is released under the MIT License. See LICENSE for details.