Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/nix-community/nixpkgs-wayland

Automated, pre-built packages for Wayland (sway/wlroots) tools for NixOS. [maintainers=@colemickens, @Artturin]
https://github.com/nix-community/nixpkgs-wayland
nixos nixpkgs sway tiling-window-manager wayland wlroots
Last synced: 7 days ago
JSON representation
Automated, pre-built packages for Wayland (sway/wlroots) tools for NixOS. [maintainers=@colemickens, @Artturin]
Host: GitHub
URL: https://github.com/nix-community/nixpkgs-wayland
Owner: nix-community
Created: 2018-10-24T01:30:44.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2024-12-03T19:18:29.000Z (10 days ago)
Last Synced: 2024-12-03T20:26:58.725Z (10 days ago)
Topics: nixos, nixpkgs, sway, tiling-window-manager, wayland, wlroots
Language: Nix
Homepage:
Size: 6.6 MB
Stars: 524
Watchers: 10
Forks: 45
Open Issues: 47
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

awesome-nix - nixpkgs-wayland - Bleeding-edge Wayland packages. (Overlays / Webinterface)
README

        # nixpkgs-wayland

[![Build](https://github.com/nix-community/nixpkgs-wayland/actions/workflows/build.yaml/badge.svg)](https://github.com/nix-community/nixpkgs-wayland/actions/workflows/build.yaml)

[![Update](https://github.com/nix-community/nixpkgs-wayland/actions/workflows/update.yaml/badge.svg)](https://github.com/nix-community/nixpkgs-wayland/actions/workflows/update.yaml)

[![Advance](https://github.com/nix-community/nixpkgs-wayland/actions/workflows/advance.yaml/badge.svg)](https://github.com/nix-community/nixpkgs-wayland/actions/workflows/advance.yaml)

## overview

Automated, pre-built, (potentially) pre-release packages for Wayland (sway/wlroots) tools for NixOS (**nixos-unstable** channel).

These packages are auto-updated to the latest version available from their upstream source control. This means this overlay and package

set will often contain **unreleased** versions.

Community chat is on Matrix: [#nixpkgs-wayland:matrix.org](https://matrix.to/#/#nixpkgs-wayland:matrix.org). We are not on Libera.

Started by: [**@colemickens**](https://github.com/colemickens)

and co-maintained by [**@Artturin**](https://github.com/Artturin) (🙏).

- [overview](#overview)

- [Usage](#usage)

  - [Binary Cache](#binary-cache)

  - [Continuous Integration](#continuous-integration)

  - [Flake Usage](#flake-usage)

  - [Install for NixOS (non-flakes, manual import)](#install-for-nixos-non-flakes-manual-import)

  - [Install for non-NixOS users](#install-for-non-nixos-users)

- [Packages](#packages)

- [Tips](#tips)

    - [General](#general)

    - [`sway`](#sway)

    - [Nvidia Users](#nvidia-users)

- [Development Guide](#development-guide)

## Usage

### Binary Cache

The [Cachix landing page for `nixpkgs-wayland`](https://nixpkgs-wayland.cachix.org) shows how to utilize the binary cache.

Packages from this overlay are regularly built against `nixos-unstable` and pushed to this cache.

### Continuous Integration

We have multiple CI jobs:

1. Update - this tries to advance nixpkgs and upgrade all packages. If it can successfully build them, the updates are push to master.

2. Advance - this tries to advance nixpkgs without touching the packages. This can help show when nixpkgs upgrades via `nixos-unstable` has advanced

   into a state where we are broken building against it.

3. Build - this just proves that `master` was working against `nixos-unstable` at the point in time captured by whatever is in `flake.lock` on `master`.

We don't have CI on Pull Requests, but I keep an eye on it after merging external contributions.

### Flake Usage

- Build and run [the Wayland-fixed up](https://github.com/obsproject/obs-studio/pull/2484) version of [OBS-Studio](https://obsproject.com/):

  ```

  nix shell "github:nix-community/nixpkgs-wayland#obs-studio" --command obs

  ```

- Build and run `waybar`:

  ```

  nix run "github:nix-community/nixpkgs-wayland#waybar"

  ```

* Use as an overlay or package set via flakes:

  ```nix

  {

    inputs = {

      nixpkgs-wayland.url = "github:nix-community/nixpkgs-wayland";

      # only needed if you use as a package set:

      nixpkgs-wayland.inputs.nixpkgs.follows = "nixpkgs";

    };

    outputs = inputs: {

      nixosConfigurations."my-laptop-hostname" =

      let system = "x86_64-linux";

      in nixpkgs.lib.nixosSystem {

        inherit system;

        modules = [({pkgs, config, ... }: {

          config = {

            nix.settings = {

              # add binary caches

              trusted-public-keys = [

                "cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY="

                "nixpkgs-wayland.cachix.org-1:3lwxaILxMRkVhehr5StQprHdEo4IrE8sRho9R9HOLYA="

              ];

              substituters = [

                "https://cache.nixos.org"

                "https://nixpkgs-wayland.cachix.org"

              ];

            };

            # use it as an overlay

            nixpkgs.overlays = [ inputs.nixpkgs-wayland.overlay ];

            # or, pull specific packages (built against inputs.nixpkgs, usually `nixos-unstable`)

            environment.systemPackages = [

              inputs.nixpkgs-wayland.packages.${system}.waybar

            ];

          };

        })];

      };

    };

  }

  ```

### Install for NixOS (non-flakes, manual import)

If you are not using Flakes, then consult the [NixOS Wiki page on Overlays](https://nixos.wiki/wiki/Overlays). Also, you can expand this section for a more literal, direct example. If you do pin, use a tool like `niv` to do the pinning so that you don't forget and wind up stuck on an old version.

```nix

{ config, lib, pkgs, ... }:

let

  rev = "master"; # 'rev' could be a git rev, to pin the overlay.

  url = "https://github.com/nix-community/nixpkgs-wayland/archive/${rev}.tar.gz";

  waylandOverlay = (import "${builtins.fetchTarball url}/overlay.nix");

in

  {

    nixpkgs.overlays = [ waylandOverlay ];

    environment.systemPackages = with pkgs; [ wayvnc ];

    # ...

  }

```

You could write that to a file `./wayland.nix` next to your `configuration.nix` and then use it like so:

```nix

{ config, lib, pkgs, ... }:

  {

    # ...

    imports = [

      # ...

      ./wayland.nix

    ];

  }

```

### Install for non-NixOS users

Non-NixOS users have many options, but here are two explicitly:

1. Activate flakes mode, then just run them outright like the first example in this README.

2. See the following details block for an example of how to add `nixpkgs-wayland` as a user-level

   overlay and then install a package with `nix-env`.

1. There are two ways to activate an overlay for just your user:

   1. Add a new entry in ``~/.config/nixpkgs/overlays.nix`:

    ```nix

    let

      url = "https://github.com/nix-community/nixpkgs-wayland/archive/master.tar.gz";

    in

    [

      (import "${builtins.fetchTarball url}/overlay.nix")

    ]

    ```

   2. Add a new file under a dir, `~/.config/nixpkgs/overlays/nixpkgs-wayland.nix`:

    ```nix

    let

      url = "https://github.com/nix-community/nixpkgs-wayland/archive/master.tar.gz";

    in

      (import "${builtins.fetchTarball url}/overlay.nix")

    ```

  Note, this method does not pin `nixpkgs-wayland`. That's left to the reader. (Just use flakes...)

2. Then, `nix-env` will have access to the packages:

```nix

nix-env -iA neatvnc

```

## Packages

| Package | Description |

| --- | --- |

| [aml](https://github.com/any1/aml) | Another main loop |

| [cage](https://github.com/Hjdskes/cage) | Wayland kiosk that runs a single, maximized application |

| [drm_info](https://github.com/ascent12/drm_info) | Small utility to dump info about DRM devices |

| [dunst](https://github.com/dunst-project/dunst) | Lightweight and customizable notification daemon |

| [eww](https://github.com/elkowar/eww) | Widget system made in Rust to create widgets for any WM |

| [foot](https://codeberg.org/dnkl/foot/) | Fast, lightweight and minimalistic Wayland terminal emulator |

| [freerdp3](https://www.freerdp.com/) | A Remote Desktop Protocol Client |

| [gebaar-libinput](https://github.com/Osleg/gebaar-libinput-fork) | Gebaar, A Super Simple WM Independent Touchpad Gesture Daemon for libinput |

| [glpaper](https://hg.sr.ht/~scoopta/glpaper) | Wallpaper program for wlroots based Wayland compositors such as sway that allows you to render glsl shaders as your wallpaper |

| [grim](https://github.com/emersion/grim) | Grab images from a Wayland compositor |

| [gtk-layer-shell](https://github.com/wmww/gtk-layer-shell) | Library to create panels and other desktop components for Wayland using the Layer Shell protocol |

| [i3status-rust](https://github.com/greshake/i3status-rust) | Very resource-friendly and feature-rich replacement for i3status |

| [imv](https://git.sr.ht/~exec64/imv) | Command line image viewer for tiling window managers |

| [kanshi](https://git.sr.ht/~emersion/kanshi) | Dynamic display configuration tool |

| [lavalauncher](https://git.sr.ht/~leon_plickat/lavalauncher) | Simple launcher panel for Wayland desktops |

| [libvncserver_master](https://github.com/LibVNC/libvncserver) | VNC server library |

| [mako](https://github.com/emersion/mako) | Lightweight Wayland notification daemon |

| [neatvnc](https://github.com/any1/neatvnc) | VNC server library |

| [new-wayland-protocols](https://gitlab.freedesktop.org/wayland/wayland-protocols/) | Wayland protocol extensions |

| [obs-wlrobs](https://hg.sr.ht/~scoopta/wlrobs) | Obs-studio plugin that allows you to screen capture on wlroots based wayland compositors |

| [rootbar](https://hg.sr.ht/~scoopta/rootbar) | Bar for Wayland WMs |

| [salut](https://gitlab.com/snakedye/salut) | A sleek notification daemon |

| [shotman](https://git.sr.ht/~whynothugo/shotman) | Uncompromising screenshot GUI for Wayland compositors |

| [sirula](https://github.com/DorianRudolph/sirula) | Simple app launcher for wayland written in rust |

| [slurp](https://github.com/emersion/slurp) | Select a region in a Wayland compositor |

| [sway-unwrapped](https://github.com/swaywm/sway) | I3-compatible tiling Wayland compositor |

| [swaybg](https://github.com/swaywm/swaybg) | Wallpaper tool for Wayland compositors |

| [swayidle](https://github.com/swaywm/swayidle) | Idle management daemon for Wayland |

| [swaylock](https://github.com/swaywm/swaylock) | Screen locker for Wayland |

| [swaylock-effects](https://github.com/jirutka/swaylock-effects) | Screen locker for Wayland |

| [swww](https://github.com/Horus645/swww) | Efficient animated wallpaper daemon for wayland, controlled at runtime |

| [waybar](https://github.com/Alexays/Waybar) | Highly customizable Wayland bar for Sway and Wlroots based compositors |

| [waypipe](https://gitlab.freedesktop.org/mstoeckl/waypipe/) | Network proxy for Wayland clients (applications) |

| [wayprompt](https://git.sr.ht/~leon_plickat/wayprompt) | multi-purpose prompt tool for Wayland |

| [wayvnc](https://github.com/any1/wayvnc) | VNC server for wlroots based Wayland compositors |

| [wbg](https://codeberg.org/dnkl/wbg) | Wallpaper application for Wayland compositors |

| [wdisplays](https://github.com/artizirk/wdisplays) | Graphical application for configuring displays in Wayland compositors |

| [wev](https://git.sr.ht/~sircmpwn/wev) | Wayland event viewer |

| [wf-recorder](https://github.com/ammen99/wf-recorder) | Utility program for screen recording of wlroots-based compositors |

| [wl-clipboard](https://github.com/bugaevc/wl-clipboard) | Command-line copy/paste utilities for Wayland |

| [wl-gammarelay-rs](https://github.com/MaxVerevkin/wl-gammarelay-rs) | A simple program that provides DBus interface to control display temperature and brightness under wayland without flickering  |

| [wlay](https://github.com/atx/wlay) | Graphical output management for Wayland |

| [wldash](https://wldash.org) | Wayland launcher/dashboard |

| [wlogout](https://github.com/ArtsyMacaw/wlogout) | Wayland based logout menu |

| [wlr-randr](https://git.sr.ht/~emersion/wlr-randr) | Xrandr clone for wlroots compositors |

| [wlroots](https://gitlab.freedesktop.org/wlroots/wlroots/) | Modular Wayland compositor library |

| [wlsunset](https://git.sr.ht/~kennylevinsen/wlsunset) | Day/night gamma adjustments for Wayland |

| [wlvncc](https://github.com/any1/wlvncc) | A Wayland Native VNC Client |

| [wob](https://github.com/francma/wob) | Lightweight overlay bar for Wayland |

| [wofi](https://hg.sr.ht/~scoopta/wofi) | Launcher/menu program for wlroots based wayland compositors such as sway |

| [wshowkeys](https://github.com/ammgws/wshowkeys) | Displays keys being pressed on a Wayland session |

| [wtype](https://github.com/atx/wtype) | xdotool type for wayland |

| [xdg-desktop-portal-wlr](https://github.com/emersion/xdg-desktop-portal-wlr) | xdg-desktop-portal backend for wlroots |

## Tips

#### General

- I recommend using [`home-manager`](https://github.com/rycee/home-manager/)!

- It has modules and options for:

  - `sway`

  - `waybar`

  - `obs` and plugins!

  - more!

#### `sway`

- You will likely want a default config file to place at `$HOME/.config/sway/config`. You can use the upstream default as a starting point: https://github.com/swaywm/sway/blob/master/config.in

- If you start `sway` from a raw TTY, make sure you use `exec sway` so that if sway crashes, an unlocked TTY is not exposed.

#### Nvidia Users

- Everything should just work now (aka, wlroots/sway don't need patching).

- This is a known-good working config, at least at one point in time:

  [mixins/nvidia.nix@ccd992](https://github.com/cole-mickens/nixcfg/blob/cdd9929d5d36ce5b4d64cf80bdeb1df3f2cba332/mixins/nvidia.nix)

## Development Guide

- Use `nix develop`

- `./main.nu`:

  - `./main.nu build` - builds and caches derivations that don't exist in the cache, use `nix-eval-jobs`

  - `./main.nu advance` - advances the flake inputs, runs `main build`

  - `./main.nu update` - advances the flake inputs, updates pkg revs, runs `main build`

- `build` pushes to the `nixpkgs-wayland` cachix

If for some reason the overlay isn't progressing and you want to help,

just clone the repo, run `nix develop -c ./main.nu update`