mirror of
https://github.com/moonlight-stream/moonlight-qt
synced 2024-12-14 05:12:27 +00:00
57 lines
3.4 KiB
Markdown
57 lines
3.4 KiB
Markdown
# Moonlight PC
|
|
|
|
[Moonlight PC](http://moonlight-stream.com) 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.
|
|
|
|
Moonlight also has mobile versions for [Android](https://github.com/moonlight-stream/moonlight-android) and [iOS](https://github.com/moonlight-stream/moonlight-ios).
|
|
|
|
See the [releases page](https://github.com/moonlight-stream/moonlight-qt/releases) for download links for Windows and Mac. For Linux, we're on [Flathub](https://flathub.org/apps/details/com.moonlight_stream.Moonlight).
|
|
|
|
You can follow development on our [Discord server](https://discord.gg/6ERtzFY).
|
|
|
|
[![Windows AppVeyor Status](https://ci.appveyor.com/api/projects/status/glj5cxqwy2w3bglv/branch/master?svg=true)](https://ci.appveyor.com/project/cgutman/moonlight-qt/branch/master)
|
|
[![Mac and Linux Travis CI Status](https://travis-ci.org/moonlight-stream/moonlight-qt.svg?branch=master)](https://travis-ci.org/moonlight-stream/moonlight-qt)
|
|
|
|
## Features
|
|
- Hardware accelerated video decoding on Windows, Mac, and Linux
|
|
- Supports streaming at up to 120 FPS (high refresh rate monitor recommended)
|
|
- Supports streaming at 720p, 1080p, 1440p, 4K, and the client PC's native screen resolution
|
|
- 5.1 surround sound audio
|
|
- HEVC support for better image quality at reduced bandwidth
|
|
- Keyboard and mouse support
|
|
- Gamepad support with SDL gamepad mappings
|
|
|
|
## Building
|
|
### General Build Requirements
|
|
* Qt 5.9 SDK or later
|
|
|
|
### Windows-specific Requirements
|
|
* Windows 7 or later
|
|
* Visual Studio 2015 or later
|
|
* Select MSVC Desktop toolchain during Qt installation
|
|
* 7-Zip (only if building installers for non-development PCs)
|
|
* WiX Toolset v3.11 or later (only if building installers for non-development PCs)
|
|
|
|
### Mac-specific Requirements
|
|
* macOS El Capitan (10.11) or later
|
|
* Xcode with High Sierra (10.13) SDK (Mojave SDK not yet supported until Qt 5.12 later this year)
|
|
* [create-dmg](https://github.com/sindresorhus/create-dmg) (only if building DMGs for use on non-development Macs)
|
|
|
|
### Linux-specific Requirements
|
|
* GCC or Clang
|
|
* Install your distro equivalents of: `openssl-devel qt5-devel SDL2-devel ffmpeg-devel qt5-qtquickcontrols2-devel libva-devel libvdpau-devel opus-devel portaudio-devel`
|
|
|
|
### Build Setup Steps
|
|
1. Install the latest Qt SDK (and optionally, the Qt Creator IDE) from https://www.qt.io/download
|
|
* You may also use Homebrew on macOS or your Linux distro's package manager for the Qt SDK as long as the packages are Qt 5.9 or later.
|
|
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\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`.
|
|
|
|
## Contribute
|
|
1. Fork us
|
|
2. Write code
|
|
3. Send Pull Requests
|
|
|
|
Check out our [website](http://moonlight-stream.com) for project links and information.
|