Installation
OBS Streamdeck CTL is written in Python, and is available via pip.
Requirements
Installing
Open a command prompt and type the following:
pip install obs-streamdeck-controls
Linux and Mac users may want to add the --user flag to install the
package and its requirements to your user directories instead of the system
directories.
Now check the Post Install instructions
Installing From Source
Obtaining Source code
Download the required release from the releases page or clone the git repository to obtain the main branch:
git clone https://github.com/djnrrd/obs_streamdeck_controls.git
Pre Installation
Register a new application on dev.twitch.com. Then
edit the file src/obs_sd_controls/conf.py and update the CLIENT_ID variable
with your own Client ID.
Installing
Change directory into the downloaded folder and install locally via pip. It
is recommended that you use the --user flag to install in your user
directory.:
cd obs_streamdeck_controls
pip install --user --use-feature=in-tree-build .
Post Install
Windows
You will likely see a WARNING message, similar to the following
WARNING: The script obs-streamdeck-ctl.exe is installed in
'C:\Users\%USERNAME%\AppData\Local\Packages\PythonSoftwareFoundation.Python.3
.9_qbz5n2kfra8p0\LocalCache\local-packages\Python39\Scripts' which is not on PATH
Add this to your path with the following command:
setx PATH "C:\Users\%USERNAME%\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.9_qbz5n2kfra8p0\LocalCache\local-packages\Python39\Scripts;%PATH%"
Make sure that you copy and paste the path from your error message, and ensure that ;%PATH% is added to the end
Restart your computer to make sure that the %PATH% is loaded correctly
Linux
If you installed with the --user flags, the command line program
obs-streamdeck-ctl will be installed to your $HOME/.local/bin folder.
Add:
PATH=$PATH:$HOME/.local/bin
to your .bashrc file, if you haven’t already.