Skip to content

Commit

Permalink
docs: various updates (#3366)
Browse files Browse the repository at this point in the history
Co-authored-by: BillyTom <953688+billytom@users.noreply.github.com>
  • Loading branch information
ReenigneArcher and BillyTom authored Dec 11, 2024
1 parent f73eb88 commit 0cc98f1
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 6 deletions.
7 changes: 4 additions & 3 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,14 @@ body:
- Linux - AUR (Third Party)
- Linux - deb
- Linux - Docker
- Linux - Fedora Copr
- Linux - flathub/flatpak
- Linux - Homebrew
- Linux - LizardByte/pacman-repo
- Linux - nixpkgs (Third Party)
- Linux - pkg.tar.zst
- Linux - Fedora Copr
- Linux - solus (Third Party)
- Linux - Unraid (Third Party)
- macOS - Homebrew
- macOS - Portfile
- Windows - Chocolatey (Third Party)
Expand All @@ -123,7 +124,7 @@ body:
- AMD
- Apple Silicon
- Intel
- Nvidia
- NVIDIA
- none (software encoding)
- n/a
validations:
Expand All @@ -149,7 +150,7 @@ body:
description: The capture method being used.
options:
- AVCaptureScreen (macOS)
- KMX (Linux)
- KMS (Linux)
- NvFBC (Linux)
- wlroots (Linux)
- X11 (Linux)
Expand Down
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,11 @@ the local server or any mobile device.
<td>AMD: VCE 1.0 or higher, see: <a href="https://github.com/obsproject/obs-amd-encoder/wiki/Hardware-Support">obs-amd hardware support</a></td>
</tr>
<tr>
<td>Intel: VAAPI-compatible, see: <a href="https://www.intel.com/content/www/us/en/developer/articles/technical/linuxmedia-vaapi.html">VAAPI hardware support</a></td>
<td>
Intel:<br>
&nbsp;&nbsp;Linux: VAAPI-compatible, see: <a href="https://www.intel.com/content/www/us/en/developer/articles/technical/linuxmedia-vaapi.html">VAAPI hardware support</a><br>
&nbsp;&nbsp;Windows: Skylake or newer with QuickSync encoding support
</td>
</tr>
<tr>
<td>Nvidia: NVENC enabled cards, see: <a href="https://developer.nvidia.com/video-encode-and-decode-gpu-support-matrix-new">nvenc support matrix</a></td>
Expand Down Expand Up @@ -90,7 +94,11 @@ the local server or any mobile device.
<td>AMD: Video Coding Engine 3.1 or higher</td>
</tr>
<tr>
<td>Intel: HD Graphics 510 or higher</td>
<td>
Intel:<br>
&nbsp;&nbsp;Linux: HD Graphics 510 or higher<br>
&nbsp;&nbsp;Windows: Skylake or newer with QuickSync encoding support
</td>
</tr>
<tr>
<td>Nvidia: GeForce GTX 1080 or higher</td>
Expand Down Expand Up @@ -125,7 +133,7 @@ the local server or any mobile device.
<td>Intel: HD Graphics 730 or higher</td>
</tr>
<tr>
<td>Nvidia: Nvidia: Pascal-based GPU (GTX 10-series) or higher</td>
<td>Nvidia: Pascal-based GPU (GTX 10-series) or higher</td>
</tr>
<tr>
<td rowspan="2">CPU</td>
Expand Down
6 changes: 6 additions & 0 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ If you forgot your credentials to the web UI, try this.
@tip{Don't forget to replace `{new-username}` and `{new-password}` with your new credentials.
Do not include the curly braces.}

### Unusual Mouse Behavior
If you experience unusual mouse behavior, try attaching a physical mouse to the Sunshine host.

### Web UI Access
Can't access the web UI?

Expand Down Expand Up @@ -190,6 +193,9 @@ has. You may get permission denied errors when attempting to launch a game or ap
You will need to modify the security permissions on your disk. Ensure that user/principal SYSTEM has full
permissions on the disk.

### Stuttering
If you experience stuttering using NVIDIA, try disabling `vsync:fast` in the NVIDIA Control Panel.

<div class="section_buttons">

| Previous | Next |
Expand Down
4 changes: 4 additions & 0 deletions gh-pages-template/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -654,6 +654,10 @@ <h2 class="fw-bolder mb-0">Download</h2>
<i class="fa-fw fab fa-docker"></i>
Docker
</a>
<a class="btn btn-outline-light me-3 mb-3" href="https://flathub.org/apps/dev.lizardbyte.app.Sunshine" target="_blank">
<i class="fa-fw fab fa-linux"></i>
Flathub
</a>
<a class="btn btn-outline-light me-3 mb-3" href="https://github.com/LizardByte/homebrew-homebrew" target="_blank">
<i class="fa-fw fas fa-beer-mug-empty"></i>
Homebrew
Expand Down

0 comments on commit 0cc98f1

Please sign in to comment.