An open API service indexing awesome lists of open source software.

https://github.com/lizardbyte/sunshine

Self-hosted game stream host for Moonlight.
https://github.com/lizardbyte/sunshine

cpp docker flathub-pkg game-stream game-streaming game-streaming-server geforce-experience homebrew-pkg maintainer-wanted moonlight pacman-pkg python remote-desktop replicator-custom-issues replicator-release-notifications rtd winget-pkg

Last synced: 5 days ago
JSON representation

Self-hosted game stream host for Moonlight.

Awesome Lists containing this project

README

          


Sunshine icon

Sunshine


Self-hosted game stream host for Moonlight.



GitHub stars
GitHub Releases
Docker
GHCR
Flathub installs
Flathub Version
Winget Version
Gurubase
GitHub Workflow Status (CI)
GitHub Workflow Status (localize)
Read the Docs
Codecov

## โ„น๏ธ 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](https://docs.lizardbyte.dev/projects/sunshine)

* [Stable Docs](https://docs.lizardbyte.dev/projects/sunshine/latest/)
* [Beta Docs](https://docs.lizardbyte.dev/projects/sunshine/master/)

## ๐ŸŽฎ Feature Compatibility

Gamepad Emulation

Feature
FreeBSD
Linux
macOS
Windows



What type of gamepads can be emulated on the host.

Clients may support other gamepads.



DualShock / DS4 (PlayStation 4)
โž–
โž–
โŒ
โœ…


DualSense / DS5 (PlayStation 5)
โŒ
โœ…
โŒ
โŒ


Nintendo Switch Pro
โœ…
โœ…
โŒ
โŒ


Xbox 360
โž–
โž–
โŒ
โœ…


Xbox One/Series
โœ…
โœ…
โŒ
โŒ

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
Windows


DXGI Desktop Duplication
โž–
โž–
โž–
โœ…


KMS/DRM
โœ…
โœ…
โž–
โž–


NvFBC (X11 only)
โž–
โœ…
โž–
โž–


ScreenCaptureKit
โž–
โž–
โœ…
โž–


Wayland (wlroots)
โœ…
โœ…
โž–
โž–


Windows.Graphics.Capture
โž–
โž–
โž–
๐ŸŸก


ย ย โ†ณ Portable
โž–
โž–
โž–
โœ…


ย ย โ†ณ Service
โž–
โž–
โž–
โŒ


X11
โœ…
โœ…
โž–
โž–


XDG Desktop Portal
โœ…
โœ…
โž–
โž–


KWin Screencast
โœ…
โœ…
โž–
โž–

Capture โ†’ Encoding Compatibility (Linux/FreeBSD)

Capture Method
VAAPI
Vulkan Video
NVENC (CUDA)
Software


KMS/DRM
โœ…
โœ…
โœ…
โœ…


NvFBC
โŒ
โŒ
โœ…
โŒ


Wayland (wlroots)
โœ…
โŒ
โœ…
โœ…


X11
โœ…
โŒ
โœ…
โœ…


XDG Desktop Portal
โœ…
โœ…
โœ…
โœ…


KWin Screencast
โœ…
โœ…
โœ…
โœ…

**Legend:** โœ… Supported | ๐ŸŸก Partial Support | โŒ Not Yet Supported | โž– Not Applicable

## ๐Ÿ–ฅ๏ธ System Requirements

> [!WARNING]
> These tables are a work in progress. Do not purchase hardware based on this information.

Minimum Requirements

Component
Requirement


GPU
AMD: VCE 1.0 or higher, see: obs-amd hardware support



Intel:

ย ย FreeBSD/Linux: VAAPI-compatible, see: VAAPI hardware support

ย ย Windows: Skylake or newer with QuickSync encoding support



Nvidia: NVENC enabled cards, see: nvenc support matrix


CPU
AMD: Ryzen 3 or higher


Intel: Core i3 or higher


RAM
4GB or more


OS
FreeBSD: 14.3+


Linux/Debian: 13+ (trixie)


Linux/Fedora: 41+


Linux/Ubuntu: 22.04+ (jammy)


macOS: 14.2+


Windows: 11+ (Windows Server does not support virtual gamepads)


Network
Host: 5GHz, 802.11ac


Client: 5GHz, 802.11ac

4k Suggestions

Component
Requirement


GPU
AMD: Video Coding Engine 3.1 or higher



Intel:

ย ย FreeBSD/Linux: HD Graphics 510 or higher

ย ย Windows: Skylake or newer with QuickSync encoding support




Nvidia:

ย ย FreeBSD/Linux: GeForce RTX 2000 series or higher

ย ย Windows: Geforce GTX 1080 or higher



CPU
AMD: Ryzen 5 or higher


Intel: Core i5 or higher


Network
Host: CAT5e ethernet or better


Client: CAT5e ethernet or better

HDR Suggestions

Component
Requirement


GPU
AMD: Video Coding Engine 3.4 or higher


Intel: HD Graphics 730 or higher


Nvidia: Pascal-based GPU (GTX 10-series) or higher


CPU
AMD: Ryzen 5 or higher


Intel: Core i5 or higher


Network
Host: CAT5e ethernet or better


Client: CAT5e ethernet or better

## โ“ Support

Our support methods are listed in our [LizardByte Docs](https://docs.lizardbyte.dev/latest/about/support.html).

## ๐Ÿ’ฒ Sponsors and Supporters


Sponsors

## ๐Ÿ‘ฅ Contributors

Thank you to all the contributors who have helped make Sunshine better!

### GitHub


GitHub contributors

### CrowdIn


CrowdIn contributors

| Previous | Next |
|:---------|-------------------------------------------:|
| | [Getting Started](docs/getting_started.md) |


[TOC]