Skip to content

Commit c2fac3c

Browse files
committed
Update Readme
1 parent c576061 commit c2fac3c

File tree

1 file changed

+25
-63
lines changed

1 file changed

+25
-63
lines changed

README.md

+25-63
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,24 @@
1-
# Moonlight PC
1+
<p align="center">
2+
<h1 align="center">Moonlight-Tailored-for-GPU-PV</h1>
3+
<p align="center">
4+
No connection timeouts anymore!
5+
</p>
6+
</p>
27

3-
[Moonlight PC](https://moonlight-stream.org) is an open source PC client for NVIDIA GameStream and [Sunshine](https://github.com/LizardByte/Sunshine).
8+
<br>
49

5-
Moonlight also has mobile versions for [Android](https://github.com/moonlight-stream/moonlight-android) and [iOS](https://github.com/moonlight-stream/moonlight-ios).
610

7-
You can follow development on our [Discord server](https://moonlight-stream.org/discord) and help translate Moonlight into your language on [Weblate](https://hosted.weblate.org/projects/moonlight/moonlight-qt/).
11+
## ℹ About
812

9-
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/glj5cxqwy2w3bglv/branch/master?svg=true)](https://ci.appveyor.com/project/cgutman/moonlight-qt/branch/master)
10-
[![Downloads](https://img.shields.io/github/downloads/moonlight-stream/moonlight-qt/total)](https://github.com/moonlight-stream/moonlight-qt/releases)
11-
[![Translation Status](https://hosted.weblate.org/widgets/moonlight/-/moonlight-qt/svg-badge.svg)](https://hosted.weblate.org/projects/moonlight/moonlight-qt/)
13+
>[Moonlight PC](https://moonlight-stream.org) is an open source PC client for NVIDIA GameStream and [Sunshine](https://github.com/LizardByte/Sunshine).
14+
15+
>Moonlight also has mobile versions for [Android](https://github.com/moonlight-stream/moonlight-android) and [iOS](https://github.com/moonlight-stream/moonlight-ios).
16+
17+
>You can follow development on our [Discord server](https://moonlight-stream.org/discord) and help translate Moonlight into your language on [Weblate](https://hosted.weblate.org/projects/moonlight/moonlight-qt/).
18+
19+
This project fixes connection timeouts when connecting via Moonlight to a machine with GPU-Paravirtualization enabled. This is the only change in comparison to the original project.
20+
21+
<br>
1222

1323
## Features
1424
- Hardware accelerated video decoding on Windows, Mac, and Linux
@@ -20,69 +30,21 @@ You can follow development on our [Discord server](https://moonlight-stream.org/
2030
- Support for both pointer capture (for games) and direct mouse control (for remote desktop)
2131
- Support for passing system-wide keyboard shortcuts like Alt+Tab to the host
2232

23-
## Downloads
24-
- [Windows, macOS, and Steam Link](https://github.com/moonlight-stream/moonlight-qt/releases)
25-
- [Snap (for Ubuntu-based Linux distros)](https://snapcraft.io/moonlight)
26-
- [Flatpak (for other Linux distros)](https://flathub.org/apps/details/com.moonlight_stream.Moonlight)
27-
- [AppImage](https://github.com/moonlight-stream/moonlight-qt/releases)
28-
- [Raspberry Pi 4 and 5](https://github.com/moonlight-stream/moonlight-docs/wiki/Installing-Moonlight-Qt-on-Raspberry-Pi-4)
29-
- [Generic ARM 32-bit and 64-bit Debian packages](https://github.com/moonlight-stream/moonlight-docs/wiki/Installing-Moonlight-Qt-on-ARM%E2%80%90based-Single-Board-Computers) (not for Raspberry Pi)
30-
- [Experimental RISC-V Debian packages](https://github.com/moonlight-stream/moonlight-docs/wiki/Installing-Moonlight-Qt-on-RISC%E2%80%90V-Single-Board-Computers)
31-
- [NVIDIA Jetson and Nintendo Switch (Ubuntu L4T)](https://github.com/moonlight-stream/moonlight-docs/wiki/Installing-Moonlight-Qt-on-Linux4Tegra-(L4T)-Ubuntu)
33+
34+
## Acknowledgements:
35+
36+
- Huge shootout to [nenkoru](https://github.com/nenkoru) for finding the solution to this problem and for mentioning it [here](https://github.com/jamesstringerparsec/Easy-GPU-PV/issues/342#issuecomment-2119200179) and [here](https://www.reddit.com/r/LizardByte/comments/13n1mn6/comment/l4vch5r/?utm_source=share&utm_medium=web3x&utm_name=web3xcss&utm_term=1&utm_content=share_button).
37+
38+
39+
## Acknowledgements of the main project:
3240

3341
#### Special Thanks
3442

3543
[![Hosted By: Cloudsmith](https://img.shields.io/badge/OSS%20hosting%20by-cloudsmith-blue?logo=cloudsmith&style=flat-square)](https://cloudsmith.com)
3644

3745
Hosting for Moonlight's Debian and L4T package repositories is graciously provided for free by [Cloudsmith](https://cloudsmith.com).
3846

39-
## Building
40-
41-
### Windows Build Requirements
42-
* Qt 5.15 SDK or later. Qt 6 is also supported for x64 and ARM64 builds.
43-
* [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/) (Community edition is fine)
44-
* Select **MSVC** option during Qt installation. MinGW is not supported.
45-
* [7-Zip](https://www.7-zip.org/) (only if building installers for non-development PCs)
46-
47-
### macOS Build Requirements
48-
* Qt 6.4 SDK or later
49-
* Xcode 13 or later
50-
* [create-dmg](https://github.com/sindresorhus/create-dmg) (only if building DMGs for use on non-development Macs)
51-
52-
### Linux/Unix Build Requirements
53-
* Qt 6 is recommended, but Qt 5.9 or later is also supported (replace `qmake6` with `qmake` when using Qt 5).
54-
* GCC or Clang
55-
* FFmpeg 4.0 or later
56-
* Install the required packages:
57-
* Debian/Ubuntu:
58-
* Base Requirements: `libegl1-mesa-dev libgl1-mesa-dev libopus-dev libsdl2-dev libsdl2-ttf-dev libssl-dev libavcodec-dev libavformat-dev libva-dev libvdpau-dev libxkbcommon-dev wayland-protocols libdrm-dev`
59-
* Qt 6 (Recommended): `qtbase6-dev qt6-declarative-dev libqt6svg6-dev qml6-module-qtquick-controls qml6-module-qtquick-templates qml6-module-qtquick-layouts qml6-module-qtqml-workerscript qml6-module-qtquick-window qml6-module-qtquick`
60-
* Qt 5: `qtbase5-dev qt5-qmake qtdeclarative5-dev qtquickcontrols2-5-dev qml-module-qtquick-controls2 qml-module-qtquick-layouts qml-module-qtquick-window2 qml-module-qtquick2 qtwayland5`
61-
* RedHat/Fedora (RPM Fusion repo required):
62-
* Base Requirements: `openssl-devel SDL2-devel SDL2_ttf-devel ffmpeg-devel libva-devel libvdpau-devel opus-devel pulseaudio-libs-devel alsa-lib-devel libdrm-devel`
63-
* Qt 6 (Recommended): `qt6-qtsvg-devel qt6-qtdeclarative-devel`
64-
* Qt 5: `qt5-qtsvg-devel qt5-qtquickcontrols2-devel`
65-
* Building the Vulkan renderer requires a `libplacebo-dev`/`libplacebo-devel` version of at least v7.349.0 and FFmpeg 6.1 or later.
66-
67-
### Steam Link Build Requirements
68-
* [Steam Link SDK](https://github.com/ValveSoftware/steamlink-sdk) cloned on your build system
69-
* STEAMLINK_SDK_PATH environment variable set to the Steam Link SDK path
70-
71-
### Build Setup Steps
72-
1. Install the latest Qt SDK (and optionally, the Qt Creator IDE) from https://www.qt.io/download
73-
* You can install Qt via Homebrew on macOS, but you will need to use `brew install qt --with-debug` to be able to create debug builds of Moonlight.
74-
* You may also use your Linux distro's package manager for the Qt SDK as long as the packages are Qt 5.9 or later.
75-
* This step is not required for building on Steam Link, because the Steam Link SDK includes Qt 5.14.
76-
2. Run `git submodule update --init --recursive` from within `moonlight-qt/`
77-
3. Open the project in Qt Creator or build from qmake on the command line.
78-
* To build a binary for use on non-development machines, use the scripts in the `scripts` folder.
79-
* For Windows builds, use `scripts\build-arch.bat` and `scripts\generate-bundle.bat`. Execute these scripts from the root of the repository within a Qt command prompt. Ensure 7-Zip binary directory is on your `%PATH%`.
80-
* For macOS builds, use `scripts/generate-dmg.sh`. Execute this script from the root of the repository and ensure Qt's `bin` folder is in your `$PATH`.
81-
* For Steam Link builds, run `scripts/build-steamlink-app.sh` from the root of the repository.
82-
* To build from the command line for development use on macOS or Linux, run `qmake6 moonlight-qt.pro` then `make debug` or `make release`
83-
* To create an embedded build for a single-purpose device, use `qmake6 "CONFIG+=embedded" moonlight-qt.pro` and build normally.
84-
* This build will lack windowed mode, Discord/Help links, and other features that don't make sense on an embedded device.
85-
* For platforms with poor GPU performance, add `"CONFIG+=gpuslow"` to prefer direct KMSDRM rendering over GL/Vulkan renderers. Direct KMSDRM rendering can use dedicated YUV/RGB conversion and scaling hardware rather than slower GPU shaders for these operations.
47+
8648

8749
## Contribute
8850
1. Fork us

0 commit comments

Comments
 (0)