fix: build all sizes windows packages

Related to #18

.github/workflows/build.yml

@@ -19,30 +19,43 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        os: [ubuntu-latest]
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+      - name: Setup node
+        uses: actions/setup-node@v4
         with:
-          python-version: ${{ matrix.python-version }}
+          node-version: 16
 
-      - name: Installing pip dependencies
+      - name: Installing Node Dependencies
+        run: |
+          rm -rf node_modules yarn.lock
+          yarn install --frozen-lockfile
+        continue-on-error: false
+
+      - name: Print cbmp version
+        run: npx cbmp --version
+
+      - name: Rendering Bitmaps
+        run: yarn render
+        continue-on-error: false
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - name: Installing PyPi Dependencies
         run: python -m pip install --upgrade pip clickgen
         continue-on-error: false
 
-      # https://github.com/returntocorp/semgrep/issues/4794
-      - name: Fixing 'attr' module error
-        run: pip install --force-reinstall --upgrade attrs
+      - name: Print clickgen Version
+        run: |
+          clickgen --version
+          ctgen --version
 
-      - name: Building `BreezeX Dark` Cursors
-        run: ctgen build.toml -d 'bitmaps/BreezeX-Dark' -n 'BreezeX-Dark' -c 'BreezeX Dark cursors.'
-
-      - name: Building `BreezeX Light` Cursors
-        run: ctgen build.toml -d 'bitmaps/BreezeX-Light' -n 'BreezeX-Light' -c 'BreezeX Light cursors.'
-
-      - name: Building `BreezeX Black` Cursors
-        run: ctgen build.toml -d 'bitmaps/BreezeX-Black' -n 'BreezeX-Black' -c 'BreezeX Black cursors.'
+      - name: Build
+        run: yarn build

.gitignore

@@ -1,4 +1,5 @@
 # Custom
+bitmaps
 themes
 bin
 

CHANGELOG.md

@@ -7,36 +7,63 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+## [v2.0.1] - 02 July 2024
+
+### :warning: Changes for Developers/Package Distributors
+
+-   The 'bitmaps' directory has been removed from the git repository. You can now generate the PNG files using `yarn render` or download them from the release assets.
+
+-   The `build.toml` file has been removed. Instead, the cursor build configurations are now distributed according to platforms within the `configs` directory:
+    -   `configs/x.build.toml`: Used to build XCursor.
+    -   `configs/win_rg.build.toml`: Used to build regular size Windows cursors.
+    -   `configs/win_lg.build.toml`: Used to build large size Windows cursors.
+    -   `configs/win_xxl.build.toml`: Used to build extra large size Windows cursors.
+
+### What's New?
+
+-   Support `256px` cursors
+-   feat: Added `Person` and `Pin` cursors for Windows
+-   Official Distributing `16` and `20` XCursors #24
+-   Multi Resolution Windows Cursors #18
+-   Attach version meta-data inside cursor packages
+-   Using [cbmp v1.1.1](https://github.com/ful1e5/cbmp/tree/v1.1.1) for rendering cursor bitmaps.
+
+### Changes
+
+-   build script renamed (`release.sh` -> `build.sh`)
+-   Use 'xz' for better compression in `build.sh` script
+-   De-framed animated cursors to static SVG files
+
 ## [v2.0.0] - 14 October 2021
 
 ### What's New?
 
-- Refactor: build with `clickgen v2` #21
-- Add cursor top_left_arrow #10 #11
-- Uninstall docs ful1e5/apple_cursor#79 ful1e5/apple_cursor#80
 -   ci: support `clickgen v2` build with cross platform test
+-   Uninstall docs ful1e5/apple_cursor#79 ful1e5/apple_cursor#80
+-   Add cursor top_left_arrow #10 #11
+-   Refactor: build with `clickgen v2` #21
 
 ### Issue Fixes
 
-- fixed #17
-- fixed #21
 -   Human readable docs #16
+-   fixed #21
+-   fixed #17
 
 ## [v1.0.3] - 13 November 2021
 
 ### Added
 
-- `Makefile` command with `THEME_PREFIX` variable
-- distributed pling products docs inside `pling` directory
-- `prepare` command added inside `Makefile`
 -   upload `BreezeX-Black` artifacts in `build` GitHub Action
+-   `prepare` command added inside `Makefile`
+-   distributed pling products docs inside `pling` directory
+-   `Makefile` command with `THEME_PREFIX` variable
 
 ### Changed
 
-- sponsor with liberapay
-- builder module renamed to `src`
-- bitmapping log more descriptive
 -   minimal `README.md` (removed badges and emojis)
+-   bitmapping log more descriptive
+-   builder module renamed to `src`
+-   sponsor with liberapay
 
 ## [v1.0.2] - 20 June 2021
 
@@ -46,24 +73,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- Bigger hotspot dot for Resize cursors
-- Windows resize cursors scale down
 -   `text` & `vertical-text` cursors scale down
+-   Windows resize cursors scale down
+-   Bigger hotspot dot for Resize cursors
 
 ## [v1.0.1] - 16 June 2021
 
 ### Changed
 
-- `left_ptr_watch` and `wait` got minimal design
 -   Cursors preview updated
+-   `left_ptr_watch` and `wait` got minimal design
 
 ## [v1.0.0] - 14 June 2021
 
 ### Added
 
-- Initial release 🎊
-- Logo and badges
 -   CI/CD Pipelines
+-   Logo and badges
+-   Initial release 🎊
 
 [unreleased]: https://github.com/ful1e5/BreezeX_Cursor/compare/v2.0.0...main
 [v2.0.0]: https://github.com/ful1e5/BreezeX_Cursor/compare/v1.0.3...v2.0.0

README.md

@@ -4,37 +4,30 @@ Extended KDE cursor, Highly inspired on **KDE Breeze** for `Windows` and `Linux`
 
 [![build](https://github.com/ful1e5/BreezeX_Cursor/actions/workflows/build.yml/badge.svg)](https://github.com/ful1e5/BreezeX_Cursor/actions/workflows/build.yml)
 
-## BreezeX needs your Input
+## Notes
 
-Until 2021 my cursors projects were well funded by [pling.com](https://www.pling.com) but since the
-[pling-factor](https://www.pling.com/terms/payout) on the website has decreased and monthly payments
-are <500$, It is now dependent on community funding and sponsorships. If you want to help me to maintain
-BreezeX and my other open source projects actively, consider sponsoring my work on [GitHub Sponsor](https://github.com/sponsors/ful1e5)
-or DM me on [Twitter](https://twitter.com/ful1e5) if your company would like to support my projects,
-I will gladly look into it and post your avatar in the project's README.
+-   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&t=7QqTBQ4MOqXONrGI-1).
 
-I appreciate all the wonderful people who patronize and sponsoring my work.
+<!-- If you're interested, you can learn more about "sponsor-spotlight" on
+ https://dev.to/ful1e5/lets-give-recognition-to-those-supporting-our-work-on-github-sponsors-b00 -->
 
-## Sponsors
+![shoutout-sponsors](https://sponsor-spotlight.vercel.app/sponsor?login=ful1e5)
 
-<!-- Add your name or avatar here with the Pull Request in case I missed it. -->
-
-N/A
+-   **2024-07-01**: [b9d526d](https://github.com/ful1e5/BreezeX_Cursor/commit/b9d526df48ac582ea80b7b6329da903f2760e046) Partitioned cursor build configuration into multiple files according to platform:
+    `build.toml` -> `configs/win_lg.build.toml`, `configs/win_rg.build.toml`, `configs/win_xl.build.toml`, `configs/x.build.toml`.
 
 ---
 
-![BreezeX Dark](https://imgur.com/zDGsq2h.png)
-![BreezeX Light](https://imgur.com/tmKu1vC.png)
-![BreezeX Black](https://imgur.com/kzLufkT.png)
-
-> **Note**
-> All cursor's `.svg` files are found in [svg](./svg) directory or you can also find them on
-> [Figma](https://www.figma.com/file/Uo4LeHvFUPDgoqLjnFc1LB/BreezeX?node-id=0%3A1).
+![Breeze Black](https://github.com/ful1e5/BreezeX_Cursor/assets/24286590/ebeb3bc7-3857-4b16-9894-8897507b1855)
+![Breeze Dark](https://github.com/ful1e5/BreezeX_Cursor/assets/24286590/e6e7d402-8ef4-4f4b-8f4c-a7f634461d52)
+![Breeze Light](https://github.com/ful1e5/BreezeX_Cursor/assets/24286590/d2e4c969-a358-42e1-b6bb-ddb0e9c94d30)
 
 ## Cursor Sizes
 
 ### Xcursor Sizes:
 
+<kbd>16</kbd>
+<kbd>20</kbd>
 <kbd>22</kbd>
 <kbd>24</kbd>
 <kbd>28</kbd>
@@ -50,27 +43,30 @@ N/A
 
 ### Windows Cursor Size:
 
-- <kbd>16x16</kbd> - Small
-- <kbd>24x24</kbd> - Regular
-- <kbd>32x32</kbd> - Large
-- <kbd>48x48</kbd> - Extra Large
+| size | Regular (× ²⁄₃) | Large (× ⁴⁄₅) | Extra-Large (× 1) |
+| ---: | --------------: | ------------: | ----------------: |
+|   32 |     21.333 → 22 |     25.6 → 26 |                32 |
+|   48 |              32 |     38.4 → 39 |                48 |
+|   64 |     42.666 → 43 |     51.2 → 52 |                64 |
+|   96 |              64 |     76.8 → 77 |                96 |
+|  128 |     85.333 → 86 |   102.4 → 103 |               128 |
 
-## Colors:
+## Colors
 
 ### BreezeX Dark
 
-- Base Color - `#4D4D4D` (Breeze)
 -   Outline Color - `#FFFFFF` (White)
+-   Base Color - `#4D4D4D` (Breeze)
 
 ### BreezeX Light
 
-- Base Color - `#FFFFFF` (White)
 -   Outline Color - `#4D4D4D` (Breeze)
+-   Base Color - `#FFFFFF` (White)
 
-### BreezeX Dark
+### BreezeX Black
 
-- Base Color - `#000000` (Black)
 -   Outline Color - `#FFFFFF` (White)
+-   Base Color - `#000000` (Black)
 
 ## How to get it
 
@@ -125,79 +121,71 @@ Run the `uninstall.bat` script packed with the `.zip` archive
 
 ## Build From Source
 
-#### Notes
-
-- BreezeX build configuration and cursor hotspot settings are bundled in the `build.toml` file.
-- Check out the scripts section in [package.json](./package.json) to see how we build the cursor theme,
-  excluding the render scripts. They are useful for converting `.svg` files to `.png` files.
-- yarn is optional, For building XCursors and Windows cursors from `.png` files or resizing them
-  you don't need that. If you want to develop/modify BreezeX's colors, and bitmaps, or generate a png
-  file from a svg, Then you can use yarn because bitmapper is written in TypeScript.
-- Since BreezeX variants are designed similarly, they share the same hotspot settings so a
-  single configuration file `build.toml` is responsible for building all variants. Due to this, you will have
-  to change the following options in `ctgen` to build the appropriate variant:
-  - **-d**: bitmaps directory
-  - **-n**: The name you want to give to the generated theme.
-  - **-c**: Theme comment.
-  - See `ctgen --help` for all available options.
-
-### Build prerequisites
+### Prerequisites
 
 -   Python version 3.7 or higher
-- [clickgen](https://github.com/ful1e5/clickgen)>=2.1.2 (`pip install clickgen`)
+-   [clickgen](https://github.com/ful1e5/clickgen)>=2.2.5 (`pip install clickgen`)
 -   [yarn](https://github.com/yarnpkg/yarn)
 
 ### Quick start
 
-1. Install [build prerequisites](#build-prerequisites) on your system
+1. Install [build prerequisites](#prerequisites) on your system
 2. `git clone https://github.com/ful1e5/BreezeX_Cursor`
-3. `cd BreezeX_Cursor && yarn build`
-4. See [Installing BreezeX Cursor](#installing-breezex-cursor).
+3. `cd BreezeX_Cursor`
+4. `yarn install`
+5. `yarn generate`
+6. See [Installing BreezeX Cursor](#installing-breezex-cursor).
 
-### Building
+### Getting Started
 
-> **Note**
-> Bitmaps are already generated in the `bitmaps` directory and **managed by the maintainer**
-> (do not edit them directly).
+Once you have the [build prerequisites](#prerequisites) installed, You can personalize colors,
+customize sizes, change target platforms, and more. This process involves using external tools,
+as this repository only contains SVG files and configuration for these tools:
 
-First make sure you installed the [build prerequisites](#build-prerequisites).
-Now that you have the dependencies, you can try build individual themes from bitmaps and
-customize sizes, target platform, and etc. with the `ctgen` CLI (packed with `clickgen`).
+-   [cbmp](https://github.com/ful1e5/cbmp): Used for customizing colors and generating PNG files.
+-   [ctgen](https://github.com/ful1e5/clickgen): Used for customizing sizes and building XCursor and Windows Cursors.
 
-#### `yarn build` aberration
+You can refer to the README of each tool for more information on their command-line options.
 
-Here are the default commands we used to build the BreezeX's variants and packed them into `yarn build`:
+#### Crafting Your BreezeX Cursor
+
+The process of creating custom cursor themes involves two main steps:
+
+1. Rendering SVG files to PNG files.
+2. Building cursor themes from PNG files.
+
+#### Customize Colors
+
+`cbmp` provides three options for changing colors:
+
+1. `-bc`: Base color, which replaces the `#00FF00` color in the SVG.
+2. `-oc`: Outlined color, which replaces the `#0000FF` color in the SVG.
+3. `-wc` (optional): Watch Background color, which replaces the `#FF0000` color in the SVG.
 
 ```bash
-ctgen build.toml -d 'bitmaps/BreezeX-Dark' -n 'BreezeX-Dark' -c 'BreezeX Dark cursors.'
-ctgen build.toml -d 'bitmaps/BreezeX-Light' -n 'BreezeX-Light' -c 'BreezeX Light cursors.'
-ctgen build.toml -d 'bitmaps/BreezeX-Black' -n 'BreezeX-Black' -c 'BreezeX Black cursors.'
+npx cbmp [...] -bc '<hex>' -oc '<hex>' -wc '<hex>'
 ```
 
-Afterwards, the themes can be found in the `themes` directory.
+Alternatively, you can provide a JSON configuration file to render SVG files, which contains a sequence of `cbmp` commands:
+
+```bash
+npx cbmp render.json
+```
 
 #### Customize Sizes
 
-> **Note**
-> You can change the cursor size up to 200 because pngs are rendered with 200x200.
-> If the cursor is resized by more than rendered png size, the final cursor will be blurred.
-
 ##### Customize Windows Cursor size
 
 To build Windows cursor with size `16`:
 
-> **Warning**
-> Windows cursor supports only one size, if multiple sizes are given with `-s` the first size will
-> be considered in build.
-
 ```bash
-ctgen build.toml -s 16 -p windows -d 'bitmaps/BreezeX-Light' -n 'BreezeX-Light' -c 'White BreezeX cusors with size 16'
+ctgen build.toml -s 16 -p windows -d 'bitmaps/BreezeX-Dark' -n 'BreezeX-Dark' -c 'Extended Breeze XCursors with size 16'
 ```
 
 You can also customize output directory with `-o` option:
 
 ```bash
-ctgen build.toml -s 16 -p windows -d 'bitmaps/BreezeX-Light' -o 'out' -n 'BreezeX-Light' -c 'White BreezeX cusors with size 16'
+ctgen build.toml -s 16 -p windows -d 'bitmaps/BreezeX-Dark' -o 'out' -n 'BreezeX-Dark' -c 'Extended Breeze Windows Cursors with size 16'
 ```
 
 ##### Customize XCursor size
@@ -205,43 +193,27 @@ ctgen build.toml -s 16 -p windows -d 'bitmaps/BreezeX-Light' -o 'out' -n 'Breeze
 To build XCursor with size `16`:
 
 ```bash
-ctgen build.toml -s 16 -p x11 -d 'bitmaps/BreezeX-Light' -n 'BreezeX-Light' -c 'White BreezeX cusors with size 16'
+ctgen build.toml -s 16 -p x11 -d 'bitmaps/BreezeX-Dark' -n 'BreezeX-Dark' -c 'Extended Breeze XCursors with size 16'
 ```
 
 You can also assign multiple sizes to `ctgen` for XCursors build:
 
 ```bash
-ctgen build.toml -s 16 24 32 -p x11 -d 'bitmaps/BreezeX-Light' -n 'BreezeX-Light' -c 'White BreezeX cusors with size 16'
-```
-
-#### Customize Colors
-
-To customize BreezeX's color you have to install node dependencies with `yarn install` command.
-After installing dependencies you can customize the colors via `npx cbmp` Node CLI App which packed with
-[cbmp](https://github.com/ful1e5/cbmp) node package.
-
-##### `yarn render` aberration
-
-Here are the default commands we used for generating the BreezeX's bitmaps and packed them into `yarn render`:
-
-```bash
-npx cbmp -d 'svg' -n 'BreezeX-Dark' -bc '#4D4D4D' -oc '#FFFFFF'
-npx cbmp -d 'svg' -n 'BreezeX-Light' -bc '#FFFFFF' -oc '#4D4D4D'
-npx cbmp -d 'svg' -n 'BreezeX-Black' -bc '#000000' -oc '#FFFFFF'
+ctgen build.toml -s 16 18 24 32 -p x11 -d 'bitmaps/BreezeX-Dark' -n 'BreezeX-Dark' -c 'Extended Breeze XCursors with multi-sizes'
 ```
 
 #### Examples
 
-Lets generate modern BreezeX with green base color and black outline:
+Lets generate BreezeX Cursor with green and black colors:
 
 ```bash
-npx cbmp -d 'svg' -n 'BreezeX-Hacker' -bc '#00FE00' -oc '#000000'
+npx cbmp -d 'svg' -o 'bitmaps/BreezeX-Hacker' -bc '#00FE00' -oc '#000000'
 ```
 
 After rendering custom color you have to build cursor through `ctgen`:
 
 ```bash
-ctgen build.toml -d 'bitmaps/BreezeX-Hacker' -n 'BreezeX-Hacker' -c 'Green and black BreezeX cursors.'
+ctgen build.toml -d 'bitmaps/BreezeX-Hacker' -n 'BreezeX-Hacker' -c 'Green and Black BreezeX cursors.'
 ```
 
 Afterwards, Generated theme can be found in the `themes` directory.
@@ -249,31 +221,40 @@ Afterwards, Generated theme can be found in the `themes` directory.
 ###### BreezeX Gruvbox
 
 ```bash
-npx cbmp -d 'svg' -n 'BreezeX-Gruvbox' -bc '#282828' -oc '#EBDBB2'
+npx cbmp -d 'svg/original' -o 'bitmaps/BreezeX-Gruvbox' -bc '#282828' -oc '#EBDBB2'
 ctgen build.toml -d 'bitmaps/BreezeX-Gruvbox' -n 'BreezeX-Gruvbox' -c 'Groovy BreezeX cursors.'
 ```
 
 ###### BreezeX Solarized Dark
 
 ```bash
-npx cbmp -d 'svg' -n 'BreezeX-Solarized-Dark' -bc '#002b36' -oc '#839496'
+npx cbmp -d 'svg/original' -o 'bitmaps/BreezeX-Solarized-Dark' -bc '#002b36' -oc '#839496'
 ctgen build.toml -d 'bitmaps/BreezeX-Solarized-Dark' -n 'BreezeX-Solarized-Dark' -c 'Solarized Dark BreezeX cursors.'
 ```
 
 ###### BreezeX Solarized Light
 
 ```bash
-npx cbmp -d 'svg' -n 'BreezeX-Solarized-Light' -bc '#839496' -oc '#002b36'
+npx cbmp -d 'svg/original' -o 'bitmaps/BreezeX-Solarized-Light' -bc '#839496' -oc '#002b36'
 ctgen build.toml -d 'bitmaps/BreezeX-Solarized-Light' -n 'BreezeX-Solarized-Light' -c 'Solarized Light BreezeX cursors.'
 ```
 
 ###### BreezeX Dracula
 
 ```bash
-npx cbmp -d 'svg' -n 'BreezeX-Dracula' -bc '#282a36' -oc '#f8f8f2'
+npx cbmp -d 'svg/original' -o 'bitmaas/BreezeX-Dracula' -bc '#282a36' -oc '#f8f8f2'
 ctgen build.toml -d 'bitmaps/BreezeX-Dracula' -n 'BreezeX-Dracula' -c 'Dracula BreezeX cursors.'
 ```
 
+## Testing Cursor
+
+There 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.
+
+-   [Cursor-Test](https://vibhorjaiswal.github.io/Cursor-Test/)
+-   [Mozilla CSS Cursor](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor)
+
+For a blueprint for creating XCursors, you may also want to refer to [Cursor-demo](https://wiki.tcl-lang.org/page/Cursor+demo).
+
 ## Bugs
 
 Bugs should be reported [here](https://github.com/ful1e5/BreezeX_Cursor/issues) on the Github issues page.