feat: Introduce graphical settings interface, KeyViewer panel, and custom color options, updating README accordingly.

Author: Ian-bug

README.md

@@ -21,13 +21,14 @@ RainingKeys is a purely external overlay application that visualizes keyboard in
 - **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.
+- **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.
-- **Fade Out**: Distance-based fade-out for visual clarity.
-- **Input Latency Compensation**: Configurable offset to visually align inputs with audio latency.
 
 ## Tech Stack
 
@@ -66,22 +67,22 @@ RainingKeysPython/
 
 ## Usage
 
-1.  Run the build script:
+1.  Run the application:
     ```bash
-    python build.py
+    python main.py
     ```
-2.  The script will generate:
-    -   Folder: `dist/RainingKeysPython/`
-    -   Zip: `RainingKeysPython.zip` (or `RainingKeysPython-debug.zip` if in debug mode)
-
-### Debug vs Release Build
-You can toggle the console window visibility via `config.ini`:** window (controls settings).
-3.  Use the Config window to move the overlay or change speed/direction live.
-4.  **Configure Lanes**:
+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. The overlay uses these keys immediately.
-5.  **To Exit**: Close the Config window or press `Ctrl+C` in the terminal.
+    -   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.
 
 ## Configuration
 
@@ -93,20 +94,22 @@ You can edit this file manually or use the **GUI Settings Window**.
 | Section | Parameter | Description |
 | :--- | :--- | :--- |
 | `Visual` | `scroll_speed` | Falling speed in pixels per second. |
-| `Visual` | `fall_direction` | `down` or `up`. |
+| `Visual` | `bar_color` | RGBA color string (e.g., `0,255,255,200`). |
 | `Position` | `x` | Overlay X position (pixels). |
 | `Position` | `y` | Overlay Y position (pixels). |
-| `lanes` | `keys` | Comma-separated list of keys (e.g., `'z','x','.'`). |
-
-*Note: Key mappings and colors are currently defined in `core/config.py`.*
+| `lanes` | `keys` | Comma-separated list of keys. |
+| `keyviewer` | `enabled` | Show/Hide KeyViewer panel. |
+| `keyviewer` | `panel_position` | `above` or `below`. Affects fall direction. |
+| `keyviewer` | `opacity` | Opacity of inactive keys (0.0 - 1.0). |
 
 ## Todo
 
-- [x] Interactive Configuration UI (GUI for settings)
-- [x] Save/Load config from ini
-- [ ] Multi-monitor support
-- [ ] Custom color
-- [x] Custom key mapping 
+- [x] Interactive Configuration UI
+- [x] Save/Load config
+- [x] Custom color selection
+- [x] Custom key mapping
+- [x] KeyViewer Panel & Key Counters
+- [ ] Multi-monitor support 
 
 ## Disclaimer
 
@@ -127,6 +130,8 @@ 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](https://github.com/paring-chan/RainingKeys)**.
 
+Also credits to **[AdofaiTweaks](https://github.com/PizzaLovers007/AdofaiTweaks)** by **PizzaLovers007**.
+
 ## License
 
 MIT License. See `LICENSE` for details.

core/gui.py

@@ -135,7 +135,6 @@ def init_ui(self):
         self.spin_kv_off_x.setValue(self.settings.kv_offset_x)
         self.spin_kv_off_x.valueChanged.connect(self.on_kv_changed)
         off_layout.addWidget(self.spin_kv_off_x)
-
         off_layout.addWidget(QLabel("Y:"))
         self.spin_kv_off_y = QSpinBox()
         self.spin_kv_off_y.setRange(-1000, 1000)
@@ -144,6 +143,17 @@ def init_ui(self):
         off_layout.addWidget(self.spin_kv_off_y)
         kv_layout.addLayout(off_layout)
 
+        # Transparency Control
+        trans_layout = QHBoxLayout()
+        trans_layout.addWidget(QLabel("Inactive Opacity:"))
+        self.spin_kv_opacity = QSpinBox()
+        self.spin_kv_opacity.setRange(0, 100)
+        self.spin_kv_opacity.setSuffix("%")
+        self.spin_kv_opacity.setValue(int(self.settings.kv_opacity * 100))
+        self.spin_kv_opacity.valueChanged.connect(self.on_kv_changed)
+        trans_layout.addWidget(self.spin_kv_opacity)
+        kv_layout.addLayout(trans_layout)
+
         self.chk_kv_counts = QCheckBox("Show Key Counts")
         self.chk_kv_counts.setChecked(self.settings.kv_show_counts)
         self.chk_kv_counts.stateChanged.connect(self.on_kv_changed)
@@ -189,6 +199,7 @@ def on_kv_changed(self):
         self.settings.set('keyviewer', 'panel_offset_x', self.spin_kv_off_x.value())
         self.settings.set('keyviewer', 'panel_offset_y', self.spin_kv_off_y.value())
         self.settings.set('keyviewer', 'show_counts', self.chk_kv_counts.isChecked())
+        self.settings.set('keyviewer', 'opacity', self.spin_kv_opacity.value() / 100.0)
         self.settings.save()
 
     def toggle_recording(self):

core/overlay.py

@@ -371,9 +371,11 @@ def draw_keyviewer(self, painter, geom):
                  if bg_color.alpha() > 200:
                     bg_color = bg_color.lighter(120)
             else:
-                # Inactive: Scale alpha down (e.g. 20%)
+                # Inactive: Scale alpha down based on settings
                 current_alpha = bg_color.alpha()
-                new_alpha = max(20, int(current_alpha * 0.2))
+                # Opacity is 0.0 to 1.0. If opacity is 0.2, we want 20% of current alpha.
+                opacity_factor = self.settings.kv_opacity 
+                new_alpha = int(current_alpha * opacity_factor)
                 bg_color.setAlpha(new_alpha)
 
             painter.setBrush(QBrush(bg_color))

core/settings_manager.py

@@ -84,6 +84,10 @@ def _load(self):
             self.config.set('keyviewer', 'height', '50')
             changed = True
 
+        if not self.config.has_option('keyviewer', 'opacity'):
+            self.config.set('keyviewer', 'opacity', '0.2')
+            changed = True
+            
         if changed:
             self.save()
 
@@ -135,10 +139,6 @@ def save_lanes(self, key_list):
     def scroll_speed(self):
         return self.get('Visual', 'scroll_speed', Config.SCROLL_SPEED, int)
 
-    @property
-    def scroll_speed(self):
-        return self.get('Visual', 'scroll_speed', Config.SCROLL_SPEED, int)
-    
     # REMOVED: fall_direction property
 
     @property
@@ -182,3 +182,6 @@ def kv_offset_y(self):
     @property
     def kv_show_counts(self):
         return self.config.getboolean('keyviewer', 'show_counts')
+    @property
+    def kv_opacity(self):
+        return self.get('keyviewer', 'opacity', 0.2, float)