2022-04-18 18:53:28 +00:00
|
|
|
Overview
|
|
|
|
|
========
|
2022-10-28 16:20:16 +00:00
|
|
|
LizardByte has the full documentation hosted on `Read the Docs <https://sunshinestream.readthedocs.io/>`_.
|
2022-04-18 18:53:28 +00:00
|
|
|
|
|
|
|
|
About
|
|
|
|
|
-----
|
2022-06-28 23:16:24 +00:00
|
|
|
Sunshine is a Game stream host for Moonlight.
|
|
|
|
|
Sunshine is a self hosted, low latency, cloud gaming solution with support for AMD, Intel, and Nvidia gpus.
|
|
|
|
|
It is an open source implementation of NVIDIA's GameStream, as used by the NVIDIA Shield.
|
|
|
|
|
Connect to Sunshine from any Moonlight client, available for nearly any device imaginable.
|
2022-04-18 18:53:28 +00:00
|
|
|
|
2022-06-28 23:16:24 +00:00
|
|
|
These are the advantages of Sunshine over GeForce Experience.
|
2022-04-18 18:53:28 +00:00
|
|
|
|
2022-10-30 02:14:16 +00:00
|
|
|
- FOSS (Free and Open Source Software)
|
|
|
|
|
- Multi-platform
|
2022-04-18 18:53:28 +00:00
|
|
|
|
2022-10-30 02:14:16 +00:00
|
|
|
- Linux
|
|
|
|
|
- macOS
|
|
|
|
|
- Windows
|
2022-04-18 18:53:28 +00:00
|
|
|
|
2022-10-30 02:14:16 +00:00
|
|
|
- Pair over web ui
|
|
|
|
|
- Supports AMD, Intel, and Nvidia GPUs for encoding
|
|
|
|
|
- Supports software encoding
|
|
|
|
|
- Supports streaming to multiple clients
|
|
|
|
|
- Web UI for configuration
|
2022-04-18 18:53:28 +00:00
|
|
|
|
|
|
|
|
Integrations
|
|
|
|
|
------------
|
|
|
|
|
|
2022-07-29 13:45:26 +00:00
|
|
|
.. image:: https://img.shields.io/github/workflow/status/lizardbyte/sunshine/CI/master?label=CI%20build&logo=github&style=for-the-badge
|
2022-04-18 18:53:28 +00:00
|
|
|
:alt: GitHub Workflow Status (CI)
|
2022-07-29 13:45:26 +00:00
|
|
|
:target: https://github.com/LizardByte/Sunshine/actions/workflows/CI.yml?query=branch%3Amaster
|
2022-04-18 18:53:28 +00:00
|
|
|
|
2022-07-29 13:45:26 +00:00
|
|
|
.. image:: https://img.shields.io/github/workflow/status/lizardbyte/sunshine/localize/nightly?label=localize%20build&logo=github&style=for-the-badge
|
2022-04-18 18:53:28 +00:00
|
|
|
:alt: GitHub Workflow Status (localize)
|
2022-07-29 13:45:26 +00:00
|
|
|
:target: https://github.com/LizardByte/Sunshine/actions/workflows/localize.yml?query=branch%3Anightly
|
2022-04-18 18:53:28 +00:00
|
|
|
|
|
|
|
|
.. image:: https://img.shields.io/readthedocs/sunshinestream?label=Docs&style=for-the-badge&logo=readthedocs
|
|
|
|
|
:alt: Read the Docs
|
|
|
|
|
:target: http://sunshinestream.readthedocs.io/
|
|
|
|
|
|
|
|
|
|
.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=localized&style=for-the-badge&query=%24.progress..data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503956.json&logo=crowdin
|
|
|
|
|
:alt: CrowdIn
|
|
|
|
|
:target: https://crowdin.com/project/sunshinestream
|
|
|
|
|
|
|
|
|
|
Support
|
|
|
|
|
---------
|
|
|
|
|
|
2022-10-28 16:20:16 +00:00
|
|
|
Our support methods are listed in our
|
|
|
|
|
`LizardByte Docs <https://lizardbyte.readthedocs.io/en/latest/about/support.html>`_.
|
2022-04-18 18:53:28 +00:00
|
|
|
|
|
|
|
|
Downloads
|
|
|
|
|
---------
|
|
|
|
|
|
2022-07-29 13:45:26 +00:00
|
|
|
.. image:: https://img.shields.io/github/downloads/lizardbyte/sunshine/total?style=for-the-badge&logo=github
|
2022-04-18 18:53:28 +00:00
|
|
|
:alt: GitHub Releases
|
2022-07-29 13:45:26 +00:00
|
|
|
:target: https://github.com/LizardByte/Sunshine/releases/latest
|
2022-04-18 18:53:28 +00:00
|
|
|
|
2022-10-28 16:20:16 +00:00
|
|
|
.. image:: https://img.shields.io/docker/pulls/lizardbyte/sunshine?style=for-the-badge&logo=docker
|
|
|
|
|
:alt: Docker
|
|
|
|
|
:target: https://hub.docker.com/r/lizardbyte/sunshine
|
|
|
|
|
|
|
|
|
|
Stats
|
|
|
|
|
------
|
|
|
|
|
.. image:: https://img.shields.io/github/stars/lizardbyte/sunshine?logo=github&style=for-the-badge
|
|
|
|
|
:alt: GitHub stars
|
|
|
|
|
:target: https://github.com/LizardByte/Sunshine
|
|
|
|
|
|
2022-07-29 13:45:26 +00:00
|
|
|
.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=AUR&style=for-the-badge&query=$.results.0.NumVotes&url=https%3A%2F%2Fapp.lizardbyte.dev%2Funo%2Faur%2Fsunshine.json&logo=archlinux
|
2022-06-20 22:55:35 +00:00
|
|
|
:alt: AUR votes
|
2022-07-29 13:45:26 +00:00
|
|
|
:target: https://aur.archlinux.org/packages/sunshine
|
