๐Ÿ“ฆ LizardByte / Sunshine

Self-hosted game stream host for Moonlight.

โ˜… 33.7k stars โ‘‚ 1.7k forks ๐Ÿ‘ 33.7k watching โš–๏ธ GNU General Public License v3.0
cppdockerflathub-pkggame-streamgame-streaminggame-streaming-servergeforce-experiencehomebrew-pkgmaintainer-wantedmoonlightpacman-pkgpythonremote-desktopreplicator-custom-issuesreplicator-release-notificationsrtdwinget-pkg
๐Ÿ“ฅ Clone https://github.com/LizardByte/Sunshine.git
HTTPS git clone https://github.com/LizardByte/Sunshine.git
SSH git clone git@github.com:LizardByte/Sunshine.git
CLI gh repo clone LizardByte/Sunshine
Julio Sanz Julio Sanz build(arch): enhanced arch support for linux build script (#4595) d299730 1 days ago ๐Ÿ“ History
๐Ÿ“‚ master View all commits โ†’
๐Ÿ“ .github
๐Ÿ“ cmake
๐Ÿ“ docker
๐Ÿ“ docs
๐Ÿ“ gh-pages-template
๐Ÿ“ packaging
๐Ÿ“ scripts
๐Ÿ“ src
๐Ÿ“ src_assets
๐Ÿ“ tests
๐Ÿ“ third-party
๐Ÿ“ tools
๐Ÿ“„ .clang-format
๐Ÿ“„ .dockerignore
๐Ÿ“„ .flake8
๐Ÿ“„ .gitattributes
๐Ÿ“„ .gitignore
๐Ÿ“„ .gitmodules
๐Ÿ“„ .prettierrc.json
๐Ÿ“„ .readthedocs.yaml
๐Ÿ“„ .rstcheck.cfg
๐Ÿ“„ CMakeLists.txt
๐Ÿ“„ codecov.yml
๐Ÿ“„ crowdin.yml
๐Ÿ“„ DOCKER_README.md
๐Ÿ“„ LICENSE
๐Ÿ“„ NOTICE
๐Ÿ“„ package.json
๐Ÿ“„ README.md
๐Ÿ“„ sunshine.icns
๐Ÿ“„ sunshine.ico
๐Ÿ“„ sunshine.png
๐Ÿ“„ sunshine.svg
๐Ÿ“„ vite.config.js
๐Ÿ“„ README.md
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

๐ŸŽฎ Feature Compatibility

Platform Feature Support
Feature FreeBSD Linux macOS Windows
Gamepad Emulation
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 โœ… โœ… โŒ โŒ
GPU Encoding
AMD/AMF โœ… (vaapi) โœ… (vaapi) โœ… (Video Toolbox) โœ…
Intel QuickSync โœ… (vaapi) โœ… (vaapi) โœ… (Video Toolbox) โœ…
NVIDIA NVENC โœ… (vaapi) โœ… (vaapi) โœ… (Video Toolbox) โœ…
Screen Capture
DXGI โž– โž– โž– โœ…
KMS โŒ โœ… โž– โž–
NVIDIA NvFBC โž– ๐ŸŸก โž– โž–
  โ†ณ X11 Support โž– โœ… โž– โž–
  โ†ณ Wayland Support โž– โŒ โž– โž–
Video Toolbox โž– โž– โœ… โž–
Wayland โœ… โœ… โž– โž–
Windows.Graphics.Capture โž– โž– โž– ๐ŸŸก
  โ†ณ Portable โž– โž– โž– โœ…
  โ†ณ Service โž– โž– โž– โŒ
X11 โœ… โœ… โž– โž–

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+
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.

๐Ÿ’ฒ Sponsors and Supporters

Sponsors

๐Ÿ‘ฅ Contributors

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

GitHub

GitHub contributors

CrowdIn

CrowdIn contributors

PreviousNext
Getting Started

[TOC]