Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
721fe85
feat: add opennow-stable Electron rewrite with working keyboard/gamep…
zortos293 Feb 13, 2026
c0b4252
feat: migrate to Electron 40/React 19 and modernize streaming
zortos293 Feb 15, 2026
c862224
feat(opennow-stable): improve mac build flow, settings shortcuts, and…
zortos293 Feb 15, 2026
386ca01
chore: remove legacy tauri/rust stack from root
zortos293 Feb 15, 2026
bef1a9f
ci: consolidate electron workflows into auto-build
zortos293 Feb 15, 2026
edb1fca
ci: track electron lockfile for npm cache
zortos293 Feb 15, 2026
9ed7d9a
ci: make auto-build cache lockfile path resilient
zortos293 Feb 15, 2026
054421c
build: add electron-builder metadata for ci packaging
zortos293 Feb 15, 2026
90a1cb7
Add repository field to package.json
zortos293 Feb 15, 2026
8d5e6cc
docs: refresh README badges and electron migration notes
zortos293 Feb 15, 2026
fa51c3d
Add README reasons section
zortos293 Feb 15, 2026
9022cc9
Polish README key features section
zortos293 Feb 15, 2026
74bc1e0
Polish README highlights
zortos293 Feb 15, 2026
ab2a734
Improve performance stats UI
zortos293 Feb 15, 2026
054d549
Update stop shortcut bindings
zortos293 Feb 15, 2026
41bd00c
Fix exit prompt shortcut handling
zortos293 Feb 15, 2026
7430248
Show game banner on loading
zortos293 Feb 15, 2026
981dfa8
Fix: Latency fixes and pipeline optimalization
zortos293 Feb 15, 2026
511c8ec
Fix fullscreen and escape handling
zortos293 Feb 15, 2026
a64ad9b
Fix escape handling in fullscreen
zortos293 Feb 15, 2026
98a8873
Fix ESC handling in fullscreenstream
zortos293 Feb 16, 2026
94d32fa
Adjust ESC hold timing for stream
zortos293 Feb 16, 2026
844979e
Sync auto-build release workflow
zortos293 Feb 16, 2026
2983cb0
Add-GFN-auth-subscription-updates-and-refresh-app-UI
zortos293 Feb 16, 2026
07b15d5
Center navbar items and improve info
zortos293 Feb 16, 2026
4e05372
feat(stream):add-session-timer-and-webrtc-time-limit-warnings
zortos293 Feb 16, 2026
dc5f52b
Update README to reflect full H.265 codec support.
zortos293 Feb 16, 2026
76d7576
Update README to reflect 5K resolution and Install-to-Play support.
zortos293 Feb 16, 2026
ad89019
Improve README accuracy by updating feature statuses and clarifying n…
zortos293 Feb 16, 2026
65b6b58
Update README feature comparison for accuracy.
zortos293 Feb 16, 2026
1cad9db
Center navbar stats and add modal
zortos293 Feb 16, 2026
e00d6f9
Migrate supported CI/CD runners to Blacksmith for improved build perf…
zortos293 Feb 16, 2026
3afcbf4
Fix invalid workflow file by cleaning up null byte corruption.
zortos293 Feb 16, 2026
717e228
Add navbar active session tracking
zortos293 Feb 16, 2026
0335424
Fix arm64 deb packaging by using system fpm to resolve architecture m…
zortos293 Feb 16, 2026
1726f9b
Del: Junk
zortos293 Feb 16, 2026
223fba2
Add README banner and icon
zortos293 Feb 16, 2026
30f2c5e
Add logo and support info
zortos293 Feb 16, 2026
762e4c5
Add logo and support card to README
zortos293 Feb 16, 2026
7a2cbaf
Merge main into dev: resolve conflicts for v0.2.4 migration
zortos293 Feb 16, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 19 additions & 87 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,99 +1,31 @@
# Contributing to GFNClient
# Contributing to OpenNOW

Thank you for your interest in contributing to GFNClient! This document provides guidelines and instructions for contributing.
Thanks for contributing.

## Getting Started
## Project Layout

### Prerequisites
- Active desktop client: `opennow-stable/` (Electron + React + TypeScript)

- [Rust](https://rustup.rs/) (latest stable)
- [Bun](https://bun.sh/) (latest)
- Platform-specific dependencies for Tauri

### Development Setup
## Local Setup

```bash
# Clone the repository
git clone https://github.com/zortos293/GFNClient.git
cd GFNClient

# Install dependencies
bun install

# Run in development mode
bun tauri dev
git clone https://github.com/OpenCloudGaming/OpenNOW.git
cd OpenNOW/opennow-stable
npm install
npm run dev
```

## How to Contribute

### Reporting Bugs

1. Check if the bug has already been reported in [Issues](https://github.com/zortos293/GFNClient/issues)
2. If not, create a new issue using the **Bug Report** template
3. Provide as much detail as possible, including:
- Steps to reproduce
- Expected vs actual behavior
- Platform and version information
- Logs and screenshots

### Suggesting Features

1. Check if the feature has already been requested in [Issues](https://github.com/zortos293/GFNClient/issues)
2. Create a new issue using the **Feature Request** template
3. Clearly describe the use case and proposed solution

### Submitting Pull Requests

1. Fork the repository
2. Create a feature branch: `git checkout -b feature/your-feature-name`
3. Make your changes
4. Test your changes locally on your platform
5. Commit with clear, descriptive messages
6. Push to your fork
7. Open a Pull Request using the PR template

## Code Guidelines

### Rust (Backend)

- Follow standard Rust conventions
- Use `cargo fmt` before committing
- Run `cargo clippy` and address warnings
- Add appropriate error handling

### TypeScript (Frontend)
## Build and Checks

- Use TypeScript strict mode
- Follow existing code patterns
- Use meaningful variable and function names

### Commit Messages

Use clear, descriptive commit messages:

```
type: short description

Longer description if needed

Fixes #123
```bash
npm run typecheck
npm run build
npm run dist
```

Types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`

## Platform-Specific Notes

### macOS
- H.265/HEVC and Opus Stereo features are macOS-only due to VideoToolbox/CoreAudio
- Fullscreen uses Tauri's window API instead of browser API

### Windows/Linux
- H.265 codec option is disabled (WebRTC limitation)
- Test with appropriate GPU drivers

## Questions?

- Open a **Question** issue
- Check existing issues and discussions
## Pull Requests

Thank you for contributing!
1. Create a feature branch
2. Keep commits focused and clear
3. Ensure `typecheck` and `build` pass locally
4. Open a PR with a concise summary
Loading