fedor/BreezeX_Cursor
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Update build from source instruction

Browse Source
This commit is contained in:
Abdulkaiz Khatri
2024-07-02 09:58:12 +05:30
parent ab01c64189
commit e04e474625
1 changed files with 79 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+79 -98
View File
@@ -4,22 +4,17 @@ 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) [![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 - 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).
[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.
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. --> - **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`.
N/A
--- ---
@@ -27,14 +22,12 @@ N/A
![BreezeX Light](https://imgur.com/tmKu1vC.png) ![BreezeX Light](https://imgur.com/tmKu1vC.png)
![BreezeX Black](https://imgur.com/kzLufkT.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).
## Cursor Sizes ## Cursor Sizes
### Xcursor Sizes: ### Xcursor Sizes:
<kbd>16</kbd>
<kbd>20</kbd>
<kbd>22</kbd> <kbd>22</kbd>
<kbd>24</kbd> <kbd>24</kbd>
<kbd>28</kbd> <kbd>28</kbd>
@@ -50,27 +43,30 @@ N/A
### Windows Cursor Size: ### Windows Cursor Size:
- <kbd>16x16</kbd> - Small | size | Regular (× ²⁄₃) | Large (× ⁴⁄₅) | Extra-Large (× 1) |
- <kbd>24x24</kbd> - Regular | ---: | --------------: | ------------: | ----------------: |
- <kbd>32x32</kbd> - Large | 32 | 21.333 → 22 | 25.6 → 26 | 32 |
- <kbd>48x48</kbd> - Extra Large | 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 ### BreezeX Dark
- Base Color - `#4D4D4D` (Breeze) - Outline Color - `#FFFFFF` (White)
- Outline Color - `#FFFFFF` (White) - Base Color - `#4D4D4D` (Breeze)
### BreezeX Light ### BreezeX Light
- Base Color - `#FFFFFF` (White) - Outline Color - `#4D4D4D` (Breeze)
- Outline Color - `#4D4D4D` (Breeze) - Base Color - `#FFFFFF` (White)
### BreezeX Black ### BreezeX Black
- Base Color - `#000000` (Black) - Outline Color - `#FFFFFF` (White)
- Outline Color - `#FFFFFF` (White) - Base Color - `#000000` (Black)
## How to get it ## How to get it
@@ -125,79 +121,71 @@ Run the `uninstall.bat` script packed with the `.zip` archive
## Build From Source ## Build From Source
#### Notes ### Prerequisites
- BreezeX build configuration and cursor hotspot settings are bundled in the `build.toml` file. - Python version 3.7 or higher
- Check out the scripts section in [package.json](./package.json) to see how we build the cursor theme, - [clickgen](https://github.com/ful1e5/clickgen)>=2.2.5 (`pip install clickgen`)
excluding the render scripts. They are useful for converting `.svg` files to `.png` files. - [yarn](https://github.com/yarnpkg/yarn)
- 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
- Python version 3.7 or higher
- [clickgen](https://github.com/ful1e5/clickgen)>=2.1.2 (`pip install clickgen`)
- [yarn](https://github.com/yarnpkg/yarn)
### Quick start ### 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` 2. `git clone https://github.com/ful1e5/BreezeX_Cursor`
3. `cd BreezeX_Cursor && yarn build` 3. `cd BreezeX_Cursor`
4. See [Installing BreezeX Cursor](#installing-breezex-cursor). 4. `yarn install`
5. `yarn generate`
6. See [Installing BreezeX Cursor](#installing-breezex-cursor).
### Building ### Getting Started
> **Note** Once you have the [build prerequisites](#prerequisites) installed, You can personalize colors,
> Bitmaps are already generated in the `bitmaps` directory and **managed by the maintainer** customize sizes, change target platforms, and more. This process involves using external tools,
> (do not edit them directly). as this repository only contains SVG files and configuration for these tools:
First make sure you installed the [build prerequisites](#build-prerequisites). - [cbmp](https://github.com/ful1e5/cbmp): Used for customizing colors and generating PNG files.
Now that you have the dependencies, you can try build individual themes from bitmaps and - [ctgen](https://github.com/ful1e5/clickgen): Used for customizing sizes and building XCursor and Windows Cursors.
customize sizes, target platform, and etc. with the `ctgen` CLI (packed with `clickgen`).
#### `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 ```bash
ctgen build.toml -d 'bitmaps/BreezeX-Dark' -n 'BreezeX-Dark' -c 'BreezeX Dark cursors.' npx cbmp [...] -bc '<hex>' -oc '<hex>' -wc '<hex>'
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.'
``` ```
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 #### 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 ##### Customize Windows Cursor size
To build Windows cursor with size `16`: 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 ```bash
ctgen build.toml -s 16 -p windows -d 'bitmaps/BreezeX-Light' -n 'BreezeX-Light' -c 'White BreezeX cursors 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: You can also customize output directory with `-o` option:
```bash ```bash
ctgen build.toml -s 16 -p windows -d 'bitmaps/BreezeX-Light' -o 'out' -n 'BreezeX-Light' -c 'White BreezeX cursors 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 ##### 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`: To build XCursor with size `16`:
```bash ```bash
ctgen build.toml -s 16 -p x11 -d 'bitmaps/BreezeX-Light' -n 'BreezeX-Light' -c 'White BreezeX cursors 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: You can also assign multiple sizes to `ctgen` for XCursors build:
```bash ```bash
ctgen build.toml -s 16 24 32 -p x11 -d 'bitmaps/BreezeX-Light' -n 'BreezeX-Light' -c 'White BreezeX cursors with size 16' ctgen build.toml -s 16 18 24 32 -p x11 -d 'bitmaps/BreezeX-Dark' -n 'BreezeX-Dark' -c 'Extended Breeze XCursors with multi-sizes'
```
#### 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'
``` ```
#### Examples #### Examples
Lets generate modern BreezeX with green base color and black outline: Lets generate BreezeX Cursor with green and black colors:
```bash ```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`: After rendering custom color you have to build cursor through `ctgen`:
```bash ```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. 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 ###### BreezeX Gruvbox
```bash ```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.' ctgen build.toml -d 'bitmaps/BreezeX-Gruvbox' -n 'BreezeX-Gruvbox' -c 'Groovy BreezeX cursors.'
``` ```
###### BreezeX Solarized Dark ###### BreezeX Solarized Dark
```bash ```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.' ctgen build.toml -d 'bitmaps/BreezeX-Solarized-Dark' -n 'BreezeX-Solarized-Dark' -c 'Solarized Dark BreezeX cursors.'
``` ```
###### BreezeX Solarized Light ###### BreezeX Solarized Light
```bash ```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.' ctgen build.toml -d 'bitmaps/BreezeX-Solarized-Light' -n 'BreezeX-Solarized-Light' -c 'Solarized Light BreezeX cursors.'
``` ```
###### BreezeX Dracula ###### BreezeX Dracula
```bash ```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.' 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
Bugs should be reported [here](https://github.com/ful1e5/BreezeX_Cursor/issues) on the Github issues page. Bugs should be reported [here](https://github.com/ful1e5/BreezeX_Cursor/issues) on the Github issues page.