Skip to content

About

Linux Desktop client for Nvidia's GeForce NOW game streaming service.

Topics

Resources

Contributing

Security policy

Stars

634 stars

Watchers

13 watching

Forks

Repository files navigation

Donate Latest Release Build Status License

GFN Electron

Unofficial desktop client for Nvidia GeForce NOW on Linux, delivering a native Electron-based experience with Wayland support, Steam Deck integration, and optional Discord rich presence.

Preview screenshot

πŸ“‘ Table of Contents

βš–οΈ Disclaimers

Affiliation

This project and its contributors are not affiliated with Nvidia, nor with the GeForce NOW product. This repository does not include Nvidia or GeForce NOW software. It provides an Electron wrapper that loads the official GeForce NOW web application.

Expectations

This is a free and open-source project maintained by volunteers. Contributions occur as contributor availability permits.

✨ Capabilities

  • Native Wayland support with compositor-aware behaviour
  • Steam Deck integration with automatic fullscreen and virtual keyboard overlay
  • Discord rich presence integration (optional)
  • Hardware-accelerated video pipeline using VA-API and GPU rendering flags
  • GPU crash fallback strategy for rendering stability
  • Keyboard shortcuts for fullscreen, navigation, and developer tooling
  • Direct game launch via CMS identifier
  • Stream quality override for resolution and refresh rate reporting

πŸš€ Usage

Launch the client from a terminal:

npm start

Keyboard Shortcuts

Shortcut Action
F11 / Super+F Toggle fullscreen
Alt+Home Navigate to the home page
Alt+F4 Exit the application
Ctrl+Shift+I Toggle developer tools
Ctrl+Shift+P Create a desktop shortcut for the active game

Command-line Arguments and Environment Variables

Argument Environment Variable Description
--direct-start <cmsId> GFN_DIRECT_START_ID=<cmsId> Launch directly into a game by CMS identifier
--disable-rpc GFN_DISABLE_RPC=1 Disable Discord rich presence
- GFN_ENABLE_EXPERIMENTAL_GPU_FLAGS=1 Re-enable aggressive GPU flags for experimentation
- GFN_RESOLUTION_WIDTH=<px> Override reported stream width
- GFN_RESOLUTION_HEIGHT=<px> Override reported stream height
- GFN_REFRESH_RATE=<hz> Override reported stream refresh rate

More Documentation

⚠️ Known Limitations

  • Application behaviour depends on the current GeForce NOW web interface and can change when upstream web functionality changes.
  • Manual installation packages receive less maintainer support than the Flatpak distribution.

πŸ–₯️ System Requirements

  • OS: Linux
  • Runtime: Node.js 20 or later
  • Graphics: GPU drivers with WebGL and hardware video decode support are recommended

πŸ“¦ Installation

Obtain it from FlatHub Obtain it from AUR Obtain it from GitHub

CLI Installation

flatpak install flathub io.github.hmlendea.geforcenow-electron

or, for Arch Linux users via AUR:

paru -S geforcenow-electron

or, if you use yay:

yay -S geforcenow-electron

πŸ› οΈ Development

Requirements

Setup

npm install

Build

npm run build

Run

npm start

Dependencies

Package Purpose
discord-rich-presence Discord RPC integration
electron-localshortcut Application-local keyboard shortcuts
electron-updater Automatic application updates
find-process Process discovery for integration logic

βš™οΈ GitHub Actions

Workflow Purpose What it does
Node.js CI Install locked dependencies and package the application Runs on pushes to and pull requests against master; sets up Node.js 20 with npm caching, installs with npm ci, and builds with npm run build
GitHub Release Build and publish release artefacts Runs on published releases; sets up Node.js 20 with npm caching, installs with npm ci, builds with npm run build, and publishes the Linux ZIP and AppImage artefacts with softprops/action-gh-release
CodeQL Static security analysis Runs on pushes to and pull requests against master and on a weekly schedule; analyses JavaScript and TypeScript

πŸ—‚οΈ Project Structure

The key directories and files are:

Path Purpose
scripts/main.js Electron main-process lifecycle, window initialisation, and runtime flags
scripts/preload.js Preload entry point; the page compatibility script is installed by the main process
scripts/renderer.js Reserved renderer module; the hosted GeForce NOW page owns the UI
scripts/rpc.js Discord rich presence integration
scripts/windowManager.js Window creation and management logic
com.github.hmlendea.geforcenow-electron.desktop Desktop entry metadata

πŸ“š Documentation

Full documentation is available in the project Wiki:

πŸ—οΈ Architecture

See ARCHITECTURE.md for a structural synopsis and component interactions.

🀝 Contributing

You are welcome to submit any suggestion, feedback, or modification to this project.

When doing so, please:

  • Maintain cross-platform compatibility
  • Submit focused pull requests that conform to the existing code style
  • Maintain your branch synchronised with master
  • Revise the documentation when functionality changes
  • Properly test all modifications, including edge cases and error conditions
  • Raise a new issue for problems or suggestions

See the contributing guidelines for details on how to report issues, suggest enhancements, and submit changes.

πŸ”’ Security

For information on reporting security vulnerabilities, see SECURITY.md.

πŸ›‘οΈ Privacy

For information on how this application handles personal data, see PRIVACY.md.

πŸ’¬ Support

For support, please open an issue.

πŸ’ Project Engagement

Discovered a problem or have a suggestion? Open an issue!

If you find this project useful, consider funding it or starring ⭐️ it on GitHub!

Donate

πŸ“„ License

This project is being distributed under the GNU General Public License v3.0 or later. See LICENSE.md for details.

About

Linux Desktop client for Nvidia's GeForce NOW game streaming service.

Topics

Resources

Contributing

Security policy

Stars

634 stars

Watchers

13 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages

Generated from electron/minimal-repro