https://github.com/namesroby/ravelink-bridge
Free Twitch Channel Points Controlable lights || Powerfull audio reactive lights controller with midi support
https://github.com/namesroby/ravelink-bridge
audio-processing channel-points chat-control easy-setup free-software lights lights-controls local-server mod-support music-reactive obs personal-use react-with-music smart-bulbs streamelements-api streamelements-overlays streamelements-widgets streamer streamer-tool twitch
Last synced: about 2 months ago
JSON representation
Free Twitch Channel Points Controlable lights || Powerfull audio reactive lights controller with midi support
- Host: GitHub
- URL: https://github.com/namesroby/ravelink-bridge
- Owner: NameSRoby
- License: isc
- Created: 2026-02-11T19:29:38.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-04-08T20:25:37.000Z (about 2 months ago)
- Last Synced: 2026-04-08T20:26:27.050Z (about 2 months ago)
- Topics: audio-processing, channel-points, chat-control, easy-setup, free-software, lights, lights-controls, local-server, mod-support, music-reactive, obs, personal-use, react-with-music, smart-bulbs, streamelements-api, streamelements-overlays, streamelements-widgets, streamer, streamer-tool, twitch
- Language: JavaScript
- Homepage:
- Size: 2.44 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RaveLink Bridge
Lightweight and powerful streamer-first local lighting engine for Philips Hue + WiZ, with Twitch-ready controls, MIDI performance mapping, audio-reactive LIVE behavior, and modular local extension points.
Optional support: https://ko-fi.com/namesroby
## Open Source Note
RaveLink Bridge is open source. If you fork/remix and ship your own distro, attribution is appreciated but not required:
- "NameSroby's RaveLink-Bridge"
## Download
- Current Windows release (v1.6.3): https://github.com/NameSRoby/ravelink-bridge/releases/latest
- All releases: https://github.com/NameSRoby/ravelink-bridge/releases
This repository is aligned to `v1.6.3`.
## Quick Install (Windows)
1. Preferred when available: download `RaveLink-Bridge-Windows-v1.6.3-setup-installer.exe` and run it.
2. Portable fallback: download `RaveLink-Bridge-Windows-v1.6.3-self-contained.zip` and extract it.
3. Standard ZIP fallback: download `RaveLink-Bridge-Windows-v1.6.3.zip` and extract it.
4. Run `RaveLink-Bridge-Start.bat`.
5. Open `http://127.0.0.1:5050`.
## v1.6.3 (Bridge OAuth + Packaging Hotfixes)
This update is a short stability release focused on bridge-owned Twitch OAuth, public-safe mod docking, and packaging cleanup for the public repository.
### What improved
- System OAuth is more resilient:
- device-code approval can complete through server-side polling instead of depending on a fragile browser-only poll loop
- widget status can recover a half-saved OAuth state from compatible mod data when needed
- bundled Twitch app ID support is clearer and can be overridden or permanently cleared per install
- Public packaging is safer:
- the public repo now ships a real `mods/` dock with a safe empty tracked config
- local-only mod enablement can live in `mods/mods.local.config.json` without getting published
- the local song-request mod remains excluded from the public repo and packaged release
- Release workflow polish:
- packaged `mods/` output now includes the dock guide and safe baseline config instead of a placeholder text file
- machine-specific path examples in public tests were sanitized
Detailed release notes:
- https://github.com/NameSRoby/ravelink-bridge/releases/tag/v1.6.3
## What This Is
RaveLink Bridge runs on your stream PC and turns live audio + operator/chat actions into Hue/WiZ light output.
- Audio-reactive LIVE engine for music/gameplay
- Twitch-triggerable color and rave control paths
- Channel points / reward friendly HTTP surface
- OBS dock URL built in (`/obs/dock`)
- MIDI controller mapping tab (learn + bindings + trigger tests)
- Local-first safe internet + Twitch Helix redemption sync lane
- Optional local mods without making mods a required boot dependency
> Developer note: this README is intentionally streamer-first. The deep maintainer material lives under `docs/repo-documentation/`.
## Streamer Quick Start
If your stream setup gremlin appears at 2AM, this checklist is built for that exact moment.
1. If you used the Windows installer or self-contained ZIP, you do not need a separate Node install.
- Source/minimal ZIP users: install Node.js LTS from `https://nodejs.org`.
2. Double-click `RaveLink-Bridge-Start.bat`.
- Packaged distro builds ship with runtime dependencies included.
3. Wait for the launcher window to show:
- `Bridge URL: http://127.0.0.1:5050`
4. The browser should open automatically.
5. If the browser does not open automatically, open:
- `http://127.0.0.1:5050`
6. Go to `FIXTURES`:
- pair your real Hue / WiZ fixtures
7. Go to `AUDIO`:
- apply a capture profile and confirm the engine is receiving signal
8. Go to `LIVE`:
- tune scenes, palette, auto Hz, and brightness
9. Start the show with `RAVE ON`.
10. Optional: open `MIDI` and map your controller.
11. Optional: open `SYSTEM` and set up Twitch OAuth / widget / safe-internet lanes.
**Stop options**
- `RaveLink-Bridge-Stop.bat`
- `Ctrl+C` in the launcher window
- `npm run stop` (terminal method)
Why this matters:
- Use one of the stop methods above so Node shuts down cleanly.
- If you just close windows/tabs the wrong way, the Node process can keep running in the background.
- That is not malware, just an unclean shutdown where the local bridge server did not exit properly.
**Terminal fallback (if needed)**
```bash
npm install
npm start
```
## Twitch + Channel Points Setup
How this integration is meant to work:
- RaveLink Bridge runs locally on your stream PC (`http://127.0.0.1:5050`).
- Twitch reward listener code runs inside your chosen overlay/bot lane.
- OBS/browser sources or automation tools can call the bridge locally.
- The integration bot must actually be connected to your channel/chat context or activations are not seen.
Typical control families exposed by the bridge:
- `POST /rave/on`
- `POST /rave/off`
- `POST /color`
- `POST /teach`
For the deeper current setup model, including safe-internet and Helix redemption sync, use:
- `docs/repo-documentation/15-system-oauth-helix-and-safe-internet.md`
- `docs/repo-documentation/07-practical-cookbook-and-examples.md`
## MIDI Quick Start
1. Open the `MIDI` tab.
- It auto-shows when a MIDI input device is detected.
- If no device is detected, you can force-show the MIDI tab from the settings cog.
2. Select `MIDI INPUT PORT` and save config.
3. Choose a learn action.
4. Arm learn.
5. Touch the controller.
6. Verify with a trigger test and watch the binding summary.
Notes:
- The current MIDI workflow is action-first, not raw note-number-first.
- The goal is to map LIVE behavior like drop hit, scene auto, overclock, palette order, and transport toggles quickly.
## OBS Dock
Add this URL to OBS custom docks:
- `http://127.0.0.1:5050/obs/dock`
Optional expanded layout URL:
- `http://127.0.0.1:5050/obs/dock?compact=0`
Notes:
- The dock URL redirects to `/?obsDock=1&compact=...` and enables dock-specific layout behavior.
- Remove or rename docks from OBS `View -> Docks -> Custom Browser Docks`.
## Version 1.6.3 Notes
- This is a short bug-fix release, not a major feature drop.
- Main focus:
- System-owned Twitch OAuth and Helix readiness recovery
- public-safe mod docking and release packaging
- keeping local-only song-request work out of the public repo and release
- The bundled server still supports mods, but the current local-only song-request mod is intentionally not part of this public package.
## Developer Quick Start
Developer tip:
- Most setup categories in this README have their own quick-start directly under the category heading (Streamer, Twitch, MIDI, OBS, Developer).
1. Install dependencies and run:
```powershell
npm install
npm start
```
2. Open `http://127.0.0.1:5050`.
3. Run the main verification pass:
```powershell
npm run verify:runtime-refactor
```
4. Package public release artifacts:
```powershell
npm run package:release
npm run package:installer
```
## Repository Map
- `src/`: server/runtime/domain source
- `public/`: browser UI, templates, styles, frontend runtime composition
- `scripts/`: verification, release, packaging, and helper automation
- `test/`: runtime, browser, route, docs, and architecture guard suites
- `docs/repo-documentation/`: packaged maintainer/reference documentation
- `THIRD_PARTY_NOTICES.md`: third-party notices included in public release
## Runtime Architecture
1. Audio/runtime services collect signal and session state.
2. Engine-v2 derives scene, palette, cadence, brightness, and intent state.
3. Fixture/routing layers resolve which brand/fixture targets are eligible.
4. Built-in Hue/WiZ transports send output with scheduler/state gating.
5. Optional mods can observe/extend behavior through supported surfaces.
Core API families:
- `/rave/*`
- `/audio/*`
- `/fixtures/*`
- `/hue/*`
- `/wiz/*`
- `/mods/*`
- `/midi/*`
- `/system/*`
## Release Workflow
1. Stop bridge.
2. Package the public release:
```powershell
npm run package:release
npm run package:installer
```
Outputs:
- `dist/RaveLink-Bridge-Windows-v1.6.3.zip`
- `dist/RaveLink-Bridge-Windows-v1.6.3-self-contained.zip`
- `dist/RaveLink-Bridge-Windows-v1.6.3-setup-installer.exe`
## Security And Data Hygiene
- Keep local backups private.
- Do not publish real fixture credentials, tokens, or IPs.
- Public release packaging excludes local runtime state and local-only mods.
- The current song-request mod is intentionally local-only and excluded from the public repo/release.
## Related Docs
Primary docs set:
- `docs/repo-documentation/README.md`
Supporting packaged notice:
- `THIRD_PARTY_NOTICES.md`
## License
ISC (`LICENSE`)