ani2xcursor

https://github.com/yuzujr/ani2xcursor
Admin
ani2xcursor is a tool that converts Windows animated cursor themes (.ani and .cur formats) into...
Tokens:1,583
Snippets:31
Trust Score:6.9
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install via paru

Source: https://github.com/yuzujr/ani2xcursor/blob/main/README.md

Use the paru AUR helper to install the source or binary version of ani2xcursor.

```bash
paru -S ani2xcursor
# or
paru -S ani2xcursor-bin
```

--------------------------------

### Install via yay

Source: https://github.com/yuzujr/ani2xcursor/blob/main/README.md

Use the yay AUR helper to install the source or binary version of ani2xcursor.

```bash
yay -S ani2xcursor
# or
yay -S ani2xcursor-bin
```

--------------------------------

### Manifest Size Configuration

Source: https://github.com/yuzujr/ani2xcursor/blob/main/README.md

Example of defining sizes per role in the manifest.toml file.

```toml
[sizes]
pointer = "48"
text    = "32, 48"
```

--------------------------------

### Run via nix run

Source: https://github.com/yuzujr/ani2xcursor/blob/main/README.md

Execute ani2xcursor directly without permanent installation.

```bash
nix run github:yuzujr/ani2xcursor -- /path/to/cursor/folder
```

--------------------------------

### Build with make

Source: https://github.com/yuzujr/ani2xcursor/blob/main/README.md

Build the project using make. Requires Linux, a C++20 compiler, pkg-config, msgfmt, and specific development libraries.

```bash
make
```

--------------------------------

### Build with xmake

Source: https://github.com/yuzujr/ani2xcursor/blob/main/README.md

Build the project using xmake. Requires Linux, xmake, a C++20 compiler, and msgfmt.

```bash
xmake
```

--------------------------------

### Usage and Options

Source: https://github.com/yuzujr/ani2xcursor/blob/main/README.md

Command line usage and available options for the ani2xcursor tool.

```bash
# Convert theme
ani2xcursor /path/to/cursor/folder

# Options
  --out, -o <dir>           Output directory (default: ./out)
  --format, -f <mode>       Output format: xcursor (default) or source
  --size, -s <mode>         Size selection mode:
                                all    - Export all sizes (default)
                                max    - Export only largest size
                                24,32  - Ensure sizes (reuse if present, rescale if missing)
  --manifest, -m            Generate previews + manifest.toml then exit
  --list, -l                Show available sizes in cursor files then exit
  --install, -i             Install theme to $XDG_DATA_HOME/icons
  --verbose, -v             Enable verbose logging
  --skip-broken             Continue on conversion errors
  --version, -V             Show version information
  --help, -h                Show this help message
```

--------------------------------

### Configure libXcursor Fallback

Source: https://github.com/yuzujr/ani2xcursor/blob/main/README.md

Define a fallback cursor theme for libXcursor by creating an index.theme file.

```ini
[Icon Theme]
Inherits=ThemeName
```

--------------------------------

### Configure Sway Cursor Theme

Source: https://github.com/yuzujr/ani2xcursor/blob/main/README.md

Define the cursor theme and size in the Sway configuration file.

```text
seat * xcursor_theme ThemeName 24
```

--------------------------------

### Manifest Directory Structure

Source: https://github.com/yuzujr/ani2xcursor/blob/main/README.md

Expected directory structure when using a manifest file for configuration.

```text
<input_dir>/ani2xcursor/
├── manifest.toml
└── previews/
    └── *.png
```

--------------------------------

### Configure X11 Cursor Theme

Source: https://github.com/yuzujr/ani2xcursor/blob/main/README.md

Set the cursor theme and size globally for X11 applications via .Xresources.

```text
Xcursor.theme: ThemeName
Xcursor.size: 24
```

--------------------------------

### Add to NixOS system packages

Source: https://github.com/yuzujr/ani2xcursor/blob/main/README.md

Include the ani2xcursor package in your system configuration.

```nix
environment.systemPackages = [
  inputs.ani2xcursor.packages.${pkgs.system}.default
];
```

--------------------------------

### Configure XFCE Cursor Theme

Source: https://github.com/yuzujr/ani2xcursor/blob/main/README.md

Move or symlink the theme to the directory XFCE expects for cursor settings.

```bash
mv ~/.local/share/icons/ThemeName ~/.icons/
# or
ln -s ~/.local/share/icons/ThemeName ~/.icons/ThemeName
```

--------------------------------

### Configure NixOS flake

Source: https://github.com/yuzujr/ani2xcursor/blob/main/README.md

Add the ani2xcursor input to your flake.nix file.

```nix
inputs.ani2xcursor.url = "github:yuzujr/ani2xcursor";
```

--------------------------------

### Configure Niri Cursor Theme

Source: https://github.com/yuzujr/ani2xcursor/blob/main/README.md

Add the cursor theme configuration to the Niri config.kdl file.

```kdl
cursor {
    xcursor-theme "ThemeName"
}
```

--------------------------------

### Set KDE Plasma Cursor Theme

Source: https://github.com/yuzujr/ani2xcursor/blob/main/README.md

Apply the cursor theme using the plasma-apply-cursortheme utility.

```bash
plasma-apply-cursortheme ThemeName
```

--------------------------------

### Set Hyprland Cursor Theme

Source: https://github.com/yuzujr/ani2xcursor/blob/main/README.md

Use hyprctl to set the cursor theme within the Hyprland configuration file.

```bash
exec = hyprctl setcursor ThemeName 24
```

--------------------------------

### Set GNOME Cursor Theme

Source: https://github.com/yuzujr/ani2xcursor/blob/main/README.md

Use gsettings to update the cursor theme for the GNOME desktop environment.

```bash
gsettings set org.gnome.desktop.interface cursor-theme 'ThemeName'
```
Tokens:
Raw