Skip to content

Commit

Permalink
update README about node-obs
Browse files Browse the repository at this point in the history
  • Loading branch information
avacreeth committed Oct 26, 2017
1 parent fae1c99 commit 09d5c26
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,22 @@ Electron client for the Streamlabs OBS streaming software.

### Node OBS

Due to OBS containing files named `package.json`, it is not
currently possible to install `node-obs` via NPM. You will
need to install and compile it manually, and then symlink it
in the root of this directory: `./node-obs`.
Node OBS is our C++ Node module that provides a javascript
interface to OBS. For SLOBS to start properly, it needs to
find a built version of node OBS at `./node-obs`. There are
currently a number of different ways to acquire this.

The simplest is to clone the prebuild repo into slobs:

```
git clone [email protected]:twitchalerts/node-obs-prebuild.git node-obs
```

This repo is updated frequently from the `staging` branch on
the node-obs repo. If you need more bleeding edge access, or
need a specific branch, you will have to do the compilation
yourself. Instructions can be found here:

Node OBS can be found here:
https://github.com/twitchalerts/node-obs

### Yarn
Expand Down

0 comments on commit 09d5c26

Please sign in to comment.