Compare commits
5
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0cce0ac0ce | ||
|
|
4cc4c3e9c2 | ||
|
|
27f537a2d7 | ||
|
|
44c031faca | ||
|
|
f66d98eb78 |
No files matched your search
@@ -0,0 +1,100 @@
|
||||
# ACCESSIBILITY.md (beta.35, D88) sends every accessibility barrier here. It is its own form rather than part of the bug
|
||||
# report because a barrier needs different facts: what the reporter uses to read or operate the screen, and how far it
|
||||
# stops them. Nothing here asks about the reporter themself.
|
||||
name: Accessibility problem
|
||||
description: Something in FrameLedger cannot be reached, read or seen — with the keyboard, a screen reader, a contrast theme, Magnifier or another aid
|
||||
labels: [accessibility]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thank you for telling us. **You never need to tell us anything about yourself or a disability** — what you use
|
||||
and what happened is enough. Screenshots and recordings help but are optional.
|
||||
|
||||
If FrameLedger refused to hook a game, stopped measuring or turned hooking off **without your knowing** — a
|
||||
safety notice you could not perceive — say so below: it is a safety problem too, and it is handled first.
|
||||
|
||||
What FrameLedger aims for and what it cannot do yet: [ACCESSIBILITY.md](https://github.com/poli0981/frameledger/blob/main/ACCESSIBILITY.md).
|
||||
|
||||
- type: textarea
|
||||
id: task
|
||||
attributes:
|
||||
label: What were you trying to do?
|
||||
placeholder: 'e.g. switch hooking on for a game, read a session''s frame rate, answer the terms window'
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: what-happened
|
||||
attributes:
|
||||
label: What happened instead?
|
||||
description: What you heard, saw or could not do — and what you expected.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: steps
|
||||
attributes:
|
||||
label: How to get there
|
||||
placeholder: |
|
||||
1. Open Games (Ctrl+2)
|
||||
2. Tab to …
|
||||
3. …
|
||||
|
||||
- type: input
|
||||
id: app-version
|
||||
attributes:
|
||||
label: FrameLedger version
|
||||
description: Help ▸ About
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: os
|
||||
attributes:
|
||||
label: Windows version
|
||||
placeholder: 'Windows 11 26100.2314'
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: aid
|
||||
attributes:
|
||||
label: What do you use?
|
||||
multiple: true
|
||||
options:
|
||||
- Keyboard only
|
||||
- Narrator
|
||||
- NVDA
|
||||
- JAWS
|
||||
- Windows Magnifier
|
||||
- A Windows contrast theme
|
||||
- Voice Access or other speech input
|
||||
- Display scaling or a large text size
|
||||
- Something else (say below)
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: aid-version
|
||||
attributes:
|
||||
label: Its version, if you know it
|
||||
placeholder: 'e.g. NVDA 2026.1'
|
||||
|
||||
- type: dropdown
|
||||
id: severity
|
||||
attributes:
|
||||
label: How much does it stop you?
|
||||
description: Optional — the maintainer sets it when reading the report (ACCESSIBILITY.md, How serious it is).
|
||||
options:
|
||||
- Not sure
|
||||
- Critical — I cannot do the task at all
|
||||
- Serious — only with great difficulty or a workaround
|
||||
- Moderate — it is tiring or inconsistent
|
||||
- Minor — it barely gets in the way
|
||||
|
||||
- type: textarea
|
||||
id: more
|
||||
attributes:
|
||||
label: Anything else
|
||||
description: A screenshot, a recording, or a diagnostic file from Help ▸ Report a bug (built on your PC; you choose what to attach).
|
||||
@@ -30,6 +30,18 @@ review questions from `docs/19_SAFETY_AND_ANTICHEAT.md` §Review checklist.
|
||||
|
||||
**Measured overhead:** <!-- e.g. "0.31 µs/present, game Avg FPS delta -0.2%" -->
|
||||
|
||||
## User-interface changes only
|
||||
|
||||
Skip this section if the PR does not change what the App shows. Otherwise — `ACCESSIBILITY.md` §For contributors,
|
||||
`docs/08_UI.md` §Accessibility:
|
||||
|
||||
- [ ] Every control that shows no text of its own has a name, from `.resx` in `en`, `vi` and `ja`
|
||||
- [ ] Colours come from the theme only, and nothing is shown by colour alone
|
||||
- [ ] Everything new can be reached and used with the keyboard, in reading order, and Esc leaves a new dialog
|
||||
- [ ] `ACCESSIBILITY.md` (and `LIMITATIONS.md`) changed in this PR if what works or what does not moved
|
||||
|
||||
**Checked by hand:** <!-- e.g. "Tab through the new card with the mouse unplugged; Narrator reads its name and value" -->
|
||||
|
||||
## Safety-string changes only
|
||||
|
||||
- [ ] `Safety_*` resx keys have human-reviewed `ja` (never machine-drafted — `docs/09_I18N.md`)
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# The GitHub Wiki is a copy of the repository's own pages (D53/D54, the owner, 2026-10-07): wiki/ (Home, the sidebar,
|
||||
# the developer pages) and guide/ (the user guide, which is the End-user part) with LIMITATIONS.md, assembled and checked
|
||||
# the developer pages) and guide/ (the user guide, which is the End-user part) with LIMITATIONS.md and ACCESSIBILITY.md, assembled and checked
|
||||
# by tools/wiki-build.ps1 - the check build.ps1 runs as `wiki-check`. A page edited on the Wiki tab is overwritten here;
|
||||
# edit wiki/ or guide/ instead (docs/13_CI_CD.md §wiki.yml).
|
||||
#
|
||||
|
||||
@@ -0,0 +1,145 @@
|
||||
# Accessibility
|
||||
|
||||
FrameLedger should be usable by everyone who plays games on a Windows PC — with a keyboard alone, with a screen reader,
|
||||
with a Windows contrast theme or Magnifier, and without telling colours apart. This page says what FrameLedger aims
|
||||
for, what works today, how that was checked, what does not work yet and what to do instead, and how to tell us about a
|
||||
barrier. It is written for the person who has just met one; the details for developers are in
|
||||
[`docs/08_UI.md`](docs/08_UI.md#accessibility).
|
||||
|
||||
FrameLedger is a desktop program: its own window, its dialogs, its document windows, the icon by the clock and the
|
||||
notices Windows shows for it. It draws nothing inside a game, so it cannot make a game itself any easier to use.
|
||||
|
||||
*Beta software: this page describes version 0.1.0-beta.35. In the app: Help ▸ Accessibility.*
|
||||
|
||||
## What FrameLedger aims for
|
||||
|
||||
- **WCAG 2.2 at level AA**, applied to desktop software as W3C's
|
||||
[WCAG2ICT](https://www.w3.org/TR/wcag2ict-22/) guidance explains. This is a goal that guides the work, not a claim:
|
||||
no formal evaluation has been made, and FrameLedger does not say it conforms to any standard.
|
||||
- **Every task can be done with the keyboard alone.**
|
||||
- **A screen reader can read every control and every value**, in the language FrameLedger is shown in, and hears what
|
||||
changes — a notice, a result.
|
||||
- **Text and controls keep their contrast** in the light and the dark theme and under Windows contrast themes, and
|
||||
**colour is never the only way something is shown.**
|
||||
- **Everything stays sharp at any display scale**, and when the window moves between screens.
|
||||
|
||||
## What works today
|
||||
|
||||
### The keyboard
|
||||
|
||||
| Keys | What they do |
|
||||
|---|---|
|
||||
| **Ctrl+1** … **Ctrl+5** (also with the numeric keypad) | Open Dashboard, Games, Compare, Logs and Settings. |
|
||||
| **Alt** or **F10**, then the arrow keys and **Enter** | Move to the menus. **Alt** with a menu's underlined letter opens it (*File*, *Tools*, *Help* in English). |
|
||||
| **Tab** and **Shift+Tab** | Move through a page or a dialog in reading order. |
|
||||
| The **arrow keys**, **Home**, **End**, **Page Up**, **Page Down** | Move inside a list or a table — a game's sessions, the games list, the Compare list, the import checklist. |
|
||||
| **Enter** or **Space** | Press the button, switch or box that has the focus. **Enter** on a game in the list opens its page. |
|
||||
| **Esc** | Closes a dialog the way its **Close** or **Cancel** button does: nothing is changed. A dialog that has no Close button waits for an answer, and the terms window has its own **Decline** and **Accept**. |
|
||||
| **Enter** in the hooking warning | Switches hooking on once the phrase is typed exactly; before that it does nothing. |
|
||||
|
||||
The same keys are in the user guide, [The screens](guide/07-screens.md#keyboard-and-mouse).
|
||||
|
||||
### Screen readers
|
||||
|
||||
- **Every page, menu, dialog and setting can be reached and used with Narrator.** The owner checked this on
|
||||
2026-11-09, keyboard only with the mouse disconnected, on 0.1.0-beta.34 and 0.1.0-alpha.3, and found no fault.
|
||||
- **Every button, switch and box that shows no text of its own has a name**, from the same translations as the screen.
|
||||
- **Dialogs say they are dialogs** and keep the focus inside them until they close.
|
||||
|
||||
### Seeing the screen
|
||||
|
||||
- **Light, dark, or the same as Windows** (Settings ▸ Theme). FrameLedger takes every colour from the theme, and every
|
||||
text is measured against what is painted under it, in both themes.
|
||||
- **The colour a game's picture lends its page** is used only as far as every text on it still reads, and never under a
|
||||
contrast theme.
|
||||
- **Windows display scaling** at any size, on every screen; **Magnifier** (Windows logo key + Plus) works as with any
|
||||
program.
|
||||
- Labels such as *Hooking on* and *Not installed*, and the ray-tracing chips, always carry their words; a chip that reads
|
||||
*N/A* is also drawn with a dashed edge.
|
||||
|
||||
### Languages
|
||||
|
||||
FrameLedger is shown in English, Vietnamese or Japanese (Settings ▸ Language), and the names a screen reader reads come
|
||||
from the same translations. The documents — the user guide, this page, the legal texts — are in English.
|
||||
|
||||
## How it is checked
|
||||
|
||||
- **On every build**, by the project's own tests: every control that shows no text has a name; no colour is written
|
||||
into a screen; every text reads against its background in both themes and after a theme switch; **Esc** closes the
|
||||
open dialog without an answer; **Ctrl+1** … **Ctrl+5** open the pages in their order; the program declares it follows
|
||||
each screen's scaling.
|
||||
- **By hand**: the owner's pass of 2026-11-09 above, repeated for each release that changes a screen.
|
||||
- **Not tested yet**: NVDA, JAWS, Voice Access, touch, Windows 10, and other people's PCs. They should work through the
|
||||
same Windows interface Narrator uses, but nobody has checked.
|
||||
|
||||
## Known limitations
|
||||
|
||||
Each one with what to do instead. A barrier that is not on this list is worth reporting.
|
||||
|
||||
- **Charts are pictures.** Tab reaches a chart, but its keys do not work reliably yet and a screen reader cannot read
|
||||
its points or its name. The numbers are written out elsewhere: a session's figures and *Statistics per series* in its
|
||||
summary, the table under the Compare chart, the list of changes under a trend chart, and **File ▸ Export ▸ Session
|
||||
CSV** or **Session JSON**.
|
||||
- **Some names a screen reader hears are wrong.** Items in drop-down lists and several lists can be read by an
|
||||
internal name rather than the text shown; the frame-rate readout, the ray-tracing chips and the text of the notices
|
||||
above the page are not read as text; some buttons in a list all have the same name, such as *Open*.
|
||||
- **Nothing is announced when it appears** — a safety notice, a banner, a short message at the bottom of the window or
|
||||
the result of **Tools ▸ Database maintenance**. A safety notice stays above the page until you answer it.
|
||||
- **Headings are not marked as headings**, so a screen reader's heading keys do not move between the sections of a
|
||||
page.
|
||||
- **Windows contrast themes are not followed.** With Settings ▸ Theme on *System*, a contrast theme can give parts of
|
||||
the window the wrong colours. Choose **Light** or **Dark** there: both keep their contrast.
|
||||
- **The short messages at the bottom of the window close after four seconds.**
|
||||
- **Windows' text size setting** (Settings ▸ Accessibility ▸ Text size) **is not followed.** Use display scaling
|
||||
(Settings ▸ System ▸ Display ▸ Scale) or Magnifier.
|
||||
- **Page changes slide in** even when Windows' animation effects are off.
|
||||
- **Pausing capture is only in the menu of the icon by the clock.**
|
||||
- **The windows Windows itself shows** — choosing a file, the administrator prompt — are Windows', not FrameLedger's.
|
||||
|
||||
## Report an accessibility problem
|
||||
|
||||
1. Open an issue with the
|
||||
[Accessibility problem form](https://github.com/poli0981/frameledger/issues/new?template=accessibility.yml).
|
||||
2. Say what you were trying to do and what happened instead; your FrameLedger version (Help ▸ About) and your Windows
|
||||
version; and what you use — the keyboard alone, Narrator, NVDA, JAWS, Magnifier, a contrast theme — with its version.
|
||||
The steps to get there help, and so does a screenshot or a recording, but neither is required. **You never need to
|
||||
tell us anything about yourself or a disability.**
|
||||
3. If you want to attach details from your PC, **Help ▸ Report a bug** builds them into a file on your PC and shows you
|
||||
what is inside first; nothing is uploaded by itself.
|
||||
|
||||
**A safety notice you could not perceive** — hooking refused, measuring stopped or hooking turned off, without your
|
||||
knowing — is a safety problem as well: say so in the report, and it is handled first.
|
||||
|
||||
### How serious it is
|
||||
|
||||
You do not have to choose; the maintainer sets it when reading the report.
|
||||
|
||||
| Severity | What it means | For example |
|
||||
|---|---|---|
|
||||
| **Critical** | A task cannot be done at all. | Hooking cannot be switched off with the keyboard; the terms window or the hooking warning cannot be answered; a safety notice cannot be read. |
|
||||
| **Serious** | It can be done only with great difficulty or a workaround. | A value can be read only by exporting the session. |
|
||||
| **Moderate** | It is tiring or inconsistent. | A name that differs from what the screen shows; an extra stop for Tab. |
|
||||
| **Minor** | It barely gets in the way. | A tooltip the keyboard cannot reach, when its words are shown elsewhere too. |
|
||||
|
||||
### What happens next
|
||||
|
||||
FrameLedger has one maintainer, so there are no promised times. Every report is read and answered, without doubting what
|
||||
you describe. Critical problems come before other work; a workaround, when there is one, is written on the issue; the
|
||||
fix ships in a release, and the issue is closed once you say it works for you — or when a fix has been out for a while
|
||||
and nobody has answered.
|
||||
|
||||
## Who looks after this
|
||||
|
||||
The project's owner, poli0981, keeps this page and the checks behind it, and reviews both for each release that changes
|
||||
a screen. A change to FrameLedger that moves anything on this page changes the page in the same pull request.
|
||||
|
||||
## For contributors
|
||||
|
||||
A change to the App keeps what the tests above hold: a name, from the translations in all three languages, for every
|
||||
control that shows no text; colours only from the theme. Say in the pull request what you checked with the keyboard
|
||||
and with Narrator. The rules and the checks are in [`docs/08_UI.md`](docs/08_UI.md#accessibility) and
|
||||
[`CONTRIBUTING.md`](CONTRIBUTING.md).
|
||||
|
||||
## Feedback
|
||||
|
||||
To improve this page, open an issue or a pull request. A barrier goes through the form above, so that it is not lost.
|
||||
+19
-56
@@ -37,65 +37,26 @@ numeric core and does not move; the heading is the full version — corrected 20
|
||||
|
||||
### Added
|
||||
|
||||
- **Filters on Games and Compare** (owner request 2026-11-06, decision D85). Games: store, engine, state, installed and
|
||||
played, beside the search and sort, with *Clear filters*; the title counts what is shown of all. Compare: game, tier
|
||||
and frame generation over every session (it listed the newest 200), with a count; a ticked session stays listed.
|
||||
- **An accessibility statement** (owner request 2026-11-09, decision D88). `ACCESSIBILITY.md` says what FrameLedger aims
|
||||
for — WCAG 2.2 at level AA as W3C's WCAG2ICT applies it to desktop software, a goal and not a claim of conformance —
|
||||
what works with the keyboard alone, a screen reader, a contrast theme or Magnifier, how it is checked (the project's
|
||||
tests, and the owner's pass of 2026-11-09: keyboard only and Narrator on 0.1.0-beta.34 and 0.1.0-alpha.3, no fault),
|
||||
what does not work yet and what to do instead, and how a barrier is reported and handled — by severity, with no
|
||||
promised times. The app shows it under **Help ▸ Accessibility**, and after Limitations in the user guide's window; the
|
||||
wiki gets an *Accessibility* page.
|
||||
- **An *Accessibility problem* issue form** (`.github/ISSUE_TEMPLATE/accessibility.yml`) asking what was tried, what
|
||||
happened and what the reporter uses — never anything about the reporter themself — and a user-interface section in the
|
||||
pull-request template. The `accessibility` label exists, and so do `safety` and `priority-high`, which the *Safety gap*
|
||||
form had named since its first day without either existing — so GitHub had never applied them.
|
||||
|
||||
### Changed
|
||||
|
||||
- **The Compare page's layout** (the owner's screenshot): the selection bar beside the list instead of a window's width
|
||||
away, with *Clear selection*; columns sized to what they hold — *Tier* and *FPS* touched, and wide gaps split the rest —;
|
||||
the date sorts by when; the settings-changed column says so in words or shows a dash (it was blank); the result
|
||||
table's session labels sit over their columns.
|
||||
- **The selected page keeps its name in the left pane** (D86): WPF UI's pane animates the selected item's label away
|
||||
(Compare's, in the screenshot — every page's while selected); FrameLedger uses a copy of its template without that.
|
||||
- **Games opens at once from any page** (owner request 2026-11-06: switching to Games stalled 0.5–1.5 s). The window
|
||||
keeps the library page it built and shows it again on every later visit, reading the library again behind it; the
|
||||
library is read off the UI thread; the cards appear before the executables are checked — a USB drive that sleeps
|
||||
took a second or more to answer, and no card was shown until every one had — and each card gets its *Not installed*
|
||||
pill when its check answers; a read keeps every card that would look the same instead of rebuilding them all; the
|
||||
list view builds only the rows on screen (`spike-notes` §27).
|
||||
- **Changing the language keeps the page you are on** — Settings, after a change made there. The App remembered only
|
||||
the pages it opened from code, so the language changed on Settings came back on the last game page opened
|
||||
(`src/FrameLedger.App/Services/ShellHost.cs`).
|
||||
- **DLSS 5 is named where the game ran it** (owner decision D84, amending D64). The owner's Hogwarts Legacy, Neural
|
||||
Rendering on, loaded DLSS 5's runtime (`nvngx_dlssnr.dll` 310.9.16.0, from the game's folder) and the session could say
|
||||
only *DLSS 5 runtime loaded* — nothing measured whether it ran. The Overlay's Streamline hook now decodes DLSS 5's
|
||||
feature (`kFeatureDLSS_NR`, Streamline 2.14) into its own per-frame fact, and the Agent keeps the share of the frames
|
||||
the game rendered through Streamline that carried it (`sessions.dlss_nr_pct`, **schema 0022** — a ledger this build
|
||||
migrated no longer opens in an earlier one). Seen running, the DLSS line reads *DLSS 5 (neural rendering on 97.3% of
|
||||
rendered frames)*, above every other generation; loaded and seen not running, *DLSS 5 runtime loaded, not seen
|
||||
running*; where nothing could tell (an earlier Overlay, a title outside Streamline), *DLSS 5 runtime loaded*, as
|
||||
before. Its library is listed with its version and source like the others, its Streamline plugin `sl.dlss_nr.dll`
|
||||
is recorded when loaded, and a game shipping either file shows *Supports DLSS 5 Neural Rendering* (rules
|
||||
`2026.11.2`, capability `dlss_nr`). The **Privacy Policy 2.14** names neural-rendering libraries among those whose
|
||||
versions are read; the **Disclaimer 2.13**'s accuracy block says when DLSS 5 is named. One hook-path change: one more
|
||||
compare in the `slEvaluateFeature` detour and one more test where a present is recorded (`spike-notes` §26).
|
||||
- **Streamline's headers are `v2.14.16`'s** (developers): the vendored copy was `v2.12.0`, byte for byte; three of its
|
||||
eleven files change — `kFeatureDLSS_NR`, the uplift buffer types 70–72, `kStructVersion7`, the version — and
|
||||
nothing FrameLedger consumed otherwise (`src/native/third_party/streamline/README.md`).
|
||||
- **A session under the NVIDIA App's *Dynamic* frame generation reads DLSS 4.5** (owner decision D83, amending D64).
|
||||
Dynamic and its ×6 mode exist only in DLSS 4.5, and the DLSS line named a generation from the measured multiplier
|
||||
alone: the owner's Phantom Blade Zero under *Dynamic, up to ×3* held ×2.0 and ×3.0 and read *DLSS 4 (a ×3.0
|
||||
frame-generation state)*. It reads *DLSS 4.5 (Dynamic multi frame generation, set in the NVIDIA App)* where the game's
|
||||
driver profile sets Dynamic, the driver reports its frame-generation override applied in the game's process, and DLSS
|
||||
Frame Generation was counted; a state measured at ×5 or more still ranks first, and a *Fixed* multiplier names nothing
|
||||
by itself (The Witcher 3 under Fixed ×6 still presented ×2.0). The game page's chip and the CSV's `# dlss:` line
|
||||
(`basis=dynamic_frame_generation`) follow; the **Disclaimer 2.13** says so in its accuracy block
|
||||
(`src/FrameLedger.Domain/Detection/DlssGeneration.cs`, `src/FrameLedger.App/Services/DlssText.cs`; `spike-notes` §26).
|
||||
- **The guard's source reads in order again** (developers only; no behaviour changes): the note that says what runs only
|
||||
for a target the anti-cheat evaluation allowed sits above the function it describes again — beta.33's two isolation
|
||||
checks had come between them — and names that isolation check among what runs
|
||||
(`src/native/FrameLedger.Injector/src/fl_guard.cpp`).
|
||||
|
||||
### Fixed
|
||||
|
||||
- **An Xbox game's page no longer fails on a strange picture name** in the game's own `MicrosoftGame.config` (beta.33's):
|
||||
a name that points at a stream of a file (`a:b.png`) made the search for its scaled variants throw — the page then
|
||||
showed no picture and logged an error, and an action on the page that reloads it could end in the crash report. Such a
|
||||
name is no picture a package ships, so it is passed over like a name outside the package
|
||||
(`src/FrameLedger.Infrastructure/Art/XboxArtCache.cs`). Found by a self-review of #351 and #352 after their gates
|
||||
passed; no install of the owner's eleven titles has such a name.
|
||||
- **Documents corrected**: charts do take focus and keys (`docs/08_UI.md` said neither — `ChartKeyboardTests` measures
|
||||
it); the database-maintenance result's live region announced nothing, since WPF raises one only when the app does; the
|
||||
"no Narrator pass" gap is the owner's pass now, beside what that pass could not show; the open question "Accessibility
|
||||
/ DPI: no design anywhere" is closed; NFR-9 names screen readers and contrast themes (D88–D91). `LIMITATIONS.md` gains an
|
||||
*Accessibility* section and loses its one struck sentence — a screen reader reads struck text as current, so no page
|
||||
the app shows strikes text through. The guide's menu table names its menu on every row, read one row at a time.
|
||||
|
||||
## Releases
|
||||
|
||||
@@ -103,6 +64,8 @@ Newest first. Each file holds that release's section exactly as it stood here.
|
||||
|
||||
| Version | Date | Notes |
|
||||
|---|---|---|
|
||||
| `0.1.0-alpha.3` | 2026-11-06 | [`docs/changelog/0.1.0-alpha.3.md`](docs/changelog/0.1.0-alpha.3.md) |
|
||||
| `0.1.0-beta.34` | 2026-11-06 | [`docs/changelog/0.1.0-beta.34.md`](docs/changelog/0.1.0-beta.34.md) |
|
||||
| `0.1.0-alpha.2` | 2026-11-03 | [`docs/changelog/0.1.0-alpha.2.md`](docs/changelog/0.1.0-alpha.2.md) |
|
||||
| `0.1.0-beta.33` | 2026-11-03 | [`docs/changelog/0.1.0-beta.33.md`](docs/changelog/0.1.0-beta.33.md) |
|
||||
| `0.1.0-alpha.1` | 2026-10-31 | [`docs/changelog/0.1.0-alpha.1.md`](docs/changelog/0.1.0-alpha.1.md) |
|
||||
|
||||
@@ -49,7 +49,7 @@ A C++ DLL (`FrameLedger.Overlay.dll`) is injected into games the user explicitly
|
||||
| UI | WPF + WPF UI (`WPF-UI` pinned = 4.3.0) + CommunityToolkit.Mvvm — `docs/16_WPFUI_SYNTAX.md` |
|
||||
| App composition | .NET Generic Host + DI in `FrameLedger.App` |
|
||||
| Charts | ScottPlot 5 |
|
||||
| Markdown in the App | **Markdig** (BSD-2-Clause, pinned ~~1.4.0~~ 1.5.0 since beta.31 — 1.4.2 in beta.30) → WPF `FlowDocument`, HTML off, no image fetched — the Legal Gate, the user guide, Help ▸ Limitations, the update notes, About (beta.12; row added 2026-10-04) |
|
||||
| Markdown in the App | **Markdig** (BSD-2-Clause, pinned ~~1.4.0~~ 1.5.0 since beta.31 — 1.4.2 in beta.30) → WPF `FlowDocument`, HTML off, no image fetched — the Legal Gate, the user guide, Help ▸ Limitations, Help ▸ Accessibility (beta.35, D88), the update notes, About (beta.12; row added 2026-10-04) |
|
||||
| GPU telemetry | **The game process's own memory since beta.12 (D43):** `FrameLedger.ProcessStats.dll` (C++, loaded by the Agent, never into a game) reads its dedicated/shared GPU memory from the `GPU Process Memory` counters and its working sets from `GetProcessMemoryInfo` — `18_GPU_VENDOR_APIS` §The game process's memory. Layered: DXGI + PDH counters (all vendors) → LibreHardwareMonitorLib (MPL-2.0, all vendors) → **NVAPI (MIT, headers + `amd64/nvapi64.lib` vendored 2026-08-05** at `src/native/third_party/nvapi/`, consumed via the `fl_nvapi` target; NVIDIA extras + Reflex). **No AMD/Intel vendor SDK** — `docs/18_GPU_VENDOR_APIS.md`. ~~**No telemetry source exists in code yet**~~ **`LhmTelemetrySource` (L2) exists since 2026-09-03 (`20_OPEN_QUESTIONS` §M5 row R1, eight GPU fields unelevated); L1 (`BaselineTelemetrySource`: DXGI identity + the PDH adapter-memory counter, the first CsWin32 consumer), `CompositeTelemetrySource` and the 1 Hz `TelemetryPoller` since 2026-09-09; L3 (`NvapiTelemetrySource` over the native `FrameLedger.NvapiBridge.dll` — the only shipped binary linking `nvapi64.lib`, loaded by the Agent into its own process and never into a game) since 2026-09-10 (PR-E2)** — `ctest fl_nvapi_probe` was the only NVAPI consumer until then, and it exists so the vendoring is verified rather than asserted. This row said no source existed for six days after one did, recorded 2026-09-09 rather than repaired quietly. This row previously claimed the vendoring in the present tense while `third_party/` held only `vulkan-headers`; `legal/` had already caught the identical claim about itself and gained a bidirectional gate, which is what made the real vendoring a red-then-green |
|
||||
| CPU/board sensors | LibreHardwareMonitorLib ≥ 0.9.6 (PawnIO) — **optional**, elevated only |
|
||||
| Tier-2 fallback | **There is none, and Tier 2 is not a measurement.** Owner decision 2026-08-28: the ladder is two rungs — hooked, or duration + sensors + the reason. ~~ETW-based, no injection~~; ~~Intel PresentMon console binary~~ dropped 2026-08-27 after §S31 retired it. Whether a shipped build ever regains a no-injection measurement is `docs/20_OPEN_QUESTIONS.md` §G |
|
||||
@@ -67,6 +67,7 @@ A C++ DLL (`FrameLedger.Overlay.dll`) is injected into games the user explicitly
|
||||
FrameLedger.slnx # XML solution format (SDK default since .NET 10)
|
||||
NOTICE # copyright + the GPLv3 section 7 additional terms (beta.12, D45)
|
||||
CONTRIBUTING.md FORKING.md CODE_OF_CONDUCT.md # for people who build, contribute or redistribute
|
||||
LIMITATIONS.md ACCESSIBILITY.md # what the software cannot do; the accessibility statement (D36, D88)
|
||||
global.json # pins the SDK band — see 12_BUILD
|
||||
RELEASE_LINE # `main`, or `alpha` on the alpha branch (D73, 2026-10-31) — 12_BUILD §The alpha line
|
||||
build.ps1 # the quality gate; CI runs this identical script
|
||||
@@ -165,7 +166,7 @@ guide/ # the user guide (beta.12, D44): ~~eight~~ short
|
||||
# (twelve since beta.17, D54: the screens, every setting, troubleshooting, a glossary;
|
||||
# and the guide is the wiki's End-user part)
|
||||
wiki/ # the wiki's own pages (beta.17, D53): Home, _Sidebar, the developer pages. wiki.yml
|
||||
# publishes them with guide/ and LIMITATIONS.md to the Wiki tab at a release;
|
||||
# publishes them with guide/, LIMITATIONS.md and ACCESSIBILITY.md to the Wiki tab at a release;
|
||||
# tools/wiki-build.ps1 assembles and checks them (build.ps1 wiki-check)
|
||||
docs/ legal/ legal/licenses/
|
||||
```
|
||||
@@ -196,6 +197,8 @@ The version handshake is wired end to end as of 2026-08-05: `FlGuardBuildId` giv
|
||||
- Hook-path changes state measured overhead in the PR body (`14_TESTING` §Hook overhead).
|
||||
- Any new hook is listed in `17_HOOK_ENGINE` §Hook inventory and justified against rule 4.
|
||||
- New user-visible strings exist in `en`, `vi`, `ja`.
|
||||
- A change to what the App shows keeps `ACCESSIBILITY.md` §For contributors (names, theme colours, nothing by colour alone,
|
||||
keyboard reach) and updates that page when it moves what works or what does not (D88).
|
||||
- Any deviation from a doc updates that doc in the same PR.
|
||||
|
||||
## Reading order
|
||||
@@ -219,7 +222,10 @@ The version handshake is wired end to end as of 2026-08-05: `FlGuardBuildId` giv
|
||||
10. Remaining (`09`–`15`).
|
||||
11. **`LIMITATIONS.md`** (repository root; shown in the App under Help ▸ Limitations) — what the WHOLE software cannot
|
||||
do, in the user's words, each item linked to its details. When a change moves a limit, the page changes in the same
|
||||
PR (D36, 2026-09-27). **`docs/LIST_GAME_TESTED.md`** — the real games FrameLedger has been run with and what each
|
||||
PR (D36, 2026-09-27). **`ACCESSIBILITY.md`** (repository root; Help ▸ Accessibility) — the accessibility statement:
|
||||
WCAG 2.2 AA through WCAG2ICT as a goal, never a claim; what works with the keyboard, a screen reader and contrast
|
||||
themes, what does not, how a barrier is reported (D88, 2026-11-09); `docs/08_UI.md` §Accessibility holds its checks.
|
||||
**`docs/LIST_GAME_TESTED.md`** — the real games FrameLedger has been run with and what each
|
||||
session measured, from a copy of the owner's ledger and the repository's own evidence (D35).
|
||||
|
||||
**Before writing native or capture code, read `docs/20_OPEN_QUESTIONS.md`** (its open entries; since beta.24 the
|
||||
|
||||
+7
-1
@@ -11,6 +11,8 @@ merged, and under what licence your contribution is accepted.
|
||||
- **Open an issue before anything larger than a fix**, so the approach can be agreed before the work is done.
|
||||
- **A game with anti-cheat that FrameLedger fails to detect** is a safety bug: use the *Safety gap* issue form.
|
||||
- **A vulnerability in FrameLedger itself** goes the private route in `SECURITY.md`, never a public issue.
|
||||
- **Something that cannot be reached, read or seen** — with the keyboard, a screen reader, a contrast theme — uses the
|
||||
*Accessibility problem* form; `ACCESSIBILITY.md` says what the App aims for.
|
||||
- Everyone who takes part follows the `CODE_OF_CONDUCT.md`.
|
||||
|
||||
## Building
|
||||
@@ -45,13 +47,17 @@ The definition of done is the one in `CLAUDE.md`:
|
||||
- a change to the hook path states its measured overhead in the PR (`docs/14_TESTING.md` §Hook overhead);
|
||||
- a new hook is listed in `docs/17_HOOK_ENGINE.md` §Hook inventory and justified against rule 4;
|
||||
- every new user-visible string exists in `en`, `vi` and `ja` (`docs/09_I18N.md`);
|
||||
- a change to what the App shows keeps `ACCESSIBILITY.md` §For contributors — a name for every control that shows no
|
||||
text, theme colours only, nothing shown by colour alone, everything reachable by keyboard — and says in the PR what was
|
||||
checked with the keyboard and Narrator; if it moves what works or what does not, `ACCESSIBILITY.md` changes with it;
|
||||
- a change that makes a document wrong updates that document in the same PR;
|
||||
- a change under `src/` adds an entry under `## [Unreleased]` in `CHANGELOG.md`;
|
||||
- every new source file carries the licence header — `./tools/notice-check.ps1 -Fix` writes it. A file you wrote
|
||||
yourself may name you in its second line instead, in the same form:
|
||||
`Copyright (C) <year> <your name> - additional terms under GPLv3 section 7: see NOTICE`.
|
||||
|
||||
The pull-request template lists the safety checks for changes to the capture layer.
|
||||
The pull-request template lists the safety checks for changes to the capture layer, and the accessibility checks for
|
||||
changes to the user interface.
|
||||
|
||||
## What will not be merged
|
||||
|
||||
|
||||
@@ -74,7 +74,7 @@
|
||||
|
||||
<ItemGroup Label="Analyzers (build-time only)">
|
||||
<PackageVersion Include="Roslynator.Analyzers" Version="5.0.1" />
|
||||
<PackageVersion Include="Meziantou.Analyzer" Version="3.0.317" />
|
||||
<PackageVersion Include="Meziantou.Analyzer" Version="3.0.319" />
|
||||
<PackageVersion Include="Microsoft.VisualStudio.Threading.Analyzers" Version="18.12.1" />
|
||||
</ItemGroup>
|
||||
|
||||
|
||||
+12
-2
@@ -5,7 +5,7 @@ hooking on for — and reading the graphics calls the game makes. That is why it
|
||||
resolution, the upscaler, frame generation and ray tracing apart. It is also where its limits come from. This
|
||||
page lists them in plain words; each item links to the document that has the details.
|
||||
|
||||
*Beta software: this page describes version 0.1.0-beta.33.*
|
||||
*Beta software: this page describes version 0.1.0-beta.34.*
|
||||
|
||||
## Games it will not measure
|
||||
|
||||
@@ -109,7 +109,7 @@ shown is recorded too, from outside the game. ([Capture](docs/04_CAPTURE.md))
|
||||
DLSS 4), the NVIDIA App's *Dynamic* frame generation that the driver reports applied (DLSS 4.5, whatever multiplier
|
||||
it chose — since 0.1.0-beta.34), or a library whose major version names one (2.x, 3.x). A *Fixed* ×5 or ×6 set in
|
||||
the App names DLSS 4.5 only when the frames show it. A 310 library with no such evidence shows its
|
||||
version only. ~~DLSS 5 is shown only as *runtime loaded*, by a library name not yet seen on a real game.~~ **DLSS 5**
|
||||
version only. **DLSS 5**
|
||||
(since 0.1.0-beta.34) is named where the game was seen running its neural rendering through Streamline, with the share
|
||||
of rendered frames; its library loaded and nothing seen reads *runtime loaded* — *not seen running* only where the
|
||||
Overlay looked. A game that runs neural rendering outside Streamline is not seen. Where each
|
||||
@@ -202,6 +202,16 @@ you accept the prompt. Turn it on only if you trust everything that runs under y
|
||||
anti-cheat, never to judge it, and recording or measuring a game vouches for nothing. Four itch.io downloads this
|
||||
project once used as examples turned out to carry malware ([details](docs/spike-notes.md)).
|
||||
|
||||
## Accessibility
|
||||
|
||||
What works with the keyboard alone, a screen reader, a contrast theme or Magnifier, what does not yet, and how to report
|
||||
a barrier is on its own page: [Accessibility](ACCESSIBILITY.md) (in the app: Help ▸ Accessibility). The largest limits:
|
||||
|
||||
- **Charts are pictures.** A screen reader cannot read their points; the numbers are in the session's figures, the
|
||||
tables and **File ▸ Export**.
|
||||
- **Windows' text size setting is not followed** — use display scaling or Magnifier.
|
||||
- **Windows contrast themes are not followed yet** — choose **Light** or **Dark** in Settings ▸ Theme.
|
||||
|
||||
## Play
|
||||
|
||||
- **Through GOG GALAXY or itch, you finish in their app.** GOG GALAXY runs the game as its own shortcuts do, and the
|
||||
|
||||
@@ -6,13 +6,14 @@
|
||||
|
||||
**New here? Start with the [user guide](guide/README.md)** — install, record a game, read your results, stay safe with
|
||||
anti-cheat, and look after your data, a page each, then every screen, every setting and what to do when something goes
|
||||
wrong. What FrameLedger cannot do is on one page: [Limitations](LIMITATIONS.md). Both are in the app too (Help ▸ User
|
||||
guide, Help ▸ Limitations), and on the project's [wiki](https://github.com/poli0981/frameledger/wiki) with the developer
|
||||
pages.
|
||||
wrong. What FrameLedger cannot do is on one page: [Limitations](LIMITATIONS.md). How it works with the keyboard alone, a
|
||||
screen reader or a contrast theme, and how to report a barrier: [Accessibility](ACCESSIBILITY.md). All three are in the
|
||||
app too (Help ▸ User guide, Help ▸ Limitations, Help ▸ Accessibility), and on the project's
|
||||
[wiki](https://github.com/poli0981/frameledger/wiki) with the developer pages.
|
||||
|
||||
<!-- accuracy-block:begin -->
|
||||
> ⚠ **What FrameLedger actually measures today — 2026-11-06.** The software is a beta; its latest
|
||||
> **beta is `0.1.0-beta.33`** (2026-11-03), an unsigned installer built from that tag with its
|
||||
> **beta is `0.1.0-beta.34`** (2026-11-06), an unsigned installer built from that tag with its
|
||||
> checksums published beside it (alphas — experimental builds on a prerelease .NET — are published apart). The source holds the desktop app
|
||||
> (library, store import, charts, settings) and the background Agent, which records a session when a
|
||||
> game in the library runs (unless you switched its recording off), injects only into games you enabled
|
||||
@@ -176,7 +177,7 @@ Elevation is **optional — for everything.** Hooked capture is the normal path
|
||||
|
||||
## Install
|
||||
|
||||
> **The latest beta is `v0.1.0-beta.33` (2026-11-03); before it `v0.1.0-beta.32` (2026-10-31), `v0.1.0-beta.31` (2026-10-26), `v0.1.0-beta.30` (2026-10-26), `v0.1.0-beta.29` (2026-10-25), `v0.1.0-beta.28` (2026-10-20), `v0.1.0-beta.27` (2026-10-20), `v0.1.0-beta.26` (2026-10-19), `v0.1.0-beta.25` (2026-10-19), `v0.1.0-beta.24` (2026-10-19), `v0.1.0-beta.23` (2026-10-14), `v0.1.0-beta.22` (2026-10-13), `v0.1.0-beta.21` (2026-10-13), `v0.1.0-beta.20` (2026-10-12), `v0.1.0-beta.19` (2026-10-12), `v0.1.0-beta.18` (2026-10-07), `v0.1.0-beta.17` (2026-10-07), `v0.1.0-beta.16` (2026-10-06), `v0.1.0-beta.15` (2026-10-06), `v0.1.0-beta.14` (2026-10-06), `v0.1.0-beta.13` (2026-10-04), `v0.1.0-beta.12` (2026-10-04), `v0.1.0-beta.11` (2026-10-03), `v0.1.0-beta.10` (2026-09-28), `v0.1.0-beta.9` (2026-09-26), `v0.1.0-beta.8` (2026-09-25), `v0.1.0-beta.7` (2026-09-23), `v0.1.0-beta.6` (2026-09-23), `v0.1.0-beta.5` (2026-09-22), `v0.1.0-beta.4` (2026-09-21), `v0.1.0-beta.3` (2026-09-21), `v0.1.0-beta.2` (2026-09-17) and `v0.1.0-beta.1` (2026-09-16).** They are pre-releases: read the notes of the one you install — `CHANGELOG.md` links each release's own file under `docs/changelog/` — for what it measures, what it does not yet, and how to update, before installing. A source build is `docs/12_BUILD.md`.
|
||||
> **The latest beta is `v0.1.0-beta.34` (2026-11-06); before it `v0.1.0-beta.33` (2026-11-03), `v0.1.0-beta.32` (2026-10-31), `v0.1.0-beta.31` (2026-10-26), `v0.1.0-beta.30` (2026-10-26), `v0.1.0-beta.29` (2026-10-25), `v0.1.0-beta.28` (2026-10-20), `v0.1.0-beta.27` (2026-10-20), `v0.1.0-beta.26` (2026-10-19), `v0.1.0-beta.25` (2026-10-19), `v0.1.0-beta.24` (2026-10-19), `v0.1.0-beta.23` (2026-10-14), `v0.1.0-beta.22` (2026-10-13), `v0.1.0-beta.21` (2026-10-13), `v0.1.0-beta.20` (2026-10-12), `v0.1.0-beta.19` (2026-10-12), `v0.1.0-beta.18` (2026-10-07), `v0.1.0-beta.17` (2026-10-07), `v0.1.0-beta.16` (2026-10-06), `v0.1.0-beta.15` (2026-10-06), `v0.1.0-beta.14` (2026-10-06), `v0.1.0-beta.13` (2026-10-04), `v0.1.0-beta.12` (2026-10-04), `v0.1.0-beta.11` (2026-10-03), `v0.1.0-beta.10` (2026-09-28), `v0.1.0-beta.9` (2026-09-26), `v0.1.0-beta.8` (2026-09-25), `v0.1.0-beta.7` (2026-09-23), `v0.1.0-beta.6` (2026-09-23), `v0.1.0-beta.5` (2026-09-22), `v0.1.0-beta.4` (2026-09-21), `v0.1.0-beta.3` (2026-09-21), `v0.1.0-beta.2` (2026-09-17) and `v0.1.0-beta.1` (2026-09-16).** They are pre-releases: read the notes of the one you install — `CHANGELOG.md` links each release's own file under `docs/changelog/` — for what it measures, what it does not yet, and how to update, before installing. A source build is `docs/12_BUILD.md`.
|
||||
|
||||
1. Download the latest `FrameLedger.App-win-Setup.exe` from [Releases](https://github.com/poli0981/frameledger/releases). It installs into `%LOCALAPPDATA%\FrameLedger.App`; your data stays in `%LOCALAPPDATA%\FrameLedger`, and uninstalling asks before touching it.
|
||||
2. SmartScreen may warn — releases are not code-signed (free, open-source project). Verify the SHA-256 checksum published with each release, then **More info → Run anyway**.
|
||||
@@ -203,7 +204,8 @@ FrameLedger is GPL-3.0-only free software, and you are welcome to build it, chan
|
||||
- **Build it:** [`docs/12_BUILD.md`](docs/12_BUILD.md) — `./build.ps1 check` is the whole quality gate, the same one CI runs.
|
||||
- **Contribute:** [`CONTRIBUTING.md`](CONTRIBUTING.md) — the definition of done, what will not be merged, and that a
|
||||
contribution is licensed GPL-3.0-only with the [`NOTICE`](NOTICE) terms (no CLA). Conduct:
|
||||
[`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md). Security reports: [`SECURITY.md`](SECURITY.md).
|
||||
[`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md). Security reports: [`SECURITY.md`](SECURITY.md). Accessibility — the goal,
|
||||
the checks and how a barrier is reported: [`ACCESSIBILITY.md`](ACCESSIBILITY.md).
|
||||
- **Fork or redistribute:** [`FORKING.md`](FORKING.md) — what the GPL asks of anyone who distributes builds, and the names
|
||||
a fork must change so it does not share FrameLedger's update feed, install folder, data, pipe or Vulkan layer.
|
||||
- **Find your way around:** the [wiki](https://github.com/poli0981/frameledger/wiki)'s developer pages are short, and each
|
||||
|
||||
@@ -467,7 +467,7 @@ function Invoke-ProjectGates {
|
||||
Invoke-Checked 'notice-check (self-test)' { & $noticeTool -SelfTest }
|
||||
Invoke-Checked 'notice-check' { & $noticeTool -RepoRoot $repo }
|
||||
|
||||
# beta.17 (D53/D54): the GitHub Wiki is built from wiki/, guide/ and LIMITATIONS.md, and wiki.yml publishes it when a
|
||||
# beta.17 (D53/D54): the GitHub Wiki is built from wiki/, guide/, LIMITATIONS.md and (beta.35) ACCESSIBILITY.md, and wiki.yml publishes it when a
|
||||
# release is made. A link or a section that leads nowhere, a page nothing leads to, a sidebar out of the guide's
|
||||
# order, a path that names nothing or a version written into a page is red here, not on the published wiki.
|
||||
# Self-test first (nine cases, both directions), then the live assembly into a temporary folder.
|
||||
|
||||
+1
-1
@@ -113,7 +113,7 @@ Draw live FPS/frametime/upscaler info inside the game. Only for games already ho
|
||||
- **NFR-6 Accuracy:** per `03_METRICS` §Accuracy budget, stated per tier.
|
||||
- **NFR-7 Resilience:** power loss loses at most the last 60 s of raw data; DB never corrupts (WAL + transactions); Agent restart recovers `.partial` sessions as `interrupted`.
|
||||
- **NFR-8 OS support:** Windows 10 22H2+ and Windows 11, x64. No ARM64 in v1.
|
||||
- **NFR-9 Accessibility:** full keyboard navigation, adequate contrast in both Fluent themes, Per-Monitor V2 DPI awareness. *(What each clause means for this app, and the check that holds it: `08_UI` §Accessibility, P4 PR-8.)*
|
||||
- **NFR-9 Accessibility:** full keyboard navigation, adequate contrast in both Fluent themes, Per-Monitor V2 DPI awareness. *(What each clause means for this app, and the check that holds it: `08_UI` §Accessibility, P4 PR-8.)* *(Widened 2026-11-09, beta.35, owner decisions D88–D91: and a screen reader reads every control and value and is told what changes; Windows contrast themes are followed; nothing is shown by colour alone. The goal behind all of it is WCAG 2.2 AA as W3C's WCAG2ICT applies it to desktop software — a goal, not a conformance claim — stated to users in `ACCESSIBILITY.md`.)*
|
||||
- **NFR-10 Offline-first:** everything except updates and opt-in metadata works with zero connectivity.
|
||||
- **NFR-11 Auditability:** the entire set of hooks is enumerable in `17_HOOK_ENGINE` §Hook inventory and matches the code; a reviewer must be able to verify in minutes that nothing reads game memory.
|
||||
|
||||
|
||||
@@ -482,7 +482,7 @@ never the path), and the super-resolution preset the driver reports applied:
|
||||
|---|---|---|
|
||||
| Super-resolution render preset **L or M** that the NVIDIA driver reports applied, in a session where super resolution ran | DLSS 4.5 (2nd-gen transformer) | `ngx_driver_words` — the SR word's `PRESET` bit and `renderPreset`; presets L/M arrived with DLL 310.5.0 (NVIDIA's DLSS 4.5 release, driver 591.74) |
|
||||
| A DLSS Frame Generation state measured at **×5 or more** | DLSS 4.5 (Dynamic / 6× multi-frame generation) | `fg_mix` / `fg_factor` with `fg_mode = dlssg` |
|
||||
| The NVIDIA App's **Dynamic** frame generation — set in the game's profile and reported applied by the driver — in a session where DLSS Frame Generation was counted *(beta.34, owner decision D83)* | DLSS 4.5 (Dynamic multi frame generation, set in the NVIDIA App) | `driver_profile`'s `NGX_DLSSG_MODE` = 4 (dynamic), `ngx_driver_words`' FG word with `FG_MODE` (bit 13), `fg_mode = dlssg` |
|
||||
| The NVIDIA App's **Dynamic** frame generation — set in the game's profile and reported applied by the driver — in a session where DLSS Frame Generation was identified *(beta.34, owner decision D83)* | DLSS 4.5 (Dynamic multi frame generation, set in the NVIDIA App) | `driver_profile`'s `NGX_DLSSG_MODE` = 4 (dynamic), `ngx_driver_words`' FG word with `FG_MODE` (bit 13), `fg_mode = dlssg` |
|
||||
| Preset **J or K** reported applied | DLSS 4 (transformer) | as above |
|
||||
| A DLSS Frame Generation state at **×3 or ×4** | DLSS 4 (multi-frame generation) | as above |
|
||||
| `nvngx_dlss.dll` **2.x** | DLSS 2 | `runtime_modules` |
|
||||
@@ -497,7 +497,8 @@ generation and its ×6 mode exist only in DLSS 4.5, so a session the driver repo
|
||||
multiplier the mode chose: the owner's Phantom Blade Zero under *Dynamic, up to ×3* held ×2.0 and ×3.0 — nine hooked sessions
|
||||
from 2026-11-03 to 11-05 — and read *DLSS 4 (a ×3.0 frame-generation state)* until then. The row needs all three: the
|
||||
profile's Dynamic (`NGX_DLSSG_MODE` = 4, NVIDIA's own name for the value), the driver's report that its frame-generation
|
||||
override applied in the game's process (the FG word's `FG_MODE` bit), and DLSS Frame Generation counted in the session —
|
||||
override applied in the game's process (the FG word's `FG_MODE` bit), and DLSS Frame Generation identified in the session
|
||||
(`fg_mode = dlssg`; its factor need not have been counted) —
|
||||
a profile set to Dynamic that the driver never applied is a setting, not evidence. The driver's own mode number is not
|
||||
read: it answers 3 under Dynamic and 1 under *Fixed* on every stored session (`spike-notes` §26), and NVIDIA's header
|
||||
names neither. A *Fixed* ×5 or ×6 is not this row — Witcher 3 under the App's Fixed ×6 still presented ×2.0 — and
|
||||
|
||||
+41
-6
@@ -43,8 +43,13 @@ Compare showed the icon alone)*. Light/Dark/System themes via `ApplicationThemeM
|
||||
**Menu bar**
|
||||
- **File:** Add game… · Import library (Steam / GOG / Epic / itch.io / Xbox *— since beta.33*) · Export ▸ (Session CSV / Session JSON / Chart PNG) · Exit
|
||||
- **Tools:** Agent status… · Update detection rules · Vulkan layer registration… · Open data folder · Database maintenance…
|
||||
- **Help:** User guide (beta.12) · Check for updates · Report a bug… · ~~Documentation~~ Online documentation · Limitations · About FrameLedger (~~App / Developer / Third-party licenses tabs~~ — built beta.12 as *This app* / *Third-party licences* / *Legal documents*, below)
|
||||
- **Help:** User guide (beta.12) · Check for updates · Report a bug… · ~~Documentation~~ Online documentation · Limitations · Accessibility (beta.35) · About FrameLedger (~~App / Developer / Third-party licenses tabs~~ — built beta.12 as *This app* / *Third-party licences* / *Legal documents*, below)
|
||||
|
||||
> **Help ▸ Accessibility, beta.35 (owner decision D88, 2026-11-09):** `ACCESSIBILITY.md` — the accessibility statement —
|
||||
> as the build embeds it (`Services.AccessibilityDocument`), in a `Windows/DocumentWindow` of its own like Limitations,
|
||||
> and after Limitations in the user guide's window so the guide's links to it open there. Information, not one of
|
||||
> FR-11's documents. What it says and the checks behind it are §Accessibility below.
|
||||
>
|
||||
> **Help ▸ Limitations, beta.10 (D36):** `LIMITATIONS.md` as the build embeds it (`Services.LimitationsDocument`), in a
|
||||
> ~~read-only, scrolling WPF UI `MessageBox` with *Open on GitHub*~~ window of its own since beta.12 (`Windows/DocumentWindow`,
|
||||
> rendered — below; corrected 2026-10-04). It is information, not one of FR-11's documents:
|
||||
@@ -642,7 +647,10 @@ Stat cards (Avg uses `FpsReadout`, Median, 1% Low, 0.1% Low, Min/Max, σ, stutte
|
||||
> frame-generation state)*, *DLSS 3 (library 3.7.10)* — else *DLSS*; then each DLSS library with its version and where
|
||||
> it was loaded from (*Super Resolution 310.5.0, from the graphics driver, preset L (2nd-gen transformer model)*), then
|
||||
> *DLSS 5 runtime loaded* when it was. The game page's *Last session measured* repeats the label; the CSV export gains
|
||||
> `# dlss:`. `DlssTextTests`.
|
||||
> `# dlss:`. `DlssTextTests`. *(beta.34: two more rows — the NVIDIA App's Dynamic frame generation the driver reports
|
||||
> applied is *DLSS 4.5 (Dynamic multi frame generation, set in the NVIDIA App)* (D83), and *DLSS 5 (neural rendering on
|
||||
> N % of rendered frames)* heads the line where the game was seen running it, its library listed like the others, *runtime
|
||||
> loaded, not seen running* where the Overlay looked and saw none (D84) — `05_DETECTION` §DLSS generation.)*
|
||||
|
||||
> **beta.27: one window per session, and no DLSS line that says only *DLSS*.** Opening a session whose summary window is
|
||||
> open — from a Sessions tab, a notification, the game page — brings that window forward, restored if minimised, rather
|
||||
@@ -803,7 +811,7 @@ Session picker (2–5, cross-game allowed) → overlaid percentile curves + stat
|
||||
|
||||
**Mixed-tier guard (FR-6.2):** selecting sessions from different capture tiers shows a blocking `ContentDialog` explaining that they measured different things; proceeding stamps the chart with a tier legend and greys out metrics unavailable in the lower tier. Sessions with `settings_changed_midsession` carry a warning icon and are excluded from trend lines by default.
|
||||
|
||||
> **Built 2026-09-14 (P3 PR-7).** `CompareViewModel` over the last 200 sessions across games: a `DataGrid`
|
||||
> **Built 2026-09-14 (P3 PR-7).** `CompareViewModel` over ~~the last 200 sessions~~ every session *(since beta.34)* across games: a `DataGrid`
|
||||
> picker with a checkbox column (Compare enabled at 2–5), the FR-6.4 warning icon per row; **Compare** asks
|
||||
> `IMixedTierPrompt` (a `ContentDialog`, default button Cancel) when the selection mixes tiers and compares
|
||||
> nothing on a decline; a comparison that proceeds carries `Compare_Mixed_Legend` as the plot's title and an
|
||||
@@ -1004,12 +1012,22 @@ NFR-9 names three things — full keyboard navigation, adequate contrast in both
|
||||
and this section is what they mean for this app, each with the test that holds it (P4 PR-8, 2026-09-15). Until then
|
||||
the requirement was one bullet under §UX rules, and nothing checked it.
|
||||
|
||||
> **The users' half is `ACCESSIBILITY.md` (beta.35, owner decision D88, 2026-11-09):** the goal — WCAG 2.2 AA as W3C's
|
||||
> WCAG2ICT applies it to desktop software, a goal and never a conformance claim — what works, what does not and what to do
|
||||
> instead, and how a barrier is reported (the *Accessibility problem* form, `labels: [accessibility]`) and handled (by
|
||||
> severity, no promised times). It is embedded and shown under Help ▸ Accessibility. **This section is the design and the
|
||||
> checks; the statement says nothing this section does not hold**, and a change that moves either changes both
|
||||
> (`AccessibilityDocumentTests` holds the statement's own rules: embedded as written, a goal and no claim, a form that
|
||||
> exists, no struck text in a page the App shows). NFR-9 was widened the same day to screen readers and contrast themes
|
||||
> (D88–D91).
|
||||
|
||||
### Keyboard
|
||||
|
||||
| Keys | Does | Where |
|
||||
|---|---|---|
|
||||
| **Ctrl+1 … Ctrl+5** (and the numeric keypad's 1–5) | Dashboard · Games · Compare · Logs · Settings | `MainWindow` `InputBindings` → `MainWindowViewModel.NavigateToCommand` → `ShellShortcuts` |
|
||||
| **Alt**, **F10** | Focuses the menu bar; arrows and Enter walk File / Tools / Help | WPF `Menu`, nothing custom |
|
||||
| **Alt** + a menu's access key | Opens that menu — `_File` `_Tools` `_Help`; `_Tệp` `_Công cụ` `Trợ _giúp`; `ファイル(_F)` `ツール(_T)` `ヘルプ(_H)` *(row added 2026-11-09: the keys existed since P3 and this table did not name them)* | the `Menu_*` strings' `_` |
|
||||
| **Tab / Shift+Tab** | Moves through a page in reading order | layout order; no `TabIndex` overrides |
|
||||
| **Arrows, Home/End, Page Up/Down** | Move within a `DataGrid` (Sessions, Compare picker, Import checklist) | `DataGrid` defaults |
|
||||
| **Esc** | Closes the open `ContentDialog` or `MessageBox` with no result — the same as its Close/Cancel button | `DialogKeyboard`, one class handler per dialog type registered at start-up |
|
||||
@@ -1037,6 +1055,10 @@ handled key — so whether Esc alone would close a dialog through `IsCancel` is
|
||||
`TextBox`, `NumberBox`, `PasswordBox`, `Slider` and `HyperlinkButton` in the App's XAML either has content or a name. A new
|
||||
unnamed one is red.
|
||||
- Status lines that change after an action (the Database maintenance result) are `AutomationProperties.LiveSetting="Polite"`.
|
||||
*(Corrected 2026-11-09: this announces nothing. WPF raises `LiveRegionChanged` only when the app raises it — "you
|
||||
explicitly raise an event", Microsoft's* What's new in accessibility *for 4.7.1 — and `TextBlockAutomationPeer` raises
|
||||
none (dotnet/wpf); the App raised no automation event anywhere. The setting marks the line as a live region and no
|
||||
more.)*
|
||||
|
||||
### Contrast
|
||||
|
||||
@@ -1127,8 +1149,21 @@ ScottPlot reads once when the control is made, before it has a window.
|
||||
|
||||
### Known gaps, stated
|
||||
|
||||
- ScottPlot plots are not keyboard-operable (no focus, no pan/zoom by keys). The numbers behind them are on the
|
||||
- ~~ScottPlot plots are not keyboard-operable (no focus, no pan/zoom by keys).~~ *(Corrected 2026-11-09, measured by
|
||||
`ChartKeyboardTests` in a window off the screen: a plot takes focus — ScottPlot's control is focusable and a Tab stop —
|
||||
and the keys ScottPlot reads reach it: the arrows pan, Ctrl with an arrow zooms, A shows all of it. What it is not is
|
||||
usable: it has no automation peer, so Narrator says nothing on reaching it, and it marks no key handled, so the page
|
||||
around it acts on the same arrow too.)* The numbers behind them are on the
|
||||
session summary's stat cards and in File ▸ Export (CSV/JSON); the hardware-change markers' text is WPF text in the
|
||||
list under each trend chart (beta.30).
|
||||
- No screen-reader pass with Narrator has been done; the names above are necessary, not proven sufficient. That pass
|
||||
is the owner's.
|
||||
- ~~No screen-reader pass with Narrator has been done; the names above are necessary, not proven sufficient. That pass
|
||||
is the owner's.~~ **The owner's pass, 2026-11-09: keyboard only with the mouse disconnected, and Narrator, on
|
||||
0.1.0-beta.34 and 0.1.0-alpha.3 — every page, menu, dialog and setting reached and used, no fault.**
|
||||
- **What that pass could not show**, found the same day by measuring the UI Automation tree WPF builds (in memory, on
|
||||
.NET 10.0.14 — not by listening): a drop-down's items are named by a record's printed form (`Choice { Value = dark,
|
||||
Label = Dark }`) and plain lists' items by their type; a control with no automation peer that still takes focus — a
|
||||
chart, the FPS readout, the RT/PT/RR chips, the game's artwork — is a Tab stop Narrator says nothing about; text inside
|
||||
a control template (the safety notices' title and message, the readout, the chips) is hidden from the control view;
|
||||
nothing is announced; no text is a heading; several charts tell series apart by colour alone; page transitions play
|
||||
with Windows' animation effects off; Windows contrast themes are not followed. `ACCESSIBILITY.md` §Known limitations
|
||||
states each to users with what to do instead.
|
||||
+1
-1
@@ -355,7 +355,7 @@ would not fit).
|
||||
13b. `tools/accuracy-check.ps1 -SelfTest`, then live — the accuracy block is ONE text (`legal/ACCURACY.md`) embedded verbatim in `README.md` and `legal/DISCLAIMER.md` §4; a copy that drifted, a copy with no markers, or an empty source is red. Four self-test cases, both directions (§S23-6, 2026-09-06)
|
||||
13c. **`tools/notice-check.ps1 -SelfTest`, then live** (beta.12, owner decision D45, 2026-10-03) — every first-party source file (`.cs .cpp .h .inl .ps1 .xaml`, tracked or new, minus `src/native/third_party/`) opens with `SPDX-License-Identifier: GPL-3.0-only` and `Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE` in its own comment syntax, because GPLv3 §7 wants additional terms named "in the relevant source files" (`NOTICE` carries them); the second line may name another holder and year in the same form (a contributor's own file).
|
||||
Seven self-test cases, both directions; `./tools/notice-check.ps1 -Fix` writes a missing header, and `tools/resx-gen.ps1` generates the accessor with it
|
||||
13d. **`tools/wiki-build.ps1 -SelfTest`, then `-Check`** (beta.17, owner decisions D53/D54, 2026-10-07) — assembles the GitHub Wiki from `wiki/`, `guide/` and `LIMITATIONS.md` into a temporary folder, as `wiki.yml` does at a release (`13_CI_CD` §wiki.yml), and fails on a link to a file, folder or section that does not exist, two sources for one page, a page that neither Home nor the sidebar leads to, a sidebar that lists the guide in another order than `guide/README.md`, a backticked repository path in a `wiki/` page that names nothing, and a version number written into a `wiki/` page (the footer says which release the wiki shows). Nine self-test cases, both directions
|
||||
13d. **`tools/wiki-build.ps1 -SelfTest`, then `-Check`** (beta.17, owner decisions D53/D54, 2026-10-07) — assembles the GitHub Wiki from `wiki/`, `guide/`, `LIMITATIONS.md` and (beta.35) `ACCESSIBILITY.md` into a temporary folder, as `wiki.yml` does at a release (`13_CI_CD` §wiki.yml), and fails on a link to a file, folder or section that does not exist, two sources for one page, a page that neither Home nor the sidebar leads to, a sidebar that lists the guide in another order than `guide/README.md`, a backticked repository path in a `wiki/` page that names nothing, and a version number written into a `wiki/` page (the footer says which release the wiki shows). ~~Nine~~ Ten self-test cases since beta.35 (the statement's page, D88), both directions
|
||||
14. `tools/changelog-check.ps1 -SelfTest` — nine cases, five expected RED. The live half needs a pull request's changed-file list and is supplied by `ci.yml`
|
||||
14b. `tools/release-notes.ps1 -SelfTest` — five cases over a fixture changelog (a dated and an undated section, a missing one, a prefix that must not match, an empty one), and since beta.24 three over a temporary tree: a version with its own `docs/changelog/<version>.md` is read from it, one without from `CHANGELOG.md`, a prefix of a file name is not that file. The live half needs a tag's version and runs in `release.yml`, where a missing or empty section is a red release (P4 PR-5)
|
||||
14d. **`tools/docs-split-check.ps1 -SelfTest`, then live** (beta.24, owner decision D66) — `CHANGELOG.md` holds no released section beside `[Unreleased]`; each `docs/changelog/<version>.md` holds one `## ` heading, its own `## [<version>] - date`, and no relative link (the App renders release notes as `CHANGELOG.md`); `CHANGELOG.md` and the files under `docs/changelog/`, and `docs/HANDOFF.md` and the files under `docs/handoff/` — and since PR-5 `docs/20_OPEN_QUESTIONS.md` and `docs/open-questions/`, `docs/spike-notes.md` and `docs/spike-notes/` — name each other in both directions. Eleven self-test cases, both directions
|
||||
|
||||
+8
-6
@@ -211,9 +211,9 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
|
||||
|
||||
### `wiki.yml` — after a successful Release run, and by hand · **repo-local, built 2026-10-07 (beta.17, D53/D54)**
|
||||
- **What:** the GitHub Wiki is a copy of the repository's own pages — `wiki/` (Home, the sidebar, the developer pages)
|
||||
and `guide/` (the user guide: the End-user part, the same pages the App shows) with `LIMITATIONS.md`.
|
||||
`tools/wiki-build.ps1` names each page (a guide page after its first heading, `guide/README.md` as *User-guide*,
|
||||
`LIMITATIONS.md` as *Limitations*), rewrites links between pages to page names and every other repository link to
|
||||
and `guide/` (the user guide: the End-user part, the same pages the App shows) with `LIMITATIONS.md` and, since
|
||||
beta.35 (D88), `ACCESSIBILITY.md`. `tools/wiki-build.ps1` names each page (a guide page after its first heading,
|
||||
`guide/README.md` as *User-guide*, `LIMITATIONS.md` as *Limitations*, `ACCESSIBILITY.md` as *Accessibility*), rewrites links between pages to page names and every other repository link to
|
||||
its address on GitHub **at the release's tag**, drops each page's first heading (the wiki prints the page name), and
|
||||
writes a footer naming the tag. The same assembly is `build.ps1`'s `wiki-check` gate (`12_BUILD` §Local quality gate,
|
||||
13d), so a dead link is red on the pull request, never on the published wiki.
|
||||
@@ -252,8 +252,8 @@ What it is and what differs on the branch: `12_BUILD` §The alpha line. What CI
|
||||
warning, its row in `CHANGELOG.md`'s Releases table, a line in HANDOFF's START HERE) → the sync pull request into
|
||||
`alpha` → a `release.yml` dispatch on `alpha` (`gh workflow run release.yml --ref alpha -f version=x.y.z-alpha.N`) →
|
||||
the signed tag on `alpha`'s head → the run (§release.yml: the line's tag rule, `--channel alpha`). **No wiki publish**
|
||||
(`wiki.yml` skips an `-alpha.` tag) and **no release line moves**: README, ACCURACY, the Disclaimer's copy and
|
||||
LIMITATIONS keep naming the newest beta.
|
||||
(`wiki.yml` skips an `-alpha.` tag) and **no release line moves**: README, ACCURACY, the Disclaimer's copy,
|
||||
LIMITATIONS and ACCESSIBILITY keep naming the newest beta.
|
||||
- **The cadence:** one alpha per beta, cut from it. Velopack's GitHub source reads the newest ten releases (one page,
|
||||
`perPage` 10), so ten alphas in a row would hide every beta from the betas' own update check, and the other way round
|
||||
(`11_UPDATER` §Channels).
|
||||
@@ -545,7 +545,9 @@ Central package management makes Dependabot PRs single-file diffs.
|
||||
**In the tree — done:**
|
||||
|
||||
- [x] Repo-local `ci.yml`, `codeql.yml`, `release.yml`, `rules-publish.yml` (all four repo-local by decision, §Workflows); ~~caller stubs pointing at `poli0981/.github`~~ — never the design, see the first paragraph *(and `wiki.yml` since beta.17, repo-local too: five)*
|
||||
- [x] Issue forms `bug_report.yml`, `feature_request.yml`, `safety_gap.yml`; `ISSUE_TEMPLATE/config.yml` pointing a vulnerability at private reporting; PR template referencing CLAUDE.md's definition of done
|
||||
- [x] Issue forms `bug_report.yml`, `feature_request.yml`, `safety_gap.yml`; `ISSUE_TEMPLATE/config.yml` pointing a vulnerability at private reporting; PR template referencing CLAUDE.md's definition of done *(and since 2026-11-09, beta.35, D88: `accessibility.yml`, the form `ACCESSIBILITY.md` sends a barrier to, and the PR template's user-interface section)*
|
||||
- [x] The labels the forms apply exist *(2026-11-09: `accessibility`, and `safety` and `priority-high`, which `safety_gap.yml` had named since it was written (2026-08-02) while the repository had neither — GitHub applies only a label that exists, so no Safety gap report was ever labelled)*
|
||||
- [x] `ACCESSIBILITY.md` — the accessibility statement: WCAG 2.2 AA through WCAG2ICT as a goal, never a claim; how a barrier is reported and handled (2026-11-09, D88)
|
||||
- [x] `.github/dependabot.yml` (nuget + github-actions, weekly; a seven-day cooldown and the actions grouped since 2026-10-25 — and a NuGet library update it never proposed is `dotnet list package --outdated`'s to find, §Dependabot and the NuGet audit)
|
||||
- [x] `SECURITY.md` — the private route for a vulnerability, the public route for a safety gap, and the honest response intent (2026-09-16)
|
||||
- [x] A release rehearsal: `release.yml` `workflow_dispatch` runs every step but the Release itself (§release.yml)
|
||||
|
||||
@@ -209,9 +209,14 @@ that it was checked against anything.
|
||||
| Mode | launch mode · attach mode · mid-session settings change |
|
||||
| Safety | game with anti-cheat → toggle disabled · simulated late AC load → unhook · double-crash → auto-disable |
|
||||
| Tier | forced Tier 2 (records duration, available sensors and the reason — and nothing else) · Tier 1 → Tier 2 degradation notice |
|
||||
| Accessibility *(added 2026-11-09, beta.35, D88)* | **keyboard only** with the mouse disconnected — every page, menu and dialog, Ctrl+1…5, Esc · **Narrator** — names, values, headings, the notices as they appear · a **contrast theme** on and off (Aquatic, Desert) · Windows **animation effects** off · a large **display scale**. The owner's first pass: 2026-11-09, keyboard only and Narrator on 0.1.0-beta.34 and 0.1.0-alpha.3, no fault (`ACCESSIBILITY.md` §How it is checked; the automated half is `08_UI` §Accessibility) |
|
||||
| Update | Velopack delta; update deferred while a game is hooked (FR-12) — *a delta needs a previous release, so this row is reachable from the second release, not the first* *(corrected 2026-10-04: no release has carried a delta — `release.yml` never fetches the previous release before `vpk pack`, `11_UPDATER` §Built — so the update leg is a full package; **since beta.13** a release carries a delta against the previous one, and the first
|
||||
update that can use it is beta.12 → beta.13 — HANDOFF owner-only item 10)* |
|
||||
|
||||
## Release smoke
|
||||
|
||||
Clean-VM install → Legal Gate → Agent setup (unelevated) → add a game → consent dialog → hooked 2-min session → charts render → CSV opens in Excel → Vulkan layer registered/unregistered cleanly → uninstall removes layer registration, task, and asks about data.
|
||||
|
||||
*(Added 2026-11-09, beta.35, D88:)* and an **accessibility smoke**, the same build: the Legal Gate, the consent dialog and
|
||||
the session summary reached and answered with the keyboard alone; Narrator reads the notice a refused game raises; the
|
||||
window readable under one contrast theme. The release's owner-only item in `HANDOFF` lists what that release moved.
|
||||
@@ -1913,7 +1913,7 @@ Each of these is referenced by an existing doc but specified nowhere.
|
||||
| ~~**Threading model**~~ | ~~Which component owns which thread, UI-thread rules, and how the 1 Hz telemetry poller, 10 Hz drain and pipe reader interact~~ **Answered 2026-09-09 (P2 PR-C): `04_CAPTURE` §Threading model** — four threads, one owner per shared object, the pipe reader named as one more producer. This row was not struck when the section was written; struck 2026-09-13. What is still unspecified is the UI thread's own rules, which is `08_UI`'s in P3 | `04_CAPTURE`, `18_GPU_VENDOR_APIS` |
|
||||
| **Pipe/shm security** | Stated as policy ("DACL granting the current user's SID") but not as implementable SDDL, nor who creates the objects with what rights. The shm half is built (`fl_shm_host.h`, the Overlay creates the section under the current user's SID); the pipe half is **built 2026-09-13 (P3 PR-1, HANDOFF §P3 decision D11)**: `D:P(A;;GA;;;<user>)(A;;GA;;;BA)` (with the owner `O:<user>` stated since 2026-09-17, `07_IPC` §C) handed to `CreateNamedPipe` with `PIPE_REJECT_REMOTE_CLIENTS`, and the client's token user compared by impersonation on its first frame (`Infrastructure.Ipc.PipeAccessControl`, pinned by `PipeServerClientTests` including the refused stranger). **Row closed** | `07_IPC` |
|
||||
| ~~**Legal doc versioning**~~ | ~~FR-11 re-shows documents "when a document version increments". Nothing says where the current version lives, who writes `legal_acceptance.version`, or how the markdown is rendered in-app~~ **Answered 2026-09-14 (P3 PR-9):** the version is the document's own `**Version:**` line, read from the copy embedded in the App at build (`App.Services.LegalDocuments`); the App writes `legal_acceptance.version` on the one Accept and re-shows any document whose embedded version differs from its row; ~~the markdown is shown as text with authoring comments stripped, not rendered~~ the markdown is shown with authoring comments stripped and, since beta.12, rendered (`08_UI` §Menu, *Documents are rendered*; §First-run flow built note) | FR-11, `06_DATA_MODEL` |
|
||||
| **Accessibility / DPI** | NFR-9 states requirements; no design anywhere | NFR-9, `08_UI` |
|
||||
| ~~**Accessibility / DPI**~~ | ~~NFR-9 states requirements; no design anywhere~~ **Answered 2026-09-15 (P4 PR-8): `08_UI` §Accessibility** — what each clause of NFR-9 means here and the check that holds it; this row was not struck then. Since 2026-11-09 (beta.35, D88) the users' half is `ACCESSIBILITY.md`, and NFR-9 names screen readers and contrast themes too. **Row closed** | NFR-9, `08_UI` |
|
||||
| **Uninstall / data deletion** | One Velopack clause. No in-app "delete all my data", despite the privacy position | `12_BUILD`, `legal/PRIVACY_POLICY.md` |
|
||||
| ~~**Cover art**~~ | ~~Appears in the schema, the data directory and the UI; nothing says where it comes from or the licence position on downloaded store art~~ **Answered 2026-10-14 (beta.23, owner decisions D60/D61):** from the user's own image (a copy in `covers\`) or what the Steam and GOG GALAXY apps already keep on this PC — nothing is downloaded, so no store art is redistributed or fetched; the art stays its owners' (`legal/TRADEMARKS.md`), the Privacy Policy 2.11 names the files read. `08_UI` §Games › Game detail. **Row closed** | `06_DATA_MODEL`, `05_DETECTION` |
|
||||
| **The main line's .NET** *(added 2026-10-31, D73–D76)* | **When does the main line — the betas and the first release — leave .NET 10 LTS, and for what?** The alpha line (`12_BUILD` §The alpha line) builds the same source on .NET 11 to gather the evidence; it decides nothing by existing. What is known: .NET 11 is STS, supported 24 months to about 2028-11, no later than .NET 10 LTS (2028-11-14), so moving buys no support time; Microsoft's supported-OS list for .NET 11 has Windows 10 only in its LTSC and IoT editions, against NFR-8's Windows 10 22H2 floor; C# 15's unions and closed hierarchies would suit the tri-states and refusal reasons, but only once the main line compiles C# 15. **Decision table, written before the evidence:** move to .NET 11 only if (a) at least two alphas on the GA runtime pass the gate and an owner's run of a hooked title with no runtime-specific defect, (b) the owner accepts dropping NFR-8's floor to Windows 11 or ships knowingly unsupported on Windows 10, and (c) something .NET 11 brings is wanted — a measured gain or a language feature; otherwise stay on .NET 10 and take .NET 12 LTS (expected 2027-11) the same way, through the alpha line first | `12_BUILD`, `13_CI_CD`, `02_SPEC` NFR-8, CLAUDE.md pinned stack |
|
||||
|
||||
+91
-64
@@ -72,6 +72,7 @@ owner-only items stay below; the history of every train, the passed owner-only i
|
||||
| `§beta.30` | [`handoff/history/0.1.0-beta.30.md`](handoff/history/0.1.0-beta.30.md) |
|
||||
| `§beta.31` | [`handoff/history/0.1.0-beta.31.md`](handoff/history/0.1.0-beta.31.md) |
|
||||
| `§beta.32` | [`handoff/history/0.1.0-beta.32.md`](handoff/history/0.1.0-beta.32.md) |
|
||||
| `§beta.33` | [`handoff/history/0.1.0-beta.33.md`](handoff/history/0.1.0-beta.33.md) |
|
||||
| `§Owner-only`, an open item | [§Owner-only](#owner-only--no-pr-can-close-these) below |
|
||||
| `§Owner-only`, a passed item (3, 12, 14–19) | [`handoff/owner-only-passed.md`](handoff/owner-only-passed.md) |
|
||||
| `§Traps`, `§Two corrections carried forward` | [`handoff/traps.md`](handoff/traps.md) |
|
||||
@@ -79,87 +80,92 @@ owner-only items stay below; the history of every train, the passed owner-only i
|
||||
|
||||
---
|
||||
|
||||
## **START HERE** — 2026-11-03, 0.1.0-beta.33: games from the Xbox app and the Microsoft Store
|
||||
## **START HERE** — 2026-11-06, 0.1.0-beta.34: DLSS 5 and DLSS 4.5 from what the game and the driver did; filters; Games at once
|
||||
|
||||
*Status is `docs/changelog/0.1.0-beta.33.md`; this is what no other file carries.* The owner: "Trong phiên này, ta sẽ tập
|
||||
trung xử lý, đánh giá, phân tích cho các game thuộc MS Store/ Xbox App/Game Pass cho (các) phiên bản tiếp theo nhé. Quy
|
||||
trình vẫn như mọi lần." — handle, evaluate and analyse the games of the Microsoft Store, the Xbox app and Game Pass for the
|
||||
next versions, the usual train; the owner's games are in `C:\XboxGames` and `D:\xbox`. #351 (the library, the install
|
||||
root, detection, the art, Privacy 2.13), #352 (Play, the guard's two refusals, one exe-path reader) and this release;
|
||||
`0.1.0-alpha.2` follows (D82).
|
||||
*Status is `docs/changelog/0.1.0-beta.34.md`; this is what no other file carries.* The owner asked for seven things, the
|
||||
usual train: (1) how DLSS 5 Neural Rendering is detected on Hogwarts Legacy (Neural Rendering on in the game), and its
|
||||
version; (2) under the NVIDIA App's *Dynamic* multi frame generation the label read DLSS 4, though Dynamic and ×6 exist
|
||||
only in DLSS 4.5 (Phantom Blade Zero); (3) filters on Games and Compare; (4) the Compare page's layout, from a
|
||||
screenshot; (5) the documents and the tested-games list, from the database; (6) switching to Games stalled 0.5–1.5 s;
|
||||
(7) a language change landed on the last content page instead of Settings. And while planning: "Bạn check Streamline các
|
||||
bản gần đây có gì thay đổi và sửa luôn nếu thật sự cần nhé." — check what changed in recent Streamline versions and fix it
|
||||
if really needed. #356 (two fixes from a self-review of #351 and #352), #357 (D83), #358 (D84, Streamline `v2.14.16`),
|
||||
#359 (items 6 and 7), #360 (items 3 and 4, D85, D86), #361 (item 5) and this release; `0.1.0-alpha.3` follows (D87) —
|
||||
the owner's screenshot is of an alpha, so the alpha is how these reach the owner's PC.
|
||||
|
||||
**Decisions (asked while planning, do not re-ask):**
|
||||
|
||||
- **D77 — measure first, on the owner's titles**: the launch chain was measured by activating six of the eleven packages
|
||||
with no FrameLedger hook, read-only, each game closed by its window and never killed, with the decision table committed
|
||||
before the run (`spike-notes` §25, its two commits in #351).
|
||||
- **D78 — GDK only**: an app-container (UWP) process is refused with a reason of its own, `TargetAppContainer`, Tier 2
|
||||
(`19_SAFETY` §The target must be able to take the Overlay); `LIMITATIONS.md` says so.
|
||||
- **D79 — the platform is "Xbox"** (id `xbox`), full scope: import, art, Play, Tier-1 capture, detection, docs and legal.
|
||||
- **D80 — Play on an Xbox game always activates its package**, in both D59 modes (`08_UI` §Games): started by its path a
|
||||
GDK game is never the game in its package — the run corrected the plan's premise that `CreateProcess` fails with error 5
|
||||
(it hands the launch executable back to the package, so the game is not the launcher's descendant; an Unreal shipping
|
||||
executable runs outside it). The Agent records such a game in attach mode.
|
||||
- **D81 — title lists stay keyed by Steam id**: an Xbox copy is matched by everything but that entry; the gap is
|
||||
`20_OPEN_QUESTIONS` §G *Xbox app / Microsoft Store titles*.
|
||||
- **D82 — alpha.2 right after beta.33** (the owner runs `0.1.0-alpha.1`, and the alpha's channel is locked): on RC3; if
|
||||
the train reaches the alpha after .NET 11's release on 2026-11-10, the standing rule applies (SDK 11.0.100, packages
|
||||
11.0.0) — no new decision.
|
||||
- **D83 — Dynamic frame generation is DLSS 4.5's**: the owner's rule, "Dynamic and ×6 exist only in DLSS 4.5". The
|
||||
evidence is the game's driver profile setting Dynamic (`NGX_DLSSG_MODE` = 4) **and** the driver reporting its
|
||||
frame-generation override applied in the game's process (`FG_MODE` in its FG word), in a session where DLSS
|
||||
Frame Generation was identified (`fg_mode = dlssg`; its factor need not have been counted); a state measured at ×5 or more still ranks first, and a *Fixed* multiplier names nothing by itself
|
||||
(amends D64). The driver's `frameGenerationMode` — 3 under Dynamic and 1 under Fixed in every session read, and unnamed
|
||||
by NVIDIA — is recorded in `spike-notes` §26, not keyed on.
|
||||
- **D84 — DLSS 5 is the session's generation where its neural rendering was measured running**: the Overlay decodes
|
||||
`kFeatureDLSS_NR` in its `slEvaluateFeature` detour and the Agent keeps its share of the Streamline batches
|
||||
(`sessions.dlss_nr_pct`, schema 0022) — *DLSS 5 (neural rendering on N % of rendered frames)*; loaded and seen not
|
||||
running, *runtime loaded, not seen running*; where nothing could tell, *runtime loaded*, as before (amends D64).
|
||||
- **D85 — the filters**: Games — store, engine, state, installed, played; Compare — game, tier, frame generation, no
|
||||
period; Compare lists every session (it listed the newest 200).
|
||||
- **D86 — the left pane's selected item keeps its label**: our copy of WPF UI 4.3.0's LeftFluent item template, whose
|
||||
`IsActive` trigger animated it away.
|
||||
- **D87 — alpha.3 right after beta.34**, on RC3: the train reaches it before .NET 11's release on 2026-11-10.
|
||||
|
||||
The Privacy Policy 2.13's wording was approved with the plan (D36).
|
||||
Streamline was re-vendored at `v2.14.16` on the owner's instruction above, not as a decision of its own. The wording of
|
||||
the Disclaimer 2.13 and the Privacy Policy 2.14, and the tested-games list (D35), were approved with the plan (D36).
|
||||
|
||||
**Choices made here:**
|
||||
|
||||
- **A GDK package root is an install-root boundary**, for the guard's check 4 and for detection alike, and only where no
|
||||
store boundary matched — so it can only widen what is walked (`19_SAFETY` §Pre-injection checks, amended 2026-11-03).
|
||||
The guard gained `GamesInstalled\<X>` with it, and one case list read by both test suites
|
||||
(`tests/fixtures/install-roots/cases.txt`) holds the two resolvers together.
|
||||
- **`root_file`, a new detection signal**, answered from the install root's own listing, so the `xbox` platform rule —
|
||||
first, because a GDK FINAL FANTASY ships Steam's DLL — is decidable even where a very large install's walk ran short.
|
||||
- **The two refusals read the target once, before the primitive**, never at the 30 s re-scan; "could not tell" refuses as
|
||||
`ProcessUnreadable`, and only enforcing flags count (`SetContextIpValidation` without strict mode is on every
|
||||
CET-compatible process: `pwsh.exe` reads `0x105`).
|
||||
- **`TargetResolver` reads the watcher's spelling** (`ProcessImagePath`) but keeps the guard's rights, so D21's
|
||||
`TargetUnreadable` is unchanged.
|
||||
- **Neural rendering's share is over the Streamline batches**, not every present: a generated frame evaluates nothing,
|
||||
and a title that never drains a batch reads *nothing could tell* (null), never 0 %.
|
||||
- **A writer older than beta.34 is told apart by its family bit**, `FL_HOOK_SL_NEURAL_RENDERING` (bit 12), published with
|
||||
the detour — an old Overlay's silence leaves `dlss_nr_pct` null instead of a measured 0 %; no layout change.
|
||||
- **The Games page is the window's**, kept by our own page provider (`WindowPageCache`), not `NavigationCacheMode`: WPF UI
|
||||
4.3.0 reads that only when neither a service provider nor a page provider is set, and `SetNavigationControl` sets one
|
||||
(`16_WPFUI_SYNTAX` §Navigation). One per window, so a language change's window builds its own.
|
||||
- **The cards come before the executable checks** — 39 of the owner's 41 Steam games are on a USB drive that sleeps — and
|
||||
each card gets its *Not installed* pill when its check answers.
|
||||
- **The pane's item template is a copy changed in one place**, reading WPF UI's own `NavigationViewConstants.xaml`: before
|
||||
the WPF UI pin moves, the upstream template is read again.
|
||||
|
||||
**Measured on the way** (`spike-notes` §25): eleven GDK packages, full trust, the user's token, medium integrity, none of
|
||||
the four mitigations; the image path and the loader's main module both in the `Content` spelling; every game `.exe`
|
||||
refuses `FILE_READ_DATA`/`FILE_EXECUTE` outside its package, so no Unreal version and no *Runs as* for these titles;
|
||||
`GetProcessMitigationPolicy` answers through `PROCESS_QUERY_LIMITED_INFORMATION`, and an unknown policy answers
|
||||
`ERROR_INVALID_PARAMETER`.
|
||||
**Measured on the way:** the owner's DLSS sessions of 2026-11-01 → 11-06, the driver's frame-generation numbering and
|
||||
Streamline's `v2.12.0` → `v2.14.16` changes are `spike-notes` §26 (the ledger read read-only; the vendored copy was
|
||||
`v2.12.0` byte for byte); the Games page before and after is §27 (first cards 822–830 ms → 10–15 ms with the first
|
||||
executable check held 800 ms; a revisit 181–215 ms → 15–16 ms). The neural-rendering decode costs nothing measurable in
|
||||
the detour and 0.14–0.19 ns on the present's feature byte (#358's body; NFR-1's budget is 1 µs per present).
|
||||
|
||||
**Traps met on the way:**
|
||||
|
||||
- **Malwarebytes quarantines `fl_guard_test.exe`** (`Malware.Heuristic.108256`, records in
|
||||
`C:\ProgramData\Malwarebytes\MBAMService\RtpDetections`) on some builds and not others: ctest then reports `fl_guard` as
|
||||
passed in 0.5 s with no output and `fl_prescan` with an empty command. Read `LastTest.log` for the assertion count before
|
||||
believing a native pass; an exclusion for `E:\frameledger\build\` is the owner's to add (a security setting), and CI runs
|
||||
both suites.
|
||||
- **`build.ps1` finds the x64 clang-format; `Get-ChildItem … clang-format.exe` finds the ARM64 one first**, which will not
|
||||
start on this PC.
|
||||
- **SonarCloud's quality gate on #351 was 77.7 % new-code coverage** (≥ 80 % wanted) and one `cpp:S5813` (`wcslen`): both
|
||||
closed in #352 — its own gate 95.4 %, main's after the merge 86.5 % on the code since beta.32 with no open issue. The
|
||||
job is advisory, so a merge on green does not wait for it — read its verdict after each merge.
|
||||
- **FluentAssertions' `OnlyContain` fails an empty collection**: a test of what this PC holds (`GamingRoots.OnThisPc()`)
|
||||
passed here and failed on the hosted runner, which has no `.GamingRoot` (#352's first CI run) — assert that nothing
|
||||
is wrong rather than that everything is right.
|
||||
- **`notice-check` reads the tracked tree**: a file deleted from the working tree but not from the index fails it with
|
||||
*Could not find file* — after every build and test had passed (#360's first local gate). Stage the change
|
||||
(`git add -A`) before the gate.
|
||||
- **A new hook family bit belongs in the native token test's exact mask** (`guard_test.cpp`), and a new Streamline fact
|
||||
in the 0xF00D case's list of facts it must not light — #358's first gate (`0x100f` against `15`).
|
||||
- **WPF UI 4.3.0**: `NavigationCacheMode` is ignored once a page provider is set; `INavigationService.SetNavigationControl`
|
||||
hands the NavigationView the container's provider, so ours is set after it; LeftFluent's item template collapses the
|
||||
selected item's label.
|
||||
- **Microsoft.Data.Sqlite's async methods run synchronously**: a read awaited on the UI thread blocks it — `Task.Run` it.
|
||||
|
||||
**Owner-only:** item 28 — the Xbox titles on real hardware.
|
||||
**Owner-only:** item 30 — beta.34 on real hardware.
|
||||
|
||||
### 0.1.0-alpha.2 — the second alpha, the same day (D82)
|
||||
### 0.1.0-alpha.3 — the third alpha, the same day (D87)
|
||||
|
||||
`alpha` took main at this pull request — `v0.1.0-beta.33` and these notes, no other change — by a merge commit, as
|
||||
`13_CI_CD` §The alpha line says: no file the switch holds had moved on main, so nothing conflicted and the switch is the
|
||||
first alpha's (SDK `11.0.100-rc.3.26522.148`, the three packages at `11.0.0-rc.3.26522.148`, the same NuGet licence
|
||||
texts). Its gate on the 11 SDK must pass before the pull request into `alpha` is merged by hand (the branch has no
|
||||
auto-merge); the release runs from the signed tag `v0.1.0-alpha.2` on `alpha`, and its delta from alpha.1 is the first
|
||||
an alpha's release has to find — #350's lookup, by the name the pack lists. Its notes are
|
||||
`docs/changelog/0.1.0-alpha.2.md`, which open with the experimental-build warning.
|
||||
`alpha` takes main at this pull request — `v0.1.0-beta.34` and these notes, no other change — by a merge commit, as
|
||||
`13_CI_CD` §The alpha line says. One file the switch holds moved on main — `legal/THIRD_PARTY_NOTICES.md`, its
|
||||
Streamline row (#358) — on a line the switch does not touch (the switch changes the *Transitive* row), so the merge
|
||||
takes both without a conflict (`git merge-tree` before the pull request); main's package set did not move, and the
|
||||
switch stays the first alpha's (SDK `11.0.100-rc.3.26522.148`, the three packages at `11.0.0-rc.3.26522.148`, the same
|
||||
NuGet licence texts) — the train reached it before .NET 11's release. Its gate on the 11 SDK must pass before the pull
|
||||
request into `alpha` is merged by
|
||||
hand (the branch has no auto-merge); the release runs from the signed tag `v0.1.0-alpha.3` on `alpha`, with its delta
|
||||
from alpha.2. Its notes are `docs/changelog/0.1.0-alpha.3.md`, which open with the experimental-build warning. It is
|
||||
the first alpha whose ledger moves (schema 22): the copy it makes first is the database as alpha.2 left it, and going
|
||||
back is to the newest beta, which opens schema 22.
|
||||
|
||||
- **The next alpha moves to .NET 11's release**: from 2026-11-10 the switch is SDK `11.0.100` and the packages `11.0.0`,
|
||||
and RC3 is out of support — move the alpha even if no beta comes.
|
||||
|
||||
**Owner-only:** item 29 — the second alpha on real hardware.
|
||||
**Owner-only:** item 31 — the third alpha on real hardware.
|
||||
|
||||
|
||||
## Owner-only — no PR can close these
|
||||
@@ -363,13 +369,33 @@ an alpha's release has to find — #350's lookup, by the name the pack lists. It
|
||||
`Art_Source_Xbox`, `Import_NothingFound`, `FirstRun_Import_Body`, `Settings_GameArt_Body`, `Play_Xbox_Format`,
|
||||
`Play_Xbox_NotStarted_Format`, `Play_PackagedGame_Format`, `Play_ToolTip_Store`, `Play_ToolTip_Direct`,
|
||||
`Settings_PlayMode_Body`, `Guard_TargetAppContainer`, `Guard_TargetMitigation`. Then
|
||||
`docs/LIST_GAME_TESTED.md` gains the Xbox titles from a ledger copy (D35), approved before the commit.
|
||||
`docs/LIST_GAME_TESTED.md` gains the Xbox titles from a ledger copy (D35), approved before the commit. *(2026-11-06,
|
||||
beta.34: done — inKONBINI and Valor Mortis, with the refresh the owner approved with the plan.)*
|
||||
29. **0.1.0-alpha.2 on real hardware** (D73, D82). (a) **The update from alpha.1**: Help ▸ Check for updates offers
|
||||
alpha.2 — the first update an alpha's updater has found — and *Restart to update* installs it; say whether it
|
||||
downloaded the delta or the whole package. (b) The terms window shows the Privacy Policy 2.13 and the Alpha notice
|
||||
with its box again, and Accept waits for the tick. (c)
|
||||
`%LOCALAPPDATA%\FrameLedger\backups\ledger-before-0.1.0-alpha.2.db` exists beside alpha.1's, and opens. (d) Item 28's
|
||||
Xbox checks, on the alpha.
|
||||
30. **beta.34 on real hardware** (D83–D86). (a) **The update from beta.33** (or alpha.3's, item 31): the terms window
|
||||
shows the Disclaimer 2.13 and the Privacy Policy 2.14 once. (b) **Hogwarts Legacy with Neural Rendering on**, one
|
||||
hooked session → *DLSS 5 (neural rendering on N % of rendered frames)*; then **off** — `spike-notes` §26's table,
|
||||
written before the run, decides (on and 0 %: neural rendering runs outside `slEvaluateFeature`, the line stays
|
||||
*runtime loaded, not seen running*, and the session's `sl_tag_census` is recorded before anything is named).
|
||||
(c) **Phantom Blade Zero** under the NVIDIA App's *Dynamic, up to ×3* → *DLSS 4.5 (Dynamic multi frame generation, set
|
||||
in the NVIDIA App)*; the game's own ×3 with no override from the App → *DLSS 4*. (d) **Games** from any page: the
|
||||
cards at once, a second visit at once; the Debug line `ui: page … shown … ms after its navigation`. (e) **Settings →
|
||||
change the language** → the window comes back on Settings. (f) The filters on Games and Compare, the Compare columns
|
||||
and selection bar, the selected page's label in the pane, in both themes. (g) The 34 `ja` strings this release adds,
|
||||
all marked `review`: `Dlss_Basis_Dynamic`, `Dlss_NeuralRendering_NotSeen`, `Dlss_Feature_NeuralRendering`,
|
||||
`Dlss_Basis_NeuralRendering_Format`, `Games_Filter_*`, `Games_Header_Filtered_Format`, `Filter_Clear`,
|
||||
`Compare_Filter_*`, `Compare_Count_Format`, `Compare_Count_Filtered_Format`, `Compare_ClearSelection`,
|
||||
`Compare_MidSession_Changed`, `A11y_Games_Filter_*`, `A11y_Compare_Filter_*`.
|
||||
31. **0.1.0-alpha.3 on real hardware** (D73, D87). (a) **The update from alpha.2**: Help ▸ Check for updates offers
|
||||
alpha.3 and *Restart to update* installs it; say whether it downloaded the delta or the whole package. (b) The terms
|
||||
window shows the Disclaimer 2.13, the Privacy Policy 2.14 and the Alpha notice with its box again, and Accept waits for
|
||||
the tick. (c) `%LOCALAPPDATA%\FrameLedger\backups\ledger-before-0.1.0-alpha.3.db` exists beside alpha.2's, and opens;
|
||||
the ledger it left is at schema 22. (d) Item 30's checks, on the alpha.
|
||||
**Answered 2026-08-05, do not re-ask:** remove `gameguard` and keep `guard` (approved
|
||||
over a red `Rules` gate, with the reasoning recorded in the merge commit); vendor NVAPI
|
||||
headers **and** `amd64/nvapi64.lib`; Windows 11 is the **measurement scope** only —
|
||||
@@ -466,10 +492,11 @@ Where each owner decision is recorded — the file and its section, and a label
|
||||
| D80 | [`08_UI.md`](08_UI.md) §Games | Play on an Xbox game always activates its package, in both modes; the Agent answers `PackagedGame` and records it in attach mode |
|
||||
| D81 | [`20_OPEN_QUESTIONS.md`](20_OPEN_QUESTIONS.md) §G | title lists stay keyed by Steam id; an Xbox copy is matched by everything but that entry |
|
||||
| D82 | [`HANDOFF.md`](HANDOFF.md) §START HERE | alpha.2 right after beta.33; on RC3 unless the train reaches it after .NET 11 ships (then SDK 11.0.100, packages 11.0.0) |
|
||||
| D83 | [`05_DETECTION.md`](05_DETECTION.md) §DLSS generation | the NVIDIA App's Dynamic frame generation, reported applied by the driver in a session that counted DLSS Frame Generation, is DLSS 4.5 (amends D64) |
|
||||
| D83 | [`05_DETECTION.md`](05_DETECTION.md) §DLSS generation | the NVIDIA App's Dynamic frame generation, reported applied by the driver in a session where DLSS Frame Generation was identified, is DLSS 4.5 (amends D64) |
|
||||
| D84 | [`05_DETECTION.md`](05_DETECTION.md) §DLSS generation | DLSS 5 heads the DLSS line where its neural rendering was measured running (`kFeatureDLSS_NR`, `dlss_nr_pct`); loaded only reads "runtime loaded" (amends D64) |
|
||||
| D85 | [`08_UI.md`](08_UI.md) §Games, §Compare | filters: Games — store, engine, state, installed, played; Compare — game, tier, frame generation (no period); Compare lists every session |
|
||||
| D86 | [`08_UI.md`](08_UI.md) (the shell) | the left pane's selected item keeps its label: our copy of WPF UI 4.3.0's LeftFluent item template |
|
||||
| D87 | [`HANDOFF.md`](HANDOFF.md) §START HERE | alpha.3 right after beta.34, on RC3 (before .NET 11's release, 2026-11-10) |
|
||||
|
||||
---
|
||||
|
||||
|
||||
+46
-16
@@ -1,43 +1,47 @@
|
||||
# Games FrameLedger has been run with
|
||||
|
||||
*As of 2026-09-27 (0.1.0-beta.10). Built from a copy of the developer's own FrameLedger database and the repository's
|
||||
*As of 2026-11-06 (0.1.0-beta.34). Built from a copy of the developer's own FrameLedger database and the repository's
|
||||
measurement notes, and reviewed by the project's owner before it was published. It lists what happened on one machine;
|
||||
it promises nothing about any other.*
|
||||
|
||||
*(Not re-read for 0.1.0-beta.11 or 0.1.0-beta.12 — noted 2026-10-04. Refreshing it needs a new copy of the database and
|
||||
the owner's review; sessions since 2026-09-27, and the game-memory figures beta.12 adds, are not here.)*
|
||||
*~~(Not re-read for 0.1.0-beta.11 or 0.1.0-beta.12 — noted 2026-10-04. Refreshing it needs a new copy of the database and
|
||||
the owner's review; sessions since 2026-09-27, and the game-memory figures beta.12 adds, are not here.)~~ Refreshed
|
||||
2026-11-06 from a copy of the database taken that day, and reviewed by the owner with the plan of 0.1.0-beta.34: the
|
||||
sessions since 2026-09-27 are below, with the graphics memory a game used where it adds something.*
|
||||
|
||||
**The machine.** Every row below was run on one PC: an NVIDIA GeForce RTX 5080 (the only graphics card), an Intel Core
|
||||
i7-14700KF, 32 GB of DDR5, Windows 11 (Insider builds 26300 → 29648) and a 2560×1440, 240 Hz monitor. **No AMD or Intel
|
||||
i7-14700KF, 32 GB of DDR5, Windows 11 (Insider builds 26300 → 29648) and a 2560×1440, 240 Hz monitor; the graphics
|
||||
driver went from 32.0.16.1714 to 32.0.16.2114 over the sessions in the database. **No AMD or Intel
|
||||
graphics card and no second machine has been tested**, and ~~**no real Vulkan or OpenGL game has been measured** — every
|
||||
measurement below is Direct3D 11 or 12~~ **one real Vulkan game has been measured (Everhex Demo, 2026-10-13) and no
|
||||
OpenGL game** — every other measurement below is Direct3D 11 or 12 *(corrected 2026-10-14)*. What the tiers mean and what FrameLedger cannot do: [LIMITATIONS.md](../LIMITATIONS.md).
|
||||
|
||||
**Two periods.** From 2026-08-03 to 2026-09-06 the games were measured with the developer's capture tool, one run at a
|
||||
time against the game's own settings menu (reports in [spike-notes.md](spike-notes.md)). From 2026-09-16 the shipped
|
||||
app and agent recorded them as a user would; the database holds the sessions from 2026-09-22 on — earlier ones went
|
||||
with the 2026-09-16 recovery and with library entries removed since.
|
||||
app and agent recorded them as a user would; ~~the database holds the sessions from 2026-09-22 on~~ the copy of
|
||||
2026-11-06 holds the sessions from 2026-10-04 on — earlier ones went with the 2026-09-16 recovery and with library
|
||||
entries and sessions removed since; a row citing the database before 2026-10-04 was read from the copy of 2026-09-27.
|
||||
|
||||
## Measured — hooked (Tier 1)
|
||||
|
||||
| Game | Engine | API | What was measured | When | Evidence |
|
||||
|---|---|---|---|---|---|
|
||||
| Cyberpunk 2077 | — | D3D12 | DLSS Balanced 1485×835 → 2560×1440, exact against its settings file; DLSS Frame Generation off ×1.00, ×3 (61.4 → 183.5 FPS), ×4 (58.7 → 234.1); FSR 3 + FSR frame generation ×2 (74.3 → 148.6); ray tracing *Yes* with path tracing on and *No* with it off, as set | 2026-08-15 → 09-05, about 25 runs | [spike-notes §8, §9, §11](spike-notes.md) |
|
||||
| Cyberpunk 2077 | — | D3D12 | DLSS Balanced 1485×835 → 2560×1440, exact against its settings file; DLSS Frame Generation off ×1.00, ×3 (61.4 → 183.5 FPS), ×4 (58.7 → 234.1); FSR 3 + FSR frame generation ×2 (74.3 → 148.6); ray tracing *Yes* with path tracing on and *No* with it off, as set; on 2026-10-20, ×2, ×3 and ×4 chosen in the game's menu within one session read as separate states, ×4.0 at 63.8 → 255.3 FPS, with ray tracing and Ray Reconstruction *Yes* | 2026-08-15 → 10-20, about 26 runs | [spike-notes §8, §9, §11, §23](spike-notes.md), database |
|
||||
| Dying Light: The Beast | — | D3D12 | DLSS Frame Generation ×4: Native 70.5 → Displayed 282.1 FPS, counted through DXGI; FSR + FSR frame generation ×2 (70.5 → 140.9); ray tracing *Yes* | 2026-09-04 → 09-06 | [spike-notes §9](spike-notes.md), [03_METRICS §Frame Generation](03_METRICS.md) |
|
||||
| Hell Is Us | Unreal Engine 5.5.4 | D3D12 | DLSS Frame Generation ×4 (76.5 → 306.2); DLSS shown as *driver-reported* (it bypasses Streamline); FSR + FSR frame generation ×2 (85.7 → 171.4); XeSS frame generation shown as Presented FPS only; ray tracing *No* | 2026-09-03 → 09-16 | [spike-notes §8, §9](spike-notes.md) |
|
||||
| Black Myth: Wukong | Unreal Engine 5.0.0 | D3D12 | DLSS Frame Generation ×4 (55.4 → 221.5); ray tracing *Yes* (16.2 % of frames in the app's session); a session that changed state showed its steady state (×4.1) instead of an average | 2026-08-20 → 09-16 | [spike-notes §9, §14](spike-notes.md) |
|
||||
| Clair Obscur: Expedition 33 | Unreal Engine 5.4.4 | D3D12 | DLSS + Frame Generation ×4 (54.9 → 218.4) and ×2 (76.0 → 149.8); frame generation off read *none*, with DXGI agreeing; ray tracing *No* | 2026-09-04 → 09-06 | [spike-notes §9](spike-notes.md) |
|
||||
| Clair Obscur: Expedition 33 | Unreal Engine 5.4.4 | D3D12 | DLSS + Frame Generation ×4 (54.9 → 218.4) and ×2 (76.0 → 149.8); frame generation off read *none*, with DXGI agreeing; ray tracing *No*; the NVIDIA App's *Fixed ×6* read ×6.0 (81.8 → 490.9) on 2026-10-20 | 2026-09-04 → 10-20 | [spike-notes §9, §23](spike-notes.md), database |
|
||||
| Rune Factory: Guardians of Azuma | Unreal Engine (version not in the executable) | D3D12 | DLSS Frame Generation ×4 (128.9 → 513.0); FSR frame generation compiled into the game counted ×2 but not named; ray tracing *No* (the game has none) | 2026-08-20 → 09-06 | [spike-notes §9](spike-notes.md) |
|
||||
| Kingdom Come: Deliverance II | — | D3D12 | FSR (3.1 or 4) at 1505×847 → 2560×1440; frame generation *none* (the game ships none); ray tracing *No* | 2026-09-04 | [spike-notes §9](spike-notes.md) |
|
||||
| Lies of P | Unreal Engine 4.27.2 | D3D12 | FSR 3 at 1506×848 → 2560×1440 with FSR frame generation ×2.04 (57.1 → 116.4) in the app; frame generation off read *none*; DLSS shown as *driver-reported*; ray tracing *No* | 2026-08-03 → 09-16 | [spike-notes §7, §9, §14](spike-notes.md) |
|
||||
| Lies of P | Unreal Engine 4.27.2 | D3D12 | FSR 3 at 1506×848 → 2560×1440 with FSR frame generation ×2.04 (57.1 → 116.4) in the app; frame generation off read *none*; DLSS shown as *driver-reported*; ray tracing *No*; on 2026-10-19 and 10-20, FSR 3 at 1707×961 and at 1280×720 → 2560×1440 with FSR frame generation ×2.0 (54.6 → 109.6, 57.6 → 116.7) and no FSR quality mode — the game never asked for one while the hook was in | 2026-08-03 → 10-20 | [spike-notes §7, §9, §14, §22, §23](spike-notes.md), database |
|
||||
| Onimusha: Way of the Sword (demo) | RE Engine | D3D12 | DLSS + DLSS Frame Generation: ×3.67 and ×3.93 with the capture tool, ×4.00 in the app's steady state (60 → 240 FPS), ×3.0 (60 → 180) in the app on 2026-09-22; ray tracing *Yes* | 2026-09-05 → 09-22 | [spike-notes §9, §14](spike-notes.md), database |
|
||||
| Cronos: The New Dawn (demo) | Unreal Engine (version not in the executable) | D3D12 | DLSS with frame generation off (105 FPS, *none*); on ×2 (86.8 → 172.7), DLSS Frame Generation named; ray tracing *Yes* | 2026-09-06 → 09-16 | [spike-notes §9, §14](spike-notes.md) |
|
||||
| Alan Wake 2 | — | D3D12 | Path tracing Ultra with DLSS and Ray Reconstruction: ray tracing *Yes* (96.8 % of frames), frame generation read ×1.00 (the game did not apply the setting that run). On 2026-09-04: DLSS with ray tracing *Yes* (99 % of frames), 92.5 FPS, frame generation *none* by count; then ray tracing off (*No*), DLSS, Presented 114.5 FPS. The quality preset was never read | 2026-08-04 → 09-04 | [spike-notes §8](spike-notes.md), run reports |
|
||||
| SILENT HILL 2 | Unreal Engine 5.1 | D3D12 | DLSS Frame Generation identified, frames not counted (Presented 78 FPS); DLSS *driver-reported*; ray tracing *Yes* | 2026-09-25 | database |
|
||||
| DARK SOULS III | FromSoftware | D3D11 | Presented 59.8 FPS; no upscaler, frame generation or ray tracing loaded | 2026-09-03 | [spike-notes §9](spike-notes.md) |
|
||||
| Sekiro: Shadows Die Twice | FromSoftware | D3D11 | Presented 60 FPS (the game's cap), two sessions of 15 min and 2 h 18 min | 2026-09-26 | database |
|
||||
| SILENT HILL 2 | Unreal Engine 5.1 | D3D12 | DLSS Frame Generation identified, frames not counted (Presented 78 FPS) on 2026-09-25; then under the NVIDIA App's *Fixed ×6* ×6.0 (53.3 → 320.0) and under its *Dynamic, up to ×6* states ×2.0, ×3.0 and ×6.1; DLSS *driver-reported*; ray tracing *Yes* | 2026-09-25 → 10-20 | database, [spike-notes §22, §23](spike-notes.md) |
|
||||
| DARK SOULS III | FromSoftware | D3D11 | Presented 59.8 FPS; no upscaler, frame generation or ray tracing loaded; then 34 sessions at the game's 60 FPS cap, the longest 6 h 12 min, four of them ended by the game crashing | 2026-09-03 → 10-25 | [spike-notes §9](spike-notes.md), database |
|
||||
| Sekiro: Shadows Die Twice | FromSoftware | D3D11 | Presented 60 FPS (the game's cap): two sessions of 15 min and 2 h 18 min, then three more of up to 1 h 6 min | 2026-09-26 → 10-29 | database |
|
||||
| Yu-Gi-Oh! Master Duel | Unity 6000.0 | D3D11 | Presented 239 FPS across six sessions (up to 5 h 25 min) | 2026-09-22 → 09-25 | database |
|
||||
| GIRLS' FRONTLINE 2: EXILIUM | Unity 2019.4 | D3D11 | Presented 53–101 FPS; the last three sessions under the user-mode anti-cheat exception (NetEase Yidun), one of them 3 h 9 min, all ended normally | 2026-09-21 → 09-27 | database, [HANDOFF](HANDOFF.md) |
|
||||
| GIRLS' FRONTLINE 2: EXILIUM | Unity 2019.4 | D3D11 | Presented 53–101 FPS; the last three sessions under the user-mode anti-cheat exception (NetEase Yidun), one of them 3 h 9 min, all ended normally; ten more under the exception, 28–72 FPS, the longest 2 h 9 min, all ended normally | 2026-09-21 → 10-20 | database, [HANDOFF](HANDOFF.md) |
|
||||
| Aniimo | Unity 2022.3 | D3D12 | DLSS at 1707×960 → 2560×1440, frame generation *none* (×1.00, 205 FPS), ray tracing *No* — then blocked (below) | 2026-09-22 | database |
|
||||
| AbyssMemory | Unreal Engine 4.26.1 | D3D11 | Presented 55 FPS, one short session | 2026-09-22 | database |
|
||||
| Umamusume: Pretty Derby | Unity 2022.3 | D3D11 | Presented 37 FPS, one session | 2026-09-27 | database |
|
||||
@@ -45,6 +49,21 @@ with the 2026-09-16 recovery and with library entries removed since.
|
||||
| Flower in Us | RPG Maker MV/MZ (NW.js) | D3D11 | Presented 59.8 FPS over three swap chains, after two refusals that found the game's browser process ambiguous (fixed) | 2026-09-03 → 09-04 | [spike-notes §9](spike-notes.md) |
|
||||
| UMIGARI | Unreal Engine 5.5.4 | D3D12 | Presented 95–97 FPS, frame generation *none*, ray tracing *No* | 2026-09-05 → 09-06 | run reports only |
|
||||
| Everhex Demo | — | Vulkan | Presented 239.7 FPS (1 % low 213.5), 14,955 frames in 69 s, through FrameLedger's Vulkan layer — the first real Vulkan game measured; started by Play set to *Start directly* | 2026-10-13 | database *(row added 2026-10-14 from a copy of the database)* |
|
||||
| The Witcher 3: Wild Hunt — Remastered | — | D3D12 | DLSS 1707×960 → 2560×1440 with DLSS Frame Generation ×2.0 (118.8 → 237.4 FPS); ray tracing and Ray Reconstruction *Yes*; under the NVIDIA App's *Fixed ×6* it still presented ×2.0 — the setting is not the frames | 2026-10-04 → 10-20 | database, [spike-notes §23](spike-notes.md) |
|
||||
| Phantom Blade Zero | Unreal Engine (version not in the executable) | D3D12 | DLSS *driver-reported*; DLSS Frame Generation under the NVIDIA App's *Dynamic* mode: up to ×6 held ×4.0 (59.5 → 235.6 FPS) and ×5.2 (44.3 → 231.2), up to ×3 held ×3.0 (58–76 → 175–227) for 75–94 % of each session longer than an hour; ray tracing *Yes*; thirteen sessions, the longest 6 h 29 min (5.26 million frames); up to 9.6 GB of graphics memory | 2026-11-01 → 11-05 | database, [spike-notes §26](spike-notes.md) |
|
||||
| Hogwarts Legacy | Unreal Engine (version not in the executable) | D3D12 | With the game's *Neural Rendering* on, DLSS 5's runtime (`nvngx_dlssnr.dll` 310.9.16.0) loaded from the game's folder — the first game seen loading it; DLSS *driver-reported*; DLSS Frame Generation not counted (non-uniform, ×1.97 overall), Presented 140.2 FPS; ray tracing *Yes*, Ray Reconstruction *No* | 2026-11-06 | database, [spike-notes §26](spike-notes.md) |
|
||||
| Valor Mortis (Xbox app) | Unreal Engine | D3D12 | DLSS Frame Generation ×6.0 (39.9 → 239.2 FPS), DLSS *driver-reported*, ray tracing *No*; recorded in attach mode | 2026-11-04 | database |
|
||||
| inKONBINI (Xbox app) | Unity 6000.0 | D3D11 | Presented 205.9 FPS, one short session | 2026-11-03 | database |
|
||||
| DARK SOULS II: Scholar of the First Sin | FromSoftware | D3D11 | The game's 60 FPS cap, nine sessions up to 5 h 29 min; one was unhooked by the safety check and recorded on | 2026-10-09 → 10-12 | database |
|
||||
| Mithril | Unreal Engine (version not in the executable) | D3D12 | Presented 91.5–119.4 FPS, ray tracing *Yes*, four sessions up to 3 h 4 min | 2026-10-12 → 10-16 | database |
|
||||
| KEEP IT ON HER | Unreal Engine 5.8 | D3D12 | Presented 59.5–108.8 FPS, ray tracing *Yes* | 2026-10-12 → 10-13 | database |
|
||||
| WALTO | Unity 6000.3 | D3D12 | Presented 212.5 FPS over 2 h 41 min (2,057,022 frames) | 2026-10-08 | database |
|
||||
| White Mask Mansion | Unity 6000.1 | D3D12 | Presented 286–309 FPS, five sessions | 2026-10-27 | database |
|
||||
| LIMINAL: Within Demo | Unity 2022.3 | D3D11 | Presented 222.5–228.6 FPS | 2026-10-12 | database |
|
||||
| Sleepytime Village | Unity 2021.3 | D3D11 | Presented 906–1,440 FPS (the game sets no cap) | 2026-10-25 → 10-26 | database |
|
||||
| Scarlet Wolf | Unity 2021.3 | D3D11 | Presented 128.5 FPS | 2026-10-15 | database |
|
||||
| March Out! Playtest | Unity 2022.3 | D3D11 | Presented 118.2 FPS | 2026-10-08 | database |
|
||||
| A Space for the Unbound – Prologue (GOG) | Unity 2019.4 | D3D11 | Presented 61.0 FPS, started by FrameLedger | 2026-10-20 | database |
|
||||
|
||||
## Recorded without measurement (Tier 2)
|
||||
|
||||
@@ -52,8 +71,14 @@ with the 2026-09-16 recovery and with library entries removed since.
|
||||
|---|---|---|---|
|
||||
| HELLO, HELLO WORLD! | A 32-bit game (RPG Maker MV): refused by the guard once, and two sessions with hooking switched off — each recorded with its duration and sensors. *Its itch.io download puts malware in front of the game — do not run it (noted 2026-10-13, [spike-notes §20](spike-notes.md))* | 2026-09-23 | database |
|
||||
| Umamusume: Pretty Derby | Three sessions played with hooking switched off for the game | 2026-09-27 | database |
|
||||
| Sekiro: Shadows Die Twice | One session played with hooking switched off | 2026-09-25 | database |
|
||||
| Sekiro: Shadows Die Twice | Two sessions played with hooking switched off | 2026-09-25, 10-07 | database |
|
||||
| GIRLS' FRONTLINE 2: EXILIUM | One session whose process Windows would not let FrameLedger open, and two recovered after the agent itself stopped mid-session (*interrupted*) | 2026-09-22 → 09-23 | database |
|
||||
| Bound Between Desks | Two sessions with hooking switched off (a Ren'Py 8.5 game) | 2026-10-15 → 10-20 | database |
|
||||
| Phantom Blade Zero | Three sessions after a game update changed its executable on 2026-11-04, until hooking was consented to again on 11-05; one refused because a module list came back incomplete | 2026-11-04 → 11-05 | database |
|
||||
| The Witcher 3: Wild Hunt — Remastered | Three sessions before hooking was consented to | 2026-10-13 → 10-20 | database |
|
||||
| Mithril | Two sessions before hooking was consented to | 2026-10-16 | database |
|
||||
| Hogwarts Legacy | One session with hooking switched off; Windows logged a crash of the game | 2026-11-06 | database |
|
||||
| Valor Mortis, WALTO, Scarlet Wolf, Lies of P, A Space for the Unbound – Prologue | One session each with hooking switched off | 2026-10-08 → 11-04 | database |
|
||||
|
||||
## Refused by the anti-cheat guard
|
||||
|
||||
@@ -64,7 +89,10 @@ with the 2026-09-16 recovery and with library entries removed since.
|
||||
| Aniimo | NetEase Yidun with a kernel driver (`NEPKernel.sys`) in the game's folder — never eligible for an exception | 2026-09-25 | [19_SAFETY](19_SAFETY_AND_ANTICHEAT.md) |
|
||||
| Goose Goose Duck | Easy Anti-Cheat's service running, and its folder | 2026-08-04 | [spike-notes §13](spike-notes.md) |
|
||||
| Neverness To Everness | Anti-Cheat Expert's kernel driver in the game's folder | 2026-08-04 | [spike-notes §13](spike-notes.md) |
|
||||
| Wuthering Waves | Anti-Cheat Expert, kept beside the game's executable four folder levels in, where the check did not look before beta.21: a session with hooking on was injected and unhooked 37 seconds later, when the 30-second re-check met ACE's driver (`ACE-BASE.sys`); nothing was measured. Since beta.21 its folder and its Steam id refuse it before any injection *(row added 2026-10-13 from the agent's log)* | 2026-10-12 | [spike-notes §19](spike-notes.md) |
|
||||
| Wuthering Waves | Anti-Cheat Expert, kept beside the game's executable four folder levels in, where the check did not look before beta.21: a session with hooking on was injected and unhooked 37 seconds later, when the 30-second re-check met ACE's driver (`ACE-BASE.sys`); nothing was measured. Since beta.21 its folder and its Steam id refuse it before any injection *(row added 2026-10-13 from the agent's log)*; two sessions recorded without measurement on 2026-10-31 | 2026-10-12 → 10-31 | [spike-notes §19](spike-notes.md), database |
|
||||
| Arknights: Endfield | Anti-Cheat Expert's folder (`AntiCheatExpert`) beside the game; one session recorded without measurement | 2026-10-31 | database |
|
||||
| Stella Sora | Anti-Cheat Expert's folder (`AntiCheatExpert`); three sessions recorded without measurement | 2026-10-30 → 10-31 | database |
|
||||
| Umamusume: Pretty Derby | CrackProof, on FrameLedger's title list since beta.11 (Steam 3224770) — measured before the list named it (above) | 2026-10-03 | [19_SAFETY](19_SAFETY_AND_ANTICHEAT.md) |
|
||||
| Counter-Strike 2 | Valve Anti-Cheat — refused by FrameLedger's title list since beta.8. On 2026-08-04 the checks alone allowed it (VAC is invisible to them); nothing was injected | 2026-08-04, beta.8 | [spike-notes §13](spike-notes.md), [19_SAFETY](19_SAFETY_AND_ANTICHEAT.md) |
|
||||
|
||||
Also refused before any injection: **Deadly Heart Gambit** — a 32-bit game (2026-08-03).
|
||||
@@ -74,4 +102,6 @@ Also refused before any injection: **Deadly Heart Gambit** — a 32-bit game (20
|
||||
The Unreal Engine version (beta.10) was checked against ten installed Unreal games without running them: Hell Is Us
|
||||
5.5.4, Black Myth: Wukong 5.0.0, Clair Obscur: Expedition 33 5.4.4, Lies of P 4.27.2, SILENT HILL 2 5.1, UMIGARI 5.5.4,
|
||||
AbyssMemory 4.26.1, **Martha Is Dead 4.27.0**; Cronos (demo) and Rune Factory name no version in their executables and
|
||||
read *not found*. ([spike-notes §15](spike-notes.md), [05_DETECTION §Engine version](05_DETECTION.md))
|
||||
read *not found*. ([spike-notes §15](spike-notes.md), [05_DETECTION §Engine version](05_DETECTION.md)) Read since on the games
|
||||
in the database: KEEP IT ON HER 5.8 and Wuthering Waves 4.26.2; Phantom Blade Zero, Hogwarts Legacy and Mithril name no
|
||||
version in their executables, and an Xbox game's executable cannot be read outside its package (Valor Mortis).
|
||||
+5
-1
@@ -11,7 +11,7 @@ This folder is for people who build, change or review FrameLedger. **If you only
|
||||
| Find your way around first | The [wiki](https://github.com/poli0981/frameledger/wiki)'s developer pages (source: [`../wiki/`](../wiki/), beta.17) — a short page per part, each linking here |
|
||||
| Learn the system | [`../CLAUDE.md`](../CLAUDE.md) (the rules and the layout), then the reading order below |
|
||||
| Build it | [`12_BUILD.md`](12_BUILD.md) — `./build.ps1 check` is the whole gate, the same one CI runs |
|
||||
| Contribute or fork | [`../CONTRIBUTING.md`](../CONTRIBUTING.md), [`../FORKING.md`](../FORKING.md), [`../NOTICE`](../NOTICE) |
|
||||
| Contribute or fork | [`../CONTRIBUTING.md`](../CONTRIBUTING.md), [`../FORKING.md`](../FORKING.md), [`../NOTICE`](../NOTICE), [`../CODE_OF_CONDUCT.md`](../CODE_OF_CONDUCT.md) *(it and `SECURITY.md`, below, added 2026-11-09: the index named neither)* |
|
||||
|
||||
**Status lives in four places, and nowhere else** — check a status claim against the code before you plan on it:
|
||||
|
||||
@@ -87,5 +87,9 @@ are safety items, and something listed there as unresolved should not be built t
|
||||
- [`../legal/`](../legal/) — the documents a user accepts, the accuracy statement, the third-party notices and licence
|
||||
texts, the trademark note.
|
||||
- [`../LIMITATIONS.md`](../LIMITATIONS.md) — what the whole software cannot do, in a player's words.
|
||||
- [`../ACCESSIBILITY.md`](../ACCESSIBILITY.md) — the accessibility statement (beta.35, D88): the goal, what works with the
|
||||
keyboard, a screen reader and contrast themes, the known limits and how a barrier is reported; shown in the App under
|
||||
Help ▸ Accessibility. Its checks are [`08_UI.md`](08_UI.md) §Accessibility.
|
||||
- [`../SECURITY.md`](../SECURITY.md) — the private route for a vulnerability, and why the guard has no override.
|
||||
- [`../rules/detection-rules.json`](../rules/detection-rules.json) — engine, platform and capability signatures and the
|
||||
anti-cheat blocklist, validated by `tools/rules-validate.ps1`.
|
||||
@@ -0,0 +1,36 @@
|
||||
<!-- The third alpha's notes (D73, D87), on main as every release's are; the alpha branch takes them with its sync. CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-alpha.3] - 2026-11-06
|
||||
|
||||
> ⚠ **EXPERIMENTAL BUILD — YOU USE IT AT YOUR OWN RISK.** This is an **alpha**: the source of `0.1.0-beta.34` built on
|
||||
> **.NET 11 Release Candidate 3** (SDK `11.0.100-rc.3.26522.148`, runtime `11.0.0-rc.3.26522.148`), a version of .NET
|
||||
> Microsoft has not finished, with the C# 15 compiler. It has not been tested the way a beta is, and it can crash, record
|
||||
> wrongly or fail to update in ways no beta has. **If you want results you can rely on, use the beta.** Before it runs it
|
||||
> shows the *Alpha notice* (`legal/ALPHA_NOTICE.md` 1.0), which you must accept, with its own box to tick.
|
||||
|
||||
**The third alpha: `0.1.0-beta.34` on .NET 11 RC3** — DLSS 5 and DLSS 4.5 named from what the game and the driver did,
|
||||
filters on Games and Compare, and a Games page that opens at once (the beta's notes, `docs/changelog/0.1.0-beta.34.md`,
|
||||
say what that brings). What an alpha is and how to go back: the user guide's *Alpha builds* page
|
||||
(`guide/11-alpha-builds.md`), and the *Alpha builds* section of `LIMITATIONS.md`.
|
||||
|
||||
**Updating from `0.1.0-alpha.2`:** Help ▸ Check for updates, then *Restart to update* with no game running — an alpha
|
||||
updates only to newer alphas. Before it first opens your database it copies it to
|
||||
`%LOCALAPPDATA%\FrameLedger\backups\ledger-before-0.1.0-alpha.3.db` (the newest three copies are kept). The terms window
|
||||
shows the **Disclaimer 2.13** and the **Privacy Policy 2.14** once and, as every time an alpha's terms window opens, waits
|
||||
for the Alpha notice's box to be ticked again; the notice itself stays 1.0. The ledger moves to schema 22, which an
|
||||
alpha.2 cannot open (the copy is the database as alpha.2 left it; going back is to the newest beta, which opens it); the
|
||||
detection rules move to `2026.11.2`.
|
||||
|
||||
**Installing it over a beta:** download `FrameLedger.App-alpha-Setup.exe` below, verify its hash against
|
||||
`SHA256SUMS.txt`, and let it replace the FrameLedger already installed; the Alpha notice is shown first. **Going back:**
|
||||
install the newest beta's `FrameLedger.App-win-Setup.exe` over it; your database stays where it is.
|
||||
|
||||
**Windows and your PC:** as for the first alpha — Microsoft supports .NET 11 on Windows 11 24H2 and later, and on Windows
|
||||
10 only in its LTSC and IoT editions; it needs a processor with SSE4.2 and POPCNT. .NET 11 RC3 is supported until .NET 11
|
||||
ships (10 November 2026); the next alpha moves to the final release.
|
||||
|
||||
### What differs from 0.1.0-beta.34
|
||||
|
||||
The same as `0.1.0-alpha.1` differed from `0.1.0-beta.32` (`docs/changelog/0.1.0-alpha.1.md`): the runtime and the
|
||||
compiler, the three libraries serviced with the runtime, what .NET 11 itself changes — and the part of FrameLedger loaded
|
||||
into a game is the beta's.
|
||||
@@ -0,0 +1,81 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.34 was cut, 2026-11-06 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.34] - 2026-11-06
|
||||
|
||||
**The thirty-fourth pre-release: DLSS 5 and DLSS 4.5 named from what the game and the driver did, filters on Games
|
||||
and Compare, and a Games page that opens at once.** The same unsigned installer: verify its hash against
|
||||
`SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.33`:** Help ▸ Check for updates, then *Restart to update* with no game running. The
|
||||
Disclaimer (2.13) and the Privacy Policy (2.14) are shown once for you to accept; the EULA does not change. The ledger
|
||||
moves to schema 22, which a beta.33 cannot open. The detection rules move to `2026.11.2`, so every game in the
|
||||
library is read again once. DLSS 4.5 under the NVIDIA App's *Dynamic* frame generation reads on sessions you already
|
||||
have; whether DLSS 5's neural rendering ran is kept for sessions recorded from now on.
|
||||
|
||||
### Added
|
||||
|
||||
- **Filters on Games and Compare** (owner request 2026-11-06, decision D85). Games: store, engine, state, installed and
|
||||
played, beside the search and sort, with *Clear filters*; the title counts what is shown of all. Compare: game, tier
|
||||
and frame generation over every session (it listed the newest 200), with a count; a ticked session stays listed.
|
||||
|
||||
### Changed
|
||||
|
||||
- **The list of games FrameLedger has been run with is current again** (`docs/LIST_GAME_TESTED.md`, decision D35's
|
||||
method): refreshed from a copy of the owner's database taken 2026-11-06 and reviewed by the owner — fifteen more
|
||||
games measured hooked, among them Phantom Blade Zero under the NVIDIA App's *Dynamic* mode, Hogwarts Legacy loading
|
||||
DLSS 5's runtime and the first two Xbox app games — and the sessions recorded without measurement or refused by the
|
||||
guard since 2026-09-27. The guide's Settings page says a language change stays on Settings; the closed §S30 notes the
|
||||
fifth Streamline id decoded (`docs/open-questions/closed-s.md`).
|
||||
- **The Compare page's layout** (the owner's screenshot): the selection bar beside the list instead of a window's width
|
||||
away, with *Clear selection*; columns sized to what they hold — *Tier* and *FPS* touched, and wide gaps split the rest —;
|
||||
the date sorts by when; the settings-changed column says so in words or shows a dash (it was blank); the result
|
||||
table's session labels sit over their columns.
|
||||
- **The selected page keeps its name in the left pane** (D86): WPF UI's pane animates the selected item's label away
|
||||
(Compare's, in the screenshot — every page's while selected); FrameLedger uses a copy of its template without that.
|
||||
- **Games opens at once from any page** (owner request 2026-11-06: switching to Games stalled 0.5–1.5 s). The window
|
||||
keeps the library page it built and shows it again on every later visit, reading the library again behind it; the
|
||||
library is read off the UI thread; the cards appear before the executables are checked — a USB drive that sleeps
|
||||
took a second or more to answer, and no card was shown until every one had — and each card gets its *Not installed*
|
||||
pill when its check answers; a read keeps every card that would look the same instead of rebuilding them all; the
|
||||
list view builds only the rows on screen (`spike-notes` §27).
|
||||
- **Changing the language keeps the page you are on** — Settings, after a change made there. The App remembered only
|
||||
the pages it opened from code, so the language changed on Settings came back on the last game page opened
|
||||
(`src/FrameLedger.App/Services/ShellHost.cs`).
|
||||
- **DLSS 5 is named where the game ran it** (owner decision D84, amending D64). The owner's Hogwarts Legacy, Neural
|
||||
Rendering on, loaded DLSS 5's runtime (`nvngx_dlssnr.dll` 310.9.16.0, from the game's folder) and the session could say
|
||||
only *DLSS 5 runtime loaded* — nothing measured whether it ran. The Overlay's Streamline hook now decodes DLSS 5's
|
||||
feature (`kFeatureDLSS_NR`, Streamline 2.14) into its own per-frame fact, and the Agent keeps the share of the frames
|
||||
the game rendered through Streamline that carried it (`sessions.dlss_nr_pct`, **schema 0022** — a ledger this build
|
||||
migrated no longer opens in an earlier one). Seen running, the DLSS line reads *DLSS 5 (neural rendering on 97.3% of
|
||||
rendered frames)*, above every other generation; loaded and seen not running, *DLSS 5 runtime loaded, not seen
|
||||
running*; where nothing could tell (an earlier Overlay, a title outside Streamline), *DLSS 5 runtime loaded*, as
|
||||
before. Its library is listed with its version and source like the others, its Streamline plugin `sl.dlss_nr.dll`
|
||||
is recorded when loaded, and a game shipping either file shows *Supports DLSS 5 Neural Rendering* (rules
|
||||
`2026.11.2`, capability `dlss_nr`). The **Privacy Policy 2.14** names neural-rendering libraries among those whose
|
||||
versions are read; the **Disclaimer 2.13**'s accuracy block says when DLSS 5 is named. One hook-path change: one more
|
||||
compare in the `slEvaluateFeature` detour and one more test where a present is recorded (`spike-notes` §26).
|
||||
- **Streamline's headers are `v2.14.16`'s** (developers): the vendored copy was `v2.12.0`, byte for byte; three of its
|
||||
eleven files change — `kFeatureDLSS_NR`, the uplift buffer types 70–72, `kStructVersion7`, the version — and
|
||||
nothing FrameLedger consumed otherwise (`src/native/third_party/streamline/README.md`).
|
||||
- **A session under the NVIDIA App's *Dynamic* frame generation reads DLSS 4.5** (owner decision D83, amending D64).
|
||||
Dynamic and its ×6 mode exist only in DLSS 4.5, and the DLSS line named a generation from the measured multiplier
|
||||
alone: the owner's Phantom Blade Zero under *Dynamic, up to ×3* held ×2.0 and ×3.0 and read *DLSS 4 (a ×3.0
|
||||
frame-generation state)*. It reads *DLSS 4.5 (Dynamic multi frame generation, set in the NVIDIA App)* where the game's
|
||||
driver profile sets Dynamic, the driver reports its frame-generation override applied in the game's process, and DLSS
|
||||
Frame Generation was identified (whether or not its factor was counted); a state measured at ×5 or more still ranks first, and a *Fixed* multiplier names nothing
|
||||
by itself (The Witcher 3 under Fixed ×6 still presented ×2.0). The game page's chip and the CSV's `# dlss:` line
|
||||
(`basis=dynamic_frame_generation`) follow; the **Disclaimer 2.13** says so in its accuracy block
|
||||
(`src/FrameLedger.Domain/Detection/DlssGeneration.cs`, `src/FrameLedger.App/Services/DlssText.cs`; `spike-notes` §26).
|
||||
- **The guard's source reads in order again** (developers only; no behaviour changes): the note that says what runs only
|
||||
for a target the anti-cheat evaluation allowed sits above the function it describes again — beta.33's two isolation
|
||||
checks had come between them — and names that isolation check among what runs
|
||||
(`src/native/FrameLedger.Injector/src/fl_guard.cpp`).
|
||||
|
||||
### Fixed
|
||||
|
||||
- **An Xbox game's page no longer fails on a strange picture name** in the game's own `MicrosoftGame.config` (beta.33's):
|
||||
a name that points at a stream of a file (`a:b.png`) made the search for its scaled variants throw — the page then
|
||||
showed no picture and logged an error, and an action on the page that reloads it could end in the crash report. Such a
|
||||
name is no picture a package ships, so it is passed over like a name outside the package
|
||||
(`src/FrameLedger.Infrastructure/Art/XboxArtCache.cs`). Found by a self-review of #351 and #352 after their gates
|
||||
passed; no install of the owner's eleven titles has such a name.
|
||||
@@ -0,0 +1,85 @@
|
||||
# HANDOFF history — 0.1.0-beta.33
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` when 0.1.0-beta.34 was cut, 2026-11-06 (owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" mean HANDOFF.md as it stood.*
|
||||
|
||||
## **START HERE** — 2026-11-03, 0.1.0-beta.33: games from the Xbox app and the Microsoft Store
|
||||
|
||||
*Status is `docs/changelog/0.1.0-beta.33.md`; this is what no other file carries.* The owner: "Trong phiên này, ta sẽ tập
|
||||
trung xử lý, đánh giá, phân tích cho các game thuộc MS Store/ Xbox App/Game Pass cho (các) phiên bản tiếp theo nhé. Quy
|
||||
trình vẫn như mọi lần." — handle, evaluate and analyse the games of the Microsoft Store, the Xbox app and Game Pass for the
|
||||
next versions, the usual train; the owner's games are in `C:\XboxGames` and `D:\xbox`. #351 (the library, the install
|
||||
root, detection, the art, Privacy 2.13), #352 (Play, the guard's two refusals, one exe-path reader) and this release;
|
||||
`0.1.0-alpha.2` follows (D82).
|
||||
|
||||
**Decisions (asked while planning, do not re-ask):**
|
||||
|
||||
- **D77 — measure first, on the owner's titles**: the launch chain was measured by activating six of the eleven packages
|
||||
with no FrameLedger hook, read-only, each game closed by its window and never killed, with the decision table committed
|
||||
before the run (`spike-notes` §25, its two commits in #351).
|
||||
- **D78 — GDK only**: an app-container (UWP) process is refused with a reason of its own, `TargetAppContainer`, Tier 2
|
||||
(`19_SAFETY` §The target must be able to take the Overlay); `LIMITATIONS.md` says so.
|
||||
- **D79 — the platform is "Xbox"** (id `xbox`), full scope: import, art, Play, Tier-1 capture, detection, docs and legal.
|
||||
- **D80 — Play on an Xbox game always activates its package**, in both D59 modes (`08_UI` §Games): started by its path a
|
||||
GDK game is never the game in its package — the run corrected the plan's premise that `CreateProcess` fails with error 5
|
||||
(it hands the launch executable back to the package, so the game is not the launcher's descendant; an Unreal shipping
|
||||
executable runs outside it). The Agent records such a game in attach mode.
|
||||
- **D81 — title lists stay keyed by Steam id**: an Xbox copy is matched by everything but that entry; the gap is
|
||||
`20_OPEN_QUESTIONS` §G *Xbox app / Microsoft Store titles*.
|
||||
- **D82 — alpha.2 right after beta.33** (the owner runs `0.1.0-alpha.1`, and the alpha's channel is locked): on RC3; if
|
||||
the train reaches the alpha after .NET 11's release on 2026-11-10, the standing rule applies (SDK 11.0.100, packages
|
||||
11.0.0) — no new decision.
|
||||
|
||||
The Privacy Policy 2.13's wording was approved with the plan (D36).
|
||||
|
||||
**Choices made here:**
|
||||
|
||||
- **A GDK package root is an install-root boundary**, for the guard's check 4 and for detection alike, and only where no
|
||||
store boundary matched — so it can only widen what is walked (`19_SAFETY` §Pre-injection checks, amended 2026-11-03).
|
||||
The guard gained `GamesInstalled\<X>` with it, and one case list read by both test suites
|
||||
(`tests/fixtures/install-roots/cases.txt`) holds the two resolvers together.
|
||||
- **`root_file`, a new detection signal**, answered from the install root's own listing, so the `xbox` platform rule —
|
||||
first, because a GDK FINAL FANTASY ships Steam's DLL — is decidable even where a very large install's walk ran short.
|
||||
- **The two refusals read the target once, before the primitive**, never at the 30 s re-scan; "could not tell" refuses as
|
||||
`ProcessUnreadable`, and only enforcing flags count (`SetContextIpValidation` without strict mode is on every
|
||||
CET-compatible process: `pwsh.exe` reads `0x105`).
|
||||
- **`TargetResolver` reads the watcher's spelling** (`ProcessImagePath`) but keeps the guard's rights, so D21's
|
||||
`TargetUnreadable` is unchanged.
|
||||
|
||||
**Measured on the way** (`spike-notes` §25): eleven GDK packages, full trust, the user's token, medium integrity, none of
|
||||
the four mitigations; the image path and the loader's main module both in the `Content` spelling; every game `.exe`
|
||||
refuses `FILE_READ_DATA`/`FILE_EXECUTE` outside its package, so no Unreal version and no *Runs as* for these titles;
|
||||
`GetProcessMitigationPolicy` answers through `PROCESS_QUERY_LIMITED_INFORMATION`, and an unknown policy answers
|
||||
`ERROR_INVALID_PARAMETER`.
|
||||
|
||||
**Traps met on the way:**
|
||||
|
||||
- **Malwarebytes quarantines `fl_guard_test.exe`** (`Malware.Heuristic.108256`, records in
|
||||
`C:\ProgramData\Malwarebytes\MBAMService\RtpDetections`) on some builds and not others: ctest then reports `fl_guard` as
|
||||
passed in 0.5 s with no output and `fl_prescan` with an empty command. Read `LastTest.log` for the assertion count before
|
||||
believing a native pass; an exclusion for `E:\frameledger\build\` is the owner's to add (a security setting), and CI runs
|
||||
both suites.
|
||||
- **`build.ps1` finds the x64 clang-format; `Get-ChildItem … clang-format.exe` finds the ARM64 one first**, which will not
|
||||
start on this PC.
|
||||
- **SonarCloud's quality gate on #351 was 77.7 % new-code coverage** (≥ 80 % wanted) and one `cpp:S5813` (`wcslen`): both
|
||||
closed in #352 — its own gate 95.4 %, main's after the merge 86.5 % on the code since beta.32 with no open issue. The
|
||||
job is advisory, so a merge on green does not wait for it — read its verdict after each merge.
|
||||
- **FluentAssertions' `OnlyContain` fails an empty collection**: a test of what this PC holds (`GamingRoots.OnThisPc()`)
|
||||
passed here and failed on the hosted runner, which has no `.GamingRoot` (#352's first CI run) — assert that nothing
|
||||
is wrong rather than that everything is right.
|
||||
|
||||
**Owner-only:** item 28 — the Xbox titles on real hardware.
|
||||
|
||||
### 0.1.0-alpha.2 — the second alpha, the same day (D82)
|
||||
|
||||
`alpha` took main at this pull request — `v0.1.0-beta.33` and these notes, no other change — by a merge commit, as
|
||||
`13_CI_CD` §The alpha line says: no file the switch holds had moved on main, so nothing conflicted and the switch is the
|
||||
first alpha's (SDK `11.0.100-rc.3.26522.148`, the three packages at `11.0.0-rc.3.26522.148`, the same NuGet licence
|
||||
texts). Its gate on the 11 SDK must pass before the pull request into `alpha` is merged by hand (the branch has no
|
||||
auto-merge); the release runs from the signed tag `v0.1.0-alpha.2` on `alpha`, and its delta from alpha.1 is the first
|
||||
an alpha's release has to find — #350's lookup, by the name the pack lists. Its notes are
|
||||
`docs/changelog/0.1.0-alpha.2.md`, which open with the experimental-build warning.
|
||||
|
||||
- **The next alpha moves to .NET 11's release**: from 2026-11-10 the switch is SDK `11.0.100` and the packages `11.0.0`,
|
||||
and RC3 is out of support — move the alpha even if no beta comes.
|
||||
|
||||
**Owner-only:** item 29 — the second alpha on real hardware.
|
||||
@@ -121,6 +121,15 @@ rather than of an instance.
|
||||
> `spike-notes` §8 and §H5 — so item 3's counter has nothing to count on this route. That is
|
||||
> a separate finding with its own consequences for HANDOFF item 3, and it does not belong to
|
||||
> this entry.
|
||||
>
|
||||
> **2026-11-06 (beta.34, D84): a fifth id is decoded, and not by guess.** `kFeatureDLSS_NR` (1004),
|
||||
> DLSS 5's neural rendering, comes from Streamline `v2.14.16`'s own `sl_core_types.h`, re-vendored for it
|
||||
> (`src/native/third_party/streamline/README.md`) — row O4's warning holds: no id is mapped from a number seen
|
||||
> arriving. Until then an evaluation of it fell to `FL_FEAT_SL_UNDECODED`, which the Agent does not store. It
|
||||
> is its own fact (`FL_FEAT_SL_NEURAL_RENDERING`, from the drain word, never from the decoded `upscaler`
|
||||
> byte — the rule above), never an upscaler; the census counts it in a bucket of its own
|
||||
> (`SlCensus.WithNeuralRendering`), so the buckets still add up. Whether a real game evaluates it through
|
||||
> `slEvaluateFeature` is owner-only item 30(a), with its table in `spike-notes` §26.
|
||||
|
||||
<details>
|
||||
<summary>The entry as it stood while it was open, including the pre-committed table with its two holes</summary>
|
||||
|
||||
@@ -27,7 +27,8 @@ are `NvAPI_NGX_GetNGXOverrideState`'s, from `ngx_driver_words`. Bits: `0x1F` ini
|
||||
So the driver reports `FG_MODE` applied under both of the App's modes and its own mode number tells them apart — 3 under
|
||||
Dynamic, 1 under Fixed, on all sixteen sessions — but NVIDIA's header names neither number. **What D83 reads is the
|
||||
profile's value, which the header does name (4, `NGX_DLSSG_MODE_DYNAMIC`), with the report's `FG_MODE` bit as proof the
|
||||
driver applied it**, and DLSS Frame Generation counted in the session. The ceiling's decode (frames generated per
|
||||
driver applied it**, and DLSS Frame Generation identified in the session (`fg_mode = dlssg`, whether or not its factor
|
||||
was counted). The ceiling's decode (frames generated per
|
||||
rendered frame, `03_METRICS` §The mix) held: a ceiling of 5 reached ×6.0, a ceiling of 2 never passed ×3.0.
|
||||
|
||||
**Decided (D83):** a session the driver reports running the App's Dynamic mode is **DLSS 4.5**, below a measured ×5 and
|
||||
@@ -41,7 +42,7 @@ Session 132 (2026-11-06 13:56, hooked, attached, 141 s, Neural Rendering on in t
|
||||
`nvngx_dlssg.dll` 310.9.16.0 and Streamline 2.14.16 (`sl.interposer.dll`, `sl.common.dll`, `sl.dlss_g.dll`,
|
||||
`sl.reflex.dll`). The install ships the matching Streamline plugin, `Engine\Plugins\Runtime\Nvidia\StreamlineCore\
|
||||
Binaries\ThirdParty\Win64\sl.dlss_nr.dll` (402,048 bytes; `nvngx_dlssnr.dll` is 266,424,944), which no list asked about.
|
||||
The driver's super-resolution word read `0x80605` (created and evaluated, no override); the session counted DLSS Frame
|
||||
The driver's super-resolution word read `0x80605` (created and evaluated, no override); the session identified DLSS Frame
|
||||
Generation but refused a factor (non-uniform, ×1.97 overall); 140.2 FPS presented.
|
||||
|
||||
What the App made of it: *DLSS · Super Resolution 310.9.16, from the game · … · DLSS 5 runtime loaded* — loaded, never
|
||||
|
||||
+18
-13
@@ -27,20 +27,21 @@ stopped, hooking turned off — each with one button that only says you have rea
|
||||
| Menu | Item | What it does |
|
||||
|---|---|---|
|
||||
| **File** | **Add game…** | Pick a game's `.exe` file. It is added with hooking off, and its page opens. |
|
||||
| | **Import library…** | A checklist of the games installed through Steam, GOG Galaxy, Epic, itch.io and the Xbox app (or the Microsoft Store). |
|
||||
| | **Export** ▸ **Session CSV** · **Session JSON** · **Chart PNG** | Saves the session you last selected or opened. Read [Your data](05-your-data.md) before you share a file. |
|
||||
| | **Exit** | Quits FrameLedger, even when *Minimize to tray on close* is on. |
|
||||
| **File** | **Import library…** | A checklist of the games installed through Steam, GOG Galaxy, Epic, itch.io and the Xbox app (or the Microsoft Store). |
|
||||
| **File** | **Export** ▸ **Session CSV** · **Session JSON** · **Chart PNG** | Saves the session you last selected or opened. Read [Your data](05-your-data.md) before you share a file. |
|
||||
| **File** | **Exit** | Quits FrameLedger, even when *Minimize to tray on close* is on. |
|
||||
| **Tools** | **Agent status…** | Opens the Dashboard, where the agent's card is. |
|
||||
| | **Update detection rules** | The agent reads its detection rules again and checks your games again. |
|
||||
| | **Vulkan layer registration…** | Opens Settings, where the Vulkan layer is. |
|
||||
| | **Open data folder** | Opens `%LOCALAPPDATA%\FrameLedger` in Explorer. |
|
||||
| | **Database maintenance…** | **Check**, **Back up…**, **Sweep…** and **Compact** your database ([When something goes wrong](09-troubleshooting.md#the-database)). |
|
||||
| **Tools** | **Update detection rules** | The agent reads its detection rules again and checks your games again. |
|
||||
| **Tools** | **Vulkan layer registration…** | Opens Settings, where the Vulkan layer is. |
|
||||
| **Tools** | **Open data folder** | Opens `%LOCALAPPDATA%\FrameLedger` in Explorer. |
|
||||
| **Tools** | **Database maintenance…** | **Check**, **Back up…**, **Sweep…** and **Compact** your database ([When something goes wrong](09-troubleshooting.md#the-database)). |
|
||||
| **Help** | **User guide** | This guide. |
|
||||
| | **Check for updates** | Asks GitHub now. |
|
||||
| | **Report a bug…** | Builds a report on your PC ([When something goes wrong](09-troubleshooting.md#report-a-problem)). |
|
||||
| | **Online documentation** | The project's page on GitHub. |
|
||||
| | **Limitations** | What FrameLedger cannot do. |
|
||||
| | **About FrameLedger** | The version, the licences and the notices. |
|
||||
| **Help** | **Check for updates** | Asks GitHub now. |
|
||||
| **Help** | **Report a bug…** | Builds a report on your PC ([When something goes wrong](09-troubleshooting.md#report-a-problem)). |
|
||||
| **Help** | **Online documentation** | The project's page on GitHub. |
|
||||
| **Help** | **Limitations** | What FrameLedger cannot do. |
|
||||
| **Help** | **Accessibility** | What works with the keyboard alone, a screen reader or a contrast theme, what does not yet, and how to report a problem. |
|
||||
| **Help** | **About FrameLedger** | The version, the licences and the notices. |
|
||||
|
||||
## Dashboard
|
||||
|
||||
@@ -133,7 +134,11 @@ is ready.
|
||||
## Keyboard and mouse
|
||||
|
||||
- **Ctrl+1** … **Ctrl+5** open Dashboard, Games, Compare, Logs and Settings.
|
||||
- **Alt** or **F10** moves to the menus.
|
||||
- **Alt** or **F10** moves to the menus; **Alt** with a menu's underlined letter opens it (**Alt+F**, **Alt+T** and
|
||||
**Alt+H** for File, Tools and Help in English).
|
||||
- **Esc** closes a dialog the way its Close or Cancel button does.
|
||||
- Over a chart, **Ctrl** and the mouse wheel zoom, dragging pans, and a double-click resets. The wheel alone scrolls the
|
||||
page.
|
||||
|
||||
What works with the keyboard alone, a screen reader or a contrast theme — and what does not yet — is on its own page:
|
||||
[Accessibility](../ACCESSIBILITY.md) (Help ▸ Accessibility).
|
||||
@@ -42,7 +42,7 @@ The link under them, *Read what the hook does and does not do*, opens the safety
|
||||
| Setting | What it does | Default |
|
||||
|---|---|---|
|
||||
| **Theme** | Follow system, Light or Dark. Applies at once. | Follow system |
|
||||
| **Language** | English, Tiếng Việt or 日本語. The window is rebuilt in the new language at once. | English |
|
||||
| **Language** | English, Tiếng Việt or 日本語. The window is rebuilt in the new language at once, and stays on Settings (since 0.1.0-beta.34; before, it could open on the last game you looked at). | English |
|
||||
|
||||
## Games
|
||||
|
||||
|
||||
+2
-1
@@ -20,7 +20,8 @@ Each page below takes a minute or two to read. The first six are the guide; the
|
||||
12. [The terms, in plain words](terms-in-plain-words.md)
|
||||
|
||||
What FrameLedger cannot do is listed on its own page: [Limitations](../LIMITATIONS.md) (in the app: Help ▸
|
||||
Limitations).
|
||||
Limitations). How it works with the keyboard alone, a screen reader or a contrast theme, and how to report a problem:
|
||||
[Accessibility](../ACCESSIBILITY.md) (Help ▸ Accessibility).
|
||||
|
||||
**FrameLedger is beta software.** It certainly still has bugs. If something goes wrong, Help ▸ Report a bug… builds a
|
||||
report on your PC that you can look at before you decide to share it.
|
||||
|
||||
+1
-1
@@ -12,7 +12,7 @@
|
||||
HTML comments are not part of the block.
|
||||
-->
|
||||
> ⚠ **What FrameLedger actually measures today — 2026-11-06.** The software is a beta; its latest
|
||||
> **beta is `0.1.0-beta.33`** (2026-11-03), an unsigned installer built from that tag with its
|
||||
> **beta is `0.1.0-beta.34`** (2026-11-06), an unsigned installer built from that tag with its
|
||||
> checksums published beside it (alphas — experimental builds on a prerelease .NET — are published apart). The source holds the desktop app
|
||||
> (library, store import, charts, settings) and the background Agent, which records a session when a
|
||||
> game in the library runs (unless you switched its recording off), injects only into games you enabled
|
||||
|
||||
+1
-1
@@ -116,7 +116,7 @@ Frame timing is derived from high-resolution timestamps taken at the moment the
|
||||
|
||||
<!-- accuracy-block:begin -->
|
||||
> ⚠ **What FrameLedger actually measures today — 2026-11-06.** The software is a beta; its latest
|
||||
> **beta is `0.1.0-beta.33`** (2026-11-03), an unsigned installer built from that tag with its
|
||||
> **beta is `0.1.0-beta.34`** (2026-11-06), an unsigned installer built from that tag with its
|
||||
> checksums published beside it (alphas — experimental builds on a prerelease .NET — are published apart). The source holds the desktop app
|
||||
> (library, store import, charts, settings) and the background Agent, which records a session when a
|
||||
> game in the library runs (unless you switched its recording off), injects only into games you enabled
|
||||
|
||||
@@ -53,6 +53,8 @@
|
||||
<EmbeddedResource Include="..\..\LICENSE" LogicalName="LICENSE" />
|
||||
<!-- beta.10 (D36): what the whole software cannot do, shown under Help > Limitations; information, not one of FR-11's accepted documents. -->
|
||||
<EmbeddedResource Include="..\..\LIMITATIONS.md" LogicalName="LIMITATIONS.md" />
|
||||
<!-- beta.35 (D88): the accessibility statement, shown under Help > Accessibility; information, not one of FR-11's accepted documents. -->
|
||||
<EmbeddedResource Include="..\..\ACCESSIBILITY.md" LogicalName="ACCESSIBILITY.md" />
|
||||
<!-- beta.12: what Help > About shows, rendered from the text this build carries (D45: the copyright line and the GPLv3
|
||||
section 7 terms, the trademark note, the third-party notices and the index of every shipped package's licence). -->
|
||||
<EmbeddedResource Include="..\..\NOTICE" LogicalName="NOTICE" />
|
||||
|
||||
@@ -86,6 +86,7 @@
|
||||
<MenuItem Header="{x:Static res:Strings.Menu_Help_ReportBug}" Command="{Binding ViewModel.ReportBugCommand}" />
|
||||
<MenuItem Header="{x:Static res:Strings.Menu_Help_Documentation}" Command="{Binding ViewModel.DocumentationCommand}" />
|
||||
<MenuItem Header="{x:Static res:Strings.Menu_Help_Limitations}" Command="{Binding ViewModel.LimitationsCommand}" />
|
||||
<MenuItem Header="{x:Static res:Strings.Menu_Help_Accessibility}" Command="{Binding ViewModel.AccessibilityCommand}" />
|
||||
<Separator />
|
||||
<MenuItem Header="{x:Static res:Strings.Menu_Help_About}" Command="{Binding ViewModel.AboutCommand}" />
|
||||
</MenuItem>
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using System.IO;
|
||||
|
||||
namespace FrameLedger.App.Services;
|
||||
|
||||
/// <summary>
|
||||
/// <c>ACCESSIBILITY.md</c> (beta.35, owner decision D88): the project's accessibility statement — what FrameLedger aims
|
||||
/// for, what works with the keyboard, a screen reader and contrast themes, what does not yet, and how to report a
|
||||
/// barrier — embedded at build time from the repository root and shown under Help ▸ Accessibility, so the App shows
|
||||
/// exactly the text this build was reviewed with.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <b>Information, not terms</b>, like <see cref="LimitationsDocument"/>: it is not one of FR-11's documents
|
||||
/// (<see cref="LegalDocuments.Keys"/>), and nothing here is accepted.
|
||||
/// </remarks>
|
||||
public static class AccessibilityDocument
|
||||
{
|
||||
/// <summary>The embedded resource's name (<c>FrameLedger.App.csproj</c>).</summary>
|
||||
public const string ResourceName = "ACCESSIBILITY.md";
|
||||
|
||||
/// <summary>The same text in the repository at this build's source, for the window's button.</summary>
|
||||
public static readonly Uri OnGitHub = RepositoryLinks.Blob(ResourceName);
|
||||
|
||||
/// <summary>The document's text, authoring comments removed.</summary>
|
||||
/// <exception cref="InvalidOperationException">The build did not embed it.</exception>
|
||||
public static string Load()
|
||||
{
|
||||
using Stream stream = typeof(AccessibilityDocument).Assembly.GetManifestResourceStream(ResourceName)
|
||||
?? throw new InvalidOperationException($"the build did not embed {ResourceName}");
|
||||
using var reader = new StreamReader(stream);
|
||||
return LegalDocuments.StripComments(reader.ReadToEnd());
|
||||
}
|
||||
}
|
||||
@@ -201,12 +201,13 @@ public static class DlssText
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The NVIDIA App's Dynamic frame generation ran in the session (beta.34, D83): DLSS Frame Generation was counted, the
|
||||
/// The NVIDIA App's Dynamic frame generation ran in the session (beta.34, D83): DLSS Frame Generation was identified, the
|
||||
/// game's driver profile sets <c>NGX_DLSSG_MODE</c> to Dynamic, and the driver's frame-generation word reports the mode
|
||||
/// override applied in the game's process (<see cref="NgxOverrideFlags.FgMode"/>). The driver's own mode number —
|
||||
/// 3 under Dynamic and 1 under Fixed on every stored session (<c>spike-notes</c> §26) — is not what is read: NVIDIA's
|
||||
/// header names the profile's values and not the report's. A profile that sets Dynamic the driver never applied, or a
|
||||
/// session where no DLSS Frame Generation was counted, is not evidence.
|
||||
/// session where no DLSS Frame Generation was identified, is not evidence; a factor the count refused takes nothing
|
||||
/// from it.
|
||||
/// </summary>
|
||||
private static bool DynamicFrameGeneration(SessionRow row) =>
|
||||
Is(row.FgMode, "dlssg")
|
||||
|
||||
@@ -14,6 +14,7 @@ public sealed class DocumentWindows(IUrlOpener urls, IThemeApplier theme, Appear
|
||||
{
|
||||
private DocumentWindow? _guide;
|
||||
private DocumentWindow? _limitations;
|
||||
private DocumentWindow? _accessibility;
|
||||
private DocumentWindow? _alphaNotice;
|
||||
private AboutWindow? _about;
|
||||
|
||||
@@ -44,6 +45,21 @@ public sealed class DocumentWindows(IUrlOpener urls, IThemeApplier theme, Appear
|
||||
_limitations.Show();
|
||||
}
|
||||
|
||||
public void ShowAccessibility()
|
||||
{
|
||||
if (Reveal(_accessibility))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
_accessibility = new DocumentWindow(Strings.Accessibility_Title, [new DocumentPage(Strings.Accessibility_Title, AccessibilityDocument.Load(), AccessibilityDocument.ResourceName)], urls, theme, appearance)
|
||||
{
|
||||
Owner = shell.Current,
|
||||
};
|
||||
_accessibility.Closed += (_, _) => _accessibility = null;
|
||||
_accessibility.Show();
|
||||
}
|
||||
|
||||
public void ShowAlphaNotice()
|
||||
{
|
||||
if (Reveal(_alphaNotice))
|
||||
|
||||
@@ -23,9 +23,9 @@ public static class EmbeddedDocuments
|
||||
|
||||
/// <summary>
|
||||
/// The user guide's pages in reading order (beta.12, D44; <c>guide/</c> in the repository). Each page's title is its
|
||||
/// first heading; <see cref="LimitationsDocument"/> closes the list, so the guide's links to it open in the window.
|
||||
/// beta.17 (D54): the four reference pages after the FAQ make the guide the wiki's End-user part too; the alpha builds'
|
||||
/// page joins them in beta.32 (D73).
|
||||
/// first heading; <see cref="LimitationsDocument"/> and, since beta.35 (D88), <see cref="AccessibilityDocument"/> close
|
||||
/// the list, so the guide's links to them open in the window. beta.17 (D54): the four reference pages after the FAQ make
|
||||
/// the guide the wiki's End-user part too; the alpha builds' page joins them in beta.32 (D73).
|
||||
/// </summary>
|
||||
public static IReadOnlyList<string> GuidePages { get; } =
|
||||
[
|
||||
@@ -70,10 +70,13 @@ public static class EmbeddedDocuments
|
||||
Page(Strings.About_Doc_Trademarks, Trademarks),
|
||||
];
|
||||
|
||||
/// <summary>Help ▸ User guide: the guide's pages, each titled by its first heading, and the Limitations page after them.</summary>
|
||||
/// <summary>
|
||||
/// Help ▸ User guide: the guide's pages, each titled by its first heading, then the Limitations page and the
|
||||
/// accessibility statement (beta.35, D88).
|
||||
/// </summary>
|
||||
public static IReadOnlyList<DocumentPage> Guide()
|
||||
{
|
||||
var pages = new List<DocumentPage>(GuidePages.Count + 1);
|
||||
var pages = new List<DocumentPage>(GuidePages.Count + 2);
|
||||
foreach (string path in GuidePages)
|
||||
{
|
||||
string text = Read(path);
|
||||
@@ -81,6 +84,7 @@ public static class EmbeddedDocuments
|
||||
}
|
||||
|
||||
pages.Add(new DocumentPage(Strings.Limitations_Title, LimitationsDocument.Load(), LimitationsDocument.ResourceName));
|
||||
pages.Add(new DocumentPage(Strings.Accessibility_Title, AccessibilityDocument.Load(), AccessibilityDocument.ResourceName));
|
||||
return pages;
|
||||
}
|
||||
|
||||
|
||||
@@ -19,4 +19,9 @@ public interface IDocumentWindows
|
||||
void ShowAlphaNotice()
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>Help ▸ Accessibility (beta.35, D88): <c>ACCESSIBILITY.md</c>, rendered.</summary>
|
||||
void ShowAccessibility()
|
||||
{
|
||||
}
|
||||
}
|
||||
Generated
+6
@@ -64,6 +64,7 @@ public static class Strings
|
||||
nameof(About_Version_Format),
|
||||
nameof(About_ViewLicence),
|
||||
nameof(About_ViewNotice),
|
||||
nameof(Accessibility_Title),
|
||||
nameof(AddGame_Added_Format),
|
||||
nameof(AddGame_Dialog_Title),
|
||||
nameof(AddGame_Failed_Format),
|
||||
@@ -753,6 +754,7 @@ public static class Strings
|
||||
nameof(Menu_File_ImportLibrary),
|
||||
nameof(Menu_Help),
|
||||
nameof(Menu_Help_About),
|
||||
nameof(Menu_Help_Accessibility),
|
||||
nameof(Menu_Help_CheckUpdates),
|
||||
nameof(Menu_Help_Documentation),
|
||||
nameof(Menu_Help_Guide),
|
||||
@@ -1297,6 +1299,8 @@ public static class Strings
|
||||
|
||||
public static string About_ViewNotice => ResourceManager.GetString(nameof(About_ViewNotice), Culture) ?? nameof(About_ViewNotice);
|
||||
|
||||
public static string Accessibility_Title => ResourceManager.GetString(nameof(Accessibility_Title), Culture) ?? nameof(Accessibility_Title);
|
||||
|
||||
public static string AddGame_Added_Format => ResourceManager.GetString(nameof(AddGame_Added_Format), Culture) ?? nameof(AddGame_Added_Format);
|
||||
|
||||
public static string AddGame_Dialog_Title => ResourceManager.GetString(nameof(AddGame_Dialog_Title), Culture) ?? nameof(AddGame_Dialog_Title);
|
||||
@@ -2675,6 +2679,8 @@ public static class Strings
|
||||
|
||||
public static string Menu_Help_About => ResourceManager.GetString(nameof(Menu_Help_About), Culture) ?? nameof(Menu_Help_About);
|
||||
|
||||
public static string Menu_Help_Accessibility => ResourceManager.GetString(nameof(Menu_Help_Accessibility), Culture) ?? nameof(Menu_Help_Accessibility);
|
||||
|
||||
public static string Menu_Help_CheckUpdates => ResourceManager.GetString(nameof(Menu_Help_CheckUpdates), Culture) ?? nameof(Menu_Help_CheckUpdates);
|
||||
|
||||
public static string Menu_Help_Documentation => ResourceManager.GetString(nameof(Menu_Help_Documentation), Culture) ?? nameof(Menu_Help_Documentation);
|
||||
|
||||
@@ -333,6 +333,14 @@
|
||||
<value>FrameLedger にできないこと</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="Menu_Help_Accessibility" xml:space="preserve">
|
||||
<value>アクセシビリティ</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="Accessibility_Title" xml:space="preserve">
|
||||
<value>アクセシビリティ</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="Menu_Help_ReportBug" xml:space="preserve">
|
||||
<value>不具合を報告…</value>
|
||||
<comment>review</comment>
|
||||
|
||||
@@ -255,6 +255,12 @@
|
||||
<data name="Limitations_Title" xml:space="preserve">
|
||||
<value>What FrameLedger cannot do</value>
|
||||
</data>
|
||||
<data name="Menu_Help_Accessibility" xml:space="preserve">
|
||||
<value>Accessibility</value>
|
||||
</data>
|
||||
<data name="Accessibility_Title" xml:space="preserve">
|
||||
<value>Accessibility</value>
|
||||
</data>
|
||||
<data name="Menu_Help_ReportBug" xml:space="preserve">
|
||||
<value>Report a bug…</value>
|
||||
</data>
|
||||
|
||||
@@ -250,6 +250,12 @@
|
||||
<data name="Limitations_Title" xml:space="preserve">
|
||||
<value>Những điều FrameLedger không làm được</value>
|
||||
</data>
|
||||
<data name="Menu_Help_Accessibility" xml:space="preserve">
|
||||
<value>Trợ năng</value>
|
||||
</data>
|
||||
<data name="Accessibility_Title" xml:space="preserve">
|
||||
<value>Trợ năng</value>
|
||||
</data>
|
||||
<data name="Menu_Help_ReportBug" xml:space="preserve">
|
||||
<value>Báo lỗi…</value>
|
||||
</data>
|
||||
|
||||
@@ -291,6 +291,13 @@ public sealed partial class MainWindowViewModel : ObservableObject, IDisposable,
|
||||
[RelayCommand]
|
||||
private void Limitations() => _documents.ShowLimitations();
|
||||
|
||||
/// <summary>
|
||||
/// Help ▸ Accessibility (beta.35, D88): <c>ACCESSIBILITY.md</c> as this build embeds it — the accessibility statement, in a
|
||||
/// window of its own like Limitations. Information, not terms — nothing is recorded.
|
||||
/// </summary>
|
||||
[RelayCommand]
|
||||
private void Accessibility() => _documents.ShowAccessibility();
|
||||
|
||||
/// <summary>Help ▸ Report a bug… (P4 PR-3): <c>10_LOGGING</c> §Bug report flow steps 2–4, the same flow the Logs page's button runs.</summary>
|
||||
[RelayCommand]
|
||||
private async Task ReportBugAsync() => _ = await _bugReports.RunAsync().ConfigureAwait(true);
|
||||
|
||||
@@ -0,0 +1,84 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using System.IO;
|
||||
using System.Text.RegularExpressions;
|
||||
using FluentAssertions;
|
||||
using FrameLedger.App.Services;
|
||||
|
||||
namespace FrameLedger.App.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// <c>ACCESSIBILITY.md</c> (beta.35, owner decision D88) rides in the assembly for Help ▸ Accessibility, is information rather
|
||||
/// than one of FR-11's accepted documents, states WCAG 2.2 AA as a goal and never as a claim, sends a barrier to a form that
|
||||
/// exists, and names only files that exist. The pages a user reads in the App strike nothing through: the App draws struck
|
||||
/// text as a decoration, so a screen reader reads a withdrawn sentence as if it were current.
|
||||
/// </summary>
|
||||
public sealed partial class AccessibilityDocumentTests
|
||||
{
|
||||
[GeneratedRegex(@"\]\((?<target>[^)#\s]+)(#[^)]*)?\)", RegexOptions.ExplicitCapture, 1000)]
|
||||
private static partial Regex Link();
|
||||
|
||||
/// <summary>A sentence that would claim conformance rather than state a goal.</summary>
|
||||
[GeneratedRegex(@"\bFrameLedger (?:conforms|complies|meets WCAG|is (?:fully )?(?:accessible|compliant|conformant))", RegexOptions.IgnoreCase | RegexOptions.CultureInvariant, 1000)]
|
||||
private static partial Regex Claim();
|
||||
|
||||
[Fact]
|
||||
public void ItIsEmbeddedAsWrittenAndIsNotADocumentTheUserAccepts()
|
||||
{
|
||||
string text = AccessibilityDocument.Load();
|
||||
|
||||
text.Should().StartWith("# Accessibility").And.NotContain("<!--");
|
||||
text.Should().Be(LegalDocuments.StripComments(File.ReadAllText(Path.Combine(AccessibilityTests.RepoRoot(), AccessibilityDocument.ResourceName))),
|
||||
"the App shows the file this build was made from");
|
||||
LegalDocuments.Keys.Should().NotContain(static k => k.Contains("access", StringComparison.OrdinalIgnoreCase),
|
||||
"the Legal Gate records an acceptance per document it shows; this is information, not terms");
|
||||
AccessibilityDocument.OnGitHub.Should().Be(new Uri("https://github.com/poli0981/frameledger/blob/main/ACCESSIBILITY.md"));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void EveryRepositoryLinkNamesAFileThatExists()
|
||||
{
|
||||
string root = AccessibilityTests.RepoRoot();
|
||||
string[] targets = [.. Link().Matches(AccessibilityDocument.Load()).Select(static m => m.Groups["target"].Value)
|
||||
.Where(static t => !t.StartsWith("http", StringComparison.OrdinalIgnoreCase))];
|
||||
|
||||
targets.Should().NotBeEmpty("the statement links the guide and the developers' details");
|
||||
foreach (string target in targets)
|
||||
{
|
||||
File.Exists(Path.Combine(root, target.Replace('/', Path.DirectorySeparatorChar))).Should().BeTrue($"ACCESSIBILITY.md links {target}");
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>D88: WCAG 2.2 AA through WCAG2ICT is a goal; no sentence says FrameLedger conforms, and a barrier has a form.</summary>
|
||||
[Fact]
|
||||
public void ItStatesAGoalAndNeverAConformanceClaim()
|
||||
{
|
||||
string text = AccessibilityDocument.Load();
|
||||
|
||||
text.Should().Contain("WCAG 2.2").And.Contain("level AA").And.Contain("WCAG2ICT").And.Contain("not a claim");
|
||||
Claim().Matches(text).Select(static m => m.Value).Should().BeEmpty("D88: a goal, never a conformance claim — no evaluation has been made");
|
||||
text.Should().Contain("https://github.com/poli0981/frameledger/issues/new?template=accessibility.yml");
|
||||
|
||||
string form = File.ReadAllText(Path.Combine(AccessibilityTests.RepoRoot(), ".github", "ISSUE_TEMPLATE", "accessibility.yml"));
|
||||
form.Should().Contain("labels: [accessibility]", "the statement's form labels what it files").And.Contain("name: Accessibility problem");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The user guide, LIMITATIONS and this statement are read in the App, where a struck sentence is drawn with a line through
|
||||
/// it and read aloud as written. Say what is true now; the history is in the changelog.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public void NoPageAUserReadsInTheAppStrikesTextThrough()
|
||||
{
|
||||
IEnumerable<(string Path, string Text)> pages = EmbeddedDocuments.GuidePages.Select(static p => (p, EmbeddedDocuments.Read(p)))
|
||||
.Append((LimitationsDocument.ResourceName, LimitationsDocument.Load()))
|
||||
.Append((AccessibilityDocument.ResourceName, AccessibilityDocument.Load()));
|
||||
|
||||
pages.Where(static p => OutsideCode(p.Text).Contains("~~", StringComparison.Ordinal)).Select(static p => p.Path)
|
||||
.Should().BeEmpty("a screen reader reads struck text as current; rewrite the sentence instead");
|
||||
}
|
||||
|
||||
/// <summary>The text outside fenced code blocks.</summary>
|
||||
private static string OutsideCode(string markdown) => string.Join('\n', markdown.Split("```").Where(static (_, i) => i % 2 == 0));
|
||||
}
|
||||
@@ -0,0 +1,77 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using System.Windows;
|
||||
using System.Windows.Input;
|
||||
using FluentAssertions;
|
||||
using FrameLedger.App.Charts;
|
||||
using ScottPlot.WPF;
|
||||
|
||||
namespace FrameLedger.App.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// What a chart does with the keyboard (beta.35): <c>08_UI</c> §Accessibility said ScottPlot plots take no focus and no
|
||||
/// keys, and they take both. A chart is a Tab stop, and the keys ScottPlot reads reach it — the arrows pan, Ctrl with an
|
||||
/// arrow zooms, A shows all of it. Driven in a real window off the screen, since a key needs the window's input source.
|
||||
/// </summary>
|
||||
public sealed class ChartKeyboardTests
|
||||
{
|
||||
[Fact]
|
||||
public async Task AFocusedChartPansWithTheArrowsZoomsWithCtrlAndShowsAllWithA()
|
||||
{
|
||||
var facts = await PagesLoadTests.OnStaAsync(() =>
|
||||
{
|
||||
var plot = new WpfPlot { Width = 600, Height = 300 };
|
||||
ChartTheme.Attach(plot);
|
||||
_ = plot.Plot.Add.Signal(new double[] { 0, 1, 0, 1, 0, 1, 0 });
|
||||
Window window = ScrollBarHidingTests.OffScreen(new Window { Content = plot });
|
||||
try
|
||||
{
|
||||
window.Show();
|
||||
Visuals.Pump();
|
||||
plot.Plot.Axes.SetLimits(-5, 5, -1, 1);
|
||||
plot.Refresh();
|
||||
Visuals.Pump();
|
||||
|
||||
ScottPlot.AxisLimits start = plot.Plot.Axes.GetLimits();
|
||||
Press(plot, System.Windows.Input.Key.Left, down: true);
|
||||
Press(plot, System.Windows.Input.Key.Left, down: false);
|
||||
ScottPlot.AxisLimits panned = plot.Plot.Axes.GetLimits();
|
||||
|
||||
Press(plot, System.Windows.Input.Key.LeftCtrl, down: true);
|
||||
Press(plot, System.Windows.Input.Key.Up, down: true);
|
||||
Press(plot, System.Windows.Input.Key.Up, down: false);
|
||||
Press(plot, System.Windows.Input.Key.LeftCtrl, down: false);
|
||||
ScottPlot.AxisLimits zoomed = plot.Plot.Axes.GetLimits();
|
||||
|
||||
Press(plot, System.Windows.Input.Key.A, down: true);
|
||||
Press(plot, System.Windows.Input.Key.A, down: false);
|
||||
ScottPlot.AxisLimits all = plot.Plot.Axes.GetLimits();
|
||||
|
||||
return new { plot.Focusable, plot.IsTabStop, Start = start, Panned = panned, Zoomed = zoomed, All = all };
|
||||
}
|
||||
finally
|
||||
{
|
||||
window.Close();
|
||||
}
|
||||
});
|
||||
|
||||
facts.Focusable.Should().BeTrue("ScottPlot makes its control focusable; Tab reaches every chart");
|
||||
facts.IsTabStop.Should().BeTrue();
|
||||
facts.Panned.Left.Should().BeLessThan(facts.Start.Left, "Left moves the view to earlier values");
|
||||
(facts.Zoomed.Top - facts.Zoomed.Bottom).Should().BeLessThan(facts.Panned.Top - facts.Panned.Bottom, "Ctrl+Up zooms in vertically");
|
||||
facts.All.Left.Should().BeGreaterThan(facts.Panned.Left, "A shows all of the data again");
|
||||
facts.All.Right.Should().BeGreaterThanOrEqualTo(6, "the whole signal, seven points from 0 to 6, is in view after A");
|
||||
}
|
||||
|
||||
/// <summary>Raises the key the way WPF would: preview, then the bubbling event, from the window's own input source.</summary>
|
||||
private static void Press(WpfPlot plot, Key key, bool down)
|
||||
{
|
||||
PresentationSource source = PresentationSource.FromVisual(plot) ?? throw new InvalidOperationException("the plot has no input source");
|
||||
var preview = new KeyEventArgs(Keyboard.PrimaryDevice, source, Environment.TickCount, key) { RoutedEvent = down ? Keyboard.PreviewKeyDownEvent : Keyboard.PreviewKeyUpEvent };
|
||||
plot.RaiseEvent(preview);
|
||||
var bubble = new KeyEventArgs(Keyboard.PrimaryDevice, source, Environment.TickCount, key) { RoutedEvent = down ? Keyboard.KeyDownEvent : Keyboard.KeyUpEvent };
|
||||
plot.RaiseEvent(bubble);
|
||||
Visuals.Pump();
|
||||
}
|
||||
}
|
||||
@@ -112,7 +112,8 @@ public sealed class DlssTextTests
|
||||
/// <summary>
|
||||
/// beta.34, owner decision D83: Phantom Blade Zero under the NVIDIA App's Dynamic frame generation, up to ×3, held ×2.0
|
||||
/// and ×3.0 and read "DLSS 4 (a ×3.0 frame-generation state)" — Dynamic exists only in DLSS 4.5. Evidence is the
|
||||
/// profile's Dynamic AND the driver's report that the override applied AND DLSS Frame Generation counted.
|
||||
/// profile's Dynamic AND the driver's report that the override applied AND DLSS Frame Generation identified — its
|
||||
/// factor need not have been counted.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public void TheNvidiaAppsDynamicFrameGenerationTheDriverAppliedIsDlss45() => InEnglish(() =>
|
||||
@@ -130,7 +131,10 @@ public sealed class DlssTextTests
|
||||
DlssText.Label(phantomBlade with { DriverProfileJson = _dynamicUpToThree.Replace("\"Value\":4,", "\"Value\":2,", StringComparison.Ordinal) })
|
||||
.Should().Be("DLSS 4 (a ×3.0 frame-generation state)", "Fixed is not Dynamic: Witcher 3 under Fixed ×6 still presented ×2.0");
|
||||
DlssText.Label(phantomBlade with { FgMode = "na", FgFactor = null, FgMixJson = null })
|
||||
.Should().BeNull("no DLSS Frame Generation was counted");
|
||||
.Should().BeNull("no DLSS Frame Generation was identified");
|
||||
DlssText.Label(phantomBlade with { FgFactor = null, FgMixJson = null, FgRefusal = "non_uniform" })
|
||||
.Should().Be("DLSS 4.5 (Dynamic multi frame generation, set in the NVIDIA App)",
|
||||
"DLSS Frame Generation identified is the evidence; a factor the count refused takes nothing from it");
|
||||
DlssText.Label(phantomBlade with { NgxDriverWordsJson = null }).Should().Be("DLSS 4 (a ×3.0 frame-generation state)", "no driver report, no evidence");
|
||||
return 0;
|
||||
});
|
||||
|
||||
@@ -85,7 +85,7 @@ public sealed class DocumentWindowsTests
|
||||
}
|
||||
});
|
||||
|
||||
facts.Pages.Should().Be(EmbeddedDocuments.GuidePages.Count + 1);
|
||||
facts.Pages.Should().Be(EmbeddedDocuments.GuidePages.Count + 2, "the guide's pages, then Limitations and Accessibility");
|
||||
facts.First.Should().Be("guide/README.md");
|
||||
facts.Shown.Should().BeTrue();
|
||||
facts.Now.Should().Be("guide/01-install.md");
|
||||
@@ -123,6 +123,46 @@ public sealed class DocumentWindowsTests
|
||||
facts.Path.Should().Be("legal/ALPHA_NOTICE.md");
|
||||
}
|
||||
|
||||
/// <summary>D88: Help ▸ Accessibility opens the statement in one window — one page, no list — and asking again brings it forward.</summary>
|
||||
[Fact]
|
||||
public async Task TheAccessibilityStatementOpensInOneWindowAndAskingAgainRevealsIt()
|
||||
{
|
||||
var facts = await PagesLoadTests.OnStaAsync(() =>
|
||||
{
|
||||
var shell = new ShellHost(new ServiceCollection().BuildServiceProvider(), null!, null!, new WindowClosePolicy());
|
||||
var documents = new DocumentWindows(new NoUrlOpener(), new NoTheme(), new AppearanceSettings(new MemorySettings()), shell);
|
||||
documents.ShowAccessibility();
|
||||
documents.ShowAccessibility();
|
||||
DocumentWindow[] open = [.. System.Windows.Application.Current.Windows.OfType<DocumentWindow>()];
|
||||
try
|
||||
{
|
||||
return new
|
||||
{
|
||||
Count = open.Length,
|
||||
Title = open.Length > 0 ? open[0].Title : null,
|
||||
Pages = open.Length > 0 ? open[0].Pages.Pages.Count : 0,
|
||||
Path = open.Length > 0 ? open[0].Pages.SelectedPage?.Path : null,
|
||||
ListShown = open.Length > 0 && open[0].Pages.FindName("PageList") is UIElement { Visibility: Visibility.Visible },
|
||||
Anchors = open.Length > 0 ? open[0].Pages.Viewer.Anchors.Count : 0,
|
||||
};
|
||||
}
|
||||
finally
|
||||
{
|
||||
foreach (DocumentWindow window in open)
|
||||
{
|
||||
window.Close();
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
facts.Count.Should().Be(1, "asking again brings the open window forward rather than stacking a copy");
|
||||
facts.Title.Should().Be(Strings.Accessibility_Title);
|
||||
facts.Pages.Should().Be(1);
|
||||
facts.Path.Should().Be(AccessibilityDocument.ResourceName);
|
||||
facts.ListShown.Should().BeFalse("one page needs no list");
|
||||
facts.Anchors.Should().BeGreaterThan(5, "every section of the statement is a heading a link can scroll to");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task LimitationsIsOnePageWithNoListAndOpensOnGitHubAtThisBuildsSource()
|
||||
{
|
||||
|
||||
@@ -34,14 +34,15 @@ public sealed class GuideDocumentsTests
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void EveryPageIsEmbeddedTitledAndListedAndLimitationsClosesTheList()
|
||||
public void EveryPageIsEmbeddedTitledAndListedAndLimitationsAndAccessibilityCloseTheList()
|
||||
{
|
||||
IReadOnlyList<DocumentPage> pages = EmbeddedDocuments.Guide();
|
||||
|
||||
pages.Should().HaveCount(EmbeddedDocuments.GuidePages.Count + 1);
|
||||
pages.Should().HaveCount(EmbeddedDocuments.GuidePages.Count + 2);
|
||||
pages[0].Title.Should().Be("FrameLedger user guide");
|
||||
pages.Take(EmbeddedDocuments.GuidePages.Count).Should().OnlyContain(static p => p.Text.Length > 300 && !p.Title.EndsWith(".md", StringComparison.Ordinal));
|
||||
pages[^1].Path.Should().Be(LimitationsDocument.ResourceName);
|
||||
pages[^2].Path.Should().Be(LimitationsDocument.ResourceName);
|
||||
pages[^1].Path.Should().Be(AccessibilityDocument.ResourceName, "beta.35 (D88): the guide's links to the statement open in the window");
|
||||
|
||||
string[] onDisk = [.. Directory.EnumerateFiles(Path.Combine(RepoRoot(), "guide"), "*.md").Select(static f => "guide/" + Path.GetFileName(f)).Order(StringComparer.Ordinal)];
|
||||
EmbeddedDocuments.GuidePages.Order(StringComparer.Ordinal).Should().Equal(onDisk, "a page in guide/ that the App does not list could never be read in the App");
|
||||
@@ -110,10 +111,13 @@ public sealed class GuideDocumentsTests
|
||||
{
|
||||
if (!anchors.TryGetValue(target, out IReadOnlyDictionary<string, System.Windows.Documents.Block>? known))
|
||||
{
|
||||
bool limitations = string.Equals(target, LimitationsDocument.ResourceName, StringComparison.Ordinal);
|
||||
string text = limitations ? LimitationsDocument.Load()
|
||||
: target.StartsWith("guide/", StringComparison.Ordinal) ? EmbeddedDocuments.Read(target)
|
||||
: File.ReadAllText(Path.Combine(root, target.Replace('/', Path.DirectorySeparatorChar)));
|
||||
string text = target switch
|
||||
{
|
||||
LimitationsDocument.ResourceName => LimitationsDocument.Load(),
|
||||
AccessibilityDocument.ResourceName => AccessibilityDocument.Load(),
|
||||
_ when target.StartsWith("guide/", StringComparison.Ordinal) => EmbeddedDocuments.Read(target),
|
||||
_ => File.ReadAllText(Path.Combine(root, target.Replace('/', Path.DirectorySeparatorChar))),
|
||||
};
|
||||
known = MarkdownRenderer.Render(text, target).Anchors;
|
||||
anchors[target] = known;
|
||||
}
|
||||
|
||||
@@ -112,7 +112,7 @@ public sealed partial class MarkdownRendererTests
|
||||
text.Should().Contain(" 0. Definitions.").And.Contain(" # not a heading", "the GPL is not Markdown: its numbered sections are not a list");
|
||||
}
|
||||
|
||||
/// <summary>Every embedded document — the Legal Gate's four and the Alpha notice (D74), LIMITATIONS, NOTICE, the trademark note, the third-party notices, the package index and the user guide's thirteen pages (eight until beta.17, twelve until beta.32).</summary>
|
||||
/// <summary>Every embedded document — the Legal Gate's four and the Alpha notice (D74), LIMITATIONS, ACCESSIBILITY (beta.35, D88), NOTICE, the trademark note, the third-party notices, the package index and the user guide's thirteen pages (eight until beta.17, twelve until beta.32).</summary>
|
||||
[Fact]
|
||||
public async Task NothingAnyEmbeddedDocumentSaysIsDropped()
|
||||
{
|
||||
@@ -120,6 +120,7 @@ public sealed partial class MarkdownRendererTests
|
||||
[
|
||||
.. LegalDocuments.Load(Shared.BuildLine.Alpha).Select(static d => (d.Path, d.Text, d.IsPlainText)),
|
||||
("LIMITATIONS.md", LimitationsDocument.Load(), false),
|
||||
(AccessibilityDocument.ResourceName, AccessibilityDocument.Load(), false),
|
||||
(EmbeddedDocuments.Notice, EmbeddedDocuments.Read(EmbeddedDocuments.Notice), true),
|
||||
(EmbeddedDocuments.Trademarks, EmbeddedDocuments.Read(EmbeddedDocuments.Trademarks), false),
|
||||
(EmbeddedDocuments.ThirdPartyNotices, EmbeddedDocuments.Read(EmbeddedDocuments.ThirdPartyNotices), false),
|
||||
@@ -155,7 +156,7 @@ public sealed partial class MarkdownRendererTests
|
||||
return problems;
|
||||
});
|
||||
|
||||
documents.Should().HaveCount(23, "ten documents and the guide's thirteen pages");
|
||||
documents.Should().HaveCount(24, "eleven documents and the guide's thirteen pages");
|
||||
missing.Should().BeEmpty("the renderer must never shorten a document a user reads or accepts");
|
||||
}
|
||||
|
||||
|
||||
@@ -296,7 +296,7 @@ public sealed class ScrollBarHidingTests
|
||||
}
|
||||
|
||||
/// <summary>A window shown where nobody sees it and never activated, small enough that the surfaces overflow it.</summary>
|
||||
private static Window OffScreen(Window window)
|
||||
internal static Window OffScreen(Window window)
|
||||
{
|
||||
window.Width = 1000;
|
||||
window.Height = 420;
|
||||
|
||||
+10
-5
@@ -5,7 +5,8 @@
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Builds the GitHub Wiki from the repository - wiki/ (Home, the sidebar, the developer pages), guide/ (the user
|
||||
guide, which is the wiki's End-user part) and LIMITATIONS.md - and refuses a wiki with a link that leads nowhere.
|
||||
guide, which is the wiki's End-user part), LIMITATIONS.md and ACCESSIBILITY.md - and refuses a wiki with a link that
|
||||
leads nowhere.
|
||||
|
||||
.DESCRIPTION
|
||||
D53/D54 (the owner, 2026-10-07): the wiki's source lives in the repository and the Wiki tab is a copy of it, written
|
||||
@@ -15,7 +16,8 @@
|
||||
Assembling:
|
||||
- wiki/*.md keeps its file name, which GitHub turns into the page's title (Build-and-test.md: "Build and test").
|
||||
- A guide page becomes the page its first heading names (guide/README.md is User-guide, LIMITATIONS.md is
|
||||
Limitations). Every page's first heading is dropped: the wiki prints the page's name above it.
|
||||
Limitations, ACCESSIBILITY.md - beta.35, D88 - is Accessibility). Every page's first heading is dropped: the wiki
|
||||
prints the page's name above it.
|
||||
- A link to one of those pages becomes the page's name; a link to any other file or folder of the repository
|
||||
becomes its address on GitHub at -Ref, the release being published; anchors are kept.
|
||||
- _Footer.md is written here, naming -Ref and where to edit.
|
||||
@@ -43,9 +45,9 @@ Set-StrictMode -Version Latest
|
||||
$ErrorActionPreference = 'Stop'
|
||||
|
||||
$repoUrl = 'https://github.com/poli0981/frameledger'
|
||||
$special = @{ 'guide/README.md' = 'User-guide'; 'LIMITATIONS.md' = 'Limitations' }
|
||||
$special = @{ 'guide/README.md' = 'User-guide'; 'LIMITATIONS.md' = 'Limitations'; 'ACCESSIBILITY.md' = 'Accessibility' }
|
||||
$pathPrefixes = @('src/', 'docs/', 'tools/', 'tests/', 'guide/', 'legal/', 'wiki/', 'rules/', '.github/')
|
||||
$rootFiles = @('README.md', 'CLAUDE.md', 'CHANGELOG.md', 'LIMITATIONS.md', 'CONTRIBUTING.md', 'FORKING.md', 'SECURITY.md',
|
||||
$rootFiles = @('README.md', 'CLAUDE.md', 'CHANGELOG.md', 'LIMITATIONS.md', 'ACCESSIBILITY.md', 'CONTRIBUTING.md', 'FORKING.md', 'SECURITY.md',
|
||||
'CODE_OF_CONDUCT.md', 'NOTICE', 'LICENSE', 'VERSION', 'build.ps1', 'global.json', 'FrameLedger.slnx', 'Directory.Build.props')
|
||||
|
||||
if ($Ref -notmatch '^[A-Za-z0-9][A-Za-z0-9._/-]*$') { throw "-Ref '$Ref' is not a branch, tag or commit name" }
|
||||
@@ -103,6 +105,7 @@ function Get-Sources([string]$SourceRoot) {
|
||||
foreach ($f in Get-ChildItem (Join-Path $SourceRoot 'wiki') -Filter *.md -File | Sort-Object Name) { & $add "wiki/$($f.Name)" $f.FullName }
|
||||
foreach ($f in Get-ChildItem (Join-Path $SourceRoot 'guide') -Filter *.md -File | Sort-Object Name) { & $add "guide/$($f.Name)" $f.FullName }
|
||||
& $add 'LIMITATIONS.md' (Join-Path $SourceRoot 'LIMITATIONS.md')
|
||||
& $add 'ACCESSIBILITY.md' (Join-Path $SourceRoot 'ACCESSIBILITY.md')
|
||||
return , $sources
|
||||
}
|
||||
|
||||
@@ -281,6 +284,7 @@ if ($SelfTest) {
|
||||
Copy-Item (Join-Path $RepoRoot 'wiki') (Join-Path $tmp 'wiki') -Recurse
|
||||
Copy-Item (Join-Path $RepoRoot 'guide') (Join-Path $tmp 'guide') -Recurse
|
||||
Copy-Item (Join-Path $RepoRoot 'LIMITATIONS.md') $tmp
|
||||
Copy-Item (Join-Path $RepoRoot 'ACCESSIBILITY.md') $tmp
|
||||
$cases = 0
|
||||
$expect = {
|
||||
param([string]$What, [string]$Pattern)
|
||||
@@ -306,6 +310,7 @@ if ($SelfTest) {
|
||||
& $mutate 'wiki/Home.md' { param($t) $t + "`n[gone](../guide/01-install.md#no-such-section)`n" } 'a link to a missing section' 'no-such-section.*names no section'
|
||||
& $mutate 'wiki/Home.md' { param($t) $t + "`n[out](../../outside.md)`n" } 'a link out of the repository' 'leaves the repository'
|
||||
& $mutate 'wiki/Limitations.md' { param($t) "Same name as LIMITATIONS.md.`n" } 'two sources for one page' "both make the page 'Limitations'"
|
||||
& $mutate 'wiki/Accessibility.md' { param($t) "Same name as ACCESSIBILITY.md.`n" } 'two sources for the statement''s page' "both make the page 'Accessibility'"
|
||||
& $mutate 'wiki/Orphan.md' { param($t) "Nothing links here.`n" } 'a page nothing leads to' "leads to 'Orphan'"
|
||||
& $mutate 'wiki/_Sidebar.md' { param($t) ($t -replace '(?m)^- \[Questions and answers\]\(\.\./guide/06-faq\.md\)\r?\n', '') + "- [Questions and answers](../guide/06-faq.md)`n" } 'a sidebar out of the guide''s order' 'lists the guide as'
|
||||
& $mutate 'wiki/Home.md' { param($t) $t + "`nSee ``src/FrameLedger.App/NoSuchFile.cs``.`n" } 'a backticked path that names nothing' 'NoSuchFile\.cs.*names nothing'
|
||||
@@ -322,7 +327,7 @@ $result = Invoke-Assembly $RepoRoot $RepoRoot $Ref
|
||||
if ($result.Problems.Count -ne 0) {
|
||||
Write-Host 'WIKI CHECK FAILED:' -ForegroundColor Red
|
||||
foreach ($p in $result.Problems) { Write-Host " $p" -ForegroundColor Red }
|
||||
Write-Host ' The wiki is built from wiki/, guide/ and LIMITATIONS.md (docs/13_CI_CD.md, wiki.yml).' -ForegroundColor Red
|
||||
Write-Host ' The wiki is built from wiki/, guide/, LIMITATIONS.md and ACCESSIBILITY.md (docs/13_CI_CD.md, wiki.yml).' -ForegroundColor Red
|
||||
exit 1
|
||||
}
|
||||
if ($Check) {
|
||||
|
||||
@@ -58,3 +58,7 @@ Each of these cost a release; the full list, with the tests that hold each, is
|
||||
(`PagesLoadTests.OnStaAsync`): contrast in both themes, a theme switch while a surface is on screen, scroll bars with the
|
||||
option on in a real window, keyboard and automation names. Each surface is hosted as the App hosts it — a page in WPF UI's
|
||||
navigation presenter, not straight in a window. A rendered check is run red against the unfixed XAML first.
|
||||
|
||||
What the App promises a user of the keyboard, a screen reader or a contrast theme is
|
||||
[`ACCESSIBILITY.md`](../ACCESSIBILITY.md); the design and the checks that hold it are §Accessibility of
|
||||
[`docs/08_UI.md`](../docs/08_UI.md#accessibility). A change that moves one changes both.
|
||||
@@ -48,5 +48,8 @@ The checklist is [`.github/pull_request_template.md`](../.github/pull_request_te
|
||||
- A change to the hook layer states its measured overhead, lists any new hook in the inventory
|
||||
([`docs/17_HOOK_ENGINE.md`](../docs/17_HOOK_ENGINE.md)) and answers the safety review questions in the template.
|
||||
- A user-visible limit that moves updates [`LIMITATIONS.md`](../LIMITATIONS.md) in the same pull request.
|
||||
- A change to what the App shows keeps [`ACCESSIBILITY.md`](../ACCESSIBILITY.md#for-contributors) — a name for every
|
||||
control that shows no text, theme colours only, nothing shown by colour alone, everything reachable by keyboard — says
|
||||
in the pull request what was checked with the keyboard and Narrator, and updates the page when what works moves.
|
||||
|
||||
How to contribute and how contributions are licensed: [`CONTRIBUTING.md`](../CONTRIBUTING.md).
|
||||
+5
-3
@@ -20,8 +20,9 @@ The [user guide](../guide/README.md) is the one FrameLedger shows under Help ▸
|
||||
|
||||
To look something up: [The screens](../guide/07-screens.md), [Every setting](../guide/08-settings.md),
|
||||
[When something goes wrong](../guide/09-troubleshooting.md), [Words FrameLedger uses](../guide/10-glossary.md),
|
||||
[The terms, in plain words](../guide/terms-in-plain-words.md), and [Limitations](../LIMITATIONS.md) — what FrameLedger
|
||||
cannot do.
|
||||
[The terms, in plain words](../guide/terms-in-plain-words.md), [Limitations](../LIMITATIONS.md) — what FrameLedger
|
||||
cannot do — and [Accessibility](../ACCESSIBILITY.md): what works with the keyboard alone, a screen reader or a contrast
|
||||
theme, and how to report a barrier.
|
||||
|
||||
## Build or change FrameLedger
|
||||
|
||||
@@ -38,6 +39,7 @@ document in [`docs/`](../docs/README.md).
|
||||
## More
|
||||
|
||||
- A bug or a question: the project's [issues](https://github.com/poli0981/frameledger/issues). A game whose anti-cheat
|
||||
FrameLedger missed: the **Safety gap** form there.
|
||||
FrameLedger missed: the **Safety gap** form there. Something that cannot be reached, read or seen: the
|
||||
**Accessibility problem** form.
|
||||
- A vulnerability: [`SECURITY.md`](../SECURITY.md).
|
||||
- The licence: [`LICENSE`](../LICENSE) (GPL v3) and [`NOTICE`](../NOTICE); the name: [`legal/TRADEMARKS.md`](../legal/TRADEMARKS.md).
|
||||
+3
-2
@@ -17,7 +17,8 @@ The full documents are [`docs/13_CI_CD.md`](../docs/13_CI_CD.md) and [`docs/11_U
|
||||
1. One pull request moves the `[Unreleased]` entries of [`CHANGELOG.md`](../CHANGELOG.md) into a new file,
|
||||
`docs/changelog/<version>.md`, under a `## [x.y.z]` or `## [x.y.z-beta.N]` heading with an *Updating from* note,
|
||||
adds its row to the Releases table in `CHANGELOG.md`, and updates the release lines in `README.md`, the accuracy
|
||||
statement (`legal/ACCURACY.md` and its copies) and `LIMITATIONS.md`. `VERSION` changes only with the numeric core.
|
||||
statement (`legal/ACCURACY.md` and its copies), `LIMITATIONS.md` and `ACCESSIBILITY.md`. `VERSION` changes only with
|
||||
the numeric core.
|
||||
2. After it merges, a signed tag `vx.y.z` (or `vx.y.z-beta.N`) on the merge commit starts `release.yml`:
|
||||
- it checks the tag against `VERSION` and that the changelog has the section;
|
||||
- reads the build id from the clean checkout, before anything is edited;
|
||||
@@ -41,7 +42,7 @@ follows each beta, never several in a row ([`docs/13_CI_CD.md`](../docs/13_CI_CD
|
||||
|
||||
1. A pull request on `main` adds the alpha's notes, `docs/changelog/<version>.md`, opening with the experimental-build
|
||||
warning and naming the beta it is cut from, and its row in the Releases table. No release line moves: README, the
|
||||
accuracy statement and `LIMITATIONS.md` keep naming the beta.
|
||||
accuracy statement, `LIMITATIONS.md` and `ACCESSIBILITY.md` keep naming the beta.
|
||||
2. A pull request merges `main` into `alpha` with a merge commit; CI runs the gate there on the prerelease SDK.
|
||||
3. A rehearsal of `release.yml` on `alpha`, then a signed tag `vx.y.z-alpha.N` on its head. The workflow refuses any
|
||||
other tag on that branch, and an alpha's tag anywhere else; it packs on Velopack's `alpha` channel, so no beta is
|
||||
|
||||
@@ -43,3 +43,4 @@ Dependencies point inwards: App and Agent → Application → Domain; Infrastruc
|
||||
| `legal/` | The documents a user accepts, the accuracy statement, licences and notices. |
|
||||
| `.github/workflows/` | CI, CodeQL, the rules gate, the release and the wiki. |
|
||||
| `LIMITATIONS.md` | What the whole software cannot do, in a player's words; also in the App. |
|
||||
| `ACCESSIBILITY.md` | The accessibility statement: the goal, what works, the known limits, how a barrier is reported; also in the App. |
|
||||
@@ -16,6 +16,7 @@
|
||||
- [Alpha builds](../guide/11-alpha-builds.md)
|
||||
- [The terms, in plain words](../guide/terms-in-plain-words.md)
|
||||
- [Limitations](../LIMITATIONS.md)
|
||||
- [Accessibility](../ACCESSIBILITY.md)
|
||||
|
||||
**Build or change FrameLedger**
|
||||
|
||||
|
||||
Reference in new issue
Block a user