2018-12-04 13:40:26 +01:00
< div >
2018-12-04 12:52:01 +01:00
< img width = "100%" height = "93" src = "https://screen-play.app/images/logo_gitlab_fullwidth.svg" >
< / div >
2018-12-04 12:45:17 +01:00
2018-12-04 13:57:54 +01:00
< div align = "center" >
2018-12-04 14:02:12 +01:00
ScreenPlay is an open source cross plattform app for displaying Wallpaper, Widgets and AppDrawer. It is written in modern C++17/Qt5/QML. Binaries with workshop support are available for Windows/Linux/MacOSX via < a href = "https://store.steampowered.com/about/" > Steam< / a > .
2018-12-04 13:57:54 +01:00
Join our community: < a href = "https://screen-play.app/" > Homepage< / a > , < a href = "https://forum.screen-play.app/" > Forum< / a > , < a href = "https://discord.gg/3RygPHZ" > Discord< / a >
2018-12-11 13:32:48 +01:00
< br > Visit our < a href = "https://aimber.gitlab.io/ScreenPlayDocs/" > Developer Documentation< / a > and our < a href = "https://aimber.gitlab.io/ScreenPlayDocs/" > Getting Started Guide< / a > !
2018-12-04 13:57:54 +01:00
< br >
< h3 > < a href = "https://steamcommunity.com/app/672870/" > Download ScreenPlay!< / a > < / h3 >
2018-12-11 13:32:48 +01:00
2018-12-04 13:57:54 +01:00
< / div >
< br >
2019-02-28 16:37:25 +01:00
## Contributing
2018-12-04 13:40:26 +01:00
2019-02-28 16:37:25 +01:00
Everyone can contribute with code, design, documentation or translation. Visit our [contributing guide ](https://gitlab.com/aimber/ScreenPlay/blob/dev/CONTRIBUTING.md ) for more informations.
2018-12-04 13:40:26 +01:00
2018-12-04 18:13:44 +01:00
# Getting started
2018-12-04 14:13:02 +01:00
2018-12-04 18:13:44 +01:00
### Basic
1. Install latest git + git-lfs
2. Download ScreenPlay with __all submodules__
2018-12-04 14:13:02 +01:00
``` bash
# HTTPS
git clone --recursive https://gitlab.com/aimber/ScreenPlay.git
```
2018-12-04 12:18:28 +01:00
### Windows
1. [Download and install MSVC 2017 Community ](https://visualstudio.microsoft.com/vs/community/ )
2. [Download and install Win 10 SDK (debugging support. Not included via the MSVC installer) ](https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk )
2018-10-03 13:20:02 +02:00
- Select debugging support during the installation (CDB)
2018-12-04 12:18:28 +01:00
3. [Download and install Qt 5 binary installer from qt.io ](https://www.qt.io/download-qt-installer )
2018-10-03 13:20:02 +02:00
- Install the Maintaince tool
2018-08-19 15:23:59 +02:00
- Select the following features to install:
2018-12-17 15:01:58 +01:00
- Qt 5.12.0 LTS
2018-08-19 15:21:34 +02:00
- MSVC 2017 64-bit
- Qt WebEngine
- Tools
- Qt Creator 4.x CDB Debugger Support
2018-12-04 12:18:28 +01:00
### Linux
1. Install dependencies for your distro:
``` bash
# Debian/Ubuntu
sudo apt install build-essential libgl1-mesa-dev
2018-08-19 15:23:59 +02:00
2018-12-04 12:18:28 +01:00
# Fedora/RHEL/CentOS (yum)
sudo yum groupinstall "C Development Tools and Libraries"
sudo yum install mesa-libGL-devel
2018-08-19 15:23:59 +02:00
2018-12-04 12:18:28 +01:00
# openSUSE (zypper)
sudo zypper install -t pattern devel_basis
```
2. [Download and install Qt 5 binary installer from qt.io ](https://www.qt.io/download-qt-installer )
- Install the Maintaince tool
- Select the following features to install:
2018-12-17 15:01:58 +01:00
- Qt 5.12.0 LTS
2018-12-04 12:18:28 +01:00
- GCC
- Qt WebEngine
### OSX
2018-12-04 14:13:02 +01:00
1. Install XCode via the app store
2. Launch XCode and install the XCode command line tools. (This may take a few minutes)
- If in doubt or unsure, execute 'xcode-select --install'
2018-12-04 18:18:58 +01:00
3. [Download and install Qt 5 binary installer from qt.io ](https://www.qt.io/download-qt-installer )
2018-12-04 12:18:28 +01:00
- Install the Maintaince tool
- Select the following features to install:
2018-12-17 15:01:58 +01:00
- Qt 5.12.0 LTS
2018-12-04 12:18:28 +01:00
- Qt WebEngine
2018-12-04 18:18:58 +01:00
4. Change your default kit: QtCreator -> Options -> Kits -> Select your default kit (Desktop Qt 5.11.2) -> Change c and c++ Compiler to Apple Clang (x86_64)
