Skip to content

CHANGELOG.md

Latest commit

 

History

History
219 lines (142 loc) · 9.54 KB

CHANGELOG.md

File metadata and controls

219 lines (142 loc) · 9.54 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

[2.0.2] - 2026-07-13

Fixed

  • Fullscreen focus tracking - The cat becomes visible again after leaving a fullscreen window for another window or workspace.

[2.0.1] - 2026-07-13

Fixed

  • Concurrent paw animation - Pressing keys on both sides of the keyboard now moves both paws at once (the both-down frame). Previously only the last-pressed key's paw animated. Per-paw deadlines preserve both input events. Fixes #78.
  • HiDPI output placement - Logical output dimensions, fractional scales, transformed outputs, and negative offsets now place overlays correctly. Fixes #75.
  • Layer and hot reload safety - All layer-shell layers can be configured and reloaded safely. Fixes #76.
  • Input and process lifecycle - Input monitoring restarts after relevant configuration changes; child process groups now stop reliably.

Changed

  • Configuration validation - Invalid time, boolean, and integer values are rejected before they reach runtime.

[2.0.0] - 2026-04-05

Breaking Changes

  • PNG → SVG asset migration - All cat assets are now SVG, rendered via nanosvg. The new artwork has a different aspect ratio (500x277 vs the old 864x360 PNGs, ~1.8:1 vs ~2.4:1). Users must re-tune their config values — at the same cat_height, the cat will appear narrower than before. Recommended starting point: cat_height=110, overlay_height=120.
  • enable_antialiasing is now a deprecated no-op. SVG rendering always produces anti-aliased output. The option is accepted but ignored.

Added

  • SVG Rendering - Pixel-perfect rendering at any size via nanosvg. No more scaling artifacts or blurry edges.
  • Sleeping Animation - 5th animation frame. idle_sleep_timeout now shows a sleeping cat instead of hiding the overlay.
  • Fast Input Retry - Input child retries device scanning every 5 seconds until devices are found, then switches to the configured hotplug_scan_interval. Fixes #69.

Changed

  • Default hotplug_scan_interval reduced from 300s to 30s for faster device detection after boot.
  • Build system - Generated Wayland protocol files are now committed to git. Building from source no longer requires wayland-scanner or wayland-protocols. Use make protocols to regenerate after updating XML sources. make clean no longer removes protocol files; use make distclean for that.
  • Nix derivation - Dropped wayland-scanner and wayland-protocols build dependencies since protocol bindings are pre-generated.

Fixed

  • Hot-reload crash (#71) - Changing overlay_height, overlay_position, or layer while running with -w no longer crashes. Uses wlr-layer-shell double-buffered properties instead of destroying/recreating surfaces.
  • Build failure (#73) - Required protocol bindings are committed to git, eliminating build-time wayland-scanner dependencies.
  • KWin fullscreen detection (#28) - Relaxed the global fullscreen fallback for compositors (KDE/KWin) that don't send per-toplevel output events. Overlay now auto-hides during fullscreen on KDE.
  • Missing protocol error (#70) - Error message now names the specific missing protocol instead of a generic failure.
  • SVG edge artifacts - Premultiplied alpha compositing for correct Wayland ARGB8888 rendering, eliminating dark fringe on anti-aliased edges.

[1.4.0] - 2026-02-14

Added

  • Multi-monitor CSV - monitor now accepts comma-separated output names; parent process launches dedicated children via --multi-monitor-child and CLI docs reflect new flow.
  • Safe hot reload hook - Config watcher now only signals reloads, the actual reload runs from a Wayland tick callback so Wayland structures stay main-thread bound.

Changed

  • Config model - config_t now stores per-config device/output arrays, inline comments are stripped, and monitor parsing loads multiple names with fallback to automatic output; keyboards hotplug state is rebuilt cleanly on reload.
  • Wayland rendering - Draw path takes anim_lock, surface recreation checks the applied layer/output/size snapshots, and buffer recreation is serialized to avoid tearing/races when configs change.
  • Documentation & packaging - README/bongocat.conf.example demonstrate comma-separated monitors, Makefile installs now ship the example config, and CLI help/version text was refreshed for v1.4.0.

Fixed

  • Dangling pointers on reload - g_config swap, input device lists, and watcher cleanup now occur only after new config is validated so the old config isn’t left referencing freed memory.
  • Config watcher and animation races - Atomic flags and mutex coverage were tightened, config_reload_callback no longer touches Wayland structures directly, and animation draw/update now handle surface recreation safely.
  • Input hotplug robustness - Path truncation is guarded, static device comparisons check nulls, and signal handlers close cleanly when the child early-exits.

[1.3.2] - 2025-12-07

Fixed

  • Monitor Reconnection - Overlay now survives monitor disconnect/reconnect (fixes #15)
  • Dynamic Overlay Resize - Changing overlay_height via config reload no longer crashes
  • Ghost Process Prevention - Added SIGQUIT/SIGHUP handlers and parent liveness check in child

Improved

  • Performance Optimizations
    • Fast buffer clearing using memset (~4x faster)
    • Skip unchanged frames when idle (~95% fewer redraws)
    • Hoisted loop invariants in image scaling
  • Thread Safety - Mutex protection during buffer recreation
  • Memory Usage - Reduced from ~20MB to ~8MB RAM

[1.3.1] - 2025-12-06

Added

  • Keyboard Hand Mapping - Left half of keyboard triggers left cat hand, right half triggers right hand
  • New config option enable_hand_mapping=1 (enabled by default)
  • Hand mapping respects mirror_x - hands flip when cat is mirrored

Changed

  • enable_hand_mapping default is now 1 (enabled)
  • NixOS module enableHandMapping default is now true

[1.3.0] - 2025-12-06

Added

  • Improved Anti-Aliasing - Box filter for downscaling + proper alpha blending for smooth edges at any size
  • Interactive Keyboard Detection - New --interactive mode in bongocat-find-devices listens for actual key presses
  • Hot-Reload Device Changes - Changing keyboard devices in config now works without restart
  • C23 Modern Codebase - RAII macros, [[nodiscard]] attributes, guard clauses throughout

Fixed

  • Hot-Reload Bug - Keyboard device path changes now properly trigger input restart
  • Memory Leaks - Fixed realloc leaks in config parsing
  • Thread Safety - Atomic operations for shared state between threads
  • Use-After-Free - Fixed crash in config reload callback
  • Fullscreen Detection - Now correctly tracks active window per workspace

Improved

  • README - Streamlined documentation with minimal config example
  • Script Reliability - Device detection script distinguishes actual keyboards from power buttons/hotkeys
  • Code Quality - Organized headers, consistent naming, comprehensive error handling

[1.2.5] - 2025-08-26

Added

  • Enhanced Configuration System - New config variables for fine-tuning appearance and behavior
  • Sleep Mode - Scheduled or idle-based sleep mode with customizable timing

Fixed

  • Fixed Positioning - Fine-tune position, defaults to center

Improved

  • Default Values - Refined default configuration values for better out-of-box experience

[1.2.4] - 2025-08-08

Added

  • Multi-Monitor Support - Choose which monitor to display bongocat on using the monitor configuration option
  • Monitor Detection - Automatic detection of available monitors with fallback to first monitor if specified monitor not found
  • XDG Output Protocol - Proper Wayland protocol implementation for monitor identification

Fixed

  • Memory Leaks - Fixed memory leak in monitor configuration cleanup
  • Process Cleanup - Resolved child process cleanup warnings during shutdown
  • Segmentation Fault - Fixed crash during application exit related to Wayland resource cleanup

Improved

  • Error Handling - Better error messages when specified monitor is not found
  • Resource Management - Improved cleanup order for Wayland resources
  • Logging - Enhanced debug logging for monitor detection and selection

[1.2.3] - 2025-08-02

Added

  • Smart Fullscreen Detection - Automatically hides overlay during fullscreen applications for a cleaner experience
  • Enhanced Artwork - Custom-drawn bongocat image files by @Shreyabardia
  • Modular Architecture - Reorganized codebase into logical modules for better maintainability

Improved

  • Signal Handling - Fixed duplicate log messages during shutdown
  • Code Organization - Separated concerns into core, graphics, platform, config, and utils modules
  • Build System - Updated to support new modular structure

[1.2.2] - Previous Release

Added

  • Automatic screen detection for all sizes and orientations
  • Enhanced performance optimizations

[1.2.1] - Previous Release

Added

  • Configuration hot-reload system
  • Dynamic device detection

[1.2.0] - Previous Release

Added

  • Hot-reload configuration support
  • Dynamic Bluetooth/USB keyboard detection
  • Performance optimizations with adaptive monitoring
  • Batch processing for improved efficiency

[1.1.x] - Previous Releases

Added

  • Multi-device support
  • Embedded assets
  • Cross-platform compatibility (x86_64 and ARM64)
  • Basic configuration