Skip to content

Commit 71ec0f3

Browse files
committed
docs: Add build instructions, debug/release configuration details, and update roadmap for completed features.
1 parent 81cc693 commit 71ec0f3

1 file changed

Lines changed: 29 additions & 2 deletions

File tree

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,13 +92,40 @@ You can edit this file manually or use the **GUI Settings Window**.
9292

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

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+
95121
## Roadmap
96122

97-
- [ ] Interactive Configuration UI (GUI for settings)
98-
- [ ] Save/Load config from JSON/YAML
123+
- [x] Interactive Configuration UI (GUI for settings)
124+
- [x] Save/Load config from ini
99125
- [ ] Multi-monitor support
100126
- [ ] Custom skins/textures for bars
101127

128+
102129
## Disclaimer
103130

104131
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)