# sysc-greet

- [sysc-greet](/docs): A graphical console greeter for greetd written in Go.
- Getting Started
  - [Installation](/docs/getting-started/installation): This guide covers installation methods for sysc-greet across different Linux distributions.
  - [Quick Start](/docs/getting-started/quick-start): Quick guide to get sysc-greet running on your system.
  - [Troubleshooting](/docs/getting-started/troubleshooting): Common issues and solutions for sysc-greet.
- Features
  - [Backgrounds & Effects](/docs/features/backgrounds-effects): sysc-greet includes animated background effects and ASCII text effects.
  - [ASCII Art Customization](/docs/features/ascii-art): Each session type can have its own ASCII art with multiple variants. Press Page Up/Down at the greeter to cycle through them.
  - [Wallpapers](/docs/features/wallpapers): sysc-greet supports two types of wallpapers: themed static images and custom wallpapers (including video backgrounds).
  - [Screensaver Configuration](/docs/features/screensaver): The login screen has a screensaver because waiting for authentication can be an aesthetic experience.
- Configuration
  - [Themes](/docs/configuration/themes): sysc-greet includes multiple color themes. Themes affect the entire color scheme of the greeter including backgrounds, borders, text, and accent ele...
  - [Backgrounds](/docs/configuration/backgrounds): sysc-greet supports background effects and wallpapers.
  - [Keyboard Layout](/docs/configuration/keyboard-layout): sysc-greet runs inside a compositor, so keyboard layout is set there.
- Compositors
  - [Niri Setup](/docs/compositors/niri): Configuration for running sysc-greet with the niri Wayland compositor.
  - [Cagebreak Setup](/docs/compositors/cagebreak): Cagebreak is a tiling kiosk compositor forked from Cage. It replaces Hyprland for the greetd greeter session, which is deprecated. Niri remains the default g...
  - [Sway Setup](/docs/compositors/sway): Configuration for running sysc-greet with the Sway Wayland compositor.
  - [Mango Setup](/docs/compositors/mango): Mango is a dwl-based tiling Wayland compositor. sysc-greet supports it as a greeter backend on Arch, Debian 13, Ubuntu 26.04, and Fedora 43/44.
  - [Hyprland Setup](/docs/compositors/hyprland): Hyprland greeter support is deprecated and unmaintained. It will be removed in a future release.
- Development
  - [Development Architecture](/docs/development/architecture): This document describes the architecture and design of sysc-greet.
  - [Building](/docs/development/building): Guide for building sysc-greet from source.
  - [Testing](/docs/development/testing): Guide for testing sysc-greet during development.