Skip to content

Commit 7682fa8

Browse files
committed
docs: Update project structure, remove detailed build instructions, and fix README formatting.
1 parent 71ec0f3 commit 7682fa8

1 file changed

Lines changed: 3 additions & 31 deletions

File tree

README.md

Lines changed: 3 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,13 @@ RainingKeys is a purely external overlay application that visualizes keyboard in
3838

3939
## Project Structure
4040

41-
```
41+
```text
4242
RainingKeysPython/
4343
├── core/
4444
│ ├── config.py # User configuration (Keys, speeds, colors)
4545
│ ├── input_mon.py # Global input listener
4646
│ └── overlay.py # Main rendering loop and window logic
47+
├── build.py # Build script for creating standalone executable
4748
├── main.py # Application entry point
4849
└── requirements.txt # Dependencies
4950
```
@@ -76,8 +77,6 @@ RainingKeysPython/
7677

7778
## Configuration
7879

79-
## Configuration
80-
8180
Settings are stored in `config.ini` (automatically created on first run).
8281
You can edit this file manually or use the **GUI Settings Window**.
8382

@@ -92,40 +91,13 @@ You can edit this file manually or use the **GUI Settings Window**.
9291

9392
*Note: Key mappings and colors are currently defined in `core/config.py`.*
9493

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-
12194
## Roadmap
12295

123-
- [x] Interactive Configuration UI (GUI for settings)
96+
- [ ] Interactive Configuration UI (GUI for settings)
12497
- [x] Save/Load config from ini
12598
- [ ] Multi-monitor support
12699
- [ ] Custom skins/textures for bars
127100

128-
129101
## Disclaimer
130102

131103
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

Comments
 (0)