Sunshine is a gamestream host for Moonlight!
Go to file
ReenigneArcher 0cc98f113e
docs: various updates (#3366)
Co-authored-by: BillyTom <953688+billytom@users.noreply.github.com>
2024-12-11 13:11:54 -05:00
.github docs: various updates (#3366) 2024-12-11 13:11:54 -05:00
cmake fix(cmake): configuration generation fails when BUILD_TESTS is OFF (#3416) 2024-11-27 00:05:51 +00:00
docker build(deps): remove unused dependency on libvdpau (#3307) 2024-10-14 23:15:53 -05:00
docs docs: various updates (#3366) 2024-12-11 13:11:54 -05:00
gh-pages-template docs: various updates (#3366) 2024-12-11 13:11:54 -05:00
packaging build(deps): bump packaging/linux/flatpak/deps/flatpak-builder-tools from 6f611f1 to a1eb29c (#3432) 2024-12-06 08:31:01 -05:00
scripts build(deps): remove unused dependency on libvdpau (#3307) 2024-10-14 23:15:53 -05:00
src fix(hostname): fix handling of non-ASCII hostnames on Windows (#3382) 2024-11-09 14:05:46 -06:00
src_assets chore(l10n): update translations (#3408) 2024-12-08 03:21:38 +00:00
tests fix(hostname): fix handling of non-ASCII hostnames on Windows (#3382) 2024-11-09 14:05:46 -06:00
third-party build(deps): bump third-party/build-deps from ccac368 to a558c92 (#3429) 2024-12-04 17:05:34 +00:00
tools fix: automatic selection for hybrid GPU and IDDSampleDriver users (#3002) 2024-09-29 20:32:34 +00:00
.clang-format docs: improvements to source code documentation (#1236) 2023-05-07 15:01:44 -04:00
.codeql-prebuild-cpp-Linux.sh build(linux): add common build script (#2946) 2024-08-03 20:04:26 -04:00
.codeql-prebuild-cpp-macOS.sh ci(codeql): migrate builds to ninja (#3250) 2024-10-02 01:12:40 +00:00
.codeql-prebuild-cpp-Windows.sh fix(boost)!: migrate boost to 1.86 (#3256) 2024-10-03 21:42:16 -04:00
.dockerignore build(linux): add common build script (#2946) 2024-08-03 20:04:26 -04:00
.flake8 chore: update global workflows (#3107) 2024-08-29 13:52:43 -04:00
.gitattributes ci(flatpak): add flatpak builder lint (#2799) 2024-07-07 10:19:11 -04:00
.gitignore feat: add publisher metadata (#3080) 2024-08-24 20:14:45 -04:00
.gitmodules chore(various): tedious updates (#3316) 2024-10-19 21:59:15 -04:00
.prettierrc.json Fixed Formatting of HTML pages, added Prettier Support 2021-08-17 19:12:15 +02:00
.readthedocs.yaml build(deps): bump third-party/doxyconfig from 671b494 to 6d145da (#2979) 2024-08-07 23:07:51 +00:00
.rstcheck.cfg Documentation Update: Add linux ssh guide (#1527) 2023-09-14 13:42:35 -04:00
CMakeLists.txt fix(win/cmake): use cmake_path(CONVERT TO_NATIVE_PATH_LIST) (#3152) 2024-09-30 21:40:46 +00:00
codecov.yml ci: use prerelease logic (#2553) 2024-05-23 21:42:06 -04:00
crowdin.yml ci(crowdin): customize PR title (#3031) 2024-08-16 11:19:57 -04:00
DOCKER_README.md build(fedora)!: add copr build (#3239) 2024-10-06 18:41:21 +00:00
LICENSE Create LICENSE 2020-02-09 22:54:06 +01:00
NOTICE NOTICE file added with Steam trademarks notice 2022-02-03 22:15:13 +01:00
package.json build(deps): bump vue from 3.5.11 to 3.5.12 (#3301) 2024-10-14 08:53:34 -04:00
README.md docs: various updates (#3366) 2024-12-11 13:11:54 -05:00
sunshine.icns feat: basic OSX .app generation 2022-04-30 10:24:59 +01:00
sunshine.ico Update sunshine.ico 2022-03-15 22:30:01 -04:00
sunshine.png Remove white background from png logo 2022-04-28 18:20:53 -04:00
sunshine.svg add tray icon (#1035) 2023-03-15 16:30:18 -04:00
vite.config.js build(vite): fix assets directories with symlinks present (#3359) 2024-11-02 16:03:11 +00:00

Overview

GitHub stars GitHub Releases Docker Flathub installs Flathub Version GHCR Winget Version

GitHub Workflow Status (CI) GitHub Workflow Status (localize) Read the Docs Codecov

LizardByte has the full documentation hosted on Read the Docs.

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.

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:
  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 Windows: 10+ (Windows Server does not support virtual gamepads)
macOS: 13+
Linux/Debian: 12+ (bookworm)
Linux/Fedora: 39+
Linux/Ubuntu: 22.04+ (jammy)
Network Host: 5GHz, 802.11ac
Client: 5GHz, 802.11ac
4k Suggestions
Component Requirement
GPU AMD: Video Coding Engine 3.1 or higher
Intel:
  Linux: HD Graphics 510 or higher
  Windows: Skylake or newer with QuickSync encoding support
Nvidia: 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.

Previous Next
Getting Started
[TOC]