Developer Setup

Install latest git + git-lfs
Install latest python 3
Clone ScreenPlay

git clone --recursive https://gitlab.com/kelteseth/ScreenPlay.git ScreenPlay/ScreenPlay

Download the latest Qt 6.4.x for you platform. Earlier versions are not supported!
Start the following script to download all needed dependencies automatically. This will create a ScreenPlay-vcpkg folder in the same directory as your ScreenPlay source folder.

cd Tools
# Windows defaults to python
python setup.py
# Linux and macOS uses python3
python3 setup.py

Open QtCreator and open the settings Tools -> Options
Clone an existing kit like Qt 6.4.1 MSVC2019 64bit and add ScreenPlay to the new kit name
Edit CMake variables amd add CMAKE_TOOLCHAIN_FILE and VCPKG_TARGET_TRIPLET
- Kits -> <Your_Kit> -> CMake Configuration

Append this:

-DCMAKE_TOOLCHAIN_FILE:STRING=%{CurrentProject:Path}/../ScreenPlay-vcpkg/scripts/buildsystems/vcpkg.cmake
# Only _one_ of these lines that match your OS:
-DVCPKG_TARGET_TRIPLET:STRING=x64-windows
-DVCPKG_TARGET_TRIPLET:STRING=x64-linux
-DVCPKG_TARGET_TRIPLET:STRING=x64-osx
-DVCPKG_TARGET_TRIPLET:STRING=arm64-osx

Save and close the settings.
Open Project via File -> Open File or Project and select your CMakeLists.txt. Then select our created kit, press Configure Project

8. Press build (the big green play button on the bottom left). This will compile and start ScreenPlay and copy all necessary files into your Qt installation.

Windows

It is recommended (but not necessary) to use an easy git UI like gitextensions.
Download and install the most recent MSVC 2019 Community
- Select "Desktop development with C++"
Download and install Qt binary installer from qt.io
- Install the Maintaince tool
- Select the following features to install:
  - Qt 6.4.1
    - MSVC 2019 64-bit
    - ALL Additional Libraries
    - Qt Quick 3d
    - Qt 5 Compatibility Module
    - Qt Shader Tools
  - Developer and Designer Tools
    - Cmake
    - Ninja

Linux dependencies

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

Linux via qt.io account

Download and install Qt binary installer from qt.io
- Install the Maintaince tool
- Select the following features to install:
  - Qt 6.4.1
    - GCC
    - ALL Additional Libraries
    - Qt Quick 3d
    - Qt 5 Compatibility Module
    - Qt Shader Tools
  - Developer and Designer Tools
    - OpenSSL 1.1.1.c Toolkit
      - OpenSSL 64-bit binaries
    - Cmake
    - Ninja

Linux via aqt

Alternativly download via aqt

python3 -m pip install aqtinstall
python3 -m aqt install-qt -O ~/aqt linux desktop 6.4.1 gcc_64 -m all
python3 -m aqt install-tool -O ~/aqt linux desktop tools_qtcreator

Open VSCode and install the CMake Tools
1. ctrl + p: CMake: Select Configure Preset
2. Select ScreenPlay 64bit Debug Linux
3. ctrl + p: CMake: Configure
4. ctrl + p: CMake: Build

MacOSX

Install XCode 13+ , 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 ninja
Download and install Qt binary installer from qt.io
- Install the Maintaince tool
- Select the following features to install:
  - Qt 6.4.1
    - Qt WebEngine
    - ALL Additional Libraries
    - Qt Quick 3d
    - Qt 5 Compatibility Module
    - Qt Shader Tools
  - Developer and Designer Tools
    - OpenSSL 1.1.1.c Toolkit
      - OpenSSL 64-bit binaries
    - Cmake
    - Ninja
Change your default kit:
- QtCreator -> Options -> Kits -> Select your default kit (Desktop Qt 6.4.1) -> Change c and c++ Compiler to Apple Clang (x86_64)

Developer docs

We use qdoc to generate documentation. Qt6 is the minimum version qdoc, because of vastly improved c++ parsing support.

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

Some useful links:

5.3 KiB Raw Blame History