shko-flake

A nix flake that packages the shko wayland compositor.

Installation

Add the flake to your /etc/nixos/flake.nix:

{
  inputs = {
    nixpkgs = "github:nixos/nixpkgs/nixos-unstable";

    shko = {
      url = "git+https://www.codeberg.org/polygonalbones/shko-flake";
      # Optional, but recommended
      inputs.nixpkgs.follows = "nixpkgs";
    };
  }

  # ...
}

Then you can use the package in your configuration.nix:

environment.systemPackages = [
  inputs.shko.packages.${system}.default
];

Usage

The package comes with two executables, the shko executable and a thin wrapper called shko-launch. Running the compositor with shko-launch is the recommended way of using shko, since it will call swc-launch shko for you.

Configuration

shko can be configured by overriding the configZig attribute in the package with your own custom config, like so:

environment.systemPackages = [
  (inputs.shko.packages.${system}.default.override {
    # Note: this can also be a string or a derivation. Look at ./nix/shko.nix for more info.
    configZig = ./my-shko-config.zig;
  })
];

(You can find the default config here for reference)