mirror of https://github.com/LizardByte/Sunshine.git synced 2024-12-26 03:16:21 +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

ns6089 fa654c12ef Some checks are pending CI / GitHub Env Debug (push) Waiting to run Details CI / Setup Release (push) Waiting to run Details CI / Setup Flatpak Matrix (push) Waiting to run Details CI / Linux Flatpak (push) Blocked by required conditions Details CI / Linux ${{ matrix.type }} (--appimage-build, 22.04, AppImage) (push) Blocked by required conditions Details CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' \|\| '' }}) (macos, 13) (push) Blocked by required conditions Details CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' \|\| '' }}) (macos, 14) (push) Blocked by required conditions Details CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' \|\| '' }}) (ubuntu, latest) (push) Blocked by required conditions Details CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' \|\| '' }}) (ubuntu, latest, true) (push) Blocked by required conditions Details CI / Macports (macOS-${{ matrix.os_version }}) (13, true) (push) Blocked by required conditions Details CI / Macports (macOS-${{ matrix.os_version }}) (14) (push) Blocked by required conditions Details CI / Windows (push) Blocked by required conditions Details CI Docker / Check Dockerfiles (push) Waiting to run Details CI Docker / Setup Release (push) Blocked by required conditions Details CI Docker / Docker${{ matrix.tag }} (push) Blocked by required conditions Details CodeQL / Get language matrix (push) Waiting to run Details CodeQL / Analyze (${{ matrix.name }}) (push) Blocked by required conditions Details Build GH-Pages / update_pages (push) Waiting to run Details fix(win/cmake): use cmake_path(CONVERT TO_NATIVE_PATH_LIST) (#3152 ) Co-authored-by: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com>		2024-09-30 21:40:46 +00:00
.github	chore(macos)!: drop monterey support (#3236 )	2024-09-29 21:37:57 +00:00
cmake	fix(win/cmake): use cmake_path(CONVERT TO_NATIVE_PATH_LIST) (#3152 )	2024-09-30 21:40:46 +00:00
docker	build(docker): update dockerfiles (#3085 )	2024-08-24 22:39:48 -04:00
docs	docs(configure): auto generate open urls (#3163 )	2024-09-11 17:56:54 -04:00
gh-pages-template	fix(gh-pages): update uno url (#3127 )	2024-09-05 08:38:34 -04:00
packaging	fix(macos/packaging): MacPorts startupitem.executable path (#3183 )	2024-09-14 18:19:09 -04:00
scripts	build(script): fix missing sudo for dnf group install (#3227 )	2024-09-28 19:02:34 +00:00
src	fix(curl): use stronger SSL and TLS versions (#3241 )	2024-09-29 23:48:10 +00:00
src_assets	fix(web-ui): broken url (#3238 )	2024-09-29 03:36:03 +00:00
tests	fix(mdns): don't hardcode mDNS instance name (#3084 )	2024-08-25 19:20:33 -04:00
third-party	build(deps): bump third-party/wayland-protocols from `24e612f` to `4878e02` (#3120 )	2024-09-05 14:18:01 +00:00
tools	fix: automatic selection for hybrid GPU and IDDSampleDriver users (#3002 )	2024-09-29 20:32:34 +00:00
.clang-format
.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	build(docs): add cmake target for docs (#2748 )	2024-06-24 16:12:31 +00:00
.codeql-prebuild-cpp-Windows.sh	ci(windows): use boost from source (#3231 )	2024-09-27 22:38:59 -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	docs: drop sphinx and use doxygen exclusively (#2932 )	2024-08-05 18:44:17 +00: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
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	docs: add interactive table of contents (#3111 )	2024-08-30 19:35:44 -04:00
LICENSE
NOTICE
package.json	build(deps): bump vue from 3.5.2 to 3.5.3 (#3150 )	2024-09-08 19:56:25 -04:00
README.md	chore(macos)!: drop monterey support (#3236 )	2024-09-29 21:37:57 +00:00
sunshine.icns
sunshine.ico
sunshine.png
sunshine.svg
toolchain-mingw64.cmake
vite.config.js

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: VAAPI-compatible, see: VAAPI hardware 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: HD Graphics 510 or higher
	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: 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]