2018-07-07 21:59:48 +00:00
# Moonlight PC
2023-09-03 23:04:31 +00:00
[Moonlight PC ](https://moonlight-stream.org ) is an open source PC client for NVIDIA GameStream and [Sunshine ](https://github.com/LizardByte/Sunshine ).
2018-07-07 21:59:48 +00:00
2021-01-14 01:36:17 +00:00
Moonlight also has mobile versions for [Android ](https://github.com/moonlight-stream/moonlight-android ) and [iOS ](https://github.com/moonlight-stream/moonlight-ios ).
2018-07-07 21:59:48 +00:00
2021-03-20 23:11:15 +00:00
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/ ).
2018-07-28 10:47:34 +00:00
2020-03-23 02:34:50 +00:00
[](https://ci.appveyor.com/project/cgutman/moonlight-qt/branch/master)
2019-08-26 06:24:34 +00:00
[](https://github.com/moonlight-stream/moonlight-qt/releases)
2021-03-20 23:12:04 +00:00
[](https://hosted.weblate.org/projects/moonlight/moonlight-qt/)
2018-07-29 02:29:54 +00:00
2018-07-28 10:45:45 +00:00
## Features
- Hardware accelerated video decoding on Windows, Mac, and Linux
2023-09-03 23:03:34 +00:00
- H.264, HEVC, and AV1 codec support (AV1 requires Sunshine and a supported host GPU)
2022-04-06 00:56:20 +00:00
- HDR streaming support
2020-04-26 23:12:10 +00:00
- 7.1 surround sound audio support
2023-09-03 23:03:34 +00:00
- 10-point multitouch support (Sunshine only)
- Gamepad support with force feedback and motion controls for up to 16 players
2020-04-26 23:12:10 +00:00
- Support for both pointer capture (for games) and direct mouse control (for remote desktop)
2021-02-07 02:15:58 +00:00
- Support for passing system-wide keyboard shortcuts like Alt+Tab to the host
2018-11-23 10:09:54 +00:00
## Downloads
2019-04-01 06:26:17 +00:00
- [Windows, macOS, and Steam Link ](https://github.com/moonlight-stream/moonlight-qt/releases )
2019-01-30 02:30:56 +00:00
- [Snap (for Ubuntu-based Linux distros) ](https://snapcraft.io/moonlight )
- [Flatpak (for other Linux distros) ](https://flathub.org/apps/details/com.moonlight_stream.Moonlight )
2020-04-27 04:31:29 +00:00
- [AppImage ](https://github.com/moonlight-stream/moonlight-qt/releases )
2024-06-10 01:54:17 +00:00
- [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 )
2020-04-27 04:31:29 +00:00
- [NVIDIA Jetson and Nintendo Switch (Ubuntu L4T) ](https://github.com/moonlight-stream/moonlight-docs/wiki/Installing-Moonlight-Qt-on-Linux4Tegra-(L4T )-Ubuntu)
2018-07-28 10:45:45 +00:00
2021-03-27 17:40:51 +00:00
#### Special Thanks
[](https://cloudsmith.com)
2023-11-03 05:13:50 +00:00
Hosting for Moonlight's Debian and L4T package repositories is graciously provided for free by [Cloudsmith ](https://cloudsmith.com ).
2021-03-27 17:40:51 +00:00
2018-07-07 21:59:48 +00:00
## Building
2018-09-29 10:24:26 +00:00
2020-01-06 07:32:48 +00:00
### Windows Build Requirements
2023-11-03 05:13:50 +00:00
* Qt 5.15 SDK or later. Qt 6 is also supported for x64 and ARM64 builds.
2023-09-12 23:26:03 +00:00
* [Visual Studio 2022 ](https://visualstudio.microsoft.com/downloads/ ) (Community edition is fine)
* Select **MSVC** option during Qt installation. MinGW is not supported.
2019-01-20 19:58:30 +00:00
* [7-Zip ](https://www.7-zip.org/ ) (only if building installers for non-development PCs)
2018-09-29 10:24:26 +00:00
2020-01-06 07:32:48 +00:00
### macOS Build Requirements
2023-11-03 05:13:50 +00:00
* Qt 6.4 SDK or later
2023-09-12 23:26:03 +00:00
* Xcode 13 or later
2018-09-29 10:24:26 +00:00
* [create-dmg ](https://github.com/sindresorhus/create-dmg ) (only if building DMGs for use on non-development Macs)
2020-01-06 07:32:48 +00:00
### Linux/Unix Build Requirements
2024-06-10 01:54:17 +00:00
* Qt 6 is recommended, but Qt 5.9 or later is also supported (replace `qmake6` with `qmake` when using Qt 5).
2018-09-29 10:24:26 +00:00
* GCC or Clang
2024-06-10 01:54:17 +00:00
* FFmpeg 4.0 or later
2020-11-29 17:10:16 +00:00
* Install the required packages:
2024-06-10 01:54:17 +00:00
* Debian/Ubuntu: `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 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`
* RedHat/Fedora (RPM Fusion repo required): `openssl-devel SDL2-devel SDL2_ttf-devel ffmpeg-devel libva-devel libvdpau-devel opus-devel pulseaudio-libs-devel alsa-lib-devel libdrm-devel qt6-qtsvg-devel qt6-qtdeclarative-devel`
2024-02-18 21:23:35 +00:00
* Building the Vulkan HDR renderer requires a `libplacebo-dev` /`libplacebo-devel` version of at least v338.0 and FFmpeg 6.1 or later.
2018-09-29 10:24:26 +00:00
2020-01-06 07:32:48 +00:00
### Steam Link Build Requirements
2019-04-01 06:26:17 +00:00
* [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
2018-09-29 10:24:26 +00:00
### Build Setup Steps
2018-08-12 00:50:29 +00:00
1. Install the latest Qt SDK (and optionally, the Qt Creator IDE) from https://www.qt.io/download
2019-01-06 03:20:00 +00:00
* 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.
2023-11-03 05:13:50 +00:00
* This step is not required for building on Steam Link, because the Steam Link SDK includes Qt 5.14.
2018-07-25 09:53:51 +00:00
2. Run `git submodule update --init --recursive` from within `moonlight-qt/`
2018-09-29 10:24:26 +00:00
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.
2023-07-15 00:55:00 +00:00
* 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%` .
2018-09-29 10:30:50 +00:00
* 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` .
2019-04-01 06:26:17 +00:00
* For Steam Link builds, run `scripts/build-steamlink-app.sh` from the root of the repository.
2024-06-10 01:54:17 +00:00
* 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.
2021-03-13 21:20:58 +00:00
* This build will lack windowed mode, Discord/Help links, and other features that don't make sense on an embedded device.
2023-12-13 05:54:23 +00:00
* 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.
2018-07-07 21:59:48 +00:00
## Contribute
1. Fork us
2. Write code
3. Send Pull Requests
2018-12-04 05:48:49 +00:00
Check out our [website ](https://moonlight-stream.org ) for project links and information.
