Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ful1e5/pokemon-cursor

An opensource Pokemon cursor (Unofficial) theme for Windows and Linux.
https://github.com/ful1e5/pokemon-cursor

cursor linux opensource pokemon theme unofficial windows

Last synced: 8 days ago
JSON representation

An opensource Pokemon cursor (Unofficial) theme for Windows and Linux.

Host: GitHub
URL: https://github.com/ful1e5/pokemon-cursor
Owner: ful1e5
License: gpl-3.0
Created: 2022-02-03T09:22:08.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2022-10-28T04:02:37.000Z (about 2 years ago)
Last Synced: 2024-05-02T03:39:47.792Z (7 months ago)
Topics: cursor, linux, opensource, pokemon, theme, unofficial, windows
Language: Shell
Homepage:
Size: 754 KB
Stars: 87
Watchers: 2
Forks: 5
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# pokemon-cursor

An unofficial opensource Pokemon cursor theme for Windows and Linux.

[![build](https://github.com/ful1e5/pokemon-cursor/actions/workflows/build.yml/badge.svg)](https://github.com/ful1e5/pokemon-cursor/actions/workflows/build.yml)

## Pokemon Cursor needs your Input

Until 2021 my cursors projects were well funded by [pling.com](https://www.pling.com) but since the
[pling-factor](https://www.pling.com/terms/payout) on the website has decreased and monthly payments
are <500$, It is now dependent on community funding and sponsorships. If you want to help me to maintain
Pokemon Cursor and my other open source projects actively, consider sponsoring my work on [GitHub Sponsor](https://github.com/sponsors/ful1e5)
or DM me on [Twitter](https://twitter.com/ful1e5) if your company would like to support my projects,
I will gladly look into it and post your avatar in the project's README.

I appreciate all the wonderful people who patronize and sponsoring my work.

## Sponsors

N/A

---

![Pokemon](https://imgur.com/Xhm2xgS.png)

> **Note**
> All cursor's `.svg` files are found in [svg](./svg) directory or you can also find them on
> [Figma](https://www.figma.com/file/OoAFKT3u1HkzSe74QrLarQ/pokemon-cursor?node-id=0%3A1).

#### Cursor Sizes

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

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

![#FFCB05](https://imgur.com/Q3Y7xFo.png)
![#3C5AA6](https://imgur.com/rlKmamu.png)
![#0070B6](https://imgur.com/epcnFzB.png)
![#000000](https://imgur.com/ScBWhdE.png)
![#ffffff](https://imgur.com/AiR8P8t.png)

## How to get it

### Easiest Way

You can download latest `stable` & `development` releases from
[Release Page](https://github.com/ful1e5/pokemon-cursor/releases).

## Installing Pokemon Cursor

#### Linux/X11

**Installation:**

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

**Uninstallation:**

```bash
rm ~/.icons/Pokemon # Remove from local users
sudo rm /usr/share/icons/Pokemon # 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 **Pokemon 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.: _Pokemon Cursors_ and
click `Delete`.
5. Click '**yes**' when prompted.

## Build From Source

#### Notes

- Pokemon build configuration and cursor hotspot settings are bundled in the `build.toml` file.
- Check out the scripts section in [package.json](./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 Pokemon's colors, and bitmaps, or generate a png
file from a svg, Then you can use yarn because bitmapper is written in TypeScript.

### Build prerequisites

- Python version 3.7 or higher
- [clickgen](https://github.com/ful1e5/clickgen)>=2.1.2 (`pip install clickgen`)
- [yarn](https://github.com/yarnpkg/yarn)

### Quick start

1. Install [build prerequisites](#build-prerequisites) on your system
2. `https://github.com/ful1e5/pokemon-cursor`
3. `cd pokemon-cursor && yarn build`
4. See [Installing Pokemon Cursor](#installing-pokemon-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](#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 Pokemon-cursor and packed them into `yarn build`:

```bash
ctgen build.toml
```

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.

```bash
ctgen build.toml -s 16 -p windows -c 'An unofficial Pokemon cursors with size 16'
```

You can also customize output directory with `-o` option:

```bash
ctgen build.toml -s 16 -p windows -o 'out' -c 'An unofficial Pokemon cursors with size 16'
```

##### Customize XCursor size

To build XCursor with size `16`:

```bash
ctgen build.toml -s 16 -p x11 -c 'An unofficial Pokemon cursors with size 16'
```

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

```bash
ctgen build.toml -s 16 24 32 -p x11 -c 'An unofficial Pokemon cursors with size 16'
```

# Bugs

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

# Getting Help

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

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