Alvazz / streamdeck-obs-plugin2

Stream Deck - OBS Studio plugin 2.0

Stream Deck - OBS Studio Plugin 2.0

This is the source code of the Stream Deck OBS Studio plugin for Windows and macOS.

Building

Windows

1. Install any necessary prerequisites:
   • Git for Windows
   • CMake (minimum 3.8, recommended 3.11+)
   • Visual Studio 2019 (Community or higher)
2. Clone the project including all submodules git clone --recurse-submodules <url> <dir>
3. Configure the project with CMake, either using cmake-gui or cmake.
   • cmake:
     1. Navigate to the cloned directory: cd /D <dir>
     2. Configure the project with cmake: cmake -H. -Bbuild -G"Visual Studio 16 2019"
     3. Build the project with cmake: cmake --build "build" --config RelWithDebInfo
     4. If you change any files, all you have to do is re-run step 3 in the correct directory.
   • cmake-gui:
     1. Change the source directory to the cloned project.
     2. Change the build directory to any directory you want.
     3. Click Configure and set things up for Visual Studio.
     4. Click Generate and wait.
     5. Click Open Project which opens up Visual Studio with the current project.
     6. Build the project with Visual Studio.
     7. If you change any files, just rebuild with Visual Studio.

Linux

1. Install any necessary prerequisites:
   • Debian-based:

     apt-get install \
      build-essential checkinstall pkg-config \
      git cmake ninja-build \
      qt5base5-dev libqt5svg5-dev libqt5x11extras5-dev
     

   • openSUSE:

     zypper in \
      build-essential checkinstall pkg-config \
      git cmake ninja-build gcc gcc-c++ \
      libqt5-qtbase-devel libqt5-qtx11extras-devel
     

   • Red Hat / Fedora-based:

     apt-get install \
      gcc gcc-c++ \
      git cmake ninja-build \
      qt5-qtbase-devel qt5-qtx11extras-devel qt5-qtsvg-devel
     

2. Clone the project including all submodules git clone --recurse-submodules <url> <dir>
3. Configure the project with CMake, either using cmake-gui or cmake.
   • cmake:
     1. Navigate to the cloned directory: cd <dir>
     2. Configure the project with cmake: cmake -H. -Bbuild -G"Ninja"
     3. Build the project with cmake: cmake --build "build" --config RelWithDebInfo
     4. If you change any files, all you have to do is re-run step 3 in the correct directory.
   • cmake-gui:
     1. Change the source directory to the cloned project.
     2. Change the build directory to any directory you want.
     3. Click Configure and set things up for the compiler and IDE of choice.
     4. Click Generate and wait.
     5. Click Open Project which opens up the IDE for further editing.

macOS

1. Install any necessary prerequisites:
   • Xcode 12
   • CMake
   • Packages to build the installer
2. Clone the project including all submodules git clone --recurse-submodules <url> <dir>
3. Configure the project with CMake, either using cmake-gui or cmake.
   • cmake:
     1. Navigate to the cloned directory: cd <dir>
     2. Configure the project with cmake: cmake -H. -Bbuild -DCMAKE_OSX_DEPLOYMENT_TARGET=10.15
     3. Build the project with cmake: cmake --build "build" --config RelWithDebInfo
     4. If you change any files, all you have to do is re-run step 3 in the correct directory.
   • cmake-gui:
     1. Change the source directory to the cloned project.
     2. Change the build directory to any directory you want.
     3. Click Configure and set things up for the compiler and IDE of choice (Xcode most likely).
     4. Change the entry CMAKE_OSX_DEPLOYMENT_TARGET to 10.15.
     5. Click Generate and wait.
     6. Click Open Project which opens up the IDE for further editing.