Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# The project owner reviews and merges every pull request.
* @phantoslayer21
122 changes: 122 additions & 0 deletions .github/ISSUE_TEMPLATE/game-compatibility-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
name: Game compatibility report
description: Report how WrongGPU behaves in a game
title: "[Game] "
labels: ["game-compatibility"]
body:
- type: markdown
attributes:
value: |
WrongGPU 0.6.0's tested games are listed in COMPATIBILITY.md. Other games are experimental.
Use only games without anti-cheat. Do not attach DLSS files or converted model files.
- type: input
id: game
attributes:
label: Game name
placeholder: "Example: Borderlands 4"
validations:
required: true
- type: input
id: game_version
attributes:
label: Game version or build
description: Shown in the game's menu or its store's update information.
validations:
required: true
- type: dropdown
id: store
attributes:
label: Where did you get the game?
options: [Steam, GOG, Epic Games Store, Xbox / Microsoft Store, Other]
validations:
required: true
- type: dropdown
id: api
attributes:
label: Graphics API the game used
options: [DirectX 12, DirectX 11, Vulkan, Not sure]
validations:
required: true
- type: input
id: upscalers
attributes:
label: Upscaling options the game offers
placeholder: "AMD FSR 3, AMD FSR 4, DLSS, XeSS"
validations:
required: true
- type: input
id: other_mods
attributes:
label: Other mods or overlays running
description: For example OptiScaler, ReShade, Cyber Engine Tweaks or MSI Afterburner. Write "none" if there are none.
validations:
required: true
- type: dropdown
id: result
attributes:
label: What happened?
options:
- Works well
- Works, with visual problems
- Game crashes or freezes
- Black or white screen
- No DLSS or other upscaler option
- WrongGPU does not become active (the overlay or Last run shows something else)
- Launcher refused or failed
- Other
validations:
required: true
- type: input
id: model_state
attributes:
label: WrongGPU state and test duration
description: Did the FPS overlay show DLSS → WrongGPU Model M (or WrongGPU RR), and what did Last run show? Did it stay active, and for how long?
validations:
required: true
- type: textarea
id: details
attributes:
label: Details
description: What looked wrong, when it happens and anything that changed it. Include reproduction steps and any flicker, ghosting, wrong colors, UI problems or stutter.
validations:
required: true
- type: input
id: settings
attributes:
label: Settings used
description: Output resolution, upscaler and quality mode, Ray Reconstruction on or off and its mode, ray tracing, frame generation, dynamic resolution and sharpening.
placeholder: "2560x1440, DLSS Quality, RR Fast, path tracing on, FG off, dynamic resolution off"
validations:
required: true
- type: input
id: fps
attributes:
label: Matched performance comparison (optional)
placeholder: "AMD FSR: average / 1% low; WrongGPU: average / 1% low; overlay ms in each mode"
- type: input
id: system
attributes:
label: Graphics card, driver, Windows version
placeholder: "RX 9070 XT, Adrenalin version, Windows 11 version"
validations:
required: true
- type: input
id: installer
attributes:
label: WrongGPU version
placeholder: "0.6.0"
validations:
required: true
- type: textarea
id: logs
attributes:
label: Logs and screenshots
description: Attach the ZIP from Collect logs on the game's page in the launcher, plus screenshots or a clip of any problem. Review logs before sharing; paths may include your Windows user name. See docs/TESTING-OTHER-GAMES.md.
- type: checkboxes
id: confirm
attributes:
label: Confirmations
options:
- label: This game has no anti-cheat, and I did not bypass a launcher refusal.
required: true
- label: I understand compatibility is experimental and tested at my own risk.
required: true
24 changes: 16 additions & 8 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
**What this changes and why**

**How it was tested** (CPU tests of BUILDING.md; GPU or game tests if any, with synthetic data)
**What each new or substantially changed file is based on** (public document, test result or own design)

**How it was tested** (CI runs the CPU tests; say what else you ran: GPU or game tests, with synthetic data)

**Checklist**
- [ ] I have made the clean-room statement of CONTRIBUTING.md (first pull request: copy it here).
- [ ] Every commit has a `Signed-off-by:` line.
- [ ] New source files carry `SPDX-License-Identifier: MIT`; this description says what each new or changed file is
based on.
- [ ] No files of the original upscaler (see CONTRIBUTING.md), no model data, game files, captures, screenshots or binaries; no paths, user or machine names of
my PC.
- [ ] I make the clean-room statement of
[CONTRIBUTING.md](https://github.com/phantoslayer21/wronggpu/blob/main/CONTRIBUTING.md#the-clean-room-statement)
for this and all my contributions (required once, in my first pull request).
- [ ] Every commit has a `Signed-off-by:` line (`git commit -s`; Developer Certificate of Origin 1.1).
- [ ] New source files carry the SPDX licence line for MIT, or are covered in `REUSE.toml`.
- [ ] No files of the original upscaler (see CONTRIBUTING.md), no model data, game files, captures, screenshots or
binaries; no paths, user or machine names of my PC.
- [ ] Any new third-party component is under a permitted licence and listed in THIRD-PARTY-NOTICES and REUSE.toml.
- [ ] Kernel changes meant to be bit-identical: the comparison is shown.
- [ ] Numbers in documents come with their measurement record.
- [ ] Kernel or runtime changes: I say whether the output is meant to stay bit-identical and show the comparison.

A maintainer scans every pull request on their side before merge (clean-room gate), reviews it, and tests it on a GPU
when the change touches kernels, the runtime, the front end or the Ray Reconstruction plugin (CONTRIBUTING.md, "How a
pull request gets merged").
90 changes: 90 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# CPU checks for every pull request and for main: licence (REUSE), line endings, the CPU builds and the CPU test set.
# No GPU job: kernels, the runtime library and the GPU tests are built and run by the maintainer (CONTRIBUTING.md).
name: CI

on:
pull_request:
push:
branches: [main]
workflow_dispatch:

permissions:
contents: read

concurrency:
group: ci-${{ github.ref }}
cancel-in-progress: ${{ github.event_name == 'pull_request' }}

jobs:
checks:
name: Licence and line endings
runs-on: windows-2022
steps:
- uses: actions/checkout@v4.2.2
- uses: actions/setup-python@v5.3.0
with:
python-version: "3.12"
- name: Line endings
run: python tools/ci/check_line_endings.py
- name: Licence (REUSE)
run: |
$PSNativeCommandUseErrorActionPreference = $true
python -m pip install --disable-pip-version-check reuse==5.0.2
reuse lint

build-and-test:
name: CPU build and tests
runs-on: windows-2022
timeout-minutes: 90
env:
CMAKE_BUILD_PARALLEL_LEVEL: "4"
PYTHONDONTWRITEBYTECODE: "1"
steps:
- uses: actions/checkout@v4.2.2
- uses: actions/setup-python@v5.3.0
with:
python-version: "3.12"
- name: Python packages
run: python -m pip install --disable-pip-version-check numpy ninja
- uses: ilammy/msvc-dev-cmd@v1.13.0
with:
arch: x64
- name: Converter
run: |
$PSNativeCommandUseErrorActionPreference = $true
cmake -S clean/converter -B out/converter -G Ninja -DCMAKE_BUILD_TYPE=Release -DCMAKE_POLICY_DEFAULT_CMP0091=NEW -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreaded
cmake --build out/converter
ctest --test-dir out/converter --output-on-failure
- name: Shared settings
run: |
$PSNativeCommandUseErrorActionPreference = $true
cmake -S clean/wgshared -B out/wgshared -G Ninja -DCMAKE_BUILD_TYPE=Release -DCMAKE_POLICY_DEFAULT_CMP0091=NEW -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreaded
cmake --build out/wgshared
ctest --test-dir out/wgshared --output-on-failure
- name: FSR front end (CPU tests)
run: |
$PSNativeCommandUseErrorActionPreference = $true
cmake -S clean/fsr -B out/frontend -G Ninja -DCMAKE_BUILD_TYPE=Release -DCMAKE_POLICY_DEFAULT_CMP0091=NEW -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreaded -DWG_MODEL_K=OFF -DWG_BUILD_ID=ci -DWG_BUILD_ASI=ON
cmake --build out/frontend
ctest --test-dir out/frontend --output-on-failure -R "unit|hosted|diagnostic|support" -E "overlay|split|d3d12"
- name: HIP runtime stand-in for the launcher tests
run: |
$PSNativeCommandUseErrorActionPreference = $true
New-Item -ItemType Directory -Force out/mockhip | Out-Null
cl /nologo /LD /O2 clean/installer/tests/mock_hip.c /Fe:out/mockhip/amdhip64_7.dll /Fo:out/mockhip/
"WRONGGPU_HIP_RUNTIME=$PWD\out\mockhip\amdhip64_7.dll" | Out-File -FilePath $env:GITHUB_ENV -Append -Encoding utf8
- name: Launcher core (CPU tests)
run: |
$PSNativeCommandUseErrorActionPreference = $true
cmake -S clean/installer -B out/launcher-tests -G Ninja -DCMAKE_BUILD_TYPE=Release -DCMAKE_POLICY_DEFAULT_CMP0091=NEW -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreaded -DWRONGGPU_PAYLOAD_DIR="$PWD/out/no-payload" -DWRONGGPU_TESTING=OFF -DWRONGGPU_PRESET_K=OFF -DWRONGGPU_DIRECT_ROUTE=OFF
cmake --build out/launcher-tests --target wg-core-tests launcher-core-tests coexist-core-tests
ctest --test-dir out/launcher-tests --output-on-failure -R "^(wg-core|launcher-core|coexist-core|source-size|wording)$"
- name: Ray Reconstruction plugin (build and CPU tests)
run: |
$PSNativeCommandUseErrorActionPreference = $true
$env:VSDEVCMD = Join-Path $env:VSINSTALLDIR 'Common7\Tools\VsDevCmd.bat'
python clean/rr_f/proxy/tools/build.py --out out/rr-proxy --no-tests
python tools/ci/run_proxy_core_tests.py out/rr-proxy
"WG_RR_PROXY_BUILD=$PWD\out\rr-proxy" | Out-File -FilePath $env:GITHUB_ENV -Append -Encoding utf8
- name: Python tests (CPU)
run: python tools/ci/run_python_tests.py --jobs 3
88 changes: 88 additions & 0 deletions COMPATIBILITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# Game compatibility

These notes apply to **WrongGPU 0.6.0**: Model M and Ray Reconstruction through the **WrongGPU edition of OptiScaler**,
set up by the WrongGPU launcher. "Ray Reconstruction" means WrongGPU's own Ray Reconstruction ran in the game; Model M
means super resolution only. This page grows with the community's reports: see [How to add your game](#how-to-add-your-game).

## Tested games

Tested on a Radeon RX 9070 XT.

| Game | Model M | Ray Reconstruction | Notes |
| --- | --- | --- | --- |
| **Cyberpunk 2077** | Yes | Yes | Our main test game. |
| **Borderlands 4** | Yes (tested with 0.4.5) | Yes | Ray Reconstruction needs one Engine.ini setting, and the game removes it on every start. After the install the launcher asks: **Fix it for me** adds the setting and makes the file read-only (uninstalling WrongGPU undoes both); **Show me how** gives the steps. The game creates Ray Reconstruction itself, so it needs the WrongGPU edition of OptiScaler. About 1.6 ms a frame at 1080p output (from 642x361): 1.589 ms in `clean/installer/tests/logs/bl4-rr-only.log`. |
| **RESIDENT EVIL requiem** | Yes | Yes, experimental | Needs **REFramework**, installed by you first: the game blocks OptiScaler without it. WrongGPU never installs, downloads or replaces REFramework; the launcher tells you when it is missing. Ray Reconstruction runs when the game's **Ray Tracing** setting is **Path Tracing** and its upscaler is **DLSS**. The game prepares Ray Reconstruction at its first start, not in the launcher. Very occasionally a single frame comes out far too bright or too dark at a scene change (see Known limits). |
| **Hogwarts Legacy** | Yes | Not available | Since the game's November 2026 update its Ray Reconstruction option is greyed out and WrongGPU's Ray Reconstruction isn't available, so the launcher doesn't offer it there. Ray Reconstruction worked before that update. |
| **Marvel's Spider-Man 2** | Yes (choose **FSR** as the game's upscaler: its menu doesn't offer DLSS) | Experimental opt-in, not recommended | With Ray Reconstruction the game often freezes the GPU or crashes. The release notes explain the opt-in for those who want to try it anyway. |
| **LEGO Batman** | Yes | Not offered | The game's menu has no Ray Reconstruction option. |
| **The Witcher 3 Remastered** | Earlier version (0.4.5) | — | Not retested with 0.6.0. |
| **Control** | Earlier versions | — | Not retested with 0.6.0. This result does not cover Control Resonant. |
| **Crimson Desert** | Earlier versions | — | Not retested with 0.6.0. |
| **Ratchet & Clank: Rift Apart** | Earlier versions | — | Not retested with 0.6.0. |
| **007 First Light** | Unsupported | Unsupported | Crashes at start under OptiScaler. |
| **Other games** | Experimental / unverified | Experimental / unverified | OptiScaler support and the launcher accepting a game alone do not establish WrongGPU compatibility. [Send a report](https://github.com/phantoslayer21/wronggpu/issues/new?template=game-compatibility-report.yml). |

A successful run does not cover every game build, graphics setting, quality mode or frame-generation configuration.
Results from earlier WrongGPU versions are labelled as such. The Borderlands 4 figure is Ray Reconstruction's own GPU
time per frame, from `clean/installer/tests/logs/bl4-rr-only.log`, a trimmed excerpt of WrongGPU's plugin log from a
test run (about 1.59 ms per frame, render 642x361, output 1920x1080). The Ray Reconstruction mode and the WrongGPU
version of that run are not recorded in the excerpt.

## Requirements for another game

- A **DirectX 12 game supported by OptiScaler**, with upscaler inputs that provide the color, depth and motion
information WrongGPU needs. Choose **DLSS** as the game's upscaler.
- **Radeon RX 9070 or RX 9070 XT** (RX 9060 XT / RX 9060 supported, not yet tested) and a recent AMD Adrenalin driver.
No AMD HIP runtime is needed.
- A local DLSS super resolution file of version **310.5 or newer** for Model M and, for Ray Reconstruction, a **DLSS Ray
Reconstruction file 310.7 or newer**, each from any game or app on your PC (not necessarily the game you play). The
launcher looks for them in your installed games.
- For Ray Reconstruction, the game must use DLSS Ray Reconstruction through game interface version 2.7, 2.8 or 2.14, or
create it directly. Games on other game interface versions keep their own denoiser. Games that create Ray
Reconstruction themselves (for example Unreal Engine games with their own plugin) need the WrongGPU edition of
OptiScaler.
- **No anti-cheat.** Do not bypass a launcher refusal.

Older Radeon cards, DirectX 11 and Vulkan are unsupported in this release.

## Known limits

- Ray Reconstruction can still show occasional visual artifacts, such as ghosting on thin lines in reflections, or
blotches in Cyberpunk 2077 with path tracing.
- RESIDENT EVIL requiem: very occasionally a single frame comes out far too bright or too dark at a scene change (after
loading a save, or during flashes of lightning). It lasts one frame.
- Preset K is not included in 0.6.0.
- Radeon RX 9060 XT / RX 9060: supported, not yet tested.
- Without a DLSS Ray Reconstruction file of version 310.7 or newer on your PC, the game keeps its own denoiser and the
launcher says so.
- After an AMD driver update (or a WrongGPU update) the launcher prepares Ray Reconstruction again in the background; a
game started before that is done prepares it at its first start.
- Frames the network can't use (for example a render size larger than the output, or textures too small during an
intro) are passed through or go to AMD FSR, and WrongGPU carries on with the next normal frame.

## How to add your game

Anyone can add a game to this page.

1. Test it as [Testing WrongGPU in other games](docs/TESTING-OTHER-GAMES.md) describes: a game without anti-cheat, the
FPS overlay or the game page's **Last run** showing that WrongGPU's Model M (or Ray Reconstruction) really ran, at
least one longer play session, and the settings you used.
2. Report it with the [game compatibility form](https://github.com/phantoslayer21/wronggpu/issues/new?template=game-compatibility-report.yml)
(or in #bug-reports on the [WrongGPU Discord server](https://discord.gg/745z9MfKwm)), with the zip from **Collect
logs**.
3. Optionally open a pull request that adds a row to the table above: the game, Model M and Ray Reconstruction
results, what you tested on (GPU, driver, WrongGPU version) and a link to your report. A timing goes in only with
the log line it comes from (game, resolution, mode, WrongGPU version). One report marks a game as "reported"; a
maintainer moves it to "tested" after checking it.

## Testing and reports

Follow [Testing WrongGPU in other games](docs/TESTING-OTHER-GAMES.md). AMD FSR frames and passed-through frames are not
Model M or Ray Reconstruction results: check the FPS overlay ("DLSS → WrongGPU Model M" or "DLSS → WrongGPU RR") and
the game page's **Last run**.

Identify the game build, GPU and driver, WrongGPU version, output resolution, input upscaler, quality mode and whether
Ray Reconstruction was on (and its mode). Include the support zip from **Collect logs** on the game's page in the
launcher, reproduction steps, visual problems and matched performance comparisons. Community reports help establish
compatibility, but no fixed report count automatically makes a game validated.
Loading
Loading