ScreenPlay/README.md

ScreenPlay: Docs:

✨Download ScreenPlay with via Steam™ with Workshop support✨

✨💻 Download ScreenPlay Windows directly✨

✨🍏 Download ScreenPlay macOS (unsigned) directly✨

Watch the Steam Early Access Trailer (YouTube)

中文总览

ScreenPlay is an Open Source cross-platform app for displaying Video Wallpaper & Widgets. It is written in modern C++20/Qt6/QML.
Homepage - Forums- Discord

Developer setup guide on how to download and compile ScreenPlay yourself.

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:
  • Create a forum topic with a detailed description
  • discord channel general
• ScreenPlay project overview
• Developer C++ Classes Documentation

Platform support

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

Feature	Windows	Linux X11 and Wayland (layer shell)	MacOS
ScreenPlay Main App	✔	✔	✔
Steam Binaries	✔	❌	✔
Wallpaper	✔	✔	✔
Widgets	✔	✔	✔
Multilanguage (EN,DE,RU,FR,ES,KO,VI,CH_ZN,PT_BR🆕)	✔	✔	✔