{"id":18274560,"url":"https://github.com/ful1e5/breezex_cursor","last_synced_at":"2025-04-05T21:09:52.766Z","repository":{"id":44712345,"uuid":"358220973","full_name":"ful1e5/BreezeX_Cursor","owner":"ful1e5","description":"extended KDE cursor.","archived":false,"fork":false,"pushed_at":"2024-07-27T10:22:06.000Z","size":4374,"stargazers_count":359,"open_issues_count":10,"forks_count":5,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-03-29T20:06:57.784Z","etag":null,"topics":["breeze","cursors","dark","linux","windows"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ful1e5.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"ful1e5"}},"created_at":"2021-04-15T10:37:53.000Z","updated_at":"2025-03-28T08:27:56.000Z","dependencies_parsed_at":"2024-07-09T13:34:04.872Z","dependency_job_id":"744c5e25-49eb-4c6d-b5e9-7532097485b0","html_url":"https://github.com/ful1e5/BreezeX_Cursor","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ful1e5%2FBreezeX_Cursor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ful1e5%2FBreezeX_Cursor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ful1e5%2FBreezeX_Cursor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ful1e5%2FBreezeX_Cursor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ful1e5","download_url":"https://codeload.github.com/ful1e5/BreezeX_Cursor/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247399885,"owners_count":20932880,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["breeze","cursors","dark","linux","windows"],"created_at":"2024-11-05T12:09:58.625Z","updated_at":"2025-04-05T21:09:52.749Z","avatar_url":"https://github.com/ful1e5.png","language":"Shell","funding_links":["https://github.com/sponsors/ful1e5"],"categories":[],"sub_categories":[],"readme":"# BreezeX Cursor\n\nExtended KDE cursor, Highly inspired on **KDE Breeze** for `Windows` and `Linux` with _HiDPi Support_ .\n\n#### Extended!?\n\nBreezeX Cursor is an independent project that supports more XCursor sizes and also offers compatibility with Windows. BreezeX provides more cursor options than the standard Breeze Cursor and allows for customization of colors and cursor sizes using powerful open-source tools.\n\n[![build](https://github.com/ful1e5/BreezeX_Cursor/actions/workflows/build.yml/badge.svg)](https://github.com/ful1e5/BreezeX_Cursor/actions/workflows/build.yml)\n\n## Notes\n\n-   All cursor's SVG files are found in [svg](./svg) directory or you can also find them on [Figma](https://www.figma.com/design/Uo4LeHvFUPDgoqLjnFc1LB/BreezeX?node-id=2620-3\u0026t=7QqTBQ4MOqXONrGI-1).\n\n\u003c!-- If you're interested, you can learn more about \"sponsor-spotlight\" on\n https://dev.to/ful1e5/lets-give-recognition-to-those-supporting-our-work-on-github-sponsors-b00 --\u003e\n\n![shoutout-sponsors](https://sponsor-spotlight.vercel.app/sponsor?login=ful1e5)\n\n-   **2024-07-01**: [b9d526d](https://github.com/ful1e5/BreezeX_Cursor/commit/b9d526df48ac582ea80b7b6329da903f2760e046) Partitioned cursor build configuration into multiple files according to platform:\n    `build.toml` -\u003e `configs/win_lg.build.toml`, `configs/win_rg.build.toml`, `configs/win_xl.build.toml`, `configs/x.build.toml`.\n\n---\n\n![Breeze Black](https://github.com/ful1e5/BreezeX_Cursor/assets/24286590/ebeb3bc7-3857-4b16-9894-8897507b1855)\n![Breeze Dark](https://github.com/ful1e5/BreezeX_Cursor/assets/24286590/e6e7d402-8ef4-4f4b-8f4c-a7f634461d52)\n![Breeze Light](https://github.com/ful1e5/BreezeX_Cursor/assets/24286590/d2e4c969-a358-42e1-b6bb-ddb0e9c94d30)\n\n## Cursor Sizes\n\n### Xcursor Sizes:\n\n\u003ckbd\u003e16\u003c/kbd\u003e\n\u003ckbd\u003e20\u003c/kbd\u003e\n\u003ckbd\u003e22\u003c/kbd\u003e\n\u003ckbd\u003e24\u003c/kbd\u003e\n\u003ckbd\u003e28\u003c/kbd\u003e\n\u003ckbd\u003e32\u003c/kbd\u003e\n\u003ckbd\u003e40\u003c/kbd\u003e\n\u003ckbd\u003e48\u003c/kbd\u003e\n\u003ckbd\u003e56\u003c/kbd\u003e\n\u003ckbd\u003e64\u003c/kbd\u003e\n\u003ckbd\u003e72\u003c/kbd\u003e\n\u003ckbd\u003e80\u003c/kbd\u003e\n\u003ckbd\u003e88\u003c/kbd\u003e\n\u003ckbd\u003e96\u003c/kbd\u003e\n\n### Windows Cursor Size:\n\n| size | Regular (× ²⁄₃) | Large (× ⁴⁄₅) | Extra-Large (× 1) |\n| ---: | --------------: | ------------: | ----------------: |\n|   32 |     21.333 → 22 |     25.6 → 26 |                32 |\n|   48 |              32 |     38.4 → 39 |                48 |\n|   64 |     42.666 → 43 |     51.2 → 52 |                64 |\n|   96 |              64 |     76.8 → 77 |                96 |\n|  128 |     85.333 → 86 |   102.4 → 103 |               128 |\n\n## Colors\n\n### BreezeX Dark\n\n-   Outline Color - `#FFFFFF` (White)\n-   Base Color - `#4D4D4D` (Breeze)\n\n### BreezeX Light\n\n-   Outline Color - `#4D4D4D` (Breeze)\n-   Base Color - `#FFFFFF` (White)\n\n### BreezeX Black\n\n-   Outline Color - `#FFFFFF` (White)\n-   Base Color - `#000000` (Black)\n\n## How to get it\n\n### Easiest Way\n\nYou can download latest `stable` \u0026 `development` releases from\n[Release Page](https://github.com/ful1e5/BreezeX_Cursor/releases).\n\n## Installing BreezeX Cursor\n\n#### Linux/X11\n\n**Installation:**\n\n```bash\ntar -xvf BreezeX-Dark.tar.gz                # extract `BreezeX-Dark.tar.gz`\nmv BreezeX-* ~/.icons/                      # Install to local users\nsudo mv BreezeX-* /usr/share/icons/         # Install to all users\n```\n\n**Uninstallation:**\n\n```bash\nrm ~/.icons/BreezeX-*                       # Remove from local users\nsudo rm /usr/share/icons/BreezeX-*          # Remove from all users\n```\n\n#### Windows\n\n**Installation:**\n\n1. Unzip `.zip` file\n2. Open unziped directory in Explorer, and **right click** on `install.inf`.\n3. Click 'Install' from the context menu, and authorize the modifications to your system.\n4. Open Control Panel \u003e Personalization and Appearance \u003e Change mouse pointers,\n   and select **BreezeX Cursors**.\n5. Click '**Apply**'.\n\n**Uninstallation:**\n\nRun the `uninstall.bat` script packed with the `.zip` archive\n\n**OR** follow these steps:\n\n1. Go to **Registry Editor** by typing the same in the _start search box_.\n2. Expand `HKEY_CURRENT_USER` folder and expand `Control Panel` folder.\n3. Go to `Cursors` folder and click on `Schemes` folder - all the available custom cursors that are\n   installed will be listed here.\n4. **Right Click** on the name of cursor file you want to uninstall; for eg.: _BreezeX Cursors_ and\n   click `Delete`.\n5. Click '**yes**' when prompted.\n\n## Build From Source\n\n### Prerequisites\n\n-   Python version 3.7 or higher\n-   [clickgen](https://github.com/ful1e5/clickgen)\u003e=2.2.5 (`pip install clickgen`)\n-   [yarn](https://github.com/yarnpkg/yarn)\n\n### Quick start\n\n1. Install [build prerequisites](#prerequisites) on your system\n2. `git clone https://github.com/ful1e5/BreezeX_Cursor`\n3. `cd BreezeX_Cursor`\n4. `yarn install`\n5. `yarn generate`\n6. See [Installing BreezeX Cursor](#installing-breezex-cursor).\n\n### Getting Started\n\nOnce you have the [build prerequisites](#prerequisites) installed, You can personalize colors,\ncustomize sizes, change target platforms, and more. This process involves using external tools,\nas this repository only contains SVG files and configuration for these tools:\n\n-   [cbmp](https://github.com/ful1e5/cbmp): Used for customizing colors and generating PNG files.\n-   [ctgen](https://github.com/ful1e5/clickgen): Used for customizing sizes and building XCursor and Windows Cursors.\n\nYou can refer to the README of each tool for more information on their command-line options.\n\n#### Crafting Your BreezeX Cursor\n\nThe process of creating custom cursor themes involves two main steps:\n\n1. Rendering SVG files to PNG files.\n2. Building cursor themes from PNG files.\n\n#### Customize Colors\n\n`cbmp` provides three options for changing colors:\n\n1. `-bc`: Base color, which replaces the `#00FF00` color in the SVG.\n2. `-oc`: Outlined color, which replaces the `#0000FF` color in the SVG.\n3. `-wc` (optional): Watch Background color, which replaces the `#FF0000` color in the SVG.\n\n```bash\nnpx cbmp [...] -bc \"\u003chex\u003e\" -oc \"\u003chex\u003e\" -wc \"\u003chex\u003e\"\n```\n\nAlternatively, you can provide a JSON configuration file to render SVG files, which contains a sequence of `cbmp` commands:\n\n```bash\nnpx cbmp render.json\n```\n\n#### Customize Sizes\n\n##### Customize Windows Cursor size\n\nTo build Windows cursor with size `16`:\n\n```bash\nctgen configs/win_lg.build.toml -s 16 -p windows -d \"bitmaps/BreezeX-Dark\" -n \"BreezeX-Dark\" -c \"Extended Breeze XCursors with size 16\"\n```\n\nYou can also customize output directory with `-o` option:\n\n```bash\nctgen configs/win_lg.build.toml -s 16 -p windows -d \"bitmaps/BreezeX-Dark\" -o \"out\" -n \"BreezeX-Dark\" -c \"Extended Breeze Windows Cursors with size 16\"\n```\n\n##### Customize XCursor size\n\nTo build XCursor with size `16`:\n\n```bash\nctgen configs/x.build.toml -s 16 -p x11 -d \"bitmaps/BreezeX-Dark\" -n \"BreezeX-Dark\" -c \"Extended Breeze XCursors with size 16\"\n```\n\nYou can also assign multiple sizes to `ctgen` for XCursors build:\n\n```bash\nctgen configs/x.build.toml -s 16 18 24 32 -p x11 -d \"bitmaps/BreezeX-Dark\" -n \"BreezeX-Dark\" -c \"Extended Breeze XCursors with multi-sizes\"\n```\n\n#### Examples\n\nLets generate BreezeX Cursor with green and black colors:\n\n```bash\nnpx cbmp -d \"svg\" -o \"bitmaps/BreezeX-Hacker\" -bc \"#00FE00\" -oc \"#000000\"\n```\n\nAfter rendering custom color you have to build cursor through `ctgen`:\n\n```bash\nctgen configs/x.build.toml -d \"bitmaps/BreezeX-Hacker\" -n \"BreezeX-Hacker\" -c \"Green and Black BreezeX cursors.\"\n\nctgen configs/win_rg.build.toml -d \"bitmaps/BreezeX-Hacker\" -n \"BreezeX-Hacker\" -c \"Green and Black BreezeX cursors.\"\nctgen configs/win_lg.build.toml -d \"bitmaps/BreezeX-Hacker\" -n \"BreezeX-Hacker\" -c \"Green and Black BreezeX cursors.\"\nctgen configs/win_xl.build.toml -d \"bitmaps/BreezeX-Hacker\" -n \"BreezeX-Hacker\" -c \"Green and Black BreezeX cursors.\"\n```\n\nAfterwards, Generated theme can be found in the `themes` directory.\n\n###### BreezeX Gruvbox\n\n```bash\nnpx cbmp -d \"svg/original\" -o \"bitmaps/BreezeX-Gruvbox\" -bc \"#282828\" -oc \"#EBDBB2\"\n\nctgen configs/x.build.toml -d \"bitmaps/BreezeX-Gruvbox\" -n \"BreezeX-Gruvbox\" -c \"Groovy BreezeX cursors.\"\n\nctgen configs/win_rg.build.toml -d \"bitmaps/BreezeX-Gruvbox\" -n \"BreezeX-Gruvbox\" -c \"Groovy BreezeX cursors.\"\nctgen configs/win_lg.build.toml -d \"bitmaps/BreezeX-Gruvbox\" -n \"BreezeX-Gruvbox\" -c \"Groovy BreezeX cursors.\"\nctgen configs/win_xl.build.toml -d \"bitmaps/BreezeX-Gruvbox\" -n \"BreezeX-Gruvbox\" -c \"Groovy BreezeX cursors.\"\n```\n\n###### BreezeX Solarized Dark\n\n```bash\nnpx cbmp -d \"svg/original\" -o \"bitmaps/BreezeX-Solarized-Dark\" -bc \"#002b36\" -oc \"#839496\"\n\nctgen configs/x.build.toml -d \"bitmaps/BreezeX-Solarized-Dark\" -n \"BreezeX-Solarized-Dark\" -c \"Solarized Dark BreezeX cursors.\"\n\nctgen configs/win_rg.build.toml -d \"bitmaps/BreezeX-Solarized-Dark\" -n \"BreezeX-Solarized-Dark\" -c \"Solarized Dark BreezeX cursors.\"\nctgen configs/win_lg.build.toml -d \"bitmaps/BreezeX-Solarized-Dark\" -n \"BreezeX-Solarized-Dark\" -c \"Solarized Dark BreezeX cursors.\"\nctgen configs/win_xl.build.toml -d \"bitmaps/BreezeX-Solarized-Dark\" -n \"BreezeX-Solarized-Dark\" -c \"Solarized Dark BreezeX cursors.\"\n```\n\n###### BreezeX Solarized Light\n\n```bash\nnpx cbmp -d \"svg/original\" -o \"bitmaps/BreezeX-Solarized-Light\" -bc \"#839496\" -oc \"#002b36\"\n\nctgen configs/x.build.toml -d \"bitmaps/BreezeX-Solarized-Light\" -n \"BreezeX-Solarized-Light\" -c \"Solarized Light BreezeX cursors.\"\n\nctgen configs/win_rg.build.toml -d \"bitmaps/BreezeX-Solarized-Light\" -n \"BreezeX-Solarized-Light\" -c \"Solarized Light BreezeX cursors.\"\nctgen configs/win_lg.build.toml -d \"bitmaps/BreezeX-Solarized-Light\" -n \"BreezeX-Solarized-Light\" -c \"Solarized Light BreezeX cursors.\"\nctgen configs/win_xl.build.toml -d \"bitmaps/BreezeX-Solarized-Light\" -n \"BreezeX-Solarized-Light\" -c \"Solarized Light BreezeX cursors.\"\n\n```\n\n###### BreezeX Dracula\n\n```bash\nnpx cbmp -d \"svg/original\" -o \"bitmaas/BreezeX-Dracula\" -bc \"#282a36\" -oc \"#f8f8f2\"\n\nctgen configs/x.build.toml -d \"bitmaps/BreezeX-Dracula\" -n \"BreezeX-Dracula\" -c \"Dracula BreezeX cursors.\"\n\nctgen configs/win_rg.build.toml -d \"bitmaps/BreezeX-Dracula\" -n \"BreezeX-Dracula\" -c \"Dracula BreezeX cursors.\"\nctgen configs/win_lg.build.toml -d \"bitmaps/BreezeX-Dracula\" -n \"BreezeX-Dracula\" -c \"Dracula BreezeX cursors.\"\nctgen configs/win_xl.build.toml -d \"bitmaps/BreezeX-Dracula\" -n \"BreezeX-Dracula\" -c \"Dracula BreezeX cursors.\"\n```\n\n## Testing Cursor\n\nThere are several websites that allow you to test your cursor states by hovering over buttons. This can be very useful when developing or verifying the behavior of a cursor. The following websites cover many of the most commonly used cursors, although they may not include all available options.\n\n-   [Cursor-Test](https://vibhorjaiswal.github.io/Cursor-Test/)\n-   [Mozilla CSS Cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor)\n\nFor a blueprint for creating XCursors, you may also want to refer to [Cursor-demo](https://wiki.tcl-lang.org/page/Cursor+demo).\n\n## Bugs\n\nBugs should be reported [here](https://github.com/ful1e5/BreezeX_Cursor/issues) on the Github issues page.\n\n## Getting Help\n\nYou can create a **issue**, I will help you.\n\n## Contributing\n\nCheck [CONTRIBUTING.md](CONTRIBUTING.md), any suggestions for features and contributions to the continuing code masterelopment can be made via the issue tracker or code contributions via a `Fork` \u0026 `Pull requests`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fful1e5%2Fbreezex_cursor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fful1e5%2Fbreezex_cursor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fful1e5%2Fbreezex_cursor/lists"}