Start using OBS with Touch Portal

The Touch Portal OBS Guides

This guide will be the first in teaching you how to use OBS (Open Broadcaster Studio) with Touch Portal. This first guide is about how to connect to OBS using the Palakis websocket plugin.

Step 1: Installing the OBS Websocket

The first thing we need to do is to install the OBS Websocket plugin in OBS. Touch Portal requires the plugin to be able to control OBS from Touch Portal. Ensure you have closed both OBS and Touch Portal to make the installation process go without issues.

Touch Portal currently works only with version 4.9.1 of the Palakis OBS Websocket plugin. At the moment of writing the later versions were still in beta and were not production ready yet. The 5.x versions are not compatible.

Download version 4.9.1 of the Palakis Websocket and install it. Scroll down on that page to see the list of installers for Windows, Mac or Linux. Follow the instructions to install the plugin.

Step 2: Setting up the Websocket

We will now start up OBS. When OBS has started open the Tools menu and click on the WebSockets Server Settings option on the bottom.

When installed, the plugin should be available in the Tools menu in OBS. If it is not, use the zip file installer from the Palakis website to manually install the plugin in the correct location.

In the settings for the websocket plugin, ensure the same settings as the image below. For now we turn off the authentication. When you have walked through this guide and checked everything connected just fine, you can turn on the authentication.

Step 3: Start Touch Portal

Now we have set up the plugin lets start Touch Portal. In Touch Portal open the settings screen.

In the settings screen open the OBS section. And ensure you have used the same settings as in the image.

Save and close the settings and continue with step 4.

Step 4: Ensuring you are connected

In Touch Portal, open a button and add the following action to it:

The dropdown listbox of that action should now contain your scenes from OBS.

If for some reason the list does not show your scenes. Fully restart Touch Portal by right-clicking on the sytem tray icon of Touch Portal and choose "Exit". Then restart Touch Portal. It should now connect. If it still does not after this step, check the Touch Portal logs to see why it fails to connect or go to our discord community to ask for assistence.


Remote Control OBS

Please note that the free base version of Touch Portal allows connecting to OBS on the same computer only. To remote control OBS you need to have the Pro upgrade.

Touch Portal allows you to set up the connection to OBS with ip addresses when you have the Pro upgrade. This means that if you want to control OBS on a different computer you only need to change the ip from 'localhost' to the ip of the computer running OBS. Of course you need to install the Palakis websocket plugin as described in the previous steps on that remote computer to be able to connect to that instance of OBS.

When you want to remote control OBS on a remote computer the ip you specify needs to be reachable from the computer on which Touch Portal is running. This means you need to accept the connection in your Firewall otherwise it will not work.

End Result

You have now connected OBS with Touch Portal and can begin with adding OBS actions to your buttons and events. Be sure to also check our other OBS guides


Back to Guide Overview