mirror of
https://gitlab.com/kelteseth/ScreenPlay.git
synced 2024-09-02 16:49:47 +02:00
2.9 KiB
2.9 KiB
Setup
- Download and install the tools for your platform first.
- Then see the instruction of how to setup QtCreator and compile ScreenPlay
Windows
- Download and install:
- Microsoft Visual Studio Community 2022 Download
- Make sure you have the exact Windows SDK and MSVC version installed we use in
CMakePresets.json
"VCToolsVersion": "14.34.31933"
aka Visual Studio17.4.3
"WindowsSDKVersion" : "10.0.22621.0"
- Make sure you have the exact Windows SDK and MSVC version installed we use in
- 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 cmake -y
- Microsoft Visual Studio Community 2022 Download
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
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
Setup QtCreator and compile ScreenPlay
- Clone ScreenPlay
git clone --recursive https://gitlab.com/kelteseth/ScreenPlay.git ScreenPlay/ScreenPlay
- 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
- This will:
- Download
Qt
andQtCreator
into:- Windows:
C:\aqt
- MacOS and Linux:
~/aqt
- Windows:
- Create a
vcpkg
folder for dependencies - Compile the dependencies
- Download ffmpeg
- Download
- Open QtCreator
- Windows:
C:\aqt\Tools\QtCreator\bin\qtcreator.exe
- Linux:
~/aqt/Tools/QtCreator/bin/qtcreator
- MacOS:
~/aqt/qtcreator
- Windows:
- Select the imported temporary kit like
ScreenPlay 64bit Debug Windows MSVC 2022 Community
- 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: