Skip to content

sofiadparamo/bongocat

🚧 This project is Work In Progress.

I'm currently supporting this project with my free time. If you encounter any issues please create an issue. Also, if you want to contribute, please do so! I can't promise to merge your pull requests, but I'll definitely check them out! I'm going to add a roadmap of wanted features soon.

No contribution guides yet, but feel free to ask if you have any questions!

😺 Bongo Cat Overlay

A floating, always-on-top Bongo Cat overlay for Windows 11 — perfect for streamers, music lovers, and anyone who wants a little keyboard-tapping cat cheering them on.

Screenshot 2025-07-09 034836

✨ Features

  • 🎹 Reactive tapping — Cat bops with any key press
  • 💤 Idle pose — Switches to a chill idle after inactivity
  • 🖱️ Drag to move — Click and drag to reposition
  • 🔍 Scroll to resize — Use mouse wheel to scale
  • ⬆️ Always on top — Won’t get buried under windows
  • 🧰 System tray menu — Resize, toggle autostart, open config
  • ⚙️ Config saved per user
  • 🖼️ Self-contained EXE — No setup required if you just want to run it
  • 🧙 Installer included — Adds start menu shortcut, autostart, uninstall support

🚀 Installation

🧪 Option A: Just run it

Download bongocat.exe from the Releases page and run it directly. You'll need to place the assets (.png and .ico files) in the same folder.

🧙 Option B: Install it properly

Download and run BongoCatSetup.exe to:

  • Add it to Start menu
  • Enable "Start on boot" from system tray
  • Uninstall cleanly from Windows Settings

🛠️ Building

Requirements

Build commands

# Build the EXE with embedded assets
pyinstaller --onefile --noconsole --icon=bongoicon.ico --add-data "frame_idle.png;." --add-data "frame1.png;." --add-data "frame2.png;." --add-data "bongoicon.png;." bongocat.py

# Generate the installer
& "C:\Program Files (x86)\Inno Setup 6\ISCC.exe" .\BongoCat.iss

Final output will be in dist\ (EXE) and Output\ (installer).


⚙️ Configuration

Settings like scale and autostart are stored in:

%APPDATA%\BongoCat\config.json

Use the system tray menu to change options or open the config folder.


📦 File Overview

File Purpose
bongocat.py Main app
bongoicon.png App + installer icon
frame_idle.png Idle pose
frame1.png Tap frame 1
frame2.png Tap frame 2
BongoCat.iss Inno Setup installer script
BongoCat.spec PyInstaller spec file

🧹 Uninstalling

If you used the installer, just go to:

SettingsAppsInstalled AppsBongo CatUninstall

Or use the Start menu shortcut to uninstall.

Otherwise, delete the app folder and config file manually. The paths are listed above.

You may also want to delete the registry key if you used the "Start with Windows" option.

About

Simple BongoCat app for windows

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages