CursorCreate

A Multi-platform Cursor Theme Building Program.

CursorCreate allows you to build cursor themes for Windows, MacOS, and Linux. It supports reading cursors from svg, xcur, cur, ani, and all image formats supported by the Pillow imaging library. Also includes a GUI for easily modifying cursor projects.

Installing

Packaged Binaries:

If you would like to avoid going through the process of installing from source, pre-built binaries have been provided on the releases page. Just download the one for your platform, extract the zip file, and run the executable inside the extracted folder.

Releases Page: https://github.com/isaacrobinson2000/CursorCreate/releases

From PyPI:

CursorCreate is also available on PyPI. To install it, execute the command below:

pip install CursorCreate

Once it is installed, it can be executed using the CursorCreate command in the shell:

# Launch the GUI:
CursorCreate
# List all command line options:
CursorCreate --help

From Source:

To install CursorCreate from source, you will need the dependencies for CursorCreate, which can be done using the requirements.txt as shown below:

pip install -r requirements.txt

Once all the dependencies are installed in your python environment (using a virtual environment is recommended) you can pull down this repository using a git clone as below:

git clone https://github.com/isaacrobinson2000/CursorCreate.git

If you are attempting to package CursorCreate for your platform, you will need nuitka installed to the virtual environment. Use the build scripts provided with this project (build_windows.bat, build_linux.sh, or build_mac.sh), as the scripts provide flags for including all the dependencies and making the executables standalone.

Example Theme

This program also comes with a template theme, but due to separate licensing the template theme is kept in a separate repository. Follow the link below to get the template theme:

https://github.com/isaacrobinson2000/CursorCreateTemplateTheme

How to Use

To launch the GUI, simply execute the CursorCreate entry file, as below:

# If you installed via prepackaged binary (Have to be in the same directory as the executable):
./CursorCreate
# If you installed via PyPI (pip install):
CursorCreate
# If you are running it from source:
python CursorCreate/cursorcreate.py

In the GUI, images can simply be dragged and dropped onto the cursor selection widgets in order to load them in. The hotspots and delays of animation frames can be modified by simply clicking on the cursor, as shown below:

To save a project, click the "Save Project" button, which will copy the source image files over to the user selected directory and generate a 'build.json' which tells CursorCreate how to turn the image source files into cursor themes for each platform.

For static images and SVGs, the animation frames are expected to be stored horizontally as squares side by side.

Note that CursorCreate is also capable of doing several actions from the command line, including building cursor themes. To see all the supported command line operations, execute the command below:

# If you installed via prepackaged binary (Have to be in the same directory as the executable):
./CursorCreate --help
# If you installed via PyPI (pip install):
CursorCreate --help
# If you are running it from source:
python CursorCreate/cursorcreate.py --help

Bugs/Issues

This software is currently in beta, and therefore may have some bugs. If you run into any issues, feel free to open an issue on the GitHub issues page.

Future Goals

• Create a setup.py for CursorCreate
• Add progress indicators when building cursors or performing any other action.