2018-07-07 21:59:48 +00:00
# Moonlight PC
2018-12-04 05:48:49 +00:00
[Moonlight PC ](https://moonlight-stream.org ) is an open source implementation of NVIDIA's GameStream, as used by the NVIDIA Shield, but built to run on Windows, Mac, and Linux. This client is the successor to [Moonlight Chrome ](https://github.com/moonlight-stream/moonlight-chrome ) for streaming on PC.
2018-07-07 21:59:48 +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-28 10:52:24 +00:00
You can follow development on our [Discord server ](https://discord.gg/6ERtzFY ).
2018-07-28 10:47:34 +00:00
2018-07-29 02:33:11 +00:00
[](https://ci.appveyor.com/project/cgutman/moonlight-qt/branch/master)
2018-07-29 20:50:11 +00:00
[](https://travis-ci.org/moonlight-stream/moonlight-qt)
2019-08-26 06:24:34 +00:00
[](https://github.com/moonlight-stream/moonlight-qt/releases)
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
2018-09-09 18:53:58 +00:00
- Supports streaming at up to 120 FPS (high refresh rate monitor recommended)
2018-09-09 18:40:13 +00:00
- Supports streaming at 720p, 1080p, 1440p, 4K, and the client PC's native screen resolution
2018-07-28 10:45:45 +00:00
- 5.1 surround sound audio
- HEVC support for better image quality at reduced bandwidth
- Keyboard and mouse support
2019-03-23 19:14:43 +00:00
- Gamepad support with force feedback for up to 4 players
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 )
2018-07-28 10:45:45 +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
* Qt 5.12.4 SDK or later
2018-09-29 10:24:26 +00:00
* Windows 7 or later
2019-04-19 03:08:27 +00:00
* [Visual Studio ](https://visualstudio.microsoft.com/downloads/ ) 2017 (Community edition is fine)
2018-09-29 10:24:26 +00:00
* Select MSVC Desktop toolchain during Qt installation
2019-01-20 19:58:30 +00:00
* [DirectX SDK ](https://www.microsoft.com/en-us/download/details.aspx?id=6812 )
* [7-Zip ](https://www.7-zip.org/ ) (only if building installers for non-development PCs)
* [WiX Toolset ](http://wixtoolset.org/releases/ ) v3.11 or later (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
* Qt 5.14 SDK or later
* macOS High Sierra (10.13) or later
* Xcode 11
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
* Qt 5.9 SDK or later
2018-09-29 10:24:26 +00:00
* GCC or Clang
2019-02-13 05:38:51 +00:00
* Install your distro equivalents of: `openssl-devel qt5-devel SDL2-devel ffmpeg-devel qt5-qtquickcontrols2-devel libva-devel libvdpau-devel opus-devel pulseaudio-libs-devel alsa-lib-devel SDL2_ttf-devel`
2018-10-07 03:12:49 +00:00
* FFmpeg 4.0 is required to build. If your distro doesn't package FFmpeg 4.0, you can build and install it from source on http://ffmpeg.org/
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.
2019-04-01 06:26:17 +00:00
* This step is not required for building on Steam Link, because the Steam Link SDK includes Qt 5.9.
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.
2018-09-29 10:30:50 +00:00
* For Windows builds, use `scripts\generate-installers.bat` . Execute this script from the root of the repository within a Qt command prompt. Ensure WiX and 7-Zip binary directories are in 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` .
2019-04-01 06:26:17 +00:00
* For Steam Link builds, run `scripts/build-steamlink-app.sh` from the root of the repository.
2019-01-06 03:20:00 +00:00
* To build from the command line for development use, run `qmake moonlight-qt.pro` then `make debug` or `make release`
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.
