ScreenPlay/README.md

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

<div align="center">
ScreenPlay is an open source cross platform app for displaying Wallpaper, Widgets and AppDrawer. It is written in modern C++17/Qt5/QML. Binaries with workshop support are available for Windows and soon Linux & MacOSX via <a href="https://store.steampowered.com/about/">Steam</a>.  Join our community: 

<h3><a href="https://screen-play.app/">Homepage</a> - <a href="https://forum.screen-play.app/">Forum</a> - <a href="https://discord.gg/3RygPHZ">🎉 Discord (Free Steam Key Here!)</a>  -  <a href="https://www.reddit.com/r/ScreenPlayApp/">Reddit</a></h3>
<!--<h4><a href="https://steamcommunity.com/app/672870/">Download ScreenPlay!</a></h4>-->
<br>

![Preview](.gitlab/media/preview.mp4)

<br> <h4><a href="https://kelteseth.gitlab.io/ScreenPlayDocs/wallpaper/wallpaper/">Wallpaper </a>  and  <a href="https://kelteseth.gitlab.io/ScreenPlayDocs/widgets/widgets/">  Widgets </a>Guide</h4>
</div>


# Contributing for none programmer

Everyone can contribute with code, design, documentation or translation. Visit our [contributing guide](https://kelteseth.gitlab.io/ScreenPlayDocs/contribute/contribute) for more informations. Also check our [Collaboration Guidelines](Docs/CodeOfConduct.md).

* If you want to help [translate](https://kelteseth.gitlab.io/ScreenPlayDocs/contribute/translations/)
* If you are a [designer](https://kelteseth.gitlab.io/ScreenPlayDocs/contribute/contribute/#design)
* Help create example app via [HTML/QML/Javascript](https://kelteseth.gitlab.io/ScreenPlayDocs/)


# Contributing for programmer
 * 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](https://forum.screen-play.app/category/2/general-discussion)
     * [discord channel general](https://discord.gg/3RygPHZ)
 * [Developer setup guide on how to download and compile ScreenPlay yourself.](Docs/DeveloperSetup.md)
 * [ScreenPlay project overview](Docs/ProjectOverview.md)
 * [Developer C++ Classes Documentation](https://kelteseth.gitlab.io/ScreenPlayDeveloperDocs/)

# Platform support

* ❌ Not working/Not implemented
* ❓ Only partical implemented/Not tested

<div align="center">

| 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🆕)__              | ✔            	| ✔     	        |  ✔     	|

</div>

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](https://gitlab.com/kelteseth/ScreenPlay/issues/34). 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](https://gitlab.com/kelteseth/ScreenPlay/blob/dev/ScreenPlayWallpaper/src/basewindow.h) baseclass for:
    * [LinuxWindow](https://gitlab.com/kelteseth/ScreenPlay/blob/dev/ScreenPlayWallpaper/src/linuxwindow.h)
    * [WinWindow](https://gitlab.com/kelteseth/ScreenPlay/blob/dev/ScreenPlayWallpaper/src/winwindow.h)
    * [MacWindow](https://gitlab.com/kelteseth/ScreenPlay/blob/dev/ScreenPlayWallpaper/src/macwindow.h)

<div align="center">

| Plattform                	    | Windows 7	       | Windows 8/8.1 	    | Windows 10  |   Gnome	         | KDE 	            | XFCE  	        | MacOS  	|
|------------------------	    |---------	       |-------	            |-------	  |---------	     |-------	        |-------	        | -------	|
| __Wallpaper__                 | ❓ Help Needed!   | ❓ Help Needed!    | ✔      	| ❌ Help Needed!  | ❌ Help Needed!  |❌ Help Needed!   | ❓ (Basic implementation) Help Needed!     	|


</div>
Update README.md 2018-12-04 13:40:26 +01:00			`<div>`
Add install-dependencies.sh for linux Move media files into .gitlab folder Change readme to better help with linux setup process 2020-01-28 18:08:12 +01:00			`<img width="100%" height="93" src=".gitlab/media/logo_gitlab_fullwidth.svg">`
Update README.md 2018-12-04 12:52:01 +01:00			`</div>`
Update README.md 2018-12-04 12:45:17 +01:00
Update README.md 2018-12-04 13:57:54 +01:00			`<div align="center">`
Fix spelling 2020-07-10 20:48:34 +02:00			`ScreenPlay is an open source cross platform app for displaying Wallpaper, Widgets and AppDrawer. It is written in modern C++17/Qt5/QML. Binaries with workshop support are available for Windows and soon Linux & MacOSX via <a href="https://store.steampowered.com/about/">Steam</a>. Join our community:`
Update README.md 2020-02-10 16:10:54 +01:00
Update README.md 2020-02-10 16:11:37 +01:00			`<h3><a href="https://screen-play.app/">Homepage</a> - <a href="https://forum.screen-play.app/">Forum</a> - <a href="https://discord.gg/3RygPHZ">🎉 Discord (Free Steam Key Here!)</a> - <a href="https://www.reddit.com/r/ScreenPlayApp/">Reddit</a></h3>`
Fix logo and text 2019-11-15 19:28:30 +01:00			`<!--<h4><a href="https://steamcommunity.com/app/672870/">Download ScreenPlay!</a></h4>-->`
Update README.md 2018-12-04 13:57:54 +01:00			`<br>`
Update README.md 2019-08-28 16:33:21 +02:00
Add install-dependencies.sh for linux Move media files into .gitlab folder Change readme to better help with linux setup process 2020-01-28 18:08:12 +01:00			`![Preview](.gitlab/media/preview.mp4)`
Update README.md 2020-02-10 16:10:54 +01:00
Update README.md 2020-06-03 15:46:23 +02:00			`<br> <h4><a href="https://kelteseth.gitlab.io/ScreenPlayDocs/wallpaper/wallpaper/">Wallpaper </a> and <a href="https://kelteseth.gitlab.io/ScreenPlayDocs/widgets/widgets/"> Widgets </a>Guide</h4>`
Update README.md 2020-02-10 16:09:36 +01:00			`</div>`
Update README.md 2019-08-28 16:33:21 +02:00
Update readme and move content into separate readme 2020-05-16 14:04:53 +02:00
			`# Contributing for none programmer`

Add Collaboration Guidelines 2020-06-27 10:13:22 +02:00			`Everyone can contribute with code, design, documentation or translation. Visit our [contributing guide](https://kelteseth.gitlab.io/ScreenPlayDocs/contribute/contribute) for more informations. Also check our [Collaboration Guidelines](Docs/CodeOfConduct.md).`
Update readme and move content into separate readme 2020-05-16 14:04:53 +02:00
			`* If you want to help [translate](https://kelteseth.gitlab.io/ScreenPlayDocs/contribute/translations/)`
			`* If you are a [designer](https://kelteseth.gitlab.io/ScreenPlayDocs/contribute/contribute/#design)`
			`* Help create example app via [HTML/QML/Javascript](https://kelteseth.gitlab.io/ScreenPlayDocs/)`


			`# Contributing for programmer`
			`* If you want to contribute but don't know how to start, take a look at our open issues and WIP merge request.`
Add more docs 2020-05-16 14:30:11 +02:00			`* If you need help don't hesitate to ask me (Keltseth) via:`
			`* [Create a forum topic with a detailed description](https://forum.screen-play.app/category/2/general-discussion)`
			`* [discord channel general](https://discord.gg/3RygPHZ)`
Fix links 2020-05-16 14:07:02 +02:00			`* [Developer setup guide on how to download and compile ScreenPlay yourself.](Docs/DeveloperSetup.md)`
			`* [ScreenPlay project overview](Docs/ProjectOverview.md)`
Update readme and move content into separate readme 2020-05-16 14:04:53 +02:00			`* [Developer C++ Classes Documentation](https://kelteseth.gitlab.io/ScreenPlayDeveloperDocs/)`

Update README.md 2020-01-30 14:18:11 +01:00			`# Platform support`

			`* ❌ Not working/Not implemented`
			`* ❓ Only partical implemented/Not tested`

			`<div align="center">`

			`\| Feature \| Windows \| Linux \| MacOS \|`
			`\|------------------------ \|--------- \|------- \|------- \|`
			`\| __ScreenPlay Main App__ \| ✔ \| ✔ \| ✔ \|`
Add cmake QtCreator readme setup 2020-05-03 13:11:26 +02:00			`\| __Steam Binaries__ \| ✔ \| ❌ \| ❌ \|`
			`\| __Wallpaper__ \| ✔ \| ❌ Help Needed for Gnome/KDE/etc! \| ✔ \|`
			`\| __Widgets__ \| ✔ \| ❓ \| ✔ \|`
Add Korean and Vietnamese languages to the feature list 2020-03-12 12:54:20 +01:00			`\| __Multilanguage (EN,DE,RU,FR,ES,KO🆕,VI🆕)__ \| ✔ \| ✔ \| ✔ \|`
Update README.md 2020-01-30 14:18:11 +01:00
Update README.md 2020-01-30 14:32:37 +01:00			`</div>`

			`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](https://gitlab.com/kelteseth/ScreenPlay/issues/34). 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](https://gitlab.com/kelteseth/ScreenPlay/blob/dev/ScreenPlayWallpaper/src/basewindow.h) baseclass for:`
			`* [LinuxWindow](https://gitlab.com/kelteseth/ScreenPlay/blob/dev/ScreenPlayWallpaper/src/linuxwindow.h)`
			`* [WinWindow](https://gitlab.com/kelteseth/ScreenPlay/blob/dev/ScreenPlayWallpaper/src/winwindow.h)`
			`* [MacWindow](https://gitlab.com/kelteseth/ScreenPlay/blob/dev/ScreenPlayWallpaper/src/macwindow.h)`

			`<div align="center">`

			`\| Plattform \| Windows 7 \| Windows 8/8.1 \| Windows 10 \| Gnome \| KDE \| XFCE \| MacOS \|`
			`\|------------------------ \|--------- \|------- \|------- \|--------- \|------- \|------- \| ------- \|`
			`\| __Wallpaper__ \| ❓ Help Needed! \| ❓ Help Needed! \| ✔ \| ❌ Help Needed! \| ❌ Help Needed! \|❌ Help Needed! \| ❓ (Basic implementation) Help Needed! \|`
Update README.md 2020-01-30 14:18:11 +01:00

			`</div>`