hyprcursor/hyprcursor-util/README.md

28 lines
985 B
Markdown
Raw Permalink Normal View History

2024-03-07 19:01:08 +01:00
## hyprcursor-util
A utility to compile, pack, unpack, etc, hyprcursor and xcursor themes.
2024-03-08 18:20:05 +01:00
## Runtime deps
- xcur2png
2024-03-07 19:01:08 +01:00
## States
Cursor themes can be in 3 states:
- compiled hyprcursor - these can be used by apps / compositors.
- compiled xcursor - these can be used by xcursor
- working state - an easy to navigate mode where every cursor is a png / svg, and all the meta is in files.
## Commands
`--create | -c [path]` -> create a compiled hyprcursor theme from a working state
`--extract | -x [path]` -> extract an xcursor theme into a working state
2024-03-10 00:18:06 +01:00
both commands support `--output | -o` to specify an output directory. For safety reasons, **do not use this on versions below 0.1.1** as it will
nuke the specified directory without asking.
Since v0.1.2, this directory is the parent, the theme will be written to a subdirectory in it called `$ACTION_$NAME`.
2024-03-08 03:00:52 +01:00
### Flags
`--resize [mode]` - for `extract`: specify a default resize algorithm for shapes. Default is `none`.