https://github.com/edqe14/node-sc
Node implementation of StreamCompanion using its built-in WebSocket endpoints.
https://github.com/edqe14/node-sc
streamcompanion websocket-endpoints
Last synced: 11 months ago
JSON representation
Node implementation of StreamCompanion using its built-in WebSocket endpoints.
- Host: GitHub
- URL: https://github.com/edqe14/node-sc
- Owner: Edqe14
- License: mit
- Created: 2020-12-21T13:39:41.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-01-17T15:24:13.000Z (over 5 years ago)
- Last Synced: 2025-06-25T04:04:59.910Z (11 months ago)
- Topics: streamcompanion, websocket-endpoints
- Language: JavaScript
- Homepage: https://node-sc.edqe.me
- Size: 1.49 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Node implementation of StreamCompanion using its built-in WebSocket endpoints.
## Table of contents
- [Quick Start](#quick-start)
- [Requirements](#requirements)
- [Documentation](#documentation)
- [License](#license)
## Quick Start
Install from `npm`
```text
npm i --save streamcompanion
```
Usage
```js
const StreamCompanion = require('streamcompanion');
const options = {
host: 'localhost',
port: 20727,
proto: 'http',
watchTokens: [],
listeners: {
tokens: true,
mapData: true,
liveData: false
}
};
const SC = new StreamCompanion(options);
// Use SC
```
## Requirements
1. Can run [StreamCompanion](https://github.com/Piotrekol/StreamCompanion)
2. Node **12+**
### Important
If you can't connect to Stream Companion, go to `Settings/Web Overlay` and click `Enable remote access`
## Documentation
[Click Here](https://node-sc.now.sh/) to open the documentation
## License
**This project is using MIT license © Edqe14**
[Click here](https://github.com/Edqe14/node-sc/blob/main/LICENSE) to read LICENSE.