1
0
mirror of https://gitlab.com/kelteseth/ScreenPlay.git synced 2024-09-03 09:09:48 +02:00

Update Docs/DeveloperSetup.md

This commit is contained in:
Elias Steurer 2022-12-15 12:57:50 +00:00
parent e2beadb671
commit f299d8cefd

View File

@ -1,31 +1,29 @@
# Developer Setup # Developer Setup
1. Install latest [git + git-lfs](https://git-scm.com/) 1. Install latest [git + git-lfs](https://git-scm.com/)
2. Install [python 3](https://www.python.org/) 2. Install latest [python 3](https://www.python.org/)
3. Clone ScreenPlay 3. Clone ScreenPlay
``` bash ``` bash
git clone --recursive https://gitlab.com/kelteseth/ScreenPlay.git ScreenPlay git clone --recursive https://gitlab.com/kelteseth/ScreenPlay.git ScreenPlay/ScreenPlay
``` ```
4. Download the latest __Qt 6.3.x__ for you platform. Earlier versions are not supported! 4. Download the latest __Qt 6.4.x__ for you platform. Earlier versions are not supported!
1. [Install instructions Windows](#windows) 1. [Install instructions Windows](#windows)
1. [Install instructions Linux](#linux) 1. [Install instructions Linux](#linux)
1. [Install instructions MacOSX](#macosx) 1. [Install instructions MacOSX](#macosx)
5. 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. 5. 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.
``` bash ``` bash
cd Tools cd Tools
py setup.py # Windows defaults to python
python setup.py
# Linux and macOS uses python3
python3 setup.py
``` ```
* This will install these dependencies via __vcpkg__
* openSSL
* sentry-native
* doctest
* infoware
<div> <div>
<img width="100%" height="auto" src="../.gitlab/media/QtCreator_kit.png"> <img width="100%" height="auto" src="../.gitlab/media/QtCreator_kit.png">
</div> </div>
5. Open __QtCreator__ and open the settings `Tools -> Options` 5. Open __QtCreator__ and open the settings `Tools -> Options`
6. Clone an existing kit like `Qt 6.3.1 MSVC2019 64bit` and add `ScreenPlay` to the new kit name 6. Clone an existing kit like `Qt 6.4.1 MSVC2019 64bit` and add `ScreenPlay` to the new kit name
5. Edit CMake variables amd add CMAKE_TOOLCHAIN_FILE and VCPKG_TARGET_TRIPLET 5. Edit CMake variables amd add CMAKE_TOOLCHAIN_FILE and VCPKG_TARGET_TRIPLET
* `Kits -> <Your_Kit> -> CMake Configuration` * `Kits -> <Your_Kit> -> CMake Configuration`
@ -39,7 +37,6 @@ Append this:
-DVCPKG_TARGET_TRIPLET:STRING=arm64-osx -DVCPKG_TARGET_TRIPLET:STRING=arm64-osx
``` ```
6. Save and close the settings. 6. Save and close the settings.
7. Open Project via `File -> Open File or Project` and select your `CMakeLists.txt`. Then select __our created kit__, press `Configure Project` 7. Open Project via `File -> Open File or Project` and select your `CMakeLists.txt`. Then select __our created kit__, press `Configure Project`
<div> <div>
@ -54,7 +51,7 @@ Append this:
1. [Download and install Qt binary installer from qt.io](https://www.qt.io/download-qt-installer) 1. [Download and install Qt binary installer from qt.io](https://www.qt.io/download-qt-installer)
- Install the Maintaince tool - Install the Maintaince tool
- Select the following features to install: - Select the following features to install:
- Qt 6.3.1 - Qt 6.4.1
- MSVC 2019 64-bit - MSVC 2019 64-bit
- **ALL Additional Libraries** - **ALL Additional Libraries**
- Qt Quick 3d - Qt Quick 3d
@ -63,16 +60,17 @@ Append this:
- Developer and Designer Tools - Developer and Designer Tools
- Cmake - Cmake
- Ninja - Ninja
## Linux via qt.io account ## Linux dependencies
1. Install dependencies for your distro: 1. Install dependencies for Debian/Ubuntu:
``` bash ``` bash
# Debian/Ubuntu sudo apt install build-essential git gpg ffmpeg mesa-common-dev libxkbcommon-* libfontconfig curl zip unzip tar git pkg-config apt-transport-https ca-certificates gnupg software-properties-common wget software-properties-common python3 python3-pip libgl1-mesa-dev lld ninja-build cmake qml-module-qt-websockets qtwebengine5-* -y
sudo apt install build-essential git gpg ffmpeg mesa-common-dev libxkbcommon-* libfontconfig curl zip unzip tar git pkg-config apt-transport-https ca-certificates gnupg software-properties-common wget software-properties-common python3-pip libgl1-mesa-dev lld ninja-build cmake qml-module-qt-websockets qtwebengine5-* -y
``` ```
## Linux via qt.io account
1. [Download and install Qt binary installer from qt.io](https://www.qt.io/download-qt-installer) 1. [Download and install Qt binary installer from qt.io](https://www.qt.io/download-qt-installer)
- Install the Maintaince tool - Install the Maintaince tool
- Select the following features to install: - Select the following features to install:
- Qt 6.3.1 - Qt 6.4.1
- GCC - GCC
- **ALL Additional Libraries** - **ALL Additional Libraries**
- Qt Quick 3d - Qt Quick 3d
@ -83,26 +81,19 @@ sudo apt install build-essential git gpg ffmpeg mesa-common-dev libxkbcommon-
- OpenSSL 64-bit binaries - OpenSSL 64-bit binaries
- Cmake - Cmake
- Ninja - Ninja
## Linux via aqt command line & VSCode
## Linux via aqt
1. Alternativly download via aqt 1. Alternativly download via aqt
``` ```
pip3 install -U pip python3 -m pip install aqtinstall
pip3 install aqtinstall python3 -m aqt install-qt -O ~/aqt linux desktop 6.4.1 gcc_64 -m all
aqt install-qt -O ~/aqt linux desktop 6.3.1 gcc_64 -m all
``` ```
1. Open VSCode and install the `CMake Tools` 1. Open VSCode and install the `CMake Tools`
1. ctrl + p: `CMake: Select Configure Preset` 1. ctrl + p: `CMake: Select Configure Preset`
2. Select `ScreenPlay 64bit Debug Linux` 2. Select `ScreenPlay 64bit Debug Linux`
3. ctrl + p: `CMake: Configure` 3. ctrl + p: `CMake: Configure`
4. ctrl + p: `CMake: Build` 4. ctrl + p: `CMake: Build`
### Fix python scripts not in path:
```
vim ~/.bashrc
```
Add at the end of the file and restart the console/terminal:
```
export PATH="~/.local/bin:$PATH"
```
## MacOSX ## MacOSX
1. Install XCode 13+ , open and restart your device. 1. Install XCode 13+ , open and restart your device.
@ -111,7 +102,7 @@ export PATH="~/.local/bin:$PATH"
1. [Download and install Qt binary installer from qt.io](https://www.qt.io/download-qt-installer) 1. [Download and install Qt binary installer from qt.io](https://www.qt.io/download-qt-installer)
- Install the Maintaince tool - Install the Maintaince tool
- Select the following features to install: - Select the following features to install:
- Qt 6.3.1 - Qt 6.4.1
- Qt WebEngine - Qt WebEngine
- **ALL Additional Libraries** - **ALL Additional Libraries**
- Qt Quick 3d - Qt Quick 3d
@ -123,7 +114,7 @@ export PATH="~/.local/bin:$PATH"
- Cmake - Cmake
- Ninja - Ninja
1. Change your default kit: 1. Change your default kit:
- `QtCreator -> Options -> Kits -> Select your default kit (Desktop Qt 6.3.1) -> Change c and c++ Compiler to Apple Clang (x86_64)` - `QtCreator -> Options -> Kits -> Select your default kit (Desktop Qt 6.4.1) -> Change c and c++ Compiler to Apple Clang (x86_64)`
# Developer docs # Developer docs