Skip to content

SplashCodeDex/keydex

Repository files navigation

KeyDeX

KeyDeX - Advanced Key & Mouse Visualizer

KeyDeX is a powerful, open-source keyboard and mouse visualization tool that I built to help content creators, developers, and presenters showcase their keystrokes and mouse actions in real-time. Perfect for tutorials, live coding sessions, presentations, and screencasts.

English | 简体中文

✨ Features

⌨️ Advanced Keystroke Visualization

Display your keystrokes with style! Show individual keys, modifiers, and complex key combinations with smooth animations and customizable appearances.

🖱️ Mouse Action Tracking

Visualize mouse clicks, drags, scrolls, and modifier combinations like Ctrl + Click or Alt + Drag in real-time.

key-visualizer

🎨 Complete Customization

Make it your own with extensive styling options:

  • Colors: Customize modifier keys, regular keys, backgrounds, and borders
  • Size & Position: Adjust visualization size and screen position
  • Animations: Choose from multiple animation presets
  • Icons: Customizable key icons and visual elements
  • Filters: Show all keys or filter to display only shortcuts

settings-window

🚀 Performance Optimized

Built with Flutter for smooth, efficient performance across all platforms with minimal system resource usage.

📥 Installation

Download KeyDeX from the GitHub Releases page.

🪟 Windows

System Requirements: Windows 10 or later, Visual C++ Redistributables

# Using Winget (recommended)
winget install SplashCodeDex.KeyDeX

# Using Scoop
scoop bucket add extras
scoop install keydex

Note: If you encounter any .dll errors, install Visual C++ Redistributables from Microsoft.

🍎 macOS

Permission Requirements:

  • Enable Input Monitoring in System Settings > Privacy & Security
  • Enable Accessibility permissions for proper functionality

🐧 Linux

Dependencies:

sudo apt-get install libayatana-appindicator3-dev
# or
sudo apt-get install appindicator3-0.1 libappindicator3-dev

Installation:

# Debian/Ubuntu
sudo apt install ./keydex.deb

# RPM-based distributions
sudo rpm -i keydex.rpm

🛠️ Development & Building

Prerequisites

Building from Source

# Clone the repository
git clone https://github.com/SplashCodeDex/keydex.git
cd keydex

# Install dependencies
flutter pub get

# Build for your platform
flutter build windows    # Windows
flutter build macos      # macOS
flutter build linux      # Linux

# Run in development mode
flutter run

Project Structure

  • lib/ - Main Flutter application code
  • assets/ - Icons, fonts, and visual assets
  • linux/, macos/, windows/ - Platform-specific configurations

🤝 Contributing

Contributions are welcome! This project represents my vision for the perfect key visualization tool, but I'm always open to improvements and new ideas.

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-enhancement)
  3. Make your changes
  4. Test thoroughly across platforms
  5. Submit a pull request

📄 License

This project is open source and available under the MIT License.

🙏 Acknowledgments

Built with ❤️ using Flutter and Dart. Special thanks to the open-source community for the amazing tools and libraries that made this possible.


Made by CodeDeX - Because every keystroke tells a story.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

 
 
 

Contributors