Mirrors/ScreenPlay
Mirrors/ScreenPlay
1
0
Fork 0
mirror of https://gitlab.com/kelteseth/ScreenPlay.git synced 2024-11-06 19:12:30 +01:00
Code Issues Projects Releases Activity
656be6f7a9
ScreenPlay/Docs/DeveloperSetup.md
Elias Steurer 656be6f7a9 Fix spelling
2022-12-16 13:35:10 +01:00

2.7 KiB
Raw Blame History

Setup

  1. Download and install the tools for your platform first.
    1. Windows
    2. Linux
    3. MacOS
  2. Then see the instruction of how to setup QtCreator and compile ScreenPlay

Windows

  1. Download and install:
    1. Microsoft Visual Studio Community 2022 Download
    2. Python 3.11+ and select Add to Path during the installation. Download
    3. 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 cmake -y

Linux

  1. 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

MacOS

  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

Setup QtCreator and compile ScreenPlay

  1. Clone ScreenPlay
git clone --recursive https://gitlab.com/kelteseth/ScreenPlay.git ScreenPlay/ScreenPlay
  1. Start the following script to download all needed dependencies automatically.
cd Tools
# Windows defaults to python
python setup.py
# Linux and macOS uses python3
python3 setup.py
  1. This will:
    1. Download Qt and QtCreator into:
      1. Windows: C:\aqt
      2. MacOS and Linux: ~/aqt
    2. Create a vcpkg folder for dependencies
    3. Compile the dependencies
    4. Download ffmpeg
  2. Open QtCreator
    1. Windows: C:\aqt\Tools\QtCreator\bin\qtcreator.exe
    2. Linux: ~/aqt/Tools/QtCreator/bin/qtcreator
    3. MacOS: ~/aqt/qtcreator
  3. Select the imported temporary kit like ScreenPlay 64bit Debug Windows MSVC 2022 Community
  4. Compile!

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: