mirror of
https://github.com/LizardByte/Sunshine.git
synced 2026-02-04 07:55:28 +00:00
build: add freebsd support (#4049)
This commit is contained in:
179
README.md
179
README.md
@ -32,6 +32,166 @@ LizardByte has the full documentation hosted on [Read the Docs](https://docs.liz
|
||||
* [Stable Docs](https://docs.lizardbyte.dev/projects/sunshine/latest/)
|
||||
* [Beta Docs](https://docs.lizardbyte.dev/projects/sunshine/master/)
|
||||
|
||||
## 🎮 Feature Compatibility
|
||||
|
||||
<table>
|
||||
<caption id="feature_compatibility">Platform Feature Support</caption>
|
||||
<tr>
|
||||
<th>Feature</th>
|
||||
<th>FreeBSD</th>
|
||||
<th>Linux</th>
|
||||
<th>macOS</th>
|
||||
<th>Windows</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="5" align="center"><b>Gamepad Emulation</b><br>
|
||||
What type of gamepads can be emulated on the host.<br>
|
||||
Clients may support other gamepads.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>DualShock / DS4 (PlayStation 4)</td>
|
||||
<td>➖</td>
|
||||
<td>➖</td>
|
||||
<td>❌</td>
|
||||
<td>✅</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>DualSense / DS5 (PlayStation 5)</td>
|
||||
<td>❌</td>
|
||||
<td>✅</td>
|
||||
<td>❌</td>
|
||||
<td>❌</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Nintendo Switch Pro</td>
|
||||
<td>✅</td>
|
||||
<td>✅</td>
|
||||
<td>❌</td>
|
||||
<td>❌</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Xbox 360</td>
|
||||
<td>➖</td>
|
||||
<td>➖</td>
|
||||
<td>❌</td>
|
||||
<td>✅</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Xbox One/Series</td>
|
||||
<td>✅</td>
|
||||
<td>✅</td>
|
||||
<td>❌</td>
|
||||
<td>❌</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="5" align="center"><b>GPU Encoding</b></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>AMD/AMF</td>
|
||||
<td>✅ (vaapi)</td>
|
||||
<td>✅ (vaapi)</td>
|
||||
<td>✅ (Video Toolbox)</td>
|
||||
<td>✅</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Intel QuickSync</td>
|
||||
<td>✅ (vaapi)</td>
|
||||
<td>✅ (vaapi)</td>
|
||||
<td>✅ (Video Toolbox)</td>
|
||||
<td>✅</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>NVIDIA NVENC</td>
|
||||
<td>✅ (vaapi)</td>
|
||||
<td>✅ (vaapi)</td>
|
||||
<td>✅ (Video Toolbox)</td>
|
||||
<td>✅</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="5" align="center"><b>Screen Capture</b></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>DXGI</td>
|
||||
<td>➖</td>
|
||||
<td>➖</td>
|
||||
<td>➖</td>
|
||||
<td>✅</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>KMS</td>
|
||||
<td>❌</td>
|
||||
<td>✅</td>
|
||||
<td>➖</td>
|
||||
<td>➖</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>NVIDIA NvFBC</td>
|
||||
<td>➖</td>
|
||||
<td>🟡</td>
|
||||
<td>➖</td>
|
||||
<td>➖</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> ↳ X11 Support</td>
|
||||
<td>➖</td>
|
||||
<td>✅</td>
|
||||
<td>➖</td>
|
||||
<td>➖</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> ↳ Wayland Support</td>
|
||||
<td>➖</td>
|
||||
<td>❌</td>
|
||||
<td>➖</td>
|
||||
<td>➖</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Video Toolbox</td>
|
||||
<td>➖</td>
|
||||
<td>➖</td>
|
||||
<td>✅</td>
|
||||
<td>➖</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Wayland</td>
|
||||
<td>✅</td>
|
||||
<td>✅</td>
|
||||
<td>➖</td>
|
||||
<td>➖</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Windows.Graphics.Capture</td>
|
||||
<td>➖</td>
|
||||
<td>➖</td>
|
||||
<td>➖</td>
|
||||
<td>🟡</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> ↳ Portable</td>
|
||||
<td>➖</td>
|
||||
<td>➖</td>
|
||||
<td>➖</td>
|
||||
<td>✅</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> ↳ Service</td>
|
||||
<td>➖</td>
|
||||
<td>➖</td>
|
||||
<td>➖</td>
|
||||
<td>❌</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>X11</td>
|
||||
<td>✅</td>
|
||||
<td>✅</td>
|
||||
<td>➖</td>
|
||||
<td>➖</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
**Legend:** ✅ Supported | 🟡 Partial Support | ❌ Not Yet Supported | ➖ Not Applicable
|
||||
|
||||
## 🖥️ System Requirements
|
||||
|
||||
> [!WARNING]
|
||||
@ -50,7 +210,7 @@ LizardByte has the full documentation hosted on [Read the Docs](https://docs.liz
|
||||
<tr>
|
||||
<td>
|
||||
Intel:<br>
|
||||
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>
|
||||
FreeBSD/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>
|
||||
Windows: Skylake or newer with QuickSync encoding support
|
||||
</td>
|
||||
</tr>
|
||||
@ -69,11 +229,8 @@ LizardByte has the full documentation hosted on [Read the Docs](https://docs.liz
|
||||
<td>4GB or more</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan="5">OS</td>
|
||||
<td>Windows: 10+ (Windows Server does not support virtual gamepads)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>macOS: 14+</td>
|
||||
<td rowspan="6">OS</td>
|
||||
<td>FreeBSD: 14.3+</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Linux/Debian: 13+ (trixie)</td>
|
||||
@ -84,6 +241,12 @@ LizardByte has the full documentation hosted on [Read the Docs](https://docs.liz
|
||||
<tr>
|
||||
<td>Linux/Ubuntu: 22.04+ (jammy)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>macOS: 14+</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Windows: 11+ (Windows Server does not support virtual gamepads)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan="2">Network</td>
|
||||
<td>Host: 5GHz, 802.11ac</td>
|
||||
@ -106,14 +269,14 @@ LizardByte has the full documentation hosted on [Read the Docs](https://docs.liz
|
||||
<tr>
|
||||
<td>
|
||||
Intel:<br>
|
||||
Linux: HD Graphics 510 or higher<br>
|
||||
FreeBSD/Linux: HD Graphics 510 or higher<br>
|
||||
Windows: Skylake or newer with QuickSync encoding support
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
Nvidia:<br>
|
||||
Linux: GeForce RTX 2000 series or higher<br>
|
||||
FreeBSD/Linux: GeForce RTX 2000 series or higher<br>
|
||||
Windows: Geforce GTX 1080 or higher
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
Reference in New Issue
Block a user