moonlight-qt README

The project's README from github.com/moonlight-stream/moonlight-qt. As one markdown file: README.md.

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.

Build Downloads Translation Status

Features

Downloads

Nightly Builds

Special Thanks

Hosted By: Cloudsmith

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

Building

Windows Build Requirements

macOS Build Requirements

Linux/Unix Build Requirements

Steam Link Hardware Limitations
Moonlight builds for Steam Link are subject to hardware limitations of the Steam Link device:

Docker containers

If you want to use Docker for building, look at this repo containing canonical containers for different architectures, which handle building deps and extra linking for you.

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.12 or later.
    • This step is not required for building on Steam Link, because the Steam Link SDK includes Qt 5.14.
  2. Download submodules and dependencies
    • Run git submodule update --init --recursive from within moonlight-qt/.
    • On Windows and macOS, you must also run setup-deps.ps1 (Windows) or setup-deps.py (macOS).
    • Perform these steps each time you pull new changes from the Git repository.
  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 qmake6 moonlight-qt.pro then make debug or make release.
      • The final binary will be placed in app/moonlight.
    • To create an embedded build for a single-purpose device, use qmake6 "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.

moonlight-qt (moonlight-stream/moonlight-qt)

Searching Database…

What is this?An open source client that streams games from your own PC to another screen using NVIDIA GameStream or Sunshine, with hardware-accelerated video and gamepad support.
Is this the app I put on the PC running the games, or on the device I play from?It goes on the device you play from — a Windows, Mac, or Linux PC, Steam Link, or Raspberry Pi. Your games keep running on the host PC and are streamed over the network.
What limits will I hit on weaker hardware like the Steam Link?The original Steam Link box tops out at 1080p, 60 FPS, and a 40 Mbps bitrate, with no HDR. Those caps come from the device itself; desktop builds are not restricted this way.
Is it strictly for games, or can it double as a remote desktop?Both: games can capture the pointer, and a direct mouse control mode serves remote desktop use. System-wide shortcuts like Alt+Tab can also be passed through to the host.
What devices can it run on besides a normal computer?Steam Link hardware, Raspberry Pi 4 and 5, generic ARM 32/64-bit Debian packages, experimental RISC-V builds, NVIDIA Jetson boards, and even Nintendo Switch (Ubuntu L4T).
Does the PC I stream from have to have an NVIDIA GPU?Not necessarily: the host can run NVIDIA GameStream or Sunshine, the open-source host. Choosing Sunshine frees you from the NVIDIA-only stack.
Is there a Moonlight app for phones and tablets?Yes — the same project ships separate Moonlight apps for Android and iOS.
Size
348.8 MB
Stars
19.1K
Age
8y
Commits · 90 Days