# CKGreeter: Just another greeter
### A simple GreetD greeter written in Rust.

---

## Installation

### Requirements
- GreetD
- A Wayland compositor, **cage** is used in the example

#### If building from source
- Rust/Cargo

## CKGreeter Install
#### Building from source
  - `sudo cargo install --git https://codeberg.org/CanadianBaconBoi/CKGreeter.git --bin ckgreeter --root /usr/bin`
#### or Prebuilt binary
  - `mkdir ./ckgreeter && cd ./ckgreeter` 
  - `wget https://codeberg.org/CanadianBaconBoi/CKGreeter/releases/download/v0.0.1/ckgreeter-linux-x86_64-v0.0.1.tgz`
  - `tar -xf ckgreeter-linux-x86_64-v0.0.1.tgz`
  - `sudo mv ckgreeter /usr/bin`
  - `sudo chown root:root /usr/bin/ckgreeter`
  - `sudo chmod 755 /usr/bin/ckgreeter`
### Setup Directories
  - `sudo mkdir -p /{etc,var/cache}/ckgreeter`
  - `sudo chown greetd:greetd /var/cache/ckgreeter`

### Configure GreetD
- Add the following line to `/etc/greetd/greetd.conf`
- `command = "cage -s -d -- /usr/bin/ckgreeter"`

## Configuration
The configuration file is located at `/etc/ckgreeter/config.toml`

Example configurations can be found in [examples/config/](examples/config)

The config needs to be copied to `/etc/ckgreeter/config.toml` before the greeter can be run.

## Screenshots
![CKGreeter, with search query 'slot canyon' and x/wayland session detection enabled](assets/screenshot1.png)
*CKGreeter, with search query 'slot canyon' and x/wayland session detection enabled*

## License
- **Commits on or after 17.06.2026:** Licensed under the [Functional Source License, Version 1.1, MIT Future License](LICENSE.md).
- **Prior unlicensed commits (before 17.06.2026):** Copyright (c) 2026 CanadianBaconBoi. All rights reserved.
