7.9 KiB
ScreenPlay 
Dev. Docs 
User Chat (Discord)
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
✨Download ScreenPlay via Steam - Steam Workshop for Wallpaper and Widgets✨
Windows only, Linux and MacOS (soon™)
Click gif to see the Steam Early Access Trailer (YouTube)
Important Issues
- Support for Windows monitor scaling is currently buggy. All monitors must be set to 100%!
- Implement KDE Support
- Implement MacOS Support
Content Creation
Learn the basics of QML for Wallpapers and Widgets in 5 minutes
- Video Wallpaper. You can import any WebM file directly or use the importer for any other video type.
- Performance Guidelines. You need a modern GPU for smooth playback. You can always use QML/HTML/GIF wallpaper if you encounter performance issues!
- Video import via Handbrake. Handbrake offers easy bulk import of videos.
- Widgets Guide. General guidelines how to create widgets. ScreenPlay uses the easy to learn QML language. No coding knowledge required!
- Storage Widget. Display your drives and usage.
- CPU Usage Widget. Displays your current CPU usage.
- RSS Feed Widget. Display news as a rss widget.
General Contributing
Everyone can contribute with code, design, documentation or translation. Visit our contributing guide for more information. Also checkout 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
Development
- 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 (Kelteseth) via:
- ScreenPlay project overview
- Developer C++ Classes Documentation
Platform support
- ❌ Not working/Not implemented
- ❓ Only partially 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,CH_ZN,PT_BR🆕) | ✔ | ✔ | ✔ |
Because every operating system has its own version of desktop environment we need to adapt the ScreenPlayWindow for every platform separately. The most feature complete for now is Windows 10. Windows 7 works but the wallpaper have the wrong coordinates. MacOS has some basic wallpaper functionality but no maintainer. For Linux we sadly have no support for any desktop environments at the moment, except basic KDE support.
If you want to help and add new desktop environments look at ScreenPlayWallpaper/src folder
- BaseWindow baseclass for:
| Plattform | Windows 10 | Gnome | KDE | MacOS |
|---|---|---|---|---|
| Wallpaper | ✔ | ❌ Help Needed! | ❓ Basic implementation | ❓ Basic implementation |