Skip to content

Quick Start

Quick Start

Quick guide to get sysc-greet running on your system.

Installation

curl -fsSL https://raw.githubusercontent.com/Nomadcxx/sysc-greet/master/install.sh | sudo bash

The interactive installer will guide you through: 1. Choosing your compositor (niri, hyprland, or sway) 2. Configuring compositor settings 3. Installing dependencies automatically

Manual Install

If you prefer manual setup, see Installation Guide.

First Launch

After installation, sysc-greet will start automatically when you boot your system.

To test the greeter without restarting:

sysc-greet --test

For fullscreen testing: 

kitty --start-as=fullscreen sysc-greet --test

Basic Usage

Login

  1. Enter your username (or press Tab to select session)
  2. Press Enter or Tab to advance to password field
  3. Enter your password
  4. Press Enter to login

Settings Menu (F1)

Press F1 to open settings menu. Navigate with Up/Down arrows: - Themes - Change color theme - Borders - Change border style - Backgrounds - Change background effects - ASCII Effects - Change text animation - Wallpaper - Select video wallpapers

Session Selection (F2)

Press F2 to open session dropdown. Use Up/Down to select a different session.

Power Menu (F4)

Press F4 to access power options: - Reboot - Shutdown - Cancel

Configuration

sysc-greet automatically saves your preferences: - Selected theme - Selected background effect - Selected border style - Selected wallpaper - Last used session (if username caching enabled)

Preferences are stored in /var/cache/sysc-greet/ and restored on next login.

Common Tasks

Change Theme 1. Press F1 2. Select Themes 3. Navigate to desired theme 4. Press Enter to apply

Set Video Wallpaper 1. Press F1 2. Select Wallpaper 3. Navigate to desired video file 4. Press Enter to apply

Cycle ASCII Art Variant 1. Press Page Up or Page Down 2. ASCII art changes to next/previous variant

For detailed configuration options, see Configuration section.