README

Sunshine
  Self-hosted game stream host for Moonlight.



  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  


 ℹ️ About

Sunshine is a self-hosted game stream host for Moonlight.
Offering low-latency, cloud gaming server capabilities with support for AMD, Intel, and Nvidia GPUs for hardware
encoding. Software encoding is also available. You can connect to Sunshine from any Moonlight client on a variety of
devices. A web UI is provided to allow configuration, and client pairing, from your favorite web browser. Pair from
the local server or any mobile device.

LizardByte has the full documentation hosted on Read the Docs

 Stable Docs
 Beta Docs

 🎮 Feature Compatibility


    Gamepad Emulation
    
        Feature
        FreeBSD
        Linux
        macOS
        Windows
    
    
        
        What type of gamepads can be emulated on the host.
        Clients may support other gamepads.
        
    
    
        Generic
        🟡1
        ✅
        ✅2
        ✅3
    
    
        DualShock / DS4 (PlayStation 4)
        🟡1
        ✅
        ✅2
        ✅3
    
    
        DualSense / DS5 (PlayStation 5)
        🟡1
        ✅
        ✅2
        ✅3
    
    
        Nintendo Switch Pro
        🟡1
        ✅
        ✅2
        ✅3
    
    
        Xbox 360
        🟡1
        ✅
        ✅2
        ✅3
    
    
        Xbox One
        🟡1
        ✅
        ✅2
        ✅3
    
    
        Xbox Series
        🟡1
        ✅
        ✅2
        ✅3
    


 [!NOTE]
 1 Missing motion, touchpad input, battery state, RGB LEDs, adaptive triggers, and raw HID output reports.
 2 Requires the separately installed and licensed Virtual HID Broker.
 3 All profiles are available through the separately installed and licensed Virtual HID Broker. Xbox 360 and DualShock 4 can also use ViGEmBus.


    Encoding API
    
        Encoding API
        GPU Vendor
        FreeBSD
        Linux
        macOS
        Windows
    
    
        AMF
        AMD
        ➖
        ➖
        ➖
        ✅
    
    
        Media Foundation
        Qualcomm
        ➖
        ➖
        ➖
        ✅
    
    
        NVENC
        NVIDIA
        ➖
        ✅
        ➖
        ✅
    
    
        QuickSync
        Intel
        ➖
        ➖
        ➖
        ✅
    
    
        VAAPI
        AMD
        ✅
        ✅
        ➖
        ➖
    
    
        Intel
        ✅
        ✅
        ➖
        ➖
    
    
        NVIDIA
        ➖
        ✅
        ➖
        ➖
    
    
        Video Toolbox
        Apple
        ➖
        ➖
        ✅
        ➖
    
    
        Intel
        ➖
        ➖
        ✅
        ➖
    
    
        Vulkan Video
        AMD
        🟡
        ✅
        ➖
        ➖
    
    
        Intel
        🟡
        🟡
        ➖
        ➖
    
    
        NVIDIA
        ➖
        🟡
        ➖
        ➖
    
    
        Software
        Any
        ✅
        ✅
        ✅
        ✅
    



    Screen Capture
    
        Capture Method
        FreeBSD
        Linux
        macOS
   

Top issues

Latest release

‼️ Attention

This release contains a high-severity security update for Linux hosts. For more information, see:

- GHSA-fp6g-27w5-489j

Linux users should update as soon as possible!

 ⚠️ Breaking changes and migration notes

- Windows hosts using Virtual HID Driver must update to version 2026.914.1218.10 or newer. Earlier driver versions are not supported by this Sunshine release.

 ✨ Highlights

- Clearer Windows virtual-input choices. A new gamepad_driver setting lets users choose all available drivers, only Virtual HID Driver, or only ViGEmBus. Selecting ViGEmBus also suppres