Bibata_Cursor/README.md

<!-- Branding -->

<p align="center">
  <img src="https://imgur.com/cfkawDi.png" width="40%">
</p>

<p align="center">
  <b>Material Based Cursors</b> 🚀
</p>

<!-- Badges -->

<p align="center">

  <!-- First Row -->

  <a href="https://github.com/ful1e5/Bibata_Cursor/actions?query=workflow%3Abibata-ci">
    <img alt="GitHub Action Build" src="https://github.com/ful1e5/Bibata_Cursor/workflows/bibata-ci/badge.svg"/>
  </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>
  
  
  <!-- Third Row -->

  </br >
  <a href="https://github.com/ful1e5/Bibata_Cursor/blob/main/LICENSE" >
    <img alt="License" src="https://img.shields.io/github/license/ful1e5/Bibata_Cursor?color=0081FB" />
  </a>

  <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">
  </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>
  
  
  <!-- Fourth Row -->

  <br />
  <a href="https://www.pling.com/p/1197198/#files-panel">
    <img alt="License" src="https://img.shields.io/badge/-Linux-grey?logo=linux" />
  </a>

  <a href="https://www.pling.com/p/1197198/#files-panel">
    <img alt="License" src="https://img.shields.io/badge/-Windows-blue?logo=windows" />
  </a>

  <!-- Fifth Row -->

  <br />
  <a href="https://github.com/ful1e5">
    <img alt="Made By Kaiz"  src="https://kaiz.vercel.app/api/badge" width="133" />
  </a>

</p>

---

<!-- Table Of Content -->

<details>
 <summary><strong>Table of Contents</strong> (click to expand)</summary>

- [Bibata ?](#bibata-)
  - [Bibata Styles](#bibata-styles)
  - [Cursor Sizes](#cursor-sizes)
  - [Colors](#colors)
  - [Preview](#preview)
  - [Quick install](#quick-install)
  - [Packages 📦](#packages-)
    - [Arch Linux/Manjaro](#arch-linuxmanjaro)
    - [Fedora](#fedora)
  - [Manual Install](#manual-install)
      - [Linux/X11](#linuxx11)
      - [Windows](#windows)
- [Dependencies](#dependencies)
  - [Runtime Dependencies](#runtime-dependencies)
      - [Install Runtime Dependencies](#install-runtime-dependencies)
        - [macOS](#macos)
        - [Debain/ubuntu](#debainubuntu)
        - [ArchLinux/Manjaro](#archlinuxmanjaro)
        - [Fedora/Fedora Silverblue/CentOS/RHEL](#fedorafedora-silverbluecentosrhel)
  - [Build Dependencies](#build-dependencies)
    - [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)
      - [Build `Bibata`](#build-bibata)
      - [Build `Bibata Modern` Only](#build-bibata-modern-only)
      - [Build `Bibata Original` Only](#build-bibata-original-only)
    - [Install Build Theme](#install-build-theme)
      - [Linux](#linux)
      - [Windows](#windows-1)
- [You may also like...](#you-may-also-like)
- [Bugs](#bugs)
- [Getting Help](#getting-help)
- [Contributing](#contributing)
- [Credit](#credit)
- [Support](#support)
</details>

<!-- Sub Projects -->

<details>
 <summary><strong>Sub Projects</strong> (click to expand)</summary>

- [Bibata Rainbow](./packages/rainbow)

</details>
<!-- Bibata intro -->

# Bibata ?

Bibata is **OpenSource**, Compact and Material Designed Cursor set. This project masterelop for improve `Cursor` Experience.

- **Bibata Amber :** Yellowish Theme.
- **Bibata Classic :** Solid Black Theme.
- **Bibata Ice :** Light Theme.

## Bibata Styles

- **Bibata Original :** Sharp edge Bibata Cursors
- **Bibata Modern :** Round edge Bibata Cursors

## Cursor 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>

## Colors

![Amber](https://imgur.com/5Jo6MSO.png)
![Classic](https://imgur.com/I5cRKE4.png)
![Ice ✓](https://imgur.com/avnR40g.png)

<!-- 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>

## Quick install

<p align="center">
  <a href="https://www.pling.com/p/1197198/" >
    <img title="Bibata Pling Store" width="40%" src="https://imgur.com/VxSgrWw.png">
  </a>
</p>

## Packages 📦

> **📝Note**: If you're having trouble with the packages please submit a request to the package maintainer before creating an issue.

### 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), Yay or any other [AUR helper](https://wiki.archlinux.org/index.php/AUR_helpers).

Pamac command:

```bash
pamac build bibata-cursor-theme
pamac build bibata-cursor-theme-bin                  # pre-built binary
```

Yay command:

```bash
yay -S bibata-cursor-theme
yay -S bibata-cursor-theme-bin                       # pre-built binary
```

### Fedora

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
```

## Manual Install

Latest `Stable` & `Development` releases can be downloaded from [Here](https://github.com/ful1e5/Bibata_Cursor/releases)

#### Linux/X11

```bash
# extract `Bibata.tar.gz`
tar -xvf Bibata.tar.gz

# For local users
mv Bibata-* ~/.icons/

# For all users
sudo mv Bibata-* /usr/share/icons/
```

#### Windows

1. unzip `Bibata_Windows.zip` file
2. Open `Bibata_Windows/<Bibata_flavor>` 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 **Bibata Cursors**.
5. Click '**Apply**'.

<!-- Build Dependencies -->

# Dependencies

## Runtime Dependencies

- libxcursor-dev
- libx11-dev
- libpng-dev (<=1.6)

#### Install Runtime Dependencies

##### macOS

```bash
brew cask install xquartz libpng
```

##### Debain/ubuntu

```bash
sudo apt install libx11-dev libxcursor-dev libpng-dev
```

##### ArchLinux/Manjaro

```bash
sudo pacman -S libx11 libxcursor libpng
```

##### Fedora/Fedora Silverblue/CentOS/RHEL

```bash
sudo dnf install libx11-devel libxcursor-devel libpng-devel
```

## Build Dependencies

- [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/)

### Node Packages

- [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)

### PyPi Packages

- [clickgen](https://pypi.org/project/clickgen/)

## Build From Scratch

### ⚡ Auto Build (using GitHub Actions)

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.

### Manual Build

#### Setup python environment

```bash
python3 -m pip install --upgrade pip                 # Update pip to latest
python3 -m pip install virtualenv                    # Install python virtual environment
virtualenv venv                                      # Create new virtualenv named `venv`
source venv/bin/activate                             # Activate virtualenv

# For Deactivate virtualenv
deactivate
```

#### Compile From Source

> Make sure your [python environment](#setup-python-environment) setup and `virtualenv` is **active**.

#### Install Node/PyPi Packages

```bash
yarn install                                         # Install all Node Packages
yarn py_install                                      # Install all PyPi Packages with Bibata builder
```

#### Build `Bibata`

```bash
yarn render:bibata-modern                            # Render Bibata Modern Bitmaps
yarn render:bibata-original                          # Render Bibata Original Bitmaps

# Build cursors packages
yarn build                                           # Build Windows & X11 packages
# OR
yarn build:x11                                       # Build only X11 packages
# OR
yarn build:win                                       # Build only Windows cursors
```

#### Build `Bibata Modern` Only

```bash
yarn render:bibata-modern                            # Render Bibata Modern Bitmaps

# Build cursors packages
yarn build                                           # Build Windows & X11 cursors
# OR
yarn build:x11                                       # Build only X11 cursors
# OR
yarn build:win                                       # Build only Windows cursors
```

#### Build `Bibata Original` Only

```bash
yarn render:bibata-original                          # Render Bibata Original Bitmaps

# Build cursors packages
yarn build                                           # Build Windows & Linux cursors
# OR
yarn build:x11                                       # Build only X11 cursors
# OR
yarn build:win                                       # Build only Windows cursors
```

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)
rm -rf ~/.icons/Bibata-* && cp -r Bibata-* ~/.icons/
```

#### 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**".

<!-- Other Interesting projects -->

# You may also like...

- [**Bibata Extra**](https://github.com/ful1e5/Bibata_Extra_Cursor) - More Bibata!
- [**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.

<!-- Bug Report -->

# Bugs

Bugs 🐛 should be reported [here](https://github.com/ful1e5/Bibata_Cursor/issues) on the Github issues page.

<!-- Help -->

# Getting Help

You can create a **issue**, I will help you. 🙂

<!-- Contributions and Suggestion -->

# 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`.

<!-- This project isn't possible without these 👇🏻-->

# Credit

- [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/)

<!-- Support -->

# Support

Share your joy with **★**.

> For more support

<a href="https://www.buymeacoffee.com/Nt7Wg4V" >
  <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;" >
</a>

<!-- Ninja  -->

<p align="center">
  <h1 align="center">(◣_◢)</h1>
</p>
<p align="center">
  <sub>Stop <strong>scrolling</strong>, It's <strong>hurt</strong> me</sub>
</p>