amane

Amane is a Rust library for building Wayland desktop shells, like bars, panels and launchers. You write your shell in plain Rust, and the amane CLI builds and runs it for you.

Keep in mind, Amane is still early (0.1) and experimental, so things will break and change.

Documentation

The full guide is at mystiafin.github.io/amane. It walks you from your first shell through layout, widgets, input and animation, plus the built-in services for audio, network, bluetooth, notifications and workspaces.

The guide's source is in docs/. To read it offline, serve it with mdBook:

mdbook serve docs --open

Installation

Before installing, check that you have what a shell needs to run:

• a Wayland compositor that supports wlr-layer-shell, for example niri, Hyprland or Sway. GNOME doesn't support it, so Amane won't work there.

Manual installation

1. Install Rust

You need a Rust toolchain with cargo. Cargo has to stay on your PATH after the install, because amane dev, amane compile and amane run call cargo to build your config.

2. Run the install script

Clone the repo and run install.sh. It installs the system libraries Amane needs with pacman, apt or dnf, then installs the CLI with cargo install --path cli:

git clone https://github.com/MystiaFin/amane.git
cd amane
./install.sh

If your distro uses another package manager, the script stops and lists what to install yourself: a C compiler, pkg-config, wayland, libxkbcommon, fontconfig, freetype, expat, vulkan-loader, libpulseaudio and linux-pam, with their headers. After that, run cargo install --path cli.

This puts amane in ~/.cargo/bin, so make sure that folder is on your PATH too.

NixOS (flake)

Add amane to your flake inputs, then add its package to your system packages:

inputs.amane.url = "github:MystiaFin/amane";

environment.systemPackages = [ inputs.amane.packages.x86_64-linux.default ];

or install it into your profile:

nix profile install github:MystiaFin/amane

Commands

Your shell lives in ~/.config/amane/src/main.rs. If you set XDG_CONFIG_HOME, Amane uses $XDG_CONFIG_HOME/amane instead.

amane startup

Creates ~/.config/amane/src/main.rs with a small starter shell. If that file already exists, it stops with an error, so it never overwrites your shell.

amane startup

amane dev

Builds your shell, starts it, and then rebuilds and restarts it every time you save. If a build fails, the old shell keeps running while you fix the error.

amane dev

amane compile

Builds the optimised shell, without starting it.

amane compile

amane run

Compiles the optimised shell, then starts it. If nothing changed since the last compile, cargo finishes right away and the shell starts straight away.

amane run

Example

This is the starter config that amane startup creates. It puts a 30 pixel blue bar at the top of the screen with some text in it.

use amane::{App, Color, Full, Layer, LayerWindow, Parent, Rectangle, Text, Vertical};

fn main() {
    App::new().window(view).run();
}

fn view() -> LayerWindow {
    LayerWindow::new()
        .width(Full)
        .height(30.0)
        .anchor_vertical(Vertical::Top)
        .layer(Layer::Top)
        .child(
            Rectangle::new()
                .width(Parent)
                .height(Parent)
                .fill(Color::BLUE)
                .child(Text::new("hello world").size(20.0).color(Color::WHITE)),
        )
}