ScreenPlay/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 - Steam

Click gif to see the Steam Early Access Trailer (YouTube)

Contributing

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

Here are some ways you can contribute:

• by using prerelease versions / master branch or the Steam nightly builds
• by adding/fixing translation
• by designing UI/UX
• by creating example HTML/QML/Javascript content
• by reporting bugs
• by writing user documentation
• by coding needed features
• by refactoring code
• by reviewing merge requests
• by verifying issues

Coding

• Developer setup guide on how to download and compile ScreenPlay yourself.
• 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
• ScreenPlay project overview
• Developer C++ Classes Documentation

Content Creation

• Wallpaper Guide
• Widgets Guide

Platform support

• ❌ Not working/Not implemented
• ❓ Only partical implemented/Not tested, help needed

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:
  • LinuxWindow
  • WinWindow
  • MacWindow

Plattform	Windows 10	Gnome	KDE	MacOS
Wallpaper	✔	❌ Help Needed!	❓ (Basic implementation)	❓ (Basic implementation)