Skip to content

A tiny kite that follows your mouse cursor around on websites; made with Typescript.

License

Notifications You must be signed in to change notification settings

venashial/kite-cursor

Repository files navigation

Kite Cursor! Video showing the kite following the cursor

Try it out on the DEMO →

Make a little kite follow your cursor around!

Physics, gravity, and more included!

Comes in a dashing red, yellow, green, and blue!

Fly your kite with no fright with easy importing!

🧩 Browser extension

Firefox

Install the Firefox extension from the Kite Cursor page on Firefox Addons.

Chrome, Edge, & Brave

The extension is currently under review on the Chrome Web Store. For now, you have to build the project locally, and install the unpacked extension from the folder dist/extension/v3

🚚 Import usage

NPM

Install it:

npm install kite-curor

Add this to start KiteCursor:

import { KiteCursor } from "kite-cursor";

new KiteCursor();

Plain JS

There are currently no plain JS imports. You can import an older version with: <script src="https://cdn.jsdelivr.net/npm/kite-cursor@0.0.1/bin/minified.js"></script>

💻 Developing

First, make sure NodeJS & pnpm are installed, then run:

pnpm install # Install dependencies

Packaging extension

Package the extension by running:

pnpm package

Then, compress the outputs to .zips:

  • dist/extension/v2 for Firefox
  • dist/extension/v2 for Chromium

Development commands:

pnpm dev # Run docs site locally for testing
pnpm package # Combines src/ into package
pnpm docs:build # Build docs site

👥 Credits

Thanks to @guerrillacontra for their rope and canvas lib codepens. This project uses that source code but refactored to use Typescript and specialized functions. Plus the fun kite parts!