mirror/Sunshine
1
0
Fork 0
mirror of https://github.com/LizardByte/Sunshine.git synced 2025-01-16 16:21:02 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity
Self-hosted game stream host for Moonlight.
2,077 Commits 12 Branches 41 Tags 78 MiB
C++ 81.3%
HTML 4.4%
CMake 3.9%
Vue 3.4%
Shell 1.5%
Other 5.4%
aa76b2398b
Go to file
Cameron Gutman aa76b2398b Add support for starting URLs and regular files that aren't executable 
This provides some limited ShellExecute-like behavior.
2024-02-08 01:59:40 -06:00
.github builds(deps): use miniupnpc package instead of submodule (#1971) 2024-01-01 18:48:27 -05:00
cmake Add support for starting URLs and regular files that aren't executable 2024-02-08 01:59:40 -06:00
docker build(docker): add docker toolchain for clion (#2098) 2024-02-03 20:57:14 -05:00
docs refactor(logging): separate logging from main (#2110) 2024-02-07 09:59:24 -05:00
gh-pages-template docs: add crowdin translations to Sunshine website (#1627) 2023-09-12 13:29:21 -04:00
packaging builds(deps): use miniupnpc package instead of submodule (#1971) 2024-01-01 18:48:27 -05:00
scripts build(deps): bump babel from 2.13.0 to 2.14.0 (#1912) 2023-12-28 11:28:55 -05:00
src Add support for starting URLs and regular files that aren't executable 2024-02-08 01:59:40 -06:00
src_assets Adjust default CPU thread count to 2 2024-01-27 21:32:29 -06:00
third-party build(deps): bump third-party/moonlight-common-c 2024-02-03 17:02:36 -06:00
tools build(cmake): use CMAKE_SOURCE_DIR property (#2091) 2024-02-03 15:29:09 -05:00
.clang-format docs: improvements to source code documentation (#1236) 2023-05-07 15:01:44 -04:00
.codeql-prebuild-cpp.sh builds(deps): use miniupnpc package instead of submodule (#1971) 2024-01-01 18:48:27 -05:00
.dockerignore docs(website): add gh-pages (#1395) 2023-07-20 11:44:02 -04:00
.flake8
.gitignore
.gitmodules style(submodules): alphabetize gitmodules (#2104) 2024-02-04 19:25:58 -05:00
.prettierrc.json
.readthedocs.yaml build(deps): use submodules for wayland protocols (#1731) 2023-10-10 16:13:52 -04:00
.rstcheck.cfg Documentation Update: Add linux ssh guide (#1527) 2023-09-14 13:42:35 -04:00
CHANGELOG.md docs: update changelog for v0.21.0 (#1629) 2023-10-15 17:57:07 -04:00
CMakeLists.txt build(cmake): use CMAKE_SOURCE_DIR property (#2091) 2024-02-03 15:29:09 -05:00
crowdin.yml
DOCKER_README.md docs(docker): add podman notes (#2035) 2024-01-18 21:53:33 -05:00
LICENSE
NOTICE
package.json build(deps): bump vite from 4.4.9 to 4.5.2 (#2048) 2024-01-20 11:07:42 -05:00
README.rst docs: refactor and general cleanup (#1992) 2024-01-07 11:58:13 -05:00
sunshine.icns
sunshine.ico
sunshine.png
sunshine.svg add tray icon (#1035) 2023-03-15 16:30:18 -04:00
toolchain-mingw64.cmake
vite.config.js Web UI migration to Vite and Vue3 and improvements to the UX (#1673) 2023-12-27 19:25:49 -05:00

README.rst 

Overview
========
LizardByte has the full documentation hosted on `Read the Docs <https://sunshinestream.readthedocs.io/>`__.

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:: This table is a work in progress. Do not purchase hardware based on this.

**Minimum Requirements**

+------------+------------------------------------------------------------+
| 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 not supported)                |
|            +------------------------------------------------------------+
|            | macOS: 11.7+                                               |
|            +------------------------------------------------------------+
|            | Linux/Debian: 11 (bullseye)                                |
|            +------------------------------------------------------------+
|            | Linux/Fedora: 37+                                          |
|            +------------------------------------------------------------+
|            | Linux/Ubuntu: 20.04+ (focal)                               |
+------------+------------------------------------------------------------+
| Network    | Host: 5GHz, 802.11ac                                       |
|            +------------------------------------------------------------+
|            | Client: 5GHz, 802.11ac                                     |
+------------+------------------------------------------------------------+

**4k Suggestions**

+------------+------------------------------------------------------------+
| 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                           |
+------------+------------------------------------------------------------+

**HDR Suggestions**

+------------+------------------------------------------------------------+
| GPU        | AMD: Video Coding Engine 3.4 or higher                     |
|            +------------------------------------------------------------+
|            | Intel: UHD Graphics 730 or higher                          |
|            +------------------------------------------------------------+
|            | Nvidia: Pascal-based GPU (GTX 10-series) or higher         |
+------------+------------------------------------------------------------+
| CPU        | AMD: todo                                                  |
|            +------------------------------------------------------------+
|            | Intel: todo                                                |
+------------+------------------------------------------------------------+
| Network    | Host: CAT5e ethernet or better                             |
|            +------------------------------------------------------------+
|            | Client: CAT5e ethernet or better                           |
+------------+------------------------------------------------------------+

Integrations
------------

.. image:: https://img.shields.io/github/actions/workflow/status/lizardbyte/sunshine/CI.yml.svg?branch=master&label=CI%20build&logo=github&style=for-the-badge
   :alt: GitHub Workflow Status (CI)
   :target: https://github.com/LizardByte/Sunshine/actions/workflows/CI.yml?query=branch%3Amaster

.. image:: https://img.shields.io/github/actions/workflow/status/lizardbyte/sunshine/localize.yml.svg?branch=nightly&label=localize%20build&logo=github&style=for-the-badge
   :alt: GitHub Workflow Status (localize)
   :target: https://github.com/LizardByte/Sunshine/actions/workflows/localize.yml?query=branch%3Anightly

.. image:: https://img.shields.io/readthedocs/sunshinestream.svg?label=Docs&style=for-the-badge&logo=readthedocs
   :alt: Read the Docs
   :target: http://sunshinestream.readthedocs.io/

Support
-------

Our support methods are listed in our
`LizardByte Docs <https://lizardbyte.readthedocs.io/en/latest/about/support.html>`__.

Downloads
---------

.. image:: https://img.shields.io/github/downloads/lizardbyte/sunshine/total.svg?style=for-the-badge&logo=github
   :alt: GitHub Releases
   :target: https://github.com/LizardByte/Sunshine/releases/latest

.. image:: https://img.shields.io/docker/pulls/lizardbyte/sunshine.svg?style=for-the-badge&logo=docker
   :alt: Docker
   :target: https://hub.docker.com/r/lizardbyte/sunshine

.. image:: https://img.shields.io/badge/dynamic/xml.svg?color=orange&label=Winget&style=for-the-badge&prefix=v&query=%2F%2Ftr%5B%40id%3D%27winget%27%5D%2Ftd%5B3%5D%2Fspan%2Fa&url=https%3A%2F%2Frepology.org%2Fproject%2Fsunshine%2Fversions&logo=microsoft
   :alt: Winget Version
   :target: https://github.com/microsoft/winget-pkgs/tree/master/manifests/l/LizardByte/Sunshine

Stats
------
.. image:: https://img.shields.io/github/stars/lizardbyte/sunshine.svg?logo=github&style=for-the-badge
   :alt: GitHub stars
   :target: https://github.com/LizardByte/Sunshine

.. _nvenc support matrix: https://developer.nvidia.com/video-encode-and-decode-gpu-support-matrix-new
.. _obs-amd hardware support: https://github.com/obsproject/obs-amd-encoder/wiki/Hardware-Support
.. _VAAPI hardware support: https://www.intel.com/content/www/us/en/developer/articles/technical/linuxmedia-vaapi.html