hyprcursor-util

compile and extract Hyprcursor cursor themes

TLDR

Compile a working-directory theme into Hyprcursor format

$ hyprcursor-util -c [path/to/theme_directory]

Extract an XCursor theme into a working directory of PNG/SVG shapes

$ hyprcursor-util -x [path/to/xcursor_theme]

Write output under a parent directory (theme lands in a subdirectory)

$ hyprcursor-util -c [path/to/theme_directory] -o [path/to/output]

Extract with a specific resize algorithm

$ hyprcursor-util --extract [path/to/xcursor_theme] --resize nearest

SYNOPSIS

hyprcursor-util {-c|--create | -x|--extract} path [options]

hyprcursor-util converts cursor themes between Hyprland's Hyprcursor format and a working tree of images plus metadata. A working state is easy to edit: every cursor is a PNG or SVG and metadata lives in files. Compiled Hyprcursor is what compositors load. Compiled XCursor is the older X11 format.Typical flow: extract an existing XCursor theme, edit shapes, then create a Hyprcursor theme. Runtime conversion from XCursor also needs xcur2png.

PARAMETERS

-c, --create path

Compile a working-state theme (PNG/SVG + metadata files) into a Hyprcursor theme apps and compositors can load.

-x, --extract path

Unpack an XCursor theme into working-state files.

-o, --output dir

Parent directory for output. Since 0.1.2 the theme is written to a subdirectory named `$ACTION_$NAME` under this path.

--resize mode

For --extract only: default resize algorithm for shapes. One of none (default), nearest, or bilinear.

INSTALL

sudo apk add hyprcursor-util

CAVEATS

--output on versions older than 0.1.1 deleted the target directory without asking. Use 0.1.1 or later. Creating a theme requires a valid working-state layout, not a random folder of images.

HISTORY

Part of hyprcursor, the cursor toolkit for Hyprland by Vaxry.

RESOURCES

Source code · Documentation