mirror of https://gitlab.com/kelteseth/ScreenPlay.git synced 2024-11-25 12:13:00 +01:00

Mirror of https://gitlab.com/kelteseth/ScreenPlay https://screen-play.app/

Go to file

Elias Steurer dcc7986ff9 Add benchmark and doctest metrics		2020-10-30 16:40:16 +01:00
.gitlab	Update .gitlab/media/preview.gif, README.md files	2020-10-29 14:28:13 +00:00
Common	Replace qt-breakpad with sentry.io	2020-09-11 16:33:27 +02:00
Docs	Add benchmark and doctest metrics	2020-10-30 16:40:16 +01:00
Legal	Add contributing and AGPL	2019-06-11 13:46:19 +02:00
ScreenPlay	Add benchmark and doctest metrics	2020-10-30 16:40:16 +01:00
ScreenPlaySDK	Call format-cpp	2020-10-29 19:17:37 +01:00
ScreenPlayShader	Call format-cmake.py	2020-10-29 19:48:40 +01:00
ScreenPlaySysInfo	Call format-cpp	2020-10-29 19:17:37 +01:00
ScreenPlayWallpaper	Call format-cpp	2020-10-29 19:17:37 +01:00
ScreenPlayWidget	Call format-cmake.py	2020-10-29 19:48:40 +01:00
Tools	Add doctest and google benchmark	2020-10-30 15:37:00 +01:00
.clang-format	Add clang format	2019-04-25 13:17:35 +02:00
.cmake-format.py	Add new ci build script and check step	2020-10-29 18:19:22 +01:00
.gitattributes	Add workshop project	2018-11-17 11:48:57 +01:00
.gitignore	Many fixes/changes	2020-10-04 11:26:25 +07:00
.gitlab-ci.yml	Add benchmark and doctest metrics	2020-10-30 16:40:16 +01:00
.gitmodules	Replace qt-breakpad with sentry.io	2020-09-11 16:33:27 +02:00
CMakeLists.txt	Format file with latest python 3.9	2020-10-29 20:06:13 +01:00
LICENSE	Add LICENSE	2019-09-18 10:41:13 +00:00
README.md	Update .gitlab/media/preview.gif, README.md files	2020-10-29 14:28:13 +00:00

README.md

ScreenPlay
Dev. Docs

ScreenPlay is an open source cross platform app for displaying Video Wallpaper, Widgets and AppDrawer. It is written in modern C++20/Qt5/QML. Binaries with workshop support are available for Windows and soon Linux & MacOSX via Steam. Join our community:

Homepage - Forum - 🎉 Discord (Free Steam Key Here!) - Reddit

Wallpaper and Widgets Guide

Contributing for none programmer

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

If you want to help translate
If you are a designer
Help create example app via HTML/QML/Javascript

Contributing for programmer

If you want to contribute but don't know how to start, take a look at our open issues and WIP merge request.
If you need help don't hesitate to ask me (Keltseth) via:
- Create a forum topic with a detailed description
- discord channel general
Developer setup guide on how to download and compile ScreenPlay yourself.
ScreenPlay project overview
Developer C++ Classes Documentation

Platform support

❌ Not working/Not implemented
❓ Only partical implemented/Not tested

Feature	Windows	Linux	MacOS
ScreenPlay Main App	✔	✔	✔
Steam Binaries	✔	❌	❌
Wallpaper	✔	❌ Help Needed for Gnome/KDE/etc!	✔
Widgets	✔	❓	✔
Multilanguage (EN,DE,RU,FR,ES,KO🆕,VI🆕)	✔	✔	✔

Because every operating system has his own version of desktop environment we need to adapt the ScreenPlayWindow for every platform seperate. The most feature complete for now is Windows 10. Windows 7 works but the wallpaper have the worng coordinates. MacOS has some basic wallpaper functionality but no maintainer. For Linux we sadly have no support for any desktops environments at the moment.

If you want to help and add new desktop environments look at ScreenPlayWallpaper/src folder

BaseWindow baseclass for:

Plattform	Windows 7	Windows 8/8.1	Windows 10	Gnome	KDE	XFCE	MacOS
Wallpaper	❓ Help Needed!	❓ Help Needed!	✔	❌ Help Needed!	❌ Help Needed!	❌ Help Needed!	❓ (Basic implementation) Help Needed!