Merge pull request #144 from ful1e5/chore/v2.0.4-prep
Prep: Bibata v2.0.4
41
.github/workflows/build.yml
vendored
|
@ -16,27 +16,42 @@ on:
|
|||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ${{ matrix.os }}
|
||||
strategy:
|
||||
matrix:
|
||||
os: [ubuntu-latest, macos-latest, windows-latest]
|
||||
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
|
||||
runs-on: "ubuntu-latest"
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Set up Python ${{ matrix.python-version }}
|
||||
uses: actions/setup-python@v2
|
||||
- name: Setup node
|
||||
uses: actions/setup-node@v3
|
||||
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@v3
|
||||
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 `Bibata Modern Amber` Cursors
|
||||
run: ctgen build.toml -n 'Bibata-Modern-Amber' -c 'Yellowish and rounded edge Bibata cursors.' -d 'bitmaps/Bibata-Modern-Amber'
|
||||
|
|
5
.gitignore
vendored
|
@ -1,6 +1,7 @@
|
|||
# Custom
|
||||
themes
|
||||
bin
|
||||
themes/
|
||||
bin/
|
||||
bitmaps/
|
||||
|
||||
# Byte-compiled / optimized / DLL files
|
||||
__pycache__/
|
||||
|
|
105
CHANGELOG.md
|
@ -7,17 +7,37 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
|
||||
## [unreleased]
|
||||
|
||||
## [v2.0.4] - 15 September 2023
|
||||
|
||||
### :warning: Breaking Changes
|
||||
|
||||
> **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?
|
||||
|
||||
- docs: Added list of websites for testing cursor states in README (fixed #123)
|
||||
- ci: Added build support with `python 3.11`
|
||||
- Pointer Actions Cursor is Re-Designed
|
||||
![Screenshot_20230915_101854](https://github.com/ful1e5/Bibata_Cursor/assets/24286590/2ea91fb0-7338-4886-872a-a871230325f1)
|
||||
|
||||
### Changed
|
||||
- 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`.
|
||||
- Animated cursors now have fewer frames, Fixes #134.
|
||||
- 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.
|
||||
|
||||
### Changes
|
||||
|
||||
- Use 'xz' for better compression in `release` script #140
|
||||
- correct AUR Package in `README.md` #142
|
||||
- Corrected the AUR Package information in `README.md`, addressing issue #142.
|
||||
|
||||
## [Bibata v2.0.3] - 06 December 2022
|
||||
### Issues Fixes
|
||||
|
||||
- docs: Added list of websites for testing cursor states in README (fixed #123)
|
||||
|
||||
## [v2.0.3] - 06 December 2022
|
||||
|
||||
### Added
|
||||
|
||||
|
@ -32,7 +52,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
- chore: Symlink `dnd-move` with `grabbing` cursor
|
||||
- chore: Simplify svg code
|
||||
|
||||
## [Bibata v2.0.2] - 10 October 2022
|
||||
## [v2.0.2] - 10 October 2022
|
||||
|
||||
### Changed
|
||||
|
||||
|
@ -40,13 +60,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
- Fix blurry Windows Cursors in Small versions #119 #116
|
||||
- Fix custom outline and base color #104
|
||||
|
||||
## [Bibata v2.0.1] - 03 October 2022
|
||||
## [v2.0.1] - 03 October 2022
|
||||
|
||||
### Changed
|
||||
|
||||
- Fix transparency pixels distortion in XCursors #118
|
||||
|
||||
## [Bibata v2.0.0] - 03 October 2022
|
||||
## [v2.0.0] - 03 October 2022
|
||||
|
||||
### Added
|
||||
|
||||
|
@ -65,7 +85,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
- Fix [Modern Classic] I-Beam cursor is blurry #117
|
||||
- Make Outline more visible in cursors
|
||||
|
||||
## [Bibata v1.1.2] - 12 July 2021
|
||||
## [v1.1.2] - 12 July 2021
|
||||
|
||||
### Added
|
||||
|
||||
|
@ -83,7 +103,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
- `Makefile` build commands re-arrange with groups
|
||||
- Dynamic determine **Windows canvas size** on **Windows cursor size** inside build.py`
|
||||
|
||||
## [Bibata v1.1.1] - 26 March 2021
|
||||
## [v1.1.1] - 26 March 2021
|
||||
|
||||
### Added
|
||||
|
||||
|
@ -106,7 +126,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
- Format `svg` files
|
||||
- Remove old username of an author with Contributors table
|
||||
|
||||
## [Bibata v1.1.0] - 26 February 2021
|
||||
## [v1.1.0] - 26 February 2021
|
||||
|
||||
### Added
|
||||
|
||||
|
@ -136,7 +156,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
- Fix Cursors not available for Login Window in Linux Mint 20 #88
|
||||
- Dirty pixel in `move` cursor fixed #94
|
||||
|
||||
## [Bibata v1.0.3] - 10 November 2020
|
||||
## [v1.0.3] - 10 November 2020
|
||||
|
||||
### Added
|
||||
|
||||
|
@ -152,7 +172,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
- fixed #82 improvement to X-cursor (feature request)
|
||||
- fixed #81 Corner resize cursors are not coloured (bug)
|
||||
|
||||
## [Bibata v1.0.2] - 30 October 2020
|
||||
## [v1.0.2] - 30 October 2020
|
||||
|
||||
### Added
|
||||
|
||||
|
@ -168,7 +188,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
- locked clickgen to **1.1.7**
|
||||
- Package information provider module changed to `builder/pkg_info.py`
|
||||
|
||||
## [Bibata v1.0.1] - 08 October 2020
|
||||
## [v1.0.1] - 08 October 2020
|
||||
|
||||
### Added
|
||||
|
||||
|
@ -188,7 +208,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
- #76 Wrong implementation resize cursors **[closed]**
|
||||
- #74 `Pillow` pip requirements checking in installation of **clickgen**
|
||||
|
||||
## [Bibata v1.0.0] - 03 October 2020
|
||||
## [v1.0.0] - 03 October 2020
|
||||
|
||||
### Changed
|
||||
|
||||
|
@ -212,19 +232,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
- Customizable Colors in **Bibata** Cursors.
|
||||
- Auto framing in animated cursors with [**pixelmatch**](https://github.com/mapbox/pixelmatch)
|
||||
|
||||
## [Bibata v0.4.2] - 12 January 2020
|
||||
## [v0.4.2] - 12 January 2020
|
||||
|
||||
### Changed
|
||||
|
||||
- same names in Oil and Classic [Fixed again]
|
||||
|
||||
## [Bibata v0.4.2.beta.1] - 22 December 2019
|
||||
## [v0.4.2.beta.1] - 22 December 2019
|
||||
|
||||
### Changed
|
||||
|
||||
- Bibata Logo resigned
|
||||
|
||||
## [Bibata v0.4.2.alpha.2] - 01 December 2019
|
||||
## [v0.4.2.alpha.2] - 01 December 2019
|
||||
|
||||
### Added
|
||||
|
||||
|
@ -238,7 +258,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
- Bibata Amber Color changed to #FF8000
|
||||
- Bibata Oil is inspired on **adwaita gtk** theme color #272728
|
||||
|
||||
## [Bibata v0.4.2.alpha.1] - 13 November 2019
|
||||
## [v0.4.2.alpha.1] - 13 November 2019
|
||||
|
||||
### Added
|
||||
|
||||
|
@ -253,42 +273,43 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
- Cursor's corner-shape changed
|
||||
- Hot-spots changed
|
||||
|
||||
## [Bibata v.0.4.1] - 03 September 2018
|
||||
## [v.0.4.1] - 03 September 2018
|
||||
|
||||
### Changed
|
||||
|
||||
- Locations Fixed
|
||||
- AUR added in README.md
|
||||
|
||||
## [Bibata v0.3.1] - 16 March 2018
|
||||
## [v0.3.1] - 16 March 2018
|
||||
|
||||
### Changed
|
||||
|
||||
- Redesign Crosshair
|
||||
|
||||
## [Bibata v0.3] - 03 February 2018
|
||||
## [v0.3] - 03 February 2018
|
||||
|
||||
### Added
|
||||
|
||||
- Initial release 🎊
|
||||
|
||||
[unreleased]: https://github.com/ful1e5/Bibata_Cursor/compare/v2.0.3...main
|
||||
[bibata v2.0.3]: https://github.com/ful1e5/Bibata_Cursor/compare/v2.0.2...v2.0.3
|
||||
[bibata v2.0.2]: https://github.com/ful1e5/Bibata_Cursor/compare/v2.0.1...v2.0.2
|
||||
[bibata v2.0.1]: https://github.com/ful1e5/Bibata_Cursor/compare/v2.0.0...v2.0.1
|
||||
[bibata v2.0.0]: https://github.com/ful1e5/Bibata_Cursor/compare/v1.1.2...v2.0.0
|
||||
[bibata v1.1.2]: https://github.com/ful1e5/Bibata_Cursor/compare/v1.1.1...v1.1.2
|
||||
[bibata v1.1.1]: https://github.com/ful1e5/Bibata_Cursor/compare/v1.1.0...v1.1.1
|
||||
[bibata v1.1.0]: https://github.com/ful1e5/Bibata_Cursor/compare/v1.0.3...v1.1.0
|
||||
[bibata v1.0.3]: https://github.com/ful1e5/Bibata_Cursor/compare/v1.0.2...v1.0.3
|
||||
[bibata v1.0.2]: https://github.com/ful1e5/Bibata_Cursor/compare/v1.0.1...v1.0.2
|
||||
[bibata v1.0.1]: https://github.com/ful1e5/Bibata_Cursor/compare/v1.0.0...v1.0.1
|
||||
[bibata v1.0.0]: https://github.com/ful1e5/Bibata_Cursor/compare/v0.4.2...v1.0.0
|
||||
[bibata v0.4.2]: https://github.com/ful1e5/Bibata_Cursor/compare/v0.4.2.beta.1...v0.4.2
|
||||
[bibata v0.4.2.beta.1]: https://github.com/ful1e5/Bibata_Cursor/compare/v0.4.2.alpha.2...v0.4.2.beta.1
|
||||
[bibata v0.4.2.alpha.2]: https://github.com/ful1e5/Bibata_Cursor/compare/v0.4.2.alpha.1...v0.4.2.alpha.2
|
||||
[bibata v0.4.2.alpha.1]: https://github.com/ful1e5/Bibata_Cursor/compare/v0.4.1...v0.4.2.alpha.1
|
||||
[bibata v.0.4.1]: https://github.com/ful1e5/Bibata_Cursor/compare/v0.3.1...v0.4.1
|
||||
[bibata v0.3.1]: https://github.com/ful1e5/Bibata_Cursor/compare/v0.3...v0.3.1
|
||||
[bibata v0.3]: https://github.com/ful1e5/Bibata_Cursor/tree/v0.3
|
||||
[bibata v0.3]: https://github.com/ful1e5/Bibata_Cursor/tree/v0.3
|
||||
[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
|
||||
[v2.0.0]: https://github.com/ful1e5/Bibata_Cursor/compare/v1.1.2...v2.0.0
|
||||
[v1.1.2]: https://github.com/ful1e5/Bibata_Cursor/compare/v1.1.1...v1.1.2
|
||||
[v1.1.1]: https://github.com/ful1e5/Bibata_Cursor/compare/v1.1.0...v1.1.1
|
||||
[v1.1.0]: https://github.com/ful1e5/Bibata_Cursor/compare/v1.0.3...v1.1.0
|
||||
[v1.0.3]: https://github.com/ful1e5/Bibata_Cursor/compare/v1.0.2...v1.0.3
|
||||
[v1.0.2]: https://github.com/ful1e5/Bibata_Cursor/compare/v1.0.1...v1.0.2
|
||||
[v1.0.1]: https://github.com/ful1e5/Bibata_Cursor/compare/v1.0.0...v1.0.1
|
||||
[v1.0.0]: https://github.com/ful1e5/Bibata_Cursor/compare/v0.4.2...v1.0.0
|
||||
[v0.4.2]: https://github.com/ful1e5/Bibata_Cursor/compare/v0.4.2.beta.1...v0.4.2
|
||||
[v0.4.2.beta.1]: https://github.com/ful1e5/Bibata_Cursor/compare/v0.4.2.alpha.2...v0.4.2.beta.1
|
||||
[v0.4.2.alpha.2]: https://github.com/ful1e5/Bibata_Cursor/compare/v0.4.2.alpha.1...v0.4.2.alpha.2
|
||||
[v0.4.2.alpha.1]: https://github.com/ful1e5/Bibata_Cursor/compare/v0.4.1...v0.4.2.alpha.1
|
||||
[v.0.4.1]: https://github.com/ful1e5/Bibata_Cursor/compare/v0.3.1...v0.4.1
|
||||
[v0.3.1]: https://github.com/ful1e5/Bibata_Cursor/compare/v0.3...v0.3.1
|
||||
[v0.3]: https://github.com/ful1e5/Bibata_Cursor/tree/v0.3
|
||||
[v0.3]: https://github.com/ful1e5/Bibata_Cursor/tree/v0.3
|
||||
|
|
178
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 -->
|
||||
|
||||
![shoutout-sponsors](https://sponsor-spotlight.vercel.app/sponsor?login=ful1e5)
|
||||
|
||||
# Bibata Cursor
|
||||
|
||||
[![build](https://github.com/ful1e5/Bibata_Cursor/actions/workflows/build.yml/badge.svg)](https://github.com/ful1e5/Bibata_Cursor/actions/workflows/build.yml)
|
||||
|
@ -15,34 +10,41 @@ 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
|
||||
#### Bibata: End of an Era (v2.x.x Marks the Final Major Version)
|
||||
|
||||
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.
|
||||
I wanted to give you a quick update on what's happening with my open-source projects. You may have noticed that I haven't been very active on this particular repository lately. That's because I've been keeping myself busy with a bunch of other exciting open-source ventures.
|
||||
|
||||
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.
|
||||
One of those projects is [bibata.live](https://github.com/ful1e5/bibata.live). I'm super enthusiastic about turning this project into a user-friendly web application, **without archiving this repo**. The idea is to allow you to download customized versions of Bibata with just a few clicks, eliminating the need for complex commands and headaches. It's all about simplicity and convenience.
|
||||
|
||||
Now, here's where you come in! I'm currently facing a bit of a time crunch, and I'd love your support. By sponsoring this project with just **$1 or more**, you can help me speed up its development and make it a reality as soon as possible. Your contribution goes a long way in fueling the project's progress.
|
||||
|
||||
But that's not all! If you encounter any issues with any of my other projects, you can also reach out to me live on [twitch.tv/ful1e5](https://www.twitch.com/ful1e5). Your feedback and bug reports are incredibly valuable, and they help me improve my work.
|
||||
|
||||
To make this journey even more exciting, you can join me on the [Github Sponsor](https://www.github.com/sponsors/ful1e5) program. Together, we can work towards achieving my sponsorship goal and keep these open-source projects thriving.
|
||||
|
||||
Your support means a lot to me, and it brings us one step closer to making 'bibata.live' and other projects even better. Let's make open-source magic happen! Thank you for being a part of this adventure.
|
||||
|
||||
## Notes
|
||||
|
||||
- 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).
|
||||
|
||||
<!-- 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 -->
|
||||
|
||||
![shoutout-sponsors](https://sponsor-spotlight.vercel.app/sponsor?login=ful1e5)
|
||||
|
||||
---
|
||||
|
||||
![Bibata Amber](https://imgur.com/MWe8MYK.png)
|
||||
![Bibata Classic](https://imgur.com/JfQHy62.png)
|
||||
![Bibata Ice](https://imgur.com/zZv7Y6L.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/Y9RKZLXhSvaxpUzsKGJkp6/Bibata-Cursor?node-id=0%3A1).
|
||||
![Bibata Amber](https://github.com/ful1e5/Bibata_Cursor/assets/24286590/67c8afbf-2de8-4a0c-b13d-aec5dd3ba8fb)
|
||||
![Bibata Classic](https://github.com/ful1e5/Bibata_Cursor/assets/24286590/b96a5ba5-6de9-485b-a15b-6e35c16678d6)
|
||||
![Bibata Ice](https://github.com/ful1e5/Bibata_Cursor/assets/24286590/044d7881-a3d7-4ee2-a1c6-df0755624c36)
|
||||
|
||||
## Variants:
|
||||
|
||||
|
@ -57,6 +59,8 @@ which enables me to continue working on open source projects full-time. Thank yo
|
|||
|
||||
### Xcursor Sizes:
|
||||
|
||||
<kbd>16</kbd>
|
||||
<kbd>20</kbd>
|
||||
<kbd>22</kbd>
|
||||
<kbd>24</kbd>
|
||||
<kbd>28</kbd>
|
||||
|
@ -112,18 +116,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 +187,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 +265,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 +287,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 +317,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.
|
||||
|
|
Before Width: | Height: | Size: 4.8 KiB After Width: | Height: | Size: 5.6 KiB |
Before Width: | Height: | Size: 4.7 KiB After Width: | Height: | Size: 5.4 KiB |
Before Width: | Height: | Size: 7.7 KiB After Width: | Height: | Size: 7.8 KiB |
Before Width: | Height: | Size: 2.9 KiB After Width: | Height: | Size: 2.9 KiB |
Before Width: | Height: | Size: 8.4 KiB After Width: | Height: | Size: 8.5 KiB |
Before Width: | Height: | Size: 8.6 KiB After Width: | Height: | Size: 8.9 KiB |
Before Width: | Height: | Size: 8.4 KiB After Width: | Height: | Size: 8.4 KiB |
Before Width: | Height: | Size: 8.9 KiB After Width: | Height: | Size: 9.2 KiB |
Before Width: | Height: | Size: 4.8 KiB After Width: | Height: | Size: 4.9 KiB |
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 6 KiB After Width: | Height: | Size: 6.1 KiB |
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 13 KiB |
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 3.1 KiB After Width: | Height: | Size: 3.2 KiB |
Before Width: | Height: | Size: 6.1 KiB After Width: | Height: | Size: 7 KiB |
Before Width: | Height: | Size: 9.2 KiB After Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 8.1 KiB After Width: | Height: | Size: 8.2 KiB |
Before Width: | Height: | Size: 6.8 KiB After Width: | Height: | Size: 6.7 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 9.9 KiB |
Before Width: | Height: | Size: 9.6 KiB |
Before Width: | Height: | Size: 9.3 KiB |
Before Width: | Height: | Size: 9.4 KiB |
Before Width: | Height: | Size: 9.8 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 11 KiB |