Files
omarchycn/manual/41-branding.md
T
David Heinemeier HanssonandClaude Fable 5 e7ea031f98 Host the manual's images in the repo under manual/images (#6861)
* Host the manual's images in the repo under manual/images

Replaces all learn.omacom.io/manual.omakub.org hotlinks with local webp
files capped at 1600px wide (~20MB total), so the manual is fully
self-contained. Theme and unlock previews are converted from the
canonical themes/*/preview.png files. A handful of illustration shots
are interim conversions of the current images, pending retakes.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* Retake the illustration screenshots fresh at 3x scaling

Navigation, clipboard history, notices, tmux layouts, prompt, and About
reshot on a clean workspace at 3.13x (1920x1080 logical on 6K) across
ten themes: Tokyo Night, Catppuccin, Gruvbox, Kanagawa, Everforest,
Nord, Osaka Jade, Rose Pine, Matte Black, and Ristretto.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* Drop the extra themes chapter from the manual

The community theme gallery will live elsewhere. Removes the chapter
and its 114 gallery images, renumbers the following chapters, and
repoints the two references (theme installs still work via
Install > Style > Theme in the menu).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* Reference the shipped theme previews instead of copying them

The themes chapter now points straight at themes/*/preview.png and
preview-unlock.png, so previews can never drift from the source and
manual/images drops from 6.3MB to 3.5MB.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-08-14 12:47:38 +02:00

2.5 KiB

Branding

Omarchy allows you to set your company logo or personal image for both the boot unlock, the screensaver, and the about screen.

Boot unlock

You can use omarchy plymouth preview to see what your custom logo and colors would look like. It takes a background color, a text color, a logo png, and a path for the preview image:

omarchy plymouth preview '#1d2021' '#ebdbb2' logo.png preview.png

Then apply the setup with omarchy plymouth set '#1d2021' '#ebdbb2' logo.png, which will also give the SDDM login screen the same colors and logo. If you want to revert, you can use omarchy plymouth reset.

branding-plymouth-shopify

Screensaver

You can change the logo used for the screensaver under Style > Screensaver. It's an ASCII logo, so you can edit the text directly, but you can also hand it a png or svg image, and we'll convert that to ASCII. It looks pretty cool.

branding-screensaver

There are three entries in that menu:

  • Edit Text opens ~/.config/omarchy/branding/screensaver.txt in your editor. Type or paste whatever you like — ASCII art, your name, a rude word. Save and quit, and the screensaver fires up immediately so you can see it.
  • Set From Image opens a file picker for a png or svg, converts it to ASCII, and shows you the result. Logos with a clear silhouette work far better than photos.
  • Restore Default puts the Omarchy logo back.

About screen

The same three options are under Style > About for the About screen you get from the Omarchy menu, and they work identically — the file is ~/.config/omarchy/branding/about.txt, and the About window pops up after each change. The About art is converted to a smaller size than the screensaver's, since it has to fit in a window rather than fill your display.

branding-about

Converting images yourself

Both of the Set From Image options are just calling omarchy transcode ascii, which you can run directly if you want control over the conversion:

omarchy transcode ascii ~/logo.svg ~/.config/omarchy/branding/screensaver.txt --width 100

It takes --width and --height in terminal columns and rows, a --mode of either braille (the default, and much finer) or block, a --threshold percentage for deciding which pixels count as part of the logo, and --invert for when your logo is light on a dark background. If a conversion comes out as a blob, the threshold is usually the knob to turn.