Skip to content

Installation

Dependencies

WayCast's dependencies are primarily based on Iced's dependencies, with additional requirements for the plugin system. For development and nix installations, the flake.nix takes care of these. If you're installing WayCast on a different system, make sure you have the following libraries available:

Iced requirements:

  • expat
  • fontconfig
  • freetype
  • freetype.dev
  • libGL
  • pkg-config
  • xorg.libX11
  • xorg.libXcursor
  • xorg.libXi
  • xorg.libXrandr
  • wayland
  • libxkbcommon

Plugin requirements:

  • glib (for file type detection and launching)

IMPORTANT NOTE FOR HYPRLAND

If you want waycast to start up even faster, remove the default "fade" animation hyprland adds to layer shell windows:

Nix

nix
layerrule = [
  "noanim, Waycast"
];

Other

layerrule = "noanim, Waycast";

Nix Flakes

Add to your flake.nix inputs:

nix
waycast.url = "git+https://gitgud.foo/thegrind/waycast";

Add the overlay:

nix
  overlays = [
    inputs.waycast.overlays.default
  ];

We also provide a home manager module.

Just the package:

nix
nixpkgs.overlays = [ inputs.waycast.overlays.default ];
environment.systemPackages = [ pkgs.waycast ];
# or for home-manager:
home.packages = [ pkgs.waycast ];

Nix Build

If you don't use Nix to manage your packages, you can still use it to build from source.

Just clone the repo and run:

sh
nix build .

Build from source

You'll need the rust toolchain as long as the dependencies outlined above. Then you can just run:

sh
cargo install