Skip to content

Support additional rain configuration #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Thedoczek wants to merge 1 commit into
base: master
Choose a base branch
from
+92 −10
Open

Support additional rain configuration #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 29 additions & 2 deletions core/configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ class DisplayConstants:
KEYVIEWER_OFFSET_Y_TOP: int = 50
KEYVIEWER_OFFSET_Y_BOTTOM: int = 50
FALLBACK_SCREEN_HEIGHT: int = 1080
FADE_START_Y: int = 800
FADE_RANGE: int = 200

@dataclass
class VisualSettings:
Expand Down Expand Up @@ -114,6 +112,9 @@ class KeyViewerSettings:
show_counts: bool = True
height: int = 60
opacity: float = 0.2
fade_position_y: int = 800
fade_length_y: int = 200
fade_trigger: str = "head"

def validate(self) -> bool:
"""Validate KeyViewer settings.
Expand All @@ -135,6 +136,32 @@ def validate(self) -> bool:
self.opacity = max(0.0, min(1.0, self.opacity))
valid = False

# Attempt to get maximum screen height from all connected screens
try:
screens = QApplication.screens()
if screens:
max_screen_y = max(screen.size().height() for screen in screens)
else:
max_screen_y = 5000
except Exception:
max_screen_y = 5000

# Validate fade parameters with respect to maximum screen size
if not (0 <= self.fade_position_y <= max_screen_y):
logger.warning(f"Fade position {self.fade_position_y} out of range [0, {max_screen_y}], clamping")
self.fade_position_y = max(0, min(max_screen_y, self.fade_position_y))
valid = False
if not (10 <= self.fade_length_y <= max_screen_y):
logger.warning(f"Fade length {self.fade_length_y} out of range [10, {max_screen_y}], clamping")
self.fade_length_y = max(0, min(max_screen_y, self.fade_length_y))
valid = False
Comment on lines +154 to +157

@coderabbitai coderabbitai Bot Jun 14, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical | ⚡ Quick win

Clamp for fade_length_y violates its own minimum bound and can crash rendering.

Line 154 enforces a minimum of 10, but Line 156 clamps with max(0, ...), which allows 0. That can propagate to _draw_active_bars() and trigger division by zero at dist_into_fade / fade_length_y.

Suggested fix 
-        if not (10 <= self.fade_length_y <= max_screen_y):
+        if not (10 <= self.fade_length_y <= max_screen_y):
             logger.warning(f"Fade length {self.fade_length_y} out of range [10, {max_screen_y}], clamping")
-            self.fade_length_y = max(0, min(max_screen_y, self.fade_length_y))
+            self.fade_length_y = max(10, min(max_screen_y, self.fade_length_y))
             valid = False
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if not (10 <= self.fade_length_y <= max_screen_y):
logger.warning(f"Fade length {self.fade_length_y} out of range [10, {max_screen_y}], clamping")
self.fade_length_y = max(0, min(max_screen_y, self.fade_length_y))
valid = False
if not (10 <= self.fade_length_y <= max_screen_y):
logger.warning(f"Fade length {self.fade_length_y} out of range [10, {max_screen_y}], clamping")
self.fade_length_y = max(10, min(max_screen_y, self.fade_length_y))
valid = False
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@core/configuration.py` around lines 154 - 157, The clamping operation for
fade_length_y uses max(0, ...) which allows the value to drop below the minimum
bound of 10 that was validated on line 154, potentially causing division by zero
in _draw_active_bars(). Fix this by changing the max(0, ...) call to max(10,
...) to enforce the consistent minimum bound of 10 that matches the validation
check.


# Validate fade trigger
if self.fade_trigger not in ("head", "tail"):
logger.warning(f"Fade trigger '{self.fade_trigger}' not in ('head', 'tail'), using 'head'")
self.fade_trigger = "head"
valid = False

# Validate panel_position
if self.panel_position not in ("above", "below"):
logger.warning(f"Invalid panel_position '{self.panel_position}', using 'below'")
Expand Down
2 changes: 1 addition & 1 deletion core/gui.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ def __init__(self, settings_manager: SettingsManager) -> None:
self.settings = settings_manager
self.config = self.settings.app_config
self.setWindowTitle(f"RainingKeys Config v{self.config.VERSION}")
self.resize(400, 670)
self.resize(410, 722)

# Apply Theme
self.setStyleSheet(DARK_THEME)
Expand Down
13 changes: 8 additions & 5 deletions core/overlay.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,8 +375,9 @@ def _draw_active_bars(
kv_offset_x = self.config.key_viewer.panel_offset_x
bar_color = self.config.visual.bar_color

fade_start_y = self.config.display.FADE_START_Y
fade_range = self.config.display.FADE_RANGE
fade_position_y = self.config.key_viewer.fade_position_y
fade_length_y = self.config.key_viewer.fade_length_y
fade_trigger = self.config.key_viewer.fade_trigger
input_latency = self.config.INPUT_LATENCY_OFFSET

# Bar Drawing Loop
Expand Down Expand Up @@ -422,10 +423,12 @@ def _draw_active_bars(
continue

# 5. Fade Logic
trigger_dist = dist_head if fade_trigger == "head" else dist_tail

alpha = 1.0
if dist_head > fade_start_y:
dist_into_fade = dist_head - fade_start_y
factor = 1.0 - (dist_into_fade / fade_range)
if trigger_dist > fade_position_y:
dist_into_fade = trigger_dist - fade_position_y
factor = 1.0 - (dist_into_fade / fade_length_y)
alpha = max(0.0, min(1.0, factor))

if alpha <= 0.0:
Expand Down
6 changes: 6 additions & 0 deletions core/settings_manager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ def load(self) -> None:
kv.show_counts = self.config_parser.getboolean('keyviewer', 'show_counts', fallback=True)
kv.height = self.config_parser.getint('keyviewer', 'height', fallback=60)
kv.opacity = self.config_parser.getfloat('keyviewer', 'opacity', fallback=0.2)
kv.fade_position_y = self.config_parser.getint('keyviewer', 'fade_position_y', fallback=800)
kv.fade_length_y = self.config_parser.getint('keyviewer', 'fade_length_y', fallback=200)
kv.fade_trigger = self.config_parser.get('keyviewer', 'fade_trigger', fallback="head")

# Lanes
if self.config_parser.has_section('lanes'):
Expand Down Expand Up @@ -142,6 +145,9 @@ def save(self) -> None:
self.config_parser.set('keyviewer', 'show_counts', str(kv.show_counts))
self.config_parser.set('keyviewer', 'height', str(kv.height))
self.config_parser.set('keyviewer', 'opacity', str(kv.opacity))
self.config_parser.set('keyviewer', 'fade_position_y', str(kv.fade_position_y))
self.config_parser.set('keyviewer', 'fade_length_y', str(kv.fade_length_y))
self.config_parser.set('keyviewer', 'fade_trigger', kv.fade_trigger)

# Lanes
if not self.config_parser.has_section('lanes'): self.config_parser.add_section('lanes')
Expand Down
50 changes: 48 additions & 2 deletions core/ui/components.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from typing import Optional
from PySide6.QtWidgets import (
QWidget, QVBoxLayout, QHBoxLayout, QLabel, QSpinBox,
QApplication, QWidget, QVBoxLayout, QHBoxLayout, QLabel, QSpinBox,
QComboBox, QGroupBox, QPushButton, QCheckBox, QColorDialog
)
from PySide6.QtCore import Signal
Expand Down Expand Up @@ -281,6 +281,44 @@ def init_ui(self) -> None:
self.chk_kv_counts.setChecked(self.config.key_viewer.show_counts)
self.chk_kv_counts.stateChanged.connect(self.on_change)
layout.addWidget(self.chk_kv_counts)

# Attempt to get maximum screen height from all connected screens
try:
screens = QApplication.screens()
if screens:
max_screen_y = max(screen.size().height() for screen in screens)
else:
max_screen_y = 5000
except Exception:
max_screen_y = 5000

# Fade Controls
fade_layout = QHBoxLayout()
fade_layout.addWidget(QLabel("Fade Y:"))
self.spin_kv_fade_pos = QSpinBox()
self.spin_kv_fade_pos.setRange(0, max_screen_y)
self.spin_kv_fade_pos.setValue(self.config.key_viewer.fade_position_y)
self.spin_kv_fade_pos.valueChanged.connect(self.on_change)
fade_layout.addWidget(self.spin_kv_fade_pos)

fade_layout.addWidget(QLabel("Length:"))
self.spin_kv_fade_len = QSpinBox()
self.spin_kv_fade_len.setRange(10, max_screen_y)
self.spin_kv_fade_len.setValue(self.config.key_viewer.fade_length_y)
self.spin_kv_fade_len.valueChanged.connect(self.on_change)
fade_layout.addWidget(self.spin_kv_fade_len)
layout.addLayout(fade_layout)

# Fade Trigger
trigger_layout = QHBoxLayout()
trigger_layout.addWidget(QLabel("Fade Trigger:"))
self.combo_kv_fade_trig = QComboBox()
self.combo_kv_fade_trig.addItems(["head", "tail"])
self.combo_kv_fade_trig.setCurrentText(self.config.key_viewer.fade_trigger)
self.combo_kv_fade_trig.currentTextChanged.connect(self.on_change)
trigger_layout.addWidget(self.combo_kv_fade_trig)
trigger_layout.addStretch()
layout.addLayout(trigger_layout)

self.setLayout(layout)

Expand All @@ -293,6 +331,9 @@ def on_change(self) -> None:
self.config.key_viewer.panel_offset_y = self.spin_kv_off_y.value()
self.config.key_viewer.show_counts = self.chk_kv_counts.isChecked()
self.config.key_viewer.opacity = self.spin_kv_opacity.value() / 100.0
self.config.key_viewer.fade_position_y = self.spin_kv_fade_pos.value()
self.config.key_viewer.fade_length_y = self.spin_kv_fade_len.value()
self.config.key_viewer.fade_trigger = self.combo_kv_fade_trig.currentText()
self.settings.save()

def update_from_config(self) -> None:
Expand All @@ -304,7 +345,9 @@ def update_from_config(self) -> None:
self.spin_kv_off_x,
self.spin_kv_off_y,
self.spin_kv_opacity,
self.chk_kv_counts
self.chk_kv_counts,
self.spin_kv_fade_pos,
self.spin_kv_fade_len
):
self.chk_kv_enabled.setChecked(self.config.key_viewer.enabled)
self.spin_kv_height.setValue(self.config.key_viewer.height)
Expand All @@ -316,3 +359,6 @@ def update_from_config(self) -> None:
self.spin_kv_off_y.setValue(self.config.key_viewer.panel_offset_y)
self.spin_kv_opacity.setValue(int(self.config.key_viewer.opacity * 100))
self.chk_kv_counts.setChecked(self.config.key_viewer.show_counts)
self.spin_kv_fade_pos.setValue(self.config.key_viewer.fade_position_y)
self.spin_kv_fade_len.setValue(self.config.key_viewer.fade_length_y)
self.combo_kv_fade_trig.setCurrentText(self.config.key_viewer.fade_trigger)