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.
- Download and install the tools for your platform first:
- Then see the instruction on how to compile
Windows
- Download and install:
- Microsoft Visual Studio Community 2022 Download
- Make sure you have the component
Desktop development with C++
installed
- Make sure you have the component
- Python 3.11+ and select
Add to Path
during the installation. Download - Optional if you do not have tools like
git
orcmake
installed, we recommendChocolatey
:- Chocolatey via Powershell (Administrator) Download
- Run
choco.exe install git vscode cmake --installargs 'ADD_CMAKE_TO_PATH=System' -y
Linux
Install dependencies for Debian/Ubuntu:
sudo apt install build-essential git gpg ffmpeg mesa-common-dev libxkbcommon-* libfontconfig curl zip unzip tar cmake pkg-config apt-transport-https ca-certificates gnupg software-properties-common wget software-properties-common python3 python3-pip libgl1-mesa-dev lld ninja-build qml-module-qt-websockets qtwebengine5-* -y
Only needed if we want x11 support
sudo apt-get install libx11-dev xserver-xorg-dev xorg-dev
MacOS
- Install XCode 14+ , open and restart your device.
- 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 https://gitlab.com/kelteseth/ScreenPlay.git ScreenPlay/ScreenPlay
Downloading dependencies is 100% automated. Simply run the setup.py
script from the Tools
folder:
cd Tools
# Windows defaults to python, linux and macOS uses python3!
python -m pip install -r requirements.txt
# This scrit will:
# 1. Downloads `Qt` and `QtCreator`
# 2. Create a `vcpkg` folder for dependencies
# 3. Compiles the dependencies
# 4. Downloads ffmpeg
python setup.py
Compile
Now you can either use VSCode or QtCreator:
Option 1 VSCode
- Open VSCode
- Install the recommended extentions:
- Press:
CTRL
+SHIFT
+P
for every command:CMake: Select Configure Preset
. Select one of the listed presets likeMSVC SP Qt 6.5.0 Debug
- Press
F7
to Compile andF5
to run!
Option 2 QtCreator
- Open QtCreator at:
- Windows:
..\aqt\Tools\QtCreator\bin\qtcreator.exe
- Linux:
../aqt/Tools/QtCreator/bin/qtcreator
- MacOS:
../aqt/Qt Creator
- Windows:
- Select the imported temporary kit like
MSVC SP Qt 6.5.0 Debug
- 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:
March 30, 2023 15:43:09