🐕 TapWatch

A terminal-based typing companion that displays an animated dog reacting to your keystrokes!

✨ Features

• 🐶 Animated Dog Companion - Watch a cute dog react to your typing
• 🌍 Global Key Capture - Monitors keystrokes system-wide
• 🎬 Sprite Animation - Smooth animations with idle and typing states
• 🔤 Big Key Display - See your last pressed key in stylish large text
• ✨ Typing Effects - New characters appear with a coalesce animation
• 🌫️ Text Fade Out - Text dissolves when you stop typing
• 📐 Window Positioning - Snap window to screen edges with arrow keys
• 📦 Compact Layout - Perfect as a coding companion

📦 Installation

cargo install tapwatch

Or build from source:

git clone https://github.com/wooyukit/tapwatch
cd tapwatch
cargo build --release

🚀 Usage

tapwatch

Or run with cargo:

cargo run --release

🎮 Controls

Key	Action
q	Quit
Esc	Quit
Ctrl+C	Quit
↑	Fit & move window to top edge
↓	Fit & move window to bottom edge
←	Fit & move window to left edge
→	Fit & move window to right edge

🖥️ Terminal Support

TapWatch uses iTerm2's inline image protocol (OSC 1337) for sprite display. For the best experience, use:

• ⭐ iTerm2 (recommended)
• WezTerm
• Kitty
• Other terminals supporting inline images

📌 Always on Top (iTerm2)

To keep the TapWatch window always on top of other windows in iTerm2:

1. Open Preferences: Go to iTerm2 → Preferences (or Settings in newer versions)
2. Go to Keys: Select the Keys tab
3. Create Hotkey: Click "Create a Dedicated Hotkey Window"
4. Configure:
   • Set your desired hotkey (e.g., Ctrl + ~ or Option + Space)
   • Check "Floating window"
   • Check "Pin hotkey window" (keeps it on top even when not focused)
   • Check "Animate showing and hiding" for a smoother effect

⚙️ Requirements

• macOS: Grant Accessibility permissions for global key capture

🎯 How It Works

TapWatch uses a sprite sheet with a 4x4 grid of dog animations:

• 😴 Rows 1-2: Idle animation (slow, relaxed)
• ⌨️ Rows 3-4: Typing animation (active, excited)

When you type, the dog transitions from idle to an energetic typing animation!

📚 Dependencies

Crate	Purpose
ratatui	Terminal UI framework
crossterm	Terminal manipulation
rdev	Global keyboard capture
image	Sprite processing
tui-big-text	Large text rendering
tachyonfx	Text animation effects

📄 License

MIT License - feel free to use and modify!

🤝 Contributing

Contributions welcome! Feel free to open issues or submit PRs.

---

Made with 🦀 Rust and ❤️