Sunshine README

The project's README from github.com/LizardByte/Sunshine. As one markdown file: README.md.

Sunshine icon

Sunshine

Self-hosted game stream host for Moonlight.

GitHub stars GitHub Releases Docker GHCR Flathub installs Flathub Version Winget Version GitHub Workflow Status (CI) GitHub Workflow Status (localize) Codecov SonarCloud

ℹ️ 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

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

[!NOTE] 1 Missing motion, touchpad input, battery state, RGB LEDs, adaptive triggers, and raw HID output reports.

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: 15.1+
Linux/Debian: 13+ (trixie)
Linux/Fedora: 43+
Linux/Ubuntu: 22.04+ (jammy)
macOS: 14.2+
Windows: 11+
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

Previous Next
Getting Started
[TOC]

Sunshine (LizardByte/Sunshine)

Searching Database…

42.3K ·GitHub
Sunshine
这是什么？Sunshine 是一款可自托管的游戏串流主机，让你能通过任意 Moonlight 客户端远程玩电脑游戏，支持 AMD、Intel 或 Nvidia 显卡的硬件加速编码（也可回退为软件编码）。
我应该把它装在游戏电脑上，还是装在我用来玩游戏的设备上？Sunshine 运行在你想要串流游戏的电脑上（即主机）；然后你再用任意 Moonlight 客户端应用，从另一台设备连接到它。
我该如何让 Sunshine 运行起来？README 中没有单一的安装命令；完整的安装说明（包括各平台的安装包）维护在 LizardByte 的 Read the Docs 网站上。
不同操作系统上的手柄模拟效果一样吗？不一样。完整的手柄模拟（Xbox、DualShock、Switch Pro 等）可在 Windows 上使用；在 FreeBSD/Linux 上仅部分支持（缺少运动、触控板、电量、RGB 和自适应扳机数据）；在 macOS 上则完全不支持。
Sunshine 支持哪些操作系统及版本？最低支持版本为 FreeBSD 15.1+、Debian 13（trixie）、Fedora 43、Ubuntu 22.04（jammy）、macOS 14.2+ 和 Windows 11+。
进行硬件编码是否需要特定的显卡？Sunshine 支持通过 AMD 的 AMF、Intel 的 QuickSync 和 Nvidia 的 NVENC 进行硬件编码（在 Linux 上还支持 VAAPI 和 Vulkan Video）；如果找不到兼容的显卡，它也会回退为软件编码。
如何将 Moonlight 客户端与 Sunshine 配对？Sunshine 提供了用于配置的网页界面，同时也能处理客户端配对——你可以在本机服务器上配对，也可以通过任意移动设备的浏览器进行配对。
Sunshine 能串流 4K 或 HDR 吗？可以，但需要更强的硬件：4K 推荐搭配 Ryzen 5 / Core i5 和 GTX 1080 级别或更好的显卡；HDR 则需要基于 Pascal 架构的 Nvidia 显卡（GTX 10 系列）或同等水平的 AMD/Intel 编码器。
在 Linux 上它使用哪些屏幕捕获方式？在 Linux 上，Sunshine 可以通过 KMS/DRM、X11、Wayland（wlroots）、XDG Desktop Portal 或 KWin Screencast 捕获屏幕，其中 KMS/DRM 在所有编码后端中兼容性最广。
What are similar projects?moonlight-qt, Apollo, stop-stutter, pyrowave, OpenNOW, TheSimpsonsGameRecomp, Piik, OptiScaler-DLSSNR-PreSR-Multipass
Which topics is it in?game-streaming, latency, screen-capture, remote-desktop, freebsd, vulkan, hardware, gaming, real-time, streaming, bsd, nvidia
Creator
LizardByte
Size
515.6 MB
Stars
42.3K
Updated
CommitOct 17Releasev2026.914.233613Sep 15
Age
4y
Commits · 90 Days