Документация StreamKit+

Руководства для стримеров (как пользоваться приложением) и для разработчиков аддонов (API песочницы, манифест, разрешения).

Интеграционные аддоны расширяют StreamKit+ из изолированного worker-процесса. Код аддона выполняется в VM-песочнице и использует глобальные API (network, events, api, …) — импорт SDK внутри worker недоступен.

Для стримеров

Как пользоваться StreamKit+ как настольным приложением — не как писать аддоны.

Раздел Описание
Начало работы Первый запуск, лицензия, из чего состоит приложение
Главное окно Таймер, быстрые действия, заголовок, статус
Последние события Живая лента событий и чипы повтора
Окно чата Общий чат, ответы, внешний вид
Настройки Боковая панель, сохранение, Основные и Интерфейс
Аддоны и каталог Установка платформ, разрешения, обновления
Оверлей Эффекты на экране и в OBS
Виджеты и приложения Виджеты OBS и окна внутри приложения
Таймер доната Файлы обратного отсчёта и автоправила
Звуковые эффекты Звуки оповещения по событиям
Хоткеи Клавиатурный агент и пресеты
Совместная синхронизация Оверлеи и хоткеи на других ПК
Игровые интеграции Действия зрителей внутри игры
Озвучка текста Голоса Piper, ElevenLabs, Windows
LLM Access Профили нейросетей для аддонов
Лицензия и обновления Лицензия, обновления приложения, список изменений
Резервные копии Zip-снимки и восстановление

Для разработчиков аддонов

Раздел Описание
Начало работы Архитектура, установка, структура проекта, @rocketman-streamkit/addon-generator
Жизненный цикл Загрузка, перезапуск аддона и защита от цикла падений
manifest.json Поля манифеста, типы, правила валидации
Публикация и релизы Регистрация в каталоге, структура GitHub-релиза, кэш и синхронизация версии
Настройка TypeScript tsconfig.json, типы, сборка
Разрешения Флаги возможностей и подтверждение пользователем
Схема настроек GenerateConfig() и UI настроек
Локализация Многоязычные строки в коде аддона
Безопасность Ограничения сети, токены, лимиты песочницы
OAuth и секреты Обмен токенов через исходящий HTTP

API песочницы

Раздел Описание
Обзор API Все глобальные объекты
events Шина событий и привязка HTTP-обработчиков
network HTTP-клиент, эндпоинты, WebSocket, SSE, SignalR, Socket.IO
api.config и storage Параметры, конфиг приложения, файловое хранилище
Доступ к файлам Чтение/запись по одобренным пользователем путям (files API)
Озвучка текста (tts) Озвучка через TTS-движок пользователя (разрешение TTS)
LLM Access (llm) Запросы к нейросетям через профили пользователя (разрешение LLM)
Загрузки yt-dlp (ytdlp) Загрузка медиа через встроенный yt-dlp (FILE_ACCESS + NETWORK_REQUEST)
addons (RPC) Запросы и события между аддонами
dashboard Виджет событий, чат, триггеры оверлея
status, notify, ui Строка состояния, онлайн зрителей, уведомления, страницы OAuth
Оповещения (alerts) Координация показа оповещений между аддонами (без разрешения)
Валюта Основная валюта пользователя и конвертация сумм
Определение языка (language) Определение языка текста через fastText (~176 языков; без разрешения)
Утилиты Таймеры, crypto, console, режим разработчика

Категории аддонов

Раздел Описание
Платформенные аддоны platform.streaming, platform.donation
Оверлеи Эффекты, статический web, простое медиа
Виджеты Постоянные web-страницы и OBS Browser Source
Приложения Окна внутри основного приложения
Игровые интеграции Внутриигровые эффекты и входные триггеры

Типизация

Установите объявления песочницы из npm — версия пакета должна совпадать с целевой версией StreamKit+:

npm install --save-dev @rocketman-streamkit/types

См. Настройка TypeScript — tsconfig.json и глобалы (declare global, без импортов в коде аддона).