Skip to content

Commit e41ee73

Browse files
authored
Create README.md
1 parent 8274798 commit e41ee73

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# KeyLighting
2+
3+
KeyLighting is a lightweight C# console application that mirrors your screen's display colors onto your RGB keyboard lighting in real time.
4+
5+
## Features
6+
7+
- Real-time screen color reflection onto your RGB keyboard
8+
- Supports color customization via configuration
9+
- Simple and fast setup
10+
11+
## Requirements
12+
13+
- Windows OS
14+
- An RGB keyboard supported by [OpenRGB](https://openrgb.org/)
15+
- OpenRGB must be running (with SDK server enabled)
16+
17+
## Setup and Usage
18+
19+
1. **Download the latest release**
20+
- Go to the [Releases]([https://github.com/your-username/your-repo/releases](https://github.com/ModMaker101/KeyLighting.NET/releases/) page.
21+
- Download the latest `.zip` file.
22+
23+
2. **Extract the archive**
24+
- Right-click the downloaded ZIP file and choose **Extract All**.
25+
26+
3. **Run the program**
27+
- Open the extracted folder.
28+
- Double-click `KeyLighting.exe` to launch the application.
29+
30+
4. **Configure the settings**
31+
- A `config.json` file will be generated (if not already present).
32+
- Open `config.json` with any text editor and adjust settings such as:
33+
- Brightness
34+
- Contrast
35+
- Vibrance
36+
- Darkening
37+
- Refresh rate
38+
- Screen targeting
39+
- And much more
40+
41+
5. **Enjoy**
42+
- Watch your keyboard lighting reflect your display in real time!
43+
44+
## Notes
45+
46+
- Make sure OpenRGB is running with SDK support enabled.
47+
- If the app doesn't seem to work, try running it as Administrator.
48+
- Close other programs that may interfere with keyboard lighting control.

0 commit comments

Comments
 (0)