Installation

Arch Linux (AUR)

yay -S wayvid

Nix / NixOS

Direct run (no installation)

# Run wayvid-gui directly from GitHub
nix run github:YangYuS8/wayvid

# Run wayvid-ctl
nix run github:YangYuS8/wayvid#wayvid-ctl -- status

Install to profile

nix profile install github:YangYuS8/wayvid

NixOS configuration

Add to your flake.nix:

{
  inputs.wayvid.url = "github:YangYuS8/wayvid";
  
  # In your system configuration:
  environment.systemPackages = [
    inputs.wayvid.packages.${system}.default
  ];
}

Home Manager

home.packages = [
  inputs.wayvid.packages.${system}.default
];

AppImage

# Download
wget https://github.com/YangYuS8/wayvid/releases/latest/download/wayvid-x86_64.AppImage
chmod +x wayvid-x86_64.AppImage

# Run
./wayvid-x86_64.AppImage

From Source

Dependencies

# Arch
sudo pacman -S rust mpv wayland wayland-protocols libxkbcommon fontconfig mesa

# Ubuntu/Debian
sudo apt install cargo libmpv-dev libwayland-dev libxkbcommon-dev libfontconfig-dev libegl-dev

# Fedora
sudo dnf install cargo mpv-libs-devel wayland-devel libxkbcommon-devel fontconfig-devel mesa-libEGL-devel

Build

git clone https://github.com/YangYuS8/wayvid
cd wayvid
cargo build --release

Install (User)

Using the installation script (recommended):

./scripts/install.sh --user

This installs to ~/.local/bin/ and adds a desktop entry.

Install (System)

sudo ./scripts/install.sh --system

Manual Install

# User install
install -Dm755 target/release/wayvid-gui ~/.local/bin/wayvid-gui
install -Dm755 target/release/wayvid-ctl ~/.local/bin/wayvid-ctl
install -Dm644 packaging/wayvid-gui.desktop ~/.local/share/applications/wayvid.desktop
install -Dm644 logo.svg ~/.local/share/icons/hicolor/scalable/apps/wayvid.svg

# System install
sudo install -Dm755 target/release/wayvid-gui /usr/local/bin/wayvid-gui
sudo install -Dm755 target/release/wayvid-ctl /usr/local/bin/wayvid-ctl

Verify

wayvid-gui --version
wayvid-ctl --version

Autostart Configuration

Method 1: GUI Settings (Recommended)

Enable "Autostart" in Settings > General. This creates an XDG autostart entry at ~/.config/autostart/wayvid.desktop.

Method 2: niri spawn-at-startup

For niri users, add to ~/.config/niri/config.kdl:

spawn-at-startup "wayvid-gui" "--minimized"

Note: niri's systemd session also supports XDG autostart, so Method 1 works too.

Method 3: Hyprland exec-once

For Hyprland users, add to ~/.config/hypr/hyprland.conf:

exec-once = wayvid-gui --minimized

Method 4: Sway exec

For Sway users, add to ~/.config/sway/config:

exec wayvid-gui --minimized

Uninstall

# Using uninstall script
./scripts/uninstall.sh --user

# AUR
yay -R wayvid

# Nix
nix profile remove wayvid

# Manual cleanup
rm -rf ~/.config/wayvid ~/.cache/wayvid