You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-31Lines changed: 3 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,12 +38,13 @@ RainingKeys is a purely external overlay application that visualizes keyboard in
38
38
39
39
## Project Structure
40
40
41
-
```
41
+
```text
42
42
RainingKeysPython/
43
43
├── core/
44
44
│ ├── config.py # User configuration (Keys, speeds, colors)
45
45
│ ├── input_mon.py # Global input listener
46
46
│ └── overlay.py # Main rendering loop and window logic
47
+
├── build.py # Build script for creating standalone executable
47
48
├── main.py # Application entry point
48
49
└── requirements.txt # Dependencies
49
50
```
@@ -76,8 +77,6 @@ RainingKeysPython/
76
77
77
78
## Configuration
78
79
79
-
## Configuration
80
-
81
80
Settings are stored in`config.ini` (automatically created on first run).
82
81
You can edit this file manually or use the **GUI Settings Window**.
83
82
@@ -92,40 +91,13 @@ You can edit this file manually or use the **GUI Settings Window**.
92
91
93
92
*Note: Key mappings and colors are currently defined in`core/config.py`.*
94
93
95
-
96
-
## Building from Source
97
-
98
-
To create a standalone executable (Windows .exe):
99
-
100
-
1. Run the build script:
101
-
```bash
102
-
python build.py
103
-
```
104
-
2. The output will be in`dist/RainingKeysPython/`.
105
-
106
-
### Debug vs Release Build
107
-
You can toggle the console window visibility via `config.ini`:
108
-
109
-
- **Debug Mode** (Console visible):
110
-
```ini
111
-
[General]
112
-
debug_mode = true
113
-
```
114
-
- **Release Mode** (No console, default):
115
-
```ini
116
-
[General]
117
-
debug_mode = false
118
-
```
119
-
(Or simply omit the line)
120
-
121
94
## Roadmap
122
95
123
-
- [x] Interactive Configuration UI (GUI for settings)
96
+
- [] Interactive Configuration UI (GUI for settings)
124
97
- [x] Save/Load config from ini
125
98
- [ ] Multi-monitor support
126
99
- [ ] Custom skins/textures for bars
127
100
128
-
129
101
## Disclaimer
130
102
131
103
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.
0 commit comments