ful1e5
288 lines
9.3 KiB
Markdown
288 lines
9.3 KiB
Markdown
# BreezeX Cursor
|
|
|
|
Extended KDE cursor, Highly inspired on **KDE Breeze** for `Windows` and `Linux` with _HiDPi Support_ .
|
|
|
|
[](https://github.com/ful1e5/BreezeX_Cursor/actions/workflows/build.yml)
|
|
|
|
## BreezeX needs your Input
|
|
|
|
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.
|
|
|
|
I appreciate all the wonderful people who patronize and sponsoring my work.
|
|
|
|
## Sponsors
|
|
|
|
<!-- Add your name or avatar here with the Pull Request in case I missed it. -->
|
|
|
|
N/A
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
> **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
|
|
|
|
### Xcursor Sizes:
|
|
|
|
<kbd>22</kbd>
|
|
<kbd>24</kbd>
|
|
<kbd>28</kbd>
|
|
<kbd>32</kbd>
|
|
<kbd>40</kbd>
|
|
<kbd>48</kbd>
|
|
<kbd>56</kbd>
|
|
<kbd>64</kbd>
|
|
<kbd>72</kbd>
|
|
<kbd>80</kbd>
|
|
<kbd>88</kbd>
|
|
<kbd>96</kbd>
|
|
|
|
### Windows Cursor Size:
|
|
|
|
- <kbd>16x16</kbd> - Small
|
|
- <kbd>24x24</kbd> - Regular
|
|
- <kbd>32x32</kbd> - Large
|
|
- <kbd>48x48</kbd> - Extra Large
|
|
|
|
## Colors:
|
|
|
|
### BreezeX Dark
|
|
|
|
- Base Color - `#4D4D4D` (Breeze Dark)
|
|
- Outline Color - `#FFFFFF` (White)
|
|
|
|
### BreezeX Light
|
|
|
|
- Base Color - `#FFFFFF` (White)
|
|
- Outline Color - `#000000` (Black)
|
|
|
|
### BreezeX Dark
|
|
|
|
- Base Color - `#000000` (Black)
|
|
- Outline Color - `#FFFFFF` (White)
|
|
|
|
## How to get it
|
|
|
|
### Easiest Way
|
|
|
|
You can download latest `stable` & `development` releases from
|
|
[Release Page](https://github.com/ful1e5/BreezeX_Cursor/releases).
|
|
|
|
## Installing BreezeX Cursor
|
|
|
|
#### Linux/X11
|
|
|
|
**Installation:**
|
|
|
|
```bash
|
|
tar -xvf BreezeX-Dark.tar.gz # extract `BreezeX-Dark.tar.gz`
|
|
mv BreezeX-* ~/.icons/ # Install to local users
|
|
sudo mv BreezeX-* /usr/share/icons/ # Install to all users
|
|
```
|
|
|
|
**Uninstallation:**
|
|
|
|
```bash
|
|
rm ~/.icons/BreezeX-* # Remove from local users
|
|
sudo rm /usr/share/icons/BreezeX-* # Remove from all users
|
|
```
|
|
|
|
#### Windows
|
|
|
|
**Installation:**
|
|
|
|
1. Unzip `.zip` file
|
|
2. Open unziped directory in Explorer, and **right click** on `install.inf`.
|
|
3. Click 'Install' from the context menu, and authorize the modifications to your system.
|
|
4. Open Control Panel > Personalization and Appearance > Change mouse pointers,
|
|
and select **BreezeX Cursors**.
|
|
5. Click '**Apply**'.
|
|
|
|
**Uninstallation:**
|
|
|
|
Run the `uninstall.bat` script packed with the `.zip` archive
|
|
|
|
**OR** follow these steps:
|
|
|
|
1. Go to **Registry Editor** by typing the same in the _start search box_.
|
|
2. Expand `HKEY_CURRENT_USER` folder and expand `Control Panel` folder.
|
|
3. Go to `Cursors` folder and click on `Schemes` folder - all the available custom cursors that are
|
|
installed will be listed here.
|
|
4. **Right Click** on the name of cursor file you want to uninstall; for eg.: _BreezeX Cursors_ and
|
|
click `Delete`.
|
|
5. Click '**yes**' when prompted.
|
|
|
|
## 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
|
|
|
|
- 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
|
|
|
|
1. Install [build prerequisites](#build-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).
|
|
|
|
### Building
|
|
|
|
> **Note**
|
|
> Bitmaps are already generated in the `bitmaps` directory and **managed by the maintainer**
|
|
> (do not edit them directly).
|
|
|
|
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`).
|
|
|
|
#### `yarn build` aberration
|
|
|
|
Here are the default commands we used to build the BreezeX's variants and packed them into `yarn build`:
|
|
|
|
```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.'
|
|
```
|
|
|
|
Afterwards, the themes can be found in the `themes` directory.
|
|
|
|
#### 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'
|
|
```
|
|
|
|
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'
|
|
```
|
|
|
|
##### Customize XCursor size
|
|
|
|
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'
|
|
```
|
|
|
|
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 '#000000'
|
|
npx cbmp -d 'svg' -n 'BreezeX-Black' -bc '#000000' -oc '#FFFFFF'
|
|
```
|
|
|
|
#### Examples
|
|
|
|
Lets generate modern BreezeX with green base color and black outline:
|
|
|
|
```bash
|
|
npx cbmp -d 'svg' -n '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.'
|
|
```
|
|
|
|
Afterwards, Generated theme can be found in the `themes` directory.
|
|
|
|
###### BreezeX Gruvbox
|
|
|
|
```bash
|
|
npx cbmp -d 'svg' -n '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'
|
|
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'
|
|
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'
|
|
ctgen build.toml -d 'bitmaps/BreezeX-Dracula' -n 'BreezeX-Dracula' -c 'Dracula BreezeX cursors.'
|
|
```
|
|
|
|
## Bugs
|
|
|
|
Bugs should be reported [here](https://github.com/ful1e5/BreezeX_Cursor/issues) on the Github issues page.
|
|
|
|
## Getting Help
|
|
|
|
You can create a **issue**, I will help you.
|
|
|
|
## Contributing
|
|
|
|
Check [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` & `Pull requests`.
|