mirror of https://github.com/LizardByte/Sunshine.git synced 2024-12-25 09:17:23 +00:00

Self-hosted game stream host for Moonlight.

cpp docker game-stream game-streaming game-streaming-server geforce-experience homebrew-pkg moonlight pacman-pkg python remote-desktop replicator-release-notifications rtd winget-pkg

Go to file

dependabot[bot] a4a1bc48cd Some checks failed CI / GitHub Env Debug (push) Has been cancelled Details CI / Setup Release (push) Has been cancelled Details CI / Setup Flatpak Matrix (push) Has been cancelled Details CI Docker / Check Dockerfiles (push) Has been cancelled Details CodeQL / Get language matrix (push) Has been cancelled Details localize / Update Localization (push) Has been cancelled Details Build GH-Pages / update_pages (push) Has been cancelled Details CI / Linux Flatpak (push) Has been cancelled Details CI / Linux ${{ matrix.type }} (--appimage-build, 22.04, AppImage) (push) Has been cancelled Details CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' \|\| '' }}) (macos, 13) (push) Has been cancelled Details CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' \|\| '' }}) (macos, 14) (push) Has been cancelled Details CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' \|\| '' }}) (ubuntu, latest) (push) Has been cancelled Details CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' \|\| '' }}) (ubuntu, latest, true) (push) Has been cancelled Details CI / Macports (macOS-${{ matrix.os_version }}) (13, true) (push) Has been cancelled Details CI / Macports (macOS-${{ matrix.os_version }}) (14) (push) Has been cancelled Details CI / Windows (push) Has been cancelled Details CI Docker / Setup Release (push) Has been cancelled Details CI Docker / Docker${{ matrix.tag }} (push) Has been cancelled Details CodeQL / Analyze (${{ matrix.name }}) (push) Has been cancelled Details build(deps): bump third-party/build-deps from `b89442e` to `249a313` (#3479 ) Bumps [third-party/build-deps](https://github.com/LizardByte/build-deps) from `b89442e` to `249a313`. - [Commits](`b89442e43d...249a313844`) --- updated-dependencies: - dependency-name: third-party/build-deps dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>		2024-12-23 18:03:44 -05:00
.github	build(docker): fix docker artifacts (#3472 )	2024-12-21 12:53:14 -05:00
cmake	feat(display)!: Add libdisplaydevice dependency and output name mapping (#2894 )	2024-12-11 14:17:44 -05:00
docker	build(deps): remove unused dependency on libvdpau (#3307 )	2024-10-14 23:15:53 -05:00
docs	docs(doxygen): remove INCLUDE_PATH from config (#3475 )	2024-12-22 00:08:51 +00:00
gh-pages-template	docs: various updates (#3366 )	2024-12-11 13:11:54 -05:00
packaging	build(copr): fix build (#3458 )	2024-12-21 18:39:15 +00:00
scripts	build(deps): remove unused dependency on libvdpau (#3307 )	2024-10-14 23:15:53 -05:00
src	fix(nvenc): Enable opt-in client refresh by client (#3415 )	2024-12-23 17:07:38 -05:00
src_assets	chore(l10n): update translations (#3443 )	2024-12-14 15:27:03 +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 `b89442e` to `249a313` (#3479 )	2024-12-23 18:03:44 -05: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	feat(display)!: Add libdisplaydevice dependency and output name mapping (#2894 )	2024-12-11 14:17:44 -05:00
.prettierrc.json
.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
NOTICE
package.json	build(deps): bump vue from 3.5.12 to 3.5.13 (#3407 )	2024-12-21 19:26:16 +00: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

README.md

Overview

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
CPU	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
Network	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
CPU	Intel: Core i5 or higher
Network	Host: CAT5e ethernet or better
Network	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
CPU	Intel: Core i5 or higher
Network	Host: CAT5e ethernet or better
Network	Client: CAT5e ethernet or better

Support

Our support methods are listed in our LizardByte Docs.

Previous	Next
	Getting Started

[TOC]