Skip to content

Latest commit

 

History

History
305 lines (208 loc) · 10.6 KB

README.md

File metadata and controls

305 lines (208 loc) · 10.6 KB
Raw

Google Cursor

An OpenSource cursor theme inspired by Google.

Build

Notes

  • All cursor's SVG files are found in svg directory or you can also find them on Figma.

shoutout-sponsors

GoogleDot Blue GoogleDot Black GoogleDot White GoogleDot Red

Cursor Sizes

Xcursor Sizes:

22 24 28 32 40 48 56 64 72 80 88 96

Windows Cursor Size:

  • 16x16 - Small
  • 24x24 - Regular
  • 32x32 - Large
  • 48x48 - Extra Large

Colors:

GoogleDot Blue

  • Base Color - #4285F4 (Blue)
  • Outline Color - #FFFFFF (White)

GoogleDot Black

  • Base Color - #000000 (Black)
  • Outline Color - #FFFFFF (White)

GoogleDot White

  • Base Color - #FFFFFF (Black)
  • Outline Color - #000000 (White)

GoogleDot Red

  • Base Color - #FF0000 (Red)
  • Outline Color - #FFFFFF (White)

How to get it

Easiest Way

You can download latest stable & development releases from Release Page.

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 currently maintained by @yochananmarqos. Can be installed via Pamac (preinstalled in Manjaro), Paru or any other AUR helper.

paru -S googledot-cursor-theme

Nix/NixOS

Nix users can install from the package in nixpkgs (Maintained by @Henry-Hiles). Installation instructions can be found by clicking on the title of the nix package. The nix package is currently only available in unstable.

Installing Google Cursor

Linux/X11

Installation:

tar -xvf GoogleDot-Blue.tar.gz                # extract `GoogleDot-Blue.tar.gz`
mv GoogleDot-* ~/.icons/                      # Install to local users
sudo mv GoogleDot-* /usr/share/icons/         # Install to all users

Uninstallation:

rm ~/.icons/GoogleDot-*                       # Remove from local users
sudo rm /usr/share/icons/GoogleDot-*          # Remove from all users

Windows

Installation:

  1. Unzip .zip file
  2. Open unziped directory 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 Google Cursors.
  5. Click 'Apply'.

Uninstallation:

Run the uninstall.bat script packed with the .zip archive

OR follow these steps:

  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.: Google Cursors and click Delete.
  5. Click 'yes' when prompted.

Build From Source

Notes

  • Google Cursor build configuration and cursor hotspot settings are bundled in the build.toml file.
  • Check out the scripts section in 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 Google Cursor's colors, and bitmaps, or generate a png file from a svg, Then you can use yarn because bitmapper is written in TypeScript.
  • Since Google Cursor variants 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

  • Python version 3.7 or higher
  • clickgen>=2.1.2 (pip install clickgen)
  • yarn

Quick start

  1. Install build prerequisites on your system
  2. git clone https://github.com/ful1e5/Google_Cursor
  3. cd Google_Cursor && yarn build
  4. See Installing Google Cursor.

Building

Note Bitmaps are already generated in the bitmaps directory and managed by the maintainer (do not edit them directly).

First make sure you installed the 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).

yarn build aberration

Here are the default commands we used to build the Google Cursor's variants and packed them into yarn build:

ctgen build.toml -d 'bitmaps/GoogleDot-Blue' -n 'GoogleDot-Blue' -c 'Blue cursor theme inspired on Google'
ctgen build.toml -d 'bitmaps/GoogleDot-Black' -n 'GoogleDot-Black' -c 'Black cursor theme inspired on Google'
ctgen build.toml -d 'bitmaps/GoogleDot-White' -n 'GoogleDot-White' -c 'White cursor theme inspired on Google'
ctgen build.toml -d 'bitmaps/GoogleDot-Red' -n 'GoogleDot-Red' -c 'Red cursor theme inspired on Google'

Afterwards, the themes can be found in the themes directory.

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.

ctgen build.toml -s 16 -p windows -d 'bitmaps/GoogleDot-Blue' -n 'GoogleDot-Blue' -c 'Blue cursor theme inspired on Google with size 16'

You can also customize output directory with -o option:

ctgen build.toml -s 16 -p windows -d 'bitmaps/GoogleDot-Blue'-o 'out' -n 'GoogleDot-Blue' -c 'Blue cursor theme inspired on Google with size 16'
Customize XCursor size

To build XCursor with size 16:

ctgen build.toml -s 16 -p x11 -d 'bitmaps/GoogleDot-Blue' -n 'GoogleDot-Blue' -c 'Blue cursor theme inspired on Google with size 16'

You can also assign multiple sizes to ctgen for XCursors build:

ctgen build.toml -s 16 24 32 -p x11 -d 'bitmaps/GoogleDot-Blue' -n 'GoogleDot-Blue' -c 'Blue cursor theme inspired on Google with size 16'

Customize Colors

To customize Google Cursor'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 node package.

yarn render aberration

Here are the default commands we used for generating the Google Cursor's bitmaps and packed them into yarn render:

npx cbmp -d 'svg' -n 'GoogleDot-Blue' -bc '#4285F4' -oc '#FFFFFF'
npx cbmp -d 'svg' -n 'GoogleDot-Black' -bc '#000000' -oc '#FFFFFF'
npx cbmp -d 'svg' -n 'GoogleDot-White' -bc '#FFFFFF' -oc '#000000'
npx cbmp -d 'svg' -n 'GoogleDot-Red' -bc '#FF0000' -oc '#FFFFFF'

Examples

Lets generate modern GoogleDot with green base color and black outline:

npx cbmp -d 'svg' -n 'GoogleDot-Hacker' -bc '#00FE00' -oc '#000000'

After rendering custom color you have to build cursor through ctgen:

ctgen build.toml -d 'bitmaps/GoogleDot-Hacker' -n 'GoogleDot-Hacker' -c 'Green and black GoogleDot cursors.'

Afterwards, Generated theme can be found in the themes directory.

GoogleDot Gruvbox
npx cbmp -d 'svg' -n 'GoogleDot-Gruvbox' -bc '#282828' -oc '#EBDBB2'
ctgen build.toml -d 'bitmaps/GoogleDot-Gruvbox' -n 'GoogleDot-Gruvbox' -c 'Groovy GoogleDot cursors.'
GoogleDot Solarized Dark
npx cbmp -d 'svg' -n 'GoogleDot-Solarized-Dark' -bc '#002b36' -oc '#839496'
ctgen build.toml -d 'bitmaps/GoogleDot-Solarized-Dark' -n 'GoogleDot-Solarized-Dark' -c 'Solarized Dark GoogleDot cursors.'
GoogleDot Solarized Light
npx cbmp -d 'svg' -n 'GoogleDot-Solarized-Light' -bc '#839496' -oc '#002b36'
ctgen build.toml -d 'bitmaps/GoogleDot-Solarized-Light' -n 'GoogleDot-Solarized-Light' -c 'Solarized Light GoogleDot cursors.'
GoogleDot Dracula
npx cbmp -d 'svg' -n 'GoogleDot-Dracula' -bc '#282a36' -oc '#f8f8f2'
ctgen build.toml -d 'bitmaps/GoogleDot-Dracula' -n 'GoogleDot-Dracula' -c 'Dracula GoogleDot cursors.'

Bugs

Bugs should be reported here on the Github issues page.

Getting Help

You can create a issue, I will help you.

Contributing

Check 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.