obs-websocket-js

obs-websocket-js

OBSWebSocket.JS allows Javascript-based connections to obs-websocket.

Download | Documentation | Examples

In Development

In the middle of a rewrite.
TODOs include...

• Travis auto deployments of pre-release and release versions, generation of documentation to gh-pages.
• Clean up method/event binding.
• Organize API versioning more efficiently to better allow backwards compatibility.
• Generate documentation based on API versioning.
• Unit testing / Socket mocking.

If you can help with any of this please do.

Contributing

• Install node.js.
• Clone the repo.
• Go nuts.
• Generate the concatenated Javascript file and API documentation by running the following...

npm install
npm install --only=dev
npm run build

• Run grunt watch using the following. Note that this will only update the distribution js file, not the markdown.

npm run watch

Formatting Guidelines

• 2 spaces rather than tabs.