Mirrored_Repos/obs-websocket
1
0
Fork 0
mirror of https://github.com/Palakis/obs-websocket.git synced 2024-08-30 18:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
03e32c8b5e
obs-websocket/docs
History
tt2468 03e32c8b5e Base: Major protocol refactor 
As discussed in the #development channel in discord
- Switch from using message types to integer op codes
- Consolidate op-specific keys into `d` sub-object
- Shorten low-level payload keys from `messageType` to `op`, add `d`

Other changes:
- The WebSocketCloseCode enum has been refactored. It's best to just
treat it like it's new
- Some performance benefits came along the way. Nothing gamechanging,
but notable
- Various bug fixes discovered while refactoring
2021-08-28 05:02:24 -07:00
..
generated docs(ci): Update generated docs - 945816c [skip ci] 2021-06-13 09:43:46 +00:00
partials Base: Major protocol refactor 2021-08-28 05:02:24 -07:00
.editorconfig Initial commit for attempted rewrite 2021-03-08 03:56:43 -08:00
.gitignore Initial commit for attempted rewrite 2021-03-08 03:56:43 -08:00
.npmrc Initial commit for attempted rewrite 2021-03-08 03:56:43 -08:00
comments.js Initial commit for attempted rewrite 2021-03-08 03:56:43 -08:00
config.json Initial commit for attempted rewrite 2021-03-08 03:56:43 -08:00
docs.js Initial commit for attempted rewrite 2021-03-08 03:56:43 -08:00
package.json docs: Lots of changes 2021-04-26 09:55:50 -07:00
protocol.hbs docs: Update some formatting 2021-04-26 19:04:16 -07:00
README.md Initial commit for attempted rewrite 2021-03-08 03:56:43 -08: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