mirror of
https://github.com/LizardByte/Sunshine.git
synced 2024-11-16 14:09:43 +00:00
Self-hosted game stream host for Moonlight.
cppdockergame-streamgame-streaminggame-streaming-servergeforce-experiencehomebrew-pkgmoonlightpacman-pkgpythonremote-desktopreplicator-release-notificationsrtdwinget-pkg
f418566b31
Some checks are pending
CI / GitHub Env Debug (push) Waiting to run
CI / Setup Release (push) Waiting to run
CI / Setup Flatpak Matrix (push) Waiting to run
CI / Linux Flatpak (push) Blocked by required conditions
CI / Linux ${{ matrix.type }} (--appimage-build, 22.04, AppImage) (push) Blocked by required conditions
CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' || '' }}) (macos, 13) (push) Blocked by required conditions
CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' || '' }}) (macos, 14) (push) Blocked by required conditions
CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' || '' }}) (ubuntu, latest) (push) Blocked by required conditions
CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' || '' }}) (ubuntu, latest, true) (push) Blocked by required conditions
CI / Macports (macOS-${{ matrix.os_version }}) (13, true) (push) Blocked by required conditions
CI / Macports (macOS-${{ matrix.os_version }}) (14) (push) Blocked by required conditions
CI / Windows (push) Blocked by required conditions
CI Docker / Check Dockerfiles (push) Waiting to run
CI Docker / Setup Release (push) Blocked by required conditions
CI Docker / Docker${{ matrix.tag }} (push) Blocked by required conditions
CodeQL / Get language matrix (push) Waiting to run
CodeQL / Analyze (${{ matrix.name }}) (push) Blocked by required conditions
localize / Update Localization (push) Waiting to run
Build GH-Pages / update_pages (push) Waiting to run
|
||
|---|---|---|
| .github | ||
| cmake | ||
| docker | ||
| docs | ||
| gh-pages-template | ||
| packaging | ||
| scripts | ||
| src | ||
| src_assets | ||
| tests | ||
| third-party | ||
| tools | ||
| .clang-format | ||
| .codeql-prebuild-cpp-Linux.sh | ||
| .codeql-prebuild-cpp-macOS.sh | ||
| .codeql-prebuild-cpp-Windows.sh | ||
| .dockerignore | ||
| .flake8 | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| .prettierrc.json | ||
| .readthedocs.yaml | ||
| .rstcheck.cfg | ||
| CMakeLists.txt | ||
| codecov.yml | ||
| crowdin.yml | ||
| DOCKER_README.md | ||
| LICENSE | ||
| NOTICE | ||
| package.json | ||
| README.md | ||
| sunshine.icns | ||
| sunshine.ico | ||
| sunshine.png | ||
| sunshine.svg | ||
| vite.config.js | ||
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.}
| 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 |
| 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 |
| 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 |
| Intel: Core i5 or higher | |
| Network | Host: CAT5e ethernet or better |
| Client: CAT5e ethernet or better |
| 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 |
| 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 |