Skip to content
Projects

AlkaidLab/foundation-sunshine

View on GitHub

AlkaidLab/foundation-sunshine has 7,771 GitHub stars and 225 forks. GitHot measured +24 stars in 24 hours, +401 in 7 days, and +484 in 15 days. Last checked 2026-11-05 08:18 UTC. Last push 2026-11-01.

How these counts are measured

Sunshine fork: an enhanced sunshine, a self-hosted game streaming host for Moonlight with HDR10/HDR Vivid, virtual displays, advanced audio, optimized encoders, and a modern control panel.

Measured star growth

in 24h
+24
in 7 days
+401
in 15 days
+484
in 1 month
Update delayed

Net star changes over overlapping periods, not daily totals. Missing measurements are left blank. Stars measure attention, not software quality.

docs/readme/README.en.md

Original

Foundation Sunshine

简体中文 · English · Deutsch · Français · 日本語

Foundation Sunshine is a free, open-source remote-control and game-streaming host for Windows, built as an enhanced fork of Sunshine. With a Moonlight client, you can use your PC desktop, run applications, and play PC games from a phone, tablet, TV, Mac, or another computer.

From dynamic HDR and display calibration to low-latency capture and hardware encoding, Foundation keeps remote video and input close to local. Surround sound and microphone forwarding, native DualSense feedback, clipboard sync, and shared folders work alongside the session, and an independent desktop GUI offers a better experience by bringing the previously scattered settings, device components, and game libraries into one place.

Download the host (Sunshine) · Download a client (Moonlight) · Install and connect

Highlights · Features and setup · FAQ · Development · Contributing

Highlights

  • Video and displays: Scene-adaptive HDR, HDR10+ / HDR Vivid and Dolby Vision extensions, with brightness calibration. ZakoDisplay provides HDR virtual displays and multiple display layouts without a physical monitor.
  • Capture and encoding: NVIDIA NVENC, AMD AMF, and Intel Quick Sync, with capture and encoding optimizations for lower latency and smoother sessions. Zako Direct takes virtual display frames directly to reduce capture-stage copies.
  • Audio and microphone forwarding: Up to 7.1.4 surround, PCM / AC3 / E-AC3, microphone forwarding, continuous audio during silence, and audio packet-loss recovery.
  • Independent desktop control panel: Manage game libraries, displays, device components, runtime status, and updates, with log diagnostics and optional AI assistance.
  • Input and native controllers: Precision touchpads, pen input, and client-side cursors. Install the DualSense component in the device center to bring supported games' USB-connected PC feedback, including adaptive triggers and haptics, into remote sessions.
  • Desktop integration and session control: Bidirectional clipboard, shared folders, USB forwarding, live video adjustments, adaptive bitrate, host commands, and session controls.

See features and setup for requirements and activation steps — the developers also hid plenty of small touches to discover.

Downloads

You can also use the website or the Website (China) to find downloads for your devices.

Install an application on each device: Foundation Sunshine on the PC you want to control, and a Moonlight client on the device you will use to control it.

Host (Sunshine)

Install on the Windows PC you want to control.

If Foundation Sunshine helps you, consider giving the project a ⭐ Star.

Open the latest regular release, expand Assets, and download the package whose name ends in WindowsInstaller.exe.

  • First installation: Use the installer and follow the setup wizard.
  • Portable deployment (not recommended): Choose Portable-x64.zip; the filename may include a version prefix. Use it only for special needs such as running multiple instances.
  • Trying new features: Browse pre-releases and read their known issues before installing.

Start with Windows 10 22H2 or newer and an AMD, Intel, or NVIDIA GPU with hardware video encoding. Available image quality, resolution, and frame rate depend on your GPU, drivers, network, and client.

Clients (Moonlight)

Install on the phone, tablet, or other computer you will use to control the PC.

We recommend the clients listed below. Foundation's HDR, display management, audio, and input enhancements require client support. Other clients may lack these features or encounter compatibility issues such as incorrect video output or connection errors.

These clients are crafted with care by AlkaidLab members to provide the best Foundation Sunshine experience. Support the projects you use with a ⭐ Star.

Partner clients

Quick start

1 Install the host (Sunshine)

  1. On the Windows PC you want to control, open the download page.
  2. Find Assets and download the file ending in WindowsInstaller.exe, then run it. Keep the installer components you may need; keep Zako Display Driver selected if you plan to use a virtual display.
  3. Open the Foundation Sunshine desktop control panel and follow the setup wizard to choose language, GPU, and display. If a physical display is connected, select it first. For a headless PC, first check whether the installer installed the virtual display driver; if it is missing, open the virtual display settings in the GUI and install it, then select the Foundation display.
  4. (Optional, not recommended) If you prefer the WebUI, open https://localhost:47990 in a browser on this PC. If the browser warns about the certificate, confirm the address is https://localhost:47990 on this PC, then continue through the browser's advanced or "more options" entry.
  5. Follow the prompts to create a username and password; you can use them to sign in to the WebUI management interface in the future.

2 Install a client (Moonlight)

On a phone, tablet, or another computer, download and install a client from the Clients (Moonlight) list above. This device shows the video and sends input.

  • Windows: Choose the Windows installer on the client release page. If you pick the portable ZIP (not recommended; use it only for special needs such as multiple instances), extract and run it; the filename may include a version prefix.
  • macOS: Download the DMG of the client you chose, and drag the app into Applications. V+ prebuilt packages are Apple Silicon only; Enhanced offers a universal package — if you know your Mac's architecture you can also pick the matching build. If macOS blocks the first launch, follow that project's installation notes.
  • Linux: Download an AppImage matching your processor and distribution, make it executable, and run it.
  • Android: Download the APK and open it from the download notification or a file manager; allow installation when prompted.
  • iOS / iPadOS, HarmonyOS: Open the store link and install.

Allow local network access when the client asks. Keep both devices on the same LAN for the first connection; a wired connection is recommended for the host PC.

3 Add the PC and pair

  1. Open the client and wait for the Windows PC to appear in the list, then select it.
  2. If it does not appear, add the IP manually: on the Windows PC press Win + R, type cmd and press Enter, then run ipconfig. Find the IPv4 Address of the active Ethernet or WLAN adapter and enter it in the client's "add PC / add host" entry.
  3. When the client shows a PIN, go back to the Sunshine management interface on the Windows PC and open the PIN page.
  4. Enter the PIN shown on the client and submit it. After the success message, return to the client.

Enter the Windows PC's LAN address, for example 192.168.1.100 — not localhost and not the management page URL. Replace the example with your PC's actual address.

4 Set video options for the first connection

Open settings in your Moonlight client, find video or quality options, and set:

Option First-time value What it means
Resolution 1920×1080 (1080p) Size of the transmitted image; higher is sharper but needs more network and processing
Frame rate 60 FPS Screen updates per second; 120 FPS needs a suitable display and headroom on both ends
Bitrate 20 Mbps; drop to 10 Mbps if the network is unstable Data budget affecting compression quality and network load
Video codec Automatic; choose H.264 first if you hit compatibility issues Compression format; HEVC / AV1 need matching decoder support
HDR Off first SDR by default; configure HDR after everything works
Audio Stereo / Opus Confirm sound first, then enable surround or other formats

Names vary slightly by client. Set resolution, frame rate, and bitrate on the client; leave the host on automatic encoding and default capture at first. Avoid enabling high resolution, high frame rate, and every enhancement at once.

5 Connect to the desktop

  1. Open the paired PC in the client and choose Desktop.
  2. Once the Windows desktop appears, move the mouse, open a window, and play some audio to confirm video, input, and sound.
  3. If Desktop is missing, use Restore built-in apps on Sunshine's Applications page, then refresh the client's app list. This restores the default built-in entries; preserve your customizations first if you changed them.

Get through this step with default video settings, then adjust HDR, resolution, or virtual displays.

6 Add a game or application (optional)

Batch scan: On Windows, open the Foundation Sunshine desktop control panel, go to Applications, and click Scan game platform libraries (Steam/Epic/GOG). Review the results, choose Quick add or Add all, then refresh the client list. Local folders can be added from the scan dialog too; the browser management page cannot access the desktop-side local scan.

Manual add: In Applications → Add new app, fill in the app name and Command, save, and refresh the client list. The command accepts a program path; wrap paths containing spaces in double quotes, for example "D:\My Games\Game\game.exe".

You can also launch the built-in Steam Big Picture entry from the client and pick a game in Steam.

Features and setup

Each topic brings capabilities, requirements, and setup instructions together:

Video HDR and color · Foundation virtual displays · Capture and encoding · Controllers and DualSense · Audio and microphone forwarding · Desktop control panel

Help and participation

Thanks to LizardByte/Sunshine, Moonlight, ZakoDisplay, and all code, testing, and translation contributors. Licensed under GPL-3.0.

Enjoying it? Leave a Star. Not that we were checking or anything.

AlkaidLab development team

qiin2333 Yundi339 ShadowLemoon skyhua0224
qiin2333 Yundi339 ShadowLemoon skyhua0224

Other contributors

Thanks to everyone contributing code, testing, and maintenance to Foundation and upstream Sunshine.

ReenigneArcher cgutman dependabot[bot] loki-47-6F-64 ns6089 LizardByte-bot TheElixZammuto psyke83 istori1 Nonary github-actions[bot] PapyKahan ABeltramo FrogTheFrog HomerSp kodemeister brad-richardson Doomsdayrs gschintgen Logical-sh Hazer diadatp KuleRucket chewi guanzhangrtk nowrep sitiom luk1337 JacekJagosz jorys-paulin tez011 KiralyCraft pgrunzjr thatsysadmin WisdomCode safijari korverdev tgurr exetico BigBrainAFK Arbitrate3280 arnerak detiam dkgkdfg65 lns103 okkiv w0utert MiroKaku TimmyOVO ReeceHumphreys mcourteaux Doridian brownj85 felipejfc CLF184 briankendall abusse perroboc andygrundman CrazyStevenz TrueZhuangJia xanderfrangos zackelia zanechua KawaiiZapic Chang-Jin-Lee bushshrub RickAndTired rafaelsgirao radugrecu97 PVermeer devusb LXY1226 sethicis SnowSwordScholar Max-Might zoeyjodon skryvel sirius128 qingm36 manteuffel723 jensaymoo jcj83429 iMakeSoftware exalented everything411 brycerocky aseligmann ahmadalli aetheryx notentered 360sym d-s-x Xythus Crashdummyy cgarst Copilot CodyManess Clutchnp cfalas cfajardo cazzoo caveat-makes-software cathyjf gamozolabs BeeLeDev angelnu amarshall Aaron-Rumpler kelvie KarlVogel justindhillon Tea23 jhgarner insanemal Calinou hgaiser Han-cy830 hadicharara c3m3gyanesh himekifee theofficialgman ekchang e-dong Gara-Dorta ehabajmal

View contribution history

Explore related projects