BongoCat Next

English | 简体中文

A modern desktop pet application featuring cute Live2D cats to accompany your coding journey

📸 Preview

Standard Mode (Mouse Interaction)

Interactive animations with motions and expressions

Keyboard Mode

The cat responds to your keyboard input with adorable animations!

Cat Girl Mode (Naximofu)

Advanced Live2D model with rich animations

✨ Features

🎯 Core Features

• 🐱 Desktop Pet Display - Adorable Live2D cat models
• ⌨️ Keyboard Response - Real-time keyboard input detection with corresponding animations
• 🖱️ Mouse Interaction - Click animations and mouse tracking
• 🎭 Motion System - Interactive motion selector with various animations
• 😃 Expression System - Dynamic facial expressions control
• 🎨 Live2D Models - Support for custom Live2D model files
• 🖼️ Transparent Window - Seamless desktop integration with full transparency

⚙️ Customization

• 🎛️ Opacity Control - Adjust cat transparency (0-100%)
• 🔄 Mirror Mode - Horizontal flip for different usage preferences
• 📌 Always on Top - Stay above all other windows
• 👻 Click Through - Optional mouse click penetration
• 🗂️ Model Switching - Switch between multiple Live2D models
• 🎮 Selector Visibility - Toggle motion and expression selectors

🛠️ System Integration

• 🎪 System Tray - Convenient tray menu for quick access
• 🔧 Global Hotkeys - System-wide keyboard shortcuts
• 📱 Multi-window - Independent main and settings windows
• 🌐 Cross-platform - Windows, macOS, and Linux support
• 🌍 Internationalization - Multi-language support (English/Chinese) with automatic language detection

🛠️ Tech Stack

Frontend

• Next.js 15 - Modern React framework with Static Site Generation (SSG) support
• TypeScript - Type-safe JavaScript
• Tailwind CSS - Utility-first CSS framework
• Ant Design - Enterprise UI components
• Zustand - Lightweight state management
• PIXI.js v6 - High-performance 2D rendering
• pixi-live2d-display - Live2D model rendering
• react-i18next - Internationalization framework

Backend

• Tauri 2 - Lightweight cross-platform desktop framework
• Rust - Systems programming language
• rdev - Cross-platform device event listening
• tauri-plugin-* - Rich Tauri plugin ecosystem

📦 Installation

Pre-built Releases

Download from Releases page:

• Windows: .msi installer
• macOS: .dmg disk image (Intel & Apple Silicon)
• Linux: .deb / .rpm / .AppImage

Development Setup

Requirements

• Node.js 18.0.0 or higher
• Rust 1.70.0 or higher
• pnpm 8.0.0 or higher

Quick Start

# Clone the repository
git clone https://github.com/liwenka1/bongo-cat-next.git
cd bongo-cat-next

# Install dependencies
pnpm install

# Start development server
pnpm dev

# In another terminal, start Tauri dev mode
pnpm tauri dev

Build

# Build frontend static files
pnpm build

# Build Tauri application
pnpm tauri build

🏗️ Project Structure

bongo-cat-next/
├── 📁 src/                     # Next.js frontend source
│   ├── 📁 app/                # App Router pages
│   │   ├── 📄 page.tsx        # Main window page
│   │   └── 📄 layout.tsx      # Root layout
│   ├── 📁 components/         # React components
│   │   ├── 📄 cat-viewer.tsx          # Cat rendering component
│   │   ├── 📄 motion-selector.tsx     # Motion selection UI
│   │   ├── 📄 expression-selector.tsx # Expression selection UI
│   │   └── 📄 keyboard-visualization.tsx
│   ├── 📁 hooks/              # Custom hooks
│   │   ├── 📁 live2d/         # Live2D system hooks
│   │   │   ├── 📄 _useCore.ts         # Core Live2D management
│   │   │   ├── 📄 _useModelLoader.ts  # Model loading
│   │   │   ├── 📄 _useMotionPlayer.ts # Motion & expression control
│   │   │   └── 📄 _useMouseEvents.ts  # Mouse interaction
│   │   ├── 📄 use-live2d-system.ts    # Main Live2D system
│   │   ├── 📄 use-keyboard.ts         # Keyboard events
│   │   ├── 📄 use-tray.ts             # System tray
│   │   └── 📄 use-shared-menu.ts      # Context menu
│   ├── 📁 i18n/               # Internationalization
│   │   └── 📄 index.ts                # i18n configuration
│   ├── 📁 locales/            # Language resources
│   │   ├── 📁 en-US/          # English translations
│   │   └── 📁 zh-CN/          # Chinese translations
│   ├── 📁 stores/             # Zustand state management
│   │   ├── 📄 cat-store.ts            # Cat state & settings
│   │   └── 📄 model-store.ts          # Model management
│   ├── 📁 types/              # TypeScript definitions
│   │   ├── 📄 live2d.ts              # Live2D types
│   │   └── 📄 device.ts              # Device event types
│   └── 📁 utils/              # Utility functions
│       └── 📄 live2d.ts              # Live2D implementation
├── 📁 src-tauri/              # Tauri Rust backend
│   ├── 📁 src/
│   │   ├── 📄 main.rs         # Main entry
│   │   ├── 📄 lib.rs          # Library entry
│   │   └── 📁 core/           # Core functionality
│   │       └── 📄 device.rs   # Device monitoring
│   ├── 📁 assets/             # Static assets
│   │   ├── 📁 models/         # Live2D model files
│   │   │   ├── 📁 standard/   # Standard cat model
│   │   │   ├── 📁 keyboard/   # Keyboard responsive model
│   │   │   └── 📁 naximofu_2/ # Advanced cat girl model
│   │   └── 📄 tray.png        # Tray icon
│   └── 📄 tauri.conf.json     # Tauri configuration
├── 📁 public/                 # Static files
│   └── 📁 img/                # Demo GIFs
└── 📄 package.json            # Node.js configuration

⚡ Performance

• Lightweight - Based on Tauri 2, installer size < 20MB
• Low Resource Usage - Memory usage < 50MB, CPU usage < 1%
• Native Performance - Rust backend provides native-level performance
• Fast Startup - Application startup time < 2 seconds
• Responsive - Keyboard and mouse event response latency < 10ms

📋 Usage

Basic Operations

1. Launch - Double-click to run, cat appears on desktop
2. Drag - Left-click and drag to move the cat anywhere
3. Right-click Menu - Right-click on cat for feature menu
4. System Tray - Click tray icon for quick access
5. Motion Control - Use the motion selector to play animations
6. Expression Control - Use the expression selector to change facial expressions

Keyboard Shortcuts

• Ctrl + Alt + H - Show/Hide cat
• Ctrl + Alt + S - Open settings
• Ctrl + Alt + Q - Quit application

Configuration

Settings are saved in:

• Windows: %APPDATA%/BongoCat Next/
• macOS: ~/Library/Application Support/BongoCat Next/
• Linux: ~/.config/BongoCat Next/

🤝 Contributing

We welcome all forms of contributions!

Development

1. Fork this repository
2. Create feature branch: git checkout -b feature/AmazingFeature
3. Commit changes: git commit -m 'Add some AmazingFeature'
4. Push to branch: git push origin feature/AmazingFeature
5. Create Pull Request

Commit Convention

Follow Conventional Commits:

• feat: New features
• fix: Bug fixes
• docs: Documentation updates
• style: Code formatting
• refactor: Code refactoring
• test: Testing related
• chore: Build process or auxiliary tools

📄 License

This project is licensed under MIT License.

🙏 Acknowledgments

• Thanks to BongoCat project inspiration
• Thanks to Tauri team for the excellent framework
• Thanks to Live2D Inc. for technical support
• Thanks to Live2d-model for providing the Live2D models
• Thanks to all developers contributing to the open source community

📞 Contact

• GitHub Issues: Submit Issues
• Discussions: Join Discussions

---

If this project helps you, please give it a ⭐ Star!