Skip to content

Commit f632365

Browse files
Update README for OpenRGB change
1 parent 9bcc40b commit f632365

1 file changed

Lines changed: 15 additions & 190 deletions

File tree

README.md

Lines changed: 15 additions & 190 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,22 @@
1-
# Keyboard Visualizer ![Icon](https://raw.githubusercontent.com/CalcProgrammer1/KeyboardVisualizer/master/KeyboardVisualizerVC/Icon.png)
2-
Razer Chroma and Corsair RGB Keyboard Spectrograph Visualizer for Windows and Linux
1+
# Keyboard Visualizer ![Icon](https://raw.githubusercontent.com/CalcProgrammer1/KeyboardVisualizer/master/KeyboardVisualizerQT/Icon.png)
32

4-
Binary Windows builds can be downloaded from the Release submodule
3+
## OpenRGB Audio Visualizer for Windows, Linux, and MacOS
4+
5+
Keyboard Visualizer turns your OpenRGB-supported RGB setup into a spectacular light show for your music. Keyboard Visualizer is able to listen to any input or loopback audio device on your computer so it can visualize audio from any music player, website, game, or other application.
6+
7+
To use Keyboard Visualizer with your setup, you must first install OpenRGB and set it up to detect all of your RGB devices. OpenRGB can be found here:
8+
9+
https://gitlab.com/CalcProgrammer1/OpenRGB
10+
11+
## What about the old Keyboard Visualizer with Razer Chroma SDK, Corsair SDK, etc?
12+
13+
Development on this version has stalled as I'm not interested in supporting a multitude of proprietary SDKs that change constantly and only work on Windows. This version remains as Keyboard Visualizer 3.x and downloads are still available in the Release submodule. I will accept pull requests for this version if others wish to keep it alive, but I plan to focus primarily on the OpenRGB version (4.x) going forwards.
14+
15+
# Building
516

617
You must have the Microsoft Visual C++ 2015 32-bit redistributable package installed to run this program (Windows).
718

8-
To build this project in Linux, install QT Creator and libopenal-dev, libhidapi-dev and open/build the .pro file.
19+
To build this project in Linux, install QT Creator and libopenal-dev and open/build the .pro file.
920

1021
# Settings
1122

@@ -127,199 +138,13 @@ Keyboard Visualizer allows you to save your custom settings in two different way
127138
client - Configure this instance as a client for synchronization
128139
- Takes the IP/hostname of the server and port as arguments,
129140
- i.e. client=192.168.1.100,1234
130-
ledstrip - LED config strings :
131-
- Serial : ledstrip=port,baud,num_leds
132-
- (ex.ledstrip=COM1,115200,30)
133-
- UDP : ledstrip=udp:client,port,num_leds
134-
- (ex.ledstrip=udp:192.168.1.5,1234,30)
135-
xmas - COM port, ex. xmas=COM2
136-
hueplus - HUE+ config:
137-
- hueplus=port,channel,num_leds
138-
- channel: 0 -> both channels, 1 -> channel 1, 2 -> channel 2
139-
- num_leds: Fans * 8 ex. 3 Fans -> 24
140-
- Important for Fans: If you have connected fans on both channels only count the fans on the channel with the most fans
141-
ex. 3 Fans on Ch. 1 4 Fans on CH. 2: num_leds 32 for the 4 Fans
142-
For best Visualizer results don`t connect on one channel 3 fans more than on the other channel
143-
- (ex. hueplus=COM4,1,24
144-
razer_use_keyboard_generic_effect
145-
- Use generic effect type in the Razer SDK, allows the use of SDK-unsupported keyboards at the expense of scaling
146-
razer_use_headset_custom_effect
147-
- Use custom effect for headsets, allows smooth color transitions on the Kraken V2 but disables the Kraken V1
148-
razer_use_chromalink_single_color
149-
- Use the single color option for the Chroma Link SDK outputs instead of bar graph option
150-
razer_disable_chromalink
151-
- Disable the Chroma Link SDK, works around a bug in the current Chroma SDK where the Chroma HDK commands are overridden
152-
razer_chroma_box_mode
153-
- razer_chroma_box_mode=mode
154-
- 0: Matrix (use 4 strips for best effect)
155-
- 1: Bar graph per single strip
156-
- 2: Bar graph stretched across 2 strips each
157-
- 3: Bar graph stretched across all 4 strips
158141

159142
# Available Visual Effects
160143

161144
* Spectrograph - Shows vertical bars for each frequency in the audio
162145
* Bar - Shows a single bar representing bass frequencies
163146
* Single Color - Brightness and color represent strength of bass frequencies
164147

165-
# Supported Devices (Windows)
166-
167-
* Razer Chroma SDK
168-
169-
Keyboards
170-
- BlackWidow Chroma (spectrograph)
171-
- BlackWidow Chroma Tournament Edition (spectrograph)
172-
- DeathStalker Chroma (horizontal bar)
173-
- BlackWidow X Chroma (spectrograph)
174-
- BlackWidow X Chroma Tournament Edition (spectrograph)
175-
- Razer Blade Stealth (spectrograph)
176-
- Razer Blade (spectrograph)
177-
- Razer Ornata Chroma (spectrograph)
178-
179-
- Unsupported keyboards may be used in "generic" mode by adding the razer_use_keyboard_generic_effect settings parameter
180-
- This uses a single effect for all keyboards supported by the SDK core, even those that don't have a device ID
181-
- Use this setting for support of these otherwise unsupported keyboards:
182-
- Razer Blade Stealth (late 2016, Kaby Lake) (spectrograph)
183-
- Razer BlackWidow Chroma V2 (spectrograph)
184-
185-
Keypads
186-
- Razer Orbweaver Chroma (spectrograph)
187-
- Razer Tartarus Chroma (single color)
188-
189-
Mice
190-
- Diamondback Chroma (bar and single color)
191-
- Mamba Tournament Edition (bar and single color)
192-
- Mamba Chroma Wireless (bar and single color, wired and wireless)
193-
- DeathAdder Chroma (single color)
194-
- Naga Epic Chroma (single color, wired only)
195-
- Naga Chroma (single color)
196-
- Orochi Chroma (single color, wired only)
197-
198-
Headsets
199-
- Kraken 7.1 Chroma (single color)
200-
- Kraken 7.1 Chroma V2 (single color)
201-
- ManO'War (single color)
202-
203-
- The Kraken 7.1 Chroma V1 does not support custom effects, so a flickery workaround is used. If you only have a V2 you
204-
- can add the settings parameter razer_use_headset_custom_effect to make the V2 output a smooth, non-flickery output but
205-
- if you also have a V1 or ManO'War connected it will go black.
206-
207-
Mouse Mats
208-
- Firefly (bar)
209-
210-
External Graphics Dock
211-
- Razer Core (bar and single color)
212-
213-
Other
214-
- Razer Chroma Mug (bar)
215-
216-
* Corsair CUE SDK
217-
218-
Keyboards
219-
- K70 RGB (spectrograph)
220-
- Likely other CUE SDK supported keyboards (spectrograph), untested
221-
222-
* Cooler Master RGB
223-
224-
Keyboards
225-
- Masterkeys Pro L (spectrograph)
226-
- Masterkeys Pro S (spectrograph)
227-
228-
* Logitech G Gaming SDK
229-
230-
Keyboards
231-
- G910 Orion Spark (spectrograph)
232-
- G810 Orion Spectrum (spectrograph)
233-
- Other single-zone RGB and Monochrome keyboards (single color)
234-
235-
Headsets
236-
- G633 (single color)
237-
- G933 (single color)
238-
239-
Mice
240-
- G600 (single color)
241-
- G900 Chaos Spectrum (single color)
242-
- G303 Daedalus Apex (single color)
243-
- G502 Proteus Spectrum (single color)
244-
* SteelSeries
245-
246-
Keyboards
247-
- Apex M800 (spectrograph)
248-
249-
* MSI SteelSeries
250-
251-
Keyboards
252-
- MSI 3-zone laptop keyboards and additional LED zones (MSI GS63VR, etc) (bar, single color)
253-
254-
* NZXT Hue+
255-
256-
- Configured using the hueplus=port,num_leds option in the settings file (bar)
257-
258-
* WS28XX Pixel LED Strips
259-
260-
- Arduino (Serial/USB-Serial) or ESP8266 (UDP over WiFi) may be used for controller
261-
- WS2812B, WS2811, and compatible LED strips/strings supported
262-
- Adjust the LEDs value in the Arduino sketch to match the number of LEDs on your LED strip/string
263-
- Recommended maximum of 90 or so LEDs on Arduino using 115200 baud rate
264-
- Configure LED strip using the ledstrip command line/settings file parameter
265-
- Number of LEDs in Arduino sketch must match num_leds parameter in LED command string
266-
- For serial connected LEDs, -ledstrip=port,baud,num_leds (ex. -ledstrip=COM1,115200,30)
267-
- For WiFi connected LEDs, -ledstrip=client,port,num_leds (ex. -ledstrip=192.168.1.5,1234,30)
268-
269-
- For up to 200 LEDs on Arduino using 1000000 baud rate, see my pixel_controller repository
270-
- This requires AVR Studio 4 + WinAVR to build, but is more efficient by skipping Arduino IDE
271-
272-
# Supported Devices (Linux)
273-
274-
* Razer Linux Drivers (https://github.com/terrycain/razer-drivers)
275-
276-
Keyboards
277-
- BlackWidow Chroma (spectrograph)
278-
- BlackWidow Chroma Tournament Edition (spectrograph)
279-
- DeathStalker Chroma (horizontal bar)
280-
- Razer Ornata Chroma (spectrograph)
281-
- Razer Blade Stealth (spectrograph)
282-
- Razer Blade Pro (spectrograph)
283-
284-
Keypads
285-
- Razer Tartarus Chroma (single color)
286-
287-
Mice
288-
- Diamondback Chroma (bar and single color)
289-
- Mamba Tournament Edition (bar and single color)
290-
- DeathAdder Chroma (single color)
291-
292-
Headsets
293-
- Kraken 7.1 Chroma (single color)
294-
- Kraken 7.1 Chroma V2 (single color)
295-
296-
Mouse Mats
297-
- Firefly (bar)
298-
299-
External Graphics Dock
300-
- Razer Core (bar and single color)
301-
302-
Other
303-
- Razer Chroma Mug (bar)
304-
305-
* SteelSeries
306-
307-
Keyboards
308-
- Apex M800 (spectrograph)
309-
310-
* MSI SteelSeries
311-
312-
Keyboards
313-
- MSI 3-zone laptop keyboards and additional LED zones (MSI GS63VR, etc) (bar, single color)
314-
315-
* NZXT Hue+
316-
317-
- Configured using the hueplus=port,num_leds option in the settings file (bar)
318-
319-
* WS28XX Pixel LED Strips
320-
321-
- See the information under the Windows supported devices list.
322-
323148
# Donations
324149

325150
* I created this project for fun mostly, and Razer's support of sending free products for me to integrate is awesome, but several people have asked if I'd accept donations. I've gotten back into cryptocurrency and mining recently so if you want to send some Bitcoin, Dogecoin, or Ethereum my way you can do so with the addresses below. I don't want to bother with PayPal and its ugly fees and I detest online advertising and block all ads on my PCs so I would never put ads on my videos or programs.

0 commit comments

Comments
 (0)