mirror of https://gitlab.com/kelteseth/ScreenPlay.git synced 2024-07-08 05:48:09 +02:00

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

Go to file

Elias Steurer 6bd7deaa43 Update vcpkg Fix compilation Remove unused benchmark		2021-12-02 15:31:05 +01:00
.gitlab	Change icon sizes	2021-11-04 16:32:40 +01:00
CMake	Disable ts line numbers	2021-11-11 18:16:19 +01:00
Docs	Update docs	2021-11-11 18:24:10 +01:00
ScreenPlay	Update vcpkg	2021-12-02 15:31:05 +01:00
ScreenPlaySDK	Refactor to use Qt6 style cmake/qml plugins	2021-10-15 15:06:05 +02:00
ScreenPlayShader	Refactor to use Qt6 style cmake/qml plugins	2021-10-15 15:06:05 +02:00
ScreenPlaySysInfo	Refactor to use Qt6 style cmake/qml plugins	2021-10-15 15:06:05 +02:00
ScreenPlayUtil	Make enum checks CaseInsensitive	2021-11-13 14:12:52 +01:00
ScreenPlayWallpaper	Change monitor selection when using Windows scaling	2021-11-20 19:22:11 +01:00
ScreenPlayWidget	Refactor to use Qt6 style cmake/qml plugins	2021-10-15 15:06:05 +02:00
ScreenPlayWorkshop	Update vcpkg	2021-12-02 15:31:05 +01:00
Tools	Update vcpkg	2021-12-02 15:31:05 +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
.gitignore	Add missing linux steam .so	2021-10-16 15:08:58 +02:00
.gitlab-ci.yml	Update vcpkg	2021-12-02 15:31:05 +01:00
CMakeLists.txt	Fix none steam builds	2021-11-13 14:47:43 +01:00
crowdin.yml	Update Crowdin configuration file	2021-09-18 12:30:08 +00:00
LICENSE	Add LICENSE	2019-09-18 10:41:13 +00:00
README_zh_CN.md	Update preview video	2021-11-04 16:03:02 +01:00
README.md	Update preview video	2021-11-04 16:03:02 +01:00

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/Qt5/QML.
Homepage - Forum- Discord

🚀Support ScreenPlay On Patreon🚀

Important Issues

Implement KDE 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:
- 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	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🆕)	✔	✔	✔