mirror of https://github.com/LizardByte/Sunshine.git synced 2024-12-28 18:16:43 +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 0164be613e 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, 12) (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 }}) (12, true) (push) Blocked by required conditions Details CI / Macports (macOS-${{ matrix.os_version }}) (13) (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 / Lint Dockerfile${{ matrix.tag }} (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 feat(cmake): use symlink/junction for shaders in build dir (#3013 )		2024-08-22 09:14:33 -04:00
.github	build(macos): fix error in macos-13 build (#3022 )	2024-08-16 18:41:31 -04:00
cmake	feat(cmake): use symlink/junction for shaders in build dir (#3013 )	2024-08-22 09:14:33 -04:00
docker	docs: drop sphinx and use doxygen exclusively (#2932 )	2024-08-05 18:44:17 +00:00
docs	fix(build): update cuda compatibilities (#3018 )	2024-08-15 18:16:19 -04:00
gh-pages-template	docs(website): add pacman download button (#2830 )	2024-07-10 15:16:49 +00:00
packaging	fix(packaging): apply udev rules for uhid (#3041 )	2024-08-19 09:29:49 -04:00
scripts	build(deps): bump babel from 2.15.0 to 2.16.0 (#2998 )	2024-08-16 19:32:32 -04:00
src	fix(win/qsv): skip unsupported 4:4:4 codecs (#3029 )	2024-08-19 08:30:13 -04:00
src_assets	chore(l10n): update translations (#2910 )	2024-08-20 11:12:24 -04:00
tests	tests(windows): prefer static libraries (#2939 )	2024-08-08 17:39:30 +00:00
third-party	build(deps): bump third-party/tray from `d9f7e76` to `ebbd14f` (#3010 )	2024-08-18 19:44:24 -04:00
tools	docs(src): add examples alias and general cleanup (#2763 )	2024-06-28 08:34:14 -04: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	docs: use doxygen directly and drop breathe (#2739 )	2024-06-24 22:14:27 +00:00
.dockerignore	build(linux): add common build script (#2946 )	2024-08-03 20:04:26 -04:00
.flake8
.gitattributes	ci(flatpak): add flatpak builder lint (#2799 )	2024-07-07 10:19:11 -04:00
.gitignore	build(deps): bump third-party/doxyconfig from `671b494` to `6d145da` (#2979 )	2024-08-07 23:07:51 +00: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	ci(flatpak): add flatpak builder lint (#2799 )	2024-07-07 10:19:11 -04: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(docker): add ipc note (#3034 )	2024-08-16 17:18:35 -04:00
LICENSE
NOTICE
package.json	build(deps): bump @fortawesome/fontawesome-free from 6.5.2 to 6.6.0 (#2878 )	2024-07-17 17:50:40 +00:00
README.md	docs: drop sphinx and use doxygen exclusively (#2932 )	2024-08-05 18:44:17 +00:00
sunshine.icns
sunshine.ico
sunshine.png
sunshine.svg
toolchain-mingw64.cmake
vite.config.js	build(macos)!: add homebrew formula and drop dmg (#2222 )	2024-03-09 10:47:55 -05: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: 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: 12+
	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
	Overview