From 3cab7e106791c9def031fa1631931d012359983d Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sat, 29 Oct 2022 22:14:16 -0400 Subject: [PATCH] change docs theme to `furo` --- .readthedocs.yaml | 4 +- README.rst | 22 +- docs/requirements.txt | 4 + docs/source/about/advanced_usage.rst | 309 ++++++++++----------- docs/source/about/installation.rst | 36 +-- docs/source/about/third_party_packages.rst | 14 +- docs/source/about/usage.rst | 76 ++--- docs/source/building/build.rst | 3 - docs/source/building/linux.rst | 2 - docs/source/building/macos.rst | 11 +- docs/source/building/windows.rst | 18 +- docs/source/conf.py | 18 +- docs/source/contributing/contributing.rst | 38 +-- docs/source/contributing/localization.rst | 39 ++- docs/source/contributing/testing.rst | 10 +- docs/source/troubleshooting/general.rst | 17 +- docs/source/troubleshooting/linux.rst | 3 - docs/source/troubleshooting/macos.rst | 23 +- docs/source/troubleshooting/windows.rst | 3 - scripts/requirements.txt | 4 - 20 files changed, 277 insertions(+), 377 deletions(-) create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 156e5624..586666c2 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -10,7 +10,7 @@ version: 2 build: os: ubuntu-20.04 tools: - python: "3.9" + python: "3.10" ## apt packages required packages to run cmake on sunshine, note that additional packages are required # apt_packages: @@ -41,5 +41,5 @@ formats: all python: install: - - requirements: ./scripts/requirements.txt + - requirements: ./docs/requirements.txt system_packages: true diff --git a/README.rst b/README.rst index 4f7a5102..f7853dee 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/LizardByte/Sunshine/tree/nightly/README.rst - Overview ======== LizardByte has the full documentation hosted on `Read the Docs `_. @@ -13,18 +11,18 @@ Connect to Sunshine from any Moonlight client, available for nearly any device i These are the advantages of Sunshine over GeForce Experience. - - FOSS (Free and Open Source Software) - - Multi-platform +- FOSS (Free and Open Source Software) +- Multi-platform - - Linux - - macOS - - Windows + - Linux + - macOS + - Windows - - Pair over web ui - - Supports AMD, Intel, and Nvidia GPUs for encoding - - Supports software encoding - - Supports streaming to multiple clients - - Web UI for configuration +- Pair over web ui +- Supports AMD, Intel, and Nvidia GPUs for encoding +- Supports software encoding +- Supports streaming to multiple clients +- Web UI for configuration Integrations ------------ diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..fc950e03 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,4 @@ +furo==2022.9.29 +m2r2==0.3.3 +Sphinx==5.3.0 +sphinx-copybutton==0.5.0 diff --git a/docs/source/about/advanced_usage.rst b/docs/source/about/advanced_usage.rst index b8613850..2ab43a85 100644 --- a/docs/source/about/advanced_usage.rst +++ b/docs/source/about/advanced_usage.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/LizardByte/Sunshine/tree/nightly/docs/source/about/advanced_usage.rst - Advanced Usage ============== Sunshine will work with the default settings for most users. In some cases you may want to configure Sunshine further. @@ -26,7 +24,7 @@ location by modifying the configuration file. Windows ./config/ ========= =========== -Example +**Example** .. code-block:: bash sunshine ~/sunshine_config.conf @@ -41,13 +39,13 @@ General sunshine_name ^^^^^^^^^^^^^ -Description +**Description** The name displayed by Moonlight -Default +**Default** PC hostname -Example +**Example** .. code-block:: text sunshine_name = Sunshine @@ -55,7 +53,7 @@ Example min_log_level ^^^^^^^^^^^^^ -Description +**Description** The minimum log level printed to standard out. **Choices** @@ -75,10 +73,10 @@ Description none no logging ======= =========== -Default +**Default** ``info`` -Example +**Example** .. code-block:: text min_log_level = info @@ -89,7 +87,7 @@ Controls gamepad ^^^^^^^ -Description +**Description** The type of gamepad to emulate on the host. .. Caution:: Applies to Windows only. @@ -106,10 +104,10 @@ Description ds4 dualshock controller (PS4) ===== =========== -Default +**Default** ``x360`` -Example +**Example** .. code-block:: text gamepad = x360 @@ -117,17 +115,17 @@ Example back_button_timeout ^^^^^^^^^^^^^^^^^^^ -Description +**Description** If, after the timeout, the back/select button is still pressed down, Home/Guide button press is emulated. On Nvidia Shield, the home and power button are not passed to Moonlight. .. Tip:: If back_button_timeout < 0, then the Home/Guide button will not be emulated. -Default +**Default** ``2000`` -Example +**Example** .. code-block:: text back_button_timeout = 2000 @@ -135,13 +133,13 @@ Example key_repeat_delay ^^^^^^^^^^^^^^^^ -Description +**Description** The initial delay in milliseconds before repeating keys. Controls how fast keys will repeat themselves. -Default +**Default** ``500`` -Example +**Example** .. code-block:: text key_repeat_delay = 500 @@ -149,15 +147,15 @@ Example key_repeat_frequency ^^^^^^^^^^^^^^^^^^^^ -Description +**Description** How often keys repeat every second. .. Tip:: This configurable option supports decimals. -Default +**Default** .. Todo:: Unknown -Example +**Example** .. code-block:: text key_repeat_frequency = 24.9 @@ -165,17 +163,17 @@ Example keybindings ^^^^^^^^^^^ -Description +**Description** Sometimes it may be useful to map keybindings. Wayland won't allow clients to capture the Win Key for example. .. Tip:: See `virtual key codes `_ .. Hint:: keybindings needs to have a multiple of two elements. -Default +**Default** None -Example +**Example** .. code-block:: text keybindings = [ @@ -188,14 +186,14 @@ Example key_rightalt_to_key_win ^^^^^^^^^^^^^^^^^^^^^^^ -Description +**Description** It may be possible that you cannot send the Windows Key from Moonlight directly. In those cases it may be useful to make Sunshine think the Right Alt key is the Windows key. -Default +**Default** None -Example +**Example** .. code-block:: text key_rightalt_to_key_win = enabled @@ -206,12 +204,12 @@ Display adapter_name ^^^^^^^^^^^^ -Description +**Description** Select the video card you want to stream. .. Tip:: To find the name of the appropriate values follow these instructions. - Linux + VA-API + **Linux + VA-API** Unlike with `amdvce` and `nvenc`, it doesn't matter if video encoding is done on a different GPU. .. code-block:: bash @@ -227,23 +225,23 @@ Description .. Todo:: macOS - Windows + **Windows** .. code-block:: batch tools\dxgi-info.exe -Default +**Default** Sunshine will select the default video card. -Examples - Linux +**Examples** + **Linux** .. code-block:: text adapter_name = /dev/dri/renderD128 .. Todo:: macOS - Windows + **Windows** .. code-block:: text adapter_name = Radeon RX 580 Series @@ -251,12 +249,12 @@ Examples output_name ^^^^^^^^^^^ -Description +**Description** Select the display number you want to stream. .. Tip:: To find the name of the appropriate values follow these instructions. - Linux + **Linux** .. code-block:: bash xrandr --listmonitors @@ -267,23 +265,23 @@ Description .. Todo:: macOS - Windows + **Windows** .. code-block:: batch tools\dxgi-info.exe -Default +**Default** Sunshine will select the default display. -Examples - Linux +**Examples** + **Linux** .. code-block:: text output_name = 0 .. Todo:: macOS - Windows + **Windows** .. code-block:: text output_name = \\.\DISPLAY1 @@ -291,16 +289,16 @@ Examples fps ^^^ -Description +**Description** The fps modes advertised by Sunshine. .. Note:: Some versions of Moonlight, such as Moonlight-nx (Switch), rely on this list to ensure that the requested fps is supported. -Default +**Default** .. Todo:: Unknown -Example +**Example** .. code-block:: text fps = [10, 30, 60, 90, 120] @@ -308,16 +306,16 @@ Example resolutions ^^^^^^^^^^^ -Description +**Description** The resolutions advertised by Sunshine. .. Note:: Some versions of Moonlight, such as Moonlight-nx (Switch), rely on this list to ensure that the requested resolution is supported. -Default +**Default** .. Todo:: Unknown -Example +**Example** .. code-block:: text resolutions = [ @@ -336,22 +334,20 @@ Example dwmflush ^^^^^^^^ -Description +**Description** Invoke DwmFlush() to sync screen capture to the Windows presentation interval. .. Caution:: Applies to Windows only. Alleviates visual stuttering during mouse movement. If enabled, this feature will automatically deactivate if the client framerate exceeds the host monitor's current refresh rate. -Default +**Default** ``enabled`` -Examples +**Example** + .. code-block:: text - Windows - .. code-block:: text - - dwmflush = enabled + dwmflush = enabled Audio ----- @@ -359,48 +355,48 @@ Audio audio_sink ^^^^^^^^^^ -Description +**Description** The name of the audio sink used for audio loopback. .. Tip:: To find the name of the audio sink follow these instructions. - Linux + pulseaudio + **Linux + pulseaudio** .. code-block:: bash pacmd list-sinks | grep "name:" - Linux + pipewire + **Linux + pipewire** .. code-block:: bash pactl info | grep Source # in some causes you'd need to use the `Sink` device, if `Source` doesn't work, so try: pactl info | grep Sink - macOS + **macOS** Sunshine can only access microphones on macOS due to system limitations. To stream system audio use `Soundflower `_ or `BlackHole `_. - Windows + **Windows** .. code-block:: batch tools\audio-info.exe -Default +**Default** Sunshine will select the default audio device. -Examples - Linux +**Examples** + **Linux** .. code-block:: text audio_sink = alsa_output.pci-0000_09_00.3.analog-stereo - macOS + **macOS** .. code-block:: text audio_sink = BlackHole 2ch - Windows + **Windows** .. code-block:: text audio_sink = {0.0.0.00000000}.{FD47D9CC-4218-4135-9CE2-0C195C87405B} @@ -408,16 +404,16 @@ Examples virtual_sink ^^^^^^^^^^^^ -Description +**Description** The audio device that's virtual, like Steam Streaming Speakers. This allows Sunshine to stream audio, while muting the speakers. .. Tip:: See `audio_sink`_! -Default +**Default** .. Todo:: Unknown -Example +**Example** .. code-block:: text virtual_sink = {0.0.0.00000000}.{8edba70c-1125-467c-b89c-15da389bc1d4} @@ -428,13 +424,13 @@ Network external_ip ^^^^^^^^^^^ -Description +**Description** If no external IP address is given, Sunshine will attempt to automatically detect external ip-address. -Default +**Default** Automatic -Example +**Example** .. code-block:: text external_ip = 123.456.789.12 @@ -442,7 +438,7 @@ Example port ^^^^ -Description +**Description** Set the family of ports used by Sunshine. Changing this value will offset other ports per the table below. .. table:: @@ -458,18 +454,15 @@ Description Video 47998 UDP +9 Control 47999 UDP +10 Audio 48000 UDP +11 - tbd 48002 UDP +13 + Mic (unused) 48002 UDP +13 ================ ============ =========================== .. Attention:: Custom ports are only allowed on select Moonlight clients. -.. Todo:: Determine the function of port 48002 UDP. See - `here `_. - -Default +**Default** ``47989`` -Example +**Example** .. code-block:: text port = 47989 @@ -477,13 +470,13 @@ Example pkey ^^^^ -Description +**Description** The private key. This must be 2048 bits. -Default +**Default** .. Todo:: Unknown -Example +**Example** .. code-block:: text pkey = /dir/pkey.pem @@ -491,13 +484,13 @@ Example cert ^^^^ -Description +**Description** The certificate. Must be signed with a 2048 bit key. -Default +**Default** .. Todo:: Unknown -Example +**Example** .. code-block:: text cert = /dir/cert.pem @@ -505,7 +498,7 @@ Example origin_pin_allowed ^^^^^^^^^^^^^^^^^^ -Description +**Description** The origin of the remote endpoint address that is not denied for HTTP method /pin. **Choices** @@ -521,10 +514,10 @@ Description wan Anyone may access /pin ===== =========== -Default +**Default** ``pc`` -Example +**Example** .. code-block:: text origin_pin_allowed = pc @@ -532,7 +525,7 @@ Example origin_web_ui_allowed ^^^^^^^^^^^^^^^^^^^^^ -Description +**Description** The origin of the remote endpoint address that is not denied for HTTPS Web UI. **Choices** @@ -548,10 +541,10 @@ Description wan Anyone may access the web ui ===== =========== -Default +**Default** ``lan`` -Example +**Example** .. code-block:: text origin_web_ui_allowed = lan @@ -559,7 +552,7 @@ Example upnp ^^^^ -Description +**Description** Sunshine will attempt to open ports for streaming over the internet. **Choices** @@ -574,10 +567,10 @@ Description off disable UPnP ===== =========== -Default +**Default** ``off`` -Example +**Example** .. code-block:: text upnp = on @@ -585,13 +578,13 @@ Example ping_timeout ^^^^^^^^^^^^ -Description +**Description** How long to wait in milliseconds for data from Moonlight before shutting down the stream. -Default +**Default** ``10000`` -Example +**Example** .. code-block:: text ping_timeout = 10000 @@ -602,22 +595,22 @@ Encoding channels ^^^^^^^^ -Description +**Description** This will generate distinct video streams, unlike simply broadcasting to multiple Clients. When multicasting, it could be useful to have different configurations for each connected Client. For instance: - - Clients connected through WAN and LAN have different bitrate constraints. - - Decoders may require different settings for color. + - Clients connected through WAN and LAN have different bitrate constraints. + - Decoders may require different settings for color. .. Warning:: CPU usage increases for each distinct video stream generated. -Default +**Default** ``1`` -Example +**Example** .. code-block:: text channels = 1 @@ -625,18 +618,18 @@ Example fec_percentage ^^^^^^^^^^^^^^ -Description +**Description** Percentage of error correcting packets per data packet in each video frame. .. Warning:: Higher values can correct for more network packet loss, but at the cost of increasing bandwidth usage. -Default +**Default** ``20`` -Range +**Range** ``1-255`` -Example +**Example** .. code-block:: text fec_percentage = 20 @@ -644,15 +637,15 @@ Example qp ^^ -Description +**Description** Quantitization Parameter. Some devices don't support Constant Bit Rate. For those devices, QP is used instead. .. Warning:: Higher value means more compression, but less quality. -Default +**Default** ``28`` -Example +**Example** .. code-block:: text qp = 28 @@ -660,17 +653,17 @@ Example min_threads ^^^^^^^^^^^ -Description +**Description** Minimum number of threads used by ffmpeg to encode the video. .. Note:: Increasing the value slightly reduces encoding efficiency, but the tradeoff is usually worth it to gain the use of more CPU cores for encoding. The ideal value is the lowest value that can reliably encode at your desired streaming settings on your hardware. -Default +**Default** ``1`` -Example +**Example** .. code-block:: text min_threads = 1 @@ -678,7 +671,7 @@ Example hevc_mode ^^^^^^^^^ -Description +**Description** Allows the client to request HEVC Main or HEVC Main10 video streams. .. Warning:: HEVC is more CPU-intensive to encode, so enabling this may reduce performance when using software @@ -698,10 +691,10 @@ Description 3 advertise support for HEVC Main and Main10 (HDR) profiles ===== =========== -Default +**Default** ``0`` -Example +**Example** .. code-block:: text hevc_mode = 2 @@ -709,7 +702,7 @@ Example encoder ^^^^^^^ -Description +**Description** Force a specific encoder. **Choices** @@ -725,10 +718,10 @@ Description software Encoding occurs on the CPU ======== =========== -Default +**Default** Sunshine will use the first encoder that is available. -Example +**Example** .. code-block:: text encoder = nvenc @@ -736,7 +729,7 @@ Example sw_preset ^^^^^^^^^ -Description +**Description** The encoder preset to use. .. Note:: This option only applies when using software `encoder`_. @@ -771,10 +764,10 @@ Description veryslow slowest ========= =========== -Default +**Default** ``superfast`` -Example +**Example** .. code-block:: text sw_preset = superfast @@ -782,7 +775,7 @@ Example sw_tune ^^^^^^^ -Description +**Description** The tuning preset to use. .. Note:: This option only applies when using software `encoder`_. @@ -807,10 +800,10 @@ Description zerolatency good for fast encoding and low-latency streaming =========== =========== -Default +**Default** ``zerolatency`` -Example +**Example** .. code-block:: text sw_tune = zerolatency @@ -818,7 +811,7 @@ Example nv_preset ^^^^^^^^^ -Description +**Description** The encoder preset to use. .. Note:: This option only applies when using nvenc `encoder`_. @@ -845,10 +838,10 @@ Description losslesshp lossless, high performance ========== =========== -Default +**Default** ``llhq`` -Example +**Example** .. code-block:: text nv_preset = llhq @@ -856,7 +849,7 @@ Example nv_rc ^^^^^ -Description +**Description** The encoder rate control. .. Note:: This option only applies when using nvenc `encoder`_. @@ -880,10 +873,10 @@ Description vbr_hq variable bitrate, high quality ========== =========== -Default +**Default** ``auto`` -Example +**Example** .. code-block:: text nv_rc = auto @@ -891,7 +884,7 @@ Example nv_coder ^^^^^^^^ -Description +**Description** The entropy encoding to use. .. Note:: This option only applies when using nvenc `encoder`_. @@ -909,10 +902,10 @@ Description cavlc ========== =========== -Default +**Default** ``auto`` -Example +**Example** .. code-block:: text nv_coder = auto @@ -920,7 +913,7 @@ Example amd_quality ^^^^^^^^^^^ -Description +**Description** The encoder preset to use. .. Note:: This option only applies when using amdvce `encoder`_. @@ -938,10 +931,10 @@ Description balanced balance performance and speed ========== =========== -Default +**Default** ``balanced`` -Example +**Example** .. code-block:: text amd_quality = balanced @@ -949,7 +942,7 @@ Example amd_rc ^^^^^^ -Description +**Description** The encoder rate control. .. Note:: This option only applies when using amdvce `encoder`_. @@ -971,10 +964,10 @@ Description vbr_peak variable bitrate, peak constrained =========== =========== -Default +**Default** ``auto`` -Example +**Example** .. code-block:: text amd_rc = auto @@ -982,7 +975,7 @@ Example amd_coder ^^^^^^^^^ -Description +**Description** The entropy encoding to use. .. Note:: This option only applies when using nvenc `encoder`_. @@ -1000,10 +993,10 @@ Description cavlc ========== =========== -Default +**Default** ``auto`` -Example +**Example** .. code-block:: text amd_coder = auto @@ -1011,7 +1004,7 @@ Example vt_software ^^^^^^^^^^^ -Description +**Description** Force Video Toolbox to use software encoding. .. Note:: This option only applies when using macOS. @@ -1030,10 +1023,10 @@ Description forced force software encoding ========== =========== -Default +**Default** ``auto`` -Example +**Example** .. code-block:: text vt_software = auto @@ -1041,17 +1034,17 @@ Example vt_realtime ^^^^^^^^^^^ -Description +**Description** Realtime encoding. .. Note:: This option only applies when using macOS. .. Warning:: Disabling realtime encoding might result in a delayed frame encoding or frame drop. -Default +**Default** ``enabled`` -Example +**Example** .. code-block:: text vt_realtime = enabled @@ -1059,7 +1052,7 @@ Example vt_coder ^^^^^^^^ -Description +**Description** The entropy encoding to use. .. Note:: This option only applies when using macOS. @@ -1077,10 +1070,10 @@ Description cavlc ========== =========== -Default +**Default** ``auto`` -Example +**Example** .. code-block:: text vt_coder = auto @@ -1091,14 +1084,14 @@ Advanced file_apps ^^^^^^^^^ -Description +**Description** The application configuration file path. The file contains a json formatted list of applications that can be started by Moonlight. -Default +**Default** OS and package dependent -Example +**Example** .. code-block:: text file_apps = apps.json @@ -1106,13 +1099,13 @@ Example file_state ^^^^^^^^^^ -Description +**Description** The file where current state of Sunshine is stored. -Default +**Default** ``sunshine_state.json`` -Example +**Example** .. code-block:: text file_state = sunshine_state.json @@ -1120,13 +1113,13 @@ Example credentials_file ^^^^^^^^^^^^^^^^ -Description +**Description** The file where user credentials for the UI are stored. -Default +**Default** ``sunshine_state.json`` -Example +**Example** .. code-block:: text credentials_file = sunshine_state.json diff --git a/docs/source/about/installation.rst b/docs/source/about/installation.rst index 5c9f2194..9f65ba59 100644 --- a/docs/source/about/installation.rst +++ b/docs/source/about/installation.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/LizardByte/Sunshine/tree/nightly/docs/source/about/installation.rst - Installation ============ The recommended method for running Sunshine is to use the `binaries`_ bundled with the `latest release`_. @@ -36,19 +34,19 @@ AppImage .. image:: https://img.shields.io/github/issues/lizardbyte/sunshine/pkg:appimage?logo=github&style=for-the-badge :alt: GitHub issues by-label -According to AppImageLint the AppImage can run on the following distros. +According to AppImageLint the supported distro matrix of the AppImage is below. - - [✖] Debian oldstable (buster) - - [✔] Debian stable (bullseye) - - [✔] Debian testing (bookworm) - - [✔] Debian unstable (sid) - - [✔] Ubuntu jammy - - [✔] Ubuntu impish - - [✔] Ubuntu focal - - [✖] Ubuntu bionic - - [✖] Ubuntu xenial - - [✖] Ubuntu trusty - - [✖] CentOS 7 +- [✖] Debian oldstable (buster) +- [✔] Debian stable (bullseye) +- [✔] Debian testing (bookworm) +- [✔] Debian unstable (sid) +- [✔] Ubuntu jammy +- [✔] Ubuntu impish +- [✔] Ubuntu focal +- [✖] Ubuntu bionic +- [✖] Ubuntu xenial +- [✖] Ubuntu trusty +- [✖] CentOS 7 #. Download ``sunshine-appimage.zip`` and extract the contents to your home directory. #. Open terminal and run the following code. @@ -58,13 +56,11 @@ According to AppImageLint the AppImage can run on the following distros. ./sunshine.AppImage --install Start: - .. code-block:: bash ./sunshine.AppImage --install && ./sunshine.AppImage Uninstall: - .. code-block:: bash ./sunshine.AppImage --remove @@ -80,7 +76,6 @@ AUR Package makepkg -fi Uninstall: - .. code-block:: bash pacman -R sunshine @@ -99,7 +94,6 @@ Debian Package .. Tip:: You can double click the deb file to see details about the package and begin installation. Uninstall: - .. code-block:: bash sudo apt remove sunshine @@ -123,7 +117,6 @@ Flatpak Package flatpak install --user sunshine.flatpak Start: - X11 and NVFBC capture (X11 Only) .. code-block:: bash @@ -135,7 +128,6 @@ Start: sudo -i PULSE_SERVER=unix:$(pactl info | awk '/Server String/{print$3}') flatpak run dev.lizardbyte.sunshine Uninstall: - .. code-block:: bash flatpak uninstall --delete-data sunshine.flatpak @@ -161,7 +153,6 @@ RPM Package .. Tip:: You can double click the rpm file to see details about the package and begin installation. Uninstall: - .. code-block:: bash sudo dnf remove sunshine @@ -178,7 +169,6 @@ pkg #. Download the ``sunshine.pkg`` file and install it as normal. Uninstall: - .. code-block:: bash cd /etc/sunshine/assets @@ -194,7 +184,6 @@ Portfile sudo nano /opt/local/etc/macports/sources.conf Add this line, replacing your username, below the line that starts with ``rsync``. - ``file:///Users//ports`` ``Ctrl+x``, then ``Y`` to exit and save changes. @@ -212,7 +201,6 @@ Portfile #. The first time you start Sunshine, you will be asked to grant access to screen recording and your microphone. Uninstall: - .. code-block:: bash sudo port uninstall sunshine diff --git a/docs/source/about/third_party_packages.rst b/docs/source/about/third_party_packages.rst index 5ae51e8b..ad8979dc 100644 --- a/docs/source/about/third_party_packages.rst +++ b/docs/source/about/third_party_packages.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/LizardByte/Sunshine/tree/nightly/docs/source/about/third_party_packages.rst - Third Party Packages ==================== @@ -15,6 +13,12 @@ Chocolatey .. image:: https://img.shields.io/chocolatey/dt/sunshine?style=for-the-badge&logo=chocolatey :alt: Chocolatey +nixpkgs +------- +.. image:: https://img.shields.io/badge/dynamic/xml?color=orange&label=nixpkgs&style=for-the-badge&prefix=v&query=%2F%2Ftr%5B%40id%3D%27nix_unstable%27%5D%2Ftd%5B3%5D%2Fspan%2Fa&url=https%3A%2F%2Frepology.org%2Fproject%2Fsunshine%2Fversions&logo=nixos + :alt: nixpgs Version + :target: https://github.com/NixOS/nixpkgs/blob/master/pkgs/servers/sunshine/default.nix + Scoop ----- @@ -22,6 +26,12 @@ Scoop :alt: Scoop Version (extras bucket) :target: https://scoop.sh/#/apps?s=0&d=1&o=true&q=sunshine +Solus +----- +.. image:: https://img.shields.io/badge/dynamic/xml?color=orange&label=Solus&style=for-the-badge&prefix=v&query=%2F%2Ftr%5B%40id%3D%27solus%27%5D%2Ftd%5B3%5D%2Fspan%2Fa&url=https%3A%2F%2Frepology.org%2Fproject%2Fsunshine%2Fversions&logo=solus + :alt: Solus Version + :target: https://dev.getsol.us/source/sunshine + Winget ------ .. image:: https://img.shields.io/badge/dynamic/xml?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 diff --git a/docs/source/about/usage.rst b/docs/source/about/usage.rst index 0e3c87a4..81cfcdcd 100644 --- a/docs/source/about/usage.rst +++ b/docs/source/about/usage.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/LizardByte/Sunshine/tree/nightly/docs/source/about/usage.rst - Usage ===== #. See the `setup`_ section for your specific OS. @@ -12,6 +10,7 @@ Usage .. Tip:: If using the Linux AppImage, replace ``sunshine`` with ``./sunshine.AppImage`` #. Configure Sunshine in the web ui + The web ui is available on `https://localhost:47990 `_ by default. You may replace `localhost` with your internal ip address. @@ -20,14 +19,14 @@ Usage .. Caution:: If running for the first time, make sure to note the username and password Sunshine showed to you, since you cannot get back later! - Add games and applications. - This can be configured in the web ui. + **Add games and applications.** + This can be configured in the web ui. - .. Note:: Additionally, apps can be configured manually. `src_assets//config/apps.json` is an example of a - list of applications that are started just before running a stream. This is the directory within the GitHub - repo. + .. Note:: Additionally, apps can be configured manually. `src_assets//config/apps.json` is an example of a + list of applications that are started just before running a stream. This is the directory within the GitHub + repo. - .. Attention:: Application list is not fully supported on macOS + .. Attention:: Application list is not fully supported on macOS #. In Moonlight, you may need to add the PC manually. #. When Moonlight request you insert the correct pin on sunshine: @@ -46,7 +45,6 @@ The Sunshine user interface will be available on port 47990 by default. Arguments --------- To get a list of available arguments run the following: - .. code-block:: bash sunshine --help @@ -56,7 +54,7 @@ Setup Linux ^^^^^ -The deb, rpm, and AppImage packages handle these steps automatically. The flatpak does not, third party packages +The `deb`, `rpm`, and `AppImage` packages handle these steps automatically. The flatpak does not, third party packages also may not. Sunshine needs access to `uinput` to create mouse and gamepad events. @@ -73,9 +71,9 @@ Sunshine needs access to `uinput` to create mouse and gamepad events. sudo tee /etc/udev/rules.d/85-sunshine-input.rules #. Optionally, configure autostart service - - filename: ``~/.config/systemd/user/sunshine.service`` - - contents: + - filename: ``~/.config/systemd/user/sunshine.service`` + - contents: .. code-block:: [Unit] @@ -100,12 +98,12 @@ Sunshine needs access to `uinput` to create mouse and gamepad events. Flatpak flatpak run dev.lizardbyte.sunshine ✖ ======== ============================================== =============== - Start once + **Start once** .. code-block:: bash systemctl --user start sunshine - Start on boot + **Start on boot** .. code-block:: bash systemctl --user enable sunshine @@ -114,12 +112,12 @@ Sunshine needs access to `uinput` to create mouse and gamepad events. .. Note:: ``cap_sys_admin`` may as well be root, except you don't need to be root to run it. It is necessary to allow Sunshine to use KMS. - Enable + **Enable** .. code-block:: bash sudo setcap cap_sys_admin+p $(readlink -f $(which sunshine)) - Disable + **Disable** .. code-block:: bash sudo setcap -r $(readlink -f $(which sunshine)) @@ -141,8 +139,7 @@ select their sink as audio device in `sunshine.conf`. .. Caution:: Gamepads are not currently supported. Configure autostart service - - MacPorts + **MacPorts** .. code-block:: bash sudo port load Sunshine @@ -153,10 +150,10 @@ For gamepad support, install `ViGEmBus `_. Cross compilation is not @@ -11,7 +9,6 @@ Building Locally Clone ^^^^^ Ensure `git `_ is installed and run the following: - .. code-block:: bash git clone https://github.com/lizardbyte/sunshine.git --recurse-submodules diff --git a/docs/source/building/linux.rst b/docs/source/building/linux.rst index b2b4bfc7..009ef882 100644 --- a/docs/source/building/linux.rst +++ b/docs/source/building/linux.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/LizardByte/Sunshine/tree/nightly/docs/source/building/linux.rst - Linux ===== diff --git a/docs/source/building/macos.rst b/docs/source/building/macos.rst index b719c6ee..074eaf4e 100644 --- a/docs/source/building/macos.rst +++ b/docs/source/building/macos.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/LizardByte/Sunshine/tree/nightly/docs/source/building/macos.rst - macOS ===== @@ -30,14 +28,13 @@ Build ----- .. Attention:: Ensure you are in the build directory created during the clone step earlier before continuing. - .. code-block:: bash +.. code-block:: bash - cmake .. - make -j ${nproc} + cmake .. + make -j ${nproc} - cpack -G DragNDrop # optionally, create a macOS dmg package + cpack -G DragNDrop # optionally, create a macOS dmg package If cmake fails complaining to find Boost, try to set the path explicitly. - ``cmake -DBOOST_ROOT=[boost path] ..``, e.g., ``cmake -DBOOST_ROOT=/opt/local/libexec/boost/1.76 ..`` diff --git a/docs/source/building/windows.rst b/docs/source/building/windows.rst index 0c6dde57..43f84a22 100644 --- a/docs/source/building/windows.rst +++ b/docs/source/building/windows.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/LizardByte/Sunshine/tree/nightly/docs/source/building/windows.rst - Windows ======= @@ -10,18 +8,20 @@ following packages using: .. code-block:: bash - pacman -S mingw-w64-x86_64-binutils mingw-w64-x86_64-openssl mingw-w64-x86_64-cmake mingw-w64-x86_64-toolchain mingw-w64-x86_64-opus mingw-w64-x86_64-x265 mingw-w64-x86_64-boost git mingw-w64-x86_64-make cmake make gcc + pacman -S mingw-w64-x86_64-binutils mingw-w64-x86_64-openssl mingw-w64-x86_64-cmake \ + mingw-w64-x86_64-toolchain mingw-w64-x86_64-opus mingw-w64-x86_64-x265 mingw-w64-x86_64-boost \ + git mingw-w64-x86_64-make cmake make gcc Build ----- .. Attention:: Ensure you are in the build directory created during the clone step earlier before continuing. - .. code-block:: bash +.. code-block:: bash - cmake -G"Unix Makefiles" .. - cmake -G"MinGW Makefiles" .. # alternatively + cmake -G"Unix Makefiles" .. + cmake -G"MinGW Makefiles" .. # alternatively - mingw32-make + mingw32-make - cpack -G NSIS # optionally, create a windows installer - cpack -G ZIP # optionally, create a windows standalone package + cpack -G NSIS # optionally, create a windows installer + cpack -G ZIP # optionally, create a windows standalone package diff --git a/docs/source/conf.py b/docs/source/conf.py index 5ef4356c..65afdc61 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -73,23 +73,11 @@ html_logo = os.path.join(root_dir, 'sunshine.png') # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'sphinx_rtd_theme' +html_theme = 'furo' html_theme_options = { - # 'analytics_id': 'G-XXXXXXXXXX', # Provided by Google in your dashboard - # 'analytics_anonymize_ip': False, - 'logo_only': False, - 'display_version': False, - 'prev_next_buttons_location': 'bottom', - 'style_external_links': True, - 'vcs_pageview_mode': 'blob', - 'style_nav_header_background': '#151515', - # Toc options - 'collapse_navigation': True, - 'sticky_navigation': True, - 'navigation_depth': 4, - 'includehidden': True, - 'titles_only': False, + "top_of_page_button": "edit", + "source_edit_link": "https://github.com/lizardbyte/sunshine/tree/nightly/docs/source/{filename}", } # extension config options diff --git a/docs/source/contributing/contributing.rst b/docs/source/contributing/contributing.rst index e79fd4ea..217bda13 100644 --- a/docs/source/contributing/contributing.rst +++ b/docs/source/contributing/contributing.rst @@ -1,39 +1,5 @@ -:github_url: https://github.com/LizardByte/Sunshine/tree/nightly/docs/source/contributing/contributing.rst - Contributing ============ -.. Tip:: If this is your first time contributing to an open source project, it is a good idea to read - MDN's `Basic etiquette for open source projects`_ first. There are a few best practices to adopt that will help - ensure that you and the other project contributors feel valued and safe, and stay productive. - -#. Fork the repo on GitHub -#. Create a new branch for the feature you are adding or the issue you are fixing - - .. Tip:: Base the new branch off the `nightly` branch. It will make your life easier when you submit the PR! - -#. Make changes, push commits, etc. -#. Files should contain an empty line at the end. -#. Document your code! -#. Test your code! -#. When ready create a PR to this repo on the `nightly` branch. - - .. Hint:: If you accidentally make your PR against a different branch, a bot will comment letting you know it's on - the wrong branch. Don't worry. You can edit the PR to change the target branch. There is no reason to close the - PR! - - .. Note:: Draft PRs are also welcome as you work through issues. The benefit of creating a draft PR is that an - automated build can run in a github runner. - - .. Attention:: Do not expect partially complete PRs to be merged. These topics will be considered before merging. - - - Does the code follows the style guidelines of this project? - - .. Tip:: Look at examples of existing code in the project! - - - Is the code well commented? - - Were documentation blocks updated for new or modified components? - - .. Note:: Developers and maintainers will attempt to assist with challenging issues. - -.. _Basic etiquette for open source projects: https://developer.mozilla.org/en-US/docs/MDN/Contribute/Open_source_etiquette +Read our contribution guide in our organization level +`docs `_. diff --git a/docs/source/contributing/localization.rst b/docs/source/contributing/localization.rst index 8b04867f..dc3e26da 100644 --- a/docs/source/contributing/localization.rst +++ b/docs/source/contributing/localization.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/LizardByte/Sunshine/tree/nightly/docs/source/contributing/localization.rst - Localization ============ Sunshine is being localized into various languages. The default language is `en` (English) and is highlighted green. @@ -24,15 +22,15 @@ Only elements of the API are planned to be translated. .. Attention:: The rest API has not yet been implemented. -Translations Basics +**Translations Basics** - The brand names `LizardByte` and `Sunshine` should never be translated. - Other brand names should never be translated. Examples: - - AMD - - Nvidia + - AMD + - Nvidia -CrowdIn Integration +**CrowdIn Integration** How does it work? When a change is made to sunshine source code, a workflow generates new translation templates @@ -47,15 +45,14 @@ Extraction There should be minimal cases where strings need to be extracted from source code; however it may be necessary in some situations. For example if a system tray icon is added it should be localized as it is user interfacing. - - Wrap the string to be extracted in a function as shown. +- Wrap the string to be extracted in a function as shown. + .. code-block:: cpp - .. code-block:: cpp + #include + boost::locale::translate("Hello world!") - #include - boost::locale::translate("Hello world!") - - .. Tip:: More examples can be found in the documentation for - `boost locale `_. +.. Tip:: More examples can be found in the documentation for + `boost locale `_. .. Warning:: This is for information only. Contributors should never include manually updated template files, or manually compiled language files in Pull Requests. @@ -65,20 +62,20 @@ used by CrowdIn to generate language specific template files. The file is genera `.github/workflows/localize.yml` workflow and is run on any push event into the `nightly` branch. Jobs are only run if any of the following paths are modified. - .. code-block:: yaml +.. code-block:: yaml - - 'src/**' + - 'src/**' When testing locally it may be desirable to manually extract, initialize, update, and compile strings. Python is required for this, along with the python dependencies in the `./scripts/requirements.txt` file. Additionally, `xgettext `_ must be installed. - Extract, initialize, and update - .. code-block:: bash +**Extract, initialize, and update** + .. code-block:: bash - python ./scripts/_locale.py --extract --init --update + python ./scripts/_locale.py --extract --init --update - Compile - .. code-block:: bash +**Compile** + .. code-block:: bash - python ./scripts/_locale.py --compile + python ./scripts/_locale.py --compile diff --git a/docs/source/contributing/testing.rst b/docs/source/contributing/testing.rst index a08c6f9c..512aed1c 100644 --- a/docs/source/contributing/testing.rst +++ b/docs/source/contributing/testing.rst @@ -1,12 +1,10 @@ -:github_url: https://github.com/RetroArcher/RetroArcher/tree/nightly/docs/source/contributing/testing.rst - Testing ======= Clang Format ------------ Source code is tested against the `.clang-format` file for linting errors. The workflow file responsible for clang -format testing is `.github/workflows/clang.yml`. +format testing is `.github/workflows/cpp-clang-format-lint.yml`. Test clang-format locally. .. Todo:: This documentation needs to be improved. @@ -17,9 +15,9 @@ Test clang-format locally. Sphinx ------ -Sunshine uses `Sphinx `_ for documentation building. Sphinx is included -in the `./scripts/requirements.txt` file. Python is required to build sphinx docs. Installation and setup of python -will not be covered here. +Sunshine uses `Sphinx `_ for documentation building. Sphinx, along with other +required documentation depencies are included in the `./docs/requirements.txt` file. Python is required to build +sphinx docs. Installation and setup of python will not be covered here. The config file for Sphinx is `docs/source/conf.py`. This is already included in the repo and should not be modified. diff --git a/docs/source/troubleshooting/general.rst b/docs/source/troubleshooting/general.rst index 6c480720..010a52c8 100644 --- a/docs/source/troubleshooting/general.rst +++ b/docs/source/troubleshooting/general.rst @@ -1,22 +1,17 @@ -:github_url: https://github.com/LizardByte/Sunshine/tree/nightly/docs/source/troubleshooting/general.rst - General ======= If you forgot your credentials to the web UI, try this. - .. code-block:: bash sunshine -creds Can't access the web UI? - #. Check firefall rules. NvFBC, NvENC, or general issues with Nvidia graphics card. - - - Consume grade Nvidia cards are software limited to a specific number of encodes. See - `Video Encode and Decode GPU Support Matrix `_ - for more info. - - You can usually bypass the restriction with a driver patch. See Keylase's - `Linux `_ - or `Windows `_ patches for more guidance. + - Consumer grade Nvidia cards are software limited to a specific number of encodes. See + `Video Encode and Decode GPU Support Matrix `_ + for more info. + - You can usually bypass the restriction with a driver patch. See Keylase's + `Linux `_ + or `Windows `_ patches for more guidance. diff --git a/docs/source/troubleshooting/linux.rst b/docs/source/troubleshooting/linux.rst index a1c8b4da..0c8e3f97 100644 --- a/docs/source/troubleshooting/linux.rst +++ b/docs/source/troubleshooting/linux.rst @@ -1,9 +1,6 @@ -:github_url: https://github.com/LizardByte/Sunshine/tree/nightly/docs/source/troubleshooting/linux.rst - Linux ===== If screencasting fails with KMS, you may need to run the following to force unprivileged screencasting. - .. code-block:: bash sudo setcap -r $(readlink -f $(which sunshine)) diff --git a/docs/source/troubleshooting/macos.rst b/docs/source/troubleshooting/macos.rst index f6014eb7..70a0d60c 100644 --- a/docs/source/troubleshooting/macos.rst +++ b/docs/source/troubleshooting/macos.rst @@ -1,29 +1,10 @@ -:github_url: https://github.com/LizardByte/Sunshine/tree/nightly/docs/source/troubleshooting/macos.rst - macOS ===== If you get this error: - - ``Dynamic session lookup supported but failed: launchd did not provide a socket path, verify that - org.freedesktop.dbus-session.plist is loaded!`` + `Dynamic session lookup supported but failed: launchd did not provide a socket path, verify that + org.freedesktop.dbus-session.plist is loaded!` Try this. - .. code-block:: bash launchctl load -w /Library/LaunchAgents/org.freedesktop.dbus-session.plist - -Uninstall: - - - pkg - - .. code-block:: bash - - sudo chmod +x /opt/local/etc/sunshine/assets/uninstall_pkg.sh - sudo /opt/local/etc/sunshine/assets/uninstall_pkg.sh - - - Portfile - - .. code-block:: bash - - sudo port uninstall Sunshine diff --git a/docs/source/troubleshooting/windows.rst b/docs/source/troubleshooting/windows.rst index bb21589c..15053519 100644 --- a/docs/source/troubleshooting/windows.rst +++ b/docs/source/troubleshooting/windows.rst @@ -1,7 +1,4 @@ -:github_url: https://github.com/LizardByte/Sunshine/tree/nightly/docs/source/troubleshooting/windows.rst - Windows ======= No gamepad is detected. - #. Verify that you've installed `ViGEmBus `_. diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 84c26fe1..ab35a359 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -1,5 +1 @@ Babel==2.10.3 -m2r2==0.3.2 -Sphinx==5.3.0 -sphinx-copybutton==0.5.0 -sphinx-rtd-theme==1.0.0