Rubylight documentation #
Rubylight · Download 2.2.10 · Release notes
Rubylight runs on your Windows gaming PC; Moonlight runs on the device you play from. These guides take you from a first desktop stream to HDR, virtual displays and the Radeon frame pipeline.
New here? Install Rubylight, open the console, then pair Moonlight and launch Desktop. Start at 1080p60 in SDR so you can check the picture, sound and controls before tuning the stream.
Start streaming #
| I want to… | Start here |
|---|---|
| Get my first stream running | Getting started: what you need, installer or portable setup, pairing and a first desktop stream. |
| Bring my settings or update an existing host | Import a profile · Upgrade safely |
| Choose a codec, enable HDR or try PyroWave | Choose your stream format · Capture and video settings |
| Give each device its own display or cap a game's frame rate | Displays and RTSS · Settings for one app or device |
| Set up a controller or use my client's microphone | Controllers · Microphone |
| Launch Steam games from Steam Deck with MoonDeck | MoonDeck setup |
| Fix a stream that will not start or feels wrong | Troubleshooting: pairing, black screens, HDR colour, audio, controllers and smoothness. |
The full configuration guide starts with the defaults. If a problem needs a bug report, collect the logs and stream details so someone else can reproduce it.
Understand Rubylight #
| Guide | What it covers |
|---|---|
| Architecture | What is written in Rust, where compute fits, frame ownership, native HDR and PyroWave. |
| Performance | Comparisons under gaming load, the meaning of each measurement and links to recorded runs. |
| Features | Everything Rubylight does: video, capture, displays, input, library, console and clients. |
| Release notes | Changes in every Windows release, from the first release candidate to the latest release. |
Build and integrate #
| Reference | What it covers |
|---|---|
| Build guide | Windows toolchain, pinned dependencies, packaging and CI. |
| Developer guide | Workspace layout, isolated profiles, validation tools and native integration work. |
| HTTP API | Authentication, CSRF, permissions and the current Rust endpoints. |
| Control messages | Rubylight's own client-to-host messages (phase lock, display luminance, mid-stream resolution change) and how a client finds out the host takes them. |
| Hardware metrics | Client overlay telemetry: discovery, paired-client authentication, JSON readings, units, polling and errors. |
| Third-party components | Codec SDKs, drivers and licensing. |
| Detailed performance record | Dated fixtures, raw results, rejected experiments and reproduction instructions. |
The 60-second launch film introduces the frame pipeline and its measured results. The project history and archived C++ references cover the earlier implementation.