Skip to content


Using the OBS sample bundle

The OBS example bundle in samples/obs-scenelist demonstrates the ability to control an OBS instance by listing all available scenes. Here is a guide to how to get it working.


You will need a working nodecg-io installation. If you have non yet take a look at installation guide. You may need to install this bundle, so take a look at the “Try an included sample”-Guide. It will also tell you how to log in and how to use the GUI.

You also need:

  • OBS with obs-websocket installed


OBS is available here and obs-websocket with install instructions is available here.

Configure the OBS sample bundle

  1. In NodeCG, create a new obs service instance.

  2. Enter the configuration for obs:

        "host": "localhost",
        "port": 4444,
        "password": "mypassword12345678"


    If you don't want to use a password, you can just remove the password property from the config.

    After entering it, click save.

  3. Set the sample's (obs-scenelist) dependency to be the newly created service instance (of type obs).

  4. Check the NodeCG logs:

    You should see an error or a success message and the names of all you scenes that you have set in OBS.