Project Architecture
Overview
ScreenPlay uses a separate ScreenPlayWallpaper app to display the wallpaper. This has the advantage that if the wallpaper crashes, the main ScreenPlay app won't crash. ScreenPlay consists of 9 projects:
- ScreenPlay (Executable)
- The main ScreenPlay App UI with Create, Installed, Community and Settings.
- ScreenPlayWallpaper (Executable)
- The Wallpaper executable that is used for displaying a single wallpaper. This uses ScreenPlaySDK to talk via QLocalsockets with the main ScreenPlayApp.
- ScreenPlayWidget (Executable)
- The Widget executable that is used for displaying a single widget. This uses ScreenPlaySDK to talk via QLocalsockets with the main ScreenPlayApp.
- ScreenPlayUtil (Libray)
- Util function, like project.json loading, that are needed in ScreenPlay and Workshop plugin.
- ScreenPlaySDK (Libray)
- A SDK used internally in the ScreenPlayWallpaper and ScreenPlayWidget to talk to the main ScreenPlay app via QLocalsockets (Windows Pipes and Unix sockets).
- ScreenPlayShader (Libray)
- A collection of reusable shader (work in progress)
- ScreenPlaySysInfo (Libray)
- A qml plugin to read CPU, GPU, Network and all sort of statisitcs.
- ScreenPlayWeather (Libray)
- A qml plugin to display weather infos.
- ScreenPlayWorkshop (Libray)
- The Steam workshop plugin that is loaded at runtime.
ScreenPlay App Class
ScreenPlay main applications wrapps all classes into a App.h and App.cpp class. This is easier for unit test integration. The main app class is used for owning all other classes via Q_PROPERTY to be easily accessible in the GUI/QML. We use the constructor of the App class to initialize all Qt register types, fonts and to check if another ScreenPlay instance is running. The init() method is used to initialize all other c++ classes in a certain order! It also sets up some events signal/slots like when the user changes the UI language.
For all other class documentation please visit ScreenPlayDeveloperDocs