mirror of
https://github.com/LizardByte/Sunshine.git
synced 2025-01-01 03:18:32 +00:00
Self-hosted game stream host for Moonlight.
cppdockergame-streamgame-streaminggame-streaming-servergeforce-experiencehomebrew-pkgmoonlightpacman-pkgpythonremote-desktopreplicator-release-notificationsrtdwinget-pkg
cdc2d1ba00
Some checks failed
CI / GitHub Env Debug (push) Has been cancelled
CI / Setup Release (push) Has been cancelled
CI / Setup Flatpak Matrix (push) Has been cancelled
CI Docker / Check Dockerfiles (push) Has been cancelled
CodeQL / Get language matrix (push) Has been cancelled
localize / Update Localization (push) Has been cancelled
Build GH-Pages / update_pages (push) Has been cancelled
CI / Linux Flatpak (push) Has been cancelled
CI / Linux ${{ matrix.type }} (--appimage-build, 22.04, AppImage) (push) Has been cancelled
CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' || '' }}) (macos, 12) (push) Has been cancelled
CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' || '' }}) (macos, 13) (push) Has been cancelled
CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' || '' }}) (macos, 14) (push) Has been cancelled
CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' || '' }}) (ubuntu, latest) (push) Has been cancelled
CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' || '' }}) (ubuntu, latest, true) (push) Has been cancelled
CI / Macports (macOS-${{ matrix.os_version }}) (12, true) (push) Has been cancelled
CI / Macports (macOS-${{ matrix.os_version }}) (13) (push) Has been cancelled
CI / Macports (macOS-${{ matrix.os_version }}) (14) (push) Has been cancelled
CI / Windows (push) Has been cancelled
CI Docker / Setup Release (push) Has been cancelled
CI Docker / Docker${{ matrix.tag }} (push) Has been cancelled
CodeQL / Analyze (${{ matrix.name }}) (push) Has been cancelled
|
||
|---|---|---|
| .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 | ||
| toolchain-mingw64.cmake | ||
| 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: 12+ | |
| 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 |