Contents
[top]
Description
The sddm theme is based on the KDE Breeze theme - Plasma workspace 5.12.3.
This sddm theme is using a semitransparent rectangle. The sddm texts are on the rectangle and moving out the sight when not needed.
- up when up arrow is pressed.
- down when the down arrow is pressed.
- mouse movement will trigger the down movement.
- after short inactivity the rectangle will slide out of sight.
The configuration is done by editing the theme.conf text file. Seven sample configuration files are included in the SampleConfFiles sub directory.
YouTube - Out of Box and tools:
The StandardBreezeWithSlidingCover.txt is having only the sliding cover over the Breeze Next wallpaper.
The StandardBreezeWithSlidingCoverAndBackgroundClock.txt will show the background clock when the sliding cover is out of sight.
YouTube - Simple and Ken Burns effect slideshow:
The Slideshow.txt will show image slideshow
The SlideshowWithKenBurnsEffect.txt will add the Ken Burns effect to the slideshow.
YouTube - Informative (?) slides with the CoverFlow:
The CoverFlow.txt shows wanted images as an animated slideshow
The JukeBox.txt plays video files as playlist.
The VideoBackgroundAlternativeButtons.txt is playing videoloop. This sample is having alternative icons for the suspend, reboot, shutdown and search buttons.
[top]
Optional tools
System Settings launcher
The Breeze slider has optional tools available in the 'Tools' sub directory. The user can activate them, if wanted, by copying the kcm_breeze_slider.desktop file to the $HOME/.local/share/kservices5/. If the $HOME/.local/share/kservices5/ directory doesn't exist the user can make it. The desktop file will add an external application to the KDE system settings.
The KDialog will offer a quick way to launch:
- file editor to edit the theme.conf.
- file manager in the breeze-slider directory.
- test button to launch the breeze-slider greeter in the test mode.
- show this readme file
The requirements for the optional tools:
- the greeter is installed: /usr/share/sddm/themes/breeze-slider/.
- KDialog is installed.
- xdg-open is installed.
- Konsole is installed.
KDE Service Menu
The video playlist option is using playlists to read the video files. The 'Tools' sub directory has a KDE service menu to wrap videos to the playlist. The user can activate it by copying the m3uwrapper.desktop file to the $HOME/.local/share/kservices5/ServiceMenus/. If the $HOME/.local/share/kservices5/ServiceMenus/ directory doesn't exist the user can make it. The desktop file will add a context menu to the KDE file manager / plasma folder view.
More of the m3uwrapper can be found from: KDE Forums - M3U.
[top]
Notes
Video bacground will need gstreamer plugins to play video/audio. To get possible error messages launch the SDDM theme from terminal.
Testing
You can test your themes using sddm-greeter. Note that in this mode, actions like shutdown, suspend or login will have no effect.
sddm-greeter --theme /path/to/you/theme
When you are testing a theme it will use your plasma (color etc) settings and your rights to access the files. These may not be same when the theme is executed as a login screen with the system (default) plasma settings.
The KDE SDDM configuration tool (kcm_sddm) is writing the settings to the theme.conf.user. Sometimes it will left the theme.conf.user dirty with partial data: YouTube - Out of Box. Either remove the theme.conf.user or clean the file.
The Video playlist player has an option to use mouse to change the playing video file and set the audio volume.
[top]
Configuration
The theme.conf file has key-value pairs:
color=red
Config keys
- Standard Breeze
- Sliding cover
- QML time/date format
- Background clocks
- Extra background
- SlideShow
- CoverFlow
- Video
- Video List
Standard Breeze
Standard Breeze theme configuration settings:
| Key | Example Value | Notes |
|---|---|---|
| type | color | Available: color, image |
| color | #1d99f3 | Color could be: an ARGB color value |
| background | Picture.jpg | image file name |
Sliding cover
| Key | Example Value | Notes |
|---|---|---|
| coverColor | #80000000 | More of the transparency: Hex transparency in colors |
| coverWaitTime | 180000 | cover will slide up after wait time - milliseconds |
| coverClock | components/StandardClock.qml | cover clock type: components/StandardClock.qml, components/ConfigurableClock.qml |
| coverClockTimeFormat | HH:mm:ss | configurable clock time format: Date QML Type |
| coverClockTimePointSize | 32 | configurable clock time point size |
| coverClocDateFormat | dd-MM-yyyy | configurable clock date format: Date QML Type |
| coverClockDatePointSize | 18 | configurable clock date point size |
| coverSuspenButton | system-suspend | Alternative icon - full path to icon file. |
| coverRebootButton | system-reboot | More of the icons: Breeze SDDM greeter icons |
| coverShutdownButton | system-shutdown | and even more: |
| coverSearchButton | system-search | full path to the icon file |
QML time/date format
Configurable clock time format: Date QML Type
| Expression | Output |
|---|---|
| h | the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display) |
| hh | the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display) |
| H | the hour without a leading zero (0 to 23, even with AM/PM display) |
| HH | the hour with a leading zero (00 to 23, even with AM/PM display) |
| m | the minute without a leading zero (0 to 59) |
| mm | the minute with a leading zero (00 to 59) |
| s | the second without a leading zero (0 to 59) |
| ss | the second with a leading zero (00 to 59) | AP or A | use AM/PM display. AP will be replaced by either "AM" or "PM". | ap or a | use am/pm display. ap will be replaced by either "am" or "pm". | t | the timezone (for example "CEST") |
Configurable clock date format: Date QML Type
| Expression | Output |
|---|---|
| d | the day as number without a leading zero (1 to 31) |
| dd | the day as number with a leading zero (01 to 31) |
| ddd | the abbreviated localized day name (e.g. 'Mon' to 'Sun'). |
| dddd | the long localized day name (e.g. 'Monday' to 'Sunday'). |
| M | the month as number without a leading zero (1 to 12) |
| MM | the month as number with a leading zero (01 to 12) |
| MMM | the abbreviated localized month name (e.g. 'Jan' to 'Dec'). |
| MMMM | the long localized month name (e.g. 'January' to 'December'). | yy | the year as two digit number (00 to 99) | yyyy | the year as four digit number. If the year is negative, a minus sign is prepended in addition. |
Background clock
| Key | Example Value | Notes |
|---|---|---|
| backgroundClock | BackgroundClocks/Blinkclock.qml | available: BackgroundClocks/Blinkclock.qml, BackgroundClocks/FixedClock.qml, BackgroundClocks/FloaterClock.qml |
| backgroundClockBackgroundColor | transparent | color of the clock background |
| backgroundClockX | 50 | X cordinate of the clock background top, left corner. Only with the FixedClock |
| backgroundClockY | 50 | Y cordinate of the clock background top, left corner. Only with the FixedClock |
| backgroundClockBackgroundRadius | 5 | background rectangle corner radius |
| backgroundClockTimeFormat | HH:mm:ss | clock time format: Date QML Type |
| backgroundClockTimePointSize | 32 | clock time font point size |
| backgroundClockTimeTextColor | white | clock time text color |
| backgroundClockDateFormat | dd-MM-yyyy | clock date format: Date QML Type |
| backgroundClockDatePointSize | 18 | clock date font point size |
| backgroundClockDateTextColor | lightgray | clock date text color |
Extra background
| Key | Example Value | Notes |
|---|---|---|
| extraBackground | SlideShow/SlideShow.qml | optional background type: SlideShow/SlideShow.qml, CoverFlow/main.qml, Video/SimplePlayer.qml, Video/DoublePlayer.qml, VideoList/VideoPlayList.qml |
More of the SimplePlayer and the DoublePlayer:
Slide Show
| Key | Example Value | Notes |
|---|---|---|
| slideKenBurns | 1 | slideshow type: 0 - simple slideshow, 1 - Ken Burns slideshow. More of the Ken Burns effect |
| slideBackgroundColor | black | slideshow background color |
| slideDuration | 7000 | how long one slide is shown - milliseconds |
| slideFillMode | Image.PreserveAspectFit | how to fill when the image has a different size than the view. Options: PreserveAspectFit, PreserveAspectCrop, Stretch. More of the fill mode |
| slideFiles | /usr/share/sddm/themes/breedze-slider/SlideFiles/ | path to the slide files |
| slideShuffle | 1 | are the files shuffled: 0 - no shuffle, 1 - file list is shuffled |
CoverFlow
| Key | Example Value | Notes |
|---|---|---|
| CoverFlowFolder | CoverImages | where the CoverFlow image files are |
| AutoMoveInterval | 2000 | how long before the cover flow is moving, milliseconds |
| NumberOfCovers | 5 | how many images shown at the time |
| CoverHeight | 75 | cover height, % of the view |
| CoverMargin | 10 | cover top margin, % |
| BackgroundColor | #353535 | CoverFlow background color |
| CoverFlowBackgroundImage | /usr/share/sddm/themes/breeze-slider2/CoverFlow/Background/stage.jpg | optional CoverFlow background image |
Video
| Key | Example Value | Notes |
|---|---|---|
| videoFile | VideoBackground/Rotating Earth at Night.mp4 | Video file to be played |
| videoFillMode | PreserveAspectCrop | how to fill when the video has a different size than the view. Options: PreserveAspectFit, PreserveAspectCrop, Stretch. More of the fill mode |
| videoVolume | 1.0 | audio volume 0.0..1.0 More of the volume |
Video list
| Key | Example Value | Notes |
|---|---|---|
| videoFile | VideoListBackground/Video-Playlist.m3u | Video list to be played |
| videoBackgroundColor | black | background color |
| videoVolume | 0.9 | audio volume 0.0..1.0 More of the volume |
| videoShuffle | 1 | are the files shuffled: 0 - no shuffle, 1 - shuffled at the start, 2 shuffled at the end |
| videoFillMode | PreserveAspectCrop | how to fill when the video has a different size than the view. Options: PreserveAspectFit, PreserveAspectCrop, Stretch. More of the fill mode |
| infoCorner | corner3 | show the file information in: corner0 - no infoCorner, corner1 - top left, corner2 - top right, corner3 - bottom right, corner4 - bottom left |
| infoTextBoxColor | #4d000000 | text background color |
| infoFontSize | 12 | font size |
| infoTextColor | white | text color |