Plymouth boot splash theme for Debian: the Debian swirl above a thin bar with a glowing highlight that slides left and right while the system boots and fills the bar when the boot is done. The whole splash is scaled to the screen, so it has the same proportions on a 1366x768 laptop and on a 4K monitor.
| situation | on screen |
|---|---|
| boot | swirl, sliding highlight; the whole bar lights up when the display manager starts |
| shutdown, reboot | swirl, sliding highlight; no fill at the end |
encrypted disk, plymouth ask-for-password |
swirl stays, the bar is replaced by a box with a lock and one bullet per character; the prompt below, a caps lock warning when it is on |
plymouth ask-question |
same box, the typed text instead of bullets; the start is cut off when it does not fit |
plymouth message, fsck output |
one centred line below the bar (or below the prompt), cut with "…" when wider than the screen |
| package, system or firmware updates | title and subtitle above the swirl, a real progress bar in place of the highlight, percent below |
plymouthandplymouth-label(text rendering for prompts, messages and titles)python3only if you want to re-render the images or runmake checkplymouth-x11only for previewing the theme from a running desktop
The theme asks for the generic Sans family. Debian's initramfs hook copies
only the system default font (fc-match without a family) into the
initramfs, so Sans gives the same font at boot and at shutdown and no extra
font packages are needed.
git clone https://github.com/nuxster/debian-slider.git
cd debian-slider
sudo make apply-now # install, set as default, rebuild the initramfsOther targets (make help lists them):
| target | what it does |
|---|---|
make check |
validate the theme files, no root needed |
make render |
regenerate theme/images/ (RENDER_FLAGS="--color 3b82f6" for options) |
make logo |
re-render src/logo.png from src/logo.svg (needs librsvg or ImageMagick) |
make install |
copy the files only (the images listed in IMAGES); honours DESTDIR and PREFIX |
make apply |
install and set as default without touching the initramfs |
make apply-now |
apply and rebuild the initramfs |
make uninstall |
remove the theme from /usr/share/plymouth/themes |
make preview |
show the current default theme for a few seconds |
sudo apt install plymouth-x11
sudo make preview # PREVIEW_SECONDS=15 to keep it longerTo see the password dialog, run in a second terminal while the preview is up:
sudo plymouth ask-for-password --prompt="Unlock disk"The debian/ directory builds a plymouth-theme-debian-slider package. The
package only installs the files; pick the theme afterwards with
plymouth-set-default-theme -R debian-slider.
sudo apt install debhelper
dpkg-buildpackage -us -uc -b
sudo apt install ../plymouth-theme-debian-slider_*.debPlymouth's two-step module draws images at their pixel size, so a bitmap
theme is large on a small screen and tiny on a large one. This theme uses the
script module instead: theme/debian-slider.script lays everything out on a
300x300 "design" canvas and scales that canvas to 30 % of the screen height
(the smallest screen's, if several are connected). The scale is snapped down
to quarter steps, so the splash never exceeds that size, and a 1080p screen
gets exactly 1x and a 4K screen exactly 2x with no resampling at all. Text is
rendered at a font size scaled the same way.
Scaling one bitmap up looks blurry, so the images are shipped in two sets,
theme/images/1x and theme/images/2x; the script picks the smallest set that
is not smaller than the wanted size and shrinks it. The sets are identical in
content, 2x is exactly twice the size of 1x:
| file | 1x | what it is |
|---|---|---|
logo.png |
121x150 | the swirl |
track.png |
250x5 | the bar |
highlight-left/right.png |
3x5 | the rounded ends of the highlight |
highlight-mid.png |
1x5 | one column of its middle, stretched to the wanted width |
glow-left/right.png |
80x64 | the two halves of the highlight's glow |
glow-mid.png |
1x64 | one column of the glow's flat middle, stretched like the highlight |
tail-left/right.png |
35x5 | the faint tails the highlight bleeds along the track |
dialog.png |
340x33 | password box with the lock glyph |
bullet.png |
10x10 | one password bullet |
capslock.png |
24x28 | caps lock warning |
There are no frame sequences: the script moves and resizes sprites. The
highlight is three sprites, its two rounded ends and a one pixel column of its
middle that Image.Scale stretches to any width; the glow is built the same
way from its two halves and a column of its flat middle. Sliding the
highlight only moves the sprites (at refresh_rate ticks per second, so it
is as smooth as the refresh rate), the end-of-boot fill and the update-mode
progress bar stretch the middle columns, and the result is pixel for pixel
what a rendered frame of that width would be. The tails are squeezed with
Image.Scale when the highlight gets close to an end of the track.
The pieces are shipped as separate files rather than cut from one image at
run time because plymouth's Image.Crop blends onto a transparent buffer,
which darkens translucent pixels and would dim the glow.
Plymouth applies its own 2x factor on HiDPI panels (small screens with a very high pixel density) before the script sees the screen size; that is expected and the same for every plymouth theme.
Everything except the swirl is drawn by tools/render.py, which needs only
python3. The swirl is read from src/logo.png, a 600 px raster of
src/logo.svg; edit the fill colour in the SVG and run make logo to
recolour it. Bar colours, size, glow and frame counts are command line
options:
python3 tools/render.py --help
python3 tools/render.py --color 3b82f6 --bar-color 222222 # blue slider
python3 tools/render.py --scales 1 2 3 # extra 3x set for huge screens
make checkAfter adding a set, list it in image_sets at the top of the script.
The settings block at the top of theme/debian-slider.script holds:
canvas_fraction(0.30): canvas height as a fraction of the screen heightscale_step,scale_min: snapping of the scalethrobber_period: seconds for one left-right-left sweep of the highlightrefresh_rate(60): script ticks per second; the highlight moves every tick, and the end-of-boot frame reaches the screen at the next oneend_units: systemd units whose start ends the boot and fills the barimage_sets: the<S>xdirectories available underimages/font_family,font_size,title_size,text_colortext_width(0.9): status lines wider than this fraction of the smallest screen are cut with an ellipsistitles: title and subtitle for the update modesdesign.*: geometry in design units, must matchtools/render.py
make check (tools/check.py) verifies the .plymouth file, that the script
and every image it references exist, that no set holds images the script
never loads, that the IMAGES list make install copies matches the script,
that the pieces of the bar fit together and that every set is an exact
multiple of 1x. It runs without plymouth, so
it cannot execute the script; use make preview for that.
theme/debian-slider.plymouth theme descriptor (ModuleName=script)
theme/debian-slider.script layout, animation, dialog and update-mode logic
theme/images/1x, 2x rendered image sets
src/logo.svg, src/logo.png the swirl, vector and 600 px raster
tools/render.py renders theme/images from src/logo.png
tools/check.py validates the theme
tools/pngio.py tiny PNG reader/writer used by both
debian/ Debian packaging
- Plymouth's
scriptmodule has no end-of-boot hook, and its quit function runs only after plymouth has stopped drawing, so nothing drawn there is ever seen. GDM and LightDM also runplymouth deactivatethe moment they start andplymouth quit --retain-splashonly once the greeter is up, so the splash freezes for those seconds. The theme therefore lights up the whole bar when systemd reportssystemd-user-sessions.servicestarting, the unit every display manager is ordered after (end_unitsin the script also lists the display managers themselves as fallbacks). Only a few dozen milliseconds are left at that point, which is why the fill is a single frame and not an animation: an animation would freeze half way. The oldtwo-stepversion of this theme could play a long end animation because plymouth waits fortwo-step's end animation before deactivating; thescriptmodule gets no such chance. - Debian's initramfs hook drops a "Debian NN" wordmark into
two-stepthemes only; this theme is not affected. - The
scriptmodule cannot show the keyboard layout indicator thattwo-stepthemes have; only the caps lock warning is shown. - Plymouth's
scriptmodule draws one set of sprites and shows it centred on every monitor, so the splash cannot be sized per screen. The theme sizes it for the smallest screen: with a 4K and a Full HD monitor both get the 1x layout, which is small on the 4K but does not overflow the Full HD one.
Code and configuration are under the MIT license. The Debian swirl is the Debian Open Use Logo, licensed under the LGPL-3+ or CC-BY-SA 3.0. See LICENSE. Debian is a registered trademark of Software in the Public Interest, Inc.; this theme is not affiliated with the Debian project.
