Skip to content

development.md

Latest commit

 

History

History
167 lines (118 loc) · 4.32 KB

development.md

File metadata and controls

167 lines (118 loc) · 4.32 KB

Development Guide

This guide covers the active Electron-based OpenNOW client in opennow-stable/.

Prerequisites

  • Node.js 22 or newer
  • npm
  • A GeForce NOW account for end-to-end testing

Getting Started

Install app dependencies inside the Electron workspace:

cd opennow-stable
npm install

You can then work either from the app directory or from the repository root.

From the repository root:

npm run dev
npm run typecheck
npm run build
npm run dist

Directly inside opennow-stable/:

npm run dev
npm run preview
npm run typecheck
npm run build
npm run dist
npm run dist:signed

Workspace Layout

opennow-stable/
├── src/
│   ├── main/           Electron main process
│   │   ├── gfn/        Auth, game catalogs, subscriptions, CloudMatch, signaling
│   │   └── services/   Cache and refresh helpers
│   ├── preload/        Safe API exposed to the renderer
│   ├── renderer/src/   React application
│   │   ├── components/ Screens, stream UI, settings, library, navigation
│   │   ├── gfn/        WebRTC client and input protocol
│   │   └── utils/      Diagnostics and UI helpers
│   └── shared/         Shared types, IPC channels, logging helpers
├── electron.vite.config.ts
├── package.json
└── tsconfig*.json

Architecture

Main process

The main process handles platform and system responsibilities:

  • OAuth and session bootstrap
  • Game catalog fetches and cache refresh
  • CloudMatch session creation, polling, claiming, and stopping
  • Signaling and low-level Electron integration
  • Local media management for screenshots and recordings
  • Persistent settings storage

Key entry point:

Preload

The preload layer exposes a narrow IPC surface to the renderer with contextBridge.

Key entry point:

Renderer

The renderer is a React app responsible for:

  • Login and provider selection
  • Browsing the catalog and public listings
  • Managing stream launch state and session recovery
  • Rendering the WebRTC stream
  • Handling controller input, shortcuts, stats overlay, screenshots, recordings, and settings UI

Key entry points:

Common Tasks

Start the app in development

cd opennow-stable
npm run dev

Run type checks

cd opennow-stable
npm run typecheck

Build production bundles

cd opennow-stable
npm run build

Package release artifacts locally

Unsigned packages:

cd opennow-stable
npm run dist

Signed packages, if your environment is configured for signing:

cd opennow-stable
npm run dist:signed

CI And Releases

The repository includes two main GitHub Actions workflows:

  • auto-build.yml builds pull requests and pushes to main and dev
  • release.yml packages and publishes tagged or manually-triggered releases

Current build matrix:

Target Output
Windows x64 NSIS installer, portable executable, latest.yml, .blockmap
Windows ARM64 NSIS installer, portable executable
macOS x64 dmg, zip
macOS arm64 dmg, zip
Linux x64 AppImage, deb
Linux ARM64 AppImage, deb

Windows ARM64 artifacts are release downloads only for now. The Windows auto-update channel remains the x64 latest.yml feed so ARM64 packaging cannot overwrite updater metadata.

Notes For Contributors

  • The active app is the Electron client. If you see older references to previous implementations, prefer opennow-stable/.
  • Root-level npm scripts are convenience wrappers around the opennow-stable workspace.
  • Before opening a PR, run npm run typecheck and npm run build.

For contribution workflow details, see .github/CONTRIBUTING.md.