Skip to main content

win2xcur is a tool to convert Windows .cur and .ani cursors to Xcursor format, and vice versa.

Project description

win2xcur and x2wincur Build Status PyPI PyPI - Format PyPI - Python Version

win2xcur is a tool that converts cursors from Windows format (*.cur, *.ani) to Xcursor format. This allows Windows cursor themes to be used on Linux, for example.

win2xcur is more than a simple image conversion tool. It preserves the cursor hotspot and animation delay, and has an optional mode to add shadows that replicates Windows's cursor shadow effect.

x2wincur is a tool that does the opposite: it converts cursors in the Xcursor format to Windows format (*.cur, *.ani), allowing to use your favourite Linux cursor themes on Windows.

win2xcurtheme converts a packaged Windows cursor theme with an INF installer into a directory of Xcursors, which can be used to construct your own cursor theme on Linux.

Conversely, x2wincurtheme converts a directory of Xcursors into Windows, while generating the complementary install.inf for easy installation.

Finally, inspectcur serves as a debugging tool, able to load arbitrary Windows or X11 cursors and show the animation settings, image sizes, and hotspots.

Installation

To install the latest stable version:

pip install win2xcur

To install from GitHub:

pip install -e git+https://github.com/quantum5/win2xcur.git

The following unofficial packages are available (use at your own risk! I don't maintain these):

  • AUR: win2xcur, which may be installed with yay -S win2xcur or paru -S win2xcur.

Usage: win2xcur

For example, if you want to convert the sample cursor to Linux format:

mkdir output/
win2xcur sample/crosshair.cur -o output/

-s can be specified to enable shadows. Multiple cursors files can be specified on the command line. For example, to convert a directory of cursors with shadows enabled:

win2xcur input/*.{ani,cur} -o output/ 

For more information, run win2xcur --help.

Usage: x2wincur

For example, if you want to convert DMZ-White to Windows:

mkdir dmz-white/
x2wincur /usr/share/icons/DMZ-White/cursors/* -o dmz-white/

Usage: win2xcurtheme

To convert an example Windows cursor theme in example with an INF installer install.inf:

mkdir -p example-linux/cursors
win2xcurtheme example/install.inf -o example-linux/cursors

You can then create example-linux/index.theme as follows:

[Icon Theme]
Name = example
Comment = My example cursor theme.
Example = default

Usage: x2wincurtheme

To convert a whole Xcursor theme to Windows format, run x2wincurtheme on the cursors subdirectory of an Xcursor theme, then specify a name with -n. For example, for DMZ-White:

x2wincurtheme /usr/share/icons/DMZ-White/cursors -n DMZ-White -o dmz-white/

Usage: inspectcur

$ inspectcur /usr/share/icons/DMZ-White/cursors/left_ptr
Cursor file: /usr/share/icons/DMZ-White/cursors/left_ptr
1. nominal size 24, 24x24, hotspot: (7, 4)
2. nominal size 32, 32x32, hotspot: (10, 5)
3. nominal size 48, 48x48, hotspot: (14, 8)
$ inspectcur /usr/share/icons/DMZ-White/cursors/watch 
Cursor file: /usr/share/icons/DMZ-White/cursors/watch
  - Frame 0, delay 30.0 ms
    1. nominal size 24, 24x24, hotspot: (12, 12)
    2. nominal size 32, 32x32, hotspot: (18, 18)
    3. nominal size 48, 48x48, hotspot: (24, 24)
  - Frame 1, delay 30.0 ms
    1. nominal size 24, 24x24, hotspot: (12, 12)
    2. nominal size 32, 32x32, hotspot: (18, 18)
    3. nominal size 48, 48x48, hotspot: (24, 24)
...

Troubleshooting

win2xcur, x2wincur, win2xcurtheme, and x2wincurtheme should work out of the box on most systems. If you are using unconventional distros (e.g. Alpine) and are getting errors related to wand, please see the Wand documentation on installation.

If you are having issues with a particular cursor or cursor theme, feel free to open an issue. However, be sure to include:

  1. the problematic cursor as an attachment[^attach] to the issue;
  2. the command you ran; and
  3. the full output of the command run.

If I can't reproduce the issue, I will not be able to help you.

[^attach]: Don't make me sign up to a website or pay to download your cursor.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

win2xcur-0.2.1.tar.gz (17.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

win2xcur-0.2.1-py3-none-any.whl (22.7 kB view details)

Uploaded Python 3

File details

Details for the file win2xcur-0.2.1.tar.gz.

File metadata

  • Download URL: win2xcur-0.2.1.tar.gz
  • Upload date:
  • Size: 17.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for win2xcur-0.2.1.tar.gz
Algorithm Hash digest
SHA256 109d0a102db2f996c2e77c4bfd0f4f02639d8681506b6e1be06891775689963d
MD5 0022b5949fe59594bf282d53a50a9048
BLAKE2b-256 f2e6b487f1619a5d4c4012d4254dbe83c41a0079f23b92e5d5092c8d95632f94

See more details on using hashes here.

File details

Details for the file win2xcur-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: win2xcur-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 22.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for win2xcur-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0a3d23168b1700b46276d420ae9b7e374749ddbd02665dd4fb067f90ff66f2c5
MD5 a055af43fe0f9379da08254012fe73bf
BLAKE2b-256 2f39caa9bd69b2e1ace3a83d7de1b61986d6204f25ea30a4db8b36aa19d7938d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page