splashfetch

A terminal splash screen that displays a truecolor braille art logo alongside system info from neofetch.

Features

- Truecolor braille rendering for PNG images
- Automatic background detection and removal
- Side-by-side display with neofetch system info
- Intelligent caching for fast startup
- Configurable via environment variables

Installation

``bash
npm install -g splashfetch
`

$3

- Python 3.6+
- wcwidth (pip install wcwidth)
- neofetch (for system info display)
- ascii-image-converter (optional, for photo mode)

Usage

`bash
splashfetch
`

Or add to your .bashrc for terminal startup:

`bash
if command -v splashfetch &> /dev/null; then
splashfetch
fi
`

Configuration

All configuration is done through environment variables:

| Variable | Default | Description |
|----------|---------|-------------|
| SPLASHFETCH_IMAGE | bundled image | Path to custom image |
| SPLASHFETCH_RENDER | auto | Render mode: photo or silhouette |
| SPLASHFETCH_WIDTH_SCALE | 1.62 | Width multiplier for art |
| SPLASHFETCH_DIMS | auto | Explicit dimensions as W,H |
| SPLASHFETCH_GAP | 4 | Spaces between art and text |
| SPLASHFETCH_CACHE_ONLY | 0 | Use cached art only (faster startup) |
| SPLASHFETCH_BG_THRESHOLD | 22 | Background color similarity threshold |
| SPLASHFETCH_BG_PAD | 4 | Padding around detected foreground |
| SPLASHFETCH_LUMA_THRESHOLD | 6 | Luma threshold for braille dots |
| SPLASHFETCH_POST_BRIGHTNESS | 1.0 | Post-render brightness adjustment |

Render Modes

- silhouette: Uses internal truecolor braille renderer. Best for dark images with transparent/solid backgrounds. Automatically detects and removes background.
- photo: Uses ascii-image-converter with dithering. Best for photographs and complex images.

Cache

Rendered art is cached in ~/.cache/splashfetch/ for fast subsequent loads. The cache key includes image modification time and all rendering parameters.

To pre-warm the cache:

`bash
SPLASHFETCH_CACHE_ONLY=0 splashfetch
``

License

MIT