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 — это самостоятельно развёртываемый хост для потоковой передачи игр, который позволяет играть в компьютерные игры удалённо с помощью любого клиента 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 поддерживает аппаратное кодирование через AMF на AMD, QuickSync на Intel и NVENC на Nvidia (а также VAAPI и Vulkan Video в Linux), но если совместимая видеокарта не найдена, он переходит на программное кодирование на любом железе.
Как подключить клиент Moonlight к Sunshine?В Sunshine есть веб-интерфейс для настройки, который также отвечает за сопряжение клиентов — можно выполнить сопряжение прямо на локальном сервере или из браузера любого мобильного устройства.
Может ли Sunshine транслировать в 4K или HDR?Да, но для этого нужно более мощное железо: для 4K рекомендуются Ryzen 5 или Core i5 и видеокарта уровня GTX 1080 или выше, а для HDR нужна видеокарта на архитектуре Pascal от Nvidia (серия GTX 10) или эквивалентный кодировщик AMD/Intel.
Какие методы захвата экрана использует Sunshine в Linux?В Linux Sunshine может захватывать экран через KMS/DRM, X11, Wayland (wlroots), XDG Desktop Portal или KWin Screencast; при этом KMS/DRM обеспечивает самую широкую совместимость со всеми бэкендами кодирования.
Creator
LizardByte
Size
515.6 MB
Stars
42.3K
Age
4y
Commits · 90 Days