2020-09-05 01:19:03 -04:00
<!-- Branding -->
2020-08-13 00:10:25 -04:00
< p align = "center" >
2020-10-02 08:29:04 -04:00
< img src = "https://imgur.com/cfkawDi.png" width = "40%" >
2020-08-13 00:10:25 -04:00
< / p >
< p align = "center" >
2020-10-02 08:15:24 -04:00
< b > Material Based Cursors< / b > 🚀
2020-08-13 00:10:25 -04:00
< / p >
2019-11-12 23:48:09 -05:00
2020-08-13 00:10:25 -04:00
<!-- Badges -->
2019-11-12 23:48:09 -05:00
< p align = "center" >
2020-08-13 00:10:25 -04:00
<!-- First Row -->
2020-09-05 08:29:29 -04:00
2020-11-14 06:43:16 -05:00
< a href = "https://github.com/ful1e5/Bibata_Cursor/actions?query=workflow%3Abibata-ci" >
2020-11-14 07:01:14 -05:00
< img alt = "GitHub Action Build" src = "https://github.com/ful1e5/Bibata_Cursor/workflows/bibata-ci/badge.svg" / >
2020-09-05 08:29:29 -04:00
< / a >
< a href = "https://www.codefactor.io/repository/github/ful1e5/bibata_cursor" >
< img src = "https://www.codefactor.io/repository/github/ful1e5/bibata_cursor/badge" alt = "CodeFactor" / >
< / a >
<!-- Second Row -->
< / br >
< a href = "https://www.typescriptlang.org/docs/handbook/typescript-from-scratch.html" >
< img alt = "npm type definitions" src = "https://img.shields.io/npm/types/typescript" >
< / a >
< a href = "https://github.com/ful1e5/clickgen" >
< img alt = "Clickgen" src = "https://img.shields.io/badge/theme%20builder-clickgen-FD0542" / >
< / a >
2020-08-13 00:10:25 -04:00
2020-09-05 08:29:29 -04:00
<!-- Third Row -->
< / br >
2020-10-01 00:33:27 -04:00
< a href = "https://github.com/ful1e5/Bibata_Cursor/blob/main/LICENSE" >
2020-08-13 00:10:25 -04:00
< img alt = "License" src = "https://img.shields.io/github/license/ful1e5/Bibata_Cursor?color=0081FB" / >
< / a >
2020-11-14 06:51:42 -05:00
< a href = "https://github.com/ful1e5/Bibata_Cursor/releases" >
< img alt = "GitHub release (latest by date)" src = "https://img.shields.io/github/v/release/ful1e5/Bibata_Cursor" >
2020-08-13 00:10:25 -04:00
< / a >
< a href = "https://aur.archlinux.org/packages/bibata-cursor-theme" >
< img alt = "AUR version" src = "https://img.shields.io/aur/version/bibata-cursor-theme" >
< / a >
2020-09-05 08:29:29 -04:00
2020-09-05 08:34:14 -04:00
<!-- Fourth Row -->
2020-09-05 08:29:29 -04:00
2020-08-13 00:10:25 -04:00
< br / >
2020-09-05 08:29:29 -04:00
< a href = "https://www.pling.com/p/1197198/#files-panel" >
< img alt = "License" src = "https://img.shields.io/badge/-Linux-grey?logo=linux" / >
2020-09-05 01:01:06 -04:00
< / a >
2020-09-05 08:29:29 -04:00
< a href = "https://www.pling.com/p/1197198/#files-panel" >
< img alt = "License" src = "https://img.shields.io/badge/-Windows-blue?logo=windows" / >
< / a >
2020-09-05 08:34:14 -04:00
<!-- Fifth Row -->
2020-09-05 08:29:29 -04:00
< br / >
2020-08-13 00:10:25 -04:00
< a href = "https://github.com/ful1e5" >
< img alt = "Made By Kaiz" src = "https://kaiz.vercel.app/api/badge" width = "133" / >
< / a >
2020-09-05 08:29:29 -04:00
2019-11-12 23:48:09 -05:00
< / p >
2018-10-21 10:28:46 -04:00
2020-08-13 00:22:03 -04:00
---
2018-10-13 03:51:42 -04:00
2020-08-13 00:22:03 -04:00
<!-- Table Of Content -->
2020-09-05 01:19:03 -04:00
2020-08-13 00:22:03 -04:00
< details >
< summary > < strong > Table of Contents< / strong > (click to expand)< / summary >
2020-09-19 07:31:18 -04:00
- [Bibata ? ](#bibata- )
- [Bibata Styles ](#bibata-styles )
- [Cursor Sizes ](#cursor-sizes )
- [Colors ](#colors )
2020-11-14 06:39:26 -05:00
- [Preview ](#preview )
2020-09-19 07:31:18 -04:00
- [Quick install ](#quick-install )
- [Packages 📦 ](#packages- )
- [Arch Linux/Manjaro ](#arch-linuxmanjaro )
- [Fedora ](#fedora )
- [Manual Install ](#manual-install )
2020-10-06 03:10:35 -04:00
- [Linux/X11 ](#linuxx11 )
- [Windows ](#windows )
2020-09-05 03:59:01 -04:00
- [Dependencies ](#dependencies )
- [Runtime Dependencies ](#runtime-dependencies )
2020-10-06 03:10:35 -04:00
- [Install Runtime Dependencies ](#install-runtime-dependencies )
- [macOS ](#macos )
- [Debain/ubuntu ](#debainubuntu )
- [ArchLinux/Manjaro ](#archlinuxmanjaro )
- [Fedora/Fedora Silverblue/CentOS/RHEL ](#fedorafedora-silverbluecentosrhel )
2020-09-05 03:59:01 -04:00
- [Build Dependencies ](#build-dependencies )
2020-09-18 08:24:49 -04:00
- [Node Packages ](#node-packages )
- [PyPi Packages ](#pypi-packages )
- [Build From Scratch ](#build-from-scratch )
- [⚡ Auto Build (using GitHub Actions) ](#-auto-build-using-github-actions )
- [Manual Build ](#manual-build )
- [Setup python environment ](#setup-python-environment )
- [Compile From Source ](#compile-from-source )
- [Install Node/PyPi Packages ](#install-nodepypi-packages )
2020-09-18 08:40:19 -04:00
- [Build `Bibata` ](#build-bibata )
- [Build `Bibata Modern` Only ](#build-bibata-modern-only )
- [Build `Bibata Original` Only ](#build-bibata-original-only )
2020-09-18 08:24:49 -04:00
- [Install Build Theme ](#install-build-theme )
- [Linux ](#linux )
- [Windows ](#windows-1 )
2020-09-19 07:31:18 -04:00
- [You may also like... ](#you-may-also-like )
2020-09-05 07:05:34 -04:00
- [Bugs ](#bugs )
- [Getting Help ](#getting-help )
2020-09-18 08:24:49 -04:00
- [Contributing ](#contributing )
2020-09-19 07:31:18 -04:00
- [Credit ](#credit )
- [Support ](#support )
2020-08-13 00:22:03 -04:00
< / details >
2020-11-14 07:08:36 -05:00
<!-- Sub Projects -->
< details >
< summary > < strong > Sub Projects< / strong > (click to expand)< / summary >
- [Bibata Rainbow ](./packages/rainbow )
< / details >
2020-09-05 01:19:03 -04:00
<!-- Bibata intro -->
2020-09-05 01:12:54 -04:00
2020-09-19 07:31:18 -04:00
# Bibata ?
2020-09-05 00:47:47 -04:00
2020-08-13 02:28:01 -04:00
Bibata is **OpenSource** , Compact and Material Designed Cursor set. This project masterelop for improve `Cursor` Experience.
2020-09-05 01:19:03 -04:00
- **Bibata Amber :** Yellowish Theme.
2020-08-13 02:28:01 -04:00
- **Bibata Classic :** Solid Black Theme.
- **Bibata Ice :** Light Theme.
2020-11-14 07:01:14 -05:00
2020-09-19 07:31:18 -04:00
## Bibata Styles
2020-09-05 07:47:31 -04:00
- **Bibata Original :** Sharp edge Bibata Cursors
- **Bibata Modern :** Round edge Bibata Cursors
2020-09-19 07:31:18 -04:00
## Cursor Sizes
2020-08-13 02:28:01 -04:00
2020-10-06 03:10:35 -04:00
< kbd > 22< / kbd >
2020-08-13 02:28:01 -04:00
< 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 >
2020-09-19 07:31:18 -04:00
## Colors
2020-08-13 02:28:01 -04:00
2020-09-05 00:47:47 -04:00
![Amber ](https://imgur.com/5Jo6MSO.png )
2020-08-13 02:28:01 -04:00
![Classic ](https://imgur.com/I5cRKE4.png )
![Ice ✓ ](https://imgur.com/avnR40g.png )
2020-11-14 06:39:26 -05:00
<!-- Preview -->
## Preview
< p align = "center" >
< img title = "Bibata Amber" width = "90%" src = "https://imgur.com/p60SQOq.png" >
< / br >
< sub > Bibata Amber< / sub >
< / p >
< p align = "center" >
< img title = "Bibata Classic" width = "90%" src = "https://imgur.com/WaqGcUF.png" >
< / br >
< sub > Bibata Classic< / sub >
< / p >
< p align = "center" >
< img title = "Bibata Ice" width = "90%" src = "https://imgur.com/ON1sd4H.png" >
< / br >
< sub > Bibata Ice< / sub >
< / p >
2020-09-19 07:31:18 -04:00
## Quick install
2020-09-05 01:02:13 -04:00
2020-09-19 07:42:42 -04:00
< p align = "center" >
2020-09-19 08:23:23 -04:00
< a href = "https://www.pling.com/p/1197198/" >
2020-09-19 07:46:57 -04:00
< img title = "Bibata Pling Store" width = "40%" src = "https://imgur.com/VxSgrWw.png" >
2020-09-19 07:44:36 -04:00
< / a >
2020-09-19 07:42:42 -04:00
< / p >
2020-09-19 07:31:18 -04:00
## Packages 📦
2020-09-05 03:40:59 -04:00
> **📝Note**: If you're having trouble with the packages please submit a request to the package maintainer before creating an issue.
2020-09-19 07:31:18 -04:00
### Arch Linux/Manjaro
2020-09-05 03:40:59 -04:00
2020-10-07 05:03:38 -04:00
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), Yay or any other [AUR helper ](https://wiki.archlinux.org/index.php/AUR_helpers ).
2020-09-05 03:40:59 -04:00
Pamac command:
```bash
2020-10-07 05:03:38 -04:00
pamac build bibata-cursor-theme
pamac build bibata-cursor-theme-bin # pre-built binary
2020-09-05 03:40:59 -04:00
```
Yay command:
```bash
yay -S bibata-cursor-theme
2020-10-07 05:03:38 -04:00
yay -S bibata-cursor-theme-bin # pre-built binary
2020-09-05 03:40:59 -04:00
```
2020-09-19 07:31:18 -04:00
### Fedora
2020-09-05 03:40:59 -04:00
Fedora users can install from the [copr-repo ](https://copr.fedorainfracloud.org/coprs/muhalantabli/copr-repo ) currently maintained by _@muhalantabli_ .
Enable the repo:
```bash
sudo dnf copr enable muhalantabli/copr-repo
```
Installation command:
```bash
sudo dnf install bibata-cursor-theme
```
2020-09-19 07:31:18 -04:00
## Manual Install
2020-09-05 01:12:54 -04:00
2020-09-05 08:07:56 -04:00
Latest `Stable` & `Development` releases can be downloaded from [Here ](https://github.com/ful1e5/Bibata_Cursor/releases )
2020-09-05 01:12:54 -04:00
#### Linux/X11
```bash
# extract `Bibata.tar.gz`
tar -xvf Bibata.tar.gz
# For local users
2020-10-05 02:57:17 -04:00
mv Bibata-* ~/.icons/
2020-09-05 01:12:54 -04:00
# For all users
2020-10-05 02:57:17 -04:00
sudo mv Bibata-* /usr/share/icons/
2020-09-05 01:12:54 -04:00
```
#### Windows
1. unzip `Bibata_Windows.zip` file
2. Open `Bibata_Windows/<Bibata_flavor>` in Explorer, and **right click** on `install.inf` .
2020-10-02 07:03:29 -04:00
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 **Bibata Cursors** .
2020-09-05 01:12:54 -04:00
5. Click '**Apply**'.
2020-09-05 03:40:59 -04:00
<!-- Build Dependencies -->
2018-09-03 07:38:53 -04:00
2020-09-05 03:40:59 -04:00
# Dependencies
2019-11-12 23:48:09 -05:00
2020-09-05 03:40:59 -04:00
## Runtime Dependencies
2019-11-12 23:48:09 -05:00
2020-09-05 03:40:59 -04:00
- libxcursor-dev
- libx11-dev
- libpng-dev (< =1.6)
2019-11-12 23:48:09 -05:00
2020-09-05 03:40:59 -04:00
#### Install Runtime Dependencies
2019-11-12 23:48:09 -05:00
2020-09-05 03:40:59 -04:00
##### macOS
2019-11-13 23:13:32 -05:00
2020-08-13 00:34:13 -04:00
```bash
2020-09-05 03:40:59 -04:00
brew cask install xquartz libpng
2019-11-13 23:13:32 -05:00
```
2019-11-12 23:48:09 -05:00
2020-09-05 03:40:59 -04:00
##### Debain/ubuntu
2018-09-03 07:38:53 -04:00
2020-08-13 00:34:13 -04:00
```bash
2020-09-05 03:40:59 -04:00
sudo apt install libx11-dev libxcursor-dev libpng-dev
2019-11-13 23:13:32 -05:00
```
2020-09-05 03:40:59 -04:00
##### ArchLinux/Manjaro
2020-08-13 00:43:32 -04:00
```bash
2020-09-05 03:40:59 -04:00
sudo pacman -S libx11 libxcursor libpng
2020-08-13 00:43:32 -04:00
```
2020-09-05 03:40:59 -04:00
##### Fedora/Fedora Silverblue/CentOS/RHEL
2020-08-13 00:43:32 -04:00
```bash
2020-09-05 03:40:59 -04:00
sudo dnf install libx11-devel libxcursor-devel libpng-devel
2020-08-13 00:43:32 -04:00
```
2020-09-05 03:40:59 -04:00
## Build Dependencies
2020-08-13 00:43:32 -04:00
2020-09-05 03:40:59 -04:00
- [nodejs ](https://nodejs.org/en/ ) (< =12.x.x)
- [yarn ](https://classic.yarnpkg.com/en/docs/install/ )
- [python3 ](https://www.python.org/downloads/ )
- [pip3 ](https://pip.pypa.io/en/stable/installing/ )
2020-08-13 00:43:32 -04:00
2020-09-05 03:40:59 -04:00
### Node Packages
2020-08-13 00:43:32 -04:00
2020-09-05 03:40:59 -04:00
- [puppeteer ](https://www.npmjs.com/package/puppeteer )
- [pngjs ](https://www.npmjs.com/package/pngjs )
- [pixelmatch ](https://www.npmjs.com/package/pixelmatch )
- [ora ](https://www.npmjs.com/package/ora )
- [chalk ](https://www.npmjs.com/package/chalk )
2020-08-13 00:43:32 -04:00
2020-09-05 03:40:59 -04:00
### PyPi Packages
2020-08-13 00:43:32 -04:00
2020-09-05 03:40:59 -04:00
- [clickgen ](https://pypi.org/project/clickgen/ )
2020-08-13 00:43:32 -04:00
2020-09-05 03:45:34 -04:00
## Build From Scratch
### ⚡ Auto Build (using GitHub Actions)
2020-11-14 07:25:52 -05:00
GitHub Actions is automatically runs on every `push` (on **main** & **dev** branch) and `pull request` (on **main** branch), You found theme resources in `artifact` section of **bibata-ci** . GitHub **Actions** available inside [.github/workflows ](https://github.com/ful1e5/Bibata_Cursor/tree/main/.github/workflows ) directory.
2020-09-05 03:45:34 -04:00
### Manual Build
#### Setup python environment
```bash
python3 -m pip install --upgrade pip # Update pip to latest
2020-10-11 01:12:56 -04:00
python3 -m pip install virtualenv # Install python virtual environment
2020-09-05 03:45:34 -04:00
virtualenv venv # Create new virtualenv named `venv`
source venv/bin/activate # Activate virtualenv
# For Deactivate virtualenv
deactivate
```
#### Compile From Source
2020-11-14 23:11:55 -05:00
> Make sure your [python environment](#setup-python-environment) setup and `virtualenv` is **active**.
2020-09-05 03:45:34 -04:00
2020-09-05 08:05:43 -04:00
#### Install Node/PyPi Packages
2020-09-05 03:45:34 -04:00
```bash
yarn install # Install all Node Packages
2020-10-11 01:12:56 -04:00
yarn py_install # Install all PyPi Packages with Bibata builder
2020-09-05 08:05:43 -04:00
```
2020-09-18 08:40:19 -04:00
#### Build `Bibata`
2020-09-05 08:05:43 -04:00
```bash
yarn render:bibata-modern # Render Bibata Modern Bitmaps
yarn render:bibata-original # Render Bibata Original Bitmaps
2020-10-07 06:05:59 -04:00
# Build cursors packages
yarn build # Build Windows & X11 packages
2020-10-10 08:09:37 -04:00
# OR
2020-10-07 06:05:59 -04:00
yarn build:x11 # Build only X11 packages
2020-10-10 08:09:37 -04:00
# OR
yarn build:win # Build only Windows cursors
2020-09-05 08:05:43 -04:00
```
2020-09-18 08:40:19 -04:00
#### Build `Bibata Modern` Only
2020-09-05 08:05:43 -04:00
```bash
yarn render:bibata-modern # Render Bibata Modern Bitmaps
2020-10-07 06:05:59 -04:00
# Build cursors packages
yarn build # Build Windows & X11 cursors
2020-10-10 08:09:37 -04:00
# OR
2020-10-07 06:05:59 -04:00
yarn build:x11 # Build only X11 cursors
2020-10-10 08:09:37 -04:00
# OR
yarn build:win # Build only Windows cursors
2020-09-05 08:05:43 -04:00
```
2020-09-18 08:40:19 -04:00
#### Build `Bibata Original` Only
2020-09-05 08:05:43 -04:00
```bash
yarn render:bibata-original # Render Bibata Original Bitmaps
2020-10-07 06:05:59 -04:00
# Build cursors packages
yarn build # Build Windows & Linux cursors
2020-10-10 08:09:37 -04:00
# OR
2020-10-07 06:05:59 -04:00
yarn build:x11 # Build only X11 cursors
2020-10-10 08:09:37 -04:00
# OR
yarn build:win # Build only Windows cursors
2020-09-05 03:45:34 -04:00
```
2020-09-05 03:50:03 -04:00
After build `bitmaps` and `themes` directory are generated at project **root** .
### Install Build Theme
All builded cursor themes are available inside `themes` directory.
#### Linux
```bash
cd ./themes
# installing Theme to local user(recommend)
2020-10-05 02:57:17 -04:00
rm -rf ~/.icons/Bibata-* & & cp -r Bibata-* ~/.icons/
2020-09-05 03:50:03 -04:00
```
#### Windows
1. Open the `settings` app.
2. **Goto** `Devices` -> `Mouse` -> `Additional Mouse Options` .
3. **Goto** the `pointers` tab.
4. Replace each cursor in the currently applied cursor set with the corresponding cursor in the `./themes/<Bibata_flavor>` folder.
5. Click "**save as**" and type in the desired name.
6. Click "**apply**" and "**ok**".
2020-10-02 07:03:29 -04:00
<!-- Other Interesting projects -->
2019-11-13 00:01:11 -05:00
2020-09-19 07:31:18 -04:00
# You may also like...
2019-11-12 23:48:09 -05:00
2020-11-14 06:51:42 -05:00
- [**Bibata Extra** ](https://github.com/ful1e5/Bibata_Extra_Cursor ) - More Bibata!
2019-11-12 23:48:09 -05:00
- [**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.
2018-09-03 07:38:53 -04:00
2020-09-05 03:40:59 -04:00
<!-- Bug Report -->
2018-09-03 07:38:53 -04:00
2020-09-05 03:40:59 -04:00
# Bugs
2018-09-03 07:38:53 -04:00
2020-11-14 06:51:42 -05:00
Bugs 🐛 should be reported [here ](https://github.com/ful1e5/Bibata_Cursor/issues ) on the Github issues page.
2018-09-03 07:38:53 -04:00
2020-09-05 03:40:59 -04:00
<!-- Help -->
2018-09-03 07:38:53 -04:00
2020-09-05 03:40:59 -04:00
# Getting Help
2018-09-03 07:38:53 -04:00
2020-09-05 03:40:59 -04:00
You can create a **issue** , I will help you. 🙂
<!-- Contributions and Suggestion -->
# Contributing
2018-09-03 07:38:53 -04:00
2020-09-05 03:40:59 -04:00
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` .
<!-- This project isn't possible without these 👇🏻 -->
2018-09-03 07:38:53 -04:00
2020-09-19 07:31:18 -04:00
# Credit
2018-10-21 10:13:55 -04:00
2019-11-12 23:48:09 -05:00
- [Adwaita ](https://github.com/GNOME/adwaita-icon-theme )
- [Dmz ](https://github.com/GalliumOS/dmz-cursor-theme )
- [Yaru ](https://github.com/ubuntu/yaru )
- Emojis are taken from [here ](https://emojipedia.org/ )
2019-10-20 06:14:35 -04:00
2020-09-05 03:40:59 -04:00
<!-- Support -->
2020-09-19 07:31:18 -04:00
# Support
2018-10-15 11:40:03 -04:00
2020-08-13 01:09:53 -04:00
Share your joy with ** ★**.
2019-11-15 11:27:14 -05:00
2020-08-13 00:34:13 -04:00
> For more support
2019-11-15 11:27:14 -05:00
2020-08-13 00:10:25 -04:00
< a href = "https://www.buymeacoffee.com/Nt7Wg4V" >
2020-08-13 00:34:13 -04:00
< img src = "https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt = "Buy Me A Coffee" style = "height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" >
2019-11-17 22:40:31 -05:00
< / a >
2018-10-15 11:40:03 -04:00
2020-08-13 00:34:13 -04:00
<!-- Ninja -->
2019-11-12 23:48:09 -05:00
< p align = "center" >
2020-08-13 01:09:53 -04:00
< h1 align = "center" > (◣_◢)< / h1 >
< / p >
< p align = "center" >
2020-10-03 04:56:02 -04:00
< sub > Stop < strong > scrolling< / strong > , It's < strong > hurt< / strong > me< / sub >
2018-09-03 07:38:53 -04:00
< / p >