Project Layout (Where Things Live)

This section outlines Branding Assets in the Omarchy repository: where they reside, how they are installed, and how they are used throughout the application.

Table of Contents

• Branding Assets Overview
• Repository Layout
• Installation Process
• Asset Details
• Usage and Integration

Branding Assets Overview

Omarchy includes two plain-text branding assets:

• icon.txt: ASCII art or icon text for “About” dialogs and status displays.
• logo.txt: ASCII art logo for the screensaver and splash screens.

These files enable a consistent, text-based branding experience in various Omarchy components.

Repository Layout

The branding assets live in the root of the Omarchy repository. When you clone the project (typically into ~/.local/share/omarchy), you will find:

/path/to/omarchy/
├── icon.txt       ← About-dialog ASCII art
├── logo.txt       ← Screensaver ASCII art
├── install/
│   └── config/
│       └── branding.sh
├── config/
│   └── fastfetch/
│       └── config.jsonc
└── bin/
    └── omarchy-cmd-screensaver

Installation Process

The install/config/branding.sh script handles copying these assets into the user’s configuration directory:

#!/bin/bash
# Allow the user to change the branding for fastfetch and screensaver
mkdir -p ~/.config/omarchy/branding
cp ~/.local/share/omarchy/icon.txt ~/.config/omarchy/branding/about.txt
cp ~/.local/share/omarchy/logo.txt ~/.config/omarchy/branding/screensaver.txt

Location: install/config/branding.sh

Migration Scripts

On upgrades, Omarchy runs migrations to ensure branding assets stay in sync:

• Copy logo.txt for screensaver personalization (1755867743.sh)
• Copy icon.txt for Fastfetch “About” section (1755904244.sh)

These migrations recreate ~/.config/omarchy/branding/screensaver.txt and about.txt from the upstream assets.

Asset Details

Usage and Integration

• Fastfetch Configuration
  The Fastfetch JSON config references the About asset as its logo source:

  {
    "$schema": "...",
    "logo": {
      "type": "file",
      "source": "~/.config/omarchy/branding/about.txt",
      "color": { "1": "green" },
      "padding": { "top": 2, "right": 6, "left": 2 }
    },
    …
  }
  

  Location: config/fastfetch/config.jsonc

• Screensaver Script (omarchy-cmd-screensaver)
  The screensaver harnesses TTE to render the ASCII art from screensaver.txt. Users can invoke:

  omarchy-launch-screensaver
  

  or toggle it via the Omarchy menu, which in turn runs:

  tte --frame-rate 240 --canvas-width 0 --anchor-text c \
    ~/.config/omarchy/branding/screensaver.txt <effect>
  

  (For brevity, see bin/omarchy-cmd-screensaver for full implementation.)

• Interactive Editing
  Omarchy’s TUI allows users to edit branding assets on-the-fly:

  • Screensaver: edit_in_nvim ~/.config/omarchy/branding/screensaver.txt
  • About: edit_in_nvim ~/.config/omarchy/branding/about.txt
    Users can customize their ASCII art without re-running the installer.

By consolidating all branding assets under ~/.config/omarchy/branding, Omarchy ensures a clear separation between source assets and user-modifiable configurations, simplifying theme and branding management.