Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cat Overlay

A transparent, always-on-top Electron overlay that displays bouncing cats on your screen. Designed for Twitch streamers to trigger via channel point redemptions through Streamer.bot.

Features

  • Transparent, click-through overlay (play games while cats bounce!)
  • Bouncing cats with elastic collision physics
  • Random cat sizes (50-150px)
  • 10-second lifetime with fade-out effect
  • Simple HTTP API for triggering from Streamer.bot

Installation

npm install

Usage

npm start

The overlay will start and listen for HTTP requests on http://127.0.0.1:3333.

Adding Your Cat Image

Place your cat PNG image at:

assets/cat.png

If no image is found, a fallback cartoon cat will be used.

API Endpoints

Spawn Cats

GET http://127.0.0.1:3333/spawn?count=5

Spawns the specified number of cats (1-100). Default is 1.

Clear All Cats

GET http://127.0.0.1:3333/clear

Immediately removes all cats from the screen.

Health Check

GET http://127.0.0.1:3333/health

Returns { "status": "ok" } if the overlay is running.

Streamer.bot Setup

  1. Create a new action in Streamer.bot
  2. Add a "HTTP Request" sub-action
  3. Configure:
    • Method: GET
    • URL: http://127.0.0.1:3333/spawn?count=10
  4. Trigger this action from a Twitch Channel Point Reward

Configuration

Edit renderer/overlay.js to customize:

// Cat spawn settings
this.minSize = 50;      // Minimum cat size in pixels
this.maxSize = 150;     // Maximum cat size in pixels
this.minSpeed = 3;      // Minimum movement speed
this.maxSpeed = 8;      // Maximum movement speed

Edit renderer/cat.js to customize:

this.lifetime = 10000;       // How long cats live (ms)
this.fadeOutDuration = 500;  // Fade out duration (ms)

Notes

  • The overlay runs on your primary monitor only
  • Cats bounce off screen edges and each other with elastic collisions
  • The window is click-through, so it won't interfere with your games
  • Works best with borderless/windowed fullscreen games

About

Skill issue but better.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages