HYPRCURSOR-UTIL(1)

NAME
hyprcursor-util - compile, pack, and extract hyprcursor and xcursor themes

SYNOPSIS
hyprcursor-util [options] command [path]

DESCRIPTION
hyprcursor-util is a utility for compiling, packing, unpacking, and converting cursor themes between hyprcursor, xcursor, and a working-state representation.

The working state is an easy-to-navigate format where each cursor is stored as a PNG or SVG and metadata is stored in files.

RUNTIME DEPENDENCIES
hyprcursor-util uses xcur2png at runtime.

THEME STATES
Themes may exist in the following states:

compiled hyprcursor
    Usable by applications and compositors supporting hyprcursor.

compiled xcursor
    Usable by xcursor-based software.

working state
    Editable form where each cursor is a PNG or SVG and metadata is stored in files.

COMMANDS

--create path
-c path
    Create a compiled hyprcursor theme from a working-state directory.

--extract path
-x path
    Extract an xcursor theme into a working-state directory.

OPTIONS

--output directory
-o directory
    Specify the output directory.

    For safety reasons, do not use this option with versions below 0.1.1, as those versions remove the specified directory without confirmation.

    Since version 0.1.2, the specified output directory is treated as the parent directory, and the result is written to a subdirectory named:

    $ACTION_$NAME

--resize mode
    For --extract only, specify the default resize algorithm for shapes.

    The default is none.

EXAMPLES
Create a compiled hyprcursor theme from a working-state directory:

hyprcursor-util --create ./theme-workdir

Create a compiled hyprcursor theme and place the result under a chosen parent directory:

hyprcursor-util --create ./theme-workdir --output ./out

Extract an xcursor theme into a working-state directory:

hyprcursor-util --extract ./xcursor-theme

Extract using a resize mode:

hyprcursor-util --extract ./xcursor-theme --resize none

NOTES
The --output behavior changed in version 0.1.2. In that and later versions, the named directory is treated as a parent directory rather than the final destination.

SEE ALSO
xcur2png(1)

AUTHORS
Hypr Development