Sunshine is a gamestream host for Moonlight!
Go to file
Cameron Gutman fe1832cda1 Revert "Use new 'remotegaming' scenario setting for QSV"
This causes Kaby Lake iGPUs to generate H.264 bitstreams with multiple
PPS NALUs which lead to some issues in current versions of Moonlight on
iOS and Android platforms.

This option also seems to override our max_dec_frame_buffering option
so it may increase latency on some Android devices too.

This reverts commit f838069a0e.
2023-10-14 01:49:47 -05:00
.github ci: update global workflows (#1730) 2023-10-12 12:22:23 -04:00
cmake build(deps): use submodules for wayland protocols (#1731) 2023-10-10 16:13:52 -04:00
docker ci: fix linux tray (#1650) 2023-09-18 18:14:53 -04:00
docs docs: update localization (#1699) 2023-10-04 21:55:57 -04:00
gh-pages-template docs: add crowdin translations to Sunshine website (#1627) 2023-09-12 13:29:21 -04:00
packaging ci: fix linux tray (#1650) 2023-09-18 18:14:53 -04:00
scripts build(scripts): remove wayland-protocols from clang-format script (#1740) 2023-10-11 18:35:33 -04:00
src Revert "Use new 'remotegaming' scenario setting for QSV" 2023-10-14 01:49:47 -05:00
src_assets Refactor shaders 2023-10-05 23:06:40 -05:00
third-party build(deps): use submodules for wayland protocols (#1731) 2023-10-10 16:13:52 -04:00
tools Fix audio code build with new MinGW headers 2023-07-30 16:35:24 -04:00
.clang-format docs: improvements to source code documentation (#1236) 2023-05-07 15:01:44 -04:00
.codeql-prebuild-cpp.sh ci: fix linux tray (#1650) 2023-09-18 18:14:53 -04:00
.dockerignore docs(website): add gh-pages (#1395) 2023-07-20 11:44:02 -04:00
.flake8 ci: update global python (#397) 2022-10-10 12:49:59 -04:00
.gitignore use npm dependencies 2022-11-19 12:58:29 -05:00
.gitmodules build(deps): use submodules for wayland protocols (#1731) 2023-10-10 16:13:52 -04:00
.prettierrc.json Fixed Formatting of HTML pages, added Prettier Support 2021-08-17 19:12:15 +02:00
.readthedocs.yaml build(deps): use submodules for wayland protocols (#1731) 2023-10-10 16:13:52 -04:00
.rstcheck.cfg Documentation Update: Add linux ssh guide (#1527) 2023-09-14 13:42:35 -04:00
CHANGELOG.md v0.20.0 release prep (#1321) 2023-05-28 20:20:35 -05:00
CMakeLists.txt refactor(cmake): split CMakeLists into modules (#1587) 2023-09-04 20:16:30 -04:00
crowdin.yml fix yaml-lint errors 2022-08-07 21:19:05 -04:00
DOCKER_README.md aur: move docker build (#895) 2023-02-13 15:27:51 -05: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 bootstrap from 5.3.1 to 5.3.2 (#1642) 2023-09-15 08:44:07 -04:00
qodana-js.yaml ci: add qodana (#1052) 2023-03-21 15:37:36 -04:00
qodana-python.yaml ci: add qodana (#1052) 2023-03-21 15:37:36 -04:00
README.rst docs: update localization (#1699) 2023-10-04 21:55:57 -04: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
toolchain-mingw64.cmake Get it to compile for windows in debug mode 2020-01-03 20:25:21 +01:00

Overview
========
LizardByte has the full documentation hosted on `Read the Docs <https://sunshinestream.readthedocs.io/>`__.

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:: This table is a work in progress. Do not purchase hardware based on this.

**Minimum Requirements**

+------------+------------------------------------------------------------+
| GPU        | AMD: VCE 1.0 or higher, see `obs-amd hardware support`_    |
|            +------------------------------------------------------------+
|            | Intel: VAAPI-compatible, see: `VAAPI hardware 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 not supported)                |
|            +------------------------------------------------------------+
|            | macOS: 11.7+                                               |
|            +------------------------------------------------------------+
|            | Linux/Debian: 11 (bullseye)                                |
|            +------------------------------------------------------------+
|            | Linux/Fedora: 36+                                          |
|            +------------------------------------------------------------+
|            | Linux/Ubuntu: 20.04+ (focal)                               |
+------------+------------------------------------------------------------+
| Network    | Host: 5GHz, 802.11ac                                       |
|            +------------------------------------------------------------+
|            | Client: 5GHz, 802.11ac                                     |
+------------+------------------------------------------------------------+

**4k Suggestions**

+------------+------------------------------------------------------------+
| GPU        | AMD: Video Coding Engine 3.1 or higher                     |
|            +------------------------------------------------------------+
|            | Intel: HD Graphics 510 or higher                           |
|            +------------------------------------------------------------+
|            | 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**

+------------+------------------------------------------------------------+
| GPU        | AMD: Video Coding Engine 3.4 or higher                     |
|            +------------------------------------------------------------+
|            | Intel: UHD Graphics 730 or higher                          |
|            +------------------------------------------------------------+
|            | Nvidia: Pascal-based GPU (GTX 10-series) or higher         |
+------------+------------------------------------------------------------+
| CPU        | AMD: todo                                                  |
|            +------------------------------------------------------------+
|            | Intel: todo                                                |
+------------+------------------------------------------------------------+
| Network    | Host: CAT5e ethernet or better                             |
|            +------------------------------------------------------------+
|            | Client: CAT5e ethernet or better                           |
+------------+------------------------------------------------------------+

Integrations
------------

.. image:: https://img.shields.io/github/actions/workflow/status/lizardbyte/sunshine/CI.yml.svg?branch=master&label=CI%20build&logo=github&style=for-the-badge
   :alt: GitHub Workflow Status (CI)
   :target: https://github.com/LizardByte/Sunshine/actions/workflows/CI.yml?query=branch%3Amaster

.. image:: https://img.shields.io/github/actions/workflow/status/lizardbyte/sunshine/localize.yml.svg?branch=nightly&label=localize%20build&logo=github&style=for-the-badge
   :alt: GitHub Workflow Status (localize)
   :target: https://github.com/LizardByte/Sunshine/actions/workflows/localize.yml?query=branch%3Anightly

.. image:: https://img.shields.io/readthedocs/sunshinestream.svg?label=Docs&style=for-the-badge&logo=readthedocs
   :alt: Read the Docs
   :target: http://sunshinestream.readthedocs.io/

Support
-------

Our support methods are listed in our
`LizardByte Docs <https://lizardbyte.readthedocs.io/en/latest/about/support.html>`__.

Downloads
---------

.. image:: https://img.shields.io/github/downloads/lizardbyte/sunshine/total.svg?style=for-the-badge&logo=github
   :alt: GitHub Releases
   :target: https://github.com/LizardByte/Sunshine/releases/latest

.. image:: https://img.shields.io/docker/pulls/lizardbyte/sunshine.svg?style=for-the-badge&logo=docker
   :alt: Docker
   :target: https://hub.docker.com/r/lizardbyte/sunshine

.. image:: https://img.shields.io/badge/dynamic/xml.svg?color=orange&label=Winget&style=for-the-badge&prefix=v&query=%2F%2Ftr%5B%40id%3D%27winget%27%5D%2Ftd%5B3%5D%2Fspan%2Fa&url=https%3A%2F%2Frepology.org%2Fproject%2Fsunshine%2Fversions&logo=microsoft
   :alt: Winget Version
   :target: https://github.com/microsoft/winget-pkgs/tree/master/manifests/l/LizardByte/Sunshine

Stats
------
.. image:: https://img.shields.io/github/stars/lizardbyte/sunshine.svg?logo=github&style=for-the-badge
   :alt: GitHub stars
   :target: https://github.com/LizardByte/Sunshine

.. _nvenc support matrix: https://developer.nvidia.com/video-encode-and-decode-gpu-support-matrix-new
.. _obs-amd hardware support: https://github.com/obsproject/obs-amd-encoder/wiki/Hardware-Support
.. _VAAPI hardware support: https://www.intel.com/content/www/us/en/developer/articles/technical/linuxmedia-vaapi.html