moonlight-qt/README.md

37 lines
2.2 KiB
Markdown
Raw Normal View History

2018-07-07 21:59:48 +00:00
# Moonlight PC
2018-07-28 10:45:45 +00:00
[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.
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-08-06 02:36:30 +00:00
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).
2018-07-28 10:45:45 +00:00
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
[![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)
2018-07-29 20:50:11 +00:00
[![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)
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:40:13 +00:00
- Supports streaming at up to 120 FPS
- 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
- Gamepad support with SDL gamepad mappings
2018-07-07 21:59:48 +00:00
## Building
1. Install the latest Qt SDK (and optionally, the Qt Creator IDE) from https://www.qt.io/download
- On Windows, install Visual Studio 2017 and select MSVC 2017 toolchain during Qt installation
- On Mac, install the latest version of XCode
- On Linux, install your distro equivalents of: `openssl-devel qt5-devel SDL2-devel ffmpeg-devel qt5-qtquickcontrols2-devel libva-devel libvdpau-devel`
2018-07-25 09:53:51 +00:00
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
2018-07-07 21:59:48 +00:00
## Contribute
1. Fork us
2. Write code
3. Send Pull Requests
Check out our [website](http://moonlight-stream.com) for project links and information.