From 0cc98f113e69a3764d3a413af022e5e2fe1aef31 Mon Sep 17 00:00:00 2001
From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com>
Date: Wed, 11 Dec 2024 13:11:54 -0500
Subject: [PATCH] docs: various updates (#3366)
Co-authored-by: BillyTom <953688+billytom@users.noreply.github.com>
---
.github/ISSUE_TEMPLATE/bug-report.yml | 7 ++++---
README.md | 14 +++++++++++---
docs/troubleshooting.md | 6 ++++++
gh-pages-template/index.html | 4 ++++
4 files changed, 25 insertions(+), 6 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
index 6e0a87ff..6356add1 100644
--- a/.github/ISSUE_TEMPLATE/bug-report.yml
+++ b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -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)
@@ -123,7 +124,7 @@ body:
- AMD
- Apple Silicon
- Intel
- - Nvidia
+ - NVIDIA
- none (software encoding)
- n/a
validations:
@@ -149,7 +150,7 @@ body:
description: The capture method being used.
options:
- AVCaptureScreen (macOS)
- - KMX (Linux)
+ - KMS (Linux)
- NvFBC (Linux)
- wlroots (Linux)
- X11 (Linux)
diff --git a/README.md b/README.md
index be73eb71..72e074b9 100644
--- a/README.md
+++ b/README.md
@@ -38,7 +38,11 @@ the local server or any mobile device.
| AMD: VCE 1.0 or higher, see: obs-amd hardware support |
- | Intel: VAAPI-compatible, see: VAAPI hardware support |
+
+ Intel:
+ Linux: VAAPI-compatible, see: VAAPI hardware support
+ Windows: Skylake or newer with QuickSync encoding support
+ |
| Nvidia: NVENC enabled cards, see: nvenc support matrix |
@@ -90,7 +94,11 @@ the local server or any mobile device.
AMD: Video Coding Engine 3.1 or higher |
- | Intel: HD Graphics 510 or higher |
+
+ Intel:
+ Linux: HD Graphics 510 or higher
+ Windows: Skylake or newer with QuickSync encoding support
+ |
| Nvidia: GeForce GTX 1080 or higher |
@@ -125,7 +133,7 @@ the local server or any mobile device.
Intel: HD Graphics 730 or higher |
- | Nvidia: Nvidia: Pascal-based GPU (GTX 10-series) or higher |
+ Nvidia: Pascal-based GPU (GTX 10-series) or higher |
| CPU |
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
index 7260ec6c..1ba8d6e0 100644
--- a/docs/troubleshooting.md
+++ b/docs/troubleshooting.md
@@ -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?
@@ -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.
+