mirror of
https://github.com/ful1e5/Bibata_Cursor.git
synced 2024-10-18 05:20:38 -04:00
prepare v2.0.4
This commit is contained in:
Abdulkaiz Khatri
parent
f9523173aa
commit
55d2284e2e
4 changed files with 72 additions and 117 deletions
17
CHANGELOG.md
17
CHANGELOG.md
|
|
@ -7,16 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
|
||||
## [unreleased]
|
||||
|
||||
## [v2.0.4] - 15 September 2023
|
||||
|
||||
### :warning: Breaking Changes
|
||||
|
||||
- 3b54187660de06d8b117ecbf191c93826bcc1fc8
|
||||
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.
|
||||
(This change applies only to developers and package distributors)
|
||||
> **Note**
|
||||
> This change applies only to developers and package distributors
|
||||
|
||||
- 3b54187660de06d8b117ecbf191c93826bcc1fc8 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.
|
||||
|
||||
### What's New?
|
||||
|
||||
- Pointer Actions Cursor is Re-Designed
|
||||
|
||||
|
||||
- The XCursor package size is now approximately `20MB` in its original form and `~2MB` when compressed.
|
||||
- Official Distributing `16` and `20` XCursors (Fixes #129)
|
||||
- The maximum size for building a cursor without losing quality is `256px`.
|
||||
|
|
@ -24,7 +28,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
- Resolved Missing Windows Cursors. (Fixes #133, #124)
|
||||
- Using [cbmp v1.0.0](https://github.com/ful1e5/cbmp/tree/v1.0.0) for rendering cursor bitmaps.
|
||||
|
||||
### Changed
|
||||
### Changes
|
||||
|
||||
- Use 'xz' for better compression in `release` script #140
|
||||
- Corrected the AUR Package information in `README.md`, addressing issue #142.
|
||||
|
|
@ -288,7 +292,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
|
||||
- Initial release 🎊
|
||||
|
||||
[unreleased]: https://github.com/ful1e5/Bibata_Cursor/compare/v2.0.3...main
|
||||
[unreleased]: https://github.com/ful1e5/Bibata_Cursor/compare/v2.0.4...main
|
||||
[v2.0.4]: https://github.com/ful1e5/Bibata_Cursor/compare/v2.0.3...v2.0.4
|
||||
[v2.0.3]: https://github.com/ful1e5/Bibata_Cursor/compare/v2.0.2...v2.0.3
|
||||
[v2.0.2]: https://github.com/ful1e5/Bibata_Cursor/compare/v2.0.1...v2.0.2
|
||||
[v2.0.1]: https://github.com/ful1e5/Bibata_Cursor/compare/v2.0.0...v2.0.1
|
||||
|
|
|
|||
162
README.md
162
README.md
|
|
@ -1,8 +1,3 @@
|
|||
<!-- 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 -->
|
||||
|
||||
|
||||
|
||||
# Bibata Cursor
|
||||
|
||||
[](https://github.com/ful1e5/Bibata_Cursor/actions/workflows/build.yml)
|
||||
|
|
@ -15,34 +10,27 @@ to improve the cursor experience for users. It is one of the most popular cursor
|
|||
in the Linux community and is now available for free on Windows as well, with multiple color
|
||||
and size options. Its goal is to offer personalized cursors to users.
|
||||
|
||||
## What does "Bibata" mean?
|
||||
#### What does "Bibata" mean?
|
||||
|
||||
The sweetest word I ever spoke was "BI-Buh," which, coincidentally, is also the word for peanuts.
|
||||
To make it more pronounceable and not sound like a baby's words, I added the suffix "Ta."
|
||||
And with that, my journey in the world of open source began.
|
||||
|
||||
## Join the Community as a Sponsor
|
||||
## Notes
|
||||
|
||||
Until 2021, my cursor projects were funded through [pling.com](https://www.pling.com).
|
||||
However, the funding has since decreased and the projects are now dependent on community
|
||||
support and sponsorships to continue. If you would like to help me maintain Bibata and my
|
||||
other open source projects, you can consider sponsoring my work on
|
||||
[GitHub Sponsor](https://github.com/sponsors/ful1e5) or contacting me on
|
||||
[Twitter](https://twitter.com/ful1e5) if your company is interested in supporting my projects.
|
||||
I would be happy to discuss it and include 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/file/Y9RKZLXhSvaxpUzsKGJkp6/Bibata-Cursor?node-id=0%3A1).
|
||||
|
||||
I am grateful to all the kind individuals and companies that support and sponsor my work,
|
||||
which enables me to continue working on open source projects full-time. Thank you.
|
||||
<!-- 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 -->
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
> **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/Y9RKZLXhSvaxpUzsKGJkp6/Bibata-Cursor?node-id=0%3A1).
|
||||
|
||||
|
||||
|
||||
|
||||
## Variants:
|
||||
|
||||
|
|
@ -112,18 +100,14 @@ You can download latest `stable` & `development` releases from
|
|||
|
||||
#### Arch Linux/Manjaro
|
||||
|
||||
Arch Linux/Manjaro users can install from the [AUR](https://aur.archlinux.org/packages/bibata-cursor-theme)
|
||||
currently maintained by [_@Shatur_](https://aur.archlinux.org/packages/?K=Shatur&SeB=m) &
|
||||
[_@yochananmarqos_](https://aur.archlinux.org/packages/?K=yochananmarqos&SeB=m).
|
||||
Can be installed via Pamac (preinstalled in Manjaro), Paru or any other
|
||||
[AUR helper](https://wiki.archlinux.org/index.php/AUR_helpers).
|
||||
##### AUR @yochananmarqos
|
||||
|
||||
```bash
|
||||
paru -S bibata-cursor-theme-bin # (recommended)
|
||||
paru -S bibata-cursor-theme
|
||||
```
|
||||
|
||||
Alternatively, Bibata binaries can be also installed using the [PKGBUILD `bibata-cursor-theme-bin`,
|
||||
available on the AUR](https://aur.archlinux.org/packages/bibata-cursor-theme-bin).
|
||||
Or [PKGBUILD](https://aur.archlinux.org/cgit/aur.git/plain/PKGBUILD?h=bibata-cursor-theme)
|
||||
|
||||
#### Fedora
|
||||
|
||||
|
|
@ -187,76 +171,63 @@ Run the `uninstall.bat` script packed with the `.zip` archive
|
|||
|
||||
## Build From Source
|
||||
|
||||
#### Notes
|
||||
|
||||
- Bibata 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 Bibata's colors, and bitmaps, or generate a png
|
||||
file from a svg, Then you can use yarn because bitmapper is written in TypeScript.
|
||||
- Since Bibata Modern and Bibata Original 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`)
|
||||
- [attrs](https://github.com/python-attrs/attrs)>=22.2.0 (`pip install attrs`)
|
||||
- [clickgen](https://github.com/ful1e5/clickgen)>=2.1.8 (`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/Bibata_Cursor`
|
||||
3. `cd Bibata_Cursor && yarn build`
|
||||
4. See [Installing Bibata Cursor](#installing-bibata-cursor).
|
||||
3. `cd Bibata_Cursor`
|
||||
4. `yarn install`
|
||||
5. `yarn generate`
|
||||
6. See [Installing Bibata Cursor](#installing-bibata-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 Bibata's variants and packed them into `yarn build`:
|
||||
#### Crafting Your Bibata
|
||||
|
||||
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/Bibata-Modern-Amber' -n 'Bibata-Modern-Amber' -c 'Yellowish and rounded edge bibata cursors.'
|
||||
ctgen build.toml -d 'bitmaps/Bibata-Modern-Classic' -n 'Bibata-Modern-Classic' -c 'Black and rounded edge Bibata cursors.'
|
||||
ctgen build.toml -d 'bitmaps/Bibata-Modern-Ice' -n 'Bibata-Modern-Ice' -c 'White and rounded edge Bibata cursors.'
|
||||
|
||||
ctgen build.toml -d 'bitmaps/Bibata-Original-Amber' -n 'Bibata-Original-Amber' -c 'Yellowish and sharp edge Bibata cursors.'
|
||||
ctgen build.toml -d 'bitmaps/Bibata-Original-Classic' -n 'Bibata-Original-Classic' -c 'Black and sharp edge Bibata cursors.'
|
||||
ctgen build.toml -d 'bitmaps/Bibata-Original-Ice' -n 'Bibata-Original-Ice' -c 'White and sharp edge Bibata 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/Bibata-Modern-Ice' -n 'Bibata-Modern-Ice' -c 'White and rounded egde bibata cusors with size 16'
|
||||
```
|
||||
|
|
@ -278,40 +249,21 @@ ctgen build.toml -s 16 -p x11 -d 'bitmaps/Bibata-Modern-Ice' -n 'Bibata-Modern-I
|
|||
You can also assign multiple sizes to `ctgen` for XCursors build:
|
||||
|
||||
```bash
|
||||
ctgen build.toml -s 16 24 32 -p x11 -d 'bitmaps/Bibata-Modern-Ice' -n 'Bibata-Modern-Ice' -c 'Custom white and rounded egde Bibata cursors'
|
||||
```
|
||||
|
||||
#### Customize Colors
|
||||
|
||||
To customize bibata'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 Bibata's bitmaps and packed them into `yarn render`:
|
||||
|
||||
```bash
|
||||
npx cbmp -d 'svg/modern' -n 'Bibata-Modern-Amber' -bc '#FF8300' -oc '#FFFFFF' -wc '#001524'
|
||||
npx cbmp -d 'svg/modern' -n 'Bibata-Modern-Classic' -bc '#000000' -oc '#FFFFFF'
|
||||
npx cbmp -d 'svg/modern' -n 'Bibata-Modern-Ice' -bc '#FFFFFF' -oc '#000000'
|
||||
npx cbmp -d 'svg/original' -n 'Bibata-Original-Amber' -bc '#FF8300' -oc '#FFFFFF' -wc '#001524'
|
||||
npx cbmp -d 'svg/original' -n 'Bibata-Original-Classic' -bc '#000000' -oc '#FFFFFF'
|
||||
npx cbmp -d 'svg/original' -n 'Bibata-Original-Ice' -bc '#FFFFFF' -oc '#000000'
|
||||
ctgen build.toml -s 16 18 24 32 -p x11 -d 'bitmaps/Bibata-Modern-Ice' -n 'Bibata-Modern-Ice' -c 'Custom white and rounded egde Bibata cursors'
|
||||
```
|
||||
|
||||
#### Examples
|
||||
|
||||
Lets generate modern Bibata with green base color and black outline:
|
||||
Lets generate Bibata-Modern with green and black colors:
|
||||
|
||||
```bash
|
||||
npx cbmp -d 'svg/modern' -n 'Bibata-Hacker' -bc '#00FE00' -oc '#000000' -wc '#001524'
|
||||
npx cbmp -d 'svg/modern' -o 'bitmaps/Bibata-Hacker' -bc '#00FE00' -oc '#000000'
|
||||
```
|
||||
|
||||
After rendering custom color you have to build cursor through `ctgen`:
|
||||
|
||||
```bash
|
||||
ctgen build.toml -d 'bitmaps/Bibata-Hacker' -n 'Bibata-Hacker' -c 'Green and black Bibata cursors.'
|
||||
ctgen build.toml -d 'bitmaps/Bibata-Hacker' -n 'Bibata-Hacker' -c 'Green and Black Bibata cursors.'
|
||||
```
|
||||
|
||||
Afterwards, Generated theme can be found in the `themes` directory.
|
||||
|
|
@ -319,28 +271,28 @@ Afterwards, Generated theme can be found in the `themes` directory.
|
|||
###### Bibata Gruvbox
|
||||
|
||||
```bash
|
||||
npx cbmp -d 'svg/original' -n 'Bibata-Gruvbox' -bc '#282828' -oc '#EBDBB2' -wc '#000000'
|
||||
npx cbmp -d 'svg/original' -o 'bitmaps/Bibata-Gruvbox' -bc '#282828' -oc '#EBDBB2' -wc '#000000'
|
||||
ctgen build.toml -d 'bitmaps/Bibata-Gruvbox' -n 'Bibata-Gruvbox' -c 'Groovy Bibata cursors.'
|
||||
```
|
||||
|
||||
###### Bibata Solarized Dark
|
||||
|
||||
```bash
|
||||
npx cbmp -d 'svg/original' -n 'Bibata-Solarized-Dark' -bc '#002b36' -oc '#839496' -wc '#000000'
|
||||
npx cbmp -d 'svg/original' -o 'bitmaps/Bibata-Solarized-Dark' -bc '#002b36' -oc '#839496' -wc '#000000'
|
||||
ctgen build.toml -d 'bitmaps/Bibata-Solarized-Dark' -n 'Bibata-Solarized-Dark' -c 'Solarized Dark Bibata cursors.'
|
||||
```
|
||||
|
||||
###### Bibata Solarized Light
|
||||
|
||||
```bash
|
||||
npx cbmp -d 'svg/original' -n 'Bibata-Solarized-Light' -bc '#839496' -oc '#002b36'
|
||||
npx cbmp -d 'svg/original' -o 'bitmaps/Bibata-Solarized-Light' -bc '#839496' -oc '#002b36'
|
||||
ctgen build.toml -d 'bitmaps/Bibata-Solarized-Light' -n 'Bibata-Solarized-Light' -c 'Solarized Light Bibata cursors.'
|
||||
```
|
||||
|
||||
###### Bibata Dracula
|
||||
|
||||
```bash
|
||||
npx cbmp -d 'svg/original' -n 'Bibata-Dracula' -bc '#282a36' -oc '#f8f8f2'
|
||||
npx cbmp -d 'svg/original' -o 'bitmaas/Bibata-Dracula' -bc '#282a36' -oc '#f8f8f2'
|
||||
ctgen build.toml -d 'bitmaps/Bibata-Dracula' -n 'Bibata-Dracula' -c 'Dracula Bibata cursors.'
|
||||
```
|
||||
|
||||
|
|
@ -349,8 +301,6 @@ ctgen build.toml -d 'bitmaps/Bibata-Dracula' -n 'Bibata-Dracula' -c 'Dracula Bib
|
|||
- [**Bibata Adapta**](https://gitlab.com/cscs/Bibata_AdaptaBreath_Cursors) - Bibata Based Cursor Made for AdaptaBreath and Manjaro.
|
||||
- [**Bibata Translucent**](https://github.com/Silicasandwhich/Bibata_Cursor_Translucent) - Bibata translucent is a translucent flavor of the Bibata.
|
||||
|
||||
Write markdown as i wrote and fix grammer and link sentence and make it informative with tilte according to sentences:
|
||||
|
||||
## 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.
|
||||
|
|
|
|||
|
|
@ -3,8 +3,8 @@
|
|||
<g filter="url(#filter0_d_2652_63)">
|
||||
<path d="M232.96 128.64C232.96 186.961 185.681 234.24 127.36 234.24C69.0387 234.24 21.76 186.961 21.76 128.64C21.76 70.3188 69.0387 23.04 127.36 23.04C185.681 23.04 232.96 70.3188 232.96 128.64Z" fill="#0000FF"/>
|
||||
</g>
|
||||
<path d="M216.714 128.64C216.714 177.989 176.709 217.994 127.36 217.994C78.0112 217.994 38.0062 177.989 38.0062 128.64C38.0062 79.2912 78.0112 39.2861 127.36 39.2861C176.709 39.2861 216.714 79.2912 216.714 128.64Z" fill="#FE0000"/>
|
||||
<path d="M128.001 72.96C112.392 72.9599 97.4223 78.956 86.3814 89.63C75.3405 100.304 69.1315 114.783 69.12 129.884C69.1149 137.093 70.5243 144.238 73.2737 150.94L172.014 92.1281C166.494 86.106 159.717 81.284 152.131 77.98C144.544 74.6761 136.32 72.9651 128.001 72.96ZM182.726 108.755L83.9134 167.567C89.4282 173.624 96.2106 178.478 103.811 181.808C111.412 185.137 119.657 186.867 128.001 186.88C135.735 186.88 143.394 185.405 150.54 182.541C157.686 179.676 164.178 175.477 169.646 170.184C175.114 164.891 179.45 158.608 182.407 151.693C185.365 144.778 186.884 137.367 186.88 129.884C186.895 122.65 185.485 115.479 182.726 108.755Z" fill="white"/>
|
||||
<path d="M216.64 128.32C216.64 177.65 176.65 217.64 127.32 217.64C77.9899 217.64 38 177.65 38 128.32C38 78.9899 77.9899 39 127.32 39C176.65 39 216.64 78.9899 216.64 128.32Z" fill="#FE0000"/>
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M113.149 129.398L82.4062 98.6557L96.0697 84.9922L126.812 115.735L157.555 84.9922L171.219 98.6556L140.476 129.398L171.219 160.141L157.555 173.805L126.812 143.062L96.0697 173.805L82.4063 160.141L113.149 129.398Z" fill="white"/>
|
||||
<defs>
|
||||
<filter id="filter0_d_2652_63" x="15.36" y="21.76" width="224" height="224" filterUnits="userSpaceOnUse" color-interpolation-filters="sRGB">
|
||||
<feFlood flood-opacity="0" result="BackgroundImageFix"/>
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 1.9 KiB After Width: | Height: | Size: 1.5 KiB |
|
|
@ -11,9 +11,9 @@
|
|||
chalk "^2.4.2"
|
||||
|
||||
"@babel/helper-validator-identifier@^7.22.5":
|
||||
version "7.22.15"
|
||||
resolved "https://registry.yarnpkg.com/@babel/helper-validator-identifier/-/helper-validator-identifier-7.22.15.tgz#601fa28e4cc06786c18912dca138cec73b882044"
|
||||
integrity sha512-4E/F9IIEi8WR94324mbDUMo074YTheJmd7eZF5vITTeYchqAi6sYXRLHUVsmkdmY4QjfKTcB2jB7dVP3NaBElQ==
|
||||
version "7.22.19"
|
||||
resolved "https://registry.yarnpkg.com/@babel/helper-validator-identifier/-/helper-validator-identifier-7.22.19.tgz#2f34ab1e445f5b95e2e6edfe50ea2449e610583a"
|
||||
integrity sha512-Tinq7ybnEPFFXhlYOYFiSjespWQk0dq2dRNAiMdRTOYQzEGqnnNyrTxPYHP5r6wGjlF1rFgABdDV0g8EwD6Qbg==
|
||||
|
||||
"@babel/highlight@^7.22.13":
|
||||
version "7.22.13"
|
||||
|
|
|
|||
Loading…
Reference in a new issue