Skip to content

Commit 9c5eb51

Browse files
qiin2333qiin2333
qiin2333
and
qiin2333
authored
修改Readme (#109)
* build(deps): update * update deps * refactor(installer/windows): move nsis code (LizardByte#3915) * Merge branch 'master' into dev * fix: gh action build * fix: 打包丢失vdd驱动的问题 * chore: update readme --------- Co-authored-by: qiin2333 <[email protected]>
1 parent 38351b2 commit 9c5eb51

File tree

2 files changed

+78
-82
lines changed

2 files changed

+78
-82
lines changed

‎README.md‎

Lines changed: 76 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,74 @@
1-
# Overview
1+
# Sunshine 基地版
22

3-
[![GitHub stars](https://img.shields.io/github/stars/lizardbyte/sunshine.svg?logo=github&style=for-the-badge)](https://github.com/LizardByte/Sunshine)
4-
[![GitHub Releases](https://img.shields.io/github/downloads/lizardbyte/sunshine/total.svg?style=for-the-badge&logo=github)](https://github.com/LizardByte/Sunshine/releases/latest)
5-
[![Docker](https://img.shields.io/docker/pulls/lizardbyte/sunshine.svg?style=for-the-badge&logo=docker)](https://hub.docker.com/r/lizardbyte/sunshine)
6-
[![GHCR](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fipitio.github.io%2Fbackage%2FLizardByte%2FSunshine%2Fsunshine.json&query=%24.downloads&label=ghcr%20pulls&style=for-the-badge&logo=github)](https://github.com/LizardByte/Sunshine/pkgs/container/sunshine)
7-
[![Winget Version](https://img.shields.io/badge/dynamic/json.svg?color=orange&label=Winget&style=for-the-badge&prefix=v&query=$[-1:].name&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fmicrosoft%2Fwinget-pkgs%2Fcontents%2Fmanifests%2Fl%2FLizardByte%2FSunshine&logo=microsoft)](https://github.com/microsoft/winget-pkgs/tree/master/manifests/l/LizardByte/Sunshine)
8-
[![GitHub Workflow Status (CI)](https://img.shields.io/github/actions/workflow/status/lizardbyte/sunshine/CI.yml.svg?branch=master&label=CI%20build&logo=github&style=for-the-badge)](https://github.com/LizardByte/Sunshine/actions/workflows/CI.yml?query=branch%3Amaster)
9-
[![GitHub Workflow Status (localize)](https://img.shields.io/github/actions/workflow/status/lizardbyte/sunshine/localize.yml.svg?branch=master&label=localize%20build&logo=github&style=for-the-badge)](https://github.com/LizardByte/Sunshine/actions/workflows/localize.yml?query=branch%3Amaster)
10-
[![Read the Docs](https://img.shields.io/readthedocs/sunshinestream.svg?label=Docs&style=for-the-badge&logo=readthedocs)](http://sunshinestream.readthedocs.io)
11-
[![Codecov](https://img.shields.io/codecov/c/gh/LizardByte/Sunshine?token=SMGXQ5NVMJ&style=for-the-badge&logo=codecov&label=codecov)](https://codecov.io/gh/LizardByte/Sunshine)
3+
基于LizardByte/Sunshine的分支，提供完整的文档支持 [Read the Docs](https://docs.qq.com/aio/DSGdQc3htbFJjSFdO?p=YTpMj5JNNdB5hEKJhhqlSB)。
124

13-
LizardByte has the full documentation hosted on [Read the Docs](https://sunshinestream.readthedocs.io).
5+
## 项目简介
146

15-
## About
7+
**Sunshine-Foundation** is a self-hosted game stream host for Moonlight，本分支版本在原始Sunshine基础上进行了重大改进，专注于提高各种串流终端设备与windows主机接入的游戏串流体验：
168

17-
Sunshine is a self-hosted game stream host for Moonlight.
18-
Offering low latency, cloud gaming server capabilities with support for AMD, Intel, and Nvidia GPUs for hardware
19-
encoding. Software encoding is also available. You can connect to Sunshine from any Moonlight client on a variety of
20-
devices. A web UI is provided to allow configuration, and client pairing, from your favorite web browser. Pair from
21-
the local server or any mobile device.
9+
### 🌟 核心特性
10+
- **HDR友好支持** - 经过优化的HDR处理管线，提供真正的HDR游戏流媒体体验
11+
- **集成虚拟显示器** - 内置虚拟显示器管理，无需额外软件即可创建和管理虚拟显示器
12+
- **高级控制面板** - 直观的Web控制界面，提供实时监控和配置管理
13+
- **低延迟传输** - 结合最新硬件能力优化的编码处理
14+
- **智能配对** - 智能管理配对设备的对应配置文件
2215

23-
## System Requirements
16+
### 🖥️ 虚拟显示器集成
17+
- 动态虚拟显示器创建和销毁
18+
- 自定义分辨率和刷新率支持
19+
- 多显示器配置管理
20+
- 无需重启的实时配置更改
2421

25-
@warning{These tables are a work in progress. Do not purchase hardware based on this information.}
22+
23+
## 推荐的Moonlight客户端
24+
25+
建议使用以下经过优化的Moonlight客户端获得最佳的串流体验：
26+
27+
### 📱 Android客户端
28+
[![威力加强版 Moonlight-Android](https://img.shields.io/badge/威力加强版-Moonlight--Android-green?style=for-the-badge&logo=android)](https://github.com/qiin2333/moonlight-android/releases/tag/shortcut)
29+
[![王冠版 Moonlight-Android](https://img.shields.io/badge/王冠版-Moonlight--Android-blue?style=for-the-badge&logo=android)](https://github.com/WACrown/moonlight-android)
30+
31+
### 🖥️ PC客户端
32+
[![Moonlight-PC](https://img.shields.io/badge/Moonlight-PC-red?style=for-the-badge&logo=windows)](https://github.com/qiin2333/moonlight-qt)
33+
34+
### 📱 iOS客户端
35+
[![真砖家版 Moonlight-iOS](https://img.shields.io/badge/真砖家版-Moonlight--iOS-lightgrey?style=for-the-badge&logo=apple)](https://github.com/TrueZhuangJia/moonlight-ios-NativeMultiTouchPassthrough)
36+
37+
38+
## 系统要求
39+
40+
@warning{这些表格正在持续更新中。请不要仅基于此信息购买硬件。}
2641

2742
<table>
28-
<caption id="minimum_requirements">Minimum Requirements</caption>
43+
<caption id="minimum_requirements">最低配置要求</caption>
2944
<tr>
30-
<th>Component</th>
31-
<th>Requirement</th>
45+
<th>组件</th>
46+
<th>要求</th>
3247
</tr>
3348
<tr>
3449
<td rowspan="3">GPU</td>
35-
<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>
50+
<td>AMD: VCE 1.0或更高版本，参见: <a href="https://github.com/obsproject/obs-amd-encoder/wiki/Hardware-Support">obs-amd硬件支持</a></td>
3651
</tr>
3752
<tr>
38-
<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>
53+
<td>Intel: VAAPI兼容，参见: <a href="https://www.intel.com/content/www/us/en/developer/articles/technical/linuxmedia-vaapi.html">VAAPI硬件支持</a></td>
3954
</tr>
4055
<tr>
41-
<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>
56+
<td>Nvidia: 支持NVENC的显卡，参见: <a href="https://developer.nvidia.com/video-encode-and-decode-gpu-support-matrix-new">nvenc支持矩阵</a></td>
4257
</tr>
4358
<tr>
4459
<td rowspan="2">CPU</td>
45-
<td>AMD: Ryzen 3 or higher</td>
60+
<td>AMD: Ryzen 3或更高</td>
4661
</tr>
4762
<tr>
48-
<td>Intel: Core i3 or higher</td>
63+
<td>Intel: Core i3或更高</td>
4964
</tr>
5065
<tr>
5166
<td>RAM</td>
52-
<td>4GB or more</td>
67+
<td>4GB或更多</td>
5368
</tr>
5469
<tr>
55-
<td rowspan="5">OS</td>
56-
<td>Windows: 10+ (Windows Server does not support virtual gamepads)</td>
70+
<td rowspan="5">操作系统</td>
71+
<td>Windows: 10+ (Windows Server不支持虚拟游戏手柄)</td>
5772
</tr>
5873
<tr>
5974
<td>macOS: 12+</td>
@@ -68,86 +83,65 @@ the local server or any mobile device.
6883
<td>Linux/Ubuntu: 22.04+ (jammy)</td>
6984
</tr>
7085
<tr>
71-
<td rowspan="2">Network</td>
72-
<td>Host: 5GHz, 802.11ac</td>
86+
<td rowspan="2">网络</td>
87+
<td>主机: 5GHz, 802.11ac</td>
7388
</tr>
7489
<tr>
75-
<td>Client: 5GHz, 802.11ac</td>
90+
<td>客户端: 5GHz, 802.11ac</td>
7691
</tr>
7792
</table>
7893

7994
<table>
80-
<caption id="4k_suggestions">4k Suggestions</caption>
95+
<caption id="4k_suggestions">4K推荐配置</caption>
8196
<tr>
82-
<th>Component</th>
83-
<th>Requirement</th>
97+
<th>组件</th>
98+
<th>要求</th>
8499
</tr>
85100
<tr>
86101
<td rowspan="3">GPU</td>
87-
<td>AMD: Video Coding Engine 3.1 or higher</td>
102+
<td>AMD: Video Coding Engine 3.1或更高</td>
88103
</tr>
89104
<tr>
90-
<td>Intel: HD Graphics 510 or higher</td>
105+
<td>Intel: HD Graphics 510或更高</td>
91106
</tr>
92107
<tr>
93-
<td>Nvidia: GeForce GTX 1080 or higher</td>
108+
<td>Nvidia: GeForce GTX 1080或更高</td>
94109
</tr>
95110
<tr>
96111
<td rowspan="2">CPU</td>
97-
<td>AMD: Ryzen 5 or higher</td>
112+
<td>AMD: Ryzen 5或更高</td>
98113
</tr>
99114
<tr>
100-
<td>Intel: Core i5 or higher</td>
115+
<td>Intel: Core i5或更高</td>
101116
</tr>
102117
<tr>
103-
<td rowspan="2">Network</td>
104-
<td>Host: CAT5e ethernet or better</td>
118+
<td rowspan="2">网络</td>
119+
<td>主机: CAT5e以太网或更好</td>
105120
</tr>
106121
<tr>
107-
<td>Client: CAT5e ethernet or better</td>
122+
<td>客户端: CAT5e以太网或更好</td>
108123
</tr>
109124
</table>
110125

111-
<table>
112-
<caption id="hdr_suggestions">HDR Suggestions</caption>
113-
<tr>
114-
<th>Component</th>
115-
<th>Requirement</th>
116-
</tr>
117-
<tr>
118-
<td rowspan="3">GPU</td>
119-
<td>AMD: Video Coding Engine 3.4 or higher</td>
120-
</tr>
121-
<tr>
122-
<td>Intel: HD Graphics 730 or higher</td>
123-
</tr>
124-
<tr>
125-
<td>Nvidia: Nvidia: Pascal-based GPU (GTX 10-series) or higher</td>
126-
</tr>
127-
<tr>
128-
<td rowspan="2">CPU</td>
129-
<td>AMD: Ryzen 5 or higher</td>
130-
</tr>
131-
<tr>
132-
<td>Intel: Core i5 or higher</td>
133-
</tr>
134-
<tr>
135-
<td rowspan="2">Network</td>
136-
<td>Host: CAT5e ethernet or better</td>
137-
</tr>
138-
<tr>
139-
<td>Client: CAT5e ethernet or better</td>
140-
</tr>
141-
</table>
126+
## 技术支持
127+
128+
遇到问题时的解决路径：
129+
1. 查看 [使用文档](https://docs.qq.com/aio/DSGdQc3htbFJjSFdO?p=YTpMj5JNNdB5hEKJhhqlSB)
130+
2. 参考官方 [LizardByte文档](https://lizardbyte.readthedocs.io/en/latest/about/support.html)
131+
3. 加入QQ交流群获取帮助
132+
133+
**问题反馈标签：**
134+
- `hdr-support` - HDR相关问题
135+
- `virtual-display` - 虚拟显示器问题
136+
- `config-help` - 配置相关问题
142137

143-
## Support
138+
## 加入社区
144139

145-
Our support methods are listed in our [LizardByte Docs](https://lizardbyte.readthedocs.io/en/latest/about/support.html).
140+
我们欢迎大家参与讨论和贡献代码！
141+
[![加入QQ群](http://pub.idqqimg.com/wpa/images/group.png '加入QQ群')](https://qm.qq.com/cgi-bin/qm/qr?k=WC2PSZ3Q6Hk6j8U_DG9S7522GPtItk0m&jump_from=webapi&authKey=zVDLFrS83s/0Xg3hMbkMeAqI7xoHXaM3sxZIF/u9JW7qO/D8xd0npytVBC2lOS+z)
146142

147-
<div class="section_buttons">
143+
---
148144

149-
| Previous | Next |
150-
|:---------|------------------------------------:|
151-
| | [Overview](docs/getting_started.md) |
145+
**Sunshine基地版 - 让游戏串流更简单**
152146

153-
</div>
147+
[![Powered by DartNode](https://dartnode.com/branding/DN-Open-Source-sm.png)](https://dartnode.com "Powered by DartNode - Free VPS for Open Source")

‎cmake/packaging/windows_nsis.cmake‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ SET(CPACK_NSIS_EXTRA_INSTALL_COMMANDS
1717
nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\update-path.bat\\\" add'
1818
nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\migrate-config.bat\\\"'
1919
nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\add-firewall-rule.bat\\\"'
20+
nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\install-vdd.bat\\\"'
2021
nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\install-gamepad.bat\\\"'
2122
nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\install-service.bat\\\"'
2223
nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\autostart-service.bat\\\"'
@@ -30,6 +31,7 @@ set(CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS
3031
ExecShell 'startunpin' '\\\"$DESKTOP\\\\SunshineGUI.lnk\\\"'
3132
nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\delete-firewall-rule.bat\\\"'
3233
nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\uninstall-service.bat\\\"'
34+
nsExec::ExecToLog '\\\"$INSTDIR\\\\scripts\\\\uninstall-vdd.bat\\\"'
3335
nsExec::ExecToLog '\\\"$INSTDIR\\\\${CMAKE_PROJECT_NAME}.exe\\\" --restore-nvprefs-undo'
3436
MessageBox MB_YESNO|MB_ICONQUESTION \
3537
'Do you want to remove Virtual Gamepad?' \

0 commit comments

Comments
 (0)