You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 90a7f04
Browse filesBrowse the repository at this point in the historyBrowse files
> **Developer preview.** Best suited to contributors and experienced modders using disposable test copies. The file-safety, rollback and checksum issues from the [2026-09-20 review](docs/reviews/2026-09-20-project-review.md) are fixed and pinned by regression tests (the review's repro script now reports all nine behaviors fixed). No verified in-game benchmarks yet. **Read the [current limitations](docs/STATUS.md) before installing.**
19
20
20
-
**Have an RTX 20/30 and a single-player D3D12 game with native frame-generation support?** We are looking for early testers. [Download the Windows developer preview](../../releases/latest), try it on a backed-up test copy, and [share a success or failure report](https://github.com/ztwzeroo/DLSS5-FrameGen/issues/new?template=game-test.yml). We have not yet verified the combined setup in a real Windows game; your report helps establish which configurations actually work.
21
+
**Have an RTX 20/30 and a single-player D3D12 game with native frame-generation support?** We are looking for early testers. See the [recommended test games](docs/TEST-GAMES.md), [download the Windows developer preview](../../releases/latest), try it on a backed-up test copy, and [share a success or failure report](https://github.com/ztwzeroo/DLSS5-FrameGen/issues/new?template=game-test.yml). We have not yet verified the combined setup in a real Windows game; your report helps establish which configurations actually work.
21
22
22
23
<p>
23
24
<ahref="../../releases"><imgsrc="https://img.shields.io/badge/Download-Releases_(exe_/_linux)-d3ff6a?style=for-the-badge&labelColor=263021"alt="Download from Releases"></a>
@@ -55,6 +56,10 @@ flowchart LR
55
56
56
57
*Setup workflow only. This diagram is not a gameplay demonstration or performance result.*
*Animated CLI walkthrough: `fetch` → `install` → `doctor` → `report`. Illustrative output, not measured game results.*
62
+
58
63
## Will it work with my setup?
59
64
60
65
These are the **target requirements**, not a verified compatibility list.
@@ -70,6 +75,8 @@ These are the **target requirements**, not a verified compatibility list.
70
75
71
76
RTX 40/50, Vulkan games and games without native frame-generation support are outside this project's current target. Other mods may conflict. **Do not use this with anti-cheat or competitive multiplayer games.**
72
77
78
+
**Multiple NVIDIA GPUs:** when several cards are present, the tool picks the **first card with a supported architecture** (RTX 20/30) and `doctor` lists every card in the rig so you can confirm which one was selected; `install DIR --arch sm75|sm86` overrides the choice. Looking for a suitable game? See [Recommended test games](docs/TEST-GAMES.md).
79
+
73
80
## Get started
74
81
75
82
Use an independently backed-up or disposable game copy. Uninstall validates its manifest, skips externally modified files and restores pre-existing user configs — but no restore is a substitute for a backup. See the [known issues](docs/STATUS.md#known-issues).
@@ -92,6 +99,8 @@ py -m dlss_combo fetch
92
99
93
100
Prefer Git? Clone `https://github.com/ztwzeroo/DLSS5-FrameGen.git`, open that folder, and run the same commands. The Python package and CLI retain the original names `dlss_combo` and `dlss-combo`.
94
101
102
+
Add `--check-update` to any command (for example `py -m dlss_combo --check-update doctor DIR`) for a non-blocking check that a newer dlss-combo release exists — it prints one line and never interrupts the run, and it is skipped silently when offline.
103
+
95
104
### 2. Configure the image layer
96
105
97
106
Open the downloaded **DLSS5-Swapper portable EXE** in `~/dlss-combo-kit/swapper/`. Use its interface and upstream instructions to configure your **test copy** of the game. If the asset is a ZIP, follow the upstream extraction instructions first.
@@ -114,7 +123,11 @@ Enable frame generation in the game's graphics settings if available. After a te
114
123
py -m dlss_combo doctor "C:/Games/TestCopy/Binaries/Win64"
115
124
```
116
125
117
-
A successful file installation or detected ReShade folder does **not** prove either rendering layer is active. Diagnostics have known limitations; [report your observed result](https://github.com/ztwzeroo/DLSS5-FrameGen/issues/new?template=game-test.yml), including failures.
126
+
A successful file installation or detected ReShade folder does **not** prove either rendering layer is active. Diagnostics have known limitations; [report your observed result](https://github.com/ztwzeroo/DLSS5-FrameGen/issues/new?template=game-test.yml), including failures. To make that easy, `report` generates a paste-ready offline game-test report:
<summary><strong>More commands and tuning options</strong></summary>
@@ -131,6 +144,8 @@ Use `py -m dlss_combo --help` or `py -m dlss_combo install --help` for the full
131
144
|`install DIR --arch sm86`| Override the GPU-architecture check; driver checks still run. |
132
145
|`install DIR --proxy winmm.dll`| Pin a specific proxy DLL name (default order follows the upstream tool-class proxies first). |
133
146
|`install DIR --launch-swapper`| Launch the downloaded DLSS5-Swapper portable after installing (checksum-verified). |
147
+
|`report DIR`| Print a paste-ready markdown game-test report (offline, read-only). Add `--out FILE` to save it. |
148
+
|`--check-update` (before any command) | Non-blocking check for a newer dlss-combo release; skipped when offline. |
134
149
|`uninstall DIR`| Remove managed files. Read the file-safety and restoration issues first. |
135
150
136
151
6X requires a compatible 310.9 build **and** game. Setting 6X with 310.1 does not make that runtime support it. Some optimization tiers are also runtime-dependent. Consult the [upstream INI](https://github.com/sdli1995/dlssg_for_sm86/blob/main/dlssg_sm86.ini) for meanings and constraints.
| Offline Python tests |122 passing at v0.1.3; CI runs the suite on Windows/Linux/macOS on every push |
180
+
| Offline Python tests |155 passing at v0.2.0; CI runs the suite on Windows/Linux/macOS on every push |
166
181
| Review regression | The 2026-09-20 repro script reports all nine fixed behaviors |
167
182
| Release binaries | Windows EXE + Linux x64 built by GitHub Actions from each tagged commit |
168
183
| Windows game sessions | Not yet validated by this project |
@@ -197,9 +212,9 @@ There are no verified performance results for this combined toolkit yet. GPU, ga
197
212
</details>
198
213
199
214
<details>
200
-
<summary><strong>Why are some command-line messages in Chinese?</strong></summary>
215
+
<summary><strong>What language is the CLI output in?</strong></summary>
201
216
202
-
The English documentation covers setup, but the CLI currently includes Chinese messages. English CLI output is on the roadmap. Include the original output when reporting a problem.
217
+
Since v0.2.0 the CLI is English-only — help text, diagnostics and errors (internal source comments remain Chinese). If you see output from an older release that mixes languages, include the original output when reporting a problem, or update to the latest release.
203
218
204
219
</details>
205
220
@@ -214,8 +229,8 @@ We will add them when reproducible Windows/NVIDIA tests are available. The banne
214
229
215
230
-[x] Add regression protection for externally modified files and original configuration recovery.
216
231
-[x] Re-verify cached files and keep the previous kit usable if refresh fails.
232
+
-[x] Make the CLI English-only (help, diagnostics, errors), guarded by a regression test.
217
233
-[ ] Add an installation preview and improve per-session diagnostics with real game evidence.
218
-
-[ ] Add English CLI messages and clearer error guidance.
219
234
-[ ] Validate Windows behavior and publish reproducible RTX 20/30 game results.
220
235
221
236
See the [English status and known issues](docs/STATUS.md), [detailed audit (Chinese)](docs/reviews/2026-09-20-project-review.md), and [contributor guide](CONTRIBUTING.md).
Windows EXE 与 Linux x64 二进制(GitHub Actions 从打 tag 的提交构建,未签名),
@@ -73,11 +74,14 @@ Target environment: **Windows 10/11 x64, RTX 20 or RTX 30**, and a D3D12 game wi
73
74
**Single-player testing only. Do not use with anti-cheat or competitive multiplayer games.**
74
75
**仅限单机测试,不要用于带反作弊的游戏或竞技多人游戏。**
75
76
77
+
**Multiple NVIDIA GPUs / 多张 NVIDIA 显卡:** with several cards present, the tool picks the **first card with a supported architecture** (RTX 20/30) and `doctor` lists every card so you can confirm the selection; `install DIR --arch sm75|sm86` overrides the choice. 不知选哪款游戏?See [Recommended test games / 推荐测试游戏](docs/TEST-GAMES.md)(英文 / English).
78
+
多卡环境下,工具自动选择**第一张受支持架构**(RTX 20/30)的显卡,`doctor` 会列出全部显卡供确认;可用 `install DIR --arch` 覆盖。
79
+
76
80
## Getting started / 开始使用
77
81
78
-
The commands below are for experimental testing. Read the known issues and keep an independent backup before writing to any game directory.
82
+
The commands below are for experimental testing. Read the known issues and keep an independent backup before writing to any game directory. Not sure which game to start with? See [Recommended test games / 推荐测试游戏](docs/TEST-GAMES.md)(英文 / English).
The command remains **`dlss-combo`**; the public project name is **DLSS5-FrameGen**. Use `py -m dlss_combo` after installation if the command is not on your PATH.
ReShade, RenoDX or Feeder file markers alone do not prove DLSS 5 is active. Coexistence with other mods depends on the game and installation route. Measure the base frame rate before raising the frame-generation multiplier.
115
129
116
130
检测到 ReShade、RenoDX 或 Feeder 文件不代表 DLSS 5 已生效。与其他 mod 是否兼容取决于具体游戏和安装路线;提高插帧倍数前,请先测不插帧时的基础帧率。
117
131
132
+
`--check-update` 可加在任意命令前(如 `dlss-combo --check-update doctor DIR`),非阻塞检查是否有新版本,只打印一行、离线自动跳过。/ Prepend `--check-update` to any command for a non-blocking newer-release check — it prints one line and is skipped silently when offline.
133
+
118
134
## Roadmap / 改善路线
119
135
120
136
-[ ] Safe file ownership, bounded uninstall paths and original configuration restoration / 文件归属、卸载范围和原始配置还原。
0 commit comments