mirror of
https://gitlab.com/kelteseth/ScreenPlay.git
synced 2024-09-03 00:59:47 +02:00
3.6 KiB
3.6 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 vscode cmake --installargs 'ADD_CMAKE_TO_PATH=System' -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
# 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
Download ScreenPlay and dependencies
git clone --recursive https://gitlab.com/kelteseth/ScreenPlay.git ScreenPlay/ScreenPlay
cd ScreenPlay
Downloading dependencies is 100% automated. Simply run the setup.py
script
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
Now you can either use VSCode or QtCreator:
Option 1: Setup VSCode and compile ScreenPlay
- Open VSCode
- Install these extentions:
- Press:
CTRL
+SHIFT
+P
for every command:CMake: Select Configure Preset
. Select one of the listed presets likeMSVC SP Qt 6.4.2 Debug
CMake: Configure
- Press
F7
to Compile andF5
to run!
Option 2: Setup QtCreator and compile ScreenPlay
- 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.4.2 Debug
- Press
CTRL
+B
to Compile andF5
to run!
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: