2021-11-06 08:06:26 -04:00
# Apple Cursor
2020-08-06 08:30:49 -04:00
2021-11-06 08:06:26 -04:00
Enjoy macOS cursors for `Windows` and `Linux` with _HiDPI Support_ .
2020-08-06 09:03:32 -04:00
2021-11-06 08:06:26 -04:00
[![Build ](https://github.com/ful1e5/apple_cursor/workflows/build/badge.svg )](https://github.com/ful1e5/apple_cursor/actions?query=workflow%3Abuild)
[![CodeFactor ](https://www.codefactor.io/repository/github/ful1e5/apple_cursor/badge )](https://www.codefactor.io/repository/github/ful1e5/apple_cursor)
[![Twitter ](https://img.shields.io/badge/twitter-ful1e5-blue )](https://twitter.com/ful1e5)
2020-08-06 09:03:32 -04:00
2020-08-11 07:48:57 -04:00
#### Cursor Sizes
2020-10-23 03:00:20 -04:00
< kbd > 22< / kbd >
2020-08-11 07:48:57 -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 >
#### Colors
2020-08-11 23:36:17 -04:00
![#13A3F5 ](https://imgur.com/m0JhD7W.png )
![#4DCB2C ](https://imgur.com/wtyqDHv.png )
![#FED103 ](https://imgur.com/5km5GW6.png )
![#FE9D0C ](https://imgur.com/Gx2eGbm.png )
![#F2493C ](https://imgur.com/hl22EPB.png )
![#B75DCC ](https://imgur.com/wev8rfw.png )
![#000000 ](https://imgur.com/24cocpe.png )
![#fffff ](https://imgur.com/YyhMKNT.png )
2020-08-11 07:48:57 -04:00
2021-11-06 08:08:13 -04:00
### Quick install
2020-08-09 08:31:53 -04:00
2021-10-14 08:13:41 -04:00
- macOSBigSur: [https://www.pling.com/p/1408466 ](https://www.pling.com/p/1408466 )
- macOSBigSur-White: [https://www.pling.com/p/1616779 ](https://www.pling.com/p/1616779 )
2021-11-22 07:06:55 -05:00
- macOSMonterey: [https://www.pling.com/p/1648124 ](https://www.pling.com/p/1648124 )
- macOSMonterey-White: [https://www.pling.com/p/1648129 ](https://www.pling.com/p/1648129 )
#### Preview:
> Check Figma file [here](https://www.figma.com/file/OZw8Ylb9xPFw9h1uZYSMFa/Mac-Cursor?node-id=0%3A1)
< p align = "center" >
< img title = "macOSMonterey" src = "https://imgur.com/bmS0fRT.png" >
< / br >
< sub > macOSMonterey Cursors< / sub >
< / p >
< p align = "center" >
< img title = "macOSMonterey White" src = "https://imgur.com/s0nqcje.png" >
< / br >
< sub > macOSMonterey White Cursors< / sub >
< / p >
< p align = "center" >
< img title = "macOSBigSur" src = "https://imgur.com/Q022eSp.png" >
< / br >
< sub > macOSBigSur Cursors< / sub >
< / p >
< p align = "center" >
< img title = "macOSBigSur White" src = "https://imgur.com/SFVR945.png" >
< / br >
< sub > macOSBigSur White Cursors< / sub >
< / p >
2020-08-09 08:31:53 -04:00
2020-08-11 08:00:57 -04:00
### Manual Install
2020-08-11 07:48:57 -04:00
2021-11-22 07:06:55 -05:00
> Note: replace name according package name.
2020-08-11 07:48:57 -04:00
#### Linux/X11
2021-11-22 07:06:55 -05:00
##### macOSMonterey
```bash
# extract `macOSMonterey.tar.gz`
tar -xvf macOSMonterey.tar.gz
# For local users
mv macOSMonterey ~/.icons/
# For all users
sudo mv macOSMonterey /usr/share/icons/
```
##### macOSBigSur
2020-08-11 07:48:57 -04:00
```bash
2020-08-30 07:54:08 -04:00
# extract `macOSBigSur.tar.gz`
tar -xvf macOSBigSur.tar.gz
2020-08-12 07:01:03 -04:00
2020-08-11 07:48:57 -04:00
# For local users
mv macOSBigSur ~/.icons/
2020-08-12 07:01:03 -04:00
2020-08-11 07:48:57 -04:00
# For all users
sudo mv macOSBigSur /usr/share/icons/
```
2020-08-10 02:29:18 -04:00
#### Windows
2021-11-22 07:06:55 -05:00
##### macOSMonterey
1. unzip `macOSMonterey-Windows.zip` file
2. Open `macOSMonterey-Windows/` in Explorer, and **right click** on `install.inf` .
2020-10-23 02:39:24 -04:00
3. Click 'Install' from the context menu, and authorize the modifications to your system.
2021-11-22 07:06:55 -05:00
4. Open _Control Panel > Personalization and Appearance > Change mouse pointers_ , and select **MacOSMonterey Cursors** .
2020-08-10 02:29:18 -04:00
5. Click '**Apply**'.
2021-11-22 07:06:55 -05:00
##### macOSBigSur
2020-08-07 09:08:30 -04:00
2021-11-22 07:06:55 -05:00
1. unzip `macOSBigSur-Windows.zip` file
2. Open `macOSBigSur-Windows/` 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 **MacOSBigSur Cursors** .
5. Click '**Apply**'.
2020-08-06 08:30:49 -04:00
2022-01-24 10:07:26 -05:00
### Uninstall
#### Windows
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.: _macOSMonterey Cursors_ and click `Delete` .
5. Click '**yes**' when prompted.
2020-08-06 09:03:32 -04:00
# Dependencies
2020-08-06 08:30:49 -04:00
2021-01-25 06:51:29 -05:00
## External Libraries
2020-08-06 08:45:14 -04:00
2021-04-04 02:37:42 -04:00
- libxcursor
- libx11
- libpng (< =1.6)
2020-08-06 08:45:14 -04:00
2021-01-25 06:51:29 -05:00
#### Install External Libraries
2020-08-06 08:45:14 -04:00
2020-08-12 00:37:15 -04:00
##### macOS
```bash
2021-01-25 06:51:29 -05:00
brew install --cask xquartz
2021-01-30 07:27:07 -05:00
brew install libpng
2020-08-12 00:37:15 -04:00
```
2020-08-06 08:45:14 -04:00
##### Debain/ubuntu
```bash
2020-08-12 00:37:15 -04:00
sudo apt install libx11-dev libxcursor-dev libpng-dev
2020-08-06 08:45:14 -04:00
```
##### ArchLinux/Manjaro
```bash
2020-08-12 00:37:15 -04:00
sudo pacman -S libx11 libxcursor libpng
2020-08-06 08:45:14 -04:00
```
##### Fedora/Fedora Silverblue/CentOS/RHEL
```bash
2020-11-26 15:44:35 -05:00
sudo dnf install libX11-devel libXcursor-devel libpng-devel
2020-08-06 08:45:14 -04:00
```
2020-08-06 09:10:07 -04:00
2020-08-07 00:26:57 -04:00
## Build Dependencies
2020-08-06 09:10:07 -04:00
2021-04-04 02:37:42 -04:00
- [gcc ](https://gcc.gnu.org/install/ )
- [make ](https://www.gnu.org/software/make/ )
- [nodejs ](https://nodejs.org/en/ ) (< =12.x.x)
- [yarn ](https://classic.yarnpkg.com/en/docs/install/ )
- [python ](https://www.python.org/downloads/ ) (< =3.8)
- [pip3 ](https://pip.pypa.io/en/stable/installing/ )
2020-08-12 00:37:15 -04:00
### Node Packages
2021-04-04 02:37:42 -04:00
- [puppeteer ](https://www.npmjs.com/package/puppeteer )
- [pngjs ](https://www.npmjs.com/package/pngjs )
- [pixelmatch ](https://www.npmjs.com/package/pixelmatch )
2020-08-12 00:37:15 -04:00
### PyPi Packages
2021-04-04 02:37:42 -04:00
- [clickgen ](https://pypi.org/project/clickgen/s )
2020-08-07 01:08:37 -04:00
2020-08-11 07:22:42 -04:00
## Build From Scratch
2020-08-07 08:41:30 -04:00
2021-11-22 07:06:55 -05:00
### Auto Build (using GitHub Actions)
2020-08-07 08:41:30 -04:00
2021-01-30 07:27:07 -05:00
GitHub Actions is automatically runs on every `push` (on **main** and **dev** branches) and `pull request` (on **main** branch), You found theme resources in `artifact` section of **build** .GitHub **Actions** source is available inside [.github/workflows ](https://github.com/ful1e5/apple_cursor/tree/main/.github/workflows ) directory.
2020-08-07 08:41:30 -04:00
2020-08-11 07:22:42 -04:00
### Manual Build
2020-08-07 08:41:30 -04:00
2021-11-22 07:06:55 -05:00
> Check **[Makefile](./Makefile)** for more targets.
2020-08-12 01:32:47 -04:00
```bash
2021-01-30 07:41:55 -05:00
make
2020-08-12 01:32:47 -04:00
```
2021-02-05 09:29:26 -05:00
#### Build `XCursor` theme
2020-08-12 01:32:47 -04:00
2021-01-30 07:41:55 -05:00
```bash
make unix
2021-02-05 09:29:26 -05:00
```
2020-08-12 01:32:47 -04:00
2021-02-05 09:29:26 -05:00
#### Customize `XCursor` size
2020-08-12 01:32:47 -04:00
```bash
2021-02-05 09:29:26 -05:00
make unix X_SIZES=22 # Only built '22px' pixel-size.
make unix X_SIZES=22 24 32 # Multiple sizes are provided with ' '(Space)
2020-08-12 01:32:47 -04:00
```
2021-02-05 09:29:26 -05:00
#### Install `XCursor` theme
2020-08-12 01:32:47 -04:00
2020-08-07 08:41:30 -04:00
```bash
2021-02-05 09:29:26 -05:00
make install # install as user
# OR
2021-01-30 10:07:13 -05:00
sudo make install # install as root
2020-08-07 08:41:30 -04:00
```
2021-02-05 09:29:26 -05:00
#### Build `Windows` theme
2020-08-10 02:29:18 -04:00
2020-08-12 01:32:47 -04:00
```bash
2021-01-30 07:41:55 -05:00
make windows
2020-08-12 01:32:47 -04:00
```
2020-08-07 08:41:30 -04:00
2021-02-05 09:29:26 -05:00
#### Customize `Windows Cursor` size
2020-08-11 07:22:42 -04:00
2020-08-07 08:41:30 -04:00
```bash
2021-02-05 09:29:26 -05:00
make windows WIN_SIZE=96 # Supports only one pixel-size
2020-08-07 08:41:30 -04:00
```
2020-08-07 09:04:59 -04:00
2021-02-05 09:29:26 -05:00
> For installation follow [these](#windows) steps.
2020-08-10 02:29:18 -04:00
2020-08-07 09:04:59 -04:00
# Bugs
2021-11-08 08:36:04 -05:00
Bugs should be reported [here ](https://github.com/ful1e5/apple_cursor/issues ) on the Github issues page.
2020-08-07 09:04:59 -04:00
# Getting Help
You can create a **issue** , I will help you. 🙂
2020-08-11 04:31:28 -04:00
# Contributing
2020-08-07 23:08:21 -04:00
2020-08-11 07:03:04 -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` .