Mirrors/ScreenPlay
Mirrors/ScreenPlay
1
0
Fork 0
mirror of https://gitlab.com/kelteseth/ScreenPlay.git synced 2024-09-02 16:49:47 +02:00
Code Issues Projects Releases Activity
0a27b61885
ScreenPlay/README.md

3.9 KiB
Raw Blame History

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 Steam. Join our community: Homepage, Forum
Visit our Developer Documentation and our Getting Started Guide!

Download ScreenPlay!

Tune in for a Twitch programming live stream every other day to learn about contributing!

Preview

Contributing

Everyone can contribute with code, design, documentation or translation. Visit our contributing guide for more informations.

Getting started

Basic

  1. Install latest git + git-lfs
  2. Download ScreenPlay with all submodules
# HTTPS
git clone --recursive https://gitlab.com/kelteseth/ScreenPlay.git
  1. Download the latest Qt 5.13. Earlier versions are not supported!

Windows

  1. Download and install MSVC 2019 Community

  2. Download and install Win 10 SDK (debugging support. Not included via the MSVC installer)

    • Select debugging support during the installation (CDB)

  3. Download and install Qt 5 binary installer from qt.io

    • Install the Maintaince tool
    • Select the following features to install:
      • Qt 5.13.0
        • MSVC 2017 64-bit
        • Qt WebEngine
      • Developer and Designer Tools
        • Qt Creator 4.x CDB Debugger Support
        • OpenSSL 1.1.1.c Toolkit
          • OpenSSL 64-bit binaries

  4. Start the vcpkg-install-dependencies.bat for the automatic dependencies management.

Linux

  1. Install dependencies for your distro:
# Debian/Ubuntu
sudo apt install build-essential libgl1-mesa-dev

# Fedora/RHEL/CentOS (yum)
sudo yum groupinstall "C Development Tools and Libraries"
sudo yum install mesa-libGL-devel

# openSUSE (zypper)
sudo zypper install -t pattern devel_basis
  1. Download and install Qt 5 binary installer from qt.io
    • Install the Maintaince tool
    • Select the following features to install:
      • Qt 5.13.0
        • GCC
        • Qt WebEngine
      • Developer and Designer Tools
        • OpenSSL 1.1.1.c Toolkit
          • OpenSSL 64-bit binaries

OSX

  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'
  3. Download and install Qt 5 binary installer from qt.io
    • Install the Maintaince tool
    • Select the following features to install:
      • Qt 5.13.0
        • Qt WebEngine
      • Developer and Designer Tools
        • OpenSSL 1.1.1.c Toolkit
          • OpenSSL 64-bit binaries
  4. Change your default kit: QtCreator -> Options -> Kits -> Select your default kit (Desktop Qt 5.13.0) -> Change c and c++ Compiler to Apple Clang (x86_64)