Skip to content

Setup build environment

We use a modern set of tools like CMake and Qt6 to create ScreenPlay. The setup is mostly automated. To get an overview of ScreenPlays architecture, see Project Architecture

  1. Download and install the tools for your platform first:
    1. Setp for 🪟 Windows
    2. Setp for 🐧 Linux
    3. Setp for 🍏 MacOS
  2. How to ⬇️ clone ScreenPlay and dependencies
  3. How to ⚙️ compile ScreenPlay


  1. Download and install:
  2. Microsoft Visual Studio Community 2022 Download
    1. Make sure you have the component Desktop development with C++ installed
  3. Python 3.11+ and select Add to Path during the installation. Download
  4. Optional if you do not have tools like git or cmake installed, we recommend Chocolatey:
    1. Chocolatey via Powershell (Administrator) Download
    2. Run choco.exe install git vscode cmake --installargs 'ADD_CMAKE_TO_PATH=System' -y


Install dependencies for Debian/Ubuntu:

sudo apt install cmake libwayland-dev wayland-protocols curl wget zip unzip tar git pkg-config libxcb-* libfontconfig-dev apt-transport-https ca-certificates gnupg  software-properties-common python3 python3-pip build-essential libgl1-mesa-dev mesa-common-dev lld ninja-build libxkbcommon-* libx11-dev xserver-xorg-dev xorg-dev -y

Git setup

Enable git credential save, so you do not have to enter your password every time.

git config --global credential.helper cache


  1. Install XCode 14+ , open and restart your device.
  2. Install brew that is needed by some third party vcpkg packages. Do not forget to add brew to your path as outlined at the on of the installation!
    • brew install pkg-config git llvm cmake

Clone ScreenPlay

git clone ScreenPlay/ScreenPlay

Downloading dependencies

Downloading dependencies is 100% automated. Simply run the script from the Tools folder:

🐧 Linux

# For Ubuntu 22.04 and newer we need to create an virutal env
sudo apt install python3.11-venv -y
# Run this command in the ScreenPlay source root folder:
python3 -m venv env
source env/bin/activate
cd Tools
python3 -m pip install -r requirements.txt

🪟 Windows and 🍏 macOS

cd Tools
python3 -m pip install -r requirements.txt

Install external dependencies for Wayland support before compiling

cd ThirdParty
git clone
cd extra-cmake-modules
cmake configure .
sudo make install
# back to ScreenPlay/ThirdParty
cd ..
git clone
cd layer-shell-qt
cmake configure . -DCMAKE_PREFIX_PATH="./../../aqt/6.6.0/gcc_64"
sudo make install


Now you can either use VSCode or QtCreator:

Option 1 VSCode

  1. Open VSCode
  2. Install the recommended extentions:
    1. C/C++ for Visual Studio Code
    2. CMake Tools
  3. Press: CTRL + SHIFT + P for every command:
    1. CMake: Select Configure Preset. Select one of the listed presets like MSVC SP Qt 6.6.0 Debug
  4. Press F7 to Compile and F5 to run!

Option 2 QtCreator

  1. Open QtCreator at:
    1. Windows: ..\aqt\Tools\QtCreator\bin\qtcreator.exe
    2. Linux: ../aqt/Tools/QtCreator/bin/qtcreator
    3. MacOS: ../aqt/Qt Creator
  2. Select the imported temporary kit like MSVC SP Qt 6.6.0 Debug
  3. Press CTRL + R to compile and run!

Developer docs

We use qdoc to generate documentation.

qdoc.exe configWindows.qdocconf

If you have installed Qt in a different directory, change the path to your Qt location.

Some useful links:

Last update: November 9, 2023 11:12:57