Skip to content

ryugen-io/wayland-bongocat

BranchesTags
 
 

Repository files navigation

Bongo Cat Wayland Overlay

License: MIT Version

A delightful Wayland overlay that displays an animated bongo cat reacting to your keyboard input! Perfect for streamers, content creators, or anyone who wants to add some fun to their desktop.

Demo

✨ Features

  • 🎯 Real-time Animation - Bongo cat reacts instantly to keyboard input
  • 🔥 Hot-Reload Configuration - Modify settings without restarting (v1.2.0)
  • 🔄 Dynamic Device Detection - Automatically detects Bluetooth/USB keyboards (v1.2.0)
  • ⚡ Performance Optimized - Adaptive monitoring and batch processing (v1.2.0)
  • 🖥️ Screen Detection - Automatic screen detection for all sizes and orientations (v1.2.2)
  • 🎮 Smart Fullscreen Detection - Automatically hides during fullscreen applications (v1.2.3)
  • 🖥️ Multi-Monitor Support - Choose which monitor to display on in multi-monitor setups (v1.2.4)
  • 😴 Sleep Mode - Scheduled or idle-based sleep mode with custom timing (v1.2.5)
  • 🎨 Customizable Appearance - Fine-tune position, size, alignment, and opacity
  • 💾 Lightweight - Minimal resource usage (~7MB RAM)
  • 🎛️ Multi-device Support - Monitor multiple keyboards simultaneously
  • 🏗️ Cross-platform - Works on x86_64 and ARM64

🚀 Installation

Arch Linux (Recommended)

# Using yay
yay -S bongocat

# Using paru
paru -S bongocat

# Run immediately
bongocat --watch-config

# Custom config with hot-reload
bongocat --config ~/.config/bongocat.conf --watch-config

Other Distributions

Fedora 
# Install dependencies
sudo dnf install wayland-devel wayland-protocols-devel gcc make

# Build from source
git clone https://github.com/saatvik333/wayland-bongocat.git
cd wayland-bongocat
make

# Run
./build/bongocat
NixOS 
# Quick start with flakes
nix run github:saatvik333/wayland-bongocat -- --watch-config

# Install to user profile
nix profile install github:saatvik333/wayland-bongocat

📖 For comprehensive NixOS setup, see nix/NIXOS.md

🎮 Quick Start

1. Setup Permissions

# Add your user to the input group
sudo usermod -a -G input $USER
# Log out and back in for changes to take effect

2. Find Your Input Devices

# If installed via AUR
bongocat-find-devices

# If built from source
./scripts/find_input_devices.sh

3. Run with Hot-Reload

# AUR installation
bongocat --watch-config

# From source
./build/bongocat --watch-config

⚙️ Configuration

Bongo Cat uses a simple configuration file format. With hot-reload enabled (--watch-config), changes apply instantly without restarting.

Basic Configuration

Create or edit bongocat.conf:

# Position settings
cat_x_offset=0                   # Horizontal offset from center position
cat_y_offset=0                   # Vertical offset from default position
cat_align=center                 # Horizontal alignment in the bar (left/center/right)

# Size settings
cat_height=80                    # Height of bongo cat (10-200)

# Overlay settings (requires restart)
overlay_height=60                # Height of the entire overlay bar (20-300)
overlay_opacity=150              # Background opacity (0-255)
overlay_position=top             # Position on screen (top/bottom)
layer=top                        # Layer type (top/overlay)

# Animation settings
idle_frame=0                     # Frame to show when idle (0-3)
fps=60                           # Frame rate (1-120)
keypress_duration=100            # Animation duration (ms)
test_animation_duration=200      # Test animation duration (ms)
test_animation_interval=0        # Test animation every N seconds (0=off)

# Input devices (add multiple lines for multiple keyboards)
keyboard_device=/dev/input/event4
# keyboard_device=/dev/input/event20  # External/Bluetooth keyboard

# Multi-monitor support
monitor=eDP-1                    # Specify which monitor to display on (optional)

# Sleep mode settings
enable_scheduled_sleep=0         # Enable scheduled sleep mode (0=off, 1=on)
sleep_begin=20:00                # Begin of sleeping phase (HH:MM)
sleep_end=06:00                  # End of sleeping phase (HH:MM)
idle_sleep_timeout=0             # Inactivity timeout before sleep (seconds, 0=off)

# Debug
enable_debug=0                   # Show debug messages

Configuration Reference

Setting Type Range Default Description
cat_height Integer 10-200 40 Height of bongo cat in pixels
cat_x_offset Integer -9999 to 9999 100 Horizontal offset from center
cat_y_offset Integer -9999 to 9999 10 Vertical offset from center
cat_align String "left"/"center"/"right" "center" Horizontal alignment in the bar
overlay_height Integer 20-300 50 Height of the entire overlay bar
overlay_opacity Integer 0-255 150 Background opacity (0=transparent)
overlay_position String "top" or "bottom" "top" Position of overlay on screen
idle_frame Integer 0-3 0 Frame to show when idle (0=both up, 1=left down, 2=right down, 3=both down)
fps Integer 1-120 60 Animation frame rate
keypress_duration Integer 10-5000 100 Animation duration after keypress (ms)
test_animation_duration Integer 10-5000 200 Test animation duration (ms)
test_animation_interval Integer 0-3600 0 Test animation interval (seconds, 0=disabled)
keyboard_device String Valid path /dev/input/event4 Input device path (multiple allowed)
monitor String Monitor name Auto-detect Monitor to display on (e.g., "eDP-1", "HDMI-A-1")
enable_debug Boolean 0 or 1 1 Enable debug logging
enable_scheduled_sleep Boolean 0 or 1 0 Enable Sleep mode
sleep_begin String "00:00" - "23:59" "00:00" Begin of the sleeping phase
sleep_end String "00:00" - "23:59" "00:00" End of the sleeping phase
idle_sleep_timeout Integer 0+ 0 Duration of user inactivity before entering sleep (seconds)

🔧 Usage

Command Line Options

bongocat [OPTIONS]

Options:
  -h, --help             Show this help message
  -v, --version          Show version information
  -c, --config           Specify config file (default: bongocat.conf)
  -w, --watch-config     Watch config file for changes and reload automatically
  -t, --toggle           Toggle bongocat on/off (start if not running, stop if running)

Examples

# Basic usage
bongocat

# With hot-reload (recommended)
bongocat --watch-config

# Custom config with hot-reload
bongocat --config ~/.config/bongocat.conf --watch-config

# Debug mode
bongocat --watch-config --config bongocat.conf

# Toggle mode
bongocat --toggle

🛠️ Building from Source

Prerequisites

Required:

  • Wayland compositor with layer shell support
  • C11 compiler (GCC 4.9+ or Clang 3.4+)
  • Make
  • libwayland-client
  • wayland-protocols
  • wayland-scanner

Build Process

# Clone repository
git clone https://github.com/saatvik333/wayland-bongocat.git
cd wayland-bongocat

# Build (production)
make

# Build (debug)
make debug

# Clean
make clean

The build process automatically:

  1. Generates Wayland protocol files
  2. Compiles with optimizations and security hardening
  3. Embeds assets directly in the binary
  4. Links with required libraries

🔍 Device Discovery

The bongocat-find-devices tool provides professional input device analysis with a clean, user-friendly interface:

$ bongocat-find-devices

╔══════════════════════════════════════════════════════════════════╗
║ Wayland Bongo Cat - Input Device Discovery v1.2.0                ║
╚══════════════════════════════════════════════════════════════════╝

[SCAN] Scanning for input devices...

[DEVICES] Found Input Devices:
┌─────────────────────────────────────────────────────────────────┐
│ Device: AT Translated Set 2 keyboard                            │
│ Path:   /dev/input/event4                                       │
│ Type:   Keyboard                                                │
│ Status: [OK] Accessible                                         │
└─────────────────────────────────────────────────────────────────┘

┌─────────────────────────────────────────────────────────────────┐
│ Device: Logitech MX Keys                                        │
│ Path:   /dev/input/event20                                      │
│ Type:   Keyboard (Bluetooth)                                    │
│ Status: [OK] Accessible                                         │
└─────────────────────────────────────────────────────────────────┘

[CONFIG] Configuration Suggestions:
Add these lines to your bongocat.conf:

keyboard_device=/dev/input/event4   # AT Translated Set 2 keyboard
keyboard_device=/dev/input/event20  # Logitech MX Keys

Advanced Features

# Show all input devices (including mice, touchpads)
bongocat-find-devices --all

# Generate complete configuration file
bongocat-find-devices --generate-config > bongocat.conf

# Test device responsiveness (requires root)
sudo bongocat-find-devices --test

# Show detailed device information
bongocat-find-devices --verbose

# Get help and usage information
bongocat-find-devices --help

Key Features

  • Smart Detection - Automatically identifies keyboards vs other input devices
  • Device Classification - Distinguishes between built-in, Bluetooth, and USB keyboards
  • Permission Checking - Verifies device accessibility and provides fix suggestions
  • Config Generation - Creates ready-to-use configuration snippets
  • Device Testing - Integrated evtest functionality for troubleshooting
  • Professional UI - Clean, colorized output with status indicators
  • Error Handling - Comprehensive error messages and troubleshooting guidance

📊 Performance

System Requirements

  • CPU: Any modern x86_64 or ARM64 processor
  • RAM: ~7MB runtime usage
  • Storage: ~0.4MB executable size
  • Compositor: Wayland with layer shell protocol support

Tested Compositors

  • ✅ Hyprland - Full support
  • ✅ Sway - Full support
  • ✅ Wayfire - Compatible
  • ✅ KDE Wayland - Compatiable
  • ❌ GNOME Wayland - Unsupported

🐛 Troubleshooting

Common Issues

Permission denied accessing /dev/input/eventX

Solution:

# Add user to input group (recommended)
sudo usermod -a -G input $USER
# Log out and back in

# Or create udev rule
echo 'KERNEL=="event*", GROUP="input", MODE="0664"' | sudo tee /etc/udev/rules.d/99-input.rules
sudo udevadm control --reload-rules
Keyboard input not detected

Diagnosis:

# Find correct device
bongocat-find-devices

# Test device manually
sudo evtest /dev/input/event4

Solution: Update keyboard_device in bongocat.conf with correct path.

Overlay not visible or clickable

Check:

  • Ensure compositor supports wlr-layer-shell-unstable-v1
  • Verify WAYLAND_DISPLAY environment variable is set
  • Try different overlay_opacity values

Tested compositors: Hyprland, Sway, Wayfire

Multi-monitor setup issues

Finding monitor names:

# Using wlr-randr (recommended)
wlr-randr

# Using swaymsg (Sway only)
swaymsg -t get_outputs

# Check bongocat logs for detected monitors
bongocat --watch-config  # Look for "xdg-output name received" messages

Configuration:

# Specify exact monitor name
monitor=eDP-1        # Laptop screen
monitor=HDMI-A-1     # External HDMI monitor
monitor=DP-1         # DisplayPort monitor

Troubleshooting:

  • If monitor name is wrong, bongocat falls back to first available monitor
  • Monitor names are case-sensitive
  • Remove or comment out monitor= line to use auto-detection
Build errors

Common fixes:

  • Install development packages: libwayland-dev wayland-protocols
  • Ensure C11 compiler: GCC 4.9+ or Clang 3.4+
  • Install wayland-scanner package

Getting Help

  1. Enable debug logging: bongocat --watch-config (ensure enable_debug=1)
  2. Check compositor compatibility
  3. Verify all dependencies are installed
  4. Test with minimal configuration

🏗️ Architecture

Project Structure

wayland-bongocat/
├── src/                 # Source code
│   ├── main.c          # Application entry point
│   ├── config.c        # Configuration management
│   ├── config_watcher.c # Hot-reload system (v1.2.1)
│   ├── input.c         # Input device monitoring
│   ├── wayland.c       # Wayland protocol handling
│   └── ...
├── include/            # Header files
├── scripts/            # Build and utility scripts
├── assets/             # Animation frames
├── protocols/          # Generated Wayland protocols
└── nix/               # NixOS integration

🤝 Contributing

This project follows industry best practices with a modular architecture. Contributions are welcome!

Development Setup

git clone https://github.com/saatvik333/wayland-bongocat.git
cd wayland-bongocat
make debug

Code Standards

  • C11 standard compliance
  • Comprehensive error handling
  • Memory safety with leak detection
  • Extensive documentation

📄 License

MIT License - see LICENSE file for details.

🙏 Acknowledgments

Built with ❤️ for the Wayland community. Special thanks to:

  • Redditor: u/akonzu for the inspiration
  • @Shreyabardia for the beautiful custom-drawn bongo cat artwork
  • All the contributors and users

₍^. .^₎ Wayland Bongo Cat Overlay v1.2.5 - Making desktops more delightful, one keystroke at a time!

About

bongocat for your desktop ₍^. .^₎

Resources

Readme

License

MIT license
Activity

Stars

1 star

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages

  • C 53.0%
  • C++ 41.6%
  • Shell 3.1%
  • Nix 1.5%
  • Makefile 0.8%