# obs-studio-node

**Repository Path**: james133/obs-studio-node

## Basic Information

- **Project Name**: obs-studio-node
- **Description**: libOBS (OBS Studio) for Node.Js, Electron and similar tools
- **Primary Language**: Unknown
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2020-06-03
- **Last Updated**: 2021-08-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OBS Studio for Node.Js
`obs-studio-node` is a Node.Js compatible wrapper around [OBS Studio](https://github.com/stream-labs/obs-studio). It works by wrapping libOBS inside a secondary process that is talked to using [lib-streamlabs-ipc](https://github.com/stream-labs/lib-streamlabs-ipc), which results in better stability and performance.

The goal of the project is to provide a fully featured working Node.Js and electron wrapper around libOBS (OBS Studio). 

## Why CMake?
CMake offers better compatibility with existing projects than node-gyp and comparable solutions. It's also capable of generating solution files for multiple different IDEs and compilers, which makes it ideal for a native module. It is also the build system of obs-studio, which we depend on for any functionality.

# Building The Project
The project is for the most part automated, so there is very little to actually do.

## Prerequisites
You will need to have the following installed:

* [Node.JS](https://nodejs.org/en/) (LTS or latest, LTS recommended for now)
* Yarn (Run `npm install -g yarn` inside a shell with node.js access)
* [CMake](https://cmake.org/), Version 3.1 or higher

### Windows
Building on windows requires additional software:

* [Visual Studio 2017 or 2015](https://visualstudio.microsoft.com/) with the latest update installed.
* [Windows SDK](https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk) (latest version, included in Visual Studio 2017)

## First Steps
1. Open a git enabled shell.
2. Clone the project: `git clone https://github.com/stream-labs/obs-studio-node.git`
3. Enter the cloned project directory: `cd obs-studio-node`
4. Initialize all submodules recursively: `git submodule update --init --recursive --force`
5. Open a node.js enabled shell (if not already in one) inside the project directory.
6. Initialize any node dependencies of the project: `yarn install`

## Configuration
1. Open CMake-GUI.
2. Set "Where is the source code:" to the cloned project directory.
3. Set "Where to build the binaries:" to the build directory inside the project directory (you might have to create it first).
4. Click "Configure".
5. Specify the generator that you want to use. "... Win64" are 64-bit capable generators.
6. Optional: If you have a 64-bit system, type in `host=x64` into the "Optional toolset to use" box.
7. Leave it at default native compilers.
8. Click Finish.
9. Click Generate once the button is no longer grey.

## Building
1. Open the project (if you still have CMake-GUI open, just click Open Project)
2. Build the "ALL_BUILD" project.

## Installing and Distribution
1. Open CMake-GUI
2. Change the "Where to build the binaries:" directory to the configured build directory. CMake should automatically update.
3. Modify the CMAKE_INSTALL_PREFIX variable to the directory of your liking. Visual Studio will need to have _write & execute_ access to that location.
4. Click Configure.
5. Click Generate.
6. Open the project and build the INSTALL project. This will create the proper node module structure in the directory you specified to CMAKE_INSTALL_PREFIX

# Building The Documentation
First make sure that you've configured and built obs-studio-node. Once you have done that, do the following:

1. Open a node.js enabled shell inside the project directory.
2. Run `yarn build:docs` and wait for the command to be done.
3. Documentation will be inside the `/docs/` directory as a static HTML file.

# Using a custom OBS Studio
A lot of the build system is automated, which makes integrating custom dependencies difficult. However there are some steps that can be taken to at least debug using custom built versions of OBS Studio.

## Configuration Requirements
The following setting must be changed before clicking Generate for the first time in obs-studio:

* ENABLE_SCRIPTING must be Off (false)
* ENABLE_UI must be Off (false)
* QTDIR must be empty

## Install/Distribution requirements
To go from just a compiling obs-studio to using the actual custom obs-studio inside obs-studio-node, you must reconfigure obs-studio to install things into `<obs-studio-node build dir>/libobs-src`. You can do this by changing CMAKE_INSTALL_PREFIX in the obs-studio project. Any changes done to obs-studio must now be installed by building the INSTALL project in obs-studio, and will then be sent along to whatever is using obs-studio-node once you build the INSTALL project in obs-studio-node.

# Contributing To The Project
See the [Guidelines for contributing](https://github.com/stream-labs/obs-studio-node/blob/staging/CONTRIBUTING.md).