mirror of
https://github.com/moonlight-stream/moonlight-qt
synced 2024-11-10 05:34:17 +00:00
95 lines
7.2 KiB
Markdown
95 lines
7.2 KiB
Markdown
# Moonlight PC
|
|
|
|
[Moonlight PC](https://moonlight-stream.org) is an open source PC client for NVIDIA GameStream and [Sunshine](https://github.com/LizardByte/Sunshine).
|
|
|
|
Moonlight also has mobile versions for [Android](https://github.com/moonlight-stream/moonlight-android) and [iOS](https://github.com/moonlight-stream/moonlight-ios).
|
|
|
|
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/).
|
|
|
|
[](https://ci.appveyor.com/project/cgutman/moonlight-qt/branch/master)
|
|
[](https://github.com/moonlight-stream/moonlight-qt/releases)
|
|
[](https://hosted.weblate.org/projects/moonlight/moonlight-qt/)
|
|
|
|
## Features
|
|
- Hardware accelerated video decoding on Windows, Mac, and Linux
|
|
- H.264, HEVC, and AV1 codec support (AV1 requires Sunshine and a supported host GPU)
|
|
- HDR streaming support
|
|
- 7.1 surround sound audio support
|
|
- 10-point multitouch support (Sunshine only)
|
|
- Gamepad support with force feedback and motion controls for up to 16 players
|
|
- Support for both pointer capture (for games) and direct mouse control (for remote desktop)
|
|
- Support for passing system-wide keyboard shortcuts like Alt+Tab to the host
|
|
|
|
## Downloads
|
|
- [Windows, macOS, and Steam Link](https://github.com/moonlight-stream/moonlight-qt/releases)
|
|
- [Snap (for Ubuntu-based Linux distros)](https://snapcraft.io/moonlight)
|
|
- [Flatpak (for other Linux distros)](https://flathub.org/apps/details/com.moonlight_stream.Moonlight)
|
|
- [AppImage](https://github.com/moonlight-stream/moonlight-qt/releases)
|
|
- [Raspberry Pi 4 and 5](https://github.com/moonlight-stream/moonlight-docs/wiki/Installing-Moonlight-Qt-on-Raspberry-Pi-4)
|
|
- [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)
|
|
- [Experimental RISC-V Debian packages](https://github.com/moonlight-stream/moonlight-docs/wiki/Installing-Moonlight-Qt-on-RISC%E2%80%90V-Single-Board-Computers)
|
|
- [NVIDIA Jetson and Nintendo Switch (Ubuntu L4T)](https://github.com/moonlight-stream/moonlight-docs/wiki/Installing-Moonlight-Qt-on-Linux4Tegra-(L4T)-Ubuntu)
|
|
|
|
#### Special Thanks
|
|
|
|
[](https://cloudsmith.com)
|
|
|
|
Hosting for Moonlight's Debian and L4T package repositories is graciously provided for free by [Cloudsmith](https://cloudsmith.com).
|
|
|
|
## Building
|
|
|
|
### Windows Build Requirements
|
|
* Qt 5.15 SDK or later. Qt 6 is also supported for x64 and ARM64 builds.
|
|
* [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/) (Community edition is fine)
|
|
* Select **MSVC** option during Qt installation. MinGW is not supported.
|
|
* [7-Zip](https://www.7-zip.org/) (only if building installers for non-development PCs)
|
|
* Graphics Tools (only if running debug builds)
|
|
* Install "Graphics Tools" in the Optional Features page of the Windows Settings app.
|
|
* Alternatively, run `dism /online /add-capability /capabilityname:Tools.Graphics.DirectX~~~~0.0.1.0` and reboot.
|
|
|
|
### macOS Build Requirements
|
|
* Qt 6.4 SDK or later
|
|
* Xcode 13 or later
|
|
* [create-dmg](https://github.com/sindresorhus/create-dmg) (only if building DMGs for use on non-development Macs)
|
|
|
|
### Linux/Unix Build Requirements
|
|
* Qt 6 is recommended, but Qt 5.9 or later is also supported (replace `qmake6` with `qmake` when using Qt 5).
|
|
* GCC or Clang
|
|
* FFmpeg 4.0 or later
|
|
* Install the required packages:
|
|
* Debian/Ubuntu:
|
|
* Base Requirements: `libegl1-mesa-dev libgl1-mesa-dev libopus-dev libsdl2-dev libsdl2-ttf-dev libssl-dev libavcodec-dev libavformat-dev libswscale-dev libva-dev libvdpau-dev libxkbcommon-dev wayland-protocols libdrm-dev`
|
|
* Qt 6 (Recommended): `qt6-base-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`
|
|
* 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`
|
|
* RedHat/Fedora (RPM Fusion repo required):
|
|
* 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`
|
|
* Qt 6 (Recommended): `qt6-qtsvg-devel qt6-qtdeclarative-devel`
|
|
* Qt 5: `qt5-qtsvg-devel qt5-qtquickcontrols2-devel`
|
|
* Building the Vulkan renderer requires a `libplacebo-dev`/`libplacebo-devel` version of at least v7.349.0 and FFmpeg 6.1 or later.
|
|
|
|
### Steam Link Build Requirements
|
|
* [Steam Link SDK](https://github.com/ValveSoftware/steamlink-sdk) cloned on your build system
|
|
* STEAMLINK_SDK_PATH environment variable set to the Steam Link SDK path
|
|
|
|
### Build Setup Steps
|
|
1. Install the latest Qt SDK (and optionally, the Qt Creator IDE) from https://www.qt.io/download
|
|
* 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.
|
|
* 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.
|
|
* This step is not required for building on Steam Link, because the Steam Link SDK includes Qt 5.14.
|
|
2. Run `git submodule update --init --recursive` from within `moonlight-qt/`
|
|
3. Open the project in Qt Creator or build from qmake on the command line.
|
|
* To build a binary for use on non-development machines, use the scripts in the `scripts` folder.
|
|
* 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%`.
|
|
* 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`.
|
|
* For Steam Link builds, run `scripts/build-steamlink-app.sh` from the root of the repository.
|
|
* To build from the command line for development use on macOS or Linux, run `qmake6 moonlight-qt.pro` then `make debug` or `make release`
|
|
* To create an embedded build for a single-purpose device, use `qmake6 "CONFIG+=embedded" moonlight-qt.pro` and build normally.
|
|
* This build will lack windowed mode, Discord/Help links, and other features that don't make sense on an embedded device.
|
|
* 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.
|
|
|
|
## Contribute
|
|
1. Fork us
|
|
2. Write code
|
|
3. Send Pull Requests
|
|
|
|
Check out our [website](https://moonlight-stream.org) for project links and information.
|