<div> <img width="100%" height="93" src=".gitlab/media/logo_gitlab_fullwidth.svg"> </div> <div align="center"> <br>

<a href="https://www.youtube.com/watch?v=q-J2fTWDxw8"><p>Watch the Steam Early Access Trailer (YouTube)</p></a>

中文总览

ScreenPlay is an Open Source cross-platform app for displaying Video Wallpaper & Widgets. It is written in modern C++23/Qt6/QML. <br> <a href="https://screen-play.app/">Homepage</a> - <a href="https://forum.screen-play.app/">Forums</a>- <a href="https://discord.com/invite/4sY9d4f2DM">Discord</a>

</div>

Table of Contents

• Quick Start
• Content Creation
• General Contributing
• Development
• Platform Support

Quick Start

<h3><a href="https://kelteseth.gitlab.io/ScreenPlayDocs/building-screenplay/">Developer setup guide on how to download and compile ScreenPlay yourself.</a> </h3>

✨ Key Features

• 🎥 Video Wallpapers - Support for WebM, MP4 and other video formats
• 🎥 Godot Engine Wallpapers - Support for Godot 4 Wallpaper (🚀 Pro Feature)
• ⏰ Timeline Wallpapers - Automatically change wallpaper based on a user defined range (🚀 Pro Feature)
• 🖼️ Static Wallpapers - Beautiful image wallpapers with various effects
• 🎮 Interactive QML Wallpapers - Custom interactive wallpapers using Qt QML
• 🌐 Web-based Wallpapers - HTML/CSS/JavaScript wallpapers
• 🧩 Desktop Widgets - Customizable widgets for system monitoring, weather, RSS feeds, and more
• 🔧 Cross-platform - Works on Windows, macOS, and Linux
• 🎨 Easy Content Creation - No coding knowledge required for basic wallpapers
• 🛠️ Steam Workshop - Easy sharing and downloading of community content

Content Creation

Learn the basics of QML for Wallpapers and Widgets in 5 minutes

<div> <a href="https://kelteseth.gitlab.io/ScreenPlayDocs/wallpaper/"><img src=".gitlab/media/wallpaper_guide.png"></a> </div>

• Wallpaper Documentation. General wallpaper guidelines and information.
• Performance Guidelines. You need a modern GPU for smooth playback. You can always use QML/HTML/GIF wallpaper if you encounter performance issues!

<div> <a href="https://kelteseth.gitlab.io/ScreenPlayDocs/widgets/"><img src=".gitlab/media/widgets_guide.png"></a> </div>

• Widgets Guide. General guidelines how to create widgets. ScreenPlay uses the easy to learn QML language. No coding knowledge required!

General Contributing

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

🚀 Quick Contributing Guide

New to contributing? Start here:

• 🐛 Report bugs - Help us improve by reporting issues
• 🌐 Translate - Make ScreenPlay available in your language
• 💡 Request features - Share your ideas
• 🎨 Create content - Make wallpapers and widgets

For developers:

• 🔧 Fix bugs - Help resolve existing issues
• ⭐ Add features - Implement new functionality
• 📚 Improve docs - Help other users and developers

Platform support

• ✅ Fully supported
• ❌ Not working/Not implemented
• ❓ Partially implemented/Not tested (help needed)

| Feature | Windows | Linux (X11/Wayland) | macOS | |------------------------ |--------- |------- |------- | | ScreenPlay Main App | ✅ | ✅ | ✅ | | Binaries | ✅ | ❌ | ✅ | | Steam Binaries | ✅ | ❌ | ✅ | | Video Wallpapers | ✅ | ✅ | ✅ | | QML/HTML Wallpapers | ✅ | ✅ | ✅ | | Desktop Widgets | ✅ | ✅ | ✅ | | Multi-monitor Support | ✅ | ✅ | ✅ | | Workshop Integration | ✅ | ❌ | ✅ | | Multilanguage Support<br/>(EN,DE,RU,FR,ES,KO,VI,ZH_CN,PT_BR) | ✅ | ✅ | ✅ |

❓ Frequently Asked Questions

<details> <summary><strong>How do I install ScreenPlay?</strong></summary>

• Steam (Recommended): Download from Steam for automatic updates and Workshop support
• Direct Download (Non-Steam Version):
  • Latest Release - Windows and macOS builds without Steam Workshop integration
  • getsp.de - Alternative download source

Note: Linux builds are coming soon! For community content downloads, visit our forums where users share wallpapers and widgets.

</details> <details> <summary><strong>Why is my video wallpaper performance poor?</strong></summary>

Video wallpapers require a modern GPU. If you experience performance issues:

• Try reducing the video resolution or bitrate
• Switch to QML or HTML wallpapers for better performance
• Check our Performance Guidelines

</details> <details> <summary><strong>How do I create my own wallpaper or widget?</strong></summary>

• Check our 5-minute QML tutorial
• Read the Wallpaper Documentation
• Browse the Widgets Guide
• Look at example content in the Content/ folder

</details> <details> <summary><strong>Can I use ScreenPlay on multiple monitors?</strong></summary>

Yes! ScreenPlay supports multi-monitor setups. You can set different wallpapers on each monitor and position widgets anywhere across your displays.

</details> <details> <summary><strong>Where can I download wallpapers and widgets?</strong></summary>

• Steam Workshop: If you use the Steam version, browse and download content directly through Steam Workshop
• Community Forums: Visit our forums for user-shared content - many users prefer this for the direct download versions
• Create Your Own: Check our content creation guides to make your own wallpapers and widgets

</details>