geoffrey/fringer-cursors
geoffrey/fringer-cursors
1
0
Fork 0
mirror of https://github.com/GeoffreyFrogeye/fringer-cursors.git synced 2025-09-05 14:00:23 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

updated figma file and installation instructions

Browse source
This commit is contained in:
Philipp Schaffrath 2024-04-07 04:18:06 +02:00
parent eb9180f69a
commit 1b9e7f2323
No known key found for this signature in database
GPG key ID: E5D3C326D00A7C3D
2 changed files with 50 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

63
README.md
View file

@ -1,21 +1,58 @@
# Phinger cursors
# Phinger Cursors
Say hello to your new cursor theme. Phinger cursors is most likely the most over engineered cursor theme out there.
Say hello to your new cursor theme. Phinger Cursors is most likely the most over engineered cursor theme out there.
![preview](assets/preview.png)
## How to install
If you are on Arch linux, you can install the AUR package [phinger-cursors](https://aur.archlinux.org/packages/phinger-cursors).
### Arch Linux
Other distros currently don't yet have phinger-cursors in their repositories. So please install manually, as described below.
I'm maintaining [phinger-cursors](https://aur.archlinux.org/packages/phinger-cursors) in the Arch User Repository. You can install it with your favorite AUR helper:
```sh
paru -S phinger-cursors
```
> [!NOTE]
> Please let me know if you want to maintain this package in the official Arch Linux repositories, so that I can update the instructions here.
### Ubuntu
Install the `phinnger-cursor-theme` from the Ubuntu repositories (thanks to @eeickmeyer):
```sh
apt-get update
apt-get install phinger-cursor-theme
```
### NixOS
You can install the `phinger-cursors` package (thanks to @moni-dz) from the NixOS repositories by adding it to your `configuration.nix`:
```nix
environment.systemPackages = with pkgs; [
phinger-cursors
];
```
Or use it in your home-manager configuration:
```nix
home.pointerCursor = {
name = "phinger-cursors-light";
package = pkgs.phinger-cursors;
size = 32;
gtk.enable = true;
};
```
### Manually
For a manual installation, download and extract the [latest release](https://github.com/phisch/phinger-cursors/releases/latest/download/phinger-cursors-variants.tar.bz2) into the `~/.icons` directory.
For a manual installation, download and extract the [latest release](https://github.com/phisch/phinger-cursors/releases/latest/download/phinger-cursors-variants.tar.bz2) into the `~/.local/share/icons` directory.
```sh
wget -cO- https://github.com/phisch/phinger-cursors/releases/latest/download/phinger-cursors-variants.tar.bz2 | tar xfj - -C ~/.icons
wget -cO- https://github.com/phisch/phinger-cursors/releases/latest/download/phinger-cursors-variants.tar.bz2 | tar xfj - -C ~/.local/share/icons
```
This installs the cursor theme for your current user. To install for all users, extract into `/usr/share/icons` instead.
@ -26,7 +63,7 @@ You might have a settings application installed that can do this for you like [G
### Manually
Enable your prefered variant (`phinger-cursors` or `phinger-cursors-light`) inside `~/.icons/default/index.theme`:
Enable your prefered variant `phinger-cursors-dark`, `phinger-cursors-light` or their left-handed counterparts `phinger-cursors-dark-left` or `phinger-cursors-light-left` inside `~/.icons/default/index.theme`:
```ini
[Icon Theme]
@ -64,7 +101,7 @@ Xcursor.size: CURSOR_SIZE
## How it's made
Phinger-cursors are designed in a [Figma](https://www.figma.com) document. Check out the [multi-page Figma document](https://www.figma.com/file/zU99op23bu3Cg438YkhZy8/phinger-cursors) used by this repository.
Phinger Cursors are designed in a [Figma](https://www.figma.com) document. Check out the [multi-page Figma document](https://www.figma.com/file/zU99op23bu3Cg438YkhZy8/phinger-cursors) used by this repository.
You can find an up to date copy of that document in this repositories root directory at [phinger-cursors.fig](phinger-cursors.fig).
@ -80,8 +117,8 @@ Each part is designed on a base grid of 24 and 32:
which means will be pixel perfect for any reasonable size:
| 24 | 32 | 48 | 64 | 72 | 96 | 128 |
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
| 24 | 32 | 48 | 64 | 72 | 96 | 128 |
| :-------------------------: | :-------------------------: | :-------------------------: | :-------------------------: | :-------------------------: | :-------------------------: | :---------------------------: |
| ![24](assets/sprite_24.png) | ![32](assets/sprite_32.png) | ![48](assets/sprite_48.png) | ![64](assets/sprite_64.png) | ![72](assets/sprite_72.png) | ![96](assets/sprite_96.png) | ![128](assets/sprite_128.png) |
If possible, parts are designed very modular, which lets you create multiple different icons from one part. A good example is the hand part that comes with multiple variations for each single phinger:
@ -96,14 +133,14 @@ Each cursor contains information about which cursor and variant it belongs to, w
### Build process
Phinger cursors are built using my [Cursor Theme Builder](https://github.com/phisch/cursor-theme-builder). It provides a JSON schema to describe a cursor theme, an exporter, that can create such a JSON file and assets from a Figma file, and a builder, which makes fully functioning X11 cursor theme variants from that. It also allows to transform cursors into left-handed versions, comes with an animation system and more.
Phinger Cursors are built using my [Cursor Theme Builder](https://github.com/phisch/cursor-theme-builder). It provides a JSON schema to describe a cursor theme, an exporter, that can create such a JSON file and assets from a Figma file, and a builder, which makes fully functioning X11 cursor theme variants from that. It also allows to transform cursors into left-handed versions, comes with an animation system and more.
This repository contains [workflows](.github/workflows) to extract a cursor-theme.json and assets, and drafts a release with built cursor theme variants.
## License & Credits
All assets, including the Figma document are licensed under the [CC-BY-SA-4.0 License](LICENSE).
Although designed from scratch, phinger cursors drew inspiration from [capitaine-cursors](https://github.com/keeferrourke/capitaine-cursors), which is based on the KDE Breeze cursors. So this is a special thanks to them, and all other amazing cursor themes out there!
Although designed from scratch, Phinger Cursors drew inspiration from [capitaine-cursors](https://github.com/keeferrourke/capitaine-cursors), which is based on the KDE Breeze cursors. So this is a special thanks to them, and all other amazing cursor themes out there!
## Contribute
@ -115,4 +152,4 @@ I can't let people contribute to the Figma document directly, but I will listen
<a href="https://discord.gg/RqKTeA4uxW" title="Desktop Makers Discord"><img align="left" width="72" alt="type=discord" src="https://user-images.githubusercontent.com/1282767/161089772-d7ad28bf-76eb-4951-b0f0-985afd5ea57a.png"></a>
I am actively working on phinger-cursors and other cool projects on the [Desktop Makers Discord](https://discord.gg/RqKTeA4uxW). It aims to be a community for communities of Linux desktop related projects. If you are looking to collaborate with or want to contribute to great projects, this might be the right place for you.
I am actively working on Phinger Cursors and other cool projects on the [Desktop Makers Discord](https://discord.gg/RqKTeA4uxW). It aims to be a community for communities of Linux desktop related projects. If you are looking to collaborate with or want to contribute to great projects, this might be the right place for you.

BIN
phinger-cursors.fig
View file

Binary file not shown.