Skip to content

Repository files navigation

OpenNOW Docs

Fumadocs + TanStack Start SPA documentation site for the OpenNOW desktop, mobile, and Nintendo Switch GeForce NOW clients.

App Repository Latest Release Discord


About

This repo hosts the public documentation website for the OpenNOW desktop client, mobile builds, and native OpenNOW-Switch homebrew client. The desktop app uses Electron, React, TypeScript, and an optional Rust/GStreamer native streamer; the Switch client is a separate C++ Horizon OS application.

Docs content lives in content/docs as MDX. Shared docs data and React MDX components live under src/lib and src/components/docs.

Pages

Section Description
Getting Started Download releases or build from source
Nintendo Switch Install the homebrew client, configure streaming, and use Switch controls and shortcuts
Architecture Electron main / preload / renderer split
Authentication OAuth + PKCE login flow
WebRTC Signaling, SDP, and data channels
Media Screenshots, recordings, and local storage
Input Shortcuts, pointer lock, gamepad, microphone
Native Streamer Experimental Rust/GStreamer streaming path, diagnostics, and fallback behavior
Configuration Settings model and defaults

Local development

Built with Fumadocs on the TanStack Start SPA template.

npm install
npm run dev          # dev server on http://localhost:3000
npm run types:check  # generate MDX collections and type-check
npm run build        # production SPA build
npm run start        # serve .output/public with SPA rewrites

Keeping docs current

These pages are anchored to the upstream repo's README, development notes, and Electron source under opennow-stable/src/. When the app changes, update docs to match. The native streamer docs describe an experimental opt-in feature that may have platform-specific bugs or fallback behavior.

About

Documentation site for OpenNOW - open source GeForce NOW client

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages