Bring in the power of the Node.js ecosystem to Supercharge your OBS Studio with JavaScript automation.
Run scripts, automate scene switching, control filters dynamically, and build custom workflows—all using JavaScript and npm packages.
β οΈ Early Development — This plugin is under active development. Expect breaking changes between versions. Not recommended for production use yet.
- π¬ Script Editor — Built-in code editor with line numbers, zoom, and run-on-demand execution
- π» REPL Console — Interactive JavaScript console for live experimentation
- π§ Full OBS API Access — Control sources, scenes, filters, transitions, audio, and more
- β‘ Event-Driven — React to OBS events (scene changes, stream start/stop, etc.)
- οΏ½ WebSocket API (No Network) — Direct access to obs-websocket protocol internally—no TCP connection needed
- π‘ Vendor Events — Register custom vendor requests and emit events for external integrations
- π¦ Node.js Powered — JavaScript runtime with basic Node.js APIs (full support planned)
// Switch to a scene
obs.frontend.setCurrentScene("Gaming")
// Toggle a source's visibility
obs.sceneItems.setVisible("Main Scene", "Webcam", false)
// Adjust filter settings on the fly
obs.filters.setSettings("Camera", "Color Correction", {
brightness: 0.1,
saturation: -0.5
})
// React to events
obs.events.on("StreamStarted", () => {
console.log("We're live! π")
})
// Direct WebSocket API access (no network!)
const list = obs.websocket.call('GetSceneItemList', {
sceneName: "My Scene"
});
// Register vendor request handler
obs.websocket.on("myVendor", "doSomething", (data) => {
console.log("Received:", data)
return { success: true }
})
// Emit vendor event to connected clients
obs.websocket.emit("myVendor", "statusUpdate", { status: "ready" })- API Reference — Complete API documentation with examples
- TypeScript Definitions — Full type definitions for IDE support
- OBS Studio 31.0 or later
- Windows 10/11 (macOS and Linux coming soon)
π¦ Coming soon! Pre-built releases will be available once CI is ready. For now, please build from source.
π¨ Build instructions coming soon! We're working on proper documentation.
| Scenario | What You Can Do |
|---|---|
| Stream Automation | Auto-switch scenes based on game state or viewer commands |
| Dynamic Overlays | Update text sources, trigger animations on events |
| Filter Control | Adjust color grading, zoom effects in response to actions |
| Chat Integration | Build custom chat bots that control OBS |
| Timed Events | Schedule scene changes, countdowns, breaks |
| Multi-Stream | Coordinate multiple sources and outputs programmatically |
Planned features for future releases:
| Priority | Feature | Description |
|---|---|---|
| π₯ High | macOS & Linux Support | Cross-platform builds (currently Windows-only) |
| π₯ High | Syntax Highlighting & IntelliSense | Code editor with syntax colors and autocomplete |
| π₯ High | Hot Reload | Auto-reload scripts on file changes |
| π₯ High | Extension/Plugin System | Load and manage third-party JavaScript extensions |
| π₯ High | Multi-Script Parallel Runtime | Run multiple scripts concurrently in isolated contexts |
| π§ Medium | Debugging Tools | Breakpoints, step-through debugging, variable inspection |
| π§ Medium | Script Marketplace | Community script sharing and discovery |
| π§ Medium | Source Creation APIs | Create custom OBS sources with JavaScript or WebAssembly |
| π§ Medium | WebAssembly Support | Run WASM modules for high-performance operations |
| π§ Medium | JSX UI Components | Figma-like API for building Qt UIs with JSX syntax |
| π§ Medium | Canvas Drawing API | HTML Canvas-like API to draw directly on OBS sources |
| π§ Medium | FFI Module | Access non-bound libobs APIs directly via foreign function interface |
| βοΈ Low | Runtime Version Selector | Choose between LTS Node.js versions |
Have a feature request? Open an issue!
This plugin is in active early development. You should expect:
- π Breaking API changes between versions
- π Bugs and incomplete features
- π Documentation gaps
- βοΈ Platform limitations (Windows-only for now)
We welcome feedback, bug reports, and contributions! Please open an issue if you encounter problems.
Contributions are welcome! Please:
- Fork the repository
- Create a feature branch
- Submit a pull request
For bug reports and feature requests, please use GitHub Issues.
This project is licensed under the GNU General Public License v2.0 — see LICENSE for details.
Built with β€οΈ for the OBS community.