FangsCode/moonlight-qt

GameStream client for PCs (Windows, Mac, Linux, and Steam Link)

Moonlight PC

Moonlight PC is an open source PC client for NVIDIA GameStream and Sunshine.

Moonlight also has mobile versions for Android and iOS.

You can follow development on our Discord server and help translate Moonlight into your language on Weblate.

Features

• Hardware accelerated video decoding on Windows, Mac, and Linux
• H.264, HEVC, and AV1 codec support (AV1 requires Sunshine and a supported host GPU)
• HDR streaming support
• 7.1 surround sound audio support
• 10-point multitouch support (Sunshine only)
• Gamepad support with force feedback and motion controls for up to 16 players
• Support for both pointer capture (for games) and direct mouse control (for remote desktop)
• Support for passing system-wide keyboard shortcuts like Alt+Tab to the host

Downloads

• Windows, macOS, and Steam Link
• Snap (for Ubuntu-based Linux distros)
• Flatpak (for other Linux distros)
• AppImage
• Raspberry Pi 4
• Generic ARM SBC packages for Debian (not for Raspberry Pi)
• Experimental RISC-V SBC packages for Debian
• NVIDIA Jetson and Nintendo Switch (Ubuntu L4T)

Special Thanks

Hosting for Moonlight's Debian and L4T package repositories is graciously provided for free by Cloudsmith.

Building

Windows Build Requirements

• Qt 5.15 SDK or later. Qt 6 is also supported for x64 and ARM64 builds.
• Visual Studio 2022 (Community edition is fine)
• Select MSVC option during Qt installation. MinGW is not supported.
• 7-Zip (only if building installers for non-development PCs)

macOS Build Requirements

• Qt 6.4 SDK or later
• Xcode 13 or later
• create-dmg (only if building DMGs for use on non-development Macs)

Linux/Unix Build Requirements

• Qt 5.9 SDK or later. Qt 6 is also supported.
• GCC or Clang
• Install the required packages:
  • Debian/Ubuntu: libegl1-mesa-dev libgl1-mesa-dev libopus-dev libqt5svg5-dev libsdl2-dev libsdl2-ttf-dev libplacebo-dev libssl-dev libavcodec-dev libva-dev libvdpau-dev libxkbcommon-dev qtwayland5 qt5-qmake qtbase5-dev qtdeclarative5-dev qtquickcontrols2-5-dev wayland-protocols qml-module-qtquick-controls2 qml-module-qtquick-layouts qml-module-qtquick-window2 qml-module-qtquick2
  • RedHat/Fedora: openssl-devel SDL2-devel SDL2_ttf-devel libplacebo-devel ffmpeg-devel qt5-qtsvg-devel qt5-qtquickcontrols2-devel libva-devel libvdpau-devel opus-devel pulseaudio-libs-devel alsa-lib-devel
• FFmpeg 4.0 or later is required to build. If your distro doesn't package FFmpeg 4.0 or later, you can build and install it from source on https://ffmpeg.org/

Steam Link Build Requirements

• Steam Link SDK cloned on your build system
• STEAMLINK_SDK_PATH environment variable set to the Steam Link SDK path

Build Setup Steps

1. Install the latest Qt SDK (and optionally, the Qt Creator IDE) from https://www.qt.io/download
   • 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.
   • This step is not required for building on Steam Link, because the Steam Link SDK includes Qt 5.14.
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\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%.
     • 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.
     • For Steam Link builds, run scripts/build-steamlink-app.sh from the root of the repository.
   • To build from the command line for development use on macOS or Linux, run qmake moonlight-qt.pro then make debug or make release
   • To create an embedded build for a single-purpose device, use qmake "CONFIG+=embedded" moonlight-qt.pro and build normally.
     • This build will lack windowed mode, Discord/Help links, and other features that don't make sense on an embedded device.
     • 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.

Contribute

1. Fork us
2. Write code
3. Send Pull Requests

Check out our website for project links and information.