obs-websocket

mirror of https://github.com/Palakis/obs-websocket.git synced 2024-08-30 18:12:16 +00:00

History

Valter Minute 740a8a8d06 General: Add ScenesCollection object

Adds a ScenesCollection object in the protocol definition,
replacing the current Array<String> return  with
Array<ScenesCollection>, keeping it more coherent with
other requests that return objects in the same format.
This will help automated code generation from comment.json
that otherwise would require ad-hoc handling for that specific
request.

Signed-off-by: Valter Minute <valter.minute@gmail.com>

2021-01-20 10:22:33 +01:00

generated

General: Add ScenesCollection object

2021-01-20 10:22:33 +01:00

partials

Docs: Various docs improvements

2020-07-09 03:27:44 -07:00

.editorconfig

Docs: Initial generation of docs from code comments (#106 )

2017-08-13 17:41:42 +02:00

.gitignore

Docs: Initial generation of docs from code comments (#106 )

2017-08-13 17:41:42 +02:00

.npmrc

Docs: Initial generation of docs from code comments (#106 )

2017-08-13 17:41:42 +02:00

comments.js

docs: improve consistency of comment docs; introduce typedefs category

2018-11-27 17:49:54 -06:00

config.json

docs: fail CI build if documentation is invalid

2017-11-13 23:25:54 -05:00

docs.js

docs: fail CI build if documentation is invalid

2017-11-13 23:25:54 -05:00

package.json

Docs: Initial generation of docs from code comments (#106 )

2017-08-13 17:41:42 +02:00

protocol.hbs

docs: improve consistency of comment docs; introduce typedefs category

2018-11-27 17:49:54 -06:00

README.md

Docs: Initial generation of docs from code comments (#106 )

2017-08-13 17:41:42 +02:00

README.md

Installation

Install node and update npm if necessary.

cd obs-websocket/docs
npm install

Build

# Just extract the comments.
npm run comments

# Just render the markdown.
npm run docs

# Do both comments and markdown.
npm run build