moonlight-qt/README.md
2018-10-06 20:12:49 -07:00

3.5 KiB

Moonlight PC

Moonlight PC 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 for streaming on PC.

Moonlight also has mobile versions for Android and iOS.

See the releases page for download links for Windows and Mac. For Linux, we're on Flathub.

You can follow development on our Discord server.

Windows AppVeyor Status Mac and Linux Travis CI Status

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 (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
  • 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/

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 for project links and information.