Skip to content

Commit 0ae6e4e

Browse files
rbqvqReenigneArcher
andcommitted
docs(windows): add documents for arm64
Add windows arm64 documents. Signed-off-by: Coia Prant <coiaprant@gmail.com> Co-authored-by: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com>
1 parent 8227eb7 commit 0ae6e4e

File tree

2 files changed

+54
-21
lines changed

2 files changed

+54
-21
lines changed

docs/building.md

Lines changed: 35 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -126,33 +126,52 @@ sudo port install "${dependencies[@]}"
126126
```
127127

128128
#### Windows
129-
First you need to install [MSYS2](https://www.msys2.org), then startup "MSYS2 UCRT64" and execute the following
130-
commands.
129+
130+
@warning{Cross-compilation is not supported on Windows. You must build on the target architecture.}
131+
132+
First, you need to install [MSYS2](https://www.msys2.org).
133+
134+
For AMD64 startup "MSYS2 UCRT64" (or for ARM64 startup "MSYS2 CLANGARM64") then execute the following commands.
131135

132136
##### Update all packages
133137
```bash
134138
pacman -Syu
135139
```
136140

141+
##### Set toolchain variable
142+
For UCRT64:
143+
```bash
144+
export TOOLCHAIN="ucrt-x86_64"
145+
```
146+
147+
For CLANGARM64:
148+
```bash
149+
export TOOLCHAIN="clang-aarch64"
150+
```
151+
137152
##### Install dependencies
138153
```bash
139154
dependencies=(
140155
"git"
141-
"mingw-w64-ucrt-x86_64-boost" # Optional
142-
"mingw-w64-ucrt-x86_64-cmake"
143-
"mingw-w64-ucrt-x86_64-cppwinrt"
144-
"mingw-w64-ucrt-x86_64-curl-winssl"
145-
"mingw-w64-ucrt-x86_64-doxygen" # Optional, for docs... better to install official Doxygen
146-
"mingw-w64-ucrt-x86_64-graphviz" # Optional, for docs
147-
"mingw-w64-ucrt-x86_64-MinHook"
148-
"mingw-w64-ucrt-x86_64-miniupnpc"
149-
"mingw-w64-ucrt-x86_64-nodejs"
150-
"mingw-w64-ucrt-x86_64-nsis"
151-
"mingw-w64-ucrt-x86_64-onevpl"
152-
"mingw-w64-ucrt-x86_64-openssl"
153-
"mingw-w64-ucrt-x86_64-opus"
154-
"mingw-w64-ucrt-x86_64-toolchain"
156+
"mingw-w64-${TOOLCHAIN}-boost" # Optional
157+
"mingw-w64-${TOOLCHAIN}-cmake"
158+
"mingw-w64-${TOOLCHAIN}-cppwinrt"
159+
"mingw-w64-${TOOLCHAIN}-curl-winssl"
160+
"mingw-w64-${TOOLCHAIN}-doxygen" # Optional, for docs... better to install official Doxygen
161+
"mingw-w64-${TOOLCHAIN}-graphviz" # Optional, for docs
162+
"mingw-w64-${TOOLCHAIN}-miniupnpc"
163+
"mingw-w64-${TOOLCHAIN}-nodejs"
164+
"mingw-w64-${TOOLCHAIN}-onevpl"
165+
"mingw-w64-${TOOLCHAIN}-openssl"
166+
"mingw-w64-${TOOLCHAIN}-opus"
167+
"mingw-w64-${TOOLCHAIN}-toolchain"
155168
)
169+
if [[ "${MSYSTEM}" == "UCRT64" ]]; then
170+
dependencies+=(
171+
"mingw-w64-${TOOLCHAIN}-MinHook"
172+
"mingw-w64-${TOOLCHAIN}-nsis"
173+
)
174+
fi
156175
pacman -S "${dependencies[@]}"
157176
```
158177

docs/getting_started.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -329,15 +329,24 @@ brew uninstall sunshine
329329
330330
### Windows
331331

332+
> [!NOTE]
333+
> Sunshine supports ARM64 on Windows; however, this should be considered experimental. This version does not properly
334+
> support GPU scheduling and any hardware acceleration.
335+
332336
#### Installer (recommended)
333337

334338
> [!CAUTION]
335339
> The msi installer is preferred moving forward. Before using a different type of installer, you should manually
336340
> uninstall the previous installation.
337341
338-
1. Download and install
339-
[Sunshine-Windows-AMD64-installer.msi](https://github.com/LizardByte/Sunshine/releases/latest/download/Sunshine-Windows-AMD64-installer.msi)
340-
[Sunshine-Windows-AMD64-installer.exe](https://github.com/LizardByte/Sunshine/releases/latest/download/Sunshine-Windows-AMD64-installer.exe)
342+
1. Download and install based on your architecture:
343+
344+
| Architecture | Installer |
345+
|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
346+
| AMD64/x64 (Intel/AMD) | [Sunshine-Windows-AMD64-installer.msi](https://github.com/LizardByte/Sunshine/releases/latest/download/Sunshine-Windows-AMD64-installer.msi) |
347+
| AMD64/x64 (Intel/AMD) | [Sunshine-Windows-AMD64-installer.exe](https://github.com/LizardByte/Sunshine/releases/latest/download/Sunshine-Windows-AMD64-installer.exe) |
348+
| ARM64 | [Sunshine-Windows-ARM64-installer.msi](https://github.com/LizardByte/Sunshine/releases/latest/download/Sunshine-Windows-ARM64-installer.msi) |
349+
| ARM64 | [Sunshine-Windows-ARM64-installer.exe](https://github.com/LizardByte/Sunshine/releases/latest/download/Sunshine-Windows-ARM64-installer.exe) |
341350

342351
> [!TIP]
343352
> Installer logs can be found in the following locations.<br>
@@ -359,8 +368,13 @@ overflow menu. Different versions of Windows may provide slightly different step
359368
> By using this package instead of the installer, performance will be reduced. This package is not
360369
> recommended for most users. No support will be provided!
361370
362-
1. Download and extract
363-
[Sunshine-Windows-AMD64-portable.zip](https://github.com/LizardByte/Sunshine/releases/latest/download/Sunshine-Windows-AMD64-portable.zip)
371+
1. Download and extract based on your architecture:
372+
373+
| Architecture | Installer |
374+
|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
375+
| AMD64/x64 (Intel/AMD) | [Sunshine-Windows-AMD64-portable.zip](https://github.com/LizardByte/Sunshine/releases/latest/download/Sunshine-Windows-AMD64-portable.zip) |
376+
| ARM64 | [Sunshine-Windows-ARM64-portable.zip](https://github.com/LizardByte/Sunshine/releases/latest/download/Sunshine-Windows-ARM64-portable.zip) |
377+
364378
2. Open command prompt as administrator
365379
3. Firewall rules
366380

0 commit comments

Comments
 (0)