A high-performance, external rhythm game input visualizer.

RainingKeys is a purely external overlay application that visualizes keyboard inputs as falling bars, similar to the "Rain" mode found in various rhythm game mods. It provides visual feedback on rhythm stability, micro-jitter, and input timing without injecting code into the game process.

• External Overlay: Runs as a transparent, always-on-top, click-through window over any game.
• Graphic Interface: Live configuration window to adjust settings on the fly.
• Positioning: Configurable X/Y overlay position.
• Fall Direction: Supports both Down (Classic) and Up (Reverse) fall directions (controlled by KeyViewer position).
• Accurate Timing: Uses high-resolution monotonic clocks (time.perf_counter) for smooth, jitter-free falling animation.
• Lane System: Configurable key-to-lane mapping (e.g., WASD, Space, Enter).
• KeyViewer Panel: Visual keyboard representation that shows key presses and counts.
• KeyViewer Transparency: Adjustable opacity for inactive keys.
• Custom Visuals: Configurable colors (RGBA) and adjustable overlay speed.
• Long Press Support: Visualizes held keys with variable-length bars.
• Performance Optimized: Implements object pooling and efficient rendering logic to minimize CPU/GPU usage.

• Python 3.10+
• PySide6 (Qt): High-performance rendering and window management.
• pynput: Global low-level keyboard hook.
• pywin32: Windows API integration for transparency and click-through flags.

RainingKeysPython/
├── core/
│   ├── config.py           # Default configuration constants
│   ├── gui.py              # Configuration Window GUI
│   ├── input_mon.py        # Global input listener
│   ├── overlay.py          # Main rendering loop and window logic
│   └── settings_manager.py # Handles config loading/saving
├── build.py                # Build script for creating standalone executable
├── main.py                 # Application entry point
└── requirements.txt        # Dependencies

1. Prerequisites: Ensure you have Python 3.10 or newer installed.
2. Clone the repository (or download source):

   git clone https://github.com/your-username/RainingKeysPython.git
   cd RainingKeysPython

3. Install dependencies:

   pip install -r requirements.txt

1. Run the application:

   python main.py

2. The application launches two windows:
   • Transparent Overlay: The visualizer itself (click-through).
   • Config Window: The controls (Alt+Tab to find if hidden).
3. Configure Lanes:
   • Click "Record Lane Keys" in the config window.
   • Press the keys you want to bind (e.g., Z, X, ., /).
   • Click "Stop Recording" to save.
4. Customize:
   • Adjust Scroll Speed and Bar Color.
   • Enable KeyViewer to see the static key panel.
   • Drag Inactive Opacity to change how faint unpressed keys look.
   • Change KeyViewer Position (Above/Below) to automatically flip the fall direction.

Settings are stored in config.ini (automatically created on first run). You can edit this file manually or use the GUI Settings Window.

• Interactive Configuration UI
• Save/Load config
• Custom color selection
• Custom key mapping
• KeyViewer Panel & Key Counters
• Multi-monitor support

This software is an unofficial community tool. It is not affiliated with, endorsed by, or connected to 7th Beat Games (developers of A Dance of Fire and Ice) or any other game developer. Use responsibly.

Contributions are welcome! We'd love to make this tool better together.

• Have a big idea or found a bug?
  Open an Issue and tell us about it!
• Want to help implement a feature?
  Fork the repository and submit a Pull Request.

Any contributions you make are greatly appreciated.

This project is inspired by the RainingKeys mod for A Dance of Fire and Ice, originally created by paring-chan.

Also credits to AdofaiTweaks by PizzaLovers007.

MIT License. See LICENSE for details.