A monorepo for the mouse-follower library and its demo application.

This monorepo contains the following packages:

The main library for creating animated sprites that smoothly follow the mouse cursor using physics-based movement.

• 🎯 Smooth physics-based following animation
• 🎨 Canvas-based sprite rendering with transparency support
• 🔗 Chain multiple followers in formation
• ⚡ High-performance animation with requestAnimationFrame
• 🎮 Customizable physics parameters
• 📱 Works on both desktop and mobile devices

View package README →

An interactive demo application showcasing the library's capabilities.

• Multiple follower examples
• Formation demonstrations
• Event-driven animations
• Stack-chan sprite integration

This project uses pnpm workspace for package management.

• Node.js 18+
• pnpm 8+

# Install dependencies for all packages
pnpm install

# Start development servers (library watch + demo dev)
# This runs both TypeScript watch for the library and Vite dev server for the demo in parallel
pnpm dev

# Run tests for the library
pnpm test

# Build all packages
pnpm build

# Build library only
pnpm build:lib

# Build demo only
pnpm build:demo

# Lint and format all packages
pnpm check:fix

.
├── packages/
│   ├── mouse-follower/    # Main library (@meganetaaan/mouse-follower)
│   │   ├── src/          # Library source code
│   │   ├── test/         # Library tests
│   │   └── README.md     # Library documentation
│   └── demo/             # Demo application (private)
│       ├── src/          # Demo source code
│       └── public/       # Demo static assets
├── docs/                 # Project documentation
├── CLAUDE.md            # AI assistant instructions
├── CONTRIBUTING.md      # Contribution guidelines
└── README.md           # This file

# From root directory - starts both library (TypeScript watch) and demo (Vite) in parallel
pnpm dev

# The library will automatically rebuild on changes
# The demo will hot-reload with the latest library changes

cd packages/mouse-follower
pnpm dev           # Run TypeScript in watch mode
pnpm test          # Run tests once
pnpm build         # Build the library for production

cd packages/demo
pnpm dev           # Start Vite dev server (requires library to be built)

The library package is published to npm. To publish a new version:

# Build and test
pnpm build:lib
pnpm test

# Publish (from root)
pnpm publish:lib

The library uses Vitest with jsdom for testing:

• Unit tests for physics calculations
• DOM manipulation tests
• Animation system tests
• Sprite rendering tests

Run tests with:

pnpm test              # Run once
pnpm test --watch      # Watch mode
pnpm test --coverage   # Coverage report

Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

This project is licensed under the MIT License - see the LICENSE file for details.

• NPM Package
• GitHub Repository
• Live Demo
• Bug Reports