# currust
~~A portmanteau of "cursor" and "Rust".~~
A tool written in Rust to convert cursors between Windows and Linux. Specifically,
converting from the CUR/ANI format to the Xcursor format (plus some other features).
## Installation
You can either download the binaries which are uploaded as releases (recommended),
or build this project yourself by cloning and… building. Not much else to say really.
## Usage
The intended use-case of this tool is to convert a Windows _cursor theme_ to Linux. A _cursor theme_
is a directory that contains some cursors, along with an installer file that uses the INF format.
You can convert a cursor theme as such:
```text
./currust ./my-cursor-theme
```
This converts the theme and writes the produced X11 theme (which is a directory) in the current
directory. Add the `--out` (or `-o` for short) argument to place it in the specified path.
```text
./currust ./my-cursor-theme -o ./please/go/here/instead
```
Cursor themes on Windows can be scaled by Windows itself. Unfortunately, this feature doesn't
exist on most Linux distributions, so Xcursor themes have to include their own size variations.
The `--scale-to` argument is available to provide some scale factors, along
with `--scale-with` to provide a scaling algorithm to use (default: Lanczos3).
Note that this increases the size of the resulting cursor theme.
```text
./currust ./my-cursor-theme --scale-to 1.5 2 3 --scale-with mitchell
```
For more information on other commands and possible usages, view the help text:
```text
./currust -h # Summarised help text
./currust --help # Detailed help text
```
## Goals
All the baseline goals I had for this project are complete, so this is more akin to
a "planned/future features" section. Note that not everything here may be added.
- [ ] Publish or otherwise for usage with `cargo` and package managers
- [ ] Conversion from X11 cursors to Windows cursors (i.e, the other way around)
- [ ] [SVG cursor themes][1] for KDE Plasma
- [ ] hyprcursor (cursor format for hyprland) support
## Notes
Here are some _other_ cursor converter tools you might want to check out:
- [win2xcur], [win2xcur-batch]
- [ani2xcursor]
- [ani-to-xcursor]
[1]: https://planet.kde.org/vlad-zahorodnii-2024-10-06-svg-cursors-everything-that-you-need-to-know-about-them/
[win2xcur]: https://github.com/quantum5/win2xcur
[win2xcur-batch]: https://github.com/khayalhus/win2xcur-batch
[ani2xcursor]: https://github.com/yuzujr/ani2xcursor
[ani-to-xcursor]: https://github.com/nicdgonzalez/ani-to-xcursor