Compare commits

...
Author SHA1 Message Date
poli0981andClaude Opus 5.5 4bf511a378 docs: two descriptions of the artwork the code outgrew before it merged - a link is never followed, the band's colour is the cover's or else the banner's, and the checks for an image that draws nothing (beta.23 PR-4)
08_UI's note on the header's cover and 06_DATA_MODEL's cover_path comment said a chosen image's path is followed only when it is one of FrameLedger's names; since the last change to PR-3 it is also never followed through a junction or a symbolic link. 08_UI also named the band's colour the cover's (it is the banner's when there is no cover) and its test list lacked PagesLoadTests.TheGamePagesArtworkIsDrawn and AccessibilityTests.NoStyleOfAWpfUiControlLeavesOutItsTemplate.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-15 00:09:11 +07:00
poli0981andClaude Opus 5.5 a6c012ee09 docs: the first real Vulkan game in the tested list, and four places that described what was never built or a count gone stale (beta.23 PR-4)
The owner asked for the documents to be brought up to date (2026-10-14) and approved,
under D35, a row from the ledger for the Vulkan game the agent's log showed on 2026-10-13.

- LIST_GAME_TESTED: Everhex Demo (Steam 5128880) - Presented 239.7 FPS, 1 % low 213.5,
  14,955 frames in 69 s through FrameLedger's Vulkan layer, started by Play set to
  Start directly; the figures re-read from a copy of the database made with SQLite's
  online backup (12_BUILD section Debugging). Its "no real Vulkan or OpenGL game has
  been measured" is struck and corrected, and LIMITATIONS says the same in a user's words.
- 15_ROADMAP P5: "eleven pre-releases through 0.1.0-beta.11" went stale at the next
  release; it points at the CHANGELOG now instead of holding a count.
- 08_UI, Settings as specified: "Privacy: online-metadata opt-in" is struck - the card
  has not been shown since 2026-09-16 and the built section below says so.
- 05_DETECTION: the "(opt-in) Steam appdetails lookup, cached 7 days" was never built;
  FrameLedger makes no store request, and beta.23's artwork (D60) is read from disk.
- CLAUDE.md, the solution layout: FrameLedger.Injector/ also builds
  FrameLedger.Guard.dll, the guard's C ABI the Agent loads.

CHANGELOG [Unreleased] has one Changed entry.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-15 00:09:11 +07:00
poli0981andClaude Opus 5.5 fb0ee60fa0 feat(app): a game's page shows its artwork - your own image, else what the Steam or GOG GALAXY app keeps on this PC - in a band coloured from it (beta.23 PR-3) (#310)
The owner asked for a game's cover and hero art on its page, its colour optionally
carried into the page (2026-10-14), and chose: images already on the PC only, a banner
with a portrait cover, the colour on by default.

D60 - where the artwork comes from:
- The image the user chooses in Edit... > Choose image..., copied only once the dialog
  closed with Save (Cancel leaves nothing) as a PNG no larger than 1200 px a side, to
  the data folder's covers\game-<id>-<unix ms>.png - a new name for each choice, so a
  shown file is never written over - and named in games.cover_path relative to the data
  folder. A cover_path is followed only when it is one of those names, in that folder
  and never through a junction or a symbolic link: a viewer's copy of a ledger may come
  from anywhere, and a rooted, share (\\host\...) or .. path is never opened. "Use the
  store's image" deletes the copy, as removing a game with its sessions does; at start
  the App deletes the copies no row names (its own folder only, never a viewer's).
- Else what the store's app keeps: Steam's appcache\librarycache\<appid>\ (flat, or in
  hash-named folders - library_600x900[_2x], library_capsule, library_hero, header,
  library_header; the newest copy wins) and GOG GALAXY's webcache\<user>\gog\<id>\
  (WebP). Which store installed the game is asked of the stores' own records as Play
  asks (StoreRecords.Owning over Steam's and GOG's, kept two minutes), never of the
  row's platform alone; store ids are digits only. Epic's and itch's apps keep no image
  files.
- Found, decoded (no larger than the page needs, frozen, the twelve latest kept) and
  coloured on the thread pool: the page's text is there first. Nothing is downloaded; privacy.online_metadata
  stays reserved.

D61 - the band's colour: the artwork's dominant colour (a hue histogram of a 48 px copy,
greys and near-black or near-white skipped) over the card's fill, at the strongest
opacity - at most 30 % on the dark theme, 22 % on the light - at which every text the
header shows still reads: primary and secondary 4.5:1, tertiary 3:1, the pills' and the
warning's text 4.5:1 on their fills. Controls/ArtTint follows a theme switch through a
resource reference on the band (ApplicationThemeManager.Changed is raised by Apply
alone); no tint in high contrast; no text is ever drawn on a picture.

Settings > Games: "Show game artwork" (ui.game_art) and "Colour the game page from its
artwork" (ui.game_art_tint), both on. Strings in en, vi and ja (ja marked for review).

Caught in a render of the page before this commit: the cover's own Style was not based
on WPF UI's DefaultImageStyle, so the ui:Image had no template and drew nothing beside a
banner that drew. PagesLoadTests.TheGamePagesArtworkIsDrawn and
AccessibilityTests.NoStyleOfAWpfUiControlLeavesOutItsTemplate both ran red first;
16_WPFUI_SYNTAX's Gotchas list has it.

Docs: Privacy Policy 2.11 (section 1: the images you choose; section 4: the store apps'
images, and their records read when a game's page opens) with legal-drift-history,
TRADEMARKS, THIRD_PARTY_NOTICES, LIMITATIONS (Game artwork), 08_UI, 16_WPFUI_SYNTAX,
06_DATA_MODEL, 01_ARCHITECTURE, 02_SPEC FR-1.3, 05_DETECTION, 12_BUILD,
20_OPEN_QUESTIONS (Cover art closed), guide 05/07/08, wiki App-UI-development, CHANGELOG.

Tests: StoreArtCachesTests (both Steam layouts, the better cover and the newest copy,
ids of another shape, nothing there, several GOG users), ColorMathTests (agrees with the
tests' own WCAG; the hardest colours keep every pair readable in both themes),
GameArtTests (source order, a missing own image, the D59 owning rule, off in Settings
reads nothing, a cover_path not ours, a damaged file, records read once),
CoverStoreTests (a new name each choice, a non-image leaves nothing, tidying keeps a
removed row's image, deleting follows our names only, a covers junction is never
followed), EditGameViewModelTests, GameDetailViewModelTests, PagesLoadTests (the band
readable in both themes and through a switch; the edit dialog's image row; the artwork
drawn).
Local gate: ALL GATES PASSED in 282 s; the artwork classes 20 times green.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-15 00:08:58 +07:00
poli0981andClaude Opus 5.5 fb313ebca6 perf(app): a game's page opens and changes session without freezing the window; a Dashboard or Logs visit no longer stays in memory (beta.23 PR-2) (#309)
The owner asked whether switching pages and tabs is slow (2026-10-14). Measured before
changing anything, with a pre-committed bar - fix what keeps the UI thread busy 50 ms or
more, can block on I/O, or grows with each visit - over the App's own pages in a real
window, Release, a ledger shaped like the owner's (docs/spike-notes.md section 21):

- Open a game with 100 sessions: 1,175-1,507 ms -> 369 ms. The Sessions grid sat in the
  page's own scroller with no height limit and built every row (17 columns each); it is
  bounded now (MaxHeight 520, as Compare's list is), builds the rows on screen, scrolls
  itself and hands the wheel to the page at its ends.
- Choose a 2,000,000-frame session: 843-1,016 ms freeze -> 17 ms. Microsoft.Data.Sqlite
  completes its async calls synchronously, so the blob read, the decode and the stutter
  detection ran on the UI thread whatever ConfigureAwait said; then the Distribution tab
  sorted every frame three times. SessionSeriesLoader reads and decodes on the thread
  pool, and Charts.SeriesDigest works out once, there, what the charts need from the
  whole session (one sort shared by the histogram, the percentile curve and its lows;
  the gap count; the presents line). The charts' public entry points are unchanged and
  compute for themselves on a series without a digest.
- A session ends after 20 Dashboard visits: 20 notices and 20 reloads -> one of each.
  DashboardViewModel and LogsViewModel were IDisposable transients the root container
  kept until exit; every Dashboard stayed subscribed. The Dashboard attaches on Loaded
  and detaches on Unloaded; neither is IDisposable; FR-3.8's in-App notice moves to
  Services.SessionNotices, one subscription for the App's life (it reached other pages
  only through the leak), kept by AgentConnectionHostedService like LiveSessions.

Also: the game page asks whether the .exe is on disk off the UI thread and no longer
reads a drive from a property getter; GameLibrary.LoadAsync stops summarising every
game's sessions for a field nothing read (GameDetail.Summary removed); the Logs tick
reads nothing when the newest file is unchanged and filters off the UI thread; Play
reads the stores' records on the thread pool (Services.StoreRecordsReader, which PR-3's
artwork reuses); at Debug the App logs how long each page took to appear.

Recorded, not fixed (spike-notes section 21): page builds of 600-2,500 visuals still cost
85-370 ms, and the library grid (275 ms at 48 games) is non-virtualizing by the beta.11
decision - a virtualizing one changes the page's look, the owner's call.

Docs: 08_UI (the game page's costs; FR-3.8's snackbar corrected in place), 16_WPFUI_SYNTAX
Gotchas (synchronous SQLite; no IDisposable transient view models), wiki
App-UI-development, spike-notes section 21, CHANGELOG.

Tests: SeriesDigestTests (sorted forms equal the charts' own; the digest of a decoded
series; the read happens off the caller's thread), DashboardViewModelTests (an
off-screen Dashboard hears nothing, one notice per session, a hidden window leaves the
notice to the tray), GameDetailViewModelTests (the executable is looked for off the
opener's thread), LogsViewModelTests (a tick re-reads only a changed file),
PagesLoadTests (the Sessions grid builds the rows on screen and hands the wheel on).
Local gate: ALL GATES PASSED in 355 s.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-14 23:24:36 +07:00
poli0981andClaude Opus 5.5 2982679fc1 test(native): the ring's concurrency cases guard on drains that overlapped the writer, repeated until one attempt did - not on a share of the stream (beta.23 PR-1) (#308)
The owner (2026-10-13, after beta.22): "Tất cả các item đã đạt yêu cầu. Bạn
có thể xử lý chip, phiên bản mới (nếu cần), cập nhật, rồi đóng phiên nhé" -
every owner-only item passed; take the chip beta.22's local gate left.

The chip: ring_test.cpp's "SPSC under a hammering writer" made a full local
gate red on a tree that touched no native code. Its anti-vacuity guard,
CHECK(accepted > kTotal / 2), failed 5 of 40 runs and then 5 of 200 of
fl_ring_test.exe on the owner's hybrid i7-14700KF - accepted 1024, 6747,
21370, 45028, 61596 - with CHECK_FALSE(mixed) clean every time. A share of
the stream measures the scheduler: a reader on an efficiency core keeps less
than half, and one the OS does not run until the writer is done keeps one
lap. docs/HANDOFF.md's trap already said to read which assertion fired.

Measured on the way, which is why it is not one line:
- a start barrier alone (the writer starts once the reader is about to loop)
  left 1 of 200: a reader the OS did not run while the writer wrote - one
  overlapping drain, accepted 2048. No single run can rule that out.
- the tiny ring's guard, CHECK(dropped > 0), passed a reader made to wait for
  the writer to finish (1.6 million drops over eight attempts): it could not
  tell a run without overlap from one with it.

Both cases now: the start barrier; a count of the drains that copied records
while the writer was still writing; and the run repeated - every attempt
checked for its properties (mixed, poisonAccepted) - until one attempt made
100 such drains, at most 8 times; the guard is that count. The tiny ring also
keeps dropped > 0, for the attempt that overlapped (the last), no longer a sum
a vacuous attempt could fill. The property checks are unchanged.

Measured: 1,000 runs, no failure, at most 3 attempts, the best attempt at
least 122 overlapping drains (median 146,981); a reader made to wait for the
writer fails both guards in every run (most overlapped drains 0 after 8
attempts). clang-format clean.

Docs: HANDOFF's native-test trap amended (both guards, the rates, the fix);
owner-only items 16, 17 and 18 struck as passed; beta.22's section says what
followed the release. CHANGELOG [Unreleased], developers only. No release:
nothing a user runs changed.

Gate: ./build.ps1 ALL GATES PASSED (309 s). The owner's live rules files were
pre-seeded and restored byte for byte.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 23:36:42 +07:00
poli0981andClaude Opus 5.5 76e89b65de release: 0.1.0-beta.22 - the CHANGELOG section, release lines, HANDOFF's beta.22 section and owner-only item 18 (beta.22 PR-2) (#307)
VERSION stays 0.1.0: the tag's numeric core. The owner (2026-10-13, during
the beta.21 train): "Bạn xử lý chip thành 1 pr mới sau release và thành 1
phiên bản mới nhé" - the chip from beta.21's review of Play as its own PR
(#306) and its own pre-release.

- CHANGELOG: [Unreleased] becomes [0.1.0-beta.22] - 2026-10-13, with its
  summary and "Updating from 0.1.0-beta.21" (nothing to accept and no game
  read again: the legal documents and rules 2026.10.4 are beta.21's);
  tools/release-notes.ps1 -Version 0.1.0-beta.22 extracts it (1,161
  characters).
- The accuracy block's release line (legal/ACCURACY.md, embedded in README
  and the Disclaimer; its date stays 2026-10-13, nothing in it changed),
  README's release lines and count ("Twenty-two"), LIMITATIONS' version.
- HANDOFF: beta.21's START HERE struck; the beta.22 section - the owner's
  words, no new decision, the traps (VSTHRD003 and a Func<Task<T>>;
  ObjectDisposedException is an InvalidOperationException); owner-only item
  18 (the ja string; nothing else a person can run on purpose).

Gates run locally on this tree: accuracy-check, wiki-check (27 pages),
notice-check, release-notes. The code is #306's, whose tree passed
./build.ps1 (291 s) and CI.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 21:58:43 +07:00
poli0981andClaude Opus 5.5 712146685f fix(app): a request the capture agent never answered is said in words and the page reads what is stored - never a crash dialog or an exception's name (beta.22 PR-1) (#306)
The owner (2026-10-13, during beta.21): "make the chip a new PR after the
release, and a new version". The chip came from beta.21's review of Play
(#304): when the pipe closes, PipeClient fails a request in flight with what
ended its reader - an IOException, an IpcFramingException or an
ObjectDisposedException - and a client AgentConnection disposed between its
check and the write throws the last.

What each caller did, read in the code:
- SessionDeletion caught no IOException: deleting sessions while the agent
  stopped or restarted for an update ended in the App's crash dialog (an
  exception out of a command); a timeout showed its own message.
- HookingConsent and AntiCheatExceptions caught IOException and
  TimeoutException as Failed with the exception's type name as the detail:
  the game page's notice read "IOException".
- Every caller missed IpcFramingException and ObjectDisposedException.
- GamePlayer (beta.21) caught them all and said "the agent is not running",
  which is untrue when the launch may have run.

Changes:
- AgentConnection.RequestAsync answers through AnsweredAsync: an
  IpcFramingException or ObjectDisposedException becomes ONE IOException
  ("the connection to the Agent closed before it answered", the original as
  its inner exception). IAgentRequests names the four ways a request fails.
  RefreshStatusAsync also catches IpcFramingException.
- AgentAnswers.IsUnanswered (IOException or TimeoutException): whether the
  request was carried out is not known.
- SessionDeletion, HookingConsent, AntiCheatExceptions and GamePlayer tell
  the three apart: InvalidOperationException = not connected, nothing was
  sent (AgentUnavailable, in their existing words); unanswered = a new
  Unanswered outcome, said with one new string, Agent_Unanswered (en/vi/ja,
  ja marked review); IpcRequestException as before. An unanswered delete
  also lets go of what named a deleted session (it may have run), and an
  ack without its counts is unanswered too. The game page reads what is
  stored after an unanswered delete, and Settings re-reads its hooked games
  after an unanswered revoke; the consent and exception paths already
  re-read the page.
- 07_IPC section Client behavior; CHANGELOG.

Tests: AgentConnectionTests.EveryWayThePipeClosesUnderARequestIsOneIOException;
SessionDeletionAndOverviewTests.ADeleteTheAgentNeverAnsweredIsSaidAsNotKnownAndThePageReadsWhatIsStored
(a delete that ran and lost its answer: the page empties and the selection
lets go); HookingConsentTests.AnAskTheAgentNeverAnsweredIsNotKnownAndOneNeverSentIsNoAgent;
AntiCheatExceptionsTests.AnAskTheAgentNeverAnsweredIsNotKnownAndSaidInWords;
GamePlayerTests.AnAnswerThatNeverCameIsNotKnownAndARequestNeverSentIsNotRunning
(replaces beta.21's "not running").

Gate: ./build.ps1 ALL GATES PASSED (291 s); App 619. The owner's live rules
files were pre-seeded and restored byte for byte.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 21:43:02 +07:00
poli0981andClaude Opus 5.5 86dffa660f release: 0.1.0-beta.21 - the CHANGELOG section, release lines, HANDOFF's beta.21 section with D57-D59 and owner-only item 17, the Wuthering Waves row of LIST_GAME_TESTED (beta.21 PR-5) (#305)
VERSION stays 0.1.0: the tag's numeric core. The owner (2026-10-13), with the
plan: "Làm trọn mạch ngay" - commit, push, CI, auto-fix, merge, bump the
version and release in one go. The release carries #301 (check 4 also walks
the executable's folder; Wuthering Waves on the title list; rules 2026.10.4),
#302 (the four itch "launchers" are malware - the docs corrected, D57; the
Supports card), #303 (the documents' wheel; one render per page) and #304
(Play, D59; Privacy Policy 2.10).

- CHANGELOG: [Unreleased] becomes [0.1.0-beta.21] - 2026-10-13, with its
  summary and "Updating from 0.1.0-beta.20" (Privacy 2.10 shown once; every
  game read and checked for anti-cheat once more under rules 2026.10.4, and
  Wuthering Waves and any game with an anti-cheat beside its executable turned
  off; the four itch downloads pointed at Security); the subsections in Keep a
  Changelog's order (Added, Changed, Fixed, Security); #302's Supports card
  fix, which had no entry, added under Fixed. tools/release-notes.ps1 -Version
  0.1.0-beta.21 extracts it (5,147 characters).
- The accuracy block (legal/ACCURACY.md, embedded in README and the
  Disclaimer): its date moves to 2026-10-13 - #304 changed its Vulkan
  sentence, and the block asks to be dated when it changes - and its release
  line; README's release lines and count ("Twenty-one"); LIMITATIONS' version.
- HANDOFF: beta.20's START HERE struck; the beta.21 section - the owner's
  list, D57-D59, the train, the traps (the pre-scan's depth limit is a reach
  and not a refusal; a long rules note fails rules-validate with a message
  about something else; the owner's older live rules make parallel test hosts
  race; WPF's fixed 48 DIP wheel step; the review of Play after green gates
  that found four defects, fixed in #304, and SessionDeletion's same gap,
  which the owner asked for as its own PR and beta.22; the analyzers met); owner-only item 17
  (Wuthering Waves blocked before any session, NTE and GF2's exception
  unchanged; Play in both modes with a Steam, an Epic, a GOG and an itch game,
  never elevated; the wheel and a touchpad; Privacy 2.10 once; the ja strings).
- docs/LIST_GAME_TESTED.md: the Wuthering Waves row in the anti-cheat table -
  hooked 37 s on 2026-10-12 before the 30 s re-check met ACE's driver, refused
  before any injection since beta.21 - marked as added 2026-10-13 from the
  agent's log (approved with the plan, D35).

Gates run locally on this tree: accuracy-check (self-test and live),
notice-check, wiki-check (self-test and 27 pages), changelog-check and
release-notes (self-tests), release-notes -Version 0.1.0-beta.21. The code is
#304's, whose tree passed ./build.ps1 (292 s) and CI.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 21:24:12 +07:00
poli0981andClaude Opus 5.5 81e95c5a72 feat(app): Play - through the store that installed the game, or started directly by the agent, switched in Settings > Games (D59); Privacy Policy 2.10 (beta.21 PR-4) (#304)
The owner's request of 2026-10-13: "a play button on a game's page (or in the
list) that points to the platform to play". Asked with the plan, the owner
answered (D59): "1: press Play -> the platform opens -> it runs; 3: it runs at
once; let me switch between the two".

Play heads a game's page (Primary, before Edit...) and sits on each library
card's corner - over the card, not inside it, so the card stays one button -
and in the list's first column. Settings > Games > Play button (ui.play_mode,
App-owned, the Agent never reads it):

- Through the store (default): the store that installed the game is the one
  whose own records name the folder its executable is in - the records the
  import reads (IStoreLibrarySource), deepest folder first, then the entry's
  own store id (StoreRecords). The row's platform is not trusted: detection
  rewrites it (an itch build shipping steam_api reads as Steam) while
  store_id stays the importer's, and a Steam link built from an itch id would
  start another game. The hand-off is each store's own form (StoreLaunches),
  measured read-only on the owner's PC:
  - Steam: steam://rungameid/<appid> (the link of Steam's 20 game shortcuts);
  - Epic: com.epicgames.launcher://apps/<ns>%3A<item>%3A<app>?action=launch&silent=true
    (the launcher's shortcut form; UNMEASURED - no Epic shortcut on the PC),
    or the AppName alone where the manifest names no catalog
    (EpicLibrarySource now reads CatalogNamespace/CatalogItemId into
    StoreGame.LaunchKey);
  - GOG: GalaxyClient.exe /command=runGame /gameId=<id> /path="<folder>"
    (GALAXY's own game shortcut), GALAXY's path from GOG's registry
    (GogGalaxyLocator);
  - itch: itch://install?game_id=<id>&launch (the itch app 26.22.0, read
    from its bundle, asks which copy to launch).
  Every id is checked against its store's shape before the shell gets it.
  No store, GOG without GALAXY, or the App itself running as administrator
  (a store app it started would be elevated, and so would the game): the
  agent starts it instead, and the notice says why.
- Start directly: the App sends LaunchGame (the pipe command existed since P3
  PR-1b with no caller): launch mode, recorded from the first frame, never
  elevated (UnelevatedProcess), hooked only where the gate allows, refused
  for a recording-off entry; agent unavailable / recording off / already
  running / failed each have their own notice, and a launch Windows refuses
  (740: the game requires administrator) ends as the existing notice.

GamePlayer (App) does both; IShellStarter is ShellStarter in the profile and
ViewerShellStarter in a viewer (D52), where every Play button is also off
(ActsOnThisPc). Strings en/vi/ja (ja marked review).

Privacy Policy 2.10 (the wording approved with the plan): section 4 names the
lists of installed games the Steam, GOG GALAXY, Epic Games and itch apps keep,
and where GOG GALAXY is installed, read at import and at Play - the import read
Epic's and itch's lists before without a word; section 2 says Play hands a
game to its store's app, which may connect to its store, while FrameLedger
connects to nothing. legal-drift-history says what 2.10 changed.

Docs: 02_SPEC FR-1.9 (and FR-3.2's caller), 04_CAPTURE and 07_IPC (LaunchGame
has a caller), 06_DATA_MODEL (ui.play_mode; capture.background stays
reserved), 08_UI section Games, the guide's screens and settings pages (and
its Vulkan layer row), LIMITATIONS (a Play section; Vulkan games through Play),
the accuracy block's Vulkan sentence in its three copies, the SettingsRegistry
note on capture.background, CHANGELOG.

Tests: StoreLaunchesTests (each store's form, ids of the wrong shape build
nothing, a GOG folder that cannot stand in quotes), StoreRecordsTests
(deepest folder, prefix trap, the entry's store id among equals, an itch
build that ships Steam's API), GamePlayerTests (every branch, the notices),
StoreLibrarySourcesTests (Epic's launch key, GOG GALAXY's locator against an
HKCU key), ViewerModeTests (the page's and the library's Play off in a
viewer; ShellStarter only in the profile).

Review before the merge, after the first CI run was green (the beta.19
lesson): a pipe that closes while LaunchGame is in flight fails it with an
IOException, ObjectDisposedException or IpcFramingException (PipeClient), and
none was caught - a command's unhandled exception is the App's crash dialog,
so pressing Play while the agent restarted for an update would have ended
there; each is now "the capture agent is not running". A store record whose
id builds no link read "GOG GALAXY is not installed" (PlayFallback.NoLink,
logged); the agent's UnknownGame reached a notice as the token
(PlayOutcome.NotInLibrary); two notices advised what their path could not do
(Play_RecordingOff_Fallback_Format; Play_AgentUnavailable_Format reworded,
en/vi/ja). SessionDeletion's same gap is left as a task of its own. Tests:
AConnectionThatGoesMidRequestIsTheAgentNotRunningNeverAnException,
EachNoticeIsTrueOnThePathItIsSaidOn.

Gate: ./build.ps1 ALL GATES PASSED on both commits (281 s, then 292 s);
Application 522, App 615. The owner's live rules files were pre-seeded
and restored byte for byte.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 21:10:11 +07:00
poli0981andClaude Opus 5.5 babd500ec3 perf(app): the documents scroll by Windows' lines and glide, and a page is rendered once - MarkdownView handles the wheel and renders ahead of layout (beta.21 PR-3) (#303)
The owner's request of 2026-10-13: scrolling the documents in the app is slow.
Measured first (rendering every embedded document in memory): layout costs
about 1 ms per wheel step, so drawing was not it. Two things were:

- WPF's ScrollViewer moves a FIXED 48 DIP per wheel message, whatever its
  delta (ScrollViewer._mouseWheelDelta; deltas of -1, -15, -120 and -360 each
  moved 48 on a FlowDocumentScrollViewer): about 2.4 lines of body text,
  Windows' "lines to scroll" ignored, a touchpad's small deltas each jumping
  the whole step - LICENSE took about 200 notches to the end.
- Each of MarkdownView's three properties rendered the whole document on its
  own: DocumentBrowser.ShowPage rendered the old text under the new path first,
  the Legal Gate's three bindings rendered three times, and nothing was kept.

Changed:

- MarkdownView handles PreviewMouseWheel itself: the delta in proportion, at
  Windows' lines per notch at a browser's line (100/3 DIP; three lines = 100,
  scaled by the zoom; -1 = a screen), eased there over about 120 ms through
  CompositionTarget.Rendering unless Windows' animations are off; a notch
  turned while easing adds to the target; something else moving the view, a
  new page or Unloaded ends the easing. At either end the wheel is left
  unhandled, so the update notes' dialog scrolls instead; Ctrl+wheel stays the
  zoom. The keyboard modifiers and the lines setting are injectable, as
  ChartWheel's are.
- One render per page: MarkdownView.Show sets the three properties and renders
  once, now (DocumentBrowser uses it); property changes post one render at
  DataBind priority, ahead of layout; Anchors and ScrollTo render what is
  pending first. A view keeps the last 16 documents it rendered (path, plain,
  text), so going back to a page costs its layout only.
- The table renderer's TableColumn Width = GridLength.Auto is gone: it is
  WPF's default.
- The ui log and --diag name WPF's render tier (0 = software rendering, where
  every scroll is drawn on the CPU).

Tests: MarkdownViewTests - the step's arithmetic; on a real view, one notch
moves 100 DIP and a delta of 15 an eighth of that, the end leaves the wheel to
the host, Ctrl leaves it to the zoom; easing adds notches to the target and a
new page stops it; Show renders once, a page shown before is not rendered
again, past 16 the oldest is; properties set one by one render once, after the
dispatcher runs. DiagReportTests: render_tier. Docs: 08_UI (rendered
documents), 16_WPFUI_SYNTAX (the 48 DIP trap), CHANGELOG.

Gate: ./build.ps1 ALL GATES PASSED (272 s); App tests 605; MarkdownViewTests
looped 5x green. The owner's live rules files were pre-seeded with the
repository's for the run and restored byte for byte after (a test run with
their older file in place raced two seeders on one replace -
AgentReadOnlyVerbsTests: "could not write the rules file").

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 20:22:59 +07:00
poli0981andClaude Opus 5.5 df113c0888 fix: the four itch "launchers" are malware - the docs say so and stop advising to run one (D57); the Supports card says what a scan found (beta.21 PR-2) (#302)
The owner's report of 2026-10-13 ("the RPG Maker path is wrong" for HELLO,
HELLO WORLD!) led to the files behind it. Read without running anything
(spike-notes section 20): the 213 MB .NET program HELLO, HELLO WORLD!, A
Doll's Locket - Remake, City of Bones and Traumerei Chapter 2 put in front of
their RPG Maker game is not a launcher. Beside each sits a byte-identical
3,060-byte registry file that sets AmsiEnable=0 (HKCU and HKLM) and adds
Microsoft Defender exclusions for .exe, .msi, powershell.exe, rundll32.exe,
msiexec.exe and regasm.exe, plus SpyNet off, and a 3,216-byte encrypted
".xml"; the program's metadata names VM and debugger checks, AES decryption,
an in-process PowerShell runspace and RunPayload/PayloadStep steps, and it
starts the RPG Maker runtime beside it - the decoy. SHA-256 of all four in
spike-notes section 20.

Owner decision D57 (asked, 2026-10-13): correct the documentation; the import
keeps taking a store's own pick when it is not a helper.

- docs/spike-notes.md: section 17's "front their runtime with a 213 MB .NET
  launcher" struck and corrected; new section 20 with what the files are.
- docs/05_DETECTION.md: the beta.19 note's rationale annotated, its "measured
  with the admin mode on (D34)" sentence struck; the RPG Maker paragraph's
  examples annotated.
- docs/HANDOFF.md: D28, D56 ("the locator now picks the same file" - not for
  HHW's import: itch's verdict names the program in front, which is not a
  helper) and owner-only item 15(a) (do not run Doll's Locket's launcher).
- CHANGELOG: a Security entry under [Unreleased]; the beta.19 entry's admin
  advice marked withdrawn.
- docs/LIST_GAME_TESTED.md: the HELLO, HELLO WORLD! row says its download is
  malware (approved with the plan, D35).
- LIMITATIONS.md: FrameLedger does not tell whether a game is safe to run.

The repository states only what the files are; nothing here was run,
decrypted or uploaded.

Also fixed, from the same screenshot: the game page's Supports card read "Not
scanned yet" for every game that ships none of the capability files, even
beside a Details card the sweep had read. It now says that until the sweep has
read the executable (ExeMachine set), then "None found" (new string
GameDetail_Supports_None, en/vi/ja - ja marked review). Test:
TheSupportsCardSaysNotScannedOnlyUntilTheSweepHasReadTheExecutable. 08_UI
says the same.

Gate: ./build.ps1 ALL GATES PASSED (301 s); App tests 600. The owner's live
rules files were copied aside and restored byte for byte.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 20:07:05 +07:00
poli0981andClaude Opus 5.5 1070cd303f fix(guard): an anti-cheat beside the executable is found before anything is injected - check 4 walks the executable's own folder too; rules 2026.10.4 (beta.21 PR-1) (#301)
The owner's report of 2026-10-13: no anti-cheat found in Wuthering Waves
(Steam 3513350). Measured read-only on the owner's disk and in the Agent's log
(spike-notes section 19):

- The install root holds a launcher, Client\ and Engine\; the entry is
  Client\Binaries\Win64\Client-Win64-Shipping.exe, and Tencent's ACE sits
  beside it in Client\Binaries\Win64\AntiCheatExpert\ (ACE-BASE.sys,
  ACE-CORE.sys, ACE-Base64.dll, ACE-Service64.exe, ACE-Setup64.exe) - four
  levels under the root.
- Check 4 walked the install root only (ResolveInstallRoot, since
  2026-09-25), and WalkDir opens folders only while depth + 1 <
  kMaxPreScanDepth (3): a folder at the last level is named and never opened,
  SILENTLY - the walk reports kOk. The rules already named the folder; the
  walk never handed it to the matcher. The library pre-scan read the game
  clean three times, and the session of 2026-10-12 was hooked for 37 s until
  the 30 s re-scan met ACE-BASE.sys - a machine-wide finding, which turned
  nothing off.

Fixed:

- Check 4 walks the install root, then - when the executable lives below it -
  the executable's own folder (ScanGameFolders): same walk, same reach, its
  own 4096-entry budget, same matcher, same D33 tolerance and finding record.
  Sources::ImageDirectory names the executable's folder and the checks
  resolve the root from it (CheckStaticPreScan, CheckBlockedStoreId). Raising
  the reach was measured and rejected (spike-notes section 19): depth 4 still
  misses NTE's AntiCheatExpert\ (six levels down), depth 5 overruns 4096
  entries on three installed titles, which would refuse them. Across the
  owner's 83 Steam installs the second walk costs at most 103 entries and
  newly finds exactly those two folders.
- Rules 2026.10.4 (the bump is also what makes every game's pre-scan run
  again - the sweep re-scans only on a rules version or executable change):
  the five ACE-* files, ACE-CORE.sys (drivers), the ACE-BASE service, a
  modules row of its own for ACE-Base64.dll appended at the end (the
  Overlay's early-stop index), and Wuthering Waves' Steam id on the title
  list (owner decision D58). Notes within the schema's 300 characters.
- Comments that said the depth cap refuses (fl_prescan.h, guard_test.cpp)
  and docs that said so (19_SAFETY item 4, 05_DETECTION) are corrected in
  place; CLAUDE.md's D33 ".sys anywhere in the install tree" now says what
  check 4 reaches.

Tests: the fake lists a folder per directory and records every directory
check 4 walks; Wuthering Waves' layout refuses from the path and from the
pid; an executable at its root is walked once; an unfinished walk of the
executable's folder refuses; D33's tolerance and the .sys rule hold in the
second walk; and two REAL-filesystem cases - the real walk names Win64 from
the root and never opens it, the pre-scan over the real walk and store seam
finds AntiCheatExpert\ beside a nested executable and passes the same tree
without it; the real ImageDirectory names the executable's own folder.

Before/after on the owner's disk, read-only (FlStaticPreScanGame): the
installed beta.20 guard answers Allow for Wuthering Waves; this build answers
BlockedStoreId Anti-Cheat Expert. NTE, GF2 (NEP2.dll) and nine other Unreal
installs read as before.

Gate: ./build.ps1 ALL GATES PASSED (296 s); native 32/32. The owner's live
rules files were copied aside before the run and restored byte for byte.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 19:51:38 +07:00
dependabot[bot]andpoli0981 f8ecc19371 Bump the minor-and-patch group with 1 update (#291)
Bumps Meziantou.Analyzer from 3.0.294 to 3.0.299

---
updated-dependencies:
- dependency-name: Meziantou.Analyzer
  dependency-version: 3.0.299
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: minor-and-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: poli0981 <127664709+poli0981@users.noreply.github.com>
2026-10-12 13:17:25 +00:00
poli0981andClaude Opus 5.5 57a428846e release: 0.1.0-beta.20 - the CHANGELOG section, release lines, HANDOFF's beta.20 section and owner-only item 16 (beta.20 PR-2) (#300)
VERSION stays 0.1.0: the tag's numeric core. The owner (2026-10-12, the
same evening as beta.19): "tung bản beta20 rồi đóng phiên hẳn". The release
carries #299: a Ren'Py game's engine version from the engine's own
renpy/vc_version.py (rules 2026.10.3, Privacy Policy 2.9).

- CHANGELOG: [Unreleased] becomes [0.1.0-beta.20] - 2026-10-12, with its
  summary and "Updating from 0.1.0-beta.19" (Privacy 2.9 shown once; every
  game read again for its engine); tools/release-notes.ps1 -Version
  0.1.0-beta.20 extracts it (957 characters).
- The accuracy block's release line (legal/ACCURACY.md, embedded in README
  and the Disclaimer; accuracy-check green), README's release lines and
  count, LIMITATIONS' version.
- HANDOFF: beta.19's START HERE struck; the beta.20 section - the owner's
  two words, no new decision (the 2.9 wording was shown with #299), the
  traps (keyboxd's I/O error, the owner's live rules copied aside and back,
  looping a touched test class); owner-only item 16 (Bound Between Desks
  reads Ren'Py 8.5.0; Privacy 2.9 once; the ja string).

Gates run locally on this tree: accuracy-check, wiki-check (self-test and
27 pages), notice-check, test-artifacts, release-notes. The code is #299's,
whose tree passed ./build.ps1 (325 s) and CI.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-12 19:12:26 +07:00
poli0981andClaude Opus 5.5 4ae563c97e feat(detection): the engine version of Ren'Py games, read from the engine's own version file (beta.20 PR-1) (#299)
The owner asked (2026-10-12, after beta.19's Unity, Godot and RPG Maker
versions) for the version of Ren'Py games. The renpy rule had no version
extractor.

Ren'Py ships its engine as Python beside the game's launcher, and
renpy/vc_version.py names its release: version = '8.5.0.25111603', beside
branch, nightly, official and version_name. Measured read-only on the
owner's one Ren'Py install, Bound Between Desks (Steam): 109 bytes, the
same number the game's log.txt printed at its last start; the launcher has
no version resource (spike-notes §18).

- Rules 2026.10.3: renpy -> {"type": "renpy_build"}; the schema's enum of
  code-decided extractors gains it. Every entry is read again once.
- Domain: RenPyBuildFacts + RenPyVersion.Decide keep MAJOR.MINOR.PATCH,
  as Ren'Py names its releases (the fourth number is the build), source
  renpy_vc_version; VersionExtractorType.RenPyBuild; the evaluator leaves
  it to the detector, as the other code-decided types.
- Application: IGameFileProbe.ReadRenPyBuildAsync; StaticGameDetector
  makes the one second read for a Ren'Py match.
- Infrastructure: RenPyBuildReader reads the first 4 KiB of
  renpy/vc_version.py beside the executable, its version line only.
- App: the game page says "Ren'Py 8.5.0" and that it was read from the
  engine's version file (en/vi/ja, ja marked review); a Ren'Py row whose
  file names no version says "Not found in the game's files".
- Privacy Policy 2.9: §4's list of the version marks an engine keeps in
  its own files names Ren'Py's (legal-drift-history). The Legal Gate shows
  it once at the next update.
- The accuracy block (ACCURACY, README, DISCLAIMER), LIMITATIONS,
  05_DETECTION §Engine version - Ren'Py, 06_DATA_MODEL, 08_UI, CHANGELOG.
- HANDOFF: owner-only item 15 struck, passed 2026-10-12 (the owner's
  report, and the Agent's log for the removal: one check at 18:04:00 took
  three session-less entries); the rules-reseed trap gains the backup the
  session made of the owner's two rules files.

Through the shipped pipeline (StaticGameDetector over GameFileProbe, read
only): Bound Between Desks renpy 8.5.0 renpy_vc_version in 79 ms; Dialoop,
Plethora of Bullets 2, A Doll's Locket and City of Bones read as before.

Tests: RenPyVersionTests (the measured value; the build dropped; shapes
that are not a version), EngineBuildReadersTests (the measured file beside
the launcher; no file, a version_name only, past the bounded head),
StaticGameDetectorTests (one read for the matched engine),
GameDetailViewModelTests and FormatsTests (the page's words).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-12 18:41:13 +07:00
poli0981andClaude Opus 5.5 3e9028c139 release: 0.1.0-beta.19 - the CHANGELOG section, release lines, HANDOFF's beta.19 section and owner-only item 15 (beta.19 PR-5) (#296)
VERSION stays 0.1.0: the tag's numeric core. The owner (2026-10-12) asked for
four items; the train is #292 (the import never takes a helper; D56), #293
(Change executable... opens in the game's folder), #294 (Unity, Godot and RPG
Maker versions; rules 2026.10.2; Privacy Policy 2.8) and #295 (an uninstalled
game with no session leaves the library; D55), then the two follow-ups of
#295's review the owner asked for as separate PRs: #297 (one notice per check;
the Games page shows its newest read) and #298 (the presence probe's
unreadable-folder tests).

- CHANGELOG: [Unreleased] becomes [0.1.0-beta.19] - 2026-10-12, with its summary
  and "Updating from 0.1.0-beta.18" (Privacy 2.8 shown once; every game read
  again for its engine; the removal switch to turn off first if wanted; an
  entry made for a helper is re-pointed by hand); tools/release-notes.ps1
  -Version 0.1.0-beta.19 extracts it.
- The accuracy block's release line (legal/ACCURACY.md, embedded in README and
  the Disclaimer; accuracy-check green), README's release lines and count,
  LIMITATIONS' version.
- HANDOFF: beta.18's START HERE struck; the beta.19 section - D55, D56, the
  existing entry not rewritten, the owner's two train instructions; the traps
  (a store's own pick can be a helper, substring helpers never overrule a
  store, Godot's string past the scan and Unity's FileVersion string, Exists
  answering false for what it may not see, the locked signing key, the
  mechanical ones, what the pre-merge review of #295 found, looping a touched
  test class, the rules reseed); owner-only item 15.

Release rehearsal: release.yml dispatched on the branch (run 38226132220)
green - FL_BUILD_ID from the clean checkout, buildid-check ok over 4 native
binaries, a 2.35 MB delta from 0.1.0-beta.18 (28 of 460 files patched).
The final tree passed ./build.ps1 (ALL GATES PASSED in 284 s).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-12 17:13:55 +07:00
poli0981andClaude Opus 5.5 59e8ea4967 test(infrastructure): a game folder Windows will not list is never gone (beta.19 PR-7) (#298)
The presence probe (#295, D55) decides whether an entry's executable is
gone — FileGone, the one answer that lets the Agent remove the entry — or
merely unreadable. File.Exists and Directory.Exists say false for what
they may not look at, so the probe asks listings: the file in its folder's,
a folder that reads as missing in its parent's, and a listing it is refused
is Unknown. The review of #295 found those two branches untested.

ExecutablePresenceProbeTests now denies the current user rights on real
folders and gives them back in a finally (the owner can always change the
access list):

- ListDirectory denied on the game folder: the executable there and a
  Gone.exe there are both Unknown, and Present again once it lists;
- ListDirectory + ReadAttributes denied on the game folder and
  ListDirectory on the library folder it is in: Directory.Exists says false
  for the game folder, and the probe still says Unknown.

Each skips (Assert.SkipUnless) when the process can list what it is denied
— a backup privilege enabled — rather than asserting something else.

Measured red on this machine: with the folder listing replaced by
File.Exists the first test fails (Present for a folder that will not list);
with the parent-listing check dropped the second fails with FileGone, the
answer that would have removed an installed game. Both restored.

FR-1.8 (02_SPEC) names the case.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-12 17:03:21 +07:00
poli0981andClaude Opus 5.5 89aae82432 fix(app): one check's removals are said once, after one read of the library (beta.19 PR-6) (#297)
The Agent removes an uninstalled, session-less entry by itself since this
train (D55), and says each removal in its own GameRemoved event. One check
that removes several sends them milliseconds apart, and the Games page on
screen showed a snackbar and started a full library read for each. WPF UI
4.3.0's SnackbarService keeps one snackbar and shows every message at once
in it (Show(true) -> SnackbarPresenter.ImmediatelyDisplay, read from the
4.3.0 assembly), so only the last name stayed on screen.

The page now waits GamesViewModel.RemovalSettle (one second, over an
injected TimeProvider) after the first removal for the rest of the check,
reads the library once and says them in one notice: the game's name as
before, or the count, five names and how many more
(Games_Removed_Many_Format, Games_Removed_More_Format; en/vi/ja, ja marked
review). A removal heard during the read starts the next notice. The game
page's own handling of its entry is unchanged.

Tests: GamesViewModelTests — the single removal waits, then says the one
name; three removals in one check make one wait, one notice naming all
three and the remaining card; six name five and "1 more". Both over a
clock whose timers fire when the test says so.

Docs: 08_UI §Games; CHANGELOG's D55 entry.

fix(app): the Games page shows its newest read of the library (beta.19 PR-6)

Reads of the library overlap - a session that ends, an import, a removal -
and each awaits its executable checks off the UI thread. The read that
started first could finish last, its checks waiting on a slow drive, and
its older list was shown over the newer one: after the Agent removed a
game, an overlapping older read put the removed game's card back until the
next read.

Found by running GamesViewModelTests in a loop while the release train was
gated: one local run in about 165 failed. The pre-existing
ACardSaysWhetherItsExecutableIsThereAndWhy starts its own two reads (the
constructor's and an explicit one), and the first could be applied last.

GamesViewModel.LoadAsync now numbers each read (Interlocked) and shows it
only if no newer read began meanwhile. The executable check is injectable
(Func<string, bool>, default GameLibrary.ExecutableExists) so a test can
hold one read's check.

Tests:
- GamesViewModelTests.AnOlderReadThatFinishesLastIsNotShownOverANewerOne
  holds the first read in its check (bounded waits, so a broken test
  fails rather than hangs), lets a newer read list two games, then lets
  the first finish. It goes red without the guard ("found 1").
- ACardSaysWhetherItsExecutableIsThereAndWhy awaits the page's first read
  before adding the games it lists.

Measured: 10 runs of the class green and the whole App suite 599/599.

Docs: 08_UI §Games; CHANGELOG Fixed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-12 16:49:59 +07:00
poli0981andClaude Opus 5.5 c1a9e16cc4 feat(agent): a game that is no longer installed and has no session leaves the library by itself (beta.19 PR-4, D55) (#295)
The owner asked (2026-10-12) whether the Agent removes games whose executable
is gone, and if not, to remove them when no session was recorded. It did not:
D41 (2026-10-03) marked them Not installed and removed nothing. Owner decision
D55 amends it: removed after ten minutes, behind a Settings switch on by
default.

- UninstalledEntryPrune (Application/Watch), asked by DetectionSweep about an
  entry whose executable stayed unreadable after the relocator: the file gone
  at sweeps >= 10 minutes apart at the same path (counted in memory - a restart
  only delays it), the switch on (retention.remove_uninstalled_games, read at
  every sweep), not recording and no .partial waiting (the merge's busy test),
  and no anti-cheat block, exception grant or failed-trial mark (rule 2 and
  D38: an uninstall must not be how a block or "never again" disappears).
- ExecutablePresenceProbe tells what ExecutableIdentity.Read's null runs
  together: a drive not connected, nothing left of the path but the drive's
  root (a different disk under the same letter), a folder Windows will not list
  (asked of the parent's listing, since Exists answers false for both) - and
  FileGone, the only answer that removes: the file gone from a folder that is
  still there, or the game's folder gone from one that is.
- SqliteGamePrune: one DELETE that holds every stored condition in the same
  statement - same row, same path, in the library, NOT EXISTS a session, no
  block, no grant, no trial mark - so a session finalized meanwhile wins.
- IPC GameRemoved (additive): the Games page on screen reloads and says why in
  the snackbar; a game page showing that entry reloads into its not-found state.
- Settings > Data > Remove uninstalled games (off in a viewer like every
  Agent-read setting; its strip says the Agent reads it within 15 seconds).
  Strings en/vi/ja (ja marked review).
- Docs: 02_SPEC FR-1.8, 06_DATA_MODEL (writer ownership, settings registry),
  07_IPC, 08_UI, 19_SAFETY, the guide's data, screens and settings pages.

A self-review after the gate (before the merge): the presence probe asks the entry's own
drive (VolumeRoots.IsReady: the type first, so a dead share is never asked whether it is
ready) instead of listing every drive per entry; an entry the delete refused is asked again
after an hour (its sessions may since have been deleted) rather than never; 06_DATA_MODEL's
cross-reference names the 19_SAFETY section that exists. The vi and ja switch texts name the
pill as those languages show it (“Chưa cài”, “未インストール”).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-12 15:50:26 +07:00
poli0981andClaude Opus 5.5 a53ebee683 feat(detection): the engine version of Unity, Godot and RPG Maker games, read from their own files (beta.19 PR-3) (#294)
The owner's request of 2026-10-12. Rules 2026.10.1 gave: Unity's
pe_file_version stored UnityPlayer.dll's FileVersion string as it is
(2022.3.39.5118735 - the build number where the release letter belongs);
Godot's strings_regex scanned the executable's first 8 MiB while the
"Godot Engine v..." string sits 57-78 MB into both exports on the owner's
disk, so it never read one; both RPG Maker rules had version: null.

Measured read-only on 23 installs first (spike-notes section 17), then decided
in code as Unreal's is since beta.10:

- Rules 2026.10.2: unity_build, godot_build, rpgmaker_build - extractor types
  that take no parameter (the schema's enum beside unreal_build).
  StaticGameDetector makes one second read for the engine that matched;
  RuleEvaluator answers null for them as for unreal_build.
- Domain: UnityVersion (player ProductVersion, else the data file's header,
  else the player's numeric version), GodotVersion (a data pack's header,
  beside the executable or appended to it, else the executable's version
  while it is still Godot's; a zero patch dropped, as Godot names it),
  RpgMakerVersion (MZ/MV core-script header; the RGSS library Game.ini names
  -> XP/VX/VX Ace, its version or the one its name carries). New
  EngineVersionSource ids name the witness - and the maker.
- Infrastructure: UnityBuildReader, GodotBuildReader, RpgMakerBuildReader -
  version resources and at most a few kilobytes of any file; RPG Maker's files
  beside the executable or up to two folders above, as RpgMakerTitle looks.
- App: Formats.Engine(id, source) and EngineWithVersion - "RPG Maker MZ
  1.10.0", "RPG Maker VX Ace (RGSS 3.0.1)", "Unity 2022.3.39f1", "Godot 4.4.1"
  on the page, the subtitle and the card; the Engine version row says what
  each was read from, and "Not found in the game's files" once read. Strings
  en/vi/ja (ja marked review).
- Privacy Policy 2.8: section 4 names the version marks an engine keeps in its
  own files (the owner-approved wording), which also covers two reads that were
  never stated (UnityPlayer.dll's version, an RPG Maker title). The accuracy
  block, LIMITATIONS, 05_DETECTION, 06_DATA_MODEL, 08_UI and
  legal-drift-history say the same.

The shipped pipeline over the owner's installs (read-only): Unity 15 of 15,
Godot 2 of 2, RPG Maker 6 of 6, every one as measured; 24 ms to 4.1 s per
entry on the USB drive, nearly all of it the install's walk.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-12 15:40:00 +07:00
poli0981andClaude Opus 5.5 3f798ad364 feat(app): Change executable... opens in the game's own folder (beta.19 PR-2) (#293)
The owner's request of 2026-10-12: the file dialog of Change executable...
opened wherever the last file dialog was, and the pick is almost always
another file of the same install.

GameFolder.StartFolder derives the folder from the row's path - the only
place one is stored: the install folder a store boundary names (InstallRoot:
steamapps\common\X, GOG Galaxy\Games\X, Epic Games\X, GamesInstalled\X), above
an Unreal package's <Project>\Binaries\Win64 where no boundary is recognised,
else the executable's folder; the nearest folder still there when that one is
gone (a Not installed entry); null for a drive that is not connected, where
Windows opens its last folder. It asks the file system, so the page runs it off
the UI thread. IGamePicker.PickExecutable takes the folder; Add game passes
none and keeps Windows' own choice.

Tests: GameFolderTests (each layout, a gone folder, an absent drive),
GameDetailViewModelTests.ChangingTheExecutableOpensThePickInTheGamesOwnFolder.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-12 15:25:07 +07:00
poli0981andClaude Opus 5.5 38fdb6bd32 fix(import): a helper a store names is never the game, and an NW.js runtime outranks its launcher (beta.19 PR-1) (#292)
The owner's A Doll's Locket - Remake (itch 5085165, RPG Maker MZ) was imported as
Dolls Locket\notification_helper.exe. The pick was butler's verdict, taken as is:
butler stores a filtered verdict - the shallowest candidates, minus those whose
manifest asks for elevation - and does not rank what is left, so with the 213 MB
DollsLocket.exe launcher asking for administrator and the NW.js runtime a level
deeper in css\, the helper was the whole verdict (read from the owner's butler.db,
read-only).

- ItchLibrarySource skips a verdict candidate whose whole name is a runtime helper
  (ExecutableLocator.RuntimeHelperNames) or that sits in a Unity plugin folder; with
  nothing left the locator guesses and the review marks the row guessed. Whole
  names, not the locator's fragments: "node" is inside Nodebuster.
- ExecutableLocator ranks an executable beside nw.dll + package.json as an NW.js
  runtime (owner decision D56): below the Unity and Unreal layouts, above a name
  match. On the owner's disk it now picks css\Game.exe for Doll's Locket and
  swiftshader\Game.exe for HELLO, HELLO WORLD! (what D28 chose by hand); every other
  install it was run over picks what it picked before. notification_helper, nwjc
  and chromedriver join the helper fragments.
- LibraryImporter matches a store title to an entry by platform + store id as well
  as by path, so a corrected guess does not offer the same game a second time; the
  existing entry is re-pointed with Change executable... (nothing rewrites it).

HANDOFF owner-only item 14 (beta.18 on real hardware) is struck: passed 2026-10-08.

* fix(import): a store title is its entry by store id also when the entry's executable is inside the title's folder (beta.19 PR-1)

Found in a self-review after the stack's gate: the platform an import writes
is badged "detected", and the detection sweep refreshes it with what its own
rules find - an itch build that ships steam_api64.dll reads as Steam. Matching
the store id under the same platform only would then offer the same itch
title again beside its entry. The id now matches under the same platform, or
with the entry's executable inside the title's install folder; the same number
under another platform elsewhere is another store's numbering and stays a new
candidate (LibraryImporterTests.TheSameStoreIdInsideTheTitlesFolderIsTheSameTitleWhateverThePlatformReadsAs).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-12 15:10:47 +07:00
poli0981andClaude Opus 5.5 6ed7851d90 test(capturehost): the Vulkan launch case asks the harness before the host runs; the target-exit case holds 15 s (beta.18 PR-5) (#290)
The two CaptureHost end-to-end races that failed beta.18's CI (both re-run green), taken at the owner's request
(2026-10-07) before the tag.

LaunchModeOnAVulkanTargetAttachesToTheLayersRingAndInjectsNothing failed #288 (run 37627351438) with
"session: RefusedByGuard / verdict: ModuleScanFailed  a module list came back incomplete". A hosted runner has the
Vulkan loader and no device, so the harness exits 77 with a "[SKIP]" line; the test read that line, or the session's
LaunchTargetExited, off the HOST's output. The runner is elevated, so the host starts the harness through
CreateProcessWithTokenW (UnelevatedProcess), which hands the child no stdout: the line never reached the host's output,
and when the guard's scan hit the dying harness the test failed instead of skipping. It now runs the plain harness
itself first (`--vulkan --hold-presenting 1`, bounded at 60 s), skips on 77 with the harness's own line, and otherwise
runs in full with no skip after the host - once the harness has presented here, every failure is real.
Measured: on this machine (a device) both cases pass, the Vulkan one in full; with the probe's ICDs hidden
(VK_DRIVER_FILES / VK_ICD_FILENAMES at a missing file, a throwaway edit) it skips in 0.66 s:
"[SKIP] vkCreateInstance failed (no ICD, or no surface extensions)".

WhenTheTargetExitsTheHostStopsAndSaysWhy failed #286 (run 37619719203) with TargetNotRunning: the host resolves its
target once, as it starts, and a host slower than the harness's 6 s hold found it gone (recorded since 2026-09-21).
The host prints nothing until its session ends, so there is no "attached" to wait for; the hold is 15 s, a margin.

The class's remark said CI does not run it; CI has, since 2026-09-06 - corrected in place. Docs: 13_CI_CD (the flake
tally), HANDOFF (beta.18's trap, struck to fixed), CHANGELOG [0.1.0-beta.18] (this ships in that tag).

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-07 23:39:14 +07:00
poli0981andClaude Opus 5.5 dadcacf1a0 release: 0.1.0-beta.18 - the CHANGELOG section with how to update from beta.17, the accuracy block's release line, README's release lines, LIMITATIONS' version, HANDOFF's beta.18 section and owner-only item 14 (beta.18 PR-4) (#289)
* fix(release): the natives carry the clean checkout's build id - read before the date substitution, handed to CMake, read back out of the binaries (beta.18 PR-3)

The chip from beta.17, open since beta.4 (HANDOFF §0.1.0-beta.4, "Found and NOT fixed"): the owner's Dashboard read
"Overlay build v0.1.0-beta.17-dirty", and beta.16's the same. The release run's own log says why:
"RELEASE_DATE = 2026-10-07 in 3 file(s)" and, 22 s later, "FL_BUILD_ID = v0.1.0-beta.17-dirty". release.yml writes the
release date into the tracked legal/*.md before the gate, and CMake's configure reads `git describe --dirty` after it.
CI's own checkout is clean (main's last run: "FL_BUILD_ID = 15b4c6b0ecc1").

- release.yml: a step before the substitution reads describe from the clean checkout (12 digits, as CMake does),
  refuses one that is already dirty or longer than 31 characters, and exports FL_BUILD_ID. After the publish,
  tools/buildid-check.ps1 reads it back out of the four natives that compile it.
- src/native/FrameLedger.Shm/CMakeLists.txt: the environment's FL_BUILD_ID is taken as given, after a check for the
  characters a C string literal carries without escaping; otherwise describe as before. Its comment said a released
  build was exact - "CI configures and builds once from a clean checkout" - corrected in place.
- tools/buildid-check.ps1 (new): looks for the id as the C string it is compiled as (characters + NUL) in each
  binary's bytes; nothing is loaded - loading the Overlay would run its DllMain. -SelfTest, eight cases, both
  directions, runs in the gate (build.ps1 'buildid-check').

Measured here: ./build.ps1 native with FL_BUILD_ID=b18-envtest.1+x_y printed "FL_BUILD_ID = b18-envtest.1+x_y", and
buildid-check over the four built DLLs: "ok - 4 native binaries carry 'b18-envtest.1+x_y'"; with FL_BUILD_ID='bad "id"'
the configure stopped ("holds a character no build id has"). On this branch's own describe (dirty, "+"), the tool
refused the id itself and found it in all four binaries.

Docs: 12_BUILD (§Release-time token substitution; gate 14c), 13_CI_CD (§release.yml), HANDOFF (§0.1.0-beta.4's bullet
struck, dated), CLAUDE.md (tools), wiki Releasing, CHANGELOG [Unreleased].

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* release: 0.1.0-beta.18 - the CHANGELOG section with how to update from beta.17, the accuracy block's release line, README's release lines, LIMITATIONS' version, HANDOFF's beta.18 section and owner-only item 14 (beta.18 PR-4)

VERSION stays 0.1.0: the tag's numeric core. The owner (2026-10-07) asked for beta.18 - the two chips beta.17 left and
the page text that blends into the dark window; the train follows beta.17's: merge on green CI, then the signed tag
v0.1.0-beta.18 on the merge commit. wiki.yml publishes the wiki after the Release run succeeds.

- CHANGELOG: [Unreleased] becomes [0.1.0-beta.18] - 2026-10-07, with its summary and "Updating from 0.1.0-beta.17";
  tools/release-notes.ps1 -Version 0.1.0-beta.18 extracts it (3948 characters).
- The accuracy block's release line (legal/ACCURACY.md, embedded in README and the Disclaimer; accuracy-check green),
  README's release lines and count, LIMITATIONS' version.
- HANDOFF: beta.17's START HERE struck; the beta.18 section - no new decisions; the traps (a page in the NavigationView
  inherits nothing; the accent is not in the theme dictionary; the gate's own refusals look like findings on the wire;
  Safety_Consent_* strings are versioned with the disclosure; a release's natives were -dirty by its own hand; the
  CaptureHost e2e flake met again); owner-only item 14.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* docs(handoff): the beta.18 traps name the Vulkan launch e2e race that failed #288's CI

On an elevated runner the harness starts through CreateProcessWithTokenW, its "[SKIP]" line never reaches the host's
output, and a guard scan that hits the exiting harness (ModuleScanFailed) fails the test instead of skipping it.
Re-run; the deterministic fix is a task.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-07 21:06:45 +07:00
poli0981andClaude Opus 5.5 1d0e8407bd fix(release): the natives carry the clean checkout's build id - read before the date substitution, handed to CMake, read back out of the binaries (beta.18 PR-3) (#288)
The chip from beta.17, open since beta.4 (HANDOFF §0.1.0-beta.4, "Found and NOT fixed"): the owner's Dashboard read
"Overlay build v0.1.0-beta.17-dirty", and beta.16's the same. The release run's own log says why:
"RELEASE_DATE = 2026-10-07 in 3 file(s)" and, 22 s later, "FL_BUILD_ID = v0.1.0-beta.17-dirty". release.yml writes the
release date into the tracked legal/*.md before the gate, and CMake's configure reads `git describe --dirty` after it.
CI's own checkout is clean (main's last run: "FL_BUILD_ID = 15b4c6b0ecc1").

- release.yml: a step before the substitution reads describe from the clean checkout (12 digits, as CMake does),
  refuses one that is already dirty or longer than 31 characters, and exports FL_BUILD_ID. After the publish,
  tools/buildid-check.ps1 reads it back out of the four natives that compile it.
- src/native/FrameLedger.Shm/CMakeLists.txt: the environment's FL_BUILD_ID is taken as given, after a check for the
  characters a C string literal carries without escaping; otherwise describe as before. Its comment said a released
  build was exact - "CI configures and builds once from a clean checkout" - corrected in place.
- tools/buildid-check.ps1 (new): looks for the id as the C string it is compiled as (characters + NUL) in each
  binary's bytes; nothing is loaded - loading the Overlay would run its DllMain. -SelfTest, eight cases, both
  directions, runs in the gate (build.ps1 'buildid-check').

Measured here: ./build.ps1 native with FL_BUILD_ID=b18-envtest.1+x_y printed "FL_BUILD_ID = b18-envtest.1+x_y", and
buildid-check over the four built DLLs: "ok - 4 native binaries carry 'b18-envtest.1+x_y'"; with FL_BUILD_ID='bad "id"'
the configure stopped ("holds a character no build id has"). On this branch's own describe (dirty, "+"), the tool
refused the id itself and found it in all four binaries.

Docs: 12_BUILD (§Release-time token substitution; gate 14c), 13_CI_CD (§release.yml), HANDOFF (§0.1.0-beta.4's bullet
struck, dated), CLAUDE.md (tools), wiki Releasing, CHANGELOG [Unreleased].

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-07 20:53:00 +07:00
poli0981andClaude Opus 5.5 a48e99b6c1 fix(app): every notice says what happened in words - the gate's own refusals, a familyless refusal, a re-scan that could not look, a stop mid-session (beta.18 PR-2) (#287)
The chip from beta.17 (found while writing the guide), measured on the Agent's own events. Three notices printed what
only the code knows:

- Disable all hooking: the gate labels its own refusals where a finding carries its family, so the notice read
  "kill switch was detected in this game (the global 'disable all hooking' switch is on (FR-2.4); ...). FrameLedger
  will not inject into it, and nothing overrides that." A game blocked before read "previously blocked was detected
  in this game (AntiCheatFile|NetEase Yidun|NEP2.dll)". The gate's refusals are said as the end now
  (Formats.EndReasonText: "All hooking is switched off in Settings, so nothing was measured."), never as a finding.
- A refusal no family names read "The anti-cheat guard did not hook this game: reason RefusedByGuard." The Agent sends
  the guard's reason for every refusal (RecordedSessionEvents.GuardReasonOf; beside a family only, until now), and the
  sentence is the guard's words ("... the game is 32-bit, and the hook runs in 64-bit games only."). An older agent's
  reads End_RefusedByGuard.
- A 30 s re-scan that could not look while the game ran read "Capture stopped: Access is denied. was detected while
  the game was running"; it reads Safety_Unhooked_Unnamed_Format ("... the game's process could not be opened ...").
- CaptureDegraded printed its reason raw and said the session went on: "The hook stopped (WriterSelfDisabled); the
  session continues without measuring." A stop ends the session (07_IPC). The notice is the end's sentence;
  Notice_Degraded_Unknown_Format names only a reason this build has no words for.

And the rest of the chip:
- Turning the kill switch on said "Applied. The capture agent reads it at the next session start."; a measured session
  stops at its next safety scan, within 30 s (CaptureOptions.ScanInterval), and Settings_KillSwitch_Applied_On says so.
- Turn off / the game page's switch / withdrawing an exception with no agent said "Nothing was enabled." - the enable
  path's words (Safety_Consent_AgentUnavailable, left as is: changing a Safety_Consent_* string's meaning would bump
  the consent disclosure). Agent_NotConnected_NothingChanged.
- The viewer (--data-dir, D52) left the user-mode exception option, the three Recording numbers and the update channel
  live; every setting the Agent reads is off there now, held by the registry (ViewerModeTests).
- 08_UI listed a "PawnIO missing" banner that was never built.

Tests, red on the unfixed code first (12 App, 1 Application):
- NoticesFromTheAgentTests builds each event as the Agent does - the gate's verdict (HookedCaptureGate, kill switch),
  the native facade's (AntiCheatVerdict.FromNative), RecordedSessionEvents.PublishReason, the wire's codec - walks
  every refusal and every stop, and refuses an enum's name, a requirement's id or "reason X" in any notice. The
  notices' tests had only raised events written by hand ("GuardBlocked", "HookFaulted"), which no Agent sends.
- RecordedSessionEventsTests.BothSafetyEventsCarryTheGuardsReasonWheneverItRefused; SettingsViewModelTests (the kill
  switch's two strips, Turn off); ViewerModeTests.EverySettingTheAgentReadsIsOffInAViewer and the channel's row;
  ReasonTextTests' familyless refusal now as the Agent sends it.

Strings: three new App keys and one Shared (Safety_Unhooked_Unnamed_Format, ja = the English until reviewed), one App
key renamed; en/vi/ja. Docs: 07_IPC (guardReason, CaptureDegraded), 08_UI (§Notifications policy, the viewer, the
kill switch's strip, PawnIO), HANDOFF (beta.17's list corrected in place), CHANGELOG [Unreleased].

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-07 20:12:26 +07:00
poli0981andClaude Opus 5.5 b42d94bf1d fix(app): page titles read in the dark theme - every page sets the text colour the navigation Frame does not pass (beta.18 PR-1) (#286)
The owner's screenshots of 0.1.0-beta.17 (2026-10-07, dark theme): every page's title and section headings - Dashboard,
Recent sessions, Games, Compare, Pick 2 to 5 sessions, Settings and its groups, Logs - near-black on the dark window.
beta.16's screenshot shows the same.

Cause: a page is shown in WPF UI's NavigationViewContentPresenter, which is a Frame, and Frame.Init sets
InheritanceBehavior.SkipToAppNow - the window's Foreground stops there. A TextBlock that sets no colour falls to the
default, which WPF UI 4.3.0's TextBlockMetadata overrides to Brushes.Black. Cards, grids and controls set their own in
their templates; the bare titles and headings did not (19 texts on six pages, 1.29:1). It came and went: a page on
screen during a theme switch did take the window's new colour, and each navigation makes a new page that does not.

- Pages/*.xaml: every Page root sets Foreground="{DynamicResource TextFillColorPrimaryBrush}".
- AccessibilityTests.EveryPageSetsItsOwnTextColour: every Page root in the App's XAML sets it. Red before: all six.
- PagesLoadTests.EveryTextIsReadableInBothThemes (Dark, Light): every surface hosted as the App hosts it - a page in
  the presenter, a window as itself, anything else in an unshown FluentWindow - and every text that shows >= 3:1 over
  the colour painted under it. Red before in Dark: the 19 titles and headings at 1.29:1; Light green.
- PagesLoadTests.Hosted puts a page in the presenter, so EveryTextFollowsAThemeSwitch checks the App's real host too.
  Until now it laid pages out straight in a window, whose colour they inherited - green over the black titles. Red
  before, both ways: a page made after the switch stayed black. It now pairs texts by their place in the tree and
  compares what shows (a switch re-applies the template of a DataGrid's collapsed scroll bar and select-all corner).
  An Appearance="Secondary" put back on one Settings text still turns it red, both ways.
- Visuals.UnderTheme switches as the App does: the accent resources derived for the theme from Windows' default accent,
  then the dictionary, and the application's own resources put back after. The accent is not in a theme dictionary, so
  a Light check measured the dark theme's link blue on the light window (1.9:1) - a colour the App never shows.
  ContrastTests uses it too; it passed systemAccentColor: true, which reads the machine's own accent palette.
- Docs: 16_WPFUI_SYNTAX (a theming bullet, a Gotchas entry), 08_UI §Contrast (the fifth hole), 14_TESTING (a page is
  measured in the Frame; a theme brings its accent), wiki App UI development, CHANGELOG [Unreleased].

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-07 19:50:14 +07:00
poli0981andClaude Opus 5.5 15b4c6b0ec release: 0.1.0-beta.17 - the CHANGELOG section with how to update from beta.16, the accuracy block's release line, README's release lines, LIMITATIONS' version, HANDOFF's beta.17 section with D53-D54 and owner-only item 13 (beta.17 PR-5) (#285)
VERSION stays 0.1.0: the tag's numeric core. The owner (2026-10-07) approved the train end to end: merge on green CI,
then the signed tag v0.1.0-beta.17 on the merge commit. wiki.yml publishes the wiki after the Release run succeeds.

- CHANGELOG: [Unreleased] becomes [0.1.0-beta.17] - 2026-10-07, with its summary and "Updating from 0.1.0-beta.16";
  tools/release-notes.ps1 -Version 0.1.0-beta.17 extracts it.
- The accuracy block's release line (legal/ACCURACY.md, embedded in README and the Disclaimer; accuracy-check green),
  README's release lines and count, LIMITATIONS' version.
- HANDOFF: beta.16's START HERE struck; the beta.17 section - D53 (the wiki's source is the repository, published by
  wiki.yml), D54 (the guide is the wiki's End-user half, twelve pages), the traps (ui:TextBlock Appearance pins a brush;
  a Loaded class handler is not a load hook; the wiki's branch and the read-only default token; gating a stack from the
  main checkout), the findings left as tasks; owner-only item 13.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-07 17:55:24 +07:00
poli0981andClaude Opus 5.5 2c967b3d63 docs(wiki): the developer half of the wiki, built from the repository and published at each release (beta.17 PR-4, D53) (#284)
* docs(guide): the user guide looks things up too - the screens, every setting, troubleshooting, a glossary (beta.17 PR-3, D54)

The owner (2026-10-07): "a complete wiki, concise and easy, split into End-user and Dev". Decided the same day (D54):
the End-user part IS the user guide, one source - shown in the App under Help > User guide and, from PR-4, on the
wiki. Four pages join it after the FAQ, each written from the code it describes (labels, defaults, ranges and messages
read in SettingsPage.xaml, SettingsRegistry, Strings.resx and the view models):

- guide/07-screens.md - the badge and banners, every menu item, Dashboard, Games, a game's page, the session summary,
  Compare, Logs, the tray icon, keyboard and mouse.
- guide/08-settings.md - every setting the Settings page shows, in its order: what it does, its default, and which
  ones the agent reads.
- guide/09-troubleshooting.md - what you see, what it means, what to do: the agent, a game recorded but not measured
  (each "Why:"), N/A figures, "How it ended", updates, the database, the viewer, reporting a problem.
- guide/10-glossary.md - the words the App shows, A to Z.

guide/README.md lists them in the App's order (EmbeddedDocuments.GuidePages). The first run's "Your library" step named
"File > Import library... on the Games page"; File is the main window's menu and the Games page has no import button -
fixed in en/vi/ja (vi names the menu as shown, "Tep").

Tests (GuideDocumentsTests), each shown to bite on a deliberately broken page:
- EveryLinkToASectionNamesAHeadingOfItsPage - every section link, within a page, to another guide page, Limitations or
  a document, against the anchors the App's renderer gives the target (it replaces the one-anchor check);
- TheContentsListThePagesInTheAppsOrder;
- TheSettingsPageOfTheGuideNamesEverySetting - every Settings_*_Label the Settings page binds, in English;
- TheScreensPageOfTheGuideNamesEveryPageAndMenuItem - every Nav_* and Menu_* of the main window.
MarkdownRendererTests counts the guide's twelve pages.

Docs: CLAUDE.md and 08_UI ("eight short English pages" struck, the tests named; the consent dialog's button is "Keep
hooking off", not "Keep it off"), CHANGELOG [Unreleased].

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* docs(wiki): the developer half of the wiki, built from the repository and published at each release (beta.17 PR-4, D53)

The owner (2026-10-07): "a complete wiki, concise and easy, split into End-user and Dev". Decided the same day (D53):
the wiki's source lives in the repository and the Wiki tab is a copy, published when a release is made; the End-user
half is the user guide (PR-3, D54). The Wiki tab existed with one placeholder page.

- wiki/: Home (two doors), _Sidebar, and eleven short developer pages - Developers (where to start, where status lives),
  Architecture (a mermaid diagram, the processes, the two tiers, a frame's way to the screen), Repository map, Build and
  test (the gates in one table), Contributor rules (the nine rules in plain words, what will never be built, every
  pull request), Capture pipeline, Metrics (and the display rules), Data and IPC, App UI development (the WPF UI traps,
  this train's two included), Releasing, Developer glossary. Each links to its full document and states no status.
- tools/wiki-build.ps1: names each page (a guide page after its first heading; guide/README.md is User-guide,
  LIMITATIONS.md Limitations), rewrites links between pages to page names and every other repository link to GitHub at
  -Ref, drops each page's first heading, writes _Footer.md naming the ref. Refuses a link to a missing file, folder or
  section, two sources for one page, a page nothing leads to, a sidebar out of the guide's order, a backticked path in a
  wiki/ page that names nothing, and a version written into a wiki/ page. -SelfTest: nine cases, both directions.
- build.ps1: the wiki-check gate after notice-check (self-test, then -Check).
- .github/workflows/wiki.yml: on workflow_run of Release (success, started by a pushed v* tag - a rehearsal never
  publishes) and by hand (ref, publish). Checks out head_sha, links at the tag, uploads the pages, and publishes with
  gh auth setup-git + a clone of <repo>.wiki.git + push HEAD:master, only when something changed. contents: write, since
  the repository's default token is read-only. Separate from release.yml so a wiki failure is never a red release and
  can be re-run.
- Docs: README (the wiki, both halves), docs/README.md (the wiki; "D1...D46" corrected), CONTRIBUTING (where
  documentation lives), CLAUDE.md (wiki/ and wiki-build), 12_BUILD (gate 13d), 13_CI_CD (wiki.yml, five repo-local
  workflows, the owner's wiki-editing setting), CHANGELOG [Unreleased].

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-07 10:18:43 +00:00
poli0981andClaude Opus 5.5 1722a4ef56 docs(guide): the user guide looks things up too - the screens, every setting, troubleshooting, a glossary (beta.17 PR-3, D54) (#283)
The owner (2026-10-07): "a complete wiki, concise and easy, split into End-user and Dev". Decided the same day (D54):
the End-user part IS the user guide, one source - shown in the App under Help > User guide and, from PR-4, on the
wiki. Four pages join it after the FAQ, each written from the code it describes (labels, defaults, ranges and messages
read in SettingsPage.xaml, SettingsRegistry, Strings.resx and the view models):

- guide/07-screens.md - the badge and banners, every menu item, Dashboard, Games, a game's page, the session summary,
  Compare, Logs, the tray icon, keyboard and mouse.
- guide/08-settings.md - every setting the Settings page shows, in its order: what it does, its default, and which
  ones the agent reads.
- guide/09-troubleshooting.md - what you see, what it means, what to do: the agent, a game recorded but not measured
  (each "Why:"), N/A figures, "How it ended", updates, the database, the viewer, reporting a problem.
- guide/10-glossary.md - the words the App shows, A to Z.

guide/README.md lists them in the App's order (EmbeddedDocuments.GuidePages). The first run's "Your library" step named
"File > Import library... on the Games page"; File is the main window's menu and the Games page has no import button -
fixed in en/vi/ja (vi names the menu as shown, "Tep").

Tests (GuideDocumentsTests), each shown to bite on a deliberately broken page:
- EveryLinkToASectionNamesAHeadingOfItsPage - every section link, within a page, to another guide page, Limitations or
  a document, against the anchors the App's renderer gives the target (it replaces the one-anchor check);
- TheContentsListThePagesInTheAppsOrder;
- TheSettingsPageOfTheGuideNamesEverySetting - every Settings_*_Label the Settings page binds, in English;
- TheScreensPageOfTheGuideNamesEveryPageAndMenuItem - every Nav_* and Menu_* of the main window.
MarkdownRendererTests counts the guide's twelve pages.

Docs: CLAUDE.md and 08_UI ("eight short English pages" struck, the tests named; the consent dialog's button is "Keep
hooking off", not "Keep it off"), CHANGELOG [Unreleased].

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-07 17:02:13 +07:00
poli0981andClaude Opus 5.5 b18d7dc80e fix(app): hide scroll bars reaches every scroller - a ScrollChanged class handler beside Loaded (beta.17 PR-2) (#282)
The owner's screenshot of 0.1.0-beta.16 (2026-10-07): with Settings > Window > Hide scroll bars on, the Dashboard still
drew its scroll bar while Settings did not.

Cause, read in dotnet/wpf: BroadcastEventHelper.OnBroadcastCallback raises Loaded only on elements whose
SubtreeHasLoadedChangeHandler is set, and FrameworkElement.ThisHasLoadedChangeEventHandler counts instance handlers,
style EventSetters, template triggers and FEF handlers - not EventManager class handlers. ScrollBarHiding (beta.14)
had one class handler on ScrollViewer.Loaded, plus a walk of the open windows when the toggle changes; the flag is
applied before the first window, so the walk never helped at start-up. WPF UI 4.3.0's ToggleSwitch, CheckBox and
ProgressRing templates carry a Loaded EventTrigger, so Settings' scroller loaded and was hidden; the Dashboard (cards,
text, borders) never loaded as far as the option knew.

- Services/ScrollBarHiding: a class handler on ScrollViewer.ScrollChangedEvent (handledEventsToo), calling the same
  idempotent Set. Every scroller raises it from its first layout, inside ContextLayoutManager.UpdateLayout, so the
  bar is gone before the first frame; the Loaded handler stays. Doc comment and App.xaml.cs comment corrected.
- ScrollBarHidingTests.AScrollerLaidOutWithNoLoadedEventIsHidden: red before (Auto).
- ScrollBarHidingTests.EverySurfaceShownWithTheOptionOnDrawsNoBar: every page navigated in WPF UI's presenter, the
  first run, About, the user guide, a session's summary and every dialog's content, each shown in a real window off
  the screen with the option on first. Red before: the Dashboard's ScrollViewer, Game detail's sessions DataGrid
  (horizontal), the first run's ListBox and MarkdownView, About's ScrollViewer, the user guide's ListBox and
  MarkdownView. Settings and Logs were already hidden (the control); the check requires Dashboard, Settings, Logs and
  the user guide to have something to scroll.
- ScrollBarHidingTests.WpfRaisesLoadedOnlyWhereASubtreeListensForIt: the harness against WPF - a scroller with its own
  Loaded class handler is not called holding a Border, and is holding a CheckBox.
- Docs: 08_UI §Settings (the false "reaches every scroller" struck and dated), 16_WPFUI_SYNTAX §Gotchas (a class
  handler on Loaded is not a load hook), 14_TESTING, CHANGELOG [Unreleased].

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-07 16:40:17 +07:00
poli0981andClaude Opus 5.5 23fa7a0fb4 fix(app): text follows a theme switch - SecondaryText/TertiaryText replace ui:TextBlock Appearance (beta.17 PR-1) (#281)
The owner's screenshots of 0.1.0-beta.16 (2026-10-07): after Dark -> Light, Settings' descriptions were light grey on
white; after the way back, dark grey on dark.

Cause, read in WPF UI at tag 4.3.0 (main is the same): TextBlock.OnAppearanceChanged stores
TryFindResource(TextFillColorSecondaryBrush|TertiaryBrush) in the internal AppearanceForeground, and TextBlockMetadata
coerces every TextBlock's Foreground to it. The brush is the one found when the element was made and is never looked
up again, so a text kept the theme it was created under. Pages are transient, so the page in view during a switch -
Settings, where the theme is chosen - showed it.

- Styles/FrameLedger.xaml: SecondaryText and TertiaryText (Foreground by DynamicResource), and the 129
  `ui:TextBlock Appearance=` in 20 files take them (107 Secondary, 22 Tertiary; only TextBlock start tags were
  edited, every ui:Button/ui:Badge Appearance kept).
- ContrastTests.NoTextBlockTakesItsColourFromAppearance: no Appearance on a TextBlock, the attached form, a style
  setter or the code form, in the App. Red before: 129 hits.
- PagesLoadTests.EveryTextFollowsAThemeSwitch (Dark and Light): every page, the first run, About, the user guide, a
  session's summary, every dialog's content, the safety InfoBar and the two custom controls, made under one theme in an
  unshown FluentWindow (only Application.Windows hear a dictionary change), switched, and compared text by text with
  the same surface made fresh. Red before: 146 stale texts each way, all TextFillColorSecondary/Tertiary.
- PagesLoadTests.WpfUisAppearanceStillKeepsTheThemeATextWasMadeUnder: the library's behaviour, kept visible; red the
  day upstream follows a switch.
- PagesLoadTests.Surfaces: one catalogue of every surface over loaded view models, for any check that wants them all.
- Docs: 16_WPFUI_SYNTAX (Text row, theming bullet, a Gotchas entry), 08_UI §Contrast (the fourth hole),
  14_TESTING (a theme switch needs a window), CHANGELOG [Unreleased].

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-07 09:20:59 +00:00
dependabot[bot]andpoli0981 6f74574e8f Bump Meziantou.Analyzer and Roslynator.Analyzers (#262)
Bumps Meziantou.Analyzer from 3.0.266 to 3.0.294
Bumps Roslynator.Analyzers from 5.0.0 to 5.0.1

---
updated-dependencies:
- dependency-name: Meziantou.Analyzer
  dependency-version: 3.0.294
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: minor-and-patch
- dependency-name: Roslynator.Analyzers
  dependency-version: 5.0.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: minor-and-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: poli0981 <127664709+poli0981@users.noreply.github.com>
2026-10-06 11:40:23 +00:00
poli0981andClaude Opus 5.5 cf4a1acc8e release: 0.1.0-beta.16 - the end-to-end suites consent to a run-unique harness copy (the beta.15 chip); beta.15 verified (#280)
* test(e2e): the suites whose host resolves its target by name consent to a run-unique copy of the harness (beta.16, the beta.15 chip)

#269's first CI run lost AgentEndToEndTests.AConsentedBoundedCaptureLandsAsOneHookedRowInTheScratchLedger: exit 6,
TargetAmbiguous - "hook-harness.exe: 1 process(es) with that name could not be read (pid 3684: Only part of a
ReadProcessMemory or WriteProcessMemory request was completed.)". build.ps1 runs the test projects as parallel processes;
another project's hook-harness.exe was still starting (its module list a partial copy), and TargetResolver must count an
unreadable process of the consented executable's NAME. The refusal is right; the suites sharing one name was not. The
[Collection("agent-harness")] only serialises classes inside Agent.Tests.

- AgentEndToEndTests, PartialRecoveryEndToEndTests and CaptureHostEndToEndTests consent to
  hook-harness-<their scratch directory>.exe, a copy of the staged harness beside their data, as PipeEndToEndTests
  already did: StageTarget copies it once per test and registers the directory with HarnessOverlayLogSweep, so its
  overlay logs leave with the run. TargetResolver, the guard and every product rule are unchanged.
- The self-constraint tests pin the copy to the staged hook-harness.exe byte for byte (and the staged one to the test
  binary's directory), so the suites still inject into nothing but our own harness.
- AnotherHookHarnessRunningBesideTheSuiteDoesNotMakeTheTargetAmbiguous runs a second harness beside the capture. Measured
  against the old shared name: "session: TargetAmbiguous", red; green now.
- Suites that attach by pid (ShmDrainIntegrationTests, the native fl_guard_test) were never exposed and keep the name.

Docs: 14_TESTING (test isolation), HANDOFF (the beta.15 trap marked fixed), CHANGELOG (development note).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* release: 0.1.0-beta.16 - the CHANGELOG section, the accuracy block's release line, README's release lines, LIMITATIONS' version, HANDOFF's section, and owner-only item 12 marked passed

VERSION stays 0.1.0: the tag's numeric core. The owner (2026-10-06), after beta.15's release: item 12 passed on real
hardware ("đã chạy và ok"), do the chip beta.15 left, release, and close the session.

Nothing in the app changed since beta.15, and the section says so; "Updating from 0.1.0-beta.15" is the ordinary path.
HANDOFF: beta.15's START HERE is struck; the beta.16 section records the chip, the beta.15 train's merges (#277 and #278
were opened from the pushed branches, so their squash titles are GitHub's defaults; the content is the gated stack's)
and three traps - a session restart that empties gpg-agent's cache before a tag, a strict linear main that makes every
stacked PR rebase and re-run CI, and a desktop app that wakes the session on a red PR but never on a green one. Item 12
is marked passed in the owner-only list; no item is added.

tools/release-notes.ps1 -Version 0.1.0-beta.16 extracts the section (860 characters); accuracy-check is green.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-06 07:13:29 +00:00
poli0981andClaude Opus 5.5 bfd5238360 release: 0.1.0-beta.15 - the CHANGELOG section with how to update from beta.14, the accuracy block's release line, README's release lines, LIMITATIONS' version, HANDOFF's train section with D51-D52 and owner-only item 12 (beta.15 PR-6) (#279)
VERSION stays 0.1.0: the tag's numeric core. The tag waits for the owner's confirmation (asked 2026-10-06).

The [Unreleased] entries of PR-1..PR-5 move under [0.1.0-beta.15] with a summary for the release body; "Updating from
0.1.0-beta.14" says what is different this time: nothing migrates and nothing is shown again, and beta.14's own update
step stops the Agent before Velopack applies - this is the first update where it runs.

HANDOFF: beta.14's START HERE is struck; the beta.15 section carries the request, D51 and D52 (asked before the plan) and
the traps of the train - launch mode's election that never ran because the tests hand-built the session's outcome, the
watcher that reports a process once, a snapshot pid that names whoever holds it now, static choice lists, and the Agent
end-to-end test that lost to another test project's harness (left as a task). Owner-only item 12: the update from
beta.14, a quick restart, a change of language, a launcher, the viewer over a copy, the ja strings.

tools/release-notes.ps1 -Version 0.1.0-beta.15 extracts the section (3583 characters); accuracy-check and notice-check
are green.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-06 04:37:17 +00:00
poli0981andClaude Opus 5.5 690ce3acf8 Beta15/pr5 viewer (#278)
* fix(watch): a game started again while its last session finalizes is recorded when that session ends (beta.15 PR-3)

From the beta.14 audit (chip, folded into beta.15 by the owner). CaptureOrchestrator.Start turned a process away while a
session for its executable was still running ("one at a time"), and ProcessWatcher reports a pid once - so a game
started again during the previous session's finalize (driver profile up to 5 s, a crash reporter waited for up to
2.5 s, the transaction) never got a session. Verified on the code first: path (b), dropped, never picked up.

- The newest turned-away process per executable is remembered (Deferred: the event and the process's start time) and
  started from Reap when that session ends - if the session ended on its own (RunAndReportAsync records the result; a
  cancelled or faulted one starts nothing), the process is the same one (pid and start time) and it is then the
  executable's ONLY process. A helper of a multi-process game (NW.js, Electron) still has the game beside it, so it stays
  turned away, as before.
- The start happens outside the table's lock; the log says "recording it now".

Tests (CaptureOrchestratorTests, FakeRecorder.Pending holding finalize open): the restart is recorded when the session
ends (red before: one request), a helper of a game still running is not, a process that left meanwhile is not. The
existing one-at-a-time test keeps its behaviour.

Docs: 04_CAPTURE §Process watcher, HANDOFF trap, CHANGELOG.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(guard): the scan set follows a parent link only while creation times allow it (beta.15 PR-4, D51)

The guard's scan set (19_SAFETY item 1, 20_OPEN_QUESTIONS S16) is the injection target, its ancestors below the first
platform launcher and its descendants, walked over one Toolhelp snapshot that links a process to its parent by pid
alone. Windows reuses pids: once a game's launcher exited, the game named a pid that could belong to anything, and the
walk scanned whatever held it - a protected process refused the session as unreadable, a blocklisted one turned the
game's hooking off for good - and a cycle of reused pids sent the same processes round again.

Owner decision D51: a parent/child link is cut ONLY when it is proven wrong - both creation times read and the child
created before the process whose pid it names as its parent, which no real child can be. A cut ancestor link ends the
ancestor walk; a cut child is not walked, nor anything below it. An unread time keeps the link (fail closed, rule 2),
equal times keep it, and each pid is walked and sent once. The launcher boundary, the depth (16), the frontier (512, one
more refuses) and "a member that cannot be read refuses" are unchanged; no C ABI change.

- fl_guard_scanset.h/.cpp: WalkScanSet, a pure allocation-free walk over snapshot rows with the creation-time callback
  and the sink; ProvenNotItsChild; ProcessCreatedAt (PROCESS_QUERY_LIMITED_INFORMATION + GetProcessTimes, the module
  scan's own read-only right; reads nothing inside the process).
- fl_guard_sources.cpp: EnumerateScanSetImpl builds rows from the snapshot and calls the walk; the static rows lose the
  image names (the launcher flag is computed as they are read). The guard stays non-re-entrant (NativeAntiCheatGuard
  serialises every call).
- The new source is in all three CMake lists (FL_INJECTOR_SOURCES, FrameLedger.Injector, FrameLedger.Guard).
- guard_test.cpp [D51]: the plain tree; a reused parent pid; an "older child"; unread times on either end keep the
  link; equal times; cycles; the limits (missing target, frontier 511/512, depth, a full sink); and the real source
  keeps a child this process just started and reads real creation times.
- 19_SAFETY item 1 amended (with the one residual: a clock set backwards), 20_OPEN_QUESTIONS S16 note, CHANGELOG.

Gate: ./build.ps1 check - ALL GATES PASSED in 289s (32/32 native suites).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* feat(app): FrameLedger.exe --data-dir opens a copy of a data folder as a viewer - no Agent started or contacted, nothing on the PC changed (beta.15 PR-5, D52)

From the beta.14 audit (chip, folded into beta.15 by the owner): the App had no --data-dir, so a build of one's own could
only be looked at over the profile's ledger - and a newer build migrates it past what the released one can read. D6
deliberately keeps the Agent's --data-dir under --console, the pipe is one per user and the Agent behind it records into
the profile's ledger, so an App over another ledger that still talked to that Agent would send it the other ledger's game
ids: SetHookEnabled consenting for the wrong game (rule 1), DeleteSessions deleting the wrong game's sessions.

Owner decision D52: the App's --data-dir is a VIEWER over a copy. D6 is unchanged.

- Program.Main reads --data-dir (DataFolderArgument) after Velopack and before the single-instance key, the log or the
  ledger: a folder that exists makes a viewer (UiPaths.UseViewerFolder; the folder is its own single-instance key, so it
  runs beside the profile's App); the profile's own folder (case, separators, a relative path, a junction - resolved as
  the Agent's identity resolves links), a missing folder, a flag with no folder or two flags refuse with a message box,
  exit 2. UiPaths refuses the profile folder a second time.
- MachineFacingServices: everything that reaches past the ledger - the pipe client, the launcher, the connection's hosted
  service, the Run entry, the Agent's maintenance flags, Velopack and the startup update check - is registered in one
  place; a viewer gets ViewerAgentLink (never connected, nothing behind it), ViewerRunAtLogon, ViewerAgentTool and
  ViewerUpdateClient (not installed) and no hosted service at all.
- AgentConnectionState.Viewer: the pill reads "Viewer - no Agent"; a persistent InfoBar names the folder.
- ActsOnThisPc disables, in a viewer: hooking, the exception's grant/withdraw, re-enable, Delete all sessions (game page
  and Settings), the kill switch, the exceptions list and refresh, the admin mode, the logon task and the Vulkan layer
  buttons, Start with Windows, the automatic update check, Help > Check for updates, Tools > Update detection rules and
  the tray's Pause. MainWindowViewModel takes IAgentLink rather than the concrete connection.
- Strings (en/vi/ja; ja marked review): Agent_State_Viewer, Viewer_Banner_*, Viewer_ChangesThisPc_Off, DataDir_*.

Tests: DataFolderArgumentTests (the profile refused in six spellings and through a junction, missing, no value, twice, a
copy inside the profile allowed, UiPaths' second lock), ViewerModeTests (the viewer link sends nothing; the consent dialog
never opens; the viewer composition holds no pipe/launcher/hosted service/registry/Velopack while the profile's still
does; every machine-facing control in the XAML binds ActsOnThisPc), SettingsViewModelTests and GameDetailViewModelTests
(viewer vs profile on the same answers).

Docs: 08_UI §Shell, 12_BUILD §Debugging (how to copy a ledger safely with SQLite's backup), 01_ARCHITECTURE §Data
directory, 10_LOGGING, CONTRIBUTING, CLAUDE.md, HANDOFF (D6 pointer, the owner's-data trap), CHANGELOG.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-06 01:58:56 +00:00
poli0981andClaude Opus 5.5 f94c76bcb6 Beta15/pr4 guard (#277)
* fix(watch): a game started again while its last session finalizes is recorded when that session ends (beta.15 PR-3)

From the beta.14 audit (chip, folded into beta.15 by the owner). CaptureOrchestrator.Start turned a process away while a
session for its executable was still running ("one at a time"), and ProcessWatcher reports a pid once - so a game
started again during the previous session's finalize (driver profile up to 5 s, a crash reporter waited for up to
2.5 s, the transaction) never got a session. Verified on the code first: path (b), dropped, never picked up.

- The newest turned-away process per executable is remembered (Deferred: the event and the process's start time) and
  started from Reap when that session ends - if the session ended on its own (RunAndReportAsync records the result; a
  cancelled or faulted one starts nothing), the process is the same one (pid and start time) and it is then the
  executable's ONLY process. A helper of a multi-process game (NW.js, Electron) still has the game beside it, so it stays
  turned away, as before.
- The start happens outside the table's lock; the log says "recording it now".

Tests (CaptureOrchestratorTests, FakeRecorder.Pending holding finalize open): the restart is recorded when the session
ends (red before: one request), a helper of a game still running is not, a process that left meanwhile is not. The
existing one-at-a-time test keeps its behaviour.

Docs: 04_CAPTURE §Process watcher, HANDOFF trap, CHANGELOG.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(guard): the scan set follows a parent link only while creation times allow it (beta.15 PR-4, D51)

The guard's scan set (19_SAFETY item 1, 20_OPEN_QUESTIONS S16) is the injection target, its ancestors below the first
platform launcher and its descendants, walked over one Toolhelp snapshot that links a process to its parent by pid
alone. Windows reuses pids: once a game's launcher exited, the game named a pid that could belong to anything, and the
walk scanned whatever held it - a protected process refused the session as unreadable, a blocklisted one turned the
game's hooking off for good - and a cycle of reused pids sent the same processes round again.

Owner decision D51: a parent/child link is cut ONLY when it is proven wrong - both creation times read and the child
created before the process whose pid it names as its parent, which no real child can be. A cut ancestor link ends the
ancestor walk; a cut child is not walked, nor anything below it. An unread time keeps the link (fail closed, rule 2),
equal times keep it, and each pid is walked and sent once. The launcher boundary, the depth (16), the frontier (512, one
more refuses) and "a member that cannot be read refuses" are unchanged; no C ABI change.

- fl_guard_scanset.h/.cpp: WalkScanSet, a pure allocation-free walk over snapshot rows with the creation-time callback
  and the sink; ProvenNotItsChild; ProcessCreatedAt (PROCESS_QUERY_LIMITED_INFORMATION + GetProcessTimes, the module
  scan's own read-only right; reads nothing inside the process).
- fl_guard_sources.cpp: EnumerateScanSetImpl builds rows from the snapshot and calls the walk; the static rows lose the
  image names (the launcher flag is computed as they are read). The guard stays non-re-entrant (NativeAntiCheatGuard
  serialises every call).
- The new source is in all three CMake lists (FL_INJECTOR_SOURCES, FrameLedger.Injector, FrameLedger.Guard).
- guard_test.cpp [D51]: the plain tree; a reused parent pid; an "older child"; unread times on either end keep the
  link; equal times; cycles; the limits (missing target, frontier 511/512, depth, a full sink); and the real source
  keeps a child this process just started and reads real creation times.
- 19_SAFETY item 1 amended (with the one residual: a clock set backwards), 20_OPEN_QUESTIONS S16 note, CHANGELOG.

Gate: ./build.ps1 check - ALL GATES PASSED in 289s (32/32 native suites).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-06 01:31:21 +00:00
poli0981andClaude Opus 5.5 9c82288192 fix(watch): a game started again while its last session finalizes is recorded when that session ends (beta.15 PR-3) (#276)
From the beta.14 audit (chip, folded into beta.15 by the owner). CaptureOrchestrator.Start turned a process away while a
session for its executable was still running ("one at a time"), and ProcessWatcher reports a pid once - so a game
started again during the previous session's finalize (driver profile up to 5 s, a crash reporter waited for up to
2.5 s, the transaction) never got a session. Verified on the code first: path (b), dropped, never picked up.

- The newest turned-away process per executable is remembered (Deferred: the event and the process's start time) and
  started from Reap when that session ends - if the session ended on its own (RunAndReportAsync records the result; a
  cancelled or faulted one starts nothing), the process is the same one (pid and start time) and it is then the
  executable's ONLY process. A helper of a multi-process game (NW.js, Electron) still has the game beside it, so it stays
  turned away, as before.
- The start happens outside the table's lock; the log says "recording it now".

Tests (CaptureOrchestratorTests, FakeRecorder.Pending holding finalize open): the restart is recorded when the session
ends (red before: one request), a helper of a game still running is not, a process that left meanwhile is not. The
existing one-at-a-time test keeps its behaviour.

Docs: 04_CAPTURE §Process watcher, HANDOFF trap, CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-06 08:07:35 +07:00
poli0981andClaude Opus 5.5 1712dc503d fix(capture): launch mode's refused outcome carries the launcher's pid, so the descendant election finally runs (beta.15 PR-2) (#275)
From the beta.14 audit (chip, folded into beta.15 by the owner). CaptureSession built the outcome of launch mode's two
guard refusals (LaunchTargetExited, LaunchNoPresentationRuntime) without TargetPid, and
CaptureOrchestrator.ElectAfterLaunchAsync returned at `TargetPid == 0` - before its own "election:" log line - so the
election (#150, 2026-09-10) never ran. The orchestrator's tests built the outcome by hand with the pid, which is why
nothing saw it.

- The refused cue is `refused with { TargetPid = pid, ExitCode = alive.ExitCode }`; the refusal handling moved to
  CaptureSession.RefusedAsync (MA0051 - SessionAsync was at 60 lines).
- ElectAfterLaunchAsync logs an outcome without a launcher pid instead of returning silently.
- CaptureSessionLaunchTests.TheGuardsTwoLaunchRefusalsAreTheirOwnSessionEndReasons asserts the pid (red before: 0).

Reachable from `Agent --console launch` (the App sends no LaunchGame). A real launcher run is still owed (owner-only).
Docs: 04_CAPTURE (corrected in place), spike-notes §14.2, CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-06 07:42:32 +07:00
poli0981andClaude Opus 5.5 fd4b2f0d5d fix(app): every list of choices, the tray's menu and the Agent pill follow a change of language at once (beta.15 PR-1) (#274)
From the beta.14 audit (chip, owner: fold the five into beta.15). A change of language rebuilds the window and its
pages, so their own text followed; two kinds did not, until a restart:

- Lists of choices built once in a static and bound with x:Static: Settings' Themes and UpdateChannels (D47's
  "Automatic (Beta)" label too), Logs' Sources and Levels, Games' Sorts. They are instance properties now, bound through
  the view model - built per page, in the language the page opens in (GameDetail's TrendMetrics has worked that way
  since beta.8). Languages stays static: each language in its own words, the same in every language.
- Singletons that outlive the rebuilt window: the tray's menu and tooltip (TrayHost) and the Agent pill and update
  banner (MainWindowViewModel). Both implement ILanguageFollower; ShellHost.Rebuild calls every registered follower once
  the new window is up. The shell's registrations moved to App.AddShell (MA0051).

Tests: LanguageFollowingTests (no view model may keep a static list of labelled choices but the languages - red on the
five lists before), SettingsViewModelTests / GamesViewModelTests / GameDetailViewModelTests (a page opened in Vietnamese
lists Vietnamese choices; the trend selector pinned for the first time), TrayHostTests (the menu relabelled, now in the
strings-culture collection).

Docs: 09_I18N (runtime switching), CHANGELOG.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-06 07:26:19 +07:00
poli0981andClaude Opus 5.5 68f115d57d release: 0.1.0-beta.14 - CHANGELOG section with how to update from beta.13, release lines, HANDOFF train section and owner-only item 11 (beta.14 PR-9) (#272)
VERSION stays 0.1.0: the tag's numeric core. The tag waits for the owner's confirmation, and PR-5 / PR-7 for the owner's
approval of the Privacy Policy 2.7 wording.

"Updating from 0.1.0-beta.13" says the three things a beta.13 user must do differently: choose Beta first (beta.13's
default stable channel finds no pre-release), update with no game running (beta.13 still auto-applies at start), and that
schema 0019 cannot be opened by an earlier version.



docs(handoff): two more traps of the beta.14 train - the 31-character build id ten commits after a tag, and the hosted runner that was never acquired (beta.14 PR-9)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-06 05:12:48 +07:00
poli0981andClaude Opus 5.5 4130b7cbe4 feat(app): the new measurements as summary cards, a render scale chart, a clocks and fan chart, trend metrics and compare rows labelled (presented) (beta.14 PR-8, D49) (#271)
The App's half of D49 (PR-7 recorded the values). Every value is read from the stored row, never recomputed, and reads
N/A on a session recorded before beta.14.

Summary (SessionSummaryViewModel, the cards in AddFrameCards / AddPacingCards / AddMachineCards):
- Time below 60 FPS, with below 30 and "display under {refresh} Hz" beneath - the refresh share named for the display, as
  it is over the presents the display received - and Frame to frame; both carry (presented) where the lows do.
- VSync (share of frames, tearing allowed beneath), Ray tracing (share of frames, rays per pixel; only where measured),
  Game in focus (foreground over drain ticks), Capture quality (gaps, lost records, faults).
- The 1% Low card carries "displayed: N" where frames were generated - rule 6, beside the game's own, never instead.
- GPU clocks (core, memory; fan and memory temperature beneath), GPU held back (power, heat; NVIDIA only), Frames per watt.

Charts:
- RenderScaleChart over RenderScaleSeries: 100 x sqrt(render / output pixels) as steps, from the render_res blob where the
  resolution varied, a flat line at the row's extent where it did not, a sentence where never measured.
- SensorsChart: the memory temperature on the temperatures plot, in a new palette colour (Chart_SensorTertiary: no
  existing colour was 60 apart from all six beside it - ChartMathTests caught Chart_Histogram == Chart_Native), and a
  Clocks and fan plot - core and memory MHz, fan RPM on the right, the ticks a limit held the card back shaded
  (LimitRuns); collapsed when the session stored none of them.

Trend: nine metrics (time below 60 / refresh, frame to frame, render scale = 100 / upscale_ratio, VSync share, frames per
watt from hooked sessions; core clock, memory temperature, power-limit share from every session), with ms, MHz and FPS/W
axes. Compare: nine rows; the median, lows, stutter, time below 60 and frame to frame carry (presented) in the cell of a
present-only session, the best decided on the number, never the label. The Latency tab is shown only for a game with a
session that measured latency (nothing measures Reflex today). Formats.Share, Milliseconds, FramesPerJoule.

Tests: SessionSummaryViewModelTests (every new card with values, a pre-beta.14 row at N/A, the displayed low),
RenderScaleAndClocksTests (scale arithmetic, steps, flat line, limit runs, both charts drawn on the STA thread),
TrendSeriesBuilderTests, CompareViewModelTests (labels and bests), FormatsTests, GameDetailViewModelTests (Latency tab),
ChartMathTests (the clocks plot's colours too).

Docs: 08_UI (summary, trend, compare, latency), 03_METRICS (render scale over time), legal/ACCURACY.md (one bullet, mirrored
into README and DISCLAIMER by accuracy-check; Disclaimer version unchanged as in beta.13), guide/03-read-your-results,
LIMITATIONS, CHANGELOG. Strings en/vi, ja marked for review.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-06 04:58:54 +07:00
poli0981andClaude Opus 5.5 5db18c9da9 feat(metrics): time below 30/60/refresh, frame to frame, VSync/tearing, the card's clocks and limits, frames per watt - recorded, schema 0019 (beta.14 PR-7, D49) (#270)
Owner request 2026-10-05 ("propose metrics and charts"); D49: all four groups. This is the Agent's half; the App's
charts, cards, trend and compare come in PR-8. Every value is null where nothing measured it.

Pacing (Domain.Metrics.FramePacing): the share of the measured time below 30 FPS, below 60 FPS and below the monitor's
refresh rate, and the mean |ft[k] - ft[k-1]| over neighbouring intervals (FrameTimeSeries.FollowsBreak: a pair across a
gap or pause is not a pair). A frame counts as below X when it is itself 10 % longer than 1000/X, or when the median of
the nine around it (RollingMedian, the stutter rule's window and edges) is 2 % longer. Measured on a copy of the owner's
ledger: GIRLS' FRONTLINE 2 capped at 60 (296,380 frames, median 16.63 ms) read 50.0 % "below 60" by the plain rule and
9.6 % by this one (4.7 % of it below 30); a rolling mean does not help. Synthetic: steady 58 -> 93 %, 60.2 -> 0.7 %, a
100 ms hitch counts its own time and no neighbour's; a steady 59 reads 40 % (the stated cost). 30/60/frame-to-frame are
over the statistics' series (application frames when generated frames were counted - rule 6); the refresh share is over
the presents, at display_monitor_hz.

Sync (PresentArgsShares): the share of presents with a sync interval >= 1 and with DXGI_PRESENT_ALLOW_TEARING - both in
every Direct3D record since P1 and read by nothing; sync_interval_mode (0001) gets its first writer (on/off/mixed). OpenGL
and Vulkan carry no arguments: null.

The card (both tiers): core/memory clock, fan, memory temperature - in the samples before, stored nowhere - as series and
averages; power and thermal limit from NVAPI's perf-decrease reasons (GpuLimitReasons: 0x2, 0x1; 100 or 0 per tick, so
the mean is the share), NVIDIA only, null elsewhere.

Efficiency (EnergyEfficiency, SessionAggregator.ApplyEfficiency): application FPS / average GPU board power. Never the
displayed rate; the native rate when frame generation was counted over the session, the presented rate only under
no_fg_runtime; null for census_not_run, fg_runtime_loaded, none_withheld, a steady-state session, no power, Tier 2.

Schema 0019: thirteen REAL columns, ADD COLUMN only; SessionRow, SessionRowColumns (Parameters6/Read6). The sensor
statistics table shows the six new series in their own units (Formats.Frequency, Formats.Rpm; strings en/vi/ja review),
because it lists every catalogued series and printed anything unknown as memory.

Tests: FramePacingTests, PresentArgsSharesTests (+ efficiency), FrameTimeSeries FollowsBreak, PacingSyncAndEfficiency-
AggregationTests (series, sync, efficiency per qualifier, both tiers, the catalogue's names, the limit bits), the
migration (LedgerDatabaseTests.ScriptNineteen...), the column-for-column round trip, the table's units.

Docs: 03_METRICS (Pacing, Sync, the card, Efficiency, accuracy rows), 06_DATA_MODEL (schema, sensor_blobs, 0019),
LIMITATIONS, Privacy Policy 2.7 section 1 (the card's sensor series), legal-drift-history (what 2.7 changed), CHANGELOG.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-06 04:44:00 +07:00
poli0981andClaude Opus 5.5 d565760830 feat(build): every managed binary names FrameLedger and carries the native copyright line; versioninfo-check reads both kinds (beta.14 PR-6, D50) (#269)
Owner request 2026-10-05 ("Thêm Assembly metadata"); D50: company and product "FrameLedger", the copyright the
native FL_COPYRIGHT word for word.

Measured before the change, from the built binaries: FrameLedger.Agent.exe/.dll read Company and Product
"FrameLedger.Agent" and FileDescription "FrameLedger.Agent" (what Task Manager lists); each library its own assembly
name; every managed LegalCopyright was one space; the apphost's OriginalFilename is its assembly's (FrameLedger.dll).
tools/versioninfo-check.ps1 read the five native binaries and nothing else.

- Directory.Build.props: Company, Product, Authors, Copyright, Description (the native blocks' sentence, the Comments
  field), RepositoryUrl (stamped as AssemblyMetadata by the SDK); the FrameLedgerSourceRef metadata moved here from the
  App csproj, and release.yml passes the same ref to the Agent's publish.
- App: AssemblyTitle "FrameLedger" and a Description. Agent: AssemblyTitle "FrameLedger Agent" and a Description.
- versioninfo-check.ps1: the rules in one function over a block, a managed half (-ManagedDir, -ExpectedProductVersion -
  required, -ManagedOnly), one LegalCopyright across every binary read, the apphost carrying its assembly's block,
  Company as well as Product = FrameLedger, and -SelfTest: ten cases, nine RED, each for the reason it names (four
  mutations of the rules each turn the self-test red). build.ps1 runs the self-test and both halves (the managed half
  alone under -SkipNative); release.yml reads out/app with the tag's version.
- AssemblyIdentityTests (App, Agent): company, product, copyright = FL_COPYRIGHT parsed from CMakeLists.txt,
  description, RepositoryUrl = IssueLink.Repository, and the Win32 block Explorer shows. Red on the source before.

Docs: 12_BUILD (Identity table, the gate, the publish lines), 13_CI_CD, 19_SAFETY, FORKING (what a fork changes),
CHANGELOG.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-06 04:33:07 +07:00
poli0981andClaude Opus 5.5 1f7aebd0a4 fix(capture): a crash is a crash report of this game or the engine crash reporter it started (beta.14 PR-5) (#267)
Owner request 2026-10-05 (prevention; example SILENT HILL 2, UE 5.1), and a false crash found on the
owner's ledger: The Witcher 3, 2026-10-04, exit code 0, stored crashed by a WER 1001
RADAR_PRE_LEAK_64 (Windows' memory-leak detector) whose P1 named witcher3.exe.

E1 - CrashEventMatcher (pure): a 1000 from "Application Error" counts only when its AppName [0] equals
the executable's, its AppPath [10] (when given) is the executable's, and its ProcessId [8] (typed)
is the session's pid; a 1001 from "Windows Error Reporting" only when EventName [2] is a crash report
(APPCRASH, BEX, BEX64, CLR20r3, MoAppCrash, MoBEX) and P1 [5] equals the name. EventLogCrashSource
filters by provider in the XPath and asks the matcher; ICrashEventSource.FoundCrash(CrashQuery).
Checked once against the owner's real Application log: the Witcher 3 window no longer matches.

E2 - CrashReporterWitness, fed by the watcher's 1 s snapshots (CaptureOrchestrator.PollOnceAsync):
every on-crash reporter (CrashReporterCatalog: CrashReportClient, CrashReporter, CrashReport,
BsSndRpt/BsSndRpt64) with its parent by pid, image and start (a pid reused by a later process is not
the parent); always-on handlers (UnityCrashHandler64/32, crashpad_handler) never. SessionRecorder asks
at the end (two more polls when the game just left, at most 2.5 s); CrashReporterRule counts it when it
started >= 10 s after the game and the game left within 60 s: crashed, notes crash_reporter=<image>;
otherwise a note crash_reporter_seen=. Unreal's crash (exit code 3, no event) is crashed now. No
process is opened. Formats.ExitText names the reporter (string en/vi/ja).

E4 - ExecutableLocator: "bssndrpt" and "bugsplat" are helper fragments (KCD2 picked its game by rank).

Privacy Policy 2.7 (section 4): the Application log's crash reports about a tracked game, and the names
of programs a tracked game starts (the first was read since P2 and not stated).

Tests: CrashEventMatcherTests (the real RADAR record shape, a hang, a name inside another, pid and path
ties, typed and hex values), CrashReporterWitnessTests, CrashReporterRuleTests, SessionRecorderTests
(exit code 3 + reporter = crashed and named; a game that kept running = note only), ExitStatusMapper,
CaptureNotes, ReasonText (ExitText), ExecutableLocator, EventLogCrashSource.

Docs: 04_CAPTURE (crash classification corrected in place), 19_SAFETY (crash safety), 06_DATA_MODEL
(note slots), LIMITATIONS (When a game crashed), CHANGELOG.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-06 03:54:05 +07:00
poli0981andClaude Opus 5.5 101b6cf4d3 test(infra): the build-id mismatch check uses another id of the same length, not one longer than the field (beta.14) (#273)
ShmHandshakeValidatorTests.TheGuardReportsThisInstallsBuildId appended "x" to this install's build id and expected a
mismatch. The handshake's buildId holds 31 characters plus NUL, and the helper cuts at 31: once `git describe` is 31
characters long - ten commits after a tag, v0.1.0-beta.13-10-g15ec7c1c5fd4 in a local gate on 2026-10-06 - the cut id
equals the real one and the check read Ok. It passed for the first nine commits after every tag and failed from the
tenth, locally and on CI alike.

The mismatch is now another id of the same length (the last character changed), which can never be cut.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-06 02:59:31 +07:00
poli0981andClaude Opus 5.5 e8bb477415 test(app): the chart-wheel test says which keys are held instead of reading the machine's keyboard (beta.14) (#268)
A local ./build.ps1 check (PR-6) went red on ChartWheelTests.APlainWheelOverAChartScrollsThePageAndNotTheChart:
offset 0. Nothing in that gate touched the App. ChartWheel read Keyboard.Modifiers, which is the machine's real
keyboard from any thread - measured: a fresh background STA thread's GetKeyState reported the machine's NumLock - so a
Ctrl held anywhere while the test ran sent the plain wheel down the zoom path (page not scrolled). CI, with no person at
the keyboard, never saw it.

ChartWheel.CurrentModifiers (default Keyboard.Modifiers; the App never sets it) is what both handlers read; the test sets
it inside its own work item on the one STA thread and puts it back. The keys are a parameter now, so the Ctrl+wheel half
is driven end to end too (page stays, the surface ScottPlot zooms from is reached). A mutation that stops Ctrl+wheel at
the plot turns that case red.

Docs: 14_TESTING (a test that sends input says which keys are held), CHANGELOG.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-06 02:20:27 +07:00
poli0981andClaude Opus 5.5 5ac1555a8b fix(guard): a scan-set member still loading or already gone is read again once before the guard refuses, and a refused re-scan of a game that has exited ends as its exit (beta.14 PR-4, D48) (#266)
Owner decision D48 (2026-10-05), from the crash-reporter question: the 30 s re-scan reads every process
in the game's tree; a member still being created (an engine's crash reporter as its game dies, any
helper started a moment before - EnumProcessModulesEx ERROR_PARTIAL_COPY) or gone between the snapshot
and the open (OpenProcess ERROR_INVALID_PARAMETER) refused the session as unreadable, ending it as a
safety unhook - which also ends a user-mode exception's trial for good.

Native (FrameLedger.Guard): Collected::kRetry, produced by EnumerateModules only for those two errors;
ACCESS_DENIED (a protected process) stays kFailed and is never retried. CheckModules runs one pass,
notes a kRetry and goes on (a finding anywhere still refuses at once), then Pause(kScanRetryPauseMs =
250) and a second pass over a FRESH scan set, where kRetry refuses as kProcessUnreadable and a gone
target leaves no set (kProcessTreeUnavailable). Sources::Pause seam (Sleep in SystemSources).
FindPresentationRuntime treats kRetry as "not yet". fl_prescan's chain ended in an implicit pass for
any new Collected value - it refuses anything but kOk now. fl-baseline-probe names the new value.

Managed: ExitScanRelabel - when the re-scan refused for ProcessUnreadable / ModuleScanFailed /
ProcessTreeUnavailable (never a finding) and the game itself has exited at conclusion, the session is
TargetExited (exit code decides normal/crashed), CaptureOutcome.ExitScanReason, notes
`scan_at_exit=<reason>` (CaptureNotes.ScanAtExit). Findings, live games and other checks unchanged.

Tests: ctest fl_guard [D48] (re-read clean; still unreadable refuses; exited member drops out; gone
target refuses; ACCESS_DENIED never retried; a finding refuses at once; a finding the re-read sees
refuses; [live]: a suspended process and a pid with no process answer kRetry against the real source),
CaptureSessionTests (relabel for the three reasons; live game, finding, driver failure unchanged),
SessionRecorderTests (the note and the exit status), CaptureNotesTests.

Docs: 19_SAFETY (check 1 amended; During a session), 04_CAPTURE, 14_TESTING, CHANGELOG.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-06 02:02:46 +07:00
poli0981andClaude Opus 5.5 544a6c6202 fix(update): the channel follows the running copy, no update is applied at start behind FR-12, and the apply waits for a game still holding the Overlay (beta.14 PR-3, D47) (#265)
Owner request 2026-10-05: audit the update logic (no failure reported). Read against Velopack 1.2.0
and the owner's own updater log.

- update.channel defaulted to stable while every release is a GitHub pre-release: a copy left on its
  defaults never found one (the log: "No releases found" since the ledger reset). Owner decision D47:
  default `auto` (choices auto/stable/beta) - UpdateChannelPolicy: a pre-release copy asks for
  pre-releases, a release for releases; a stored stable/beta wins. Settings lists "Automatic (Beta)".
- VelopackApp applied a downloaded package at the next start (SetAutoApplyOnStartup is ON by default)
  inside Run(), before FR-12 and the Agent's stop - the log shows the Agent killed. Off now; the
  package is adopted at start (UpdateService.AdoptPending over UpdateManager.UpdatePendingRestart, no
  feed request) and goes Ready/Deferred like any other.
- OnBeforeUpdateFastCallback asks the Agent to stop before Velopack replaces the version (installer
  over an installed copy); Velopack's diagnostics go to the App's log (VelopackSerilogLogger).
- The apply waits while a game still has FrameLedger.Overlay.dll (or the Vulkan layer) loaded from the
  install folder (PayloadInUse: a mapped image refuses an exclusive write; no process opened), and
  while an Agent waits on the administrator prompt (ElevationMarker, beside the instance lock).
- Stop budget = IpcProtocol.AgentShutdownGrace (15 s, the Agent's host reads it too) + 5 s; was 10 s.
- The offer states the delta's size (UpdateInfo.DeltasToTarget) with the full package as fallback.
- IOException is Offline only from the network (HttpIOException, a socket error); the uninstaller
  removes the "Start FrameLedger with Windows" Run value.

Tests: UpdateChannelPolicyTests, UpdateServiceTests (pre-release copy asks for pre-releases; a stable
choice wins; a pending package is Ready without a feed request and applies; deferred under a session;
a held Overlay keeps it Ready, leaves the Agent alone and says why; the elevation marker holds the
folder; the stop budget outlasts the grace), VelopackHooksTests (private fields of the pinned 1.2.0
builder: _autoApply false, the logger, the before-update hook), UpdatePromptsTests, PayloadInUseTests,
UpdateFailureMapperTests, UninstallHookTests, SettingsViewModelTests, SettingsRegistryTests.
Strings en/vi/ja (ja marked review).

Docs: 11_UPDATER (the update audit, beta.14), 06_DATA_MODEL, 08_UI, 12_BUILD, LIMITATIONS,
guide/01-install, CHANGELOG.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-06 01:46:24 +07:00
poli0981andClaude Opus 5.5 c1984cab74 feat(app): Settings > Window > Hide scroll bars - no bar drawn anywhere, every scroller still scrolls (beta.14 PR-2) (#264)
Owner request 2026-10-05: an option to hide the scroll bars but still scroll.

ui.hide_scrollbars (bool, default 0, App only - AgentReads false). A bar's visibility is bound inside
its scroller's template, so no style reaches it: Services/ScrollBarHiding registers one class handler
on ScrollViewer's Loaded at start (beside DialogKeyboard) and, while on, sets an Auto or Visible axis to
Hidden - WPF's "no bar, still scrolls" for wheel, keyboard and touch - keeping the scroller's own value
on it; a Disabled axis is never touched (it lays its content out at the viewport's width). The Settings
toggle applies to the open windows at once (posted to the dispatcher from another thread), and off puts
every kept value back. Read at start beside ui.fps_decimals.

Strings en/vi/ja (ja marked review). Tests: ScrollBarHidingTests (a plain scroller, a disabled one, a
DataGrid's, a multi-line TextBox's and a FlowDocumentScrollViewer's: on hides every bar and the wheel
still scrolls; off restores each scroller's own setting; one that loads while on is hidden and one that
loads after off is left alone), SettingsViewModelTests.HidingScrollBars..., SettingsRegistryTests.
The class joins the strings-culture collection (process-wide state, runs alone).

Docs: 06_DATA_MODEL (settings row), 08_UI (Settings), 16_WPFUI_SYNTAX (gotcha), CHANGELOG.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-06 01:31:02 +07:00
poli0981andClaude Opus 5.5 32e3c5aa8e fix(app): the import list readable in the dark theme with whole tick boxes, and the mouse wheel scrolls every page, dialog and chart (beta.14 PR-1) (#263)
Owner report 2026-10-05 (screenshot of File > Import library in the dark theme; "the wheel does not
scroll, I have to drag the scroll bar").

Import list: the row style added in beta.11 was based on {x:Type DataGridRow}, which WPF UI 4.3.0 does
not define - it keys its row style DefaultDataGridRowStyle - so the lookup fell through to Aero2's row and
SystemColors.WindowBrush (white in every theme) under the dark theme's white text. Based on
DefaultDataGridRowStyle now. WPF UI's CheckBox (MinWidth 120, padding 11) drew a sliver of the box in the
40 px column: MinWidth 0, no padding. The dialog's own scrolling is off (ImportReviewPrompt.Create), so the
list takes the height the window leaves and is the one thing that scrolls; the intro and the count stay.
Compare's DataGridCheckBoxColumn (an Aero2 box) is a template column with the theme's CheckBox.

Wheel: NavigationViewContentPresenter makes ScrollViewer.CanContentScroll default to true for Page and wraps
such a page in a DynamicScrollViewer; the five pages' own root ScrollViewer then had infinite height,
nothing to scroll, and took every wheel. Every Page sets CanContentScroll="False"; page roots and the
session summary show their bar on Auto. The Logs tail is bounded again, so autoscroll follows the end.
Scrollers nested in dialogs are ui:PassiveScrollViewer. Charts/ChartWheel (through ChartTheme.Attach, all
nine plots): a plain wheel is re-raised on the plot's parent so ScottPlot never zooms; Ctrl+wheel zooms
and stops there.

Tests (each run red against the unfixed XAML first): ImportReviewRenderTests (every text cell >= 4.5:1
against the composited colour painted under it, Dark and Light; ticked boxes drawn whole, counted in a
RenderTargetBitmap; a 60-row list scrolls inside the list with the footer in view), AccessibilityTests
(no BasedOn a type the App's dictionaries hold no style for; no DataGridCheckBoxColumn; every Page opts out
of the DynamicScrollViewer; no plain ScrollViewer in a dialog), PagesLoadTests (pages navigated in the real
presenter are not wrapped and the wheel scrolls them; the Logs tail is bounded and follows the end; every
page reads CanContentScroll false after WPF UI's override), ChartWheelTests. Visuals/Wcag test helpers;
ContrastTests uses Wcag.

Docs: 08_UI (UX rules, Contrast's third hole), 16_WPFUI_SYNTAX (two corrections in place, five gotchas),
14_TESTING (what the App draws), guide/03 (Ctrl+wheel), CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-06 01:03:04 +07:00
poli0981andClaude Opus 5.5 0ffecb5851 release: 0.1.0-beta.13 - Velopack deltas in release.yml, the CHANGELOG section, the accuracy block's release line, README's release lines, LIMITATIONS' version, HANDOFF's train section and owner-only item 10 (#261)
* ci(release): publish a Velopack delta - download the previous release before vpk pack, keep only what this pack built, filter the feed to this build (beta.13)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* release: 0.1.0-beta.13 - the CHANGELOG section, the accuracy block's release line, README's release lines, LIMITATIONS' version, HANDOFF's train section with the one START HERE and owner-only item 10

VERSION stays 0.1.0: the tag's numeric core.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* test(capture): the four sessions that must end on a scan, a throw, the kill switch or an exit get a 30 s safety net instead of a 120 ms ceiling they raced on a loaded runner (beta.13)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-04 09:39:53 +07:00
poli0981andClaude Opus 5.5 e77a130fc9 fix: a refusal for a driver or service says "on this PC", the unhook notice promises nothing untrue, the GPU sensors follow the game's adapter, and the language-changing tests run alone (beta.13 PR-1) (#260)
The four follow-ups the beta.12 documentation audit left as chips; three of
them here, the fourth (Velopack deltas) rides the release PR.

S23-3. The guard's checks 2 and 2b are machine-wide: while Easy Anti-Cheat's
service runs for another title, every game refuses with BlockedService, and
the notice read "Easy Anti-Cheat was detected in this game". CaptureRefused
and SafetyUnhook gain an optional guardReason (additive; reason stays the
session's end reason), and BlockedService / BlockedDriver read
Safety_Refused_MachineWide_Format, Safety_Unhooked_MachineWide_Format and
Summary_Tier2_Why_MachineWide_Format (en/vi; ja as an English copy awaiting
the human safety review, like its siblings). Safety_Unhooked_Format loses
"will not inject into this game again until you enable it again", untrue both
ways since 2026-09-22. Formats.NamedRefusal is the one place a named refusal
is worded; SafetyNotices and HookingConsentResult both use it.

L1's adapter. SelectAdapter had no caller, and fixing that alone would have
changed little: the composite merges L3 > L2 > L1 per field, and L2 and L3
read their own first GPU. CaptureProgress carries the handshake's AdapterLuid;
the recorder hands it to the poller once (noted in the .partial);
CompositeTelemetrySource.SelectAdapter points L1 at it (IGpuAdapterSelector)
and tells the other layers its vendor (IGpuVendorFollower): L2 maps that
vendor's LHM node, L3 contributes nothing for a non-NVIDIA adapter. What stays
first-found is written in 18_GPU_VENDOR_APIS and LIMITATIONS.

Culture races. The strings-culture collection serialized its own members but
ran beside every other class; it now has a definition with
DisableParallelization, and StringsTests asserts xUnit bound it.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-04 09:11:38 +07:00
poli0981andClaude Opus 5.5 ff43d8cdb3 release: 0.1.0-beta.12 - the CHANGELOG section, the accuracy block's release line, README's release lines, LIMITATIONS' version, HANDOFF's train section with the one START HERE and owner-only item 9 (#259)
The [Unreleased] entries move under ## [0.1.0-beta.12] - 2026-10-04 with a
summary for a user and the update notes from beta.11 (schema 0018; the
Legal Gate shows EULA 1.5 / Disclaimer 2.10 / Privacy 2.6 once; the GPL is
no longer accepted). The date is the local one, as beta.9 and beta.10 did
when their runs fell on the previous UTC day.

The accuracy block's release line moves in its three copies (ACCURACY,
README, Disclaimer - the precedent of beta.6-8: no version bump for the
release line). README's release list and count, LIMITATIONS' version line.

HANDOFF: the beta.12 train section (D43-D46, the traps, the code gaps the
documentation audit found and left for their own PRs) carries the file's
one START HERE, and owner-only item 9 lists what only real hardware and the
owner can check: the game's memory beside Task Manager, the Legal Gate, the
guide and About, the ja strings, and LIST_GAME_TESTED's refresh (D35).

VERSION stays 0.1.0: the tag's numeric core.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-04 01:52:22 +07:00
poli0981andClaude Opus 5.5 63808a3821 docs: about a hundred statements the code contradicted, corrected in place with dated notes; a developer index; the Logs page reads the Agent's lines; a Settings switch that did nothing removed (D46, beta.12 PR-6) (#258)
Four audits read docs 01-20, HANDOFF, CLAUDE.md and FORKING against the
code. Every stale statement is struck and followed by a dated correction,
the repository's own convention (D46); history stays as it stood.

The largest classes: a rules feed that does not exist (05, 11, 13, 19, 02
FR-7.3, the rules file's own $comment, the rules workflow's header -
rules reach a user with a release); hooks that were never built (01's
diagram, 17's XeSS row and detour count, 03's fgEvaluations sources); the
in-game watchdog described as reading two numbers and sleeping (17; the
Disclaimer was fixed in PR-5); the unhook path and the vtable-swap advice
(17); L1 never pointed at the game's adapter (18); pre-release steps that
would bump VERSION (13, CHANGELOG header); the Legal Gate's row count (08);
the logging configuration of the two processes (10); a delta package never
published (11, 14); missing 0009/0013 migration entries and a duplicated
0002 paragraph (06); closed items still marked open, and S23-3 marked
deferred while the refusal UI shipped without it (20); the stale START HERE
(HANDOFF); the layout, tools and static-analysis lines (CLAUDE.md); three
names a fork must also change (FORKING). docs/README.md is a new index.

Code found by the same audits:
- LogTail.LevelOf read only the App's "[HH:mm:ss.fff LVL]" prefix, so the
  Logs page's Warning and Error filters showed no Agent line; the Agent
  writes Serilog's default template, a date first. Both are read, with a
  strict timestamp shape; the test that fed App-form lines into the fake
  Agent log now uses the real form.
- Settings' "Record games launched outside FrameLedger" wrote
  capture.background, which no Agent code read, and the App cannot start a
  game, so "off" could only mean recording nothing. The switch and its two
  strings (en/vi/ja) are removed; the key stays reserved, AgentReads false.
- Comments that said what is not so: the sparkline, the flyout,
  VulkanLayerRegistered "false by construction", two self-test counts, the
  sensor blobs' nominal Hz, SessionRowColumns' missing generator.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-04 01:29:49 +07:00
poli0981andClaude Opus 5.5 f1e518f962 feat: a user guide in the app, the GPL shown for information rather than accepted, EULA 1.5 / Disclaimer 2.10 / Privacy 2.6, and a README for players and for developers (D44, D45, beta.12 PR-5) (#257)
- guide/: eight short English pages for players (install and first start, record a game, read your results, anti-cheat
  and safety, your data, questions and answers, the terms in plain words), embedded in the App and shown under
  Help > User guide - the first Help item - with Limitations last; links between pages open in the window.
  Help > Documentation becomes Online documentation: the README at this build's source.
- The Legal Gate: LegalDocument.RequiresAcceptance; the GPL is listed as "your licence", with a line saying GPLv3
  section 9 needs no acceptance, and Accept writes three rows (an old gpl row stays, unread). The summary names the
  user-mode exception (it said there was no way to override the refusal) and the one network request (it said nothing
  is sent anywhere).
- EULA 1.5: an unmeasured session also records the game's memory use; the GPL needs no acceptance; where the
  third-party notices are in an installed copy; consumer rights no agreement can limit, and severability.
  Disclaimer 2.10: what it reads about a game from outside it; the maintainers' preface moves to
  docs/legal-drift-history.md. Privacy 2.6: the game's memory use (replacing a video-memory figure never read), a new
  section 3A on what an export or a bug report carries about you; the history notes move to the same file.
- README: a pointer to the guide up front, the safety table's D38 rule and the feature list's memory line corrected,
  Tier 2 names the game's memory, NOTICE beside the licence, and a section for developers and forks.
- Strings: 3 new keys, 6 changed, en/vi/ja (ja marked review).
- Tests: GuideDocumentsTests (every page listed and titled, every link leads somewhere, the section anchor exists), the
  guide in the renderer's nothing-dropped test (17 documents), the guide window, three acceptance rows and the old gpl
  row left alone, the documentation link.
- Docs: 02_SPEC FR-11, 06_DATA_MODEL, 08_UI, 09_I18N, CLAUDE.md layout, CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-04 00:51:27 +07:00
poli0981andClaude Opus 5.5 ca2275ce85 feat(app): documents rendered, not raw Markdown - the Legal Gate, Help > Limitations, the update notes and a tabbed About with the program's legal notices; links open this version's documents (owner request 4, D45, beta.12 PR-4) (#256)
- Markdown/MarkdownRenderer: Markdig 1.4.0 (BSD-2-Clause) into a themed WPF FlowDocument - headings with GitHub
  anchors, emphasis, strikethrough, code, quotes, nested and numbered lists, pipe tables, rules, links. HTML is off
  (shown as text), no image is fetched (its description stands in), an unknown node is shown as its source text. The
  GPL is shown as written, monospace.
- Controls/MarkdownView (FlowDocumentScrollViewer: selectable, Ctrl+C, zoom) and Markdown/MarkdownLinks: http, https and
  mailto through IUrlOpener, #section scrolls, a relative path resolves against the document's place in the repository
  and opens in the App when the window holds that page; file:, javascript:, drive and UNC paths are never followed.
- Services/RepositoryLinks: release.yml stamps -p:FrameLedgerSourceRef (the tag; a rehearsal's commit) as assembly
  metadata, so every link into the repository opens this version's documents instead of main's.
- The Legal Gate renders its documents (a link to another document opens it in the gate; View on GitHub goes through
  IUrlOpener); Help > Limitations is Windows/DocumentWindow; Help > About is Windows/AboutWindow - This app (the
  Appropriate Legal Notices: copyright, no warranty, the licence with the NOTICE terms, this version's source),
  Third-party licences (THIRD_PARTY_NOTICES and the package index, the licences folder), Legal documents (EULA, GPL,
  Disclaimer, Privacy, NOTICE, Trademarks). The update notes are rendered.
- Licences: tools/license-gather.ps1 takes a reviewed override for an expression it has no text for (sixteen self-test
  cases); tools/license-overrides/Markdig.txt; legal/licenses/nuget (78 packages); a THIRD_PARTY_NOTICES row, and its
  "About -> Third-party tab" item ticked. The table there had a note line between its rows, which ended it for Markdig;
  the note is below the table now.
- Strings: 22 new keys, 2 removed, en/vi/ja (ja marked review).
- Tests: MarkdownRendererTests (each construct; nothing dropped and no table left as source, for all nine embedded
  documents), MarkdownLinksTests, DocumentWindowsTests, the first-run opener, the legal documents' paths.
- Docs: 08_UI, 11_UPDATER, 16_WPFUI_SYNTAX (FlowDocument), 12_BUILD, 20_OPEN_QUESTIONS, CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-04 00:22:50 +07:00
poli0981andClaude Opus 5.5 cc847c588e feat(app): the game's own memory wherever a session is shown - two summary cards, a stored statistics table, Sessions columns, Trend and Compare metrics, two memory charts, the live card, the CSV line (D43, beta.12 PR-3) (#255)
- Formats.Memory: Task Manager's units (MB below 1 GB, GB to two decimals, 1 GB = 1024 MB, null is N/A, never 0).
- Services.GameMemoryText: the summary's VRAM (this game) and RAM (this game) cards - the median with the peak and the
  shared / commit peak beneath - the Sessions grid's median · peak cells and tooltips, the live line, the CSV
  `# game_memory:` header line; all from the stored columns and sensor_stats_json. Where Windows reported no private
  working set the working set is shown and says so; an unpinned hold that summed several processes says how many.
- Services.SensorStatsTable + the summary's "Statistics per series": every stored series' mean / median / minimum /
  peak / readings in its own unit; a session recorded before beta.12 gets one sentence instead.
- SensorsChart: two memory plots in GB - Video memory (this game's dedicated and shared, the whole graphics card's)
  and Memory (this game's private working set or labelled working set, the whole PC's). The line that read the
  never-produced per-present vram_proc blob is gone.
- Trend: MaxVramProcess (vram_proc_max_mb, never written, so never a point) becomes Median / Peak VRAM (game) and
  Median / Peak RAM (game) in GB, machine metrics over both tiers; Avg RAM in use is labelled as the whole PC's, in GB.
  Compare gains the four rows, ranking nothing.
- Live card: MemoryText from SessionProgress / SessionHeld (the old VramText read a field nothing produced).
- Strings: 41 new keys, 4 relabelled, 5 dead ones removed, en/vi/ja (ja marked review); 09_I18N glossary rows.
- Tests: GameMemoryTextTests (new), summary, trend, compare, chart, live card, dashboard, export; GamesViewModelTests
  joins the culture collection (it compared resource text across a parallel culture flip and failed once).
- Docs: 08_UI (corrected in place, new beta.12 paragraph), 03_METRICS export schema, CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-03 23:53:21 +07:00
poli0981andClaude Opus 5.5 2ce8251d31 feat: the game's own memory, measured from outside the game in every session - a C++ reader of the GPU Process Memory counters and GetProcessMemoryInfo, median and mean, schema 0018 (D43, beta.12 PR-2) (#254)
- FrameLedger.ProcessStats.dll (C++20, loaded by the Agent, never into a game): the game process's dedicated and shared
  GPU memory from the documented `GPU Process Memory` performance counters (no handle to the game, every instance of the
  pid summed) and its private working set / working set / commit from GetProcessMemoryInfo (EX2, falling back to EX)
  through PROCESS_QUERY_LIMITED_INFORMATION only (a sentinel refuses an EX2 answer whose private working set was not
  filled). Not D3DKMTQueryStatistics ("Reserved for system use").
  ctest fl_process_stats (GPU_INSTANCE on a hardware adapter, NO_GPU_INSTANCE on CI) and fl-probe-processstats.
- Measured first, decision table in spike-notes §16 written before the runs: +512.0 MiB for a 512 MiB buffer,
  private working set equal to Windows' own counter, 0.1 ms per read, nothing leaked over 600 reads; dedicated reads a
  constant 4.5 MiB above DXGI's local usage, so it is never compared with a budget.
- NativeProcessStats (third facade), GameMemoryReader: a pinned session reads through its held handle; an unpinned
  Tier-2 hold opens each process of the executable for the read, refuses a reused pid, sums. CaptureSession tells the
  observer which process (ICaptureObserver.Measuring), the recorder forwards it to the poller (ITelemetryPoller.Follow).
- TelemetrySample.Game; five sensor series; schema 0018 (game_vram_dedicated_*, game_ram_private_*, ..., sensor_stats_json);
  SeriesAggregates gains Median and Min; a wide .partial sensors chunk (type 8) with type 4 still read; SessionProgress
  and SessionHeld carry the game's memory live.
- notice-check accepts a contributor's own copyright line in the same form.
- Tests: the two classes that open a LibreHardwareMonitor Computer run one at a time - GenericCpu.Update threw a
  NullReferenceException in the local gate when they ran in parallel (the Agent's own read is already contained).
- Docs corrected in place: 03_METRICS, 18_GPU_VENDOR_APIS, 17_HOOK_ENGINE, 20_OPEN_QUESTIONS (§M7, §H10, new §M11),
  04_CAPTURE, 19_SAFETY, 06_DATA_MODEL, 07_IPC, 02_SPEC, 01_ARCHITECTURE, 12_BUILD, CLAUDE.md; the accuracy block and
  LIMITATIONS.md.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-03 23:21:45 +07:00
poli0981andClaude Opus 5.5 ff949afc6f feat(legal): NOTICE with the GPLv3 section 7 additional terms, the licence header in every source file, and the documents for people who build, contribute or redistribute (D45, beta.12 PR-1) (#253)
- NOTICE: copyright, GPL-3.0-only, and three additional terms of the kinds section 7 permits - (b) preserve the
  notices and the attribution in the program's legal notices, (c) mark a modified version as different and do not
  call it "FrameLedger" alone, (e) no trademark rights in the name. Shipped as licenses\NOTICE.txt; release.yml
  refuses a published tree without it.
- Section 7 wants additional terms named in the source files: every first-party .cs .cpp .h .inl .ps1 .xaml file
  (1,053; src/native/third_party excluded) opens with the SPDX line and a pointer to NOTICE. tools/notice-check.ps1
  is the gate (six self-test cases, both directions; -Fix writes a missing header) and tools/resx-gen.ps1 generates
  the string accessors with the header.
- The native VERSIONINFO LegalCopyright said GPL-3.0-or-later; it now names the real licence.
- CONTRIBUTING.md, FORKING.md, CODE_OF_CONDUCT.md (Contributor Covenant 2.1 by reference), legal/TRADEMARKS.md.
- 12_BUILD gate list, CLAUDE.md layout and conventions.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-03 22:16:00 +07:00
poli0981andClaude Opus 5.5 3fb27c8df4 test: the recorder's session harness no longer depends on how many drains a loaded runner fits into 150 ms (beta.12 PR-0) (#252)
main went red at a1b06d2 on SessionRecorderTests.ASessionThatRecordedNothingEndsTheExceptionOnlyDuringItsTrial(1,true):
expected Saved, got Discarded. The loop is bounded by MaxDuration on the wall clock, the session's length comes from the
SteppingClock (+5 s per drain), and a busy hosted runner fitted fewer than six drains into 150 ms - under the 30 s
minimum. The harness's minimum is now one clock step: SuperviseAsync drains at least twice (once in the loop, once
after it), so every hooked session is over it on any machine, and a held session whose clock never moves stays under
it, which is what ARefusedSessionIsATierTwoRow... asserts.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-03 22:01:48 +07:00
poli0981andClaude Opus 5.5 a1b06d28be release: 0.1.0-beta.11 - the CHANGELOG section, the accuracy block's release line, README's release lines, LIMITATIONS' version, HANDOFF's train section (#251)
* release: 0.1.0-beta.11 - the CHANGELOG section, the accuracy block's release line, README's release lines, LIMITATIONS' version, HANDOFF's train section

The eleventh pre-release (owner, 2026-10-03: "bump beta11"). The [Unreleased] entries of
#247-#250 move under ## [0.1.0-beta.11] - 2026-10-03 as written, after a summary for a user
and "Updating from 0.1.0-beta.10" (quit the App and the Agent first; schema 0017 adds one
column and an older version cannot open the database again; every game is re-checked once
under rules 2026.10.1; an exception made under beta.9 or beta.10 stays in force and finishes
its trial). The sub-sections' bullets are separated as beta.10's are.

The accuracy block's date and release line (legal/ACCURACY.md and its two verbatim copies,
README.md and legal/DISCLAIMER.md; accuracy-check), README's release list and count
("Eleven tagged pre-releases"), LIMITATIONS.md's version line, and HANDOFF's section for the
train: decisions D38-D42 and the CrackProof choice, the traps met on the way, and owner-only
item 8 (what only real hardware can check in beta.11). VERSION stays 0.1.0; the tag carries
the pre-release suffix.

release-notes.ps1 -Version 0.1.0-beta.11 extracts the section (7,728 characters).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* docs(safety): the trial paragraph says what a short or unhooked session is not judged by - its frames and its exit - and that a crash while hooked or a finding still ends the exception for good

19_SAFETY's D38 paragraph said a session too short to be stored, or never hooked, "proves nothing
either way and is not judged". UserModeExceptionLapsePolicy judges it by the D33 ends all the same:
a crash while hooked, however short, or a finding about the game at the start, ends the exception
for good during the trial; what such a session is not judged by is its frames and its exit (it
neither counts toward the two nor fails the trial that way). Found in a last read before the tag.

UserModeExceptionLapsePolicyTests pins the short crash: EndOf answers SessionCrashed for a hooked
session that crashed and was not stored, in the trial. ./build.ps1 check: ALL GATES PASSED.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-03 12:07:15 +07:00
poli0981andClaude Opus 5.5 c4e47868dd feat: delete all sessions of a game or of every game, charts across a game's sessions, and no Settings row without a control (D39, D40, beta.11) (#250)
* feat: delete all sessions of a game or of every game, charts across a game's sessions, and no Settings row without a control (D39, D40, beta.11)

Owner requests 2026-10-03; when asked, the owner chose both charts (an overview on the Sessions
tab and several metrics on the Trend) and both places for Delete all sessions (the game's page
and Settings > Data).

Delete all sessions (D40, FR-1.7):
- A pipe request, DeleteSessions { gameId? } -> DeleteSessionsAck { gameId?, games, sessions }.
  The rows are the Agent's (06_DATA_MODEL Writer ownership), so the Agent deletes them through
  ISessionRepository.DeleteSessionsAsync in one transaction - segments, frame and sensor series and
  annotations cascade - and answers Error SessionRunning while a session of that game (of any
  game, for all; CaptureOrchestrator.IsRecording / IsRecordingAny) is being recorded.
- App: SessionDeletion asks; the game page's Sessions tab and Settings > Data (a new section, one
  row) ask first through IConfirmations.DeleteSessionsAsync with the count; the strip says what
  was deleted or why nothing was (a recording, no agent, an older agent). The game page reloads
  and clears File > Export's selection when it pointed at a deleted session (ids are reused).

Charts across sessions (D39, FR-6.6):
- The Sessions tab opens with "Sessions at a glance": every hooked session's Presented FPS, or
  Native and Displayed where frame generation was measured (rule 6), and the 1% / 0.1% lows,
  oldest first, partial sessions hollow (TrendSeriesBuilder.Overview); a click near a session's
  points selects it in the grid (TrendChart.SessionClicked).
- The Trend keeps its selector and adds "Also draw": ticked metrics are drawn on the same chart,
  their unit (TrendSeriesBuilder.UnitOf: FPS, degC, %, W, MB, x) on the left when it is the
  selected metric's and on the right when it is a second one; a third unit cannot be ticked.
  TrendChart.Show takes TrendLines; one line keeps its name on the axis as before.

Settings, no row without a control (owner request): the hooked-games card shows only while a game
has hooking on; the Elevation row became the admin mode row's status line; the language note is
gone; the retention message names Settings > Recording.

Strings en/vi/ja (ja marked review); docs 02_SPEC (FR-1.7, FR-6.6, FR-10), 06_DATA_MODEL, 07_IPC,
08_UI; CHANGELOG. Tests: repository delete + cascade; the handler's delete and its malformed
payload; IsRecordingAny; SessionDeletion's outcomes; the game page asks, deletes through the
Agent and reloads; Settings asks with the total; the overview and the two-unit Trend; units.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(app): the overview draws Native and Displayed only for sessions that generated frames - on the others Native is the Presented rate, and a second line on the same points read as a second measurement

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(app): after Delete all sessions, a summary window open on a deleted session closes and File > Export lets go of it - from Settings too

The plan for D40 said the summary windows of deleted sessions close; they did not. A summary is
a window of its own, so after a delete it stayed open on a session that is gone, and a note
written from it would have gone to whichever session takes the id next (the table has no
AUTOINCREMENT). And File > Export's selection was let go of only by the game page: a delete from
Settings > Data left it naming a deleted session.

Both now happen in SessionDeletion, the App's one path to DeleteSessions, after the Agent
answers Deleted: the selection is cleared when its session is no longer in the ledger
(ISessionRepository.FindByIdAsync - a session of another game stays selected), and the summary
windows close the ones whose session is gone (ISessionWindows, which SessionSummaryOpener now
implements over the windows it opened; DI registers the one opener under both interfaces). A
failure there is logged and not the delete's. The game page's own clearing moved there.

Tests: AfterADeleteWhatNamedADeletedSessionLetsGoOfIt (the selection cleared, a kept session
still selected, the windows asked after each delete and not after a refused one); the game page
test builds its SessionDeletion with the selection. 08_UI and the CHANGELOG entry say it.
./build.ps1 check: ALL GATES PASSED (App 399).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(app): Delete all sessions closes only the summary windows still open after the ledger read - one the user closed meanwhile is not closed twice

SessionSummaryOpener.CloseDeletedAsync awaits a read per window; a window the user closed during it
has left the list (its Closed handler removes it), and WPF's Window.Close on a closed window can
throw. Each window is closed only while it is still in the list. ./build.ps1 check: ALL GATES PASSED.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(app): the Trend unticks a metric left in a third unit when the selected metric changes - every ticked box has its line

With two units ticked beside the selected metric (degC and a frame rate, say), changing the selected
metric to a third unit (watts) left three units ticked; TrendChart draws two, so one box stayed ticked
naming a line that was not there. BuildTrendLines now keeps the selected metric's unit and the first
ticked unit in the list and unticks the rest, before it sets which options can be ticked.

Test: TheOverviewAndTheTrendDrawSeveralMetricsTwoUnitsAtMost goes on to tick degC and the 1% low,
select watts, and finds two units drawn and one line per ticked box. 08_UI says it.
./build.ps1 check: ALL GATES PASSED.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-03 11:44:00 +07:00
poli0981andClaude Opus 5.5 c48b1348a7 feat(app): the Games library fills the window, switches to a list, counts and refreshes its games; import hides what is already in it (beta.11) (#249)
* feat(app): the Games library fills the window, switches to a list, counts and refreshes its games; import hides what is already in it (beta.11)

Owner requests 2026-10-03 (screenshots): the empty band right of the library; a manual refresh
for when games are installed or uninstalled; import's games already in the library, dimmed or
hidden. The owner chose, when asked: the refresh does all three (reload, new games from the
stores, mark uninstalled games), and the view switches between a filling grid and a list.

Library (Games page):
- Controls.UniformWrapPanel: as many columns as fit at 300 px or wider, every card an equal share
  of the width, each row as tall as its tallest card - the cards were 300 px in a WrapPanel, so a
  card's width went unused at the right. The pill row wraps instead of cutting its last pill.
- A list view (name, store, engine, status, sessions, played, last played; double-click or Enter
  opens a game); the button beside the sort shows the other view; ui.library_view remembers it.
- The title counts the games ("Games - 42").
- Refresh reads the library again, then ImportLibraryFlow.RunAsync(onlyNew: true) asks the stores
  for games installed since ("No new games" and no checklist when there are none), and every
  entry whose executable is not on disk carries a "Not installed" pill whose tooltip names the path
  and says when the drive itself is not connected (ExecutablePresenceProbe, off the UI thread on
  each listing, never stored; nothing is removed).
- The page reloads itself while on screen when a session ends (SessionCompleted) or an import adds
  games (LibraryChanges): navigating to the page already on screen does nothing in WPF UI 4.3.0, so
  an import from the menu showed only after leaving the page.

Import (FR-1.2): the games already in the library - at this path or under another drive letter -
are hidden by default; "Show the N games already in the library" brings them back dimmed; a row
that cannot be imported has its box disabled (the XAML said "cannot be ticked" while a tick was
taken and ignored).

Strings en/vi/ja; 08_UI, 06_DATA_MODEL (ui.library_view), CHANGELOG. Tests: GamesViewModelTests
(reload on import and session end, not after Detach; presence; column math), ImportLibraryFlowTests
(refresh offers only new games; hidden until asked), PagesLoadTests (the grid fills its width; the
list replaces it and is remembered; the checklist renders with existing rows shown). Rendered to
PNG in a hosted window to look at it (1270 px: three columns; 900 px: two; the list).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* refactor(app): the library's Not installed pill reads the file the game page's way - GameLibrary.ExecutableExists and its sentence - instead of a second probe and two more strings

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-03 10:48:22 +07:00
poli0981andClaude Opus 5.5 0e03d07dac feat: the user-mode anti-cheat exception needs no earlier sessions - its first two are a trial that ends it for good if one goes badly (D38, schema 0017, Disclaimer 2.9, EULA 1.4) (#248)
The owner deleted their ledger and found GIRLS' FRONTLINE 2 "Not eligible: 0 successful hooked
session(s), two are needed" - for good. D33's rule was a catch-22 for every game it could meet
again: since beta.8 the library sweep blocks a game the moment it is added, a blocked game is
never hooked without a grant (CaptureSession sends it to Tier 2 before the resolver), so it could
never earn the two sessions, and a reset ledger lost the ones it had. Asked with that (2026-10-03),
the owner chose D38: a grant needs no session; the first two hooked sessions under it are a trial;
any end during the trial ends the exception for good.

Agent / Application:
- UserModeExceptionRules: TrialSessions = 2 replaces RequiredSessions; IsEligible(block, verdict,
  trialFailed) - the guard's answer and the trial mark, no count; InTrial(successfulBefore).
- UserModeExceptionLapse.TrialFailed; UserModeExceptionLapsePolicy judges a session against the
  grant in force: during its trial every D33 end, or a stored hooked session with no frames or an
  abnormal exit, revokes it with trialFailed; a session too short to store, or never hooked, is
  not judged. The recorder passes the row it stored (SessionForTrial).
- ISessionRepository.CountSuccessfulUnderGrantAsync (family + started >= grant) replaces
  CountSuccessfulHookedAsync; ac_exception_sessions is now the trial's progress.
- AgentCommandHandler: TooFewSessions is gone; a game whose trial failed is refused before
  anything is scanned (Refused TrialFailed, signal = unix ms). AntiCheatExceptionCommands drops
  the session repository.
- The sweep answers a blocked entry whose executable cannot be read ("PreScanFailed", no bytes in
  the key) instead of leaving it "Checking..." for ever.

Infrastructure: schema 0017 games.ac_exception_trial_failed_at; the revoke sets it once
(COALESCE), eligibility is never written eligible over it and a grant is refused over it, both in
SQL; Change executable does not name it; a twin merge keeps the earlier mark.

App: the disclosure is ac-exception-dialog/2 (Why names no count, a Trial paragraph); the card
says "trial: N of 2", a failed trial "none can be made again", a scan that found nothing "was not
found" (not "could not finish"); an eligible game's Anti-cheat card no longer says "cannot be
turned on" beside Make exception...; the Settings list shows only games it can act on, without
the duplicated count, and Refresh only while a row is checking. Strings en/vi/ja (ja safety text
English until reviewed).

Docs and legal: CLAUDE.md rule 2 amendment, 19_SAFETY, FR-2.8, 06_DATA_MODEL (0017), 07_IPC,
08_UI, 20_OPEN_QUESTIONS, LIMITATIONS, SECURITY, the accuracy block (README, Disclaimer),
Disclaimer 2.9 (2A), EULA 1.4, CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-03 10:25:42 +07:00
poli0981andClaude Opus 5.5 5ab297b7b7 feat(rules): three CrackProof titles on the anti-cheat title list - Umamusume, Heaven Burns Red, Madoka Magica Magia Exedra by Steam id (rules 2026.10.1, beta.11) (#247)
The owner asked for "a few" games protected by HyperTech's CrackProof, by Steam id where needed.
Three are listed, each on the evidence of its own Steam store page, which states "Uses Kernel
Level Anti-Cheat" and names CrackProof (read 2026-10-03):

- 3224770 Umamusume: Pretty Derby (Cygames)
- 1973710 Heaven Burns Red (WRIGHT FLYER STUDIOS / Key; the Steam app is the Japanese release)
- 2987800 Madoka Magica Magia Exedra (Aniplex)

ANOTHER EDEN (1252600) is named by a community list (AreWeAntiCheatYet) but its store page says
nothing of the kind, so it is left out.

Why a title list and not a family: a Proton log of Umamusume shows the driver loaded from
C:\Windows\System32 under a numbered name (usrdrv017864.sys, ValveSoftware/Proton#8853) - outside
the game's folder, so the .sys rule cannot see it before the first run, and no driver token
could name it. Steam ids only: no executable name was verified, and a guessed one is a false
refusal waiting for an unrelated game. A title-list finding is never excepted by the user-mode
exception.

- rules/detection-rules.json: blockedStoreIds +3 (family "CrackProof"), rulesVersion 2026.10.1 -
  every library entry is pre-scanned again once; the floor regenerates from the file.
- guard_test: the three ids refuse as BlockedStoreId naming CrackProof, from the floor.
- 19_SAFETY check 3 (counts, the evidence, why no executables) and a seed-table row like VAC's;
  20_OPEN_QUESTIONS S14's row; CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-03 10:06:50 +07:00
poli0981andClaude Opus 5.5 ebea4a7eda release: 0.1.0-beta.10 - the CHANGELOG section, the accuracy block's release line, README's release lines (#246)
The tenth pre-release, the owner's four beta.10 items: the exact Unreal Engine version on a game's page (#241, schema
0015); the display mode - exclusive full-screen, borderless, windowed or minimised, as a share of each session, with the
window's and the monitor's size - on the summary, the game page, the Trend and Compare, both tiers (#242 shared-memory
layout 4, #243 schema 0016); running the capture agent as administrator, off by default, with a UAC prompt at every
agent start and games kept standard-user (#244, D34); and the documents - LIMITATIONS.md (Help > Limitations), the
owner-approved list of games tested, Privacy 2.5 and Disclaimer 2.8 (#245, D35, D36). Same unsigned installer; the
Legal Gate opens once for Privacy 2.5 and Disclaimer 2.8; the EULA is unchanged (1.3). A game running while the update
is installed must be restarted before it can be measured (layout 4).

HANDOFF's beta.10 section already names `[0.1.0-beta.10]` as its status.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-27 17:32:19 +00:00
poli0981andClaude Opus 5.5 372389c521 docs: what FrameLedger cannot do, the games it has been run with, and the legal text for beta.10 - LIMITATIONS.md in the App, the tested-games list, Privacy 2.5, Disclaimer 2.8 (D35, D36) (#245)
Item 4 of the owner's beta.10 request (update the docs at the end, add a list of real games tested) and owner decisions
D35 (the list from a COPY of the owner's ledger plus the repository's evidence, reviewed by the owner before commit)
and D36 (legal text where it would become false, and a user-facing LIMITATIONS.md for the whole software).

- LIMITATIONS.md (repository root): the limits of the whole software in the user's words - the games it will not
  measure, an unmeasured session, frame generation, upscaling and ray tracing, the display mode, the engine version,
  sensors, the admin mode, platform and tested hardware, data, installation - each linked to its details. Embedded in
  the App (LimitationsDocument) and shown under Help > Limitations with Open on GitHub; NOT one of FR-11's accepted
  documents. LimitationsDocumentTests: embedded as written, not in LegalDocuments.Keys, every repository link exists.
- docs/LIST_GAME_TESTED.md: 22 games measured hooked, the unmeasured sessions and why, six refused by the guard, and
  the Unreal versions read without running - from a copy of the ledger (read in the scratchpad with Python sqlite3,
  never a FrameLedger binary on the data folder) and spike-notes, CHANGELOG, HANDOFF and the run reports. Approved by
  the owner 2026-09-27, with Alan Wake 2's two 2026-09-04 captures added and UMIGARI kept on its run reports.
- Legal: Privacy Policy 2.5 (a game window's display facts, the Unreal build name, and - first said here - the
  executable's content and the processor/memory counters); Disclaimer 2.8 (section 5A, the admin mode and its risk; the
  limitations page and the list in section 0); the accuracy block dated 2026-09-27 with the display mode, the engine
  version and the admin mode (README and DISCLAIMER copies, accuracy-check green); SECURITY.md's admin-mode reports.
  EULA unchanged (1.3).
- Stale text corrected in place: 19_SAFETY's ETW Tier-2 offer, README's Agent row and elevation paragraph, 04_CAPTURE's
  port list, HANDOFF D11's pipe owner check, 17_HOOK_ENGINE's fault policy (compare-and-restore, not MH_ALL_HOOKS),
  HANDOFF's "Alan Wake 2 did not run on 2026-09-04", and the 18-vs-9 session count recorded rather than guessed.
- HANDOFF: the beta.10 train (D34-D37, what was measured, the traps), owner-only item 7 (beta.10 on real hardware) and
  item 6 done by the ledger's evidence (three GF2 sessions under the exception); CLAUDE.md's reading order names both
  new documents; 08_UI's Help menu; CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-27 17:02:56 +00:00
poli0981andClaude Opus 5.5 7ad1519a4c feat: run the capture agent as administrator - an option off by default, a disclosure, and a UAC prompt at every agent start; games stay standard-user (D34, beta.10) (#244)
* feat: run the capture agent as administrator - an option off by default, a disclosure, and a UAC prompt at every agent start; games stay standard-user (D34, beta.10)

The owner asked for a Settings option, off by default, to let the Agent run with administrator rights. Owner decision D34
(2026-09-27): Windows is asked at EVERY Agent start - by the App, or by the logon task's Agent - with no silent path, and
games started from an elevated Agent must not run elevated.

- Setting capture.run_elevated (registry, Agent-read), read BEFORE the Agent exists by Infrastructure.Startup's
  RunElevatedSetting: one row, PRAGMA query_only, no version gate (the first start after an update meets an older
  schema), anything but "1" is off.
- App: AgentLauncher asks through a UAC prompt owned by the main window (ShellHost.Handle) and starts the Agent with
  --serve --for-user <SID>; declined or failed, it starts the standard user's Agent with --elevation <outcome>; an
  elevated Agent that exits 11 (another account answered) makes it start standard-user Agents until the App restarts.
  With the option off and the App elevated, the Agent gets the desktop shell's token. The connection shows
  AgentConnectionState.Elevating while the prompt waits.
- Agent: --serve takes at most one of --for-user <SID> (refuses to run as another account: exit 11, before anything is
  claimed or written) or --elevation declined|other-account|failed. A plain --serve with the option on and no elevation
  (the logon task's) holds the folder's ElevationMarker, asks Windows once (taskbar prompt), and hands over to the
  elevated Agent once it has claimed the folder - or serves as before and says why. HelloAck.ElevationOutcome carries
  the answer; an elevated Agent logs its enabled privileges.
- Games: ProcessLauncher in an elevated Agent starts the game with the shell's token (UnelevatedProcess: GetShellWindow,
  the token duplicated, CreateProcessWithTokenW, the kill switch's explicit environment) and refuses with error 1400
  rather than start it elevated. LaunchGame is reachable by any process of the user; an elevated launch would be a
  silent elevation.
- Locks: the ledger's migration lock is a SharedMutex with a stated DACL (owner the user; user, Administrators, SYSTEM),
  so an elevated creator no longer locks the unelevated App out; the elevation marker keeps two prompts from racing.
- Privileges: nothing enables one. TokenPrivileges reads them; chokepoint-check forbids AdjustTokenPrivileges,
  RtlAdjustPrivilege, EnterDebugMode and SeDebugPrivilege under src/ (canary checked); PrivilegeFootprintTests asserts on
  the elevated CI runner that the resolver and LibreHardwareMonitor's CPU group enable none.
- Settings: "Run the agent as administrator" with the versioned disclosure (Shared Safety_AdminMode_*, agent-admin-dialog/1;
  ja = the English pending review, vi translated), then a restart over the pipe - never under a running session - and the
  elevation line says why a standard user's Agent is one. Safety_Refused_TargetUnreadable names the mode.
- Updater: the apply also waits for the data folder's instance lock to be let go; an Agent holding it without answering
  is never updated under.
- Tests: setting reader (no ledger, no table, "1"/"0"), marker, account check, SharedMutex SDDL + wait/release,
  environment block, shell-token start (elevated runs only), privilege footprint, CLI surface, Settings toggle
  (declined writes nothing; accepted writes, stops, retries; a running session defers), elevation words, Elevating pill,
  launcher marker, updater held-folder cases.
- Docs: 01_ARCHITECTURE ADR-9, 19_SAFETY elevated targets, 20_OPEN_QUESTIONS G (closed: chosen, not inherited),
  06_DATA_MODEL settings, 02_SPEC FR-10, 12_BUILD flags, 07_IPC (HelloAck, prompts, stated DACLs), 08_UI Settings,
  11_UPDATER, 18_GPU_VENDOR_APIS, 04_CAPTURE launch; CHANGELOG.

No hook-path change: the Overlay is untouched.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* test: the admin mode's two tests as the hosted runner measured them - a variable keeps the process's own name casing, and the runner's token arrives with SeDebugPrivilege on

CI on #244 (run 36332900944) failed two of the new tests, both on facts of the hosted runner rather than of the code:

- The environment block keeps an existing variable's own casing ("Path" there, "PATH" on the dev box) when the caller
  overrides it - Windows compares names without case, so the value replaces it rather than standing beside it. The
  test now finds the one PATH entry case-insensitively and checks its value.
- The runner's token ARRIVES with SeDebugPrivilege enabled (an administrator's service), so "nothing enabled before
  anything ran" was false there. The footprint test now asserts that nothing it runs NEWLY enables a powerful
  privilege, and names what was already on in its message.

The third failure of that run, TargetResolverTests.OneInstanceResolves (TargetNotRunning), is the hosted-runner flake
the test's own comment records from 2026-09-04; this PR does not touch the resolver.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-27 23:49:16 +07:00
poli0981andClaude Opus 5.5 5a890553b2 feat: the display mode - how each game was shown and for how much of the session, both tiers, on the summary, the game page, the trend and compare (schema 0016, beta.10) (#243)
The owner asked for the game's window size and display mode (exclusive fullscreen / borderless / windowed) and the share of
the session each took, with trend and compare. PR-2 (#242) published the swap chain's own answer in shared-memory region 4;
this change reads the window from outside, classifies, tallies, stores and shows it.

- Domain/Display: DisplayModeClassifier (no window -> minimised -> exclusive, only from a region-4 sample under 2 s old ->
  covers its monitor: borderless when the chain said not exclusive, "fullscreen or borderless" when nothing could say ->
  windowed), DisplayTally (milliseconds, not ticks: a sample stands for the time until the next), DisplaySummary.
- Application: IDisplayProbe; DisplaySampler on the capture loop's tick beside focus (100 ms hooked) and on the Tier-2
  hold's tick (1 s) - an interval ending on a paused tick is dropped; ITargetResolver.PidsOf finds a hold's processes by
  image path in the watcher's snapshot (never by name, never an unreadable path), still opening nothing;
  CaptureOutcome.Display; the recorder writes it on the row's skeleton (SessionDisplayColumns), so a Tier-2 row has it.
- Infrastructure: WindowGeometryProbe - user32 out of process, per-monitor DPI aware (V2) while it asks and put back; the
  window region 4 names when it still belongs to the game (to its root), else the largest visible, uncloaked, non-tool
  top-level window of the game's processes; MONITORINFOEX + EnumDisplaySettings for the monitor and its refresh rate.
  Nothing belonging to the game is read (CLAUDE.md rule 4). Schema 0016: fifteen sessions.display_* columns, ADD COLUMN
  only; sessions.swap_effect gets its first writer.
- Composition: the Agent's CaptureSession and the operator host's take the probe.
- App: a Display stat card and line on the session summary, the last measured session and a Display column (tooltip with
  every share) on the game page, three Trend metrics (exclusive / borderless / windowed share, every tier, never left out
  as a mid-session change, no exclusive or borderless point where the two could not be told apart), three Compare rows
  (never ranked), the CSV's "# display:" line (invariant). Strings en/vi/ja; Strings.Designer.cs regenerated.
- Tests: classifier and tally (Domain); sampler on a moved clock, pause, staleness, swap-effect names; CaptureSession Tier 1
  from region 4 + window and Tier-2 hold by the snapshot's pids; recorder Tier-2 row and hooked row; LatestProcessSnapshot
  pids; migration 0016 and the repository round trip; WindowGeometryProbe against hook-harness's real window; App card,
  line, game page, trend, compare, export, DisplayText.
- Docs: 03_METRICS (new section Display mode, accuracy row, export header), 04_CAPTURE, 05_DETECTION (runtime facts row;
  present mode still has no writer), 06_DATA_MODEL (DDL + 0016), 08_UI, 02_SPEC (FR-7.4, FR-7.2 note), CHANGELOG.

No hook-path change: the Overlay is untouched by this PR (its cost was measured in #242).

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-27 23:15:28 +07:00
poli0981andClaude Opus 5.5 a4b18e698c feat(overlay): shared-memory region 4 - the presenting swap chain's exclusive state, window and back buffer, polled twice a second (layout 4, beta.10) (#242)
The owner asked for the game's window size and display mode (exclusive fullscreen / borderless / windowed) and the share of
a session each took. Two of the facts that decide it only the process knows: whether the swap chain is in exclusive
fullscreen, and which window it presents to. This change publishes them; the Agent's window geometry, the classification,
the storage and the App follow in the next PR of the train.

- fl_shm.h layout 4: FlDisplayState, a 64-byte region at 0xC0 (the ring moved to 0x100; FlWriterState had no slack left).
  A seqlock the writer never waits on: a presenting thread that finds it taken skips the sample. DXGI_SWAP_EFFECT is
  stored plus one (DISCARD is 0, the vendor-zero trap).
- Overlay: the present hook asks GetFullscreenState(&fs, nullptr) and GetDesc at most every 500 ms per chain - getters
  on the chain the title passed, the same object FindOrAdd already described (CLAUDE.md rule 4); the chain with the
  largest back buffer is described, and one silent for 2 s gives way. SetFullscreenState stays unhooked on purpose: DXGI
  leaves exclusive fullscreen by itself (focus loss, Alt+Enter) without the title calling it. The periodic GetDesc also
  refreshes every record's output size, closing the unhooked ResizeBuffers1 hole on D3D12. OpenGL publishes the window
  and client size it already read, with no exclusive bits.
- Managed: ShmLayout mirror + FlDisplayFlags; ShmRingReader.DisplayState takes a consistent copy (eight attempts, a full
  fence between copy and re-check); ICaptureSink/ShmCaptureSink expose it. Nothing consumes it yet.
- Tests: hook-harness --hold-presenting-hwnd (the first DXGI fixture with a window); fl_guard "[display]" checks the region
  names the harness's own window, its back buffer, windowed and a second sample; the OpenGL case checks its region; the
  mirror test covers the region and now fails a struct the dump emits but nothing mirrors.
- Overhead (hook-harness --probe-frames, 3 runs, WARP): GetFullscreenState 12.6-13.1 ns/call, GetDesc 13.6-14.5 ns/call,
  paid at most twice a second per chain - under 1 ns per present at 60 fps, plus one QPC comparison per present.
- Docs: 07_IPC (layout 4 + region 4; the FlWriterState block showed reserved[5] where the header had none), 17_HOOK_ENGINE
  (SetFullscreenState row: polled, not hooked), 15_ROADMAP, 11_UPDATER (pre-1.0 practice for the MAJOR rule).

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-27 22:46:01 +07:00
poli0981andClaude Opus 5.5 32fdcf82f3 feat(detection): the exact Unreal Engine version from the shipping executable, and the witness it rests on (beta.10) (#241)
The owner asked for the exact Unreal Engine version on a game's page. The rule could not give one: it read only the
executable's ProductVersion string, which most shipping executables leave empty, and its pattern
`\+\+UE(4|5)\+Release-(\d+\.\d+)` had two capture groups of which the evaluator returns the first - so every Unreal
version ever stored was a bare "4" or "5".

Measured first, read-only, on the owner's ten installed Unreal titles: the numeric file version is the engine's in seven,
a studio's own in three; the engine's branch name (UTF-16 `++UE5+Release-5.1`) is in the bytes of five - in .rdata in
four, 290 MB into .code in Black Myth: Wukong's protected executable (whose .rdata is 8 KB).

- Domain: UnrealVersion.Decide weighs the two witnesses (branch + agreeing file version -> M.m.p; branch alone -> M.m;
  a file version that reads as an engine's where nothing says the studio replaced it -> M.m.p; else nothing), and
  EngineVersionSource names the rung. The ten measured titles are its test cases.
- Rules 2026.09.6: the unreal extractor is `unreal_build` (a fourth oneOf branch in the schema, no parameter);
  StaticGameDetector makes the second read for the one engine that matched, never the probe for every game.
- UnrealBuildReader: the version resource, then the branch name in .rdata (or the whole file, bounded at 1 GiB, when
  .rdata is under 1 MiB), 4 MB chunks with overlap so a cut name is never read short, cancellation between chunks.
  Through the shipped reader on the same ten files: every version as measured, 16 ms to 1.1 s each, 7.5 s for Black
  Myth on the owner's USB drive.
- Schema 0015: games.engine_version_source, written only with a version the row took; the old rule's bare "4"/"5"
  removed only where field_provenance says detected.
- rules-validate: a version pattern must compile and capture exactly one group (canary: the old pattern is red).
- App: the game page's Details say which witness an Unreal version rests on, or that none was found.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-27 22:14:49 +07:00
poli0981andClaude Opus 5.5 a7329fc45c release: 0.1.0-beta.9 - the CHANGELOG section, the accuracy block's release line, README's release lines, HANDOFF's status pointer (#239)
The ninth pre-release: one narrow exception a user can make, per game, for a game whose only
anti-cheat runs in user mode and that FrameLedger has measured hooked at least twice (owner
decision D33): the guard's tolerance and the Overlay's channel (#236), the Agent's eligibility,
grant, marks and ends with schema 0014 (#237), and the option, the list, the disclosure and the
legal text in the App (#238). Same unsigned installer; the Legal Gate opens once for the
Disclaimer 2.7 and the EULA 1.3 (owner's leave 2026-09-26). The Privacy Policy is unchanged.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-25 22:29:22 +00:00
poli0981andClaude Opus 5.5 f32c10d758 feat(app): the user-mode anti-cheat exception in Settings and on the game page - its option, its list, its versioned disclosure, and the legal text that says it (D33) (#238)
Owner decision D33 (2026-09-26), beta.9 PR-3 of 4, on the guard (#236) and the Agent (#237).
This is the part a user sees; every state it shows is the Agent's, read from its columns,
and every grant is the Agent's to make.

- Settings > Capture: "Allow hooking in games with user-mode anti-cheat that were measured
  before" (hooking.usermode_ac_exceptions, off by default) and under it the User-mode
  exceptions list - eligible games (Make exception...), games held back only by the session
  count, games carrying an exception (Withdraw), each with its finding, its successful hooked
  sessions and its state. Off, only kept exceptions are listed, suspended. "Checking..." until
  the Agent has answered about every blocked game; Refresh re-reads.
- The disclosure: AntiCheatExceptionPrompt / AntiCheatExceptionDialogContent over the new
  Safety_Exception_* family (Shared, versioned by AntiCheatExceptionDisclosure.Version; ja
  English verbatim marked for review). Why it is offered, the risk at the same grain as FR-2.1's
  dialog (a ban possibly days later, invisible to FrameLedger), what is still refused, how it
  ends, that it turns nothing on, offline/single-player; the primary button bound to the ticked
  "I accept the risk of a ban for this game", Enter = Keep it blocked.
- AntiCheatExceptions: the handshake on HelloAck.ExceptionDisclosureVersion (no dialog against
  other text), then SetAntiCheatException; Granted / Withdrawn / Refused (TooFewSessions, the
  guard's finding, BlockNotExceptionable, could not verify) / OptionOff / VersionMismatch /
  AgentUnavailable, each said in the user's language.
- The game page: a User-mode exception card (ExceptionView over GameRow.AcException) - eligible,
  checking, not eligible and why (too few sessions; "the guard also found Kernel driver in the
  game folder (NEPKernel.sys)"; "... is not user-mode throughout"), in force, suspended, ended
  and why. An exception in force brings the Hooking card back even while anti-cheat cards are
  hidden, its switch usable through FR-2.1's dialog, the finding still under it.
- Marks: the library card says Exception; a session hooked under one is "Hooked · exception"
  in the Sessions tab (tooltip names the family) and has a line in its summary.
- Legal (owner-approved): Disclaimer 2.6 -> 2.7 (sec. 2A describes the exception and its risk;
  sec. 2's "no setting" sentence points to it), EULA 1.2 -> 1.3 (the code-injection clause
  names it), the accuracy block (all three copies, re-dated 2026-09-26), SECURITY.md (what in
  the exception is a security report), README's Hard refusal row. Privacy stays 2.4. The Legal
  Gate re-shows the two changed documents.

Tests: AntiCheatExceptionsTests (handshake, declined sends nothing, our version sent, the
Agent's answers, withdrawal needs no dialog, the button waits for the tick),
GameDetailViewModelTests (eligible offers it; in force makes the switch usable; off =
suspended; the card says Exception; why not eligible - one session, Aniimo's driver, a
kernel-level family), SettingsViewModelTests (off by default; the list follows the Agent's
columns; off lists only a kept exception).

Docs: 08_UI (the game page card, the Settings list), 09_I18N (Safety_Exception_*),
20_OPEN_QUESTIONS (the decision recorded, what stays the owner's), 19_SAFETY (status),
CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-25 22:16:06 +00:00
poli0981andClaude Opus 5.5 9b5d1cd486 feat: the Agent grants, keeps and ends a user-mode anti-cheat exception - eligibility from its own facts, the Overlay told first, every re-scan naming the family, schema 0014 (D33) (#237)
Owner decision D33 (2026-09-26), beta.9 PR-2 of 4, on PR-1's native half. Nothing in the
App asks for an exception yet (PR-3 adds the option, the list and the disclosure); this is
everything the Agent does once something does.

- The option: hooking.usermode_ac_exceptions (SettingsRegistry, off by default, Agent-read)
  behind IUserModeExceptionSwitch. Off suspends every exception and deletes none.
- Eligibility: AntiCheatPreScanSweep asks each BLOCKED entry, while the option is on, one
  question - a tolerant pre-scan naming the block's family (PreScanGameAsync(exe, family)),
  keyed on the rules, the executable and the block text so it re-runs only on a change -
  and counts ISessionRepository.CountSuccessfulHookedAsync every pass (hooked, frames,
  exit_status normal). UserModeExceptionRules.IsEligible: a module/file/folder block, the
  guard let exactly that family through, >= 2 sessions. A block is still never scanned for
  a new one and never cleared.
- The grant: SetAntiCheatException {gameId, enabled, disclosureVersion} (07_IPC). The
  Agent's disclosure version (AntiCheatExceptionDisclosure.Version, also in HelloAck), the
  option on, an exceptionable block, then the Agent's OWN facts - a tolerant pre-scan of the
  file on disk and the session count - and the store writes the grant only over facts that
  make the game eligible (ConsentWriteOutcome.NotEligible otherwise), bound in SQL to the
  block they were reached about. A grant turns nothing on: hooking is FR-2.1's SetHookEnabled,
  which under an exception in force names the family and answers prescan "exception".
- The session: HookRequest.FromConsent derives ToleratedFamily from the stored grant only
  (UserModeExceptionRules.CoveredFamily: option on, grant on these bytes, block naming that
  family) and only when the Overlay's channel was published first
  (IOverlayToleranceChannel -> Infrastructure.Capture.OverlayToleranceChannel, the
  Local\FrameLedger.Tolerate.<pid> mapping with a stated O:<user>D:P(A;;GR;;;<user>) DACL, a
  name already taken refused). The gate hands the guard the NAME; GuardSupervisor names it
  to every 30 s re-scan. A blocked row whose exception does not apply is hooking-off before
  the process is opened. The hooked session is marked (sessions.ac_exception_family,
  "; ac-exception=<family>" in the notes, CaptureNotes reads it, CSV header line).
- The end: UserModeExceptionLapsePolicy after the row is stored - NewFinding (a finding
  about the game at the start or the re-scan), SafetyUnhook, OverlayStopped, SessionCrashed
  while hooked; the sweep ends a grant on other bytes (ExecutableChanged, with the option off
  too) or one the facts no longer support (NoLongerEligible - never on a scan that could not
  look); Change executable ends it; the user withdraws it (Withdrawn). An end turns hooking
  off while the block stands and keeps the consent stamp and the grant's history.
- Schema 0014: fourteen games.ac_exception_* columns (eligibility + key, grant, end) and
  sessions.ac_exception_family, ADD COLUMN only. GameRow.AcException, GameConsentRecord
  .Exception, StoredBlock (Reason|Family|Signal read back).
- IAntiCheatGuard: every method takes string? toleratedFamily - required, so every caller
  states which it means; still four methods of int/string/CancellationToken
  (NoSecondMatcherTests unchanged but for the note).

Tests: UserModeExceptionRulesTests, UserModeExceptionLapsePolicyTests, D33 cases in
AntiCheatPreScanSweepTests (option off asks nothing, keyed question, live count, title list
never asked, the Aniimo shape, ends), HookRequestFromConsentTests, HookedCaptureGateTests
(both entries), GuardSupervisorTests, CaptureSessionTests (the channel before the injection,
option off / other bytes -> hooking-off without opening the process, a failed channel is no
exception, a start-time finding), SessionRecorderTests (the mark; a crash ends it),
AgentCommandHandlerTests (disclosure/option, facts, refusals, SetHookEnabled under it,
withdrawal), SqliteGameConsentStoreTests, SqliteSessionRepositoryTests, LedgerDatabaseTests
(0014), OverlayToleranceChannelTests (read by the user, write refused, squatted name, NUL/
newline), IpcCodecTests, SettingsRegistryTests.

Docs: 02_SPEC (FR-2.3 note, FR-2.8), 04_CAPTURE (the gate's one branch), 06_DATA_MODEL (schema
0014, the setting, writer ownership), 07_IPC (SetAntiCheatException, HelloAck, SetHookEnabled,
section D built), 19_SAFETY (status), HANDOFF traps, CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-25 21:22:22 +00:00
poli0981andClaude Opus 5.5 01d3afd504 feat(guard): the native half of the user-mode exception - the guard tolerates one named user-mode family and keeps scanning, and the Overlay learns it before its loader detour exists (D33) (#236)
Owner decision D33 (2026-09-26, beta.9 PR-1 of 4): a per-game exception for anti-cheat
that is user-mode throughout, bound to evidence (>= 2 successful Tier-1 sessions), chosen
with CLAUDE.md rule 2 and D22 quoted back. This PR is the part the guard and the Overlay
own; nothing asks for it yet (NativeAntiCheatGuard passes no family), so every game is
judged exactly as in beta.8. The Agent's half is PR-2, the App's and the legal text PR-3.

- ABI: FlGuardEvaluate, FlGuardedInject, FlGuardedInjectWhenReady and FlStaticPreScanGame
  take `const char* toleratedFamilies` - family NAMES, never evidence; nullptr/"" is
  today's behaviour. No new entry point, and nothing of the withdrawn bypass comes back.
- fl::guard::FamilyIsUserModeOnly / ResolveTolerance / MatchNameTolerating: the guard
  itself decides which names it honours - a family with no drivers or services entry and
  no .sys among its files, in the floor AND the rules file (the floor cannot shrink, so
  data can make a family kernel-level and never the reverse). At most 8 names.
- Tolerant scans keep scanning past a tolerated hit (module sink, CheckModules, the tree
  walk), so a second family, a suspicious module or a .sys further in still refuses - the
  load-order fail-open S22(b) closed for the exemption. A .sys is refused whichever family
  matched it. Title lists, drivers, services, the fuzzy tier, scan failures,
  TargetUnreadable, WOW64 and the kill switch are untouched; the Vulkan branch evaluates
  strictly (the layer's self-scan goes inert on any anti-cheat module).
- kAllowedUserModeException = 28 (the slot the withdrawn bypass left): an allow that names
  the family and signal it let through. Managed: AntiCheatRefusalReason
  .AllowedUnderUserModeException, AntiCheatVerdict.RanUnderException / AllowedUnderException;
  IsFindingAboutTheGame stays false for it; Refused() cannot carry either allow.
- fl_tolerance.h: Local\FrameLedger.Tolerate.<pid>, FlTolerance (16 + 8 x 64 = 528 B), the
  Agent's channel to the Overlay BEFORE injection (the ring is the Overlay's, created after
  its detour would need the answer). Mirrored as Shared.FlTolerance / ToleranceLayout and
  held by ShmLayoutMirrorTests through fl-layout-dump.
- Overlay: InitThread reads the mapping once, before InstallLoaderHook, resolves each name
  against its own compiled floor and honours only a user-mode family (a 64-bit mask over the
  floor's module families, logged as TOLERANCE). Hook_LoadLibraryExW tests one bit before
  the early stop.
- NativeAntiCheatGuard: the parameter crosses as NUL-terminated UTF-8 byte[] (CA2101 rejects
  [MarshalAs(LPUTF8Str)] string), the shape FlGuardCheckRules already used.

Overhead: the present path is unchanged - no per-frame hook body was edited. The loader
detour gains one acquire load of a uint64, a shift and a compare on the floor-match branch
only (a branch taken approximately never); the mapping is read once on the init thread.

Tests: guard_test [D33] (6 cases, 73 assertions): the user-mode matrix, ResolveTolerance,
the allow and its family/signal, everything outside the family still refusing (EAC named,
BattlEye after NEP2, a suspicious module, vgk.sys, vgc, a title list, the Aniimo shape with
NEPKernel.sys, an incomplete walk, an unreadable process), the pre-scan answering as the
chokepoint does, and an integration case: a decoy NEP2.dll loaded 2.5 s after injection
does not stop the Overlay when the mapping names NetEase Yidun, and does when it names
Easy Anti-Cheat. AntiCheatVerdictTests, ShmLayoutMirrorTests, ReasonTextTests follow the
new reason.

Docs: CLAUDE.md rule 2 (amendment D33), 19_SAFETY (new section The user-mode exception,
cross-references), 17_HOOK_ENGINE (the detour note, overhead), 07_IPC (section D, the
tolerance mapping), HANDOFF (the beta.9 train: decision, evidence, traps), CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-25 20:33:40 +00:00
poli0981andClaude Opus 5.5 1a655237f5 release: 0.1.0-beta.8 - the CHANGELOG section, the accuracy block re-dated and extended, README's release lines, the Privacy Policy 2.4, HANDOFF's status pointer (#235)
The eighth pre-release: anti-cheat found before anyone asks (#227-#229), what a
game's files and the NVIDIA driver say about it (#230, #231), reasons that read
as what they are (#232), a Trend that works and FPS with two decimals (#233),
and a frame-generation session's numbers and charts over application frames
(#234). Same unsigned installer; the Legal Gate opens once for the Privacy
Policy 2.4 (owner's leave 2026-09-25: it names the library-wide anti-cheat check,
the files' version information and the NVIDIA driver's per-game settings).

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-25 17:06:15 +00:00
poli0981andClaude Opus 5.5 9e7eed6351 fix: a frame-generation session's lows are over application frames, a pause is a gap and not time, and the charts draw what they say (#234)
Owner request 2026-09-25 (beta.8, item 8: fix the charts that are not reasonable). Measured first on the
owner's Onimusha demo capture (DLSS FG x3, read from a copy of the ledger): generated frames are submitted
half a millisecond after their application frame, so the stored median over presents read 2,073 FPS on a
60 FPS game, and the chart's "native" line was each frame's interval to the generated one before it.

- Domain: FrameTimeSeries.ApplicationFrames (application frame to application frame; a gap or an uncounted
  present breaks the chain); MeasuredSeconds - D leaves out every interval a gap sat in, so AverageFps is the
  kept intervals over the seconds they span; RecordWindow.SecondsOf and FgWindow.From take the gap set.
- Application: SessionAggregator takes median / lows / min / max / sigma / stutter over application frames
  where generated frames were counted (segments too), the Displayed 1% low over presents, and no frame
  statistic when a technology was named and no application frame counted. CaptureSession marks a gap before
  the first record stamped at or after the resume's QPC (test red before the fix). SessionFinalizer writes
  frame_blobs.first_present_ms (schema 0013).
- App: SessionSeriesLoader charts the dominant swapchain, application-frame intervals, every present when
  all were generated (noted), sensors on the frames' axis when the blob says where the first present is,
  Tier-2 sensors alone. FrametimeChart: labels (Application frames / Presents), no 0 ms frames after gaps,
  a note on present timing and closed-up gaps, segment labels, the overlay only when aligned.
  DistributionChart: histogram over p0.5-p99.5 with centred bars and an outside count; PercentileCurve
  drawn where ten frames lie beyond each side (FR-4.8 generalised) with the 1% / 0.1% lows marked.
  SensorsChart: watt axis, "Memory", VRAM 0 left out, distinct colours in both themes (light Percentile
  was SensorSecondary's gold), both tiers; the summary window gets a Sensors section. The game page
  reloads when one of its sessions completes.
- The live 5 s window reads the survivors' rate over a drop, not the survivors spread over the lost time.
- Docs: 03_METRICS, 04_CAPTURE, 06_DATA_MODEL, 08_UI, HANDOFF traps, CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-25 16:52:59 +00:00
poli0981andClaude Opus 5.5 aba58dfd7d fix: the Trend tab draws on first open with Native and Presented as two metrics, FPS can show two decimals, and every steady-state factor carries its share (#233)
Owner request 2026-09-25 (beta.8, items 6 and 7: does Trend really work; FPS with up to two
decimals behind a setting).

- Trend: the page draws what the view model holds when it is made (the load finished before
  the page subscribed, so every first open was blank); the date axis is made before the theme
  and the label (DateTimeTicksBottom replaced the axis and dropped both); "Average" is two
  metrics - Presented FPS on sessions that counted no generated frame, Native FPS where frame
  generation was measured - and the tab opens on Native when the newest measured session counted
  generated frames; machine metrics count Tier-2 sessions; partial points (settings changed, or a
  steady state for Native/Displayed/factor) are hollow with a note; one hardware marker per day;
  the metric list in the page's language; the empty text names the metric.
- FPS decimals: ui.fps_decimals (off by default; Settings > Window), FpsDecimals holder read at
  start and moved at once, Formats.FpsNumber "62.40" / "62", rounded half away from zero.
- Rule 6: the readout line (Average card, Compare) and the Sessions grid's FG column carry the
  steady share; "Lifetime average" is labelled as the last measured session it is.
- Compare: the best cell's accent colour (a local Foreground outranked the trigger), best as
  shown (ties by displayed text), loads unranked, the 0-100 percentile axis (AutoScale ran after
  SetLimitsX), and PNG exports with an opaque background (ChartTheme.SavePng).
- Docs: 08_UI, 06_DATA_MODEL (ui.fps_decimals), HANDOFF traps, CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-25 16:39:06 +00:00
poli0981andClaude Opus 5.5 2c02978b5b fix: reasons read as what they are - End task is not a crash, a refusal no anti-cheat names is not "detected", every end reason has its words (#232)
Owner request 2026-09-25 (beta.8, item 5: clearer reasons - 32-bit game, exe missing,
process killed...).

- Exit classification: a crash is an exception's exit code (NTSTATUS 0xC0000000-0xC0FFFFFF
  but 0xC000013A, 0xE06D7363 C++, 0xE0434352 .NET, 0x80000003) or the event log's witness;
  End task's 1, a program's -1, Ctrl+C are ordinary ends with the code in the notes.
  CrashAutoDisablePolicy takes the exit code too and still counts every non-zero exit in
  its window (the safety did not loosen); its row reason says "ended abnormally".
- capture_notes: the guard slot has three positions, guard=Reason|Family|Signal, none
  dropped and no ';' inside one (an empty family used to be dropped and the signal read as
  the family; a ';' in a signal cut it). Old rows are read by the rule that separates them:
  findings and the gate's own refusals carry a family, every other reason's second part
  was its signal. exit_code, crash_event and the new launch_error are read back.
- A launch that cannot start keeps Windows' reason (IProcessLauncher.Start(..., out
  win32Error), a default interface overload; CaptureOutcome.LaunchError).
- App: every SessionEndReason has its sentence (Formats.EndReasonText, enum-walk test);
  every familyless guard refusal says what happened (Formats.GuardSentence) in the
  summary, the safety notice and the enable-time refusal instead of "<signal> was
  detected in this game"; the summary says how it ended ("crashed (0xC0000005 access
  violation)", "ended with exit code 1 - what End task and taskkill leave"); the missing
  executable bar and notice say whether the drive or the file is missing.
- Docs: 04_CAPTURE (classification corrected, notes format, launch error), 19_SAFETY (crash
  safety counts abnormal ends), 08_UI, HANDOFF traps, CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-25 16:02:50 +00:00
poli0981andClaude Opus 5.5 7d6b670173 feat: a session records the NVIDIA driver profile it ran under, and says what the NVIDIA App overrides - DLSS preset and mode, frame generation, Smooth Motion (#231)
Owner request 2026-09-25 (beta.8, item 4: detect whether the NVIDIA App overrides DLSS
settings - FG, RR, the model preset - through NVAPI).

- NVAPI bridge ABI 2: FlNvDriverProfile(exePath, ids, count, out) reads, through DRS, the
  profile the driver applies to an executable (FindApplicationByName on the full path;
  none named -> the current global profile) and the value, location and "someone set it"
  of each id asked. Read-only: a session is created, loaded, read and destroyed; the
  bridge has no DRS setter. A path too long for NVAPI's string is refused, never
  truncated. FlNvDriverProfileSize for the mirror.
- The ids and their values' meanings are NVIDIA's NvApiDriverSettings.h (MIT), written as
  Application.Capture.NvidiaDriverSettings (18 constants, no header vendored); Smooth
  Motion is community-documented only and labelled so.
- NvapiDriverProfileSource (IDriverProfileSource) over the bridge; SessionRecorder reads
  the profile beside every session (both tiers), bounded at 5 s, and a failed read costs
  the column, never the session. Schema 0012: sessions.driver_profile (DriverProfileRecord
  JSON). ngx_driver_words keeps ratio/mode/preset/fg fields beside its masks.
- App: the session summary says the profile and what it overrides ("DLSS override (preset K,
  Quality) - Frame Generation override (x4, latest preset)") and what the driver reported
  applying in the game's process from its override bits; the game page's Details card has
  an "NVIDIA App override" row from the newest session that read one. Configuration, never
  a measurement (03_METRICS).
- Fixed: ctest fl_nvapi_bridge passed on its branch line alone (PASS_REGULAR_EXPRESSION
  ignores the exit code) while its reference-counting check failed on every GPU machine;
  the check is corrected and a FAIL_REGULAR_EXPRESSION added.
- Docs: 18_GPU_VENDOR_APIS (ABI 2, read-only DRS, the ctest trap), 03_METRICS, 06_DATA_MODEL
  (0012), 08_UI, HANDOFF traps, CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-25 15:49:57 +00:00
poli0981andClaude Opus 5.5 efcee1d08d feat: the game page says what the game's files say - x64 or x86, file and store versions, the DLSS/FSR/XeSS files it ships - and a 32-bit game's hooking cannot be turned on (#230)
Owner request 2026-09-25 (beta.8, item 3: game version, DLSS/FSR versions, 32/64-bit).

- Schema 0011: games.exe_machine / exe_file_version / exe_product_version /
  library_versions, written whole by the detection sweep (DetectionWrite). A NULL
  exe_machine is stale once, so every library entry is read under this build.
- PeImports.ReadArchitecture: the COFF machine and, for .NET, the CLR header's flags
  (Domain.Detection.ExecutableArchitecture: x64 | x86 | arm64 | arm | anycpu |
  anycpu32 | other | unknown) - an AnyCPU assembly carries an I386 machine and runs as
  64-bit unless it prefers or requires 32-bit.
- GameFileProbe: the files a capability rule names, with the numeric version of their
  VS_FIXEDFILEINFO (bounded at 48); RuleEvaluator.NamesFile shares the matcher.
- Known not hookable (x86, anycpu32, arm64, arm): SetHookEnabled answers
  Refused ExecutableNotX64 before anything is scanned or stamped; the sweep turns off
  hooking on a row enabled before this build (hook_autodisabled_reason); the page
  disables the switch with the reason and offers no re-enable. A switch that is on can
  still be turned off.
- App: a Details card (runs as, file/product version, store build labelled with its
  store, engine, shipped libraries), the subtitle says "Steam build 20374416", and the
  session summary lists the runtime libraries (runtime_modules, recorded since P2 and
  shown nowhere) against the copy the game ships.
- Rules 2026.09.5: fsr gains ffx_fsr3*.dll, xess gains libxess_dx11.dll (+ fixture).
- Docs: 05_DETECTION (what the files say about themselves), 06_DATA_MODEL (0011),
  07_IPC (ExecutableNotX64), 08_UI (Details, loaded libraries), HANDOFF traps, CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-25 15:34:41 +00:00
poli0981andClaude Opus 5.5 653e2991db feat: the Agent pre-scans the library for anti-cheat, and an anti-cheat game's page shows the finding instead of its hooking switch (#229)
Owner decision 2026-09-25 (beta.8, item 2, HANDOFF D32): hide the hooking part of
anti-cheat games, and find which games those are without waiting for anyone to ask.

- AntiCheatPreScanSweep (Application) + AntiCheatPreScanHostedService (Agent --serve):
  every library entry through the guard's advisory checks 3 and 4 (PreScanGameAsync),
  at start, every 15 s and at once after UpdateRules; once per rules version and
  executable. Skips a blocked row, an unreadable executable and an entry whose session
  is running. Gates nothing: every session start still runs checks 1-4.
- Schema 0010: games.hook_prescan_rules_version / _exe_size_bytes / _exe_mtime_ms, the
  sweep's own key. Change executable clears it with hook_prescan_state.
- IGameConsentStore.RecordPreScanAsync: a finding is the block every other moment
  writes (consent stamp kept), a pass is 'clean', a scan that could not answer is
  'unverified'; the UPDATE itself never writes over a block and never adds a row.
- hook_blocked_reason is stored as Reason|Family|Signal; the App says it in the
  user's language (BlockedReasonText); older rows are shown as stored.
- HookingTurnedOff IPC event, only when the sweep turned off hooking the user had
  turned on: a persistent notice of its own kind (Dismiss, no "record without
  measuring" - no session is running).
- App: ui.hide_anticheat_hooking (default on). The game page shows an Anti-cheat card
  in place of the Hooking card; off, the card is back with the switch disabled and the
  finding under it. The library card says "Anti-cheat" (the caution pair ContrastTests
  already measures). A blocked row no longer offers the crash auto-disable's re-enable.
- Docs: 19_SAFETY (the fourth moment; the enable-time row corrected to checks 3+4 over
  the install root), 02_SPEC FR-2.2/2.7, 06_DATA_MODEL, 07_IPC, 08_UI, HANDOFF D32 +
  traps (and owner-only item 3 marked taken by D30), CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-25 14:36:04 +00:00
poli0981andClaude Opus 5.5 79f21422a3 feat(guard): check 3 is live in both halves and seeded; any kernel driver in a game's folder is a finding; the pre-scan sees the install root (#228)
beta.8 PR-2, the owner's strictness decisions of 2026-09-25 (HANDOFF D30, D31).

- Check 3's store half: Sources::StoreIdentity reads the store's own metadata from the install root the guard
  derives itself - the Steam library's appmanifest_*.acf whose installdir is the game's folder, or a GOG
  goggame-<id>.info - so no caller hands in evidence (S3) and nothing is read from the game (rule 4). Matrix: listed
  refuses (BlockedStoreId); no store identity is not refused; unreadable store metadata refuses (PreScanFailed).
- rules 2026.09.4 seeds both per-title lists - 30 Steam app ids, 33 executables across nine families (VAC titles,
  Riot, Roblox, Blizzard, Call of Duty, NetEase, ACE, HoYoverse, EA) - and floors them like the families, so data
  can add a title and never remove one. kMaxTitleRules 64 -> 128 (the floor doubles the worst case). rules-validate
  refuses generic executable names, exact rules without .exe, and duplicates, and checks the 2x capacity.
- The kernel-driver rule: a *.sys file in the install tree that no files entry names is AntiCheatFile under
  "Kernel driver in the game folder". Code, not data; a named entry (randgrid.sys) keeps its own family.
- FlStaticPreScan(gameDirectory) -> FlStaticPreScanGame(exePath), and IAntiCheatGuard.PreScanGameDirectoryAsync ->
  PreScanGameAsync(executablePath): SetHookEnabled passed the exe's own folder and the guard scanned exactly that, so
  an Unreal title's root-level EasyAntiCheat folder was never seen by the enable-time scan. The guard now resolves
  the install root itself and runs check 3 there too. The port keeps four methods.

Tests: native fakes gain the store seam; new cases for the store matrix, the driver rule, the root resolution and
check 3 in the advisory scan; the real seam against a Steam library and a GOG folder built in %TEMP%; the floor
reproduction and the minimal-file test cover the title lists.
Docs: 19_SAFETY checks 3 and 4, the VAC row; 20_OPEN_QUESTIONS S14 closed and the S24 count; 05_DETECTION; HANDOFF
D30/D31 and traps; CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-25 13:59:28 +00:00
poli0981andClaude Opus 5.5 80df94a934 feat(rules): the anti-cheat blocklist names twenty-two families through more signals; the guard holds 256 entries (#227)
The owner asked for the anti-cheat set to be as large and as strict as possible (beta.8, PR-1).

- rules 2026.09.3: 11 families / 19 entries / 30 values become 22 / 74 / 142. New: EA AntiCheat, Activision
  Ricochet (19_SAFETY's "no data yet" row), NetEase Anti-Cheat, NetEase Yidun, Nexon Game Security, TenProtect,
  AhnLab HackShield, EQU8, Anybrain, FredaikisAntiCheat, Roblox Hyperion; existing families gain drivers, services,
  folders and files (BEDaisy.sys, FACEIT.sys, ESEADriver, HoYoKProtect.sys, xhunter1, denuvo-anti-cheat.sys...).
  Every new token is documented, not measured, and its note says so. Services that run outside play are left out
  (EAAntiCheatService, PnkBstrA, Denuvo's updater). New modules rows are appended (early_stop_family is an index).
- kMaxFamilies 64 -> 256 (2 x 74 worst case); schema maxItems follows. Rules is 541,736 bytes, so it is reset in
  place (ResetRules) rather than assigned from a stack temporary: the Vulkan layer parses on a game's own thread.
  Native tests hold Rules on the heap.
- A generated fixture requires every seed value to match its own family in its own group; Ricochet's "no data"
  test asserts its data now; VAC's asserts no family entry fakes it.
- Measured: the Overlay's MatchesFloorModule goes from ~20 ns to ~60 ns per miss over the larger floor.

Docs: 19_SAFETY Blocklist seed (regenerated table, expansion note), 14_TESTING, 20_OPEN_QUESTIONS S5, CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-25 13:38:11 +00:00
poli0981andClaude Opus 5.5 53048ab2e0 release: 0.1.0-beta.7 - the CHANGELOG section, the accuracy block's release line, README's release lines, HANDOFF's status pointer (#226)
The seventh pre-release: a program in the library can be left unrecorded,
and Steam's own tools already in a library start that way (#225, D29,
schema 0009). Same unsigned installer; the Legal Gate opens once for the
Privacy Policy 2.3 and the Disclaimer 2.6.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-23 09:19:12 +07:00
poli0981andClaude Opus 5.5 944f827a2b feat: a library entry can be left unrecorded - Steam tools start off, the Privacy Policy and the Disclaimer say so (#225)
Owner, 2026-09-23: the Agent records Borderless Gaming although hooking is
off, and it starts with Windows. Since Tier 2 exists every library entry
that runs gets a session, so each boot added one, for as long as the
utility ran, to the playtime totals (today 07:36-07:45 in agent-*.log).

D29: a per-entry Recording switch (FR-1.6) plus the import's known-tools
list applied to the entries an earlier import made.
- Schema 0009: games.record_sessions INTEGER NOT NULL DEFAULT 1; the one
  data change switches it off for rows with platform 'steam' and a
  SteamLibrarySource.KnownTools app id (a test holds the script's ids to
  that list). The UI writes it; the Agent only reads it.
- CaptureOrchestrator: the watchlist (and the launch election's tracked
  set) is the entries whose recording is on - an ignored program is no
  event, no session, no log line; switched off while a session of it
  runs, that session's stop token is cancelled once at the next poll (a
  user stop, saved as such); LaunchGame answers RecordingOff.
- The twin merge keeps the switch off when either twin had it off.
- App: a Recording card on the game page (no dialog: it deletes nothing,
  and nothing goes over the pipe), "Not recorded" on the library card in
  place of the hooking badge; en/vi/ja.
- Legal: the Privacy Policy 2.3 (a program whose recording is off is not
  watched; history note) and the Disclaimer 2.6 (the accuracy block's
  "unless you switched its recording off", which also carries #224's
  correction) - the Legal Gate shows both once. The EULA's statement stays
  true and is unchanged.

Tests: orchestrator (not watched, stop on switch-off once, launch
refused), schema 0009 applied from 8 to a tool/game/hand-added ledger, the
script's ids within KnownTools, repository switch, merge carry, the game
page and the card. Docs: 02_SPEC FR-1.6, 04_CAPTURE, 06_DATA_MODEL,
07_IPC, 08_UI, HANDOFF D29 + traps, CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-23 08:22:55 +07:00
poli0981andClaude Opus 5.5 6fbf1f4cbc release: 0.1.0-beta.6 - the CHANGELOG section, the accuracy block re-dated and corrected, README's release lines, HANDOFF's status pointer (#224)
* fix: one entry per executable across drive letters - twins merge, an updated game follows with hooking off

Item 5 of the owner's beta.6 list: after the USB drive's letter changed
and changed back (H: on 2026-09-22 morning, D: after the reboot), the
library showed two entries side by side for the games played from it, and
the relocator's NOT EXISTS refused every move onto the other entry's path
- 5,675 "could not be moved" lines that day.

D26 (owner): two entries for one executable merge, in the Agent.
- ExecutableRelocator: a same-bytes move refused because another library
  entry holds the path becomes a merge (IGameMerge / SqliteGameMerge, one
  transaction; GameMergePlan picks the entry made first, a tie keeping the
  lower id). Sessions are re-parented before the dropped row is deleted
  (sessions.game_id cascades), the survivor takes the path after (UNIQUE).
  A block either carried is kept (hooking off), a crash auto-disable still
  in force is kept, crash counts add; no consent moves between the rows -
  hook_enabled only ever goes to 0. The merge re-reads both rows in the
  transaction and writes nothing unless they are as planned.
- It waits while a session of either entry runs (CaptureOrchestrator.
  IsRecording) or waits in a .partial to be recovered (IPartialSessionStore.
  PendingGameIds, read beside a running writer with FileShare.ReadWrite).
- Never with an entry removed from the library; other bytes under a twin
  are not merged - the log says once which entry to remove.

D27 (owner): when the only file at the entry's path on another letter has
other bytes (updated meanwhile), the entry follows it through the Change
executable write: hooking off, consent cleared, block kept. The watcher's
adopt follows the same rule.

Also:
- LibraryImporter no longer adds a twin: a store executable that is a
  library entry's path on another letter, with that entry's file gone, is
  shown "In the library under another drive letter" (Import_Note_Moved,
  en/vi/ja) and skipped at import.
- DetectionSweep does not call a merged-away entry unreadable.
- DetectionHostedService catches DbException: a service that throws stops
  the Agent's host, and a busy ledger is a retry.

Tests: relocator (merge, survivor choice, busy, refused merge, removed
owner, other bytes not merged, D27 sweep and watcher, ambiguity), plan,
SqliteGameMerge on a real ledger (sessions re-parented, block and
auto-disable carried or not, no consent moved, nothing written when a row
changed), sweep, importer, import review, .partial headers beside a
writer. Docs: 19_SAFETY, 06_DATA_MODEL, HANDOFF D24 done + D26/D27 + traps,
CHANGELOG.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* release: 0.1.0-beta.6 - the CHANGELOG section, the accuracy block re-dated and corrected, README's release lines, HANDOFF's status pointer

The sixth pre-release: another game's Game.exe is no longer recorded under
an entry (#220), a session whose entry was removed keeps its data and a
bad .partial no longer stops the Agent (#219), a game that is not measured
is shown while it runs (#221), RE Engine and FromSoftware are detected and
engines are shown by name (#222), and two entries for one executable under
two drive letters merge (#223). Same unsigned installer; schema 0008
unchanged; rules 2026.09.2.

The accuracy block (README, legal/ACCURACY.md, legal/DISCLAIMER.md) is
re-dated, and one sentence corrected while doing so: it said the driver's
DLSS record "is not displayed yet", and the App has shown it as
"DLSS (driver-reported)" on the library, the summary, the game page and the
live card since 0.1.0-beta.3. A block re-dated with a sentence known to be
false would assert it again. No Disclaimer version bump, as with #218.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-23 03:57:18 +07:00
poli0981andClaude Opus 5.5 101bbbe5e4 fix: one entry per executable across drive letters - twins merge, an updated game follows with hooking off (#223)
Item 5 of the owner's beta.6 list: after the USB drive's letter changed
and changed back (H: on 2026-09-22 morning, D: after the reboot), the
library showed two entries side by side for the games played from it, and
the relocator's NOT EXISTS refused every move onto the other entry's path
- 5,675 "could not be moved" lines that day.

D26 (owner): two entries for one executable merge, in the Agent.
- ExecutableRelocator: a same-bytes move refused because another library
  entry holds the path becomes a merge (IGameMerge / SqliteGameMerge, one
  transaction; GameMergePlan picks the entry made first, a tie keeping the
  lower id). Sessions are re-parented before the dropped row is deleted
  (sessions.game_id cascades), the survivor takes the path after (UNIQUE).
  A block either carried is kept (hooking off), a crash auto-disable still
  in force is kept, crash counts add; no consent moves between the rows -
  hook_enabled only ever goes to 0. The merge re-reads both rows in the
  transaction and writes nothing unless they are as planned.
- It waits while a session of either entry runs (CaptureOrchestrator.
  IsRecording) or waits in a .partial to be recovered (IPartialSessionStore.
  PendingGameIds, read beside a running writer with FileShare.ReadWrite).
- Never with an entry removed from the library; other bytes under a twin
  are not merged - the log says once which entry to remove.

D27 (owner): when the only file at the entry's path on another letter has
other bytes (updated meanwhile), the entry follows it through the Change
executable write: hooking off, consent cleared, block kept. The watcher's
adopt follows the same rule.

Also:
- LibraryImporter no longer adds a twin: a store executable that is a
  library entry's path on another letter, with that entry's file gone, is
  shown "In the library under another drive letter" (Import_Note_Moved,
  en/vi/ja) and skipped at import.
- DetectionSweep does not call a merged-away entry unreadable.
- DetectionHostedService catches DbException: a service that throws stops
  the Agent's host, and a busy ledger is a retry.

Tests: relocator (merge, survivor choice, busy, refused merge, removed
owner, other bytes not merged, D27 sweep and watcher, ambiguity), plan,
SqliteGameMerge on a real ledger (sessions re-parented, block and
auto-disable carried or not, no consent moved, nothing written when a row
changed), sweep, importer, import review, .partial headers beside a
writer. Docs: 19_SAFETY, 06_DATA_MODEL, HANDOFF D24 done + D26/D27 + traps,
CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-23 03:42:31 +07:00
poli0981andClaude Opus 5.5 7756072af0 feat(rules): RE Engine and FromSoftware are detected; engines are shown by name (#222)
Items 2 and 3 of the owner's beta.6 list, checked on the owner's disk first.

- re_engine: `re_chunk_000.pak` beside the executable, the exact name (a
  glob without a star is the whole leaf, so a patch archive alone is not
  it). RESIDENT EVIL 2 and the Onimusha demo carry it.
- fromsoftware: a `*.bhd` AND a `*.bdt` sibling - DARK SOULS II
  (GameDataEbl), III (Data0-5), ELDEN RING (Data0-3) and Sekiro (Data1-5).
  The request said `.bht`; on disk it is `.bdt`. No `Game\` requirement:
  Sekiro has none, and "the parent folder is named X" is not a signal type.
- Both after the RPG Maker rules and before godot (whose *.pck also matches
  a loose Wwise bank). rulesVersion 2026.09.2, so every row re-detects.
  None of the other 80 Steam titles on the owner's disk has either marker.
- Fixtures engines/re_engine and engines/fromsoftware; the
  every_engine_marker canary carries both and still expects unity; its
  README said "four engines" while it held six.

The App shows engines by name (Formats.Engine: proper nouns, an unknown or
user-typed id passes through) on the card and the game page, where it
showed `rpgmaker_mv`; a test holds every shipped rule's id to its own name.
A hand-added executable whose name says nothing (Game.exe) is named from
RPG Maker's System.json gameTitle, else the nearest non-runtime folder
(GameTitleGuess + RpgMakerTitle), so HHW's swiftshader\Game.exe is "HELLO,
HELLO WORLD!" and not "Game". GameLibrary's misplaced doc comment fixed.

Engine detection never feeds the guard: ELDEN RING stays refused.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-23 03:17:34 +07:00
poli0981andClaude Opus 5.5 b7a03f0fce fix: a session that is not hooked is shown while it runs (#221)
A game with hooking off, one the guard refused, or one whose process could
not be read has been recorded since beta.5 (duration, sensors, the reason),
but SessionEventPublisher sent SessionStarted only at the ring attach and
progress only while attached. For as long as such a game ran the Dashboard
said "Nothing is being captured." and the tray stayed idle.

Agent:
- The hold's ticks carry the refusal (CaptureProgress.Held, with the pid the
  loop holds). The first held tick publishes SessionStarted ONCE, at tier 2,
  with an optional `hold` (the loop's reason and the guard's reason, family
  and signal - the words capture_notes will carry), and the refusal's own
  event at once instead of at the exit; it is not repeated at the end.
- Every held tick after feeds a new SessionHeld event (elapsed + sensors) at
  1 Hz while a client listens - never SessionProgress, whose required fields
  would put measured-looking zeros on the wire.
- ActiveSession carries the hold; SessionCompleted carries the entry's id and
  name; a faulted session also completes (finalize "faulted").
- All fields additive and optional: IpcProtocol.Version stays 2.

App:
- LiveSessions (App-lifetime) is seeded from the status on every (re)connect
  and moved by start/completion; the Dashboard seeds its card from it (it is
  rebuilt per visit). The tray and the updater seed their own lists from the
  same status; the updater no longer holds a download at Deferred on a
  status read hours earlier.
- The live card shows a held session with the T2 badge, elapsed, temperatures,
  "Recording duration and sensors only - nothing is measured." and why (the
  summary's own sentence), with no FPS readout. A tier-2 session without a
  hold is starting, not held. A hooked session takes the card, never the
  reverse. Stop clears the name; the notice names the completed session; a
  faulted completion is no notice.
- Formats: RefusedConsentMissing reads "the game's executable changed since
  hooking was turned on" instead of the enum name (en/vi/ja).

Tests: publisher (held announce once, reason once, no progress, status hold,
faulted completion), event table, codec (additive fields, beta.5 payloads),
capture session (ticks carry the hold and pid), live card, LiveSessions,
Dashboard, tray, updater, Tier2Reason, and a pipe end-to-end case with a
hooking-off harness. Docs: 07_IPC, 08_UI, 04_CAPTURE, 11_UPDATER (gap
closed), HANDOFF, CHANGELOG.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-23 02:58:33 +07:00
poli0981andClaude Opus 5.5 7ddb367c63 fix: a file name is not an identity - another game's Game.exe no longer runs under a library entry (#220)
2026-09-23 00:16 on the owner's machine: HELLO, HELLO WORLD!'s RPG Maker runtime (swiftshader\Game.exe)
matched Flower in Us, the only entry named Game.exe, by file name; the session was recorded under that
name, which created a new "Flower in Us" entry at HHW's path, and an NW.js child exact-matched the new
entry and started a second session. Both Tier-2 holds were timed by the name Game (HANDOFF D25).

- A StalePath match starts nothing unless the relocator moves the entry to it; otherwise one log line
  per executable, no session, no entry, a silent exit.
- ExecutableRelocator.TryAdoptAsync accepts only a drive-letter twin with the one-candidate rule
  (identical RPG Maker Game.exe stubs could have carried a consent to another game).
- The running table is keyed by executable path; IsRecording(gameId); the election registers and defers.
- Tier-2 liveness reads the watcher's snapshot by image path (LatestProcessSnapshot), opening nothing.
- Resolver notes reach agent-*.log with why a candidate was unreadable; unreadable/could-not-move and the
  sweep summary are logged once per change.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-23 02:39:53 +07:00
poli0981andClaude Opus 5.5 d586de1ccc fix: a session whose entry was removed lands where its executable lives, or is dropped; one bad .partial never stops the watcher (#219)
Two GIRLS' FRONTLINE 2 sessions on the owner's machine (2026-09-22 23:26, 2026-09-23 00:25) died on the
sessions.game_id foreign key because their entry was removed and re-imported while the game ran, and each
left a .partial that the next start's recovery would have failed on the same way - stopping the host, since
recovery runs before the watcher and the Generic Host stops on a background service's exception.

- ISessionRepository.ResolveOwnerAsync: the row the session started under when it predates the session or
  holds its executable, else the row that holds the executable now, else FinalizeStatus.GameRemoved.
- The write re-checks the row inside its transaction (SessionOwnerMissingException), never the FK error.
- PartialRecovery never throws: an unfinalizable file is quarantined as <guid>.partial.failed.
- Log lines name the session, the game and the executable; the host logs into agent-*.log (AddSerilog).

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-23 02:24:58 +07:00
poli0981andClaude Fable 5.1 97c3feb648 release: 0.1.0-beta.5 - the CHANGELOG section, the accuracy block re-dated, README's release lines, HANDOFF's status pointer (#218)
The fifth pre-release: the guard override is gone and a finding turns hooking off (#215), Tier 2 exists
(#216), a drive that changes its letter is followed (#217). Same unsigned installer; schema 0008; the
Legal Gate opens once (Disclaimer 2.5, EULA 1.2).

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-22 14:54:16 +07:00
poli0981andClaude Fable 5.1 480b30ae0d feat: a drive that changed its letter is the same executable - the row follows it with consent, block and detection kept (#217)
Owner ask 2026-09-22 (D24). The owner's external drive came back as H: instead of D: and every game on it
read "executable unreadable"; a game launched from H: matched its row by file name only and ran as a
stranger. ExecutableRelocator finds the same file - same size, same mtime, exactly one other drive-letter
root - and moves the row to it through IGameRepository.RelocateExecutableAsync, whose write requires the
same size and mtime again. Asked by the 15 s sweep (relocate, then scan in the same pass), by the watcher
on a file-name match (adopt, so the session is the row's), and by the enable-hooking command before it
says unreadable. The game's page says when its executable is not where the entry points.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-22 11:46:31 +07:00
poli0981andClaude Fable 5.1 3f95c4b9fb feat: Tier 2 exists - a refused session is held, unhooked, until the game exits; hooking-off is decided before the process is opened; Steam tools are not games (#216)
Owner ask 2026-09-22 (D23): "Tier 2 does not work - what does it record, and show it." Every refusal
returned within a second and the 30 s minimum discarded it. CaptureSession.HoldUnhookedAsync now keeps a
refused session open, ticking the telemetry poller through the observer, until the target exits (a pinned
liveness, or the executable's name through ITargetResolver.IsRunning when the loop never opened the
process). The row lands as T2 with its sensor aggregates and the reason; the summary says why
(Formats.Tier2Reason over capture_notes). The operator host sets HoldUnhooked = false.

RunAsync reads the consent record before resolving the target: a hooking-off row - merely added, blocked,
auto-disabled - is never opened, so an elevated utility in the library (Borderless Gaming) is a quiet
Tier-2 row rather than the anti-cheat-driver notice. SteamLibrarySource.KnownTools keeps the next import
from adding one. PartialRecovery no longer reads a tick as proof of a hooked session.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-22 11:35:42 +07:00
poli0981andClaude Fable 5.1 7c67f4610d fix: the guard override is withdrawn; a finding turns the game's hooking off at session start and at the re-scan (#215)
Owner decision 2026-09-22 (D22). The per-game override of 2026-09-21 is removed entirely: the native
acknowledged entries and reason 28, FlGuardIsJudgement, the SetGuardBypass message, the App's card and
dialog, the session mark and export line, the Safety_Bypass_* strings, and schema 0007's five columns
(0008 drops them). CLAUDE.md rule 2 reads "there is no override" again; Disclaimer 2.5, EULA 1.2.

In its place: an anti-cheat named in the game itself (its process, its title lists, its folder) is written
to the row as the pre-scan always wrote it, now also when the guard finds it at a session's start or at
the 30 s re-scan (AntiCheatVerdict.IsFindingAboutTheGame, CaptureSession.TurnHookingOffAsync). A
machine-wide driver or service refuses that session only. CaptureRefused / SafetyUnhook carry
hookingTurnedOff and the notice says so; capture_notes carry hooking-turned-off=.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-22 11:14:24 +07:00
poli0981andClaude Fable 5.1 b9c11e4a34 docs: beta.4's notes named a cause they had no evidence for - corrected against Windows' own event logs (#214)
The owner reported that the external USB drive holding the Steam library had a loose cable on 2026-09-21. The System
and Application logs agree: disk resets and paging errors on that drive from 20:42, two restarts of the PC (20:57,
21:02), start_protected_game.exe and GF2_Exilium.exe both ending 0xc0000006 (in-page I/O error).

Withdrawn: the [0.1.0-beta.4] Updating note said an install over a running Agent had half-replaced the folder and
caused three failed starts. Nothing was installed between those failures and the start that worked; they are
unexplained. Corrected in place, and HANDOFF says it was a guess that got published.

Explained: the GF2 SafetyUnhook at 21:45 coincides with that game crashing on the failing drive.

Unchanged, with the evidence stated: TargetUnreadable (Easy Anti-Cheat's log says "successfully loaded in-game" the
second the resolver found a process it could not open), the two App instances at 21:07, the English safety texts.
FrameLedger injected nothing into ELDEN RING in any run.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-21 23:27:06 +07:00
poli0981andClaude Fable 5.1 dd3bf3634f release: 0.1.0-beta.4 - the CHANGELOG section, the accuracy block re-dated, README's release lines, HANDOFF; a wrong date corrected (#213)
CHANGELOG: [Unreleased] becomes [0.1.0-beta.4] - 2026-09-21 with a user-facing summary and the update notes (quit the
App and end the Agent before installing; the Disclaimer moved to 2.4; no schema change). The accuracy block and its two
embedded copies name 0.1.0-beta.4. HANDOFF gains decision D21 (a process an anti-cheat driver protects is
TargetUnreadable and the bypass stops there - rule 3, not rule 2), four things found and NOT fixed, and three traps.

#212 dated its comments and docs 2026-09-22; it was written and merged on 2026-09-21. Fourteen files corrected, dates
only. VERSION stays 0.1.0.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-21 22:46:20 +07:00
poli0981andClaude Fable 5.1 a670c26b0e fix: one App per data folder; safety texts follow the UI language; the bypass page says what is true; a protected process is TargetUnreadable (#212)
All four from the owner's installed beta.3 (a screenshot of ELDEN RING's page under the guard bypass, and the day's logs).

Single instance. Nothing stopped a second App: the log shows two started 360 ms apart - two shells, two tray icons, a
second log file, both writing one ledger. Services.SingleInstance claims the data folder in Program.Main (named mutex +
named event keyed on a hash of the folder, after Velopack's hooks, before any window); a later start sets the event and
exits 0, and the first brings its window forward through ShellHost.Reveal. --diag never claims.

Language. FrameLedger.Shared's Strings was never given the UI culture and fell back to the thread's, which the App's
async start does not pass on to later dispatcher work: a Vietnamese UI showed the consent dialog, the refusal notices
and the whole guard-bypass card in English. App.ApplyCulture sets both families.

The page. Under a bypass it printed "Hooking is disabled for this game: ..." beside a hooking switch that was on. The
finding stays and reads "The guard found: ... You chose to bypass it for this game".

The result. With the bypass on, ELDEN RING under Easy Anti-Cheat produced no session and a toast reading
"InjectFailed: TargetAmbiguous". The anti-cheat's driver closes the game's process to other programs; the resolver
could read no candidate and called that ambiguous. It is SessionEndReason.TargetUnreadable now, classified as a
refusal, and reaches the user as a persistent notice saying nothing was injected or measured, that the bypass does not
change this, and that FrameLedger will not work around another product's protection (rule 3; nothing here attempts
to). The bypass disclosure says so before it is accepted (guard-bypass-dialog/2) and so does DISCLAIMER 2A (2.3 -> 2.4).
The refusal notices no longer say "there is no way to override this".

Also: the Agent's session log line names what the guard said when it was not a plain allow - a SafetyUnhook on the
owner's machine left no trace of which finding fired.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-21 22:19:39 +07:00
poli0981andClaude Fable 5.1 a10b281074 release: 0.1.0-beta.3 - the CHANGELOG section, the accuracy block re-dated, README's release lines, HANDOFF's decisions and traps (#211)
CHANGELOG: [Unreleased] becomes [0.1.0-beta.3] - 2026-09-21 with a user-facing summary and the update notes (schema 7;
the Legal Gate re-opens; a Steam row created for the wrong executable is not rewritten). The accuracy block
(legal/ACCURACY.md and its two embedded copies) is dated 2026-09-21, names 0.1.0-beta.3 and says "beta" where it said
"pre-alpha". README's install line names the three pre-releases. HANDOFF gains what no other file carries: decisions
D18-D20 (the one guard override and its fixed shape; the derived DLSS preset still not shown; the bug bundle does not
get the machine's hardware), what the owner still owes, and the traps this train paid for. VERSION stays 0.1.0.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-21 19:44:59 +07:00
poli0981andClaude Fable 5.1 a3516efe97 docs(legal): the terms an end user needs - beta, minimum requirements, the guard bypass; stale docs; two flaky tests (#210)
Terms. legal/DISCLAIMER.md 2.2 -> 2.3 and legal/EULA.md 1.0 -> 1.1, so the Legal Gate opens once after the update:
- section 0: this is pre-release (beta) software; it certainly still has bugs, and the developer is not responsible for
  incidents that result;
- section 2A: the per-game guard bypass, entirely at the user's own risk, no responsibility and no liability;
- section 4A: the PC must meet at least the minimum requirements the game's developer or publisher states - read them
  first; problems below them, or on unstable, overclocked or overheating hardware, are the user's, not the developer's;
- section 7A: back up your own data; builds are unsigned - download from the project's Releases page only and verify the
  hash; no affiliation with any game, platform or vendor; numbers are for your own information.
The first-run Legal step shows a short plain-language summary of those points (en/vi/ja) above the documents, which
remain the terms. legal/ACCURACY.md and its two embedded copies no longer say "There is no override anywhere", and say
that injection happens past the guard or past the user's own acceptance of a game's bypass.

Stale docs. THIRD_PARTY_NOTICES gains the test-time row it never had (xUnit.net v3 4.x under Apache-2.0,
FluentAssertions 7.x and why it is pinned, NSubstitute, coverlet, Test.Sdk, Catch2). 16_WPFUI_SYNTAX named a TFM this
repository never built. 14_TESTING still called Catch2 and the blocked toggle future work. README's status line said
"pre-alpha" beside three pre-releases. build.ps1 "skipped" the coverage and rules gates when their tools were missing,
which its own header calls worse than no gate - a missing tool fails now.

Two flaky tests, both seen on PR #209's CI and neither touching what that PR changed: the native-log test slept a
fixed 1500 ms and read the log between two UNHOOK_RESTORED lines (it polls for the last one, bounded at 10 s), and
ParentDumpTests dumped a child it had started microseconds earlier and got ERROR_PARTIAL_COPY (it retries while the
child finishes loading, bounded at 5 s).

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-21 19:27:54 +07:00
poli0981andClaude Fable 5.1 234962f0e7 feat(safety): a per-game "bypass the anti-cheat guard" switch, at the user's own risk (owner decision 2026-09-21) (#209)
The owner asked for a mode that skips the guard behind a warning the user MUST accept first, and chose the per-game
form. CLAUDE.md rule 2 said "There is no override switch. Do not add one"; it is amended with this, and the amendment
is the constraint list below. Rule 3 is untouched: the bypass changes WHETHER FrameLedger injects, never HOW.

What it is. A switch on the game's page, off by default, never global: no setting, no CLI switch, no environment
variable, no field in rules/detection-rules.json (the schema still rejects one). It is a recorded human act - its own
disclosure, accepted by a ticked acknowledgement AND the typed phrase BYPASS, stamped by the Agent with the
disclosure's version (schema 0007: games.guard_bypass_at / _disclosure_version) through IGuardBypassStore, a port of its
own. It is keyed on the executable like consent, and ends when hooking is turned off or the executable changes.

What it overrules: the guard's JUDGEMENT (blocklist matches, the suspicious-module rule, scans that could not look,
unusable rules, the PreviouslyBlocked latch). What it never overrules: the kill switch, a game merely added, a missing
consent, a foreign payload, a 32-bit target, a failed injection, and a Vulkan title the guard refuses.

Native. FlGuardedInjectAcknowledged / FlGuardedInjectWhenReadyAcknowledged live in fl_guard.cpp, the one chokepoint
file. They run EVERY check, verify the payload, use the same LoadLibraryW primitive, and answer
AllowedUnderUserBypass (28) with the family and signal of what was found - never kAllow, so Allowed() stays false for
every caller written before it. IsGuardJudgement is the list; FlGuardIsJudgement exports it for the mirror test.

Managed. AntiCheatVerdict.IsAllowedUnderBypass, asked by name in CaptureSession only. HookRequest gains the fifth
input, built in FromConsent from a stored record that names its disclosure, dropped on a fingerprint mismatch.
HookedCaptureGate checks it after the kill switch, enablement and consent. The port's acknowledged methods DEFAULT to
the hard gate. GuardSupervisor still scans and still ticks under a bypass; a judgement is kept, counted and does not
unhook, a fact still does. SetGuardBypass re-checks everything the App checked; SetHookEnabled under a recorded bypass
still writes the finding and stamps consent beside it.

Afterwards. sessions.guard_bypassed / guard_bypass_family / guard_bypass_signal; the sessions list, the summary, the
CSV header and the JSON export say so. A session recovered from a .partial does not carry the mark (recorded limit).

Docs with it: CLAUDE.md rule 2, 19_SAFETY (the spec), 02_SPEC FR-2.7, 06, 07, 08, 14, 20_OPEN_QUESTIONS, SECURITY.md,
and tools/chokepoint-check.ps1's own description. Safety strings in en/vi; ja ships the English until a reviewer signs.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-21 18:58:29 +07:00
poli0981andClaude Fable 5.1 9a14304a41 feat: CPU load, memory and (elevated) CPU temperature; per-game trend metrics; Settings shows this PC (#208)
* feat: CPU load, memory and (elevated) CPU temperature are measured; trend metrics per game; Settings shows this PC

Telemetry. sessions.avg_cpu_load / avg_cpu_temp / max_cpu_temp / avg_ram_mb and the cpu_load / cpu_temp / ram_mb
series were in schema 0001 with no producer. TelemetryPoller now reads the machine beside the GPU on the same 1 Hz
tick through ISystemTelemetrySource, and the reading rides each TelemetrySample as a SystemReading - outside GpuSample,
whose capability bits and layer attribution mean nothing here. Two unprivileged Win32 calls, no process opened:
GetSystemTimes (time busy across every logical processor; the first tick has no interval and is null, never 0) and
GlobalMemoryStatusEx. CPU temperature is the one privileged reading: a separate CPU-only LibreHardwareMonitor Computer,
opened only when the Agent is elevated AND PawnIO is installed. It is UNMEASURED on real hardware (20_OPEN_QUESTIONS
M10 carries the one session that settles it). HelloAck.cpuTempAvailable reports those two conditions instead of a
constant false. The .partial sensor chunk carries the three values in bits 12-14 of its existing presence mask, so an
older file reads back with an empty reading. No migration; older sessions keep their nulls.

App. The game page's Trend tab gains average GPU load, average GPU power, max VRAM (game), average CPU load, max CPU
temperature, average memory in use and the xFG factor - a factor that is its session's steady state (rule 6) is a
partial point: left out by default, drawn marked when mid-session changes are included. The Sensors chart draws CPU
temperature, CPU load and system memory; Compare gains three rows; the session summary gains GPU and CPU cards and the
session's hardware snapshot under its header; the live card carries cpuLoadPct. Settings > System states this PC as a
session's snapshot would record it (the same IHardwareSnapshotSource), with Copy; nothing is sent anywhere. --diag
prints it; the bug bundle's sysinfo.json is deliberately unchanged (its keys are the issue link's prefill).

legal/ACCURACY.md and its two embedded copies say what is and is not measured about the processor.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

* style: one property per line in the trend test's object initialiser

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-21 18:17:36 +07:00
poli0981andClaude Fable 5.1 366b0467bc build(native): FL_BUILD_ID falls back to a shorter form when the long one does not fit, so a dirty tree configures (#207)
After the first tag `git describe --always --dirty --abbrev=12` yields `v0.1.0-beta.2-2-g<12 hex>-dirty` on any tree
with an uncommitted change: 35 characters against FlShmHandshake::buildId's 31. Every local CMake configure of a dirty
tree was fatal, and the recorded workaround was "commit before you build" (2026-09-17, hit again 2026-09-21).

The id is a version-skew signal, not a provenance guarantee, so when the long form does not fit the configure retries
with `--dirty=+ --abbrev=8` (`v0.1.0-beta.2-2-gd3e74988+`, 26 chars). A release is a clean checkout at a tag and never
takes the fallback. Still too long after that is still fatal, for the reason the check exists.

Verified: a deliberately dirtied worktree two commits past the tag configured with
`FL_BUILD_ID = v0.1.0-beta.2-2-gd3e74988+` and built; before this it stopped at the FATAL_ERROR.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-21 17:56:45 +07:00
poli0981andClaude Fable 5.1 985ecba12e fix(app): DLSS is named where the driver reports it, instead of "Unknown upscaler"; a measured preset is its name (#206)
Most DLSS titles call NGX directly, and no NGX hook may exist (the SDK's licence, 20_OPEN_QUESTIONS), so the hook
runs and sees nothing: `unknown`. FSR was named because its dispatch is hooked. The NVIDIA driver does report the
feature per process; the Agent has stored that on every session since P2 (sessions.upscaler_driver_reported) and the
capture host has printed it since 2026-09-06. Nothing under FrameLedger.App read it.

Formats.Upscaler(token, quality, driverReported) is 03_METRICS' ladder in one place: a hook's name outranks
everything and takes its measured preset; where no hook named one and the driver reports NGX super resolution created
and evaluated, the text is "DLSS (driver-reported)" - attributed, identity only, never a quality; otherwise the
token's own text, and `unknown` now reads "Upscaler not identified". The library, the session summary, the game page
and the live card (SessionProgress.upscalerDriverReported, optional) all use it. Sessions already recorded show it
too, because the column was always written.

Domain.Metrics.UpscalerNames, promised by 03_METRICS from the start: the one produced quality byte (sl::DLSSMode via
Streamline) is its preset's name - "DLSS Balanced", not "DLSS 2". A value with no name is shown as stored. A preset
derived from the render scale is still not shown (HANDOFF 7a, an owner decision not taken).

Nothing native changed; no hook was added.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-21 17:41:26 +07:00
poli0981andClaude Fable 5.1 d3e74988a7 fix(app): the Games card's tags are readable in the light theme, and a Steam import picks the game, not its browser helper (#205)
Badges. The platform and engine tags on the Games card (and the edit dialog's "Detected" marker) were
ui:Badge Appearance="Secondary". WPF UI 4.3.0's Secondary trigger repaints the background only and keeps the default
badge's on-accent foreground, so in the light theme they were near-white text on a near-white fill: two empty boxes
beside a readable hooking pill (owner's screenshot, 2026-09-21). They are the App's own TagPill + TagPillText now, the
pair ContrastTests already measures in both themes, and ContrastTests refuses a Secondary badge in App XAML.

Steam import. Steam names no executable, so the import guessed "the largest non-helper". On GIRLS' FRONTLINE 2:
EXILIUM that was GF2_Exilium_Data\Plugins\ZFGameBrowser.exe (1,082,944 bytes), not the 675,392-byte Unity player, and
because the watcher, consent and the gate are keyed on the executable path, hooking enabled on that row could never
match the game - while the same game added by its exe worked. ExecutableLocator now ranks: the engines' own layouts
(Unity X.exe beside X_Data; Unreal *-Win64-Shipping.exe), then a name matching the install folder, then size. It skips
X_Data\Plugins and redistributables folders, knows browser/webview/subprocess/analyzer/vconsole as helpers, and walks
four levels. Verified read-only over the owner's Steam library: GF2, Red Dead Redemption 2 (was the Rockstar launcher
installer), Counter-Strike 2 (was vconsole2.exe), Rune Factory, Dying Light: The Beast (was nothing).

Change executable. The game page shows the row's executable and re-points it: IGameRepository.ChangeExecutableAsync
leaves the row as a new game would be (hooking off, no consent, pre-scan not run), never clears a block, refuses a path
another row owns; the App revokes consent over the pipe first, as removal does. Rows an earlier import created are
not rewritten.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-21 17:19:03 +07:00
poli0981andClaude Fable 5.1 34e405fe08 deps: xUnit.net v3 4.0.1 (as xunit.v3.mtp-off) and the other outdated packages; one test race the new scheduler found (#204)
xunit.v3 3.2.2 -> 4.0.1, referenced as xunit.v3.mtp-off with xunit.runner.visualstudio 4.0.0. 4.0 makes Microsoft
Testing Platform v2 the default of the plain package; build.ps1's gates are VSTest-shaped on purpose (the XPlat Code
Coverage collector, the results.trx the struct-mirror gate and the 25-minute wall clock read), so the projects take the
same 4.x framework through the variant xunit publishes for that.

Also Dapper 2.1.86, Microsoft.Data.Sqlite / Microsoft.Extensions.Hosting / System.Diagnostics.EventLog 10.0.12,
CsWin32 0.3.333, Roslynator 5.0.0, Meziantou.Analyzer 3.0.266, Microsoft.NET.Test.Sdk 18.10.1, NSubstitute 6.2.0.
WPF-UI [4.3.0] and FluentAssertions [7.2.2] stay pinned, with their reasons. legal/licenses/nuget regenerated.

The first gate run on 4.0.1 failed StringsTests.TheCulturePropertyOverridesTheThread: eight App.Tests classes write
the process-wide Strings.Culture and ran in parallel. They share one collection now; five runs green, then the gate.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-21 16:58:22 +07:00
poli0981andClaude Opus 5 e2568eb312 release: 0.1.0-beta.2 — the CHANGELOG section, the accuracy block re-dated with the steady state, README's release lines (#202)
The commit the second tag points at (13_CI_CD §Branch & release policy; VERSION
still reads 0.1.0).

- CHANGELOG: the [Unreleased] entries move as written under
  `## [0.1.0-beta.2] - 2026-09-17` — the header's rule from the second tag on —
  after a short account of what changed for a user and three update notes: end
  every Agent before installing (an elevated one needs an elevated Task
  Manager), the ledger migrates to schema 6 without re-aggregating stored
  sessions, and sessions recorded while several Agents ran appear once per
  Agent. release-notes.ps1 extracts 10.6 KB.
- legal/ACCURACY.md: dated 2026-09-17, "latest pre-release is 0.1.0-beta.2",
  and the frame-generation bullet says what a finished session's factor is
  when the state changed: the steady state's, always with its share
  (03_METRICS §The steady state, #198). Re-embedded verbatim in README.md and
  legal/DISCLAIMER.md (accuracy-check green). The Disclaimer's version stays
  2.2, as it did for 0.1.0-beta.1: the block is re-dated, the terms are not
  changed.
- README: the install and status lines name the latest pre-release.

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-17 15:33:01 +07:00
poli0981andClaude Opus 5 402e98ab56 fix(agent): one Agent per data folder — an App started as administrator no longer starts an Agent per connect round (#201)
On the owner's machine the installed 0.1.0-beta.1 ran four FrameLedger.Agent.exe
--serve. The App opened at 10:04 was elevated (the three Agents it started run
at High integrity; the first, at Medium); the pipe of the Agent already serving
refused it, AgentConnection swallowed the refusal, took it for an absent Agent
and started another on each round, 17 s apart. Nothing in the Agent noticed the
first — 01_ARCHITECTURE §Lifecycle specified a single instance through named
mutexes and it was never built — so every game launched in the next hour was
injected, read and recorded by all four (four sessions with equal frame counts
per launch), and the three extras logged "accept failed" every 260 ms for four
hours, 2 MB each.

Why the pipe refused: PipeOptions.CurrentUserOnly compares the pipe's owner
with the client token's default OWNER (dotnet/runtime ValidateRemotePipeUser),
and an elevated token's default owner is BUILTIN\Administrators — the log files
the elevated Agents created are owned by it, the unelevated ones' by the user.

- Infrastructure.Startup.AgentInstanceLock: a named mutex per data folder
  (Local\FrameLedger.Agent.<hash>), held and never waited on; access denied
  counts as held. --serve and the console's capture / launch / recover claim it
  before logging, rules and the ledger; a second process exits 10 with one line.
- App: AgentLauncher.RunningAgent probes the claim and the last Agent it started
  (watched until exit, exit code logged); AgentConnection starts nothing while
  one is up, and logs why a connect failed once per distinct reason.
- Pipe: the SDDL states the owner (O:<user>), and PipeClient checks the owner
  against its token USER before writing a byte
  (PipeAccessControl.RequireOwnedByCurrentUser).
- PipeServer: an instance that cannot be created backs off 250 ms -> 10 s and is
  logged once per streak with its Win32 error — read with GetLastSystemError,
  since CsWin32 0.3.298 declares CreateNamedPipeW without SetLastError and
  GetLastPInvokeError read 0.
- Tests: AgentInstanceLockTests; OneAgentPerDataFolderTests (the shipped binary
  against a claimed scratch folder: exit 10, nothing created);
  AgentConnectionTests (an Agent that is up and does not answer is never started
  again; the real launcher sees the claim); PipeServerClientTests (the owner;
  an Administrators-owning token trusts its user's pipe and refuses an
  Administrators one, on CI's elevated runner; the backoff logs once, error 231).
- Docs: 01_ARCHITECTURE §Lifecycle, 07_IPC §C and §Client behavior, 08_UI,
  12_BUILD, 20_OPEN_QUESTIONS §G (a second reader on one ring from another data
  folder is still possible), CHANGELOG.

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-17 15:03:12 +07:00
poli0981andClaude Opus 5 fcf91acc40 fix(app): closing the App no longer ends in a Fatal error — the tray is removed on its own thread (#199)
The installed 0.1.0-beta.1 logged "the calling thread cannot access this object
because a different thread owns it" from TrayHost.Dispose and exited with code 1
on close. The App waited with WaitForShutdownAsync, which resumes on the thread
pool and stops the hosted services there, so the tray icon — a WPF object whose
disposal unsubscribes Application.Exit — was removed off its thread; TearDownAsync
then stopped every service a second time.

- App.RunAsync waits for the stop request on the dispatcher; TearDownAsync
  stops the host once, from the UI thread.
- TrayHost.Dispose marshals to the icon's dispatcher from any thread (bounded
  at 5 s; skipped once the dispatcher has shut down).
- TrayHostTests disposes a real tray icon from a pool thread while the UI thread
  pumps: red on the old code with that exception, green now; skipped where the
  session has no notification area.

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-17 14:51:20 +07:00
poli0981andClaude Opus 5 63cec83e69 fix(diagnostics): a crash dump is written by a child process, so it can no longer hang the process it describes (#200)
* fix(diagnostics): a crash dump is written by a child process, so it can no longer hang the process it describes

FrameLedger.Infrastructure.Tests hung about one run in eight (it cancelled the
first tag's release run after 58 minutes). The verbose reporter of a hung run
showed thirteen tests started and none finished, one of them
CrashDumpWriterTests.WritesAMinidumpOfThisProcess — which, like the product's
crash path in the App and the Agent, called MiniDumpWriteDump on the calling
process. That suspends every other thread of it; one holding the heap or
loader lock deadlocks the dumper and the whole process freezes. Forty runs
without that test: no hang.

- CrashDumpWriter.TryWrite starts FrameLedger.Agent.exe --write-crash-dump
  <file> and waits up to 30 s; a missing, failed or slow helper is a null path
  and one line, as before.
- ParentDump (the helper) dumps its PARENT with the same flags. It takes no pid
  and refuses unless the parent is still running, started before it, and has
  its image in the helper's own directory — the App or the Agent, never a game
  (CLAUDE.md rule 4). The self-contained install ships no createdump.exe.
- The Agent answers --write-crash-dump before logging, rules and the ledger.
- build.ps1: --blame-hang did not stop the hung xUnit v3 executable, so dotnet
  test runs under a 25-minute wall-clock limit, kills the tree on expiry, and
  names the test projects that wrote no results.trx (exercised locally: success,
  timeout-kill with nothing left alive, failure exit).
- Tests: ParentDumpTests (a real minidump of another process; which parent is
  ours), CrashDumpWriterTests (failing and missing dumper), CrashDumpHelperTests
  (the shipped Agent dumps the test process from outside; refuses a System32
  parent; the flag's surface). 40 runs of the suite with them: no hang, no
  failure.
- Docs: 10_LOGGING §Crash handling, 12_BUILD Agent flags, 13_CI_CD tally,
  CHANGELOG.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(diagnostics): a failed dump names dbghelp's error instead of 0

CsWin32 0.3.298 declares MiniDumpWriteDump without SetLastError, so
Marshal.GetLastPInvokeError() read whatever an earlier call left - 0 when
measured on CreateNamedPipeW the same day (#201). The code is read with
GetLastSystemError at once, as CsWin32's own wrappers do, and printed as the
HRESULT dbghelp reports. ParentDumpTests: dumping a process that has exited
fails, leaves no file, and the line carries a non-zero code.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(persistence): the migration mutex is the ledger file's, so a hung process no longer fails every other ledger

MigrationRunner took Local\FrameLedger.Ledger.Migrate for every ledger. On #199's CI
run Infrastructure.Tests froze (the in-process minidump this PR removes) while
one of its tests held it, and seven App and Agent tests - each on its own
scratch ledger - failed after 30 s with "another process has been migrating
the ledger". The name is the file's now: Migrate.<SHA-256 of the full path>,
MigrationRunner.LockNameFor.

MigrationLockTests: names differ per file and ignore case; a thread holding
another ledger's lock does not delay opening this one (on main it waited 30 s
and threw). 06_DATA_MODEL §Migrations, CHANGELOG.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-17 14:39:00 +07:00
poli0981andClaude Opus 5 3ecf36f71f feat(fg): a session whose frame-generation state changed publishes its steady state, with its share (schema 0006) (#198)
* feat(fg): a session whose frame-generation state changed publishes its steady state, with its share (schema 0006)

The owner saw the live card show the FG factor all session and the finished
session show "factor not counted" most of the time, and suspected the path from
the hook to the UI. The path is whole: the stored per-frame counts of all nine
hooked sessions of 2026-09-16 read 2.00 / 3.00 / 4.00 inside gameplay. The live
card looks at five seconds; the stored row looked at the whole session, split
it in eight and refused it when one bucket departed — and every real session
opens with a splash, a menu or a loading screen. The refusal is right (Wukong
averages to 2.22; its gameplay ran x4.1) and stays; the gameplay's number is no
longer thrown away with the average.

- Domain.Metrics.FgSteadyState: five-second windows (the live card's own), the
  ACTIVE windows agreeing within 10 % that hold the most time, published at
  >= 10 s and >= 10 % of the presenting time, with Native and Displayed counted
  over the state's own windows. Only behind a NonUniform refusal; never beside
  a published session factor; never for an unattributed or saturated set.
- FgWindow: BucketTolerance 25 % -> 10 % (a x3-then-x4 session published 3.69;
  the one published session read x2.04 for a gameplay of 2.00);
  MultipleStreams refuses only when the chains' samples INTERLEAVE — Onimusha
  recreates its swapchain on entering gameplay and was refused on every session.
- Row: fg_factor_scope ('session' | 'steady') and fg_steady_share, schema 0006;
  fg_refusal and its detail stay beside a steady factor. FgLadder: a steady
  state without an identity is ActiveUnidentified.
- UI: the generated shape with the chip "x2.0 FG · 75%" — the share is never
  omitted — and a tooltip saying why there is no session-wide factor.
- Replayed over the owner's nine sessions through the real FgWindow: eight
  publish (Onimusha x4.00 60 -> 240, Lies of P x2.00, Hell Is Us x3.03, Cronos
  x2.00 225 -> 451, Wukong x4.11); the ninth had nine seconds of gameplay.
- CLAUDE.md rule 6 amended (owner decision 2026-09-17). Docs: 03_METRICS §The
  steady state, 08_UI, 06_DATA_MODEL, CHANGELOG. Two strings en/vi/ja.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

* fix(fg): FgSteadyState drops its unreachable branches and checks its arguments (coverage 94.7 % -> 100 %)

CI's coverage gate refused the steady-state PR: FgSteadyState at 94.7 %
against the 95 % per-calculator floor. The misses were branches that cannot
run: an empty state after re-drawing around the pooled factor (a weighted mean
of members within 10 % of the centre always has a member within 10 % of
itself), a zero presenting time (a valid start always yields a slice), a
before-origin QPC and an infinite slice factor that the active check
short-circuits before reading. They are gone; an out-of-range start throws
instead of returning null, and a direct-call test covers the arguments and the
no-active-window case. Behaviour for every reachable input is unchanged:
Domain 165 and Application 246 green, 100 % line coverage on the class.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-17 11:51:42 +07:00
poli0981andClaude Fable 5.1 d8815b5b73 docs: the first tag ran — 13_CI_CD §release.yml, 12_BUILD sizes, 15_ROADMAP §P5, CHANGELOG (#197)
v0.1.0-beta.1 on becc208, run 35111939019: cancelled once by a test hang
(Infrastructure.Tests, 58 min, no test named), green on the re-run in 11 min;
the pre-release exists with the section's notes and SHA256SUMS. The sentences
that said the workflow had never run under a tag are struck where they sit.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-16 23:25:25 +07:00
poli0981andClaude Fable 5.1 f631c43c51 chore(build): dotnet test names a hung test and fails after 15 minutes (--blame-hang) (#196)
The first tag run sat in Infrastructure.Tests for 58 minutes — every other
suite green, the same suite 42 s an hour earlier — until the 60-minute job
limit cancelled it, and the log named nothing. --blame-hang with a 15-minute
timeout and a mini dump makes the next hang a named failure. 13_CI_CD's tally
records the run.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-16 23:12:33 +07:00
poli0981andClaude Fable 5.1 becc208d8f release: 0.1.0-beta.1 — the CHANGELOG section, the accuracy block's first sentence, README's release lines (#195)
The commit the first tag points at (13_CI_CD §Branch & release policy;
VERSION already reads 0.1.0).

- CHANGELOG: `## [0.1.0-beta.1] - 2026-09-16` is a written summary of what the
  pre-release is and is not — the moved entries would be 370 KB against a
  125,000-character release body — and the entries stay below it verbatim
  under `## Ledger before 0.1.0-beta.1`, where release-notes.ps1 stops
  (4.5 KB extracted). The header's "this file still has no heading" note is
  struck and the reason recorded. `[Unreleased]` is empty.
- legal/ACCURACY.md: "unreleased: no tagged build" becomes "first pre-release
  is 0.1.0-beta.1", re-embedded verbatim in README.md and legal/DISCLAIMER.md
  (accuracy-check green).
- README: the install section's "no release yet" line and the status line
  name the pre-release.

Rehearsed on main by release.yml's dry run (run 35107110773): the gate,
publish (252 MB tree), licences, tree assertion, vpk (Setup.exe 110 MB,
portable zip and full nupkg 105 MB) and checksums all passed; only the
Release step was skipped, as designed.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-16 21:55:31 +07:00
poli0981andClaude Fable 5.1 e0758e6dae fix(tests): the capture-host suite waits for a killed host to exit before reading or deleting its files (#194)
Two CaptureHost flakes CI kept producing had one cause: Kill() returned before
the killed host had released its files, so the kill-and-recover case opened a
.partial the dead process still held ('being used by another process'), and
Dispose's ledger delete silently failed and left a consent record for the
refusal case to find. Kill waits for exit (15 s, asserted); DeleteHostLedger
retries. 13_CI_CD's flake tally records it.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-16 21:42:35 +07:00
poli0981andClaude Fable 5.1 e69fdf30ac docs(legal): the legal documents say what the software does, in release form (EULA 1.0, Disclaimer 2.2, Privacy 2.2) (#192)
- EULA 1.0, Disclaimer 2.2, Privacy Policy 2.2: the -draft suffix (which
  legal_acceptance.version recorded) and the "Draft for review" banners are
  gone; the Legal Gate shows all three again.
- Privacy Policy §2 listed three requests the software has never made (a
  weekly safety-list update, a weekly rules update, an opt-in Steam lookup)
  under an audit note since 2026-08-04; 2.2 keeps the two real rows (Velopack
  update check and download), says there is no other request, and records the
  removal as history. §1: no cover art (no such feature); log retention as the
  code has it (7 days App, 14 Agent).
- Disclaimer: the 25-line audit block inside the accepted text moved unchanged
  to docs/legal-drift-history.md; a five-line pointer explains how §4 is kept
  true (ACCURACY.md + accuracy-check); the contact footer is added.
- Third-party notices: the IGCL/ADLX box ticked with its check named
  (license-check §1); the About-tab box says not built and not a gate for the
  first pre-release; the trademarks pointer reads §6.
- README §Privacy collapsed to one accurate paragraph.
- Settings: the privacy.online_metadata toggle is no longer shown (no code
  makes the request); the setting stays reserved (06_DATA_MODEL, 08_UI).
- 20_OPEN_QUESTIONS §S20: a feed lands as a new policy version, not as rows
  kept in advance. CHANGELOG.
- ACCURACY.md's "unreleased" sentence deliberately untouched: it is rewritten
  in the tag commit, where it becomes false.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-16 21:29:23 +07:00
poli0981andClaude Fable 5.1 96b564ce77 chore(release): a release rehearsal (workflow_dispatch dry run), SECURITY.md, and an honest hygiene checklist (#191)
* chore(release): a release rehearsal (workflow_dispatch dry run), SECURITY.md, and an honest hygiene checklist

P5 prep. release.yml has never been exercised by a tag; everything after the
version gate had only run by hand on one machine.

- release.yml: `workflow_dispatch` with a `version` input runs the identical
  job — gate, publish, runtime licences, the published-tree assertion,
  `vpk pack`, checksums, the artifact (`release-<version>-dry-run`) — and skips
  only `gh release create`; no tag is made. A missing `## [x.y.z]` section is
  a warning with placeholder notes in a rehearsal and stays a stop on a tag,
  because that section is written in the tag commit and a rehearsal precedes
  it.
- SECURITY.md: the private route for a vulnerability (GitHub's private
  reporting when enabled, else e-mail), the public Safety gap form for an
  undetected anti-cheat, what not to include, the response intent stated as an
  intent. ISSUE_TEMPLATE/config.yml points a vulnerability at the private
  route; README links both.
- 13_CI_CD §Repo hygiene checklist rewritten: the in-tree items were done and
  unticked, the first box asked for caller stubs the file's own first paragraph
  rejects, the rest are GitHub settings only the owner can set. §release.yml
  documents the dry run. 14_TESTING: the Velopack-delta row is reachable from
  the second release. 15_ROADMAP §P5, CHANGELOG.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

* fix(release): a handled dry-run failure clears LASTEXITCODE (the runner's pwsh wrapper exits with it)

The first rehearsal printed the warning for the missing CHANGELOG section and
then failed anyway: GitHub's pwsh step ends with 'exit $LASTEXITCODE', which
release-notes.ps1 had left at 1.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-16 21:13:38 +07:00
poli0981andClaude Fable 5.1 1ff501a2d5 feat(fg): the "factor not counted" tooltip says which bucket and by how much (sessions.fg_refusal_detail, schema 0005) (#190)
The owner's Dashboard showed "DLSS-G active — factor not counted" on Hell Is
Us, Black Myth: Wukong, Cronos and Onimusha. Three refused non_uniform (one of
eight equal-sample buckets departed > 25 % from the whole, or held no tokens —
a menu, a loading screen, an alt-tab inside a whole play session), one
multiple_streams (a second swapchain); the tooltip could only repeat the kind.
FgWindow had computed the bucket, its ratio and the window's; the aggregator
kept only the kind.

- Application.Recording.FgRefusalDetail: kind, subject, count, bucket
  index/count, the bucket's ratio (null when it held no tokens — infinity is
  not JSON) and the window's; ToJson/Parse over RecordingJsonContext.
- 0005_fg_refusal_detail.sql; SessionRow.FgRefusalDetail; SessionRowColumns;
  SessionAggregator.ApplyFg stores it beside fg_refusal.
- FpsPresentation.IdentifiedTooltip(technology, refusal, detail) appends
  RefusalDetailText: "Bucket 3 of 8 measured 2.25 against 3.65 for the whole
  session, over 53 samples." / "2 swapchains presented during the session." /
  "40 samples; at least 64 are needed to check." A kind with no numbers worth a
  sentence adds nothing; an unparsable column is the old tooltip.
- No number is decided by it; the producer is unchanged (owner's decision
  2026-09-16: store and show the reason; no steady-state factor, no change to
  multiple_streams).
- Six strings en/vi/ja; Strings.Designer.cs regenerated.
- Tests: SessionAggregatorTests, LedgerDatabaseTests (script five),
  FpsPresentationTests. Docs: 06_DATA_MODEL §Migrations, 03_METRICS §FG
  factor, 08_UI §FPS display rule, CHANGELOG.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-16 20:59:38 +07:00
poli0981andClaude Fable 5.1 d7a38fbd89 docs(spike): §14.1's row half — the shipped Agent's Lies of P session (fsr3, 1506×848→2560×1440, FG ×2.04, rt no) (#193)
The owner's afternoon of watcher-driven sessions produced the milestone's row:
sessions.id 10, Lies of P, attach mode from a Steam launch. The 'against its
menus' column stays blank for the owner; the DLSS-G rows of the same afternoon
are recorded as the refused shape. 15_ROADMAP §P2 says the row half exists.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-16 20:46:05 +07:00
poli0981andClaude Fable 5.1 93154495d9 fix(import): itch.io import reads butler's database, so an install location outside %APPDATA% is found (#188)
* fix(import): itch.io import reads butler's database, so an install location outside %APPDATA% is found

ItchLibrarySource scanned %APPDATA%\itch\apps\*\.itch\receipt.json.gz and nothing
else; on the owner's machine the itch app's one install location is
D:\another\it, apps\ is empty, and the import logged "itch — 0 title(s)" with
no reason. The app records its installs in %APPDATA%\itch\db\butler.db:
install_locations, caves, and butler's own verdict JSON naming the executable
it launches.

- Copy butler.db (+ -wal) to a temporary directory, open the copy read-only
  (the running app holds it in WAL mode), join the three tables, take the first
  Windows candidate of the verdict as the executable (an HTML/Love2D game leaves
  the locator's guess), still scan apps\ receipts for what the database does
  not list; an install found both ways is one row, the database's.
- One log line per run through the importer's sink says what was consulted
  and what each source yielded.
- The constructor now takes the itch directory, not apps\.
- Measured on this machine: 1 location, 2 caves, both titles with butler's
  executables.
- Tests: StoreLibrarySourcesTests (butler.db built in the test: a location
  elsewhere, a custom folder, a forward-slash verdict path, an HTML-only
  verdict, an unparsable verdict, a receipt beside a cave, a receipt-only
  install; no database and a garbage database fall back to receipts and say so).
- Docs: 05_DETECTION §Platform signatures, CHANGELOG.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

* style(tests): using order in StoreLibrarySourcesTests (dotnet format)

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

* fix(tests): the layer registration test deletes only its own registry subtree

It deleted SOFTWARE\FrameLedger.Test whole, which is shared with the GOG
reader's test; when the two overlapped on the runner the GOG keys vanished
mid-test (#188 round 2, 'expected a single item, collection empty').

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-16 20:11:44 +07:00
poli0981andClaude Fable 5.1 8e3a67a8a1 feat(rules): RPG Maker MV/MZ and XP/VX/VX Ace engine rules, rulesVersion 2026.09.1 (#189)
05_DETECTION marked both RPG Maker rows ⛔ "cannot be expressed in
schemaVersion 2". The MV/MZ reasoning wanted a nested group for nw.dll AND
(www/ OR package.json), but MV and MZ both ship package.json beside nw.dll
unconditionally — www/ is only where MV keeps its data — so
all: [nw.dll, package.json] is the whole signal. Measured on the owner's
Flower in Us (Steam) and a hand-extracted MV title: both engine=none before,
both rpgmaker_mv now; Godot, Ren'Py and the rest unchanged.

- rpgmaker_mv: all of nw.dll + package.json siblings, version null (the .js
  header needs a `from` that strings_regex lacks).
- rpgmaker_rgss "RPG Maker XP/VX/VX Ace": any of RGSS1*/RGSS2*/RGSS3*.dll or a
  *.rgssad/*.rgss2a/*.rgss3a archive, version null (which DLL matched is not a
  value any extractor produces) — one rule, the variant unnamed.
- Both after unity/unreal and before godot (an MV game has no .pck; a Godot
  game has no nw.dll).
- Fixtures engines/rpgmaker_mv, engines/rpgmaker_rgss; every_engine_marker
  gains nw.dll, package.json, RGSS301.dll and still expects unity.
- rulesVersion 2026.09.1: the sweep's cache key changes, so every game is
  re-detected on the Agent's next pass.
- Docs: 05_DETECTION §Engine signatures (the ⛔ note kept, struck), CHANGELOG.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-16 19:36:50 +07:00
poli0981andClaude Fable 5.1 c419482169 fix(app): the hooking chip meets AA in both themes, and the FG qualifier no longer clips (#187)
The Games card's "Hooking on/off" was `ui:Badge Appearance="Info"`: WPF UI
paints that with PaletteLightBlueBrush, a fixed Material colour outside both
theme dictionaries, under the theme's white text — #03A9F4 in dark, 2.6:1 — and
no `#` in our XAML for NoXamlHardCodesAColour to catch. It is a Border in the
new HookStatePill style (ON: the accent pair the ×FG chip uses; OFF: the Pill's
muted fill with secondary text); the edit dialog's "Detected" badge is
Secondary.

ContrastTests holds it two ways: no App XAML uses the four palette appearances,
and every pill (text, fill) pair composited over the card and window is ≥ 4.5:1
in both theme dictionaries — with the old pair asserted below it so the check is
known to bite. The accent brushes are derived the way MainWindow derives them
(ApplicationAccentColorManager.Apply on a fixed default accent).

The Dashboard's FG qualifier chip had the other defect — a sentence-length
qualifier in a star column with no trimming — so the text trims with an
ellipsis at 260 px (the tooltip carries the sentence) and the recent-sessions
row sizes the readout to content with the game's name trimming first.

Docs: 08_UI §Contrast, 16_WPFUI_SYNTAX §Theming, CHANGELOG.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-16 18:59:30 +07:00
poli0981andClaude Fable 5.1 c6491a3b89 fix(ledger): a print verb no longer migrates the ledger it prints, and a close checkpoints the WAL it wrote (#186)
`FrameLedger.Agent --console sessions`, run against the owner's own ledger while
its on-disk file was at schema 2, applied scripts 0003 and 0004 to it: every
verb opened through the one migrating `LedgerDatabase.OpenAsync`. Found while
investigating a ledger whose day of rows lived only in a WAL a fresh connection
discarded (salt one generation behind the header, no checkpoint into the main
file); the mechanism is unrecorded and 06_DATA_MODEL §Migrations carries what
was observed.

- `LedgerDatabase.OpenReadOnlyAsync`: existing file, `query_only`, no
  MigrationRunner; older AND newer schemas refused with the reason;
  WriteAsync/MaintainAsync throw.
- Agent: `sessions`, `consent list`, `killswitch status` open read-only
  (`Program.PrintsOnly`); `db path` opens nothing; a refusal is a console line
  with exit 7, not a crash dump. App `--diag` opens read-only.
- `OpenAsync` runs a passive checkpoint after migrating and reports it;
  `DisposeAsync` runs `wal_checkpoint(TRUNCATE)` and reports it, through the new
  `diagnostics` sink (one log line each in agent-*.log / ui-*.log).
- Tests: LedgerDatabaseTests (older schema refused byte-for-byte unchanged,
  read-only reads and refuses writes, missing file creates nothing, a close
  leaves the row readable through immutable=1); AgentReadOnlyVerbsTests.
- Docs: 06_DATA_MODEL, 12_BUILD, 10_LOGGING, HANDOFF §Traps, CHANGELOG.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-16 18:43:10 +07:00
1409 changed files with 74504 additions and 3061 deletions

No files matched your search

+6
View File
@@ -0,0 +1,6 @@
# Where a report goes when it is not a bug, a feature or a safety gap (SECURITY.md).
blank_issues_enabled: true
contact_links:
- name: Security vulnerability (private)
url: https://github.com/poli0981/frameledger/security/advisories/new
about: A way past the guard, an injection the user did not enable, a privacy leak — report it privately, per SECURITY.md.
+100 -10
View File
@@ -21,12 +21,28 @@
# channel sees it. The managed assemblies take the tag's full version through
# -p:Version; the native blocks keep the numeric core (CMake's project() accepts
# nothing else).
#
# A DRY RUN (2026-09-16, P5 prep): `workflow_dispatch` with a version runs every
# step below — the gate, the publish, the tree assertion, vpk, the checksums — and
# uploads the result as a workflow artifact, but creates no tag and no Release.
# It is the first-tag measurement without the tag: 13_CI_CD §release.yml said the
# workflow "has not been exercised by a tag yet", and everything after the version
# gate had only ever run by hand on one machine. In a dry run a missing
# `## [x.y.z]` CHANGELOG section is a printed warning with placeholder notes rather
# than a stop, because the section is written in the tag commit and a dry run
# precedes it; on a real tag it stays a hard stop.
name: Release
on:
push:
tags: ['v*']
workflow_dispatch:
inputs:
version:
description: 'Version to rehearse (e.g. 0.1.0-beta.1): numeric core must equal VERSION; no tag, no Release'
required: true
type: string
# The Release API is contents: write; nothing else is needed and nothing else is granted.
permissions:
@@ -71,9 +87,13 @@ jobs:
- name: Version gate (tag vs VERSION, CHANGELOG section)
id: version
shell: pwsh
env:
DRY_RUN: ${{ github.event_name == 'workflow_dispatch' }}
DISPATCHED_VERSION: ${{ inputs.version }}
run: |
$ErrorActionPreference = 'Stop'
$tag = $env:GITHUB_REF_NAME
$dry = $env:DRY_RUN -eq 'true'
$tag = if ($dry) { 'v' + $env:DISPATCHED_VERSION.TrimStart('v') } else { $env:GITHUB_REF_NAME }
$m = [regex]::Match($tag, '^v(\d+\.\d+\.\d+)(-[0-9A-Za-z.]+)?$')
if (-not $m.Success) { throw "tag '$tag' is not vMAJOR.MINOR.PATCH[-prerelease]" }
$full = $tag.Substring(1)
@@ -83,10 +103,34 @@ jobs:
if ($core -ne $file) { throw "tag $tag has numeric core $core but VERSION says $file — bump VERSION in the same commit as the changelog section, then tag" }
New-Item -ItemType Directory -Force out | Out-Null
./tools/release-notes.ps1 -Version $full -OutFile out/notes.md
if ($LASTEXITCODE -ne 0) { throw 'release notes' }
if ($LASTEXITCODE -ne 0) {
if (-not $dry) { throw 'release notes' }
Write-Host "::warning::CHANGELOG.md has no '## [$full]' section yet - a dry run continues with placeholder notes; a real tag stops here"
[System.IO.File]::WriteAllText('out/notes.md', "DRY RUN of $full - CHANGELOG.md has no ``## [$full]`` section yet.`n", [System.Text.UTF8Encoding]::new($false))
# The runner's pwsh wrapper ends the step with `exit $LASTEXITCODE`, so a handled failure must clear it
# (measured 2026-09-16: the first rehearsal printed the warning and then failed with the script's exit 1).
$global:LASTEXITCODE = 0
}
"version=$full" >> $env:GITHUB_OUTPUT
"prerelease=$pre" >> $env:GITHUB_OUTPUT
Write-Host "releasing $full (pre-release: $pre)"
"dry_run=$($dry.ToString().ToLowerInvariant())" >> $env:GITHUB_OUTPUT
Write-Host "$(if ($dry) { 'DRY RUN of' } else { 'releasing' }) $full (pre-release: $pre)"
# The Overlay's build id is `git describe --dirty` at CMake's configure
# (src/native/FrameLedger.Shm/CMakeLists.txt), and the next step edits tracked
# files: every release until beta.18 shipped "<tag>-dirty". So the id is read
# here, from the clean checkout, and handed to CMake through the environment;
# buildid-check reads it back out of the published binaries.
- name: Build id (the clean checkout)
shell: pwsh
run: |
$ErrorActionPreference = 'Stop'
$id = "$(git describe --always --dirty --abbrev=12)".Trim()
if ($LASTEXITCODE -ne 0 -or -not $id) { throw 'git describe failed' }
if ($id.EndsWith('-dirty')) { throw "the checkout is dirty before the release has touched it: $id" }
if ($id.Length -gt 31) { throw "build id '$id' is $($id.Length) characters; FlShmHandshake::buildId holds 31" }
"FL_BUILD_ID=$id" >> $env:GITHUB_ENV
Write-Host "FL_BUILD_ID = $id"
# 12_BUILD §Release-time token substitution: the effective date of a legal
# document is the date it ships. The only placeholder that survives into the
@@ -121,9 +165,14 @@ jobs:
run: |
$ErrorActionPreference = 'Stop'
$v = '${{ steps.version.outputs.version }}'
dotnet publish src/FrameLedger.App -c Release -r win-x64 --self-contained -p:PublishReadyToRun=true -p:Version=$v -o out/app
# beta.12: the App's links into the repository open the documents of THIS release (Services/RepositoryLinks.cs):
# the tag, or for a rehearsal - which has no tag - the commit it was built from.
$ref = if ('${{ steps.version.outputs.dry_run }}' -eq 'true') { '${{ github.sha }}' } else { "v$v" }
dotnet publish src/FrameLedger.App -c Release -r win-x64 --self-contained -p:PublishReadyToRun=true -p:Version=$v -p:FrameLedgerSourceRef=$ref -o out/app
if ($LASTEXITCODE -ne 0) { throw 'App publish failed' }
dotnet publish src/FrameLedger.Agent -c Release -r win-x64 --self-contained -p:PublishReadyToRun=true -p:Version=$v -o out/app
# beta.14 (D50): the same ref for the Agent - Directory.Build.props stamps it on every assembly, and both
# publishes build the same libraries into this one folder.
dotnet publish src/FrameLedger.Agent -c Release -r win-x64 --self-contained -p:PublishReadyToRun=true -p:Version=$v -p:FrameLedgerSourceRef=$ref -o out/app
if ($LASTEXITCODE -ne 0) { throw 'Agent publish failed' }
# A self-contained package redistributes the .NET runtime, and its licence and
@@ -150,7 +199,7 @@ jobs:
}
Get-ChildItem $dest | ForEach-Object { Write-Host (" {0,-64} {1,8:N0}" -f $_.Name, $_.Length) }
# What ships is what matters: the two entry points and the four shipped native
# What ships is what matters: the two entry points and the five shipped native
# binaries (versioninfo-check's list) must be in the tree, and the unshipped
# capture host must not be (package-closure-check proves it statically; this
# reads the directory).
@@ -158,14 +207,18 @@ jobs:
shell: pwsh
run: |
$ErrorActionPreference = 'Stop'
$required = 'FrameLedger.exe', 'FrameLedger.Agent.exe', 'FrameLedger.Overlay.dll', 'FrameLedger.VkLayer.dll', 'FrameLedger.Guard.dll', 'FrameLedger.NvapiBridge.dll', 'rules/detection-rules.json',
'licenses/nuget/INDEX.md', 'licenses/THIRD_PARTY_NOTICES.md', 'licenses/FrameLedger-GPL-3.0.txt', 'licenses/mpl-2.0.txt', 'licenses/apache-2.0.txt'
$required = 'FrameLedger.exe', 'FrameLedger.Agent.exe', 'FrameLedger.Overlay.dll', 'FrameLedger.VkLayer.dll', 'FrameLedger.Guard.dll', 'FrameLedger.NvapiBridge.dll', 'FrameLedger.ProcessStats.dll', 'rules/detection-rules.json',
'licenses/nuget/INDEX.md', 'licenses/THIRD_PARTY_NOTICES.md', 'licenses/FrameLedger-GPL-3.0.txt', 'licenses/NOTICE.txt', 'licenses/mpl-2.0.txt', 'licenses/apache-2.0.txt'
$missing = @($required | Where-Object { -not (Test-Path (Join-Path out/app $_)) })
if ($missing.Count -gt 0) { throw "out/app is missing: $($missing -join ', ')" }
if (Test-Path out/app/FrameLedger.CaptureHost.exe) { throw 'out/app contains the unshipped capture host (12_BUILD: exactly two roots)' }
if (@(Get-ChildItem out/app/licenses/dotnet -File -ErrorAction SilentlyContinue).Count -lt 2) { throw 'out/app/licenses/dotnet holds fewer than two files -- the runtime licence step did not run' }
./tools/versioninfo-check.ps1 -BuildDir out/app
# beta.14 (D50): the managed half too - the eight managed binaries, carrying the tag's full version.
./tools/versioninfo-check.ps1 -BuildDir out/app -ManagedDir out/app -ExpectedProductVersion '${{ steps.version.outputs.version }}'
if ($LASTEXITCODE -ne 0) { throw 'versioninfo-check over the published tree' }
# beta.18: the native binaries carry the build id read from the clean checkout, exactly - never "<tag>-dirty".
./tools/buildid-check.ps1 -BuildDir out/app -Expected $env:FL_BUILD_ID
if ($LASTEXITCODE -ne 0) { throw 'buildid-check over the published tree' }
$size = (Get-ChildItem out/app -Recurse -File | Measure-Object Length -Sum).Sum / 1MB
Write-Host ("published tree: {0:N0} MB" -f $size)
@@ -179,17 +232,53 @@ jobs:
# ledger.db, logs, the layer manifest). The same id would put the install inside
# the ledger's folder and have the uninstaller remove every session without the
# question 12_BUILD promises. The title the user sees is still "FrameLedger".
# A DELTA (beta.13): vpk pack diffs against the newest full package already in --outputDir, and until beta.13 that
# directory was always empty - so no release carried a delta and every update downloaded the whole package
# (11_UPDATER §Built). The previous release is downloaded first; what THIS pack produced is assets.win.json, and only
# that is kept: the previous full package moves out (not uploaded, not checksummed) and the feed lists this build
# alone, as `vpk upload github` would write it. No previous release, or a download that fails, is a full-only
# release - said as a warning, not a stop, because it is exactly what every release before this one was.
- name: Pack (Velopack)
shell: pwsh
env:
GH_TOKEN: ${{ github.token }}
run: |
$ErrorActionPreference = 'Stop'
dotnet tool install -g vpk --version 1.2.0
if ($LASTEXITCODE -ne 0) { throw 'vpk install failed' }
$v = '${{ steps.version.outputs.version }}'
New-Item -ItemType Directory out/release -Force | Out-Null
vpk download github --repoUrl "https://github.com/${{ github.repository }}" --channel win --pre --token $env:GH_TOKEN --outputDir out/release
if ($LASTEXITCODE -ne 0) { Write-Host '::warning::the previous release could not be downloaded - this release carries a full package only' }
Write-Host 'previous release:'
Get-ChildItem out/release -File | ForEach-Object { Write-Host (" {0,-48} {1,12:N0}" -f $_.Name, $_.Length) }
vpk pack --packId FrameLedger.App --packVersion $v --packDir out/app --mainExe FrameLedger.exe --packTitle FrameLedger --packAuthors FrameLedger --releaseNotes out/notes.md --outputDir out/release
if ($LASTEXITCODE -ne 0) { throw 'vpk pack failed' }
$built = @((Get-Content out/release/assets.win.json -Raw | ConvertFrom-Json) | ForEach-Object { $_.RelativeFileName })
if ($built.Count -eq 0) { throw 'vpk pack wrote no assets.win.json entries' }
$keep = $built + @('releases.win.json', 'assets.win.json', 'RELEASES')
New-Item -ItemType Directory out/previous -Force | Out-Null
Get-ChildItem out/release -File | Where-Object { $keep -notcontains $_.Name } | Move-Item -Destination out/previous
$feed = Get-Content out/release/releases.win.json -Raw | ConvertFrom-Json
$feed.Assets = @($feed.Assets | Where-Object { $built -contains $_.FileName })
if ($feed.Assets.Count -eq 0) { throw 'the feed lists none of this build''s packages' }
[System.IO.File]::WriteAllText((Join-Path $PWD 'out/release/releases.win.json'), ($feed | ConvertTo-Json -Depth 8 -Compress), [System.Text.UTF8Encoding]::new($false))
if (Test-Path out/release/RELEASES) {
$legacy = @(Get-Content out/release/RELEASES | Where-Object { $built -contains ($_ -split ' ')[1] })
[System.IO.File]::WriteAllLines((Join-Path $PWD 'out/release/RELEASES'), [string[]]$legacy, [System.Text.UTF8Encoding]::new($false))
}
Write-Host 'this release:'
Get-ChildItem out/release | ForEach-Object { Write-Host (" {0,-48} {1,12:N0}" -f $_.Name, $_.Length) }
Write-Host ('feed: ' + (($feed.Assets | ForEach-Object { '{0} {1} {2}' -f $_.Type, $_.Version, $_.FileName }) -join '; '))
if (-not (Test-Path out/release/FrameLedger.App-win-Setup.exe)) { throw 'vpk did not produce FrameLedger.App-win-Setup.exe (README §Install names it)' }
$delta = "out/release/FrameLedger.App-$v-delta.nupkg"
if (Get-ChildItem out/previous -Filter '*-full.nupkg' -ErrorAction SilentlyContinue) {
if (-not (Test-Path $delta)) { throw "the previous full package was downloaded, but vpk produced no delta ($delta)" }
} else {
Write-Host '::warning::no previous full package - this release carries no delta'
}
- name: Checksums
shell: pwsh
@@ -205,6 +294,7 @@ jobs:
Get-Content out/release/SHA256SUMS.txt
- name: Create the GitHub Release
if: steps.version.outputs.dry_run != 'true'
shell: pwsh
env:
GH_TOKEN: ${{ github.token }}
@@ -221,7 +311,7 @@ jobs:
if: always()
uses: actions/upload-artifact@v7
with:
name: release-${{ github.ref_name }}
name: release-${{ steps.version.outputs.version || github.ref_name }}${{ steps.version.outputs.dry_run == 'true' && '-dry-run' || '' }}
path: |
out/release/**
out/notes.md
+6 -4
View File
@@ -1,9 +1,11 @@
# Gate changes to the detection + anti-cheat rules (docs/13_CI_CD.md).
#
# The raw file on `main` IS the distribution endpoint (docs/05_DETECTION.md),
# so there is nothing to publish — this workflow only gates correctness. That
# also means a bad merge ships to every user on their next rules check, which
# is why the anticheat block gets extra scrutiny here.
# There is nothing to publish: no rules feed exists (docs/20_OPEN_QUESTIONS.md
# §S20 feed half), so a rules change reaches users inside a release, seeded by
# the Agent from the packaged copy. This header said the raw file on `main` was
# the distribution endpoint until 2026-10-04. This workflow only gates
# correctness, and the anticheat block still gets the extra scrutiny, because
# whatever merges here ships in the next release.
name: Rules
+100
View File
@@ -0,0 +1,100 @@
# 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
# 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).
#
# Separate from release.yml on purpose. The release stays as it was and its dry run stays a pure rehearsal; a wiki that
# fails to publish is a red run of its own, re-run on its own, never a red release. A step after `gh release create`
# could never be re-run at all: the release would already exist.
#
# A release that release.yml creates with GITHUB_TOKEN fires no `release` event for other workflows. `workflow_run` does
# fire - the Release run itself was started by the owner's tag push - and it runs THIS file as it is on main, so the job
# checks out the commit the release was built from (head_sha) and links the repository's files at the tag (head_branch).
name: Wiki
on:
workflow_run:
workflows: [Release]
types: [completed]
workflow_dispatch:
inputs:
ref:
description: 'Branch, tag or commit to build the wiki from; repository files are linked at this ref'
required: true
default: main
type: string
publish:
description: 'Publish to the Wiki tab (off: build, check and upload the pages only)'
required: true
default: false
type: boolean
# The repository's default token is read-only; pushing to <repo>.wiki.git needs contents: write.
permissions:
contents: write
concurrency:
group: wiki
cancel-in-progress: false
jobs:
wiki:
# A rehearsal of release.yml (workflow_dispatch) never publishes the wiki: only a run started by a pushed v* tag
# that succeeded.
if: >-
github.event_name == 'workflow_dispatch' ||
(github.event.workflow_run.conclusion == 'success' &&
github.event.workflow_run.event == 'push' &&
startsWith(github.event.workflow_run.head_branch, 'v'))
runs-on: windows-latest
timeout-minutes: 10
env:
# Values reach the scripts through the environment only, never pasted into them.
WIKI_REF: ${{ github.event_name == 'workflow_dispatch' && inputs.ref || github.event.workflow_run.head_branch }}
WIKI_PUBLISH: ${{ github.event_name == 'workflow_run' || inputs.publish }}
steps:
- uses: actions/checkout@v7
with:
ref: ${{ github.event_name == 'workflow_dispatch' && inputs.ref || github.event.workflow_run.head_sha }}
persist-credentials: false
- name: Build and check the wiki
shell: pwsh
run: |
$ErrorActionPreference = 'Stop'
./tools/wiki-build.ps1 -Ref $env:WIKI_REF -Out out/wiki
if ($LASTEXITCODE -ne 0) { throw 'wiki-build failed' }
- name: Upload the pages
uses: actions/upload-artifact@v7
with:
name: wiki-${{ github.run_id }}
path: out/wiki/**
if-no-files-found: error
retention-days: 14
- name: Publish to the Wiki tab
if: env.WIKI_PUBLISH == 'true'
shell: pwsh
env:
GH_TOKEN: ${{ github.token }}
run: |
$ErrorActionPreference = 'Stop'
gh auth setup-git
if ($LASTEXITCODE -ne 0) { throw 'gh auth setup-git failed' }
git clone --depth 1 "https://github.com/$env:GITHUB_REPOSITORY.wiki.git" wiki-repo
if ($LASTEXITCODE -ne 0) { throw 'cloning the wiki failed - it must have one page created on github.com first' }
Get-ChildItem wiki-repo -Force | Where-Object Name -ne '.git' | Remove-Item -Recurse -Force
Copy-Item out/wiki/* wiki-repo -Recurse
Set-Location wiki-repo
git add -A
git diff --cached --quiet
if ($LASTEXITCODE -eq 0) { Write-Host "The wiki already shows $env:WIKI_REF; nothing to publish."; exit 0 }
git -c user.name='github-actions[bot]' -c user.email='41898282+github-actions[bot]@users.noreply.github.com' commit -q -m "wiki: $env:WIKI_REF"
if ($LASTEXITCODE -ne 0) { throw 'commit failed' }
# The wiki repository's branch is master (git ls-remote, 2026-10-07).
git push origin HEAD:master
if ($LASTEXITCODE -ne 0) { throw 'push failed' }
Write-Host "Published the wiki at $env:WIKI_REF"
+1750 -3
View File
File diff suppressed because it is too large. Load diff
+57 -14
View File
@@ -12,16 +12,24 @@ A C++ DLL (`FrameLedger.Overlay.dll`) is injected into games the user explicitly
1. **Injection is opt-in, per game, never automatic.** The user must add the game *and* enable hooking for it. There is no "hook everything" mode, no global auto-inject.
2. **The anti-cheat guard is a hard gate, not a warning.** Before injecting, scan the target for known anti-cheat/anti-tamper modules (`19_SAFETY`). If any is found → **refuse**, log, tell the user why. There is no override switch, no "I understand, continue anyway" button. Do not add one.
> **Amended 2026-09-22 (owner decision): the override of 2026-09-21 is withdrawn, and the sentence above is the rule again.** For one day (releases `0.1.0-beta.3` and `beta.4`) a per-game override existed. The owner withdrew it: no entry point, no message, no column (schema 0008 drops 0007's five), no string. Do not add one in any form.
>
> **A finding turns the game's hooking off** (`19_SAFETY` §What a finding does to the game). An anti-cheat named in the game itself — its process, its title lists, its folder — is written to the row exactly as the pre-scan always wrote it (`hook_enabled = 0`, `hook_blocked_reason`, `hook_prescan_state = 'blocked'`), and since 2026-09-22 also when the guard finds it at a session's start or at the 30 s re-scan (`AntiCheatVerdict.IsFindingAboutTheGame`). A machine-wide driver or service refuses that session only. The notice, the game's page, the session's notes and the Agent's log all say it happened. Nothing clears the block, as before.
> **Amended 2026-09-26 (owner decision D33): one narrow, evidence-bound exception.** Asked with the 2026-09-22 withdrawal and this rule quoted back, the owner chose a per-game exception for anti-cheat that is **user-mode throughout** — a Settings option off by default, then the user ticks each eligible game through a versioned disclosure (bans are possible and can arrive days later). Eligible only when every finding about the game is `BlockedModule` / `AntiCheatFile` / `AntiCheatDirectory` of ONE family whose floor-and-file footprint has no driver, service or `.sys` (`fl::guard::FamilyIsUserModeOnly` — the GUARD decides, from a family NAME the caller passes), no `.sys` is anywhere in the install tree *(within check 4's reach: three levels under the install root and, since 2026-10-13, under the executable's own folder)*, no title list names the game, and the ledger holds ≥ 2 successful Tier-1 sessions of it. Drivers, services, title lists, the `.sys` rule, the fuzzy tier, scan failures, `TargetUnreadable`, 32-bit, the kill switch and Vulkan are never excepted. The guard runs every check and keeps scanning past the tolerated family (`kAllowedUserModeException`, reason 28); the Overlay learns the family from `Local\FrameLedger.Tolerate.<pid>` before its loader detour exists. A new finding, a crash / safety unhook / floor stop under it, or an executable change ends it; the block is never cleared. **No other form of override is to be added** (`19_SAFETY` §The user-mode exception).
> **Amended 2026-10-03 (owner decision D38): the evidence moved from before the grant to its trial.** "≥ 2 successful Tier-1 sessions" above could never be met by a game blocked at add time — since beta.8 that is every blocked game — nor after a ledger reset. Asked with that, the owner chose: a grant needs no session; the first two hooked sessions under it are a trial, and any end during the trial (a crash, a safety unhook, a floor stop, a new finding, or a stored hooked session with no frames or an abnormal exit) ends the exception **for good** (`games.ac_exception_trial_failed_at`, schema 0017, never cleared). Every other condition above is unchanged, and so is the last sentence.
3. **Never implement evasion.** No manual mapping, no PE header erasure, no thread hiding, no signature obfuscation, no unlinking from the PEB module list. Injection uses documented `LoadLibraryW`. The DLL keeps its real name, real exports, and version info. A performance tool must be *visible* to anti-cheat, not hidden from it. Any PR that makes FrameLedger harder to detect is rejected on principle.
4. **Never read or write game memory outside our own hooks.** We read arguments passed to APIs we hooked and COM/handle objects we legitimately own. No pattern scanning for game internals, no reading player/entity state, no writing to game memory. Ever.
5. **The hook must never crash the game.** Every hook body: SEH-guarded, allocation-free, lock-free, no logging, no exceptions crossing the boundary. On repeated faults, self-disable (`17_HOOK_ENGINE` §Fault policy).
6. **FPS display rule (product requirement):** wherever FPS is shown and Frame Generation is active, show *Native FPS*, *Displayed FPS*, and the FG factor together (`62 → 118 FPS (×1.9 FG)`). Never a single inflated number. See `docs/03_METRICS.md`.
> **Amended 2026-09-03 (owner decision).** When frame generation is *not measured* — `FL_MEASURED_FG` clear, which is every title on today's writer — the one number that may stand alone is **Presented FPS** (`presents / D`), with a mandatory qualifier from the **runtime census** (`FlWriterState.runtimeCensus`): "no frame-generation runtime was loaded, so this cannot include in-process generated frames" or "a frame-generation runtime is loaded and nothing was observed — this MAY include generated frames". The word "Native" never appears alone. **The census never produces `none`**: a statically linked FSR has no module to see, and a census-`none` there would be exactly the inflated number this rule forbids.
> **Amended 2026-09-03 (owner decision).** When frame generation is *not measured* — `FL_MEASURED_FG` clear, ~~which is every title on today's writer~~ which is every title with no Streamline or FidelityFX hook live *(corrected 2026-10-04: the writer sets it since #103, 2026-09-03)* — the one number that may stand alone is **Presented FPS** (`presents / D`), with a mandatory qualifier from the **runtime census** (`FlWriterState.runtimeCensus`): "no frame-generation runtime was loaded, so this cannot include in-process generated frames" or "a frame-generation runtime is loaded and nothing was observed — this MAY include generated frames". The word "Native" never appears alone. **The census never produces `none`**: a statically linked FSR has no module to see, and a census-`none` there would be exactly the inflated number this rule forbids.
>
> **Amended 2026-09-05.** A counted `none` (`presents = application frames`) is **withheld** — Presented FPS with a third qualifier, "this number counts application frames; the Displayed rate is unknown" — on the one shape measured to produce a false `none`: Streamline ≥ 2.8.0 with `sl.dlss_g.dll` loaded (Dying Light: The Beast, five captures, DLSS FG ×4 per the owner). `docs/03_METRICS.md` §Frame Generation carries the key and why it is the Streamline plugin rather than `nvngx_dlssg.dll`; `20_OPEN_QUESTIONS` §H5 carries the session that keeps or withdraws it.
>
> **Amended 2026-09-06 (Leg 0 landed): narrowed, not withdrawn.** `sl.dlss_g.dll` is a startup-time load on that title (frame generation off, census unchanged, twice), and the same morning's ×4 capture measured the discriminator the gate lacked: the 2.8.0 pacer's generated presents are DXGI presents on the hooked chain (§H5 row P1-DXGI), counted through `dxgiUnseen` into `Native 70.52 → Displayed 282.08 (×4 FG)`. So a counted `none` beside a READ `IDXGISwapChain::GetLastPresentCount` with zero unseen is `none`, printed with DXGI's agreement; it is withheld only when the counter was not read.
>
> **Amended 2026-09-17 (owner decision): the steady state.** A session whose frame-generation state changed (menus, loading, a settings change) has no session-wide factor — averaging ×1 menus with ×4 gameplay is the inflated-or-deflated single number this rule forbids — but it is no longer left with none: *Native → Displayed (×N FG)* is shown for the state the session spent most of its generating time in, **always with the share of the session it covers** (`62 → 118 FPS (×1.9 FG · 75%)`), never as a session average (`docs/03_METRICS.md` §The steady state).
7. **RT / PT / RR are tri-state** (`Yes` / `No` / `N/A`) with manual override. They are now *measured*, not guessed — but where measurement is genuinely impossible, the honest answer is still `N/A`. Never fabricate `Yes`.
> **Amended 2026-08-20 with the PR that wrote the hooks, per the owner ruling of 2026-08-14.** This rule named *"inline RayQuery without DXIL scan"* as one of the impossible cases, and that conflated two questions. **Whether rays are being traced is measurable** — `BuildRaytracingAccelerationStructure` is called by RayQuery titles and by `DispatchRays` titles alike, which is why both hooks exist and why the `No` branch requires the AS-build hook to have been *installed*. What needs a DXIL scan is **classifying the technique as RayQuery**, and that stays `N/A`. So the impossible cases are: naming the technique, and path-tracing classification, which has no API-level signature at all (`03_METRICS` §RT/PT/RR — a confidence score that may only ever *suggest*).
@@ -39,7 +47,8 @@ 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 |
| GPU telemetry | 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 |
| Markdown in the App | **Markdig** (BSD-2-Clause, pinned 1.4.0) → 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) |
| 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 |
| Storage | SQLite via Microsoft.Data.Sqlite + Dapper (no EF) |
@@ -54,14 +63,21 @@ 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
global.json # pins the SDK band — see 12_BUILD
build.ps1 # the quality gate; CI runs this identical script
src/
native/
FrameLedger.Overlay/ # C++20 DLL injected into the game (hooks + ring writer + optional overlay)
FrameLedger.Injector/ # C++20 static lib: launch/attach injection, AC guard probe
FrameLedger.Injector/ # C++20 static lib: launch/attach injection, AC guard probe; also builds
# FrameLedger.Guard.dll, the guard's C ABI the Agent loads (line added 2026-10-14)
FrameLedger.VkLayer/ # C++20 Vulkan implicit layer DLL + manifest JSON
FrameLedger.Shm/ # header-only: ring buffer + record layout, shared by native & C# (mirrored)
FrameLedger.NvapiBridge/ # C++ DLL loaded by the Agent (never a game): NVAPI telemetry, NGX state (P2 PR-E2)
FrameLedger.ProcessStats/ # C++ DLL loaded by the Agent (never a game): the game process's memory (beta.12, D43)
tests/ tools/ third_party/ # ctest suites; probes, hook-harness, vendor stubs; vendored headers
# (these three lines added 2026-10-04 — the list stopped at Shm)
FrameLedger.Domain/ # entities, metric calculators — zero dependencies
# (Metrics/ WRITTEN 2026-09-09, P2 PR-A: frame times,
# percentiles, lows, stutter, the FG window and its
@@ -80,7 +96,8 @@ src/
# and Capture/ (PR-C): ShmRingAttacher/ShmCaptureSink over the
# reader, HeldProcessLivenessSource, TargetResolver (path only,
# never a pid), ProcessLauncher, the module snapshot, the marker scan
FrameLedger.Shared/ # IPC contracts (System.Text.Json source-gen) + ShmRecord struct mirror
FrameLedger.Shared/ # IPC contracts (System.Text.Json source-gen) + the struct mirror (ShmLayout.cs;
# it said "ShmRecord", a type that never existed, until 2026-10-04)
FrameLedger.Agent/ # capture orchestrator: watcher, injector control, shm drain, recorder
# BUILT 2026-09-10 (P2 PR-F): a Generic Host. `--serve` = watcher
# (Application.Watch: ProcessWatcher, ProcessTree, DescendantElection,
@@ -97,7 +114,9 @@ src/
# is built as of 2026-09-14 (PR-5 Games/Dashboard, PR-6 summary +
# charts, PR-7 trend/compare, PR-8a Settings/safety notices/Logs/
# --diag, PR-8b tray + the Agent's maintenance flags, PR-9 first run
# + Legal Gate FR-11); Strings.resx en/vi/ja
# + Legal Gate FR-11); Strings.resx en/vi/ja. `--data-dir <copy>`
# (beta.15, D52) = a VIEWER: no Agent started or contacted,
# nothing on the PC changed, the profile's own folder refused
FrameLedger.CaptureHost/ # UNSHIPPED, and since P2 PR-C (2026-09-09) a THIN SHELL: verbs,
# the operator disclosure, the report consumer, and the composition
# of Application.Capture.CaptureSession over Infrastructure's
@@ -110,12 +129,20 @@ src/
# is not what holds rule 1.
tests/
FrameLedger.Domain.Tests/ FrameLedger.Application.Tests/ FrameLedger.Infrastructure.Tests/
FrameLedger.Agent.Tests/ FrameLedger.App.Tests/
FrameLedger.CaptureHost.Tests/ # incl. the Category=Integration end-to-end case
native/FrameLedger.Overlay.Tests/ # Catch2: ring buffer, record encode, fault policy
tools/ # changelog-check, chokepoint-check, coverage-gate, gen-ac-floor,
# hookinventory-check, license-check, package-closure-check,
# rules-validate, vendor-exports, versioninfo-check,
# vklayer-blastradius
Shared/ fixtures/ # test helpers; the detection corpus and other fixtures
~~native/FrameLedger.Overlay.Tests/~~ # never existed (corrected 2026-10-04): the native tests are
# src/native/tests/ (ctest, mostly Catch2 — ring, guard, layout,
# vklayer, unhook, rules budget, NVAPI bridge, process stats)
tools/ # accuracy-check, changelog-check, chokepoint-check, coverage-gate,
# gen-ac-floor, hookinventory-check, license-check, license-gather
# (+ license-overrides/), notice-check, package-closure-check,
# release-notes, rules-validate, test-artifacts-check, vendor-exports,
# versioninfo-check, vklayer-blastradius, fps-impact-runbook,
# wiki-build (beta.17: builds and checks the wiki; the wiki-check gate),
# buildid-check (beta.18: the release's build id in the shipped natives)
# (six names added 2026-10-04)
# (PowerShell). This line used to name three, one of which
# — resx-audit — ~~does not exist~~ exists since 2026-09-13 with
# resx-gen (the committed Strings.Designer.cs generator).
@@ -123,19 +150,31 @@ tools/ # changelog-check, chokepoint-check, coverage-gat
# fl-layout-dump -> struct offsets for the C# mirror test
# hook-harness -> dummy D3D11 + D3D12 + Vulkan + OpenGL app
# (--vulkan since #140, --opengl since #141)
# fl-probe-* -> guard, hook profile, interposer, NVAPI, process
# stats, signer, Vulkan layer; fl-baseline-probe;
# vendor-stubs/ -> fixture DLLs with the vendors' export names
rules/detection-rules.json # engine/platform/capability + anticheat blocklist
guide/ # the user guide (beta.12, D44): ~~eight~~ short English pages for players, embedded in the
# App (Help > User guide); README.md is its contents. docs/ is for developers.
# (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;
# tools/wiki-build.ps1 assembles and checks them (build.ps1 wiki-check)
docs/ legal/ legal/licenses/
```
Dependency direction: `App/Agent → Application → Domain`; **`Application → Shared` since 2026-09-09** (P2 PR-A, decision D1 — `Application.Metrics.FrameSampleMapper` is where `FlFrameRecord` becomes Domain's `FrameSample`, and `Application.Capture.CaptureSession`, hosted there since PR-C the same day, is written over the record; `DrainResult` moved to Shared with it); `Infrastructure` implements `Application` ports; Domain references nothing. **The native layer is reachable only through `Infrastructure`** — no P/Invoke anywhere else. **Two facades since 2026-09-10:** `NativeAntiCheatGuard` (required — absent throws) and `NativeNvapiBridge` (optional — absent is a missing telemetry layer that reports itself), both by absolute path beside the assembly through its one `DllImport` resolver, `Infrastructure.Native.BesideThisAssembly`; the runtime allows one resolver per assembly, which is why a third facade claims a name there rather than setting its own.
Dependency direction: `App/Agent → Application → Domain`; **`Application → Shared` since 2026-09-09** (P2 PR-A, decision D1 — `Application.Metrics.FrameSampleMapper` is where `FlFrameRecord` becomes Domain's `FrameSample`, and `Application.Capture.CaptureSession`, hosted there since PR-C the same day, is written over the record; `DrainResult` moved to Shared with it); `Infrastructure` implements `Application` ports; Domain references nothing. **The native layer is reachable only through `Infrastructure`** — no P/Invoke anywhere else. **~~Two~~ Three facades since ~~2026-09-10~~ 2026-10-03:** `NativeAntiCheatGuard` (required — absent throws), `NativeNvapiBridge` (optional — absent is a missing telemetry layer that reports itself) and, since beta.12 (D43), `NativeProcessStats` (optional — the game process's own memory, read from outside the game; absent reads N/A), all by absolute path beside the assembly through its one `DllImport` resolver, `Infrastructure.Native.BesideThisAssembly`; the runtime allows one resolver per assembly, which is why the third facade claims a name there rather than setting its own.
## Coding conventions
**C# —** `Nullable enable`, `TreatWarningsAsErrors`, `AnalysisLevel latest-all`, file-scoped namespaces, Roslynator + Meziantou + VS Threading analyzers, `dotnet format` clean. Async suffixed `Async`, `ConfigureAwait(false)` off the UI. All user-visible strings from `.resx`. Timestamps UTC (unix-ms in SQLite); QPC ticks only inside the capture pipeline.
**C++ —** `clang-format` (LLVM base, 4-space, 120 col) enforced in CI. No STL containers that allocate in hook paths. No `std::mutex` in hook paths. `-D_HAS_EXCEPTIONS=0` in the Overlay target. Every hook entry point wrapped per the `FL_HOOK_GUARD` macro (`17_HOOK_ENGINE`). Static analysis: `/analyze` + clang-tidy (`bugprone-*`, `cert-*`, `concurrency-*`).
**C++ —** `clang-format` (LLVM base, 4-space, 120 col) enforced in CI. No STL containers that allocate in hook paths. No `std::mutex` in hook paths. `-D_HAS_EXCEPTIONS=0` in the Overlay target. Every hook entry point wrapped per the `FL_HOOK_GUARD` macro (`17_HOOK_ENGINE`). Static analysis: ~~`/analyze` + clang-tidy (`bugprone-*`, `cert-*`, `concurrency-*`)~~ CodeQL (`codeql.yml`, a required check); `/analyze` and clang-tidy are not configured *(corrected 2026-10-04)*.
**Struct mirroring —** `FlFrameRecord`, `FlShmHandshake`, `FlWriterState` and `FlControlBlock` each exist twice: `src/native/FrameLedger.Shm/include/fl_shm.h` (**normative**) and `src/FrameLedger.Shared/ShmLayout.cs` as `[StructLayout(LayoutKind.Sequential)]`. `ShmLayoutMirrorTests` asserts size and every field offset on both sides **against JSON emitted by `tools/fl-layout-dump`**, never a transcribed table, and walks the field list in both directions so a field added on either side alone fails.
**Licence header —** every first-party source file (`.cs .cpp .h .inl .ps1 .xaml`) opens with two comment lines, `SPDX-License-Identifier: GPL-3.0-only` and `Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE` (beta.12, owner decision D45). GPLv3 §7 requires additional terms to be named in the source files, and `NOTICE` holds them — (b) preserve the notices, (c) mark modified versions, (e) no trademark rights in the name. `tools/notice-check.ps1` is a `build.ps1` gate; `-Fix` writes a missing header. `src/native/third_party/` is excluded.
**Struct mirroring —** ~~`FlFrameRecord`, `FlShmHandshake`, `FlWriterState` and `FlControlBlock`~~ `FlShmHandshake`, `FlWriterState`, `FlControlBlock`, `FlDisplayState` (layout 4, beta.10), `FlFrameRecord` and `FlTolerance` (D33, beta.9) each exist twice *(corrected 2026-10-04)*: `src/native/FrameLedger.Shm/include/fl_shm.h` / `fl_tolerance.h` (**normative**) and `src/FrameLedger.Shared/ShmLayout.cs` as `[StructLayout(LayoutKind.Sequential)]`. `ShmLayoutMirrorTests` asserts size and every field offset on both sides **against JSON emitted by ~~`tools/fl-layout-dump`~~ `src/native/tools/fl-layout-dump`**, never a transcribed table, and walks the field list in both directions so a field added on either side alone fails.
It also asserts **blittability** (`RuntimeHelpers.IsReferenceOrContainsReferences`), because offsets cannot see it: measured 2026-08-05, swapping the `fixed byte BuildId[32]` for this repo's own `[MarshalAs(ByValTStr)] string` idiom keeps `Marshal.SizeOf` at 64 and every offset correct while `Unsafe.SizeOf` collapses to **40** — a mirror that passes the obvious checks and cannot be read out of a memory-mapped view.
@@ -143,7 +182,7 @@ It also asserts **blittability** (`RuntimeHelpers.IsReferenceOrContainsReference
The version handshake is wired end to end as of 2026-08-05: `FlGuardBuildId` gives the Agent a build id of its own and `ShmHandshakeValidator` performs the refuse-to-attach comparison `07_IPC` specifies (§S23-1). **Its default is `NotEvaluated`, not `Ok`** — a result nobody produced has validated nothing, the same rule `AntiCheatVerdict` follows.
**Dev mode —** `FL_MOCK=1` is **specified but not implemented** — `grep -rn FL_MOCK src tests tools build.ps1` returns nothing (recorded 2026-08-04). When it exists it runs the whole app with a synthetic frame source and no injection at all, and it is how the UI is meant to be developed; until then, do not plan work on the assumption that it is there. `tools/hook-harness` is a dummy **D3D11 + D3D12 + Vulkan + OpenGL** app used to exercise hooks without a real game — `--vulkan` since #140 and `--opengl` since #141 (2026-09-06); this sentence said both were unwritten until 2026-09-09 (`docs/12_BUILD.md` §Targets is the accurate list).
**Dev mode —** `FL_MOCK=1` is **specified but not implemented** — `grep -rn FL_MOCK src tests tools build.ps1` returns nothing (recorded 2026-08-04). When it exists it runs the whole app with a synthetic frame source and no injection at all, and it is how the UI is meant to be developed; until then, do not plan work on the assumption that it is there. ~~`tools/hook-harness`~~ `src/native/tools/hook-harness` (path corrected 2026-10-04) is a dummy **D3D11 + D3D12 + Vulkan + OpenGL** app used to exercise hooks without a real game — `--vulkan` since #140 and `--opengl` since #141 (2026-09-06); this sentence said both were unwritten until 2026-09-09 (`docs/12_BUILD.md` §Targets is the accurate list).
## Definition of done (per PR)
@@ -169,6 +208,10 @@ The version handshake is wired end to end as of 2026-08-05: `FlGuardBuildId` giv
8. `docs/18_GPU_VENDOR_APIS.md` — layered GPU telemetry (DXGI/PDH · LHM · NVAPI) + vendor-SDK licence rules
9. `docs/06_DATA_MODEL.md` · `docs/07_IPC.md` · `docs/08_UI.md` · `docs/16_WPFUI_SYNTAX.md`
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
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`.** It
lists the defects and gaps that survived the doc audit — things the other
+14
View File
@@ -0,0 +1,14 @@
# Code of conduct
FrameLedger adopts the **[Contributor Covenant, version 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/)**
(© Contributor Covenant contributors, licensed CC BY 4.0) as its code of conduct, for everyone who takes part in the
project — in issues, pull requests, discussions and any other project space.
In short: be respectful and welcoming, criticise ideas rather than people, and do not harass, insult or demean anyone.
The full text linked above is the code; this summary does not replace it.
## Reporting
Report behaviour that breaks the code to the maintainer at **contact@poli0981.dev**. Reports are read in confidence,
and the maintainer decides on the response in line with the Covenant's enforcement guidelines — from a private note to
a ban from the project's spaces.
+81
View File
@@ -0,0 +1,81 @@
# Contributing to FrameLedger
Thank you for looking. FrameLedger is a small project with strict rules, because it loads code into games and a mistake
can cost a user their account. This page says how to build it, what a change has to bring with it, what will not be
merged, and under what licence your contribution is accepted.
## Before you start
- **Read `CLAUDE.md`'s *Non-negotiable rules* and `docs/19_SAFETY_AND_ANTICHEAT.md` first.** They constrain everything
that touches a game.
- **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.
- Everyone who takes part follows the `CODE_OF_CONDUCT.md`.
## Building
You need Windows 10 22H2 or later (x64), Visual Studio 2022 with the C++ workload (MSVC v143), CMake 3.28 or later,
PowerShell 7, and the .NET SDK that `global.json` pins. Then:
```powershell
./build.ps1 check
```
That is the whole quality gate, and continuous integration runs the identical script: the native build and its tests,
`clang-format`, the managed build with warnings as errors, `dotnet format`, every test project, and the repository's own
checks (licences, the accuracy blocks, the licence headers, the changelog rules, …). `docs/12_BUILD.md` describes each
step and the build profiles. Run it in your main checkout: a fresh `git worktree` cannot configure the native build.
Documentation lives in three places: `guide/` for players (shown in the app and on the wiki), `wiki/` for the wiki's own
pages, and `docs/` for developers. A change a player would notice updates `guide/`; a change to how the code is put
together updates `docs/` — and the `wiki/` page that summarises it, if that page now says something else.
`./build.ps1 check` builds the wiki and fails on a link that leads nowhere.
Never point a build of your own at the data FrameLedger records into (`%LOCALAPPDATA%\FrameLedger`): a newer build
migrates the database, and the released one cannot read it back. To look at real data, copy the folder and start
`FrameLedger.exe --data-dir <copy>` — a viewer that starts no Agent and changes nothing on the PC (`docs/12_BUILD.md`
§Debugging says how to copy it safely).
## What a pull request brings with it
The definition of done is the one in `CLAUDE.md`:
- it builds without warnings (C# and C++), the tests are green, and `dotnet format` and `clang-format` are clean;
- 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 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.
## What will not be merged
Whatever its other merits, a change that
- adds any way to override, weaken or skip the anti-cheat guard (rule 2);
- makes FrameLedger harder to detect — manual mapping, header erasure, thread hiding, unlinking modules, obfuscation,
renamed binaries (rules 3 and 9);
- reads or writes game memory outside the hooked calls (rule 4), or makes a hook able to crash a game (rule 5);
- adds telemetry, analytics or any network request beyond the ones `legal/PRIVACY_POLICY.md` lists (rule 8);
- turns injection on for a game the user did not individually enable (rule 1).
## Licensing of contributions
FrameLedger is licensed under the GNU GPL, version 3 only, with the additional terms in `NOTICE`. **By opening a pull
request you confirm that you have the right to submit the change, and you license it under GPL-3.0-only, with the
additional terms in `NOTICE` (GPLv3 §7 (b), (c) and (e)) applying to it as they apply to the rest of FrameLedger's own
material.** There is no contributor licence agreement and no copyright assignment: you keep the copyright in your
contribution. Code from elsewhere must come with a licence compatible with GPL-3.0-only and be listed in
`legal/THIRD_PARTY_NOTICES.md`.
Changes written with AI assistance are welcome on the same terms — you are responsible for what you submit, as for any
other change.
## Questions
Open an issue, or write to contact@poli0981.dev.
+26
View File
@@ -69,6 +69,32 @@
<IncludeSourceRevisionInInformationalVersion>false</IncludeSourceRevisionInInformationalVersion>
</PropertyGroup>
<!-- beta.14 (D50): every managed binary names the product and who wrote it, as the native ones always have
(19_SAFETY: a binary says plainly what it is). Explorer's Properties > Details and Task Manager read these. Until
beta.14 the SDK's defaults stood: the Agent's Company and Product read "FrameLedger.Agent", each library's its own
assembly name, and no managed binary carried a copyright. The copyright is the native FL_COPYRIGHT
(src/native/CMakeLists.txt) word for word: tools/versioninfo-check.ps1 reads both from the built binaries and is
red when they differ. The file description is the AssemblyTitle - an entry point sets its own, a library keeps its
assembly name - and the Description is the Comments field, the native blocks' sentence for a library. The SDK
stamps RepositoryUrl into every assembly as AssemblyMetadata; it is the App's IssueLink.Repository, and the App's
AssemblyIdentityTests holds the two equal (a fork changes both - FORKING.md). -->
<PropertyGroup>
<Company>FrameLedger</Company>
<Product>FrameLedger</Product>
<Authors>poli0981</Authors>
<Copyright>Copyright (C) 2026 poli0981. GPL-3.0-only with additional terms: see NOTICE</Copyright>
<Description>Performance measurement tool. Identifies itself deliberately; see https://github.com/poli0981/frameledger</Description>
<RepositoryUrl>https://github.com/poli0981/frameledger</RepositoryUrl>
</PropertyGroup>
<!-- beta.12: the source a build was made from - release.yml passes the tag (a rehearsal, its commit); a local build has
none. The App's links into the repository open THIS version's documents with it (Services/RepositoryLinks.cs).
Every assembly since beta.14 (D50), not the App's alone: the two publishes build the same libraries into one
out/app, and release.yml passes the same ref to both. -->
<ItemGroup Condition="'$(FrameLedgerSourceRef)' != ''">
<AssemblyMetadata Include="FrameLedgerSourceRef" Value="$(FrameLedgerSourceRef)" />
</ItemGroup>
<!-- Test projects: documentation comments are noise, and xUnit's own
analyzers already cover what matters there. -->
<PropertyGroup Condition="$(MSBuildProjectName.EndsWith('.Tests'))">
+26 -12
View File
@@ -3,7 +3,7 @@
<!--
Central package management (docs/12_BUILD.md). Every version is pinned here
and nowhere else, which also makes Dependabot PRs single-file diffs.
All versions verified against nuget.org on 2026-08-02.
All versions verified against nuget.org on 2026-08-02; re-verified and bumped 2026-09-21.
-->
<PropertyGroup>
<ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
@@ -25,10 +25,17 @@
<PackageVersion Include="CommunityToolkit.Mvvm" Version="8.4.2" />
<PackageVersion Include="ScottPlot.WPF" Version="5.1.59" />
<PackageVersion Include="H.NotifyIcon.Wpf" Version="2.4.1" />
<!--
Markdig (Alexandre Mutel): Markdown rendered in the App (beta.12, owner request 4) - the Legal Gate, Help,
About and the user guide show their documents rendered, not as raw text. BSD-2-Clause, no dependency on
net10.0. The package ships no licence file, so its text is a reviewed override
(tools/license-overrides/Markdig.txt). HTML is disabled in the pipeline (App/Markdown/MarkdownRenderer.cs).
-->
<PackageVersion Include="Markdig" Version="1.4.0" />
</ItemGroup>
<ItemGroup Label="Hosting and logging">
<PackageVersion Include="Microsoft.Extensions.Hosting" Version="10.0.10" />
<PackageVersion Include="Microsoft.Extensions.Hosting" Version="10.0.12" />
<PackageVersion Include="Serilog" Version="4.4.0" />
<PackageVersion Include="Serilog.Extensions.Hosting" Version="10.0.0" />
<PackageVersion Include="Serilog.Sinks.Console" Version="6.1.1" />
@@ -37,8 +44,8 @@
<ItemGroup Label="Storage">
<!-- No EF: Dapper over Microsoft.Data.Sqlite (CLAUDE.md pinned stack). -->
<PackageVersion Include="Microsoft.Data.Sqlite" Version="10.0.10" />
<PackageVersion Include="Dapper" Version="2.1.79" />
<PackageVersion Include="Microsoft.Data.Sqlite" Version="10.0.12" />
<PackageVersion Include="Dapper" Version="2.1.86" />
<!--
Transitive pin, not a direct dependency.
@@ -56,7 +63,7 @@
</ItemGroup>
<ItemGroup Label="Interop, telemetry and packaging">
<PackageVersion Include="Microsoft.Windows.CsWin32" Version="0.3.298" />
<PackageVersion Include="Microsoft.Windows.CsWin32" Version="0.3.333" />
<PackageVersion Include="Velopack" Version="1.2.0" />
<!-- MPL-2.0. docs/18_GPU_VENDOR_APIS.md §L2 requires >= 0.9.6, and
legal/THIRD_PARTY_NOTICES.md has a release-gate check that no
@@ -64,19 +71,26 @@
<PackageVersion Include="LibreHardwareMonitorLib" Version="0.9.6" />
<!-- The crash witness (04_CAPTURE §Crash & exit classification): Application log events 1000/1001. In-box
for WPF apps, a package for a class library on the Windows TFM. Microsoft, MIT. -->
<PackageVersion Include="System.Diagnostics.EventLog" Version="10.0.10" />
<PackageVersion Include="System.Diagnostics.EventLog" Version="10.0.12" />
</ItemGroup>
<ItemGroup Label="Analyzers (build-time only)">
<PackageVersion Include="Roslynator.Analyzers" Version="4.16.1" />
<PackageVersion Include="Meziantou.Analyzer" Version="3.0.257" />
<PackageVersion Include="Roslynator.Analyzers" Version="5.0.1" />
<PackageVersion Include="Meziantou.Analyzer" Version="3.0.299" />
<PackageVersion Include="Microsoft.VisualStudio.Threading.Analyzers" Version="18.7.23" />
</ItemGroup>
<ItemGroup Label="Testing">
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.8.1" />
<PackageVersion Include="xunit.v3" Version="3.2.2" />
<PackageVersion Include="xunit.runner.visualstudio" Version="3.1.5" />
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.10.1" />
<!--
xUnit.net v3, 4.x line (2026-09-21). 4.0 made Microsoft Testing Platform v2 the default of the plain
`xunit.v3` package and dropped MTP v1. build.ps1's gates are VSTest-shaped on purpose - the
`XPlat Code Coverage` collector, `results.trx` read by the struct-mirror gate and by Invoke-TestsWithin -
so the projects reference the SAME 4.x framework through its `mtp-off` variant, the one xunit publishes
for exactly this. Moving to MTP v2 is a build.ps1 change, not a version bump; do them together or not at all.
-->
<PackageVersion Include="xunit.v3.mtp-off" Version="4.0.1" />
<PackageVersion Include="xunit.runner.visualstudio" Version="4.0.0" />
<!--
FluentAssertions is pinned to the 7.x line ON PURPOSE, and must not be
bumped to 8.x without redoing the licence analysis.
@@ -94,7 +108,7 @@
Reviewed 2026-08-02. See docs/20_OPEN_QUESTIONS.md §G.
-->
<PackageVersion Include="FluentAssertions" Version="[7.2.2]" />
<PackageVersion Include="NSubstitute" Version="6.0.0" />
<PackageVersion Include="NSubstitute" Version="6.2.0" />
<PackageVersion Include="coverlet.collector" Version="10.0.1" />
</ItemGroup>
+94
View File
@@ -0,0 +1,94 @@
# Forking and redistributing FrameLedger
This page is for anyone who clones or forks FrameLedger — and above all for anyone who **gives builds of a modified
FrameLedger to other people**. It says what the licence lets you do, what it asks of you when you distribute, and the
practical things a fork has to change so that its users and FrameLedger's users do not get each other's updates, data
or blame. It is written to be useful, not as legal advice; the texts that decide are `LICENSE` (the GNU GPL, version 3)
and `NOTICE`.
## What the licence lets you do
FrameLedger is free software under the **GNU General Public License, version 3 only** (`GPL-3.0-only`). You may run it
for any purpose, study and change its source, and share copies — changed or not — free of charge or for a fee. You do
not need anyone's permission, and you do not have to accept the licence just to run the program (GPLv3 §9).
## What it asks when you distribute a build
"Distribute" here is the GPL's *convey*: giving a copy to someone else, including publishing an installer. Running
FrameLedger yourself, or changing it for yourself, asks nothing of you.
- **The source goes with the build.** Whoever receives your binaries must be able to get the complete source code
that builds them, under the same licence (GPLv3 §6) — the C++ and C# sources, the build scripts (`build.ps1`,
`src/native/CMakeLists.txt`, the workflows) and everything else needed to rebuild them. Publishing the exact source
tree at the tag you built from, next to the release, is the simplest way. An installer such as the Velopack
`Setup.exe` counts as a binary.
- **Keep the notices.** Ship `LICENSE`, `NOTICE` and the third-party licences with every copy. The release workflow
already does this: the App's publish step copies them into `licenses\` beside the executables (`licenses\NOTICE.txt`,
`licenses\FrameLedger-GPL-3.0.txt`, `licenses\THIRD_PARTY_NOTICES.md`, `licenses\nuget\`), and
`.github/workflows/release.yml` refuses a published tree without them. Do not remove the copyright and licence
headers from the source files.
- **Say that it is changed.** A modified version must carry prominent notices that you modified it, and when
(GPLv3 §5(a)).
- **Add no restrictions.** You may not impose terms that take away the rights the GPL gives your users (GPLv3 §10) —
an end-user agreement that forbids what the GPL permits is not allowed. FrameLedger's own EULA says that nothing in
it limits those rights.
### The additional terms in `NOTICE`
FrameLedger's own material is licensed with three additional terms of the kinds GPLv3 §7 permits. In short:
- **(b)** keep the copyright line and the attribution *"Based on FrameLedger by poli0981 —
https://github.com/poli0981/frameledger"* in your build's Appropriate Legal Notices (FrameLedger shows them under
Help ▸ About);
- **(c)** do not name a modified version "FrameLedger" alone, say in its notices and documentation that it is modified
and by whom, and do not present its builds, installers or update feed as the original project's;
- **(e)** no rights are granted in the name "FrameLedger" or the project's logo and icon, beyond saying truthfully
where your work comes from ("based on FrameLedger", "a fork of FrameLedger").
`NOTICE` has the exact wording. These terms cover material written by FrameLedger's developer; how far they reach
depends on the copyright in that material — parts of FrameLedger were written with AI assistance under the developer's
direction. If the difference matters to you, ask a lawyer, not this page.
## What a fork that ships builds has to change
FrameLedger installs into the user's profile, keeps one database there, runs a background agent and registers a few
system-wide names. A fork that keeps them **collides with an installed FrameLedger**: the two would update each other,
share — and migrate — one database, and fight over the same pipe and shared memory. Change all of these together:
| What | Where | Why |
|---|---|---|
| Product name, icon, title | the App's resources, `--packTitle` in `release.yml`, `Strings.resx` | NOTICE (c) and (e) |
| Update feed | `VelopackUpdateClient.RepositoryUrl` (`src/FrameLedger.App/Update/VelopackUpdateClient.cs`) | otherwise your users are offered FrameLedger's releases, and FrameLedger's users yours |
| Install folder | `--packId` in `release.yml` (today `FrameLedger.App`) | Velopack installs into `%LOCALAPPDATA%\<packId>` and **deletes that folder on uninstall** — never choose a packId that equals any data folder |
| Data folder | `LedgerPaths` (`src/FrameLedger.Infrastructure/Persistence/LedgerPaths.cs`) and the other `%LOCALAPPDATA%\FrameLedger` paths (`DetectionRulesFile`, `VkLayerLaunchEnvironment`, the Overlay's log folder, and the guard's own `fl::guard::RulesFilePath` in `src/native/FrameLedger.Injector/src/fl_ac_rules.cpp`) | a newer schema migrates the database in place and an older build cannot open it again |
| Agent pipe | `IpcProtocol.PipeName` (`src/FrameLedger.Shared/Ipc/IpcProtocol.cs`) | the App talks to whichever agent owns the pipe |
| Shared memory and mutex names | `Local\FrameLedger.*` (the ring, the tolerance channel, `SingleInstance`, the agent's instance lock) — in C# and in `src/native` | two programs must not open each other's ring |
| Vulkan layer | `VK_LAYER_FRAMELEDGER_overlay`, its `HKCU\SOFTWARE\Khronos\Vulkan\ImplicitLayers` registration, and its `FRAMELEDGER_ENABLE_VK_LAYER` / `DISABLE_FRAMELEDGER_VK_LAYER` variables (the manifest template in `src/native/FrameLedger.VkLayer/` and `VkLayerLaunchEnvironment`) | one implicit layer per name — and a fork that keeps the variables is switched on by every FrameLedger launch |
| Start with Windows | `RunAtLogon.DefaultValueName` (`src/FrameLedger.Infrastructure/Startup/RunAtLogon.cs`) | one `HKCU\…\Run` value per name |
| Logon task | `LogonTask` (the Agent's maintenance verbs) | one task per name |
| Issue and help links | `IssueLink.Repository` (`src/FrameLedger.App/Services/IssueLink.cs`) — `RepositoryLinks` builds every document link in the App from it and the source ref `release.yml` passes — plus the Releases link in `guide/01-install.md` and `.github/ISSUE_TEMPLATE/` | your users' reports belong in your tracker |
| Who the documents name | `legal/EULA.md`, `legal/DISCLAIMER.md`, `legal/PRIVACY_POLICY.md` name poli0981 as the Developer, with a contact | the person who distributes a build is the one its users deal with; review every claim they make, too — they describe FrameLedger's builds, not yours |
| Version information | `FL_COMPANY_NAME` / `FL_PRODUCT_NAME` / `FL_COPYRIGHT` in `src/native/CMakeLists.txt`; `Company` / `Product` / `Authors` / `Copyright` / `Description` / `RepositoryUrl` in `Directory.Build.props` and the `AssemblyTitle` / `Description` of the App's and the Agent's csproj (since beta.14); and the names `tools/versioninfo-check.ps1` and the two `AssemblyIdentityTests` require | anti-cheat vendors and users identify the DLLs loaded into games and the processes beside them by it (`docs/19_SAFETY_AND_ANTICHEAT.md`); it must name your project, and the copyright line must be one line on every binary — the check compares them |
| Checksums | your own `SHA256SUMS.txt` | users verify what *you* built |
The detection rules and the anti-cheat blocklist (`rules/detection-rules.json`) ship with each build; keeping them
current for your users becomes your job.
## What we ask, and cannot require
The GPL does not allow adding restrictions, so the following is a request, not a condition. FrameLedger is built
around a few rules (`CLAUDE.md`, *Non-negotiable rules*), and the reason is the people who use it:
- the anti-cheat guard is a hard gate with no override switch;
- injection is opt-in, per game, and never automatic;
- nothing is hidden from security software — no manual mapping, no header erasure, no renamed or obfuscated binaries;
- the game's memory is never read or written outside the hooked calls;
- no telemetry and no silent network requests.
A build that drops any of these can get its users' accounts banned. It is not FrameLedger, must not say it is
(NOTICE (c)), and the original developer is not responsible for it.
## See also
`NOTICE` · `LICENSE` · `CONTRIBUTING.md` (if you would rather send your change upstream) ·
`legal/TRADEMARKS.md` · `legal/THIRD_PARTY_NOTICES.md` · `docs/12_BUILD.md` (building from source)
+34
View File
@@ -0,0 +1,34 @@
<Project>
<!--
Ships FrameLedger.ProcessStats.dll beside the importing project's output (beta.12, owner decision D43).
The third P/Invoke facade after the guard's and the NVAPI bridge's (docs/18_GPU_VENDOR_APIS.md §L1, the game
process's memory): NativeProcessStats loads it BY ABSOLUTE PATH from AppContext.BaseDirectory and never falls back
to a search, so it has to actually be there. Read-only, and NEVER loaded into a game — the Agent (and the unshipped
capture host) load it into their own process for the 1 Hz read of a game's dedicated/shared GPU memory (the
GPU Process Memory counters) and its working sets (GetProcessMemoryInfo).
Imported by the same three projects as the bridge: FrameLedger.Agent, FrameLedger.CaptureHost and
FrameLedger.Infrastructure.Tests (the mirror test and the real read P/Invoke into the real DLL).
Warn rather than fail when absent, as the bridge does: an absent reader is a missing measurement (every game-memory
field reads N/A), not a safety hole.
-->
<PropertyGroup>
<FlProcessStatsOutDir>$(MSBuildThisFileDirectory)build\native\x64-release\FrameLedger.ProcessStats\</FlProcessStatsOutDir>
</PropertyGroup>
<ItemGroup>
<None Include="$(FlProcessStatsOutDir)FrameLedger.ProcessStats.dll" Condition="Exists('$(FlProcessStatsOutDir)FrameLedger.ProcessStats.dll')">
<Link>FrameLedger.ProcessStats.dll</Link>
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
</ItemGroup>
<Target Name="FlWarnOnMissingProcessStats" AfterTargets="Build"
Condition="!Exists('$(FlProcessStatsOutDir)FrameLedger.ProcessStats.dll')">
<Warning Text="FrameLedger.ProcessStats.dll was not found at $(FlProcessStatsOutDir). Run build.ps1 native first; the game's memory will read N/A." />
</Target>
</Project>
+209
View File
@@ -0,0 +1,209 @@
# What FrameLedger cannot do
FrameLedger measures a game by loading a small component into it — only for a game you added and switched
hooking on for — and reading the graphics calls the game makes. That is why it can tell the real render
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.22.*
## Games it will not measure
- **Games with anti-cheat.** FrameLedger looks for anti-cheat before it touches a game and refuses when it
finds one — there is no switch that overrides this. The one exception is an anti-cheat that runs entirely
inside the game (no driver, no service), which you can allow per game after a warning; its first two
sessions are a trial, and one that does not go well ends the exception for good. A ban is still possible and
may come days later. Kernel anti-cheat is never allowed.
([Safety](docs/19_SAFETY_AND_ANTICHEAT.md))
- **Anti-cheat FrameLedger does not know about.** The list of anti-cheat products is FrameLedger's own and
can be incomplete. A game protected by something unknown may be hooked; that is a risk to your account
that you take by switching hooking on.
- **32-bit games and Direct3D 9 games.** Only 64-bit Direct3D 11, Direct3D 12 and OpenGL games are measured
from their own calls; a 32-bit or Direct3D 9 game is recorded without measurement.
- **Vulkan games, unless FrameLedger starts them.** A Vulkan game is measured only when FrameLedger launches it
with its Vulkan layer switched on — **Play** set to *Start directly* does; one started another way is not observed by
the layer.
- **Games that run as administrator,** unless you turn on *Run the agent as administrator* in Settings
(off by default; Windows asks every time the agent starts). **A process Windows protects** stays closed
either way.
- **Vulkan games that run as administrator.** Windows' Vulkan loader does not load FrameLedger's Vulkan
layer into an elevated game, so admin mode does not help there.
- **A game that was already running when FrameLedger was updated** — restart the game once.
- **Games you did not switch hooking on for.** Adding a game only records its sessions; measuring it is a
separate, per-game choice with its own warning.
## What an unmeasured session contains
When a game is not measured — any of the reasons above — its session still records **how long it ran, the
machine's sensors (GPU temperature, load, power; CPU load; memory), how much memory the game itself used (read from
Windows, outside the game) and why nothing was measured.** Every
frame-rate, upscaler, frame-generation and ray-tracing value reads **N/A**, never 0. How the game's window was
shown is recorded too, from outside the game. ([Capture](docs/04_CAPTURE.md))
## When a game crashed
- A session reads **crashed** when the game ended with an exception's code, when Windows logged a crash report of it,
or — since 0.1.0-beta.14 — when it started its engine's crash reporter (Unreal's, CD PROJEKT RED's, Capcom's,
BugSplat's) and exited within a minute. A game that handles its own crash quietly, starts no reporter and leaves no
crash report reads **ended normally**, with its exit code.
- A crash reporter is seen from a once-a-second look at running programs: one that opens and closes faster can be
missed, and one started in the game's first 10 seconds is not counted (it could be a monitor that starts with the
game). Unity's crash handler and Chromium's `crashpad_handler` start with every game that has them, so their presence
says nothing. Sessions recorded before 0.1.0-beta.14 keep how they were stored — a few of them may read *crashed*
because Windows logged a memory report about the game. ([details](docs/04_CAPTURE.md))
## Frame rate and frame generation
- **One inflated number is never shown.** When frame generation is measured, the page shows the game's own
frames and the displayed frames together (`62 → 118 FPS (×1.9 FG)`). When it cannot be measured, the page
shows **Presented FPS** with a sentence saying whether generated frames could be included.
- **Frame generation done by the driver outside the game** (AMD Fluid Motion Frames, NVIDIA Smooth Motion)
is not visible to FrameLedger; the rates shown are what the game presented.
- Frame generation is counted on **Direct3D games** only. DLSS Frame Generation and FSR frame generation are
named from the calls the game makes; any other generator is shown only as *active*, never named, and where
the generated frames cannot be counted the page shows Presented FPS with a note instead of a factor.
- **A session whose frame generation changed** (menus, loading, a settings change) shows the factor of the
state it spent most of its time in, with the share of the session it covers — never an average of the two.
([Metrics](docs/03_METRICS.md))
- **Time below 30, 60 FPS and below the refresh rate** (since 0.1.0-beta.14) leaves out the small wobble of a game
held at its limit: a frame counts as below 60 when it took 10 % longer than 1/60 s, or when the frames around it ran
2 % slower. So a game running steadily just under the line — 59 FPS against 60 — reads partly as at it. Time below
the refresh rate needs the monitor's rate, which a session saved after a crash does not have.
- **VSync and tearing** (since 0.1.0-beta.14) are what the game *asked* for on each frame; the graphics driver or a
variable-refresh display can override it, and FrameLedger cannot see which won. OpenGL and Vulkan games do not say,
and read N/A. ([Metrics](docs/03_METRICS.md))
## Upscaling and ray tracing
- **The render scale chart** (since 0.1.0-beta.14) is drawn only where the render resolution was measured — the
same games as *Render → output resolution* in the accuracy statement; elsewhere it says it was not measured.
- The upscaler is read from the game's calls: DLSS and NIS through NVIDIA Streamline, and FSR through AMD's
FidelityFX libraries. **Intel XeSS is not read** (its licence forbids it), FSR 2 and upscalers built into the
game are not identified, and Vulkan and OpenGL games read N/A. Where no hook saw DLSS but the NVIDIA driver
reports it, the page says it is the driver's report.
- **The quality preset** (Quality, Balanced, …) has not been reported on any game yet, and the render
resolution is N/A where the game's own calls do not carry it (DLSS without Streamline, for one).
- **Ray tracing** is *Yes*, *No* or *N/A* — measured from the game's ray-tracing calls on Direct3D 12, and
N/A where FrameLedger could not look. **Path tracing is never stated as a fact**: there is no API signal
for it. You can correct any of these by hand, and your correction is labelled as yours.
- HDR output, NVIDIA Reflex latency, the video-memory budget Windows gives a game, and shader-compilation
stutter are **not measured yet** — they read N/A. ([Accuracy](legal/ACCURACY.md))
## The game's memory
- **What is shown is what Task Manager's Details tab shows** for the game's process — *Dedicated GPU memory*,
*Shared GPU memory* and *Memory* (the private working set) — read from Windows once a second, from outside
the game. FrameLedger never looks inside the game's memory to get it.
- **One process.** A measured game is its own process; for a game that is not measured, every process running
the game's executable is added together. Launchers, crash reporters and other helper programs are not counted.
- **The private working set needs a recent Windows**: Windows 10 22H2 or Windows 11 with the September 2023
update or later. Without it the working set is shown instead, labelled as such.
- A game that has not created anything on the graphics card yet (its first second, a launcher screen) reads
N/A for video memory. AMD and Intel graphics cards have not been tested.
([Metrics](docs/03_METRICS.md))
## Display mode (full-screen, borderless, windowed)
- **Exclusive full-screen is known only for a measured Direct3D (DXGI) game** — the game's own swap chain
says so. For OpenGL, Vulkan and unmeasured games, a window covering the screen reads *Fullscreen or
borderless*, never either one.
- **What Windows does behind the game is not visible:** a game in exclusive full-screen may still be shown
through Windows' compositor ("fullscreen optimizations"), and a game's menu may call a borderless window
"Fullscreen". FrameLedger reports what the game asked for.
- The mode is sampled ten times a second in a measured session and once a second in an unmeasured one; very
short switches can be missed. A session recovered after a crash, and every session recorded before
beta.10, read N/A. ([Display mode](docs/03_METRICS.md#display-mode--both-tiers-beta10))
## Engine version
- The exact version is read for **Unreal Engine 4 and 5** games, from the game's executable file on disk.
A studio can remove or rename what it is read from; then the page says the version was not found.
**Unreal Engine 3 and older are not recognised.**
- Since beta.19 also **Unity**, **Godot** and **RPG Maker** (MV, MZ, XP, VX, VX Ace): from the engine's own files —
Unity's player library or data file, Godot's data pack, RPG Maker's core script or the runtime library its `Game.ini`
names. A Unity game whose data file is encrypted shows the version without its release letter (`2019.4.40`, not
`2019.4.40f1`); an XP, VX or VX Ace game shows its runtime library's number, which is not the editor's.
**RPG Maker 2000 and 2003 are not recognised.**
- Since beta.20 also **Ren'Py**: from the engine's own version file (`renpy/vc_version.py`); a Ren'Py game whose engine
names no version there shows none. Other engines show a version only where their files state one.
([Detection](docs/05_DETECTION.md))
## Sensors
- GPU temperature, load, power and memory are best supported on **NVIDIA** GPUs. **AMD and Intel GPUs have
not been tested** on real hardware yet.
- **On a PC with more than one graphics card**, the GPU figures follow the card the game draws on once a Direct3D game
has shown its first frame; before that, in an unmeasured session, and for OpenGL or Vulkan games they describe the
first card Windows lists, and with two cards of one brand the temperature and load come from that brand's first card.
The session's hardware details always name the first card. None of this has been tested on a machine with two cards.
([Telemetry](docs/18_GPU_VENDOR_APIS.md))
- **CPU temperature** needs *Run the agent as administrator* and the separately installed PawnIO driver, and
has not been verified on real hardware yet. CPU load is the time the processor was busy — not Task
Manager's "utility" figure, which can exceed 100%. ([Telemetry](docs/18_GPU_VENDOR_APIS.md))
- **Whether the graphics card was held back by its power limit or by heat** (since 0.1.0-beta.14) is known only on
NVIDIA cards, and only as it was at each once-a-second reading. On other cards it reads N/A.
- **Frames per watt** (since 0.1.0-beta.14) counts the game's own frames — never generated ones — against the graphics
card's power alone, not the processor's or the whole PC's. It reads N/A where the game's own frame rate is not known.
([Metrics](docs/03_METRICS.md))
## Running the agent as administrator
Off by default. When on, **Windows asks every time the agent starts** and names an unknown publisher, because
FrameLedger is not signed. It lets FrameLedger open games that run as administrator and read the CPU
temperature; it does not bypass anti-cheat, does not open protected processes, and does not make games you
start from FrameLedger run as administrator. **The risk:** FrameLedger is installed in your user folder, so a
program running under your account could replace its files and would then run as administrator the next time
you accept the prompt. Turn it on only if you trust everything that runs under your account.
([Architecture, ADR-9](docs/01_ARCHITECTURE.md))
## Platform and what has been tested
- **Windows 10 22H2 or Windows 11, 64-bit only.**
- The games FrameLedger has actually been run with, and what was measured on each, are listed in
[LIST_GAME_TESTED.md](docs/LIST_GAME_TESTED.md). Everything was measured on one machine (an NVIDIA
GeForce RTX 5080 with an Intel Core i7-14700KF on Windows 11); other hardware is untested.
- **One real Vulkan game has been measured** (Everhex Demo, 2026-10-13) **and no OpenGL game**, beyond FrameLedger's
own test program.
- There is **no in-game overlay**; everything is shown in the FrameLedger window.
- **FrameLedger does not tell whether a game is safe to run.** It reads a game's files to find its engine and its
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)).
## Play
- **Through GOG GALAXY or itch, you finish in their app.** GOG GALAXY runs the game as its own shortcuts do, and the
itch app asks which copy to launch. The Epic Games Launcher's link is the one its own shortcuts carry, and has not
been tried on a real Epic game yet.
- **FrameLedger never starts a game as administrator.** *Start directly* does not start a game that asks for it — start
that one from its store or its own shortcut — nor a game whose recording is off: FrameLedger starts only what it
records. While FrameLedger itself runs as administrator, Play starts every game directly, with your standard rights.
## Game artwork
- **Only the Steam and GOG GALAXY apps keep pictures FrameLedger can show** (since 0.1.0-beta.23). A game's page shows
the cover and banner those apps keep on your PC for a game they installed, read where they keep them — nothing is
downloaded or copied. A game from itch, the Epic Games Launcher or another store, or one whose `.exe` is outside a
store's own folder, shows a picture only once you choose one (**Edit… ▸ Choose image…**). A GOG picture needs Windows'
WebP support, which Windows 11 and most Windows 10 installs have. ([Game page](docs/08_UI.md))
- The pictures belong to the games' owners; FrameLedger ships none ([names and trademarks](legal/TRADEMARKS.md)).
## Your data
- Everything stays on your computer (`%LOCALAPPDATA%\FrameLedger`). FrameLedger sends no telemetry; its only
network requests are the update check and the update download, both to GitHub, and the check can be switched
off. The anti-cheat list and the detection rules ship with each version — **a newer list reaches you only with
the next update.** ([Privacy policy](legal/PRIVACY_POLICY.md))
- Per-frame data is kept for the **last 20 sessions of each game** (configurable); older sessions keep their
summaries.
- A newer version upgrades the database in place, and an **older version cannot open it again** — there is
no downgrade.
## Installation
FrameLedger's programs are **not code-signed**: Windows SmartScreen may warn when you install it, and the
administrator prompt names an unknown publisher. Each release publishes SHA-256 checksums you can compare.
**An update waits while a game FrameLedger measured is still running.** The part of FrameLedger loaded into a game stays
loaded until the game exits, and Windows will not let the update replace it; *Restart to update* says which file is held
until you close that game ([details](docs/11_UPDATER.md)). Copies older than 0.1.0-beta.14 look only for stable
releases unless you choose *Beta* in Settings ▸ Updates, and apply a downloaded update the next time they start.
+45
View File
@@ -0,0 +1,45 @@
FrameLedger
Copyright (C) 2026 poli0981 <contact@poli0981.dev>
FrameLedger is free software: you can redistribute it and/or modify it under the terms of the
GNU General Public License as published by the Free Software Foundation, version 3 of the
License only (GPL-3.0-only).
FrameLedger is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details. Its full text is in the file LICENSE
and at <https://www.gnu.org/licenses/gpl-3.0.html>.
ADDITIONAL TERMS UNDER SECTION 7 OF THE GNU GENERAL PUBLIC LICENSE, VERSION 3
These terms apply to the material in this repository authored by poli0981. They do not
apply to third-party components, which keep their own licences (legal/THIRD_PARTY_NOTICES.md).
Every first-party source file points here with the line
"Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE".
(b) Preservation of notices. You must preserve this notice, the copyright line above, and
the attribution "Based on FrameLedger by poli0981 - https://github.com/poli0981/frameledger"
in the Appropriate Legal Notices displayed by any work that contains this material
(in FrameLedger itself: Help > About).
(c) Marking of modified versions. A modified version you convey must be marked in
reasonable ways as different from the original version: it must not be named
"FrameLedger" alone, it must say in its Appropriate Legal Notices and in its
documentation that it is modified and by whom, and it must not present its builds,
installers or update feed as those of the original project.
(e) Trademarks. These terms grant no rights under trademark law to use the name
"FrameLedger", or the project's logo and icon, beyond describing the origin of a work
truthfully (for example "based on FrameLedger").
Section 7 of the GPL permits additional terms of the kinds its paragraphs (a) to (f) list;
the three above are of the kinds named in paragraphs (b), (c) and (e).
SEE ALSO
FORKING.md what a redistributor of a modified version is asked to change
legal/TRADEMARKS.md third-party names and marks
legal/THIRD_PARTY_NOTICES.md the third-party components and their licences
LICENSE the GNU General Public License, version 3
+107 -44
View File
@@ -4,25 +4,36 @@
> No telemetry. No accounts. All data stays on your machine.
**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.
<!-- accuracy-block:begin -->
> ⚠ **What FrameLedger actually measures today — 2026-09-15.** The software is pre-alpha and
> **unreleased**: no tagged build or installer has been published. The source holds the desktop app
> ⚠ **What FrameLedger actually measures today — 2026-10-13.** The software is a beta; its latest
> **pre-release is `0.1.0-beta.22`** (2026-10-13), an unsigned installer built from that tag with its
> checksums published beside it. 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, injects only into games you enabled and only past the safety guard, and
> game in the library runs (unless you switched its recording off), injects only into games you enabled
> and only past the safety guard, and
> stores sessions in a local database. What that path measures:
>
> - **Frame times and output resolution:** measured from the present call for Direct3D 11/12 and
> OpenGL titles FrameLedger injects into. Vulkan titles are measured only when FrameLedger itself
> starts the game with its Vulkan layer enabled, which today only the Agent's command-line launch
> does. A Vulkan title started any other way is not observed by the layer; FrameLedger injects its
> starts the game with its Vulkan layer enabled, which the Play button set to *Start directly* (since
> beta.21) and the Agent's command-line launch do. A Vulkan title started any other way is not
> observed by the layer; FrameLedger injects its
> Direct3D component into it instead, and what that records on a Vulkan title has not been
> verified. Direct3D 9 and every 32-bit title are not measured.
> - **Which upscaler is running:** measured from the API a Direct3D title calls — DLSS or NIS through
> NVIDIA Streamline (with Ray Reconstruction Yes/No), and FSR through AMD's shipped FidelityFX DLLs:
> named FSR 3 from the older DLLs, and FSR without a version from the newer ones, which host both
> FSR 3.1 and FSR 4. FSR 2, and FSR shipped any other way, is not identified. For DLSS titles that
> bypass Streamline, the NVIDIA driver's own per-process record is stored with the session, labelled
> *driver-reported*; the app does not display it yet. Intel XeSS is **not** read (its SDK licence
> bypass Streamline, the NVIDIA driver's own per-process record is stored with the session and shown
> as *DLSS (driver-reported)*. The NVIDIA driver's profile for the game — the DLSS and frame-generation
> overrides the NVIDIA App sets — is read, never changed, and shown as the driver's settings beside what
> was measured. Intel XeSS is **not** read (its SDK licence
> forbids it), and neither is an upscaler compiled into the game: those read `N/A`, or "Unknown
> upscaler" when another vendor's hook ran in the game. Vulkan and OpenGL titles read `N/A`.
> - **Quality preset:** not reported on any title measured. The one route this software may use — the
@@ -35,22 +46,64 @@
> - **Frame generation (Direct3D titles only):** the Displayed rate is counted from presents, plus the
> presents DXGI's own counter saw on the same swap chain that the hook did not; the Native rate from
> the vendor's own per-frame calls (NVIDIA Streamline, AMD FidelityFX) where the title makes them, and
> `N/A` where it does not. DLSS-G and FSR FG are named from the calls the game makes; any other
> generator (XeSS-FG, one compiled into the game) is shown only as active with the technology not
> identified, and is never named. Where a technology is named but its frames could not be counted, or
> frame generation is not measured, the software shows **Presented FPS** with a note on what it may
> include — never a Native figure.
> `N/A` where it does not. When frame generation did not stay in one state for the whole session
> (menus, loading screens, a settings change), no session-wide factor is shown: the factor, Native and
> Displayed are those of the state that held longest — five-second windows whose ratios agree within
> 10 %, covering at least 10 s and 10 % of the time the game was presenting — and are always shown with
> the share of the session they cover; with no such state, the reason is shown instead. DLSS-G and FSR
> FG are named from the calls the game makes; any other generator (XeSS-FG, one compiled into the game)
> is shown only as active with the technology not identified, and is never named. Where a technology is
> named but its frames could not be counted, or frame generation is not measured, the software shows
> **Presented FPS** with a note on what it may include — never a Native figure. Where generated frames
> were counted, the lows, median and stutter are taken over application frames only.
> - **Ray tracing:** Yes/No measured on Direct3D 12 from ray-dispatch and acceleration-structure-build
> calls; the technique and path tracing are `N/A`, and so is ray tracing on other APIs.
> - **Display mode:** how each game's window was shown — exclusive full-screen, borderless, windowed or
> minimised — as a share of the session, with the window's size and the monitor's, in every session.
> Exclusive full-screen is known only for Direct3D titles FrameLedger injects into, from the game's own
> swap chain; for every other session the window alone is read, and a window covering its monitor reads
> *full-screen or borderless*. What Windows does behind the game (fullscreen optimizations) is not visible.
> - **Engine version:** the exact Unreal Engine 4 or 5 version, read from the game's executable on disk and
> labelled with what it rests on; `N/A` where the executable names none. Since beta.19 also Unity's (from its
> player library or its data file — without the release letter where only the library's number is readable),
> Godot's (from its data pack) and RPG Maker's maker and version (MV and MZ from their core script; XP, VX and VX
> Ace by their runtime library's version, which is not the editor's). RPG Maker 2000/2003 is not detected. Since
> beta.20 also Ren'Py's (from its engine's version file). Other engines show what their own files state.
> - **The game's own memory (since beta.12):** its dedicated and shared GPU memory and its private
> working set — the numbers Task Manager's Details tab shows — with its working set and commit, read
> once a second from Windows' own counters, from outside the game, in every session: a game
> FrameLedger injects into through the handle it already holds, any other by opening it briefly with
> the least access Windows offers (and adding up every process running its executable). Shown with
> mean, median and peak. The game's other processes (launchers, helpers) are not counted.
> - **Video memory:** in use on the whole graphics card, recorded from Windows and GPU-driver telemetry
> and charted. **Not measured at all:** each game's own video-memory use and budget, which frame
> spikes were shader compilation, PC latency (Reflex), HDR, and CPU temperature. Stutter count and
> stutter time are measured from frame times.
> and charted. **Not measured at all:** the video-memory budget Windows gives a game, which frame
> spikes were shader compilation, PC latency (Reflex), and HDR. Stutter count and stutter time are
> measured from frame times.
> - **Pacing, VSync and the graphics card (since beta.14):** the share of the time below 30 FPS, below 60 FPS and below
> the monitor's refresh rate, measured from frame times with small margins so that a game held at its limit is not
> counted as below it (a rate less than 2 % under the line reads partly as at it), and how much one frame's time
> differs from the next; for Direct3D titles, how many frames asked to wait for the display and how many allowed
> tearing — what the game asked, not what the driver did; the graphics card's clock speeds, fan speed and memory
> temperature in every session, and, on NVIDIA cards only, how much of the time its power limit or its temperature held
> it back, read once a second; and frames per watt — the game's own frames per second for each watt the graphics card
> drew, never counting generated frames, `N/A` where the game's own frame rate is not known.
> - **Processor and memory:** how busy the processor was (time busy, all cores together — not the
> frequency-scaled figure Task Manager draws) and how much system memory was in use, read from
> Windows once a second and charted. Processor temperature is read only when the Agent runs as
> administrator — an option, off by default, for which Windows asks at every start of the Agent — with
> PawnIO installed, and that reading has not yet been checked on real hardware; everywhere else it is `N/A`.
> - **Safety:** every pre-injection check runs before injection, including the signed-by-a-known-vendor
> half of the suspicious-module rule. During every capture the Agent re-runs the checks every 30 s and
> stops capturing on a refusal: a Direct3D or OpenGL game's hooks are removed, and the Vulkan layer
> goes passthrough. A global switch in Settings turns all hooking off, and a running capture stops at
> its next check; it can only refuse, never permit. There is no override anywhere.
> its next check; it can only refuse, never permit. **There is no override.** A finding about a game — anti-cheat
> named in its process or in its folder (any kernel driver there counts), or the game on a title list by its
> store id or executable name — turns hooking off for that game, whether found by the Agent's own check of every
> game in the library, before injection, at a session's start or by the 30 s re-check; the game's page says so,
> and nothing turns it back on for that executable — except a user-mode exception you make yourself, per game,
> in Settings (off by default): only where the only finding is one anti-cheat that runs entirely in user mode, with
> no driver file in the game's folder. Its first two sessions are a trial, and one that does not go well ends it
> for good. The guard still runs every check under it and ends it on anything new; a ban remains possible.
>
> Where a value is not measured it reads `N/A`, with two exceptions: FPS then shows Presented FPS with a
> note on what it may include, and ray-tracing flags may show a value you set yourself, labelled as
@@ -69,7 +122,7 @@ Most tools tell you your frame rate. FrameLedger tells you **what produced that
- **Which upscaler is running** — DLSS / FSR, read from the API the game calls, not guessed from files on disk. Intel XeSS is not read: its SDK licence forbids it.
- **Frame Generation, measured** — native and generated frames counted separately. Shown as `62 → 118 FPS (×1.9 FG)` when both are counted, and as a qualified Presented FPS when they are not — never as one inflated number.
- **Ray tracing, actually detected** — including inline ray tracing (DXR 1.1 `RayQuery`), which frame-counting tools miss entirely.
- **Per-process VRAM** and whether the driver was exceeding its budget (a real stutter explanation).
- **The game's own VRAM and RAM** — Task Manager's figures for the game's process, read from outside the game in every session, with mean, median and peak (since beta.12). ~~and whether the driver was exceeding its budget~~ — the video-memory budget is not measured yet.
- **Shader-compilation stutter attribution** — which frame spikes were pipeline compiles.
- **PC latency** when the game uses Reflex.
@@ -86,7 +139,7 @@ FrameLedger is built to keep that risk small and to be honest about it:
| Safeguard | |
|---|---|
| **Off by default** | Injection is disabled for every game until you enable it individually, after a consent prompt |
| **Hard refusal** | Known anti-cheat/anti-tamper components are detected before injection and every 30 s during a session. Detected ⇒ FrameLedger refuses, or stops capturing at the next scan — so up to 30 s can pass before it reacts to anti-cheat that loads mid-session. For Direct3D/OpenGL that means hooks are removed; for Vulkan it means the layer goes passthrough, because a layer cannot leave the loader chain of a running game. **There is no override — not in settings, not in a config file, not on the command line**<br><br>✅ **Both halves run since 2026-09-10.** The *pre-injection* refusal runs every documented check, and during every capture the Agent re-runs them every 30 s: the component inside the game removes its hooks within one frame of being told to, and within 65 s if it stops hearing from the scanner. *(Until 2026-09-15 this cell said the in-session re-scan did not run at all, which stopped being true when the Agent's capture loop landed.)* For a Vulkan title the stop is the layer's own: it checks the scanner's counter on every present and goes passthrough within one present of the stop flag, or after 65 s without a scan — a title that has stopped presenting is not stopped by that deadline, and presents nothing to be observed either. |
| **Hard refusal** | Known anti-cheat/anti-tamper components are detected before injection and every 30 s during a session. Detected ⇒ FrameLedger refuses, or stops capturing at the next scan — so up to 30 s can pass before it reacts to anti-cheat that loads mid-session. For Direct3D/OpenGL that means hooks are removed; for Vulkan it means the layer goes passthrough, because a layer cannot leave the loader chain of a running game. **There is no override — not in settings, not in a config file, not on the command line**<br><br>**One narrow exception since beta.9 (owner decisions D33, D38):** per game, after its own disclosure and only while a Settings option (off by default) is on, a game whose only finding is one anti-cheat that runs entirely in user mode — no driver file in its folder, on no title list — may be hooked under a user-mode exception. ~~and that FrameLedger has measured successfully at least twice~~ *(corrected 2026-10-03: since beta.11, D38, a grant needs no earlier session; its first two hooked sessions are a trial, and one that does not go well ends it for good.)* The guard still runs every check under it, refuses anything else it finds, and ends it on anything new; a ban remains possible (`legal/DISCLAIMER.md` §2A).<br><br>✅ **Both halves run since 2026-09-10.** The *pre-injection* refusal runs every documented check, and during every capture the Agent re-runs them every 30 s: the component inside the game removes its hooks within one frame of being told to, and within 65 s if it stops hearing from the scanner. *(Until 2026-09-15 this cell said the in-session re-scan did not run at all, which stopped being true when the Agent's capture loop landed.)* For a Vulkan title the stop is the layer's own: it checks the scanner's counter on every present and goes passthrough within one present of the stop flag, or after 65 s without a scan — a title that has stopped presenting is not stopped by that deadline, and presents nothing to be observed either. |
| **No evasion, ever** | FrameLedger does not hide, rename, obfuscate, or disguise itself. It keeps its real name, real exports, and version info. It is meant to be plainly visible to any security software that looks. This is an architectural rule, not a setting |
| **Read-only** | It never reads or writes game memory, never modifies game behavior, never touches saves or input, and never changes GPU clocks, fans, or power limits |
| **Always a way out** | FrameLedger refuses rather than pushes through. When the guard finds anti-cheat, or the hook fails, or you have not enabled a game, it **stops** — and records the session anyway: start, end, duration, whatever hardware sensors your machine provides, and the reason there is nothing else. Every measured value reads `N/A`; it never estimates one.<br><br>**The way out is that it does not inject, not that it measures another way.** An earlier version of this row promised a no-injection measurement mode. It was designed around Intel PresentMon, that was dropped on 2026-08-27 after measurement, and no replacement was chosen — so **frame times require hooking**. Said in this row rather than a footnote because the row is in the SAFETY table, and a reader deciding whether to enable a game needs the real alternative, not a comfortable one |
@@ -98,32 +151,23 @@ FrameLedger is built to keep that risk small and to be honest about it:
| Tier | How | What you get |
|---|---|---|
| **1** | Injected hooks (opt-in, per game) | Everything above |
| **2** | None — nothing is injected | **Session duration, whatever hardware telemetry your machine can provide, and why there is nothing else** (which check refused, or that the hook failed, was not enabled, or the game is 32-bit). On NVIDIA that telemetry is measured to be GPU temperature, load, power, clocks, VRAM in use and fan speed, with no elevation; AMD and Intel are untested. Everything else reads `N/A` |
| **2** | None — nothing is injected | **Session duration, whatever hardware telemetry your machine can provide, the game's own memory use (read from Windows, outside the game; since beta.12), and why there is nothing else** (which check refused, or that the hook failed, was not enabled, or the game is 32-bit). On NVIDIA that telemetry is measured to be GPU temperature, load, power, clocks, VRAM in use and fan speed, with no elevation; AMD and Intel are untested. Everything else reads `N/A` |
The tier is recorded on every session and shown in the UI. Metrics unavailable at a session's tier read `N/A` — FrameLedger never substitutes an estimate for a measurement.
> **This ladder used to have three rungs and a middle one that measured frame times without injecting.** It was to be built on Intel PresentMon; that was dropped on 2026-08-27 after measurement, and no replacement was chosen. **So frame times, FPS and the lows are now Tier-1-only.** Said plainly because the previous README promised them without injection, and a reader who remembers that would otherwise assume it still holds.
## Architecture
| Component | Runs as | Role |
|---|---|---|
| `FrameLedger.exe` | Standard user | Fluent desktop UI (WPF + [WPF UI](https://github.com/lepoco/wpfui)), charts, library, settings |
| `FrameLedger.Agent.exe` | Standard user (elevation optional) | Injection control, safety guard, data collection, GPU telemetry, storage |
| `FrameLedger.Overlay.dll` | Inside the game | C++20 hooks + lock-free shared-memory writer. Records only; never analyzes, allocates, or blocks |
| `FrameLedger.VkLayer.dll` | Inside the game | Vulkan implicit layer (Vulkan titles use this instead of injection) |
Elevation is **optional — for everything.** Hooked capture is the normal path and runs as a standard user, and there is no longer any tier that needs more than that. Elevation unlocks exactly two extras: CPU temperature sensors (not read yet — see the block above), and attaching to games that themselves run elevated. ~~and the Tier-2 ETW fallback. If you expect to rely on Tier 2, run the Agent elevated.~~ — there is no ETW fallback to rely on.
## Requirements
- Windows 10 (22H2) or Windows 11, 64-bit
- A 64-bit DirectX 11/12 or OpenGL game, or a Vulkan game FrameLedger starts, for hooked (Tier-1) capture. **32-bit games — including most DirectX 9 titles — cannot be measured at all**: the component FrameLedger loads is x64 and an x64 DLL cannot enter a 32-bit process. Such a title records duration and hardware telemetry and nothing else. *(This line previously said "supported at Tier 2 only", which meant frame times without injection. That tier no longer exists.)*
- Optional: [PawnIO](https://pawnio.eu/) for CPU temperature, which is not read yet (GPU telemetry works without it, through your graphics driver's own libraries)
- Optional: [PawnIO](https://pawnio.eu/) for CPU temperature, read only when the Agent runs as administrator (since 0.1.0-beta.3; not yet checked on real hardware). CPU load, memory in use and all GPU telemetry work without it
Elevation is **optional — for everything.** Hooked capture is the normal path and runs as a standard user, and there is no longer any tier that needs more than that. Elevation unlocks exactly two extras: CPU temperature sensors (~~not read yet~~ read with PawnIO, not yet checked on real hardware — see the block above), and attaching to games that themselves run elevated. ~~and the Tier-2 ETW fallback. If you expect to rely on Tier 2, run the Agent elevated.~~ — there is no ETW fallback to rely on. **Since beta.10 it is a choice in Settings** — *Run the agent as administrator*, off by default: Windows asks every time the agent starts, games you start from FrameLedger still run as you, and `LIMITATIONS.md` says what it does not change.
## Install
> **No release has been published yet.** The steps below are for the first tagged release; until then FrameLedger runs only from a source build (`docs/12_BUILD.md`).
> **The latest pre-release is `v0.1.0-beta.22` (2026-10-13); before it `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 `CHANGELOG.md`'s section for the one you install — 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**.
@@ -131,26 +175,45 @@ Elevation is **optional — for everything.** Hooked capture is the normal path
## Privacy
Everything lives locally in `%LOCALAPPDATA%\FrameLedger`. The only network calls FrameLedger will ever make: update checks against GitHub Releases, detection-rules updates from this repository, and *optional, opt-in* store metadata lookups. Bug reports are always built locally, shown to you, and submitted by you. Full policy: [`legal/PRIVACY_POLICY.md`](legal/PRIVACY_POLICY.md).
**Today it makes one of them: the update check** — at startup, a few seconds after launch, unless you turn it off in Settings ▸ Updates, and when you choose Help ▸ Check for updates — plus the download of an update you accepted; both go to GitHub Releases, from an installed copy only, and nothing is applied until you restart (never while a game is hooked). The rules feed does not exist — the blocklist ships with the build and updates only when you install a new one (`docs/20_OPEN_QUESTIONS.md` §S20). Listing a fetch that has no code is over-disclosure, and this document was already corrected once for describing a weekly outbound request the software never made.
Everything lives locally in `%LOCALAPPDATA%\FrameLedger`. The only network calls FrameLedger makes are **the update check** — a few seconds after launch unless you turn it off in Settings ▸ Updates, and when you choose Help ▸ Check for updates — and **the download of an update you accepted**; both go to GitHub Releases, from an installed copy only, and nothing is applied until you restart (never while a game is hooked). There is no other request: the anti-cheat blocklist and the detection rules ship with the build and update only when you install a new one (`docs/20_OPEN_QUESTIONS.md` §S20), and nothing is looked up on any store. Bug reports are always built locally, shown to you, and submitted by you. Full policy: [`legal/PRIVACY_POLICY.md`](legal/PRIVACY_POLICY.md) — version 2.2 removed the three rows (a rules feed twice over, a Steam lookup) that earlier versions listed for requests the software never made.
## License
GPL-3.0-only. See `LICENSE`. Third-party components: [`legal/THIRD_PARTY_NOTICES.md`](legal/THIRD_PARTY_NOTICES.md).
GPU telemetry is layered so the project never depends on a proprietary vendor licence: a vendor-neutral DXGI/performance-counter baseline, LibreHardwareMonitor (MPL-2.0) for sensors on all vendors, and NVIDIA's NVAPI SDK (MIT) for NVIDIA-only extras (telemetry and the driver's DLSS record today; Reflex latency is not read yet). No Intel or AMD GPU *telemetry* SDK is bundled — see `docs/18_GPU_VENDOR_APIS.md` for why. The one AMD component in the tree is five MIT headers from the FidelityFX SDK, used for types only so the upscaler hook can read an FSR title's own dispatch descriptor; nothing AMD-built is linked or redistributed.
## Documentation
Developer/AI-facing docs in [`docs/`](docs/). Start with `CLAUDE.md`, then `docs/19_SAFETY_AND_ANTICHEAT.md` (which constrains everything else), then `docs/01_ARCHITECTURE.md`.
GPL-3.0-only (see `LICENSE`), with the additional terms in [`NOTICE`](NOTICE) that GPLv3 section 7 permits: keep the copyright line and the attribution, mark a changed version as changed and do not call it "FrameLedger" alone, and no trademark rights in the name ([`legal/TRADEMARKS.md`](legal/TRADEMARKS.md)). In the app: Help ▸ About. Third-party components: [`legal/THIRD_PARTY_NOTICES.md`](legal/THIRD_PARTY_NOTICES.md).
## Reporting a safety gap
If you find a game with anti-cheat that FrameLedger fails to detect, please open an issue — **that is a safety bug and is treated with the same priority as a security report.**
If you find a game with anti-cheat that FrameLedger fails to detect, please open an issue with the *Safety gap* form — **that is a safety bug and is treated with the same priority as a security report.** A vulnerability in FrameLedger itself takes the private route in [`SECURITY.md`](SECURITY.md).
**How fast a fix can reach you, stated accurately.** Blocklist entries are data rather than code, so a fix is a one-line change here. But the software has **no rules-update path yet**: it installs the blocklist that shipped with your build and never fetches another (`docs/20_OPEN_QUESTIONS.md` §S20, feed half). Until that exists, a blocklist fix reaches you **only when you install a new release**. This paragraph previously said the opposite, and the sentence it said it in was a response-time promise attached to a security-priority commitment.
## For developers and forks
FrameLedger is GPL-3.0-only free software, and you are welcome to build it, change it and redistribute it.
- **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).
- **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
links to the document it summarises ([`wiki/`](wiki/) is their source).
- **Read the design:** the developer documentation is in [`docs/`](docs/). Start with [`CLAUDE.md`](CLAUDE.md), then
[`docs/19_SAFETY_AND_ANTICHEAT.md`](docs/19_SAFETY_AND_ANTICHEAT.md) — which constrains everything else — then
[`docs/01_ARCHITECTURE.md`](docs/01_ARCHITECTURE.md).
### Architecture
| Component | Runs as | Role |
|---|---|---|
| `FrameLedger.exe` | Standard user | Fluent desktop UI (WPF + [WPF UI](https://github.com/lepoco/wpfui)), charts, library, settings |
| `FrameLedger.Agent.exe` | Standard user — as administrator only when you turn that on in Settings, and Windows asks at every start (beta.10) | Injection control, safety guard, data collection, GPU telemetry, storage |
| `FrameLedger.Overlay.dll` | Inside the game | C++20 hooks + lock-free shared-memory writer. Records only; never analyzes, allocates, or blocks |
| `FrameLedger.VkLayer.dll` | Inside the game | Vulkan implicit layer (Vulkan titles use this instead of injection) |
GPU telemetry is layered so the project never depends on a proprietary vendor licence: a vendor-neutral DXGI/performance-counter baseline, LibreHardwareMonitor (MPL-2.0) for sensors on all vendors, and NVIDIA's NVAPI SDK (MIT) for NVIDIA-only extras (telemetry and the driver's DLSS record today; Reflex latency is not read yet). No Intel or AMD GPU *telemetry* SDK is bundled — see `docs/18_GPU_VENDOR_APIS.md` for why. The one AMD component in the tree is five MIT headers from the FidelityFX SDK, used for types only so the upscaler hook can read an FSR title's own dispatch descriptor; nothing AMD-built is linked or redistributed.
---
**Status:** pre-alpha, under active development. Roadmap: [`docs/15_ROADMAP.md`](docs/15_ROADMAP.md).
**Status:** pre-release (beta). Twenty-two tagged pre-releases so far; see `CHANGELOG.md` for what each one changed and the accuracy block at the top of this file for what is and is not measured. It is not feature-complete, it certainly still has bugs, and `legal/DISCLAIMER.md` §0 says what that means for you.
+72
View File
@@ -0,0 +1,72 @@
# Security policy
FrameLedger loads a component into game processes that the user has individually enabled, and it
refuses to do so when it detects anti-cheat or anti-tamper software. Two kinds of report matter here,
and they take different routes.
## A vulnerability in FrameLedger
Anything that could let FrameLedger be used against the person running it or against a third party:
a way to make the Agent inject into a process the user did not enable, a way past the anti-cheat
guard, a way to make the hook read or write game memory it does not own, a way to make the App or
Agent execute something from an untrusted source, a privacy leak (data leaving the machine, or the
bug bundle carrying what the privacy policy says it does not).
**Report it privately.** Use GitHub's private vulnerability reporting on this repository when it is
enabled (Security ▸ Report a vulnerability); otherwise e-mail <contact@poli0981.dev>. Please do not
open a public issue for a vulnerability until a fix has shipped.
What helps: the version (Help ▸ About, or `FrameLedger.exe --diag`), the steps, and what you observed.
What to leave out: instructions for defeating any anti-cheat system — FrameLedger needs to know what
to refuse, never how to evade (`docs/19_SAFETY_AND_ANTICHEAT.md`).
This is a one-person project. The intent is to acknowledge a private report within a week and to say
plainly what will happen next; that is an intent, not a contractual response time.
## The guard has no override
For two pre-releases (0.1.0-beta.3 and beta.4) a user could overrule the anti-cheat guard for one game through a
disclosure. That switch was withdrawn on 2026-09-22 (`docs/19_SAFETY_AND_ANTICHEAT.md` §What a finding does to the game): a finding
now turns the game's hooking off. What IS a security report: any way to reach an injection past a refusal — a flag, a
setting, a crafted rules file, a pipe message, a database edit the Agent honours — or a finding about a game that
does not turn its hooking off.
Since 0.1.0-beta.9 one narrow exception exists (owner decision D33, `docs/19_SAFETY_AND_ANTICHEAT.md` §The user-mode
exception): per game, only for one anti-cheat family that is user-mode throughout, with the guard still running every
check. The grant is a record in your own database, like the consent stamp; what keeps it narrow is the guard, which
decides itself which family it may let through. So these are security reports too: the guard letting through a family
that has a driver, a service or a `.sys` in the floor or the rules; an exception applying to a game with a kernel
driver in its folder, on a title list, or with a second anti-cheat; the Agent writing a grant on a pipe message
without its own tolerant pre-scan; an exception that survives a new finding, a crash or safety stop under it, or a
changed executable; since 0.1.0-beta.11 (D38), an exception that survives a session during its two-session trial that
did not go well, and any grant written for a game whose earlier exception failed its trial; and the Overlay tolerating
a family the guard did not.
## Running the agent as administrator
Since 0.1.0-beta.10 the capture agent can run as administrator — an option, off by default (owner decision D34,
`docs/01_ARCHITECTURE.md` ADR-9) — and Windows asks at every start of the agent. The residual risk is stated to the user
rather than solved: FrameLedger installs per user and unsigned, so a program running under the same account could replace
its files and be run as administrator when the user next accepts the prompt. What IS a security report: any way the
agent becomes administrator WITHOUT that prompt (a task, a service, an inherited token the option did not choose); a game
or any other program that an elevated agent starts with its own token instead of the desktop shell's; any privilege the
agent enables (none is — `tools/chokepoint-check.ps1` forbids the enablers under `src/`); an elevated agent that runs for
another account than the one that asked; and a named object an elevated agent creates that the same user's unelevated
processes can no longer open, or that another user can.
## A safety gap — a game with anti-cheat that FrameLedger fails to detect
This is treated with the same priority as a security report, and it takes the **public** route: open
an issue with the *Safety gap* form (`.github/ISSUE_TEMPLATE/safety_gap.yml`). Blocklist entries are
data (`rules/detection-rules.json`), so the fix is small — but the software has no rules-update path
yet, so a fix reaches installed copies only with the next release (`README` §Reporting a safety gap
says the same, and `docs/20_OPEN_QUESTIONS.md` §S20 carries the feed that would change it).
## Scope notes
- Releases are not code-signed; `SHA256SUMS.txt` is published beside every asset (`docs/11_UPDATER.md`
§Unsigned releases). A report that an installer's hash does not match what the release lists is a
security report.
- The evasion techniques FrameLedger will never implement are listed in `docs/19_SAFETY_AND_ANTICHEAT.md`.
A pull request that makes FrameLedger harder for anti-cheat to see is declined on principle, not
reviewed for quality.
+85 -26
View File
@@ -1,3 +1,6 @@
# SPDX-License-Identifier: GPL-3.0-only
# Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
#Requires -Version 7.0
<#
.SYNOPSIS
@@ -68,6 +71,25 @@ function Invoke-Checked([string]$What, [scriptblock]$Body) {
if ($LASTEXITCODE -ne 0) { throw "$What failed (exit $LASTEXITCODE)" }
}
<#
`dotnet test` under a wall-clock limit (2026-09-17). `--blame-hang` does not stop a deadlocked xUnit v3 test
executable — measured: the hung process was still alive four minutes after a 60 s hang timeout — so a hang spent the
CI job's whole 60-minute budget and named nothing (the first tag's release run, 2026-09-16). This kills the process
tree after $Minutes and names the test projects that wrote no results.trx: the ones that did not finish.
#>
function Invoke-TestsWithin([int]$Minutes, [string[]]$Arguments) {
$p = Start-Process -FilePath 'dotnet' -ArgumentList $Arguments -NoNewWindow -PassThru
$null = $p.Handle # Start-Process quirk: without a cached handle ExitCode reads empty after exit
if (-not $p.WaitForExit($Minutes * 60 * 1000)) {
& taskkill /T /F /PID $p.Id 2>&1 | Out-Null
$unfinished = @(Get-ChildItem (Join-Path $repo 'tests') -Directory -Filter '*.Tests' |
Where-Object { -not (Test-Path (Join-Path $_.FullName 'TestResults/results.trx')) } |
ForEach-Object { $_.Name })
throw "dotnet test did not finish within $Minutes minutes — a test hung, and the process tree was killed. No results.trx from: $($unfinished -join ', ')"
}
if ($p.ExitCode -ne 0) { throw "dotnet test failed (exit $($p.ExitCode))" }
}
<#
Clear an ambient Platform variable before any MSBuild invocation.
@@ -253,18 +275,24 @@ function Invoke-Managed([bool]$FixFormat) {
Remove-Item -Recurse -Force -ErrorAction SilentlyContinue
# --logger trx so downstream gates can assert that a NAMED test executed,
# not merely that the run was green. The struct-mirror gate below reads it.
#
# --blame-hang: a test that never returns names itself and fails the run after
# 15 minutes, instead of eating the job's timeout. The first tag run
# (v0.1.0-beta.1, 2026-09-16, run 35111939019) sat in Infrastructure.Tests for
# 58 minutes — every other suite green, the whole suite 42 s the run before —
# until the 60-minute job limit cancelled it, and the log named nothing. The
# timeout is per test host, well above the slowest suite (Agent, ~1.5 min on
# the hosted runner); the mini dump goes to TestResults beside the trx.
# --blame-hang did NOT stop the deadlocked xUnit v3 executable it was added for (measured 2026-09-17); the
# wall-clock limit of Invoke-TestsWithin is what bounds a hang now. The suite takes 4-5 minutes on the runner.
$testArgs = @('test', "`"$solution`"", '-c', $Configuration, '--no-build', '--collect:"XPlat Code Coverage"',
'--logger', 'trx;LogFileName=results.trx')
if ($SkipIntegration) {
Skip-Gate 'integration tests' 'the guard refuses a .NET test host that loads a `protect`-matching module (20_OPEN_QUESTIONS §S19(b)) — run ./build.ps1 check with no switches to include them'
Invoke-Checked 'dotnet test' {
dotnet test $solution -c $Configuration --no-build --collect:"XPlat Code Coverage" `
--logger 'trx;LogFileName=results.trx' --filter 'Category!=Integration'
}
Invoke-TestsWithin 25 ($testArgs + @('--filter', 'Category!=Integration'))
}
else {
Invoke-Checked 'dotnet test' {
dotnet test $solution -c $Configuration --no-build --collect:"XPlat Code Coverage" `
--logger 'trx;LogFileName=results.trx'
}
Invoke-TestsWithin 25 $testArgs
}
# The cobertura reports above were produced and ignored from the day the
@@ -274,12 +302,10 @@ function Invoke-Managed([bool]$FixFormat) {
# so the number is never negotiated against code that already exists.
Write-Step 'coverage-gate'
$coverageTool = Join-Path $repo 'tools/coverage-gate.ps1'
if (Test-Path $coverageTool) {
Invoke-Checked 'coverage-gate' { & $coverageTool }
}
else {
Skip-Gate 'coverage-gate' 'tools/coverage-gate.ps1 not implemented yet'
}
# The tool has existed since P2. A missing file is a broken checkout, and this script's own header says why a gate
# must not read as "skipped" then: it would say "checked" in CI output when nothing was (corrected 2026-09-21).
if (-not (Test-Path $coverageTool)) { throw 'tools/coverage-gate.ps1 is missing; the coverage gate cannot be skipped' }
Invoke-Checked 'coverage-gate' { & $coverageTool }
}
# --- 7-9. Project-specific gates -------------------------------------------
@@ -288,23 +314,33 @@ function Invoke-ProjectGates {
# failure (docs/13_CI_CD.md).
Write-Step 'rules-validate'
$rulesTool = Join-Path $repo 'tools/rules-validate.ps1'
if (Test-Path $rulesTool) {
Invoke-Checked 'rules-validate' { & $rulesTool }
}
else {
Skip-Gate 'rules-validate' 'tools/rules-validate.ps1 not implemented yet'
}
if (-not (Test-Path $rulesTool)) { throw 'tools/rules-validate.ps1 is missing; the rules gate cannot be skipped' }
Invoke-Checked 'rules-validate' { & $rulesTool }
# Being plainly identifiable to anti-cheat is a requirement, not packaging
# polish (docs/19_SAFETY_AND_ANTICHEAT.md). Reads the built binary, because
# what ships is what an anti-cheat vendor sees.
#
# beta.14 (D50): BOTH HALVES. The rules prove themselves first (ten cases,
# nine RED, each for its own reason), then the live pass reads the native five
# and the managed eight from the App's and the Agent's build output, whose
# ProductVersion is the VERSION file's here (release.yml passes the tag's).
# Under -SkipNative the managed half still runs.
Write-Step 'versioninfo-check'
$versionTool = Join-Path $repo 'tools/versioninfo-check.ps1'
if ((Test-Path $versionTool) -and -not $SkipNative) {
Invoke-Checked 'versioninfo-check' { & $versionTool -BuildDir (Join-Path $repo "build/native/x64-$($Configuration.ToLower())") }
}
elseif ($SkipNative) {
Skip-Gate 'versioninfo-check' 'native build skipped, so there is no binary to inspect'
if (Test-Path $versionTool) {
Invoke-Checked 'versioninfo-check (self-test)' { & $versionTool -SelfTest }
$managedDirs = @('FrameLedger.App', 'FrameLedger.Agent' | ForEach-Object { Join-Path $repo "src/$_/bin/$Configuration" })
$productVersion = (Get-Content (Join-Path $repo 'VERSION') -Raw).Trim()
if ($SkipNative) {
Invoke-Checked 'versioninfo-check (managed)' { & $versionTool -ManagedOnly -ManagedDir $managedDirs -ExpectedProductVersion $productVersion }
Skip-Gate 'versioninfo-check (native)' 'native build skipped, so there is no binary to inspect'
}
else {
Invoke-Checked 'versioninfo-check' {
& $versionTool -BuildDir (Join-Path $repo "build/native/x64-$($Configuration.ToLower())") -ManagedDir $managedDirs -ExpectedProductVersion $productVersion
}
}
}
else {
Skip-Gate 'versioninfo-check' 'tools/versioninfo-check.ps1 not implemented yet'
@@ -387,7 +423,7 @@ function Invoke-ProjectGates {
Write-Step 'license-check'
$licenseTool = Join-Path $repo 'tools/license-check.ps1'
if (Test-Path $licenseTool) {
# P4 PR-6: the NuGet half's generator proves itself first (fourteen cases, five that must be RED), then
# P4 PR-6: the NuGet half's generator proves itself first (sixteen cases since beta.12, six that must be RED), then
# license-check runs its live -Check over this build's restore output as its section 3.
Invoke-Checked 'license-gather (self-test)' { & (Join-Path $repo 'tools/license-gather.ps1') -SelfTest }
Invoke-Checked 'license-check' { & $licenseTool }
@@ -420,6 +456,23 @@ function Invoke-ProjectGates {
Skip-Gate 'accuracy-check' 'tools/accuracy-check.ps1 not implemented yet'
}
# beta.12 (D45): GPLv3 section 7 wants additional terms named "in the relevant source files", so every
# first-party source file opens with the SPDX line and the NOTICE pointer. Self-test first (seven cases, both
# directions), then the live pass over the tracked tree; ./tools/notice-check.ps1 -Fix writes a missing header.
Write-Step 'notice-check'
$noticeTool = Join-Path $repo 'tools/notice-check.ps1'
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
# 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.
Write-Step 'wiki-check'
$wikiTool = Join-Path $repo 'tools/wiki-build.ps1'
Invoke-Checked 'wiki-check (self-test)' { & $wikiTool -RepoRoot $repo -SelfTest }
Invoke-Checked 'wiki-check' { & $wikiTool -RepoRoot $repo -Check }
Write-Step 'changelog-check'
$changelogTool = Join-Path $repo 'tools/changelog-check.ps1'
if (Test-Path $changelogTool) {
@@ -435,6 +488,12 @@ function Invoke-ProjectGates {
Write-Step 'release-notes'
Invoke-Checked 'release-notes (self-test)' { & (Join-Path $repo 'tools/release-notes.ps1') -SelfTest }
# beta.18: the build id a release hands CMake (read from the clean checkout before the date substitution edits
# legal/*.md) is read back out of the published native binaries by release.yml. Self-test only here — the live
# pass needs that id, which only a release has (12_BUILD §Release-time token substitution).
Write-Step 'buildid-check'
Invoke-Checked 'buildid-check (self-test)' { & (Join-Path $repo 'tools/buildid-check.ps1') -SelfTest }
# 09_I18N's gate, built with the first .resx family (P3 PR-2, 2026-09-13): every key in en/vi/ja, ja
# Safety_* marked for human review, the generated accessor current. Self-test first (at least four
# cases must go red), then the live pass; a tree with no family is red, not skipped.
+45 -9
View File
@@ -23,11 +23,18 @@
│ ├ upscaler hooks: NGX · Streamline · FFX · XeSS │
│ ├ RT hooks: CreateStateObject · DispatchRays · BuildRaytracingAS │
│ ├ PSO hooks: pipeline creation (stutter attribution) │
│ ├ per-process VRAM: IDXGIAdapter3::QueryVideoMemoryInfo │
│ ├ (per-process VRAM via QueryVideoMemoryInfo: never built — D43 reads │
│ │ the game's memory from outside, in the Agent's ProcessStats.dll) │
│ └ ring writer (allocation-free, lock-free, SEH-guarded) │
└───────────────────────────────────────────────────────────────────────────┘
```
> **Corrected 2026-10-04 — the game-process box names hooks that were never built.** ~~NGX · XeSS ·
> CreateStateObject · PSO hooks~~: NGX is licence-blocked, XeSS stops at the runtime census by licence, and
> `CreateStateObject` and pipeline creation are unwritten rows of `17_HOOK_ENGINE` §Hook inventory. What the Overlay
> does install: the DXGI present path, `wglSwapBuffers`, the Streamline and FidelityFX entry points, the two
> `ID3D12GraphicsCommandList4` ray-tracing methods, and the `LoadLibraryExW` wake.
> `*` **`AntiCheatGuard` is a facade, not an implementation.** The guard is
> native (`20_OPEN_QUESTIONS` §S13(a)); the box above is the P/Invoke wrapper
> in `Infrastructure` that the Agent calls. Nothing managed parses rules or
@@ -57,8 +64,8 @@
| Tier | Mechanism | Gets you | When used |
|---|---|---|---|
| **1** | Injected hooks (default when the user enabled it and the guard passed) | Everything: exact render/output res, upscaler + quality, FG ground truth, RT/PT evidence, per-process VRAM, PSO stutter attribution, Reflex latency, present flags | Offline/single-player titles the user opted in |
| **2** | None | **Session duration, whatever hardware telemetry this machine can provide, and the REASON there is nothing else** — which check refused, or that the hook failed, was not enabled, or the target is 32-bit. Every measured field reads `N/A` (FR-4.9) | Guard refused, hook failed, user chose not to hook, or a target the Overlay structurally cannot enter |
| **1** | Injected hooks (default when the user enabled it and the guard passed) | Everything: exact render/output res, upscaler + quality, FG ground truth, RT ~~/PT~~ evidence, ~~per-process VRAM, PSO stutter attribution, Reflex latency,~~ present flags *(corrected 2026-10-04: path tracing, the in-game VRAM, PSO attribution and Reflex latency have no producer — `05_DETECTION` §Runtime facts)* | Offline/single-player titles the user opted in |
| **2** | None | **Session duration, whatever hardware telemetry this machine can provide, and the REASON there is nothing else** — which check refused, or that the hook failed, was not enabled, or the target is 32-bit. Every ~~measured~~ frame field reads `N/A` (FR-4.9) *(corrected 2026-10-04: two facts are measured from outside the game in both tiers — the display mode (beta.10) and the game process's memory (beta.12, D43))* | Guard refused, hook failed, user chose not to hook, or a target the Overlay structurally cannot enter |
Tier is recorded per session (`sessions.capture_tier`) and shown in the UI, because metric availability differs and comparing across tiers must be explicit.
@@ -90,9 +97,19 @@ Guard re-runs every 30 s for the life of the session; anti-cheat appearing late
- Agent idles at ~0% CPU: 1 Hz process poll. No capture machinery exists until a tracked game launches.
- Session ends when the process tree exits, or on safety unhook, or on user stop.
- The DLL is **not unloaded** from a live process after unhooking (threads may still be inside trampolines). It disables its hooks, stops writing, and goes dormant until the process exits. Documented, deliberate.
- UI exit does not stop the Agent when background capture is enabled; otherwise UI sends `Shutdown`.
- ~~UI exit does not stop the Agent when background capture is enabled; otherwise UI sends `Shutdown`.~~ *(Corrected 2026-10-04: closing the UI never stops the Agent. `Shutdown` is sent only for an update, by the uninstall hook and for the admin mode's restart; the background-capture setting was read by nothing, and its switch is gone since beta.12 — `06_DATA_MODEL` §Settings registry.)*
- Single instance via named mutexes; the ring name is per-PID so multiple games can be captured simultaneously (rare but supported).
> **The single instance was specified here and not built until 2026-09-17**, and 0.1.0-beta.1 ran four Agents: an
> App started as administrator was refused by the pipe of the Agent already serving (`07_IPC` §C, amended the same
> day), took the refusal for an absent Agent, and started another on each connect round — and every game launched in
> the next hour was injected, read and recorded by all four. **Built:** `Infrastructure.Startup.AgentInstanceLock`,
> one named mutex per data folder (`Local\FrameLedger.Agent.<hash of the folder>`), claimed by `--serve` and the
> console's capturing verbs (`capture`, `launch`, `recover`) before logging, rules or the ledger; a second process
> exits **10** with one line on stderr. The App probes the same claim before it starts an Agent (`07_IPC` §Client
> behavior). What it does not cover: two Agents on two data folders (a developer's `--console --data-dir` beside the
> installed Agent) can still both attach to one game's ring — `20_OPEN_QUESTIONS` §G, Agent lifecycle.
## Failure domains
| Failure | Behavior |
@@ -100,12 +117,12 @@ Guard re-runs every 30 s for the life of the session; anti-cheat appearing late
| Anti-cheat detected pre-injection | Refuse, explain which signal fired, offer Tier 2 |
| Anti-cheat detected mid-session | Immediate clean unhook, `exit_status = unhooked_safety`, prominent notice |
| Injection API fails (access denied, protected process) | Log, no retry loop, offer Tier 2 + "run Agent elevated" hint — elevation here is about *attaching to an elevated target*, not about reaching a tier; Tier 2 needs none |
| Hook faults 3× | DLL self-disables, sets fault flag in handshake block, Agent finalizes session as `degraded` |
| Hook faults 3× | DLL self-disables, sets ~~fault flag in handshake block~~ `FlWriterState.status` to `SELF_DISABLED` *(corrected 2026-10-04)*, Agent finalizes session as `degraded` |
| Game crashes ≤ 60 s after injection, twice | Hooking auto-disabled for that game, Tier 2 takes over |
| Ring overflow (Agent stalled) | Overwrite-oldest; dropped count published in the ring header → session flagged with a data-quality warning |
| Ring overflow (Agent stalled) | Overwrite-oldest; ~~dropped count published in the ring header~~ the Agent counts drops from its own read index *(corrected 2026-10-04: the writer keeps no reader index and publishes no count — `04_CAPTURE` §Ring draining)* → session flagged with a data-quality warning |
| Layout/version mismatch DLL ↔ Agent | Agent refuses to attach, tells user to restart the game after update |
| Vendor API unavailable (no NVAPI etc.) | GPU telemetry degrades to `N/A`; frame metrics unaffected |
| DB locked/corrupt | Integrity check + backup-and-recreate in Tools |
| DB locked/corrupt | Integrity check + backup~~-and-recreate~~ in Tools ▸ Database maintenance *(corrected 2026-10-04: there is no recreate action)* |
## Data directory
@@ -116,11 +133,16 @@ ledger.db SQLite (WAL)
rules\detection-rules.json engine/platform/feature + anticheat blocklist
logs\ui-*.log, agent-*.log, overlay-<pid>-*.log (native log flushed at session end, never mid-frame)
crashdumps\*.dmp
breadcrumbs\<pid>.json pre-injection breadcrumb (19_SAFETY §Crash safety)
breadcrumbs\<pid>.json (corrected 2026-10-04: never created — the breadcrumb is the .partial file's header and notes)
tmp\<sessionGuid>.partial crash-safety flush of raw buffers, every 60 s (04_CAPTURE §Ring draining)
covers\*.jpg
covers\game-<id>-<ms>.png the images users chose for their games (beta.23, D60) — ~~covers\*.jpg, never created~~;
a store app's own artwork is shown from where that app keeps it, never copied here
```
*(beta.15, D52: `FrameLedger.exe --data-dir <folder>` reads a COPY of this folder instead — a viewer that starts and
contacts no Agent and changes nothing on the PC, with its own `logs\` and `crashdumps\` beside the copy; `08_UI` §Shell.
The profile's own folder is refused there.)*
## Key design decisions (ADR)
- **ADR-1 (superseded):** ~~Passive ETW only; injection out of scope.~~ Replaced by ADR-7.
@@ -132,3 +154,17 @@ covers\*.jpg
- **ADR-7 (2026-07, core change):** **Capture moves to in-process graphics-API hooking**, C++20 DLL + MinHook, with a Vulkan implicit layer for Vulkan. Rationale: passive detection of DLSS/upscaling/frame-generation/RT state showed large errors against real games; those states are only knowable at the API boundary. Trade-offs accepted: anti-cheat exposure (mitigated by the hard guard in `19_SAFETY`, offline titles only), crash risk in the host process (mitigated by SEH guards + fault policy + auto-disable), a second toolchain in the build, and per-API maintenance as vendors change SDKs. Scope limited to titles the user explicitly opts in.
- **ADR-8:** **No evasion, ever** (`19_SAFETY` §What we will never build). This is an architectural constraint, not a preference — it defines what "correct" means for this codebase.
- **ADR-9:** Elevation demoted from required to optional; the Agent runs as a standard user by default.
**Chosen, not inherited, since beta.10 (owner decision D34, 2026-09-27):** Settings ▸ Capture agent ▸ *Run the agent as
administrator* (`capture.run_elevated`, off by default, a versioned disclosure — `agent-admin-dialog/1` — before it turns
on). With it on, **Windows is asked every time the Agent starts** — a UAC prompt owned by the App's window when the App
starts it, flashing on the taskbar when the logon task does — and there is no silent path: no "highest privileges" task,
no service. The elevated Agent is started for one user (`--serve --for-user <SID>`) and refuses to run as another
account (exit 11: a standard user answered with an administrator's password, and that account's `%LOCALAPPDATA%` is not
this user's ledger); a declined prompt leaves a standard user's Agent that says so (`--elevation declined`,
`HelloAck.ElevationOutcome`). With it off, an App started as administrator starts the Agent with the desktop shell's
token. **A game an elevated Agent starts gets the shell's token too** (`Infrastructure.Startup.UnelevatedProcess`) —
`LaunchGame` reaches the Agent over a pipe any process of the user may open, so an elevated launch would be a silent
elevation — and nothing enables a privilege (`TokenPrivileges` reads them; `tools/chokepoint-check.ps1` forbids the
enablers under `src/`). It buys what it always did: attaching to a game that runs as administrator, and the CPU
temperature with PawnIO. It does not open a process an anti-cheat driver protects (D21), and a Vulkan game that runs as
administrator stays unmeasured — the Khronos loader ignores the HKCU implicit layers for an elevated process.
+24 -12
View File
@@ -7,26 +7,32 @@ Requirement IDs (`FR-x`, `NFR-x`) are referenced by other docs, commits, and tes
### FR-1 Game library
- FR-1.1 Add game by picking an `.exe`, or drag-dropping an exe/shortcut.
- FR-1.2 Auto-import from Steam, GOG Galaxy, Epic, itch.io with a review checklist. **Import never enables hooking for anything.**
- FR-1.3 Editable metadata (name, cover, publisher, version, notes); auto-detected fields badged and overridable.
- FR-1.3 Editable metadata (name, cover, publisher, version, notes); auto-detected fields badged and overridable. *(The cover is built since beta.23, D60: the user's own image, else the Steam or GOG GALAXY app's artwork on this PC — `08_UI` §Games.)*
- FR-1.4 Remove game (asks whether to keep or delete its sessions).
- FR-1.5 "Supports" row shows shipped-capability hints (DLSS/FSR/XeSS/FG) — visually distinct from measured per-session values (`05_DETECTION` §Capability hints).
- FR-1.7 Delete all sessions (beta.11, owner decision D40): of one game from its page, or of every game from Settings ▸ Data, after a confirmation that says how many — with their frame and sensor series and notes; the library, the settings and every consent stay. The Agent deletes them (the rows are its, `06_DATA_MODEL` §Writer ownership) and refuses while a session it would delete under is being recorded.
- FR-1.8 Uninstalled games leave the library by themselves (beta.19, owner decision D55, amending D41): an entry whose executable has been gone for ten minutes — its drive connected and the folder it was installed in still there, so an unplugged or re-lettered drive never counts, and neither does a folder Windows will not list (`ExecutablePresenceProbeTests`) — and that has no session (stored, being recorded or waiting to be recovered) is removed by the Agent, behind Settings ▸ Data ▸ *Remove uninstalled games* (on by default). Never an entry carrying an anti-cheat block, an exception or a failed-trial mark (FR-2.2, rule 2). The App is told (`GameRemoved`).
- FR-1.9 Play (beta.21, owner decision D59): a game's page and each library entry start the game — through the app of the store whose own records name its folder (Steam, the Epic Games Launcher, GOG GALAXY, itch), or by the agent's launch mode (FR-3.2), as Settings ▸ Games says; never as administrator, and never in a viewer (`08_UI` §Games).
- FR-1.6 Recording switch per entry (2026-09-23, HANDOFF D29): off, the program is not watched at all — no session, no measurement, no injection — and a session of it that is running stops. On by default; entries an old import made for Steam's own tools start with it off. The library card says "Not recorded".
### FR-2 Hooking consent & control (new, safety-critical — see `19_SAFETY`)
- FR-2.1 Hooking is **off by default for every game**. Enabling requires a per-game consent dialog stating what is injected, why, and the anti-cheat/ban risk.
- FR-2.2 The static anti-cheat pre-scan disables the toggle outright for titles shipping anti-cheat; the reason is shown and the control is not clickable.
- FR-2.3 The runtime guard refuses injection and refuses to continue a session when anti-cheat is detected. **No override exists anywhere in the UI, config, or CLI.**
- FR-2.2 The static anti-cheat pre-scan disables the toggle outright for titles shipping anti-cheat; the reason is shown and the control is not clickable. Since 2026-09-25 (beta.8, owner decision) the Agent runs that pre-scan over every library entry itself — once per rules version and executable, whether or not hooking was ever asked for — and by default the game's page shows only the finding in place of the Hooking card (Settings: *Hide hooking on anti-cheat games*, `ui.hide_anticheat_hooking`); the library card says "Anti-cheat". The reason is always on the page (`19_SAFETY` §What a finding does to the game).
- FR-2.3 The runtime guard refuses injection and refuses to continue a session when anti-cheat is detected. **No override exists anywhere in the UI, config, or CLI.** *(Since 2026-09-26 one narrow, evidence-bound exception exists — FR-2.8. It is not an override: the guard still runs every check and decides itself which anti-cheat family it may let through.)*
- FR-2.4 Global "disable all hooking" kill switch in Settings; also honored by the Vulkan layer.
- FR-2.7 (owner decision 2026-09-22; it was a per-game override for one day, withdrawn) A finding about a game — anti-cheat named in its process, on its title lists or in its folder — turns hooking off for that game wherever the guard makes it: at the pre-scan, at a session's start, at the 30 s re-scan, or (since 2026-09-25) at the Agent's pre-scan of the library. The row carries the reason, the game's page and the notice say so, and nothing overrides it (`19_SAFETY` §What a finding does to the game).
- FR-2.8 (owner decision D33, 2026-09-26) **The user-mode anti-cheat exception.** A Settings option, off by default, lets the user grant a per-game exception to a game whose only anti-cheat findings are ONE family that is user-mode throughout (no driver, service or `.sys` in the floor or the rules), whose install tree holds no `.sys`, which is on no title list, ~~and which FrameLedger has measured hooked at least twice (successful Tier-1 sessions)~~ and no exception of which ever ended during its trial (D38, 2026-10-03: a grant needs no session; its first two hooked sessions are a trial, and an end during the trial — any end below, or a stored hooked session with no frames or an abnormal exit — ends it for good, `games.ac_exception_trial_failed_at`). The Agent computes that eligibility itself; the user grants each game through a versioned disclosure that states the ban risk; hooking is then turned on through FR-2.1's dialog as ever. Machine-wide drivers and services, title lists, kernel drivers in the game folder, the fuzzy tier, a scan that could not finish, an unreadable process, a 32-bit game, the kill switch and Vulkan are never excepted. A new finding, a crash / safety unhook / Overlay stop under it, or a changed executable ends it; the option off suspends it; the block itself is never cleared and stays shown (FR-2.2). Sessions under it are marked with the family (`19_SAFETY` §The user-mode exception).
- FR-2.5 Repeated crashes shortly after injection auto-disable hooking for that game, with an explanation and a manual re-enable path.
- FR-2.6 Users can always see, per session, which tier produced the data.
### FR-3 Session capture
- FR-3.1 Watcher detects tracked exe launches (1 Hz) and captures automatically at the highest permitted tier.
- FR-3.2 Launch mode: start the game from FrameLedger for suspended-launch injection (catches startup-time upscaler init).
- FR-3.2 Launch mode: start the game from FrameLedger for suspended-launch injection (catches startup-time upscaler init). *(The App reaches it since beta.21: Play set to Start directly sends `LaunchGame` — FR-1.9.)*
- FR-3.3 Attach mode for games launched externally; sessions flagged `late_attach`.
- FR-3.4 Track the process tree; capture the descendant that actually presents.
- FR-3.5 Per-frame records for the whole session; telemetry at 1 Hz (configurable 0.5–2 s).
- FR-3.6 Session ends on process-tree exit, safety unhook, or user stop. Sessions under the minimum length (default 30 s) are discarded.
- FR-3.7 Crash detection: nonzero exit code or matching Application Error 1000 / WER 1001 events → `exit_status = crashed`.
- FR-3.7 Crash detection: ~~nonzero exit code~~ an exception's exit code *(corrected 2026-10-04: since beta.8, `ExitStatusMapper.IsExceptionCode` — End task's exit code 1 is `normal`, the code kept in `capture_notes`; `04_CAPTURE` §Crash & exit classification)* or matching Application Error 1000 / WER 1001 events → `exit_status = crashed`.
- FR-3.8 Post-session toast with summary + "View".
- FR-3.9 Pause/resume capture globally from tray.
@@ -35,9 +41,9 @@ Requirement IDs (`FR-x`, `NFR-x`) are referenced by other docs, commits, and tes
- FR-4.2 **Native vs Displayed FPS + FG factor**, always shown together (`62 → 118 FPS (×1.9 FG)`).
- FR-4.3 *(Tier 1)* Measured upscaler identity, quality preset, render resolution, output resolution, upscale ratio; mid-session changes captured as segments.
- FR-4.4 *(Tier 1)* Measured RT activity (`rt_frame_pct`, `rays_per_pixel`, RT PSO count); RR from the NGX feature; PT as a confidence-scored suggestion only.
- FR-4.5 *(Tier 1)* Per-process VRAM usage/budget and budget-exceeded percentage.
- FR-4.5 *(Tier 1)* Per-process VRAM usage/budget and budget-exceeded percentage. *(beta.12, owner decision D43: the **usage** half is met for **both tiers** from outside the game — the game process's dedicated and shared GPU memory, Task Manager's columns — with its private working set, working set and commit beside it, mean / median / peak (`03_METRICS` §Game process memory). The budget and its exceeded percentage stay unmeasured, `20_OPEN_QUESTIONS` §M11.)*
- FR-4.6 *(Tier 1)* PSO-compilation stutter attribution; *(Tier 1 + Reflex)* PC latency avg/p95.
- FR-4.7 Telemetry aggregates: CPU/GPU temp, hotspot, loads, power, throttle %, RAM.
- FR-4.7 Telemetry aggregates: CPU/GPU temp, hotspot, loads, power, throttle %, RAM. *(beta.12: every stored series also has its median and minimum, in `sensor_stats_json`.)*
- FR-4.8 Sufficiency guards: 0.1% Low needs ≥ 10,000 app frames, 1% Low ≥ 1,000; else `N/A`.
- FR-4.9 Any metric unavailable at the session's tier renders `N/A` — never an estimate presented as measurement.
@@ -52,13 +58,15 @@ Requirement IDs (`FR-x`, `NFR-x`) are referenced by other docs, commits, and tes
- FR-6.1 Sessions table per game: date, duration, tier badge, Native, Displayed, FG×, lows, resolution + upscaler, RT/PT/RR chips, crash badge, tags.
- FR-6.2 Compare 2–5 sessions; **mixed-tier comparisons require explicit acknowledgement** and are marked on the chart.
- FR-6.3 Hardware snapshot per session; trend charts mark changes ("GPU driver 572.16 → 576.02").
- FR-6.6 Charts across a game's sessions (beta.11, owner decision D39): the Sessions tab opens with an overview of every hooked session's rate and lows (Presented FPS, or Native and Displayed where frame generation was measured; 1% and 0.1% lows), a click selecting the session; and the Trend draws more metrics beside the selected one, two units at most (the second against the right axis).
- FR-6.4 Sessions with mid-session settings changes are excluded from trends by default, with a toggle.
- FR-6.5 Session tags and notes.
### FR-7 Detection
- FR-7.1 Static: engine, engine version, store platform, store id, publisher, game version (`05_DETECTION`).
- FR-7.2 Runtime: API, present mode, swap effect, HDR, upscaler, FG, RT — all Tier 1, all measured.
- FR-7.3 Rules ship as `detection-rules.json`, updatable independently of releases; **anticheat-block updates apply regardless of the user's rules auto-update preference.**
- FR-7.1 Static: engine, engine version, store platform, store id, publisher, game version (`05_DETECTION`; the Unreal Engine version since 2026-09-27, §Engine version).
- FR-7.2 Runtime: API, present mode, swap effect, HDR, upscaler, FG, RT — all Tier 1, all measured. (Present mode and HDR have no writer yet, `05_DETECTION` §Runtime facts; swap effect is written since beta.10 from the display-mode sample.)
- FR-7.4 Display mode (beta.10, owner request 2026-09-27): how each session's game was shown — exclusive fullscreen, borderless, windowed, minimised, or *fullscreen or borderless* where nothing could tell the two apart — as a share of the session's time, with the window, back buffer and monitor sizes; both tiers (Tier 2 from the window alone); shown on the session summary, the game page, the Trend (three share metrics) and Compare, and exported (`03_METRICS` §Display mode).
- FR-7.3 Rules ship as `detection-rules.json`, updatable independently of releases; **anticheat-block updates apply regardless of the user's rules auto-update preference.** *(Unmet — corrected 2026-10-04: there is no rules feed and no auto-update preference. Rules change only with a release: `RulesSeeder` installs them, Tools ▸ Update detection rules re-seeds them — `20_OPEN_QUESTIONS` §S20 feed half.)*
### FR-8 Tri-state flags
- FR-8.1 `Yes / No / N/A` for Ray Tracing, Path Tracing, Ray Reconstruction, per session, with source (`measured | manual | inherited`).
@@ -71,10 +79,14 @@ Requirement IDs (`FR-x`, `NFR-x`) are referenced by other docs, commits, and tes
- FR-9.3 Chart PNG.
### FR-10 Settings
Language (en/vi/ja), theme, start with Windows, minimize to tray, background capture, **global hooking kill switch**, min session length, telemetry interval, retention, Agent elevation (optional — explains what it unlocks), Vulkan layer registration state, update channel, online metadata opt-in, reopen legal documents.
> **beta.10 (D34):** "Agent elevation (optional — explains what it unlocks)" is the admin mode — *Run the agent as
> administrator*, off by default, a disclosure before it turns on, Windows' prompt at every Agent start (`01_ARCHITECTURE`
> ADR-9, `08_UI` §Settings).
Language (en/vi/ja), theme, start with Windows, minimize to tray, background capture, **global hooking kill switch**, min session length, telemetry interval, retention, Agent elevation (optional — explains what it unlocks), Vulkan layer registration state, update channel, ~~online metadata opt-in,~~ reopen legal documents *(corrected 2026-10-04: the opt-in has had no row since 2026-09-16 because no store request exists, and the background-capture switch — read by nothing — is gone since beta.12; `06_DATA_MODEL` §Settings registry)*. **beta.11 (owner request 2026-10-03: no row without a control):** Delete all sessions (FR-1.7, a *Data* section); the elevation state is a line of the admin mode's own row, not a row of its own; the hook-enabled list shows only while a game has hooking on; the language row carries no separate note.
### FR-11 Legal Gate
First run blocks until the user accepts EULA, GPLv3 notice, Disclaimer, Privacy Policy. Re-shown when a document version increments. The injection risk is stated in the Disclaimer *and* repeated at per-game consent (FR-2.1) — once is not enough for something that can cost an account.
First run blocks until the user accepts ~~EULA, GPLv3 notice, Disclaimer, Privacy Policy~~ the EULA, the Disclaimer and the Privacy Policy; **the GPLv3 is shown beside them for information and needs no acceptance** (GPLv3 §9 — "You are not required to accept this License in order to receive or run a copy of the Program"; changed beta.12, owner decision D45, `08_UI` §First-run flow). Re-shown when a document version increments. The injection risk is stated in the Disclaimer *and* repeated at per-game consent (FR-2.1) — once is not enough for something that can cost an account.
### FR-12 Updates
Velopack against GitHub Releases; silent startup check, manual check in Help; error dialogs mapped per `11_UPDATER`. **Updates never apply while a game is hooked** — deferred to session end (the DLL on disk must not change under a running game).
+278 -13
View File
@@ -1,6 +1,6 @@
# 03 — Metrics
**Single source of truth** for every number FrameLedger displays. ~~Implement in `FrameLedger.Domain.Metrics` with golden tests (`14_TESTING`).~~ **Implemented in `FrameLedger.Domain.Metrics` since 2026-09-09 (P2 PR-A), with the goldens `14_TESTING` names:** `FrameTimeSeries` (frame times from QPC, gaps excluded), `Percentile` (linear), `FrameStatistics` (median / lows / min / max / σ with the sufficiency guards), `RollingMedian` + `StutterDetector`, `FgWindow` + `FgRefusal` (the factor and every refusal, as facts — the English lives with the report), `UpscaleExtent`, `SegmentBuilder`, `RtVerdict` / `HdrVerdict` (the tri-states), `VramAggregates` / `LatencyAggregates` / `SeriesAggregates`. They consume `FrameSample` and `WriterFacts` — Domain's own types, since Domain references nothing — and `Application.Metrics.FrameSampleMapper` is the one place a shared-memory record becomes one; the Domain enums are pinned to `FrameLedger.Shared`'s in both directions by `MetricEnumMirrorTests`. The frame-generation LADDER (rung 0 / 1 / 3 / 4 as a verdict, and the withheld `none`) is not yet a Domain type: it is still the capture host's prose in `MeasuredFacts`, and lands with the recorder that stores `fg_mode` (PR-D).
**Single source of truth** for every number FrameLedger displays. ~~Implement in `FrameLedger.Domain.Metrics` with golden tests (`14_TESTING`).~~ **Implemented in `FrameLedger.Domain.Metrics` since 2026-09-09 (P2 PR-A), with the goldens `14_TESTING` names:** `FrameTimeSeries` (frame times from QPC, gaps excluded), `Percentile` (linear), `FrameStatistics` (median / lows / min / max / σ with the sufficiency guards), `RollingMedian` + `StutterDetector`, `FgWindow` + `FgRefusal` (the factor and every refusal, as facts — the English lives with the report), `UpscaleExtent`, `SegmentBuilder`, `RtVerdict` / `HdrVerdict` (the tri-states), `VramAggregates` / `LatencyAggregates` / `SeriesAggregates`. They consume `FrameSample` and `WriterFacts` — Domain's own types, since Domain references nothing — and `Application.Metrics.FrameSampleMapper` is the one place a shared-memory record becomes one; the Domain enums are pinned to `FrameLedger.Shared`'s in both directions by `MetricEnumMirrorTests`. The frame-generation LADDER (rung 0 / 1 / 3 / 4 as a verdict, and the withheld `none`) ~~is not yet a Domain type: it is still the capture host's prose in `MeasuredFacts`, and lands with the recorder that stores `fg_mode` (PR-D).~~ *(Corrected 2026-10-04: it landed with PR-D on 2026-09-10 as `Application.Recording.FgLadder` — in Application, not Domain. The session row (`SessionAggregator`), the live card (`SessionProgressCalculator`) and the capture host's report all read it; `MeasuredFacts` keeps only the host's strings.)*
Every metric declares which **capture tier** it requires (`01_ARCHITECTURE` §Capture tiers). A Tier-2 session simply has `N/A` where Tier-1 data is missing — never a silently degraded estimate presented as fact.
@@ -27,7 +27,7 @@ Let `D` = session duration (first → last present), `F_app` = frames the *game*
| **Native FPS (avg)** | `count(F_app) / D` | 1 |
| **Displayed FPS (avg)** | `count(F_disp) / D` | 1 |
| **Presented FPS (avg)** | `presents / D` — **numerically Displayed FPS; the name for the one number that stands alone.** "Native" and "Displayed" are printed only *together* (rule 6); when frame generation is not measured, this is the headline, with a mandatory qualifier (§Frame Generation, rung 0's qualifier) | 1 |
| **FG factor** | `DisplayedFPS / NativeFPS`, shown `×N.N`; `—` when FG inactive; **`N/A` when FG is not measured** — and **`N/A` when FG was *identified* but the count refused** (`fg_mode` a technology, `fg_factor` NULL, `fg_refusal` the reason — schema 0003, 2026-09-14): the one number is then Presented FPS with a warning chip naming the technology, exactly rung 0's third row, because the identity says generated frames may be in the presents and the count cannot say how many. Never `×0.0`, never "Native" | 1 |
| **FG factor** | `DisplayedFPS / NativeFPS`, shown `×N.N`; `—` when FG inactive; **`N/A` when FG is not measured** — and **`N/A` when FG was *identified* but the count refused** (`fg_mode` a technology, `fg_factor` NULL, `fg_refusal` the reason — schema 0003, 2026-09-14 — and `fg_refusal_detail` its numbers: the bucket that departed, its ratio and the window's — schema 0005, 2026-09-16): the one number is then Presented FPS with a warning chip naming the technology, exactly rung 0's third row, because the identity says generated frames may be in the presents and the count cannot say how many. Never `×0.0`, never "Native". **Since 2026-09-17 a session refused as `non_uniform` publishes its STEADY STATE instead** — `fg_factor_scope = steady`, the share beside it (§The steady state, below) | 1 |
| **Avg FPS** (headline) | = Native FPS when `fg_mode` is measured (`api` rung) or `none`; **= Presented FPS, labelled, when `fg_mode` is `N/A`**. Time-based, **not** the mean of instantaneous FPS values | 1 |
| **Median FPS** | `1000 / p50(ft_app)` | 1 |
| **1% Low** | `1000 / p99(ft_app)` | 1 |
@@ -38,6 +38,9 @@ Let `D` = session duration (first → last present), `F_app` = frames the *game*
| **Stutter time %** | `Σ ft_app[stutter] / Σ ft_app × 100` | 1 |
| **PC latency** | mean/p95 of `reflexLatencyUs` when Reflex reports it | **1 only** |
| **PSO stutter %** | share of stutter frames with `psoCreatedThisFrame > 0` | **1 only** |
| **Time below 30 / 60 FPS** (beta.14) | share of `Σ ft_app` in frames that count as below X — `ft > 1.10 × 1000/X`, or the nine-frame rolling median `> 1.02 × 1000/X` (§Pacing) | 1 |
| **Time below refresh** (beta.14) | the same over **presents**, X = `display_monitor_hz` — the display's rate, so over what the display received | 1 |
| **Frame to frame** (beta.14) | mean `\|ft_app[k] − ft_app[k−1]\|` over neighbouring intervals, ms | 1 |
**Percentile method:** sort ascending, linear interpolation between closest ranks (NumPy `linear` / Excel `PERCENTILE`). Document it, test it — tools differ and users will compare numbers.
@@ -55,8 +58,32 @@ entirely rather than counted as one long frame. Including it would fabricate a
stutter — the exact artifact these metrics exist to detect honestly. Gaps count
toward the session's data-quality warnings.
> **Since beta.8 a pause is a gap, and a gap is not time either.** The Overlay records nothing while FR-3.9's pause
> holds, so the first record after the resume is QPC-apart from the last one before it by the whole pause: counted, a
> fabricated minutes-long frame in every statistic — the Overlay's own comment on its pause check (`MayObserve`) names that
> artefact — and paused minutes in every average. `CaptureSession` reads the QPC as it tells the ring to resume and marks
> a gap before the first record stamped at or after it (`CaptureSessionTests.TheFirstRecordPresentedAfterAResumeFollowsAGap`,
> red before the fix). And **`D`, the time base of every average, is the time the kept intervals span** — first to last
> present less every interval a gap sat in (`FrameTimeSeries.MeasuredSeconds`, `FgWindow.Seconds`): Presented FPS is
> the kept intervals over the seconds they span, and Native / Displayed leave the gaps out of their seconds too. For
> lost records this reads the survivors' rate (a drop is the Agent falling behind, not the game) where it read the
> survivors spread over the lost time — a rate nobody measured; with no gap nothing changes.
**Lows use application frames only.** Generated frames smooth display cadence but do not represent simulation stalls; mixing them hides real stutter. A secondary "Displayed 1% Low" is stored for the Displayed chart series but never replaces the headline.
> **And since beta.8 (2026-09-25) they are computed that way — until then they were not.** Where generated frames were
> counted (`fg_mode` a technology, or `active`), `SessionAggregator` took the median, the lows, min / max, σ and the stutter
> rule over every present of the dominant stream: the 1% low of a ×2 session sat above its native average, and on the
> owner's Onimusha demo capture (DLSS FG ×3, which submits each generated frame half a millisecond after its application
> frame) the stored median read **2,073 FPS on a 60 FPS game**. `ft_app` is now `Domain.Metrics.FrameTimeSeries.ApplicationFrames`:
> the interval between two consecutive presents that carried an application frame's token, the generated presents between
> them adding no interval of their own; a gap or a present that does not claim the count breaks the chain. The segments'
> lows follow; the Displayed 1% low stays over every present. **A technology named and no application frame counted**
> (`no_evaluations`, `not_counted`) has no frame statistic at all — N/A rather than a low over presents that include
> generated frames. Per-present attribution is accurate to one present (§Frame Generation); it was measured regular —
> application, generated, generated, repeating — on that capture. **Rows written before beta.8 keep their stored
> numbers**, as with the steady state (#198); their charts are drawn from the blob with the new rule.
> **When frame generation is NOT measured, the lows are taken over presents and labelled
> `(presented)`** — added 2026-09-03 with Presented FPS. On a title with no in-process frame
> generation that is exactly the application-frame low; on one that generates frames through a
@@ -66,6 +93,41 @@ toward the session's data-quality warnings.
**Sufficiency guards (FR-4.8):** 0.1% Low needs ≥ 10,000 application frames, 1% Low ≥ 1,000; otherwise `N/A`.
## Pacing (beta.14, D49)
**Time below 30 / 60 FPS and below the refresh rate** are shares of the measured time — `Σ ft (counted) / Σ ft` — so a long
hitch weighs what a player sits through, not one frame among many. **Frame to frame** is the mean change from one frame
time to the next over neighbouring intervals (`FrameTimeSeries.FollowsBreak`: a pair with an interval left out between —
a gap, a pause — is not a pair); it is low when pacing is even whatever the rate.
**Which frames count as below X — and why not "longer than 1000 / X".** The present-to-present interval of a game held
at X jitters around `1000 / X` by a few tenths of a millisecond, half of it on the long side. Measured on a copy of the
owner's ledger (2026-10-06): a GIRLS' FRONTLINE 2 session capped at 60 (median 16.63 ms, 296,380 frames) reads **50.0 %**
of its time "below 60" under the plain rule, and a rolling mean does not help — the local average of a game held at 60
sits on the threshold. So a frame counts when **it is itself more than 10 % longer** than `1000 / X` (a long frame, never
jitter) **or the median of the nine frames around it** (`RollingMedian`, the stutter rule's centered window and edges) **is
more than 2 % longer** (a rate that stays below X). The same session reads 9.6 % (its time below 30 alone is 4.7 %); with
a 0.4 ms jitter a steady 58 FPS reads 93 %, a steady 60.2 reads 0.7 %, and a 100 ms hitch counts its own 100 ms and no
neighbour's. **The cost, stated:** a rate less than 2 % under X (58.8–60 FPS for 60) reads partly as at X — a steady 59
reads 40 %. `Domain.Metrics.FramePacing`; `FramePacingTests` pins each of these.
**Which series.** 30, 60 and frame to frame are over `ft_app` — application frames where generated frames were counted
(rule 6: generated frames do not make a game run at 60), the presents otherwise, labelled `(presented)` as every
present-only statistic is. **The refresh share is over the presents**, generated ones included: it is the display's rate,
and what matters there is what the display received — a ×4 frame-generation session on a 240 Hz display reads near 0 %,
and over its application frames it would read 100 % whatever the pacing. It needs `display_monitor_hz` (the display
tally's, §Display mode): a session recovered from its crash file has none, and reads N/A. **Sufficiency:** the 1 % low's
1,000 frames; below it every value is N/A.
## Sync — what the presents asked for (beta.14, D49)
`vsync_present_pct` is the share of the dominant stream's presents with a sync interval of one or more (the game asked
to wait for the display), `tearing_allowed_pct` the share with `DXGI_PRESENT_ALLOW_TEARING`. Both arguments were in every
Direct3D record since P1 (`FL_MEASURED_PRESENT_ARGS`) and read by nothing; `sessions.sync_interval_mode` (0001) gets its
first writer with them — `on` (every present), `off` (none), `mixed`. **Asked, not obtained:** a driver setting or a
variable-refresh display can override the request, and nothing in the process says which won. OpenGL's
`wglSwapBuffers` and Vulkan's `vkQueuePresentKHR` carry neither argument: N/A, never 0 %. Tier 1 only.
## Frame Generation — ground truth (Tier 1)
This is the metric the rewrite exists for. Resolution ladder, highest confidence first; the winning rung is stored in `fg_source`:
@@ -369,13 +431,48 @@ F_app = Σ fgEvaluations (APPLICATION frames, counted at the
> its verdict on the line under the ratio so the number cannot be read without it. A guard keyed
> on a quantity that is zero on the route that runs is not a guard.
>
> ### The steady state — owner decision 2026-09-17
>
> **The refusal was right and its consequence was wrong.** A session that ran its menus at ×1 and its gameplay at
> ×4 averages to a number no configuration had (Black Myth: Wukong, 2026-09-16: 2.22 over a session whose gameplay
> read ×4.1 for two thirds of it), so the session-level factor is refused — and until this date the gameplay's own
> number was thrown away with the average. Every real play session opens with a splash, a menu or a loading screen,
> so on the owner's machine the shipped Agent published a factor on **one hooked session in nine** while the live
> card, which looks at five seconds at a time, showed it throughout; the owner read that as a broken data path. It
> was not: the nine sessions' stored per-frame counts read **2.00 / 3.00 / 4.00 to two decimals** inside gameplay.
>
> **The rule.** When — and only when — the session-level factor is refused as `NonUniform`, `FgSteadyState` cuts the
> claimed span into **five-second windows (the live card's own)**, classifies each by its own `presents ÷ tokens`,
> and takes the set of ACTIVE windows (≥ 1.5) agreeing within **10 %** that holds the most time. It is published when
> it covers **≥ 10 s and ≥ 10 % of the presenting time**: `fg_factor`, `native_fps` and `displayed_fps` are that
> state's own (counted over its windows, independently), `fg_factor_scope = 'steady'`, `fg_steady_share` the fraction,
> and `fg_refusal` / `fg_refusal_detail` stay set as the reason the number is not session-wide. ×3 and ×4 are 25 %
> apart and never pool; a factor that wanders forms no state and the refusal stands alone; any other refusal
> (unattributed, saturated, interleaved streams) gets no steady state — slicing does not make a record set
> trustworthy. **Never a session average, and never shown without its share.** Replayed over the nine sessions:
> eight publish (Onimusha ×4.00 60 → 240, Lies of P ×2.00, Hell Is Us ×3.03, Cronos ×2.00 225 → 451, Wukong ×4.11),
> the ninth had nine seconds of gameplay.
>
> **Two constants moved with it.** `BucketTolerance` is **10 %**, the steady state's own, down from 25 %: at 25 % a
> session that ran ×3 then ×4 published 3.69, and the owner's one published session read ×2.04 because its opening
> bucket (2.35) sat inside the tolerance while its gameplay read 2.00 — tightening was unaffordable while a refusal
> meant no number, and is free now. And **`MultipleStreams` refuses only when the chains' samples INTERLEAVE**:
> the hazard is a process-wide drain word with two chains presenting at once, and Onimusha recreates its swapchain
> on entering gameplay — chain 1 for the menus, chain 2 after, not one sample interleaved in three sessions — which
> is one stream at a time and was refused as two.
>
> **This also leaves §RT/PT/RR without a settled denominator.** `rt_frame_pct`,
> `rays_per_pixel` and the `≥ 5% of frames` gate are per-APPLICATION-frame quantities, and
> dividing them by presents dilutes each by the frame-generation factor — at ×4 a title that
> path-traces every application frame reports 25%. Whoever writes the RT hooks must choose a
> denominator and state it here.
>
> *(Settled 2026-08-20 with the RT hooks — §RT/PT/RR, "The denominator": `rt_frame_pct` is a share of presents
> and says so, and the tri-state is unaffected. Marked here 2026-10-04.)*
`fgEvaluations` is recorded per present by the NGX/Streamline/FFX/XeSS FG hooks
`fgEvaluations` is recorded per present by ~~the NGX/Streamline/FFX/XeSS FG hooks~~ the `slGetNewFrameToken`
detour; where Streamline never issued a token, by the FidelityFX dispatches — new PREPARE `frameID`s, else UPSCALE
dispatches, the FSR 3.0 host's included *(corrected 2026-10-04: NGX and XeSS have no hook)*
(`17_HOOK_ENGINE` §Upscaling / frame generation). `fg_factor = F_disp / F_app`.
> **`fgEvaluations` counts EVALUATIONS, not generated frames — owner ruling, 2026-08-14 —
@@ -447,9 +544,18 @@ carries the three shapes.
## Upscaling — measured, not guessed (Tier 1)
> **The NVIDIA driver's overrides are a configuration, not a measurement (beta.8, 2026-09-25).** A session now also
> stores the driver profile its executable ran under (`sessions.driver_profile`: the NVIDIA App's DLSS, Ray
> Reconstruction and frame-generation overrides, read from the driver's settings store — never from the game's process
> or memory, CLAUDE.md rule 4) and the driver's own per-process override report in full (`ngx_driver_words`: preset,
> mode, ratio beside the masks). Both are shown as what the driver was set to do and what it says it did — "NVIDIA
> profile …: DLSS override (preset K, Quality)" — and neither changes a measured value, a rung of the upscaler ladder or
> the frame-generation factor: those stay what the hooks saw. A profile override the hooks contradict is two true
> statements about different things, and the page shows both.
From the upscaler hooks we get, per frame:
- `upscaler`: the technology **actually executing** (`dlss`, `fsr2`, `fsr3`, `fsr4`, `xess`, `nis`, `none`) — from the API that was called, not from a DLL sitting on disk.
- `upscaler`: the technology **actually executing** (`dlss`, `fsr2`, `fsr3`, `fsr4`, `xess`, `nis`, `none`; **`fsr`** since 2026-09-04 — FSR through the SDK 2.x upscaler DLL, version not named) — from the API that was called, not from a DLL sitting on disk. *(Corrected 2026-10-04: `fsr` was missing here; `fsr4` is reserved and no writer produces it.)*
> **`dlss_rr` is NOT a value of this field, and this line listed it until 2026-08-06.** Layout
> v3 retired it and **reserved** the slot rather than reusing it, because it made Ray
@@ -460,6 +566,12 @@ From the upscaler hooks we get, per frame:
> the conflation the record had already removed.
- `renderW × renderH` vs `outputW × outputH` → **exact upscale ratio**: `sqrt((outW×outH)/(renW×renH))`, reported both as a ratio (`1.50×`) and a percentage (`67% render scale`).
- `upscalerQuality`: the vendor's own quality enum (DLSS Performance/Balanced/Quality/DLAA, XeSS quality setting, FSR preset), mapped to a display name per vendor in `Domain.UpscalerNames`.
> **`Domain.Metrics.UpscalerNames` exists since 2026-09-21; this line promised it from the start and the UI printed the
> raw integer until then.** It holds ONE table because one producer exists: `sl::DLSSMode` as the title chained it
> into `slEvaluateFeature` (1 Performance · 2 Balanced · 3 Quality · 4 Ultra Performance · 5 Ultra Quality · 6 DLAA;
> `eOff` and anything past `eCount` never reach a row). The ffx-api dispatch carries no quality and XeSS has no hook,
> so there is nothing of theirs to name. A value the table does not know is shown as stored. It names the MEASURED
> byte only — a label derived from the render/output ratio is `HANDOFF` §7a's owner decision, still not taken.
- Resolution changes mid-session (user changed settings, or dynamic resolution scaling) produce **segments**: the session stores a segment list `(startFrame, renderW/H, outputW/H, upscaler, quality)`. Aggregates report the dominant segment plus a "settings changed during session" flag — averaging across a settings change is the classic way benchmark numbers become meaningless.
> **Two segmentation axes exist, they compose in ONE order, and neither document said so until
@@ -515,6 +627,24 @@ Tier 2 has none of this: `upscaler = unknown`, ratio `N/A`.
> than resolved*. Beside an `N/A` with the bit clear it prints the driver's negative, attributed, which
> says nothing about FSR or XeSS. **The negative is owed** (§H5): a title with DLSS switched off should
> read the bit clear; if it does not, the rung is withdrawn.
>
> **The App states the rung since 2026-09-21; until then only the capture host's console did.** The Agent has written
> `sessions.upscaler_driver_reported` since P2, and nothing under `FrameLedger.App` read it, so every NGX-direct DLSS
> title read "Unknown upscaler" in the library while FSR — whose dispatch the hook does see — was named (the owner's
> report). `Formats.Upscaler(token, quality, driverReported)` is the ladder in one place: a hook's name outranks
> everything and takes its measured preset; where no hook named one (`unknown`, or no claim) and the driver reports the
> feature, the text is **`DLSS (driver-reported)`** — attributed, identity only, never a quality even when a byte is
> on the row; otherwise the token's own text, and `unknown` now reads "Upscaler not identified" (a hook ran and saw
> nothing — which is what it means — rather than "Unknown upscaler", which read as a product). The live card gets the
> same word through `SessionProgress.upscalerDriverReported` (`07_IPC`). Segments carry no driver word: the driver's
> bookkeeping is per process, not per settings change. **Nothing native changed and no NGX hook was added**: the
> licence bar in `20_OPEN_QUESTIONS` stands.
**The render scale over time (beta.14, D49).** The session summary draws `100 × √(render pixels / output pixels)` — the
per-axis scale, `100 / upscale_ratio` — as steps over the session: from the `render_res` blob where the resolution
varied (the finalizer stores it only then), a flat line at the row's extent where it did not, and a sentence where the
upscaler's parameters were never measured (`App.Charts.RenderScaleSeries`). The Trend and Compare read the row's
`upscale_ratio`, the dominant extent.
## RT / PT / RR — evidence-based tri-state
@@ -600,15 +730,143 @@ Derived extras (Tier 1): `rays_per_pixel` (mean dispatch volume ÷ output pixels
> 2026-08-20 `maxTraceRecursionDepth` has no producer: `CreateStateObject` is a separate PR,
> and `pt_confidence` reads it, which is one of the reasons Path Tracing is still `N/A`.
## Per-process VRAM (Tier 1)
## Display mode — both tiers (beta.10)
`vramUsedMb` from `IDXGIAdapter3::QueryVideoMemoryInfo(LOCAL)` inside the game = **this game's** usage and budget. **MiB, truncating, and it must use the same divisor as `vramBudgetMb`** — the two are compared, and mismatched rounding would put a systematic bias into `budget_exceeded_pct`. Residual: a flip within 1 MiB of the budget, 0.004% of a 24 GiB card. Stored as its own series and clearly labelled apart from the adapter-wide figure from `18_GPU_VENDOR_APIS`. Aggregates: avg, max, and `budget_exceeded_pct` (share of samples where `CurrentUsage > Budget`, i.e. the driver was likely evicting — a genuinely useful stutter explanation).
**Owner request, 2026-09-27:** "detect the game's window size and whether it runs full-screen, borderless or windowed,
and how much of the time". Schema 0016 (`06_DATA_MODEL`), shared-memory region 4 (`07_IPC`, layout 4), the Agent's
`Application.Capture.DisplaySampler`, Domain's `Display.DisplayModeClassifier` and `Display.DisplayTally`.
**Two witnesses, and neither reads the game.**
1. *The swap chain's own answer* — Tier 1, DXGI only. The Overlay asks `IDXGISwapChain::GetFullscreenState` and `GetDesc`
on the chain the game passed to `Present`, at most twice a second per chain, and publishes the chain with the largest
back buffer in region 4: its window, back buffer, swap effect, and whether it is exclusive (`17_HOOK_ENGINE` §Hook
inventory — polled, not a `SetFullscreenState` hook). OpenGL publishes its window and client area with no exclusive
answer; the Vulkan layer publishes nothing yet.
2. *The window from outside* — both tiers. The Agent asks user32 about the game's top-level window: minimised or not, the
client area in screen coordinates, the monitor it is on and that monitor's refresh rate — per-monitor DPI aware while it
asks, because the Agent runs DPI-unaware and Windows would otherwise scale another process's coordinates
(`Infrastructure.Display.WindowGeometryProbe`). The window is the one region 4 names when it still belongs to the game
(a handle is reused once its window is gone), else the largest visible, uncloaked, non-tool top-level window of any
process running the game's executable — found by image path in the watcher's snapshot for a Tier-2 session that never
opened the process. This is the focus sample's class of question: CLAUDE.md rule 4 is about game memory, and no handle
to the game's process is opened for it.
**The ladder, per sample** (`DisplayModeClassifier`):
| Mode | When | Column (ms) |
|---|---|---|
| No window | no window could be read and the chain did not say exclusive | `display_nowindow_ms` — outside every share |
| Minimized | the window is minimised | `display_minimized_ms` |
| Exclusive fullscreen | a region-4 sample under 2 s old in which the swap chain SAID exclusive | `display_exclusive_ms` |
| Borderless | the client area covers its monitor (±1 px each edge) and the chain said not exclusive | `display_borderless_ms` |
| Fullscreen or borderless | the client area covers its monitor and nothing could say which — OpenGL, Vulkan, every Tier-2 session | `display_covers_ms` |
| Windowed | anything else | `display_windowed_ms` |
**Time, not ticks.** A sample stands for the wall time until the next: every drain tick (100 ms) hooked, every hold tick
(1 s) at Tier 2 — so the two add up in one unit, milliseconds. An interval that ends on a paused tick is dropped, which
excludes a pause to within one tick at each edge, as the frame series' gap does. A mode's **share** is its milliseconds
over the observed time (every mode but *No window*). `display_changes` counts samples whose mode differs from the one
before, no-window samples skipped. The sizes — `display_window_*` (client area), `display_buffer_*` (back buffer),
`display_monitor_*` and `display_monitor_hz` — are the ones seen in the mode that lasted longest; `display_source` is the
strongest witness any sample had (`swapchain` > `opengl` > `window`). `sessions.swap_effect`, a column since 0001 with no
writer, is written from region 4.
**What it cannot say** (the user-facing list is `LIMITATIONS.md`):
- *Exclusive* is what the game asked DXGI for. Windows may still present such a game through the compositor ("fullscreen
optimizations"), and a flip-model borderless window may be promoted to independent flip; neither is visible without a
trace session, which FrameLedger does not have (`20_OPEN_QUESTIONS` §G).
- A game's menu may call a borderless window "Fullscreen"; the swap chain's answer is what is reported.
- A minimised game issues only occlusion probes, which the hook drops before sampling: a region-4 sample older than 2 s
keeps its window and loses its exclusive bits.
- Tier 2, OpenGL and Vulkan can never tell exclusive from borderless. Their covering time is *Fullscreen or borderless*,
and the trend draws no exclusive or borderless point for a session with any of it.
- A session recovered from its `.partial` file has no display facts — the tally is not in the crash file — and reads
N/A. The focus pair, which the partial carries, is the precedent this does not follow.
**A side effect of region 4's poll (layout 4).** `GetDesc` every 500 ms also refreshes the chain's output size, which
catches a `ResizeBuffers1` the hook inventory does not have: a title that resizes through it now splits its segments at the
change and reads "settings changed mid-session" (FR-6.4), which is what it was.
**Where it is shown** (`08_UI`): the session summary's Display card and line, the game page's last measured session and
its Sessions column, three Trend metrics — *Exclusive fullscreen share %*, *Borderless share %*, *Windowed share %*, every
tier, and a mode switch is not a mid-session change for them (switching resizes the swap chain; the share is what that
switch was) — three Compare rows, never ranked, and the CSV's `# display:` line (§Export schema) and the JSON's aggregates.
## Game process memory — both tiers (beta.12, owner decision D43)
**What is measured since 2026-10-03:** the game process's own memory, read from OUTSIDE the game once a second by the
Agent through `FrameLedger.ProcessStats.dll` (`18_GPU_VENDOR_APIS` §The game process's memory) — never from the game's
memory (CLAUDE.md rule 4):
| Figure | Source | What it is |
|---|---|---|
| **Dedicated GPU memory** (`game_vram_dedicated`) | PDH `\GPU Process Memory(pid_<pid>_luid_…_phys_<n>)\Dedicated Usage`, every instance naming the pid summed | the number Task Manager's Details tab shows under that name |
| Shared GPU memory (`game_vram_shared`) | the same counter set's `Shared Usage` | system memory the GPU uses on the game's behalf |
| **Memory — private working set** (`game_ram_private`) | `GetProcessMemoryInfo`, `PROCESS_MEMORY_COUNTERS_EX2.PrivateWorkingSetSize` | Task Manager's "Memory" column; N/A on a Windows that predates EX2 (Windows 10 22H2 / 11 22H2 without the September 2023 update) |
| Working set (`game_ram_ws`) | `WorkingSetSize` | the whole working set, shared pages included; what the card falls back to where the private working set is N/A |
| Commit (`game_commit`) | `PrivateUsage` | private memory committed, resident or not |
**Which process.** A hooked session — and any session refused after the loop pinned the process — reads the pinned pid
through the handle the session already holds (`SYNCHRONIZE | PROCESS_QUERY_LIMITED_INFORMATION`). An unpinned Tier-2 hold
(hooking off, blocked, unresolved, cannot pin) reads **every process running the game's executable** in the watcher's
snapshot, each opened for the read with `PROCESS_QUERY_LIMITED_INFORMATION` and closed after it, and SUMS them; a process
whose creation time is not the snapshot's (a reused pid), or that refuses even that right, is left out of both halves.
`game_memory_processes` says how many were summed. Child processes of another executable (a launcher, a crash handler, a
web view) are not counted.
**Dedicated is not the DXGI budget model's "local usage".** dwm.exe read 858 MB dedicated against 310 MB local at an idle
desktop, and a test process holding a buffer read 4.5 MiB more dedicated than its own `QueryVideoMemoryInfo(LOCAL)` at
both 8 MiB and 512 MiB (`spike-notes` §16, M3) — a constant per-device amount, not one that grows with the game's
allocations. So dedicated is defined as Task Manager's column and is **never compared with a budget**: the budget and
`budget_exceeded_pct` stay unmeasured (`20_OPEN_QUESTIONS` §M11), and `vram_proc_*` / `vram_budget_exceeded_pct` /
`FlFrameRecord.vramUsedMb` stay reserved for that in-process figure.
**Aggregates** (schema 0018): dedicated avg / median / max, shared max, private working set avg / median / max, working
set max, commit max, the process count, the sources (`counters,ex2,ex,held,opened`), and every series' n / mean / median /
min / max in `sensor_stats_json` (§Sensor aggregates). MiB stored; shown in GB as Task Manager does (1 GB = 1024 MiB).
> **The paragraph below is the design that was never built, kept as it stood** (struck 2026-10-03: the Overlay never
> called `QueryVideoMemoryInfo` — `dllmain.cpp` lists `FL_MEASURED_VRAM` as unproduced, §H10 never settled where in the
> game to call it — and D43 chose the outside read instead).
~~`vramUsedMb` from `IDXGIAdapter3::QueryVideoMemoryInfo(LOCAL)` inside the game = **this game's** usage and budget. **MiB, truncating, and it must use the same divisor as `vramBudgetMb`** — the two are compared, and mismatched rounding would put a systematic bias into `budget_exceeded_pct`. Residual: a flip within 1 MiB of the budget, 0.004% of a 24 GiB card. Stored as its own series and clearly labelled apart from the adapter-wide figure from `18_GPU_VENDOR_APIS`. Aggregates: avg, max, and `budget_exceeded_pct` (share of samples where `CurrentUsage > Budget`, i.e. the driver was likely evicting — a genuinely useful stutter explanation).~~
## Sensor aggregates
Per session over 1 Hz samples: `avg` (mean of non-null), `max`. Sensor timeline aligned to the frame timeline via the shared QPC epoch captured at session start. Fields with no data are `N/A`, never 0.
Per session over 1 Hz samples: `avg` (mean of non-null), `max` — and since beta.12 the `median` (the linear-interpolation
50th percentile: the middle sample of an odd count, the mean of the two middle ones of an even count) and the `min`
(`Domain.Metrics.SeriesAggregates`). Every stored series' n / mean / median / min / max is written once at finalize to
`sessions.sensor_stats_json`, so the summary's statistics read stored values and outlive a retention sweep of the raw
series. Sensor timeline aligned to the frame timeline via the shared QPC epoch captured at session start. Fields with no
data are `N/A`, never 0.
## Accuracy budget (shown in Help → About metrics)
**The card's clocks and limits (beta.14, D49), both tiers.** The core and memory clock (MHz), the fan (RPM) and the
memory temperature were in the samples before (L2 reads them, L3 too) and stored nowhere; they are series now
(`gpu_core_clock`, `gpu_mem_clock`, `gpu_fan`, `gpu_mem_temp`) with `avg_gpu_core_clock_mhz`, `avg_gpu_mem_clock_mhz`,
`avg_gpu_fan_rpm` and `max_gpu_mem_temp`. **What held the card back** is NVAPI's perf-decrease reasons
(`GpuSample.ThrottleReasons`, L3 only): `gpu_power_limit` / `gpu_thermal_limit` read 100 on a tick whose reasons include
the power limit (`0x2`) / thermal slowdown (`0x1`) and 0 on one whose reasons do not, so their mean — `power_limit_pct`,
`thermal_limit_pct` — is the share of ticks held back. A card no layer reports reasons for (every card but NVIDIA's) has
no answer: N/A, never "not limited". `throttle_pct` (any reason) is unchanged.
## Efficiency (beta.14, D49)
`app_frames_per_joule` = the application frame rate ÷ the card's average board power — FPS per watt, frames per joule.
**Never the displayed rate** (rule 6): a generated frame costs the card a fraction of a rendered one, and counting it would
sell frame generation as efficiency. The application rate is known when frame generation was counted over the session
(Native FPS; a counted `none` makes it the presented rate), or when no frame-generation runtime was loaded
(`presented_qualifier = no_fg_runtime`). **Null** for `census_not_run`, `fg_runtime_loaded` and `none_withheld`, for a
session whose generation changed state (its steady state covers a share of the session, and the power is the whole
session's), without a power reading, and at Tier 2 (no frames). The power is the **graphics card's** — not the
processor's, not the whole PC's — averaged over the session's sensor ticks. `Domain.Metrics.EnergyEfficiency`,
`SessionAggregator.ApplyEfficiency`.
## Accuracy budget ~~(shown in Help → About metrics)~~
*(Corrected 2026-10-04: no such page exists. Users read these limits in `LIMITATIONS.md` (Help ▸ Limitations) and in
`legal/ACCURACY.md`, which it links.)*
| Quantity | Tier 1 | Tier 2 |
|---|---|---|
@@ -617,10 +875,17 @@ Per session over 1 Hz samples: `avg` (mean of non-null), `max`. Sensor timeline
| Upscaler + render resolution | **exact** (vendor API arguments) | not available |
| RT active | measured per frame | not available |
| Path tracing | heuristic, confidence-scored, never asserted | not available |
| Per-process VRAM | exact | not available |
| ~~Per-process VRAM~~ Game process memory (beta.12) | ~~exact~~ dedicated / shared GPU memory as Task Manager counts it — a known 512 MiB allocation read +512.0 MiB (`spike-notes` §16); private working set equal to Windows' own counter; read from outside the game | ~~not available~~ the same, from outside; an unpinned hold sums the executable's processes |
| PC latency | as reported by Reflex | not available |
| Display mode (beta.10) | per 100 ms sample: exclusive fullscreen as the swap chain answers it (DXGI; OpenGL and Vulkan cannot say), borderless, windowed, minimised; the window's size from user32 | per 1 s sample, from the window alone: windowed, minimised, or *fullscreen or borderless* — never split |
| GPU temp / load / power | vendor API accuracy, ±1 s sampling | same |
| CPU temperature | sensor-inherent ±1–2 °C, needs LHM + PawnIO + elevation | same |
| GPU clocks / fan / memory temperature (beta.14) | vendor API accuracy, ±1 s sampling | same |
| GPU power / thermal limit (beta.14) | NVAPI's perf-decrease reasons once a second — a limit that came and went between two ticks is not seen; NVIDIA only, N/A on every other card | same |
| Time below 30 / 60 / refresh (beta.14) | from the frame times above, with the margins of §Pacing — a rate less than 2 % under the threshold reads partly as at it | **not available** |
| Efficiency (beta.14) | the application rate's accuracy over the board-power sensor's; N/A wherever the application rate is not known | **not available** |
| CPU temperature | sensor-inherent ±1–2 °C, needs LHM + PawnIO + elevation. **Read since 2026-09-21** (`Telemetry.LhmCpuTemperatureReader`: the package sensor, else the hottest core) and **unmeasured on real hardware** — no elevated run with PawnIO has been taken (`20_OPEN_QUESTIONS` §CPU) | same |
| CPU load | **time busy over elapsed, every logical processor** (`GetSystemTimes`, 1 Hz, unprivileged; since 2026-09-21). Not Task Manager's "utility", which is frequency-scaled and exceeds 100 under turbo — the two are different numbers and this one is stated as what it is. Null on a session's first tick (no interval yet), never 0 | same |
| System memory in use | physical memory in use machine-wide, MiB (`GlobalMemoryStatusEx`, 1 Hz, unprivileged; since 2026-09-21). The machine's, not the game's | same |
> **The Tier-2 column is now "not available" for everything except sensors, and that is the whole change.** It previously claimed frame times within 0.1% without injection. Nothing produces them.
@@ -640,13 +905,13 @@ Per-column sources, and what a *Tier-2* export does instead:
| Column | Tier-1 source | Tier 2 |
|---|---|---|
| `frame_index`, `qpc_ms`, `frametime_ms` | `frametimes` blob + session `qpcEpoch` | ~~from CSV~~ — no Tier-2 CSV exists; a Tier-2 session exports no per-frame rows at all |
| `native_or_generated` | `frame_flags` generated bit — set where `fgEvaluations == 0`, i.e. the presents that carried **no** application-frame evaluation. Inverted from the pre-2026-08-14 reading, and accurate to one frame per the note in §Frame Generation | `FrameType` (2.x) |
| `native_or_generated` | `frame_flags` generated bit — set where `fgEvaluations == 0`, i.e. the presents that carried **no** application-frame evaluation. Inverted from the pre-2026-08-14 reading, and accurate to one frame per the note in §Frame Generation | ~~`FrameType` (2.x)~~ — no Tier-2 CSV *(corrected 2026-10-04)* |
| `render_w/h`, `output_w/h` | `render_res` blob — **two `uint16` pairs per frame**, not one; `ResizeBuffers` is hooked precisely because output resolution changes mid-session | `N/A` |
| `upscaler`, `upscaler_quality`, `fg_mode` | segment table, joined by frame index | `N/A` |
| `rt_flags` | `rt_flags` blob, **one byte per frame** preserving all three bits (`asBuildObserved`, `dispatchObserved`, `psoCreatedEver`) — collapsing them to a single "rt-active" bit loses the inline-RayQuery distinction this project exists to measure. The third was `rtPsoAlive` until layout v3 renamed it: creation is observed at `CreateStateObject` and destruction is COM `Release`, which is not in the hook inventory and must not be added, so the bit latches and could only ever mean "created ever" | `N/A` |
| `dispatch_rays` | `dispatch_rays` blob (`uint32[]`, the volume) | `N/A` |
| `pso_created` | `pso_created` blob (`uint16[]`, the **count**, not a flag) | `N/A` |
| `vram_mb` | `vram_proc` per-frame blob. Note the value is refreshed at 1 Hz (`17_HOOK_ENGINE` §Memory) so it is a held sample, not a per-frame measurement — the header block says so | `N/A` |
| `vram_mb` | `vram_proc` per-frame blob. ~~Note the value is refreshed at 1 Hz (`17_HOOK_ENGINE` §Memory) so it is a held sample, not a per-frame measurement — the header block says so~~ **Corrected 2026-10-03: the Overlay never produced it, so the column has always been empty.** It stays in the list — the schema is fixed — and the header's note says so; the game's memory is the `# game_memory:` header line (beta.12, §Game process memory) | `N/A` |
| `reflex_latency_us` | `latency_us` blob; **finalize must write it** | `N/A` |
Plus a `#`-prefixed header block: game, date, **capture tier**, api, present mode, hardware snapshot, segment list, the tri-state flags with their sources, and the note that `vram_mb` is 1 Hz-sampled. The tier belongs in the header because a Tier-2 export is missing whole columns and anyone reading it later must know why.
Plus a `#`-prefixed header block: game, date, **capture tier**, api, present mode, swap effect, **the display line** (beta.10: `# display:` with each mode's milliseconds, the changes, the source and the window / back buffer / monitor sizes, or `N/A` for a session recorded before — §Display mode; a mode is the session's, not a frame's, so it is not a column), hardware snapshot, segment list, the tri-state flags with their sources, ~~and the note that `vram_mb` is 1 Hz-sampled~~ **the game's memory** (beta.12: `# game_memory:` with the dedicated GPU memory's mean / median / max, the shared max, the private working set's mean / median / max, the working set's and the commit's max — MiB, invariant — the process count and the sources, or `N/A` for a session recorded before or one where nothing answered; the session's figure, read once a second, so a header line like the display's), and the note that `vram_mb` is the in-game figure this build does not produce. The tier belongs in the header because a Tier-2 export is missing whole columns and anyone reading it later must know why.
+161 -13
View File
@@ -22,6 +22,7 @@ public interface IFrameSource : IAsyncDisposable
> {
> FlWriterState WriterState { get; } FlShmHandshake Handshake { get; }
> long TotalDropped { get; } long TotalGaps { get; }
> FlDisplayState? DisplayState { get; } // region 4, beta.10 (added to this sketch 2026-10-04)
> DrainResult Drain(Span<FlFrameRecord> into, IList<ulong> gapIndices);
> void PublishGuardResult(uint completedEvaluations, bool unhookRequested);
> void SetPaused(bool paused); void RequestLogFlush();
@@ -38,7 +39,9 @@ public interface IFrameSource : IAsyncDisposable
> with `FlGuardBuildId`), `ITargetLivenessSource` (`HeldProcessLivenessSource`, §S29(e)),
> `ITargetResolver` (`TargetResolver`, path only — never a pid), `IProcessLauncher`
> (`ProcessLauncher`, launch mode), `IRuntimeModuleSnapshot`, `INgxDriverProbe`,
> `IExecutableMarkerScan`. `ShmRingReader` itself gains no interface and no second consumer
> ~~`IExecutableMarkerScan`~~ — **corrected 2026-09-27:** the marker scan is the recorder's, not the loop's; the loop's
> later ports are `IKillSwitch` (FR-2.4), `ICapturePauseSource`, `IUserModeExceptionSwitch` and
> `IOverlayToleranceChannel` (D33) and `IDisplayProbe` (beta.10). `ShmRingReader` itself gains no interface and no second consumer
> (`NoSecondRingReaderTests`). A **pure move**: the loop's ordering rules, its tests and the
> capture host's report are byte-for-byte what they were; the host is now a thin shell that
> composes the same objects. What the table below used to call `HookedFrameSource` is this.
@@ -74,6 +77,32 @@ promises.** It is stated here, in `README` §Capture tiers and in `03_METRICS`
frame times without injection and a reader who remembers that will otherwise assume
it still holds.
> **Built 2026-09-22 — until then Tier 2 did not exist in practice.** Every refusal returned from
> `CaptureSession` within about a second and `SessionFinalizer`'s 30 s minimum discarded the row, so the
> table above described a tier no session had ever reached (the owner's log: `Discarded (tier 2, exit=Normal,
> frames=0)` for every refusal). Now the loop **holds** a refused session open — `HoldUnhookedAsync`, one tick
> per `CaptureOptions.HoldInterval` (1 s), each tick draining the telemetry poller through the observer as a
> hooked session's ticks do — until the target exits, the user stops it or `MaxDuration` runs out. The clock is
> the pinned liveness when the loop holds a pin, and ~~the executable's NAME~~ **the executable's image path in the
> watcher's own 1 Hz snapshot** (`ITargetResolver.IsRunning` over `LatestProcessSnapshot`, 2026-09-23; a process
> whose path could not be read still counts by its name; the console verbs, where nothing polls, keep the name
> list) when it never opened the process — by name, another game's `Game.exe` held an RPG Maker game's session
> open. Nothing about the hold touches the target, and no process is opened for it. *(Corrected 2026-10-03, beta.12, D43:
the hold now reads the game's own memory, once a second, by opening each process running the executable with
`PROCESS_QUERY_LIMITED_INFORMATION` for the read and closing it after — the right the watcher's own snapshot already uses
on every process each second; nothing is held, nothing is injected, and the memory's contents are never read. Its video
memory comes from performance counters that need no handle at all; `03_METRICS` §Game process memory.)* **And hooking-off is decided before the process is opened**: `RunAsync` reads the consent record
> first, and a row whose hooking is off — merely added, blocked by a finding, auto-disabled — goes straight to
> the hold with `RefusedHookNotEnabled` (its verdict is the row's block when it has one, `PreviouslyBlocked`).
> The resolver used to run first, and a hooking-off utility that runs elevated (Borderless Gaming, imported from
> Steam) was reported as a process an anti-cheat driver protects, with the notice that sentence deserves.
> `TargetNotRunning` alone returns at once — there is nothing to hold. Launch mode's two guard refusals
> (`LaunchTargetExited`, `LaunchNoPresentationRuntime`) return at once too, because the descendant election
> is waiting on them. The unshipped operator host sets `HoldUnhooked = false`: to an operator a refusal is the
> answer and the exit code. The discard rule is unchanged: a Tier-2 row under 30 s is still dropped, which is
> now a game that ran under 30 s rather than every refusal. `PartialRecovery` no longer reads a tick as proof of
> a hooked session — a held session flushes ticks with no records and no `attached` note.
**The reason is the payload of Tier 2**, not a consolation attached to it. A session
that records duration and sensors while saying nothing about *why* it measured
nothing is indistinguishable from a broken capture. `sessions.capture_notes` and the
@@ -103,7 +132,7 @@ which makes the notification more important than it was, not less.
## Process watcher
- 1 Hz snapshot via `CreateToolhelp32Snapshot` (CsWin32): pid, ppid, exe path (`QueryFullProcessImageName`).
- Watchlist match on normalized full path (`GetFinalPathNameByHandle` — junctions/symlinks), filename fallback with a stale-path warning badge.
- Watchlist match on normalized full path (~~`GetFinalPathNameByHandle`~~ `File.ResolveLinkTarget` *(corrected 2026-10-04 — `ExecutableIdentity` says why)* — junctions/symlinks), ~~filename fallback with a stale-path warning badge~~ **and a file name alone never starts a session (2026-09-23, HANDOFF D25): it can only be the entry's own executable on a drive that changed its letter (the relocator's rule), or it is not in the library.**
- Process tree assembled from ppid chains; the **capture target** is the descendant that actually presents. In launch mode we know it; in attach mode we wait for the first ring handshake. ~~or (Tier 2) elect the PID with the most presents in the first 10 s~~ — there is no Tier-2 present stream to elect from. Re-elect if the presenting PID dies while the tree lives (level-transition relaunches).
> **Built 2026-09-10 (P2 PR-F), in `Application.Watch` with one adapter.** `ToolhelpProcessSnapshotSource`
@@ -113,7 +142,26 @@ which makes the notification more important than it was, not less.
> both null so it can match nothing. `ProcessWatcher` diffs it against the watchlist — the `games` rows — on the
> normalised full path first and on the file name only when exactly ONE row carries it (`StalePath`, the
> "stale-path warning badge"; the session is keyed on the path the process actually runs from, so consent for the
> old path does not follow the binary). `ProcessTree` reads ppid chains with the one rule that defeats pid
> old path does not follow the binary — **unless it IS the same binary on a drive that changed its letter**, 2026-09-22:
> `CaptureOrchestrator.AdoptIfMovedAsync` asks `ExecutableRelocator` first, and when the row's file is gone and the
> running one has the row's size and mtime, the row is moved and the session is the row's, consent and all;
> `19_SAFETY` §A moved drive is the same executable). **Narrowed 2026-09-23 (D25): a `StalePath` match that is not
> adopted records NOTHING.** The stranger session was keyed on the real path and named after the matched row, and
> `SessionRecorder`'s `EnsureAsync` turned that into a new library entry with the other game's name: *HELLO, HELLO
> WORLD!*'s `swiftshader\Game.exe` became a second "Flower in Us" (the only entry named `Game.exe`), and its NW.js
> children, matching the new entry exactly, started a second session beside the first. Now the process is said once
> in the log ("not in the library, so nothing is recorded") and its exit is silent; the adopt itself accepts only the
> row's path with its drive letter changed (an RPG Maker `Game.exe` has the same bytes in every game); and the
> running-session table is keyed by the executable's path, so a re-imported or merged entry's new id cannot start a
> second session for the same executable. The launch election registers its session there too, and skips a child the
> watcher already records. *(beta.15, 2026-10-06:)* a process turned away by that rule — "one at a time" — was never
> recorded, because the watcher reports a pid once: **a game started again while its last session was still finalizing**
> (the driver profile, a crash reporter waited for, the transaction — seconds) got no session at all. The orchestrator
> now remembers the newest such process per executable and starts its session when the running one ends, if that one
> ended on its own (not cancelled with the host), the process is the same (pid and start time) and it is then the
> executable's ONLY process — a helper of a game still running has the game beside it and stays turned away, as before
> (`CaptureOrchestratorTests`: the restart recorded, the helper not, a process that left meanwhile not). **Behaviour change:** a game whose folder moved (not its drive letter) records nothing until
> *Change executable* points its entry at the new file. `ProcessTree` reads ppid chains with the one rule that defeats pid
> reuse: a child that started before its parent is not its child. `DescendantElection` picks the newest-started
> descendant whose image is tracked — a launcher's consent does not extend to what it spawns, so the elected image
> needs its own record. `CaptureOrchestrator` is the `--serve` loop: one snapshot per second, ONE session per game
@@ -125,10 +173,27 @@ which makes the notification more important than it was, not less.
> (`05_DETECTION` §Caching) on its own task, because `GameFileProbe` blocks on file I/O and the 1 Hz poll must
> not wait on it. It reads game files and writes the detected columns of `games`; it never touches a process,
> a hook, or a consent column.**
>
> **The watchlist is the entries whose recording is on (2026-09-23, FR-1.6, D29).** Borderless Gaming starts with
> Windows on the owner's machine, and since Tier 2 exists every library entry that runs gets a session — one per boot,
> for as long as the utility ran, in the playtime totals. `games.record_sessions = 0` (schema 0009, the user's switch on
> the game page) takes an entry out of the watchlist `PollOnceAsync` hands the watcher, and out of the launch election's
> tracked set: its process appearing is no event, no session and no log line. Switched off while a session of it runs,
> the orchestrator cancels that session's stop token at its next poll — the loop ends as a user stop and saves what it
> had — and `LaunchGame` answers `RecordingOff`. Switched back on, a process that is still running is picked up by
> the next poll (a pid the watcher never matched is new to it). Detection and the drive-letter relocator still follow
> the entry; they read files, not processes.
## Launch mode vs attach mode
**Launch mode (preferred).** User starts the game from FrameLedger (or FrameLedger is set as the launch wrapper): `CreateProcess(CREATE_SUSPENDED)` → guard → inject → `ResumeThread`. Catches swapchain creation and upscaler init, which attach mode can miss entirely — a game that creates its DLSS feature during startup will otherwise report `upscaler = unknown` for the whole session.
**Launch mode (preferred).** User starts the game from FrameLedger ~~(or FrameLedger is set as the launch wrapper)~~ *(corrected 2026-10-04: no wrapper exists, and no App button sends `LaunchGame` yet — the pipe command has no caller; launch mode runs from the Agent's developer verb `--console launch --exe`. Since beta.21 one does: **Play** set to *Start directly* — D59, `08_UI` §Games)*: `CreateProcess(CREATE_SUSPENDED)` → guard → inject → `ResumeThread`. Catches swapchain creation and upscaler init, which attach mode can miss entirely — a game that creates its DLSS feature during startup will otherwise report `upscaler = unknown` for the whole session.
> **An elevated Agent starts the game as a standard user (beta.10, the admin mode, D34).** `ProcessLauncher` checks its
> own token: elevated, it starts the game with the desktop shell's token (`Infrastructure.Startup.UnelevatedProcess` —
> `GetShellWindow`'s process, its token duplicated, `CreateProcessWithTokenW`, the same explicit environment the kill
> switch decides), pins it from the start's own handle, and never falls back to its own token: with no shell the launch
> fails with `Launch_Error_1400`. `LaunchGame` is a pipe command any process of the user can send; an elevated launch would
> be an elevation without a prompt.
> **Built 2026-09-06 (P1 item 2) as "inject late", which is the only shape §S1 left possible, and the
> sentence above is kept as the intent it does not quite describe.** A `CREATE_SUSPENDED` target has
@@ -149,6 +214,11 @@ which makes the notification more important than it was, not less.
> that spawns the real game and quits lands on the first, and re-electing the descendant is the Agent's
> (P2, §Process watcher) — **built 2026-09-10 (PR-F)**: the Agent's `--console launch` hands either
> answer to `DescendantElection` and runs an attach-mode session against the newest tracked descendant.
> *(Corrected 2026-10-06, beta.15: **it never ran until beta.15.** The refused outcome carried no `TargetPid`, and
> `CaptureOrchestrator.ElectAfterLaunchAsync` returned at `TargetPid == 0` — before its own `election:` log line — on every
> launch since #150; the orchestrator's tests built the outcome by hand, pid included, so nothing saw it. The refused
> outcome carries the launcher's pid and exit code now (`CaptureSessionLaunchTests` pins it), and an outcome without
> one is logged rather than silent. A real launcher run is still owed: HANDOFF, owner-only.)*
> **The host never terminates what it launched**: any refusal after the start
> leaves the title running unhooked, which is Tier 2.
>
@@ -167,13 +237,13 @@ which makes the notification more important than it was, not less.
**Attach mode.** Game launched from Steam/GOG/Epic normally; watcher sees it, guard runs, inject. Feature hooks install late, so early-init facts may be missed; the Overlay compensates by re-reading state on the first `EvaluateFeature` call it does observe, and the session is flagged `late_attach = true` so the UI can note that startup-time settings may be incomplete.
Steam users can also set FrameLedger as a launch option wrapper; documented in the UI rather than automated (never modify a user's Steam config for them).
~~Steam users can also set FrameLedger as a launch option wrapper; documented in the UI rather than automated (never modify a user's Steam config for them).~~ *(Corrected 2026-10-04: not built — there is no wrapper entry point and no UI text; a game started from Steam is recorded in attach mode. The parenthesis still holds: never modify a user's Steam config for them.)*
## The guard
The guard is **native** (`20_OPEN_QUESTIONS` §S13(a)) and the Agent reaches it through `IAntiCheatGuard`, a **thin P/Invoke facade over the single implementation** — never a second one. Two blocklist matchers that can disagree is a fail-open by construction: the day they diverge, one is wrong and nothing says which. Nothing managed parses rules or matches a blocklist, and a test asserts it (§S15 item 1).
The facade exposes exactly two operations, and neither hands out a clearance:
The facade exposes ~~exactly two operations~~ four *(corrected 2026-10-04: `GuardedInjectWhenReadyAsync`, launch mode's waiting entry, and `PreScanGameAsync`, the advisory checks 3–4 behind FR-2.2 and the library pre-scan, joined the two below; since D33 each takes `toleratedFamily`, a family name the guard resolves itself)*, and none hands out a clearance:
- `GuardedInjectAsync(pid, payload)` — runs every pre-injection check and, only on a pass, injects. There is no overload that skips the checks and no way to supply evidence; the guard collects its own, so a caller can ask but only the guard answers (§S13(b)).
- `EvaluateAsync(pid)` — the same checks with no injection, for the 30 s in-session re-scan. It cannot be used to pre-authorise anything: it takes no payload and returns no token, so acting on a pass means calling `GuardedInjectAsync`, which re-collects.
@@ -182,6 +252,18 @@ Its result is authoritative: no code path may inject without a passing check, an
What the Agent checks **before** asking the guard is the thing the native side structurally cannot see: **per-game consent** (CLAUDE.md rule 1). Consent is a record of something a human did, so `HookedCaptureGate` refuses an unconsented or un-enabled game without the guard ever being called.
> **The user-mode exception (D33, 2026-09-26) — one branch, and it only narrows.** A blocked game is refused
> `PreviouslyBlocked` before the guard is asked, as ever, UNLESS `HookRequest.FromConsent` found its exception in
> force: `hooking.usermode_ac_exceptions` on, a grant on the row made on the executable on disk, the block naming that
> family (`UserModeExceptionRules.CoveredFamily`) — and the session could publish the Overlay's channel
> (`IOverlayToleranceChannel`, `07_IPC` §D) BEFORE building the request. Then the gate hands the guard the family's
> NAME through the same entry (`GuardedInjectAsync` / `…WhenReadyAsync`), the guard decides whether to honour it and
> runs every check, and every 30 s re-scan names it again (`GuardSupervisor(guard, toleratedFamily)`). A blocked row
> whose exception does not apply is hooking-off before the process is opened, like any other. A hooked session under
> it is marked (`sessions.ac_exception_family`, `; ac-exception=<family>` in the notes), and a finding about the game,
> a safety unhook, the Overlay's own stop or a crash while hooked ends the exception (`UserModeExceptionLapsePolicy`,
> after the row is stored). `19_SAFETY` §The user-mode exception is the rule; this is where the loop applies it.
> **Where it lives, corrected 2026-08-06.** This sentence said "lives in SQLite", and was the
> only line in the tree that said where consent lives — while no database, no `games` table
> and no consent writer existed in any `.cs` file (§S27). The port is
@@ -234,6 +316,7 @@ What the Agent checks **before** asking the guard is the thing the native side s
> **The PAIR, because zero is not a finding.** A process owning no top-level window at all — `hook-harness` presents to a composition swapchain and has none — is unfocused on every tick of every run. Reporting that as focus loss would fire on every integration run and teach the reader to ignore the line, which is the could-not-look/looked-and-found-nothing collision `FlRtTier` and `upscalerQuality` already exist to avoid.
>
> **It is attribution, never the guard.** What refuses a mixed window is `FgWindow.BatchRefusal`, computed from the records alone, so a caller that never wires focus still cannot publish an averaged ratio. Focus is what lets the report name the cause.
- **Each drain tick also samples the display mode (beta.10)** — `Application.Capture.DisplaySampler` on the same tick as focus: shared-memory region 4 (the presenting chain's window, back buffer, swap effect and exclusive state, as the Overlay last asked them) and the window's geometry from outside (`IDisplayProbe`, `Infrastructure.Display.WindowGeometryProbe`), classified and added up by the time each sample stood for; a paused tick drops the interval it ends. The last sample is closed before the last drain, and the tally rides out on `CaptureOutcome.Display`. **The Tier-2 hold samples too**, once per hold tick (1 s): the window only — by the pinned pid when the loop holds one, else by every process running the executable in the watcher's snapshot (`ITargetResolver.PidsOf`, image path only — never a name), still opening nothing. The recorder writes the tally on the row's skeleton, so both tiers store it (`03_METRICS` §Display mode, `06_DATA_MODEL` 0016).
- **Dropped records are computed here, not read from the header.** The Overlay has no reader index and cannot know whether a slot it overwrites was consumed. The Agent owns the read index, so it owns the accounting: when `writeIndex - readIndex > capacity`, add the excess to the session's data-quality counter and resume at `writeIndex - capacity`. A non-zero value means the Agent stalled for over ~16 s — log it, surface it as a session warning, never silently accept it.
> **That sentence is true only because the read index is seeded from the writer at
@@ -245,7 +328,7 @@ What the Agent checks **before** asking the guard is the thing the native side s
> published at attach are counted separately as `RecordsBeforeAttach`; that is not
> a stall and must not raise this warning.
- **A torn record is a gap, not a skipped frame.** Silently dropping it merges two frame times into one double-length interval, i.e. fabricates a stutter. Record an explicit gap at that index; `03_METRICS` excludes gap-adjacent intervals from frame-time statistics.
- Records go into an in-memory buffer (`ArrayPool<FlFrameRecord>` segments). Every 60 s, a crash-safety flush writes raw buffers to `%LOCALAPPDATA%\FrameLedger\tmp\<sessionGuid>.partial`.
- Records go into an in-memory buffer (~~`ArrayPool<FlFrameRecord>` segments~~ a `List<FlFrameRecord>` — corrected 2026-10-04). Every 60 s, a crash-safety flush writes raw buffers to `%LOCALAPPDATA%\FrameLedger\tmp\<sessionGuid>.partial`.
## Threading model
@@ -254,7 +337,7 @@ What the Agent checks **before** asking the guard is the thing the native side s
| Thread | Cadence | Owns | Touches |
|---|---|---|---|
| **Session loop** (`CaptureSession.RunAsync`, one async loop per session) | `Task.Delay(100 ms)` drain ticks; the 30 s guard scan is awaited inline | The ring reader, for the life of the session — drain, `PublishGuardResult`, `SetPaused`, `RequestLogFlush` — and the record buffer it fills | Samples foreground per tick, drains the telemetry queue per tick (PR-D), writes `.partial` itself (PR-D) |
| **Session loop** (`CaptureSession.RunAsync`, one async loop per session) | `Task.Delay(100 ms)` drain ticks; the 30 s guard scan is awaited inline | The ring reader, for the life of the session — drain, `PublishGuardResult`, `SetPaused`, `RequestLogFlush` — and the record buffer it fills | Samples foreground and the display mode per tick (beta.10), drains the telemetry queue per tick (PR-D), writes `.partial` itself (PR-D) |
| **Telemetry** (`fl-telemetry`, `TelemetryPoller`, one per session) | 1 Hz, never faster than 500 ms | Its own `ConcurrentQueue` of `TelemetrySample` | Reads the composite source only; L2 has a thread of its own inside the library, and the composite is read from this thread and no other |
| **Watcher** (built 2026-09-10, PR-F: `CaptureOrchestrator.RunAsync` on a `PeriodicTimer(1 s)`) | 1 Hz process snapshot | The watcher's events and the running-session table — ~~`PollOnceAsync` is their only writer; there is no `Channel`, because there is no second consumer~~ **since 2026-09-13 (P3 PR-1b) the table has one lock**: `PollOnceAsync` on the timer, `LaunchAsync` and `StopSession` from the pipe's tasks (HANDOFF §P3 D12 as built — two commands do not justify a channel); the sessions themselves never take it | The `games` rows (one read per poll) and never the ring; each session it starts runs on its own task |
| **Finalize** (PR-D) | Once, on the session loop's task | The one SQLite connection, behind a `SemaphoreSlim(1)` | `ApplicationStopping` cancels the loop; finalize gets a grace window, then the `.partial` stays for recovery |
@@ -270,9 +353,15 @@ than a tuning knob. ~~There is no UI thread in P2; the pipe reader (P3) joins as
the pipe's tasks touches the ring or the recorder, and the session loop never waits on a client. The command half (PR-1b) is the
`Channel` producer this sentence anticipated.
> **The pause is a gap (beta.8).** FR-3.9's pause stops the Overlay recording; the loop reads the QPC as it tells the ring
> to resume (`ApplyPause`, before `SetPaused(false)`, on the Overlay's own clock — `Stopwatch` is `QueryPerformanceCounter`)
> and marks a gap before the first drained record stamped at or after it (`MarkResume`). A record drained after the
> resume but stamped before it is a straggler the pause had not reached. `03_METRICS` §Data gaps says what a gap then
> does to the statistics and to `D`.
## Telemetry poller
1 Hz on its own thread: `CompositeTelemetrySource.TryRead` (`18_GPU_VENDOR_APIS` — DXGI/PDH baseline, LibreHardwareMonitor sensors, NVAPI extras on NVIDIA) + optional CPU sample when the Agent is elevated and PawnIO is present. Never called from the game process, never faster than 500 ms. Samples carry the session QPC epoch for timeline alignment.
1 Hz (the session's `telemetry.interval_ms`, 500–2000 ms) on its own thread: `CompositeTelemetrySource.TryRead` (`18_GPU_VENDOR_APIS` — DXGI/PDH baseline, LibreHardwareMonitor sensors, NVAPI extras on NVIDIA) ~~+ optional CPU sample when the Agent is elevated and PawnIO is present~~ + *(corrected 2026-10-04)* the machine's reading on the same tick — CPU load and memory in use without elevation, CPU temperature only when elevated with PawnIO — and the game process's memory (beta.12, D43). Never called from the game process, never faster than 500 ms. Samples carry the session QPC epoch for timeline alignment.
## Session recorder — state machine
@@ -317,6 +406,22 @@ because a layer cannot leave a running game's loader chain.
**Discard rule:** duration < min session length (default 30 s) → discard silently (log only).
> **A session whose entry was removed while it ran (2026-09-23).** Step 5 wrote under the id the session *started*
> with, and the owner's GIRLS' FRONTLINE 2 entry was removed — and re-imported — twice while the game ran: both
> sessions died on the foreign key (`session: FAULTED SqliteException: … FOREIGN KEY constraint failed`, 2026-09-22
> 23:26 and 2026-09-23 00:25), and each left a `.partial` whose recovery would have died the same way at the next
> start — stopping the host, because recovery ran before the watcher with no guard. As built:
> - **The owner is looked up, not assumed** (`ISessionRepository.ResolveOwnerAsync`, `FinalizeInput.ExePath`): the id
> the session started under when that row predates the session or holds its executable (an id SQLite reused for a
> later game is neither — `games.id` has no AUTOINCREMENT), else the row that holds the executable's path now (the
> re-imported entry), else **`GameRemoved`**: the user removed the game with its sessions and this was one of them.
> Nothing is written, the `.partial` is deleted, and the log says which. The write transaction re-checks the row, so a
> removal between the lookup and the insert is the same answer rather than the foreign key's exception.
> - **Recovery never throws.** A file it cannot finalize is set aside as `<guid>.partial.failed` (never retried, kept for
> a bug report) and reported `Failed`; the next file is recovered, and the watcher starts either way.
> - The Agent's host logs through Serilog since the same day: a background service that stops the host is now in
> `agent-*.log`, where before it was in no file at all.
> **Built 2026-09-10 (P2 PR-D): `Application.Recording`.** The state machine above is the intent; what
> runs is one class per box. `SessionRecorder` owns a session end to end — the row's identity and time
> base (`session_guid`, `qpc_epoch`/`qpc_frequency` from `TimeProvider.GetTimestamp`, which is QPC), the
@@ -342,9 +447,30 @@ because a layer cannot leave a running game's loader chain.
## Crash & exit classification
- Normal: presenting PID exit code 0.
- `crashed`: nonzero exit code, **or** an Application Error (1000) / WER (1001) event log record naming the exe within `[start, end + 30 s]`.
- `unhooked_safety`: the guard fired mid-session.
- Normal: presenting PID exit code 0 — **and since beta.8 any exit code that is not an exception's** (End task and taskkill leave 1; a program's own error exit; Ctrl+C's `0xC000013A`), kept in `capture_notes` and said as what it is.
- `crashed`: ~~nonzero exit code~~ **an exception's exit code** (`ExitStatusMapper.IsExceptionCode`: NTSTATUS `0xC0000000–0xC0FFFFFF` but `0xC000013A`, `0xE06D7363` C++, `0xE0434352` .NET, `0x80000003` breakpoint), **or** an Application Error (1000) / WER (1001) event log record ~~naming the exe~~ **that is a crash report of this game** within `[start, end + 30 s]`, **or** (beta.14) an engine's crash reporter the game started before it left.
> **Corrected 2026-10-05 (beta.14, the crash-reporter question): the event-log witness was too broad, and one engine's
> crashes had no witness at all.** A record counted when any of its strings *contained* the executable's name: on the
> owner's machine a WER 1001 `RADAR_PRE_LEAK_64` — Windows' memory-leak detector — named `witcher3.exe` and a session
> that ended with exit code 0 was stored `crashed` (2026-10-04, read from a copy of the ledger and the event log); a hang
> report, another program whose name contains this one's, or a crash of a same-image child would have done the same.
> `CrashEventMatcher` now takes a 1000 from `Application Error` only when its application name equals the executable's,
> its path (when given) is the executable's and its process id is the session's, and a 1001 from `Windows Error
> Reporting` only when it is a crash report (`APPCRASH`, `BEX`, `BEX64`, `CLR20r3`, `MoAppCrash`, `MoBEX`) whose first
> parameter is the executable's name. And Unreal handles its own crash — it starts `CrashReportClient.exe` and exits
> with code 3, no exception code and no event — so it read `normal`. The watcher's once-a-second snapshots now record
> every **on-crash** reporter a process starts (`Watch.CrashReporterCatalog`: Unreal's `CrashReportClient.exe`,
> REDengine's `CrashReporter.exe`, RE Engine's `CrashReport.exe`, BugSplat's `BsSndRpt(64).exe`) with its parent by pid,
> image and start (`CrashReporterWitness` — a pid reused by a later process is not the parent); the recorder asks at the
> end, after two more polls when the game just left. It counts (`CrashReporterRule`) when it started at least 10 s after
> the game and the game left within 60 s of it: `crashed`, with `crash_reporter=<image>` in the notes. A reporter whose
> game kept running is a note (`crash_reporter_seen=`). **Always-on handlers never count** — Unity's
> `UnityCrashHandler64.exe` and `crashpad_handler.exe` start with their game. No process is opened for any of this.
> Sessions stored before beta.14 keep their status.
- `unhooked_safety`: the guard fired mid-session. *(Since beta.14, D48: a re-scan that refused only because it could not
read the game's tree, concluded after the game itself had exited, is the game's exit instead — `normal` or `crashed` by
its exit code — with `scan_at_exit=<reason>` in `capture_notes`; `19_SAFETY` §During a session.)*
- `degraded`: Overlay self-disabled after faults, or ring layout mismatch mid-session.
- `interrupted`: Agent died mid-session; recovered from `.partial` on next start.
- A **user stop** (FR-3.6; `StopSession` over the pipe, P3 PR-1b) is `normal`: the loop ends as `SessionEndReason.StoppedByUser` at its next tick, drains once more and finalizes; the target keeps running, unhooked from here. It is the session's own stop token, not the host's cancellation — the latter leaves a `.partial`.
@@ -361,10 +487,25 @@ Crash-within-60s-of-injection happening twice for the same game ⇒ **hooking au
> exit code and the witness (`end=TargetExited; exit_code=-1073741819; crash_event=application_log`).
> `CrashAutoDisablePolicy` counts only crashes inside the 60 s window after the attach — `hook_crash_count`
> is that count and nothing else — and disables on the second; it never re-enables.
>
> **Corrected 2026-09-25 (beta.8, owner item 5): End task is not a crash.** The owner's sessions ended by Task Manager
> read *Crashed* — every non-zero code was one, and `TerminateProcess` leaves 1. A crash is now an exception's code or
> the event log's witness; any other code is `normal` with the code in the notes, and the session summary says it
> ("ended with exit code 1 — what End task and taskkill leave…", "crashed (0xC0000005 access violation)", "0xC0000006
> in-page I/O error: a disk or drive failed…"). **The safety policy did not get looser:** it takes the exit code beside
> the status and still counts every non-zero exit inside its window — a game the hook hung that the user then ended is
> the shape it exists for — and its row reason says "ended abnormally", not "crashed" (`19_SAFETY` §Crash & stability).
>
> **The notes' guard slot has three positions since the same day:** `guard=Reason|Family|Signal`, every slot present
> and `;` never inside one (`CaptureNotes.GuardSlot`). It was `Reason/Family/Signal` with an empty family dropped, so
> a refusal no family names put its signal where the family goes — and the notice read "Access is denied was detected
> in this game" — and a signal with a `;` was cut there. Old rows are read by the one rule that separates them: findings
> and the gate's own refusals carry a family, every other reason's second part was its signal. A launch that cannot
> start keeps Windows' reason (`launch_error=740`; `IProcessLauncher.Start(…, out win32Error)`).
## Live progress
`SessionProgress` at 1 Hz to the UI (`07_IPC`): rolling 5 s Native FPS, Displayed FPS, FG factor, current render→output resolution, upscaler + quality, RT active flag, GPU/CPU temp, per-process VRAM, elapsed. Suppressed when no UI client is connected. This is what makes the Dashboard live card genuinely useful — it is showing *measured* settings, not guesses.
`SessionProgress` at 1 Hz to the UI (`07_IPC`): rolling 5 s Native FPS, Displayed FPS, FG factor, current render→output resolution, upscaler + quality, RT active flag, GPU/CPU temp, ~~per-process VRAM~~ the game process's dedicated GPU memory and private working set (beta.12, from the newest telemetry tick — `SessionHeld` carries the same two for a held session), elapsed. Suppressed when no UI client is connected. This is what makes the Dashboard live card genuinely useful — it is showing *measured* settings, not guesses.
> **Built 2026-09-13 (P3 PR-1, HANDOFF §P3 decision D13): `Application.Ipc.SessionProgressCalculator`**, over the last 5 s of the
> ring's records through the same calculators the row uses — `FrameTimeSeries` for the presented rate, `FgWindow` + the FG ladder for
@@ -373,6 +514,13 @@ Crash-within-60s-of-injection happening twice for the same game ⇒ **hooking au
> stands alone with the census qualifier (`FgLadder.PresentedQualifier`, the row's). CPU temperature is null until the Agent composes a
> CPU sensor, and every other unmeasured field is null, never 0. Rate-limited to 1 Hz inside the observer's `Tick`, computed only while
> a client is connected, and a fault in the computation is counted rather than allowed to end the session.
>
> **A held session is live too (2026-09-23).** The hold's ticks carry the refusal (`CaptureProgress.Held`, with the pid the loop
> holds, 0 for a hooking-off hold that never opened the process). The publisher's first held tick announces the session —
> `SessionStarted` at tier 2 with its `hold`, and the refusal's own event at once rather than when the game exits — and every tick
> after feeds `SessionHeld` (elapsed and sensors, nothing measured) at the same 1 Hz while a client listens. It is never run through
> `SessionProgressCalculator`, whose window over no records would still emit a qualifier. A session whose task faults now also
> completes on the pipe (`finalize: faulted`, `07_IPC`), so nothing is left shown as running.
## Overhead rules (NFR-1)
+270 -27
View File
@@ -26,11 +26,20 @@ Derived in the Agent from the record stream; the mapping is in `03_METRICS`. Sum
| Reflex on + PC latency | NVAPI Reflex hooks |
| Per-process VRAM | `QueryVideoMemoryInfo` |
| PSO compilation events | pipeline-creation hooks |
| Display mode — exclusive fullscreen / borderless / windowed / minimised, with the window, back buffer and monitor (beta.10) | `GetFullscreenState` + `GetDesc` polled on the presenting chain (≤ 2 Hz, shared-memory region 4), and the window's geometry read by the Agent **out of process** — so this row is **both tiers**: a Tier-2 session has the window alone, and never splits exclusive from borderless (`03_METRICS` §Display mode) |
> **Not built, 2026-09-15:** four rows above have no writer yet — HDR output, Reflex and PC latency, per-process
> VRAM, and PSO compilation events. The Overlay never sets their measured bits, so every calculator over them
> returns nothing and the columns stay null; `legal/ACCURACY.md` lists them as not measured. This table is the
> design; the block is the state.
>
> **2026-09-27 (beta.10):** the first row's *swap effect* has a writer since schema 0016 — region 4's `GetDesc`, stored
> in `sessions.swap_effect` as a name (`flip_discard`, …) — and the display-mode row is new. **Present mode has none**,
> and the block above did not list it: `sessions.present_mode` is null on every row, and the pages say N/A.
>
> **2026-10-04 (beta.12, D43):** the per-process VRAM row's *usage* is measured — not by `QueryVideoMemoryInfo` but
> from outside the game, in both tiers, with the game's RAM beside it (`game_vram_*`, `game_ram_*`; `03_METRICS`
> §Game process memory). The in-game figure, its budget and `vram_proc_*` stay unbuilt.
> **"present-count delta" is removed from the FG row, and it was not merely unreliable —
> it was structurally zero.** `03_METRICS` §Frame Generation retired that rung on
@@ -42,11 +51,11 @@ Derived in the Agent from the record stream; the mapping is in `03_METRICS`. Sum
> stale-by-not-being-touched failure this project keeps recording; `06_DATA_MODEL`'s
> `fg_source` enum carried the same value and is corrected in the same pass.
~~Tier-2 sessions have `upscaler = unknown`, resolutions `N/A`, RT `N/A`, and an FG mode only if cadence resolves it.~~ **Simpler since 2026-08-28: a Tier-2 session detects NOTHING.** It has no frames, so cadence has nothing to run over. `upscaler`, resolutions, RT and FG all read `N/A`, and the static-hint tier (below) is the only thing that says anything about such a title — which it labels *inference*, never measurement.
~~Tier-2 sessions have `upscaler = unknown`, resolutions `N/A`, RT `N/A`, and an FG mode only if cadence resolves it.~~ **Simpler since 2026-08-28: a Tier-2 session detects NOTHING.** It has no frames, so cadence has nothing to run over. `upscaler`, resolutions, RT and FG all read `N/A`, and the static-hint tier (below) is the only thing that says anything about such a title — which it labels *inference*, never measurement. **The ~~one exception~~ exceptions** *(corrected 2026-10-04)* are how its window was shown (the display-mode row, beta.10) and the game process's memory (beta.12), which the Agent reads from outside the game in either tier.
## Static hints — rules engine
Rules are **data, not code**: `rules/detection-rules.json`, bundled and updatable from the repo (raw GitHub URL, ETag-cached; manual "Update detection rules" in Tools + weekly auto-check). Schema:
Rules are **data, not code**: `rules/detection-rules.json`, bundled ~~and updatable from the repo (raw GitHub URL, ETag-cached; manual "Update detection rules" in Tools + weekly auto-check)~~ *(corrected 2026-10-04: nothing fetches. The rules ship with the build and `RulesSeeder` installs them in `%LOCALAPPDATA%\FrameLedger\rules\`; Tools ▸ Update detection rules re-seeds from the copy beside the binary and wakes the detection and anti-cheat sweeps. A rules change reaches users with a release — `20_OPEN_QUESTIONS` §S20 feed half)*. Schema:
```json
{
@@ -59,9 +68,9 @@ Rules are **data, not code**: `rules/detection-rules.json`, bundled and updatabl
}
```
The `anticheat` block is the same file that feeds the hard guard in `19_SAFETY` — shipping it as updatable data is what lets a newly-protected game be blocked without waiting for an app release. **Rules updates that touch the `anticheat` block are treated as security updates:** applied on next check regardless of the user's auto-update preference for other rules.
The `anticheat` block is the same file that feeds the hard guard in `19_SAFETY` — shipping it as updatable data is what lets a newly-protected game be blocked without waiting for an app release. ~~**Rules updates that touch the `anticheat` block are treated as security updates:** applied on next check regardless of the user's auto-update preference for other rules.~~ *(Corrected 2026-10-04: there is no feed and no auto-update preference, so today a newly-protected game waits for a release; the sentence is what a feed must do once built, §S20.)*
Signal types evaluated by `RuleEvaluator` (Domain): `file_exists`, `dir_exists`, `sibling_glob`, **`path_contains`**, `pe_company_contains`, `pe_product_contains`, `strings_contains` (bounded 8 MB scan), `manifest_field`. Combine with `all` / `any` — **not nested**, which schemaVersion 2 forbids. Version extractors: `pe_file_version` (of the sibling its `from` names, not of the executable), `pe_product_version_regex`, **`strings_regex`**, `manifest_field`.
Signal types evaluated by `RuleEvaluator` (Domain): `file_exists`, `dir_exists`, `sibling_glob`, **`path_contains`**, `pe_company_contains`, `pe_product_contains`, `strings_contains` (bounded 8 MB scan), `manifest_field`. Combine with `all` / `any` — **not nested**, which schemaVersion 2 forbids. Version extractors: `pe_file_version` (of the sibling its `from` names, not of the executable), `pe_product_version_regex`, **`strings_regex`**, `manifest_field`, and since 2026-09-27 **`unreal_build`** (no parameter; decided in code, §Engine version). A regex extractor must capture exactly **one** group — the evaluator returns the first — and `rules-validate.ps1` refuses any other count and any pattern that does not compile (both promised by the rules file's `$comment` and enforced by nothing until beta.10).
> `path_contains` and `strings_regex` were in the shipped data and the schema
> and missing from this list; the schema's own `$comment` said so and nobody had
@@ -83,7 +92,10 @@ Signal types evaluated by `RuleEvaluator` (Domain): `file_exists`, `dir_exists`,
### Trust and staleness of the rules feed
`20_OPEN_QUESTIONS` §S4. The file is fetched over HTTPS from a raw GitHub URL.
> **Specified, not built (corrected 2026-10-04):** there is no feed (§S20 feed half, §S4); these rules apply once one
> exists. Today the seeder validates the packaged copy with the guard's parser and keeps `detection-rules.json.bak`.
`20_OPEN_QUESTIONS` §S4. The file ~~is~~ would be fetched over HTTPS from a raw GitHub URL.
Three rules, because a gate whose data can silently go stale is a gate with an
expiry date nobody sees:
@@ -131,13 +143,15 @@ Recorded as a residual risk, not as a solved problem.
| Engine | Signals | Version |
|---|---|---|
| Unity | `UnityPlayer.dll` sibling **or** `<Exe>_Data/` dir | FileVersion of `UnityPlayer.dll` |
| Unreal 4/5 | exe matches `*-Win64-Shipping.exe` **or** `*/Content/Paks/*.pak` | ProductVersion regex `\+\+UE(4\|5)\+Release-(\d+\.\d+)` |
| Godot | `.pck` sibling **or** `strings_contains("Godot Engine v")` | strings regex `Godot Engine v(\d+\.\d+[\.\d]*)` |
| Unity | `UnityPlayer.dll` sibling **or** `<Exe>_Data/` dir | `unity_build` (since 2026-10-12, §Engine version — Unity, Godot, RPG Maker): the player library's ProductVersion, the data file's header, the library's numeric version. ~~FileVersion of `UnityPlayer.dll`~~ — the string as it is, `2022.3.39.5118735`, the build number where the release letter belongs |
| Unreal 4/5 | exe matches `*-Win64-Shipping.exe` **or** `*/Content/Paks/*.pak` | `unreal_build` (since 2026-09-27, §Engine version): the shipping executable's numeric file version and the engine's branch name inside it. ~~ProductVersion regex `\+\+UE(4\|5)\+Release-(\d+\.\d+)`~~ — two capture groups, of which the evaluator returns the first, so every Unreal version it ever stored was a bare `4` or `5` |
| Godot | `.pck` sibling **or** `strings_contains("Godot Engine v")` | `godot_build` (since 2026-10-12): a data pack's header, beside the executable or appended to it. ~~strings regex `Godot Engine v(\d+\.\d+[\.\d]*)`~~ — the string sits 57–78 MB into a real export, past the 8 MiB scan, so it never read one |
| GameMaker | `data.win` | `N/A` |
| RPG Maker MV/MZ ⛔ | `nw.dll` + `www/` or `package.json` | `rpg_core.js` / `rmmz_core.js` header |
| RPG Maker XP/VX/VXAce ⛔ | `RGSS10*`/`RGSS20*`/`RGSS30*.dll` | dll name → XP/VX/VXAce |
| Ren'Py | `renpy/` dir **or** `*.rpa` | `renpy/__init__` strings / `log.txt` first line |
| RPG Maker MV/MZ | `nw.dll` **and** `package.json` siblings (since 2026-09-16) | `rpgmaker_build` (since 2026-10-12): the core script's header, which also names the maker (MZ or MV). ~~`N/A` — the `.js` header needs a `from` that `strings_regex` lacks~~ |
| RPG Maker XP/VX/VX Ace | `RGSS1*`/`RGSS2*`/`RGSS3*.dll` sibling **or** a `*.rgssad`/`*.rgss2a`/`*.rgss3a` archive (since 2026-09-16) | `rpgmaker_build` (since 2026-10-12): the RGSS library `Game.ini` names — its generation names the maker (XP, VX, VX Ace), its version is the library's. ~~`N/A` — one rule, the variant unnamed~~ |
| RE Engine (Capcom) | `re_chunk_000.pak` sibling, the exact name (since 2026-09-23) | `N/A` |
| FromSoftware | a `*.bhd` **and** a `*.bdt` sibling (since 2026-09-23) | `N/A` |
| Ren'Py | `renpy/` dir **or** `*.rpa` | ~~`renpy/__init__` strings / `log.txt` first line~~ `N/A` *(corrected 2026-10-04: no extractor — `strings_regex` reads only the executable)* |
| CryEngine | `CrySystem.dll` | FileVersion |
| Source | `gameinfo.txt` + `bin/engine.dll` | `N/A` |
| Unknown | fallback | — |
@@ -146,33 +160,199 @@ Order matters (first match wins). Engine is user-overridable.
**The array order in `detection-rules.json` *is* that precedence**, and the only thing in the repository that notices a reorder is `tests/fixtures/rules/ordering/unity_markers_with_ue_structure` — a directory carrying Unity markers *and* Unreal structure, which is the case `14_TESTING` names.
⛔ **Two rows cannot be expressed in schemaVersion 2**, and are documented rather than half-implemented — a rule that exists but never fires is worse than one that is absent, because it reads as coverage:
> **Both RPG Maker rows were ⛔ "cannot be expressed in schemaVersion 2" until 2026-09-16, and the reasoning was
> half right.** It said MV/MZ needs `nw.dll` **and** (`www/` **or** `package.json`), a nested group v2 refuses. But
> MV and MZ both ship `package.json` beside `nw.dll` unconditionally — `www/` is only where MV keeps its data — so
> `all: [nw.dll, package.json]` is the whole signal and needs no nesting. Measured on the owner's *Flower in Us*
> (Steam) and a hand-extracted MV title, both `Game.exe` + `nw.dll` + `package.json` (+ `www/`), both `engine=none`
> until this rule. The RGSS family is one rule, `rpgmaker_rgss` "RPG Maker XP/VX/VX Ace", `any` over the three DLL
> prefixes and the three archive extensions, `version: null` — the variant is not named, which is the product
> decision the old note deferred, taken as "one engine, no version" rather than three rules. **What still cannot be
> expressed** is a version for either: MV/MZ's lives in a sibling `.js` header and `strings_regex` has no `from`;
> RGSS's is which DLL matched. Both rules sit after `unity` and `unreal` and before `godot` (an MV game has no
> `.pck`; a Godot game has no `nw.dll`), with fixtures `engines/rpgmaker_mv` and `engines/rpgmaker_rgss`, and the
> `every_engine_marker` canary carries both engines' markers and still expects `unity`. `rulesVersion` is
> `2026.09.1`, so the sweep's cache key changes and every game is re-detected on the next pass.
- **RPG Maker MV/MZ.** The signal is `nw.dll` **and** (`www/` **or** `package.json`) — a nested group, and `signalGroup` sets `maxProperties: 1` with its own `$comment` saying nesting is unsupported in v2. Its version is a header inside a sibling `.js`, and `strings_regex` carries no `from`, so it cannot be aimed at a file other than the executable.
- **RPG Maker XP/VX/VXAce.** The signals *are* expressible (`any` over the three `RGSS*` prefixes), but the version is "which of them matched" — an answer no extractor produces. Splitting it into three engine rules with `version: null` and the variant in the display name would work and is a product decision about how the engine reads in the UI, not a mechanical fill-in.
> **RE Engine and FromSoftware, 2026-09-23 (owner request, "mang tính tương đối" — a relative signal, not a proof).**
> Both are file-layout signals, checked on the owner's disk before they were written. **RE Engine:** every Capcom RE
> Engine title ships its content as `re_chunk_000.pak` beside the executable, with patches as
> `re_chunk_000.pak.patch_00N.pak` (RESIDENT EVIL 2 and the Onimusha demo). The rule names the base archive exactly — a
> glob without a star is the whole leaf name — so a patch archive alone is not it. **FromSoftware:** the studio's
> titles keep their data as `.bhd` header + `.bdt` data pairs beside the executable — DARK SOULS II
> (`GameDataEbl.bhd/.bdt`), DARK SOULS III (`Data0`–`Data5`), ELDEN RING (`Data0`–`Data3`, plus `DLC`) and Sekiro
> (`Data1`–`Data5`). The request described the second extension as `.bht`; on disk it is **`.bdt`**. An `all` group
> over the two globs — half a pair is not a pair. The request also described a `<Game>\Game\` layout; it is not a
> signal here, because Sekiro has no `Game\` folder and "the parent folder is named X" is not a signal type anyway.
> None of the owner's other 80 Steam titles carries either marker. Both rules sit after the RPG Maker rules and
> before `godot`, whose `*.pck` would also match a loose Wwise sound bank (an `Unknown` there would stop the walk
> before these rules). Fixtures `engines/re_engine` and `engines/fromsoftware`; the `every_engine_marker` canary
> carries both engines' markers and still expects `unity`. `rulesVersion` is `2026.09.2`, so every stored game is
> re-detected on the next sweep. Engine detection never feeds the guard: ELDEN RING stays refused by its anti-cheat
> whatever engine it is shown as. **Engines are shown by name since the same date** (`Formats.Engine` in the App —
> proper nouns, not resources; an unknown id, or one the user typed, passes through): the game card and page used
> to show the raw id (`rpgmaker_mv`).
⛔ *(kept for the record — the two rows above were the ones this note described)* **Two rows cannot be expressed in schemaVersion 2**, and are documented rather than half-implemented — a rule that exists but never fires is worse than one that is absent, because it reads as coverage:
- ~~**RPG Maker MV/MZ.** The signal is `nw.dll` **and** (`www/` **or** `package.json`) — a nested group, and `signalGroup` sets `maxProperties: 1` with its own `$comment` saying nesting is unsupported in v2.~~ Its version is a header inside a sibling `.js`, and `strings_regex` carries no `from`, so it cannot be aimed at a file other than the executable.
- ~~**RPG Maker XP/VX/VXAce.** The signals *are* expressible (`any` over the three `RGSS*` prefixes), but the version is "which of them matched" — an answer no extractor produces. Splitting it into three engine rules with `version: null` and the variant in the display name would work and is a product decision about how the engine reads in the UI, not a mechanical fill-in.~~
Everything else in the table is in the data and has a fixture; `rules-validate.ps1` fails if a rule id has no fixture directory, or a fixture no rule.
### Engine version — Unreal Engine (beta.10, 2026-09-27, schema 0015)
The owner asked for "the exact Unreal Engine version (3.0, 4.5, 5.1 …) on the game's page". What was shipped could not
give one: the rule read only the executable's `ProductVersion` string, which most shipping executables leave empty, and
its regex had two capture groups, so the one answer it could give was `4` or `5`. **Measured before anything was written,
read-only, on the owner's ten Unreal titles** (`spike-notes` §Unreal Engine versions):
| Title | Numeric file version | Version strings / company | Branch name in the bytes | Read as |
|---|---|---|---|---|
| Black Myth: Wukong | 5.0.0.0 | none | `++UE5+Release-5.0` (290 MB into `.code`; `.rdata` 8 KB) | 5.0.0 |
| Cronos: The New Dawn (demo) | 1.2.0.0 | the studio's | none | — |
| Clair Obscur: Expedition 33 | 5.4.4.0 | none | none | 5.4.4 (file version) |
| Hell Is Us | 5.5.4.0 | `UE5-CL-0` / Nacon | none (the studio's own branch) | 5.5.4 (file version) |
| Lies of P | 4.27.2.0 | none | none | 4.27.2 (file version) |
| Martha Is Dead | 4.27.0.0 | none | `++UE4+Release-4.27` (`.rdata`) | 4.27.0 |
| Rune Factory: Guardians of Azuma | 1.0.3.0 | none | none | — |
| SILENT HILL 2 | 1.0.0.5 | the studio's | `++UE5+Release-5.1` (`.rdata`) | 5.1 |
| UMIGARI | 5.5.4.0 | `++UE5+Release-5.5-CL-40574608` / Epic Games, Inc. | (in the strings) | 5.5.4 |
| AbyssMemory | 4.26.1.0 | none | `++UE4+Release-4.26` (`.rdata`) | 4.26.1 |
**Two witnesses, each wrong in its own way.** The numeric file version (`VS_FIXEDFILEINFO`) is the engine's
MAJOR.MINOR.PATCH unless the studio replaced it (Cronos, SILENT HILL 2, Rune Factory); the branch name the engine compiles
in (a UTF-16 string) names the release line and no patch, and is missing wherever a studio renamed its branch or the
executable is packed. `Domain.Detection.UnrealVersion.Decide` takes them in order: **(1)** both, agreeing on MAJOR.MINOR →
the file's MAJOR.MINOR.PATCH (`unreal_branch_file`); **(2)** a branch name alone → MAJOR.MINOR (`unreal_branch`); **(3)**
no branch name, and a file version that reads as an engine's (4.0–4.27, 5.0–5.9, patch ≤ 20) where nothing says the studio
replaced it — no version strings, a string naming the same `UE4`/`UE5`, or Epic's company name → MAJOR.MINOR.PATCH
(`unreal_file_version`); **(4)** anything else → no version. The third rung is the weakest (a studio could number its own
game 4.2 and ship no strings), which is why `games.engine_version_source` keeps the rung and the game page says it.
**Where it is read.** `StaticGameDetector` makes a second read for the one engine that matched — never the probe for every
game in the library: `GameFileProbe.ReadUnrealBuildAsync` picks the row's own executable when it is the shipping build
(`*-Win64-Shipping.exe`, `*-WinGDK-Shipping.exe`), else the largest shipping executable the walk listed (a row pointing at
the launcher stub at the install root), and `UnrealBuildReader` reads its version resource and — unless the version strings
already name the branch — scans its `.rdata` section for the branch name: 15–39 MB in nine of the ten titles. An `.rdata`
under 1 MiB (Black Myth's protector merged its constants elsewhere) sends the scan over the whole file, bounded at 1 GiB and
stopping at the first chunk that names a release line. Chunks are 4 MB with an overlap, so a name cut by a chunk's edge is
read whole and never as the digits that fitted; cancellation is observed between chunks. Measured through the shipped
reader on the same ten files: every row above as tabled, 16 ms to 1.1 s each and 7.5 s for Black Myth, on the owner's USB
drive — once per executable, because the detection key (rules version + size + mtime) changes only when the file does.
**What it is not.** UE3 titles are not detected as Unreal at all (the rule's signals are UE4/5's layout) and have no
numbered release lines to report. A version the user typed is never overwritten and carries no witness. Rules
`2026.09.6` change the key, so every library entry is read again once; schema 0015 removes the bare `4`/`5` the old rule
wrote, where detection wrote it.
### Engine version — Unity, Godot, RPG Maker (beta.19, 2026-10-12, rules 2026.10.2)
The owner asked for the version of RPG Maker, Unity and Godot games ("if possible"). What the rules gave: Unity's
`pe_file_version` stored `UnityPlayer.dll`'s FileVersion string as it is (`2022.3.39.5118735`, the build number where the
release letter belongs); Godot's `strings_regex` scanned the executable's first 8 MiB, and in both Godot exports on the
owner's disk the `Godot Engine v…` string sits 57–78 MB in, so it never read one; both RPG Maker rules had `version: null`.
**Measured before anything was written, read-only, on 23 installs** (`spike-notes` §17), and decided in code as Unreal's
is — three extractor types that take no parameter (`unity_build`, `godot_build`, `rpgmaker_build`; the schema's enum),
one second read by `StaticGameDetector` for the engine that matched, a decider in `Domain.Detection` and the witness in
`games.engine_version_source`:
| Engine | Witness, strongest first | Source id | On the owner's disk |
|---|---|---|---|
| Unity | `UnityPlayer.dll`'s ProductVersion is an editor version (`2022.3.39f1 (4e1b…)` → `2022.3.39f1`) | `unity_player` | 13 of 15 |
| | the header of `<Game>_Data\globalgamemanagers` (first 256 bytes) names one | `unity_data` | A Space for the Unbound, 2019.4.1f1 |
| | the library's numeric file version, MAJOR.MINOR.PATCH and no release letter — Unity's own binary, so the engine's, only shorter | `unity_player_file` | GIRLS' FRONTLINE 2 (data file encrypted), 2019.4.40 |
| Godot | the 20-byte header of the data pack beside the executable (`<exe>.pck`, else the only `.pck` there): `GDPC`, format, MAJOR, MINOR, PATCH | `godot_pck` | both: 4.2.2, 4.4.1 |
| | the same header of a pack appended to the executable, found through its 12-byte trailer (size + `GDPC`) | `godot_pck_embedded` | none (synthetic files only) |
| | the executable's ProductVersion while its ProductName is still `Godot Engine` (a project that set its own carries the game's: 衔蝶 `0.1.0.3`) | `godot_exe` | — |
| RPG Maker MV/MZ | line 2 of the core script: `js/rmmz_core.js` → MZ, `www/js/rpg_core.js` or `js/rpg_core.js` → MV (first 4 KiB) | `rpgmaker_mz_core`, `rpgmaker_mv_core` | MZ 1.10.0; MV 1.6.2, 1.6.2, 1.6.1 |
| RPG Maker XP/VX/VX Ace | the RGSS library `Game.ini`'s `Library=` names: RGSS1 → XP, RGSS2 → VX, RGSS3 → VX Ace; its numeric version when it is its generation's, else the one its name carries (`RGSS301` → 3.0.1) | `rgss1_library`, `rgss2_library`, `rgss3_library` | VX Ace 3.0.1, twice |
A Godot version leaves out a zero patch, as Godot names its releases (4.3, 4.2.2). The App names the maker from the
witness — the two RPG Maker rules each cover several makers — and says that an RGSS number is the runtime library's, not
the editor's: *RPG Maker MZ 1.10.0*, *RPG Maker VX Ace (RGSS 3.0.1)* (`Formats.Engine(id, source)`,
`Formats.EngineWithVersion`); the game page's *Engine version* row says what each version was read from, and *Not found in
the game's files* once the sweep has read a row of these engines and found none.
**Where it is read.** Beside the row's executable first: `UnityPlayer.dll` (else the shallowest one the walk listed) and
`<exe>_Data` (else a `*_Data` beside that player); `<exe>.pck`. RPG Maker's files are looked for beside the executable and
up to two folders above it, as `RpgMakerTitle` already looked for a title — a launcher-fronted game keeps its runtime in
a subfolder (A Doll's Locket's `css\`, HELLO, HELLO WORLD!'s `swiftshader\` — *both "launchers" are malware, D57,
`spike-notes.md` §20*); a `Library=` that points outside the ini's
folder is named and not read. Version resources and at most a few kilobytes of any file; the whole detection of one entry
measured 24 ms to 4.1 s on the owner's USB drive, nearly all of it the install's walk, once per executable and rules
version. The Privacy Policy says so since 2.8 (§4).
**What it is not.** RPG Maker 2000/2003 is not detected at all (no install to measure, no rule). XP and VX libraries are
read by the VX Ace rule's reader unmeasured. A Unity build older than 2019 keeps its player in the executable (no
`UnityPlayer.dll`): its data file's header is the only witness. Rules `2026.10.2` change the detection key, so every
library entry is read again once; a Unity row keeps the old raw string only if none of its witnesses can be read now.
### Engine version — Ren'Py (beta.20, 2026-10-12, rules 2026.10.3)
The owner asked for the version of Ren'Py games once beta.19's were on screen. The `renpy` rule had no version extractor
(`version: null`). Ren'Py ships its engine as Python beside the game's launcher, and `renpy/vc_version.py` names its
release — `version = '8.5.0.25111603'`, beside `branch`, `nightly`, `official` and `version_name`. Measured 2026-10-12 on
the owner's one Ren'Py install, Bound Between Desks (Steam): 109 bytes, and the game's own `log.txt` printed
`Ren'Py 8.5.0.25111603` at its last start; the launcher carries no version resource (`spike-notes` §18).
**What is read and how it is decided.** `renpy_build` (`RenPyBuildReader`): the first 4 KiB of `renpy/vc_version.py`
beside the row's executable, its `version` line only (`version_name` is not it). `RenPyVersion.Decide` keeps
MAJOR.MINOR.PATCH — Ren'Py names its releases by those three; the fourth is the build — and records `renpy_vc_version`.
The page says *Ren'Py 8.5.0* and that it was read from the engine's version file; a Ren'Py row whose file names no
version says *Not found in the game's files*. Through the shipped pipeline (`StaticGameDetector` over `GameFileProbe`)
Bound Between Desks read `8.5.0` in 79 ms, and the Unity, Godot and RPG Maker installs read as before. The Privacy
Policy names the file since 2.9 (§4). Rules `2026.10.3` change the detection key, so every library entry is read again
once.
**What it is not.** Nothing else is guessed from: a Ren'Py game whose `vc_version.py` names no version, or that ships its
engine compiled only, reads as not found. One Ren'Py install was measured.
### Platform signatures & metadata
| Platform | Signals | Metadata |
|---|---|---|
| Steam | `steam_api64.dll`/`steam_api.dll` sibling, or path contains `steamapps\common` | nearest `steamapps/appmanifest_<id>.acf` (walk up): `appid`, `name`, `buildid` → version |
| GOG | `goggame-<id>.info` sibling, or `Galaxy64.dll` | `.info` JSON: `gameId`, `name`, `version` |
| Epic | `EOSSDK-Win64-Shipping.dll`, or path under an Epic install | `%ProgramData%\Epic\EpicGamesLauncher\Data\Manifests\*.item` matched by `InstallLocation` |
| itch.io | `.itch\receipt.json.gz` | receipt JSON: title, id |
| Epic | `EOSSDK-Win64-Shipping.dll`~~, or path under an Epic install~~ *(corrected 2026-10-04: the rule has no path signal)* | `%ProgramData%\Epic\EpicGamesLauncher\Data\Manifests\*.item` matched by `InstallLocation` |
| itch.io | `.itch\receipt.json.gz` | **`%APPDATA%\itch\db\butler.db`** (`install_locations` + `caves`, butler's `verdict` names the executable) since 2026-09-16, then the receipt JSON: title, id |
| None/Manual | fallback | PE VersionInfo |
**Auto-import (FR-1.2):** Steam via `libraryfolders.vdf` → all `appmanifest_*.acf`; GOG via `HKLM\SOFTWARE\WOW6432Node\GOG.com\Games\*`; Epic via `Manifests\*.item`; itch by receipt scan. Import presents a review checklist; nothing is launched, nothing is hooked on import.
> **The stores' artwork on this PC (beta.23, owner decision D60).** A game's page shows the cover and banner the Steam and
> GOG GALAXY apps already keep — Steam's `appcache\librarycache\<appid>\` (files flat or in hash-named folders), GOG
> GALAXY's `webcache\<user>\gog\<productId>\` — found for the store whose own records own the game's folder
> (`StoreRecords.Owning`, as Play finds it). `Infrastructure.Art.SteamArtCache` and `GogArtCache` read them; nothing is
> downloaded, so the *(opt-in)* online lookup in the publisher/version order below still does not exist. Epic, itch and
> other stores keep no image files: their games show the image the user chooses, or none. The detail: `08_UI` §Games ›
> Game detail, *The header's cover*.
**Auto-import (FR-1.2):** Steam via `libraryfolders.vdf` → all `appmanifest_*.acf` except `SteamLibrarySource.KnownTools` (2026-09-22: Steamworks Common Redistributables, Borderless Gaming, Wallpaper Engine, SteamVR, the Proton and Steam Linux Runtime entries, Blender — tools Steam's manifests do not distinguish from games, and which became library rows the watcher recorded); GOG via `HKLM\SOFTWARE\WOW6432Node\GOG.com\Games\*`; Epic via `Manifests\*.item`; itch by receipt scan. Import presents a review checklist; nothing is launched, nothing is hooked on import.
> **Built 2026-09-14 (P4 PR-4).** `Application.Import.LibraryImporter` over four `IStoreLibrarySource` adapters in
> `Infrastructure.Import` — `SteamLibrarySource` (`libraryfolders.vdf` + `appmanifest_*.acf` through
> `ValveKeyValues`, the Steam root from `HKCU\Software\Valve\Steam\SteamPath`), `GogLibrarySource` (the HKLM
> keys, read-only, the first HKLM read in the tree), `EpicLibrarySource` (`*.item` JSON: `DisplayName`,
> `InstallLocation`, `LaunchExecutable`, `AppName`, `AppVersionString`), `ItchLibrarySource`
> (`%APPDATA%\itch\apps\*\.itch\receipt.json.gz`). **Two stores do not name the game's executable** (Steam,
> itch): `ExecutableLocator` walks the install three levels deep, drops the helpers by name fragment and takes
> the largest — a *guess the review list marks as such*; GOG's `exe` and Epic's `LaunchExecutable` are the store's
> (~~`%APPDATA%\itch\apps\*\.itch\receipt.json.gz`~~ — **since 2026-09-16 butler's database first**: the itch app
> records the install locations the user chose in `%APPDATA%\itch\db\butler.db`, and they need not be under
> `%APPDATA%` at all — on the owner's machine the one location was `D:\another\it` and `apps\` was empty, so the
> receipt scan returned nothing, silently; `install_locations` + `caves` give every install, butler's own `verdict`
> names the executable it launches, and `apps\` receipts are still scanned for what the database does not list. The
> database is copied to a temporary directory and the copy opened read-only, because the running app holds it in
> WAL mode. One log line says what was consulted: `import: itch — butler.db read: 1 location(s), 2 cave(s), …`).
> **Two stores do not name the game's executable** (Steam,
> itch-by-receipt): `ExecutableLocator` walks the install ~~three~~ **four** levels deep, drops the helpers by name
> fragment, everything under a Unity `X_Data\Plugins` folder and every redistributables/prerequisites folder, and then
> **ranks** what is left — ~~takes the largest~~ an executable the engine's own layout names as the game (Unity: `X.exe`
> beside `X_Data`; Unreal: `*-Win64-Shipping.exe`) beats one named after the install folder, which beats a stranger, and
> size decides only between equals. "The largest wins" was measured wrong 2026-09-21 on GIRLS' FRONTLINE 2: EXILIUM:
> the import chose `GF2_Exilium_Data\Plugins\ZFGameBrowser.exe` (1,082,944 bytes) over the 675,392-byte Unity player, and
> because the watcher, consent and the gate are keyed on the executable path, hooking enabled on that row could never
> match the game. The same pass fixed Red Dead Redemption 2 (the 140 MB launcher installer under `Redistributables`),
> Counter-Strike 2 (`vconsole2.exe`), Rune Factory (root bootstrapper vs the shipping binary) and Dying Light: The
> Beast (the game sits four levels down). Still a *guess the review list marks as such*, and since the same date the
> game page shows the row's executable and **Change executable…** re-points it (hooking off and unconsented afterwards,
> exactly as a new game; a block is never cleared by it). GOG's `exe` and Epic's `LaunchExecutable` are the store's
> own. The review (`ImportReviewPrompt`) ticks only what can be imported: a row already in the library or with no
> executable on disk cannot be. Every added row lands exactly as File ▸ Add game… lands it — hooking off — and
> the store's platform, id and version go through `IGameRepository.ApplyStoreMetadataAsync` under the same
@@ -183,7 +363,36 @@ Everything else in the table is in the data and has a fixture; `rules-validate.p
> is fetched (CLAUDE.md rule 8's "opt-in store metadata" is the online lookup, which does not exist). First-run
> step 4 now points at File ▸ Import library… rather than saying "later build".
**Publisher/version order:** store manifest → PE `CompanyName`/`ProductVersion` → *(opt-in)* Steam `appdetails` lookup, cached 7 days.
> **beta.19 (owner report 2026-10-12): a store's own pick can be a helper, and a launcher is not the game.** The owner's
> A Doll's Locket - Remake (itch 5085165, RPG Maker MZ) was imported as `Dolls Locket\notification_helper.exe` — NW.js's
> toast helper. The pick was **butler's verdict**, taken as is: butler stores a *filtered* verdict (the shallowest
> candidates, minus those whose manifest asks for elevation) and does not rank what is left, and on that install the
> 213 MB `DollsLocket.exe` launcher asks for administrator while the NW.js runtime sits a level deeper in `css\`, so the
> helper was the whole verdict (read from the owner's `butler.db`, read-only). *(Corrected 2026-10-13, owner decision
> D57: that "launcher" — the same 213 MB program HELLO, HELLO WORLD!, City of Bones and Träumerei put in front of their
> runtime — is malware: it ships a registry file that switches off Windows' script scanning and adds Microsoft Defender
> exclusions (`spike-notes.md` §20). Do not run it. The admin-mode sentence below is withdrawn; the three changes stand
> as rules about helpers and NW.js layouts, and the import still takes a store's own pick when it is not a helper.)*
> Three changes:
> **(1)** a verdict candidate whose whole name is a runtime helper (`ExecutableLocator.RuntimeHelperNames`:
> `notification_helper`, `crashpad_handler`, `UnityCrashHandler64/32`, `CrashReportClient`, NW.js's `nwjc` and
> `chromedriver`) or that sits in a Unity plugin folder is skipped, and with nothing left the locator guesses and the
> review marks the row *guessed* — whole names, because the locator's fragments are inside real games' names (`node` in
> *Nodebuster*) and a store's pick is overruled only when it cannot be the game; the locator's `HelperFragments` gain the
> same three NW.js names. **(2)** The locator ranks **an executable beside `nw.dll` + `package.json`** — the `rpgmaker_mv`
> rule's own signal — as an NW.js runtime (owner decision D56), below the Unity and Unreal layouts (an NW.js folder can
> be a tool shipped beside such a game) and above a name match (the launcher in front of the runtime is named after the
> install): the install's guess is `css\Game.exe`, the process that draws, as D28 pointed HELLO, HELLO WORLD!'s entry at
> its runtime by hand. ~~That runtime starts elevated (its launcher asks for administrator), so it is measured with the
> admin mode on (D34).~~ *(Withdrawn 2026-10-13, D57: it starts elevated because the malware in front of it asks for
> administrator.)* **(3)** Discovery matches a store title to an entry by **platform + store id** as well as by
> path: the entry an earlier import made at another executable is "already in the library" (the log names its path),
> so a corrected guess never adds the same game a second time — that entry is re-pointed with Change executable…, and
> nothing rewrites it by itself (D25/D27). Tests: `ExecutableLocatorTests.AnNwjsRuntimeBeatsTheLauncherNamedAfterTheInstallAndItsHelpersAreDropped`,
> `StoreLibrarySourcesTests.ItchSkipsAVerdictCandidateThatIsARuntimeHelper` (the verdict as stored),
> `LibraryImporterTests.AStoreTitleAlreadyInTheLibraryAtAnotherExecutableIsNotOfferedAgain`.
**Publisher/version order:** store manifest → PE `CompanyName`/`ProductVersion` ~~→ *(opt-in)* Steam `appdetails` lookup, cached 7 days~~ *(never built — FrameLedger makes no request to a store, `privacy.online_metadata` is reserved, and a game's artwork (beta.23, D60) is read from the store app's own files on the disk; struck 2026-10-14)*. *(Since beta.8 the PE versions are stored beside the store's rather than instead of it — §What the files say about themselves; the page labels a store's value with its store, "Steam build 20374416".)*
## Capability hints (explicitly labelled as such)
@@ -191,8 +400,8 @@ Files shipped with a game tell us what it *supports*. These populate a **"Suppor
- DLSS SR `nvngx_dlss.dll` · DLSS-G `nvngx_dlssg.dll` · **Ray Reconstruction `nvngx_dlssd.dll`**
- Streamline `sl.interposer.dll`, `sl.dlss_g.dll`, `sl.reflex.dll`
- FSR `ffx_fsr2_*.dll`, `ffx_frameinterpolation_*.dll`, `amd_fidelityfx_*.dll`, `ffx_api*.dll` — a hint still, even though `amd_fidelityfx_dx12.dll` / `_upscaler_dx12.dll` / `_framegeneration_dx12.dll` are *hooked* since 2026-09-04: the measured chip comes from the dispatch, never from the file
- XeSS `libxess.dll`, XeFG `libxess_fg.dll`
- FSR `ffx_fsr2_*.dll`, `ffx_fsr3*.dll` (since rules 2026.09.5 — FSR 3's `ffx_fsr3_x64.dll` / `ffx_fsr3upscaler_x64.dll` matched nothing before), `ffx_frameinterpolation_*.dll`, `amd_fidelityfx_*.dll`, `ffx_api*.dll` — a hint still, even though `amd_fidelityfx_dx12.dll` / `_upscaler_dx12.dll` / `_framegeneration_dx12.dll` are *hooked* since 2026-09-04: the measured chip comes from the dispatch, never from the file
- XeSS `libxess.dll`, `libxess_dx11.dll` (since rules 2026.09.5), XeFG `libxess_fg.dll`
- DXR-capable: `d3d12.dll` usage + RT-capable GPU (capability only — says nothing about the game)
- **Vulkan (since P4 PR-2, 2026-09-14) — a code-level fact, not a rule.** The rules can only ask about files
beside the executable, and the Vulkan loader is not one of them (`vulkan-1.dll` lives in System32). So
@@ -205,17 +414,48 @@ Files shipped with a game tell us what it *supports*. These populate a **"Suppor
The UI wording is deliberate: **"Supports DLSS-G"** (capability, from files) versus **"Frame Generation: DLSS-G ×1.9"** (measured, from this session). Users conflating these is exactly the confusion the old design created.
### What the files say about themselves (beta.8, 2026-09-25, schema 0011)
The owner asked for the game's version, the DLSS / FSR versions and whether a game is 32- or 64-bit. The sweep read
most of it already and kept none of it; since beta.8 it keeps four more facts per game, written whole with each
detection (`DetectionWrite`, `games.exe_machine` / `exe_file_version` / `exe_product_version` / `library_versions`):
- **What the executable runs as** — `PeImports.ReadArchitecture`, from the same bounded header read as the imports:
the COFF machine and, for a .NET executable, the CLR header's flags (`Domain.Detection.ExecutableArchitecture`:
`x64 | x86 | arm64 | arm | anycpu | anycpu32 | other | unknown`). An "AnyCPU" assembly carries an I386 machine and
runs as a 64-bit process unless it prefers or requires 32-bit, which is why the machine alone is not the answer.
`x86`, `anycpu32`, `arm64` and `arm` are **known not hookable** — the hook is an x64 DLL loaded with `LoadLibraryW`
(CLAUDE.md rule 3) — so enabling hooking on one is refused before anything is scanned or stamped
(`Refused { reason: "ExecutableNotX64", signal: <id> }`, `07_IPC`), and a row enabled before this build read the file
has its hooking turned off by the sweep (`hook_autodisabled_reason` = `executable is x86: the hook runs in x64
processes only`). `unknown` and `other` are not: the guard's `TargetIsWow64` at a session's start stays the check.
A row whose `exe_machine` is NULL is stale once, so every library entry is read under this build.
- **The executable's own versions** — the PE `FileVersion` and `ProductVersion` strings. The file's word, kept apart
from `game_version`, which is the store's (a Steam build id, a GOG or Epic version string) or the user's. For an
Unreal title the file version is often the *engine's*; the page labels both and does not pick one.
- **What it ships, with versions** — every file a capability rule names among those the walk listed, with the
numeric version of its `VS_FIXEDFILEINFO` (the version *string* may carry text, and Streamline stamps `2,8,0,0`):
`nvngx_dlss.dll 3.7.10.0`, `sl.interposer.dll 2.8.0.0`, `ffx_fsr2_api_x64.dll …`. Bounded at 48 files. A file with
no version resource is listed with none — it is shipped either way. FSR is named by its file, never mapped to an
"FSR 2.2" number: the DLL's version is the SDK's, and no table of that mapping has been measured.
**Shipped is not loaded.** `library_versions` is what the game folder holds. What the process loaded is
`sessions.runtime_modules` (Tier 1), and the two differ exactly when something else supplied the DLL — the NVIDIA
App's DLSS override loads the driver's `nvngx_dlss.dll` from the driver store under the same name. The session
summary prints the loaded list and names such a difference ("the game ships 3.7.10.0: another copy was loaded");
it does not claim who loaded it.
## Anti-cheat pre-scan (static)
Before a game is ever launched with hooking enabled, the static scan checks for anti-cheat SDKs shipped alongside it (`EasyAntiCheat/` directory, BattlEye binaries, EOS anti-cheat components, etc.). A hit **disables the hooking toggle for that game entirely** in the UI, with an explanation — the user cannot enable it, so the guard never even has to fire at launch. Prevention beats interception.
**Implemented in the native guard, not here** (`fl_prescan.cpp`, exposed as `FlStaticPreScan`). It uses the same `MatchName` and the same rules file as the injection guard, matching directory names against the `anticheat.directories` group and file names against `anticheat.files`. Nothing managed matches a blocklist (§S15 item 1).
**Implemented in the native guard, not here** (`fl_prescan.cpp`, exposed as ~~`FlStaticPreScan`~~ `FlStaticPreScanGame` since 2026-09-25, which takes the executable, resolves the install root itself and runs check 3 as well). It uses the same `MatchName` and the same rules file as the injection guard, matching directory names against the `anticheat.directories` group and file names against `anticheat.files`. Nothing managed matches a blocklist (§S15 item 1). **It walks two folders since 2026-10-13:** the install root and, when the executable lives below it, the executable's own folder — each three levels deep. The root alone missed Wuthering Waves' `Client\Binaries\Win64\AntiCheatExpert\`, which sits beside the executable and four levels under the root (`19_SAFETY` §Pre-injection checks, item 4; `spike-notes.md` §19).
Three things this section previously implied that are not true, and are worth stating:
- **The UI answer is advisory.** It decides whether the toggle is *offered*; it does not gate injection. The same scan runs a second time inside the guard's chokepoint against a directory derived from the target's own pid, so "prevention beats interception" is a convenience, not the enforcement.
- **A hit disables the toggle; "could not scan" must not.** The scan is tri-state. `Reason::kPreScanFailed` — directory absent, unlistable, past a bound, or behind a reparse point — is *neither* a hit nor a pass. It must surface as "could not verify", distinct from "anti-cheat found": disabling the toggle on it would be a false refusal with no appeal, and clearing it would be a fail-open.
- **The token list is thin.** `directories` and `files` carry three tokens today. Widening needs verified names; a guessed token fails closed by never firing, which is a silent hole (`19_SAFETY` §Blocklist seed).
- **A hit disables the toggle; "could not scan" must not.** The scan is tri-state. `Reason::kPreScanFailed` — directory absent, unlistable, past the entry bound, or behind a reparse point — is *neither* a hit nor a pass. *("Past a bound" until 2026-10-13: the depth bound is a reach, not a refusal — a folder at the last level is named and never opened, and the walk still reads as complete.)* It must surface as "could not verify", distinct from "anti-cheat found": disabling the toggle on it would be a false refusal with no appeal, and clearing it would be a fail-open.
- **The token list is thin.** `directories` and `files` ~~carry three tokens today~~ *(corrected 2026-10-04: rules 2026.10.1 carry 9 directory families (12 names) and 18 file families (55 names), and since 2026-09-25 any `*.sys` in the install tree is a finding by code, not data)*. Widening needs verified names; a guessed token fails closed by never firing, which is a silent hole (`19_SAFETY` §Blocklist seed).
## Caching & privacy constraints
@@ -225,7 +465,10 @@ Three things this section previously implied that are not true, and are worth st
> `DetectionHostedService` (`--serve` only) sweeps the library on its own task — every 15 s, and at once
> when `UpdateRules` re-seeds the rules file — through `Application.Detection.DetectionSweep`, which runs
> `StaticGameDetector` over the real `GameFileProbe` for every game whose key is stale and persists through
> `IGameRepository.ApplyDetectionAsync`. A game the App adds is scanned on the next tick (the App writes the
> `IGameRepository.ApplyDetectionAsync`. *A missing executable is asked one more question before it is skipped
> (2026-09-22): is the same file — same size, same mtime — under exactly one other drive letter? When it is, the row
> follows it (`ExecutableRelocator`, `19_SAFETY` §A moved drive is the same executable) and this very pass scans
> it there; `DetectionSweepReport.Relocated` counts them.* A game the App adds is scanned on the next tick (the App writes the
> row, the Agent reads the table); no Agent running means no scan, and the game page says "not scanned yet".
> *The key's exe half is NOT `exe_size_bytes` / `exe_mtime_ms`:* those are the consent fingerprint the gate
> reads (`SqliteGameConsentStore` refuses a mismatch while a block stands), so schema 0004 gave the key its own
+312 -33
View File
@@ -2,7 +2,7 @@
`%LOCALAPPDATA%\FrameLedger\ledger.db`. Pragmas: `journal_mode=WAL`, `synchronous=NORMAL`, `foreign_keys=ON`, `busy_timeout=5000`. `Microsoft.Data.Sqlite` + Dapper; all writes in explicit transactions.
**Writer ownership:** Agent writes `sessions`, `session_segments`, `frame_blobs`, `sensor_blobs`, `hardware_snapshots`, the hook-state columns on `games`, **and since P4 PR-1 (2026-09-14) the *detected* columns on `games`** — `engine`, `engine_version`, `platform` under the per-field provenance rule (`05_DETECTION` §Caching: a `user` field is never touched), `capability_flags` whole, and the cache key `detection_rules_version` / `detection_exe_size_bytes` / `detection_exe_mtime_ms` — through `IGameRepository.ApplyDetectionAsync` only. The UI and the Agent were both already writers of `games`; this adds columns to the Agent's half, not a third writer (HANDOFF §P4). **And since P4 PR-4 the UI's library import writes `platform`, `store_id` and `game_version` through `ApplyStoreMetadataAsync`** — the same per-field provenance rule, badged `detected` (a store's record is not the user's typing), on columns the UI already owned. **Maintenance (P4 PR-7) adds no writer:** the retention sweep on demand is the Agent's, asked over the pipe; the UI's `VACUUM` rewrites pages with the same contents and changes no row (§Retention built note). UI writes `games` (user-editable fields — since P3 PR-3 that is the FR-1.3 metadata, the `*_default` tri-states, and `removed_at`; never a `hook_*` column), `session_annotations` (tags, notes, and since schema 0002 the FR-8.3 overrides — which is WHY they are on this table and not on `sessions`), `settings`, `legal_acceptance`. Both read everything. The ports say the same in their names: `IGameRepository.UpdateMetadataAsync` / `SetTriStateDefaultAsync` / `RemoveAsync`, `ISessionAnnotationRepository`, `RegisteredSettings`, `ILegalAcceptanceStore.RecordAsync` (all P3 PR-3).
**Writer ownership:** Agent writes `sessions`, `session_segments`, `frame_blobs`, `sensor_blobs`, `hardware_snapshots`, the hook-state columns on `games`, **and since P4 PR-1 (2026-09-14) the *detected* columns on `games`** — `engine`, `engine_version`, `platform` under the per-field provenance rule (`05_DETECTION` §Caching: a `user` field is never touched), `capability_flags` whole, and the cache key `detection_rules_version` / `detection_exe_size_bytes` / `detection_exe_mtime_ms`, and since schema 0011 (2026-09-25) the executable's own facts `exe_machine` / `exe_file_version` / `exe_product_version` / `library_versions`, written whole like the flags — through `IGameRepository.ApplyDetectionAsync` only. The UI and the Agent were both already writers of `games`; this adds columns to the Agent's half, not a third writer (HANDOFF §P4). **And since P4 PR-4 the UI's library import writes `platform`, `store_id` and `game_version` through `ApplyStoreMetadataAsync`** — the same per-field provenance rule, badged `detected` (a store's record is not the user's typing), on columns the UI already owned. **And since 2026-09-23 the Agent's relocator merges two entries for one executable under two drive letters** (`IGameMerge`, HANDOFF D26, `19_SAFETY` §A moved drive is the same executable): in one transaction it re-parents the dropped entry's `sessions` to the survivor (before the delete — `sessions.game_id` cascades), carries a block or a crash auto-disable still in force to the survivor (`hook_enabled` only ever to 0; `hook_blocked_reason` is copied, never originated or cleared), adds the crash counts, deletes the dropped `games` row, and then moves the survivor to the file's path (after the delete — `exe_path` is UNIQUE). It was the one Agent write that deletes a `games` row until beta.19; it never touches a consent column. **And since beta.19 (2026-10-12, D55) the Agent removes an entry whose game is no longer installed** (`IGamePrune`, `SqliteGamePrune`, asked by the detection sweep through `UninstalledEntryPrune`): one `DELETE` that holds every stored condition in the same statement — the same row at the same path, `removed_at` NULL, no session stored (`NOT EXISTS` on `sessions` — nothing cascades), no `hook_blocked_reason`, `hook_prescan_state` not `blocked`, no `ac_exception_at` and no `ac_exception_trial_failed_at` — behind `retention.remove_uninstalled_games`; a block, a grant and D38's mark are never removed with their entry (`19_SAFETY` §What a finding does to the game, *What clears it*). **And since 2026-09-23 the UI writes `record_sessions`** (schema 0009, FR-1.6): the entry's recording switch, which the Agent only reads — off, the watcher does not watch for the program. The script's one data change switches it off for entries an old import made for Steam's own tools (`SteamLibrarySource.KnownTools`, the ids as of the script); a twin merge keeps it off when either twin had it off. **And since 2026-09-25 the Agent's pre-scan of the library (`19_SAFETY` §What a finding does to the game) writes the hook-state columns of every entry, not only of those the user asked to hook** — `hook_prescan_state`, and on a finding `hook_enabled = 0` and `hook_blocked_reason` — and its own key, `hook_prescan_rules_version` / `hook_prescan_exe_size_bytes` / `hook_prescan_exe_mtime_ms` (schema 0010), through `IGameConsentStore.RecordPreScanAsync` only: columns that were already the Agent's, never over a block, never a new row. **And since 2026-09-26 (schema 0014, D33) the Agent writes the user-mode exception's columns** — `ac_exception_*` on `games` through `IGameConsentStore` only (eligibility from the sweep, a grant from the `SetAntiCheatException` command, every end), and `sessions.ac_exception_family` with the session — the grant only after the user accepted its disclosure in the UI, which asks and never writes. **And since 2026-10-03 (beta.11, D40) the Agent deletes sessions on request** — every session of one game or of every game, `DeleteSessions` over the pipe, through `ISessionRepository.DeleteSessionsAsync` in one transaction (segments, blobs and annotations cascade), never while one is being recorded; the UI asks and never deletes a session row itself *(for Delete all sessions; FR-1.4's removal is the App's own cascade, above — corrected 2026-10-04)*. **Maintenance (P4 PR-7) adds no writer:** the retention sweep on demand is the Agent's, asked over the pipe; the UI's `VACUUM` rewrites pages with the same contents and changes no row (§Retention built note). UI writes `games` (user-editable fields — since P3 PR-3 that is the FR-1.3 metadata, the `*_default` tri-states, and `removed_at`; ~~never a `hook_*` column~~ **and two downgrades** *(corrected 2026-10-04)*: *Change executable* (2026-09-21, `GameLibrary.ChangeExecutableAsync`) turns hooking off, clears the consent and pre-scan columns and ends an exception grant — it never writes a block or a grant — and *Remove game ▸ DeLine truncated
## Schema (v2 — hook architecture)
@@ -40,12 +40,24 @@ CREATE TABLE schema_migrations (version INTEGER PRIMARY KEY, applied_at INTEGER
CREATE TABLE games (
id INTEGER PRIMARY KEY,
name TEXT NOT NULL,
exe_path TEXT NOT NULL UNIQUE,
exe_path TEXT NOT NULL UNIQUE, -- where the executable lives; rewritten by ExecutableRelocator when the
-- SAME bytes (exe_size_bytes, exe_mtime_ms) turn up under another drive
-- letter (2026-09-22), and by Change executable for a DIFFERENT binary
platform TEXT NOT NULL DEFAULT 'none', -- steam|gog|epic|itch|none
store_id TEXT,
engine TEXT, engine_version TEXT,
-- (schema 0015, ALTERed last) engine_version_source TEXT: where engine_version came from — a
-- Domain.Detection.EngineVersionSource id (unreal_branch_file | unreal_branch | unreal_file_version; since beta.19
-- unity_player | unity_data | unity_player_file | godot_pck | godot_pck_embedded | godot_exe | rpgmaker_mz_core |
-- rpgmaker_mv_core | rgss1_library | rgss2_library | rgss3_library — the RPG Maker ids also name the maker; since
-- beta.20 renpy_vc_version; or the
-- rule's extractor type); NULL for a version the user typed. Written with the version only (05_DETECTION §Engine version)
publisher TEXT, game_version TEXT,
cover_path TEXT, notes TEXT,
cover_path TEXT, notes TEXT, -- cover_path: written since beta.23 (D60) — the image the user chose, as
-- covers\game-<id>-<unix ms>.png relative to the data folder (a PNG copy
-- <= 1200 px); followed only when it is one of those names under covers\
-- and never through a junction or a symbolic link (a viewer's copy could
-- name a share); NULL = the store app's own artwork
removed_at INTEGER, -- schema 0002 (P3 PR-3): FR-1.4 "remove, keep sessions" — the row stays
-- (sessions.game_id is NOT NULL, ON DELETE CASCADE) but leaves the
-- library; a later launch of the same exe restores it (removed_at = NULL)
@@ -53,7 +65,32 @@ CREATE TABLE games (
-- hooking state (19_SAFETY)
hook_enabled INTEGER NOT NULL DEFAULT 0, -- 0 = Tier 2, i.e. nothing measured; default for every new game
hook_consent_at INTEGER, -- per-game informed consent timestamp
hook_blocked_reason TEXT, -- set by the static AC pre-scan; non-null = toggle disabled in UI
hook_blocked_reason TEXT, -- set by the static AC pre-scan; non-null = toggle disabled in UI.
-- 'Reason|Family|Signal' since 2026-09-25 (SqliteGameConsentStore.
-- BlockText), so the App can say it in the user's language; older
-- rows keep "Reason: Family Signal" and are shown as stored
hook_prescan_rules_version TEXT, -- schema 0010 (2026-09-25): the key the Agent's pre-scan of the
hook_prescan_exe_size_bytes INTEGER, -- library last scanned the row under — the rules version and the
hook_prescan_exe_mtime_ms INTEGER, -- executable's size and mtime; NULL = never scanned by the sweep.
-- Change executable clears them with hook_prescan_state
-- schema 0014 (2026-09-26, D33): the user-mode anti-cheat exception, a layer OVER hook_blocked_reason, never its clearing
ac_exception_eligible INTEGER NOT NULL DEFAULT 0, -- the Agent's sweep: the exception may be granted now
ac_exception_verdict TEXT, -- its tolerant pre-scan, Reason|Family|Signal; NULL = nothing asked
ac_exception_sessions INTEGER NOT NULL DEFAULT 0, -- D38: successful sessions under the grant in force (its trial)
ac_exception_checked_rules_version TEXT, -- the key the verdict was reached under: rules, executable size and
ac_exception_checked_exe_size_bytes INTEGER, -- mtime, and the block text itself
ac_exception_checked_exe_mtime_ms INTEGER,
ac_exception_checked_block TEXT,
ac_exception_at INTEGER, -- the user's grant; NULL = no exception in force
ac_exception_family TEXT, -- the family it covers (kept as history once it ends)
ac_exception_disclosure_version TEXT, -- AntiCheatExceptionDisclosure.Version the user accepted
ac_exception_exe_size_bytes INTEGER, -- the executable the grant was made on; other bytes end it
ac_exception_exe_mtime_ms INTEGER,
ac_exception_lapsed_at INTEGER, -- when and why the last grant ended (UserModeExceptionLapse:
ac_exception_lapsed_reason TEXT, -- Withdrawn|ExecutableChanged|NoLongerEligible|NewFinding|
-- SafetyUnhook|OverlayStopped|SessionCrashed|TrialFailed)
-- schema 0017 (2026-10-03, D38): an exception of this game ended during its trial — for good; never cleared
ac_exception_trial_failed_at INTEGER,
hook_autodisabled_reason TEXT, -- set after repeated crashes
hook_crash_count INTEGER NOT NULL DEFAULT 0,
capability_flags TEXT, -- JSON: what the game SHIPS — never a measurement. Since P4 PR-1 (2026-09-14) a JSON
@@ -67,6 +104,14 @@ CREATE TABLE games (
rr_default TEXT NOT NULL DEFAULT 'na',
detection_rules_version TEXT,
exe_machine TEXT, -- schema 0011 (2026-09-25): what the executable runs as, from its PE
-- headers (x64|x86|arm64|arm|anycpu|anycpu32|other|unknown); NULL =
-- not read by this build yet, which the detection sweep reads as stale
exe_file_version TEXT, -- schema 0011: the executable's PE FileVersion (the file's word; game_version
exe_product_version TEXT, -- is the store's or the user's) and its ProductVersion
library_versions TEXT, -- schema 0011: JSON array, the capability files the game SHIPS —
-- {"capability","path","fileVersion","productVersion"}; what a session
-- LOADED is sessions.runtime_modules
field_provenance TEXT, -- JSON: {"engine":"detected","publisher":"user",...}
-- absent or unrecognised reads as "user"
added_at INTEGER NOT NULL, updated_at INTEGER NOT NULL
@@ -85,15 +130,18 @@ CREATE TABLE games (
> human's typed value as auto-detected is a lie they cannot see through; failing to
> badge a detected value merely costs a badge on something they can still edit. The
> rule it exists to support — *detection never overwrites a `user` field* — is in
> `05_DETECTION` §Caching and is enforced by `StaticDetectionResult.ShouldWrite`,
> which is tested even though nothing persists yet.
> `05_DETECTION` §Caching and is enforced by ~~`StaticDetectionResult.ShouldWrite`,
> which is tested even though nothing persists yet~~ `SqliteGameRepository.FieldProvenance.Resolve`
> *(corrected 2026-10-04: applied per field since P4 PR-1, and it also fills an empty field that has no entry;
> `ShouldWrite` keeps its tests but has no production caller)*.
>
> ~~No migration is written here. There is no SQLite layer at all, and §Migrations
> forbids editing an applied script — so guessing the shape into `0001_init.sql`
> before its consumers exist maximises the chance of baking in a wrong guess that
> can only be appended to.~~ **Written 2026-09-09 (P2 PR-B), with its first consumer:** the
> column exists in `0001_init.sql`; the writer (the detection cache, P4) and the reader (the
> library card, P3) are still unbuilt, so it is decided, created, and empty.
> column exists in `0001_init.sql`; ~~the writer (the detection cache, P4) and the reader (the
> library card, P3) are still unbuilt, so it is decided, created, and empty~~ *(corrected 2026-10-04: written since
> 2026-09-14 by the detection sweep, the store import and Edit…; read for the Edit dialog's badges and the game page)*.
> **The three hook-state columns have a consumer before they have a table, and two
> fields it needs are not here.** Added 2026-08-06 with `IGameConsentStore`, whose
@@ -104,7 +152,8 @@ CREATE TABLE games (
> anything else — so a record could carry a consent time that nothing had ever
> disclosed anything for. `ConsentProvenance`'s zero value means *no disclosure was
> shown*, and it deliberately has **no FR-2.1 member**: that dialog needs reviewed
> `Safety_*` wording in en/vi/ja and no `.resx` exists anywhere in this tree.
> `Safety_*` wording in en/vi/ja and ~~no `.resx` exists anywhere in this tree~~ *(superseded: the dialog shipped in
> P3 PR-4 as `ConsentDialog`, below — corrected 2026-10-04)*.
> - **A disclosure/wording version.** `legal_acceptance` carries `(doc, version,
> accepted_at)` while this column carries a timestamp alone, so nothing could mark
> existing per-game consent stale when the reviewed wording changes. It is carried
@@ -126,7 +175,10 @@ CREATE TABLE games (
> shipped producer, still not FR-2.1, stamped by the Agent's clock; the store writes the NAME the
> acknowledgement carries and refuses `NotRecorded`.
>
> **Still unanswered, and it is an owner decision rather than a coding one:** who
> ~~**Still unanswered, and it is an owner decision rather than a coding one:**~~ **Answered by the owner on
> 2026-09-22: nothing clears it** *(corrected 2026-10-04)*. A clean re-scan, *Change executable*, a re-import and a twin
> merge all leave it, and the toggle stays disabled (`19_SAFETY` §What a finding does to the game); D33's exception
> sits on top of the block and never clears it. The question as it stood: who
> clears `hook_blocked_reason` when a re-scan comes back clean. `19_SAFETY` §A game
> already enabled can become blocked later makes a non-null value mean "toggle
> disabled" and makes re-enabling "a user action" — but if nothing clears the column
@@ -152,7 +204,9 @@ CREATE TABLE sessions (
started_at INTEGER NOT NULL, ended_at INTEGER NOT NULL, duration_s REAL NOT NULL,
capture_tier INTEGER NOT NULL, -- 1 = hooked, 2 = not hooked; CHECK (capture_tier IN (1,2))
capture_notes TEXT, -- why tier degraded, late_attach, etc.
capture_notes TEXT, -- why tier degraded, late_attach, etc.; beta.14 adds crash_reporter= /
-- crash_reporter_seen= (an engine's crash reporter the game started) and
-- scan_at_exit= (D48: a re-scan that could not read as the game exited)
late_attach INTEGER NOT NULL DEFAULT 0,
telemetry_source TEXT, -- composite descriptor, e.g. 'l1+lhm+nvapi' (18_GPU_VENDOR_APIS)
overlay_build_id TEXT, -- native DLL build that produced this data
@@ -176,10 +230,11 @@ CREATE TABLE sessions (
-- presentation
api TEXT, present_mode TEXT, swap_effect TEXT,
hdr_flag TEXT NOT NULL DEFAULT 'na', hdr_source TEXT, -- tri-state, like rt/rr beside it
sync_interval_mode TEXT, -- observed vsync behavior
sync_interval_mode TEXT, -- observed vsync behavior: on|off|mixed — first written in beta.14 (0019's
-- §Sync), NULL where no present carried its arguments (OpenGL, Vulkan, Tier 2)
-- upscaling / FG (measured at tier 1)
upscaler TEXT, -- none|dlss|fsr2|fsr3|fsr4|xess|nis|unknown
upscaler TEXT, -- none|dlss|fsr2|fsr3|fsr4|xess|nis|unknown, and fsr since 2026-09-04 (FL_UPSCALER_FSR_UNVERSIONED; added 2026-10-04)
upscaler_quality TEXT,
upscaler_sharpness INTEGER, -- percent; NULL when the API reports none
render_w INTEGER, render_h INTEGER, -- dominant segment
@@ -238,7 +293,43 @@ CREATE TABLE sessions (
avg_cpu_temp REAL, max_cpu_temp REAL,
avg_gpu_temp REAL, max_gpu_temp REAL, max_gpu_hotspot REAL,
avg_gpu_load REAL, avg_cpu_load REAL, avg_ram_mb REAL,
avg_gpu_power_w REAL, throttle_pct REAL
avg_gpu_power_w REAL, throttle_pct REAL,
-- schema 0018 (2026-10-03, beta.12, D43): the game process's own memory, read from outside it, both tiers
-- (03_METRICS §Game process memory), MiB; and every sensor series' n/mean/median/min/max as JSON
game_vram_dedicated_avg_mb REAL, game_vram_dedicated_median_mb REAL, game_vram_dedicated_max_mb REAL,
game_vram_shared_max_mb REAL,
game_ram_private_avg_mb REAL, game_ram_private_median_mb REAL, game_ram_private_max_mb REAL,
game_ram_ws_max_mb REAL, game_commit_max_mb REAL,
game_memory_processes INTEGER, -- processes summed: 1 pinned, every process of the executable for a held one
game_memory_source TEXT, -- counters,ex2,ex,held,opened — the reads that answered
sensor_stats_json TEXT, -- {"gpu_temp":{"N":…,"Mean":…,"Median":…,"Min":…,"Max":…}, …}
-- schema 0019 (2026-10-06, beta.14, D49): pacing (hooked), the present arguments (Direct3D), the card's clocks and limits
-- (both tiers) and efficiency (hooked) — 03_METRICS §Pacing, §Sync, §Sensor aggregates, §Efficiency
time_below_30_pct REAL, time_below_60_pct REAL,
time_below_refresh_pct REAL, -- over presents, at display_monitor_hz; NULL without a rate
frametime_delta_mean_ms REAL, -- mean |ft[k] - ft[k-1]| over neighbouring intervals
vsync_present_pct REAL, tearing_allowed_pct REAL, -- shares of the presents that carried their arguments
avg_gpu_core_clock_mhz REAL, avg_gpu_mem_clock_mhz REAL, avg_gpu_fan_rpm REAL, max_gpu_mem_temp REAL,
power_limit_pct REAL, thermal_limit_pct REAL, -- shares of the ticks that carried reasons: NVIDIA (L3) only
app_frames_per_joule REAL, -- application FPS / average GPU board power; never displayed frames (rule 6)
-- schema 0016 (2026-09-27, beta.10): the display mode, both tiers (03_METRICS §Display mode). Milliseconds per mode,
-- each sample standing for the time until the next (100 ms hooked, 1 s at Tier 2), a pause not counted; nowindow is
-- outside every share. NULL before, on a session recovered from its .partial file, and where the loop never sampled —
-- N/A, never 0. Written on the recorder's SKELETON: a Tier-2 session never reaches the aggregator.
display_exclusive_ms INTEGER, -- the swap chain SAID exclusive (DXGI only)
display_borderless_ms INTEGER, -- covers its monitor, the chain said not exclusive
display_windowed_ms INTEGER,
display_covers_ms INTEGER, -- covers its monitor and nothing could say which ("fullscreen or borderless")
display_minimized_ms INTEGER,
display_nowindow_ms INTEGER, -- no window could be read
display_changes INTEGER, -- mode changes between samples
display_source TEXT, -- swapchain | opengl | window: the strongest witness any sample had
display_window_w INTEGER, display_window_h INTEGER, -- client area, in the mode that lasted longest
display_buffer_w INTEGER, display_buffer_h INTEGER, -- the swap chain's back buffer, same mode
display_monitor_w INTEGER, display_monitor_h INTEGER, display_monitor_hz INTEGER
);
CREATE INDEX ix_sessions_game_started ON sessions(game_id, started_at DESC);
@@ -275,13 +366,29 @@ CREATE TABLE frame_blobs (
-- stored only when either varies
dispatch_rays BLOB, -- uint32[] : ray volume per frame, tier 1 only
pso_created BLOB, -- uint16[] : compile COUNT per frame, not a flag
vram_proc BLOB, -- uint32[] MB per frame; held 1 Hz sample, see 03_METRICS
latency_us BLOB -- uint32[], tier 1 + Reflex only
vram_proc BLOB, -- uint32[] MB per frame; never written (corrected 2026-10-04: the Overlay never produced vramUsedMb)
latency_us BLOB, -- uint32[], tier 1 + Reflex only
first_present_ms REAL -- schema 0013 (beta.8): the dominant stream's first present, ms from qpc_epoch —
-- the sensors' zero (t_ms) against the frames'. NULL before; the charts then
-- keep the sensor overlay off rather than draw it out of step
);
CREATE TABLE sensor_blobs (
session_id INTEGER NOT NULL REFERENCES sessions(id) ON DELETE CASCADE,
-- schema 0007 (2026-09-21) added five guard-override columns (games.guard_bypass_at,
-- games.guard_bypass_disclosure_version; sessions.guard_bypassed, guard_bypass_family, guard_bypass_signal) and
-- schema 0008 (2026-09-22) DROPPED them with the feature (19_SAFETY §What a finding does to the game). Sessions that
-- ran under it keep "guard-bypass=" in capture_notes.
series TEXT NOT NULL, -- cpu_temp|gpu_temp|gpu_hotspot|gpu_load|gpu_power|vram_proc|vram_adapter|cpu_load|ram_mb
-- (vram_proc was listed here from 0001 and never written); since schema 0018 (beta.12,
-- D43) also game_vram_dedicated|game_vram_shared|game_ram_private|game_ram_ws|game_commit,
-- MiB — the game process's own memory (Application.Recording.SensorSeriesCatalog); since
-- beta.14 (D49) also gpu_core_clock|gpu_mem_clock (MHz), gpu_fan (RPM), gpu_mem_temp (°C)
-- and gpu_power_limit|gpu_thermal_limit (100 or 0 per tick, NVIDIA only) — a series name
-- needs no migration
-- cpu_load / ram_mb / cpu_temp and sessions.avg_cpu_load, avg_cpu_temp, max_cpu_temp,
-- avg_ram_mb were in schema 0001 with NO producer until 2026-09-21 (Telemetry.SystemTelemetrySource
-- on the poller's tick). Rows before that date hold NULL, which is what they measured; no migration.
hz REAL NOT NULL, codec TEXT NOT NULL, data BLOB NOT NULL,
PRIMARY KEY (session_id, series)
);
@@ -308,6 +415,10 @@ CREATE TABLE legal_acceptance (doc TEXT PRIMARY KEY, version TEXT NOT NULL, acce
> App at build (`GPL-3.0-only` for the licence text) — the App is the only writer, one row per document per
> Accept, re-recorded when the embedded version differs from the row's. `20_OPEN_QUESTIONS` §G "Legal doc
> versioning" closes on that.
>
> **Three rows since beta.12 (D45).** The GPL is shown for information and needs no acceptance (GPLv3 §9), so Accept
> writes `eula`, `disclaimer` and `privacy` only, and the gate is not held open for `gpl`. A `gpl` row an earlier
> version wrote stays, unread (`LegalGate`).
## Settings registry
@@ -325,14 +436,24 @@ switch's rule); integers are invariant-culture within an inclusive range; choice
| `ui.theme` | choice | `system` | `system` · `light` · `dark` | UI |
| `ui.start_with_windows` | bool | `0` | | UI (P4) |
| `ui.minimize_to_tray` | bool | `0` | | UI (PR-8) |
| `capture.background` | bool | `1` | | Agent |
| `ui.hide_anticheat_hooking` | bool | `1` | | UI (beta.8, 2026-09-25): the game page of an entry the guard found anti-cheat in shows the finding in place of its Hooking card (`08_UI` §Game detail) |
| `ui.fps_decimals` | bool | `0` | | UI (beta.8, 2026-09-25): every FPS figure with two decimals ("62.40") instead of a whole number |
| `ui.hide_scrollbars` | bool | `0` | | UI (beta.14, 2026-10-05): no scroll bar drawn anywhere; every scroller still scrolls with the wheel, the keyboard and touch (`App.Services.ScrollBarHiding`, `08_UI` §Settings) |
| `ui.library_view` | choice `grid`\|`list` | `grid` | | UI (beta.11, 2026-10-03): the Games library as a grid of cards that fills the width, or as a list; written by the page's own switch, no Settings row (`08_UI` §Games) |
| `ui.game_art` | bool | `1` | | UI (beta.23, owner decision D60): a game's page shows its artwork — the image the user chose, else what the Steam or GOG GALAXY app keeps on this PC; nothing is downloaded. Settings ▸ Games (`08_UI` §Games) |
| `ui.game_art_tint` | bool | `1` | | UI (beta.23, owner decision D61): the page's header band takes the artwork's colour, at the strongest opacity that keeps its text readable. Settings ▸ Games |
| `ui.play_mode` | choice `store`\|`direct` | `store` | | UI (beta.21, owner decision D59): what Play does — `store` hands the game to the app of the store whose own records name its folder, and the agent starts it where none does; `direct` has the agent start it (`LaunchGame`, launch mode). Settings ▸ Games (`08_UI` §Games) |
| `capture.background` | bool | `1` | | ~~Agent~~ nobody *(corrected 2026-10-04: no Agent code ever read it, so the watcher recorded every tracked game whatever it said; beta.12 removed its switch from Settings and reserved the key — `SettingsRegistry.CaptureBackground`. Since beta.21 the App can start a game (Play), and the key stays reserved: a game Play starts is recorded as any other start)* |
| `hooking.kill_switch` | bool | `0` | | Agent (FR-2.4, since P2 PR-F) |
| `hooking.usermode_ac_exceptions` | bool | `0` | | Agent, at every session start and command (FR-2.8, D33, 2026-09-26): off suspends every user-mode exception without deleting any; on, the user still grants each eligible game |
| `capture.run_elevated` | bool | `0` | | The App when it starts the Agent, and an Agent the logon task started — both BEFORE the Agent exists, through `Infrastructure.Startup.RunElevatedSetting` (one row, `PRAGMA query_only`, no version gate, anything but `1` is off) (D34, beta.10): on, Windows is asked for administrator rights at every Agent start (`01_ARCHITECTURE` ADR-9) |
| `capture.min_session_s` | int | `30` | 5–600 | Agent, per session (FR-3.6) |
| `telemetry.interval_ms` | int | `1000` | 500–2000 | Agent, per session (FR-3.5) |
| `retention.raw_sessions_per_game` | int | `20` | 0–10000; **0 = unlimited** | Agent, per session (§Retention) |
| `update.channel` | choice | `stable` | `stable` · `beta` | UI (P4 PR-5 reads it: `beta` = GitHub pre-releases too) |
| `retention.remove_uninstalled_games` | bool | `1` | | Agent, at every detection sweep (beta.19, D55, FR-1.8): on, an entry whose executable has been gone for ten minutes — its drive connected, the folder it was installed in still there — and that has no session and no anti-cheat block or exception is removed; off, it stays and reads *Not installed* (D41's behaviour) |
| `update.channel` | choice | ~~`stable`~~ `auto` (beta.14, D47) | `auto` · `stable` · `beta` | UI (P4 PR-5 reads it: `beta` = GitHub pre-releases too; `auto` follows the running copy, a pre-release asking for pre-releases — `11_UPDATER` §The update audit) |
| `update.auto_check` | bool | `1` | | UI (P4 PR-5: the startup silent check, `11_UPDATER` §Flow "if enabled") |
| `privacy.online_metadata` | bool | `0` | | UI (P4; CLAUDE.md rule 8) |
| `privacy.online_metadata` | bool | `0` | | *reserved* — no consumer and, since 2026-09-16, no toggle on Settings either: the store request it would enable has no code (CLAUDE.md rule 8), and PRIVACY_POLICY 2.2 removed the row that described it |
| `log.debug` | bool | `0` | | UI |
An operator's bounded capture (`--console … --seconds N`, which lowers the discard threshold to N) keeps
@@ -344,14 +465,17 @@ Because Tier-1 and Tier-2 sessions carry different fields, every query that comp
## Blob encoding
`float32`/`uint16`/`uint32` little-endian arrays through `DeflateStream` (Optimal). One hour at 100 fps ≈ 360k frames ≈ 1.4 MB raw frametimes ≈ **≤ 0.7 MB stored**; flags compress far better; render-res only stored when it varies. Decode helpers in `Infrastructure.Blobs` with round-trip test
`float32`/`uint16`/`uint32` little-endian arrays through `DeflateStream` (Optimal). One hour at 100 fps ≈ 360k frames ≈ 1.4 MB raw frametimes ≈ **≤ 0.7 MB stored**; flags compress far better; render-res only stored when it varies. Decode helpers in `Infrastructure.Blobs` with round-trip tests (NaN forbidden — assert).
> **Two rules the finalizer applies (2026-09-10, P2 PR-D).** `frametimes[i]` is the interval from the previous
> record ON THE SAME SWAPCHAIN; the first record of a stream, and any record after a torn slot or an
> overwrite skip, carries 0 with the `frame_flags` gap bit set, so the statistics exclude it and the export
> still reconstructs `qpc_ms`. `swapchain_ids` is present only when the session held more than one stream.
> **Schema 0013 (beta.8)** adds `frame_blobs.first_present_ms`: the charts draw the dominant stream from its first present
> and the sensors from `qpc_epoch`, and nothing said how far apart the two zeros were. Gaps stay closed up on the frame
> axis (a gap's interval is stored as 0), so a series still drifts ahead of its sensors past each gap.
> Sensor series are aligned to `t_ms` (milliseconds from `qpc_epoch`) and a tick with no reading is stored as
> **−1** — never 0, which would be a reading — because temperatures, loads, power and memory are never negative.s (NaN forbidden — assert).
> **−1** — never 0, which would be a reading — because temperatures, loads, power and memory are never negative.
## The `.partial` file
@@ -369,10 +493,11 @@ Because Tier-1 and Tier-2 sessions carry different fields, every query that comp
> | 1 `Header` | UTF-8 JSON: format version, `session_guid`, `started_at`, `qpc_epoch`/`qpc_frequency`, `game_id`, `snapshot_id`, exe path, pid, tier, mode, Overlay build id, telemetry descriptor, launch wait | on create — the breadcrumb `19_SAFETY` §Crash safety asks for before injection |
> | 2 `Records` | `i64` first ordinal, then N raw `FlFrameRecord` (64 B each); a chunk that does not continue the sequence is refused | each flush |
> | 3 `Gaps` | N × `i32` gap-before record indices | each flush |
> | 4 `Sensors` | N × one telemetry sample: QPC, wall clock, layer, presence mask, then only the fields that carry a value — null stays null | each flush |
> | 4 `Sensors` | N × one telemetry sample: QPC, wall clock, layer, presence mask, then only the fields that carry a value — null stays null | ~~each flush~~ read only since beta.12, so a beta.11 file still recovers *(corrected 2026-10-04)* |
> | 5 `Tick` | drain/foreground ticks, dropped, gaps, guard ticks, wall clock, the raw `FlWriterState`; the last one wins | each flush |
> | 6 `Note` | wall clock + UTF-8 text: a state transition | each transition |
> | 7 `Touches` | N × `i64` QPC at which the host touched the target | each flush |
> | 8 `SensorsWide` | the same samples under a 32-bit presence mask that carries the game process's memory (D43) | each flush, since beta.12 *(row added 2026-10-04)* |
>
> Recovery (`PartialRecovery`): a file whose guid is already a row is deleted (the finalize had landed);
> one under the minimum session length is discarded; one with no readable header is dropped; the rest
@@ -380,6 +505,16 @@ Because Tier-1 and Tier-2 sessions carry different fields, every query that comp
> column computed from the prefix exactly as a live finalize would. **Rejected:** a `sessions_in_progress`
> table — a blob churn every minute, a lock fight with the UI in P3, and `04_CAPTURE` had already named a
> file under `tmp\`.
>
> **The header's `game_id` is where the session started, not necessarily where it lands (2026-09-23).** A live
> finalize and a recovery both ask `ISessionRepository.ResolveOwnerAsync`: that id when the row predates the session
> or holds the header's exe path; else the row that holds the exe path now (an entry removed and re-imported while
> the game ran); else nothing — `FinalizeStatus.GameRemoved` / `RecoveryStatus.GameRemoved`, file deleted, nothing
> written. `games.id` is `INTEGER PRIMARY KEY` without AUTOINCREMENT, so a deleted id can be handed to the next row
> added; `added_at` after the session's start and another path is how that row is told apart. A file recovery cannot
> finalize for any other reason is renamed `<guid>.partial.failed` (`IPartialSessionStore.Quarantine`) — not listed
> again, not retried, kept for a bug report — and recovery goes on to the next file: it runs before the watcher on
> every start, and one file used to be able to stop them all.
## Retention
@@ -406,11 +541,6 @@ Sequential embedded SQL (`Migrations/0001_init.sql`, `0002_*.sql`, …), applied
> columns on `session_annotations` and `games.removed_at`. `LedgerDatabaseTests` asserts one
> `schema_migrations` row per script, so `LatestVersion` is 2.
> **`0002_annotation_overrides_and_removal.sql` (P3 PR-3, 2026-09-13) — the first append**, and the first
> time the runner ran two scripts on a real file: `ALTER TABLE ADD COLUMN` only — the three override
> columns on `session_annotations` and `games.removed_at`. `LedgerDatabaseTests` asserts one
> `schema_migrations` row per script, so `LatestVersion` is 2.
> **`0003_fg_refusal.sql` (2026-09-14) — `sessions.fg_refusal`.** The owner's ledger held two hooked rows with
> `fg_mode = 'dlssg'`, `fg_source = 'api'` and `fg_factor` NULL — the identity stood, the count refused — and
> nothing recorded which refusal; every FG surface said N/A beside a detection that had succeeded. One
@@ -422,25 +552,174 @@ Sequential embedded SQL (`Migrations/0001_init.sql`, `0002_*.sql`, …), applied
> which are the consent fingerprint the gate reads and which a background scan must never refresh.
> `LatestVersion` is 4; `LedgerDatabaseTests` asserts the columns.
> **`0005_fg_refusal_detail.sql` (2026-09-16) — `sessions.fg_refusal_detail`.** 0003 recorded WHICH refusal took the
> factor; the owner's Dashboard then showed "DLSS-G active — factor not counted" on four titles with a tooltip that
> could only say "the frame-generation state changed mid-session", while `FgWindow` had computed which of the eight
> buckets departed, its ratio and the window's, and `SessionAggregator` kept only the kind. The column is
> `Application.Recording.FgRefusalDetail` as JSON (`RecordingJsonContext`): kind, subject, count, bucket index/count,
> the bucket's ratio (null when it held no tokens — infinity is not JSON) and the window's. Written by the Agent
> beside `fg_refusal`, read by the UI's tooltip (`FpsPresentation.RefusalDetailText`), never an input to a number.
> Existing rows keep NULL. `LatestVersion` is 5; `LedgerDatabaseTests` asserts the column.
> **`0006_fg_steady_state.sql` (2026-09-17) — `sessions.fg_factor_scope` / `fg_steady_share`.** `fg_factor` was
> session-wide or NULL, and on real play it was almost always NULL (`03_METRICS` §The steady state). `session` = one
> state for the whole claimed span; `steady` = `fg_factor` / `native_fps` / `displayed_fps` describe the state the
> session spent most of its generating time in, `fg_steady_share` of the presenting time, with `fg_refusal` and its
> detail still set beside it. A reader that ignores the scope reads a steady factor as a session one, which is why
> every surface prints the share. Existing rows keep NULL. `LatestVersion` is 6.
> **`0007_guard_bypass.sql` (2026-09-21) and `0008_withdraw_guard_bypass.sql` (2026-09-22) — the first DROP.** 0007
> added five columns for the per-game guard override; the owner withdrew the feature a day later and 0008 drops them
> (`ALTER TABLE … DROP COLUMN`, SQLite ≥ 3.35 — `LedgerDatabaseTests` asserts the engine's version beside the columns'
> absence). "Never edit an applied script; only append" holds: 0007 stays as applied and 0008 is the append. The
> data dropped is the override acknowledgements themselves, which is the decision. `LatestVersion` is 8.
> **`0009_record_sessions.sql` (2026-09-23, D29) — `games.record_sessions`** *(entry added 2026-10-04; it was
> missing)*. FR-1.6's recording switch, `NOT NULL DEFAULT 1`; the App writes it, the Agent only reads it. Its one data
> change switches it off for entries an old import made for Steam's own tools (`SteamLibrarySource.KnownTools` as of the
> script). `LatestVersion` is 9; `LedgerDatabaseTests.ScriptNineAddsTheRecordingSwitchOffForSteamToolsOnly`.
> **`0010_prescan_key.sql` (2026-09-25) — `games.hook_prescan_rules_version` / `hook_prescan_exe_size_bytes` /
> `hook_prescan_exe_mtime_ms`.** The Agent pre-scans every library entry for anti-cheat since beta.8, and again
> whenever the rules or the executable change, so it needs what each row was last scanned against — its own key, as
> 0004's columns are the detection sweep's, and apart from `exe_size_bytes` / `exe_mtime_ms` for the same reason
> (the consent fingerprint must never be refreshed by a background scan). `ALTER TABLE ADD COLUMN` only; existing
> rows read NULL, which the sweep reads as "never scanned" and scans on its first pass. `LatestVersion` is 10;
> `LedgerDatabaseTests.ScriptTenAddsThePreScanKeyEmptyForExistingRows` applies it from 9 to a ledger holding a row.
> **`0011_executable_facts.sql` (2026-09-25) — `games.exe_machine` / `exe_file_version` / `exe_product_version` /
> `library_versions`.** The owner asked for the game's version, its DLSS / FSR versions and 32- or 64-bit; the detection
> sweep read the PE version resource and walked the tree for the capability files, and kept neither. Four columns,
> written whole by that sweep (`05_DETECTION` §What the files say about themselves) — facts about files, so no
> provenance and no user override. Existing rows read NULL, and a NULL `exe_machine` makes the sweep read the row once
> more on its first pass. `LatestVersion` is 11; `LedgerDatabaseTests.ScriptElevenAddsTheExecutableFactsEmptyForExistingRows`.
> **`0012_driver_profile.sql` (2026-09-25) — `sessions.driver_profile`.** The NVIDIA driver profile the session's
> executable ran under, read by the Agent's recorder beside every session (both tiers) through the NVAPI bridge's
> read-only DRS entry point (`18_GPU_VENDOR_APIS` §L3, ABI 2): JSON (`Application.Recording.DriverProfileRecord`) —
> `Outcome` (`Application` | `Global` | `Degraded`), `Profile`, and one entry per setting of
> `Application.Capture.NvidiaDriverSettings` with its `Value` (null = set in no profile), `Location` and `Predefined`.
> A driver configuration, never a measurement (`03_METRICS` §Upscaling). NULL for every row before, and where no
> NVIDIA bridge was there to ask. The same day `ngx_driver_words` gained `Ratio`, `Mode`, `Preset`, `FgCount`,
> `FgPreset`, `FgMode` beside its masks (additive JSON fields; older rows lack them). `LatestVersion` is 12;
> `LedgerDatabaseTests.ScriptTwelveAddsTheDriverProfileColumn`.
> **`0013_first_present.sql` (beta.8, 2026-09-25) — `frame_blobs.first_present_ms`** *(entry added 2026-10-04; it was
> missing)*. The charted stream's first present, in milliseconds from `qpc_epoch`, written by the finalizer
> (§Blob encoding); NULL before, and such a row's sensor overlay stays off rather than drawn out of step. `LatestVersion`
> is 13; `LedgerDatabaseTests.ScriptThirteenAddsTheFirstPresentColumn`.
> **`0014_usermode_ac_exception.sql` (beta.9, 2026-09-26, owner decision D33) — the user-mode anti-cheat exception.**
> Fourteen `games.ac_exception_*` columns in three groups — the Agent's eligibility answer about a blocked row and its
> key, the user's grant, and how the last grant ended — and `sessions.ac_exception_family`, the family a HOOKED session
> ran under the exception with. `ADD COLUMN` only; no row changes, so a blocked row stays blocked, not eligible, with
> no grant, until the Agent and the user say otherwise (`19_SAFETY` §The user-mode exception). Written through
> `IGameConsentStore` only — `RecordExceptionEligibilityAsync` (the sweep), `GrantAntiCheatExceptionAsync` (the
> `SetAntiCheatException` command; the store applies `UserModeExceptionRules.IsEligible` itself), `RevokeAntiCheatExceptionAsync`
> (every end) — plus one downgrade in `ChangeExecutableAsync`, which ends a grant (`ExecutableChanged`) and forgets
> the eligibility. The grant and the eligibility are each bound in SQL to the block they were reached about. `LatestVersion`
> is 14; `LedgerDatabaseTests.ScriptFourteenAddsTheExceptionColumnsAndChangesNoRow`.
> **`0015_engine_version_source.sql` (beta.10, 2026-09-27) — where an engine version came from.** `games.engine_version_source`
> (`05_DETECTION` §Engine version): the witness an Unreal version rests on, or the rule's extractor type for every other
> engine; written by `ApplyDetectionAsync` only where the run's version was taken (a `user` field keeps none), cleared by a
> user's edit of the version (`UpdateMetadataAsync`). The script's one data change removes the bare `4` / `5` the old
> Unreal rule wrote (a two-group regex returning its first group) — **only where `field_provenance` says `detected`**: a
> value the user typed, one with no badge (which reads as the user's) and one whose provenance does not parse stay as they
> were, and the last does not fail the migration (`CASE WHEN json_valid(…)`, since SQLite promises no order for `AND`).
> `LatestVersion` is 15; `LedgerDatabaseTests.ScriptFifteenAddsTheWitnessAndRemovesOnlyTheOldRulesDetectedDigit`.
> **`0016_display_mode.sql` (beta.10, 2026-09-27) — how the game was shown.** Fifteen `sessions.display_*` columns
> (`03_METRICS` §Display mode): milliseconds in each mode, the changes, the witness, and the window / back buffer / monitor
> sizes in the mode that lasted longest. ADD COLUMN only, no data change: a session recorded before reads N/A. Written by
> the recorder on the row's skeleton (`Recording.SessionDisplayColumns.WithDisplay`), so a Tier-2 session — which never
> reaches the aggregator — has them too; `sessions.swap_effect`, a column since 0001, gets its first writer from the same
> facts. `SessionRowColumns` is hand-edited (its generator is not in the repository) and reads by name. `LatestVersion` is
> 16; `LedgerDatabaseTests.ScriptSixteenAddsTheDisplayColumnsAndAnEarlierSessionHasNone`,
> `SqliteSessionRepositoryTests.ASessionRoundTripsColumnForColumn`.
> **`0017_exception_trial.sql` (beta.11, 2026-10-03, owner decision D38) — the exception's trial.** One column,
> `games.ac_exception_trial_failed_at`: when an exception of the game ended during its trial (`19_SAFETY` §The user-mode
> exception), NULL when none did. ADD COLUMN only, no data change: a grant made under D33 stays in force and carries no
> mark. Written by the Agent's revoke only (`IGameConsentStore.RevokeAntiCheatExceptionAsync(…, trialFailed)`), set once
> (`COALESCE`), cleared by nothing — not by `ChangeExecutableAsync`, which does not name it — and carried by a twin merge
> (the earlier of two). The store applies it in SQL: no eligibility is written as eligible and no grant is written over
> it. `ac_exception_sessions` (0014) changes meaning without a script: since D38 it is the trial's progress under the grant
> in force, which the sweep rewrites on its first pass. `LatestVersion` is 17;
> `LedgerDatabaseTests.ScriptSeventeenAddsTheTrialMarkAndChangesNoRow`,
> `SqliteGameConsentStoreTests.AnEndDuringTheTrialMarksTheGameAndNothingClearsIt`,
> `SqliteGameMergeTests.AFailedExceptionTrialOnEitherTwinMarksTheSurvivor`.
> **`0018_game_memory.sql` (beta.12, 2026-10-03, owner decision D43) — the game process's own memory.** Twelve
> columns, ADD COLUMN only: `game_vram_dedicated_{avg,median,max}_mb`, `game_vram_shared_max_mb`,
> `game_ram_private_{avg,median,max}_mb`, `game_ram_ws_max_mb`, `game_commit_max_mb`, `game_memory_processes`,
> `game_memory_source` and `sensor_stats_json`. Written by the recorder's aggregation for both tiers
> (`SessionAggregator.WithSensorAggregates`); a session before it reads N/A. **Not `vram_proc_*`**: those name the
> in-process DXGI figure compared with a budget (a different quantity, `03_METRICS` §Game process memory) and stay
> reserved. The `.partial` gains chunk type 8 (`SensorsWide`, a 32-bit mask with the game fields); type 4 is still read,
> so a beta.11 crash file recovers. `LatestVersion` is 18; `LedgerDatabaseTests.ScriptEighteenAddsTheGameMemoryColumnsAndAnEarlierSessionHasNone`,
> `SqliteSessionRepositoryTests.ASessionRoundTripsColumnForColumn`,
> `PartialSessionFileTests.TheGameMemoryRoundTripsAndANarrowSensorsChunkFromBeta11StillReads`.
> **`0019_pacing_sync_gpu_limits.sql` (beta.14, 2026-10-06, owner decision D49) — pacing, sync, the card, efficiency.**
> Thirteen REAL columns, ADD COLUMN only: `time_below_{30,60,refresh}_pct`, `frametime_delta_mean_ms`,
> `vsync_present_pct`, `tearing_allowed_pct`, `avg_gpu_{core,mem}_clock_mhz`, `avg_gpu_fan_rpm`, `max_gpu_mem_temp`,
> `power_limit_pct`, `thermal_limit_pct`, `app_frames_per_joule`. Written by the recorder's aggregation
> (`SessionAggregator.ApplyPacing` / `ApplySync` / `ApplyEfficiency` for a hooked session, `WithSensorAggregates` for the
> card on both tiers); `sync_interval_mode` (0001) gets its first writer beside them. A session before it reads N/A — no
> value is computed after the fact. The `.partial` needs no change: the six new sensor series are fields every sample
> already carried. `LatestVersion` is 19; `LedgerDatabaseTests.ScriptNineteenAddsThePacingAndCardColumnsAndAnEarlierSessionHasNone`,
> `SqliteSessionRepositoryTests.ASessionRoundTripsColumnForColumn`. **A beta.13 cannot open a ledger beta.14 migrated.**
> **Every open used to migrate, and one that should not have did — 2026-09-16.** The Agent's `--console sessions`,
> a verb that prints, was run against the owner's ledger while the file on disk was at schema 2 and applied 0003 and
> 0004 to it. `LedgerDatabase.OpenReadOnlyAsync` exists since that day: an existing file, `PRAGMA query_only`, no
> `MigrationRunner`, and a refusal (`LedgerSchemaException`) for a schema **older** than the build as well as newer —
> the older file needs the App or `--serve` to bring it forward, not a verb whose name says it reads. The Agent's
> `sessions`, `consent list` and `killswitch status` open that way (`Program.PrintsOnly` is the list, pinned by
> `AgentReadOnlyVerbsTests`), `db path` opens nothing, and the App's `--diag` does the same.
>
> **What that run found, recorded because the mechanism is not known.** The on-disk `ledger.db` was 94 KB, 23 pages,
> dated 14 September, at schema 2 with three test games and no sessions; the day's 41 imported games and 18 sessions
> were in `ledger.db-wal` — 4 MB, 1006 frames — and every one of those frames carried salt-1 one **lower** than the
> WAL header's, with a checkpoint sequence of 1 and a single frame under the new salt. That is the shape SQLite leaves
> after a checkpoint has moved every frame into the main file and the next writer restarts the log; but no checkpoint
> had reached this main file (645 pages of data, 23 on disk, and the file's own time stamp two days old). A fresh
> connection therefore recovered one frame and saw the 14 September state, while the App and Agent that were running
> saw the whole day through the wal-index they shared. Neither process closed cleanly enough to fix it: the Agent's
> stop at 17:57 and the console's exit at 17:58 both left the WAL in place, and `-wal`/`-shm` then vanished between
> 18:00 and 18:04 with no FrameLedger process alive. The data was rebuilt by applying the old-salt chain to the main
> file (176 commits, `integrity_check` ok) and the broken set kept beside it. **Nothing in this repository writes the
> main file behind SQLite's back, replaces it, or restarts the WAL by hand**; what the code can do about an unknown
> mechanism is make the next occurrence visible, and it does: `OpenAsync` runs `wal_checkpoint(PASSIVE)` after
> migrating and logs the frame count it found and moved (`LedgerDatabase.OpenDiagnostics`), and `DisposeAsync` runs
> `wal_checkpoint(TRUNCATE)` and logs that, so a clean close leaves the main file complete and a WAL that will not
> checkpoint is a logged number rather than a silent one. A WAL at open holding frames a passive checkpoint cannot
> move, with no other FrameLedger process running, is the signature to look for.
> **Built 2026-09-09 (P2 PR-B):** `Infrastructure.Persistence.MigrationRunner` over scripts embedded in
> the assembly (so the schema a build applies is the one it was tested against), one transaction per
> script, under `Local\FrameLedger.Ledger.Migrate` — session-local rather than `Global\`, because the
> Agent and the UI share a session and the global namespace asks for a privilege a standard user need
> not hold. **A ledger at a version newer than the build's scripts is refused, not read**
> not hold. *(One name per ledger FILE since 2026-09-17 — `Migrate.<hash of the path>`,
> `MigrationRunner.LockNameFor`: with one name for every ledger, a test process frozen mid-migration held
> every other process's scratch ledger, and seven App and Agent tests failed after 30 s on #199's run.)* **A ledger at a version newer than the build's scripts is refused, not read**
> (`LedgerSchemaException`): guessing at a schema we do not understand is the one option that could
> turn a newer file into wrong answers. `LedgerDatabase` opens with the four pragmas above, one
> connection per process behind a gate, and every write in an explicit transaction — a failing blob
> insert leaves no session row behind (`SqliteSessionRepositoryTests`).
**`0001_init.sql` creates the schema above directly.** There is no v1 → v2
upgrade path, because there is no released v1: nothing has shipped, so no
FrameLedger database exists anywhere in the world. Writing and testing a
upgrade path, because there is no released v1: ~~nothing has shipped, so no
FrameLedger database exists anywhere in the world~~ *(corrected 2026-10-04: eleven pre-releases shipped from
0.1.0-beta.1 on 2026-09-16, and the appended scripts carry their ledgers forward; no schema older than 0001 ever
shipped, so there is still no v1 → v2 path)*. Writing and testing a
migration from a schema that never existed is work with no user on the other end
of it. The `schema_migrations` machinery still ships from day one — it is what
makes the *next* migration safe, and `11_UPDATER` §Versioning already requires
migrations to cover every released `MAJOR-1`. That obligation begins at the first
release, not before it.
migrations to cover every released `MAJOR-1`. ~~That obligation begins at the first
release, not before it.~~ It began with 0.1.0-beta.1.
## Hardware change markers (FR-6.3)
Snapshot captured per session, hashed, deduped. Trend queries join consecutive sessions' snapshots; differing fields emit a marker `{after_session_id, field, old, new}`. GPU driver version now comes from the vendor API (`18_GPU_VENDOR_APIS`) rather than WMI, which makes it accurate enough to be worth charting.
Snapshot captured per session, hashed, deduped. Trend queries join consecutive sessions' snapshots; differing fields emit a marker `{after_session_id, field, old, new}`. GPU driver version now comes from ~~the vendor API (`18_GPU_VENDOR_APIS`)~~ DXGI's four-part user-mode driver version (`HardwareSnapshotSource`; corrected 2026-10-04) rather than WMI, which makes it accurate enough to be worth charting.
+146 -20
View File
@@ -1,24 +1,28 @@
# 07 — IPC
Three channels, each chosen for its constraints:
~~Three~~ Four channels, each chosen for its constraints *(corrected 2026-10-04: §D, the tolerance mapping, arrived
in beta.9 without a row here)*:
| Channel | Between | Transport | Why |
|---|---|---|---|
| **A. Frame ring** | Overlay DLL → Agent | Shared memory, lock-free SPSC | Hot path: no syscall allowed |
| **B. Control block** | Agent ↔ Overlay DLL | Same shared memory, atomics | Tiny, infrequent, must work even if the game is unresponsive |
| **C. Command pipe** | UI ↔ Agent | Named pipe, JSON | Rich, versioned, human-debuggable |
| **D. Tolerance mapping** | Agent → Overlay DLL, once, before injection | Its own shared memory, read-only to the Overlay | Must exist before the Overlay's loader detour does (§D, D33) |
## A + B — shared memory (`Local\FrameLedger.Ring.<pid>`)
Created by the Overlay on init, opened by the Agent. Name is deliberately plain and identifiable (`19_SAFETY` — no obfuscated object names).
Layout — **four regions, each exactly one 64-byte cache line before the ring**:
Layout — **~~four~~ five regions, each exactly one 64-byte cache line before the ring** (layout 4 since
2026-09-27, beta.10: region 4 is new and the ring moved from `0xC0` to `0x100`):
```
[0x0000] FlShmHandshake 64 B write-once by the Overlay at init
[0x0040] FlWriterState 64 B Overlay-written (writeIndex touched every present)
[0x0080] FlControlBlock 64 B Agent-written
[0x00C0] FlFrameRecord[capacity] (64 B each, power-of-two capacity)
[0x00C0] FlDisplayState 64 B Overlay-written, at most every 500 ms per chain (layout 4)
[0x0100] FlFrameRecord[capacity] (64 B each, power-of-two capacity)
```
The header is split in two on purpose. The immutable handshake and the
@@ -49,9 +53,19 @@ struct alignas(64) FlWriterState { // Overlay-written
uint32_t rtStateObjectsCreated; // @32 session count, published at 1 Hz
uint32_t rasterPsoCreated; // @36 session count, published at 1 Hz
uint32_t runtimeCensus; // @40 FlRuntimeCensus bits; watchdog-published, OR-only (2026-09-03, took reserved[0])
uint32_t reserved[5]; // @44..63 must be zero; reserved for additive fields
uint32_t slTagCensus; // @44 FlSlTagType bits per route (2026-09-05)
uint32_t dxgiPresentsUnseen; // @48 presents DXGI counted beyond the hooked ones (2026-09-05, saturating)
uint32_t dxgiPresentSamples; // @52 hooked presents on which that counter was read
uint16_t loaderSignals; // @56 the LoadLibrary detour's installed bit + wake count (2026-09-06)
uint16_t earlyStopFamily; // @58 1-based floor family index of an early stop; 0 = none (2026-09-06)
uint32_t dxgiPresentsBeforeHook; // @60 presents before the first hooked one (2026-09-06) -- the LAST word:
// no slack left, so layout 4 added a region rather than a field
};
> **This block showed `reserved[5]` at @44 until 2026-09-27** — five words the header had spent by 2026-09-06
> (`slTagCensus`, the two DXGI counters, the loader words, `dxgiPresentsBeforeHook`). `fl_shm.h` is normative and the
> mirror test reads the header, so nothing broke; a reader of this page was told there was room where there was none.
struct alignas(64) FlControlBlock { // Agent-written
uint32_t pauseRequested; // @0
uint32_t unhookRequested; // @4 19_SAFETY: set when the guard fires mid-session
@@ -61,12 +75,41 @@ struct alignas(64) FlControlBlock { // Agent-written
uint32_t reserved[11]; // @20..63 must be zero
};
struct alignas(64) FlDisplayState { // Overlay-written (layout 4, 2026-09-27, beta.10)
uint32_t seq; // @0 seqlock: odd while a writer is inside; the writer CASes and SKIPS if taken
uint32_t flags; // @4 FlDisplayFlags: SAMPLED | EXCLUSIVE_KNOWN | EXCLUSIVE | OPENGL
uint64_t hwnd; // @8 OutputWindow (DXGI) or WindowFromDC (OpenGL); 0 = a composition chain
uint32_t bufferWidth; // @16 the back buffer (DXGI) / client area (OpenGL)
uint32_t bufferHeight; // @20
uint32_t swapEffect; // @24 DXGI_SWAP_EFFECT + 1 (DISCARD is 0); 0 = not read
uint32_t swapFlags; // @28 DXGI_SWAP_CHAIN_DESC.Flags
uint32_t chainId; // @32 the FlFrameRecord.swapchainId described
uint32_t samples; // @36 samples published (wraps)
uint64_t sampleQpc; // @40 QPC of the last sample
uint32_t reserved[4]; // @48..63 must be zero
};
static_assert(sizeof(FlShmHandshake) == 64);
static_assert(sizeof(FlWriterState) == 64);
static_assert(sizeof(FlControlBlock) == 64);
static_assert(FL_SHM_RING_OFFSET == 0xC0 && FL_SHM_RING_OFFSET % 64 == 0);
static_assert(sizeof(FlDisplayState) == 64);
static_assert(FL_SHM_DISPLAY_OFFSET == 0xC0 && FL_SHM_RING_OFFSET == 0x100 && FL_SHM_RING_OFFSET % 64 == 0);
```
**Region 4 — the presenting swap chain's display facts (layout 4, 2026-09-27, beta.10).** The owner asked for the game's
window size and display mode (exclusive fullscreen / borderless / windowed) and the share of a session each took. The two
facts only the process knows — whether the chain is in exclusive fullscreen, and which window it presents to — are
getters on the chain the title passed to the hooked Present (`GetFullscreenState`, `GetDesc`), asked at most every 500 ms
per chain; everything else — the window's rectangle and style, its monitor, the classification — is the Agent's, read
out of process with user32 at the drain tick, exactly as the foreground sample is (`03_METRICS` §Display mode). The
region describes ONE chain: the largest back buffer, and a chain silent for 2 s gives way; `chainId` names it. It is a
seqlock the writer never waits on — a writer that finds `seq` odd (another presenting thread inside) skips the sample and
the next present retries — and `ShmRingReader.DisplayState` takes a copy between two reads of an even, unchanged `seq`
(eight attempts, then null for that tick). The Vulkan layer never writes it (all zeros: nothing sampled); an OpenGL stream
writes the window and client size with no exclusive bits, which a reader treats as *unknown*, never as *windowed*. A
minimised game presents only `DXGI_PRESENT_TEST`, which the hook drops before sampling, so a `sampleQpc` older than 2 s
leaves the exclusive bits unknown.
The cross-process fields are declared as plain integers and accessed through
`std::atomic_ref` rather than as `std::atomic<T>` members. `std::atomic<T>` has
no guaranteed layout, cannot be memcpy'd, and cannot be mirrored by a C#
@@ -260,6 +303,28 @@ same class of bug as record drift.
Agent is inert from the beginning rather than enjoying a grace window.
- If `unhookRequested` is set, the Overlay disables hooks within one frame and sets `status = unhooked`. This path must be the fastest, most-tested code in the DLL: it is the safety stop.
## D — the tolerance mapping (`Local\FrameLedger.Tolerate.<pid>`), D33 (2026-09-26)
Agent → Overlay, once, BEFORE the injection it concerns: the anti-cheat family NAMES a game's user-mode exception
covers (`19_SAFETY` §The user-mode exception). It cannot live in A + B: the Overlay creates that mapping on init and the
Agent opens it afterwards, while the Overlay's loader detour must know the tolerance from the moment it exists.
```cpp
struct FlTolerance { // fl_tolerance.h; 16 + 8 x 64 = 528 B, no padding
uint32_t magic; // @0 FL_TOLERANCE_MAGIC ("FLTL")
uint32_t version; // @4 FL_TOLERANCE_VERSION (1)
uint32_t count; // @8 names used, <= 8
uint32_t reserved; // @12 zero
char families[8][64]; // @16 NUL-terminated ASCII family names
};
```
Created by the Agent for the game's pid, current user only, held for the session; read once by the Overlay's
`InitThread` before `InstallLoaderHook`, which resolves every name against its own compiled floor and honours only a
user-mode family. Absent, malformed or naming anything else: nothing is tolerated. Mirrored as `FlTolerance` /
`ToleranceLayout` in `FrameLedger.Shared` and held to the native layout by `ShmLayoutMirrorTests` through
`fl-layout-dump`. *(Built in beta.9: PR-1, the Overlay reads it; PR-2, the Agent writes it — `Infrastructure.Capture.OverlayToleranceChannel`, security descriptor `O:<user>D:P(A;;GR;;;<user>)` stated rather than defaulted (an elevated Agent's default DACL omits the user, and the Overlay in an unelevated game could not open it), a name that already exists refused as not ours, and a channel that cannot be published is no exception: the session then names no family and the blocked game is refused as before.)*
## C — command pipe (`\\.\pipe\FrameLedger.v2`)
Unchanged in spirit from v1, bumped to `v2` for the new message set.
@@ -291,7 +356,24 @@ Unchanged in spirit from v1, bumped to `v2` for the new message set.
SDDL `D:P(A;;GA;;;<user SID>)(A;;GA;;;BA)` on the instance — `PipeAccessControl.Sddl`, what `20_OPEN_QUESTIONS`
§G asked for — and the token check by impersonation on the client's FIRST frame, because the kernel refuses
`ImpersonateNamedPipeClient` before the client has written; a stranger is disconnected without an answer and
counted. The client side uses `PipeOptions.CurrentUserOnly`, the mirror check on the server's owner.)*
counted. ~~The client side uses `PipeOptions.CurrentUserOnly`, the mirror check on the server's owner.~~)*
> **Amended 2026-09-17: the owner is stated, and the client compares it with its token USER.** The SDDL is now
> `O:<user SID>D:P(A;;GA;;;<user SID>)(A;;GA;;;BA)`. Left to default, a pipe's owner is its creator token's default
> owner, and an elevated token's is `BUILTIN\Administrators` — measured on the owner's machine that morning: the log
> files the elevated Agents created are owned by Administrators, the unelevated ones' by the user.
> `PipeOptions.CurrentUserOnly` compares the pipe's owner with the client token's default OWNER
> (`NamedPipeClientStream.ValidateRemotePipeUser` in dotnet/runtime), so an App started as administrator refused the
> user's own unelevated Agent, silently, as though none were there, and started another on every connect round
> (`01_ARCHITECTURE` §Lifecycle). The client connects without that option and calls
> `PipeAccessControl.RequireOwnedByCurrentUser` before it writes a byte; `PipeServerClientTests` pins the owner and
> drives both directions on a token that owns as Administrators (CI's elevated runner — an unelevated run skips it).
>
> **Accept failures back off.** An instance that cannot be created is retried 250 ms doubling to 10 s and logged on
> the first failure, on a change of error and at 10, 100, 1000… in a row, with the Win32 error. The three extra
> Agents of that morning logged the bare "accept failed" every 260 ms for four hours, 2 MB each. The error is read
> with `GetLastSystemError`: CsWin32 0.3.298 declares `CreateNamedPipeW` without `SetLastError`, so
> `GetLastPInvokeError` read 0.
- Framing: 4-byte LE length + UTF-8 JSON, max 1 MB. `System.Text.Json` source-generated contexts in `FrameLedger.Shared`.
*(Header and body go out in one write, so on the message-mode pipe one frame is one message; the reader
reassembles by length alone. Over the cap, or a stream ending inside a frame, is `IpcFramingException`.)*
@@ -300,29 +382,36 @@ Unchanged in spirit from v1, bumped to `v2` for the new message set.
makes an additive field safe.)*
- A request the Agent cannot answer gets `Error { code, message }` with the request's `id`: `UnknownType`,
`Malformed` (no `id` when the envelope itself could not be read), `ProtocolMismatch`, `HandlerFaulted`. The
connection survives all four.
connection survives all four. *(Added 2026-10-04: `SetHookEnabled` and `SetAntiCheatException` also answer
`Error UnknownGame` — no row has that id — and `Error ExecutableUnreadable` — nothing scanned, stamped or granted;
the App branches on the second.)*
### Messages
| Type | Dir | Payload / notes |
|---|---|---|
| `Hello` | UI→A | `{ appVersion, protocol: 2 }` → `HelloAck { agentVersion, protocol, pid, elevated, overlayBuildId, vulkanLayerRegistered, telemetrySource /* composite, e.g. l1+lhm+nvapi */, cpuTempAvailable, disclosureVersion /* P3 PR-4, D14: the FR-2.1 text this Agent stamps against */, ~~etwAvailable~~ }` — `etwAvailable` struck 2026-09-13 with the tier it described (2026-08-28); `pid` added. `vulkanLayerRegistered` is **false by construction** today (the layer is per-launch, never registered) and `cpuTempAvailable` false unelevated; `telemetrySource` is the composite stood up once on the first `Hello` |
| `GetStatus` | UI→A | → `StatusAck { state, activeSession?, tier? }` |
| `Hello` | UI→A | `{ appVersion, protocol: 2 }` → `HelloAck { agentVersion, protocol, pid, elevated, overlayBuildId, vulkanLayerRegistered, telemetrySource /* composite, e.g. l1+lhm+nvapi */, cpuTempAvailable, disclosureVersion /* P3 PR-4, D14: the FR-2.1 text this Agent stamps against */, exceptionDisclosureVersion /* D33, 2026-09-26: the user-mode exception's disclosure this Agent grants against */, elevationOutcome /* beta.10, D34: the admin mode's answer at this start — granted, declined, other-account, failed — or null when nobody asked */, ~~etwAvailable~~ }` — `etwAvailable` struck 2026-09-13 with the tier it described (2026-08-28); `pid` added. ~~`vulkanLayerRegistered` is **false by construction** today (the layer is per-launch, never registered)~~ `vulkanLayerRegistered` is the HKCU implicit-layer registration as the Agent found it at start *(corrected 2026-10-04: since P3 PR-8b; true while `VkLayerReconciler` keeps the layer registered for a hook-enabled Vulkan game, P4 PR-2)* and `cpuTempAvailable` false unelevated; `telemetrySource` is the composite stood up once on the first `Hello` |
| `GetStatus` | UI→A | → `StatusAck { state, activeSession?, tier? }` — and `activeSessions[]`, one `{ sessionGuid, gameId, gameName?, pid, tier, startedAt, hold? }` per running session. **`hold` added 2026-09-23, optional:** present on a session held unhooked (Tier 2), with the same words `SessionStarted.hold` carries; a session listed at tier 2 WITHOUT a `hold` has not attached yet — it is starting, not held. The App reads this list on every (re)connect (§Client behavior) |
| `SetWatchlist` | UI→A | `{ entries: [{ gameId?, exePath }] }` — ~~full replace~~ **ensure, never remove** (built 2026-09-13, PR-1b): each entry's path is normalised by the Agent, its row ensured with hooking OFF when new, and the ack is `WatchlistAck { games: [{ gameId, exePath, name }], unreadable: [exePath] }`; `gameId` in a request is a hint and never trusted over the path. UI re-sends on connect. **Carries no hooking state** (see §The pipe is not a trust boundary). *Since the App writes `games` rows itself under `06_DATA_MODEL` §Writer ownership (HANDOFF §P3 D15), this is the pipe's way of adding a row, not the only one; the watcher reads the table at 1 Hz either way.* |
| `LaunchGame` | UI→A | `{ gameId, arguments? }` → ~~suspended-launch~~ launch mode as built ("inject late", `04_CAPTURE` §Launch mode) → `LaunchAck { gameId, accepted, outcome, sessionGuid? }` — `outcome` is `Accepted` · `UnknownGame` · `SessionRunning` (one per game at a time) · `Unavailable`. *(Built 2026-09-13, PR-1b: `CaptureOrchestrator.LaunchAsync` over an `ILaunchRecorderFactory` the Agent composes with the Vulkan layer's environment — or none when FR-2.4's switch is on — and the launcher election runs after, as the console's `launch` does; the elected session is not addressable by the launch's guid.)* |
| `SetHookEnabled` | UI→A | `{ gameId, enabled, disclosureVersion? }` — Agent re-runs the static AC pre-scan and may reply `Refused`. **The Agent stamps the consent timestamp itself.** *(Built 2026-09-13, PR-1b, as far as it can be: `enabled: false` → `RevokeAsync` → `HookEnabledAck { gameId, enabled: false, outcome }`; `enabled: true` → the pre-scan of the executable's directory, a refusal or a "could not verify" recorded through `RecordGuardBlockAsync` and answered `Refused { gameId, reason, family?, signal? }`; a clean scan → ~~**`Error DisclosureUnavailable`, nothing stamped** — the reviewed FR-2.1 text does not exist, and a client's `disclosureVersion` is a claim, not a disclosure shown. PR-4 replaces that last branch with the stamp~~ **since PR-4 (2026-09-13): the client's `disclosureVersion` compared with the Agent's own `SafetyDisclosure.Version`; equal → the stamp from the Agent's clock with `ConsentProvenance.ConsentDialog`, answered `HookEnabledAck { enabled, outcome, prescan: "clean" }`; anything else → `Error DisclosureVersionMismatch`, nothing written (D14). `DisclosureUnavailable` remains for a composition that wired no version, which `--serve` never is.)* |
| `LaunchGame` | UI→A *(the App sends it since beta.21: Play in its Start directly mode, and in the store mode where no store installed the game — `App.Services.GamePlayer`, D59)* | `{ gameId, arguments? }` → ~~suspended-launch~~ launch mode as built ("inject late", `04_CAPTURE` §Launch mode) → `LaunchAck { gameId, accepted, outcome, sessionGuid? }` — `outcome` is `Accepted` · `UnknownGame` · `SessionRunning` (one per game at a time) · `Unavailable` · `RecordingOff` (2026-09-23: the entry's recording switch is off, FR-1.6 — FrameLedger does not start what it will not record). *(Built 2026-09-13, PR-1b: `CaptureOrchestrator.LaunchAsync` over an `ILaunchRecorderFactory` the Agent composes with the Vulkan layer's environment — or none when FR-2.4's switch is on — and the launcher election runs after, as the console's `launch` does; the elected session is not addressable by the launch's guid.)* |
| `SetHookEnabled` | UI→A | `{ gameId, enabled, disclosureVersion? }` — Agent re-runs the static AC pre-scan and may reply `Refused`. **The Agent stamps the consent timestamp itself.** *(Built 2026-09-13, PR-1b, as far as it can be: `enabled: false` → `RevokeAsync` → `HookEnabledAck { gameId, enabled: false, outcome }`; `enabled: true` → the pre-scan of the executable's directory, a refusal or a "could not verify" recorded through `RecordGuardBlockAsync` and answered `Refused { gameId, reason, family?, signal? }`; a clean scan → ~~**`Error DisclosureUnavailable`, nothing stamped** — the reviewed FR-2.1 text does not exist, and a client's `disclosureVersion` is a claim, not a disclosure shown. PR-4 replaces that last branch with the stamp~~ **since PR-4 (2026-09-13): the client's `disclosureVersion` compared with the Agent's own `SafetyDisclosure.Version`; equal → the stamp from the Agent's clock with `ConsentProvenance.ConsentDialog`, answered `HookEnabledAck { enabled, outcome, prescan: "clean" }`; anything else → `Error DisclosureVersionMismatch`, nothing written (D14). `DisclosureUnavailable` remains for a composition that wired no version, which `--serve` never is.)* **Since beta.8 (2026-09-25):** the pre-scan is of the executable (the guard resolves the install root, PR-2 of that train), and BEFORE it an executable known not to run as x64 is answered `Refused { gameId, reason: "ExecutableNotX64", signal: "x86" | "anycpu32" | "arm64" | "arm" }` with nothing scanned and nothing written — not a guard reason and not a block (`05_DETECTION` §What the files say about themselves). **Since D33 (2026-09-26):** for a blocked game whose user-mode exception is in force for the executable on disk (the option on, a grant made on these bytes, the block naming that family) the pre-scan NAMES the family, and a pass under it is stamped as ever and answered `prescan: "exception"`; a finding about the game under it also ends the exception. |
| `SetAntiCheatException` | UI→A | **Added 2026-09-26 (D33).** `{ gameId, enabled, disclosureVersion? }` — grant or withdraw a game's user-mode anti-cheat exception (`19_SAFETY` §The user-mode exception). `enabled: false` → the exception ends (`Withdrawn`), hooking goes off while the block stands → `AntiCheatExceptionAck { gameId, granted: false, outcome, family? }`. `enabled: true` → `Error DisclosureVersionMismatch` unless `disclosureVersion` is the Agent's `AntiCheatExceptionDisclosure.Version`; `Error ExceptionsOff` while `hooking.usermode_ac_exceptions` is off; `Refused { reason: "BlockNotExceptionable" }` for a title list or an unreadable block; then the Agent's OWN facts — ~~the successful Tier-1 sessions (`Refused { reason: "TooFewSessions", signal: <count> }` under two)~~ *(D38, 2026-10-03: no session is needed)*; a game an exception of which ended during its trial is refused before anything is scanned (`Refused { reason: "TrialFailed", family, signal: <unix ms> }`); a tolerant pre-scan of the executable on disk naming the block's family (`Refused { reason, family, signal }` unless the guard let exactly that family through) — and the store writes the grant only over facts that make the game eligible, and never over a failed trial → `AntiCheatExceptionAck { granted, outcome, family }`. **A grant turns nothing on**: hooking is FR-2.1's `SetHookEnabled`, afterwards. Not answered (`UnknownType`) by an Agent composed without the exception. |
| `PauseCapture` / `ResumeCapture` | UI→A | global → `PauseAck { paused }`; `StatusAck.paused` reports it. *(Built 2026-09-13, PR-1b: one in-memory flag, `CapturePause`, read by every session loop at its tick and told to the ring once per transition; supervision — the guard scan, the kill switch, the safety stop — never pauses. Not persisted: an Agent that restarts resumes.)* |
| `StopSession` | UI→A | `{ sessionGuid }` — graceful ~~unhook~~ stop + finalize → `StopAck { sessionGuid, accepted, reason? }`. *(Built 2026-09-13, PR-1b: the orchestrator names every session it starts and cancels THAT session's stop token; the loop reads it at its next tick, drains once more, and ends as `SessionEndReason.StoppedByUser` — `exit_status = normal`, the row stored like any other, the target left running. A guid nobody runs is `accepted: false`. Distinct from the host's cancellation, which leaves a `.partial`.)* |
| `UpdateRules` | UI→A | **no payload** — a trigger, not a source. The Agent re-reads only its own `%LOCALAPPDATA%\FrameLedger\rules\` copy → `UpdateRulesAck { outcome }`. *(Built 2026-09-13, PR-1b: the seeder's `EnsureSeededAsync` outcome; a payload naming a path is ignored, and a test sends one to prove it.)* |
| `Shutdown` | UI→A | graceful stop → `ShutdownAck`, then the host stops (sessions finalize inside its grace window). *(Built 2026-09-13, PR-1b: `IAgentLifetime`, the host's under `--serve`, a logged no-op under `--console`.)* |
| `DeleteSessions` | UI→A | **Added 2026-10-03 (beta.11, D40).** `{ gameId? }` — every session of that game, or of every game when it is null, with their segments, frame and sensor series and annotations (they cascade) → `DeleteSessionsAck { gameId?, games, sessions }`. `Error SessionRunning` and nothing deleted while a session of that game — of any game, for all — is being recorded (`CaptureOrchestrator.IsRecording` / `IsRecordingAny`). The client names no rows beyond the game: they are the Agent's (§Writer ownership). Additive: an older Agent answers `Error UnknownType`, which the App says as "restart the agent". Carries no safety fact. |
| `SweepRetention` | UI→A | **no payload** — a trigger, like `UpdateRules`: the Agent applies `06_DATA_MODEL` §Retention to every game with the `retention.raw_sessions_per_game` it reads itself → `SweepRetentionAck { keep, games, sessions }` (`keep` 0 = unlimited, and then nothing was swept). *(Built 2026-09-15, P4 PR-7, for Tools ▸ Database maintenance: `Application.Recording.RetentionSweep` over `ISessionRepository.SweepRetentionAllAsync`, composed into `AgentCommandHandler` under `--serve`. The client names no number because the rows are the Agent's (§Writer ownership). Additive: an older Agent answers `Error UnknownType`, which the dialog reads as "restart the Agent". Carries no safety fact.)* |
| `SessionStarted` | A→UI | `{ sessionGuid, gameId, gameName, pid, tier, startedAt }` — **published at the attach**, i.e. when the session becomes Tier 1 and the live card has something to show; a session that never attaches has no `SessionStarted`, only its `SessionCompleted` (tier 2) and, when a refusal or error caused that, the event below that names it |
| `SessionProgress` | A→UI | 1 Hz: `{ sessionGuid, elapsedS, presents5s, presentedFps5s?, presentedQualifier, nativeFps5s?, displayedFps5s?, fgFactor?, fgMode, upscaler?, upscalerQuality?, renderW/H?, outputW/H?, rtActive?, gpuTempC?, cpuTempC?, vramProcMb?, latencyUs?, fgRefusal?, fgRuntimeCensus? }` — a 5 s rolling window over the ring through the SAME Domain calculators the row uses (`SessionProgressCalculator`, D13). **Two fields added 2026-09-14, both optional (an older client ignores them, §C):** `fgRefusal` is the row's `fg_refusal` (schema 0003) — present when `fgMode` names a technology and `fgFactor` is absent, so the live card can say "DLSS-G active — factor not counted" rather than N/A; `fgRuntimeCensus` is the raw census so the `fg_runtime_loaded` chip can name the module. **Rule 6 at the wire (2026-09-13):** `nativeFps5s` / `displayedFps5s` / `fgFactor` are present only when frame generation was measured in the window; otherwise `presentedFps5s` stands alone with `presentedQualifier` (`census_not_run` · `no_fg_runtime` · `fg_runtime_loaded` · `none_withheld`, the row's `presented_qualifier` from the same function). Every unmeasured field is absent, never 0. Suppressed when no client is connected |
| `SessionCompleted` | A→UI | `{ sessionGuid, sessionId?, exitStatus, tier, finalize, reason }` — UI loads the full row from SQLite; `sessionId` is null and `finalize` is `discarded` when the row was not stored (under the minimum length); `exitStatus` is the row's vocabulary (`normal` · `crashed` · `unhooked_safety` · `degraded`); `reason` is the loop's `SessionEndReason` |
| `CaptureRefused` | A→UI | `{ gameId, gameName, reason, family?, signal? }` — **guard fired**; UI shows the plain-language explanation — ~~and the Tier-2 offer~~; there is no alternative measurement to offer, only the option to record the session unmeasured (`08_UI` §Safety events). *(Built: for `RefusedByGuard`, `RefusedPreviouslyBlocked`, `RefusedKillSwitch` and `PreScanCouldNotVerify` — the last with no family, because "could not verify" is neither a hit nor a pass; `family`/`signal` are the verdict's. A game merely not enabled or not consented raises nothing: that is an ordinary Tier-2 row, not a refusal to explain.)* |
| `CaptureDegraded` | A→UI | `{ sessionGuid, from: 1, to: 2, reason }` — Tier 1 → Tier 2 mid-flight, or overlay self-disabled. **Under a two-rung ladder this means measurement STOPPED**, not that it continued at lower fidelity, and the notice must say so. *(Built: `SupervisionLost`, `WriterSelfDisabled`, `WriterStoppedBlocklisted`, `WriterNeverInstalledHooks`, `SupervisionFaulted`, `KillSwitchEngaged` — `RecordedSessionEvents.Classify` is the table.)* |
| `SafetyUnhook` | A→UI | `{ sessionGuid, family?, signal? }` — anti-cheat appeared mid-session; prominent UI notice. *(Built: the verdict that FIRED, not the pass that started the session — `CaptureOutcome.Verdict` carries the supervisor's last verdict on this reason since 2026-09-13.)* |
| `CaptureError` | A→UI | `{ sessionGuid?, code, message }` — `InjectFailed`, `RingVersionMismatch`, `AttachRefused`, ~~`EtwAccessDenied`~~ (struck 2026-09-13 with the tier), ~~`PresentMonMissing`~~ (retired with the tool, 2026-08-27 — a code naming an implementation nobody chose), `TelemetryUnavailable`, `DbWriteFailed`, `SessionFaulted` (the session's task threw before finalize; the `.partial` stays for recovery, and no `SessionCompleted` follows). *(Built: `RingVersionMismatch` for a layout / record-size / build-id refusal — the "restart the game after an update" case — `AttachRefused` for the rest of the ring's refusals, `InjectFailed` for a target that could not be started, pinned, read or singled out.)* |
| `SessionStarted` | A→UI | `{ sessionGuid, gameId, gameName, pid, tier, startedAt, hold? }` — **published once per session**: at the attach (tier 1, `startedAt` the attach), or — **since 2026-09-23** — at the first tick of a session held unhooked (tier 2, `startedAt` the session's start, `pid` 0 when the loop never opened the process, as a hooking-off hold never does). ~~a session that never attaches has no `SessionStarted`, only its `SessionCompleted` (tier 2)~~ — that was the beta.5 wire, and every hooking-off, refused or unreadable game read "Nothing is being captured." for as long as it ran. **`hold` (optional, tier 2 only)** is why nothing is measured: `{ reason, guardReason?, family?, signal?, hookingTurnedOff }` — the loop's `SessionEndReason` and, when the guard said anything but allow, its reason, family and signal: the same words the row's `capture_notes` will carry, so the live card and the summary read one sentence (`Formats.Tier2HoldReason` / `Tier2Reason`). The refusal's own event (`CaptureRefused` and the rest, below) goes out with this start rather than when the game exits, and is not repeated at the end |
| `SessionHeld` | A→UI | **Added 2026-09-23.** 1 Hz while a client listens, for a session held unhooked only: `{ sessionGuid, elapsedS, gpuTempC?, cpuTempC?, gpuLoadPct?, cpuLoadPct?, gameVramDedicatedMb?, gameRamPrivateMb? }` — how long it has run and the machine's sensors (and since beta.12 the game process's own memory, read from outside it — optional, an older client ignores them). **Never `SessionProgress`**: its `presents5s`, `presentedQualifier` and `fgMode` are required, and zeros there would put measured-looking numbers on the wire for a session that measures nothing (rule 6 has nothing to show and shows nothing) |
| `SessionProgress` | A→UI | 1 Hz: `{ sessionGuid, elapsedS, presents5s, presentedFps5s?, presentedQualifier, nativeFps5s?, displayedFps5s?, fgFactor?, fgMode, upscaler?, upscalerQuality?, upscalerDriverReported?, renderW/H?, outputW/H?, rtActive?, gpuTempC?, cpuTempC?, cpuLoadPct?, vramProcMb?, latencyUs?, fgRefusal?, fgRuntimeCensus?, gameVramDedicatedMb?, gameRamPrivateMb? }` (the last two added 2026-10-03, beta.12, optional: the game process's dedicated GPU memory and private working set, MiB, from the newest telemetry tick; `vramProcMb` stays reserved for the in-process figure and has no producer) — a 5 s rolling window over the ring through the SAME Domain calculators the row uses (`SessionProgressCalculator`, D13). **`upscalerDriverReported` added 2026-09-21, optional:** `dlss` when the NVIDIA driver reports an NGX super-resolution feature created and evaluated in the target (`03_METRICS` §The driver-reported rung), so the live card says `DLSS (driver-reported)` where no hook can name the upscaler; identity only. **`cpuLoadPct` added 2026-09-21, optional** (CPU time busy over the last telemetry tick, 0–100; `cpuTempC` has a producer from the same date, present only when the Agent is elevated with PawnIO). **Two fields added 2026-09-14, both optional (an older client ignores them, §C):** `fgRefusal` is the row's `fg_refusal` (schema 0003) — present when `fgMode` names a technology and `fgFactor` is absent, so the live card can say "DLSS-G active — factor not counted" rather than N/A; `fgRuntimeCensus` is the raw census so the `fg_runtime_loaded` chip can name the module. **Rule 6 at the wire (2026-09-13):** `nativeFps5s` / `displayedFps5s` / `fgFactor` are present only when frame generation was measured in the window; otherwise `presentedFps5s` stands alone with `presentedQualifier` (`census_not_run` · `no_fg_runtime` · `fg_runtime_loaded` · `none_withheld`, the row's `presented_qualifier` from the same function). Every unmeasured field is absent, never 0. Suppressed when no client is connected |
| `SessionCompleted` | A→UI | `{ sessionGuid, sessionId?, exitStatus, tier, finalize, reason, gameId?, gameName? }` — UI loads the full row from SQLite; `sessionId` is null and `finalize` is `discarded` when the row was not stored (under the minimum length), or `game_removed` when its entry was removed with its sessions while it ran (2026-09-23), or **`faulted` when the session's task threw before it could finalize** (2026-09-23: it follows the `CaptureError SessionFaulted`, with `exitStatus` `interrupted` and `reason` `SessionFaulted`, so the live card and the tray let go of a session that no longer runs; the `.partial` stays for recovery); `exitStatus` is the row's vocabulary (`normal` · `crashed` · `unhooked_safety` · `degraded`); `reason` is the loop's `SessionEndReason`. **`gameId` / `gameName` added 2026-09-23, optional:** the entry the session was stored under — the finalizer's owner when it re-keyed a session whose entry was removed, else the one it started under — so the notice names the session that completed, not whatever the live card last showed |
| `CaptureRefused` | A→UI | `{ gameId, gameName, reason, family?, signal?, hookingTurnedOff, guardReason? }` — **`guardReason` (beta.13, optional)** is the guard's own reason ~~when it named a family~~ **whenever it refused (beta.18; beside a family only until then)**: `BlockedService` / `BlockedDriver` is a finding on the PC, not in the game, and the notice says so (§S23-3), and a refusal no family names is said in the guard's words (`Formats.GuardSentence`) — it printed the end's name, "reason RefusedByGuard"; `reason` stays the session's end reason — **guard fired**; `hookingTurnedOff` (2026-09-22) is true when the finding turned the game's hooking off (`19_SAFETY` §What a finding does to the game); UI shows the plain-language explanation — ~~and the Tier-2 offer~~; there is no alternative measurement to offer, only the option to record the session unmeasured (`08_UI` §Safety events). *(Built: for `RefusedByGuard`, `RefusedPreviouslyBlocked`, `RefusedKillSwitch`, `PreScanCouldNotVerify` and, since 2026-09-21 (beta.4), `TargetUnreadable` — a protected process the Agent could not open (added 2026-10-04) — `PreScanCouldNotVerify` with no family, because "could not verify" is neither a hit nor a pass; `family`/`signal` are the verdict's. A game merely not enabled or not consented raises nothing: that is an ordinary Tier-2 row, not a refusal to explain.)* |
| `CaptureDegraded` | A→UI | `{ sessionGuid, from: 1, to: 2, reason }` — Tier 1 → Tier 2 mid-flight, or overlay self-disabled. **Under a two-rung ladder this means measurement STOPPED**, not that it continued at lower fidelity, and the notice must say so. *(Since beta.18 it says the end in words, `Formats.EndReasonText`; it printed `reason` raw — "The hook stopped (WriterSelfDisabled); the session continues without measuring" — and a stop ends the session, it does not continue it.)* *(Built: `SupervisionLost`, `WriterSelfDisabled`, `WriterStoppedBlocklisted`, `WriterNeverInstalledHooks`, `SupervisionFaulted`, `KillSwitchEngaged` — `RecordedSessionEvents.Classify` is the table.)* |
| `SafetyUnhook` | A→UI | `{ sessionGuid, family?, signal?, hookingTurnedOff, guardReason? }` — `guardReason` as on `CaptureRefused` (beta.13) — anti-cheat appeared mid-session; prominent UI notice; `hookingTurnedOff` as on `CaptureRefused`. *(Built: the verdict that FIRED, not the pass that started the session — `CaptureOutcome.Verdict` carries the supervisor's last verdict on this reason since 2026-09-13.)* |
| `GameRemoved` | A→UI | `{ gameId, gameName?, exePath, reason }` — **since beta.19 (D55):** the Agent removed a library entry by itself; `reason` is `uninstalled` (its executable gone for ten minutes from a folder that is still there, no session, no anti-cheat block or exception — `06_DATA_MODEL` §Writer ownership). Not a session event. The Games page on screen reloads and says so; a game page showing that entry reloads into its not-found state. Additive: a client that does not know the type ignores it (§Versioning). |
| `HookingTurnedOff` | A→UI | `{ gameId, gameName?, reason, family?, signal? }` — **since 2026-09-25 (beta.8):** the Agent's pre-scan of the library (`19_SAFETY` §What a finding does to the game) found anti-cheat in a game whose hooking the user had turned on, and turned it off. Not a session event — no session is running — so the UI's notice carries no "record without measuring" action, only Dismiss (`SafetyNoticeKind.HookingOff`). A finding on a game whose hooking was already off sends nothing: its page and its library card change, nothing the user switched on did. Additive: a client that does not know the type ignores it (§Versioning). |
| `CaptureError` | A→UI | `{ sessionGuid?, code, message }` — `InjectFailed`, `RingVersionMismatch`, `AttachRefused`, ~~`EtwAccessDenied`~~ (struck 2026-09-13 with the tier), ~~`PresentMonMissing`~~ (retired with the tool, 2026-08-27 — a code naming an implementation nobody chose), `TelemetryUnavailable`, `DbWriteFailed`, `SessionFaulted` (the session's task threw before finalize; the `.partial` stays for recovery, and ~~no `SessionCompleted` follows~~ a `SessionCompleted` with `finalize: faulted` follows since 2026-09-23). *(Built: `RingVersionMismatch` for a layout / record-size / build-id refusal — the "restart the game after an update" case — `AttachRefused` for the rest of the ring's refusals, `InjectFailed` for a target that could not be started, pinned, read or singled out.)* |
| `Ping`/`Pong` | ~~both~~ UI→A | 15 s keepalive, **client-driven** (built 2026-09-13): the client pings, the Agent answers; the Agent initiates nothing on an idle connection |
## The pipe is not a trust boundary
@@ -363,10 +452,47 @@ message, and that message always re-scans.
## Client behavior (UI)
- Connect with 250 ms × 8 backoff; on failure start the Agent, retry; then show an Agent status banner with Repair.
- **The running sessions are the status's, then the events' (2026-09-23).** Every list of running sessions the App
keeps is seeded from `StatusAck.activeSessions` on every (re)connect and moved by `SessionStarted` /
`SessionCompleted` after that; a lost Agent empties it. The Dashboard reads the App-lifetime `LiveSessions`
service (it is rebuilt per visit, so a list of its own would start empty); the tray and the updater seed their
own from the same status. Before this a Dashboard opened after a game started read "Nothing is being captured.",
the tray stayed idle for a session that began before the App connected, and the updater held an update at
*Deferred* on a status read hours earlier.
- Connect with 250 ms × 8 backoff; on failure start the Agent, retry; then show an Agent status banner with ~~Repair~~ Retry *(corrected 2026-10-04)*.
> **Amended 2026-09-17: never a second Agent.** A round that ends without a connection starts one only when no
> process holds the user's data folder (`AgentInstanceLock`, probed through `IAgentLauncher.RunningAgent`) and the
> Agent this App started last has exited. Otherwise it starts nothing and logs why the connect failed and that it
> is not starting another — once per distinct reason, not once per round (`AgentConnection.LastConnectFailure`;
> before this the reason was swallowed, and a refusal looked exactly like an absent Agent). The Agent it does start
> is watched until it exits and its exit code logged, so exit 10 — the folder was already claimed — is visible in
> the App's log. `AgentConnectionTests` pins both.
> **Amended 2026-09-27 (beta.10, the admin mode, D34): a start may ask Windows first.** With `capture.run_elevated` on
> and this App a standard user's, the start is a UAC prompt owned by the App's window (`IAgentLauncher.WillAskForElevation`
> turns the pill into *Waiting for administrator permission*), and while it is up the folder's `ElevationMarker`
> (`Local\FrameLedger.Agent.Elevating.<hash>`) is held — `RunningAgent` reads it as "an Agent is coming", so the App never
> prompts beside the logon task's Agent, which holds the same marker while its own prompt waits on the taskbar. A declined
> prompt starts the standard user's Agent with `--elevation declined`; an elevated Agent that exits 11 (another account
> answered) makes the App start standard-user Agents until it restarts.
- **Named objects an elevated process creates state their DACL (beta.10).** An elevated token's default DACL grants
Administrators and SYSTEM and not the user, so an object an elevated Agent creates with it cannot be opened by the same
user's unelevated App or game: the pipe (`PipeAccessControl`), the tolerance mapping (§D) and — since beta.10 — the
ledger's migration lock (`Infrastructure.Startup.SharedMutex`: owner the user, full access to the user, Administrators
and SYSTEM) each carry an explicit descriptor. The instance lock and the elevation marker are only ever probed, and a
probe that is refused reads as "held".
- Treat the pipe as unreliable: library, history and charts must all work with the Agent offline. Only live status degrades.
- **A request the Agent never answered is neither a failure nor a refusal (beta.22).** `IAgentRequests.RequestAsync` fails
in one of four ways: `InvalidOperationException` — not connected, nothing was sent; `IpcRequestException` — the Agent
answered `Error`; `TimeoutException`; and `IOException` — the connection closed before the answer, whatever closed it
(`AgentConnection.AnsweredAsync` turns the `IpcFramingException` and `ObjectDisposedException` that `PipeClient` can fail a
request in flight with into it, so a caller handles one). The last two mean *whether it was carried out is not known*
(`AgentAnswers.IsUnanswered`): the caller says so in words (`Agent_Unanswered`) and reads what is stored again — deleting
sessions, the hooking switch, the anti-cheat exception and Play alike. Until beta.22 deleting sessions caught no
`IOException` (the App's crash dialog) and showed a timeout's own message, and the hooking switch and the exception
showed `IOException` or `TimeoutException` as their notice.
- SQLite is the source of truth for anything persisted; pipe events are refresh signals (except `SessionProgress`, which is live-only by design).
- `CaptureRefused` and `SafetyUnhook` are **never** collapsed into a generic error toast — they get dedicated, explanatory UI (`08_UI` §Notifications).
- `CaptureRefused`, `SafetyUnhook` and (since 2026-09-25) `HookingTurnedOff` are **never** collapsed into a generic error toast — they get dedicated, explanatory UI (`08_UI` §Notifications).
## Versioning
+654 -41
View File
@@ -19,12 +19,74 @@ WPF + **WPF UI (Wpf.Ui, Fluent)**. Shell = `ui:FluentWindow` with custom `ui:Tit
status: Agent state shown as a pill in TitleBar trailing content + Dashboard card
```
> **A viewer over a copy, beta.15 (owner decision D52).** `FrameLedger.exe --data-dir <folder>` opens the ledger in
> `<folder>` — a COPY of a data folder — and keeps its log and crash dumps beside it. It starts and contacts no Agent: the
> pipe is one per user, and the Agent behind it records into the profile's ledger, so a request carrying the copy's game
> ids would act on other games (a consent written for the wrong one is rule 1's failure). Its composition holds no pipe
> client, no launcher, no update check and no Run-entry writer (`Services.MachineFacingServices`,
> `ViewerModeTests`); the pill reads *Viewer — no Agent*, a persistent InfoBar names the folder, and every control that
> would ask the Agent or change the PC is disabled — hooking, the exception's grant and withdrawal, re-enabling, Delete
> all sessions, the kill switch, the admin mode, the logon task, the Vulkan layer, Start with Windows, the automatic
> update check, Help ▸ Check for updates, Tools ▸ Update detection rules and the tray's Pause — and, since beta.18,
> every setting the Agent reads (the user-mode exception option and the three Recording numbers had been missed, and a
> change said the capture agent would read it) and the update channel beside the update check
> (`ViewerModeTests.EverySettingTheAgentReadsIsOffInAViewer`). The profile's own folder
> is refused however it is spelled (case, separators, a relative path, a junction), as is a folder that does not exist;
> a refusal is a message box and exit 2. The viewer's folder is its own single-instance key, so it runs beside the
> profile's App. D6 is unchanged: the Agent's `--data-dir` stays under `--console`.
**NavigationView items:** Dashboard · Games · Compare · Logs — `Settings` lives in `FooterMenuItems`. Icons from `SymbolIcon` (Fluent System Icons; pick from the `SymbolRegular` enum — see 16 §Icons).
**Menu bar**
- **File:** Add game… · Import library (Steam / GOG / Epic / itch.io) · Export ▸ (Session CSV / Session JSON / Chart PNG) · Exit
- **Tools:** Agent status… · Update detection rules · Vulkan layer registration… · Open data folder · Database maintenance…
- **Help:** Check for updates · Report a bug… · Documentation · About FrameLedger (App / Developer / Third-party licenses tabs)
- **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 ▸ 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:
> nothing is accepted or recorded, and the Disclaimer points at it.
>
> **Help ▸ User guide, beta.12 (D44).** `guide/` — ~~eight~~ short English pages for players (install, record a game, read
> your results, anti-cheat and safety, your data, questions and answers, the terms in plain words; *since beta.17, D54,
> also the screens, every setting, what to do when something goes wrong and the words the App uses — twelve pages,
> and the wiki's End-user part*) — embedded in the
> App (`Services.EmbeddedDocuments.Guide`, titles from each page's first heading) and shown in a `Windows/DocumentWindow`
> with a page list, Limitations last; a link between guide pages opens the page in the window. Help ▸ Documentation is
> *Online documentation*: the README at this build's source. `GuideDocumentsTests` holds every page listed and titled and
> every link leading somewhere — and since beta.17 every section link (against the anchors the App's renderer gives the
> target), the contents in the App's order, and that *Every setting* and *The screens* name every setting the Settings
> page shows and every page and menu item of the main window.
>
> **Documents are rendered, beta.12 (owner request 4, D45).** Every Markdown document the App shows — the Legal Gate's
> three texts, Help ▸ Limitations, the update notes, About's documents — is drawn by `Markdown/MarkdownRenderer`
> (Markdig 1.4.0, BSD-2-Clause) into a WPF `FlowDocument` inside `Controls/MarkdownView` (a read-only
> `FlowDocumentScrollViewer`: selectable, Ctrl+C, Ctrl+wheel zoom): headings, emphasis and strikethrough, inline and
> fenced code in monospace, quotes, nested and numbered lists, pipe tables with a header row, rules, links. **HTML is
> off** — a tag is shown as the text it is; **no image is fetched** — its description stands in; a node the renderer
> does not know is shown as its own source text, and `MarkdownRendererTests` proves for every embedded document that
> no word of its plain text is lost and no table is left as `|---|` source. The GPL's `LICENSE` is not Markdown: it is
> shown as written, monospace. Colours and the font are theme resources (`16_WPFUI_SYNTAX` §FlowDocument).
> **The wheel and the render, beta.21 (owner request 2026-10-13: "scrolling the documents is slow"):** a notch moves
> Windows' *lines to scroll* at a browser's line (100/3 DIP; three lines = 100 DIP, scaled by the zoom; a delta in
> proportion, so a touchpad's small deltas move a little; Windows' *one screen at a time* a screen) and eases there in
> about 120 ms unless Windows' animations are off — WPF moved a fixed 48 DIP per message, whatever its delta. At its ends
> the view leaves the wheel to what holds it (the update notes' dialog), and Ctrl+wheel stays the zoom. A page is
> rendered once (`MarkdownView.Show`; three bindings changing ask for one render, ahead of layout), and a view keeps the
> last 16 documents it rendered, so going back to a page costs its layout only (`MarkdownViewTests`). Links
> follow `Markdown/MarkdownLinks`: http, https and mailto through `IUrlOpener`; `#section` scrolls to the heading
> (GitHub's anchors); a relative path resolves against the document's place in the repository and opens in the App
> when the window holds that page, on GitHub otherwise — **at this build's own source** (`Services/RepositoryLinks`:
> the release's tag, stamped by `release.yml`; `main` for a local build — every link said `blob/main` before); any
> other scheme (`file:`, `javascript:`, a drive or UNC path) is not followed, its address shown beside its text.
> **Help ▸ Limitations** is a window of its own (`Windows/DocumentWindow`, one page, *Open on GitHub*); **Help ▸ About**
> is `Windows/AboutWindow`, three tabs: *This app* — the version, and the program's Appropriate Legal Notices (GPLv3
> §0, §5(d)): the copyright line, no warranty, the licence with the NOTICE terms, this version's source, *View the
> licence* / *View NOTICE* / *Open the source code*; *Third-party licences* — `legal/THIRD_PARTY_NOTICES.md` and the
> package index, rendered, and *Open the licences folder* (the published `licenses\`; a development build says it has
> none); *Legal documents* — EULA, GPL, Disclaimer, Privacy Policy, NOTICE, Trademarks. Asking again brings the open
> window forward (`Services/DocumentWindows`). Tests: `MarkdownRendererTests`, `MarkdownLinksTests`,
> `DocumentWindowsTests`.
The Menu sits in its own row **below** the TitleBar (never inside the drag region — 16 §Gotchas).
@@ -55,6 +117,7 @@ The Menu sits in its own row **below** the TitleBar (never inside the drag regio
> are empty states; Settings has Appearance (theme + language, both persisted in `settings` — D16's
> `ui.theme`/`ui.language`). The App starts `FrameLedger.Agent.exe --serve` beside itself when the pipe
> is absent (`07_IPC` §Client behavior, 8 × 250 ms) and shows **Missing** when there is no Agent to start.
> *(Since 2026-09-17: and only when no Agent already holds the data folder — `07_IPC` §Client behavior.)*
> Measured on the dev box: first window at 1.3 s from process start (NFR-4's 2 s). ~~The tray is PR-8's.~~
> **Tray built 2026-09-14 (P3 PR-8b).** `Services/TrayHost` over `TrayViewModel` (no WPF in the view model,
> `TrayViewModelTests`): the four icons are drawn at start (`TrayIcons`, a PNG inside an in-memory `.ico`,
@@ -65,8 +128,12 @@ The Menu sits in its own row **below** the TitleBar (never inside the drag regio
> Dashboard), Exit (a real exit through `ShellHost.Quit`, whatever minimize-to-tray says); a left click opens the
> window. **Minimize to tray on close** hides the live window when `ui.minimize_to_tray` is on and a tray icon
> exists (`WindowClosePolicy`); a language rebuild's old window is unaffected. **FR-3.8's balloon** — "Session
> saved — <game> — click to view" — is raised only while the window is off screen; on screen, the Dashboard's
> snackbar carries the same event (one event, exactly one channel), and its click opens the summary window.
> saved — <game> — click to view" — is raised only while the window is off screen; on screen, ~~the Dashboard's~~ the
> App's snackbar carries the same event (one event, exactly one channel), and its click opens the summary window.
> *(Corrected 2026-10-14, beta.23: the snackbar's notice was raised by the Dashboard's view model, and it reached the
> other pages only because no Dashboard ever went away — each visit made one, the root container kept every one, each
> subscribed, so twenty visits were twenty notices for one session. It is `Services.SessionNotices` now, one
> subscription for the App's life; the Dashboard listens only while it is on screen.)*
> A safety event is never a balloon (`TrayViewModelTests` asserts it). Tools ▸ Agent status… and Tools ▸ Vulkan
> layer registration… now navigate (Dashboard, Settings) instead of saying "not yet".
@@ -75,7 +142,7 @@ The Menu sits in its own row **below** the TitleBar (never inside the drag regio
## Notifications policy
- **In-app, transient** (rules updated, export done, non-fatal capture warning): `ISnackbarService` snackbar, 4 s.
- **In-app, persistent** (Agent offline, PawnIO missing, update downloaded): `ui:InfoBar` banner pinned above content with action button.
- **In-app, persistent** (Agent offline, ~~PawnIO missing,~~ update downloaded, a viewer's folder, the safety notices): `ui:InfoBar` banner pinned above content with action button. *(Corrected 2026-10-07: no PawnIO banner was ever built — CPU temperature reads N/A, and Settings ▸ System says it needs the admin mode and PawnIO; the viewer's banner (D52) and the safety notices were missing from the list.)*
- **System-level, app possibly minimized** (session saved with "View" action, capture error while in tray, update available): tray balloon/toast via H.NotifyIcon.
- One event → exactly one channel; never duplicate the same event across snackbar *and* tray.
@@ -92,11 +159,48 @@ The Menu sits in its own row **below** the TitleBar (never inside the drag regio
> duration and hardware telemetry — with every frame-derived value at N/A"). The one button is
> `Safety_RecordWithoutMeasuring` on a refusal and Dismiss otherwise; it removes the notice and does nothing
> else, because the Agent already records Tier 2 on a refusal (owner decision 2026-08-28) — the button is the
> user's acknowledgement, not a second request. `CaptureError` (non-fatal) goes to the 4 s strip. The safety
> user's acknowledgement, not a second request. *(That sentence became true on 2026-09-22: until then every
> refused session was discarded under the minimum length, and for one day `TargetUnreadable` omitted the
> "still recorded" sentence for that reason. `04_CAPTURE` §Tier selection.)* The session summary of a Tier-2 row
> says WHY under its Tier-2 sentence (`Formats.Tier2Reason` over `capture_notes`: hooking off, the block on the
> row, the guard's family and signal, a process that could not be opened, or the end reason by name —
> `Summary_Tier2_Why_*`). `CaptureError` (non-fatal) goes to the 4 s strip. The safety
> documentation link lives on the Settings page's Capture section rather than in every notice. Tests:
> `SafetyNoticesTests` (the three kinds, the sentence per refusal reason, the strip for errors, nothing for a
> session event, dismiss only by the user).
>
> **On this PC, not in this game — beta.13 (§S23-3).** A driver or a service is found machine-wide: while Easy
> Anti-Cheat's service runs for another title, every game refuses with `BlockedService`, and the notice said the
> family "was detected in this game". The events carry the guard's own reason (`guardReason`, `07_IPC`), and a
> `BlockedService` / `BlockedDriver` refusal reads `Safety_Refused_MachineWide_Format` ("… is running on this PC (…): a
> driver or service, which may belong to another game or program …"), an unhook `Safety_Unhooked_MachineWide_Format`,
> and the summary's Tier-2 reason `Summary_Tier2_Why_MachineWide_Format`; a module, a title list or a file in the game
> still reads "in this game". `Safety_Unhooked_Format` lost "will not inject into this game again until you enable it
> again", untrue both ways since 2026-09-22 (a machine-wide finding turns no hooking off; a finding about the game turns
> it off for good, which `Safety_HookingTurnedOff` then says). Without a `guardReason` — an older Agent — the notice
> reads as before. Tests: `SafetyNoticesTests.AServiceOrDriverIsOnThisPcAndAModuleIsInThisGame`,
> `…AnUnhookSaysWhereTheFindingWasAndPromisesNoReEnable`, `Tier2ReasonTests`.
>
> **Every notice in words — beta.18** (found while writing the guide, beta.17). Three texts printed what only the code
> knows. The gate's own refusals — *Disable all hooking*, a game blocked before — carry the gate's label where a finding
> carries its family, and the kill switch's notice read *"kill switch was detected in this game (the global 'disable all
> hooking' switch is on (FR-2.4); …). FrameLedger will not inject into it, and nothing overrides that."* They are said as
> the session's end now (`Formats.EndReasonText`: "All hooking is switched off in Settings, so nothing was measured."),
> never as a finding. A refusal no family names read *"The anti-cheat guard did not hook this game: reason
> RefusedByGuard."*: the events carry the guard's own reason for every refusal since (`07_IPC`), and the sentence is its
> words — "… the game is 32-bit, and the hook runs in 64-bit games only."; an older Agent's reads `End_RefusedByGuard`.
> A 30 s re-scan that could not look while the game still ran read *"Capture stopped: Access is denied. was detected while
> the game was running"*; it reads `Safety_Unhooked_Unnamed_Format` ("Capture stopped while the game was running — the
> game's process could not be opened — and FrameLedger unhooked."). And `CaptureDegraded` printed its reason raw and said
> the session went on — *"The hook stopped (WriterSelfDisabled); the session continues without measuring."* — where a stop
> ends it: the notice is the end's own sentence ("The measuring hook turned itself off after repeated faults, so measuring
> stopped."), and `Notice_Degraded_Unknown_Format` names only a reason this build has no words for. Tests:
> `NoticesFromTheAgentTests` builds each event as the Agent does — the gate's verdicts, the native facade's
> (`AntiCheatVerdict.FromNative`), `RecordedSessionEvents.PublishReason`, the wire's codec — walks every refusal and every
> stop, and refuses an enum's name, a requirement's id or "reason X" in any notice; it went red on the unfixed code with
> exactly the texts above. Until then the notices' tests raised events written by hand ("GuardBlocked", "HookFaulted", a
> guard reason sent as the end), which no Agent sends.
>
> **Corrected 2026-09-14, after the owner saw a red bar with no way out.** WPF UI 4.3.0's `InfoBar` template has
> **no `ContentPresenter`**, so the action button above — placed as the InfoBar's Content, the only dismissal once
> `IsClosable="False"` removed the X — was never rendered. The view model was right and the screen was wrong.
@@ -105,6 +209,14 @@ The Menu sits in its own row **below** the TitleBar (never inside the drag regio
> `PagesLoadTests.TheInfoBarTemplateRendersItsContent`, which renders both templates and fails when upstream
> gains a presenter — the signal to delete the copy.
> **The pre-scan's notice (2026-09-25, beta.8).** The Agent's pre-scan of the library (`19_SAFETY` §What a finding
> does to the game) sends `HookingTurnedOff` when it turned off hooking the user had turned on; `SafetyNotices` makes
> it a `SafetyNotice` of kind `HookingOff` — Error, persistent like the others, titled *"{game}: hooking turned off"*
> (`Notice_HookingOff_Title_Format`), the refusal sentence naming the family and the signal followed by
> `Safety_HookingTurnedOff`. It has **no** `Notice_Refused_Recording` and its button is Dismiss, not
> `Safety_RecordWithoutMeasuring`: no session is running, so there is nothing to record without measuring. A finding
> on a game whose hooking was already off raises no notice; its card and its page say it (§Games).
## FPS display rule (global, FR-4.2 / CLAUDE.md rule 6)
Reusable control `FpsReadout` (custom control styled with WPF UI theme brushes):
@@ -113,13 +225,14 @@ Reusable control `FpsReadout` (custom control styled with WPF UI theme brushes):
- FG **measured `none`** (a hook ran and saw no frame generation — no producer exists yet) → `144 FPS`, nothing else.
- FG **not measured** (`fg_mode = N/A`, every title today) → `144 FPS` as **Presented FPS**, with a mandatory qualifier chip from the runtime census: muted **"FG not observed"** when no frame-generation runtime was loaded in the process (tooltip: *"no frame-generation runtime was loaded; this number cannot include in-process generated frames — statically linked FSR3-FG and driver-level AFMF excepted"*), or a **⚠ warning chip "FG runtime loaded — may include generated frames"** naming the module when one was. Never the word "Native", never a factor, never `—`.
- FG detected → **`62 → 118 FPS (×1.9 FG)`** — Native first and visually primary (`FontTypography="Subtitle"`), Displayed second, factor as a small accent chip. Tooltip: "Native: frames rendered by the game · Displayed: frames shown on screen incl. generated frames".
- **FG identified, count refused (2026-09-14 — a fourth shape, `FpsReadoutKind.IdentifiedUncounted`).** `fg_mode` names a technology and `fg_factor` is NULL: the owner's Black Myth: Wukong and Onimusha rows, where the tags named DLSS-G and the token count did not resolve. Until this date the readout fell into the "detected" shape and printed **`N/A → N/A FPS (×0.0 FG)`** — a factor nobody counted — while the game page said `DLSS-G ` and the grid said N/A. Now: **`304 FPS`** as Presented FPS with a **⚠ warning chip "DLSS-G active — factor not counted"**, tooltip = the row's `fg_refusal` in plain words ("no application-frame token was counted", "the frame-generation state changed mid-session", …) plus "read it as Displayed, not Native"; the game page's measured row reads **`DLSS-G · factor not counted`**; Displayed and FG× say `N/A` (no factor exists, and it is not a measured none). Never the word "Native", never a factor. The `fg_runtime_loaded` chip also **names the module** now (`FG runtime loaded (sl.dlss_g.dll) — may include generated frames`) from `fg_runtime_census`, as this rule always asked. `FpsPresentation.FrameGenerationLabel` is the one place the page and the live card build the label.
- **A steady-state factor carries its share (2026-09-17).** When `fg_factor_scope = steady` the readout is the generated shape — `58 → 116 FPS` with the chip **`×2.0 FG · 75%`** — and the share is never omitted: the number describes the state the session spent most of its generating time in, not the session. Tooltip: why there is no session-wide factor (menus, loading, a settings change), what the number covers, and the refusal's own numbers. The "factor not counted" chip below remains for a session with no state long enough (`03_METRICS` §The steady state).
- **FG identified, count refused (2026-09-14 — a fourth shape, `FpsReadoutKind.IdentifiedUncounted`).** `fg_mode` names a technology and `fg_factor` is NULL: the owner's Black Myth: Wukong and Onimusha rows, where the tags named DLSS-G and the token count did not resolve. Until this date the readout fell into the "detected" shape and printed **`N/A → N/A FPS (×0.0 FG)`** — a factor nobody counted — while the game page said `DLSS-G ` and the grid said N/A. Now: **`304 FPS`** as Presented FPS with a **⚠ warning chip "DLSS-G active — factor not counted"**, tooltip = the row's `fg_refusal` in plain words ("no application-frame token was counted", "the frame-generation state changed mid-session", …) plus "read it as Displayed, not Native" — **and since 2026-09-16 the refusal's numbers from `fg_refusal_detail`** ("Bucket 3 of 8 measured 2.25 against 3.65 for the whole session, over 53 samples.", "2 swapchains presented during the session."), because the owner's four DLSS-G rows all read the same sentence and the sentence could not say why; the game page's measured row reads **`DLSS-G · factor not counted`**; Displayed and FG× say `N/A` (no factor exists, and it is not a measured none). Never the word "Native", never a factor. The `fg_runtime_loaded` chip also **names the module** now (`FG runtime loaded (sl.dlss_g.dll) — may include generated frames`) from `fg_runtime_census`, as this rule always asked. `FpsPresentation.FrameGenerationLabel` is the one place the page and the live card build the label.
- Tables get three columns (Native / Displayed / FG×); Displayed and FG× render `—` when `fg_mode = none` and **`N/A` when it is not measured** — the two are different negatives and the table must not collapse them. The Native column carries the Presented figure with its qualifier when FG is not measured.
- Charts: Native series default; "Displayed" toggle appears only when displayed data exists (FR-5.4).
## Tri-state feature chips (RT / PT / RR)
`TriStateChip` custom control (WPF UI has no Chip primitive — build on `Border` + theme brushes, 16 §Custom controls): **Yes** = filled (accent) · **No** = outlined · **N/A** = dashed outline, muted foreground. Suffix icon shows source: 🔍 detected · ✎ manual · ↧ inherited. Click → `ui:Flyout` to override (session-level) with "set as default for this game" checkbox (FR-8.3). Chips appear on session rows, session summary header, and game header.
`TriStateChip` custom control (WPF UI has no Chip primitive — build on `Border` + theme brushes, 16 §Custom controls): **Yes** = filled (accent) · **No** = outlined · **N/A** = dashed outline, muted foreground. ~~Suffix icon shows source: 🔍 detected · ✎ manual · ↧ inherited. Click → `ui:Flyout` to override~~ *(corrected 2026-10-04: the source is the chip's tooltip, and a click opens FR-8.3's dialog, `TriStateOverridePrompt` — no flyout exists)* (session-level) with "set as default for this game" checkbox (FR-8.3). Chips appear on session rows, session summary header, and game header.
## Screens
@@ -127,7 +240,7 @@ All screens are `Page`s registered with the navigation page provider and navigat
### Dashboard
- Agent status `ui:CardControl` (state, capability badges as `InfoBadge`: telemetry source, Vulkan layer, ~~ETW fallback~~, PawnIO/CPU-temp, elevation — Repair button on error).
- **Live capture card** (visible during capture): game name, **tier badge**, elapsed, live `FpsReadout` (5 s rolling), **measured** `renderW×H → outputW×H` with upscaler + quality, RT-active dot, CPU/GPU temp, per-process VRAM, sparkline (last 120 s) fed by `SessionProgress`. Tier 1 shows measured settings — this is the payoff of hooking and should read as facts, not guesses.
- **Live capture card** (visible during capture): game name, **tier badge**, elapsed, live `FpsReadout` (5 s rolling), **measured** `renderW×H → outputW×H` with upscaler + quality, RT-active dot, CPU/GPU temp, ~~per-process VRAM~~ the game's own VRAM and RAM (beta.12: read from outside the game, so a held session has them too), sparkline (last 120 s) fed by `SessionProgress`. Tier 1 shows measured settings — this is the payoff of hooking and should read as facts, not guesses.
- Recent sessions list (last 10 across games) → click opens session summary.
- Totals strip: games tracked, total playtime, sessions this week (`ui:Card` row).
@@ -135,30 +248,118 @@ All screens are `Page`s registered with the navigation page provider and navigat
> is `LiveCaptureViewModel` over the pipe's `SessionStarted` / `SessionProgress` / `SessionCompleted`
> (marshalled through the captured `SynchronizationContext`): game, tier badge, elapsed, the `FpsReadout` at
> 1 Hz under the display rule (Presented FPS with its census chip until frame generation is measured), the
> measured `renderW×H → outputW×H` with upscaler + quality, the RT chip, GPU/CPU temperature, per-process VRAM.
> The sparkline is PR-6's. Recent = `ISessionRepository.ListRecentAsync(10)` with game names; a completed
> measured `renderW×H → outputW×H` with upscaler + quality, the RT chip, GPU/CPU temperature, ~~per-process VRAM~~
> (corrected 2026-10-03: that line read the Overlay's per-present VRAM, which nothing produced, so it was always empty;
> since beta.12 it is "This game: VRAM … · RAM …" from the newest telemetry tick, `GameMemoryText.Live`).
> ~~The sparkline is PR-6's.~~ Recent = `ISessionRepository.ListRecentAsync(10)` with game names; a completed
> session reloads the lists (the row is in SQLite, `07_IPC` §Client behavior). Totals = the library's games,
> `SummariseByGameAsync` playtime, `CountSinceAsync(now − 7 d)`. Capability badges and the Repair button are
> PR-8's with the Agent section.
> `SummariseByGameAsync` playtime, `CountSinceAsync(now − 7 d)`. ~~Capability badges and the Repair button are
> PR-8's with the Agent section.~~ *(Corrected 2026-10-04: PR-6 and PR-8 shipped without them. No sparkline exists,
> here or on the Games cards; the Agent card shows its facts as text, and the Vulkan layer state and the logon
> task's Repair are on Settings.)*
>
> **Amended 2026-09-23: the card shows every running session, measured or not.** A session held unhooked
> (Tier 2 — hooking off, refused, unreadable) shows its name, the T2 badge, the elapsed time and the
> machine's temperatures from `SessionHeld`, the line "Recording duration and sensors only — nothing is
> measured." and **why**, in the sentence its summary will carry (`Formats.Tier2HoldReason` over the start's
> `hold`, the same words `Tier2Reason` reads from `capture_notes`) — and no `FpsReadout` at all. A session the
> status lists at tier 2 with no `hold` has not attached yet: its name and badge until the attach's start arrives,
> never the held line and never the "Attached — waiting" one. A hooked session takes the card from a held one,
> never the reverse. The card is seeded from the
> App-lifetime `LiveSessions` when the Dashboard is built, so a session that started while another page was
> open is on it at once; the completion notice names the session that completed (`SessionCompleted.gameName`)
> and a `faulted` completion is no notice (the strip's `CaptureError` already said it). Until this date the
> Agent announced only hooked sessions: every other game read "Nothing is being captured." while it ran.
### Games (grid → detail)
- `GridView`-style panel of cover cards (`ui:CardAction`): name, platform badge, engine badge, total playtime, last played, mini trend sparkline (avg Native FPS last 10 sessions). Sort/filter/`ui:AutoSuggestBox` search.
> **The library, beta.11 (owner requests 2026-10-03).** *The empty band on the right:* the cards were 300 px in a plain
> `WrapPanel`, so at ~1350 px three fitted and a card's width was left unused; the grid is now
> `Controls.UniformWrapPanel` — as many columns as fit at 300 px or wider, every card an equal share of the width, each row
> as tall as its tallest card — and the pill row wraps instead of cutting its last pill. **Grid or list** (owner's choice:
> switch between the two): the button beside the sort shows the other view; the list is one row per game (name, store,
> engine, status, sessions, played, last played; double-click or Enter opens it), and the choice is `ui.library_view`.
> **The count** is in the title (*Games · 42*). **Refresh** reads the library again, then asks the stores for games installed
> since (`ImportLibraryFlow.RunAsync(onlyNew: true)`: *No new games* and no checklist when there are none), and every entry
> whose executable is not on disk carries a **Not installed** pill — its tooltip is the game page's own sentence for it,
> the drive that is not connected or the path the file is gone from (`GameLibrary.ExecutableExists` and
> `Formats.ExecutableMissingText`, asked off the UI thread on every listing, never stored; ~~nothing is removed for it~~
> *since beta.19 (D55) the Agent removes such an entry by itself after ten minutes when it has no session and no
> anti-cheat block or exception, and its drive is connected — Settings ▸ Data ▸ Remove uninstalled games, on by default; the
> page on screen hears `GameRemoved`, reloads and says so in the snackbar (`Games_Removed_Format`); one with sessions keeps
> its pill. One check removes its games in one event each, milliseconds apart: the page waits `GamesViewModel.RemovalSettle`
> (one second) after the first, then reads the library once and says them all in one notice — the count, five names and
> how many more, `Games_Removed_Many_Format`. It said each and reloaded each, and WPF UI 4.3.0's `SnackbarService` shows every
> message at once in its one snackbar, so only the last name stayed on screen. And only the newest read of the library is
> shown: reads overlap — a session that ends, an import, a removal — and the one that started first could finish last,
> its executable checks waiting on a slow drive, and put back a removed game's card (`GamesViewModel.LoadAsync`,
> `GamesViewModelTests.AnOlderReadThatFinishesLastIsNotShownOverANewerOne`)*). **The page reloads by itself** while it is on screen when a session ends (`SessionCompleted`) or an
> import adds games (`LibraryChanges` — navigating to the page already on screen does nothing in WPF UI 4.3.0, so an
> import from the menu never showed until the page was left). **Import** (FR-1.2): the games already in the library — at
> this path or under another drive letter — are hidden by default (*Show the N games already in the library* brings them
> back, dimmed), and a row that cannot be imported has its box disabled; the XAML comment said "cannot be ticked" while a
> tick was taken and ignored. Tests: `GamesViewModelTests`, `ImportLibraryFlowTests.RefreshOffersOnlyNewGamesAndSaysWhenThereAreNone`,
> `…GamesAlreadyInTheLibraryAreHiddenUntilAskedFor`, `PagesLoadTests.TheLibraryGridFillsItsWidthAndTheListViewReplacesIt`,
> `…TheImportChecklistRendersWithTheExistingRowsShown`.
>
- **Game detail:**
- Header: cover, name, publisher, version, platform, engine+version, API + Present Mode of last session, `FpsReadout` (lifetime avg), TriState chips, Edit button.
- Header: cover *(built in beta.23, the note below)*, name, publisher, version, platform, engine+version, API + Present Mode of last session, `FpsReadout` (lifetime avg), TriState chips, Edit button.
- **Two clearly separated rows** (`05_DETECTION` §Capability hints — conflating these was the old design's core mistake):
- **Supports** — greyed capability chips from files on disk ("Supports DLSS-G", "Supports XeSS"). Static inference.
- **Supports** — greyed capability chips from files on disk ("Supports DLSS-G", "Supports XeSS"). Static inference. With none: *not scanned yet* until the Agent's sweep has read the executable, then *none found* (beta.21 — it read "not scanned yet" for every game that ships none of the files).
- **Last session measured** — accent chips with real values ("DLSS Quality · 1440p → 2160p", "Frame Generation DLSS-G ×1.9", "Ray Tracing: Yes"). Measured.
- **Hooking control** (`ui:CardControl` with `ToggleSwitch`): off by default. Turning it on opens the consent dialog (FR-2.1). When the static anti-cheat pre-scan blocked it, the switch is **disabled** with the reason shown inline and no way to force it. When auto-disabled after crashes, an `InfoBar` explains and offers manual re-enable.
> **What opening the page and choosing a session cost, beta.23 (owner request 2026-10-14; `spike-notes` §21).** The
> Sessions grid is bounded (`MaxHeight` 520, as Compare's list is): inside the page's own scroller it was measured with no
> height limit and built every row — 100 sessions were 100 rows of 17 columns, 1.2–1.5 s to open the page; it builds the
> rows on screen now, scrolls itself, and hands the wheel to the page at its ends
> (`PagesLoadTests.TheSessionsGridBuildsTheRowsOnScreenAndHandsTheWheelOnAtItsEnd`). A session's series is read and
> decoded on the thread pool — Microsoft.Data.Sqlite completes its asynchronous calls synchronously, so the decode of a
> two-million-frame session ran on the UI thread whatever `ConfigureAwait` said — and what the charts derive from the whole
> session (one sort of its frames where the Distribution tab did three, the histogram, the percentile curve, the presents
> line) is worked out there once (`Charts.SeriesDigest`): choosing such a session froze the window 0.8–1.0 s, 17 ms now.
> Whether the executable is on disk is asked off the UI thread, as the library page has asked since beta.19.
> **The header's cover, built in beta.23 (owner decisions D60/D61, request 2026-10-14) — never before: the line above said
> "cover" from the first draft and nothing drew one.** The image the user chose (Edit… ▸ *Choose image…*, a PNG copy ≤ 1200 px
> in the data folder's `covers\game-<id>-<unix ms>.png`, `games.cover_path` relative to the data folder; *Use the store's
> image* drops it), else what the app of the store that installed the game keeps on this PC — Steam's
> `appcache\librarycache\<appid>\` (its files flat or in hash-named folders: `library_600x900.jpg` / `library_capsule.jpg`,
> `library_hero.jpg`, `header.jpg` / `library_header.jpg`) and GOG GALAXY's `webcache\<user>\gog\<productId>\`
> (`*_glx_vertical_cover.webp`, `*_glx_bg_top_padding_*.webp`). Which store installed the game is asked of the stores' own
> records, as Play asks (`StoreRecords.Owning`, D59) — Steam's and GOG's only, cached two minutes; nothing is downloaded
> (`privacy.online_metadata` stays reserved). The page: a band (`ArtBand`, rounded) holding the banner (`ui:Image`, as tall
> as its proportions make it, ≤ 240, fading into the band through an alpha mask set in code) above the usual header with the
> cover beside the name (120×180, or 230×107 for a landscape header); a game with no artwork shows no band. No text is
> drawn on a picture. **The band's colour** (`Controls.ArtTint`, D61): the cover's — else the banner's — dominant colour (`Services.ColorMath`: a
> hue histogram of a 48-px copy, vivid pixels weighted, a grey picture none) over the card's fill at the strongest opacity
> — ≤ 30 % on a dark theme, ≤ 22 % on a light one — at which primary and secondary text keep 4.5:1, tertiary 3:1, and the
> pills' and the warning's text 4.5:1 on their fills; recomputed through a resource reference when the theme changes;
> untinted with the option off, a grey picture or high contrast. Everything is read and decoded on the thread pool
> (`Services.GameArt`; the twelve newest images kept); the text shows first and the picture when ready. A chosen image's
> path is followed only when it is one of these names in the data folder's `covers`, and never through a junction or a
> symbolic link — a viewer's copy (D52) could name a share, or hold a link to one. Settings ▸ Games: *Show game artwork* (`ui.game_art`) and *Colour the game page from its artwork*
> (`ui.game_art_tint`), both on. Tests: `GameArtTests`, `CoverStoreTests`, `ColorMathTests` (the hardest colours in both
> themes against the tests' own WCAG), `EditGameViewModelTests`, `PagesLoadTests.EveryTextIsReadableInBothThemes` (the
> surfaces' game page has artwork), `…TheArtworkBandFollowsAThemeSwitch` and `…TheGamePagesArtworkIsDrawn` with
> `AccessibilityTests.NoStyleOfAWpfUiControlLeavesOutItsTemplate` (the cover once took its place and drew nothing, a
> `ui:Image` style not based on WPF UI's; caught in a render before it shipped). The library's cards still have no image.
> **Built 2026-09-14 (P3 PR-5): the grid, the detail page's header, the two rows, the hooking control and
> the Sessions tab.** Grid: `ui:CardAction` cards with platform / engine / hooking badges, sessions, playtime,
> last played (the sparkline is PR-6's); search and sort in memory; FR-1.1 by File ▸ Add game…, the page's
> last played (~~the sparkline is PR-6's~~ no sparkline was built — corrected 2026-10-04); search and sort in memory; FR-1.1 by File ▸ Add game…, the page's
> button, or an `.exe` dropped on the page (a `.lnk` needs the shell-link reader, later); FR-1.4 through
> `Wpf.Ui.Controls.MessageBox` with **Keep sessions / Delete sessions too**, revoking consent over the pipe
> FIRST when it was on. Detail: header (name, publisher · version · store · engine, last session's date and
> API, the last hooked session's `FpsReadout`, the three chips resolved with the annotation and the game
> default — `Application.TriState.TriStateResolution`), Edit… (FR-1.3, a `ContentDialog` badging detected
> fields), **Supports** (from `capability_flags`; ~~empty until P4's scan writes it, and the card says so~~ **written by the Agent's detection sweep since P4 PR-1, 2026-09-14** — the rule ids as product names via `CapabilityNames`, "not scanned yet" only until the Agent's next tick) beside
> fields), **the row's executable path under the subtitle and Change executable… since 2026-09-21** (a store import
> guesses the executable and everything downstream is keyed on it; the pick re-points the row, which comes back
> hooking-off and unconsented like a new game, consent revoked over the pipe first, a block never cleared —
> `05_DETECTION` §Library import; **since beta.19 the file dialog opens in the game's own folder** — `GameFolder.StartFolder`:
> the store boundary's install folder (`InstallRoot`), an Unreal package's root above `<Project>\Binaries\Win64`, else
> the executable's folder, and the nearest folder still there when that one is gone; nothing for a drive that is not
> connected, where Windows opens its last folder; owner request 2026-10-12, `GameFolderTests`), **one App per data folder since 2026-09-21** (`Services.SingleInstance`: a named mutex and a named event keyed on a hash of the data directory, claimed in `Program.Main` after Velopack's hooks and before any window; a later start sets the event and exits 0, and the first instance brings its window forward through `ShellHost.Reveal` — from the tray too. Nothing stopped a second App before: the owner's log shows two started 360 ms apart, two tray icons, a second log file. `--diag` never claims), ~~**the guard-bypass switch since 2026-09-21**~~ **withdrawn 2026-09-22** (the card, its dialog, the session mark and the export line are gone; a blocked row's toggle is disabled and `Safety_Blocked_Toggle_Format` is the whole story; a refusal or unhook notice that turned hooking off ends with `Safety_HookingTurnedOff` — `19_SAFETY` §What a finding does to the game), **Supports** (from `capability_flags`; ~~empty until P4's scan writes it, and the card says so~~ **written by the Agent's detection sweep since P4 PR-1, 2026-09-14** — the rule ids as product names via `CapabilityNames`, "not scanned yet" only until the Agent's next tick) beside
> **Last session measured** (upscaler · resolution, frame generation, the non-N/A chips — accent pills, from the
> hooks). Hooking: the toggle is `OneWay` from the row and its command runs `HookingConsent`; a refusal, a
> mismatch or a failure is a persistent `InfoBar` on the page (never a toast); a blocked row disables the
@@ -168,12 +369,130 @@ All screens are `Page`s registered with the navigation page provider and navigat
> with tooltips. Frametime / Distribution / Trend / Sensors / Latency say which build brings them (PR-6, PR-7).
> `PagesLoadTests` loads every page and both control templates under the real theme dictionaries on an STA
> thread, so a binding typo is red in CI rather than a `XamlParseException` at first navigation.
>
> **The recording switch (2026-09-23, FR-1.6).** A `ui:CardControl` **Recording** above the hooking control, its
> `ToggleSwitch` `OneWay` from `games.record_sessions` and its command writing the row through
> `GameLibrary.SetRecordingAsync` — no dialog (it deletes nothing; sessions already recorded stay) and nothing over
> the pipe (the Agent reads the table each tick). Status line *Recorded when it runs* / *Ignored — nothing is
> recorded*; the body says what off means (the program is not watched; a running session stops) and when to use it
> (a utility that starts with Windows). The library card shows **Not recorded** in place of the hooking badge, since an
> ignored program is never hooked whatever its hooking switch says. The hooking control stays independent: a user can
> keep a consent on an entry they stopped recording for a while.
>
> **Anti-cheat games (2026-09-25, beta.8, owner decision).** The Agent pre-scans every library entry now, so the App
> knows which games ship anti-cheat before anyone asks to hook them (`19_SAFETY` §What a finding does to the game).
> The library card says **Anti-cheat** in place of *Hooking off* — the caution fill with primary text, the warning
> qualifier's pair that `ContrastTests` measures in both themes — for an entry that is recorded (*Not recorded* still
> comes first). On the game's page the Hooking card is a switch that could only be refused, so while
> `ui.hide_anticheat_hooking` is on — its default, Settings ▸ Capture *Hide hooking on anti-cheat games* — the card
> and its lines give way to one **Anti-cheat** card: *"Found: {what}. Hooking is off for this game and cannot be
> turned on; its sessions record play time and sensors only."* Off, the card is back with the switch disabled and
> `Safety_Blocked_Toggle_Format` under it. `{what}` is `Services.BlockedReasonText` over the stored
> `Reason|Family|Signal` — *"BattlEye — its module BEClient_x64.dll was loaded in the game"*, *"Easy Anti-Cheat —
> its folder EasyAntiCheat ships with the game"*, *"… is a listed title"*, *"the game's store id … is listed"* —
> and a row stored before that form is shown as it was. The crash auto-disable's re-enable bar is not offered on a
> blocked row: its one action could only be refused. Tests: `GameDetailViewModelTests` (hidden, shown, the card
> pill), `BlockedReasonTextTests`, `PagesLoadTests.AnAntiCheatGamesPageRendersTheFindingInPlaceOfTheHookingCard`.
>
> **D38 (2026-10-03, beta.11): the trial.** *Not eligible: N successful hooked session(s), two are needed* is gone — a
> grant needs no session. The card reads *Exception in force since … — trial: N of 2 good sessions so far* until the
> trial is over, *Not eligible: an exception of this game ended during its trial on …, so none can be made again* after
> a failed one, and *Not eligible now: {family} was not found in the game's folder when it was checked* where the
> tolerant scan found nothing of the family (it used to say the check "could not finish"). The **Anti-cheat** card of an
> eligible game says hooking is off *unless you make a user-mode exception for it (below)* — "cannot be turned on" beside
> a usable *Make exception…* contradicted itself. The disclosure (`ac-exception-dialog/2`) names no session count and
> has a **Trial** paragraph. Tests: `GameDetailViewModelTests.WhyAGameIsNotEligibleIsSaidOnItsPage`,
> `SettingsViewModelTests.TheExceptionOptionIsOffByDefaultAndItsListFollowsTheAgentsColumns`, `AntiCheatExceptionsTests`.
>
> **The user-mode exception (2026-09-26, beta.9, owner decision D33).** While Settings' option is on, a blocked
> game's page shows a **User-mode exception** card with the Agent's answer about it (`Services.ExceptionView` over
> `GameRow.AcException` — the App reads those columns and writes none): *Eligible — no exception made* with **Make
> exception…**; *Checking…* until the Agent has looked at this block; *Not eligible: N successful hooked session(s), two
> are needed*; *Not eligible: the guard also found {family} ({signal})* — Aniimo's *Kernel driver in the game folder
> (NEPKernel.sys)*; *Not eligible: {family} is not user-mode throughout*; and how the last exception ended. **Make
> exception…** opens the exception's disclosure (`AntiCheatExceptionPrompt`, text `Safety_Exception_*` versioned by
> `AntiCheatExceptionDisclosure.Version`, the primary button bound to the ticked *I accept the risk of a ban for this
> game*, Enter = *Keep it blocked*) and then `SetAntiCheatException`; the Agent gathers the facts and grants or
> refuses, and the page says which. An exception in force brings the Hooking card back — even while anti-cheat cards
> are hidden — with its switch usable through FR-2.1's dialog as ever, the finding still under it; **Withdraw
> exception** ends it and turns hooking off. With the option off a kept exception is shown *suspended* and the switch
> is disabled again. The library card says **Exception** for a game carrying one; a hooked session under it is
> *Hooked · exception* in the Sessions tab (the tooltip names the family) and its summary has one line saying so.
> Tests: `GameDetailViewModelTests.AnEligibleGameOffersTheExceptionAndOneInForceMakesTheSwitchUsable`,
> `…WhyAGameIsNotEligibleIsSaidOnItsPage`, `AntiCheatExceptionsTests`.
>
> **Details (2026-09-25, beta.8, schema 0011).** A `ui:CardExpander` **Details** under the two rows, expanded, says
> what the game's files and its store say (`05_DETECTION` §What the files say about themselves): *Runs as* (64-bit
> (x64) · 32-bit (x86) · ARM64 · .NET, any CPU (runs as 64-bit) · …), *File version* and *Product version* (the
> executable's PE resource — for an Unreal title often the engine's), *Store* ("Steam build 20374416", "GOG version
> 1.2.3" — or *Version* when the user typed it), *Engine*, and *Ships with*, one line per capability file: "DLSS:
> nvngx_dlss.dll 3.7.10.0", "XeSS: libxess.dll (no version)". A row the Agent has not read yet says so. The subtitle
> labels the store's version the same way and then drops the bare store name it would repeat. **An executable that
> cannot run as x64** (x86, 32-bit-preferring .NET, ARM) disables the hooking switch with `Hooking_NotX64_Format` under
> it and no re-enable bar — turning it on could only be refused (the Agent refuses `ExecutableNotX64` anyway); a switch
> already on can still be turned off. Tests: `GameDetailViewModelTests.TheDetailsCardSaysWhatTheFilesSayAndAnX86SwitchCannotBeTurnedOn`,
> `FormatsTests`, and the page renders in `PagesLoadTests`. **The Details card's *NVIDIA App override* row** (same day)
> is the newest session that read a driver profile, in the same words; no row where none did. Tests:
> `NvidiaOverridesTests`, `GameDetailViewModelTests.TheDetailsCardNamesTheNvidiaAppsOverridesFromTheNewestSessionThatReadThem`.
> **The *Engine* row carries the version, and an *Engine version* row says what it was read from** (beta.10 for Unreal;
> beta.19 for Unity, Godot and RPG Maker; beta.20 for Ren'Py — `05_DETECTION` §Engine version): the player library, the
> data file's header, a data pack, a core script, the RGSS library `Game.ini` names or Ren'Py's `renpy/vc_version.py`, and
> *Not found in the game's files* once the Agent has
> read such a title and found none. RPG Maker's witness names the maker on the page, the subtitle and the library card
> (*RPG Maker MZ 1.10.0*, *RPG Maker VX Ace (RGSS 3.0.1)*; `Formats.Engine(id, source)`). Tests:
> `GameDetailViewModelTests.TheDetailsCardSaysWhatAUnityGodotOrRpgMakerVersionWasReadFrom`,
> `FormatsTests.TheVersionsWitnessNamesTheMakerAndRgssSaysWhoseNumberItIs`.
- Tabs (WPF `TabControl`, Fluent-styled):
1. **Sessions** — `DataGrid`: date, duration, **tier badge (T1/T2)**, Native, Displayed, FG×, 1% Low, 0.1% Low, resolution + upscaler, max GPU temp, API, chips, ⚠ crash badge, tags. Row → Session summary. Multi-select → "Compare". Tier-2 rows render `—` (not blank, not zero) in Tier-1-only columns, with a tooltip explaining why.
1. **Sessions** — `DataGrid`: date, duration, **tier badge (T1/T2)**, Native, Displayed, FG×, 1% Low, 0.1% Low, resolution + upscaler, max GPU temp, API, chips, ⚠ crash badge, tags. Row → Session summary. ~~Multi-select → "Compare".~~ (not built; Compare's own picker chooses) Tier-2 rows render ~~`—`~~ `N/A` (not blank, not zero) in Tier-1-only columns, with a tooltip explaining why *(corrected 2026-10-04: as built — `—` means a measured none, §FPS display rule)*.
2. **Frametime** — ScottPlot timeline of selected session (decimated), stutter markers, sensor overlay toggle (temp on right axis).
3. **Distribution** — FPS histogram + percentile curve of selected session(s).
4. **Trend** — metric-over-date line (selector: Native avg / Displayed avg / 1% Low / 0.1% Low / max GPU temp), vertical **hardware-change markers** with tooltip "GPU driver 572.16 → 576.02" (FR-6.3).
5. **Sensors** — temp/load/power/VRAM timelines per session; per-process VRAM and adapter-wide VRAM as separate, differently-labelled series.
> **Across sessions, beta.11 (owner decision D39, FR-6.6).** The **Sessions** tab opens with *Sessions at a glance*: a
> `TrendChart` of every hooked session's Presented FPS (sessions that counted no generated frame), Native and Displayed
> (sessions where frame generation was measured — rule 6, never one inflated line) and 1% / 0.1% lows, oldest first,
> partial sessions hollow (`TrendSeriesBuilder.Overview`); a click near a session's points selects it in the grid and
> scrolls to it (`TrendChart.SessionClicked`). Under it, **Delete all sessions…** (FR-1.7) for this game. The **Trend**
> keeps its selector and adds *Also draw*: any other metric ticked is drawn on the same chart, its unit
> (`TrendSeriesBuilder.UnitOf`: FPS, °C, %, W, MB, ×) on the left axis when it is the selected metric's and on the right
> when it is a second one (marked ▸ in the legend); a metric in a third unit cannot be ticked, and when the selected
> metric changes to a third unit only the first ticked unit in the list stays ticked, so every ticked box has its line;
> the selected metric is not offered beside itself. One line alone keeps its name on the axis, as before. After any delete — here or in
> Settings — a summary window still open on a deleted session closes, and File ▸ Export lets go of it (`SessionDeletion`;
> ids are reused once the newest is gone). Tests: `SessionDeletionAndOverviewTests`.
>
> **The display mode, beta.10 (FR-7.4, `03_METRICS` §Display mode).** The **Last session measured** row adds how that
> session was shown — the mode that lasted longest with its share and the window's size (`Display: Borderless 92% ·
> 2560×1440`); the **Sessions** tab has a *Display* column for every session, Tier 2 included (the mode shown longest,
> with a tooltip carrying every share, the changes, the window on its monitor, the back buffer and the witness), `N/A`
> for a session recorded before; the **Trend** has three more metrics — *Exclusive fullscreen share %*, *Borderless
> share %*, *Windowed share %* — over every session whatever its tier, never left out as a mid-session change (a mode
> switch resizes the swap chain, and the share is what that switch was), with no exclusive or borderless point for a
> session that had any time nothing could split (`Services.DisplayText`, `Charts.TrendSeriesBuilder.DisplayShare`).
>
> **The game's own memory, beta.12 (owner decision D43, `03_METRICS` §Game process memory).** Read from outside the game
> once a second in either tier, it is shown wherever a session is (`Services.GameMemoryText`, from the stored columns and
> `sensor_stats_json` — never recomputed). The **Sessions** tab has *VRAM (game)* and *RAM (game)*: the median · the
> peak, in Task Manager's units (MB below 1 GB, GB to two decimals, 1 GB = 1024 MB, `Formats.Memory`), the tooltip
> carrying the mean, the shared GPU memory's peak, the working set's and the commit's peaks, and how many processes were
> added together where an unpinned hold summed more than one. Where Windows did not report the private working set, the
> working set is shown and SAYS so ("(working set)") — never passed off as Task Manager's "Memory". The **Trend** replaces
> *Max VRAM (game)* — which read `vram_proc_max_mb`, a column nothing ever wrote, so it never had a point — with *Median /
> Peak VRAM (game)* and *Median / Peak RAM (game)* in GB, machine metrics that count Tier-2 sessions (the RAM lines are the
> private working set only: a working-set-only session has no point there rather than another quantity on the line);
> *Avg RAM in use* is the whole PC's, now in GB too. **Compare** adds the four as rows that rank nothing — a game that uses
> more of a card it has is not worse. The **Sensors** tab and the summary's Sensors section draw two memory plots in GB:
> *Video memory (VRAM)* — this game's dedicated and shared beside the whole graphics card's — and *Memory (RAM)* — this
> game's private working set (or its working set, labelled) beside the whole PC's; this game is one colour on both. The
> **summary** adds two cards, *VRAM (this game)* and *RAM (this game)* — the median, with "median · peak … · shared …" /
> "… · commit …" beneath — and a table, **Statistics per series**: every stored series' mean, median, minimum, peak and
> number of readings, each in its own unit (`Services.SensorStatsTable`); a session recorded before beta.12 shows one
> sentence instead of the table. The **live card** shows "This game: VRAM … · RAM …" from the newest tick, a held session
> included, and the CSV gains the `# game_memory:` header line. Tests: `GameMemoryTextTests`,
> `SessionSummaryViewModelTests.TheGamesMemoryAndTheStoredStatisticsAreShownForASessionThatWasNotHooked`,
> `TrendSeriesBuilderTests`, `CompareViewModelTests`, `ChartMathTests.TheMemoryPlotFallsBackToTheWorkingSetUnderItsOwnName`,
> `LiveCaptureViewModelTests`, `SessionExporterTests`.
5. **Sensors** — temp/load/power/VRAM timelines per session; per-process VRAM and adapter-wide VRAM as separate, differently-labelled series. Since beta.12 two memory plots in GB: *Video memory (VRAM)* (this game's dedicated and shared, the whole graphics card's) and *Memory (RAM)* (this game's private working set, the whole PC's).
6. **Latency** *(Tier 1 + Reflex only)* — PC latency timeline, avg/p95.
> **Built 2026-09-14 (P3 PR-7): tabs 2–6.** Frametime and Distribution show the session selected in the
@@ -184,14 +503,87 @@ All screens are `Page`s registered with the navigation page provider and navigat
> GPU °C), FR-6.4's exclusion of `settings_changed_midsession` sessions by default with the toggle and the
> excluded count, and FR-6.3's markers — labelled dashed lines wherever two consecutive sessions' hardware
> snapshots differ in GPU driver, GPU, CPU, display mode or OS ("GPU driver: 572.16 → 576.02"). **Sensors**:
> GPU core / hotspot °C, load % and power W (right axis) on one plot; VRAM on another with the game's own
> per-present `vram_proc` (a held 1 Hz sample) and the adapter-wide `vram_adapter` sensor as two
> differently-labelled series. **Latency**: the `latency_us` blob with the stored avg / p95 lines, shown only
> when Reflex reported (`reflex_active`); otherwise the tab says so.
> GPU core / hotspot °C, load % and power W (right axis) on one plot; VRAM on another with ~~the game's own
> per-present `vram_proc` (a held 1 Hz sample) and~~ the adapter-wide `vram_adapter` sensor ~~as two
> differently-labelled series~~ (corrected 2026-10-03: the Overlay never produced `vram_proc`, so the game's line was
> never drawn on any session; beta.12's two memory plots are described above). **Latency**: the `latency_us` blob with the stored avg / p95 lines, shown only
> when Reflex reported (`reflex_active`); otherwise the tab says so. **Since beta.14 the tab itself is shown only when one
> of the game's sessions measured latency** (`GameDetailViewModel.AnyLatency`): nothing measures Reflex today, and a tab
> that could only say "no data" was noise.
>
> **Trend, beta.14 (D49):** nine more metrics — *Time below 60 FPS %*, *Display under refresh rate %*, *Frame to frame
> ms*, *Render scale %* (`100 / upscale_ratio`), *VSync share %* and *Frames per watt* from hooked sessions; *Avg GPU core
> clock MHz*, *Max GPU memory °C* and *Held back by power limit %* from every session's telemetry. Each has its own unit
> (ms, MHz and FPS/W are new axes); a session recorded before beta.14 has no point (`TrendSeriesBuilderTests`).
>
> **Trend, corrected 2026-09-25 (beta.8, owner item 6: "does Trend really work?").** It did not, on first open: the
> view model started loading before the page existed, and a load that finished first raised `TrendPresented` to nobody
> — the tab was blank until something reloaded it. The page now draws what the view model holds when it is made
> (`PagesLoadTests.TheTrendIsDrawnWhenThePageIsMadeOnADateAxisThatKeepsItsLabel`). Also: the date axis is created
> BEFORE the theme and the label (`DateTimeTicksBottom` replaces the bottom axis, and made afterwards it dropped both);
> **Average is two metrics** — *Presented FPS* on sessions that counted no generated frame (never on one that did: its
> presented rate includes them, the single inflated number rule 6 forbids) and *Native FPS* where frame generation was
> measured — and the trend opens on Native when the newest measured session counted generated frames; the machine
> metrics count **Tier-2 sessions too** (a game never hooked had no trend); a point that describes part of its session —
> settings changed, or a steady state, for Native and Displayed as well as the factor — is drawn **hollow** and the
> note says so; hardware changes on one day are **one** marker; the metric list is built in the language the page opens
> in; the empty text names the metric.
>
> **FPS with two decimals (same day, owner item 7).** Settings ▸ Window: *Show FPS with two decimals*
> (`ui.fps_decimals`, off by default) — every FPS figure through `Formats.FpsNumber`: "62.40" when on, "62" when off,
> rounded half away from zero both ways (it rounded half to even). `Services.FpsDecimals` holds it for the process
> like `LoggingLevel`: read at start, moved at once by the toggle, shown by a page the next time it formats.
>
> **Rule 6, the places that dropped the share (same day).** A steady-state factor is never shown without its share:
> the readout line ("58 → 116 FPS (×2.0 FG · 75%)"), which the Average card and Compare use, and the Sessions grid's
> FG× column ("×2.0 · 75%"). The header's "Lifetime average" was the last measured session's readout and says so now.
>
> **Compare (same day).** The best cell is in the accent colour — a local `Foreground` on the cell outranked the
> trigger, so it was only ever bold — and "best" is the best as shown (62.4 and 62.3 both read 62, both best); the load
> rows rank nothing; the percentile axis is 0–100 again (`AutoScale` ran after `SetLimitsX` and undid it); exported
> PNGs have an opaque background (`ChartTheme.SavePng`: the window's colour under the transparent figure).
> **Play, beta.21 (owner decision D59: "1: press Play → the platform opens → it runs; 3: it runs at once; let me switch
> between the two").** A **Play** button heads a game's page (before Edit…, Primary) and sits on each library card's
> corner — over the card, not inside it, so the card stays one button — and in the list's first column. **Settings ▸
> Games ▸ Play button** (`ui.play_mode`): *Through the store* (the default) hands the game to the app of the store whose
> own records name its folder — the records the import reads (`Application.Play.StoreRecords`; the row's `platform` is not
> trusted, detection may have rewritten it while `store_id` stayed the importer's) — Steam `steam://rungameid/<id>`, the
> Epic Games Launcher `com.epicgames.launcher://apps/<ns>%3A<item>%3A<app>?action=launch&silent=true`, GOG GALAXY
> `GalaxyClient.exe /command=runGame /gameId=<id> /path="<folder>"`, the itch app `itch://install?game_id=<id>&launch`
> (`StoreLaunches`: the forms the stores' own shortcuts and code use, measured on the owner's PC except Epic's; every id
> checked against its store's shape before the shell gets it). No store, GOG without GALAXY, or the App itself running as
> administrator: the agent starts the game instead, and the notice says why. *Start directly* sends `LaunchGame` (launch
> mode): recorded from the first frame, never as administrator, refused for a recording-off entry. A viewer's (D52) Play is
> off and its composition holds no `ShellStarter`. Tests: `StoreLaunchesTests`, `StoreRecordsTests`, `GamePlayerTests`,
> `ViewerModeTests`.
### Session summary (secondary `FluentWindow`, also the post-session toast target)
Stat cards (Avg uses `FpsReadout`, Median, 1% Low, 0.1% Low, Min/Max, σ, stutter %, duration), TriState chips, API/PresentMode/upscaler line, crash `InfoBar` (Severity=Error) when `crashed`, frametime chart, sensor strip, tags/notes editor, Export buttons.
Stat cards (Avg uses `FpsReadout`, Median, 1% Low, 0.1% Low, Min/Max, σ, stutter %, duration, **Display** — beta.10: the mode shown longest with its share and the window's size, both tiers; **VRAM (this game)** and **RAM (this game)** — beta.12: the median with the peak beneath, both tiers), **Statistics per series** (beta.12: every stored series' mean / median / minimum / peak), TriState chips, API/PresentMode/upscaler line, **the display line** (beta.10: every mode's share, the changes, the window on its monitor at its refresh rate, the back buffer and swap effect, and what the facts rested on — "the swap chain said whether it was exclusive" or "from the window alone: exclusive fullscreen cannot be told from borderless"; absent for a session recorded before), crash `InfoBar` (Severity=Error) when `crashed`, frametime chart, sensor strip, tags/notes editor, Export buttons.
> **beta.14 (D49): the new measurements, as cards and charts.** The cards come in three methods (`AddFrameCards`,
> `AddPacingCards`, `AddMachineCards`), every value read from the row — never recomputed — and N/A on a row written before
> beta.14:
> - **Time below 60 FPS** with *below 30* and *display under {refresh} Hz* beneath it — the refresh share named for the
> display because it is over the presents the display received (`03_METRICS` §Pacing) — and **Frame to frame**; both
> carry *(presented)* where the session's statistics are over presents, as the lows do.
> - **VSync** (*{share} of frames*, with *tearing allowed* beneath), **Ray tracing** (*{share} of frames* and rays per
> pixel — the card appears only where ray tracing was measured), **Game in focus** (foreground ticks over drain ticks)
> and **Capture quality** (gaps · lost records · faults).
> - The **1% Low** card carries *displayed: {presents' 1% low}* beneath it where frames were generated (rule 6: beside the
> game's own, never instead of it).
> - **GPU clocks** (core · memory, with fan and memory temperature beneath), **GPU held back** (power · heat, NVIDIA only)
> and **Frames per watt** (*the game's own frames, GPU power only*).
>
> Charts: **Render scale** under Distribution (`Charts/RenderScaleChart` over `RenderScaleSeries`: `100 × √(render pixels /
> output pixels)` as steps — from the `render_res` blob where the resolution varied, a flat line at the row's extent where
> it did not, and a sentence where the upscaler's parameters were never measured), and on **Sensors** the card's memory
> temperature on the temperatures plot (its own palette colour, `Chart_SensorTertiary`: no existing one was 60 apart from
> all six beside it) and a fourth plot, **Clocks and fan** — core and memory clock in MHz, the fan in RPM on the right, and
> the ticks its power limit or heat held it back shaded behind them; collapsed when the session stored none of these.
> Tests: `SessionSummaryViewModelTests` (the new cards, a row before beta.14 at N/A, the displayed low),
> `RenderScaleAndClocksTests`, `ChartMathTests`.
>
> **Built 2026-09-14 (P3 PR-6).** `Windows/SessionSummaryWindow` (a secondary `FluentWindow` with its own
> `ContentDialogHost`), opened from a Sessions-tab row (double-click or Open) and from the Dashboard's recent
> list. Stat cards read the STORED aggregates — never recomputed — with the lows labelled *(presented)* when
@@ -207,14 +599,77 @@ Stat cards (Avg uses `FpsReadout`, Median, 1% Low, 0.1% Low, Min/Max, σ, stutte
> has no per-frame source yet), the segment ribbon as alternating spans when there is more than one segment,
> and GPU temperature / load on the right axis behind the sensor toggle; `DistributionChart` draws the FPS
> histogram and the percentile curve (`Domain.Metrics.Percentile`, so the two lows are two points on it).
>
> **Honest charts, 2026-09-25 (beta.8, owner item 8: "fix the charts that are not reasonable").** Measured first on the
> owner's own Onimusha demo capture (DLSS FG ×3, read from a copy of the ledger): the title submits each generated frame
> half a millisecond after its application frame, so the "native" series — each application frame's interval to the
> present before it — was a generated frame's half millisecond, and the stored median read 2,073 FPS on a 60 FPS game.
> What changed, each with a test (`SessionSeriesLoaderTests`, `ChartMathTests`, `PagesLoadTests`):
> - **One stream.** `SessionSeriesLoader` charts the swapchain the statistics are over (`SegmentBuilder.DominantStream`,
> identified first, then the most presents) — the stored intervals are per swapchain, and two streams interleaved on
> one axis drew neither — with that stream's segments; the CSV export is the same stream (its header says so).
> - **Application frame to application frame.** The default series is each application frame's time from the previous
> application frame, the generated presents between them adding their intervals to it; a gap breaks the chain. It is
> labelled *Application frames* where frame generation was counted and *Presents* where it was not — never "Native"
> alone. A session whose presents were all generated (the `no_evaluations` refusal) charts every present and says so.
> - **The every-present line** (FR-5.4's toggle) leaves out the presents after a gap, which were drawn as 0 ms frames,
> and a note says what it is not: presents are timed at submission, and a burst of generated frames is not the
> display's cadence.
> - **Segments are labelled** with their settings (upscaler, render → output, frame generation) where the segment is
> wide enough; the label was computed for every segment and drawn for none.
> - **The sensor overlay is in step.** Schema 0013's `frame_blobs.first_present_ms` says where the first present sits on
> the sensors' clock; the overlay was drawn tens of seconds early (the launch and the loading screen). A session
> recorded before keeps the overlay off rather than drawn out of step; gaps are still closed up on the frame axis, and
> the note says how many when the overlay is on.
> - **Distribution.** The histogram is binned over the 0.5th–99.5th percentile, not min–max (one 0.3 ms non-frame set the
> axis to thousands of FPS), with the frames outside counted in a note, and its bars sit on their bins' centres (they
> sat half a bin left: ScottPlot's bins are lower edges). The percentile curve is drawn only where ten frames lie
> beyond a percentile on each side — FR-4.8's rule, generalised — so its 1% and 0.1% lows are marked exactly where
> the stat cards publish them, and the single shortest interval no longer sets the axis; the 0–100 axis holds.
> - **Sensors** (the tab and a new section of the summary window): power on a watt axis at the right, the second
> plot is *Memory* (the game's VRAM, the adapter's, the system's RAM), ~~a per-present VRAM of 0 is a present the sample
> did not reach and is left out~~ (corrected 2026-10-03: there was no per-present VRAM to draw — the Overlay never
> produced it; beta.12 replaced the plot with two, above), the time axis says where its zero is, and every line has its own colour in both
> themes (the light theme drew power and CPU temperature in one gold). **A session that was not hooked charts its
> sensors** — kept since 2026-09-22, shown nowhere until now.
> - **The game page follows the Agent while it is shown**: a `SessionCompleted` for this game reloads it
> (`GameDetailViewModel.Attach` / `Detach` on the page's Loaded / Unloaded; the link is a singleton and must not hold the
> page). Its sessions, trend and header were the ones it opened with.
> **FR-5.3:** `Charts/Decimator` — every bucket's min and max in order, ≤ 4000 points per series per draw, a
> 500k-point series keeps its spike and its dip (`DecimatorTests`). Zoom and pan are ScottPlot's.
> **FR-9:** `SessionExporter` — the CSV with `03_METRICS` §Export schema's column line verbatim and the `#`
> header block (tier, api, hardware, the tri-states with sources, the segments, the 1 Hz VRAM note),
> header block (tier, api, hardware, the tri-states with sources, the segments, ~~the 1 Hz VRAM note~~ — since beta.12
> the `# game_memory:` line, and a note that `vram_mb` is the in-game figure this build does not produce),
> InvariantCulture throughout, no rows for Tier 2; the JSON (`frameledger-session/1`: metadata, the row as
> aggregates with N/A omitted, segments, the annotation); PNG through `Plot.SavePng`. Tags (comma-separated,
> de-duplicated) and notes save to the annotation row. **FR-3.8** is an in-app notice on `SessionCompleted`
> (saved / discarded); the tray toast with "View" arrives with the tray (PR-8).
>
> **The loaded libraries (2026-09-25, beta.8).** Under the hardware line, a Tier-1 session says what it had loaded —
> `sessions.runtime_modules`, written since P2 and shown nowhere until then — sorted, one line: *"Loaded:
> nvngx_dlss.dll 310.2.1.0 (the game ships 3.7.10.0: another copy was loaded, for example by the driver or the NVIDIA
> App) · sl.interposer.dll 2,8,0,0"*. The comparison is with the game's own copy (`games.library_versions`) as the
> same four numbers (`Formats.SameVersion`: Streamline's `2,8,0,0` string equals `2.8.0.0`); it names a difference and
> never who made it. Older rows show their list the day this ships; a Tier-2 row has none and no line.
>
> **The NVIDIA driver's side (2026-09-25, beta.8).** Two more lines where they have something to say
> (`Services.NvidiaOverrides`): the driver profile the game ran under and what it overrides — *"NVIDIA profile “Clair
> Obscur: Expedition 33”: DLSS override (preset K, Quality) · Frame Generation override (×4, latest preset)"*, or "no
> DLSS or frame generation override", or the global profile's when none names the game — and what the driver
> reported applying in the game's process from its override bits (*"NVIDIA driver, for this game's process: DLSS DLL
> chosen by the driver · preset K · Quality"*). Smooth Motion is labelled a setting community tools document, not
> NVIDIA. Neither line is a measurement (`03_METRICS` §Upscaling); a machine without an NVIDIA driver shows neither.
>
> **How it ended, and why (2026-09-25, beta.8, owner item 5).** Under the header line, *"How it ended: …"*
> (`Formats.ExitText`): a crash names its exception ("crashed (0xC0000005 access violation)", "0xC0000006 in-page I/O
> error: a disk or drive failed while the game read its files"), End task's exit code is an ordinary end said as
> what it is, and the event log's witness is named as such. The Tier-2 sentence has words for **every**
> `SessionEndReason` (`Formats.EndReasonText`, an enum-walk test keeps it so) and for every refusal no anti-cheat
> family names (`Formats.GuardSentence`: "The anti-cheat guard did not hook this game: the game is 32-bit…") — the
> safety notice and the enable-time refusal use the same words instead of "<signal> was detected in this game"; a
> launch that could not start says Windows' reason. The game page's missing-executable bar says whether the **drive**
> is not connected (FrameLedger finds the game again when it is) or the file is gone from its path, and so does the
> notice when enabling hooking meets an unreadable executable. Tests: `ReasonTextTests`, `Tier2ReasonTests`.
### Compare
Session picker (2–5, cross-game allowed) → overlaid percentile curves + stat table with best-value highlighting; FG columns always show Native and Displayed separately. Export PNG.
@@ -230,6 +685,16 @@ Session picker (2–5, cross-game allowed) → overlaid percentile curves + stat
> separate rows (never one column), Median, the lows, stutter time %, max GPU °C, duration — with the best
> value of each row bold and accent-coloured (higher wins for FPS, lower for temperature and stutter; N/A is
> never best), and a Tier-2 session's cells at N/A. Export PNG through `Plot.SavePng`.
>
> **beta.10:** three rows after Duration — *Display mode* (every share), *Window* and *Monitor* (with its refresh
> rate) — facts, not scores: no mode is better than another, so none is ever marked best, and every tier has them.
>
> **beta.14 (D49):** *Time below 60 FPS* and *Frame to frame* (lower is better), *Display under refresh rate* (lower is
> better), *VSync share* and *Render scale* (settings: no best), *Avg GPU core clock* and *Held back by power limit*
> (facts: no best), *Max GPU memory °C* (lower) and *Frames per watt* (higher). **A statistic a present-only session has
> over its presents carries *(presented)* in its cell** — the median, the lows, stutter, time below 60, frame to frame —
> beside a session whose same statistic is over the game's own frames; the best is decided on the number, never the label
> (`CompareViewModel.Row`'s label, `CompareViewModelTests`).
### Logs
Tail view of `ui-*.log` / `agent-*.log` (toggle), level filter, search (`ui:AutoSuggestBox`), pause-scroll; buttons: Open logs folder, Export bug bundle (routes to 10_LOGGING flow).
@@ -238,21 +703,69 @@ Tail view of `ui-*.log` / `agent-*.log` (toggle), level filter, search (`ui:Auto
> (App / Agent) read with `FileShare.ReadWrite` — Serilog keeps it open — capped at the last 2 MB with the partial
> first line dropped, refreshed every 2 s while the page is on screen (the page's Loaded/Unloaded start and stop
> the timer) and never while paused; the level filter reads the `[HH:mm:ss.fff LVL]` prefix of 10_LOGGING's
> template (continuation lines such as stack frames keep only under All); the search is a plain `ui:TextBox`, not
> template ~~(continuation lines such as stack frames keep only under All)~~ — the App's; *(corrected 2026-10-04: the
> Agent writes Serilog's default template, a date first, which the filter did not read, so Warning and Error showed no
> Agent line; since beta.12 `LogTail.LevelOf` reads both)* — continuation lines such as stack frames keep only under All; the search is a plain `ui:TextBox`, not
> an `AutoSuggestBox` — there is nothing to suggest. The view is a read-only `TextBox` in Consolas that scrolls to
> the end on every refresh unless paused. "Export bug bundle" is 10_LOGGING's step 2 and nothing more (see there).
> The status line says shown / total / file. Tests: `LogTailTests`, `LogsViewModelTests`, and the page renders in
> `PagesLoadTests`.
### Settings
> **beta.23 (owner decisions D60/D61).** The Games section has, under the Play button, **Show game artwork**
> (`ui.game_art`, on) and **Colour the game page from its artwork** (`ui.game_art_tint`, on; disabled while the first is
> off) — the game page's artwork and its band's colour (§Games › Game detail, *The header's cover*). Neither downloads
> anything; the App reads both at each page load, the Agent neither.
>
> **beta.14 (owner request 2026-10-05: "an option to hide the scroll bars but still scroll").** The Window section has
> **Hide scroll bars** (`ui.hide_scrollbars`, off by default). A bar's visibility is bound inside its scroller's template,
> which no style reaches, so `Services.ScrollBarHiding` sets the scrollers themselves: ~~one class handler on
> `ScrollViewer`'s Loaded (registered at start beside `DialogKeyboard`) reaches every scroller the App shows~~ class
> handlers on `ScrollViewer`'s ScrollChanged and Loaded (registered at start beside `DialogKeyboard`) reach every scroller
> the App shows *(corrected 2026-10-07, beta.17, the owner's screenshot of the Dashboard with its bar: WPF raises Loaded
> only where a subtree listens for it with a handler of its own, and a class handler is not one — `16_WPFUI_SYNTAX`
> §Gotchas. Settings, full of toggle switches whose template listens, lost its bar; the Dashboard, the first run, About,
> the user guide and a game's wide sessions table kept theirs. Every scroller raises ScrollChanged from its first layout)*,
> those inside a DataGrid, a TextBox, a rendered document and a dialog included. While on, an axis that is `Auto` or `Visible` becomes
> `Hidden` — WPF's "no bar, still scrolls": wheel, keyboard and touch — and its own value is kept on it; a `Disabled` axis is
> never touched (it lays its content out at the viewport's width). The toggle applies to the open windows at once, and off
> puts every kept value back. Tests: `ScrollBarHidingTests` (on hides every bar and the wheel still scrolls; off restores
> each; a scroller that loads later follows; since beta.17 a scroller laid out with no Loaded at all, and every page,
> window and dialog shown in a real window with the option on), `SettingsViewModelTests.HidingScrollBars…`.
> **beta.11 (owner request 2026-10-03: "remove the Settings rows that have no button or similar").** Every row has a control
> now: the *Games with hooking on* card shows only while a game has hooking on (its empty sentence is gone); the *Elevation*
> card is gone and its state is the third line of *Run the agent as administrator* (its explanation a tooltip on it); the
> sentence under the language row is gone. A **Data** section has one row, **Delete all sessions…** (FR-1.7): the
> confirmation names how many, the Agent deletes them (`DeleteSessions`), and the strip says what happened or why nothing
> was deleted (a session being recorded, no agent, an older agent). Tests: `SettingsViewModelTests.DeleteAllSessionsAsksWithTheTotalThenGoesThroughTheAgent`.
> **Since beta.19 (D55) the Data section's first row is *Remove uninstalled games*** (`retention.remove_uninstalled_games`,
> on by default, off in a viewer like every setting the Agent reads): its strip says the Agent reads it within 15 seconds
> (`Settings_RemoveUninstalled_Applied`), not at the next session — the detection sweep reads it at every pass. Tests:
> `ViewerModeTests.EverySettingTheAgentReadsIsOffInAViewer`, `GuideDocumentsTests.TheSettingsPageOfTheGuideNamesEverySetting`.
Sections per FR-10 using the WPF UI settings idiom: `ui:CardControl`/`ui:CardExpander` rows with `ToggleSwitch`, `ComboBox`, `ui:NumberBox` (numeric inputs — min session length, sensor interval, retention). Language switch applies immediately (09_I18N). Theme selector (Light/Dark/System) drives `ApplicationThemeManager` (16 §Theming). **Capture section (top, most important):** the global **hooking kill switch** (`ToggleSwitch`, prominent) with a one-line summary of what it does; a list of games currently hook-enabled with a per-game revoke; Vulkan layer registration state + Register/Unregister; a link to the safety documentation. Turning the global switch off must take effect immediately, including for the Vulkan layer.
Agent section: elevation state with a plain explanation of what elevation *optionally* unlocks (CPU temperature, elevated-game attach — ~~ETW fallback~~, which no longer exists) and that it is **not required by any capture tier**; task state, Register/Repair/Remove task, "Start agent at logon", background capture toggle. Privacy: online-metadata opt-in with plain-language explanation. Legal: reopen documents.
**System (2026-09-21, FR "show the user's hardware"):** a card above Legal stating this PC as a session's hardware snapshot would record it right now — processor, graphics card, graphics driver, memory, Windows build, primary display — through the same `IHardwareSnapshotSource` the Agent stamps sessions with, read on the thread pool when the page opens, a field that could not be read as N/A, with **Copy** (the same lines as text) and a note that nothing is sent anywhere and what CPU temperature needs. Its own `SystemInfoViewModel`, not `SettingsViewModel`'s. The same snapshot is one tertiary line under the session summary's header (it was loaded for the export and shown nowhere), and `--diag` prints it; the bug bundle's `sysinfo.json` is deliberately NOT given it — its keys are the issue link's prefill.
Agent section: elevation state with a plain explanation of what elevation *optionally* unlocks (CPU temperature, elevated-game attach — ~~ETW fallback~~, which no longer exists) and that it is **not required by any capture tier**; task state, Register/Repair/Remove task, "Start agent at logon", ~~background capture toggle~~ *(removed in beta.12 — nothing read it; corrected 2026-10-04)*. ~~Privacy: online-metadata opt-in with plain-language explanation.~~ *(Not shown since 2026-09-16: no code makes the request and `privacy.online_metadata` stays reserved — the built Settings below; struck 2026-10-14.)* Legal: reopen documents.
> **The admin mode, beta.10 (owner decision D34; `01_ARCHITECTURE` ADR-9).** The Agent section has a switch, *Run the agent
> as administrator* (`capture.run_elevated`, off by default). Turning it on opens a `ContentDialog`
> (`Services.AgentAdminPrompt`, text `FrameLedger.Shared`'s `Safety_AdminMode_*`, version `agent-admin-dialog/1` in its
> corner) whose primary button is enabled only by ticking "I understand…" and whose default button keeps standard rights;
> declined, nothing is written. Either way the row is written and the Agent restarts — asked to stop over the pipe, its
> instance lock waited out, the connection's next round starting it the new way — **except under a running session**,
> which the restart would end: then the snackbar says the change applies at the Agent's next start. The elevation line
> says why a standard user's Agent is one when Windows was asked (`HelloAck.ElevationOutcome`: declined, answered by
> another account, could not start), and while the prompt waits the status pill reads *Waiting for administrator
> permission* (`AgentConnectionState.Elevating`).
> **Built 2026-09-14 (P3 PR-8a), with three rows deferred to PR-8b and one to PR-9.** `SettingsViewModel` over
> `Application.Settings.RegisteredSettings` (the registry of `06_DATA_MODEL` §Settings registry — every write is
> one `settings` row, and a key the Agent reads gets the 4 s "Applied. The capture agent reads it at the next
> session start" line, D16). **Capture, first:** the kill switch as a `CardExpander` whose header is the toggle
> session start" line, D16 — but for turning the kill switch on, which says a game being measured stops at its next
> safety scan, within 30 seconds: beta.18; until then it said the next session start). **Capture, first:** the kill switch as a `CardExpander` whose header is the toggle
> and whose state line says "All hooking is off" / "Per-game settings decide" — it is `hooking.kill_switch`, the
> gate's fourth input (`CaptureSession` consults it at every 30 s re-scan, so a running measured session stops at
> its next scan; nothing else needs pushing); the hook-enabled list is `games.hook_enabled` as the ledger has it,
@@ -263,14 +776,16 @@ Agent section: elevation state with a plain explanation of what elevation *optio
> `19_SAFETY_AND_ANTICHEAT.md` at the public repository in the user's browser (nothing is fetched).
> **Recording:** minimum session length, sensor interval and raw-series retention as `ui:NumberBox`es bounded by
> the registry; a value outside the range is refused in place (the previous value comes back, a warning names the
> range, nothing is written); background capture as a toggle with the honest sentence (recorded, measured only if
> hook-enabled and not Vulkan). **Agent:** the elevation state from `HelloAck.Elevated` with the paragraph above
> range, nothing is written); ~~background capture as a toggle with the honest sentence (recorded, measured only if
> hook-enabled and not Vulkan)~~ *(removed in beta.12, 2026-10-04: the toggle wrote `capture.background`, which no Agent
> code read, so turning it off recorded every game anyway; with no way to start a game from the App, "off" could only
> have meant recording nothing. The key is reserved — `06_DATA_MODEL` §Settings registry)*. **Agent:** the elevation state from `HelloAck.Elevated` with the paragraph above
> (not required by any tier; unlocks CPU temperature through PawnIO and attaching to elevated games); the logon
> task row says the scheduled task arrives with the tray build. **Window:** "Start FrameLedger with Windows" is
> `Infrastructure.Startup.RunAtLogon` — this user's `HKCU\…\Run` value, quoted executable path, never HKLM —
> and the Run entry is the truth the toggle loads from; "Minimize to tray on close" is stored now and honoured
> when the tray exists. **Privacy:** `privacy.online_metadata`, off by default, with the network sentence.
> **Updates:** `update.channel` is read by PR-5's updater (beta = GitHub pre-releases), and `update.auto_check` — the startup check, on by default — sits beside it. **Logging:** `log.debug` moves this app's `LoggingLevelSwitch` at
> when the tray exists. **Privacy:** ~~`privacy.online_metadata`, off by default, with the network sentence~~ — the card is not shown since 2026-09-16 (no code makes the request; the setting stays reserved).
> **Updates:** `update.channel` is read by PR-5's updater (beta = GitHub pre-releases; since beta.14 *Automatic (Beta)* or *(Stable)* first, the default, following the running copy — D47), and `update.auto_check` — the startup check, on by default — sits beside it. **Logging:** `log.debug` moves this app's `LoggingLevelSwitch` at
> once; the Agent has no reader for the key yet, and the row says so. **Legal:** reopen is a "not yet" line
> until PR-9's gate exists. ~~Register/Unregister the layer, Register/Repair/Remove the task~~ — PR-8b, with the
> Agent flags they need. Tests: `SettingsViewModelTests` (seven cases), `RunAtLogonTests` (Infrastructure, under
@@ -286,9 +801,28 @@ Agent section: elevation state with a plain explanation of what elevation *optio
> enforces on its own after every consent change and every sweep — the button is the repair tool, `12_BUILD`
> §The Vulkan layer is not registered at install time); Repair appears
> when the task's action names another path (a moved install). "Minimize to tray on close" is honoured.
>
> **2026-09-25 (beta.8):** Capture gained *Hide hooking on anti-cheat games* (`ui.hide_anticheat_hooking`, on by
> default) between the kill switch and the Vulkan layer row — §Games says what it hides; the game's page reads it at
> each load. It hides a control that could only be refused, never the finding.
>
> **2026-09-26 (beta.9, D33):** Capture gained *Allow hooking in games with user-mode anti-cheat that were measured
> before* (`hooking.usermode_ac_exceptions`, off by default), below the hide switch, and under it the **User-mode
> exceptions** list — the games the Agent found eligible (**Make exception…**), held back only by the session count,
> or carrying an exception (**Withdraw**), each with its finding, its successful hooked sessions and its state; with
> the option off only kept exceptions are listed, *suspended*. *Checking…* shows until the Agent has answered about
> every blocked game, and **Refresh** re-reads the list (the Agent's sweep runs every 15 s). The option is an
> Agent-read key and takes effect at the next session start and command.
>
> **2026-10-03 (beta.11, D38):** the option reads *Allow hooking in games whose only anti-cheat runs in user mode*, and
> its body names the trial. The list shows **only rows with an action** — eligible (**Make exception…**) or carrying an
> exception (**Withdraw**); "held back only by the session count" is gone with the count, and a game that can never
> qualify is explained on its own page. Each row is the game, its finding and its state — the state carries a grant's
> trial (*Exception in force since … — trial: 1 of 2 good sessions so far*), so the separate count line that repeated it
> is gone. **Refresh** shows only while a row is *Checking…*, the one time it can change anything.
### First-run flow
1. Legal Gate (FR-11): four documents, scrollable, links to GitHub-hosted versions, single Accept.
1. Legal Gate (FR-11): four documents, scrollable, links to GitHub-hosted versions, single Accept. **Since beta.12 (D45) Accept covers three** — the EULA, the Disclaimer, the Privacy Policy; the GPL is listed as *your licence*, with a line saying it needs no acceptance (GPLv3 §9), and gets no `legal_acceptance` row (`06_DATA_MODEL`). **Rendered since beta.12** (§Menu, *Documents are rendered*): the Markdown texts drawn, the GPL as written; a link from one document to another the gate shows opens it in the gate; *View on GitHub* opens the document at this build's source, through `IUrlOpener`.
2. Agent setup: runs **unelevated by default** — a short, honest paragraph explains that elevation is optional and unlocks CPU temperature and elevated-game attach. ~~and the Tier-2 ETW fallback. It must be explicit that **without elevation there is no Tier 2**~~ — **struck 2026-08-28: no tier needs elevation, so there is nothing to warn about here.** Capability check results shown afterwards. ~~with Tier-2 availability listed as its own badge~~ — there is no availability to report.
3. Hooking explainer: what Tier 1 vs Tier 2 means — **and it must be explicit that Tier 2 measures nothing**, because the honest version of this screen is the one where a user who declines knows what they are declining — and that hooking stays off until enabled per game.
4. Optional library import.
@@ -299,16 +833,17 @@ Agent section: elevation state with a plain explanation of what elevation *optio
> in read-only mode. **(1) The gate:** the four documents ride in the assembly (`LegalDocuments`: `legal/EULA.md`,
> the root `LICENSE` as the GPLv3 text, `legal/DISCLAIMER.md`, `legal/PRIVACY_POLICY.md`, embedded at build so the
> App shows the text this build was reviewed with; HTML authoring comments stripped; `{{RELEASE_DATE}}` left for
> `release.yml`), a list on the left, the text in a read-only box, "View on GitHub" per document, **one Accept**
> that writes four `legal_acceptance` rows with each document's own `**Version:**` line (`GPL-3.0-only` for the
> licence), and Decline, which ends the host — the shell never appears. Closing the window without deciding is a
> `release.yml`), a list on the left, the text in a read-only box (~~raw Markdown~~ rendered since beta.12), "View on GitHub" per document, **one Accept**
> that writes ~~four~~ three `legal_acceptance` rows with each document's own `**Version:**` line ~~(`GPL-3.0-only` for the
> licence)~~ *(corrected 2026-10-04: since beta.12, D45, the GPL is shown for information and gets no row; an older
> `gpl` row is left as written)*, and Decline, which ends the host — the shell never appears. Closing the window without deciding is a
> decline. **(2) Agent setup:** the honest paragraph (unelevated by default; elevation optional, unlocks CPU
> temperature and elevated-game attach, required by no tier) and the facts from `HelloAck` as they arrive —
> state, version, telemetry source, overlay build, CPU temperature, elevated — N/A until the Agent answers.
> **(3) The explainer:** the consent dialog's own reviewed Tier 1 / Tier 2 paragraphs (`Safety_Consent_Hooked` /
> `_NotHooked`, so the two screens cannot drift), that hooking stays off until enabled per game, and that the
> Disclaimer states the risk. **(4)** ~~the import placeholder (P4)~~ **since P4 PR-4 (2026-09-14) a real pointer: the stores' libraries are imported from File ▸ Import library… once inside, every row hooking off** (the step itself stays text — the review dialog needs the shell's dialog host, which the first-run window has not). D8 unchanged: the gate is not a consent
> precondition. Tests: `LegalDocumentsTests`, `FirstRunViewModelTests` (required on empty, one Accept = four
> precondition. Tests: `LegalDocumentsTests`, `FirstRunViewModelTests` (required on empty, one Accept = ~~four~~ three
> rows at the documents' versions, a moved version re-shows only that document, decline/close write nothing,
> read-only records nothing, the Agent facts), the two steps rendered in `PagesLoadTests`.
>
@@ -327,6 +862,12 @@ Agent section: elevation state with a plain explanation of what elevation *optio
- Keyboard: ~~NavigationView items Ctrl+1…5; grids fully navigable; Esc closes flyouts/dialogs~~ — §Accessibility below, since P4 PR-8 (2026-09-15); this bullet named three behaviours and none of them was built or checked.
- No blocking dialogs during capture; errors surface as InfoBars/tray toasts.
- Charts and stat numbers use culture-aware formatting per active UI culture (09); colors only from theme resources or the per-theme chart palette (16 §ScottPlot).
- **The mouse wheel scrolls whatever is under the pointer (beta.14).** Every page scrolls itself
(`ScrollViewer.CanContentScroll="False"` on the `Page` — `16_WPFUI_SYNTAX` §Gotchas: until beta.14 the wheel scrolled
nothing on five pages, and the Logs tail did not follow the newest line); a scroller nested in a dialog hands the wheel
on at its ends (`ui:PassiveScrollViewer`); over a chart a plain wheel scrolls the page and **Ctrl+wheel zooms the chart**
(`Charts/ChartWheel`, every plot through `ChartTheme.Attach`) — drag still pans and double-click still resets, as
ScottPlot does. The import checklist scrolls inside its list and nowhere else, so its intro and its count stay put.
## Accessibility
@@ -344,7 +885,8 @@ the requirement was one bullet under §UX rules, and nothing checked it.
| **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 |
**Esc is the Close button, never the primary one.** On the consent dialog (FR-2.1) that is "Keep it off": nothing is
**Esc is the Close button, never the primary one.** On the consent dialog (FR-2.1) that is ~~"Keep it off"~~ "Keep hooking
off" *(the button's text, corrected 2026-10-07)*: nothing is
stamped. A dialog that offers no Close button is not dismissed by Esc, and the Legal Gate (FR-11) is a window of its own
(`FirstRunWindow`) with explicit Decline and Accept, on which Esc does nothing. WPF UI 4.3.0 handles no key in
either dialog type (its `ContentDialog.cs` and `MessageBox.cs` at tag 4.3.0 have no key handler — read 2026-09-15),
@@ -355,8 +897,9 @@ which is why the handler is ours.
- Every interactive control that shows no text of its own carries `AutomationProperties.Name` from `.resx` — the
toggles and choice boxes on Settings, the hooking switch on a game's page, and the icon-only close button in the
`InfoBar` template. A control *with* visible text needs nothing: its text is its name.
- `PagesLoadTests`-style scan (`AccessibilityTests.EveryTextlessControlHasAName`): every `Button`, `ToggleSwitch`,
`ToggleButton`, `CheckBox`, `ComboBox` and `HyperlinkButton` in the App's XAML either has content or a name. A new
- `PagesLoadTests`-style scan (`AccessibilityTests.~~EveryTextlessControlHasAName~~ EveryInputThatShowsNoTextHasAnAutomationName`
— corrected 2026-10-04): every `Button`, `ToggleButton`, `ToggleSwitch`, `CheckBox`, `RadioButton`, `ComboBox`,
`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"`.
@@ -364,8 +907,78 @@ which is why the handler is ours.
Colours come from the WPF UI theme dictionaries and nothing else, so contrast is the Fluent themes' — both of which
meet it — and cannot be broken locally: `AccessibilityTests.NoXamlHardCodesAColour` fails on any `#RRGGBB` or named
colour in the App's XAML. The chart palette is the one deliberate exception (`16_WPFUI_SYNTAX` §ScottPlot: one
palette per theme, chosen with the theme).
colour in the App's XAML. The chart palette is ~~the one~~ a deliberate exception (`16_WPFUI_SYNTAX` §ScottPlot: one
palette per theme, chosen with the theme). *(Corrected 2026-10-14, beta.23: the game page's artwork band is the second —
a colour worked out at run time from the artwork and the theme's own text and fill colours, at the strongest opacity at
which every text on it keeps 4.5:1 (tertiary 3:1), so it is held by construction rather than by the theme;
`ColorMathTests` checks the hardest colours in both themes against the tests' own WCAG, and `PagesLoadTests` measures the
rendered band. Its banner's fade is an alpha mask set in code, no colour at all.)*
> **"Cannot be broken locally" had a hole, closed 2026-09-16.** `ui:Badge Appearance="Info"` — the Games card's
> "Hooking on/off" and the edit dialog's "Detected" — paints its background with WPF UI's `PaletteLightBlueBrush`, a
> fixed Material colour from `Palette.xaml` that is **not** in either theme dictionary, under the theme's white text:
> `#03A9F4` at **2.6:1** in dark, below AA-large, and no `#` in our XAML for the scan to catch. The hooking state is
> now a `Border` in the `HookStatePill` style (ON: the accent pair the ×FG chip uses; OFF: the Pill's muted fill with
> secondary text), the Detected badge is `Secondary`, and `ContrastTests` holds it two ways: **no `ui:Badge` in the App's
> XAML uses `Appearance="Info"`** (or `Caution`/`Danger`/`Success` — the same palette), and the WCAG ratio of every
> pill's (text, fill) pair, composited over the card and window backgrounds, is ≥ 4.5 in **both** theme dictionaries —
> with the old pair asserted *below* it, so the check is known to bite. The accent pair is measured against WPF UI's
> default accent; a user's system accent replaces it at runtime through `ApplicationThemeManager`, and WPF UI picks the
> on-accent text for it.
>
> **And `Secondary` was a second hole, closed 2026-09-21** (the owner's screenshot: two empty white boxes where a Steam
> title's platform and engine were, beside a readable "Hooking off"). WPF UI 4.3.0's `Secondary` trigger repaints only
> the badge's background (`ControlFillColorDefault`); `Foreground` stays `BadgeForeground`, the on-accent colour of the
> DEFAULT badge, which in the light theme is near-white text on a near-white fill. The hooking pill beside it was
> readable because it sets its own foreground. The platform and engine tags and the Detected marker are now a `Border`
> in the `TagPill` style with `TagPillText` (secondary text on the Pill's fill — the pair `ContrastTests` already
> measures in both themes as "hooking off"), and `ContrastTests.NoBadgeUsesTheSecondaryAppearance` refuses a literal
> `Appearance="Secondary"` badge in the App's XAML. The title bar's Agent badge binds its appearance and never binds
> Secondary.
>
> The Dashboard's FG qualifier chip was reported with it and had the other defect: not contrast (caution fill under
> primary text, ≈ 12:1) but **clipping** — the pill sat in a star column with no trimming, so a sentence-length
> qualifier overflowed the row. The qualifier text trims with an ellipsis at 260 px (the readout's tooltip carries the
> full sentence), and the row's readout column is sized to content with the game's name trimming first.
>
> **A third hole, closed 2026-10-05 (beta.14; the owner's screenshot of File ▸ Import library in the dark theme: every
> row white, its text invisible, each tick box a sliver).** A style `BasedOn="{StaticResource {x:Type DataGridRow}}"`,
> added in beta.11 to dim the rows already in the library: WPF UI 4.3.0 keys its row style `DefaultDataGridRowStyle`
> and defines no implicit one, so the lookup fell through to Aero2's row and its `SystemColors.WindowBrush` — a white no
> theme reaches, under the dark theme's white text. No `#` in our XAML, no palette badge: neither check above could see
> it, and light-theme rows read fine. The tick boxes were WPF UI's `CheckBox` (`MinWidth` 120, padding 11) in a 40 px
> column. Held three ways: `AccessibilityTests.NoStyleIsBasedOnAnImplicitStyleTheThemeDoesNotDefine` (every `BasedOn`
> type has a style in the App's dictionaries), `ImportReviewRenderTests` (the rendered dialog, both themes: every cell's
> text against the composited colour painted under it ≥ 4.5:1, each ticked box drawn whole), and
> `AccessibilityTests.NoDataGridCheckBoxColumn` (Compare's checkbox column drew an Aero2 box). Each went red on the
> unfixed XAML before it went green.
>
> **A fourth hole, closed 2026-10-07 (beta.17; the owner's screenshots of Settings after a theme switch: its descriptions
> light grey on white in Light, dark grey on dark in Dark).** Every check above measures a theme as a surface is *made*
> under it; a switch while the surface is on screen is a different question. WPF UI 4.3.0's `ui:TextBlock
> Appearance="Secondary|Tertiary"` — 129 texts in 20 files, nearly every description and caption — looks its brush up
> once and keeps it (`16_WPFUI_SYNTAX` §Gotchas), so the page on screen during a switch kept the old theme's muted text:
> Settings above all, where the theme is chosen. Pages are made again on each navigation, which is why only the page in
> view showed it. Those texts take the `SecondaryText` / `TertiaryText` styles now. Held two ways:
> `ContrastTests.NoTextBlockTakesItsColourFromAppearance` (no `Appearance` on a TextBlock in any form, nor its code form),
> and `PagesLoadTests.EveryTextFollowsAThemeSwitch` (every page, the first run, About, the user guide, a session's
> summary, every dialog's content and the safety InfoBar, made under one theme, switched, and compared text by text with
> the same surface made fresh under the other — both ways). Both went red on the unfixed XAML, the second with 146 stale
> texts each way, before they went green.
>
> **A fifth hole, closed 2026-10-07 (beta.18; the owner's screenshots of beta.17 in the dark theme: every page's title and
> section headings near-black on the dark window — beta.16's screenshot shows it too).** This text had no colour of ours,
> because it had none. A page is shown in WPF UI's `NavigationViewContentPresenter`, a `Frame`, and a Frame passes no
> inherited value into its page (`InheritanceBehavior.SkipToAppNow`), so a text that sets no colour falls to the TextBlock
> default, which WPF UI 4.3.0 makes black (`16_WPFUI_SYNTAX` §Gotchas). Cards, grids and controls set their own; the bare
> titles and headings did not: 19 texts on the six pages at 1.29:1. Every check above laid a page out straight in a
> window, whose text colour the page then inherited — a page the App never draws — and a page on screen during a theme
> switch did take the window's colour, while each navigation makes a new one that does not, so it came and went. Every
> page sets `Foreground="{DynamicResource TextFillColorPrimaryBrush}"` on its root. Held two ways:
> `AccessibilityTests.EveryPageSetsItsOwnTextColour`, and `PagesLoadTests.EveryTextIsReadableInBothThemes` — every
> surface hosted as the App hosts it, a page in the presenter, and every text that shows ≥ 3:1 over the colour painted
> under it, in both themes. `EveryTextFollowsAThemeSwitch` hosts its pages in the presenter too since, and went red with
> them: a page made after a switch stayed black. All three went red on the unfixed XAML before they went green.
### DPI
+28 -4
View File
@@ -2,12 +2,28 @@
Languages: **en** (neutral/default) · **vi** · **ja**. Same `.resx` pattern as the rest of the poli0981 portfolio.
> **The user guide is English (beta.12, owner decision D44)**, like the legal documents: `guide/` is Markdown the App
> embeds and renders, not `.resx` text. The UI around it — the menu item, the window's title — is translated.
> **Both string families are given the UI culture explicitly (2026-09-21).** `App.ApplyCulture` sets `Strings.Culture`
> AND `FrameLedger.Shared.Strings.Culture`. The second was missing: the safety family fell back to the thread's
> `CurrentUICulture`, and a culture set inside the App's async start flows with that async context, not to the
> dispatcher's later operations — so on an English Windows a Vietnamese UI showed the consent dialog, the refusal
> notices in English (and, for one day, a guard-override card). A resource accessor that depends on which thread asks is the defect;
> `StringsTests.ApplyingTheUiLanguageSetsTheSafetyFamilyToo` holds it with the thread deliberately left English.
## Mechanics
- One `Strings.resx` (+ `Strings.vi.resx`, `Strings.ja.resx`) per assembly that has user-visible text (`App`, `Shared` for error codes). Access through a generated strongly-typed class; **no string literals in XAML/C# for user-visible text** (analyzer TODO: Meziantou MA0011/manual review in PR checklist). **As built (P3 PR-2, 2026-09-13):** the class is `Strings.Designer.cs`, written by `tools/resx-gen.ps1 -Resx <file>` and **committed** — not the SDK's `ResXFileCodeGenerator`, which the SDK-style WPF project does not run — with `Culture`, `ResourceManager`, `Keys`, and one property per key; the audit below fails when it is stale. The first family is `src/FrameLedger.App/Strings.resx` (65 keys); `Shared`'s arrives with PR-4's `Safety_*` text, because an empty family is what the audit refuses.
- XAML binding via `{x:Static res:Strings.Key}` plus a `LocalizeExtension` for the few dynamic cases.
- One `Strings.resx` (+ `Strings.vi.resx`, `Strings.ja.resx`) per assembly that has user-visible text (`App`, `Shared` ~~for error codes~~ for the safety family, the `Safety_*` keys — corrected 2026-10-04). Access through a generated strongly-typed class; **no string literals in XAML/C# for user-visible text** (analyzer TODO: Meziantou MA0011/manual review in PR checklist). **As built (P3 PR-2, 2026-09-13):** the class is `Strings.Designer.cs`, written by `tools/resx-gen.ps1 -Resx <file>` and **committed** — not the SDK's `ResXFileCodeGenerator`, which the SDK-style WPF project does not run — with `Culture`, `ResourceManager`, `Keys`, and one property per key; the audit below fails when it is stale. The first family is `src/FrameLedger.App/Strings.resx` (65 keys); `Shared`'s arrives with PR-4's `Safety_*` text, because an empty family is what the audit refuses.
- XAML binding via `{x:Static res:Strings.Key}` ~~plus a `LocalizeExtension` for the few dynamic cases~~ *(corrected 2026-10-04: no `LocalizeExtension` exists; text that varies is composed in the view model from `Strings.*`)*.
- **Runtime switching:** setting change → set `CultureInfo.CurrentUICulture` + `Thread` defaults → re-create the main window shell (cheap; state preserved via VM). Persist in `settings`.
- `SatelliteResourceLanguages` = `en;vi;ja` in the App csproj to keep publish size down.
**Two kinds of text did not follow, until beta.15:** a list of choices built once in a static (Settings' themes and update
channels, the Logs page's two lists, the Games page's sort order — `x:Static` read the list built in the language the
App started in), and the singletons that outlive the rebuilt window (the tray's menu, the title bar's Agent pill and the
update banner). The lists are per page now, bound through the view model; the singletons implement
`ILanguageFollower`, which `ShellHost.Rebuild` calls once the new window is up. `LanguageFollowingTests` refuses a new
static list of labelled choices — the language list, each language in its own words, is the one exception.
- `SatelliteResourceLanguages` = `en;vi;ja` in ~~the App csproj~~ `Directory.Build.props` (corrected 2026-10-04) to keep publish size down.
## Key conventions
@@ -24,7 +40,7 @@ Languages: **en** (neutral/default) · **vi** · **ja**. Same `.resx` pattern as
- `en` written first, is authoritative.
- `vi` authored by the maintainer.
- `ja` machine-drafted, each entry marked with `<comment>review</comment>` until reviewed; the About dialog credits reviewers.
- `ja` machine-drafted, each entry marked with `<comment>review</comment>` until reviewed; ~~the About dialog credits reviewers~~ *(corrected 2026-10-04: no screen credits reviewers yet, and no `ja` entry has been reviewed — owner-only)*.
- CI check (`tools/resx-audit`): every key present in all three files; ~~missing → build warning list artifact~~ **missing is RED (2026-09-13)**: `tools/resx-audit.ps1` exists since P3 PR-2 as `build.ps1` step 15, self-test first (11 fixture cases, at least four must go red) then the live pass over every `Strings.resx` under `src/`. Per family it requires C#-identifier keys with non-empty neutral values, **exactly** the neutral key set in `vi` and `ja` (a missing key would fall back to English silently; an extra one is dead text), the `Safety_*` rule below, and a current `Strings.Designer.cs`. A tree with no family is red, not green — the gate must not be vacuous.
## Glossary (fixed translations)
@@ -45,6 +61,11 @@ Languages: **en** (neutral/default) · **vi** · **ja**. Same `.resx` pattern as
| Anti-cheat | Anti-cheat (giữ nguyên) | アンチチート |
| Capture tier | Mức thu thập | 計測ティア |
| Measured / Supports | Đo được / Hỗ trợ | 実測 / 対応 |
| VRAM / RAM (beta.12) | VRAM / RAM (giữ nguyên) | VRAM / RAM |
| Dedicated / Shared GPU memory | Bộ nhớ GPU chuyên dụng / dùng chung | 専用 / 共有 GPU メモリ |
| Private working set / Working set / Commit | giữ nguyên | プライベート ワーキング セット / ワーキング セット / コミット |
| this game / whole graphics card / whole PC | game này / cả card đồ họa / cả máy | このゲーム / グラフィックス カード全体 / PC 全体 |
| Median / Mean / Peak | Trung vị / Trung bình / Đỉnh | 中央値 / 平均 / ピーク |
Technical benchmark vocabulary stays in English across all locales where the community convention is English (1% Low, stutter, present mode, frame pacing).
@@ -55,6 +76,9 @@ Consent, refusal, and safety-unhook text (FR-2.1, `19_SAFETY`) is **reviewed lik
- No machine-drafted `ja` in this category — a mistranslated ban warning is a real harm. These keys are marked `<comment>safety: human review required</comment>` and ~~the `ja` build fails the resx audit until a human reviewer signs off; until then the `en` string is shown as fallback rather than an unreviewed translation~~ **as built (2026-09-13): the audit is red on a `Safety_*` key in `ja` that carries neither `safety: human review required` nor `safety: reviewed by <name>`, and red on one marked review-required whose value is anything but the `en` string verbatim** — the key-set rule forbids leaving it out, so "shown as `en` until signed" is true by construction (the value IS the English), not by a runtime fallback. Signing = replacing the comment with `safety: reviewed by <name>` beside the reviewed text.
- Never soften the wording per locale. "May result in a permanent ban of your account" must survive translation with the same force in all three languages.
- Key prefix `Safety_*` so they are easy to audit as a group.
- **`Safety_Exception_*` (2026-09-26, D33)** is the user-mode exception's disclosure: the same rules — `ja` ships the
English verbatim marked for review — and its own version, `AntiCheatExceptionDisclosure.Version`, bumped when any of
those strings changes meaning, exactly as `SafetyDisclosure.Version` is for `Safety_Consent_*`.
> **What is in scope, stated 2026-08-06 because a binary now exists that is not.** These rules
> govern the **shipped** application's user-visible strings — what `12_BUILD` §Publish & package
+30 -4
View File
@@ -3,9 +3,19 @@
## Serilog configuration
- Sinks: rolling file per process — `logs/ui-.log`, `logs/agent-.log` (`rollingInterval: Day`, `retainedFileCountLimit: 7`, `fileSizeLimitBytes: 10 MB`, `rollOnFileSizeLimit: true`). Console sink in DEBUG builds. *(`ui-.log` is written since 2026-09-13, P3 PR-2, with `Process=ui` enriched and every unhandled path — Dispatcher, AppDomain, unobserved task — logged as Fatal/Error; ~~the crash dialog and minidump of §Crash handling are still P4's~~ — built 2026-09-15, P4 PR-9, §Crash handling's note.)*
- *(beta.15, D52: an App started with `--data-dir <copy>` — a viewer — writes `ui-.log` and its crash dumps under the
copy, never under `%LOCALAPPDATA%\FrameLedger`; its first lines name the folder and say it is a viewer.)*
- Minimum level `Information` (`Debug` toggle in Settings → applies live via `LoggingLevelSwitch`).
- Enrichers: process name, version, `SessionGuid` and `GamePid` scoped properties during capture (`LogContext.PushProperty`).
- ~~Enrichers: process name, version, `SessionGuid` and `GamePid` scoped properties during capture (`LogContext.PushProperty`).~~
- Template: `[{Timestamp:HH:mm:ss.fff} {Level:u3}] {SourceContext} {Message:lj} {Properties:j}{NewLine}{Exception}`.
> **Corrected 2026-10-04 — the four lines above are `ui-.log`'s configuration, not both processes'.** `agent-.log`
> (`FrameLedger.Agent/Program.cs`, since 2026-09-10) is daily with **14** files kept and no size cap, writes Serilog's
> **default** template — `2026-10-04 09:15:02.123 +07:00 [INF] …`, a date first — and its level is fixed at
> Information with `Microsoft.*` at Warning: `log.debug` is the App's alone. Neither process has a console sink, and no
> enricher exists beyond the App's `Process=ui`. The Logs page reads both shapes since beta.12 — until then its level
> filter recognised only the App's `[HH:mm:ss.fff LVL]` prefix, so Warning and Error showed no Agent line at all
> (`LogTail.LevelOf`, `LogTailTests.TheAgentsTemplateIsReadToo`).
- **Never log:** full user paths outside `%LOCALAPPDATA%\FrameLedger` (redact to `<user>`), machine name, any exe arguments of games. ~~A `RedactingEnricher` enforces the path rule.~~ *(No such enricher was ever written: found 2026-09-15, checking `legal/PRIVACY_POLICY.md` §3's "logs are redacted (user directory paths removed) before bundling" against the bundle, which copied the logs verbatim. An enricher could not have kept the rule anyway: exception text and the Overlay's native log never pass through one, and the data directory itself sits under the user's profile, so every run logs a user name. The rule is enforced where a log leaves the machine instead: `App/Services/LogRedactor` over every log copy in the bug bundle, §Bug report flow step 2. The files in `logs\` keep their full paths; they leave the PC only if the user copies them.)*
- Capture hot path logs nothing per-frame; counters summarized at finalize.
@@ -15,6 +25,17 @@
- On fatal: Serilog `Fatal` with full exception → write minidump via `MiniDumpWriteDump` (CsWin32, `MiniDumpWithIndirectlyReferencedMemory | WithThreadInfo`) to `crashdumps/` (keep last 5) → UI shows crash dialog offering the bug-report flow → exit code 1.
- Agent crash mid-session → `.partial` recovery path (04_CAPTURE) on next start finalizes an `interrupted` session.
> **Written by a child process since 2026-09-17.** `MiniDumpWriteDump` on the calling process suspends every other
> thread of it, and a suspended thread holding the process heap or loader lock deadlocks the dumper — Microsoft's
> documentation says to dump "from a separate process if at all possible". The in-process writer below froze the
> Infrastructure test suite one run in eight, and a crashing App or Agent is the unstable process the warning is about.
> `CrashDumpWriter.TryWrite` now starts `FrameLedger.Agent.exe --write-crash-dump <file>` (the Agent beside the App;
> the Agent's own binary for the Agent) and waits up to 30 s; the helper (`ParentDump`) dumps **its parent** with the
> same two flags, and nothing else: it takes no pid, and refuses unless the parent is still running, started before it,
> and has its image in the helper's own directory — the App or the Agent, never a game (CLAUDE.md rule 4). A missing,
> failed or slow helper is a null path and one Warning line, as before. The runtime's `createdump.exe` would have done
> the job, but a self-contained install does not ship it (measured on 0.1.0-beta.1).
>
> **Built 2026-09-15 (P4 PR-9).** `Infrastructure/Diagnostics/CrashDumpWriter` writes
> `crashdumps\<ui|agent>-<yyyyMMdd-HHmmss, UTC>-<pid>.dmp` through CsWin32's `MiniDumpWriteDump` with exactly the two
> flags above, keeps the five newest `*.dmp` of either process after each write, and never throws: a failure is a null
@@ -140,15 +161,20 @@ Tails the active files (shared read), level filter, text search, pause autoscrol
## Diagnostics extras
- `Tools → Agent status…` shows the `HelloAck` capability set (telemetry source, overlay build id, Vulkan layer — ~~tier availability~~, which meant "is the ETW fallback reachable" and has no meaning under a two-rung ladder) + last 20 Agent log lines.
- `Tools → Agent status…` ~~shows the `HelloAck` capability set (telemetry source, overlay build id, Vulkan layer~~ — ~~tier availability~~, which meant "is the ETW fallback reachable" and has no meaning under a two-rung ladder ~~) + last 20 Agent log lines~~. *(Corrected 2026-10-04: it opens the Dashboard's Agent card — state, version, telemetry source, overlay build id, elevated, running sessions. The Vulkan layer state is on Settings ▸ Capture and the Agent's log on the Logs page.)*
- **Never include a game's own logs, saves, or config files** in a bug bundle, even when a crash looks game-related. We ship our logs only.
- `--diag` CLI flag on the App prints environment + capability report to stdout (support requests).
> **Read-only since 2026-09-16:** `DiagAsync` opens the ledger through `LedgerDatabase.OpenReadOnlyAsync`, so a
> diagnostic run against a ledger at another schema reports that fact (the schema line reads the refusal) rather
> than migrating the file it was asked to describe.
>
> **Built 2026-09-14 (P3 PR-8a).** `App.OnStartup` sees `--diag` and runs `DiagAsync` instead of the host: no
> window, no Agent, the ledger opened read-only for its schema version and the settings, then
> `Services/DiagReport.Build` (app version, OS and bitness, runtime, locale, elevation, data and logs
> directories, ledger schema or "could not open", whether `FrameLedger.Agent.exe` is beside the App, every
> registry key's effective value) written to `logs/diag-<yyyyMMdd-HHmmss>.txt` **and** to stdout — the App is
> directories, ledger schema or "could not open", whether `FrameLedger.Agent.exe` is beside the App, since
> 2026-09-21 the machine as a session's hardware snapshot records it — CPU, GPU, driver, RAM, display — added to this
> list 2026-10-04, and every registry key's effective value) written to `logs/diag-<yyyyMMdd-HHmmss>.txt` **and** to stdout — the App is
> a WinExe with no console of its own, so stdout carries the report only when the caller attached one or piped
> it (`FrameLedger.exe --diag | more` works; a double-click leaves the file). Exit 0, or 1 with a Fatal line in
> `ui-*.log`. The Agent's `--diag` stays on its `NotImplementedFlags` list — 10_LOGGING names the flag as the
+79 -12
View File
@@ -1,14 +1,17 @@
# 11 — Updater
Velopack, feeding from GitHub Releases of `https://github.com/poli0981/frameledger`. Stable channel only in v1.
Velopack, feeding from GitHub Releases of `https://github.com/poli0981/frameledger`. ~~Stable channel only in v1.~~ *(Corrected 2026-10-04: two channels since P4 PR-5 — `update.channel`, ~~stable by default~~ or beta, which adds pre-releases. Every release so far is a pre-release; see §Built, Channels.)* *(Corrected 2026-10-05: the default is `auto` since beta.14, which follows the running copy — §The update audit, beta.14.)*
## Flow
- **Startup silent check** (if enabled): `UpdateManager.CheckForUpdatesAsync()` 5 s after UI idle. Offline/any failure → log `Information`, no dialog (NFR-10). Update found → non-blocking toast "Update vX.Y.Z available" → Downloads in background → "Restart to update" button (never auto-restart; the user may be mid-capture — if a capture is active, defer the prompt until session end).
- **Manual check** (Help → Check for updates): progress dialog; all failures produce the mapped dialog below.
- **A viewer never updates** (beta.15, D52): an App started with `--data-dir <copy>` registers neither Velopack nor the
startup check (`Services.MachineFacingServices` gives it `ViewerUpdateClient`, which answers "not installed"), and
Help → Check for updates and the automatic-check switch are disabled — an update replaces this PC's installed copy.
- **Never apply an update while a game is hooked** (FR-12): the Overlay DLL on disk must not change under a running game, and a mid-session swap would invalidate the ring layout handshake. If a capture is active, defer the prompt and the apply until the session ends.
- Apply: `WaitExitThenApplyUpdates` on restart. Agent is stopped via `Shutdown` before applying and the scheduled task action path is re-validated after update (Velopack keeps a stable `current` path, but verify in P4 and re-register task if the action path changed).
- Release notes (GitHub release body, Markdown) rendered in the update dialog.
- Release notes (GitHub release body, Markdown) rendered in the update dialog. ~~(shown as plain text until beta.12 — §Flow and §Limits below said so)~~ **Rendered since beta.12** by `Controls/MarkdownView` (`08_UI` §Menu, *Documents are rendered*), relative links resolved against `CHANGELOG.md` at this build's source.
## Error mapping (FR-12)
@@ -21,7 +24,7 @@ Velopack, feeding from GitHub Releases of `https://github.com/poli0981/frameledg
| Package hash mismatch | `Update_Err_Corrupt` | Auto-retry once, then dialog |
| Unknown | `Update_Err_Unknown` + exception logged | "Report a bug" shortcut |
Detection-rules updates share this client, but the **`anticheat` block is fetched and applied on its own schedule regardless of the user's rules-update preference** (`05_DETECTION` FR-7.3) — a user who turned off rules updates must still receive new anti-cheat entries.
~~Detection-rules updates share this client, but the **`anticheat` block is fetched and applied on its own schedule regardless of the user's rules-update preference** (`05_DETECTION` FR-7.3) — a user who turned off rules updates must still receive new anti-cheat entries.~~ *(Corrected 2026-10-04: there is no rules fetch and no rules-update preference. Tools ▸ Update detection rules re-reads the copy seeded from the install (`07_IPC`); FR-7.3 is unmet (`20_OPEN_QUESTIONS` §S20). The sentence is what a fetch must do once built.)*
All update HTTP goes through one `GitHubHttpClient` (also used by rules updates) with: UA `FrameLedger/{version}`, 10 s timeout, ETag cache in `settings`, single retry with jitter for transient failures.
@@ -29,13 +32,23 @@ All update HTTP goes through one `GitHubHttpClient` (also used by rules updates)
Binaries are not code-signed (project policy). Consequences and mitigations, documented in README and the update dialog footer:
- SmartScreen warning on first run of a new version — expected; SHA-256 checksums (`SHA256SUMS.txt`) published with every release; CI prints them into release notes.
- Velopack delta packages reduce download size; full package fallback automatic.
- ~~Velopack delta packages reduce download size; full package fallback automatic.~~ *(Corrected 2026-10-04: no delta has been published — `release.yml` never puts the previous release in `out/release` before `vpk pack`, so every update downloads the full package; a delta needs a `vpk download github` step first.)* **Built in beta.13:**
`release.yml` downloads the previous release into `out/release` before `vpk pack`, so a release carries
`FrameLedger.App-<version>-delta.nupkg` beside the full package; the previous full package is moved out (neither uploaded
nor checksummed) and the feed lists this build alone, as `vpk upload github` would write it. Velopack applies the delta
when the installed copy is the previous release and falls back to the full package otherwise — `0.1.0-beta.13` is the
first release with one, so beta.12 → beta.13 is the first update that can use it (owner-only: HANDOFF item 10).
- Never bypass or suppress OS warnings programmatically.
## Versioning
SemVer `MAJOR.MINOR.PATCH`. Tag `vX.Y.Z` triggers the release workflow (13_CI_CD). `MAJOR` bumps for DB schema or IPC protocol breaks; migrations must cover every released `MAJOR-1` version.
> **Under `0.x` this rule is not applied, and every pre-release says so by shipping one anyway** (SemVer §4: a major version
> zero is initial development). Schemas ~~0008–0015~~ 0008–0017 *(corrected 2026-10-04: 0016 shipped in beta.10 beside 0015, 0017 in beta.11; 0018 rides beta.12)* and the shared-memory layout 4 (2026-09-27, beta.10) each shipped in a
> `0.1.0-beta.N`. What protects a user is not the number: the ledger migrates in place (`06_DATA_MODEL` §Migrations), and a
> layout mismatch is refused at attach with "restart the game" (`07_IPC` §Protocol rules). The rule applies from `1.0.0`.
## Built 2026-09-14 (P4 PR-5) — what exists, and where it deviates from the above
`src/FrameLedger.App/Update/`. Velopack 1.2.0 (`Directory.Packages.props`, pinned since P0, referenced since
@@ -50,20 +63,27 @@ flow, and the tests run the flow over a fake client because nothing here may tou
window is off screen (`08_UI` §Notifications policy), and the shell's persistent InfoBar carries the download
and the **Restart to update** button.
- **Manual check:** Help ▸ Check for updates → `UpdateService.CheckInteractivelyAsync` and the dialogs in
`UpdatePrompts` (WPF-UI `MessageBox`): the offer with the release notes (the GitHub release body, shown as text —
no Markdown renderer is shipped), the unsigned-release footer, Download / Later; "up to date"; "not an
`UpdatePrompts` (WPF-UI `MessageBox`): the offer with the release notes (the GitHub release body, ~~shown as text —
no Markdown renderer is shipped~~ rendered since beta.12, at most 260 px tall and scrolling), the unsigned-release footer, Download / Later; "up to date"; "not an
installed copy"; and the error table below. There is no progress *dialog*: progress is the banner's percent. A
package that fails its checksum is downloaded once more before the Corrupt row is shown (the table's "auto-retry
once").
- **FR-12 is the shape of the flow, not a check at the end.** A downloaded package is `Ready` only while the Agent
reports no session (its `StatusAck` at connect, then `SessionStarted` / `SessionCompleted` on the pipe);
otherwise it is `Deferred`, the button is disabled and the body says why, and it becomes `Ready` when the last
session ends. The apply is refused again inside if a session started meanwhile. A recording-only (Tier 2)
session ends. The apply is refused again inside if a session started meanwhile. ~~A recording-only (Tier 2)
session that began before the App connected is covered by the status; one that begins afterwards raises no
`SessionStarted` (that event is the ring's) and is not — a known gap, recorded rather than hidden: the Overlay
is not on disk under such a session, so the rule's reason does not apply to it.
is not on disk under such a session, so the rule's reason does not apply to it.~~ **Closed 2026-09-23:** a held
(Tier 2) session raises its own `SessionStarted`, so it defers an update like any other; and the status read at
connect SEEDS the running set rather than being OR-ed with it forever — before, a session running when the App
connected held every download at `Deferred` until the next reconnect, hours after it ended.
- **Apply:** `Shutdown` to the Agent over the pipe, the connection's relaunch held (`IAgentLink.SetLaunchHold`),
the pipe watched until it drops (10 s; an Agent that does not stop leaves everything as it was and says so),
the pipe watched until it drops (10 s; an Agent that does not stop leaves everything as it was and says so) —
**and since beta.10 the data folder's instance lock watched until it is let go, within the same 10 s**: an Agent run as
administrator (the admin mode) holds the install directory's files exactly as long as its process lives, and one that
holds the folder without answering this App (still starting, another version) is never updated under — the apply is
refused with `Update_AgentStillRunning` instead,
then `WaitExitThenApplyUpdates(asset, silent: false, restart: true)` and the host ends. The restarted App
starts the Agent beside itself as always, and when Velopack reports the restart (`OnRestarted`) the host reads
the logon task: `Stale` (the action path moved) runs `--install-task`, this user's own task, and says so in the
@@ -92,8 +112,55 @@ flow, and the tests run the flow over a fake client because nothing here may tou
empty token — measured on 1.2.0 by reflection, so the request identifies the product and nothing else. When the rules fetch is built
(`05_DETECTION` FR-7.3, `20_OPEN_QUESTIONS` §S20 feed half) it needs a client of its own; this paragraph no
longer claims the updater provides one.
- Release notes are rendered as plain text, not Markdown.
- ~~Release notes are rendered as plain text, not Markdown.~~ Corrected 2026-10-03: rendered since beta.12 (Markdig; HTML off, no image fetched).
## The update audit, beta.14 (owner request 2026-10-05: "check the update logic")
No failure had been reported; the audit read the flow above against Velopack 1.2.0 and the owner's own updater log
(`%LOCALAPPDATA%\velopack\velopack_FrameLedger.App.log`, read-only) and found two defects that made the flow above
partly fiction, and six smaller ones. Each is fixed in place:
- **A copy left on its defaults never found an update.** `update.channel` defaulted to `stable` while every release is a
GitHub pre-release; the owner's log reads "No releases found" from the day their ledger (and its settings row) was reset.
**Owner decision D47:** the default is `auto`, which follows the running copy — a pre-release asks for pre-releases, a
release for releases (`Update/UpdateChannelPolicy`, SemVer's `-` before any `+`) — and a stored `stable` or `beta` is the
user's choice and wins. Settings shows *Automatic (Beta)* or *(Stable)* first. Only an explicit selection ever wrote the
row (`SettingsViewModel.Persist` is guarded while loading), so existing copies with no row move to `auto`.
- **Velopack applied a downloaded update at the next start, behind FR-12.** `VelopackApp` applies a package waiting in
the install folder on startup unless told not to (`SetAutoApplyOnStartup`, ON by default), and the startup check
downloads in the background — so the next start of `FrameLedger.exe` (the Start menu, the logon Run value, a second
click, `--diag`) applied it inside `VelopackApp.Run()`, before the single-instance claim, before FR-12 could ask
whether a session runs, and before the Agent was asked to stop; its updater killed the Agent instead (the owner's log:
"Auto apply is true, so restarting to apply update…", then "Killing process: …FrameLedger.Agent.exe"). Off now
(`VelopackHooks`, pinned by `VelopackHooksTests` through the builder's private fields); a package an earlier run left
is adopted at start — `UpdateService.AdoptPending`, from `UpdateManager.UpdatePendingRestart`, no feed request — and is
Ready or Deferred like any other.
- **An update Velopack starts itself** (the installer run over an installed copy) asks the Agent to stop first, as the
uninstaller does (`OnBeforeUpdateFastCallback`, 15 s budget, a line in `logs\update.log`). The hook runs in the
version being replaced, so it first works for the update after beta.14.
- **The apply waits while a game still has the Overlay loaded** from the install folder (`Update/PayloadInUse`: a mapped
image refuses an exclusive write — a file-system question, no process opened). The Overlay is never unloaded from a
live game (`17_HOOK_ENGINE`), so after a mid-game stop the swap would fail half way after the App had quit. Asked before
the Agent is stopped; the strip names the file.
- **An Agent waiting on the administrator prompt** (the logon task's, the admin mode) holds only its elevation marker, not
the instance lock; the apply now waits for either (`UpdateService.AgentHolds`).
- **The stop budget is the Agent's own shutdown grace and five seconds** (`IpcProtocol.AgentShutdownGrace`, 15 s, which
the Agent's host now reads too): the App waited 10 s for an Agent that took up to 15 to finalize its sessions.
- **The offer says the download Velopack will make:** the deltas from the installed version when the feed has them
(`UpdateInfo.DeltasToTarget`; 1.6 MB for beta.12 → beta.13) and the full package as the fallback — it said ~102 MB.
Velopack's own lines are in the App's log since beta.14 (`velopack: …`, `VelopackSerilogLogger`), so whether a delta
or the full package came is in the bug report too.
- **Smaller:** an `IOException` is "offline" only from the network (`HttpIOException`, a socket error) — a full disk
read as offline; the uninstaller removes the "Start FrameLedger with Windows" Run value, which named an executable it
deletes.
**What none of this reaches:** a copy still on 0.1.0-beta.13 or older runs its own code for the update to beta.14 —
stable by default, apply-at-start on. Its user chooses *Beta* in Settings ▸ Updates and updates with no game running
(the beta.14 release notes say so); everything above holds from beta.14 on.
`UpdateServiceTests` (App.Tests/Update) cover the two skips, the channels, Deferred ↔ Ready, each error row, and
the apply's three endings; `UpdateFailureMapperTests` the table; `UninstallHookTests` the hook; a real feed has
not been exercised — the first tag is the measurement (`13_CI_CD` §release.yml).
the apply's three endings; `UpdateFailureMapperTests` the table; `UninstallHookTests` the hook; ~~a real feed has
not been exercised — the first tag is the measurement~~ *(corrected 2026-10-04: the feed has existed since
v0.1.0-beta.1, 2026-09-16, and every release since carries `releases.win.json`; whether an installed copy has updated
through it is not recorded here)*
(`13_CI_CD` §release.yml).
+95 -21
View File
@@ -5,7 +5,7 @@ Mixed toolchain: .NET 10 for managed projects, MSVC for the native layer.
## Prerequisites
- Windows 11 (dev), **.NET 10 SDK**, **Visual Studio 2026** with: .NET desktop development, **Desktop development with C++** (MSVC v143+, Windows 11 SDK ≥ 10.0.22621), C++ ATL not required.
- **Vulkan SDK** (for the layer + validation layers during development).
- **Vulkan SDK** (~~for the layer +~~ validation layers during development, and to run `tools/vklayer-blastradius.ps1`) *(corrected 2026-10-04: the layer builds against the vendored `third_party/vulkan-headers`; CI installs no SDK)*.
- CMake ≥ 3.28 (native projects use CMake; consumed by the solution via a build target — see below).
- Optional: PawnIO for CPU-temperature testing; an NVIDIA GPU for the NVAPI/Reflex paths (dev machine: RTX 5080). AMD/Intel telemetry paths need no SDK — if you have such hardware, testing L1/L2 coverage there is valuable.
- **No admin needed for normal development.** `FL_MOCK=1` is **specified but not implemented** — `grep -rn FL_MOCK src tests tools build.ps1` returns nothing (CLAUDE.md §Dev mode records the same, and this line contradicted it in the present tense until 2026-08-05). When it exists it runs the whole app with a synthetic source and zero injection. Until then the no-injection development path is `hook-harness`, which needs no admin either.
@@ -23,8 +23,9 @@ Targets:
- `FrameLedger.Overlay` → `FrameLedger.Overlay.dll`
- `FrameLedger.VkLayer` → `FrameLedger.VkLayer.dll` + `VkLayer_FRAMELEDGER_overlay.json`
- `FrameLedger.Injector` → **static lib only.** There is no `FrameLedger.Injector.exe` and none ships (`20_OPEN_QUESTIONS` §S9, decided 2026-08-02). A standalone `LoadLibraryW` injector that users can run is a path into a game process that the guard does not stand in front of — a bypass, and a bad look for a project whose position is "we refuse where we are not welcome". The Agent links the static lib; the guard owns the chokepoint inside it (§S13(b)), so there is no callable entry point that skips the gate. Manual testing uses `hook-harness`, never a real game (§Debugging).
- `FrameLedger.NvapiBridge` → `FrameLedger.NvapiBridge.dll` (**2026-09-10, P2 PR-E2**): the C ABI the Agent reaches NVAPI through (`18_GPU_VENDOR_APIS` §L3) and the **only shipped binary that links `nvapi64.lib`**. Read-only by construction, loaded by the Agent into **its own process** by absolute path through `/FrameLedger.NvapiBridge.targets`, and **never into a game** — its name carries none of the words the guard's §S18 heuristic scans for. `fl_native_flags` only, not the hostile-environment set. `versioninfo-check.ps1` requires its version block like the other three shipped natives. ctest `fl_nvapi_bridge` (`src/native/tests/nvapi_bridge_test.cpp`) exercises every export and requires `BRANCH: AVAILABLE` or `BRANCH: DEGRADED` in the output, so a bridge gutted to `return 0` is red on a runner without the driver too.
- `FrameLedger.Overlay.Tests` → Catch2 unit tests (ring buffer, record layout, fault filter, seqlock) **and the guard's fail-closed matrix** (`14_TESTING` §Safety-guard tests) — the guard is native, so its tests are too
- `FrameLedger.NvapiBridge` → `FrameLedger.NvapiBridge.dll` (**2026-09-10, P2 PR-E2**): the C ABI the Agent reaches NVAPI through (`18_GPU_VENDOR_APIS` §L3) and the **only shipped binary that links `nvapi64.lib`**. Read-only by construction, loaded by the Agent into **its own process** by absolute path through `/FrameLedger.NvapiBridge.targets`, and **never into a game** — its name carries none of the words the guard's §S18 heuristic scans for. `fl_native_flags` only, not the hostile-environment set. `versioninfo-check.ps1` requires its version block like the other ~~three~~ shipped natives (five in all since beta.12 — corrected 2026-10-04). ctest `fl_nvapi_bridge` (`src/native/tests/nvapi_bridge_test.cpp`) exercises every export and requires `BRANCH: AVAILABLE` or `BRANCH: DEGRADED` in the output, so a bridge gutted to `return 0` is red on a runner without the driver too.
- `FrameLedger.Guard` → `FrameLedger.Guard.dll` (the guard's C ABI over the Injector library, `src/native/FrameLedger.Injector/CMakeLists.txt`; loaded by the Agent) and `FrameLedger.ProcessStats` → `FrameLedger.ProcessStats.dll` (beta.12, D43: the game process's memory, read by the Agent from outside the game; probe `fl-probe-processstats`) *(both bullets added 2026-10-04; they were missing)*
- ~~`FrameLedger.Overlay.Tests`~~ the ctest executables in `src/native/tests/` (`fl_ring_test`, `fl_guard_test`, `fl_vklayer_test`, … — corrected 2026-10-04: no target of that name has existed) → Catch2 unit tests (ring buffer, record layout, fault filter, seqlock) **and the guard's fail-closed matrix** (`14_TESTING` §Safety-guard tests) — the guard is native, so its tests are too
- `hook-harness` → the dummy **D3D11 + D3D12** app, WARP + composition swapchain so it runs headless on CI (`17_HOOK_ENGINE` §Test harness). D3D12 is device → command queue → swapchain, which is the acquisition asymmetry a D3D11-only fixture cannot exercise. ~~Vulkan and OpenGL modes to follow as those hooks land.~~ **`--vulkan --hold-presenting N` since 2026-09-06 (P1 item 3):** a real swapchain on a hidden window through the real loader, reached by `LoadLibraryW("vulkan-1.dll")` so only the vendored headers are needed and CI (no loader) still builds it; exit 77 = cannot run here, which the ctest reads as SKIP. **`--opengl --hold-presenting N` since the same day (P1 item 4):** a real context on a hidden window, `SwapBuffers`'d through gdi32 as a title does, on Microsoft's generic renderer — so it runs on CI.
- `fl-probe-hookprofile` → build-profile probes for `/guard:cf` and `-D_HAS_EXCEPTIONS=0` (`20_OPEN_QUESTIONS` §H1/§H3)
- `fl-probe-guard` → measures the Windows APIs the guard is built on, unelevated (`spike-notes.md` §1). Not the guard, and takes no injection rights.
@@ -43,7 +44,7 @@ Compiler/linker flags (enforced in CMake, not per-target ad hoc): `/std:c++20 /M
**No AMD or Intel GPU *telemetry* SDK is vendored.** Those vendors' sensors are covered by LibreHardwareMonitor and the DXGI/PDH baseline (`18_GPU_VENDOR_APIS`). A build that pulls in Intel IGCL or AMD ADLX material is a licensing regression, not a feature — CI greps for it. **The AMD FidelityFX ffx-api headers (MIT by exception, tag v2.3.0) ARE vendored since 2026-09-04**, for the Overlay's upscaler hook and for types only — `fl_fidelityfx_headers` above, `18_GPU_VENDOR_APIS` §AMD for the licence reading, and `license-check.ps1` §2d for the per-file gate. Intel's XeSS SDK failed the checklist and nothing of it is here.
**VERSIONINFO is mandatory** on `FrameLedger.Overlay.dll` and `FrameLedger.VkLayer.dll`: real `CompanyName`, `ProductName=FrameLedger`, `FileDescription`, version. Identifiability is a requirement (`19_SAFETY`), and a CI check fails the build if the resource block is missing.
**VERSIONINFO is mandatory** on ~~`FrameLedger.Overlay.dll` and `FrameLedger.VkLayer.dll`~~ every shipped native — the five `tools/versioninfo-check.ps1` lists (corrected 2026-10-04): real `CompanyName`, `ProductName=FrameLedger`, `FileDescription`, version. Identifiability is a requirement (`19_SAFETY`), and a CI check fails the build if the resource block is missing. **Since beta.14 (D50) the managed binaries are held to the same** — §Version, *Identity*.
## Managed build & native integration
@@ -55,7 +56,7 @@ Compiler/linker flags (enforced in CMake, not per-target ad hoc): `/std:c++20 /M
> **`RuntimeIdentifier` is NOT set here, and this bullet claimed it was until 2026-08-06.** The props file's own comment explains why: forcing a RID onto class libraries pulls RID-specific assets into their restore for no benefit, so each executable sets it — `FrameLedger.App`, `FrameLedger.Agent` and now `FrameLedger.CaptureHost`, plus its test project, which needs the same RID to reference a RID'd exe. A new project copying this document rather than the props file would have inherited nothing.
- Nullable enable, ImplicitUsings enable, `TreatWarningsAsErrors=true`, `AnalysisLevel=latest-all`, deterministic, `ContinuousIntegrationBuild` on CI.
- `Directory.Packages.props`: central package management, all versions pinned (including `WPF-UI` = 4.3.0 exactly — `16_WPFUI_SYNTAX` §Version hygiene).
- **Native output reaches the managed side through `.targets` files imported by `FrameLedger.Agent`**, not through `FrameLedger.Infrastructure`: `/FrameLedger.Guard.targets` (the guard DLL), `/FrameLedger.Overlay.targets` (the payload, §S22), `/FrameLedger.Rules.targets` (the blocklist seed) and, since 2026-09-10, `/FrameLedger.NvapiBridge.targets` (the L3 bridge; it **warns rather than fails** when the DLL is absent, because a missing telemetry layer reports itself where a missing guard would be a safety hole). Ordering comes from `build.ps1`, which runs the native build first — **not** from the solution: `FrameLedger.slnx` contains no native project.
- **Native output reaches the managed side through `.targets` files imported by `FrameLedger.Agent`**, not through `FrameLedger.Infrastructure`: `/FrameLedger.Guard.targets` (the guard DLL), `/FrameLedger.Overlay.targets` (the payload, §S22), `/FrameLedger.Rules.targets` (the blocklist seed) and, since 2026-09-10, `/FrameLedger.NvapiBridge.targets` (the L3 bridge; it **warns rather than fails** when the DLL is absent, because a missing telemetry layer reports itself where a missing guard would be a safety hole), and since beta.12 `/FrameLedger.ProcessStats.targets` (the game-memory reader, D43; it also warns rather than fails — an absent reader reads N/A; added 2026-10-04). Ordering comes from `build.ps1`, which runs the native build first — **not** from the solution: `FrameLedger.slnx` contains no native project.
> **This bullet was wrong in four ways and is corrected 2026-08-04.** It named a copy of `FrameLedger.Injector.exe`, which §S9 closed and which line 25 above says does not exist, 24 lines earlier in the same document. It attributed the copying to a build target in `FrameLedger.Infrastructure.csproj`, which contains no `<Target>` at all. It said the copies happen there, when the guard DLL was deliberately moved out to a `.targets` file so it would stop flowing to every referencing project (§S18 blocker 3). And it credited the solution with an ordering the solution cannot express.
- **Struct mirror check — ✅ built 2026-08-05.** `ShmLayoutMirrorTests` runs `tools/fl-layout-dump`, reads its JSON, and asserts size plus every field offset against the C# `[StructLayout]` mirrors in `FrameLedger.Shared` — in **both directions**, so a field on either side alone fails. It also asserts blittability, which offsets cannot see. The `struct-mirror` gate reads the run's `.trx` and fails when that test class did not execute, so deleting the test is red as well as breaking it. Struct drift between the two layers is the most dangerous silent bug in this architecture; the build now genuinely catches it.
@@ -64,10 +65,25 @@ Compiler/linker flags (enforced in CMake, not per-target ad hoc): `/std:c++20 /M
## Debugging
Launch profiles:
- **"UI + Mock"** — `FL_MOCK=1`, no Agent, no injection. Default for UI work.
- **"UI + Agent"** — both managed processes, real capture against `hook-harness`.
- **"Harness + Overlay"** — starts `hook-harness` under the debugger with the Overlay injected at launch; attach a second native debugger to step hook code.
~~Launch profiles:~~
- ~~**"UI + Mock"** — `FL_MOCK=1`, no Agent, no injection. Default for UI work.~~
- ~~**"UI + Agent"** — both managed processes, real capture against `hook-harness`.~~
- ~~**"Harness + Overlay"** — starts `hook-harness` under the debugger with the Overlay injected at launch; attach a second native debugger to step hook code.~~
*(Corrected 2026-10-04: none of these is committed, and "UI + Mock" needs `FL_MOCK`, which §Prerequisites says is not
implemented. What exists: `FrameLedger.exe` starts `FrameLedger.Agent.exe --serve` beside itself. To capture against the
harness, run `hook-harness.exe --real --hold-presenting N`, then the Agent's `--console --data-dir <scratch>` verbs
`consent grant --exe` and `capture --exe`, as `AgentEndToEndTests` does — never against your own data folder.)*
**To look at real data with a build of your own (beta.15, D52): `FrameLedger.exe --data-dir <copy>`.** Make the copy with
SQLite's online backup, which is consistent while the Agent writes — in Python,
`sqlite3.connect("file:C:/Users/<you>/AppData/Local/FrameLedger/ledger.db?mode=ro", uri=True).backup(sqlite3.connect(r"<copy>\ledger.db"))`
— or copy the whole folder with every FrameLedger process stopped
(closing the App does not stop the Agent). A copy of the database alone has no `covers\`: the games whose image the user
chose show the store's artwork instead (beta.23), and choosing one in the viewer writes into the copy's own `covers\`. The App opens the copy, migrating it if your build is newer, which is exactly
why it must be a copy, and writes its log and crash dumps beside it. It is a viewer: no Agent is started or contacted and
nothing on the PC is changed (`08_UI` §Shell). It refuses the profile's own folder however it is spelled, and a folder
that does not exist.
**Toolchain gotchas, both hit on a real machine and both handled by `build.ps1`:**
@@ -88,7 +104,7 @@ Launch profiles:
Native debugging notes: use **`hook-harness`, never a real game**, for step-through debugging — a breakpoint inside a present hook of a real game freezes it in ways anti-cheat and drivers both dislike. Enable the Vulkan validation layers when touching `FrameLedger.VkLayer`. Application Verifier + PageHeap on the harness catches ring-buffer bugs early.
Agent flags: `--serve`, `--console`, ~~`--diag`~~ (the App's — `FrameLedger.exe --diag`, `10_LOGGING`; the Agent answers exit 2 for it), `--install-task`, `--uninstall-task`, `--register-vklayer`, `--unregister-vklayer` (all four real since 2026-09-14, P3 PR-8b: the task is `\FrameLedger\FrameLedger.Agent` through the Task Scheduler COM API — `schtasks /Create /SC ONLOGON` is "Access is denied" unelevated on the dev box, measured — this user's logon trigger, interactive token, lowest run level; the layer registration is `17_HOOK_ENGINE` §Vulkan's HKCU value).
Agent flags: `--serve` (since beta.10 with at most one of `--for-user <SID>` — the account an Agent started as administrator must be, else it exits 11 — or `--elevation declined|other-account|failed` — its starter asked Windows and got this; both from the admin mode, `01_ARCHITECTURE` ADR-9), `--console`, `--write-crash-dump <file>` (2026-09-17: the crash-dump helper a crashing App or Agent starts; it dumps its parent and takes no pid — `10_LOGGING` §Crash handling), ~~`--diag`~~ (the App's — `FrameLedger.exe --diag`, `10_LOGGING`; the Agent answers exit 2 for it), `--install-task`, `--uninstall-task`, `--register-vklayer`, `--unregister-vklayer` (all four real since 2026-09-14, P3 PR-8b: the task is `\FrameLedger\FrameLedger.Agent` through the Task Scheduler COM API — `schtasks /Create /SC ONLOGON` is "Access is denied" unelevated on the dev box, measured — this user's logon trigger, interactive token, lowest run level; the layer registration is `17_HOOK_ENGINE` §Vulkan's HKCU value).
> **Built 2026-09-10 (P2 PR-F): `--serve` and `--console`; the other five answer "not implemented in P2"
> with exit 2** rather than being silently accepted (`--diag` is the App's anyway, `10_LOGGING`). The console
@@ -100,6 +116,17 @@ Agent flags: `--serve`, `--console`, ~~`--diag`~~ (the App's — `FrameLedger.ex
> shipped `FrameLedger.Agent.exe` against `hook-harness` with a scratch `--data-dir` and reads the one
> `sessions` row back — the milestone's technical half, in the merge gate.
> **The print verbs open the ledger read-only (2026-09-16).** `sessions`, `consent list` and `killswitch status`
> migrate nothing and refuse — exit 7, the reason on stderr — a ledger at a schema older or newer than the build;
> `db path` opens no file at all. Until then every verb went through the migrating open, and `sessions` run against
> the owner's ledger applied two scripts to it (`06_DATA_MODEL` §Migrations). `AgentReadOnlyVerbsTests` pins the set.
> **One capturing process per data folder (2026-09-17).** `--serve`, `capture`, `launch` and `recover` claim the data
> folder (`AgentInstanceLock`) before logging, rules or the ledger, and exit **10** — one line on stderr, nothing
> written — when another process holds it; the other verbs run beside a serving Agent, as the App's `--install-task`
> does. `OneAgentPerDataFolderTests` runs the shipped binary against a claimed scratch folder
> (`01_ARCHITECTURE` §Lifecycle).
## Bundled assets
- ~~`assets/native/PresentMon.exe` (pinned, SHA-256 verified at build) for the Tier-2 fallback~~ — **DROPPED 2026-08-27, and there are no bundled native assets at all.** §S31 measured PresentMon classifying every frame of a ×4 capture as an application frame (row P2); the owner then dropped it outright. It is not bundled, not fetched, not used, and `tools/frametype-oracle.ps1` — the parser that consumed its output — is deleted with it. `assets/` does not exist and now has no reason to. **And since 2026-08-28 Tier 2 is not a measurement at all**: the ladder is two rungs, `EtwFrameSource` is deleted from the design, and whether a shipped build ever regains a no-injection measurement is `20_OPEN_QUESTIONS` §G.
@@ -153,6 +180,29 @@ two products claiming to be one.
- `release.yml` refuses a tag whose numeric core is not the file's. Bumping the version is one edit to
`VERSION`, in the same commit as the changelog section, before the tag.
**Identity (beta.14, D50).** Every binary names the product, says what it is and carries one copyright line. Until
beta.14 only the native blocks did: the managed ones carried the SDK's defaults — the Agent's company and product read
`FrameLedger.Agent`, each library's its own assembly name — and no copyright, and those blocks are what Explorer's
*Properties ▸ Details* and Task Manager show (Task Manager lists the Agent by its file description).
| Field | Native (`src/native/CMakeLists.txt`) | Managed (`Directory.Build.props`, the two entry points' csproj) |
|---|---|---|
| CompanyName, ProductName | `FL_COMPANY_NAME`, `FL_PRODUCT_NAME` = `FrameLedger` | `Company`, `Product` = `FrameLedger` |
| LegalCopyright | `FL_COPYRIGHT` | `Copyright` — the same line, word for word |
| FileDescription | each target's `fl_add_version_resource` description | `AssemblyTitle`: `FrameLedger` (App), `FrameLedger Agent` (Agent); a library keeps its assembly name |
| Comments | the identification sentence | `Description` — the same sentence for a library, a line of its own for each entry point |
| FileVersion / ProductVersion | the numeric core, `x.y.z.0` | `x.y.z.0` / the full version (`-p:Version`, a pre-release's tag included) |
| OriginalFilename | the file's own name | the assembly's (`FrameLedger.dll`) — the apphost `.exe` carries a copy of its assembly's block |
Also stamped on every assembly: `AssemblyMetadata("RepositoryUrl")` (the SDK, from `RepositoryUrl`; the App test holds
it equal to `IssueLink.Repository`) and, when `release.yml` passes it, `FrameLedgerSourceRef` — the App csproj's alone
until beta.14, now `Directory.Build.props`', and passed to both publishes. `tools/versioninfo-check.ps1` reads all of it
from the BUILT binaries — the native five and, with `-ManagedDir`, the managed eight (`FrameLedger.exe`/`.dll`,
`FrameLedger.Agent.exe`/`.dll`, Domain, Application, Infrastructure, Shared) — and is red when a copyright differs
anywhere, when a managed `ProductVersion` is not `-ExpectedProductVersion` (required: a comparison with nothing passes
everything), or when an apphost does not carry its assembly's block; its `-SelfTest` (ten cases, nine RED, each for the
reason it names) runs first. `AssemblyIdentityTests` (App and Agent) pins the source against `FL_COPYRIGHT`.
The Velopack package version is the tag's (`vpk pack --packVersion`), and `UpdateManager.CurrentVersion` reads
the installed package's manifest — not the assembly — which is why the two are made to agree here rather than
assumed to.
@@ -161,15 +211,20 @@ assumed to.
```
cmake --build --preset x64-release
dotnet publish src/FrameLedger.App -c Release -r win-x64 --self-contained -p:PublishReadyToRun=true -o out/app
dotnet publish src/FrameLedger.Agent -c Release -r win-x64 --self-contained -p:PublishReadyToRun=true -o out/app
vpk pack --packId FrameLedger.App --packVersion {ver} --packDir out/app --mainExe FrameLedger.exe --packTitle FrameLedger --releaseNotes out/notes.md --outputDir out/release
dotnet publish src/FrameLedger.App -c Release -r win-x64 --self-contained -p:PublishReadyToRun=true -p:FrameLedgerSourceRef={tag} -o out/app
dotnet publish src/FrameLedger.Agent -c Release -r win-x64 --self-contained -p:PublishReadyToRun=true -p:FrameLedgerSourceRef={tag} -o out/app
vpk download github --repoUrl https://github.com/poli0981/frameledger --channel win --pre --outputDir out/release # beta.13: the previous release, for a delta
vpk pack --packId FrameLedger.App --packVersion {ver} --packDir out/app --mainExe FrameLedger.exe --packTitle FrameLedger --packAuthors FrameLedger --releaseNotes out/notes.md --outputDir out/release
```
> **Run by `release.yml` since 2026-09-14 (P4 PR-5)** — `13_CI_CD` §release.yml carries the steps around it
> (the version gate, `{{RELEASE_DATE}}`, the published-tree assertion, checksums, the release). Both publishes
> take `-p:Version=<tag>` (§Version). No `--icon`: `assets/icon.ico` does not exist, and this line named it
> for six weeks.
> for six weeks. **Since beta.12 the App also takes `-p:FrameLedgerSourceRef`** — the tag, or for a rehearsal the
> commit — stamped as assembly metadata so its links into the repository open THIS version's documents
> (`Services/RepositoryLinks`); a build without it links to `main`. **Since beta.14 the Agent takes it too**, because
> `Directory.Build.props` stamps it on every assembly and both publishes build the same libraries into `out/app` (§Version,
> *Identity*).
>
> **The package id is `FrameLedger.App`, and this line said `FrameLedger` until 2026-09-14 — which would have
> deleted every user's ledger on uninstall.** Velopack installs into `%LOCALAPPDATA%\<packId>` and removes that
@@ -203,8 +258,8 @@ vpk pack --packId FrameLedger.App --packVersion {ver} --packDir out/app --mainEx
> prevent.
- No trimming (WPF + reflection), no NativeAOT (WPF unsupported), **no obfuscation** (GPLv3 policy, and `19_SAFETY` forbids making our binaries harder to identify).
- `SatelliteResourceLanguages=en;vi;ja`. ~~Expected package ≈ 95–130 MB self-contained.~~ **Measured 2026-09-14 (P4 PR-5): the published tree is 250 MB in 362 files** (App + Agent, self-contained, ReadyToRun roughly doubles the IL). `vpk pack` 1.2.0 over that tree, run by hand the same day with the workflow's arguments: `FrameLedger.App-win-Setup.exe` **104 MB**, the full `.nupkg` and the portable zip 100 MB each, plus `releases.win.json` / `RELEASES` / `assets.win.json`; vpk's own pre-process step verified `VelopackApp.Run()` in `FrameLedger.App.Program::Main()`.
- Velopack hooks (**built 2026-09-14, P4 PR-5**: `App/Update/VelopackHooks`, wired in the hand-written `Program.Main` before any window). **Install registers nothing** — the first-run flow is the offer (Agent setup), and the layer follows the ledger (§The Vulkan layer is not registered at install time); this line used to say "offer Agent setup + Vulkan layer registration", and the second half was the thing the section below forbids. Uninstall runs `UninstallHook`: `Shutdown` to a running Agent over the pipe (best effort, it holds the install directory), unregister the layer (HKCU), remove the logon task, then **ask** about the data folder — deleted on Yes only, never when it and the install overlap (`AreSeparate`), and a question unanswered inside Velopack's 30 s callback budget keeps it.
- `SatelliteResourceLanguages=en;vi;ja`. ~~Expected package ≈ 95–130 MB self-contained.~~ **Measured 2026-09-14 (P4 PR-5): the published tree is 250 MB in 362 files** (App + Agent, self-contained, ReadyToRun roughly doubles the IL). `vpk pack` 1.2.0 over that tree, run by hand the same day with the workflow's arguments: `FrameLedger.App-win-Setup.exe` **104 MB**, the full `.nupkg` and the portable zip 100 MB each, plus `releases.win.json` / `RELEASES` / `assets.win.json`; vpk's own pre-process step verified `VelopackApp.Run()` in `FrameLedger.App.Program::Main()`. **From the hosted runner on the first tag (2026-09-16, `v0.1.0-beta.1`):** the tree 252 MB, `Setup.exe` 110 MB, the nupkg and the zip 105 MB — the same shape, a few MB heavier for two more days of code.
- Velopack hooks (**built 2026-09-14, P4 PR-5**: `App/Update/VelopackHooks`, wired in the hand-written `Program.Main` before any window; since beta.14 Velopack's apply-at-start is off and an update it starts itself stops the Agent first — `11_UPDATER` §The update audit). **Install registers nothing** — the first-run flow is the offer (Agent setup), and the layer follows the ledger (§The Vulkan layer is not registered at install time); this line used to say "offer Agent setup + Vulkan layer registration", and the second half was the thing the section below forbids. Uninstall runs `UninstallHook`: `Shutdown` to a running Agent over the pipe (best effort, it holds the install directory), unregister the layer (HKCU), remove the logon task, remove the *Start FrameLedger with Windows* Run value (beta.14 — it named the executable being deleted), then **ask** about the data folder — deleted on Yes only, never when it and the install overlap (`AreSeparate`), and a question unanswered inside Velopack's 30 s callback budget keeps it.
## Release-time token substitution
@@ -212,33 +267,52 @@ vpk pack --packId FrameLedger.App --packVersion {ver} --packDir out/app --mainEx
the repository, and it is deliberate: the effective date of a legal document is
the date it ships, which is not knowable at authoring time. `release.yml` (**built 2026-09-14**, P4 PR-5 — the step runs before the
build, because the App embeds `legal/*.md`)
substitutes it with the tag date when packaging, and `ci.yml` fails the build if
substitutes it with ~~the tag date~~ the run's UTC date (corrected 2026-10-04) when packaging, and `ci.yml` fails the build if
**any other** `{{` token appears in `README.md` or `legal/*.md` (`13_CI_CD.md`
§ci.yml). Everything else — repository URL, slug, developer identity, contact
address — is resolved in the source files, because an unsubstituted token in a
document the app displays for acceptance (FR-11) is a defect, not a template.
**The build id is read before it (beta.18).** The substitution edits tracked files, and the native build id is
`git describe --dirty` at CMake's configure (`src/native/FrameLedger.Shm/CMakeLists.txt`): every release until beta.18
shipped `<tag>-dirty` — the owner's Dashboard read *Overlay build v0.1.0-beta.17-dirty*, and that run's log printed
`FL_BUILD_ID = v0.1.0-beta.17-dirty` two lines after `RELEASE_DATE = 2026-10-07 in 3 file(s)`. `release.yml` now reads
describe from the clean checkout first, refuses one that is already dirty or longer than 31 characters, and passes it
as the environment's `FL_BUILD_ID`, which CMake takes as given (checked for the characters a C string literal carries);
after the publish, `tools/buildid-check.ps1` reads it back out of the four native binaries that compile it, by their
bytes — nothing is loaded. A developer's build still runs describe itself (`+` marks a dirty tree when the long form
would not fit).
## Local quality gate (pre-push)
`./build.ps1 check`:
1. `cmake --build --preset x64-release` (C++ `/W4 /WX`)
1. `cmake --build --preset x64-release` (C++ `/W4 /WX`) — since beta.12 also `FrameLedger.ProcessStats.dll` (the game
process's memory, D43; staged beside the Agent, CaptureHost and Infrastructure.Tests by
`FrameLedger.ProcessStats.targets`), its ctest `fl_process_stats` (GPU_INSTANCE on a machine with a hardware adapter,
NO_GPU_INSTANCE elsewhere) and the instrument `fl-probe-processstats` (`spike-notes` §16)
2. native tests (Catch2)
3. `clang-format --dry-run -Werror` over `src/native`
4. `dotnet restore` + build (warnings as errors)
5. `dotnet format --verify-no-changes`
6. `dotnet test --logger trx` — including `ShmLayoutMirrorTests`; with no switches it also runs the
`Category=Integration` classes, which CI excludes
`Category=Integration` classes, ~~which CI excludes~~ which CI runs too *(corrected 2026-10-04: `ci.yml` and
`release.yml` call `./build.ps1 check` with no switches since 2026-09-06, as the paragraph after this list says;
only `-SkipIntegration`, which nobody passes, leaves them out, loudly)*
7. `tools/coverage-gate.ps1` — reads this run's cobertura reports; self-arming, and armed today for
`FrameLedger.Domain` and `FrameLedger.Application`
8. `tools/rules-validate.ps1` (schema + `anticheat` block sanity — a malformed or empty blocklist is a safety bug)
9. `tools/versioninfo-check.ps1` — reads the built binary, because what ships is what an anti-cheat vendor sees; since P4 PR-5 it also compares every `FileVersion` against the `VERSION` file (§Version)
9. `tools/versioninfo-check.ps1` — reads the built binary, because what ships is what an anti-cheat vendor sees; since P4 PR-5 it also compares every `FileVersion` against the `VERSION` file (§Version); **since beta.14 (D50) both halves run — the self-test, then the native five and the managed eight from the App's and the Agent's build output** (`-ManagedDir`, `-ExpectedProductVersion` = `VERSION`), one copyright across all of them (§Version, *Identity*). Under `-SkipNative` the managed half still runs
10. `tools/chokepoint-check.ps1` — injection and evasion primitives confined to one file, native **and** managed, plus the `FL_GUARD_TESTABLE` symbol check against the shipped artifacts
11. **`tools/hookinventory-check.ps1`** — three passes: A resolves every vendor symbol the Overlay names against `docs/vendor-exports.json`, B sweeps for stray literals, C reads the BUILT Overlay's import table and asserts it imports no vendor module. C skips loudly under `-SkipNative`. **Missing from this list until 2026-08-28**, which is §R10 happening again
12. **`tools/package-closure-check.ps1`** — both halves: the self-test (5 cases, 4 of which must go RED) **and** a live pass over this repository. It walks the transitive `ProjectReference` closure of the two publish roots below and fails on anything outside the allowlist, naming the reference edge. `FrameLedger.CaptureHost` is an injecting entry point kept out of the package by construction, and `20_OPEN_QUESTIONS` §S27 is closed on exactly that basis
13. `tools/license-check.ps1` — asserts every vendored third-party has a licence copy in `legal/licenses/`, and that no Intel IGCL / AMD ADLX material has appeared in the tree; since P4 PR-6 (§3) also that `legal/licenses/nuget/` is exactly what `tools/license-gather.ps1` writes for this build's restore output — every NuGet package the App and the Agent ship (77), both directions. `license-gather.ps1 -SelfTest` runs first: fourteen fixture cases, five that must be RED (a hand edit, a package that no longer ships, a URL-only licence with no reviewed override, an applied MPL Exhibit B, a missing restore output), and one run under tr-TR in a child process, because the output must not depend on the machine's culture
13. `tools/license-check.ps1` — asserts every vendored third-party has a licence copy in `legal/licenses/`, and that no Intel IGCL / AMD ADLX material has appeared in the tree; since P4 PR-6 (§3) also that `legal/licenses/nuget/` is exactly what `tools/license-gather.ps1` writes for this build's restore output — every NuGet package the App and the Agent ship (77), both directions. `license-gather.ps1 -SelfTest` runs first: ~~fourteen~~ sixteen fixture cases, ~~five~~ six that must be RED (a hand edit, a package that no longer ships, a URL-only licence with no reviewed override, an expression with no text in the script and no reviewed override, an applied MPL Exhibit B, a missing restore output), and one run under tr-TR in a child process, because the output must not depend on the machine's culture. **Since beta.12 (78 packages):** a reviewed override also answers for an expression the script has no text for — Markdig declares BSD-2-Clause and ships no file, and `tools/license-overrides/Markdig.txt` is the project's own `license.txt` at the packaged commit
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
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). 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)
14c. **`tools/buildid-check.ps1 -SelfTest`** (beta.18) — eight cases, both directions: a binary built from a dirty tree (`-dirty`, or the short form's `+`), one with no id, a missing one, and an expected id that is dirty or not an id are red. The live half needs the release's clean-checkout id and runs in `release.yml` over the published tree (§Release-time token substitution)
15. `tools/resx-audit.ps1` — ~~**skipped loudly; it does not exist, and no `.resx` file does either**~~ **built 2026-09-13 (P3 PR-2)**: `-SelfTest` first (11 fixture cases, both directions), then the live pass over every `Strings.resx` family under `src/` — key sets equal across en/vi/ja, `Safety_*` in `ja` marked for review or signed, `Strings.Designer.cs` current with `tools/resx-gen.ps1`. A tree with no family is red (`09_I18N` §Translation workflow)
16. **struct-mirror** — reads this run's `.trx` and fails when `ShmLayoutMirrorTests` did not execute, so deleting the mirror test is red as well as breaking it
16b. **`tools/test-artifacts-check.ps1`** — `-SelfTest` first (seven cases, two RED), then live: an `overlay-*.log` created since this gate started, still in the real `%LOCALAPPDATA%\FrameLedger\logs` after the tests, whose first line names a `hook-harness*` image, fails the gate. It is what makes a test binary without its log sweep red (`17_HOOK_ENGINE` §Native logging, 2026-09-15); a game's log never counts
+126 -18
View File
@@ -6,7 +6,7 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
## Workflows (`.github/workflows/`)
### `ci.yml` — push to `main` + all PRs · **repo-local**
### `ci.yml` — push to `main` + all PRs + `workflow_dispatch` (added 2026-10-04) · **repo-local**
- `runs-on: windows-latest`, .NET SDK pinned by `global.json` via `actions/setup-dotnet`, MSVC via `ilammy/msvc-dev-cmd`, NuGet cached.
- Single step of substance: **`./build.ps1 check`** — the same script, with the same switches (none), a developer runs before pushing. The gate list lives in `12_BUILD` §Local quality gate, **once**, rather than being restated here where it goes stale.
- ~~**`-SkipIntegration` is the one place local and CI deliberately differ**~~ — **gone since 2026-09-06.** From 2026-08-05 CI passed it for a measured reason: §S16 puts the injecting process's ancestors in the scan set, a .NET test host loads `System.Security.Cryptography.ProtectedData.dll`, and the guard's `protect` fragment refused our own harness (§S19(b)). The signer half now verifies that module's embedded signature offline and reads `O=Microsoft Corporation` on the compiled-in bound, so the `Category=Integration` cases run here — **nine** when this was written, **20 across six classes** as of 2026-09-13 (Agent 6, CaptureHost 7, Infrastructure 7); count them with `grep -rl 'Category", "Integration' tests` rather than trusting either number — and a green CI IS evidence for the managed drain and the capture host's end-to-end behaviour. The switch remains in `build.ps1`, loud, for a developer who must.
@@ -26,6 +26,43 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
wrong by the end of the same evening; it is corrected rather than quietly deleted, because a frequency
claim made from one observation is exactly the shape this file keeps catching.
**Re-run before investigating**; if it reproduces, read the module list and the scan-set reason, not the test.
- **A hang, not a refusal — the first tag run (2026-09-16, run 35111939019).** Every suite green except
`Infrastructure.Tests`, which printed its "test run for …" line and nothing else for 58 minutes until the job's
60-minute limit cancelled the run; the same suite took 42 s in the rehearsal an hour earlier. The log named no
test. ~~`build.ps1` now passes `--blame-hang --blame-hang-timeout 15m --blame-hang-dump-type mini` to `dotnet test`,
so the next hang fails the run in 15 minutes with the test's name in `TestResults\…\Sequence.xml` and a mini
dump beside it — the diagnostic this run lacked. Which test hung is **unmeasured**; the re-run is the measurement.~~
**Found and fixed 2026-09-17.** Reproduced locally one run in eight; the xUnit verbose reporter of a hung run showed
thirteen tests started and none finished, one of them `CrashDumpWriterTests.WritesAMinidumpOfThisProcess…` — which
called `MiniDumpWriteDump` on its OWN process. That call suspends every other thread of the caller, and one holding
the heap or loader lock deadlocks the dumper: the whole test process froze, including xUnit's long-running-test
timer, which is why nothing was ever named. 40 runs without that test: no hang. **The same call was the product's
crash path**, in the App and the Agent — a real crash could have hung instead of dumping. Dumps are written by a
child process now (`Infrastructure.Diagnostics.ParentDump`, `FrameLedger.Agent.exe --write-crash-dump`; `10_LOGGING`
§Crash handling). And **`--blame-hang` did not stop the hung xUnit v3 executable** — still alive four minutes after
a 60 s hang timeout — so `build.ps1` runs `dotnet test` under a 25-minute wall-clock limit instead, kills the tree on
expiry, and names the test projects that wrote no `results.trx`. *(Measured on xUnit v3 3.2.2. The suites moved to
4.0.1 on 2026-09-21 as `xunit.v3.mtp-off`, still under VSTest; whether `--blame-hang` stops a hung 4.x executable is
unmeasured, and the wall clock stays either way.)*
- **Two more shapes had one cause, found and fixed 2026-09-16** after four failures in one evening's merge train:
`AKilledHostLeavesAPartialThatRecoverTurnsIntoAnInterruptedSession` ("the process cannot access the file …
`.partial`") and `WithNoConsentRecordTheHostRefusesAndNothingIsEverInjected` (a leftover consent record). The
suite's `Kill` helper returned before the killed host had released its files, so the next line read a `.partial`
the dead process still held, and the ledger delete in `Dispose` silently failed and left the record for the next
case. `Kill` now waits for exit (bounded, asserted) and the delete retries. Not §S19(b) either — a test-harness
race, and the third flake shape of the day (the registry-subtree race between `VkLayerRegistrationTests` and the
GOG reader's test, fixed in #188) was the same kind.
- **Two more on 2026-10-07 (beta.18), both re-run green and then fixed the same day.**
`WhenTheTargetExitsTheHostStopsAndSaysWhy` ended **`TargetNotRunning`** (#286, run 37619719203): the host resolves its
target once, as it starts, and a host slower than the harness's 6 s hold found it gone — the shape recorded since
2026-09-21. The hold is 15 s: a margin, not a signal, because the host prints nothing until its session ends.
`LaunchModeOnAVulkanTargetAttachesToTheLayersRingAndInjectsNothing` ended **`RefusedByGuard` / `ModuleScanFailed`**
(#288, run 37627351438): the hosted runner has the Vulkan loader and no device, so the harness exits 77 with a
`[SKIP]` line — but the runner is elevated, the host starts the harness through `CreateProcessWithTokenW`
(`UnelevatedProcess`), the child gets no stdout, and the line never reached the host's output; the test then
depended on the session reading `LaunchTargetExited`, and a scan that hit the dying harness failed it instead. The
test now asks the harness directly, before the host runs (exit 77 = skip, with the harness's own line); hiding the
Vulkan ICDs from that probe makes it skip in under a second, and on a machine with a device it runs in full.
- **A re-run ERASES the evidence, which is why the count above had to be kept by hand.**
`gh run rerun --failed` updates the original run's conclusion, so `gh run list` showed **18 success, 1
cancelled, 0 failed** across the twenty runs that contained all three failures above. Anyone measuring
@@ -55,8 +92,8 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
> `ShmLayoutMirrorTests` did not execute. `12_BUILD` carried the identical stale sentence and is
> corrected with it; restating the gate list in two documents is what let one of them rot.
- **Licence guard:** `tools/license-check` fails the build if a vendored dependency is missing its licence copy, or if Intel IGCL / AMD ADLX headers appear anywhere in the tree (`docs/18_GPU_VENDOR_APIS.md` §Vendor SDKs we deliberately do not use), or — since P4 PR-6 — if `legal/licenses/nuget/` is not what `tools/license-gather.ps1` writes for the NuGet packages this build ships. A Dependabot bump therefore goes red until someone re-runs the script and commits the texts, which is the point: the new version's licence is read by a person before it ships. Licensing regressions are silent and hard to unwind later — catch them at PR time.
- **Placeholder guard:** fails if any `{{` token survives in `README.md` or `legal/*.md`. Those are shipped, legally operative documents (FR-11 displays them in the first-run Legal Gate); an unsubstituted `{{DEVELOPER_NAME}}` in an EULA is not a cosmetic defect.
- `permissions: contents: read`.
- **Placeholder guard:** fails if any `{{` token survives in `README.md` or `legal/*.md` *(other than `{{RELEASE_DATE}}`, which `release.yml` substitutes — added 2026-10-04)*. Those are shipped, legally operative documents (FR-11 displays them in the first-run Legal Gate); an unsubstituted `{{DEVELOPER_NAME}}` in an EULA is not a cosmetic defect.
- ~~`permissions: contents: read`.~~ `permissions: contents: read, pull-requests: read` — the second for the Changelog step's list of a pull request's files, read-only *(corrected 2026-10-04)*.
### `codeql.yml` — push, PR, weekly cron · **repo-local**
@@ -69,11 +106,31 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
### `release.yml` — on tag `v*` · **repo-local, built 2026-09-14 (P4 PR-5)**
> **Exercised by a tag on 2026-09-16 — `v0.1.0-beta.1`, run 35111939019 — and the first attempt did not finish.**
> The version gate, the substitution and the quality gate ran; the quality gate then sat in `Infrastructure.Tests` for
> 58 minutes (every other suite green; the same suite 42 s in the rehearsal an hour before) until the job's 60-minute
> limit cancelled it, with no test named. `gh run rerun --failed` on the same tag: the gate in 11 minutes
> (Infrastructure 305 in 17 s), publish (252 MB tree), licences, the tree assertion, `vpk pack` (`Setup.exe` 110 MB,
> portable zip and full nupkg 105 MB), `SHA256SUMS.txt`, and the pre-release created with the section's notes and the
> checksums appended — <https://github.com/poli0981/frameledger/releases/tag/v0.1.0-beta.1>. Two things the tag taught:
> a tag run can be re-run in place after a flake (the Release step is idempotent up to the release existing — it did
> not, so nothing had to be deleted), and a hang eats the whole job budget silently, which is why #196 added
> `--blame-hang` to the gate. The paragraph below is the history as it stood.
>
> This heading said **PLANNED, NOT PRESENT** from 2026-08-06 until the workflow existed, with the note that
> "nothing in this repository has ever run `dotnet publish`". Still true of the *repository's history*: the
> workflow has not been exercised by a tag yet — its publish, tree assertion and `vpk pack` steps were run by hand on
> "nothing in this repository has ever run `dotnet publish`". ~~Still true of the *repository's history*: the
> workflow has not been exercised by a tag yet~~ (struck 2026-09-16, above) — its publish, tree assertion and `vpk pack` steps were run by hand on
> 2026-09-14 (`12_BUILD` §Publish & package has the sizes), the release upload was not. The first tag is the rest of the measurement; until then every other claim below is
> what the file says, not what a run showed.
>
> **A dry run exists since 2026-09-16 (P5 prep).** `workflow_dispatch` with a `version` input runs the identical
> job — gate, publish, runtime licences, tree assertion, `vpk pack`, checksums, the artifact upload — and skips only
> `gh release create`; no tag is made. Two things differ from a tag run, both deliberate: the version comes from the
> input (its numeric core must still equal `VERSION`), and a missing `## [x.y.z]` section is a printed warning with
> placeholder notes rather than a stop, because that section is written in the tag commit and a rehearsal precedes
> it. The artifact is `release-<version>-dry-run`. Run it with `gh workflow run release.yml -f version=0.1.0-beta.1`
> (on the branch that carries the file, `--ref <branch>`); the result is what the first tag will do, minus the
> upload. The rehearsal's outcome is recorded in `CHANGELOG.md` when it has run.
- `runs-on: windows-latest`, the same .NET / MSVC / clang-format pins as `ci.yml`, `permissions: contents: write`
(the Release API) and nothing else.
@@ -81,15 +138,27 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
`VERSION` file (`12_BUILD` §Version); and `CHANGELOG.md` must carry a **non-empty** `## [x.y.z]` section for the
full version, extracted by `tools/release-notes.ps1` (self-tested on every `build.ps1 check`). A missing
section is a red release, not an empty note — the ledger's header said the opposite for five weeks.
- **The build id from the clean checkout** (beta.18): `git describe --always --dirty --abbrev=12` before anything edits a
tracked file — a dirty one or one over 31 characters stops the run — into `FL_BUILD_ID` for CMake. Until beta.18 the
substitution below ran first and every release's natives called themselves `<tag>-dirty` (`12_BUILD` §Release-time
token substitution).
- `{{RELEASE_DATE}}` substituted in `legal/*.md` with the run's UTC date **before the build**, because the App
embeds those documents (FR-11); any `{{` token left anywhere after that fails the job.
- **The identical gate** — `./build.ps1 check`, native first, every tool including `versioninfo-check` against
`VERSION`. A release never skips it.
- `dotnet publish` App + Agent, self-contained + ReadyToRun, `-p:Version=<tag>`, into one `out/app`.
- **The published tree asserted by name**: `FrameLedger.exe`, `FrameLedger.Agent.exe`, the four shipped natives
`versioninfo-check` lists, `rules/detection-rules.json`; `FrameLedger.CaptureHost.exe` absent (`12_BUILD`:
- **The published tree asserted by name**: `FrameLedger.exe`, `FrameLedger.Agent.exe`, the ~~four~~ five shipped natives
`versioninfo-check` lists (`FrameLedger.ProcessStats.dll` since beta.12 — corrected 2026-10-04), `rules/detection-rules.json`; `FrameLedger.CaptureHost.exe` absent (`12_BUILD`:
exactly two roots — `package-closure-check` proves it statically, this reads the directory); `versioninfo-check`
run again over `out/app`, because a `.targets`-staged DLL that failed to copy is a warning to `dotnet publish`.
run again over `out/app`, because a `.targets`-staged DLL that failed to copy is a warning to `dotnet publish` —
**since beta.14 (D50) with its managed half** (`-ManagedDir out/app -ExpectedProductVersion <tag>`): the eight managed
binaries name FrameLedger, carry the tag's full version and the native binaries' copyright line (`12_BUILD` §Version,
*Identity*). Both publishes take `-p:FrameLedgerSourceRef` since beta.14.
- **since beta.13, `vpk download github --pre` first**, so `vpk pack` finds the previous release's full package in
`out/release` and writes a delta; after the pack, what `assets.win.json` names is kept and the rest (the previous full
package) moves to `out/previous`, the feed and `RELEASES` are filtered to this build, and a downloaded previous package
with no delta beside it fails the job. A failed download is a warning: the release is full-only, as every one before it
was (`11_UPDATER` §Built).
- `vpk pack --packId FrameLedger.App` (the `vpk` tool pinned to the library's 1.2.0) with the release notes;
`FrameLedger.App-win-Setup.exe` must come out, because README §Install names it. **Not `--packId FrameLedger`**:
Velopack installs into and uninstalls `%LOCALAPPDATA%\<packId>`, which with that id is the data folder
@@ -102,8 +171,8 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
- ~~Optional final step: submit installer hash to VirusTotal~~ — not built; an upload of the installer to a third
party is a decision the owner makes, not a step a workflow adds quietly.
### `rules-publish.yml` — on change to `rules/detection-rules.json` in `main`
- Runs `tools/rules-validate` and fails on anti-cheat removals. The raw file on `main` **is** the distribution endpoint (05_DETECTION), so this workflow only gates correctness.
### `rules-publish.yml` — ~~on change to `rules/detection-rules.json` in `main`~~ on a PR or push to `main` touching the rules file, its schema, `rules-validate.ps1` or this workflow (corrected 2026-10-04)
- Runs `tools/rules-validate` and fails on anti-cheat removals. ~~The raw file on `main` **is** the distribution endpoint (05_DETECTION), so this workflow only gates correctness.~~ *(Corrected 2026-10-04: there is no feed — §S20's feed half is deferred and nothing in `src` fetches. A rules change reaches users only inside a release, seeded by the Agent from the packaged copy; this workflow only gates correctness.)*
> **There is no `rulesVersion` bump check, and this line used to claim one.**
> `rules-validate.ps1` checks the field's *format* and nothing compares it
@@ -127,9 +196,32 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
> evaluator through the real probe. Both halves run on the same PR; only the
> coverage half fires on a rules-only change, which is why the two are
> described separately rather than as one gate.
- **The `anticheat` block gets extra scrutiny:** schema-valid, non-empty, no entry removed without a justification in the PR body. Removing a blocklist entry is a safety change and requires the same review as a security fix.
- **The `anticheat` block gets extra scrutiny:** schema-valid, non-empty, no entry removed without a justification in the PR body. Removing a blocklist entry is a safety change and requires the same review as a security fix. *(Added 2026-10-04: the PR-only removal step fails the job on any removal, a shrunk per-title list or an added trusted signer, whatever the body says — the justification is for the reviewer, and the job stays red.)*
- `permissions: contents: read`.
### `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
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.
- **When:** `workflow_run` on `Release`, completed — the job runs only when that run succeeded and was started by a
pushed `v*` tag, so a `workflow_dispatch` rehearsal of `release.yml` never publishes. It checks out the run's
`head_sha` (a `workflow_run` job runs `main`'s copy of this file) and links at `head_branch`, the tag. By hand:
`gh workflow run wiki.yml -f ref=main -f publish=false` builds, checks and uploads the pages as an artifact; with
`publish=true` it publishes them.
- **Why not a step of `release.yml`:** the release stays as it was, its rehearsal stays a pure rehearsal, and a wiki
that fails to publish is a red run of its own that can be re-run — a step after `gh release create` could never be
re-run, the release already existing. A release created with `GITHUB_TOKEN` fires no `release` event for other
workflows; `workflow_run` fires because the Release run itself was started by a tag push.
- **Publishing:** `gh auth setup-git`, a clone of `<repo>.wiki.git`, everything but `.git` replaced, a commit as
`github-actions[bot]` only when something changed, `git push origin HEAD:master` (the wiki's branch is `master`). A
page edited on the Wiki tab is overwritten at the next release: edit `wiki/` or `guide/`.
- `permissions: contents: write` — the repository's default workflow token is read-only (read from the API,
2026-10-07), and pushing to the wiki repository needs write.
## Dependabot (`.github/dependabot.yml`)
```yaml
@@ -149,13 +241,29 @@ Central package management makes Dependabot PRs single-file diffs.
## Branch & release policy
- `main` protected: CI + CodeQL required, linear history, no direct pushes.
- Release: in ONE commit, bump `VERSION` and move the `[Unreleased]` entries of `CHANGELOG.md` under `## [X.Y.Z] - date` (Keep a Changelog format) → tag `vX.Y.Z` → `release.yml` does the rest (and refuses a tag that disagrees with either file) → smoke-test the produced installer on a clean Win 10 VM + Win 11 (manual checklist in 14_TESTING §Release smoke).
- Release: in ONE commit, bump `VERSION` and move the `[Unreleased]` entries of `CHANGELOG.md` under `## [X.Y.Z] - date` (Keep a Changelog format) → tag `vX.Y.Z` → `release.yml` does the rest (and refuses a tag that disagrees with either file) *(corrected 2026-10-04: for a pre-release tag `vX.Y.Z-beta.N`, do not bump `VERSION` — it already holds the numeric core the gate compares, and it read `0.1.0` through eleven betas; the section is `## [X.Y.Z-beta.N] - date`, the full version. Bump `VERSION` only when the numeric core moves)* → smoke-test the produced installer on a clean Win 10 VM + Win 11 (manual checklist in 14_TESTING §Release smoke).
- Pre-releases: `vX.Y.Z-beta.N` tags mark the GitHub release as pre-release; the App's `stable` channel ignores them and its `beta` channel (Settings ▸ Updates, `update.channel`) includes them — built with P4 PR-5, so ~~explicit beta channel is v2 backlog~~ is struck. The managed assemblies carry the full tag version; the native VERSIONINFO blocks carry the numeric core (`12_BUILD` §Version).
## Repo hygiene checklist (one-time setup)
## Repo hygiene checklist
- [ ] Add repo-local `ci.yml`; add caller stubs for CodeQL + release pointing at `poli0981/.github` with the explicit permissions above
- [ ] Enable Dependabot alerts + security updates
- [ ] Add `bug_report.yml`, `feature_request.yml` issue forms; PR template referencing CLAUDE.md definition-of-done
- [ ] Branch protection as above
- [ ] Repo topics: `windows`, `wpf`, `benchmark`, `fps`, `presentmon`, `game-performance`
> Rewritten 2026-09-16 (P5 prep). The list below had every box unticked while three of them were done in the
> tree, and its first box asked for caller stubs this file's own opening paragraph says were never the design.
> In-tree items are stated as done with their location; the rest are GitHub settings only the owner can set,
> listed as such rather than as work a PR could close.
**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] `.github/dependabot.yml` (nuget + github-actions, weekly)
- [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)
**GitHub settings — the owner's (`HANDOFF` §Owner-only):**
- [x] Branch protection as §Branch & release policy states *(marked 2026-10-04, read from the API: required checks `check`, `analyze (csharp, none)` and `analyze (cpp, manual)`; linear history; a pull request required; force pushes off; enforced for admins)*
- [ ] `Rules / validate` as a required check (§S23-2, after its skip-shim)
- [ ] Dependabot alerts + security updates (the manifest is in the tree; the alerts are a setting)
- [x] Private vulnerability reporting enabled (Settings ▸ Security), so `config.yml`'s link resolves *(marked 2026-10-04: GitHub reports it enabled)*
- [ ] Wiki editing restricted to collaborators (Settings ▸ General ▸ Features ▸ Wikis ▸ *Restrict editing to collaborators only*): otherwise anyone with a GitHub account can change a page until the next release overwrites it (§wiki.yml, beta.17)
- [ ] Repo topics: `windows`, `wpf`, `benchmark`, `fps`, `game-performance` (~~`presentmon`~~ — dropped 2026-08-27, §G)
+71 -6
View File
@@ -1,26 +1,34 @@
# 14 — Testing
Managed: xUnit + FluentAssertions + NSubstitute. Native: Catch2. Coverage goal ≥ 80% on `Domain` + `Application`; **Domain metric calculators ≥ 95% or the PR fails**.
Managed: xUnit.net v3 4.x (the `xunit.v3.mtp-off` variant since 2026-09-21 — `build.ps1` runs the suites under VSTest for the coverage collector and `results.trx`; `Directory.Packages.props` says why) + FluentAssertions 7.x + NSubstitute. Native: Catch2. Coverage goal ≥ 80% on `Domain` + `Application`; **Domain metric calculators ≥ 95% or the PR fails**.
## Safety-guard tests (highest priority — these protect users, not code quality)
The anti-cheat guard is the one component where a bug can cost someone an account. It gets the most rigorous treatment in the codebase:
**These are Catch2 tests, not xUnit.** `20_OPEN_QUESTIONS` §S13(a) settled the guard into the C++ `FrameLedger.Injector`, so the fail-closed matrix below lives in the native suite and the guard needs seams — injectable enumerator function pointers — before any of these failures can be forced at all. Landing Catch2 is a prerequisite of the guard, not a later nicety (§S15).
**These are Catch2 tests, not xUnit.** `20_OPEN_QUESTIONS` §S13(a) settled the guard into the C++ `FrameLedger.Injector`, so the fail-closed matrix below lives in the native suite and the guard needs seams — injectable enumerator function pointers — before any of these failures can be forced at all. ~~Landing Catch2 is a prerequisite of the guard, not a later nicety (§S15).~~ **Landed long since** — `ctest` runs ~~31~~ 32 native suites on every gate (`fl_process_stats` since beta.12 — corrected 2026-10-04) (`fl_guard` alone is ~100 s); the sentence was left in the future tense until 2026-09-21.
- Blocklist matching: exact, case-insensitive, prefix rules; every family in `19_SAFETY` §Blocklist seed has a fixture. Two families (Activision Ricochet, Valve VAC) have **no data yet**, so their fixtures must assert that absence explicitly rather than quietly passing on an empty rule set.
- Blocklist matching: exact, case-insensitive, prefix rules; every family in `19_SAFETY` §Blocklist seed has a fixture. ~~Two families (Activision Ricochet, Valve VAC) have **no data yet**, so their fixtures must assert that absence explicitly rather than quietly passing on an empty rule set.~~ *(Corrected 2026-10-04: both have data since 2026-09-25 — Ricochet a driver and services, VAC per-title lists of Steam ids and executables, which `rules_budget_test.cpp` matches back to "Valve VAC".)* **Since 2026-09-25** the fixture is generated from the shipped seed (`rules_budget_test.cpp`: every entry's every value matches its own family in its own group, which also catches a row an earlier prefix shadows), and Ricochet's fixture asserts its data; VAC's still asserts that no family entry fakes it.
- **A finding turns the game's hooking off (2026-09-22), and the proofs are about WHICH findings.** `AntiCheatVerdictTests` pins `IsFindingAboutTheGame` per reason (in the game: yes; machine-wide driver or service, heuristics, failed scans, the latch: no) and that a finding without a family is not one; `CaptureSessionTests` that a start-time `BlockedModule` writes the block, keeps the consent stamp and says `HookingTurnedOff`, that a `BlockedDriver` refuses the session and leaves the row alone, and that the 30 s re-scan's finding writes the same block; `RecordedSessionEventsTests` and `SafetyNoticesTests` that the flag travels to the notice. The override of 2026-09-21 had its own proofs for one day; they went with it, and `NoSecondMatcherTests` counts the port's four methods again.
- **Fail-closed proofs:** malformed `detection-rules.json`, missing `anticheat` block, unreadable target process, `EnumProcessModulesEx` failure, partial module list → **all must refuse injection**, never allow. Each is a named test.
- **Measured error paths that must be named tests** (`spike-notes.md` §1): `ERROR_PARTIAL_COPY (299)` from a suspended target, `ERROR_ACCESS_DENIED (5)` from a protected one, a driver-list parse whose paths are not native paths, and a service query returning `ACCESS_DENIED` — the last of which **cannot be produced on real services by a standard user**, so it exists only as a fake. Every one means REFUSE.
- Mid-session detection: simulated late-loading anti-cheat module → `unhookRequested` set, hooks disabled within one frame, session finalized `unhooked_safety`. Cover the **driver** scan too, not only modules: a machine-wide driver can start after injection.
- **Absence-of-override test:** no code path may reach the injection primitive without a passing guard result. The mechanism previously described here — a `sealed` token type "only the guard can produce" — does not work and was disproved by compiling (`20_OPEN_QUESTIONS` §S8: C# accessibility flows inward, `CS0122`). The replacement is structural: the guard **owns the chokepoint** and calls the primitive itself, the primitive has internal linkage in the guard's own translation unit so no other TU has a symbol to call, and a build-time check asserts that nothing else references it. A token that escapes can be ignored; a symbol that does not exist cannot.
- Static pre-scan: a game directory containing `EasyAntiCheat/` renders `hook_enabled` un-settable; API-level attempt to set it is rejected — including via `SetWatchlist`, which no longer carries hooking state at all (`07_IPC` §The pipe is not a trust boundary). **The toggle half needs persistence and is not built yet**; the scan itself is ctest `fl_prescan`, whose matrix is mostly fail-closed: a listing that FAILED, one that was TRUNCATED, a directory that could not be established, unusable rules, and a missing evidence source must each be *undetermined*, never clean. Two cases exist only to stop the rest passing vacuously — a genuinely clean directory must be **allowed**, and a name matching the wrong group (a directory named like a `files` entry) must **not** fire. One case removes a family from the rules and asserts the hit disappears, which is what proves there is a single matcher rather than a second one that happens to agree.
- Static pre-scan: a game directory containing `EasyAntiCheat/` renders `hook_enabled` un-settable; API-level attempt to set it is rejected — including via `SetWatchlist`, which no longer carries hooking state at all (`07_IPC` §The pipe is not a trust boundary). ~~**The toggle half needs persistence and is not built yet**~~ **built in P2/P3**: `SqliteGameConsentStore.RecordGuardBlockAsync` forces `hook_enabled = 0`, `AgentCommandHandler.SetHookEnabledAsync` re-runs the pre-scan and answers `Refused`, and `GameDetailViewModel` disables the toggle on a blocked row (corrected 2026-09-21; since 2026-09-22 a finding at a session's start or at the re-scan writes the same block — `CaptureSessionTests`); the scan itself is ctest `fl_prescan`, whose matrix is mostly fail-closed: a listing that FAILED, one that was TRUNCATED, a directory that could not be established, unusable rules, and a missing evidence source must each be *undetermined*, never clean. Two cases exist only to stop the rest passing vacuously — a genuinely clean directory must be **allowed**, and a name matching the wrong group (a directory named like a `files` entry) must **not** fire. One case removes a family from the rules and asserts the hit disappears, which is what proves there is a single matcher rather than a second one that happens to agree.
> **D48 (beta.14):** the module check's one re-read is held both ways in ctest `fl_guard` `[D48]` — a member still
> loading reads clean on the re-read (one pause, two snapshots); one still unreadable refuses; one that exited drops out of
> the fresh set; a target that exited refuses; `ACCESS_DENIED` is never retried; a finding refuses at once and a finding
> the re-read sees refuses — and against the real source (`[live]`: a process created suspended and a pid with no process
> answer `kRetry`). The managed half — a refused re-scan of a game that has exited ends as its exit, never for a finding —
> is `CaptureSessionTests` and `SessionRecorderTests`.
## Native unit tests (Catch2)
- **Ring buffer:** SPSC correctness under a hammering writer thread; seqlock torn-read detection; wrap and overwrite-oldest semantics; power-of-two capacity assumptions. Include the **one-full-lap case**: a reader stalled exactly `capacity` records must not validate a different frame as unchanged (this is what the never-reset `seq` counter defends, `07_IPC` §Protocol rules).
- **Drop accounting:** the reader-side computation (`writeIndex - readIndex > capacity`) reports the right count and resumes at the right index. The writer has no drop counter to test — by design.
- **Torn records produce gap markers,** not silently shortened streams; a golden test asserts the gap does not appear as a stutter.
- **Record and header layout:** `static_assert(sizeof(...) == 64)` and `offsetof` assertions for `FlFrameRecord` **and all three header structs** (`FlShmHandshake`, `FlWriterState`, `FlControlBlock`) — the Agent reads across the process boundary in every one of them. Both halves exist as of 2026-08-05: the native side is `layout_test.cpp` plus the `static_assert`s (ctest `fl_shm_layout`), and the runtime offset dump from `tools/fl-layout-dump` is consumed by `ShmLayoutMirrorTests`, which walks the field list in **both directions** and additionally asserts blittability — `Marshal.SizeOf` and every offset stay correct for a mirror that uses `[MarshalAs(ByValTStr)] string`, while `Unsafe.SizeOf` drops from 64 to 40 and the struct can no longer be read from a mapped view.
- **Record and header layout:** `static_assert(sizeof(...) == 64)` and `offsetof` assertions for `FlFrameRecord` **and all ~~three~~ four header structs** (`FlShmHandshake`, `FlWriterState`, `FlControlBlock`, and `FlDisplayState` since layout 4, beta.10) — plus D33's `FlTolerance`, mirrored the same way *(corrected 2026-10-04)* — the Agent reads across the process boundary in every one of them. Both halves exist as of 2026-08-05: the native side is `layout_test.cpp` plus the `static_assert`s (ctest `fl_shm_layout`), and the runtime offset dump from `tools/fl-layout-dump` is consumed by `ShmLayoutMirrorTests`, which walks the field list in **both directions** and additionally asserts blittability — `Marshal.SizeOf` and every offset stay correct for a mirror that uses `[MarshalAs(ByValTStr)] string`, while `Unsafe.SizeOf` drops from 64 to 40 and the struct can no longer be read from a mapped view.
- **Fault policy:** injected SEH faults in a fake hook body → counter increments, original still called, self-disable at 3.
- **Hook index verification, by behaviour.** A vtable slot carries no identity, so "check that slot 8 *is* `Present`" is not a question the runtime can answer — the earlier wording here required something unimplementable. What is answerable: patch the slot, call the method, see whether the detour ran (`17_HOOK_ENGINE` §Getting vtable addresses; proved for slots 8, 13 and 22 in `spike-notes.md` §H4). Runs headless on CI via WARP and `CreateSwapChainForComposition`. A deliberate mismatch aborts installation instead of patching.
- **Every probe must be shown to fail.** A probe that ends in an unconditional assertion is green by construction and its ctest is decorative — `fl_proxy_swapchain` shipped in exactly that state. Before a probe counts as a regression net, break the thing it watches and watch it go red.
@@ -43,6 +51,52 @@ The anti-cheat guard is the one component where a bug can cost someone an accoun
- Blob codecs round-trip for every series in `frame_blobs` (NaN forbidden — assert), including the two-pair `render_res` encoding and the three-bit `rt_flags` byte. SQLite migrations apply cleanly from an empty file to the current schema, and re-applying is a no-op. (There is no v1→v2 upgrade to test — `06_DATA_MODEL` §Migrations.)
- IPC pipe: framing, split reads, oversize rejection, unknown fields/types ignored, protocol mismatch.
### What the App draws (beta.14)
A page or dialog that only *loads* has proved nothing about how it looks: `PagesLoadTests` counted the import list's
rows while every row was white text on white in the dark theme (`08_UI` §Contrast). The rendered checks run on the one
STA thread with the App's three dictionaries (`PagesLoadTests.OnStaAsync`) and look at the result: `Visuals` lays a
control out at a window's size, pumps the dispatcher (a `NavigationViewContentPresenter`'s navigation), swaps the theme
dictionary for one check and puts Dark back, and composites every Border and Panel background between a text and the
window into the colour actually painted under it; `Wcag` is the arithmetic. `ImportReviewRenderTests` measures each text
cell against that colour in both themes and counts the accent pixels of each ticked box in a `RenderTargetBitmap`; the
paging checks navigate a real page in WPF UI's presenter and send it the wheel. Each was run red against the unfixed XAML
first — a rendered check that cannot fail is the counted-rows check again.
**A theme switch needs a window (beta.17).** A change to `Application.Resources` reaches only the trees of
`Application.Windows`, and a `Window` registers itself there when it is constructed, shown or not. So
`PagesLoadTests.EveryTextFollowsAThemeSwitch` hosts each surface in a `FluentWindow` it never shows, swaps the theme
dictionary as `ApplicationThemeManager.Apply` does, and compares every text's colour with the same surface made fresh
under the new theme. `PagesLoadTests.Surfaces` builds every page, window and dialog content from loaded view models, for
any check that wants all of them. Colours are compared and texts only reported: another test class may change
`Strings.Culture` between the two builds.
**A page is measured in the Frame the App shows it in, and a theme brings its accent (beta.18).** WPF UI's
`NavigationViewContentPresenter` is a `Frame`, which passes no inherited value into the page, the text colour included, so
a page laid out straight in a window measures the window's colour and not the App's: the theme-switch check above did, and
stayed green over every page title drawn black (`08_UI` §Contrast, fifth hole). The rendered checks host a page in the
presenter (`PagesLoadTests.Hosted`), and `PagesLoadTests.EveryTextIsReadableInBothThemes` measures every surface's shown
texts at ≥ 3:1 in both themes. `Visuals.UnderTheme` switches as the App does — the accent resources derived for the theme
from Windows' default accent (`Visuals.DefaultAccent`, the App's derivation rather than the machine's own palette), then
the dictionary — and puts the application's own resources back afterwards. The accent lives in `Application.Resources`,
not in a theme dictionary; until then a check under Light measured the dark theme's link blue on the light window, 1.9:1,
a colour the App never shows. The theme-switch check compares what can be seen: a text only one of the two instances holds
counts where it shows, and a collapsed part is not compared (a switch re-applies the template of a DataGrid's idle scroll
bar, and its glyphs exist in the switched instance only).
**Loaded needs a shown window, and even then it is not raised everywhere (beta.17).** A tree laid out by hand never raises
Loaded, and a shown one raises it only where a subtree listens for it (`16_WPFUI_SYNTAX` §Gotchas) — so a test that calls
`RaiseEvent(Loaded)` proves a handler, never that WPF reaches it. `ScrollBarHidingTests.EverySurfaceShownWithTheOptionOnDrawsNoBar`
shows each surface in a real window, off the screen and never activated, with the option on before anything is built as
at start-up; `WpfRaisesLoadedOnlyWhereASubtreeListensForIt` checks the harness against WPF itself (a scroller holding a
Border is never loaded, one holding a CheckBox is), on CI too.
**A test that sends input must also say which keys are held.** `Keyboard.Modifiers` is the machine's real keyboard, read
from any thread (a fresh background thread's `GetKeyState` reports the machine's NumLock — measured 2026-10-06), so a
wheel test that read it held whatever key a person pressed while the gate ran: `ChartWheelTests`' plain half went red once
on the developer's machine and never on CI. The handlers read `ChartWheel.CurrentModifiers`, which the test sets inside its
own work item on the STA thread and puts back — and with the keys a parameter, the Ctrl half is driven end to end too.
## Integration tests (CI-runnable, no game, no anti-cheat surface)
`hook-harness` is what makes this architecture testable without touching a real title:
@@ -61,6 +115,16 @@ The anti-cheat guard is the one component where a bug can cost someone an accoun
caused when its run ends, and `tools/test-artifacts-check.ps1` fails the gate for one left behind
(`17_HOOK_ENGINE` §Native logging, 2026-09-15). A new native test binary that starts the harness needs the listener;
a managed test project that stages it gets the sweep from `FrameLedger.DrainFixtures.targets`.
- **Test isolation: a suite whose host resolves its target BY NAME consents to a run-unique copy of the harness**
(beta.16). `build.ps1` runs the test projects as parallel processes, and `TargetResolver` counts every process of the
consented executable's name — an unreadable one too, which is what a `hook-harness.exe` another project is still
starting is (its module list a partial copy). #269's first CI run lost `AgentEndToEndTests` that way:
`TargetAmbiguous`, exit 6. `AgentEndToEndTests`, `PartialRecoveryEndToEndTests` and `CaptureHostEndToEndTests` now copy
the staged harness to `hook-harness-<their scratch directory>.exe` beside their data, as `PipeEndToEndTests` already
did, register that directory with the sweep, and pin the copy to the staged harness byte for byte;
`AnotherHookHarnessRunningBesideTheSuiteDoesNotMakeTheTargetAmbiguous` runs a second harness beside the capture (red
against the shared name: `TargetAmbiguous`). A suite that attaches by pid (`ShmDrainIntegrationTests`, the native
`fl_guard_test`) is not exposed and keeps the staged name.
- Guard integration: harness loads a **dummy DLL named like an anti-cheat module** → injection refused pre-launch; loaded late → safety unhook. (A renamed harmless DLL, not real anti-cheat software.)
## Hook overhead measurement (NFR-1, per release)
@@ -130,7 +194,8 @@ 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 |
| Update | Velopack delta; update deferred while a game is hooked (FR-12) |
| 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
+18 -10
View File
@@ -151,7 +151,7 @@ Findings written to `docs/spike-notes.md`. Nothing in P1 starts until the exit c
> the hard gate, against NFR-10 — but the evidence changed, and the consequence is
> live: the drain tests are skipped in CI until it is fixed.
0. **The guard.** Module + driver enumeration, blocklist matching, fail-closed behaviour on every error path. **Moved from item 8**: items 1 and 6 below inject into real games, and CLAUDE.md rule 2 plus P1's own "it ships before the first real injection, not after" both forbid that ordering. **◐ Every documented check now has a call site; one half of one check does not.** `EvaluateImpl` runs checks 1, 2, 2b, 3 (executable half) and 4 — five, not four, because 2b (`services`) is the only tier ever measured firing on real anti-cheat and every count that says "four" omits it. The guard is built (`FrameLedger.Injector`, native per §S13(a)), owns the chokepoint, and its fail-closed matrix is Catch2-driven. The injection primitive landed after it, in that order. Reached from managed code through one P/Invoke facade — never a second matcher (§S15). Evidence: `spike-notes.md` §1; §S7, §S8, §S16 closed.
0. **The guard.** Module + driver enumeration, blocklist matching, fail-closed behaviour on every error path. **Moved from item 8**: items 1 and 6 below inject into real games, and CLAUDE.md rule 2 plus P1's own "it ships before the first real injection, not after" both forbid that ordering. ~~**◐ Every documented check now has a call site; one half of one check does not.**~~ **Every documented check has a call site since 2026-09-25 (§S14) — corrected 2026-10-04.** `EvaluateImpl` runs checks 1, 2, 2b, 3 (executable half) and 4 — five, not four, because 2b (`services`) is the only tier ever measured firing on real anti-cheat and every count that says "four" omits it. The guard is built (`FrameLedger.Injector`, native per §S13(a)), owns the chokepoint, and its fail-closed matrix is Catch2-driven. The injection primitive landed after it, in that order. Reached from managed code through one P/Invoke facade — never a second matcher (§S15). Evidence: `spike-notes.md` §1; §S7, §S8, §S16 closed.
> **This line said ✅ DONE, and it was wrong in a way worth recording.**
> `19_SAFETY` specifies four pre-injection checks. **Check 4** (the static
@@ -174,6 +174,12 @@ Findings written to `docs/spike-notes.md`. Nothing in P1 starts until the exit c
> > deleted: it is the third place that had to be corrected for one PR, and the
> > count is the point.
> >
> > *(Corrected 2026-10-04: the paragraphs below were overtaken on 2026-09-25 — both halves of check 3 are wired
> > and seeded. `CheckBlockedStoreId` reads Steam's `appmanifest_*.acf` and GOG's `goggame-*.info` through a
> > guard-owned seam; an install no store names is not refused, unreadable store metadata is; Epic has no reader.
> > Rules 2026.10.1 list 33 executables and 33 Steam ids, floored. The owner question about a permanently
> > uncallable sub-check is moot.)*
> >
> > **This item stays ◐, on a different and narrower reason.** Check 3's
> > **store-id half** has no call site and cannot be given one: nothing produces
> > a `store_id` — the platform metadata extractors are unbuilt, which is the
@@ -186,7 +192,7 @@ Findings written to `docs/spike-notes.md`. Nothing in P1 starts until the exit c
> > uncallable is an owner decision, not a coding one. And unchanged either way:
> > `blockedExecutables` **ships empty**, so check 3 refuses nothing today. What
> > #52 changed is that populating it would now do something.
1. **Vulkan layer passthrough.** Minimal implicit layer registered under `HKCU`, with the opt-in checks that keep it passthrough for non-enabled processes. **Moved from item 7**: a passthrough bug loads FrameLedger into every Vulkan process on the machine, which is the highest blast radius in the spike. **◐ Gates done, interception not started.** `enable_environment` measured against loader 1.4.357, blast radius verified, in-layer blocklist self-scan built and proven both directions. `vkQueuePresentKHR` is **not** hooked — that is P1, and §S2's in-layer supervision check lands with it.
1. **Vulkan layer passthrough.** Minimal implicit layer registered under `HKCU`, with the opt-in checks that keep it passthrough for non-enabled processes. **Moved from item 7**: a passthrough bug loads FrameLedger into every Vulkan process on the machine, which is the highest blast radius in the spike. **◐ Gates done, ~~interception not started~~.** `enable_environment` measured against loader 1.4.357, blast radius verified, in-layer blocklist self-scan built and proven both directions. ~~`vkQueuePresentKHR` is **not** hooked — that is P1, and §S2's in-layer supervision check lands with it.~~ *(Corrected 2026-10-04: landed 2026-09-06, P1 item 3 — present and swapchain interception plus §S2's in-layer supervision, ctests `fl_vklayer_real` and `fl_vklayer_supervision`. The ray-tracing and pipeline entries are still unbuilt.)*
2. **Hook viability.** `hook-harness` (D3D11 + D3D12) + MinHook: dummy-device vtable probe, verify present indices at runtime, install/uninstall cleanly, measure per-present cost. Confirm `/MT` DLL loads into a real (offline, non-AC) game without incident. **✅ DONE.** Vtable indices proved by behaviour (§H4), unhook proved not to clobber a later hooker (§H7), per-present cost measured at 8.4 ns against a 1,000 ns budget — and **the `/MT` DLL is now loaded into a real title**: Lies of P, attach mode, guard passing, module verified present by re-enumeration, game still rendering afterwards (`spike-notes.md` §7).
> **Attach mode only when this ran.** Launch mode was blocked by §S18 — the
@@ -224,7 +230,9 @@ Findings written to `docs/spike-notes.md`. Nothing in P1 starts until the exit c
> (Steam `.acf`, GOG `.info`, Epic `.item`) — every platform rule is
> `sibling_glob`/`path_contains`, so identification is unaffected but
> **`store_id` is null for every title**. No SQLite, so nothing is persisted
> and `field_provenance` is decided-but-unimplemented (P2). The engine and
> and `field_provenance` is decided-but-unimplemented (P2). *(Overtaken — corrected 2026-10-04: the store import
> writes `store_id` since P4 PR-4, the guard reads the stores' metadata for check 3 since 2026-09-25, and
> `field_provenance` is written since 2026-09-14.)* The engine and
> platform fixture families are **P4 library metadata shipped early** under
> P0's name.
>
@@ -264,7 +272,7 @@ Findings written to `docs/spike-notes.md`. Nothing in P1 starts until the exit c
8. **Telemetry layering.** Fill the `18_GPU_VENDOR_APIS` capability matrix on real hardware:
- L1 baseline (DXGI + PDH counters) working vendor-neutrally; decide whether the `D3DKMT` perf-data probe is stable enough on Win 10 **and** Win 11 to keep. **🅓 Deferred to Win 11 only, 2026-08-05** — one machine, and it is Win 11. Win 10 22H2 stays a supported floor and is explicitly unmeasured; the deferral holds only for as long as the probe stays non-load-bearing, which `18_GPU_VENDOR_APIS` §L1 now states as the condition rather than as advice.
- L2: which fields LibreHardwareMonitor actually returns per vendor, and **whether GPU sensors work unelevated without PawnIO** — this decides whether the default unelevated Agent has temperatures. **◐ NVIDIA measured 2026-09-03: yes (§M5 row R1), eight fields unelevated, `LhmTelemetrySource` written.** AMD / Intel remain 🅓 (§R5/§R6).
- L3: NVAPI linked from vendored MIT headers; Reflex latency, throttle reasons, per-domain utilisation.
- L3: NVAPI linked from vendored MIT headers; Reflex latency, throttle reasons, per-domain utilisation. *(Status added 2026-10-04: built 2026-09-10, P2 PR-E2, as `FrameLedger.NvapiBridge.dll` — throttle reasons and utilisation; Reflex latency has no producer.)*
- ~~**Licence confirmations:** LHM free of MPL-2.0 Exhibit B; NVAPI SPDX blocks intact~~ — **done before P0 began, both clear** (`spike-notes.md` §0). `tools/license-check` is in place and proven to fail on a planted violation.
*(The former items 7 "Vulkan layer" and 8 "Guard prototype" are now items 1 and 0. §R1/§R2 are folded in, not pending.)*
@@ -298,7 +306,7 @@ Findings written to `docs/spike-notes.md`. Nothing in P1 starts until the exit c
> `logs\overlay-<pid>-*.log` (init / Agent request / stop), `opengl32!wglSwapBuffers` with the harness's
> `--opengl` mode. **D3D9 is not built and will not be**: `20_OPEN_QUESTIONS` §Scope decisions rules it out
> of v1 (the Overlay is x64-only and those titles are 32-bit); listing it here was the roadmap's, not the
> scope's. What P1 still leaves ⏳ in `17_HOOK_ENGINE` §Hook inventory: `SetFullscreenState`,
> scope's. What P1 still leaves ⏳ in `17_HOOK_ENGINE` §Hook inventory: ~~`SetFullscreenState`~~ (polled instead, 2026-09-27),
> `SetColorSpace1`, `CreateSwapChain*`, `ID3D12Device5::CreateStateObject`, the Vulkan RT / pipeline entries,
> §Pipeline and §Memory/latency — feature rows, each with its own measurement question, not P1's core. P2
> (the Agent, the recorder, SQLite) is next per this file.
@@ -311,16 +319,16 @@ Findings written to `docs/spike-notes.md`. Nothing in P1 starts until the exit c
> re-scan wired to a real Overlay.
## P2 — Capture pipeline (1 week)
Agent: watcher, tier selection, injection orchestration, shm drain, telemetry poller (NVAPI first), session recorder, segments, `.partial` recovery, ~~Tier-2 `EtwFrameSource` retained as fallback.~~ **There is nothing to retain: Tier 2 has no mechanism as of 2026-08-27** (§G). `EtwFrameSource` is a port with no adapter, and P2 should not be planned as though writing one were scoped. SQLite v2 schema + migrations. Domain metric calculators + golden tests. **Milestone: first real hooked session persisted with measured upscaler/RT data.** *Technical half reached 2026-09-10 (P2 PR-F): the shipped `FrameLedger.Agent.exe --console capture` against `hook-harness` ends as one hooked `sessions` row, in the merge gate (`AgentEndToEndTests`). **P2's code is complete as of PR-G (2026-09-10)** — kill-and-recover is in the gate too (`PartialRecoveryEndToEndTests`) and `tools/fps-impact-runbook.ps1` exists. What P2 still owes is two MEASUREMENTS, not code: the real-title milestone read against the game's own menus, and the ≤ 0.5 % FPS-impact run. Both are the owner's; `spike-notes` §14 holds their slots and the exact commands.*
Agent: watcher, tier selection, injection orchestration, shm drain, telemetry poller (NVAPI first), session recorder, segments, `.partial` recovery, ~~Tier-2 `EtwFrameSource` retained as fallback.~~ **There is nothing to retain: Tier 2 has no mechanism as of 2026-08-27** (§G). `EtwFrameSource` is a port with no adapter, and P2 should not be planned as though writing one were scoped. SQLite v2 schema + migrations. Domain metric calculators + golden tests. **Milestone: first real hooked session persisted with measured upscaler/RT data.** *Technical half reached 2026-09-10 (P2 PR-F): the shipped `FrameLedger.Agent.exe --console capture` against `hook-harness` ends as one hooked `sessions` row, in the merge gate (`AgentEndToEndTests`). **P2's code is complete as of PR-G (2026-09-10)** — kill-and-recover is in the gate too (`PartialRecoveryEndToEndTests`) and `tools/fps-impact-runbook.ps1` exists. What P2 still owes is two MEASUREMENTS, not code: the real-title milestone read against the game's own menus, and the ≤ 0.5 % FPS-impact run. Both are the owner's; `spike-notes` §14 holds their slots and the exact commands. **The milestone's row half exists as of 2026-09-16** — the shipped Agent's Lies of P session with `fsr3`, 1506×848 → 2560×1440, FG ×2.04 and `rt = no` (`spike-notes` §14.1); the menu column is still the owner's, as is the FPS-impact run.*
## P3 — UI (1 week) — **code-complete 2026-09-14 (P3 PR-0 … PR-9; `docs/HANDOFF.md` §P3 carries the slice table, each row struck with its PR; the owner's merges of the stack are the remaining act)**
WPF UI shell (`16_WPFUI_SYNTAX`), library, per-game hooking consent flow, Dashboard live card showing *measured* settings, session summary, ScottPlot charts, game detail tabs, Compare with tier guarding, segment ribbon, tri-state chips with override, refusal/degradation/unhook notices as first-class UI. **Plus, moved here from P4 on 2026-09-13 (owner):** the command pipe (`07_IPC` §C — P2's decision D10 put it here), i18n en/vi/ja with `tools/resx-audit` (the consent dialog is the first thing that needs a reviewed `.resx`, so it cannot wait), the Legal Gate (FR-11), Settings (FR-10, the kill switch first), the Logs page, tray + toasts. The owner chose the whole of `08_UI` over a shell-first cut; HANDOFF §P3 carries the slice order and the decisions (D11–D17). *Not started as of 2026-09-13: `FrameLedger.App` is the scaffold, `FrameLedger.Shared` has no IPC type, and no `.resx` exists in the tree.*
## P3 — UI (1 week) — **code-complete 2026-09-14 (P3 PR-0 … PR-9; `docs/HANDOFF.md` §P3 carries the slice table, each row struck with its PR; ~~the owner's merges of the stack are the remaining act~~ merged 2026-09-13/14, #152–#165)**
WPF UI shell (`16_WPFUI_SYNTAX`), library, per-game hooking consent flow, Dashboard live card showing *measured* settings, session summary, ScottPlot charts, game detail tabs, Compare with tier guarding, segment ribbon, tri-state chips with override, refusal/degradation/unhook notices as first-class UI. **Plus, moved here from P4 on 2026-09-13 (owner):** the command pipe (`07_IPC` §C — P2's decision D10 put it here), i18n en/vi/ja with `tools/resx-audit` (the consent dialog is the first thing that needs a reviewed `.resx`, so it cannot wait), the Legal Gate (FR-11), Settings (FR-10, the kill switch first), the Logs page, tray + toasts. The owner chose the whole of `08_UI` over a shell-first cut; HANDOFF §P3 carries the slice order and the decisions (D11–D17). ~~*Not started as of 2026-09-13: `FrameLedger.App` is the scaffold, `FrameLedger.Shared` has no IPC type, and no `.resx` exists in the tree.*~~ *(Struck 2026-10-04: false since PR-2 — the App shell, the en/vi/ja `.resx`, `Shared/Ipc`.)*
## P4 — Detection & product polish (1 week)
~~Static rules engine + `detection-rules.json` (engines, platforms, capabilities, **anticheat blocklist**) + validator + fixtures~~ **landed 2026-09-14 (P4 PR-1: the engine existed since P0; the Agent's `DetectionSweep` is its first caller, `ApplyDetectionAsync` its first writer — HANDOFF §P4)**; ~~store auto-import~~ **landed 2026-09-14 (P4 PR-4)**; ~~capability-vs-measured UI separation~~ **(PR-1: the Supports row reads the sweep's flags)**; ~~i18n en/vi/ja; Legal Gate;~~ ~~Velopack + updater (with the hooked-session deferral)~~ **landed 2026-09-14 (P4 PR-5 — the deferral is `UpdateService`'s shape, not a flag)**; ~~bug bundle incl. overlay logs~~ **landed (overlay logs since P3 PR-8a; 2026-09-15, P4 PR-9: the crash dialog, the minidump in both processes and the dump as the bundle's opt-in — `10_LOGGING` built notes)**; ~~tray + toasts; Settings;~~ ~~DB maintenance~~ **landed 2026-09-15 (P4 PR-7: the sweep is the Agent's over `SweepRetention`; integrity, backup and compaction in the App)**; ~~accessibility pass~~ **landed 2026-09-15 (P4 PR-8: `08_UI` §Accessibility written first — Ctrl+1…5, Esc on every dialog, an automation name on every textless input, theme colours only — each held by `AccessibilityTests`)**; ~~the scheduled task (`--install-task`)~~ (P3 PR-8b) and ~~the Velopack install hooks~~ **(PR-5: the uninstall hook; install registers nothing, by design — `12_BUILD` §The Vulkan layer is not registered at install time)**. *(The struck items moved to P3 on 2026-09-13 — see §P3.)*
## P5 — Ship (3–4 days)
CI/CD with the native build (`release.yml` exists since P4 PR-5, 2026-09-14 — untested by a tag yet); CodeQL (C# + C++); Dependabot; CHANGELOG; README with the P0 accuracy comparison — **which is not a percentage, and this line used to send its author looking for one**. The decision is recorded under item 3 and in `spike-notes.md` §8: the baseline can answer **none** of item 4's four runtime questions, so the defensible claim is *"the baseline cannot answer four of these five questions at all"*, not *"N% more accurate"*. Overhead + tier cross-validation measurements; release smoke on clean VMs; `v0.1.0-beta.1`.
CI/CD with the native build (`release.yml` exists since P4 PR-5, 2026-09-14 — ~~untested by a tag yet~~ **ran on the first tag 2026-09-16** (`13_CI_CD` §release.yml: cancelled by a test hang once, green on the re-run); **rehearsable without one since 2026-09-16**, `13_CI_CD` §release.yml's dry run); CodeQL (C# + C++); Dependabot; CHANGELOG; README with the P0 accuracy comparison — **which is not a percentage, and this line used to send its author looking for one**. The decision is recorded under item 3 and in `spike-notes.md` §8: the baseline can answer **none** of item 4's four runtime questions, so the defensible claim is *"the baseline cannot answer four of these five questions at all"*, not *"N% more accurate"*. Overhead + tier cross-validation measurements; release smoke on clean VMs; ~~`v0.1.0-beta.1`~~ **tagged and published 2026-09-16** — ~~eleven pre-releases through `0.1.0-beta.11` (2026-10-03), added 2026-10-04~~ a pre-release at each step since, listed in the CHANGELOG *(corrected 2026-10-14: the count went stale at the next release)* — (pre-release, unsigned, `SHA256SUMS.txt` beside the assets). What P5 still owes: the clean-VM smoke (`14_TESTING` §Release smoke — Win 10 22H2 is unmeasured), the overhead run (`spike-notes` §14.3), and the README's accuracy comparison sentence.
**Total ≈ 5.5–6.5 weeks full-time** — roughly 1.5–2 weeks more than the ETW design, which is the honest price of the accuracy.
@@ -339,7 +347,7 @@ CI/CD with the native build (`release.yml` exists since P4 PR-5, 2026-09-14 —
- Microsoft Store / Game Pass titles (packaged-app injection constraints)
- AFK segmentation via `GetLastInputInfo`
- GPU frame time via timestamp queries (needs care: injecting queries into the game's command lists is more invasive than anything in v1 — needs its own risk review)
- Beta update channel; ARM64
- ~~Beta update channel;~~ ARM64 *(struck 2026-10-04: the beta channel shipped with P4 PR-5 — `update.channel`, Settings ▸ Updates; `13_CI_CD` §Branch & release policy)*
## Permanently out of scope
+117 -10
View File
@@ -6,8 +6,8 @@ Mandatory conventions for all XAML/C# in `FrameLedger.App`. WPF UI = lepoco's Fl
| Package (NuGet id) | Pin | Notes |
|---|---|---|
| `WPF-UI` | **= 4.3.0** (exact; bump deliberately) | Assembly/namespace is `Wpf.Ui`. Targets `net8.0-windows` → resolves cleanly for our `net10.0-windows10.0.19041.0` TFM (`12_BUILD` §Managed build) |
| `WPF-UI.Abstractions` | transitive | Navigation abstractions (`INavigationViewPageProvider`) |
| `WPF-UI` | **= 4.3.0** (exact; bump deliberately) | Assembly/namespace is `Wpf.Ui`. Targets `net8.0-windows` → resolves cleanly for our `net10.0-windows10.0.22621.0` TFM (`12_BUILD` §Managed build; this row said `19041` until 2026-09-21, which is no TFM this repository ever built — `Directory.Build.props` has been `22621` with a 19045 floor throughout) |
| `WPF-UI.Abstractions` | ~~transitive~~ **= 4.3.0**, referenced directly (corrected 2026-10-04) | Navigation abstractions (`INavigationViewPageProvider`) |
| `WPF-UI.DependencyInjection` | match `WPF-UI` | DI glue (`services.AddNavigationViewPageProvider()`); verify exact id/version at scaffold |
| `WPF-UI.Tray` | **not used** | Tray stays on H.NotifyIcon.Wpf (CLAUDE.md stack table) |
@@ -81,7 +81,7 @@ Theme rules:
<RowDefinition Height="*"/> <!-- NavigationView -->
</Grid.RowDefinitions>
<ui:TitleBar Grid.Row="0" Title="FrameLedger" Icon="pack://application:,,,/Assets/icon.ico" />
<ui:TitleBar Grid.Row="0" Title="FrameLedger" /> <!-- no Icon: no icon file exists yet (corrected 2026-10-04) -->
<Menu Grid.Row="1"> <!-- classic menu, Fluent-restyled automatically --> </Menu>
@@ -103,7 +103,7 @@ Theme rules:
</ui:NavigationView>
<ui:SnackbarPresenter x:Name="SnackbarPresenter" Grid.Row="2" VerticalAlignment="Bottom" />
<ContentPresenter x:Name="DialogHost" Grid.Row="2" /> <!-- ContentDialogService host -->
<ui:ContentDialogHost x:Name="DialogHost" Grid.Row="2" /> <!-- §Dialogs; a ContentPresenter stood here until 2026-10-04 -->
</Grid>
</ui:FluentWindow>
```
@@ -121,7 +121,7 @@ Code-behind wires services once: `navigationService.SetNavigationControl(RootNav
| Need | Use | Not |
|---|---|---|
| Button | `ui:Button` with `Appearance="Primary/Secondary/Danger"`, `Icon="{ui:SymbolIcon Play24}"` | bare `Button` |
| Text | `ui:TextBlock` with `FontTypography="Caption/Body/BodyStrong/Subtitle/Title"` | hardcoded FontSize |
| Text | `ui:TextBlock` with `FontTypography="Caption/Body/BodyStrong/Subtitle/Title"`; muted text with `Style="{StaticResource SecondaryText}"` or `TertiaryText` (beta.17) | hardcoded FontSize; `Appearance="Secondary"` on a TextBlock (§Gotchas) |
| Text input | `ui:TextBox` (`PlaceholderText`, `Icon`) | native TextBox |
| Numbers | `ui:NumberBox` (`Minimum/Maximum/SmallChange`, `SpinButtonPlacementMode="Compact"` — needs ≥ 4.3.0) | TextBox + parsing |
| Toggle | `ui:ToggleSwitch` | CheckBox for on/off settings |
@@ -132,9 +132,9 @@ Code-behind wires services once: `navigationService.SetNavigationControl(RootNav
| Busy | `ui:ProgressRing` | |
| Contextual popup | `ui:Flyout` | Popup hand-rolling |
| Hyperlink-ish | `ui:HyperlinkButton`, `ui:Anchor` | |
| Grid of records | native `DataGrid` (WPF UI restyles it) | third-party grids |
| Grid of records | native `DataGrid` (WPF UI restyles it — through the grid's own `RowStyle`/`CellStyle`/`ColumnHeaderStyle` setters, so a local one is based on WPF UI's keyed style: §Gotchas, added 2026-10-05) | third-party grids |
Native `Menu`, `TabControl`, `ComboBox`, `Slider`, `ListView` are fine — the `ControlsDictionary` restyles standard WPF controls to Fluent automatically.
Native `Menu`, `TabControl`, `ComboBox`, `Slider`~~, `ListView`~~ are fine — the `ControlsDictionary` restyles standard WPF controls to Fluent automatically. *(Corrected 2026-10-05: 4.3.0 has no implicit style for the native `ListView`, `ListViewItem` or `GridViewColumnHeader` — only `ui:ListView` is restyled — nor for `DataGridRow`, `DataGridCell`, `DataGridColumnHeader` or `FlowDocumentScrollViewer`; read from the loaded `ControlsDictionary`.)*
## Icons
@@ -143,9 +143,38 @@ Native `Menu`, `TabControl`, `ComboBox`, `Slider`, `ListView` are fine — the `
## Theming & brushes
- Colors **only** via `{DynamicResource …}` theme keys, e.g. `TextFillColorPrimaryBrush`, `TextFillColorSecondaryBrush`, `ControlFillColorDefaultBrush`, `CardBackgroundFillColorDefaultBrush`, `ApplicationBackgroundBrush`, `AccentTextFillColorPrimaryBrush`, `SystemFillColorCriticalBrush`. `DynamicResource` always (theme can change at runtime); `StaticResource` for theme brushes is a review-blocking bug.
- Colors **only** via `{DynamicResource …}` theme keys, e.g. `TextFillColorPrimaryBrush`, `TextFillColorSecondaryBrush`, `ControlFillColorDefaultBrush`, `CardBackgroundFillColorDefaultBrush`, `ApplicationBackgroundBrush`, `AccentTextFillColorPrimaryBrush`, `SystemFillColorCriticalBrush`. `DynamicResource` always (theme can change at runtime); `StaticResource` for theme brushes is a review-blocking bug. *(Added 2026-10-07: so is a property that looks like a theme colour but is looked up once — `ui:TextBlock Appearance`, §Gotchas.)*
- **`ui:Badge` `Appearance="Info"` / `Caution` / `Danger` / `Success` are NOT theme colours.** Their backgrounds are
`Palette*Brush` from WPF UI's `Palette.xaml` — one fixed Material palette shared by both themes — under the theme's
text: Info is white on `#03A9F4` in dark (2.6:1), measured 2026-09-16 on the Games card. ~~Use `Secondary` (theme
fill)~~ **`Secondary` is refused too since 2026-09-21**: its trigger repaints the background only and keeps the default
badge's on-accent `BadgeForeground`, near-white on near-white in the light theme. Use the `TagPill` + `TagPillText`
styles (`Styles/FrameLedger.xaml`), or the `Pill` style with a `SystemFillColor*BackgroundBrush` and an explicit text
brush; `ContrastTests` refuses all five (`08_UI` §Contrast).
- Do **not** set `Background` on `FluentWindow` (kills Mica). Page backgrounds transparent by default.
- Exception to the no-hex rule: the chart palette — defined once per theme in `Styles/ChartPalette.xaml` (two dictionaries), never inline.
- **Every `Page` root sets `Foreground="{DynamicResource TextFillColorPrimaryBrush}"`** (2026-10-07): the navigation's
Frame passes no text colour into a page, and a text with none is black (§Gotchas).
- Exception to the no-hex rule: the chart palette — defined once per theme in ~~`Styles/ChartPalette.xaml` (two dictionaries)~~ `Styles/ChartPalette.Dark.xaml` and `ChartPalette.Light.xaml` (corrected 2026-10-04), never inline.
- Second exception (beta.23, D61): the game page's artwork band, `Controls/ArtTint` — a colour worked out in code from the
artwork and the theme's own text and fill colours, the strongest tint at which every text on it still reads (4.5:1,
tertiary 3:1). It follows a theme switch through a **resource reference on the band** (`SetResourceReference` on a
private attached property bound to `ApplicationBackgroundColor`), not through `ApplicationThemeManager.Changed`, which
only `ApplicationThemeManager.Apply` raises — a page made and switched in the tests' harness would never hear it.
## FlowDocument (rendered documents, beta.12)
- **WPF UI 4.3.0 styles no `FlowDocument`.** Its own defaults are black Georgia on white, so a document in the dark theme
is unreadable unless the document is themed in code: `Markdown/MarkdownRenderer` sets `TextElement.Foreground` to
`TextFillColorPrimaryBrush` and `TextElement.FontFamily` to `ContentControlThemeFontFamily` **by resource reference**
(`SetResourceReference`, the code form of `DynamicResource`), a transparent background, and resource references for
every other colour (`AccentTextFillColorPrimaryBrush` links, `SubtleFillColorSecondaryBrush` code and table headers,
`ControlStrokeColorDefaultBrush` rules, quote bars and table borders). Never a literal brush.
- Host it in `Controls/MarkdownView` (a `FlowDocumentScrollViewer`, toolbar hidden) — not a `RichTextBox`, which is an
editor. A `Hyperlink` there does not navigate by itself: the view handles `RequestNavigate` and decides
(`Markdown/MarkdownLinks`).
- `AccentTextFillColorPrimaryBrush` is the light accent in the dark theme only after `ApplicationThemeManager.Apply(…,
updateAccent: true)` — measured 2026-10-03 in the test host, which skips it: links drew #003E92 on #202020 there and
#73C2FF once the accent was applied as `WpfThemeApplier` applies it.
## Custom controls (`FpsReadout`, `TriStateChip`, sparklines)
@@ -169,7 +198,7 @@ var box = new Wpf.Ui.Controls.MessageBox
var result = await box.ShowDialogAsync(); // Wpf.Ui.Controls.MessageBoxResult.Primary
```
⚠ Name clash with `System.Windows.MessageBox` — in App code, `using MessageBox = Wpf.Ui.Controls.MessageBox;` and ban the System one (BannedSymbols/analyzer note).
⚠ Name clash with `System.Windows.MessageBox` — in App code, `using MessageBox = Wpf.Ui.Controls.MessageBox;` ~~and ban the System one (BannedSymbols/analyzer note)~~ *(corrected 2026-10-04: nothing bans it. Three paths use the Win32 box on purpose — the crash dialog, the startup-failure dialog and the uninstall question — because they run when the shell's dialog host cannot be trusted. Use the WPF UI one everywhere else.)*
- Rich in-flow dialogs: `IContentDialogService` (host wired in MainWindow — a `ui:ContentDialogHost`, since 4.3.0 marks `SetDialogHost(ContentPresenter)` obsolete).
- Transient in-app: `ISnackbarService.Show(title, message, ControlAppearance.Success, new SymbolIcon(SymbolRegular.Checkmark24), TimeSpan.FromSeconds(4))`.
- System/tray notifications: H.NotifyIcon only (08_UI §Notifications policy).
@@ -205,9 +234,87 @@ On startup and on `ApplicationThemeManager.Changed`: for every live plot set fig
bar with no exit, which is exactly how the safety notices shipped (2026-09-14). `Styles/FrameLedger.xaml` carries
the upstream template plus one presenter column; `PagesLoadTests.TheInfoBarTemplateRendersItsContent` renders both
templates and turns red when upstream gains a presenter, which is when the copy comes out.
- [ ] **WPF UI 4.3.0 keys its DataGrid parts' styles and defines no implicit one** (`DefaultDataGridRowStyle`,
`DefaultDataGridCellStyle`, `DefaultDataGridColumnHeaderStyle`, handed to the grid by its implicit `DataGrid` style's
`RowStyle`/`CellStyle`/`ColumnHeaderStyle` setters). A local `RowStyle` replaces WPF UI's; based on
`{StaticResource {x:Type DataGridRow}}` it falls through to Aero2's row, whose `SystemColors.WindowBrush` no theme
reaches: the import list was white text on white in the dark theme (owner's screenshot, beta.14). Base it on
`DefaultDataGridRowStyle`. `AccessibilityTests.NoStyleIsBasedOnAnImplicitStyleTheThemeDoesNotDefine` refuses any
`BasedOn` a type the App's dictionaries hold no style for, and `ImportReviewRenderTests` measures the rendered rows.
- [ ] **A style of the App's for a WPF UI control replaces the style that holds its template** (beta.23). WPF UI 4.3.0 gives
its controls their templates in its own styles (`DefaultImageStyle`, …), applied only to a control with no style of its
own: a local `<Style TargetType="ui:Image">` with no `BasedOn` leaves the control with no template, and it takes its
place and draws nothing — the game page's cover was an empty space beside the name while the banner above it, with no
style, drew (caught in a render before it shipped). Base it on WPF UI's (`BasedOn="{StaticResource DefaultImageStyle}"`).
`AccessibilityTests.NoStyleOfAWpfUiControlLeavesOutItsTemplate`, `PagesLoadTests.TheGamePagesArtworkIsDrawn`.
- [ ] **WPF UI's `CheckBox` is `MinWidth` 120 with an 11 px padding**: in a narrow grid column it draws a sliver of the box.
`MinWidth="0" Padding="0"` there. A `DataGridCheckBoxColumn` uses WPF's own element style, an Aero2 box — use a template
column (`AccessibilityTests.NoDataGridCheckBoxColumn`).
- [ ] **Every page sets `ScrollViewer.CanContentScroll="False"`.** `NavigationViewContentPresenter` changes that property's
default to true for `Page` and, on each navigation, wraps a page that keeps it in a `DynamicScrollViewer`. A page with
its own root `ScrollViewer` inside that wrapper has infinite height, nothing to scroll — and a stock `ScrollViewer`
marks every wheel handled even then, so the wheel scrolled nothing on five pages until beta.14 (owner: "I have to drag
the scroll bar"); the Logs tail grew to hold every line and never followed the end.
`AccessibilityTests.EveryPageOptsOutOfTheDynamicScrollViewer`, `PagesLoadTests.ANavigatedPageIsNot…`.
- [ ] **A stock `ScrollViewer` nested in a scroller takes the wheel at its ends too.** Inside a dialog use
`ui:PassiveScrollViewer`, which hands the wheel on when it cannot scroll (`AccessibilityTests.NoPlainScrollViewerInsideADialog`).
A `ContentDialog` whose content should not scroll as a whole sets `ScrollViewer.VerticalScrollBarVisibility="Disabled"`
on the dialog: its content row then has the window's height, and a `*` row inside it can hold a list that scrolls alone
(`ImportReviewPrompt`).
- [ ] **A `ScrollViewer` moves a FIXED 48 DIP per wheel message, whatever its delta** (`ScrollViewer._mouseWheelDelta`,
read from .NET 10.0.12; measured on a `FlowDocumentScrollViewer`: deltas of −1, −15, −120 and −360 each moved 48). It
ignores Windows' *lines to scroll*, and a precision touchpad's small deltas each jump the whole step — a long document
read as slow and jerky while its layout cost about a millisecond a step. `Controls/MarkdownView` handles
`PreviewMouseWheel` itself (beta.21): the delta in proportion at Windows' lines, eased, unhandled at its ends.
- [ ] **Microsoft.Data.Sqlite completes its "async" calls synchronously** (measured 2026-10-14, beta.23): a
`ConfigureAwait(false)` after a ledger read does not leave the thread that asked, so a view model's load, a session's
decode, a sort over its frames all ran on the UI thread. Work that must not run there goes in `Task.Run` —
`Charts.SessionSeriesLoader`, the game page's executable check (`spike-notes` §21).
- [ ] **A transient page's view model is never `IDisposable`** (beta.23). Pages and their view models are transient, and
the root container keeps every transient disposable it makes until the App exits: every Dashboard and Logs page ever
opened stayed in memory, and each Dashboard stayed subscribed to the Agent — at a session's end every one reloaded its
lists on the UI thread and raised its own notice. Listen on Loaded and stop on Unloaded (`Attach`/`Detach`, as Games,
the game page and the Dashboard do); `DashboardViewModelTests.ADashboardOffScreenHearsNothing…`.
- [ ] **ScottPlot 5 zooms on every wheel and never marks it handled.** Without `Charts/ChartWheel` a wheel over a chart
zoomed it and scrolled the page at once; a plain wheel is the page's, Ctrl+wheel the chart's, for every plot that
`ChartTheme.Attach` registers.
- [ ] **A scroll bar's visibility is bound inside its scroller's template** (`ComputedVerticalScrollBarVisibility`), so a style
on `ScrollBar` or `ui:DynamicScrollBar` cannot hide it. Set the scroller's own `ScrollBarVisibility` to `Hidden` — no
bar, and the wheel, the keyboard and touch still scroll (`ui:PassiveScrollViewer` treats only `Disabled` as "cannot
scroll") — as `Services.ScrollBarHiding` does for `ui.hide_scrollbars` (beta.14), reaching each scroller from a class
handler on `ScrollChanged` since beta.17 rather than from `Loaded` alone (next item).
- [ ] **A class handler on `Loaded` is not a load hook.** WPF raises Loaded only on an element whose subtree listens for it
with a handler of its own — an instance handler, a style's `EventSetter`, a template's trigger
(`BroadcastEventHelper.OnBroadcastCallback` walks only into `SubtreeHasLoadedChangeHandler`;
`FrameworkElement.ThisHasLoadedChangeEventHandler`) — and `EventManager.RegisterClassHandler` counts as none of them.
WPF UI 4.3.0's `ToggleSwitch`, `CheckBox` and `ProgressRing` templates carry a Loaded trigger, so a scroller over those
loads and a scroller over plain cards and text never does: `ScrollBarHiding` hid Settings' bar and not the Dashboard's
(beta.17). To reach every instance, hook an event the element raises itself — a scroller's `ScrollChanged` comes from its
first layout. `ScrollBarHidingTests.WpfRaisesLoadedOnlyWhereASubtreeListensForIt` keeps the behaviour visible, and a test
that raises Loaded with `RaiseEvent` proves the handler, never that it is reached.
- [ ] **No dialog in 4.3.0 closes on Esc.** Neither `ContentDialog.cs` nor `MessageBox.cs` at the 4.3.0 tag handles a
key (read 2026-09-15), and `ContentDialog.CloseButtonText` DEFAULTS to "Close" — an empty string is how a dialog
says it has no Close button. `MessageBox.Close()` is `[Obsolete("Use Close with MessageBoxResult instead")]` while no
such overload is public; the Close button's own path is `TemplateButtonCommand.Execute(MessageBoxButton.Close)`.
`Services/DialogKeyboard` registers one class handler on `Window` (bubbling `KeyDown`, so a dropdown's Esc wins) and
closes through those paths; `AccessibilityTests.EscapeClosesTheOpenDialogWithNoResult` holds it (`08_UI` §Accessibility).
- [ ] **`ui:TextBlock Appearance` keeps the theme a text was made under (4.3.0).** `TextBlock.OnAppearanceChanged` stores
`TryFindResource(…)` in the internal `AppearanceForeground`, and `TextBlockMetadata` coerces every TextBlock's `Foreground`
to it — the brush found when the element was made, never looked up again (read at tag 4.3.0, 2026-10-07; `main` is the
same). After a theme switch the page on screen kept the old theme's secondary text: light grey on white, dark grey on dark
(the owner's screenshots of Settings, beta.17). The property also inherits, so the attached form on a container pins every
text under it. Muted text takes `Style="{StaticResource SecondaryText}"` or `TertiaryText` (`Styles/FrameLedger.xaml`,
`DynamicResource`). `ContrastTests.NoTextBlockTakesItsColourFromAppearance` refuses every form in the App's XAML and code,
`PagesLoadTests.EveryTextFollowsAThemeSwitch` renders every surface through a switch both ways, and
`PagesLoadTests.WpfUisAppearanceStillKeepsTheThemeATextWasMadeUnder` turns red the day upstream follows a switch.
- [ ] **A page in the `NavigationView` inherits nothing, its text colour included.** `NavigationViewContentPresenter` is a
`Frame`, and `Frame` sets `InheritanceBehavior.SkipToAppNow`: the window's `Foreground` stops there, and a text that sets
no colour falls to the TextBlock default, which WPF UI 4.3.0's `TextBlockMetadata` makes `Brushes.Black`. Cards, grids
and controls set their own colour in their templates; the bare texts did not — every page's title and section headings
were black on the dark window, 1.3:1 (the owner's screenshots of beta.17; beta.16's show it too). It came and went: a
page on screen during a theme switch did take the window's new colour through the switch, and every navigation makes a
new page that does not. Every `Page` root sets `Foreground="{DynamicResource TextFillColorPrimaryBrush}"`
(`AccessibilityTests.EveryPageSetsItsOwnTextColour`). A check that lays a page out straight in a window measures the
window's colour, not the App's — beta.17's theme-switch check did and was green over the black titles — so the rendered
checks host a page in the presenter, and `PagesLoadTests.EveryTextIsReadableInBothThemes` measures every surface so
hosted at ≥ 3:1 in both themes.
+51 -24
View File
@@ -22,7 +22,7 @@ The injected DLL. Its whole job: install hooks, write 64-byte records into a rin
> ⚠ The CFG result was measured with **strict mode off**. A host that enables CFG strict mode does not auto-validate dynamically generated code and could still `__fastfail`. Rare, but real, and not something the fault policy can catch — see §Fault policy and `20_OPEN_QUESTIONS` §H8.
- No STL container that allocates in a hook path. `std::atomic` and fixed arrays are fine.
- VERSIONINFO populated (`ProductName=FrameLedger`, real company/version) — being identifiable is required by `19_SAFETY`.
- Exports: `FlGetBuildId()`, `FlRequestUnhook()`, `FlGetStatus()`. Real names, no ordinal-only tricks.
- Exports: `FlGetLayoutVersion()` (added to this line 2026-10-04), `FlGetBuildId()`, `FlRequestUnhook()`, `FlGetStatus()`. Real names, no ordinal-only tricks.
## DLL entry
@@ -57,6 +57,16 @@ The injected DLL. Its whole job: install hooks, write 64-byte records into a rin
> them and the loader does not list them. Body under `FL_HOOK_GUARD`, no allocation, no lock, no
> logging (rule 5). Exercised by `hook-harness --load-after-ms N PATH` (up to four), against the real
> Overlay in a real target, both jobs.
>
> **D33 (2026-09-26): one family may be tolerated.** Before `InstallLoaderHook`, `InitThread` reads
> `Local\FrameLedger.Tolerate.<pid>` once (`fl_tolerance.h`; absent = nothing tolerated, the ordinary case),
> resolves each name against its OWN compiled floor, honours only a family whose whole footprint there is
> user-mode (`fl::guard::FamilyIsUserModeOnly`) and keeps a 64-bit mask over the floor's module families. The
> detour's only change is one bit test before (b): a tolerated family's module loading late is not an early stop.
> **Overhead:** one relaxed-acquire `uint64` load, a shift and a compare, on the floor-match branch alone — a branch
> that fires approximately never — and nothing on the present path; the tolerance is read on the init thread, not in
> a hook body (and logged there as `TOLERANCE`). ctest `fl_guard` `[D33]` loads a decoy `NEP2.dll` 2.5 s in: the
> Overlay keeps recording when the mapping names NetEase Yidun, and stops when it names Easy Anti-Cheat.
4. Install present hooks for what exists (below).
5. Install feature hooks (upscaler / RT / PSO) lazily — the first time their module appears.
6. Publish `status = ready` in the handshake block.
@@ -72,7 +82,7 @@ void** vtbl = *reinterpret_cast<void***>(dummySwapChain);
MH_CreateHook(vtbl[kPresentIndex], &Hook_Present, reinterpret_cast<void**>(&Orig_Present));
```
Index constants (`IDXGISwapChain::Present = 8`, `Present1 = 22` on `IDXGISwapChain1`, `ResizeBuffers = 13`) live in `HookIndices.h`.
Index constants (`IDXGISwapChain::Present = 8`, `Present1 = 22` on `IDXGISwapChain1`, `ResizeBuffers = 13`) live in ~~`HookIndices.h`~~ `FrameLedger.Overlay/include/fl_dxgi_vtable.h`, shared with the harness; the D3D12 command-list slots in `fl_d3d12_vtable.h` (corrected 2026-10-04: no `HookIndices.h` exists).
> ⚠ **"Verified at runtime against the dummy object" is not implementable, and
> must not be reintroduced.** A vtable slot holds a bare function pointer: no
@@ -102,15 +112,18 @@ Index constants (`IDXGISwapChain::Present = 8`, `Present1 = 22` on `IDXGISwapCha
> restore-only-if-unchanged rule matters, since another overlay may have
> patched the same shared slot after us.
Prefer hooking the **vtable entry** over inline-patching for COM methods (cleaner uninstall, no trampoline hazards); use MinHook inline hooks for flat C exports (`wglSwapBuffers`, NGX/FFX/XeSS entry points).
~~Prefer hooking the **vtable entry** over inline-patching for COM methods (cleaner uninstall, no trampoline hazards);~~ *(corrected 2026-10-04: the Overlay swaps no vtable entry. It reads the slot off a throwaway object and MinHooks the function it points at, so one patch covers every instance (§Ray tracing); §Compare-and-restore explains why the swap is not the cleaner uninstall.)* Use MinHook inline hooks for flat C exports too (`wglSwapBuffers`, the Streamline and FidelityFX entry points ~~, NGX/FFX/XeSS~~ — NGX and XeSS have none).
## Hook inventory
Every hook must be listed here with a purpose. Anything not on this list is not allowed to exist (`19_SAFETY` review checklist).
> **This table is a SPECIFICATION. As of 2026-09-04 the Overlay installs TWELVE DETOURS —
> **This table is a SPECIFICATION. ~~As of 2026-09-04 the Overlay installs TWELVE DETOURS —
> the eight of 2026-09-03 plus four `ffxDispatch` trampolines, one per AMD module a game
> calls — and the FidelityFX row below is the ninth ✅.** The counts differed until 2026-09-03, because a
> calls — and the FidelityFX row below is the ninth ✅.~~** *(Corrected 2026-10-04: as of 2026-09-06 it installs up
> to SIXTEEN — the nine `FL_HOOK_INVENTORY` rows (four Streamline including `slSetTagForFrame`, four `ffxDispatch`,
> `ffxFsr3ContextDispatchUpscale`), the three DXGI slots, the two `ID3D12GraphicsCommandList4` methods,
> `wglSwapBuffers` and `LoadLibraryExW`; four hooks landed without this banner moving.)* The counts differed until 2026-09-03, because a
> row is a *capability* and a detour is a *patch*, and the FG-count row rode on the
> evaluate detour; it has its own now, `sl.interposer.dll!slGetNewFrameToken`. The AMD row
> is the opposite shape — **one row-family, four modules, four patches from one
@@ -133,7 +146,7 @@ Every hook must be listed here with a purpose. Anything not on this list is not
> Reset is load-bearing — and no vendor symbol is resolved by name, so `FL_HOOK_INVENTORY`
> and `hookinventory-check` do not cover them at all.
> **Every other row below is unwritten**, including
> `SetFullscreenState`, `SetColorSpace1`, `CreateSwapChain*`, ~~`wglSwapBuffers`~~ (built 2026-09-06, #141, its row below),
> ~~`SetFullscreenState`~~ (polled instead since 2026-09-27, its row below), `SetColorSpace1`, `CreateSwapChain*`, ~~`wglSwapBuffers`~~ (built 2026-09-06, #141, its row below),
> `ID3D12Device5::CreateStateObject`, §Pipeline and §Memory/latency.
>
> Stated here because the distinction is invisible from the table. What a writer may then
@@ -151,12 +164,12 @@ Every hook must be listed here with a purpose. Anything not on this list is not
> so a shipped hook missing from here is invisible to every gate. Flip the row **and this
> banner** in the same PR that builds a hook.
### The one system-module detour — a hook, and the asymmetry stated
### ~~The one system-module detour~~ The two system exports patched by name — a hook, and the asymmetry stated *(heading corrected 2026-10-04: `wglSwapBuffers` above is the other)*
| Hook | Purpose |
|---|---|
| ✅ `opengl32.dll!wglSwapBuffers` (2026-09-06, P1 item 4) | The OpenGL present hook (§Presentation). A system module, not a vendor one, so — like the row below — it is deliberately **not** in `FL_HOOK_INVENTORY` and `hookinventory-check` does not cover it; listed here so the table above and these two rows together are the whole inventory |
| ✅ `kernelbase.dll!LoadLibraryExW` (2026-09-06, P1 item 1) | The wake for lazily loaded runtimes and the in-process anti-cheat stop — §DLL entry step 3 above carries the mechanism. **Rule 4:** it reads one argument the API was given (`flags`) and one property of a handle the loader just returned to *its own caller* (the module file name); nothing of the game's. **It is the only hook on a system module, and it is deliberately not in `FL_HOOK_INVENTORY`:** that table is *vendor* symbols resolved by name and gated by `hookinventory-check` against `vendor-exports.json`, and `LoadLibraryExW` is neither vendor nor uncertain. It is listed here instead so the table above and this row together are the whole inventory. It **never** installs, uninstalls or patches anything itself (§H2) |
| ✅ `kernelbase.dll!LoadLibraryExW` (2026-09-06, P1 item 1) | The wake for lazily loaded runtimes and the in-process anti-cheat stop — §DLL entry step 3 above carries the mechanism. **Rule 4:** it reads one argument the API was given (`flags`) and one property of a handle the loader just returned to *its own caller* (the module file name); nothing of the game's. **~~It is the only hook on a system module, and~~ Like `wglSwapBuffers` above it, it is deliberately not in `FL_HOOK_INVENTORY` (corrected 2026-10-04):** that table is *vendor* symbols resolved by name and gated by `hookinventory-check` against `vendor-exports.json`, and `LoadLibraryExW` is neither vendor nor uncertain. It is listed here instead so the table above and this row together are the whole inventory. It **never** installs, uninstalls or patches anything itself (§H2) |
### Watchdog observations — not hooks, and listed here so nobody mistakes them for one
@@ -169,7 +182,7 @@ Every hook must be listed here with a purpose. Anything not on this list is not
|---|---|
| ✅ `IDXGISwapChain::Present`, `Present1` | Frame boundary, QPC, sync interval, present flags. **`DXGI_PRESENT_TEST` calls are dropped without a record** — the occlusion probe submits nothing, and a minimised game emits a stream of them (`07_IPC` §Protocol rules). **Since 2026-09-05 the hook also reads `IDXGISwapChain::GetLastPresentCount` on the chain it just saw** (rule 4: the same COM object `FindOrAdd` already calls `GetDesc` on, no new hook) and publishes `dxgiPresentSamples` / `dxgiPresentsUnseen` — DXGI's count of presents on that chain that this hook never saw, the in-process half of `20_OPEN_QUESTIONS` §H5 Leg 1. One virtual call per hooked present, costed by `hook-harness --probe-frames`. **And per record since the same night: `dxgiUnseen` @52 under `FL_MEASURED_DXGI_PRESENTS`**, so the consumer's window counts `Displayed = hooked + unseen` per bucket (`03_METRICS` §Displayed may be DXGI-COUNTED) — measured 2.90 / 2.95 on DL:TB at Streamline 2.8.0, 0 on 2.7.3 and 2.10.3. **And since 2026-09-06 (P1 item 2) the same read, at the FIRST hooked present on the first hooked chain, is published once as `FlWriterState.dxgiPresentsBeforeHook` @60** — DXGI's count of presents that ran before the hook was in, launch mode's cost meter (`20_OPEN_QUESTIONS` §S1); 0xFFFFFFFF until a present is seen, set before the present hooks go in. **Corrected 2026-09-14 (`fl_dxgi_count.h`, ctest `fl_dxgi_count`):** a reading that went *backwards* — a chain released and re-created at the same address inherits the slot's old count — used to wrap `now − previous` to ~4e9, saturate the record byte at 255 (the `DxgiSaturated` refusal) and add the wrap to the session total: the owner's ledger held `dxgi_unseen_total = 4294967243`. A regression is now a reset (no delta claimed, nothing added, the slot re-armed) and the total saturates at `UINT32_MAX` rather than wrapping. Cost: one compare on the same virtual call; measured per `14_TESTING` §Hook overhead in the PR |
| ✅ `IDXGISwapChain::ResizeBuffers` · ⏳ `ResizeTarget` | Output resolution changes mid-session. `ResizeBuffers` re-reads the swapchain description *after* the original returns; `ResizeTarget` is not hooked |
| ⏳ `IDXGISwapChain::SetFullscreenState` | Fullscreen ↔ borderless transitions |
| ~~⏳ `IDXGISwapChain::SetFullscreenState`~~ **not hooked — polled (2026-09-27, beta.10)** | ~~Fullscreen ↔ borderless transitions~~ **Region 4, `FlDisplayState` (`07_IPC`, layout 4).** DXGI leaves exclusive fullscreen by itself — focus lost, Alt+Enter inside its own window hook — without the title calling this method, so a hook would miss exactly the transitions a mode share must count. Instead the present hook asks, **at most every 500 ms per chain**, two getters on the chain the title passed: `GetFullscreenState(&fs, nullptr)` (no `IDXGIOutput` taken) and `GetDesc` (the window, the back buffer, the swap effect). Rule 4: the same object `FindOrAdd` already calls `GetDesc` on and the counter reads — no new hook, no read beyond it; the window's geometry and the classification are the Agent's, out of process. `GetDesc` again also refreshes the size every record carries, which closes `IDXGISwapChain3::ResizeBuffers1` (unhooked: a D3D12 title resizing through it kept its old size until now). Published through a seqlock the writer never waits on (a taken lock skips the sample). OpenGL publishes the window and client size `ReadGlSize` already holds, with no exclusive bits. Cost per `14_TESTING` §Hook overhead in the PR |
| ⏳ `IDXGISwapChain3::SetColorSpace1` | HDR output detection. **`IDXGISwapChain3`, not 4** — 4 adds only `SetHDRMetaData` (`20_OPEN_QUESTIONS` §H9 — *answered and removed with H1/H3/H4 in the P0 spike (`6b1fa83`); this row used to say `IDXGISwapChain4`, and the corrected interface here IS the answer, so the citation points at history rather than at a live entry*). Unbuilt, which is why `colorSpace` reads `NOT_REPORTED` and `FL_MEASURED_HDR` stays clear. **When it is built, the writer must initialise `colorSpace = FL_COLOR_SPACE_SDR` at swapchain identification** — an SDR title never calls `SetColorSpace1`, so "hook live, no call" would otherwise sit at `NOT_REPORTED` forever and HDR's definite `No` would be unreachable. DXGI documents G22/Rec.709 as the default, which makes SDR a *measured* default rather than an affirmative negative |
| ⏳ `IDXGIFactory::CreateSwapChain*` | Capture swapchain desc (format, buffer count, swap effect, flags) at creation. Unbuilt — the swapchain description is currently read on demand in the present hook via `GetDesc` |
| ✅ `wglSwapBuffers` (2026-09-06, P1 item 4) | OpenGL titles: one record per `opengl32!wglSwapBuffers`, `api` = OpenGL, the output size from `GetClientRect` on the window the HDC belongs to (first sighting and every 256th present, so a resize is caught without a second hook), **no `FL_MEASURED_PRESENT_ARGS`** — the call has no sync interval and no flags. A MinHook inline patch on the flat export (measured 2026-08-05: a `jmp` thunk into the vendor ICD, relocated like any first instruction), installed at init when `opengl32.dll` is already mapped and lazily on the watchdog otherwise, with the `LoadLibrary` detour waking it for `opengl32.dll`. Exercised by `hook-harness --opengl --hold-presenting N`, which calls **gdi32's `SwapBuffers`** the way a title does — measured to reach the hook (ctest `fl_guard` `[opengl]`, on Microsoft's generic renderer, so it runs on CI too). The one system-module row below carries the inventory asymmetry |
@@ -184,7 +197,7 @@ Every hook must be listed here with a purpose. Anything not on this list is not
| ✅ Streamline: `slSetTag` — **and, since 2026-09-05, every tag's TYPE** (`slTagCensus`; a HUD-less / UI tag marks the present `FL_FG_DLSS_G`, rule 4: the same argument) | The **global** resource tags, where a title states the size of the buffer it is upscaling *from*: `kBufferTypeScalingInputColor`'s extent → `renderW/H` — **or, since 2026-09-05, the size the tagged `sl::Resource` declares when the extent is zero** (`TagSize` in `fl_sl_inputs.h`, shared by all three tag routes; GUID-checked; a Resource declaring no size is still the honest unknown). **Built 2026-08-15** (`FL_HOOK_UPSCALER_PARAMS`), and it is an ALTERNATIVE to the local tags in `slEvaluateFeature`'s `inputs`, not a layer over them — `sl_core_api.h:258` says global and local tags "do NOT interact", so a title using one yields nothing from the other and both are read. Published only on a frame where an evaluation was also seen, because a tag is viewport state that outlives any one frame. This row was MISSING from this table while the hook shipped, which is the gap the banner above now names |
| ✅ Streamline: `slSetTagForFrame` — **and every tag's TYPE, as above** | The same global tags through **Streamline 2.8's frame-based entry point**, which deprecates `slSetTag`: `(const FrameToken&, const ViewportHandle&, const ResourceTag*, uint32_t, CommandBuffer*)` — the token first, then exactly `slSetTag`'s list, handed to the same tag walk. **Built 2026-09-04** (`FL_HOOK_UPSCALER_PARAMS`, its own trampoline; the family is now **published when whole** — once every tag export the loaded interposer has is patched — because publishing on the first row entitled records the second was not yet producing, 38 of 41 on the fixture: the ffx leaves' #110 defect again, fixed the same way). Measured need: Dying Light: The Beast (SL 2.8.0) published `Dlss` identity on every batch and the params bit on none across three captures, because a 2.8 title that tags per frame never calls the deprecated export. The token is not read; the frame count stays with `slGetNewFrameToken`. The installer picks this detour by SYMBOL (`kSymbolSlSetTagForFrame`, bound to the row by `static_assert`), not by family, since the two rows share a family bit and differ in signature |
| ✅ **FidelityFX ffx-api: `ffxDispatch` on the FOUR modules a game calls** — `amd_fidelityfx_dx12.dll` (SDK 1.1.x monolith), `amd_fidelityfx_upscaler_dx12.dll`, `amd_fidelityfx_framegeneration_dx12.dll`, **and `amd_fidelityfx_loader_dx12.dll`** (added the evening of 2026-09-04: three loader-shipping titles at FSR produced zero dispatches at any leaf export, so the loader is where their calls arrive) · ⏳ FSR 3.0 host route `ffx_fsr3_x64.dll!ffxFsr3ContextDispatchUpscale` / `ffxFsr3DispatchFrameGeneration` · ~~`ffxFsr2ContextCreate`~~ · ~~`ffxCreateContext`~~ | **Built 2026-09-04** (`HANDOFF` item 7c). One observer behind three trampolines reads the DESCRIPTOR the title passed — head type first, body only after the type matched a constant from the vendored MIT headers (`third_party/fidelityfx/`, tag v2.3.0): **UPSCALE** → identity (`FSR3` from the monolith, `FSR_UNVERSIONED` from the 2.x upscaler DLL, which hosts FSR 3.1 and FSR 4 behind one type) + `renderSize` → `renderW/H` (quality and sharpness `0xFF`: the dispatch carries neither) + one COUNT; **PREPARE / PREPARE_V2** → `frameID` counted on a *new* index only — this vendor's `slGetNewFrameToken`, the `fgEvaluations` producer once a title has ever prepared, with the UPSCALE count as the fallback for a title that never does; **FRAMEGENERATION** → `fgMode = FSR_FG` on that present. Rule 4: the argument of the API we hooked, never `context`, `pNext`, a command list or a resource. **Why all four:** a UE5 title ships the two leaves with no loader and calls their exports; a loader-shipping title calls the loader's export and the signed loader reaches its providers through an object, not the leaves' exports (measured: Dying Light: The Beast, KCD2, Wukong). The morning's "never the loader" rested on the export tables alone and was reversed by the run. What guards against a loader that DID re-enter a leaf's export is the K = 1 control with all four hooked and the consumer's `frames/upscale-drained`, both of which read 2× in that case. `ffxCreateContext` is deliberately NOT a row — nothing it carries fills a field the dispatch does not, and its honest family would collide with `slEvaluateFeature`'s under the installer's equality binding. The family is compound (`IDENTITY \| PARAMS \| FG_EVALUATIONS`), pinned by `static_assert`s that also bind the leaf table to the rows both ways and refuse the loader as a row. Streamline keeps precedence for the count once it has ever issued a token, so every §S31-validated title is byte-identical. Second count: the consumer prints `frames/upscale-drained`, the AMD `tokens/batch`. **FSR 3.0 — BUILT 2026-09-05 as a fifth AMD target:** `ffx_fsr3_x64.dll!ffxFsr3ContextDispatchUpscale` (Cyberpunk's copy; named export, its own descriptor, vendored from tag **`fsr3-v3.0.4`** — the tag whose twelve `ffxFsr3*` declarations match the shipped module, not the `v1.1.4` first named). Rule 4: the detour reads `renderSize` of the descriptor the title passed and nothing else — never the context, a resource or the command list; the offset is pinned to a literal (1256) so a re-vendoring that moved it fails to compile. Same family and publish point as the four rows (`PublishFfxFamilyIfWhole` waits for a loaded host too), keyed by module in the installer; identity `FSR3` as a fact. `ffxFsr3DispatchFrameGeneration` is deliberately not a row (§H11 carries the reversal condition); the `ffx_fsr3upscaler_x64.dll` leaf is the pre-committed alternative if the facade reads silent (row B2) — never both, or `frames/upscale-drained` reads 2.00 |
| XeSS: `xessD3D12CreateContext`, `xessD3D12Init`, `xessD3D12Execute` | `outputResolution`, `qualitySetting`, XeSS version; `xess_fg` variants for XeFG |
| ~~XeSS: `xessD3D12CreateContext`, `xessD3D12Init`, `xessD3D12Execute`~~ **Closed at the census by licence, 2026-09-04** (`20_OPEN_QUESTIONS` §Scope decisions, `18_GPU_VENDOR_APIS` §Intel XeSS SDK): no hook on any `libxess*.dll` export *(corrected 2026-10-04)* | ~~`outputResolution`, `qualitySetting`, XeSS version; `xess_fg` variants for XeFG~~ |
| ✅ **Application frames per present** (`fgEvaluations`) — **`sl.interposer.dll!slGetNewFrameToken` since 2026-09-03** | Native vs Displayed frame counts at Tier 1 — see `03_METRICS` §Frame Generation. **The producer is the frame-token export**: Streamline hands a title one token per application frame and the title must ask; the detour counts distinct tokens between two presents (pointer changes, nothing dereferenced), `FL_HOOK_FG_EVALUATIONS` is its family, and it installs on every Streamline 2 title including the ones that evaluate nothing through `slEvaluateFeature`. Rule 4: the out-parameter of an API we hooked. Premise and its gate in `03_METRICS`; pre-committed table in `20_OPEN_QUESTIONS` §S31. *The row as it stood before:* ~~NGX/SL/FFX/XeSS FG feature evaluations per present. **Built 2026-08-15 for Streamline, and MEASURED TO YIELD NOTHING ON THAT ROUTE**~~ — `slEvaluateFeature(kFeatureDLSS_G)` is never called by Cyberpunk 2077 (0 across ~14,000 batches, four FG settings), so this row installs, is honest, and counts zero; see `docs/HANDOFF.md` item 3. Built on the detour that was already there: `kFeatureDLSS_G` contributes to a saturating COUNT in the same word the feature bits live in (`fl_sl_seen.h`) rather than to a bit, because a bit collapses several evaluations between two presents into one — and under multi-frame generation that is the common case, not the edge. The row's family is therefore compound (`FL_HOOK_UPSCALER_IDENTITY \| FL_HOOK_FG_EVALUATIONS`), pinned by a `static_assert` because `hookinventory-check` reads that column as an opaque identifier. **Counts EVALUATIONS, not generated frames** — the 2026-08-14 owner ruling; the multiplier lives in `sl::DLSSGOptions`, which is only reachable by the route §2b refused. ~~Non-NVIDIA FG vendors are **deferred with a written rationale**: `amd_fidelityfx_framegeneration_dx12.dll` 3.1.5 exports only the five generic `ffx*` entry points, identical to five sibling modules, so identity is in the arguments and we have no headers~~ — **AMD has a producer since 2026-09-04** (the FidelityFX row above: the PREPARE dispatch's `frameID`, or the UPSCALE count on a title that never prepares, feeds `fgEvaluations` when Streamline has never issued a token); Intel stays at the census (`20_OPEN_QUESTIONS` §Scope decisions, by licence); the FSR 3.0 host DLL's UPSCALE (`ffxFsr3ContextDispatchUpscale`, since 2026-09-05) counts like an ffx-api UPSCALE when neither Streamline nor a PREPARE has spoken |
> `GetFrameStatistics().PresentCount` is **not** in this inventory and must not be
@@ -318,7 +331,7 @@ So:
### Memory / latency
| Hook / call | Yields |
|---|---|
| `IDXGIAdapter3::QueryVideoMemoryInfo` (we **call** it, not hook it, once per second from our own thread) | **Per-process VRAM** `CurrentUsage` + `Budget` — previously impossible; now exact |
| ~~`IDXGIAdapter3::QueryVideoMemoryInfo` (we **call** it, not hook it, once per second from our own thread)~~ | ~~**Per-process VRAM** `CurrentUsage` + `Budget` — previously impossible; now exact~~ **Never built; superseded 2026-10-03 (D43):** the game's memory is read from OUTSIDE the game by the Agent (`18_GPU_VENDOR_APIS` §The game process's memory), so nothing in the Overlay calls it. Only the budget would need it, and that stays open (`20_OPEN_QUESTIONS` §M11) |
| NVAPI Reflex: hook `NvAPI_D3D_SetSleepMode`, `NvAPI_D3D_SetLatencyMarker`; call `NvAPI_D3D_GetLatency` | Reflex on/off + PC latency breakdown. Declarations come from the vendored MIT NVAPI headers (`18_GPU_VENDOR_APIS` §L3); the Overlay links them like any other header. NVIDIA-only — the whole block compiles out to a no-op capability flag elsewhere |
### Explicitly not hooked
@@ -349,7 +362,9 @@ Vulkan gets an **implicit layer** (`FrameLedger.VkLayer`), not injection — it
DLL**, and it compares the variable's **value**, so a stray
`FRAMELEDGER_ENABLE_VK_LAYER=0` does not enable us. **This makes Vulkan
Tier 1 launch-mode-only** — the Agent sets the variable when it starts an
opted-in game, so a Vulkan title launched from Steam or GOG is not hooked.
opted-in game, so a Vulkan title launched from Steam or GOG is not ~~hooked~~ observed by the layer *(corrected
2026-10-04: attach mode has no Vulkan rule, so such a title gets the Overlay injected like a D3D one, and what its
DXGI hooks record there is unverified; `kTargetIsVulkanLayered` applies to launch mode only)*.
It is a *loading* gate, not a security gate: anything running as the user can
set the variable.
@@ -477,7 +492,9 @@ struct alignas(64) FlFrameRecord { // 64 bytes exactly, static_assert'd
uint8_t fgEvaluations; // @43 FG feature evaluations observed this frame
uint32_t vramUsedMb; // @44 MiB, matching vramBudgetMb
uint32_t reflexLatencyUs; // @48 0 = unavailable
uint32_t reserved; // @52 must be zero
uint8_t dxgiUnseen; // @52 DXGI-counted presents the hook did not see (2026-09-05; this listing
// showed a uint32 reserved here until 2026-10-04)
uint8_t reserved[3]; // @53..55 must be zero
uint32_t seq; // @56 seqlock counter (see 07_IPC §Protocol rules)
uint32_t swapchainId; // @60 which swapchain this present came through; 0 = unidentified
};
@@ -515,8 +532,9 @@ Field notes — each of these was a defect in an earlier revision:
uncomputable from a pinned counter. `rays_per_pixel` divides this by output
pixels.
- **`maxTraceRecursionDepth`** is the second of the four stated inputs to
`pt_confidence`. It is read at `CreateStateObject` (§Hook inventory) but
previously had no transport to the Agent and no column to land in.
`pt_confidence`. It ~~is~~ would be read at `CreateStateObject` (§Hook inventory) but
previously had no transport to the Agent and no column to land in. *(Corrected 2026-10-04: `CreateStateObject` is
not hooked, so nothing writes it yet.)*
- **`_pad0` and `_pad1` were explicit holes and are now carrying data.** Both were
named only so every offset could be asserted; spending them costs nothing,
because both bytes ranges were already inside the record and already written
@@ -551,14 +569,15 @@ Field notes — each of these was a defect in an earlier revision:
- **SPSC lock-free ring**, capacity a power of two (default 8192 records = 512 KB), overwrite-oldest.
- Writer/reader seqlock protocol, including the rule that the payload write must
**exclude** the `seq` field and that `seq` is never reset: `07_IPC` §Protocol rules.
- Header: three separate 64-byte lines before the ring — `FlShmHandshake` (write-once),
- Header: ~~three~~ **four** separate 64-byte lines before the ring *(corrected 2026-10-04: since layout 4, 2026-09-27,
beta.10, `FlDisplayState` at 0xC0 — Overlay-written at most every 500 ms; the ring starts at 0x100)* — `FlShmHandshake` (write-once),
`FlWriterState` (Overlay-written: `writeIndex`, `status`, `apiMask`, `faultCount`),
and `FlControlBlock` (**Agent**-written: `pauseRequested`, `unhookRequested`,
`overlayEnabled`, `guardTicks`). The control flags are *not* in the Overlay's
header — they are written by the other process, and mixing them into an
Overlay-written line reintroduces exactly the false sharing the split exists to
prevent. Layout is normative in `07_IPC` §A + B.
- **The hot path performs: one QPC read, a few field reads from cached state, one 60-byte store, two relaxed atomic stores and two compiler fences.** No syscall, no allocation, no lock, no logging. Target ≤ 1 µs per present.
- **The hot path performs: one QPC read, a few field reads from cached state, one 60-byte store, two relaxed atomic stores and two compiler fences.** No syscall, no allocation, no lock, no logging. Target ≤ 1 µs per present. *(Added 2026-10-04: the summary leaves out the per-present `IDXGISwapChain::GetLastPresentCount` call (§H5, the `dxgiUnseen` count) and the display sample every 500 ms at most (region 4).)*
- Per-frame mutable state (current upscaler, render res, dispatch counts) lives in a small struct updated by the feature hooks and *read* by the present hook; counters reset at present.
## The watchdog thread — the only thread we add to the game
@@ -567,6 +586,11 @@ One thread, started on the init thread *after* the hooks are installed, sleeping
`1000 ms` at a time. It evaluates `unhookRequested` and the `guardTicks` deadline,
calls `StopObserving` when either fires, and **exits** once stopped.
> **Corrected 2026-10-04 — this describes the thread as it was first written.** Since the lazy installers landed
> (`slEvaluateFeature`, 2026-08-09) the loop also installs feature hooks, runs the runtime census, publishes counters,
> appends the native log, and stops on the loader detour's early-stop family; it waits on that detour's wake event with
> a 1000 ms timeout rather than sleeping. `legal/DISCLAIMER.md` §2 says so to users since beta.12 (Disclaimer 2.10).
**Why it exists.** Both stops used to be evaluated only on the present path, and
`MayObserve` is reachable only from `RecordPresent`, which is reachable only from
the two present hooks. In a process that had stopped presenting — hung,
@@ -590,9 +614,12 @@ we do not own; the re-scan it would have run allocates ~1.15 MB transiently; and
it would have called `NtQuerySystemInformation` and probed the SCM from inside a
game, which is the behavioural signature of anti-analysis code (CLAUDE.md rule 3).
None applies to the Overlay, which is loaded by documented `LoadLibraryW` and is
never `FreeLibrary`'d from a live process. **This thread enumerates nothing,
never `FreeLibrary`'d from a live process. ~~**This thread enumerates nothing,
probes nothing and allocates nothing** — it reads two `uint32`s from our own
mapping and sleeps. That distinction is the whole justification and must survive
mapping and sleeps.~~ *(Corrected 2026-10-04: it enumerates no process, module list or service — the rule-3 line, which
holds — but it asks the loader for fixed module names, allocates through MinHook and, for ray tracing, creates one
command allocator and list on the game's own D3D12 device, and writes the log file. The justification below is
restated for that scope: what it must never start doing is scanning.)* That distinction is the whole justification and must survive
any future change: a watchdog that starts scanning is a different object under
rule 3.
@@ -614,7 +641,7 @@ Every hook body is wrapped:
```
- Any SEH exception inside our code ⇒ increment `faultCount`, record which hook, **return control to the original function** so the game continues.
- 3 faults total ⇒ set `status = self_disabled`, uninstall all hooks (`MH_DisableHook(MH_ALL_HOOKS)`), stop writing, stay dormant. The Agent sees the flag and finalizes the session as `degraded`.
- 3 faults total ⇒ set `status = self_disabled`, ~~uninstall all hooks (`MH_DisableHook(MH_ALL_HOOKS)`)~~ restore each patch's prologue only while its bytes are still our jump (compare-and-restore per patch through `StopObserving`, §Unhooking, §H7 — `MH_ALL_HOOKS` would have removed an overlay chained after us; corrected 2026-09-27), stop writing, stay dormant. The Agent sees the flag and finalizes the session as `degraded`.
- Never `__try` around the call to the original function — only around *our* code, so we never mask a game bug as ours or vice versa.
- The trampoline call to the original is always executed exactly once, on every path, including error paths.
@@ -635,7 +662,7 @@ Every hook body is wrapped:
> against the injected Overlay in ctest `fl_guard` `[log]`, where every patch reads `UNHOOK_RESTORED`
> because the harness is alone in its process.
`FlRequestUnhook()` (or the control flag) ⇒ `MH_DisableHook(MH_ALL_HOOKS)`, restore vtable entries **only where they are still ours**, flush the ring, set status. **The DLL is not `FreeLibrary`'d from the live process** — a thread could still be inside a trampoline. It goes dormant and unloads with the process. This is deliberate and documented.
~~`FlRequestUnhook()` (or the control flag) ⇒ `MH_DisableHook(MH_ALL_HOOKS)`, restore vtable entries **only where they are still ours**, flush the ring, set status.~~ *(Corrected 2026-10-04: both reach `StopObserving` — compare-and-restore per patch as the note above says, then the status; there is no `MH_ALL_HOOKS`, no vtable entry and no ring flush. The watchdog flushes the native log on its way out.)* **The DLL is not `FreeLibrary`'d from the live process** — a thread could still be inside a trampoline. It goes dormant and unloads with the process. This is deliberate and documented.
### Compare-and-restore, never unconditional restore
@@ -704,7 +731,7 @@ No logging in hook bodies. A small fixed-size in-memory ring of structured event
## Test harness
`src/native/tools/hook-harness` — a minimal D3D11 app that presents at a controlled rate. It lets CI and local dev exercise hook paths with **no game and no anti-cheat surface at all** (`14_TESTING`).
`src/native/tools/hook-harness` — a ~~minimal D3D11~~ D3D11/D3D12 app (plus `--vulkan` / `--opengl` modes — corrected 2026-10-04) that presents at a controlled rate. It lets CI and local dev exercise hook paths with **no game and no anti-cheat surface at all** (`14_TESTING`).
Two choices make it run on a hosted CI runner, which is what made vtable-index
verification a dev-machine-only affair before:
@@ -712,8 +739,8 @@ verification a dev-machine-only affair before:
- **WARP** (`D3D_DRIVER_TYPE_WARP`) — a software rasteriser, so no adapter is required.
- **`CreateSwapChainForComposition`** — no `HWND`, so no dependency on a window station or an interactive session.
Current modes: `--probe-vtable` (§H4, ctest `fl_vtable_indices`), `--probe-proxy` (§H5, ctest `fl_proxy_swapchain`), `--probe-unhook` (§H7, ctest `fl_unhook_preserves_foreign`), `--probe-cost` (NFR-1, measurement only), **`--probe-frames`** (ctest `fl_frame_identity` — what counts as a frame, against `GetLastPresentCount`), **`--probe-d3d12`** (ctest `fl_d3d12_acquisition` — device → command queue → swapchain), `--present N`, `--hold N`, **`--real`** and **`--plus-ui K``**, **`--vulkan --hold-presenting N`** (P1 item 3, real loader, exit 77 = cannot run here) and **`--opengl --hold-presenting N`** (P1 item 4, gdi32 `SwapBuffers` on a hidden window, Microsoft's generic renderer — runs on CI).
Current modes: `--probe-vtable` (§H4, ctest `fl_vtable_indices`), `--probe-proxy` (§H5, ctest `fl_proxy_swapchain`), `--probe-unhook` (§H7, ctest `fl_unhook_preserves_foreign`), `--probe-cost` (NFR-1, measurement only), **`--probe-frames`** (ctest `fl_frame_identity` — what counts as a frame, against `GetLastPresentCount`), **`--probe-d3d12`** (ctest `fl_d3d12_acquisition` — device → command queue → swapchain), `--present N`, `--hold N`, **`--real`** and **`--plus-ui K``**, **`--vulkan --hold-presenting N`** (P1 item 3, real loader, exit 77 = cannot run here) and **`--opengl --hold-presenting N`** (P1 item 4, gdi32 `SwapBuffers` on a hidden window, Microsoft's generic renderer — runs on CI). *(Added 2026-10-04, each with its own ctest: `--probe-d3d12-vtable`, `--probe-dxr`, `--probe-dxr-inputs`, `--probe-upscaler-resolve`, `--probe-sl-abi`, `--probe-ffx-resolve`, `--probe-sl-inputs`, `--probe-sl-seen`, `--probe-dxgi-count`; and the `--hold-presenting-*` injection fixtures with `--load` / `--load-after-ms`.)*
> **Every present here used to carry `DXGI_PRESENT_TEST`, which submits nothing.** Measured: 500 of them leave `GetLastPresentCount` at 0 while 37 real presents move it by 37. "N presents → N records" was therefore satisfiable only by a writer counting non-frames. `--real` issues real presents; the test-present path is kept as a named mode because it is what an alt-tabbed title actually runs.
Still to add as the hook layer grows: Vulkan devices, RT PSO creation and ray dispatch, stub upscaler exports with the real vendor names, a PSO-compile spike generator, and a fault-injecting hook body for the self-disable path (`14_TESTING` §Integration tests).
Still to add as the hook layer grows: ~~Vulkan devices, RT PSO creation and ray dispatch, stub upscaler exports with the real vendor names,~~ *(the struck three exist — corrected 2026-10-04)* a PSO-compile spike generator, and a fault-injecting hook body for the self-disable path (`14_TESTING` §Integration tests).
+92 -11
View File
@@ -33,7 +33,7 @@ public interface IGpuTelemetrySource : IDisposable
Implementations compose rather than compete:
- `BaselineTelemetrySource` (L1) — always constructed.
- `LhmTelemetrySource` (L2) — constructed when LHM initialises.
- `LhmTelemetrySource` (L2) — ~~constructed when LHM initialises~~ always constructed; a `Computer` that will not open disables the layer for the session (corrected 2026-10-04).
- `NvapiTelemetrySource` (L3) — ~~constructed only on NVIDIA hardware~~ **always constructed since 2026-09-10 (P2 PR-E2)** and disables itself when the bridge DLL or the NVIDIA driver is absent, so the composite's descriptor simply omits `nvapi` and no caller has to know the vendor before composing.
- `CompositeTelemetrySource` merges them with a fixed precedence per field (**L3 > L2 > L1**) and records which layer supplied each value.
@@ -52,20 +52,58 @@ Implementations compose rather than compete:
> `LayerOf(field)` answers per field. It also applies the two-fault rule one level up — a layer
> whose `TryRead` throws (which the port forbids) is excluded on the second throw, the others
> untouched. (3) Identity is its own record, `GpuAdapterIdentity` (name, LUID, ids, memory sizes,
> user-mode driver version), read once per session from DXGI; the Agent hands the handshake's
> `adapterLuid` to `SelectAdapter` so samples describe the adapter the game presented on. Every
> user-mode driver version), read once per session from DXGI; ~~the Agent hands the handshake's
> `adapterLuid` to `SelectAdapter` so samples describe the adapter the game presented on.~~ *(Corrected 2026-10-04:
> nothing calls `SelectAdapter` outside tests. L1 stays on the first hardware adapter in DXGI's high-performance order,
> as `HardwareSnapshotSource` does, and the handshake's `adapterLuid` is read by no managed code — so on a
> multi-adapter machine L1 can describe an adapter the game did not present on. The game's own memory, D43, is
> summed over every adapter and is not affected.)* **Built in beta.13:** the recorder hands the handshake's
> `adapterLuid` to the poller at the first tick that carries one (`CaptureProgress.AdapterLuid`, noted in the
> `.partial`), and `CompositeTelemetrySource.SelectAdapter` points L1 at it (`IGpuAdapterSelector`) and tells the layers
> that read their own GPU its vendor (`IGpuVendorFollower`): L2 maps that vendor's GPU node instead of the first one
> LibreHardwareMonitor lists (on a laptop often the integrated GPU), and L3 contributes nothing when the game's adapter
> is not NVIDIA's — N/A rather than another card's temperature. **What stays first-found:** a session before the game's
> first present, a Tier-2 session (no handshake), a game presenting through OpenGL or Vulkan (they publish no LUID), two
> GPUs of one vendor (L2 and L3 take that vendor's first), and the session's hardware snapshot
> (`HardwareSnapshotSource`, taken before the first present). Every
> poller sample is stamped with QPC (`TelemetrySample.QpcTicks`), the ring's clock, and
> `QpcClockTests` pins `Stopwatch` / `TimeProvider.GetTimestamp` to the real counter.
> Per-process VRAM comes from the **Overlay** (`IDXGIAdapter3::QueryVideoMemoryInfo` inside the game), not from here. Adapter-wide VRAM is a separate series with a different label — they answer different questions and users will otherwise think one of them is broken.
> ~~Per-process VRAM comes from the **Overlay** (`IDXGIAdapter3::QueryVideoMemoryInfo` inside the game), not from here.~~
> **Corrected 2026-10-03 (beta.12, D43): the game process's memory is read from OUTSIDE the game** — §The game process's
> memory below; the Overlay never called `QueryVideoMemoryInfo`. Adapter-wide VRAM is a separate series with a different
> label — they answer different questions and users will otherwise think one of them is broken.
### The game process's memory (beta.12, owner decision D43)
`FrameLedger.ProcessStats.dll` — the third native facade the Agent loads beside itself (`NativeProcessStats`, after the
guard's and the NVAPI bridge's), never into a game — reads one process's memory per call:
- **Video memory:** the documented performance counters `\GPU Process Memory(pid_<pid>_luid_…_phys_<n>)\Dedicated
Usage` and `\Shared Usage` (`PdhAddEnglishCounterW` with a `*` instance, so a localised counter name does not matter;
`PdhGetFormattedCounterArrayW` after each collection), every instance naming the pid **summed** — each adapter and
physical index the process allocated on. This is the per-process figure, so the adapter-wide rule below ("filter to our
adapter, don't sum blindly") does not apply to it. **No handle to the game is needed.**
- **System memory:** `GetProcessMemoryInfo` with `PROCESS_MEMORY_COUNTERS_EX2` (its `PrivateWorkingSetSize` is Task
Manager's "Memory"), retried with `PROCESS_MEMORY_COUNTERS_EX` where the OS refuses the larger structure; an EX2
answer whose private working set was left as written (a sentinel) or reads zero beside a nonzero working set is N/A,
never a measured zero. It needs `PROCESS_QUERY_LIMITED_INFORMATION` and
nothing more: the session's held handle when it has one, else a handle opened for the read and closed after it, whose
creation time must be the watcher's (a reused pid is refused, not read).
- **Not `D3DKMTQueryStatistics`.** It answers the same per-process segment figures, but Microsoft documents it as
"Reserved for system use"; the counters are the documented face of the same accounting.
- Measured on the dev box (`spike-notes` §16): one collect + read costs 0.1 ms (max 0.22 ms), a 512 MiB allocation reads
+512.0 MiB, the private working set equals `\Process V2(…)\Working Set - Private`, 600 collections leak nothing. One
`GameMemoryReader` per session, on the session's `fl-telemetry` thread (`TelemetryPoller`'s third source).
## L1 — baseline (no licence, all vendors)
- **DXGI:** `IDXGIFactory6::EnumAdapterByGpuPreference` → adapter description, LUID (matches the swapchain adapter from the Overlay handshake), dedicated/shared memory sizes. ~~`IDXGIAdapter3::QueryVideoMemoryInfo` for adapter-wide usage/budget.~~ **Measured wrong, 2026-09-09:** `DXGI_QUERY_VIDEO_MEMORY_INFO.CurrentUsage` is the *calling process's* usage by the structure's own definition — which is exactly why the Overlay reads it inside the game for `vram_proc` — and from the Agent it read **0 bytes** beside a 16 GB adapter. Adapter-wide usage is the PDH counter below, as this list always said; DXGI is identity only (`DxgiAdapters`, the first CsWin32 consumer in the tree).
- **DXGI:** `IDXGIFactory6::EnumAdapterByGpuPreference` → adapter description, LUID (matches the swapchain adapter from the Overlay handshake), dedicated/shared memory sizes. ~~`IDXGIAdapter3::QueryVideoMemoryInfo` for adapter-wide usage/budget.~~ **Measured wrong, 2026-09-09:** `DXGI_QUERY_VIDEO_MEMORY_INFO.CurrentUsage` is the *calling process's* usage by the structure's own definition ~~— which is exactly why the Overlay reads it inside the game for `vram_proc` —~~ *(corrected 2026-10-04: the Overlay never read it, and `vram_proc` was never produced — §The game process's memory)* and from the Agent it read **0 bytes** beside a 16 GB adapter. Adapter-wide usage is the PDH counter below, as this list always said; DXGI is identity only (`DxgiAdapters`, the first CsWin32 consumer in the tree).
- **PDH performance counters** — the same source Task Manager uses, fully documented, vendor-neutral:
- `\GPU Engine(*)\Utilization Percentage` (sum per engine type: 3D, Compute, Copy, VideoDecode)
- `\GPU Adapter Memory(*)\Dedicated Usage`
- `\GPU Process Memory(*)\Dedicated Usage` (cross-check against the Overlay's figure)
- `\GPU Process Memory(*)\Dedicated Usage` ~~(cross-check against the Overlay's figure)~~ — **read since 2026-10-03
as the game process's own figure** (§The game process's memory; the Overlay never produced one)
- Instance names embed the LUID — parse and filter to our adapter, don't sum blindly across GPUs.
> **Built 2026-09-09 (PR-E1), one counter of the three:** `PdhAdapterMemoryCounter` binds
@@ -75,8 +113,10 @@ Implementations compose rather than compete:
> idle desktop, moving tick to tick. A machine without the counter set fails the open and the
> field is N/A with the layer standing — not a fault. **`Utilization Percentage` is deliberately
> not read** (`20_OPEN_QUESTIONS` §M10, decided): `LoadPct` is L2's vendor-reported load and is
> labelled as such. `GPU Process Memory` is not read either — the Overlay's in-process figure is
> the one the pipeline stores, and a cross-check is a diagnostic, not a field.
> labelled as such. ~~`GPU Process Memory` is not read either — the Overlay's in-process figure is
> the one the pipeline stores, and a cross-check is a diagnostic, not a field.~~ **Since 2026-10-03 (D43) `GPU Process
> Memory` IS read** — by `FrameLedger.ProcessStats.dll`, as the game process's dedicated and shared GPU memory; there was
> never an in-process figure to cross-check.
- **Driver version:** ~~`SetupAPI` / registry adapter properties.~~ **`IDXGIAdapter::CheckInterfaceSupport(IDXGIDevice)`** — its documented second output is the user-mode driver version for that interface, four 16-bit fields of one 64-bit value (`32.0.16.1664` on the dev box, 2026-09-09; the WARP adapter answers with the OS build). Neither SetupAPI nor the registry is walked: both need a device-instance enumeration nothing else here has a reason to carry. Feeds the hardware snapshot and the trend-chart change markers (`06_DATA_MODEL`). This is the four-part form the vendor's own tooling shows, not the marketing number (`561.09`), which only L3 knows.
- **Optional probe, P0 evaluation only:** `D3DKMTQueryAdapterInfo` with `KMTQAITYPE_ADAPTERPERFDATA` reportedly exposes temperature, power and fan for any vendor. The D3DKMT structures are **not fully documented and have changed across Windows builds**. Treat as an experiment: if it proves stable on both Win 10 22H2 and Win 11 during P0, keep it as an L1 extra behind a capability flag; if it looks fragile, drop it and let L2 handle temperatures. Never let it be load-bearing.
@@ -105,13 +145,31 @@ L1 gives no temperatures on its own (unless the D3DKMT probe pans out). That is
`LibreHardwareMonitorLib` ≥ 0.9.6, consumed as an **unmodified NuGet package**. It already implements per-vendor GPU sensor access internally — which means the vendor-interop licensing problem is one LHM has solved upstream, under a licence that works for us. That is the entire reason this layer exists.
- `Computer` opened with `IsGpuEnabled` always; `IsCpuEnabled` + `IsMemoryEnabled` only when the Agent is elevated and PawnIO is available.
- `Computer` opened with `IsGpuEnabled` always; ~~`IsCpuEnabled` + `IsMemoryEnabled` only when the Agent is elevated and PawnIO is available~~ nothing else, ever — the CPU temperature uses a separate `Computer` (below) (corrected 2026-10-04).
- Poll on a dedicated thread: `computer.Accept(updateVisitor)` then read mapped sensors. Never faster than 500 ms; default 1000 ms.
- Sensor mapping by `SensorType` + name heuristics per vendor (`GPU Core`, `GPU Hot Spot`, `GPU Memory`, `GPU Package Power`, …), kept in `SensorMap.cs` with unit tests against captured sensor-tree fixtures.
- **P0 verification items:** (a) which fields LHM actually returns per vendor on real hardware — fill the capability matrix below — **NVIDIA filled 2026-09-03, AMD/Intel deferred (§R5/§R6)**; (b) ~~whether GPU-only usage works **without** elevation and without PawnIO (expected yes, since GPU sensors go through user-mode vendor paths, but confirm — it determines whether the default unelevated Agent has temperatures at all)~~ — **confirmed 2026-09-03, §M5 row R1**: eight fields unelevated, the same eight elevated, PawnIO never opened; (c) ~~confirm LHM's sources are not marked with MPL-2.0 Exhibit B~~ — **done, 2026-08-02: clear.** No source file applies the notice; the only repository hit is the `LICENSE` template itself, and every file we depend on carries the permissive Exhibit A. Method and evidence in `docs/spike-notes.md` §0. Re-check on every version bump, and check *source headers*, never the LICENSE file — MPL-2.0's own text contains Exhibit B as a template, so grepping the licence finds it in every MPL project ever published.
CPU and motherboard sensors remain LHM-only, elevated-only, PawnIO-dependent, and optional.
> **The machine beside the GPU — built 2026-09-21, and deliberately NOT a fourth layer.** `ISystemTelemetrySource`
> (`Telemetry.SystemTelemetrySource`) is read by `TelemetryPoller` on the same tick as the composite and rides each
> `TelemetrySample` as a `SystemReading` — outside `GpuSample`, because the per-field capability bits and layer
> attribution above mean nothing for "how busy was the CPU". Two unprivileged Win32 calls, no process opened:
> `GetSystemTimes` (busy = (kernel + user) − idle over the interval; kernel INCLUDES idle in that API; the first tick has
> no interval and is null) and `GlobalMemoryStatusEx` (physical memory in use). **CPU temperature is the one privileged
> reading**: `LhmCpuTemperatureReader.TryOpen` opens a SEPARATE `Computer` (~~CPU group only~~ CPU and memory groups, GPU off — corrected 2026-10-04 — L2's stays GPU-only and
> unelevated by design, so the unprivileged layer's behaviour never depends on privilege) only when the process is
> elevated AND `PawnIo.IsInstalled`; it takes the package sensor (`CPU Package`, `Core (Tctl/Tdie)`) and falls back to the
> hottest core. **Unmeasured on real hardware**: exercised against a fake `ILhmComputer` only; the first elevated run
> with PawnIO is the measurement — **which the user can now choose to make (beta.10, the admin mode: Settings ▸ Capture
> agent ▸ Run the agent as administrator, `01_ARCHITECTURE` ADR-9)**; until beta.10 an elevated Agent existed only when an
> App started as administrator happened to start it, and `PrivilegeFootprintTests` now asserts on the elevated CI runner
> that opening this CPU group enables no privilege. `HelloAck.cpuTempAvailable` reports those same two conditions (it was a constant
> `false`). A tick only the machine answered is still queued, under a placeholder `GpuSample` with
> `TelemetryLayer.None` and no field. The `.partial` sensor chunk carries the three values in bits 12–14 of the
> existing 16-bit presence mask, so an older file reads back with an empty reading.
## L3 — NVAPI (MIT, NVIDIA only)
**Integration: vendored headers + import library, linked normally. ✅ Vendored 2026-08-05** at `src/native/third_party/nvapi/` — nine headers (`nvapi.h`'s include closure plus `nvapi_interface.h`), `License.txt`, and `amd64/nvapi64.lib`; **x64 only**, `x86/nvapi.lib` deliberately not taken. Consumed through the `fl_nvapi` INTERFACE target. NVIDIA publishes the NVAPI SDK — headers, interface definitions, and `nvapi64.lib` — under the **MIT licence** (verified 2026-08-02 and re-verified on the vendored copy: `amd64/nvapi64.lib` is a tracked file in the MIT repo and `License.txt` names the import libraries as the subject of the grant, so the binary is covered and not only the headers), so the SDK material can live in our GPL-3.0 repository with only the usual MIT attribution obligation. The runtime implementation lives in `nvapi64.dll`, which ships with the installed NVIDIA driver.
@@ -146,6 +204,29 @@ Still resolve **entry points defensively at runtime**: `nvapi64.dll` may be abse
> **Not in this build, stated so nobody infers it from the table below:** VRAM (`FlNvSample.vram` is
> reserved and its bit is never set — see the Memory row), power, hotspot temperature, per-domain
> utilisation beyond the GPU domain, and anything Reflex (§M8: a hook fact, not a poller field).
>
> **ABI 2 (2026-09-25, beta.8): the driver profile, read-only.** The owner asked whether the NVIDIA App overrides a
> game's DLSS (frame generation, ray reconstruction, the model preset). The NVIDIA App writes those overrides into the
> driver's own settings store (DRS), so `FlNvDriverProfile(exePath, ids, count, out)` reads them there: a DRS session
> is created, the settings loaded, the profile the driver applies to that path found (`NvAPI_DRS_FindApplicationByName`
> — a fully qualified path returns the profile the driver will apply on launch; none named → the current global
> profile), each id read with `NvAPI_DRS_GetSetting` (value, where it comes from, whether someone set it), and the
> session destroyed. **No DRS setter exists in the bridge** — not `SetSetting`, not `SaveSettings`, not
> `RestoreProfileDefault`, not `NvAPI_NGX_SetNGXOverrideState`: the overrides are the user's, and this only reports
> them. A path longer than NVAPI's string is refused, never truncated (a truncated path names another program).
> The ids and their values' meanings are NVIDIA's `NvApiDriverSettings.h` (github.com/NVIDIA/nvapi, MIT), written into
> `Application.Capture.NvidiaDriverSettings` as eighteen constants rather than vendored as a header; Smooth Motion
> (`0xB0D384C0`) is not in NVIDIA's header and is documented by community profile tools only, which every surface
> that shows it says. Managed: `NvapiDriverProfileSource` (`IDriverProfileSource`) — the Agent's recorder reads the
> profile beside every session, both tiers, and stores it in `sessions.driver_profile` (schema 0012). Verified by
> ctest `fl_nvapi_bridge` (argument refusals, DEGRADED before init, the global profile of the test's own executable on
> a GPU machine) and `NvapiBridgeMirrorTests` (`FlNvDriverProfileSize`, ABI 2).
>
> **The ctest could not fail on a GPU machine until the same day.** `fl_nvapi_bridge` was registered with
> `PASS_REGULAR_EXPRESSION` alone, which makes ctest ignore the exit code: the AVAILABLE branch's reference-counting
> check (two references, two releases, then a read expected to work) failed on every machine with an NVIDIA GPU while
> ctest reported Passed, and CI — no driver — never takes that branch. The check is corrected and the registration now
> carries a `FAIL_REGULAR_EXPRESSION` on Catch2's failure lines.
| Purpose | Function |
|---|---|
@@ -267,7 +348,7 @@ on the NVIDIA dev box even though nothing in it may be hooked or declared.
- Poll at 1 Hz on a dedicated Agent thread. Never from the game process, never from the Overlay.
- Any layer that throws or hangs twice is disabled for the session and its fields report `N/A`, rather than being retried in a loop.
- **Read-only, always.** These libraries can also set clocks, fan curves and power limits. FrameLedger never calls a setter — not in v1, not in the backlog. A measurement tool that can modify hardware state is a different product with a different risk profile.
- **Read-only, always.** These libraries can also set clocks, fan curves and power limits. FrameLedger never calls a setter — not in v1, not in the backlog. A measurement tool that can modify hardware state is a different product with a different risk profile. *(Since beta.8 the same holds for the driver's settings store: the bridge reads DRS profiles and has no entry point that writes, saves or restores one — §L3, ABI 2.)*
## Capability matrix (fill during P0 on real hardware)
@@ -297,7 +378,7 @@ as the same thing.
|---|---|---|---|
| GPU utilisation | **deferred by decision** (§M10, 2026-09-09) — L2's vendor-reported load is what `LoadPct` carries, labelled as such; the engine counters are not read | untested | untested |
| Adapter VRAM | ✓ **measured 2026-09-09** — PDH `GPU Adapter Memory … Dedicated Usage`, 1301 MB at an idle desktop, RTX 5080 (`QueryVideoMemoryInfo` measured **not** adapter-wide: 0 bytes from the Agent) | untested | untested |
| Per-process VRAM | `arch` for L1 — the Overlay's in-process `QueryVideoMemoryInfo` is the figure stored; `GPU Process Memory` is not read | `arch` | `arch` |
| Per-process VRAM | ~~`arch` for L1 — the Overlay's in-process `QueryVideoMemoryInfo` is the figure stored; `GPU Process Memory` is not read~~ ✓ **measured 2026-10-03** — `GPU Process Memory` Dedicated/Shared by pid from outside the game, +512.0 MiB for a 512 MiB buffer (`spike-notes` §16) | untested | untested |
| Driver version | ✓ **measured 2026-09-09** — `CheckInterfaceSupport(IDXGIDevice)` → `32.0.16.1664` | untested | untested |
| Core temp | ? (D3DKMT probe, Win 11 only — see below) | untested | untested |
| Power | ? (D3DKMT probe) | untested | untested |
+498 -46
View File
@@ -18,11 +18,11 @@ These are permanently out of scope. A PR implementing any of them is rejected re
- Hiding, renaming, or randomizing the DLL, its exports, or its shared-memory object names
- Thread hiding (`NtSetInformationThread`/`ThreadHideFromDebugger`) or debugger-evasion tricks
- Signature-breaking obfuscation/packing of our own binaries
- Any "stealth mode", "bypass" setting, or documentation explaining how to defeat the guard below
- Any "bypass" setting, "stealth mode", or documentation explaining how to defeat the guard below. *(The first two words left this line on 2026-09-21 and returned on 2026-09-22 — §What a finding does to the game. The one exception the owner has granted since, D33 on 2026-09-26, is not a bypass: the guard still runs every check and decides itself which family is user-mode — §The user-mode exception.)*
- Reading or writing game memory outside the arguments of APIs we hooked
- Kernel drivers of our own
The DLL ships with its real filename, a populated VERSIONINFO block (`CompanyName`, `ProductName=FrameLedger`, version), and named kernel objects that clearly say `FrameLedger`. Being identifiable is a feature.
The DLL ships with its real filename, a populated VERSIONINFO block (`CompanyName`, `ProductName=FrameLedger`, version), and named kernel objects that clearly say `FrameLedger`. Being identifiable is a feature. Since beta.14 (D50) the Agent — the process that injects — and the App say the same about themselves: `FrameLedger` as company and product, *FrameLedger Agent* as the Agent's description, the native binaries' copyright line (`12_BUILD` §Version, *Identity*; `tools/versioninfo-check.ps1` reads both kinds).
## The anti-cheat guard (hard gate)
@@ -51,6 +51,19 @@ Implemented in `FrameLedger.Injector` and reached from managed code through a th
> handle rights above are confirmed sufficient for every target this call can
> legitimately reach.
>
> **Amended 2026-10-05 (owner decision D48, beta.14): one re-read, never a pass.** A member of the scan set that
> is still being created answers `ERROR_PARTIAL_COPY` (its loader has not built a module list), and one that exited
> between the snapshot and the open answers `ERROR_INVALID_PARAMETER`. Both refused the whole session — and at the
> 30 s re-scan an engine's crash reporter starting as its game died, or any helper started a moment before the scan,
> turned an ordinary exit into a "safety" unhook, which ends a user-mode exception's trial for good. Such a member
> (`Collected::kRetry`, `fl_guard.h`) is now read once more: the pass finishes (a finding in any member still refuses
> at once), waits `kScanRetryPauseMs` (250 ms), takes a **fresh** scan set and scans it whole. A member still unreadable
> then refuses `kProcessUnreadable`, as before; one that has gone is not in the new set; a target that has gone leaves
> no set, which refuses `kProcessTreeUnavailable`. **`ERROR_ACCESS_DENIED` — a protected process — is never retried**,
> and no other answer of any source is. The sentence above stands: every failure still means REFUSE; what changed is
> how many times "still loading" is asked before it counts as one. ctest `fl_guard` `[D48]` holds both directions,
> against fakes and against the real source (a process created suspended, a pid with no process).
>
> **Launch mode (2026-09-06, P1 item 2) does not weaken this.** `FlGuardedInjectWhenReady` polls
> the same enumeration to learn *when* the launched target has mapped a presentation runtime, and a
> failing enumeration there means "not yet" — the poll continues. That is not a pass: the poll
@@ -91,6 +104,23 @@ Implemented in `FrameLedger.Injector` and reached from managed code through a th
> inspected (`ERROR_ACCESS_DENIED`) refuses too — there is no "scanned what we
> could" state.
>
> **Amended 2026-10-06 (owner decision D51, beta.15): a parent link is followed only while creation times allow it.**
> The set is walked over one process snapshot, which links a process to its parent by pid alone, and Windows reuses
> pids. A launcher that exits after starting its game leaves the game naming a pid that may now belong to anything:
> until beta.15 the walk scanned whatever held it — a protected process refused the session as unreadable, a
> blocklisted one turned the game's hooking off for good — and a cycle of reused pids sent the same processes round
> again. A parent/child link is now cut **only when it is proven wrong**: both creation times read (`GetProcessTimes`,
> under the module scan's own read-only right) and the child created **before** the process whose pid it names as its
> parent, which no real child can be. A cut ancestor link ends the ancestor walk there; a cut child is not walked, nor
> is anything below it. A time that cannot be read keeps the link, equal times keep it, and each pid is walked and
> scanned once (`WalkScanSet`, `fl_guard_scanset.cpp`). Nothing else about the set moved: the launcher boundary, the
> depth (16 ancestors), the frontier (512 — one more refuses) and "a member that cannot be read refuses". **The
> residual:** creation times are wall-clock, so a clock set *backwards* between a parent's start and its child's makes a
> real link look wrong and drops that branch from the module check; the install-folder scan and the machine-wide driver
> and service checks do not depend on the tree. ctest `fl_guard` `[D51]` holds the walk against fixtures (a reused
> parent, an older "child", unread times, equal times, cycles, the limits) and the real source against a child this
> process starts.
>
> **One reviewed exception, decided 2026-08-03 and implemented 2026-08-04
> (§S18), then re-keyed the same day (§S22(b)).** A module that is FrameLedger's
> own does not trip the *fuzzy* fragment tier. The exact blocklist still applies
@@ -217,8 +247,51 @@ Implemented in `FrameLedger.Injector` and reached from managed code through a th
> `NtQuerySystemInformation` is a documented-as-unsupported API and its
> `RTL_PROCESS_MODULE_INFORMATION` layout is version-sensitive; the struct
> offsets must be asserted, not assumed. Treat a parse failure as *refuse*,
> never as *clean*. `20_OPEN_QUESTIONS` §S7 tracks the remaining work.
3. **Rules blocklist** — `detection-rules.json` carries `anticheat.blockedExecutables` (exe names) and `anticheat.blockedStoreIds` (Steam appids etc.) for known competitive/online titles, updatable independently of app releases (`05_DETECTION` §Rules updates).
> never as *clean*. ~~`20_OPEN_QUESTIONS` §S7 tracks the remaining work.~~ *(Corrected 2026-10-04: done —
> `fl_guard_sources.cpp` asserts the layout and refuses a parse that yields non-native paths; §S7, closed, is about
> handle rights and WOW64.)*
3. **Rules blocklist** — `detection-rules.json` carries `anticheat.blockedExecutables` (exe names) and `anticheat.blockedStoreIds` (Steam appids etc.) for known competitive/online titles, ~~updatable independently of app releases (`05_DETECTION` §Rules updates)~~ shipped with each release; there is no rules-update path yet *(corrected 2026-10-04: `20_OPEN_QUESTIONS` §S20 feed half; `05_DETECTION` §Trust and staleness of the rules feed)*.
> **Both halves are wired and seeded since 2026-09-25** (owner: "as many and as strict as possible"; rules
> `2026.09.4`). The block below is the history it replaces, kept for the reasoning.
>
> **The store half reads the store's own files, through a seam the guard owns.** `Sources::StoreIdentity` takes the
> install root the guard already derives from the pid (check 4's `ImageDirectory`) and answers from disk: under
> `<library>\steamapps\common\<folder>`, the one `appmanifest_<id>.acf` whose `installdir` is `<folder>` →
> `steam:<id>`; a `goggame-<id>.info` in the root → `gog:<id>`. Nothing is handed in by a caller (§S3 is untouched —
> the ABI still takes a pid and nothing else) and nothing is read from the game's process (rule 4).
>
> **The matrix §S14 asked for:** a listed identity refuses (`BlockedStoreId`, naming the family); an install no store
> names — a loose folder, a GOG-less, manifest-less copy — is **not** refused, because "no store identity" is an
> answer, not an unknown, and refusing it would be the gate that cannot pass; a store layout whose metadata could not
> be read (a manifest that will not open, more than 4096 of them, a listing error) refuses as `PreScanFailed`. With
> nothing listed, nothing is read. Epic has no reader: an Epic install carries no identity to this check.
>
> **What is listed, and why a title list at all:** ~~33~~ 34 Steam app ids and 33 executable names across ten families —
> Valve VAC (CS2, Dota 2, TF2, Deadlock and Valve's older VAC titles), Riot Vanguard, Roblox Hyperion, Blizzard's
> online titles ("Blizzard Warden"), Call of Duty (Activision Ricochet), NetEase (Marvel Rivals, NARAKA, FragPunk,
> Once Human), ACE (Delta Force, Arena Breakout: Infinite), HoYoverse and EA (Battlefield 2042/6, EA SPORTS FC 25/26),
> and since 2026-10-03 (rules `2026.10.1`, owner's list) HyperTech's **CrackProof** (Umamusume: Pretty Derby
> `3224770`, Heaven Burns Red `1973710`, Madoka Magica Magia Exedra `2987800` — Steam ids only: no executable name
> was verified, and a guessed one is a false refusal waiting for an unrelated game). **Since 2026-10-13 (rules
> `2026.10.4`, owner decision D58) Wuthering Waves `3513350`, under ACE**, by its Steam id alone (its executable,
> `Client-Win64-Shipping.exe`, is a name Unreal games share): its ACE sits beside the executable, where check 4 did
> not reach until the same rules (item 4 below), and a session was hooked for 37 s on 2026-10-12 before the 30 s
> re-scan met the driver — a machine-wide finding, which turned nothing off (`spike-notes.md` §19).
> These are the titles whose anti-cheat leaves nothing of the game's own for checks 1, 2 and 4 to find — VAC runs
> inside Steam, Blizzard's scanner is built into the game — or whose kernel driver loads only after the checks run.
> CrackProof is the second kind: a Proton log of Umamusume shows its driver loaded from `C:\Windows\System32` under a
> numbered name (`usrdrv017864.sys`, ValveSoftware/Proton#8853), outside the game's folder, so the `.sys` rule cannot
> see it before the first run and no driver token could name it. Each of the three store pages states *"Uses Kernel
> Level Anti-Cheat"* and CrackProof (read 2026-10-03); ANOTHER EDEN, which a community list also names, was left out
> because its store page says nothing of the kind.
> Every app id was checked against its Steam store page; Call of Duty's changed when Activision split CoD HQ, so only
> ids with a live store page are listed. The per-title lists are **floored** like the families: a rules file can
> add a title and cannot take one off. `rules-validate` refuses a name engines and tools share (`Game.exe`,
> `Client-Win64-Shipping.exe`, `hl2.exe`…), an exact rule that names no `.exe`, and duplicates.
>
> **The owner declined the bulk list** (AreWeAntiCheatYet's ~250 Steam ids): community data that keeps listing a game
> after it drops its anti-cheat would turn hooking off for good on a title that no longer needs it.
> ⚠ **◐ The EXECUTABLE half is wired as of 2026-08-05; the STORE-ID half is
> blocked.** `CheckBlockedExecutable` runs inside `EvaluateImpl` between the
@@ -250,8 +323,26 @@ Implemented in `FrameLedger.Injector` and reached from managed code through a th
> rules file — and therefore every title on the machine (§S17).
4. **Multiplayer heuristic** — if the pre-launch file scan finds an anti-cheat SDK shipped alongside the game (e.g. EOS anti-cheat binaries, `EasyAntiCheat/` directory) even when not currently loaded → refuse and explain.
> **Any kernel driver in the install tree counts, since 2026-09-25 (owner decision).** A `*.sys` file that no
> `files` entry names is reported as `AntiCheatFile` under the family **"Kernel driver in the game folder"**. Every
> driver this project has found shipped inside a game — `PGameProtectDriver_X64.sys`, `randgrid.sys`,
> `NeacSafe64.sys`, `BlackCat64.sys`, `mhyprot*.sys` — was an anti-cheat's, and naming each one in data first is how
> the next one walks past, as ACE's did in August. The rule is **code, not data** (`fl_prescan.cpp`,
> `kKernelDriverInTreeFamily`): no rules file can remove it or rename its family. A named `files` entry still wins,
> so `randgrid.sys` reads as Activision Ricochet. **The cost the owner accepted:** a game that ships a driver for
> some other purpose (a wheel, a peripheral, an old disc check) has its hooking turned off like any finding, and
> nothing clears it.
>
> **The advisory pre-scan takes the executable and resolves the install root itself, since 2026-09-25.**
> `FlStaticPreScan(gameDirectory)` scanned the directory it was handed, and its one caller (`SetHookEnabled`) handed
> it the executable's own folder — so for an Unreal title, the scan that decides whether hooking may be turned on
> looked at `<root>\<Project>\Binaries\Win64\`, exactly where the Lies of P measurement below says `EasyAntiCheat/`
> is not. The chokepoint always resolved the root. `FlStaticPreScanGame(exePath)` replaces it: the same
> `ResolveInstallRoot`, plus check 3 on the executable's name and the install's store identity.
> **Implemented, and stated narrowly.** `fl_prescan.cpp` walks the target's
> own directory (derived from its pid, never from a caller-supplied path) to
> install root and, since 2026-10-13, its executable's own folder (both derived from its pid, never from a
> caller-supplied path — "Which directory" below) to
> **depth 3** — raised from 2 on 2026-08-04 (§S22, `spike-notes.md` §13), because a
> title shipping its own kernel driver two levels below the install root was
> invisible from where the scan starts, so the blocklist row naming it could not
@@ -262,7 +353,7 @@ Implemented in `FrameLedger.Injector` and reached from managed code through a th
> nothing produced either.
>
> **It runs inside the chokepoint**, as the last of the four checks in
> `EvaluateImpl`. `FlStaticPreScan` also exports it for FR-2.2's pre-launch
> `EvaluateImpl`. ~~`FlStaticPreScan`~~ `FlStaticPreScanGame` (since 2026-09-25 — corrected 2026-10-04) also exports it for FR-2.2's pre-launch
> question, but that export is **advisory**: it gates nothing, and a caller who
> never asks it — or ignores the answer — changes nothing about what injection
> allows.
@@ -271,9 +362,11 @@ Implemented in `FrameLedger.Injector` and reached from managed code through a th
> could. Since 2026-08-04 `FrameLedger.Guard.dll` ships beside the **Agent
> only** (`FrameLedger.Guard.targets`, §S18 blocker 3), so `FrameLedger.App`
> has no `FlStaticPreScan` call site and no DLL to load. FR-2.2's advisory
> answer reaches the UI through the Agent over IPC (`07_IPC`) when that exists.
> answer reaches the UI through the Agent over IPC (`07_IPC`) ~~when that exists.
> Recorded rather than quietly reworded: an advisory export with no consumer is
> a claim about the product that is not true yet.
> a claim about the product that is not true yet.~~ *(corrected 2026-10-04: it does — the Agent's
> `SetHookEnabled` answer carries it since P3, `HookEnabledAck.Prescan`, and the library sweep's
> `hook_prescan_state` since beta.8 is shown on the game's page)*.
>
> **Which directory.** The **install root**, resolved by walking up from the
> executable to a known platform boundary (`steamapps\common\<X>` and
@@ -294,24 +387,42 @@ Implemented in `FrameLedger.Injector` and reached from managed code through a th
> appeal. A nested executable outside a recognised store layout is therefore
> still scanned narrowly; that residual is stated, not closed.
>
> **Amended 2026-10-13: the root AND the executable's folder.** The root replaced the executable's folder, and
> that was half the answer. The walk reaches three levels below where it starts, and an Unreal executable is
> already three below its root, so a folder **beside** the executable is four: MEASURED on Wuthering Waves, whose
> Tencent ACE lives in `Client\Binaries\Win64\AntiCheatExpert\` (with `ACE-BASE.sys` and `ACE-CORE.sys` in it). The
> walk from the root listed `Win64` and never opened it, so the library pre-scan read the game clean three times,
> hooking stayed available, and the first session was hooked for 37 s until the 30 s re-scan met ACE's driver —
> machine-wide, so nothing was turned off (`spike-notes.md` §19). Neverness To Everness keeps a second
> `AntiCheatExpert\` beside its `HTGame.exe`, six levels down, that no walk had seen either. Check 4 now walks the
> root and then, when the executable lives below it, the executable's own folder — same walk, same reach, its own
> 4096-entry budget, the same matcher and the same D33 tolerance (`ScanGameFolders`). `ImageDirectory` names the
> executable's folder and the checks resolve the root from it. Raising the reach instead was measured and rejected:
> depth 4 still misses NTE's folder, and at depth 5 three installed titles overrun 4096 entries (Yu-Gi-Oh! Master
> Duel: 41,251), which would refuse them. Measured across the owner's 83 Steam installs, the second walk costs at most
> 103 entries and newly finds exactly those two folders.
>
> **What it does not cover.** Beyond the above, the residual is an anti-cheat
> SDK sitting on disk whose service is not installed and whose module is not
> loaded; checks 1, 2 and 2b already cover the rest. And today the `directories` + `files`
> groups carry only three tokens between them, so "check 4 ran" is a much
> groups carry ~~only three tokens~~ 67 tokens between them since 2026-09-25, plus any `.sys` by code *(corrected
> 2026-10-04; documented names, not measured ones)*, so "check 4 ran" is a much
> narrower statement than "this game ships no anti-cheat". Widening it needs
> **verified** file and directory names — the seed table below deliberately
> carries "no data yet" rows rather than guesses, because a wrong token fails
> closed by never firing, which is a silent hole.
>
> **Every uncertainty refuses**, with `Reason::kPreScanFailed` rather than a
> hit: directory absent or unlistable, either bound exceeded, a name we could
> hit: directory absent or unlistable, ~~either bound exceeded~~ the 4096-entry bound exceeded, a name we could
> not convert, or a reparse point — which is never followed, because a
> junction can hide an `EasyAntiCheat/` beneath it. **Unmeasured:** how often
> junction can hide an `EasyAntiCheat/` beneath it. *(Corrected 2026-10-13: the DEPTH bound never refused. It is a
> reach — a folder at the last level is named and not opened, and the walk still reads as complete — which is how
> Wuthering Waves' ACE was missed; the paragraph above is what answers it.)* **Unmeasured:** how often
> a legitimate library trips the reparse-point rule or the 4096-entry bound.
> That needs a real game library, and it is a false-refusal path, so it is
> recorded rather than assumed benign.
Any check failing ⇒ **injection is refused**. The UI shows which check fired and offers Tier-2 (ETW) capture instead, which requires no injection — but does require an elevated Agent, so the offer must state that plainly and fall through to Tier 3 rather than appearing to succeed and recording nothing (`04_CAPTURE` §Frame source abstraction).
Any check failing ⇒ **injection is refused**. The UI shows which check fired and ~~offers Tier-2 (ETW) capture instead, which requires no injection — but does require an elevated Agent, so the offer must state that plainly and fall through to Tier 3 rather than appearing to succeed and recording nothing (`04_CAPTURE` §Frame source abstraction)~~ **records the session unmeasured — Tier 2: its duration, the machine's sensors and the reason — which needs no injection and no elevation; there is no ETW rung and no Tier 3 since 2026-08-28** (corrected 2026-09-27: this sentence outlived the ladder it described by a month).
### The payload is checked too, and for a long time it was not
@@ -348,7 +459,179 @@ the injection primitive, not a fifth question about the title.
- **Absent** is still `kInjectionFailed`, not `kPayloadNotOurs`. A damaged install
and a misuse of the ABI are different problems and must not share a reason.
> There is no override. No hidden setting, no config-file flag, no CLI switch, no "advanced users" escape hatch. If a user disagrees with a specific entry, the path is a GitHub issue against the rules file, reviewed in public — not a local bypass.
> **There is no override.** ~~There is one, since 2026-09-21, and it is none of the things this paragraph named~~ *(one day; withdrawn 2026-09-22)*: still no hidden setting, no config-file flag, no CLI switch, no "advanced users" escape hatch, no global form. If a user disagrees with a specific entry, the path is still a GitHub issue against the rules file, reviewed in public. What exists is below — and since 2026-09-26 (D33), one narrow, evidence-bound exception for anti-cheat that is user-mode throughout, which lets a named family through while every check still runs (§The user-mode exception).
### What a finding does to the game — owner decision 2026-09-22
**The per-game override of 2026-09-21 is withdrawn.** It shipped in `0.1.0-beta.3` and `beta.4`. Its first real use
(D21, below) showed that it could not reach a process an anti-cheat driver protects, and where it could inject it only
exposed the user to the risk its own disclosure described. The owner withdrew it on 2026-09-22: the native entries, the
pipe message, the App's dialog and card, the strings and the five columns of schema 0007 are gone (schema 0008 drops
them). Sessions that ran under it keep `guard-bypass=` in `capture_notes`; nothing else remembers it.
**What replaced it is the opposite of an override: a finding turns the game's hooking off.** The pre-scan has done
this since P2 (`RecordGuardBlockAsync`: `hook_enabled = 0`, `hook_blocked_reason`, `hook_prescan_state = 'blocked'`).
Every later moment the guard can find something writes the same block — a fourth since 2026-09-25:
| Moment | Where | What it sees |
|---|---|---|
| hooking is turned on | `AgentCommandHandler.SetHookEnabledAsync` | checks 3 and 4 over the executable and its install root (`PreScanGameAsync`; check 4 over the executable's own folder until 2026-09-25) |
| a session starts | `CaptureSession.SessionAsync`, after the gate | checks 1–4 over the live process, its tree, the drivers, the folder |
| the 30 s re-scan | `CaptureSession.DrainAsync`, on a `SafetyUnhook` | the same, for an anti-cheat that loaded late |
| the Agent's pre-scan of the library | `AntiCheatPreScanSweep`, under `--serve` | checks 3 and 4 over every entry, whether or not its hooking was ever on |
**The Agent's pre-scan of the library — owner decision 2026-09-25 (beta.8).** Until then the first three moments were
the only ones, and each needs the user to have asked for hooking: a game nobody enabled stayed
`hook_prescan_state = 'not_run'`, so the App could not tell an anti-cheat game from any other. The owner asked for the
hooking part of anti-cheat games to be hidden, which needs to know which they are, so the Agent now asks the advisory
question itself (`AntiCheatPreScanHostedService`: at start, every 15 s, and at once after `UpdateRules`):
- **Which entries.** Every library row not removed, once per rules version and executable — the key is its own
(schema 0010: `hook_prescan_rules_version`, `hook_prescan_exe_size_bytes`, `hook_prescan_exe_mtime_ms`), so a rules
update that names a game already in the library, or a game update that adds anti-cheat, is a re-scan. Skipped: a
blocked row (it is never asked again), an executable that cannot be read, an entry whose session is running (that
session's own checks are). *Change executable* clears the key with the state, so the new binary is scanned.
- **What it writes** (`IGameConsentStore.RecordPreScanAsync`): a finding about the game is the block above, the
consent stamp kept; a pass is `'clean'`; a scan that could not answer is `'unverified'`, which leaves the toggle
alone. It never writes over a block and never adds a row — the `UPDATE` itself requires both, so a block written
between the sweep's read and its write still stands.
- **What it tells.** A `HookingTurnedOff` event (`07_IPC`) only when the entry's hooking was on: the one case where
something the user switched on changed. Every other finding changes only the game's page and card.
- **What it is not.** It gates nothing: every session start still runs checks 1–4 against the live process, whatever
the sweep wrote. It opens no process — the scan reads the executable's path, its install folder and the stores'
files. It holds the guard's lock for one walk at a time (`NativeAntiCheatGuard` serialises every native call), so a
session start waits for at most the one walk in flight.
**Which findings** — `AntiCheatVerdict.IsFindingAboutTheGame`: an anti-cheat *named* (family non-empty) in the game's
own process (`BlockedModule`), on its title lists (`BlockedExecutable`, `BlockedStoreId`) or in its folder
(`AntiCheatDirectory`, `AntiCheatFile`). **Not** a machine-wide driver or service (`BlockedDriver`, `BlockedService`):
a driver running for another game says nothing about this one, so that refuses this session and writes nothing. Not a
scan that could not look, not unusable rules, not the unsigned-module heuristic, not the latch of an earlier block.
**What the user sees.** The refusal or unhook notice ends with `Safety_HookingTurnedOff`; the game's page shows the
block (`Safety_Blocked_Toggle_Format`) with the toggle disabled; `capture_notes` carry
`hooking-turned-off=<reason>/<family>`; the Agent's session line carries `; hooking-turned-off`; `CaptureRefused` and
`SafetyUnhook` carry `hookingTurnedOff` (`07_IPC`). `CaptureOutcome.HookingTurnedOff` is the loop's word for it.
Since 2026-09-25 (beta.8): the block is stored as `Reason|Family|Signal` so the App says what was found in the user's
language (rows written before keep `"Reason: Family Signal"` and are shown as stored); the library card says
*Anti-cheat* instead of *Hooking off*; and the game's page shows the finding **in place of** the Hooking card, whose
switch could only be refused, while `ui.hide_anticheat_hooking` is on — its default (`08_UI` §Game detail). Off, the
card is back with the finding under its disabled switch. The finding itself is on the page either way (FR-2.2).
**What clears it.** Nothing, as before: the block outlives *Change executable* and a re-import (§A game already enabled
can become blocked later). The owner asked for hooking to be turned off when anti-cheat is detected, not for a second
switch. *(Still true under D33: an exception is a separate layer over the block, never a clearing of it — §The user-mode
exception.)* *(And under D55, beta.19: the Agent removes an entry whose game is no longer installed and that has no session,
but never one that carries a block, an exception's grant or a failed trial — the delete's own SQL refuses them
(`SqliteGamePrune`), so an uninstall is not how a block, a grant or D38's "never again" disappears. Only the user's
*Remove… ▸ Delete sessions too* deletes such a row, as before.)*
**D21 stands as a fact.** A process an anti-cheat driver protects is `SessionEndReason.TargetUnreadable` (2026-09-21:
every candidate of that name exists and none can be opened; ELDEN RING under Easy Anti-Cheat on the owner's machine).
Nothing will be built that opens it — that would be defeating another product's protection, which is rule 3. The same
reason covers a game that runs as administrator while the Agent does not.
**What did not change.** `InjectViaLoadLibrary` keeps internal linkage in `fl_guard.cpp` and `tools/chokepoint-check.ps1`
still finds the injection primitives in exactly that file and the evasion primitives nowhere. `IAntiCheatGuard` is back
to four methods (`NoSecondMatcherTests`). `FloorFamilies` is untouched.
### The user-mode exception — owner decision 2026-09-26 (D33)
**Why it exists.** The beta.8 library sweep turned hooking off for *GIRLS' FRONTLINE 2: EXILIUM* on a documented,
unmeasured rule — NetEase Yidun, `AntiCheatFile NEP2.dll` — after FrameLedger had measured that game hooked (three
normal Tier-1 sessions in the owner's ledger, 474,143 frames). The owner asked for a way to keep measuring a game like
that, and chose, against the rule this document had kept since 2026-09-22 and with that rule quoted back to them, **an
exception the user grants per game, bound to evidence, and only for anti-cheat that is user-mode throughout.** The
reasons D22 withdrew the override are answered one by one: it "did nothing where it was wanted" — ~~an exception is only
offered where FrameLedger has already measured the game hooked~~ *(D38 below: the measurement now comes under the grant,
as its trial)*; it "only exposed the user to the risk its own disclosure described" — that risk stands, and the disclosure
says so, including that a ban can arrive days later and that FrameLedger cannot know.
> **Amended 2026-10-03 (owner decision D38): the evidence comes after the grant, as a trial.** The owner deleted their
> ledger and found *GIRLS' FRONTLINE 2* "Not eligible: 0 successful hooked session(s), two are needed" — for good. The rule
> below was a catch-22 for every game it could ever meet again: since beta.8 the library sweep blocks a game the moment
> it is added, a blocked game is never hooked without a grant (`CaptureSession` sends it to Tier 2 before the resolver),
> so it can never earn the two sessions, and a reset ledger loses the ones it had. D33's evidence was reachable only for a
> game measured before its block, and only while those rows lasted. Asked with that, the owner chose: **a grant needs no
> session; the first two hooked sessions under it are a trial; any of them that does not go well ends the exception for
> good** (`games.ac_exception_trial_failed_at`, schema 0017, which nothing clears). Every other condition is unchanged.
**What may be excepted — all of it must hold:**
- every finding about the game is `BlockedModule`, `AntiCheatFile` or `AntiCheatDirectory` of **one** family;
- that family's whole footprint is user-mode — no `drivers` entry, no `services` entry and no `*.sys` among its `files`, in
the compiled floor or the rules file (`fl::guard::FamilyIsUserModeOnly`). The floor cannot be shrunk, so data can make a
family kernel-level and never the reverse. On today's data that leaves NetEase Yidun, AhnLab HackShield, Anybrain,
FredaikisAntiCheat and Roblox Hyperion *(Hyperion added 2026-10-04: its rows are one module and one file; its only title
is on the executable list, so it is never excepted in practice)*; Easy Anti-Cheat, BattlEye, ACE, NetEase Anti-Cheat, mihoyo protect, Vanguard, Ricochet and every
other family carry a driver or a service and are never excepted;
- no `*.sys` anywhere in the install tree *(within check 4's reach: three levels under the install root and, since 2026-10-13, under the executable's own folder)* — the kernel-driver rule (D30) is never excepted, whichever family a driver
belongs to (so *Aniimo*, which unpacks `NEPKernel.sys` beside `NEP2.dll` on its first run, stays blocked);
- the game is on no title list (`BlockedExecutable`, `BlockedStoreId` — the notorious titles are there by design);
- ~~the ledger holds **at least two successful Tier-1 sessions** of the game: hooked, frames recorded, `exit_status = normal`
(which since beta.8 includes End task's exit code 1 and a user's stop), never crashed, never unhooked for safety.~~
**Since D38 (2026-10-03): no session is needed** — and no exception of the game has ever ended during its trial
(`ac_exception_trial_failed_at` is NULL).
**Never excepted, whatever the user ticked:** a machine-wide `BlockedDriver` or `BlockedService`, the fuzzy tier
(`SuspiciousUnsigned`), a scan that could not look or finish, unusable rules, `TargetUnreadable` (D21), a 32-bit target,
the kill switch, and a Vulkan target (the implicit layer's own self-scan stays strict).
**How the guard takes it.** The four evaluating ABI entries carry `toleratedFamilies` — a NAME, never evidence
(`fl_guard_abi.h`). The guard resolves it against its own rules (`ResolveTolerance`), keeps only a user-mode family,
runs every check, lets that family's modules, files and folders through **and keeps scanning past them**, so a second
family, a suspicious module or a `.sys` further in still refuses. A pass that let something through is
`kAllowedUserModeException` (reason 28, the slot the withdrawn bypass left) with the family and the signal; the session it
starts is marked with them.
**How the Overlay takes it.** The Overlay stops observing when a floor module loads after injection, so the Agent
publishes the exception's family names in `Local\FrameLedger.Tolerate.<pid>` (`fl_tolerance.h`) before it asks the guard
to inject, and the Overlay's init thread reads them once, before its loader detour exists — resolving each against its
own compiled floor and honouring only a user-mode family. A mapping that names anything else tolerates nothing, and the
Agent's 30 s re-scan keeps judging every other signal.
**What ends it.** A new finding outside the excepted family at any of the four moments above writes the block as before
and revokes the exception; a session under it that crashes, is unhooked for safety or is stopped by the Overlay's
in-process floor stop revokes it; an executable change ends it with the consent it shared a fingerprint with; turning
the option off suspends every exception. **The block itself is never cleared** — the exception is a separate layer over
it, and the finding stays on the game's page (FR-2.2).
**The trial (D38).** Until two sessions under a grant have succeeded — hooked, stored, frames recorded, `normal`
(`ISessionRepository.CountSuccessfulUnderGrantAsync`: under that family, started at or after the grant) — the grant is in
its trial, and the App says so ("trial: 1 of 2"). During the trial **any** end of the list above ends the exception
**for good**, and so does a stored hooked session that recorded no frame or did not end normally
(`UserModeExceptionLapse.TrialFailed`, decided by `UserModeExceptionLapsePolicy` when the recorder stores the row): the
end is recorded with its own reason and `ac_exception_trial_failed_at` is set. While it is set the sweep writes the game
not eligible, the Agent refuses a grant (`Refused.reason = TrialFailed`, the signal is when) and the store refuses one in
SQL; withdrawing, a game update, *Change executable* and a twin merge all keep it. A session too short to be stored, or
one that was never hooked, is not judged by its frames or its exit — it neither counts toward the two nor fails the
trial that way — but an end of the list above still ends the exception for good during the trial: a crash while
hooked, however short, or a finding about the game at the start. After the trial, an end is what it was under
D33: the exception may be made again once the sweep finds the game eligible. Deleting sessions can only lengthen a trial
— the count is read, never stored as a grant's own fact.
**What it is not.** Not a bypass of a live refusal, not a global switch (a Settings option off by default enables the list,
and the user ticks each game), not reachable from the command line, and not evasion: the DLL stays `LoadLibraryW`-loaded,
named and visible (rule 3). `InjectViaLoadLibrary` still has internal linkage in `fl_guard.cpp`; `tools/chokepoint-check.ps1`
is unchanged.
*Built in beta.9. PR-1: the guard's tolerance and the Overlay's channel. PR-2: the Agent — the option
(`hooking.usermode_ac_exceptions`, off), the sweep's eligibility pass (a tolerant pre-scan keyed on the rules, the
executable and the block; the session count every pass), the `SetAntiCheatException` command (the Agent gathers the
facts itself; the store applies the rule), the gate's one branch with the channel published before the request, the
re-scans naming the family, the session's mark, and every end (`UserModeExceptionLapse`) — schema 0014. PR-3: the
option and the list in Settings, the versioned disclosure (`Safety_Exception_*`, `AntiCheatExceptionDisclosure`), the
game page's exception card and its usable switch under an exception in force, the marks, and the legal text
(Disclaimer §2A 2.7, EULA 1.3, the accuracy block, SECURITY.md) — `08_UI` §Games.*
*D38 in beta.11 (2026-10-03): `UserModeExceptionRules.TrialSessions` replaces `RequiredSessions`; eligibility is the
guard's answer and the trial mark; `ac_exception_sessions` is the trial's progress; schema 0017
(`ac_exception_trial_failed_at`); `Refused.reason` `TrialFailed` replaces `TooFewSessions`; the disclosure is
`ac-exception-dialog/2` (its `Why` names no count, a new `Trial` paragraph); the Settings list shows only games it can act
on; and a sweep that cannot read the executable answers "could not verify" instead of leaving the row "checking" for ever.
Legal text: Disclaimer §2A 2.9, EULA 1.4, the accuracy block, SECURITY.md, LIMITATIONS.md.*
### The floor data cannot remove
@@ -422,32 +705,112 @@ earlier version of this table produced an entry that was matched *literally* and
therefore never fired. A silent hole in the blocklist, created by its own
normative documentation. Write tokens here exactly as the data must hold them.
| Family | Group | Match | Tokens |
|---|---|---|---|
| Easy Anti-Cheat | `modules` | prefix | `EasyAntiCheat`, `EasyAntiCheat_EOS` |
| Easy Anti-Cheat | `directories` | name | `EasyAntiCheat` |
| Easy Anti-Cheat | `services` | name | `EasyAntiCheat`, `EasyAntiCheat_EOS`, `EasyAntiCheat_EOSSys` |
| Easy Anti-Cheat | `drivers` | prefix | `EasyAntiCheat` — **machine-wide refusal** (check 2) |
| BattlEye | `modules` | prefix | `BEClient`, `BEService` |
| BattlEye | `directories` | name | `BattlEye` |
| Riot Vanguard | `drivers` | exact | `vgk.sys` — **machine-wide refusal** (check 2) |
| Riot Vanguard | `services` | name | `vgc` |
| Denuvo Anti-Cheat | `modules` | prefix | `denuvo` |
| nProtect GameGuard | `modules` | prefix | `GameGuard`, `npgg`, `GameMon` |
| Xigncode3 | `modules` | prefix | `xhunter` |
| Xigncode3 | `files` | name | `x3.xem` |
| mihoyo protect | `drivers` | prefix | `mhyprot` |
| FACEIT | `modules` | prefix | `faceit` |
| ESEA | `modules` | prefix | `esea` |
| PunkBuster | `modules` | prefix | `PnkBstr`, `pbcl`, `pbsv` |
| Anti-Cheat Expert | `drivers` | exact | `ACE-BASE.sys`, `ACE-ADVT.sys`, `ACE-GAME.sys` — **machine-wide refusal** (check 2) |
| Anti-Cheat Expert | `services` | name | `AntiCheatExpert Protection`, `AntiCheatExpert Service` |
| Anti-Cheat Expert | `files` | name | `PGameProtectDriver_X64.sys` |
| **Activision Ricochet** | — | — | **No data yet** — driver and service names unconfirmed (`20_OPEN_QUESTIONS` §S5) |
| **Valve VAC** | — | — | **No data yet** — needs `blockedStoreIds`, whose half of check 3 **cannot be called** (§S14; the executable half was wired in #52, but a renamed exe defeats it anyway, which is why this row reserves the store-id route). **Measured 2026-08-04: a real VAC title returns `Allow`** (`spike-notes.md` §13) |
| Family | Group | Match | Tokens | Added |
|---|---|---|---|---|
| Easy Anti-Cheat | `modules` | prefix | `EasyAntiCheat`, `EasyAntiCheat_EOS` | seed |
| Easy Anti-Cheat | `drivers` | prefix | `EasyAntiCheat` — **machine-wide refusal** (check 2) | seed |
| Easy Anti-Cheat | `directories` | name | `EasyAntiCheat`, `EasyAntiCheat_EOS` | seed; `EasyAntiCheat_EOS` 2026-09-25 |
| Easy Anti-Cheat | `services` | name | `EasyAntiCheat`, `EasyAntiCheat_EOS`, `EasyAntiCheat_EOSSys` | seed |
| Easy Anti-Cheat | `files` | name | `EasyAntiCheat_EOS_Setup.exe`, `EasyAntiCheat_Setup.exe`, `EasyAntiCheat_x64.dll`, `EasyAntiCheat_x86.dll`, `EasyAntiCheat_EOS.sys`, `start_protected_game.exe`, `eac_server64.dll` | 2026-09-25 |
| BattlEye | `modules` | prefix | `BEClient`, `BEService` | seed |
| BattlEye | `drivers` | exact | `BEDaisy.sys` — **machine-wide refusal** (check 2) | 2026-09-25 |
| BattlEye | `directories` | name | `BattlEye` | seed |
| BattlEye | `services` | name | `BEService`, `BEDaisy` | 2026-09-25 |
| BattlEye | `files` | name | `BEService.exe`, `BEService_x64.exe`, `BEClient.dll`, `BEClient_x64.dll`, `BEDaisy.sys` | 2026-09-25 |
| Denuvo Anti-Cheat | `modules` | prefix | `denuvo` | seed |
| Denuvo Anti-Cheat | `drivers` | exact | `denuvo-anti-cheat.sys` — **machine-wide refusal** (check 2) | 2026-09-25 |
| Denuvo Anti-Cheat | `services` | name | `denuvo-anti-cheat` | 2026-09-25 |
| Denuvo Anti-Cheat | `files` | name | `denuvo-anti-cheat.sys`, `denuvo-anti-cheat-runtime.dll`, `denuvo-anti-cheat-update-service.exe` | 2026-09-25 |
| nProtect GameGuard | `modules` | prefix | `GameGuard`, `npgg`, `GameMon` | seed |
| nProtect GameGuard | `directories` | name | `GameGuard` | 2026-09-25 |
| nProtect GameGuard | `services` | name | `npggsvc` | 2026-09-25 |
| nProtect GameGuard | `files` | name | `GameGuard.des`, `GameMon.des`, `GameMon64.des`, `npggNT.des`, `npggNT64.des`, `npsc.des` | 2026-09-25 |
| Xigncode3 | `modules` | prefix | `xhunter` | seed |
| Xigncode3 | `modules` | exact | `x3.xem` | 2026-09-25 |
| Xigncode3 | `drivers` | prefix | `xhunter` — **machine-wide refusal** (check 2) | 2026-09-25 |
| Xigncode3 | `directories` | name | `XIGNCODE`, `XIGNCODE3` | 2026-09-25 |
| Xigncode3 | `services` | name | `xhunter1` | 2026-09-25 |
| Xigncode3 | `files` | name | `x3.xem`, `xhunter1.sys` | seed; `xhunter1.sys` 2026-09-25 |
| PunkBuster | `modules` | prefix | `PnkBstr`, `pbcl`, `pbsv` | seed |
| PunkBuster | `drivers` | prefix | `PnkBstrK` — **machine-wide refusal** (check 2) | 2026-09-25 |
| PunkBuster | `directories` | name | `PunkBuster` | 2026-09-25 |
| PunkBuster | `files` | name | `pbsvc.exe`, `PnkBstrA.exe`, `PnkBstrB.exe`, `pbsv.dll`, `pbcl.dll`, `pbag.dll` | 2026-09-25 |
| FACEIT | `modules` | prefix | `faceit` | seed |
| FACEIT | `drivers` | exact | `FACEIT.sys` — **machine-wide refusal** (check 2) | 2026-09-25 |
| FACEIT | `services` | name | `FACEIT`, `FACEITService` | 2026-09-25 |
| ESEA | `modules` | prefix | `esea` | seed |
| ESEA | `drivers` | prefix | `ESEADriver` — **machine-wide refusal** (check 2) | 2026-09-25 |
| ESEA | `services` | name | `ESEADriver2` | 2026-09-25 |
| Riot Vanguard | `drivers` | exact | `vgk.sys` — **machine-wide refusal** (check 2) | seed |
| Riot Vanguard | `services` | name | `vgc`, `vgk` | seed; `vgk` 2026-09-25 |
| mihoyo protect | `modules` | prefix | `mhypbase` | 2026-09-25 |
| mihoyo protect | `drivers` | prefix | `mhyprot`, `HoYoKProtect` — **machine-wide refusal** (check 2) | seed; `HoYoKProtect` 2026-09-25 |
| mihoyo protect | `services` | name | `mhyprot2`, `mhyprot3`, `HoYoKProtect` | 2026-09-25 |
| mihoyo protect | `files` | name | `mhypbase.dll`, `mhyprot2.sys`, `mhyprot3.sys`, `HoYoKProtect.sys` | 2026-09-25 |
| Anti-Cheat Expert | `modules` | prefix | `SGuard`, `AntiCheatExpert` | 2026-09-25 |
| Anti-Cheat Expert | `modules` | exact | `ACE-Base64.dll` | 2026-10-13 |
| Anti-Cheat Expert | `drivers` | exact | `ACE-BASE.sys`, `ACE-ADVT.sys`, `ACE-GAME.sys` — **machine-wide refusal** (check 2) | seed |
| Anti-Cheat Expert | `drivers` | exact | `ACE-CORE.sys` — **machine-wide refusal** (check 2) | 2026-10-13 |
| Anti-Cheat Expert | `directories` | name | `AntiCheatExpert`, `AceAntibotClient` | 2026-09-25 |
| Anti-Cheat Expert | `services` | name | `AntiCheatExpert Protection`, `AntiCheatExpert Service`, `ACE-BASE` | seed; `ACE-BASE` 2026-10-13 |
| Anti-Cheat Expert | `files` | name | `PGameProtectDriver_X64.sys`, `SGuard64.exe`, `SGuardSvc64.exe` | seed; `SGuard64.exe`, `SGuardSvc64.exe` 2026-09-25 |
| Anti-Cheat Expert | `files` | name | `ACE-BASE.sys`, `ACE-CORE.sys`, `ACE-Base64.dll`, `ACE-Service64.exe`, `ACE-Setup64.exe` (measured in Wuthering Waves' folder) | 2026-10-13 |
| EA AntiCheat | `modules` | prefix | `EAAntiCheat` | 2026-09-25 |
| EA AntiCheat | `drivers` | exact | `EAAntiCheat.sys` — **machine-wide refusal** (check 2) | 2026-09-25 |
| EA AntiCheat | `files` | name | `EAAntiCheat.Installer.exe`, `EAAntiCheat.GameServiceLauncher.exe`, `EAAntiCheat.GameServiceLauncher.dll` | 2026-09-25 |
| NetEase Anti-Cheat | `modules` | prefix | `NeacSafe`, `NeacClient` | 2026-09-25 |
| NetEase Anti-Cheat | `drivers` | prefix | `NeacSafe` — **machine-wide refusal** (check 2) | 2026-09-25 |
| NetEase Anti-Cheat | `files` | name | `NeacSafe64.sys`, `NeacSafe64_ex.sys` | 2026-09-25 |
| NetEase Yidun | `modules` | exact | `NEP2.dll` | 2026-09-25 |
| NetEase Yidun | `files` | name | `NEP2.dll` | 2026-09-25 |
| Nexon Game Security | `modules` | prefix | `BlackCipher`, `BlackCall`, `BlackXchg` | 2026-09-25 |
| Nexon Game Security | `drivers` | exact | `BlackCat64.sys` — **machine-wide refusal** (check 2) | 2026-09-25 |
| Nexon Game Security | `directories` | name | `BlackCipher` | 2026-09-25 |
| Nexon Game Security | `files` | name | `BlackCipher.aes`, `BlackCipher64.aes`, `BlackCall.aes`, `BlackCall64.aes`, `BlackCat64.sys` | 2026-09-25 |
| TenProtect | `modules` | prefix | `TP3Helper`, `TenSafe` | 2026-09-25 |
| TenProtect | `drivers` | exact | `TesSafe.sys` — **machine-wide refusal** (check 2) | 2026-09-25 |
| TenProtect | `files` | name | `TP3Helper.exe` | 2026-09-25 |
| AhnLab HackShield | `modules` | prefix | `EhSvc`, `HShield`, `HSInst` | 2026-09-25 |
| AhnLab HackShield | `directories` | name | `HShield` | 2026-09-25 |
| AhnLab HackShield | `files` | name | `HSInst.dll`, `EhSvc.dll` | 2026-09-25 |
| Anybrain | `modules` | exact | `anybrainSDK.dll`, `Cerebro.dll` | 2026-09-25 |
| Anybrain | `files` | name | `anybrainSDK.dll`, `Cerebro.dll` | 2026-09-25 |
| Roblox Hyperion | `modules` | exact | `RobloxPlayerBeta.dll` | 2026-09-25 |
| Roblox Hyperion | `files` | name | `RobloxPlayerBeta.dll` | 2026-09-25 |
| EQU8 | `modules` | prefix | `equ8` | 2026-09-25 |
| EQU8 | `drivers` | prefix | `EQU8_HELPER` — **machine-wide refusal** (check 2) | 2026-09-25 |
| EQU8 | `files` | name | `equ8_conf.json` | 2026-09-25 |
| Activision Ricochet | `drivers` | exact | `randgrid.sys`, `brynhildr.sys`, `atvi-brynhildr.sys` — **machine-wide refusal** (check 2) | 2026-09-25 |
| Activision Ricochet | `services` | name | `atvi-randgrid_sr`, `atvi-randgrid_msstore` | 2026-09-25 |
| Activision Ricochet | `files` | name | `randgrid.sys` | 2026-09-25 |
| FredaikisAntiCheat | `directories` | name | `FredaikisAntiCheat` | 2026-09-25 |
| **Valve VAC** | — | — | ~~**No data yet** — needs `blockedStoreIds`, whose half of check 3 **cannot be called**~~ **Per-title lists since 2026-09-25** (check 3): 13 Steam app ids and 8 executables, the store half wired. VAC runs inside Steam, so no module, driver or file of the game's own can name it — this row stays a dash on purpose. (**Measured 2026-08-04: a real VAC title returned `Allow`**, `spike-notes.md` §13 — the gap these lists close.) | 2026-09-25 |
| **CrackProof** | — | — | **Per-title list since 2026-10-03** (check 3, rules `2026.10.1`): 3 Steam app ids, no executables. Its kernel driver loads from `System32` under a numbered name, so no module, driver or file of the game's own can name it — this row stays a dash on purpose, like VAC's. | 2026-10-03 |
The "no data yet" rows are deliberately kept rather than deleted. An admitted
gap is reviewable; a deleted row is invisible.
gap is reviewable; a deleted row is invisible. ~~Activision Ricochet's was one of them~~ — it has data since
2026-09-25 (~~below~~ above); ~~VAC's stays until its per-title route exists~~ VAC's became per-title lists the same day,
13 Steam ids and 8 executables *(corrected 2026-10-04)*.
> **Expanded 2026-09-25 (owner: "as many anti-cheats and as strict as possible").** Eleven families became
> twenty-two and 19 entries became 74: EA AntiCheat, Activision Ricochet, NetEase Anti-Cheat, NetEase Yidun, Nexon
> Game Security, TenProtect, AhnLab HackShield, EQU8, Anybrain, FredaikisAntiCheat and Roblox Hyperion are new, and
> most existing families gained the groups they lacked — BattlEye's `BEDaisy.sys`, FACEIT's and ESEA's drivers,
> `HoYoKProtect.sys` (which the `mhyprot` prefix never matched), Xigncode3's driver and service, Denuvo's driver.
> **Every new token is DOCUMENTED, not measured**: the sources are SteamDB's `FileDetectionRuleSets` (MIT), the
> vendors' own support pages (Activision RICOCHET, EA, FACEIT, BattlEye), LOLDrivers and DRML, named per entry in
> the data's `note`. The ACE rule above still holds — a blocklist may over-cover and must never under-cover, and a
> wrong token fails closed by never firing — so an unmeasured token is admitted, labelled, and left for a real title
> to confirm. `kMaxFamilies` went 64 → 256 with it (2 × 74 no longer fitted).
>
> **Three services are deliberately absent**, and the reason is the RUNNING rule above: a service counts while it
> runs, and a service that runs outside play refuses every session on the machine. `EAAntiCheatService` can be set
> to start automatically; PunkBuster's `PnkBstrA` runs at every boot once installed; Denuvo's update service runs
> apart from the game. Each family is caught through its driver, its modules or its files instead.
>
> **New `modules` rows are appended, never inserted.** The Overlay's `LoadLibrary` detour reports a 1-based index
> into this group's order (`FlWriterState.earlyStopFamily` → `sessions.early_stop_family`), so a row inserted above
> an existing one would change what indexes already stored mean.
> **Anti-Cheat Expert was added 2026-08-04 from measurement, not from reading.**
> `ACE-BASE.sys` and `ACE-ADVT.sys` were found installed under `System32\drivers`
@@ -474,7 +837,7 @@ gap is reviewable; a deleted row is invisible.
> *every* title, which is how a user ends up hunting for the override that
> CLAUDE.md rule 2 says does not exist.
The list is data, versioned in `detection-rules.json`, expandable without a release. Unknown-but-suspicious modules (filename containing one of the `nameFragments` — today `anticheat`, `antitamper`, `guard`, `protect` — plus unsigned-by-known-vendor) produce a **warn-and-refuse** with a "report this to us" link rather than silently allowing.
The list is data, versioned in `detection-rules.json`, expandable without ~~a release~~ a code change, still delivered by a release (§S20 feed half — corrected 2026-10-04). Unknown-but-suspicious modules (filename containing one of the `nameFragments` — today `anticheat`, `antitamper`, `guard`, `protect` — plus unsigned-by-known-vendor) produce a **warn-and-refuse** with a "report this to us" link rather than silently allowing.
> **Three corrections to that sentence, all recorded in §S19; one is now closed.**
> It listed four fragments while the data carried five (`gameguard` was missing
@@ -531,6 +894,15 @@ checked stays untrusted and refuses — that direction is deliberate.
Re-run **every pre-injection check** every 30 s, for **every Tier-1 session —
injected or layered**.
> **A refused re-scan of a game that has already exited is that exit (owner decision D48, beta.14).** When the re-scan
> refuses only because it could not read the game's tree (`ProcessUnreadable`, `ModuleScanFailed`,
> `ProcessTreeUnavailable` — never a finding) and the game itself has exited by the time the session concludes, the
> session ends as `TargetExited`, its exit code deciding normal or crashed, with `scan_at_exit=<reason>` in its notes
> (`Application.Capture.ExitScanRelabel`). The stop was still published to the Overlay — the game it would have stopped
> is gone. A finding, any refusal while the game still runs, and a refusal of another check (drivers, services, the
> pre-scan) are a safety unhook exactly as before. `CaptureSessionTests.AnUnreadableRescanOfAGameThatHasExited…` and
> its three refusing neighbours.
> **This said "both the module scan and the driver scan" until 2026-08-05, and
> the loop runs four checks, not two** (`20_OPEN_QUESTIONS` §S23-4).
> `FlGuardEvaluate` → `EvaluateImpl` runs `CheckDrivers`, `CheckServices`,
@@ -599,12 +971,32 @@ injected or layered**.
> stop). Modules loaded **before** the Overlay attached are the pre-injection scan's, as always. The
> detour supplements the poll; it replaces nothing (§S6's own ruling).
> **This sentence used to say the hook "already exists and is currently unused", which was false.** Corrected 2026-08-04: the Overlay installs no hooks at all — `dllmain.cpp` exports one function and nothing in the tree calls `MH_CreateHook` outside a probe. §S6 is therefore downstream of the whole P1 hook layer, not "the cheapest available improvement to the most important behavior in the product". A reader planning work off this paragraph was being told a mechanism was sitting there ready.
> **This sentence used to say the hook "already exists and is currently unused", which was false.** Corrected 2026-08-04: the Overlay installs no hooks at all — `dllmain.cpp` exports one function and nothing in the tree calls `MH_CreateHook` outside a probe. *(Overtaken 2026-09-06: P1 installed the hooks and the `LoadLibraryExW` detour above; the Overlay exports four functions. Marked 2026-10-04.)* §S6 is therefore downstream of the whole P1 hook layer, not "the cheapest available improvement to the most important behavior in the product". A reader planning work off this paragraph was being told a mechanism was sitting there ready.
### Elevated / protected targets
If `OpenProcess` with the needed rights fails (protected process, higher integrity), do **not** escalate creatively. Report "cannot attach" and offer Tier-2. Never attempt to acquire privileges beyond running the Agent elevated at the user's explicit request.
> **The explicit request exists since beta.10 (owner decision D34, 2026-09-27): the admin mode.** An option off by default,
> turned on through a versioned disclosure (`Safety_AdminMode_*`, `agent-admin-dialog/1`) that states what it adds, what it
> does not change, how Windows asks and the risk of a per-user install; then **Windows asks at every start of the Agent**
> (`01_ARCHITECTURE` ADR-9). What it does NOT do, each held by code rather than by this paragraph:
>
> - **It clears no finding and opens no protected process.** The guard runs exactly as unelevated: the driver scan asks
> `NtQuerySystemInformation`, and a process an anti-cheat driver protects stays `TargetUnreadable` (D21) — elevation turns
> "could not look" into an answer only where Windows would give any administrator one.
> - **It enables no privilege.** An elevated token holds `SeDebugPrivilege` and `SeLoadDriverPrivilege` disabled and they
> stay so: `AdjustTokenPrivileges`, `RtlAdjustPrivilege`, `EnterDebugMode` and the debug privilege's name may not appear
> under `src/` (`tools/chokepoint-check.ps1`), and `PrivilegeFootprintTests` asserts on the elevated CI runner that opening
> targets and LibreHardwareMonitor's CPU group enabled none.
> - **It elevates no game.** A game started from FrameLedger gets the desktop shell's token (`UnelevatedProcess`); with no
> shell to take one from, the launch is refused with that reason (`Launch_Error_1400`), never made elevated instead.
> - **It is not silent.** Every start asks; a start that was declined serves as a standard user and says so; the prompt
> answered by another account ends that Agent before it touches anything (exit 11).
>
> The residual risk is stated to the user, not solved: FrameLedger installs per user and unsigned, so a program running
> under the account could replace its files and be run as administrator the next time the user accepts the prompt.
## User-facing consent
Enabling hooking is a **per-game** action, gated by a one-time dialog per game that states, in plain language:
@@ -668,7 +1060,60 @@ Consent is stored per game (`games.hook_consent_at`), **stamped by the Agent, ne
> publishing `unhookRequested`, and keeps the Vulkan layer off by never setting `FRAMELEDGER_ENABLE_VK_LAYER`
> on a launch.
The default for every newly added game is **hooking off — Tier 2**. Nothing is ever injected because the user merely added a game.
The default for every newly added game is **hooking off — Tier 2**. Nothing is ever injected because the user merely added a game — and since 2026-09-22 nothing is *opened* either: a hooking-off row's Tier-2 session is held by ~~the executable's name~~ the executable's image path in the watcher's own snapshot (2026-09-23), with no `OpenProcess`, no resolver and no gate (`04_CAPTURE` §Tier selection). *(Corrected 2026-10-03, beta.12, owner
decision D43: such a hold now reads the game process's own memory once a second — its video memory from performance
counters that open nothing, its system memory through a handle opened with `PROCESS_QUERY_LIMITED_INFORMATION` for the
read and closed after it, the same least right the watcher's snapshot already opens every process with, each second. No
handle is held, nothing is injected, the guard is not involved, and what is read is the kernel's accounting about the
process, never its memory — rule 4 is untouched. A process that refuses even that right reads N/A.)*
### A moved drive is the same executable — owner ask 2026-09-22
Every row is keyed on its executable's path, and consent is a record about one executable: path, size, mtime
(`ExecutableFingerprint`). On 2026-09-21/22 the owner's external drive came back as `H:` instead of `D:`, and
every one of 46 games read "executable unreadable" until the letter came back; a game launched from `H:` matched
its row by file name only and ran as a stranger, keyed on the new path, with no consent. **The path is where the
bytes live; the size and the mtime are what the consent is about.** So `ExecutableRelocator` may move a row to the
same file under another drive-letter root — and only then — with everything kept: consent, block, pre-scan state,
detection. The conditions are the safety of it:
- the file is gone from the row's path (both files present is two copies, not a move; nothing happens);
- exactly one other root holds a file with the same size and the same mtime (two is an ambiguity, and ambiguity
refuses, as it does in the resolver);
- the repository's write requires the same size and mtime again (`RelocateExecutableAsync`), so no caller can point
a consent at a different binary through it;
- no process is opened for any of this; the relocator reads files. It is asked by the 15 s sweep, by the watcher on
a file-name match, and by the enable-hooking command before it says "unreadable".
- **the candidate is the row's own path with only the drive letter changed — for every caller (2026-09-23).** The
watcher's adopt used to accept ANY running path with the row's size and mtime, and every RPG Maker MV game ships
the same NW.js `Game.exe`, byte for byte, with the mtime an unzip keeps: a hooking-on entry whose drive was unplugged
could have followed another game's executable, consent and all. The adopt now requires the drive-letter twin and the
same one-candidate rule as the sweep (over the drive list plus the running file's own drive). A file-name match that
is not adopted records nothing at all (`04_CAPTURE` §Process watcher, HANDOFF D25).
*Change executable* is the other operation and stays what it was: a different binary, so hooking off, consent gone,
pre-scan not run — it is the user saying "that file", not "that file moved".
**Two more answers, 2026-09-23 (owner decisions D26, D27).** Both are downgrades or neutral by construction; neither
can move a consent onto a binary it was not given for.
- **D27 — the file moved and changed.** When the row's file is gone and the only file at its path under another
letter has OTHER bytes (the game updated while the drive had another letter), the row follows it through *Change
executable*'s write (`ChangeExecutableAsync`): the new size and mtime, hooking off, consent cleared, the pre-scan
back to not run, the block kept. The user turns hooking on again for the new binary, through the disclosure, as
for any changed executable. Two such files (two drives) is an ambiguity and refuses. The same rule holds for the
watcher's adopt, whose session is then Tier 2 until the user does.
- **D26 — two entries for one file.** When the move is refused because another entry already holds the target path
— a twin made while the letter was different, as the owner's `H:` entries were — and the file there has the bytes
the stale entry recorded, the two become one (`IGameMerge`, one transaction): the entry made first stays (its name,
notes, consent and history), the other's sessions are re-parented to it, a block either carried is kept (hooking
off; nothing clears a block, and a merge must not be how one disappears), a crash auto-disable still in force is
kept, the crash counts add, and the dropped row is deleted. **Nothing about consent moves between the rows:** the
survivor keeps its own record — which, when it is the entry that moves, is about these same bytes — and the dropped
row's goes with it. A merge waits while a session of either entry runs or waits in a `.partial` to be recovered (a
session finalized under a deleted entry would be dropped), and it is never done with an entry removed from the
library. Other bytes under the twin are not merged: they do not prove the other entry is this game, so the log says
so once and the user removes the entry they do not want.
### A game already enabled can become blocked later
@@ -686,20 +1131,27 @@ game's executable** (path, size or mtime). If it now matches:
§games), so this needs no schema change, and a non-null value already means
"toggle disabled in the UI".
3. `hook_consent_at` is **preserved**. The user did consent; the block is not a
withdrawal of consent and must not silently require them to consent again if
the title is later cleared.
withdrawal of consent and must not silently require them to consent again ~~if
the title is later cleared~~ *(corrected 2026-10-04: nothing clears a block since D22; the stamp is kept for the
record and for a D33 exception)*.
4. The UI shows a persistent notice, not a transient toast — the user needs to
understand why a game they enabled stopped being captured at Tier 1.
A rules update that *removes* a match does **not** re-enable hooking on its own.
A rules update that *removes* a match does **not** re-enable hooking ~~on its own.
Turning it back on is a user action, because re-enabling silently would mean the
rules feed can switch injection on for a game without anyone looking.
rules feed can switch injection on for a game without anyone looking.~~ — nothing does *(corrected 2026-10-04: the block
outlives a rules change, a game update and *Change executable*; §What a finding does to the game)*.
## Crash & stability safety
- Two crashes of the same game within 60 s of injection ⇒ hooking auto-disabled for that game, UI explains, Tier-2 takes over. Recorded in `games.hook_autodisabled_reason`.
- Two crashes of the same game within 60 s of injection ⇒ hooking auto-disabled for that game, UI explains, Tier-2 takes over. Recorded in `games.hook_autodisabled_reason`. *"Crash" here is any abnormal end: since beta.8 a session whose exit code is not an exception's (End task's 1) is `normal` on its row, and this policy still counts it inside the window — a hang our hook caused, ended by the user, is the case it exists for. The row's reason says "ended abnormally twice within 60 s of injection" (`04_CAPTURE` §Crash & exit classification).*
- **What reads as a crash changed in beta.14, in both directions** (`04_CAPTURE` §Crash & exit classification): a
Windows report that is not a crash (a memory-leak or hang report) no longer makes one, and an engine's crash reporter
started by a game that then left does — Unreal's crash ended with exit code 3 and read `normal`. Both feed this policy,
the D33 lapse and D38's trial as `crashed` always has: an Unreal game that crashes under a user-mode exception ends it
now, where before beta.14 the crash went unseen; a leak report no longer ends one.
- The Overlay DLL self-disables after 3 faults in hook bodies (`17_HOOK_ENGINE` §Fault policy) and reports it.
- Every hooked session writes a breadcrumb file before injection; if the game process dies before the first frame record arrives, the next run is recorded as suspect.
- Every hooked session writes a breadcrumb file before injection~~; if the game process dies before the first frame record arrives, the next run is recorded as suspect~~ *(corrected 2026-10-04: no "suspect" mark exists; the breadcrumb is the `.partial` file, and an early death counts toward the two-within-60-s auto-disable above)*.
> **"Cautious mode" is deferred to v1.1 (`20_OPEN_QUESTIONS` §S12).** It was
> described as "hooks installed, overlay drawing disabled" — but **v1 draws no
+92 -30
View File
@@ -23,12 +23,42 @@ Rules for this document:
## Scope decisions already taken (recorded, not open)
> **2026-09-21 — the guard gained one override, by owner decision, and it reverses a sentence this project wrote in
> several places.** CLAUDE.md rule 2 said "There is no override switch ... Do not add one"; `19_SAFETY` said "There is no
> override"; `HookingConsentOutcome` said so in a doc comment. The owner asked for a per-game "bypass the guard" mode at
> the user's own risk, behind a warning the user must accept first, and chose the per-game form over a global switch and
> over one that kept kernel anti-cheat refused. It is built as `19_SAFETY` §The user's bypass specifies: per game, off by
> default, its own two-act disclosure, stamped by the Agent, overruling the guard's JUDGEMENT only, never changing HOW
> FrameLedger injects (rule 3), and marking every session it starts. **What stays open, and is the owner's:** whether a
> shipped build should offer it for the kernel-level families at all (the rules file has no severity and may not grow
> one, so that would be a code list); and the ja text, which ships as English until a reviewer signs. **Pre-committed
> withdrawal:** an injection reached under it without the disclosure having been shown, or a session under it that is
> not marked, removes the switch from the App in the next release.
>
> **2026-09-22 — withdrawn by the owner, for a reason the pre-commitment did not list.** Its first real use (ELDEN
> RING under Easy Anti-Cheat) reached `TargetUnreadable`: the switch could not do anything where it was wanted, and
> where it could inject it only exposed the user. The owner asked for the opposite: a finding turns the game's hooking
> off, wherever the guard makes it. `19_SAFETY` §What a finding does to the game is the specification; CLAUDE.md rule 2 is
> unstruck. The two open items above (kernel-level families, the ja text) are moot.
>
> **2026-09-26 — one narrow exception, by owner decision D33, with the 2026-09-22 withdrawal quoted back.** Beta.8's
> library sweep blocked a game FrameLedger had measured hooked (GIRLS' FRONTLINE 2: EXILIUM, NetEase Yidun `NEP2.dll`),
> and the owner chose an evidence-bound, per-game exception for anti-cheat that is user-mode throughout (`19_SAFETY`
> §The user-mode exception; CLAUDE.md rule 2's amendment). The two reasons D22 gave are answered: it is offered only
> where FrameLedger has already measured the game hooked, and its risk is stated in its own disclosure. *(2026-10-03,
> D38: the first of the two no longer holds as written — a game blocked at add time could never be measured, so the
> measurement moved under the grant as a two-session trial whose failure is for good.)* **What stays
> open, and is the owner's:** the `ja` text of `Safety_Exception_*`, which ships as English until a reviewer signs;
> whether a family the rules file makes kernel-level later should end existing exceptions at once (today it does, at
> the sweep's next pass and at every session start); and a real-hardware check that NEP2.dll's load time relative to
> the injection is covered on the owner's machine (the ctest decoy covers the late load).
| # | Decision | Consequence |
|---|---|---|
| — | **D3D9 is not a Tier-1 API in v1.** The Overlay is x64-only; an x64 DLL cannot load into a 32-bit process, and D3D9 titles are almost entirely 32-bit | **The consequence hardened on 2026-08-28 without a word of this row changing**, which is why it is called out: that catalogue used to be "Tier 2", meaning frame times without injection. Tier 2 now measures nothing, so those titles are **unmeasurable in v1**. The VN / JRPG / older-indie catalogue is Tier 2. Reversing this means a second 32-bit Overlay **and** injector, doubling the native build matrix and adding a second struct-mirror surface. Revisit only with evidence that users care more about those titles than about the maintenance cost |
| — | **`ci.yml` is repo-local**, not a caller stub | The ops repo's `reusable-desktop-csharp.yml` runs `dotnet` directly with no native pre-step input, and `12_BUILD` requires CI and local to run the same script |
| — | **No `v1 → v2` migration** | Nothing shipped, so no such database exists. `0001_init.sql` creates the current schema |
| — | ~~**Multi-process titles are refused as `TargetAmbiguous` in v1**~~ — **the Chromium case is RESOLVED the same day (2026-09-03), by the vendor's own label** | Chromium-based runtimes — NW.js, Electron, RPG Maker MV/MZ, a large share of the VN catalogue — run several processes from ONE image path (browser, renderer, GPU), and *Flower in Us* refused as `TargetAmbiguous`. The presenting process is Chromium's GPU process, which owns no window, so "the one with the window" and "the parent" were both wrong picks. **What resolves it:** Chromium marks that process with `--type=gpu-process` on its own command line. `TargetResolver` now reads each candidate's command line through `NtQueryInformationProcess(ProcessCommandLineInformation)` — **served by the kernel, no `ReadProcessMemory`, no PEB walk, `PROCESS_QUERY_LIMITED_INFORMATION` only**, which is the rule-4 line `HeldProcessHandle` already draws — and resolves only when **exactly one** readable candidate carries the flag as a whole argument. Two GPU processes (two instances), none, or any unreadable candidate still refuse. §S27 is untouched: consent is keyed on the path, every candidate is that path, the guard scans the pid chosen, and `--pid` stays forbidden. **Measured the same evening, and the first rule did not fire:** *Flower in Us* runs **six** processes — browser, `crashpad-handler`, three `utility`, `renderer` — and **no `--type=gpu-process` at all**. NW.js runs the GPU **in-process, in the browser**, which is the one process Chromium leaves untyped. Second rule added: exactly one untyped candidate, every other candidate typed, no GPU process ⇒ the browser is the target; two untyped candidates are two instances and refuse. The refusal line now prints the tree (`browser=1, renderer=1, utility=3, …`) so the next unknown shape is data rather than a bare `TargetAmbiguous`. **Still unmeasured:** whether the Overlay loads and sees presents inside that browser process |
| — | ~~**Multi-process titles are refused as `TargetAmbiguous` in v1**~~ — **the Chromium case is RESOLVED the same day (2026-09-03), by the vendor's own label** | Chromium-based runtimes — NW.js, Electron, RPG Maker MV/MZ, a large share of the VN catalogue — run several processes from ONE image path (browser, renderer, GPU), and *Flower in Us* refused as `TargetAmbiguous`. The presenting process is Chromium's GPU process, which owns no window, so "the one with the window" and "the parent" were both wrong picks. **What resolves it:** Chromium marks that process with `--type=gpu-process` on its own command line. `TargetResolver` now reads each candidate's command line through `NtQueryInformationProcess(ProcessCommandLineInformation)` — **served by the kernel, no `ReadProcessMemory`, no PEB walk, `PROCESS_QUERY_LIMITED_INFORMATION` only**, which is the rule-4 line `HeldProcessHandle` already draws — and resolves only when **exactly one** readable candidate carries the flag as a whole argument. Two GPU processes (two instances), none, or any unreadable candidate still refuse. §S27 is untouched: consent is keyed on the path, every candidate is that path, the guard scans the pid chosen, and `--pid` stays forbidden. **Measured the same evening, and the first rule did not fire:** *Flower in Us* runs **six** processes — browser, `crashpad-handler`, three `utility`, `renderer` — and **no `--type=gpu-process` at all**. NW.js runs the GPU **in-process, in the browser**, which is the one process Chromium leaves untyped. Second rule added: exactly one untyped candidate, every other candidate typed, no GPU process ⇒ the browser is the target; two untyped candidates are two instances and refuse. The refusal line now prints the tree (`browser=1, renderer=1, utility=3, …`) so the next unknown shape is data rather than a bare `TargetAmbiguous`. ~~**Still unmeasured:**~~ **Measured 2026-09-04** (`spike-notes` §9, run 3): the Overlay loads and sees presents inside that browser process — Flower in Us resolved, injected, captured, 3,587 records over three swap chains *(corrected 2026-10-04)* |
| — | **Intel XeSS / XeFG identity is closed at the census — no hook on any `libxess*.dll` export** (decided 2026-09-04, delegated by the owner) | The XeSS SDK failed `18_GPU_VENDOR_APIS` §Checklist (Intel Simplified Software License: binary-only grant, no reverse engineering, termination; headers forbid copying), so no declaration may be vendored or re-declared. The signature-free counter that seemed to survive that — an assembly thunk on a named export — still inline-patches Intel's code inside the game process, which the same licence forbids as *modification*; it would also be the only entry outside `FL_HOOK_GUARD` and a second build language, for identity alone. An Intel title therefore reports upscaler `NOT_REPORTED` and, with `libxess_fg.dll` in the census, Presented FPS under rule 6's *"MAY include generated frames"* qualifier — honest, and the same answer NGX-direct got. **Reversal condition:** Intel relicenses the headers so the checklist clears; then §H11's AMD route applies to Intel verbatim |
| — | **A title whose upscaler or frame generation is compiled into its executable is Presented FPS + the census's qualifier, in attach mode, and that is the ceiling for IDENTITY** (recorded 2026-09-04; **two such titles found the same night — Rune Factory, and Black Myth: Wukong for its upscaling, which ships and loads the 1.1.x monolith and never dispatches to it**) | No module for the census, no export for the inventory: nothing by name. What survives static linking is behaviour on interfaces we hook — the FSR3 frame-generation proxy swapchain at *creation* (launch mode only, §S1 deferred) and queue-side cadence with no vendor name on it. ~~**No installed title has this shape**~~ — **Rune Factory: Guardians of Azuma has it**: `amd_fidelityfx_dx12.dll` ships beside the executable and is never loaded (the census has no AMD module), FSR frame generation is on, and the report read `59.99 → 119.95 (×2 FG)`, *technology not identified* — because on a UE5 title **Streamline's frame token is requested whether or not NVIDIA's features are the ones running**, so the application-frame COUNT survives static linking even though the identity cannot. The ceiling is therefore lower than this row first said: the trio with an unidentified technology, not Presented FPS alone (§H11's run table). Identity for such a title stays out of reach by name |
| — | ~~**Tier 2 requires an elevated Agent**~~ | **CLOSED 2026-08-28 by the two-rung ladder.** The requirement came from Windows restricting ETW trace sessions; there is no ETW rung, so **no capture tier needs elevation**. Elevation is optional everywhere and buys exactly two things (CPU temperatures via PawnIO, attaching to elevated targets — ADR-9). An unelevated Agent whose Tier-1 attempt fails lands on Tier 2, which is what every unhooked session lands on regardless of privilege |
@@ -71,22 +101,22 @@ or it becomes the next stale status claim this file exists to record.
| S3, S5, S7, S8, S9, S10, S11, S15, S16, S17, S18, S21, S22 | ✅ **resolved** | Thirteen. Reasoning kept in place rather than deleted |
| **S25, S26** | ✅ **resolved 2026-08-05** | The two runtime stops unreachable in a non-presenting process; occlusion probes recorded as frames |
| **S28** | ✅ **resolved 2026-08-05** | The guard's entry points share process-wide statics; a concurrent call cleared the blocklist mid-match and every check fell through to `Allow`. Reproduced by CI, not argued |
| **S27** | ✅ **resolved, and restated 2026-08-06** | The chokepoint is the anti-cheat gate, not the consent gate. It was closed by *not building* a capture host; item 1 built one, and the ✅ survives on the clause that was always load-bearing — **no injecting entry point on any SHIPPED binary**. `FrameLedger.CaptureHost` is unpublished, and `tools/package-closure-check.ps1` makes that a gate rather than a fact about today's csproj. `HookRequest` is get-only behind one factory, so this entry's own rejected synthesis no longer compiles |
| **S27** | ✅ **resolved, and restated 2026-08-06** | The chokepoint is the anti-cheat gate, not the consent gate. It was closed by *not building* a capture host; item 1 built one, and ~~the ✅ survives on the clause that was always load-bearing — **no injecting entry point on any SHIPPED binary**. `FrameLedger.CaptureHost` is unpublished, and `tools/package-closure-check.ps1` makes that a gate rather than a fact about today's csproj.~~ *(Corrected 2026-10-04: ✅ restated 2026-09-10 in the entry below — the shipped Agent injects by design, and the four properties in the entry hold rule 1; `package-closure-check` keeps its meaning for the CaptureHost only.)* `HookRequest` is get-only behind one factory, so this entry's own rejected synthesis no longer compiles |
| S12 | 🅓 **deferred, rationale written** | Cautious mode → v1.1; it disabled nothing in v1. *(Marked ✅ until 2026-08-27 — same disposition, different glyph.)* |
| **S1** | ◐ **launch mode built as "inject late" 2026-09-06 (P1 item 2); the cost is now measured per title** | `FlGuardedInjectWhenReady` polls until a presentation runtime is mapped, then runs the full guard; `dxgiPresentsBeforeHook` and the reported wait are the input the 2026-08-05 deferral lacked. The ruling "inject late vs. no launch mode" is answered by construction — inject late exists — and whether it is *preferred* per title is what the numbers decide |
| **S13(c)** | ✅ **salvageable, and salvaged 2026-09-06** | The externally observable proxy the entry proposed is what was built; the missing input is produced by every launched session |
| **S19(b)** | 🅓 **deferred, rationale written — and MEASURED** | CI 2026-08-05: the fragment fires on `System.Security.Cryptography.ProtectedData.dll` loaded by a .NET **test host**, i.e. inside a real scan set in the launch-mode arrangement — refusing our own injection. The entry's "plausible and unmeasured" is superseded; the deferral rationale (a `CryptCATAdmin*` PR doing network I/O inside the hard gate, NFR-10) still stands. *(Marked 🔴 until 2026-08-27. The measurement belongs in this cell, not in the marker — a glyph that means "deferred" and a glyph that means "open defect" cannot be the same one in a table audited by counting.)* |
| **S14** | 🅓 **exe half wired 2026-08-05; store-id half deferred to P4, rationale written 2026-09-06** | The store-id half's only in-policy route is P4's platform metadata extractors feeding a guard-side resolver; a resolver with no extractor would refuse every title. No title is blocked by store id today because none is listed |
| **S14** | ✅ **both halves wired and seeded 2026-09-25** (exe half 2026-08-05) | ~~The store-id half's only in-policy route is P4's platform metadata extractors feeding a guard-side resolver~~ — built as a guard-side seam that reads Steam's `appmanifest_*.acf` and GOG's `goggame-<id>.info` itself; an install no store names is not refused, unreadable store metadata is. 30 Steam ids and 33 executables listed (rules 2026.09.4), floored; 33 Steam ids since 2026-10-03 (rules 2026.10.1: three CrackProof titles, `19_SAFETY` check 3). Epic has no reader |
| **S23-1** | ✅ **resolved 2026-08-05** | `FlGuardBuildId` gives the Agent a build id of its own, and `ShmHandshakeValidator` performs the comparison `07_IPC` and `04_CAPTURE` both specify. Every refusal path is driven, including **both ids empty** — the shape the feature shipped in, where `"" == ""` reported `Ok` for every process on the machine |
| **S23-4** | ✅ **resolved 2026-08-05** | `19_SAFETY` §During a session said "the module scan and the driver scan"; `EvaluateImpl` runs four. Reworded to "every pre-injection check" so it cannot go stale when a check is added, with the two omissions named — `services` is the only tier measured firing on real anti-cheat, and the pre-scan is the only one touching the filesystem |
| **S2 part three** | ✅ **built 2026-09-06 (P1 item 3)** | In-layer supervision on the present path, landed with `vkQueuePresentKHR`; `unhookRequested` and the tick deadline both stop the layer (passthrough with the reason on the mapping), proven by a fake loader chain and a 1.5 s test-only flavour of the DLL |
| **S4 signing** | 🅓 **deferred to P4, rationale written 2026-09-06** | Signing is a property of the feed and there is no feed (§S20); every rules file today shipped inside a release whose checksum attests it. The P4 decision (compiled-in key, detached signature, fail-closed) is written in the entry |
| **S4 signing** | 🅓 **deferred ~~to P4~~, unscheduled — P4 closed without it (corrected 2026-10-04); rationale written 2026-09-06** | Signing is a property of the feed and there is no feed (§S20); every rules file today shipped inside a release whose checksum attests it. The P4 decision (compiled-in key, detached signature, fail-closed) is written in the entry |
| **S6** | ✅ **built 2026-09-06 (P1 item 1)** | The detour on `kernelbase!LoadLibraryExW` stops the Overlay from inside on an exact-floor MODULE match, within one present or one watchdog iteration, and wakes the lazy installers within milliseconds for an inventoried module; measured against the real Overlay in ctest `fl_guard` `[loader]`/`[S6]`. Exact names only — fragment and signer stay the host's 30 s scan, so the disclosure does not change |
| **S19(a)** | ✅ **resolved 2026-08-05** | `gameguard` could never fire — `guard` subsumed it. Removed; `rules-validate` now fails when any fragment contains another, so the class cannot return. Zero coverage lost: nProtect has its own named module family |
| **S19(c)** | ✅ **resolved 2026-09-06** | The fields are constants the schema pins and the guard never reads, because the policy is code by CLAUDE.md rule 2 and `19_SAFETY`; `rules-validate` now proves the schema rejects `action: "allow"` and `signerField: "CN"` (canary 3), so the data cannot say otherwise |
| **S19(d) residual** | ✅ **resolved 2026-08-05** | A second canary, **derived from the shipped document** rather than hand-written, carries `nameFragments: []` and must be rejected. The entry's stated consequence was overstated and is corrected in place: the generated floor would not have disappeared, `gen-ac-floor.ps1` hard-errors and the native build fails — what was unguarded is the *schema* half |
| **S20 feed half** | 🅓 **deferred to P4, rationale written 2026-09-06** | **FR-7.3 stays unmet and written as unmet**: the fetch needs a shipped Agent, §S4's signing and the privacy policy's rows, all P4; until then a rules edit ships with the next release, checksum-attested |
| **S23-3** | 🅓 **deferred to P3, rationale written 2026-09-06** | `08_UI`'s refusal notice is wrong in the commonest case; the requirement reaches `08_UI` and the `Safety_*` keys in the PR that creates the first refusal UI — a string with no view would read as done |
| **S20 feed half** | 🅓 **deferred ~~to P4~~, unscheduled — P4 closed without it (corrected 2026-10-04); rationale written 2026-09-06** | **FR-7.3 stays unmet and written as unmet**: the fetch needs a shipped Agent, §S4's signing and the privacy policy's rows, all P4; until then a rules edit ships with the next release, checksum-attested |
| **S23-3** | ~~🅓 **deferred to P3, rationale written 2026-09-06**~~ ~~🔴 **open: P3 shipped the refusal UI without it**~~ ✅ **closed in beta.13** — the events carry the guard's own reason and a `BlockedService` / `BlockedDriver` notice says the family is running on this PC (`08_UI` §Safety events) *(it was 🔴 from 2026-10-04: a machine-wide notice still read "… was detected in this game")* | `08_UI`'s refusal notice is wrong in the commonest case; the requirement reaches `08_UI` and the `Safety_*` keys in the PR that creates the first refusal UI — a string with no view would read as done |
| **S23-5** | ✅ **resolved 2026-08-05** | Closed the way §S23-4 closed the same class — by **removing** the restatement, not correcting it — and `rules-validate` now fails when any `$comment` enumerates checks again. The rule's own first version was scoped to the wrong object and could not fire; it now walks every `$comment` and fails if it finds none |
| **S23-6** | ✅ **closed 2026-09-06** | `license-check` binds `THIRD_PARTY_NOTICES` bidirectionally, and the accuracy blocks are now ONE text — `legal/ACCURACY.md`, embedded verbatim in `README.md` and `DISCLAIMER.md` §4, gated by `tools/accuracy-check.ps1` (self-tested both directions). Truth stays a human's job; drift between copies no longer is |
| **S23-2** | 🚫 **owner only — no PR can close it** | `Rules / validate` is **not** a required status check on `main`. **Re-verified against the live branch protection 2026-08-05**, not repeated from the entry: `required_status_checks.contexts` is exactly `["check", "analyze (csharp, none)", "analyze (cpp, manual)"]` (`strict: true`, `enforce_admins: true`, `required_linear_history: true`). The `validate` job is path-filtered and `pull_request`-only, so a red removal check does not block the merge button. **The gate that exists to make the anti-cheat blocklist un-removable is advisory.** This is a branch-protection setting |
@@ -107,7 +137,7 @@ either work or a rationale written down:
correction. **S30 closed 2026-08-15 and S31 opened 2026-08-20**, and this bullet went on
naming S30 until 2026-08-27 — so the total below stayed right by coincidence rather than
by count.)*
- **three ⏳** — S2 part three, S4 signing, S23-3
- **three ⏳** — S2 part three, S4 signing, S23-3 *(S2 part three built 2026-09-06 and S23-3 closed in beta.13 — noted 2026-10-04; S4 signing stays deferred)*
- ~~two ◐~~ ~~**three ◐**~~ **two ◐ (2026-09-04)** — S14, S23-6. ~~**S31**~~ *(moved out of ❓ on 2026-08-27 when its test landed on row P2; **resolved 2026-09-04** when the token count landed on row P1 with `tokens/batch = 1.00` — the question answered by a second count rather than by an oracle)*
- **one 🔴** — S29, added by the audit that produced this recount; **five of its seven
findings are now closed**, and the residue is (a) the ungated managed drain and (d) the
@@ -153,6 +183,10 @@ the recount becomes the next thing that needs recounting.
> as ◐ two here rather than re-glyphing the rows: the rows were right and the paragraph was
> wrong, and the residue of each is a run, not a rationale. P2's sequencing is `HANDOFF` §P2.
>
> **2026-09-25: S14 ✅.** The store-id half, one of the six deferrals of 2026-09-06 (to P4), is built and seeded
> in the beta.8 train: a guard-side seam reads the store's own metadata, and the lists carry 30 Steam ids and 33
> executables. The deferred set is five; ◐ stays two (S1, H11); nothing else in this count moved.
>
> **STILL TEN on 2026-08-27, for the third consecutive movement.** S31 moved from ❓ to ◐,
> so ❓ goes four to three and ◐ goes two to three. **The number has now stayed at ten across
> three different changes**, and that is worth saying out loud precisely because a reader
@@ -1461,7 +1495,7 @@ there is no way to point the layer at a different rules file (§S3), so without
it the test silently skipped on any machine that had not run the product — and a
ctest that always skips is a gate that cannot fail.
### ◐ Part three: mid-session guard inside a layered process — decided, half built
### ~~◐~~ ✅ Part three: mid-session guard inside a layered process — decided, ~~half built~~ built 2026-09-06 (heading corrected 2026-10-04)
> #### ✅ Built 2026-09-06 (P1 item 3), in the PR that added the present hook — as the deferral below said it would be
>
@@ -1523,7 +1557,8 @@ the layer already has — every uncertainty resolves to inert.
> file and exits. What is built and tested is the *counting discipline*: the tick
> counts evaluations rather than seconds. What is not built is the supervision.
> A reader ticking this off as delivered would then find `07_IPC` §Supervision
> loss unimplementable, which is exactly what happened.
> loss unimplementable, which is exactly what happened. *(Overtaken in P2: `ShmRingReader` publishes the tick from
> `GuardSupervisor`, which `CaptureSession` runs on every Tier-1 session. Marked 2026-10-04.)*
**✅ The Agent half's counting discipline is built and proven.** `GuardSupervisor`
(`FrameLedger.Application`) computes what will become `guardTicks`, and the load-bearing property
@@ -1619,7 +1654,9 @@ a system DLL.
**Two families remain unrepresented in the data** — Activision Ricochet (driver
and service names unconfirmed) and Valve VAC (needs `blockedStoreIds`). Recorded
in the seed's own `$comment`. The `heuristic.trustedSigners` list is a guess and
in the seed's own `$comment`. ~~Ricochet~~ **has data since 2026-09-25** (`randgrid.sys`,
`atvi-randgrid_sr`/`_msstore`, from Activision's support pages — documented, unmeasured; `19_SAFETY`
§Blocklist seed). VAC still has none. The `heuristic.trustedSigners` list is a guess and
is marked UNVERIFIED.
### S13(c) · Is launch-mode injection salvageable?
@@ -1776,6 +1813,12 @@ refuses too. Sibling *services* are covered by name via the rules data rather
than by tree walking, which is more reliable. The runtime re-scan recomputes the
set rather than caching it.
**Amended 2026-10-06 (D51, beta.15).** The set's parent links come from a snapshot that links by pid alone, and pids
are reused: the walk followed a launcher's pid after the launcher had exited and something else had taken it, and a
cycle of reused pids was walked round. A link is now cut only when creation times prove it wrong (the child created
before its named parent); an unread time keeps it, and each pid is walked once. `19_SAFETY` §Pre-injection checks item 1
carries the rule and its one residual — a clock set backwards between a parent's start and its child's.
<details><summary>The question as originally recorded</summary>
Found 2026-08-02. Not previously recorded anywhere, and it changes the guard's
@@ -2620,8 +2663,9 @@ disproved:
> **🅓 Deferred to P4, rationale written 2026-09-06.** The feed is the product's one
> permitted outbound request after the release check (CLAUDE.md rule 8), and it needs
> three things P0 does not have: a shipped Agent to run it in, the signing §S4 defers to
> the same phase, and the privacy policy's rows that describe it (`legal/PRIVACY_POLICY.md`
> already flags them as describing a request the software does not make). Until then a
> the same phase, and the privacy policy's rows that describe it (~~`legal/PRIVACY_POLICY.md`
> already flags them as describing a request the software does not make~~ — **removed in version 2.2, 2026-09-16**:
> the feed lands as a new policy version the Legal Gate shows again, not as rows kept in advance). Until then a
> rules edit reaches a machine with the next release, whose checksum attests it — a slower
> delivery, not a weaker gate. FR-7.3 stays unmet and stays written as unmet.
- **No binary/data handshake inside the guard.** `ParseRules` still walks only the
@@ -2631,19 +2675,21 @@ disproved:
which used to claim a bump check that does not exist.
- **`trustedSigners` is the one allow-widening field a foreign file still
controls.** Deliberately not floored, because flooring an allowlist has the
wrong polarity. Inert today — `IsTrustedSigner` has no production call site
while §S19(b) is deferred — and **live the moment the signer half is wired**,
wrong polarity. ~~Inert today — `IsTrustedSigner` has no production call site
while §S19(b) is deferred — and~~ **live the moment the signer half is wired** *(corrected 2026-10-04: wired since
§S19(b), 2026-09-06, and bounded by `IsCompiledTrustedSigner`)*,
which makes gating it a prerequisite of §S19(b) rather than of this item.
- **This is what arms the Vulkan layer's self-scan for the first time.** `layer.cpp`
§S2's second half could only ever answer "inert" while the file never existed.
It is now reachable, on a machine where the file is present. The layer still
It is now reachable, on a machine where the file is present. ~~The layer still
intercepts nothing (`vkQueuePresentKHR` is P1), so nothing observable changes
yet — recorded here so it is not discovered as a surprise when the present hook
lands.
lands.~~ *(Corrected 2026-10-04: `vkQueuePresentKHR` is intercepted since 2026-09-06, §S2 part three.)*
- **A seed replacement is a rules update in FR-2.3's sense**, and the obligation
attached to that event — re-run the pre-scan, force-disable a game that has
started matching — is unimplemented. There is no `games` table yet, so there is
nothing to write; named here so whoever builds persistence has an anchor.
started matching — ~~is unimplemented. There is no `games` table yet, so there is
nothing to write; named here so whoever builds persistence has an anchor.~~ *(corrected 2026-10-04: built —
`UpdateRules` wakes `AntiCheatPreScanSweep`, beta.8, keyed per rules version by schema 0010.)*
### S21 ✅ · The hard gate's data source was caller-nameable, and its completeness floor never read the values — **closed**
@@ -3043,7 +3089,7 @@ required contexts are exactly `check`, `analyze (csharp, none)` and
the gate that exists to make the anti-cheat blocklist un-removable is advisory.
Fixing it is a branch-protection change, i.e. the owner's, not a code change.
**3. 🅓 Deferred to P3, rationale written 2026-09-06 — `08_UI` describes a refusal notice that is wrong in the commonest case.** *(The requirement below must reach `08_UI` and the `Safety_*` keys in the PR that creates the first refusal UI, and not before: there is no UI to be wrong in yet, and a `.resx` string with no view is the kind of fix that reads as done. The spike log carries the measurement; this line is the reminder.)* It
**3. ~~🅓 Deferred to P3, rationale written 2026-09-06~~ ~~🔴 Open~~ ✅ Closed in beta.13 (`08_UI` §Safety events: a driver or service is said as running on this PC) — P3 built the refusal UI without it (corrected 2026-10-04: `SafetyNotices.RefusalText` formats every named refusal as "… was detected in this game", so the measured case below still reads wrong) — `08_UI` describes a refusal notice that is wrong in the commonest case.** *(The requirement below must reach `08_UI` and the `Safety_*` keys in the PR that creates the first refusal UI, and not before: there is no UI to be wrong in yet, and a `.resx` string with no view is the kind of fix that reads as done. The spike log carries the measurement; this line is the reminder.)* It
promises "the specific signal named in plain language". Measured (`spike-notes`
§13): while any Easy Anti-Cheat title is running, **every** target — including a
freshly spawned, unrelated process — refuses with `BlockedService` naming
@@ -3139,7 +3185,14 @@ gate.
> and the block's own comment says so. The block was rewritten to 2026-09-06 truth in the same
> PR (the previous §4 note still said frame generation and ray tracing had no hook).
### S14 ◐ · Pre-injection check 3 is **unwired**, and has no "cannot determine" state
### S14 ✅ · Pre-injection check 3 ~~is **unwired**, and has no "cannot determine" state~~ — both halves wired and seeded 2026-09-25
> **Closed 2026-09-25 (beta.8, owner decision: title lists yes, the AreWeAntiCheatYet bulk list no).** The store
> half reads the store's own metadata through `Sources::StoreIdentity`, from the install root the guard derives
> from the pid — the ABI is unchanged, which was reason (2). Reason (3) is answered by the matrix in `19_SAFETY`
> check 3: listed refuses, no store identity is not applicable, unreadable store metadata refuses. Both lists are
> seeded (30 Steam ids, 33 executables) and floored. What stays open is Epic, which has no reader and so carries no
> identity to this check. The body below is the history.
Found 2026-08-02 while hardening the rules toolchain. `19_SAFETY` §Pre-injection
checks lists a per-title blocklist as check 3, but `anticheat.blockedExecutables`
@@ -3924,7 +3977,7 @@ make us miss the present.
Needs a real Streamline/DLSS-G title, ideally with RTSS and the Steam overlay
also active (`spike-notes.md` §Environment — that machine already has both).
### H6 · D3D12 command-list hooks count recorded, not executed, work
### H6 ✅ · D3D12 command-list hooks count recorded, not executed, work — **answered 2026-08-20 with the RT hooks** *(marked 2026-10-04: per-present atomics drained once per present; the unit is "recorded between two presents", `03_METRICS` §RT)*
`DispatchRays`, `BuildRaytracingAccelerationStructure` and pipeline creation are
recorded into command lists, possibly on many threads, possibly re-executed or
@@ -4233,6 +4286,11 @@ this item defers, and whether generated presents reach our vtable is what §H5 t
### H10 · Per-process VRAM thread inside the game process
🅓 **The usage half is answered from outside the game — 2026-10-03 (beta.12, owner decision D43); the budget half is
deferred with §M11.** The game's dedicated and shared GPU memory are read by the Agent from the `GPU Process Memory`
counters (`18_GPU_VENDOR_APIS` §The game process's memory), so no thread and no DXGI call is added inside the game for
them. What only an in-process call could give is the budget, and nothing reads it. *(The question as it stood:)*
`17_HOOK_ENGINE` §Memory calls `QueryVideoMemoryInfo` "once per second from our
own thread". Spawning a thread inside a host process we do not own is a heavier
footprint than the rest of the design's posture, and DXGI calls off the render
@@ -4256,9 +4314,11 @@ instead, which needs no thread at all.
| M2 ✅ | ~~Does the pinned console binary still exist, run unelevated, and emit the 2.x column set?~~ | **Answered, then closed 2026-08-27.** It exists (2.5.1, 956,768 bytes, SHA256 `9BEC…A191`, **no VERSIONINFO at all**); it does **not** run unelevated (exit 6 — the account is in neither Administrators nor Performance Log Users, and the running `PresentMonSharedService` does not help because the console starts its own session); and the 2.x column set **is measured** — 24 columns, `spike-notes` §11. The parser ate three real CSVs and resolved `FrameType` correctly against a first column literally named `Application`. Closed because the binary is dropped, and kept in full because every one of those facts cost a measurement |
| M5 ✅ | **Do LHM GPU sensors work unelevated, without PawnIO?** **YES — measured 2026-09-03, row R1 of the pre-committed table below**, NVIDIA RTX 5080 / 616.56 / LHM 0.9.6: eight fields unelevated (core and memory temperature, load, VRAM used, core and memory clock, package power, fan), the identical eight in the elevated control, PawnIO never opened. The three user-facing sentences stand. Numbers in `spike-notes` §10. *(The row as it stood while open follows, unchanged.)* This decides whether the default unelevated Agent has temperatures at all, and therefore how ADR-9 reads to users. **SEVERITY PROMOTED 2026-08-28, and the promotion is the point.** It used to decide how a design note read. It now decides whether a **user-facing claim is true**: the two-rung ladder says a Tier-2 session records duration and hardware telemetry, and that sentence is heading for `README`, the consent dialog and `legal/EULA.md`. If LHM needs elevation for GPU sensors, then the DEFAULT Agent's Tier-2 session is **duration only** and every one of those documents is wrong. Until it is measured, all three are worded *"whatever hardware telemetry this machine can provide"* — honest under either outcome, at the cost of vagueness. `18_GPU_VENDOR_APIS` §P0(b) already specifies the test and the dev box can run it |
| M6 ✅ | ~~Elevation-free Tier 2~~ | **Closed by decision 2026-08-27.** Half was answered on 2026-08-20 in the direction nobody expected: `PresentMonSharedService` is installed and `Running` as LocalSystem and the console **still** fails, because it starts its own trace session. The other half — whether `Performance Log Users` suffices without admin — stays unmeasured and now has no subject. **The elevation question does not disappear with the tool**: ETW trace sessions are restricted by Windows, not by PresentMon, so whatever §G chooses inherits it. Re-ask it there |
| M7 ✅ | ~~`18_GPU_VENDOR_APIS` §Runtime policy says telemetry is never read from the game process, but `17_HOOK_ENGINE` reads per-process VRAM and Reflex latency there. Reconcile the wording — the rule means "no vendor SDK polling loops in the game", not "no measurement in the game"~~ **Closed 2026-09-09 (PR-E1) by the code taking exactly that shape.** The rule is *no telemetry polling loop in the game*: the one 1 Hz loop is `TelemetryPoller` on the Agent's `fl-telemetry` thread, and it reads L1/L2/L3 only. Per-process VRAM stays an in-process read on the present path (`vram_proc`, `17_HOOK_ENGINE`), and PR-E1 measured why that must be so: `IDXGIAdapter3::QueryVideoMemoryInfo`'s `CurrentUsage` is the *calling process's* figure — 0 bytes from the Agent — so it is a measurement only where the game is. Adapter-wide usage is L1's PDH counter. §Runtime policy's sentence stands as written; this row is the reconciliation |
| M7 ✅ | ~~`18_GPU_VENDOR_APIS` §Runtime policy says telemetry is never read from the game process, but `17_HOOK_ENGINE` reads per-process VRAM and Reflex latency there. Reconcile the wording — the rule means "no vendor SDK polling loops in the game", not "no measurement in the game"~~ **Closed 2026-09-09 (PR-E1) by the code taking exactly that shape.** The rule is *no telemetry polling loop in the game*: the one 1 Hz loop is `TelemetryPoller` on the Agent's `fl-telemetry` thread, and it reads L1/L2/L3 only. Per-process VRAM stays an in-process read on the present path (`vram_proc`, `17_HOOK_ENGINE`), and PR-E1 measured why that must be so: `IDXGIAdapter3::QueryVideoMemoryInfo`'s `CurrentUsage` is the *calling process's* figure — 0 bytes from the Agent — so it is a measurement only where the game is. **Corrected 2026-10-03 (beta.12, D43): "only where the game is" holds for `QueryVideoMemoryInfo` and not in general** — the `GPU Process Memory` performance counters give any process's dedicated and shared GPU memory from outside it, with no handle, and the Agent reads them since that day (`18_GPU_VENDOR_APIS` §The game process's memory; `spike-notes` §16). The in-process read was never built. Adapter-wide usage is L1's PDH counter. §Runtime policy's sentence stands as written; this row is the reconciliation |
| M8 ✅ | ~~The `GpuSample` type has no latency field, yet L3 is credited with Reflex/PC latency. Latency is per-frame and arrives via the ring, not the 1 Hz sample. Fix the layering description~~ **Closed 2026-09-09 (PR-E1): the description now matches the type.** `GpuSample` has no latency field by design (its own remarks said so since 2026-09-03), `TelemetrySample` carries a 1 Hz reading stamped with QPC, and per-frame latency is `FlFrameRecord.reflexLatencyUs` in the ring. The §L3 table row "Reflex / PC latency" is an *in-process hook fact* the Overlay records (`SetSleepMode` / `SetLatencyMarker`, `17_HOOK_ENGINE`), never a poller field; `NvapiTelemetrySource` (PR-E2) will not call `NvAPI_D3D_GetLatency` |
| M9 ✅ | **Closed 2026-08-02 by a decision.** The old file/module detection does not exist in this repository and the owner confirmed there is no copy elsewhere, so **"build a minimal static-hint detector as the measurement baseline" is now P0 item 3** (`15_ROADMAP`). It needs no guard and no injection. Until it exists, ADR-7's headline claim stays out of the README rather than being asserted unmeasured |
| M10 ❓ | **§CPU — is the CPU temperature this build reads the right sensor, and does it read at all on the owner's machine?** `LhmCpuTemperatureReader` (2026-09-21) opens a CPU-only LibreHardwareMonitor `Computer` when the Agent is elevated AND `PawnIo.IsInstalled`, takes the package sensor (`CPU Package` / `Core (Tctl/Tdie)`) and falls back to the hottest core. It was written against LHM's sensor names and a fake `ILhmComputer`; **no elevated run with PawnIO has been taken.** | **The measurement is one session:** Agent elevated, PawnIO installed, a five-minute capture with HWiNFO or Ryzen Master open beside it. Pre-committed: `max_cpu_temp` within 3 °C of the reference's package peak → keep; a core sensor picked where a package sensor exists, or a reading tens of degrees off (a distance-to-TjMax sensor mistaken for a temperature) → fix `Pick` and re-run; nothing read at all → `cpu_temp` stays N/A and `legal/ACCURACY.md` says processor temperature is not measured. CPU **load** and memory are not in question: `TheRealCountersAnswerOnThisMachine` reads them on every gate run. |
| M11 🅓 | **The game's VRAM budget and `budget_exceeded_pct` (FR-4.5's second half), 2026-10-03.** D43 reads the game's usage from outside (the `GPU Process Memory` counters); the budget the OS grants the process is what DXGI's `QueryVideoMemoryInfo` returns to the *calling* process (§M7), so only an in-process call — the Overlay's background thread, which today only checks for a stop — or `D3DKMTQueryStatistics`' `PROCESS_SEGMENT_GROUP` query (documented "Reserved for system use") could read it. **Deferred by decision:** neither is built; `vram_budget_exceeded_pct` stays NULL and the budget N/A, and the in-process route would change what the Disclaimer says the Overlay's thread does. Reopening it needs that decision, not a measurement. | — |
| M10 ✅ | ~~PDH `\GPU Engine(*)\Utilization Percentage` summed across engines does not reproduce the Task Manager figure the doc invokes. Decide what we actually report and label it accordingly~~ **Decided 2026-09-09 (PR-E1): L1 does not read the engine counters at all.** `LoadPct` is L2's vendor-reported `GPU Core` load (measured ✓ on NVIDIA, §M5 row R1) and is labelled *GPU load (vendor)* wherever it is shown; on a machine without L2 the field is N/A, never a sum that is not the number the user expects. What L1 does read from PDH is one counter, `\GPU Adapter Memory(luid_…_phys_0)\Dedicated Usage`, bound by LUID — the figure Task Manager labels "Dedicated GPU memory", measured 1301 MB at an idle desktop on the RTX 5080. Reopening this needs a measurement of `max(engine)` against Task Manager's own number, not a decision |
#### §M5 — the decision table, pre-committed 2026-09-03 BEFORE the first run
@@ -4305,16 +4365,16 @@ Each of these is referenced by an existing doc but specified nowhere.
| Area | What is missing | Referenced by |
|---|---|---|
| **Agent lifecycle** | Scheduled-task definition, start-at-logon, how elevation is requested and persisted, what "Repair" repairs. **`--serve` exists since 2026-09-10 (P2 PR-F)** — a Generic Host around the watcher, stopped by Ctrl+C with a 15 s finalize grace — and `--install-task` / `--uninstall-task` answer "not implemented in P2"; the task definition and start-at-logon are what stays open | `08_UI` Settings, `11_UPDATER`, `12_BUILD` flags |
| **Session identity** | ~~`sessions` has no GUID column, yet `SessionStarted`/`StopSession`/`.partial` files are all keyed by `sessionGuid`.~~ **`sessions.session_guid` (UNIQUE) exists since 2026-09-09 (P2 PR-B), with `qpc_epoch` / `qpc_frequency` beside it.** ~~Still open: the `.partial` file format is undefined, and it is the crash-recovery artifact — PR-D's, pre-committed in HANDOFF §P2 (CRC-framed append-only chunks, the valid prefix wins)~~ **Built 2026-09-10 (P2 PR-D): `06_DATA_MODEL` §The `.partial` file, `PartialSessionFile` + `PartialRecovery`, killed at every byte in the merge gate.** What stays open here is the pipe's use of the guid (P3) | `07_IPC`, `04_CAPTURE`, `06_DATA_MODEL` |
| **Agent lifecycle** | Scheduled-task definition, start-at-logon, how elevation is requested and persisted, what "Repair" repairs. **`--serve` exists since 2026-09-10 (P2 PR-F)** — a Generic Host around the watcher, stopped by Ctrl+C with a 15 s finalize grace — and `--install-task` / `--uninstall-task` answer "not implemented in P2"; the task definition and start-at-logon are what stays open *(corrected 2026-10-04: built in P3 PR-8b — `LogonTask` behind both flags, and start-with-Windows as the HKCU Run value)*. **One Agent per data folder since 2026-09-17** (`01_ARCHITECTURE` §Lifecycle: `AgentInstanceLock`, exit 10; beta.1 ran four after an elevated App was refused by the pipe). **Still open from that morning:** (1) the ring's single consumer is enforced across data folders only by `NoSecondRingReaderTests`' source sweep — a developer's `--console --data-dir` capture beside the installed Agent can still attach a second reader to one game's `Local\FrameLedger.Ring.<pid>`, and a runtime claim beside the mapping would close it; (2) ~~elevation is inherited, not chosen — an App started as administrator starts an elevated Agent, which injects and writes the ledger as administrator~~ **closed 2026-09-27 (beta.10, owner decision D34): chosen** — `capture.run_elevated`, a UAC prompt at every Agent start, the logon task's Agent asking through its own prompt, and with the option off an administrator's App starts the Agent with the shell's token (`01_ARCHITECTURE` ADR-9). "How elevation is requested and persisted" is that: requested by the prompt, persisted as one settings row and never as a task's run level | `08_UI` Settings, `11_UPDATER`, `12_BUILD` flags |
| **Session identity** | ~~`sessions` has no GUID column, yet `SessionStarted`/`StopSession`/`.partial` files are all keyed by `sessionGuid`.~~ **`sessions.session_guid` (UNIQUE) exists since 2026-09-09 (P2 PR-B), with `qpc_epoch` / `qpc_frequency` beside it.** ~~Still open: the `.partial` file format is undefined, and it is the crash-recovery artifact — PR-D's, pre-committed in HANDOFF §P2 (CRC-framed append-only chunks, the valid prefix wins)~~ **Built 2026-09-10 (P2 PR-D): `06_DATA_MODEL` §The `.partial` file, `PartialSessionFile` + `PartialRecovery`, killed at every byte in the merge gate.** ~~What stays open here is the pipe's use of the guid (P3)~~ *(built in P3 PR-1/1b: the session events and `StopSession` carry `SessionGuid` — corrected 2026-10-04)* | `07_IPC`, `04_CAPTURE`, `06_DATA_MODEL` |
| ~~**Settings registry**~~ | ~~The `settings` table is key/value with no key list, defaults, types, or validation — and no message for the UI to push a changed setting to the Agent.~~ **Decided 2026-09-13 (HANDOFF §P3 decision D16)**: the key list with defaults and ranges, and *no* push message — the Agent re-reads its keys at each session start. **Built the same day (P3 PR-3):** `06_DATA_MODEL` §Settings registry (12 keys), `Application.Settings.SettingsRegistry` + `RegisteredSettings` (validating writes, tolerant reads), `SettingsRecorderPolicy` resolving `capture.min_session_s` / `telemetry.interval_ms` / `retention.raw_sessions_per_game` at each session start. **Row closed** | `06_DATA_MODEL`, FR-10 |
| **Error taxonomy** | `07_IPC` lists `CaptureError` codes; no canonical mapping to resx keys and user-facing text, though `09_I18N` requires safety strings to be reviewed as legal text | `07_IPC`, `09_I18N` |
| ~~**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)` 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 (`08_UI` §First-run flow built note) | FR-11, `06_DATA_MODEL` |
| **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` |
| **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 | `06_DATA_MODEL`, `05_DETECTION` |
| ~~**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` |
| **Tier-2 mechanism** *(was: PresentMon distribution)* | **By what mechanism does a shipped build reach a no-injection MEASUREMENT?** Nothing names one. Since 2026-08-28 the ladder is two rungs and Tier 2 is explicitly not a measurement — duration, sensors and the reason — so this row is no longer about degraded fidelity but about whether that capability returns at all. **It now owns TWO casualties, not one:** the frame-generation oracle §S31 spent four attempts looking for, and `14_TESTING`'s Tier-1 accuracy cross-check, struck the same day because it required a second instrument measuring the same frames. **One mechanism would restore both**, which is the strongest argument for costing it. Constraints on any answer: `README`'s capture-tier table and its **safety** row *"always a way out"*, `legal/DISCLAIMER.md` §73 and `legal/EULA.md` §33; ETW needs elevation whatever the tool; and `15_ROADMAP` has no v2 fallback either | `README`, `legal/DISCLAIMER.md`, `legal/EULA.md`, `04_CAPTURE`, `14_TESTING`, `15_ROADMAP` |
---
@@ -4326,7 +4386,9 @@ the guard is **item 0**, the Vulkan passthrough test is **item 1**, the two
licence checks were run first and came back clear (`spike-notes.md` §0), and
P0's exit criteria no longer import P2 work — the FPS-impact measurement moves
to the end of P1, while the harness-level per-present cost (no game, no Agent,
no drain) stays in P0. Items 5–9 below are still open.
no drain) stays in P0. ~~Items 5–9 below are still open.~~ *(Corrected 2026-10-04: 5 and 6 are deferred, 🅓 below; 7
is moot — `ci.yml` has gated every PR since bootstrap; 8 is history, P1 having closed; 9 stays open — no `ja` string has
been reviewed, an owner-only item.)*
5. **P0 item 5 asks for an AFMF decision on an RTX 5080.** AFMF is AMD driver
-side. Reword to "validate on NVIDIA; record AFMF as untested", per the
precedent `14_TESTING` already sets for absent hardware.
@@ -4378,9 +4440,9 @@ no drain) stays in P0. Items 5–9 below are still open.
| Named where | Artifact | State |
|---|---|---|
| `12_BUILD:139`, `13_CI_CD:11`, `09_I18N:28`, `CLAUDE.md:66` | `tools/resx-audit` | Absent. **Honestly handled** — `build.ps1:309` skips it loudly with a reason, and no `.resx` files exist yet |
| `12_BUILD:139`, `13_CI_CD:11`, `09_I18N:28`, `CLAUDE.md:66` | `tools/resx-audit` | ~~Absent. **Honestly handled** — `build.ps1:309` skips it loudly with a reason, and no `.resx` files exist yet~~ **✅ Built 2026-09-13 (P3 PR-2)**, a `build.ps1` step (marked 2026-10-04) |
| `12_BUILD:136`, `13_CI_CD:11` | the managed **struct-mirror** test | ~~Absent. Nothing under `tests/` references `FlFrameRecord`.~~ **✅ Built in #47** — `ShmLayout.cs` + `ShmLayoutMirrorTests`, driven by `fl-layout-dump`'s JSON rather than a transcribed table, asserting blittability as well as offsets, and walking the field list in both directions. `build.ps1`'s gate now reads the run's `.trx` and fails when the class did not execute, so **deleting the test is red too** — it used to `Test-Path` a source file |
| `13_CI_CD:21`, `12_BUILD:121`, `CHANGELOG:9` | `.github/workflows/release.yml` | Absent. `CHANGELOG`'s header instructs an author to write for a consumer that does not exist |
| `13_CI_CD:21`, `12_BUILD:121`, `CHANGELOG:9` | `.github/workflows/release.yml` | ~~Absent. `CHANGELOG`'s header instructs an author to write for a consumer that does not exist~~ **✅ Built 2026-09-14 (P4 PR-5)**; it published beta.1 through beta.11 (marked 2026-10-04) |
| `12_BUILD` §Local quality gate | gates omitted from the list | ~~**Three documents give three different counts, which is the finding.** `build.ps1` has **15** `Write-Step` calls as of 2026-08-05 (14 before this PR's `changelog-check`); `12_BUILD` lists 10; this row said 13.~~ **Corrected 2026-08-06: `build.ps1` has 17 `Write-Step` calls** (`package-closure` added two), and `12_BUILD`'s list is rewritten to 16 numbered entries — the difference is that `Invoke-Native`'s three steps run under one heading there. `13_CI_CD` no longer restates the list at all; it points at `12_BUILD`, because restating it in two places is what let one of them rot. **Nothing still derives the list from the script**, so the drift is slowed rather than stopped, and this row remains open for that reason. **And it drifted again, exactly as predicted — re-counted 2026-08-28.** `hookinventory-check` had reached `build.ps1` and never reached the list; `frametype-oracle` had reached both and then been deleted with PresentMon, so the two errors happened to cancel and the *totals* matched while the *membership* did not — the same coincidence §S24's own recount was caught by. The list is rebuilt to **17 entries against 17 `Write-Step` calls, in script order** (re-deriving the order caught a second defect: two adjacent entries had been transposed relative to the script). **The row still does not close.** Aligning by hand is what was done in 2026-08-06 and again here; it lasts until the next gate lands. The fix is a gate that reads the `Write-Step` names out of `build.ps1` and fails when the list disagrees — until it exists, re-count rather than trusting the number |
The struct-mirror row is the one that matters. `CLAUDE.md` §Struct mirroring
+1097 -15
View File
File diff suppressed because it is too large. Load diff
+77
View File
@@ -0,0 +1,77 @@
# 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
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.)*
**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
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.
## 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) |
| 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) |
| 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) |
| 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 |
| 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) |
| 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 |
| 恋しかるべき (KOISHIKARUBEKI) | Unity 6000.3 | D3D11 | Presented 59.6 FPS | 2026-09-03 | [spike-notes §9](spike-notes.md) |
| 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)* |
## Recorded without measurement (Tier 2)
| Game | Why nothing was measured | When | Evidence |
|---|---|---|---|
| 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 |
| 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 |
## Refused by the anti-cheat guard
| Game | What was found | When | Evidence |
|---|---|---|---|
| ELDEN RING | Easy Anti-Cheat: its folder, and a process Windows would not let FrameLedger open. Nothing was ever injected; eight sessions recorded without measurement | 2026-09-21 → 09-27 | [CHANGELOG](../CHANGELOG.md), database |
| GIRLS' FRONTLINE 2: EXILIUM | NetEase Yidun (`NEP2.dll`, user mode) — turned hooking off after it had been measured; measured again since 2026-09-26 under the user-mode exception its owner made | 2026-09-25 | [19_SAFETY](19_SAFETY_AND_ANTICHEAT.md) |
| 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) |
| 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).
## Engine version read from the executable only
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))
+87
View File
@@ -0,0 +1,87 @@
# FrameLedger developer documentation
This folder is for people who build, change or review FrameLedger. **If you only want to use it, read the
[user guide](../guide/README.md) instead** — it is also in the app, under Help ▸ User guide.
## Where to start
| You want to… | Read |
|---|---|
| Pick up work where it stopped | [`HANDOFF.md`](HANDOFF.md) — sequencing, decisions (~~D1…D46~~ D1 onward — *corrected 2026-10-07: the range grows with every train*) and the traps that each cost a cycle. It carries no status on purpose |
| 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) |
**Status lives in four places, and nowhere else** — check a status claim against the code before you plan on it:
| Question | File |
|---|---|
| What is unresolved, and what does it block? | [`20_OPEN_QUESTIONS.md`](20_OPEN_QUESTIONS.md) |
| What was measured, on what machine? | [`spike-notes.md`](spike-notes.md) |
| Which phase is where? | [`15_ROADMAP.md`](15_ROADMAP.md) |
| What landed, in which release? | [`../CHANGELOG.md`](../CHANGELOG.md) |
What the software promises users is the accuracy block in [`../legal/ACCURACY.md`](../legal/ACCURACY.md), copied
verbatim into the README and the Disclaimer and bound to its source by `tools/accuracy-check.ps1`.
## Reading order
1. [`19_SAFETY_AND_ANTICHEAT.md`](19_SAFETY_AND_ANTICHEAT.md) — the guard, the refusal list, what will not be built. It
constrains everything else.
2. [`01_ARCHITECTURE.md`](01_ARCHITECTURE.md) — processes, the injection flow, lifecycles, the ADRs.
3. [`02_SPEC.md`](02_SPEC.md) — the FR / NFR ids used everywhere.
4. [`03_METRICS.md`](03_METRICS.md) — the metric math; the source of truth for every number shown.
5. [`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) — the C++ hook layer inside the game.
6. [`04_CAPTURE.md`](04_CAPTURE.md) — capture orchestration on the Agent's side.
7. [`05_DETECTION.md`](05_DETECTION.md) — engine, upscaler, frame-generation and ray-tracing facts.
8. [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) — layered telemetry, the game process's memory, vendor-SDK licence rules.
9. [`06_DATA_MODEL.md`](06_DATA_MODEL.md) · [`07_IPC.md`](07_IPC.md) · [`08_UI.md`](08_UI.md) ·
[`16_WPFUI_SYNTAX.md`](16_WPFUI_SYNTAX.md)
10. The rest: [`09_I18N.md`](09_I18N.md), [`10_LOGGING_AND_BUG_REPORTS.md`](10_LOGGING_AND_BUG_REPORTS.md),
[`11_UPDATER.md`](11_UPDATER.md), [`12_BUILD.md`](12_BUILD.md), [`13_CI_CD.md`](13_CI_CD.md),
[`14_TESTING.md`](14_TESTING.md), [`15_ROADMAP.md`](15_ROADMAP.md).
**Before you write native or capture code, read [`20_OPEN_QUESTIONS.md`](20_OPEN_QUESTIONS.md):** its S-series items
are safety items, and something listed there as unresolved should not be built the way an older document describes it.
## Every document, in one line
| Document | What it is for |
|---|---|
| [`01_ARCHITECTURE.md`](01_ARCHITECTURE.md) | The processes (App, Agent, Overlay, Vulkan layer), how injection flows, the architecture decisions |
| [`02_SPEC.md`](02_SPEC.md) | Functional and non-functional requirements, by id |
| [`03_METRICS.md`](03_METRICS.md) | How every number is computed: frame times, lows, stutter, frame generation, display mode, the game's memory, sensor statistics, the export schema |
| [`04_CAPTURE.md`](04_CAPTURE.md) | The Agent's capture loop, the tiers, finalizing and recovery, the threading model |
| [`05_DETECTION.md`](05_DETECTION.md) | Detecting engines, platforms and capabilities; the detection rules |
| [`06_DATA_MODEL.md`](06_DATA_MODEL.md) | The SQLite schema, every migration, who writes what, retention |
| [`07_IPC.md`](07_IPC.md) | The shared-memory ring between the game and the Agent, and the named pipe between the Agent and the App |
| [`08_UI.md`](08_UI.md) | Every screen of the App, as specified and as built |
| [`09_I18N.md`](09_I18N.md) | English / Vietnamese / Japanese strings, the glossary, the safety-string review rule |
| [`10_LOGGING_AND_BUG_REPORTS.md`](10_LOGGING_AND_BUG_REPORTS.md) | Logs in every process, the bug-report bundle, redaction |
| [`11_UPDATER.md`](11_UPDATER.md) | Velopack updates from GitHub Releases, and when an update may apply |
| [`12_BUILD.md`](12_BUILD.md) | The toolchain, the build, the quality gate step by step, publishing and packaging |
| [`13_CI_CD.md`](13_CI_CD.md) | The CI and release workflows |
| [`14_TESTING.md`](14_TESTING.md) | The test strategy, hook overhead, the hardware matrix |
| [`15_ROADMAP.md`](15_ROADMAP.md) | The phases and where each stands |
| [`16_WPFUI_SYNTAX.md`](16_WPFUI_SYNTAX.md) | WPF UI (lepoco) rules, theming, rendered documents, gotchas |
| [`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) | The hooks inside the game: inventory, fault policy, the ring writer, Vulkan |
| [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) | Telemetry layers (DXGI/PDH, LibreHardwareMonitor, NVAPI), the game process's memory, licences |
| [`19_SAFETY_AND_ANTICHEAT.md`](19_SAFETY_AND_ANTICHEAT.md) | The anti-cheat guard, what a finding does, the user-mode exception, what will never be built |
| [`20_OPEN_QUESTIONS.md`](20_OPEN_QUESTIONS.md) | Every unresolved question, defect and measurement, with its status marker |
| [`HANDOFF.md`](HANDOFF.md) | Sequencing, the owner's decisions, traps |
| [`spike-notes.md`](spike-notes.md) | What was measured, how, on which machine, and what each result decided |
| [`LIST_GAME_TESTED.md`](LIST_GAME_TESTED.md) | The real games FrameLedger has been run with, and what each session measured (changes need the owner's review) |
| [`legal-drift-history.md`](legal-drift-history.md) | How the legal documents once drifted from the software, and the maintainers' notes moved out of them |
| [`vendor-exports.json`](vendor-exports.json) | The vendor DLL exports the hooks are allowed to bind, checked by `tools/vendor-exports` |
## Beside this folder
- [`../guide/`](../guide/README.md) — the user guide (players, English); since beta.17 (D54) also the wiki's End-user part.
- [`../wiki/`](../wiki/Home.md) — the wiki's own pages: Home, the sidebar, the developer pages (D53). `wiki.yml`
publishes them with the guide to the Wiki tab when a release is made; `build.ps1`'s `wiki-check` holds every link.
- [`../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.
- [`../rules/detection-rules.json`](../rules/detection-rules.json) — engine, platform and capability signatures and the
anti-cheat blocklist, validated by `tools/rules-validate.ps1`.
+111
View File
@@ -0,0 +1,111 @@
# How `legal/` drifted from the software, 2026-08-04 → 2026-09-15
The block below lived at the top of `legal/DISCLAIMER.md` — inside the text a user accepts at first run — from
2026-08-04 until 2026-09-16, when it moved here unchanged. It is the record of six re-counts of that document's
promises against the code, in both directions, and of the mechanism that ended the drift: one accuracy statement
(`legal/ACCURACY.md`) embedded in `README.md` and `DISCLAIMER.md` §4 and bound to its source by
`tools/accuracy-check.ps1` (`docs/20_OPEN_QUESTIONS.md` §S23-6). It is kept because the pattern it records —
half a mechanism reading as a whole one, an under-claim going unnoticed because everyone was watching for
over-claims — is the pattern the next reviewer of `legal/` will meet. Nothing here is normative; the current
statement is `legal/ACCURACY.md`, dated.
> ⚠ **Accuracy audit — re-checked 2026-08-14, a FOURTH time, after PR #64. SIX statements below describe behaviour the software does not yet fully have**, and they are flagged here rather than quietly reworded because a document the user accepts must not over-promise.
>
> **A FIFTH time, 2026-09-06, and the mechanism changed rather than the count.** Every drift this block records came from the same cause: the sentence about what the software measures lived in three places and was re-read in none of them. It now lives in **one** — `legal/ACCURACY.md`, embedded verbatim in §4 below and in `README.md`, and `tools/accuracy-check.ps1` fails the build when a copy differs from the source (`20_OPEN_QUESTIONS` §S23-6). The bullets below are the history of the four drifts and are kept as history; the block in §4 is the current statement, dated.
>
> **A SIXTH time, 2026-09-15, and the drift ran the safe way again.** The block in §4 is re-dated and rewritten against the code: OpenGL is measured, the shipped Agent runs the in-session re-scan, the whole-card video memory is recorded, and the Vulkan, preset, FSR-version and frame-generation sentences say exactly what the code does. Two bullets below became false because the software caught up with them, and they are struck where they sit. Version 2.1-draft, so the first-run gate shows this document again.
>
> **The fourth drift is the first one that ran the other way, and that is the finding.** Every previous re-count found this document claiming *more* than the software did. #64 landed the upscaler identity hook and this block went on saying "there is no upscaler hook anywhere in the software" — an under-claim, in the one file whose failure mode everybody was watching for in the opposite direction. It went unnoticed for five days for exactly that reason: a reviewer checking whether `legal/` over-promises reads a sentence like that and moves on. **Re-reading this block means checking both directions.**
>
> **The re-count was overdue and this block's own rule is what says so.** The last line of this block requires whoever changes what `FrameLedger.Overlay` does to re-read it. #48 changed exactly that — the Overlay now drops `DXGI_PRESENT_TEST` presents without recording them — and this block was not re-read. That is the second time the rule has been broken since it was written, and both breaches were invisible from inside the PR that caused them.
>
> **Two additions this round, both about what the software claims to *measure*** — the class the project has already had to retract twice:
>
> **Two bullets changed substance and neither could be struck.** The capture side that *receives* a stop now exists and now runs whether or not the game is presenting; the side that would *send* one still does not. That is the pattern to watch for when re-counting: half a mechanism reads as a whole one, and the half that is missing is usually the one nobody was looking at.
>
> - ~~§1's *"what it observes: … presentation, upscaling, ray tracing, pipeline creation"* and §4's *"upscaling, frame-generation and ray-tracing state are read from the parameters the game passes to those APIs"* — **only the presentation path is intercepted.** There is no upscaler hook, no frame-generation hook, no ray-tracing hook and no pipeline hook anywhere in the software.~~ **FALSE SINCE #64, corrected 2026-08-14 — the fourth drift, and this one is the block's own subject.** An **upscaler hook exists**: one detour on `sl.interposer.dll!slEvaluateFeature`, module-scoped, reading one argument. It measures **which upscaler is running** (DLSS, NIS, or `unknown` — never "none") and, for Streamline titles, **whether Ray Reconstruction is active**, which is a `Yes`/`No` the software now publishes. What still does not exist: quality preset, render resolution, frame generation, ray tracing, pipeline. The capture side states all of that in its own data on every frame rather than defaulting to "none", so nothing false is *recorded*; what over-promised was this document, in the direction of under-claiming rather than over-claiming — which is the safer direction and is still wrong. Both sentences are qualified where they sit.
> - ~~§2's *"and every 30 seconds afterwards … it stops at the next scan"* — the pre-injection guard is real and refuses. The **receiving half is implemented**: an injected D3D title removes its hooks within one frame of the stop flag being set. The **sending half is still missing, and the missing part is narrower than this block used to say.** Both the write path (`ShmRingReader.PublishGuardResult`, which maps the shared memory and advances the field) and the read path exist in shipped code and are tested; what does not exist is a production caller that runs the loop between them. A missing loop, not a missing subsystem — and the user-facing consequence is identical: **no re-scan runs and no stop is ever sent.**~~ **FALSE SINCE 2026-09-10 (P2 PR-F), struck 2026-09-15:** the shipped Agent drives the loop — during every capture it re-runs the checks every 30 s and sends the stop on a refusal (`legal/ACCURACY.md`, embedded in §4).
> - §2's *"waits **65 seconds** before concluding that contact is lost"* — **the deadline now has a reader, and since 2026-08-05 it runs whether or not the game is presenting.** For one day it was evaluated only on a present, so a title that had hung or been alt-tabbed never reached it — the exact case the mechanism was specified for. A watchdog inside the injected component now checks once a second regardless. Two qualifications remain: for **Vulkan titles the check runs on each present rather than once a second** — the layer may not own a thread, so a Vulkan title that has stopped presenting is not stopped by the deadline (and presents nothing to be observed) — and **the 65-second value itself is not covered by a test** — the stop is proven to fire, but a suite that runs on every build cannot wait 65 seconds, so what is verified is the mechanism, not the number.
> - ~~§3's *"automatically stops injecting into a game that crashes shortly after injection twice"* — the only trace of this anywhere is a `hook_crash_count` column in a schema for which no `.sql` file exists. There is no design for it.~~ **BUILT 2026-09-10 (P2 PR-D), struck 2026-09-15:** two crashes of the same game within 60 s of injection disable hooking for that game, with the reason on its row (`CrashAutoDisablePolicy`).
> - §1's *"Only FrameLedger's own component is ever loaded"* — **narrower than it sounds, and the qualification is now in §1 itself.** The check is a directory test: the payload must resolve into FrameLedger's own install directory. It does not compare a filename, a version or any content, deliberately — a name check would be defeated by any DLL that borrowed the name. A published self-contained build puts several hundred files in that directory.
>
> **None of this may ship as-is.** Either the behaviour exists at first release or these sentences change. Tracked in `docs/20_OPEN_QUESTIONS.md`.
>
> **This block is maintained by hand and nothing verifies it.** Every other document here is bound to the code by something — `rules-validate` cross-checks the blocklist, `static_assert`s bind `fl_shm.h` to `07_IPC`, `versioninfo-check` and `chokepoint-check` bind claims to binaries. `legal/` is bound by nothing, and it has now gone stale **three times**: first within hours of being written, when the 65-second sentence was added directly beneath a header that said "Three"; then again when five PRs (#40–#44) changed the Overlay from a stub into a hooking, shared-memory-mapping, control-block-reading component and touched **no documentation at all**, leaving the second bullet above asserting four things about that binary that were each false. and a third time when #46–#52 landed — seven PRs, including one (#48) that changed what the Overlay does *inside a game* — with no edit here at all. None of the three drifts was visible from inside the PR that caused it. **Whoever edits any promise in this file must re-count — and whoever changes what `FrameLedger.Overlay` does must re-read this block, because nothing will remind them.**
>
> **That sentence has now failed twice, so it is being replaced by something that is not a sentence.** `ci.yml` fails a pull request that touches `src/` without touching `CHANGELOG.md`. That is a weaker gate than the ones binding every other document — it forces a *ledger* entry, not a re-read of *this* file — and it is written down as weaker rather than described as a fix. A gate over the claims in `legal/` would have to assert things about behaviour rather than about files, and nobody has designed one (`docs/20_OPEN_QUESTIONS.md` §S23-6).
---
## Moved out of the accepted documents on 2026-10-03 (beta.12: Disclaimer 2.10, Privacy Policy 2.6)
The three blocks below were notes for the documents' maintainers inside texts a user accepts. They moved here unchanged
when the user guide (`guide/`) and a rendered Legal Gate made those documents read as what they are — terms — and they
are kept because they record what each version changed and why (owner decision D45).
### The Disclaimer's preface (versions 2.3–2.9)
> **How this document is kept true.** The statement of what FrameLedger measures (§4) is `legal/ACCURACY.md`,
> embedded here and in `README.md` and bound to its source by `tools/accuracy-check.ps1`, which fails the build when a
> copy differs. Earlier versions of this document carried a hand-maintained audit of how its own promises drifted from
> the software — six re-counts between 2026-08-04 and 2026-09-15; that history is `docs/legal-drift-history.md`,
> moved out of the text you accept on 2026-09-16 and kept in full.
### The Privacy Policy's §2 history note (versions 2.2–2.5)
> **History.** Versions 2.0 and 2.1 of this document listed three further rows — a weekly safety-list update, a weekly detection-rules update, and an opt-in Steam store lookup — describing requests the software did not make; from 2026-08-04 they carried an audit note saying so. Version 2.2 (2026-09-16) removes them. A privacy policy that lists a transmission which never happens is as wrong as one that omits a transmission which does.
### The Privacy Policy's §4 history note (versions 2.3–2.5)
> **History.** Version 2.3 (2026-09-23) adds the per-entry recording switch. Before it, every program in your library was recorded whenever it ran, which recorded a utility that starts with Windows at every boot.
>
> Version 2.4 (2026-09-25, 0.1.0-beta.8) names what the software reads to check every game in your library for anti-cheat — until then it checked only a game you asked to hook — and to name the versions of its files, and the NVIDIA driver's settings for your games. The files of a library game's folder were already read to detect its engine and features; this version is the first to say so.
>
> Version 2.5 (2026-09-27, 0.1.0-beta.10) adds how a tracked game's window is shown — read from Windows — and the engine build name read from an Unreal Engine game's executable. It is also the first version to say two things the software already did: it reads the **content** of a library game's executable (markers in its first 8 MB and its import table, since the detection of engines and features; and, when a session starts, the graphics-library markers in the whole file), and it reads the processor load and the memory in use (since 0.1.0-beta.3). Nothing here leaves your device, as before.
### What version 2.11 of the Privacy Policy changed (0.1.0-beta.23)
A game's page shows its artwork (beta.23 PR-3, owner decisions D60/D61; the wording approved with the plan). §1 adds the
images a user chooses for a game, kept as a copy in the data folder's `covers` folder and deleted when the store's image
is chosen again or the game is removed with its sessions. §4 adds the cover and banner images the Steam and GOG GALAXY apps
keep on the disk for a library game, read to show them on its page and never copied or sent, and says that Steam's and
GOG GALAXY's lists of installed games are now also read when a game's page opens, to find that artwork. §2 is unchanged:
nothing is downloaded, and the software still looks nothing up on any store. Nothing here leaves your device, as before.
### What version 2.10 of the Privacy Policy changed (0.1.0-beta.21)
§4 names the lists of installed games the Steam, GOG GALAXY, Epic Games and itch apps keep on the disk, and where GOG
GALAXY is installed, read when the library is imported and when Play is pressed (beta.21 PR-4, owner decision D59; the
wording approved with the plan). The import has read the Epic Games Launcher's manifests and itch's records since
0.1.0-beta.1 without a word here — §4 named only "the store files that name it (Steam's and GOG's, on your disk)", read for
detection; this version is the first to say so. §2 says that Play hands a game to its store's app, which may connect to
its store, and that FrameLedger itself connects to nothing. Nothing here leaves your device, as before.
### What version 2.9 of the Privacy Policy changed (0.1.0-beta.20)
§4's list of the version marks an engine keeps in its own files gains one: the version file of a Ren'Py game's engine
(`renpy/vc_version.py`), read to show a Ren'Py game's engine version (beta.20 PR-1, owner request 2026-10-12) — its first
4 KiB, for the `version` line only. Nothing here leaves your device, as before.
### What version 2.8 of the Privacy Policy changed (0.1.0-beta.19)
§4 names the version marks an engine keeps in its own files, read to show a Unity, Godot or RPG Maker game's engine
version (beta.19 PR-3, owner request 2026-10-12): Unity's player library (its version information) and the header of its
data file, the header of a Godot data pack, an RPG Maker game's core script and `Game.ini` and the library `Game.ini`
names. Two of them were read before and never stated: the version information of `UnityPlayer.dll` (the Unity rule's
extractor since the detection rules began) and an RPG Maker MV/MZ game's title in `data/System.json`, which the App reads
to name a game added by hand (since 2026-09-23). Nothing here leaves your device, as before.
### What version 2.7 of the Privacy Policy changed (0.1.0-beta.14)
§4 says two things the software reads to tell a crash from an ordinary exit: the crash reports Windows keeps in its
Application log about a tracked game — read since P2 and never stated until 2.7 — and the names of the programs a tracked
game starts, so that an engine's own crash reporter is recognised (beta.14 PR-5). §1 lists the graphics card's clock
speeds, fan speed, memory temperature and power or thermal limit among the stored sensor series (beta.14 PR-7, D49): they
were read before and are stored since.
### What version 2.6 of the Privacy Policy changed
It names the game's own memory use (since beta.12, read from outside the game in every session) where version 2.5
named "video-memory usage reported by the graphics runtime" — an in-game figure the software never read — and adds
§3A: what an export or a bug report can carry about you before you share it.
+275 -7
View File
@@ -2462,7 +2462,8 @@ produced no false refusal on any real install.
## 14 · The P2 milestone and the FPS-impact run *(slots — the owner's runs)*
**Nothing below has been run.** The section exists because P2's code is finished and its two
**Nothing below has been run** *(written 2026-09-10; §14.1's row half is read 2026-09-16 — see there — and §14.2–14.4 are
still unrun)*. The section exists because P2's code is finished and its two
remaining obligations are measurements a script cannot take: a real title, read against its own
settings menu, and a benchmark whose number only the operator can see. Written as empty slots with
the exact commands rather than left absent, so the next session cannot mistake "not measured" for
@@ -2487,14 +2488,34 @@ FrameLedger.Agent --console launch --exe "<title>.exe" --seconds 600
FrameLedger.Agent --console sessions --last 1
```
**The row half is read — 2026-09-16, the shipped Agent, not the console.** The owner ran the App with its `--serve`
Agent for an afternoon (18 hooked sessions — **count note, 2026-09-27:** `CHANGELOG` 2026-09-17 says *all nine hooked
sessions of 2026-09-16*; neither count was re-made when the other was written, and the ledger as it stands today holds no
session from that day, so the discrepancy is recorded rather than resolved — attach mode, `late_attach = 1`, every one watcher-driven from a Steam
launch rather than the `launch` verb above — a Steam title started from its Shipping executable relaunches through
Steam, so the console recipe is the wrong vehicle for a Steam library and the product's own path is the right one).
`sessions.id = 10`, **Lies of P**, 16:11, 147 s, `d3d12`, 16,221 frames, `guard_ticks_published = 5`, Overlay
`dcf5796bf2a6-dirty`, read from the ledger (rebuilt that evening from its WAL — `06_DATA_MODEL` §Migrations carries
that incident; the row is the row):
| Field | Read from the row | The game's own menu | Agree? |
|---|---|---|---|
| `upscaler` | | | |
| `upscaler_quality` | | | *(`N/A` is the measured answer on every title so far — §9, P0 exit criterion 1)* |
| `render_w` × `render_h` → `output_w` × `output_h` | | | |
| `fg_mode` / `fg_factor` | | | |
| `rt_flag` | | | |
| `telemetry_source` | | *(expect `l1+lhm+nvapi` on this box since PR-E2)* | |
| `upscaler` | `fsr3` (`fg_source = api`) | *owner to read* | |
| `upscaler_quality` | `NULL` (0xFF → not stored, #183) | | *(`N/A` is the measured answer on every title so far — §9, P0 exit criterion 1; FSR 3 carries no Streamline `DLSSOptions` to chain, so it is the expected answer here too)* |
| `render_w` × `render_h` → `output_w` × `output_h` | **1506 × 848 → 2560 × 1440** (`upscale_ratio` 1.70 — FSR "Balanced" is 1.7×; "Quality" would be 1.5×, "Performance" 2.0×) | *owner to read* | |
| `fg_mode` / `fg_factor` | `fsrfg` / **2.04** (`native_fps` 57.1 → `displayed_fps` 116.4, `displayed_counted_by = hook`, no refusal) | *owner to read* | |
| `rt_flag` | `no` (`rt_source = measured`, `rt_frame_pct` 0.0) | *owner to read* | |
| `telemetry_source` | `l1+lhm+nvapi` | *(expect `l1+lhm+nvapi` on this box since PR-E2)* | ✅ |
**What this row does and does not settle.** It is the first hooked session the *shipped* Agent persisted with a
measured upscaler, a counted frame-generation factor and a measured RT state — the milestone's row half. The
"against its menus" column is empty because only the owner can read the game's settings screen, and the row is
kept here with that column blank rather than filled from memory. The same afternoon's DLSS-G rows (Onimusha ×2,
Hell Is Us, Black Myth: Wukong) are the *refused* shape — identity `dlssg` from the tags, `fg_factor` NULL,
`fg_refusal` = `multiple_streams` (RE Engine's second swapchain) or `non_uniform` (a bucket that departed: menus,
loading, alt-tab in a whole play session) — which is the guard working on real play rather than on a 40-second leg,
and the reason `fg_refusal_detail` (schema 0005) now stores the bucket's numbers. Onimusha's `rt_flag = yes` with
`rt_frame_pct` 25.0 / 17.8 and Wukong's `yes` at 16.2 are measured against nothing yet either.
**One launch per capture** (HANDOFF §Traps): a title measured off / ×2 / ×4 is three launches.
@@ -2510,6 +2531,9 @@ then elects the newest tracked descendant and attaches.
spawns — so the run is: `consent grant` the launcher, `launch` it, read the `election:` line, then
`consent grant` the game the election named and `launch` again.
*(2026-10-06, beta.15: before beta.15 the `election:` line could not appear — the launch's refused outcome carried no
launcher pid and the election returned before it logged anything. Run this table on beta.15 or later.)*
| | |
|---|---|
| Title / launcher | |
@@ -2545,3 +2569,247 @@ inspects module sizes is the way to fill it.
Unchanged by P2 and repeated here because it is the other measurement no PR can close: the
compare-and-restore path is proven against a fixture (`ctest fl_unhook_inline`), and §H7 still asks
for one capture with each of the six overlays actually resident on the dev machine.
## 15 · Unreal Engine versions in shipping executables *(2026-09-27, beta.10)*
Measured read-only on the owner's machine (i7-14700KF, RTX 5080, Windows 11 29648): every `*-Win64-Shipping.exe`
under `D:\SteamLibrary\steamapps\common` (a USB drive), before the extractor was written, then again through the
shipped `UnrealBuildReader` once it was. Nothing was copied or written; the numbers are in `05_DETECTION` §Engine version
(the table is not repeated here).
- **Numeric file version** (`VS_FIXEDFILEINFO`): the engine's MAJOR.MINOR.PATCH in seven of ten; a studio's own in three
(Cronos 1.2.0.0, Rune Factory 1.0.3.0, SILENT HILL 2 1.0.0.5). The version *strings* are empty in six of ten.
- **Branch name** (UTF-16 `++UE4+Release-M.m` / `++UE5+Release-M.m`): present in five — in `.rdata` in four (15–30 MB
sections), and 290 MB into `.code` in Black Myth: Wukong, whose protected executable has an 8 KB `.rdata`; in UMIGARI
also in the version strings. Absent in five (Hell Is Us carries `UE5-CL-0`: a renamed branch).
- **The shipped reader, same ten files:** every version as tabled — 8 read, 2 honestly none — in 16 ms to 1.1 s each and
7.5 s for Black Myth (the whole-file fallback, stopping at the first chunk that names a release line). A first pass
that scanned only a PE's `.rdata` read Black Myth as `5.0.0` from the file version alone; the 1 MiB `.rdata` floor
(`UnrealBuildReader.MinRdataBytes`) is what moved it to the stronger rung.
- No UE3 title is installed; the rule does not detect UE3 at all.
## 16 · A game process's own memory, read from outside it *(2026-10-03, beta.12, owner decision D43)*
**Why this was measured.** Per-process VRAM had storage since 0001 and no producer: `17_HOOK_ENGINE` §Memory planned
`IDXGIAdapter3::QueryVideoMemoryInfo` inside the game, `20_OPEN_QUESTIONS` §M7 (2026-09-09) recorded that its
`CurrentUsage` is the calling process's own (0 bytes from the Agent) and concluded the figure could only be read in the
game, and §H10 left open where in the game. The owner chose the other road (D43): the documented performance counters
`\GPU Process Memory(pid_<pid>_luid_…_phys_<n>)\Dedicated Usage` / `Shared Usage` — the numbers Task Manager's Details tab
shows — need no handle to the game at all, and `GetProcessMemoryInfo` needs only `PROCESS_QUERY_LIMITED_INFORMATION`.
§M7's conclusion holds for `QueryVideoMemoryInfo` and not in general.
**Already seen before this section was written**, stated so the table below is not read as having preceded them:
(1) the counter set exists on the dev box, 37 instances at an idle desktop (`Get-Counter`, 2026-10-03); (2) `Dedicated
Usage` is not `Local Usage` — dwm.exe 858 MB against 310 MB — so "dedicated" is defined as Task Manager's column and never
compared with a DXGI budget; (3) `ctest fl_process_stats` on the RTX 5080 while the reader was being written: a 256 MiB
DEFAULT buffer moved this process's dedicated figure 12.9 → 269.0 MiB (+256.1), and `PROCESS_MEMORY_COUNTERS_EX2` answered
(private working set 5.2 MiB) on Windows 11 29648.
**The decision table, written before the runs below** (instrument: `fl-probe-processstats`, `--hold-vram` in one
process and `--read` against it in another):
| # | Measurement | Outcome → what it means |
|---|---|---|
| M1 | Cost of one collect + read, 60 samples at 1 s | median ≤ 5 ms → 1 Hz with the sensors; 5–20 ms → still 1 Hz, noted in `18_GPU_VENDOR_APIS`; > 20 ms → every 5 s, and said so |
| M2 | Δ dedicated of a second process holding 512 MiB | within ±2 % → "Dedicated GPU memory, as Task Manager shows it" may be written; off by > 10 % → stop, the video half does not ship |
| M3 | dedicated against that process's own `QueryVideoMemoryInfo(LOCAL).CurrentUsage` | recorded in `03_METRICS`, whichever way it falls — the source does not change |
| M4 | `PrivateWorkingSetSize` (EX2) against `\Process V2(<name>:<pid>)\Working Set - Private` | equal → "the same as Task Manager's Memory column"; EX2 refused → the EX fallback, and Windows 10 stays unmeasured |
| M5 | How soon a new process's counter instance appears | recorded; the first seconds of a session reading N/A is then expected, not a fault |
| M6 | The probe's own private bytes after 600 collections | Δ < 1 MiB → keep one query per session; more → open and close per collection, then measure again |
**Results (2026-10-03, the same evening; RTX 5080, driver 617.14, Windows 11 29648.1000, `fl-probe-processstats`
from this PR's build):**
| # | Measured | Row taken |
|---|---|---|
| M1 | 60 samples at 1 s: collect + read **median 0.098 ms, max 0.217 ms**; 600 back to back: median 0.028 ms, max 0.190 ms | ≤ 5 ms → 1 Hz with the sensors |
| M2 | holder at 8 MiB: dedicated **21.0 MiB**; holder at 512 MiB: **525.0 MiB** → Δ **512.0 MiB** for 512 MiB allocated (0.0 %); the in-process ctest earlier: +256.1 MiB for 256 | within ±2 % → "Dedicated GPU memory, as Task Manager shows it" |
| M3 | the holder's own `CurrentUsage(LOCAL)`: 16.5 MiB (8 MiB holder) and 520.5 MiB (512 MiB holder) against dedicated 21.0 and 525.0 — **dedicated reads 4.5 MiB more, the same 4.5 MiB at both sizes** | recorded in `03_METRICS`: the counter includes a constant per-device amount the DXGI budget group does not; the difference does not grow with what the game allocates |
| M4 | private working set (EX2) **9.1 MiB** = `\Process V2(fl-probe-processstats:<pid>)\Working Set - Private` **9.1 MiB**, in all 60 samples | equal → "the same as Task Manager's Memory column" |
| M5 | the holder's instance was present at the reader's first poll, ~50 ms after the holder started (its device and buffer had already been created) | an instance exists from the process's first GPU allocation; a game that has made none reads N/A, as specified |
| M6 | 600 collections: the probe's private bytes moved by **0 bytes** (−44 KB over the 60 slow ones) | < 1 MiB → one query per session |
**What stays unmeasured:** Windows 10 22H2 (no machine; the reader falls back to `PROCESS_MEMORY_COUNTERS_EX` where EX2 is
refused, and the private working set then reads N/A), AMD and Intel GPUs, a laptop with two adapters (the reader sums
every adapter's instances for the pid), and a real game — the owner's beta.12 check (HANDOFF owner-only item 9) compares
a session's figures with Task Manager's Details tab at the same moment.
## 17 · Unity, Godot and RPG Maker versions in installed games *(2026-10-12, beta.19)*
Measured read-only on the owner's machine (i7-14700KF, RTX 5080, Windows 11 29648) before the readers were written:
every `UnityPlayer.dll`, `*.pck`, `rmmz_core.js`, `rpg_core.js` and `RGSS*.dll` up to five levels under `D:\another`
(GOG, itch and loose installs), `D:\SteamLibrary\steamapps\common`, Steam's own `common` and `G:\` — 23 installs, read in
9.6 s. Then again through the shipped pipeline (`StaticGameDetector` over `GameFileProbe`, rules `2026.10.2`), which read
every install as tabled. Nothing was copied or written; the decision rules are in `05_DETECTION` §Engine version — Unity,
Godot, RPG Maker.
| Engine | Installs | What the files say | Read as (shipped) | Detect time |
|---|---|---|---|---|
| Unity 2020+ | DONT GO, Dialoop, Broken Shell Demo, Deadly Heart Gambit, DreadFields, Kemono Teatime, March Out!, Umamusume, Walto, Yasha, Yu-Gi-Oh! Master Duel, 帰路, Legends of Runeterra | `UnityPlayer.dll` ProductVersion `2022.3.39f1 (4e1b0f82c39a)` … `6000.3.17f1 (cf0352b38e81)`; FileVersion `2022.3.39.5118735` (the build number where the release letter belongs) | the ProductVersion's editor version (`unity_player`) | 26 ms – 4.1 s |
| Unity 2019.4 | A Space for the Unbound - Prologue (GOG) | ProductVersion = FileVersion `2019.4.1.15122501`; `*_Data/globalgamemanagers` byte 20: `2019.4.1f1` | `2019.4.1f1` (`unity_data`) | 102 ms |
| Unity 2019.4 | GIRLS' FRONTLINE 2: EXILIUM | ProductVersion `2019.4.40.16762411`; the data file's header is not readable (encrypted) | `2019.4.40` (`unity_player_file`) | 2.2 s |
| Godot 4 | Plethora of Bullets 2 (itch), 衔蝶 (Steam) | `<exe>.pck` header `GDPC`, format 2, `4.2.2` / `4.4.1`; the exe's `Godot Engine v4.4.1.stable.official` sits 57–78 MB in; 衔蝶's version resource is the studio's (`0.1.0.3`) | `4.2.2`, `4.4.1` (`godot_pck`) | 24–41 ms |
| RPG Maker MZ | A Doll's Locket - Remake (itch) | `js/rmmz_core.js` line 2 `// rmmz_core.js v1.10.0` (also under the runtime's `css\js\`) | MZ `1.10.0` | 41–53 ms |
| RPG Maker MV | Flower in Us (Steam), 996IR, HELLO, HELLO WORLD! (itch) | `www/js/rpg_core.js` `v1.6.2`, `v1.6.2`, `v1.6.1` (HHW's one folder above its runtime) | MV `1.6.x` | 70–275 ms |
| RPG Maker VX Ace | City of Bones, Träumerei Chapter 2 (itch) | `Game.ini`: `Library=System\RGSS301.dll`; the DLL's version `3, 0, 1, 1` | VX Ace, RGSS `3.0.1` | 427–442 ms |
- **Detect time** is the whole detection of one entry — the install's walk, the rules and the second read — on the USB
drive; the second read itself is a version resource and at most a few kilobytes. It runs once per executable and rules
version, like Unreal's.
- ~~**Four of the itch installs front their runtime with a 213 MB .NET launcher**~~ **Four of the itch installs put a
213 MB .NET program in front of their runtime, and it is malware** *(corrected 2026-10-13, owner decision D57 — §20;
do not run it)* (HELLO, HELLO WORLD!, A Doll's Locket - Remake — whose launcher asks for administrator —, City of
Bones and Träumerei) — read as a launcher, the reason the import's choice of executable changed in the same train
(`05_DETECTION` §Library import, D56).
- **Not measured:** RPG Maker 2000/2003 (`RPG_RT.exe`; none installed, and no rule detects it), XP and VX (no install —
their RGSS1/RGSS2 libraries are read by the same rule as VX Ace's, unmeasured), a Unity build older than 2019 (its
player is the executable, with no `UnityPlayer.dll`), a Godot 3 export, and a Godot pack appended to the executable
(both installs ship the pack beside it; the trailer the reader follows is Godot's documented layout, tested on
synthetic files only).
## 18 · The Ren'Py version in an installed game *(2026-10-12, beta.20)*
The owner's one Ren'Py install, read-only: Bound Between Desks (Steam) — `BoundBetweenDesks.exe` (386,048 bytes, no version
resource), `BoundBetweenDesks.py`, `game\`, `lib\py3-windows-x86_64\` (Python 3.12: `libpython3.12.dll`,
`librenpython.dll`, `pythonw.exe`) and `renpy\` with the engine's `.py` sources beside `__pycache__\*.cpython-312.pyc`.
- `renpy\vc_version.py` (109 bytes, LF line ends): `branch = 'master'`, `nightly = False`, `official = True`,
`version = '8.5.0.25111603'`, `version_name = 'In Good Health'`.
- `renpy\__init__.py` imports those names from `vc_version` (else from `renpy.versions.get_version()`) and builds
`version_tuple` from `version.split(".")`; `renpy.version` is `"Ren'Py " + version_only`.
- The game's own `log.txt` (written at its last start, 2026-09-16) begins `Ren'Py 8.5.0.25111603`: the same number.
Then through the shipped pipeline (`StaticGameDetector` over `GameFileProbe`, rules `2026.10.3`): `renpy 8.5.0
renpy_vc_version` in 79 ms; Dialoop (`unity 6000.3.3f1`), Plethora of Bullets 2 (`godot 4.2.2`), A Doll's Locket - Remake
(`rpgmaker_mv 1.10.0`) and City of Bones (`rpgmaker_rgss 3.0.1`) read as in §17.
- **Not measured:** an older Ren'Py (no other install), whose `vc_version.py` may name no `version` — it then reads as
not found; a build that ships the engine compiled only (none seen).
## 19 · Anti-cheat beside the executable — Wuthering Waves *(2026-10-13, beta.21, owner decision D58)*
The owner's report: FrameLedger found no anti-cheat in `D:\SteamLibrary\steamapps\common\Wuthering Waves` (Steam
`3513350`, Unreal Engine 4.26.2). Read-only, on the owner's disk and in the Agent's own log.
**The layout.** The install root holds the launcher `Wuthering Waves.exe` (483,768 bytes), `Client\`, `Engine\` and
`ClearThirdParty.exe`; the library entry is the shipping binary `Client\Binaries\Win64\Client-Win64-Shipping.exe`
(169,213,960 bytes). Beside it, `Client\Binaries\Win64\AntiCheatExpert\` holds Tencent's ACE: `ACE-BASE.sys`
(4,125,432), `ACE-CORE.sys` (3,923,120) with `ACE-CORE.sys2`, `.sysa` and `.sysa2`, `ACE-Base64.dll` (69,736,848),
`ACE-Service64.exe`, `ACE-Setup64.exe`, `ACE-Base.dat` and `pld.dat`. The folder is **four levels** under the root;
entries per level under the root: 6, 10, 31, 276, 109, 136 (levels 1–6). Neverness To Everness keeps a second
`AntiCheatExpert\` beside its `HTGame.exe`, at `Client\WindowsNoEditor\HT\Binaries\Win64\` — **six** levels down.
**Why it read clean.** Check 4 walked the install root only (since 2026-09-25), three levels deep, and a folder at the
last level is named and never opened, silently: the walk listed `Win64` and reported a complete, clean tree. The rules
already named the folder (`directories`: `AntiCheatExpert`); the walk never handed the name to the matcher.
**What it cost, from the Agent's log.** Added by import 2026-10-11 19:50:19 → `prescan: scanned 2 — anti-cheat 1, clean 1`
(the anti-cheat was NTE's `PGameProtectDriver_X64.sys`, three levels down); re-scanned after the game's update at
21:22:14, clean; re-added 2026-10-13 18:30:44, clean. With hooking turned on, the session of 2026-10-12 started at
21:10:20 found nothing — ACE's driver not yet loaded, its services stopped — and was injected; at 21:10:57 the 30 s
re-scan met `ACE-BASE.sys` (written to `System32\drivers` at 21:10 by the game's ACE setup) and unhooked:
`SafetyUnhook; Saved (tier 1, exit=UnhookedSafety, frames=0); guard=BlockedDriver/Anti-Cheat Expert`. A driver is a
machine-wide finding, which refuses the session and turns nothing off, so the game's hooking stayed on. Registered on
the machine afterwards: the kernel service `ACE-BASE` (demand start) and the user-mode `AntiCheatExpert Protection`.
**The options, measured across the owner's 83 Steam installs** (read-only listings):
| Option | Cost | Newly finds | Verdict |
|---|---|---|---|
| Walk the executable's own folder too | ≤ 103 entries (NTE), 95 for Wuthering Waves | exactly the two `AntiCheatExpert\` folders above | **taken** |
| Depth 3 → 4 | one constant; peak 1,627 entries (Half-Life 2) | Wuthering Waves' folder name only — NTE's is six levels down, and the folder's files stay out of reach | rejected |
| Depth 5 or more | over 4096 entries for Yu-Gi-Oh! Master Duel (41,251), Yasha (12,215), GIRLS' FRONTLINE 2 (9,969) | — | rejected: those games would read *could not verify* and be refused at session start, GF2 under its D33 exception included |
| Make the depth cap refuse | — | — | rejected: it would refuse nearly every game |
**Taken (rules `2026.10.4`):** check 4 walks the install root, then the executable's folder when it lives below the
root (`ScanGameFolders`, `fl_prescan.cpp`), each with its own 4096-entry budget; the five `ACE-*` names join the
`files` group, `ACE-CORE.sys` the `drivers` group, `ACE-BASE` the `services` group and `ACE-Base64.dll` a `modules`
row of its own (so an injected Overlay stops itself if it loads); and Wuthering Waves' Steam id is on the title list.
The version bump is what makes every game's pre-scan run again: the sweep re-scans only when the rules version or the
executable changes.
- **Not measured:** that the game loads `ACE-Base64.dll` (no session has run since), and whether ACE's other titles
keep the same layout.
## 20 · The launcher in front of four itch installs is malware *(2026-10-13, beta.21, owner decision D57)*
§17 read the 213 MB program four itch.io downloads put in front of their RPG Maker game as a *launcher*, and the
documentation built on that reading (D28, D56's rationale, HANDOFF item 15(a), which told the owner to run A Doll's
Locket's with the agent as administrator). Read on 2026-10-13 without running anything — file listings, the itch
receipt, version resources, the .NET metadata strings and the files beside it — it is not a launcher. **It is malware.
Do not run it.**
| Download (itch) | The program | SHA-256 | Beside it |
|---|---|---|---|
| HELLO, HELLO WORLD! (5015466) | `HELLOHELLOWORLD.exe`, 213,572,096 bytes | `053553514C3E34865393654477631DEFB50B36509F44B8ADC5B1E555E1F64FD1` | `locales\ml.reg`, `locales\ko.xml` |
| A Doll's Locket - Remake (5085165) | `DollsLocket.exe`, 213,745,664 bytes | `51D3271AD0FFAF3652DAB9F66C1279CB2CA16F46A6AB2E5173D032600C1E5E53` | `data\Items.reg`, `data\Armors.xml` |
| City of Bones | `CityofBones.exe`, 213,557,760 bytes | `CA81BE260941E7BE2D87FE6852E7DAD0D432A84F071C2C578A7BD06BE7E61248` | `System\Windowskin.reg`, `System\RGSS301.xml` |
| Träumerei Chapter 2 | `TräumereiChapter2.exe`, 213,559,808 bytes | `65D4CCB7065227A0ED08D8977CA2F00F1E2A6DDC5F375C2C32E115D90DE29E4D` | `System\Game.reg`, `System\RGSS301.xml` |
- **The four programs are one .NET program**, unsigned, its version resource Visual Studio's template named after each
game (`HELLOHELLOWORLD`, version 1.0.0.7, "Copyright © 2026"), and nearly all of its size embedded resources.
- **Beside each, two files named like the game's own.** A 3,060-byte Windows registry file — byte-identical in all four —
that sets `AmsiEnable = 0` under `HKCU` and `HKLM\SOFTWARE\Microsoft\Windows Script\Settings` (it switches off
Windows' script scanning), and under `HKLM\SOFTWARE\Policies\Microsoft\Windows Defender` adds exclusions for the `.exe`
and `.msi` extensions and for `powershell.exe`, `rundll32.exe`, `msiexec.exe` and `regasm.exe`, and sets
`SpynetReporting = 0` and `SubmitSamplesConsent = 2` (no cloud protection, no samples sent). And a 3,216-byte `.xml`
that is no XML: high-entropy bytes, a different blob in each download.
- **What the program's own metadata names** (type and member names, read as strings): checks for virtual machines
(VMware, VirtualBox, QEMU, Hyper-V, Xen, KVM, Bochs, Parallels — through WMI, the registry and the firmware) and for
debuggers (`IsDebuggerPresent`, `CheckRemoteDebuggerPresent`, `NtQueryInformationProcess` on the debug port, object and
flags, hardware breakpoints, debugger windows); AES decryption of Base64 text; PowerShell run inside the process
(`CreateRunspace`, `AddScript`); registry writes; steps named `RunPayload` and `PayloadStep`; and the game it starts
afterwards — the RPG Maker runtime beside it (`swiftshader\Game.exe`, `css\Game.exe`, `Game.exe` with
`RGSS301.dll`), which is what makes it look like the game.
- **Where it sits in each download:** the itch receipt of HELLO, HELLO WORLD! lists the program, the runtime in
`swiftshader\` and both disguised files as what the download installed; nothing was added afterwards.
**What changes in FrameLedger (D57): the documentation, not the import.** The import still takes a store's own pick when
it is not a helper (beta.19) — FrameLedger reads a game's files to find its engine and anti-cheat, never to judge
whether it is safe, and a store's verdict stays the store's. What is corrected in place: §17's bullet, `05_DETECTION`
§Library import (D56's rationale and its admin-mode sentence), HANDOFF D28, D56 and item 15(a), the beta.19 CHANGELOG
entry, and the HELLO, HELLO WORLD! row of `LIST_GAME_TESTED.md`; `LIMITATIONS.md` says FrameLedger does not tell a safe
game from an unsafe one.
- **Not measured, and not to be:** what the payload does. Nothing here was run, decrypted or uploaded anywhere.
## 21 · Opening pages and switching tabs in the App *(2026-10-14, beta.23)*
The owner asked whether switching pages and tabs is slow. Measured with a harness over the App's own pages and view
models — not committed: it times, and a timing assertion in CI is a flake — on the dev PC (i7-14700KF, RTX 5080, Windows
11 29648), Release build, each page shown in WPF UI's `NavigationViewContentPresenter` in a real, off-screen window. The
ledger is a scratch one shaped like the owner's (its counts read from the owner's ledger without writing to it): 48 games, one with 100 sessions (NFR-4's
"opening a game with 100 sessions ≤ 500 ms"), one with a 2,000,000-frame session (the owner's longest: WALTO, 2,057,022
frames, with noisy frame times so a sort is a real sort). **Freeze** is the longest stretch the UI thread did not answer
(a probe re-posted at idle priority); median of 10 runs, 5 for the selection; *before* is two runs of `main` (2982679).
**The decision table, written before the first run:** fix what keeps the UI thread busy 50 ms or more, what can block
on I/O, and what grows with each visit; record the rest.
| What | Freeze before | Freeze after | Why it was slow |
|---|---|---|---|
| Open a game with 100 sessions | 1,175–1,507 ms | 369 ms | the Sessions grid inside the page's scroller had no height limit and built every row: 100 rows of 17 columns |
| Choose the 2,000,000-frame session | 843–1,016 ms | 17 ms | the blob read, its decode and the stutter detection ran on the UI thread (Microsoft.Data.Sqlite's async is synchronous), then three sorts of every frame for the Distribution tab (its histogram, its percentile curve, the curve's lows) and two walks for the Frametime chart — for tabs not even shown. The series is ready 0.85 s after the click either way; the window answers meanwhile now |
| A session ends after 20 visits to the Dashboard | 46–60 ms, **20 notices** | 18 ms, 1 notice | every Dashboard ever opened stayed alive (a transient `IDisposable` the root container keeps) and subscribed: each reloaded its lists and raised FR-3.8's notice |
| Open the library (48 games) | 265–404 ms | 275 ms | not fixed — below |
| Open a game with 9 sessions | 148–203 ms | 210 ms | building ≈ 1,750 visuals, the grid's 9 rows ≈ 130 each |
| Open Compare | 66–82 ms | 87 ms | building its visuals |
| Open Settings | 75–99 ms | 85 ms | building its visuals |
| Open the Dashboard | 48–61 ms | 46 ms | — |
| Open Logs | 16–23 ms | 23 ms | — |
| Switch a game page's tab (Frametime, Distribution, Trend, Sensors, Latency, back) | 1–25 ms | 1–24 ms | already cheap: a hidden tab is not in the visual tree, and its plot renders once when shown |
Also changed, and held by tests rather than by these numbers: the game page asks whether its executable is on disk off
the UI thread (a USB drive that sleeps answered on it — 39 of the owner's 41 Steam games are on one); the Logs page's
two-second tick reads nothing when the newest file has not changed (it re-read up to 2 MB and replaced the whole text);
Play reads the stores' records on the thread pool (every press listed Steam's manifests and copied itch's database on
the UI thread); the game page no longer summarises every game's sessions to show one.
**Above the bar, and not fixed.** A page that builds 600–2,500 visuals costs 85–370 ms whatever it reads — about 0.1 ms a
visual on this PC — and the remaining cost of the game page is its grid's rows (≈ 130 visuals each). The library is the
one that grows with the data: 275 ms at 48 games, about 5.7 ms a card, so about 0.6 s at 100. Its grid is a
non-virtualizing panel by decision (beta.11, `Controls/UniformWrapPanel`: cards an equal share of the width, each row as
tall as its tallest card); a virtualizing one builds only the cards on screen but makes every card one height and the
grid scroll under a fixed header — a change to how the page looks, offered to the owner instead of made here. Nor was a
schema migration added for an index on `sessions.started_at` (the Dashboard sorts the table): at the owner's 41 sessions
it costs nothing measurable, and a new schema version locks the ledger out of every earlier build.
+49
View File
@@ -0,0 +1,49 @@
# Install and first start
## What you need
- **Windows 10 (22H2) or Windows 11, 64-bit.**
- Games FrameLedger can measure: **64-bit DirectX 11, DirectX 12 and OpenGL games.** Other games — 32-bit games,
DirectX 9 games, and Vulkan games you start yourself — are still recorded (how long you played, your PC's sensors,
the game's memory use), but not measured. [Limitations](../LIMITATIONS.md) has the full list.
## Download and install
1. Download `FrameLedger.App-win-Setup.exe` from the project's
[Releases page](https://github.com/poli0981/frameledger/releases) on GitHub.
2. **Check the file.** Each release publishes SHA-256 checksums in `SHA256SUMS.txt`. In PowerShell:
`Get-FileHash .\FrameLedger.App-win-Setup.exe` — the result must match the line for that file.
3. Run it. FrameLedger is free software and is **not code-signed**, so Windows SmartScreen may warn about an unknown
publisher. Once the checksum matches, choose **More info ▸ Run anyway**.
FrameLedger installs into `%LOCALAPPDATA%\FrameLedger.App` and needs no administrator rights. Your recordings are kept
separately, in `%LOCALAPPDATA%\FrameLedger`.
## The first start
The first window walks you through four short steps:
1. **Before you start** — the documents. You accept three: the End User License Agreement, the Disclaimer and the
Privacy Policy. The GNU GPL v3 is shown too: it is your licence to FrameLedger and needs no acceptance. A short
summary sits above them, and [The terms, in plain words](terms-in-plain-words.md) explains them, but the documents
are the terms. Declining closes FrameLedger.
2. **The capture agent** — the background program that notices when one of your games starts and records it. It runs
as you, without administrator rights.
3. **What hooking means** — the difference between a game that is recorded and a game that is measured. Read
[Anti-cheat and safety](04-anti-cheat-and-safety.md) before you switch hooking on for any game.
4. **Your game library** — where to import it from. Nothing is measured until you choose to.
## Updates
A few seconds after it starts, FrameLedger asks GitHub whether a newer version exists. A new version downloads in the
background and is installed only when you restart FrameLedger — never while a game is being measured, and not while a
game it measured earlier is still running. You can switch the check off in **Settings ▸ Updates ▸ Check for updates at
startup**, and check by hand with Help ▸ Check for updates.
**Settings ▸ Updates ▸ Channel** is *Automatic* unless you choose: a test version (a pre-release, like every version so
far) looks for test versions, a release looks for releases. Choose *Stable* or *Beta* to decide yourself. Before
0.1.0-beta.14 the channel was *Stable* by default and found no version at all — on an older copy, choose *Beta* to update.
## Uninstall
Uninstall FrameLedger from Windows Settings ▸ Apps. It asks before it deletes your recordings folder.
+47
View File
@@ -0,0 +1,47 @@
# Record a game
## 1. Add the game
- **File ▸ Add game…** — pick the game's `.exe` file.
- **File ▸ Import library…** — FrameLedger lists the games installed through Steam, GOG, Epic and itch.io, and you
tick the ones to add.
Every game is added with **hooking off**.
## 2. Play
When a game in your library starts, the capture agent records a session by itself. While it runs, the **Dashboard**
shows it live. When the game closes, the session is saved and you get a notice. A session shorter than 30 seconds is
not kept.
## Recorded, or measured
A game in your library is always **recorded**: how long you played, your PC's sensors (GPU temperature, load and power;
CPU load; memory in use) and how much memory the game itself used — its video memory and its RAM, read from Windows
from outside the game.
To **measure** a game — frame rate and frame times, the real render resolution, the upscaler, frame generation, ray
tracing — FrameLedger has to load a small component into it. That is called **hooking**, and it is a choice you make
**one game at a time**: open the game's page (Games ▸ the game) and switch **Hooking** on. A warning explains the risk
first. **Read [Anti-cheat and safety](04-anti-cheat-and-safety.md) before you do.**
In the session list, **T1** marks a measured session and **T2** one that was only recorded; a recorded session says
why it was not measured.
## When FrameLedger will not measure a game
- **It found anti-cheat.** FrameLedger then turns hooking off for that game and says why on the game's page.
- **The game is 32-bit or uses DirectX 9.**
- **It is a Vulkan game** you started yourself.
- **The game runs as administrator.** Settings ▸ Capture agent ▸ *Run the agent as administrator* can help (off by
default; Windows asks every time the agent starts). Read its risk in [Limitations](../LIMITATIONS.md) first.
- **The game was already running when FrameLedger was updated** — restart the game once.
## Programs that are not games
Open the entry's page and switch **Recording** off: it is then ignored and nothing is recorded.
## Turning all hooking off
**Settings ▸ Capture ▸ Disable all hooking** stops every game from being hooked, whatever each game's own switch says. A
session that is running stops measuring within 30 seconds.
+63
View File
@@ -0,0 +1,63 @@
# Read your results
Open **Games ▸ a game ▸ Sessions**: one row per session. Double-click a row (or press **Open**) for the session's
summary. The Dashboard lists your most recent sessions too.
## N/A means "not measured"
A value FrameLedger could not measure reads **N/A** — never 0, and never an estimate. A session that was only recorded
(**T2**) has N/A for everything that needs hooking, and says why.
## Frame rate
- **When frame generation was measured**, the game's own frames and the frames you saw are shown together:
`62 → 118 FPS (×1.9 FG)`. If frame generation changed during the session (menus, loading screens, a settings change),
the figures are for the state that lasted longest, with the share of the session it covers: `(×1.9 FG · 75%)`.
- **When it could not be measured**, you see **Presented FPS** with a sentence saying whether generated frames could be
included in it. FrameLedger never shows a single number that may count generated frames as the game's own.
- **1% low** and **0.1% low** are the frame rate of the slowest 1% and 0.1% of frames: the further they fall below the
average, the less smooth the game felt. **Stutter** counts frames that took much longer than the frames around them,
and the share of time they took.
- **Time below 60 FPS** (with *below 30* and *display under* your monitor's refresh rate beneath it) is how much of the
session ran slower than that. A game held at its limit is not counted as dropping below it for the tiny wobble every
frame limit has. **Frame to frame** is how much one frame's time differs from the next: lower is smoother.
- **VSync** is how many frames asked to wait for the display, and *tearing allowed* how many did not mind tearing — what
the game asked; your graphics driver can still override it.
- **GPU clocks**, the fan and the video memory's temperature are the card's own readings. **GPU held back** says how much
of the time its power limit or its temperature slowed it down (NVIDIA cards only). **Frames per watt** is the game's
own frames per second for each watt the graphics card drew — generated frames never count.
## Memory
- **VRAM (this game)** is the game's own video memory — what Task Manager's Details tab calls *Dedicated GPU memory* for
the game's process. **RAM (this game)** is its *Memory (private working set)*. Both are read from Windows once a
second, from outside the game, whether or not the game was hooked.
- The **median** is the typical level during the session; the **peak** is the highest it reached.
- *VRAM, whole graphics card* and *RAM in use, whole PC* count everything else running too, so they are usually much higher.
- **Statistics per series**, at the bottom of the summary, lists the mean, median, minimum and peak of every sensor.
## Ray tracing
**Ray tracing**, **path tracing** and **ray reconstruction** read *Yes*, *No* or *N/A*. Ray tracing is measured on
DirectX 12 games; path tracing is never stated as a fact, because nothing in a game's calls says so. Click a chip to
correct it by hand — your correction is labelled as yours.
## Charts
- **Frametime** — how long each frame took. Spikes are stutters.
- **Distribution** — how often each frame rate occurred.
- **Render scale** — the share of the screen's resolution the game rendered at before upscaling (100% means no
upscaling), and when it changed.
- **Sensors** — temperatures, load and power; video memory; memory; and the card's clocks and fan, with the moments it
was held back shaded. The game's own line and the whole card's or the whole PC's are drawn separately.
- **Trend** (on the game's page) — one point per session over time, for example before and after a driver update.
Changes to your hardware or driver are marked on it.
- **Compare** (in the navigation on the left) — pick sessions, even of different games, and see them side by side.
To look closer, hold **Ctrl** and turn the mouse wheel over a chart to zoom, drag to pan, and double-click to reset. The
wheel alone scrolls the page.
## Export
The summary's **Export CSV**, **Export JSON** and **Export PNG** buttons — or File ▸ Export — save a session to a file.
Read [Your data](05-your-data.md) before you share one.
+45
View File
@@ -0,0 +1,45 @@
# Anti-cheat and safety
## The risk
To measure a game, FrameLedger loads a small component into it ("hooking"). **Anti-cheat systems can detect that and
may warn you, block you, or permanently ban your account** — and a ban can arrive days after the session. The developer
cannot reverse a ban, recover progress, or speak to a game's publisher for you.
**Use hooking for offline and single-player games.** Switching it on for a game with online or competitive play is
your decision and your risk.
## What FrameLedger does to keep the risk small
- **Hooking is off for every game** until you switch it on for that game, after a warning.
- **It looks for anti-cheat** before it hooks a game and every 30 seconds while it is hooked. If it finds any, it
refuses — or stops measuring at the next check — and turns hooking off for that game. **There is no switch that
overrides this**, apart from the one narrow exception below.
- **It never hides.** It keeps its real name and does nothing to avoid being seen by security software.
- **It never reads or changes the game's memory**, its saves or your input. It only observes the graphics calls the
game makes.
## What it cannot promise
- Its list of anti-cheat systems is its own and **can be incomplete**, and a game can add anti-cheat in an update.
- Anti-cheat that starts in the middle of a session can be there for **up to 30 seconds** — in the worst case 65 —
before FrameLedger stops.
- Some anti-tamper software (Denuvo, for example) can make a game **crash** when it is hooked, even offline.
## The one exception you can make
**Settings ▸ Capture ▸ User-mode exceptions** (off by default). For a game whose only finding is one anti-cheat that runs
entirely inside the game — no driver, nothing else found — you may allow hooking for that game after a separate warning.
Its first two hooked sessions are a trial: one that does not go well ends the exception for good. FrameLedger still runs
every check under it, and **a ban is still possible.** Kernel anti-cheat is never allowed.
## Turning everything off
**Settings ▸ Capture ▸ Disable all hooking** stops all hooking at once, whatever each game's own switch says.
## If FrameLedger missed a game's anti-cheat
Please open an issue with the **Safety gap** form on the project's GitHub page. That is treated as a safety bug, with
the same priority as a security report. A fix reaches you with the next version you install.
The full statement of the risk is the [Disclaimer](../legal/DISCLAIMER.md), §2 and §2A.
+53
View File
@@ -0,0 +1,53 @@
# Your data
## Where it is
Everything FrameLedger records stays on your PC, in `%LOCALAPPDATA%\FrameLedger` (Tools ▸ Open data folder): the
database with your library and sessions, the logs, and crash reports of FrameLedger itself. There is no account and
nothing is uploaded. The only network requests are the update check and the update download, both to GitHub
([Install and first start](01-install.md#updates)).
## What is in it
Your game library; your sessions — frame times when a game was measured, the statistics, your PC's sensors, the game's
own memory use, how the game's window was shown; a short description of your hardware for each session; your tags and
notes; your settings; and, in the `covers` folder, a copy of each picture you chose for a game. The pictures the Steam and
GOG GALAXY apps keep for your games are shown from where those apps keep them, never copied. The
[Privacy Policy](../legal/PRIVACY_POLICY.md) lists all of it.
## How much is kept
The per-frame data of the newest **20 sessions of each game** is kept; older sessions keep their statistics. Change it
in **Settings ▸ Recording ▸ Raw series kept per game** (0 keeps everything).
## Back it up
**Tools ▸ Database maintenance… ▸ Back up…** writes a consistent copy of the database to a file you choose, even while
a game is being recorded. The pictures you chose for games are not in it: copy the data folder's `covers` folder too.
Backing up is up to you — FrameLedger does not do it by itself.
## Delete it
- **A game's sessions:** Games ▸ the game ▸ Sessions ▸ **Delete all sessions…**
- **A game:** its page ▸ **Remove…** A game you uninstalled goes by itself when it has no sessions (Settings ▸ Data ▸
**Remove uninstalled games**, on unless you turn it off); one with sessions stays, with them, until you remove it.
- **Every session of every game:** Settings ▸ Data ▸ **Delete all sessions…**
- **Everything:** uninstall FrameLedger and let it delete the data folder, or delete the folder yourself.
## Share it — carefully
An exported **CSV** or **JSON** file, and a bug report, can contain:
- your games' names and **the paths to their files**, which include your **Windows user name** when a game is installed
in your user folder;
- your PC's processor, graphics card, driver and Windows version;
- your tags and notes.
Look at a file before you share it. **Help ▸ Report a bug…** builds the report on your PC, shows you every file in it,
and removes your user folder's path from the logs; you decide whether to attach it to an issue on GitHub. An export is
written as it is. Once you share a file, whoever receives it — and the site you post it to — can read it.
## Updating and going back
A new version upgrades the database in place. **An older version cannot open it afterwards** — there is no downgrade,
so keep a backup if you might want to go back.
+49
View File
@@ -0,0 +1,49 @@
# Questions and answers
## Why does my session say N/A everywhere?
The game was recorded, not measured (**T2**): hooking is off for it, FrameLedger found anti-cheat, or the game is one
FrameLedger cannot measure. The session's summary says which. See [Record a game](02-record-a-game.md).
## I switched hooking on, and the game is still not measured.
FrameLedger refuses a game where it finds anti-cheat, and cannot measure 32-bit games, DirectX 9 games, Vulkan games you
start yourself, or a game that runs as administrator (unless the agent does too). A game that was already running when
FrameLedger updated needs one restart. The game's page and the session's summary say what happened.
## Why "Presented FPS" and not the game's own frame rate?
Because frame generation could not be measured in that session. Presented FPS counts every frame the game handed to
Windows, and the sentence beside it says whether generated frames could be among them. FrameLedger never labels a
number that may include generated frames as the game's own.
## Why is the video memory different from my in-game overlay?
FrameLedger shows what Task Manager shows for the game's process: its *Dedicated GPU memory*. Overlays often show the
whole graphics card's use, which includes every other program, or the amount the game is allowed to use. FrameLedger
shows the whole card's figure too, separately.
## Why is the CPU temperature N/A?
Reading it needs *Run the agent as administrator* (Settings ▸ Capture agent) and the separately installed PawnIO
driver — and that reading has not been checked on real hardware yet. CPU load needs neither.
## Windows warned me when I installed FrameLedger.
FrameLedger is not code-signed, so SmartScreen does not know its publisher. Check the download against the published
SHA-256 checksum before you run it ([Install and first start](01-install.md)).
## Can I use FrameLedger with online games?
Recording works with any game. **Hooking** an online or competitive game risks your account — see
[Anti-cheat and safety](04-anti-cheat-and-safety.md).
## Something is wrong. How do I report it?
**Help ▸ Report a bug…** builds a report on your PC and opens the issue form on GitHub; you decide what to attach. If
FrameLedger missed a game's anti-cheat, use the **Safety gap** form instead.
## Where are the full documents?
**Help ▸ About ▸ Legal documents**, or Settings ▸ Legal ▸ Reopen the legal documents. What FrameLedger cannot do is in
[Limitations](../LIMITATIONS.md).
+129
View File
@@ -0,0 +1,129 @@
# The screens
What each part of FrameLedger shows and what each button does. What the numbers mean is in
[Read your results](03-read-your-results.md); every setting is in [Every setting](08-settings.md).
## The main window
**The badge at the top right** says how the capture agent is doing:
| Badge | Meaning |
|---|---|
| Agent connected | Everything works. |
| Connecting to agent… · Starting agent… | FrameLedger is reaching the agent, or starting it. Give it a few seconds. |
| Waiting for administrator permission… | *Run the agent as administrator* is on, and Windows is asking you. |
| Agent offline | The agent is installed but does not answer. FrameLedger keeps trying; **Retry** on the banner tries now. |
| Agent not installed | `FrameLedger.Agent.exe` is missing: install FrameLedger again. |
| Viewer — no Agent | You opened a copy of a data folder to look at ([When something goes wrong](09-troubleshooting.md#looking-at-a-copy-of-your-data)). |
**Banners** under the menus stay until you act on them: *Capture agent offline* with **Retry**; *Update* with **Restart to
update** (it waits while a game is being recorded); and the safety notices — a game's hooking refused, measurement
stopped, hooking turned off — each with one button that only says you have read it.
**The pages** are on the left: **Dashboard**, **Games**, **Compare**, **Logs**, and **Settings** at the bottom.
## The menus
| 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 and itch.io. |
| | **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. |
| **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)). |
| **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. |
## Dashboard
- **Live capture** — the game being recorded right now: its name, **T1** (measured) or **T2** (recorded only), and the
time so far. While it is measured: the frame rate, the resolution, the upscaler, frame generation, ray tracing, the GPU
and CPU temperatures and the game's memory. *Attached — waiting for the first frames…* means hooking worked and the
first frames are on their way.
- **Games tracked**, **Total playtime**, **Sessions this week**.
- **Capture agent** — *State*, *Agent version*, *Telemetry source* (which sensor readers work on this PC: `l1` is
Windows itself, `lhm` is LibreHardwareMonitor, `nvapi` is NVIDIA's own and only on NVIDIA cards), *Overlay build* (the
version of the component loaded into games), *Elevated* (whether the agent runs as administrator) and *Running
sessions*. Everything reads N/A until the agent answers.
- **Recent sessions** — the ten newest. Click one to open its summary.
## Games
- **Search games**; sort by **Name**, **Last played** or **Playtime**; **Show as a list** or **Show as a grid**.
- **Refresh** reads your library again: it offers games newly installed through a store, and marks a game whose `.exe`
is gone as *Not installed*. The agent removes such a game by itself after ten minutes when it has no sessions and its
drive is connected — never one where anti-cheat was found (**Settings ▸ Data ▸ Remove uninstalled games** turns this
off).
- **Add game…** — or drop `.exe` files onto the page.
- Each game shows its name, its store and engine, and one state: **Hooking on**, **Hooking off**, **Anti-cheat** (found,
so it is not hooked), **Exception** (a user-mode exception is in force) or **Not recorded**; then its sessions,
playtime and last play. Click it to open its page (in the list: double-click, or Enter). Its **Play** button (on the
card's corner; the list's first column) starts it as the game's page does.
## A game's page
- **At the top:** the game's picture — a banner and its cover, from the Steam or GOG GALAXY app on your PC or the image
you chose — in a band that takes the picture's colour; then the name, publisher, version, store and engine, the `.exe`
path, the last session, the last measured session's frame rate and its ray-tracing chips. A game with no picture shows
none (**Settings ▸ Games** turns the picture and its colour off). **Play** starts the game: through the store that
installed it, or directly — **Settings ▸ Games ▸ Play button** chooses. **Edit…** changes the name, publisher, version
and notes, and the picture: **Choose image…** (kept as a copy once you save) or **Use the store's image**. **Change
executable…** points the entry at another `.exe` and turns hooking back off; its file dialog opens in the game's own
folder. **Remove…** asks whether to keep the game's sessions.
- **Recording** — off, FrameLedger ignores the program completely: for a launcher or a tool that is not a game.
- **Hooking** — on, the game is measured. A warning comes first, and you type `I ACCEPT THE INJECTION RISK` to go on.
Read [Anti-cheat and safety](04-anti-cheat-and-safety.md) before you do.
- **Anti-cheat** — shown in its place when anti-cheat was found: what was found, and where. **User-mode exception**
appears when the game qualifies for the one exception.
- **Supports** and **Details** — what the game's own files contain, as far as FrameLedger can tell.
- **Tabs:** **Sessions** (every session: double-click a row or press **Open**; **Delete all sessions…** at the top),
**Frametime**, **Distribution**, **Trend** (one point per session for a figure you choose, with changes to your
hardware or driver marked), **Sensors**, and **Latency** when the game reported it.
## A session's summary
It opens from a session row, from the Dashboard, and from the notice when a session is saved.
- A warning at the top when the game crashed or measuring stopped early.
- The **Ray Tracing**, **Path Tracing** and **Ray Reconstruction** chips: click one to correct it by hand, for this
session or as the game's default. Your correction is labelled as yours.
- The figures, the charts and **Statistics per series** — [Read your results](03-read-your-results.md) explains each.
- **Tags and notes** with **Save**, and **Export CSV**, **Export JSON**, **Export PNG**.
## Compare
Tick **2 to 5 sessions**, from any of your games, and press **Compare**: one frame-rate curve per measured session, and
a table with the best value of each row in bold. Comparing a measured session with an unmeasured one asks first,
because they measured different things.
## Logs
What FrameLedger and its agent wrote down. Choose **App** or **Agent**, a level, and search; **Pause** stops the view from
following new lines. **Open logs folder**, and **Export bug bundle**, which does the same as Help ▸ Report a bug….
## Settings
Every switch and box is described in [Every setting](08-settings.md).
## The tray icon
The icon by the clock has **Open FrameLedger**, **Pause capture** / **Resume capture**, **Agent status** and **Exit**; a
click on it opens the window. **Pause capture** stops measuring the running sessions until you resume, and the paused
stretch is left out of their figures. While the window is hidden, a notice pops up when a session is saved or an update
is ready.
## Keyboard and mouse
- **Ctrl+1** … **Ctrl+5** open Dashboard, Games, Compare, Logs and Settings.
- **Alt** or **F10** moves to the menus.
- **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.
+84
View File
@@ -0,0 +1,84 @@
# Every setting
Settings is the last item on the left. Its sections follow, in the order it shows them. Settings marked *agent* are read
by the capture agent; unless the row says otherwise, a change applies from the next session.
## Capture
| Setting | What it does | Default |
|---|---|---|
| **Disable all hooking** | Nothing is loaded into any game, whatever each game's own switch says. A game being measured stops being measured at the next safety check, within 30 seconds. Sessions are still recorded. *Agent.* | Off |
| **Games with hooking on** | Shown while any game has hooking on: one **Turn off** per game. | — |
| **Hide hooking on anti-cheat games** | On, the page of a game where anti-cheat was found shows only what was found; off, it also shows the Hooking switch, greyed out. Such a game is never hooked either way. | On |
| **Allow hooking in games whose only anti-cheat runs in user mode** | Turns on the one narrow exception ([Anti-cheat and safety](04-anti-cheat-and-safety.md#the-one-exception-you-can-make)). The games that qualify are listed under it, each with **Make exception…** (after a warning) or **Withdraw**. *Agent.* | Off |
| **Vulkan layer** | The component that measures Vulkan games — but only a game FrameLedger starts itself: **Play** set to *Start directly* (Games, below) does; a Vulkan game started any other way is recorded, not measured. The agent registers and removes it by itself; **Register** and **Unregister** repair that, for your Windows user only. | — |
The link under them, *Read what the hook does and does not do*, opens the safety document on GitHub.
## Recording
| Setting | What it does | Default |
|---|---|---|
| **Minimum session length (s)** | A shorter session is not kept. 5 to 600 seconds. *Agent.* | 30 |
| **Sensor interval (ms)** | How often the PC's sensors are read during a session. 500 to 2000 ms. *Agent.* | 1000 |
| **Raw series kept per game** | How many of each game's newest sessions keep their per-frame data; older ones keep their statistics. 0 keeps everything. *Agent.* | 20 |
## Data
| Setting | What it does | Default |
|---|---|---|
| **Remove uninstalled games** | A game whose `.exe` has been gone for ten minutes is removed from your library — only when it has no sessions, its drive is connected and the folder it was installed in is still there (an unplugged drive never counts), and never a game where anti-cheat was found. Off, it stays and reads *Not installed*. *Agent*, within 15 seconds. | On |
| **Delete all sessions** | Deletes every session of every game, with its data and notes, after asking. Your library, your settings and each game's hooking choice stay. It cannot be undone, and it is refused while a game is being recorded. | — |
## Capture agent
| Setting | What it does | Default |
|---|---|---|
| **Run the agent as administrator** | Lets FrameLedger measure games that run as administrator, and read CPU temperature with PawnIO installed. Windows asks every time the agent starts, at logon too. A warning explains the risk first; read [Limitations](../LIMITATIONS.md#running-the-agent-as-administrator). The agent restarts to apply it, or at its next start if a game is being recorded. | Off |
| **Start the agent at logon** | **Register**, **Repair** or **Remove** a task that starts the agent when you log on, for your user only and without administrator rights. Without it, FrameLedger starts the agent when you open it. | Not installed |
## Appearance
| 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 |
## Games
| Setting | What it does | Default |
|---|---|---|
| **Show game artwork** | A game's page shows a picture of the game: the image you chose for it (**Edit…**), or else the cover and banner the Steam or GOG GALAXY app already keeps on your PC. Nothing is downloaded; a game from another store shows a picture only once you choose one. | On |
| **Colour the game page from its artwork** | The band at the top of a game's page takes the picture's main colour — never so strongly that a text on it gets hard to read. Off, the band keeps the plain card colour. | On |
| **Play button** | What **Play** does, on a game's page and on each game in the library. *Through the store*: Steam or the Epic Games Launcher starts the game, GOG GALAXY runs it, and the itch app asks which copy to launch — each store's app does what it does when you start a game from it. A game no store installed, and a GOG game without GOG GALAXY, is started by FrameLedger instead; so is every game while FrameLedger itself runs as administrator, so that the game does not. *Start directly*: FrameLedger's agent starts the game, recorded from its first frame, with your standard rights; it does not start a game whose recording is off, or one that asks to run as administrator. | Through the store |
## Window
| Setting | What it does | Default |
|---|---|---|
| **Start FrameLedger with Windows** | Opens FrameLedger when you log on, for your user only. | Off |
| **Minimize to tray on close** | Closing the window keeps FrameLedger running by the clock; quit with **Exit** in the tray's menu or the File menu. | Off |
| **Show FPS with two decimals** | Every frame rate with two decimals (62.40) instead of a whole number (62). Pages show it when they next open. | Off |
| **Hide scroll bars** | No scroll bars are drawn anywhere; the wheel, the keyboard and touch still scroll. Applies at once. | Off |
## Updates
| Setting | What it does | Default |
|---|---|---|
| **Channel** | *Automatic* follows your copy: a test version (a pre-release) looks for test versions, a release for releases. Or choose *Stable*, or *Beta* (releases and pre-releases). | Automatic |
| **Check for updates at startup** | One question to GitHub a few seconds after FrameLedger starts. A new version downloads in the background and installs only when you restart. | On |
## Logging
| Setting | What it does | Default |
|---|---|---|
| **Debug logging** | FrameLedger writes far more detail into its log, for a bug report. The agent keeps its own level. | Off |
## System
This PC as FrameLedger records it with every session: processor, graphics card and driver, memory, Windows build and
the main display. Nothing is sent anywhere. **Copy** puts the lines on the clipboard, for a bug report.
## Legal
**Reopen the legal documents** shows the documents you accepted, and the GPL, again. Nothing is accepted again.
+98
View File
@@ -0,0 +1,98 @@
# When something goes wrong
Find what you see, then what it means and what to do. Questions that are not problems are in
[Questions and answers](06-faq.md).
## The capture agent is not working
| You see | It means | Do this |
|---|---|---|
| **Connecting to agent…** or **Starting agent…** | FrameLedger is reaching its agent, or starting it. | Wait a few seconds. |
| **Agent offline**, and a banner: *The capture agent is not answering* | The agent is installed but does not answer. Your library, sessions and charts still work; only what is live does not. FrameLedger keeps trying. | **Retry** on the banner, or close FrameLedger and open it again. |
| **Agent not installed** | `FrameLedger.Agent.exe` is missing from FrameLedger's folder. | Install FrameLedger again from the [Releases page](https://github.com/poli0981/frameledger/releases). |
| **Waiting for administrator permission…** | *Run the agent as administrator* is on, and Windows is asking. The prompt may be waiting on the taskbar. | Answer it — or switch the option off in Settings ▸ Capture agent. |
| Settings says *the administrator prompt was declined* | The agent runs with your normal rights. | Nothing, unless you need it ([Every setting](08-settings.md#capture-agent)). |
## A game was recorded but not measured
The session is **T2**, its frame figures read N/A, and its summary says why on the **Why:** line — go by that line.
While the game runs, a notice may say *hooking refused*.
| Why | Do this |
|---|---|
| Hooking was off for the game. | Switch **Hooking** on in the game's page, after reading [Anti-cheat and safety](04-anti-cheat-and-safety.md). |
| The game's file changed since hooking was switched on — an update, usually. | Switch hooking on again for it. |
| The game you added is its launcher. | Add the game's own `.exe` too: hooking a launcher does not reach the game it starts. |
| Anti-cheat was found in the game. | Nothing: FrameLedger will not hook it, and hooking stays off. The only exception is narrow ([Anti-cheat and safety](04-anti-cheat-and-safety.md#the-one-exception-you-can-make)). |
| An anti-cheat driver or service was running on the PC. It may belong to another game. | Close the program it belongs to: the next session is measured again. |
| Anti-cheat appeared while the game was running. | Nothing: measuring stopped, and the summary says *Measurement stopped early*. |
| FrameLedger could not check the game's files. | It checks again by itself; Tools ▸ Update detection rules checks now. |
| The game runs as administrator. | Settings ▸ Capture agent ▸ *Run the agent as administrator* — read its risk in [Limitations](../LIMITATIONS.md#running-the-agent-as-administrator) first. A game protected by an anti-cheat driver cannot be measured either way. |
| The game is 32-bit, uses DirectX 9, or uses Vulkan. | Nothing: these are recorded, not measured ([Limitations](../LIMITATIONS.md#games-it-will-not-measure)). |
| **Disable all hooking** is on. | Switch it off in Settings ▸ Capture. |
| The game was already running when FrameLedger was updated. | Close the game and start it again. |
| Hooking was switched off after the game crashed twice soon after it started. | Switch it on again in the game's page if the cause may be gone — after a driver update, for example. |
| The game's file is gone. | If only its drive letter changed, FrameLedger follows it within about 15 seconds; otherwise **Change executable…** on the game's page. |
| The component could not be loaded into the game. | [Report a problem](#report-a-problem). |
## Some numbers read N/A
- **Everything** reads N/A: the session was not measured — see above.
- **1% low** needs 1,000 of the game's own frames, and **0.1% low** 10,000: a shorter session reads N/A for them.
- **VSync** reads N/A for OpenGL games.
- **VRAM (this game)** reads N/A for the game's first second.
- **GPU sensors** on AMD and Intel cards have not been tested, and **GPU held back** is read on NVIDIA cards only.
- **A session's charts are gone**: its per-frame data was removed under *Raw series kept per game*
([Every setting](08-settings.md#recording)); its statistics stay.
- **Presented FPS** instead of the game's own frame rate, **video memory** that differs from an in-game overlay, and
**CPU temperature**: see [Questions and answers](06-faq.md).
## A session says the game crashed
*How it ended*, on the session's summary:
| It says | It means |
|---|---|
| ended normally | The game closed by itself. |
| ended with exit code 1 | What *End task* or `taskkill` leaves behind: not a crash. |
| crashed (0xC0000005 …) | The game ended with an error code. *0xC0000006* often points at a failing drive. |
| crashed (Windows logged an application error) | Windows recorded the game's crash. |
| crashed (the game started its crash reporter, …) | The game's own crash reporter started while it was ending. |
| interrupted | The agent itself stopped during the session; the session was rebuilt when the agent next started. |
More in [Limitations](../LIMITATIONS.md#when-a-game-crashed). If FrameLedger itself stops, it says *FrameLedger stopped
unexpectedly* and offers to report it.
## An update does not install
- *A session is running, so it is applied only after the session ends* — restart FrameLedger once the game has closed.
- *… is still loaded in a game FrameLedger measured* — close that game, then **Restart to update**.
- *Try again in about an hour* — GitHub limits how often it is asked. *Offline* — no connection.
- A download that fails its check twice: [report a problem](#report-a-problem).
- Windows warns about the installer: see [Install and first start](01-install.md#download-and-install).
## The database
Everything is in one file, the ledger. **Tools ▸ Database maintenance…**:
- **Check** reads the whole file. If it finds a problem, **Back up…** first, then [report a problem](#report-a-problem).
- **Back up…** writes a consistent copy wherever you choose, even while a game is recorded.
- **Sweep…** removes old per-frame data, as *Raw series kept per game* does; it needs the agent running.
- **Compact** gives freed space back to the disk; it waits until no game is being recorded.
- *The ledger was busy* — try again in a moment.
## Looking at a copy of your data
`FrameLedger.exe --data-dir <folder>` opens a **copy** of a data folder to look at — one sent with a bug report, for
example. The badge reads **Viewer — no Agent**: nothing is recorded and nothing on this PC is changed. It refuses your own
data folder.
## Report a problem
- **Help ▸ Report a bug…** (or Logs ▸ Export bug bundle) saves a zip on your PC with FrameLedger's logs, a description of
your PC and your settings — and, if you tick them, FrameLedger's last crash dump and the last session without its
frames, notes or tags. Your Windows user name is removed from the paths in the logs; the crash dump is not cleaned.
You see every file, then the issue form opens on GitHub, and you add the zip yourself: FrameLedger sends nothing.
- The logs are in `%LOCALAPPDATA%\FrameLedger\logs` (Logs ▸ Open logs folder).
- If FrameLedger missed a game's anti-cheat, use the **Safety gap** form instead
([Anti-cheat and safety](04-anti-cheat-and-safety.md#if-frameledger-missed-a-games-anti-cheat)).
+60
View File
@@ -0,0 +1,60 @@
# Words FrameLedger uses
What the words on FrameLedger's screens mean, in alphabetical order. How each figure is computed is in the developers'
[metrics document](../docs/03_METRICS.md).
- **0.1% low, 1% low** — the frame rate of the game's slowest 0.1% and 1% of frames. The further they fall below the
average, the less smooth the game felt. They need 10,000 and 1,000 of the game's own frames.
- **Agent** (the capture agent) — the program FrameLedger runs in the background, with your normal rights, that notices
a game starting and records it.
- **Anti-cheat finding** — what FrameLedger's anti-cheat check found for a game: a component loaded into it, a file or
folder of it, or the game itself on a list. A game with a finding is not hooked ([Anti-cheat and
safety](04-anti-cheat-and-safety.md)).
- **Bug bundle** — the zip **Help ▸ Report a bug…** writes on your PC. Nothing is sent by FrameLedger.
- **Compare** — two to five sessions side by side, from any of your games.
- **Disable all hooking** — the switch that stops every game from being hooked at once, whatever each game's own switch
says. Sessions are still recorded.
- **Displayed FPS** — the frames you saw, generated frames included.
- **FG factor** — Displayed FPS divided by Native FPS, shown as `×1.9 FG`.
- **FPS** — frames per second over the time measured.
- **Frame generation** — the technology (DLSS Frame Generation, FSR Frame Generation) that inserts frames the game did
not render itself.
- **Frame time** — how long one frame took, in milliseconds.
- **Frame to frame** — how much one frame's time differs from the next. Lower is smoother.
- **Frames per watt** — the game's own frames per second for each watt the graphics card drew.
- **GPU held back** — how much of the time the card's power limit or its temperature slowed it down. NVIDIA cards only.
- **Hooking** — loading FrameLedger's small component into a game to measure it. Off for every game until you switch
it on for that game.
- **Ledger** — the one database file that holds your library and sessions, `%LOCALAPPDATA%\FrameLedger\ledger.db`.
- **N/A** — not measured. Never 0, and never an estimate.
- **Native FPS** — the frames the game rendered itself.
- **Overlay build** — the version of the component that hooking loads into a game. It draws nothing on your screen.
- **Override** — your own Yes, No or N/A for a ray-tracing chip. The measured value is kept, and yours is marked as
yours.
- **Presented FPS** — every frame the game handed to Windows, shown when frame generation could not be measured, with a
note saying whether generated frames could be among them.
- **RAM (this game)** — the game's own memory, what Task Manager's Details tab shows as its private working set.
- **Ray tracing, Path tracing, Ray reconstruction** — read *Yes*, *No* or *N/A*. Ray tracing is measured on DirectX 12
games; path tracing is never stated as a fact.
- **Render scale** — the share of the screen's resolution the game drew at before upscaling. 100% means no upscaling.
- **Session** — one run of a game, from its start to its end. A session shorter than 30 seconds is not kept.
- **Steady state** — when frame generation changed during a session (menus, loading screens, a settings change), the
figures are for the state that lasted longest, with the share of the session it covers: `×1.9 FG · 75%`.
- **Stutter** — frames that took more than twice as long as the frames around them, counted, with the share of time
they took.
- **T1** — a measured session. **T2** — a session that was only recorded: how long you played, your PC's sensors and
the game's memory, with every frame figure N/A.
- **Tags and notes** — what you write on a session's summary.
- **Telemetry source** — which sensor readers work on this PC: `l1` is Windows itself, `lhm` is LibreHardwareMonitor,
`nvapi` is NVIDIA's own.
- **Time below 60 FPS** — how much of the session ran slower than 60 frames per second (and *below 30*, and *below your
display's refresh rate*), not counting the tiny wobble of a game held at its frame limit.
- **Trend** — one point per measured session over time, on a game's page.
- **Upscaler** — the technology that draws the game at a lower resolution and scales it up (DLSS, FSR).
- **User-mode exception** — the one way to hook a game where anti-cheat was found: only an anti-cheat that runs entirely
inside the game, one game at a time, after a warning. Its first two sessions are a trial.
- **Viewer** — FrameLedger opened over a copy of a data folder: no agent, nothing recorded, nothing changed.
- **VRAM (this game)** — the game's own video memory, what Task Manager shows as its *Dedicated GPU memory*.
- **VSync** — how many frames asked to wait for the display; *tearing allowed*, how many did not mind tearing. It is
what the game asked: your graphics driver can override it.
- **Vulkan layer** — the component that measures Vulkan games, used only when FrameLedger starts a game itself.
+28
View File
@@ -0,0 +1,28 @@
# FrameLedger user guide
FrameLedger records how your games run on this PC — frame rate, frame times, the settings a game is really rendering
with, temperatures, and how much memory the game uses — and keeps every session so you can compare them later.
Everything stays on your PC.
Each page below takes a minute or two to read. The first six are the guide; the next four are there to look things up.
1. [Install and first start](01-install.md)
2. [Record a game](02-record-a-game.md)
3. [Read your results](03-read-your-results.md)
4. [Anti-cheat and safety](04-anti-cheat-and-safety.md) — read this before you switch hooking on for any game
5. [Your data](05-your-data.md)
6. [Questions and answers](06-faq.md)
7. [The screens](07-screens.md) — what each page, menu and button does
8. [Every setting](08-settings.md)
9. [When something goes wrong](09-troubleshooting.md)
10. [Words FrameLedger uses](10-glossary.md)
11. [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).
**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.
This guide is part of FrameLedger and describes the version it came with. It is also in the project's repository on
GitHub, in the `guide` folder, and on the project's wiki, which shows the newest release.
+43
View File
@@ -0,0 +1,43 @@
# The terms, in plain words
This page sums up the documents FrameLedger shows you. **It is a summary, not the terms:** the documents themselves
are the terms, and where this page and a document differ, the document is right. They are all under **Help ▸ About ▸
Legal documents**.
## End User License Agreement — you accept it
- FrameLedger is **free software** under the GNU GPL v3 (below), and nothing in the agreement takes any of that away.
- It records performance data **on your PC**.
- It hooks a game **only if you switch that on for that game**, after a warning. If anti-cheat bans your account for
it, **that risk is yours**, and the developer cannot undo a ban.
- It is **beta** software, provided **without warranty**, and the developer is not liable for damage it causes — as
far as the law allows. Rights the law gives you as a consumer, which no agreement can take away, stay yours.
- Read it: [EULA](../legal/EULA.md).
## Disclaimer — you accept it
How FrameLedger measures, why that can be detected by anti-cheat, what its safety checks can and cannot catch, how
accurate its measurements are, that your PC must meet each game's own requirements, and what *Run the agent as
administrator* changes. Read it: [Disclaimer](../legal/DISCLAIMER.md).
## Privacy Policy — you accept it
Everything stays on your PC: no account, no telemetry, no analytics. The only network requests are the update check
and the update download, to GitHub, and the check can be switched off. It lists what FrameLedger can observe, and says
that sharing an export or a bug report is your decision. Read it: [Privacy Policy](../legal/PRIVACY_POLICY.md).
## GNU General Public License v3 — your licence, shown for information
It gives you the right to **use, study, share and change** FrameLedger. You do not have to accept it to use the
program. If you **give copies to others** — changed or not — you must pass on the same freedoms and offer the source
code. Read it: [GPL v3](../LICENSE).
## NOTICE — the copyright line and three extra terms
The copyright line, and three terms of the kinds the GPL's section 7 allows: keep the copyright line and the
attribution; a changed version must say it is changed and must not be called just "FrameLedger"; and the terms give no
rights to the FrameLedger name or logo. Read it: [NOTICE](../NOTICE).
## When the documents change
A new version of a document you accepted is shown to you again before FrameLedger continues.
+63 -16
View File
@@ -11,24 +11,29 @@
that changes what FrameLedger.Overlay or the capture host does; date the change.
HTML comments are not part of the block.
-->
> ⚠ **What FrameLedger actually measures today — 2026-09-15.** The software is pre-alpha and
> **unreleased**: no tagged build or installer has been published. The source holds the desktop app
> ⚠ **What FrameLedger actually measures today — 2026-10-13.** The software is a beta; its latest
> **pre-release is `0.1.0-beta.22`** (2026-10-13), an unsigned installer built from that tag with its
> checksums published beside it. 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, injects only into games you enabled and only past the safety guard, and
> game in the library runs (unless you switched its recording off), injects only into games you enabled
> and only past the safety guard, and
> stores sessions in a local database. What that path measures:
>
> - **Frame times and output resolution:** measured from the present call for Direct3D 11/12 and
> OpenGL titles FrameLedger injects into. Vulkan titles are measured only when FrameLedger itself
> starts the game with its Vulkan layer enabled, which today only the Agent's command-line launch
> does. A Vulkan title started any other way is not observed by the layer; FrameLedger injects its
> starts the game with its Vulkan layer enabled, which the Play button set to *Start directly* (since
> beta.21) and the Agent's command-line launch do. A Vulkan title started any other way is not
> observed by the layer; FrameLedger injects its
> Direct3D component into it instead, and what that records on a Vulkan title has not been
> verified. Direct3D 9 and every 32-bit title are not measured.
> - **Which upscaler is running:** measured from the API a Direct3D title calls — DLSS or NIS through
> NVIDIA Streamline (with Ray Reconstruction Yes/No), and FSR through AMD's shipped FidelityFX DLLs:
> named FSR 3 from the older DLLs, and FSR without a version from the newer ones, which host both
> FSR 3.1 and FSR 4. FSR 2, and FSR shipped any other way, is not identified. For DLSS titles that
> bypass Streamline, the NVIDIA driver's own per-process record is stored with the session, labelled
> *driver-reported*; the app does not display it yet. Intel XeSS is **not** read (its SDK licence
> bypass Streamline, the NVIDIA driver's own per-process record is stored with the session and shown
> as *DLSS (driver-reported)*. The NVIDIA driver's profile for the game — the DLSS and frame-generation
> overrides the NVIDIA App sets — is read, never changed, and shown as the driver's settings beside what
> was measured. Intel XeSS is **not** read (its SDK licence
> forbids it), and neither is an upscaler compiled into the game: those read `N/A`, or "Unknown
> upscaler" when another vendor's hook ran in the game. Vulkan and OpenGL titles read `N/A`.
> - **Quality preset:** not reported on any title measured. The one route this software may use — the
@@ -41,22 +46,64 @@
> - **Frame generation (Direct3D titles only):** the Displayed rate is counted from presents, plus the
> presents DXGI's own counter saw on the same swap chain that the hook did not; the Native rate from
> the vendor's own per-frame calls (NVIDIA Streamline, AMD FidelityFX) where the title makes them, and
> `N/A` where it does not. DLSS-G and FSR FG are named from the calls the game makes; any other
> generator (XeSS-FG, one compiled into the game) is shown only as active with the technology not
> identified, and is never named. Where a technology is named but its frames could not be counted, or
> frame generation is not measured, the software shows **Presented FPS** with a note on what it may
> include — never a Native figure.
> `N/A` where it does not. When frame generation did not stay in one state for the whole session
> (menus, loading screens, a settings change), no session-wide factor is shown: the factor, Native and
> Displayed are those of the state that held longest — five-second windows whose ratios agree within
> 10 %, covering at least 10 s and 10 % of the time the game was presenting — and are always shown with
> the share of the session they cover; with no such state, the reason is shown instead. DLSS-G and FSR
> FG are named from the calls the game makes; any other generator (XeSS-FG, one compiled into the game)
> is shown only as active with the technology not identified, and is never named. Where a technology is
> named but its frames could not be counted, or frame generation is not measured, the software shows
> **Presented FPS** with a note on what it may include — never a Native figure. Where generated frames
> were counted, the lows, median and stutter are taken over application frames only.
> - **Ray tracing:** Yes/No measured on Direct3D 12 from ray-dispatch and acceleration-structure-build
> calls; the technique and path tracing are `N/A`, and so is ray tracing on other APIs.
> - **Display mode:** how each game's window was shown — exclusive full-screen, borderless, windowed or
> minimised — as a share of the session, with the window's size and the monitor's, in every session.
> Exclusive full-screen is known only for Direct3D titles FrameLedger injects into, from the game's own
> swap chain; for every other session the window alone is read, and a window covering its monitor reads
> *full-screen or borderless*. What Windows does behind the game (fullscreen optimizations) is not visible.
> - **Engine version:** the exact Unreal Engine 4 or 5 version, read from the game's executable on disk and
> labelled with what it rests on; `N/A` where the executable names none. Since beta.19 also Unity's (from its
> player library or its data file — without the release letter where only the library's number is readable),
> Godot's (from its data pack) and RPG Maker's maker and version (MV and MZ from their core script; XP, VX and VX
> Ace by their runtime library's version, which is not the editor's). RPG Maker 2000/2003 is not detected. Since
> beta.20 also Ren'Py's (from its engine's version file). Other engines show what their own files state.
> - **The game's own memory (since beta.12):** its dedicated and shared GPU memory and its private
> working set — the numbers Task Manager's Details tab shows — with its working set and commit, read
> once a second from Windows' own counters, from outside the game, in every session: a game
> FrameLedger injects into through the handle it already holds, any other by opening it briefly with
> the least access Windows offers (and adding up every process running its executable). Shown with
> mean, median and peak. The game's other processes (launchers, helpers) are not counted.
> - **Video memory:** in use on the whole graphics card, recorded from Windows and GPU-driver telemetry
> and charted. **Not measured at all:** each game's own video-memory use and budget, which frame
> spikes were shader compilation, PC latency (Reflex), HDR, and CPU temperature. Stutter count and
> stutter time are measured from frame times.
> and charted. **Not measured at all:** the video-memory budget Windows gives a game, which frame
> spikes were shader compilation, PC latency (Reflex), and HDR. Stutter count and stutter time are
> measured from frame times.
> - **Pacing, VSync and the graphics card (since beta.14):** the share of the time below 30 FPS, below 60 FPS and below
> the monitor's refresh rate, measured from frame times with small margins so that a game held at its limit is not
> counted as below it (a rate less than 2 % under the line reads partly as at it), and how much one frame's time
> differs from the next; for Direct3D titles, how many frames asked to wait for the display and how many allowed
> tearing — what the game asked, not what the driver did; the graphics card's clock speeds, fan speed and memory
> temperature in every session, and, on NVIDIA cards only, how much of the time its power limit or its temperature held
> it back, read once a second; and frames per watt — the game's own frames per second for each watt the graphics card
> drew, never counting generated frames, `N/A` where the game's own frame rate is not known.
> - **Processor and memory:** how busy the processor was (time busy, all cores together — not the
> frequency-scaled figure Task Manager draws) and how much system memory was in use, read from
> Windows once a second and charted. Processor temperature is read only when the Agent runs as
> administrator — an option, off by default, for which Windows asks at every start of the Agent — with
> PawnIO installed, and that reading has not yet been checked on real hardware; everywhere else it is `N/A`.
> - **Safety:** every pre-injection check runs before injection, including the signed-by-a-known-vendor
> half of the suspicious-module rule. During every capture the Agent re-runs the checks every 30 s and
> stops capturing on a refusal: a Direct3D or OpenGL game's hooks are removed, and the Vulkan layer
> goes passthrough. A global switch in Settings turns all hooking off, and a running capture stops at
> its next check; it can only refuse, never permit. There is no override anywhere.
> its next check; it can only refuse, never permit. **There is no override.** A finding about a game — anti-cheat
> named in its process or in its folder (any kernel driver there counts), or the game on a title list by its
> store id or executable name — turns hooking off for that game, whether found by the Agent's own check of every
> game in the library, before injection, at a session's start or by the 30 s re-check; the game's page says so,
> and nothing turns it back on for that executable — except a user-mode exception you make yourself, per game,
> in Settings (off by default): only where the only finding is one anti-cheat that runs entirely in user mode, with
> no driver file in the game's folder. Its first two sessions are a trial, and one that does not go well ends it
> for good. The guard still runs every check under it and ends it on anything new; a ban remains possible.
>
> Where a value is not measured it reads `N/A`, with two exceptions: FPS then shows Presented FPS with a
> note on what it may include, and ray-tracing flags may show a value you set yourself, labelled as
+160 -47
View File
@@ -1,34 +1,24 @@
# FrameLedger — Disclaimer
**Version:** 2.1-draft · **Effective:** {{RELEASE_DATE}}
**Version:** 2.10 · **Effective:** {{RELEASE_DATE}}
> ⚠ Draft for review. Not legal advice. Review before first public release — this version covers code injection and should be read carefully.
## 0. This is pre-release (beta) software
> ⚠ **Accuracy audit — re-checked 2026-08-14, a FOURTH time, after PR #64. SIX statements below describe behaviour the software does not yet fully have**, and they are flagged here rather than quietly reworded because a document the user accepts must not over-promise.
>
> **A FIFTH time, 2026-09-06, and the mechanism changed rather than the count.** Every drift this block records came from the same cause: the sentence about what the software measures lived in three places and was re-read in none of them. It now lives in **one** — `legal/ACCURACY.md`, embedded verbatim in §4 below and in `README.md`, and `tools/accuracy-check.ps1` fails the build when a copy differs from the source (`20_OPEN_QUESTIONS` §S23-6). The bullets below are the history of the four drifts and are kept as history; the block in §4 is the current statement, dated.
>
> **A SIXTH time, 2026-09-15, and the drift ran the safe way again.** The block in §4 is re-dated and rewritten against the code: OpenGL is measured, the shipped Agent runs the in-session re-scan, the whole-card video memory is recorded, and the Vulkan, preset, FSR-version and frame-generation sentences say exactly what the code does. Two bullets below became false because the software caught up with them, and they are struck where they sit. Version 2.1-draft, so the first-run gate shows this document again.
>
> **The fourth drift is the first one that ran the other way, and that is the finding.** Every previous re-count found this document claiming *more* than the software did. #64 landed the upscaler identity hook and this block went on saying "there is no upscaler hook anywhere in the software" — an under-claim, in the one file whose failure mode everybody was watching for in the opposite direction. It went unnoticed for five days for exactly that reason: a reviewer checking whether `legal/` over-promises reads a sentence like that and moves on. **Re-reading this block means checking both directions.**
>
> **The re-count was overdue and this block's own rule is what says so.** The last line of this block requires whoever changes what `FrameLedger.Overlay` does to re-read it. #48 changed exactly that — the Overlay now drops `DXGI_PRESENT_TEST` presents without recording them — and this block was not re-read. That is the second time the rule has been broken since it was written, and both breaches were invisible from inside the PR that caused them.
>
> **Two additions this round, both about what the software claims to *measure*** — the class the project has already had to retract twice:
>
> **Two bullets changed substance and neither could be struck.** The capture side that *receives* a stop now exists and now runs whether or not the game is presenting; the side that would *send* one still does not. That is the pattern to watch for when re-counting: half a mechanism reads as a whole one, and the half that is missing is usually the one nobody was looking at.
>
> - ~~§1's *"what it observes: … presentation, upscaling, ray tracing, pipeline creation"* and §4's *"upscaling, frame-generation and ray-tracing state are read from the parameters the game passes to those APIs"* — **only the presentation path is intercepted.** There is no upscaler hook, no frame-generation hook, no ray-tracing hook and no pipeline hook anywhere in the software.~~ **FALSE SINCE #64, corrected 2026-08-14 — the fourth drift, and this one is the block's own subject.** An **upscaler hook exists**: one detour on `sl.interposer.dll!slEvaluateFeature`, module-scoped, reading one argument. It measures **which upscaler is running** (DLSS, NIS, or `unknown` — never "none") and, for Streamline titles, **whether Ray Reconstruction is active**, which is a `Yes`/`No` the software now publishes. What still does not exist: quality preset, render resolution, frame generation, ray tracing, pipeline. The capture side states all of that in its own data on every frame rather than defaulting to "none", so nothing false is *recorded*; what over-promised was this document, in the direction of under-claiming rather than over-claiming — which is the safer direction and is still wrong. Both sentences are qualified where they sit.
> - ~~§2's *"and every 30 seconds afterwards … it stops at the next scan"* — the pre-injection guard is real and refuses. The **receiving half is implemented**: an injected D3D title removes its hooks within one frame of the stop flag being set. The **sending half is still missing, and the missing part is narrower than this block used to say.** Both the write path (`ShmRingReader.PublishGuardResult`, which maps the shared memory and advances the field) and the read path exist in shipped code and are tested; what does not exist is a production caller that runs the loop between them. A missing loop, not a missing subsystem — and the user-facing consequence is identical: **no re-scan runs and no stop is ever sent.**~~ **FALSE SINCE 2026-09-10 (P2 PR-F), struck 2026-09-15:** the shipped Agent drives the loop — during every capture it re-runs the checks every 30 s and sends the stop on a refusal (`legal/ACCURACY.md`, embedded in §4).
> - §2's *"waits **65 seconds** before concluding that contact is lost"* — **the deadline now has a reader, and since 2026-08-05 it runs whether or not the game is presenting.** For one day it was evaluated only on a present, so a title that had hung or been alt-tabbed never reached it — the exact case the mechanism was specified for. A watchdog inside the injected component now checks once a second regardless. Two qualifications remain: for **Vulkan titles the check runs on each present rather than once a second** — the layer may not own a thread, so a Vulkan title that has stopped presenting is not stopped by the deadline (and presents nothing to be observed) — and **the 65-second value itself is not covered by a test** — the stop is proven to fire, but a suite that runs on every build cannot wait 65 seconds, so what is verified is the mechanism, not the number.
> - ~~§3's *"automatically stops injecting into a game that crashes shortly after injection twice"* — the only trace of this anywhere is a `hook_crash_count` column in a schema for which no `.sql` file exists. There is no design for it.~~ **BUILT 2026-09-10 (P2 PR-D), struck 2026-09-15:** two crashes of the same game within 60 s of injection disable hooking for that game, with the reason on its row (`CrashAutoDisablePolicy`).
> - §1's *"Only FrameLedger's own component is ever loaded"* — **narrower than it sounds, and the qualification is now in §1 itself.** The check is a directory test: the payload must resolve into FrameLedger's own install directory. It does not compare a filename, a version or any content, deliberately — a name check would be defeated by any DLL that borrowed the name. A published self-contained build puts several hundred files in that directory.
>
> **None of this may ship as-is.** Either the behaviour exists at first release or these sentences change. Tracked in `docs/20_OPEN_QUESTIONS.md`.
>
> **This block is maintained by hand and nothing verifies it.** Every other document here is bound to the code by something — `rules-validate` cross-checks the blocklist, `static_assert`s bind `fl_shm.h` to `07_IPC`, `versioninfo-check` and `chokepoint-check` bind claims to binaries. `legal/` is bound by nothing, and it has now gone stale **three times**: first within hours of being written, when the 65-second sentence was added directly beneath a header that said "Three"; then again when five PRs (#40–#44) changed the Overlay from a stub into a hooking, shared-memory-mapping, control-block-reading component and touched **no documentation at all**, leaving the second bullet above asserting four things about that binary that were each false. and a third time when #46–#52 landed — seven PRs, including one (#48) that changed what the Overlay does *inside a game* — with no edit here at all. None of the three drifts was visible from inside the PR that caused it. **Whoever edits any promise in this file must re-count — and whoever changes what `FrameLedger.Overlay` does must re-read this block, because nothing will remind them.**
>
> **That sentence has now failed twice, so it is being replaced by something that is not a sentence.** `ci.yml` fails a pull request that touches `src/` without touching `CHANGELOG.md`. That is a weaker gate than the ones binding every other document — it forces a *ledger* entry, not a re-read of *this* file — and it is written down as weaker rather than described as a fix. A gate over the claims in `legal/` would have to assert things about behaviour rather than about files, and nobody has designed one (`docs/20_OPEN_QUESTIONS.md` §S23-6).
**FrameLedger is a beta.** Every build published so far is a pre-release. It has been tested on a small number of
machines and games — the games are listed in `docs/LIST_GAME_TESTED.md` in the project's repository, and what the software
cannot do is listed in `LIMITATIONS.md` there and in the app under Help ▸ Limitations — and **it certainly still contains
bugs — some of them not yet known to anyone.** Features can
change or disappear between builds, recorded data can turn out to be wrong, and an update can require your data to be
migrated.
By installing or running a pre-release build you accept that:
- it may crash, hang, fail to record, or record wrongly, and may cause the game you are measuring to do the same;
- **the developer is not responsible for any incident, loss or damage that results**, including lost progress, corrupted
saves, lost recordings, wasted time, or anything else described in this document;
- no support, fix, or response time is promised. Reports are welcome and are read; nothing is owed in return.
If that is not acceptable to you, do not use a pre-release build.
## 1. How FrameLedger measures (read this first)
@@ -46,7 +36,9 @@ Be precise about what that does and does not promise, because the shorter versio
Install it somewhere only you can write to, and verify the published SHA-256 checksums.
**What it observes:** arguments the game passes to graphics APIs we intercept (presentation, upscaling, ray tracing, pipeline creation) and video-memory usage reported by the graphics runtime.
**What it observes inside the game:** arguments the game passes to graphics APIs we intercept (presentation, upscaling, ray tracing, pipeline creation).
**What it reads about the game from outside it, in every session:** the game process's own memory use — its dedicated and shared video memory and its working sets, the figures Windows' Task Manager shows — from Windows' performance counters and process-memory information. For a game it does not inject into, FrameLedger opens the game's process for this with the least access Windows offers, once a second, and closes it again; it reads nothing inside the process.
> **What of that list is observed today is stated once, in §4 below** (the block `legal/ACCURACY.md` carries, dated). The list here describes what the software is designed to observe, and the boundary — API arguments and nothing else — holds for all of it.
@@ -59,7 +51,7 @@ Install it somewhere only you can write to, and verify the published SHA-256 che
FrameLedger is designed to reduce that risk substantially:
- Injection is **off by default** and must be enabled by you **per game**.
- Before injecting, and every 30 seconds afterwards, FrameLedger scans for known anti-cheat and anti-tamper components. **If it finds one, it refuses to inject; if a session is already running, it stops at the next scan.** There is no setting to override this. Because the scan runs every 30 seconds rather than continuously, anti-cheat that loads mid-session may be present for **up to 30 seconds** before FrameLedger detects it and stops.
- Before injecting, and every 30 seconds afterwards, FrameLedger scans for known anti-cheat and anti-tamper components. **If it finds one, it refuses to inject; if a session is already running, it stops at the next scan.** No setting turns this off, globally or per game; the one exception you can make yourself, per game, still runs every check and is described in §2A. Because the scan runs every 30 seconds rather than continuously, anti-cheat that loads mid-session may be present for **up to 30 seconds** before FrameLedger detects it and stops.
**And there is a second, longer window you should know about.** The part of FrameLedger running inside the game also stops on its own if it loses contact with the part doing the scanning — because a scanner that has stopped cannot protect you. It waits **65 seconds** before concluding that contact is lost, so that one delayed scan on a busy machine does not end your session. In the worst case those windows combine: if the scanner stops at the moment anti-cheat appears, the component inside the game may keep running for up to **65 seconds** afterwards. That number is 65 and not 30, and this document says so rather than leaving the 30 above to imply it.
@@ -73,8 +65,8 @@ FrameLedger is designed to reduce that risk substantially:
the game exits.
- FrameLedger contains **no evasion techniques of any kind** — it does not hide, rename, obfuscate, or disguise itself. It is intended to be plainly identifiable to any security software that looks.
For completeness about what it *does* run inside the game: besides the intercepted calls themselves, the component starts **one background thread** that sleeps for a second at a time and checks whether it has been told to stop. It reads only FrameLedger's own shared memory. It does not scan the game, enumerate what the system has loaded, or query Windows services — deliberately, because software that does those things from inside a game process looks like the thing this tool is trying not to be mistaken for.
- FrameLedger injects into a game only after you enable that game individually. For every other game — and for any game where the safety checks refuse — it records the session's start, end and duration together with whatever hardware sensor readings your machine provides, and reports every other measurement as not available. **There is no measurement mode that works without injecting**; an earlier version of this document described one, and it was never built. FrameLedger never estimates a value it could not measure, and it always shows which of the two modes produced a session. Neither mode requires administrator rights.
For completeness about what it *does* run inside the game: besides the intercepted calls themselves, the component starts **one background thread**. It wakes once a second, or when the game loads a library, and then: checks FrameLedger's own shared memory for a request to stop and for the heartbeat of the safety scan described above; asks Windows, by name, whether the graphics, upscaling and frame-generation libraries it knows about are loaded, and puts its interception into the ones that are (for ray tracing it creates one command list on the game's own Direct3D 12 device, to find the functions to intercept); writes its counters to FrameLedger's shared memory; and writes FrameLedger's own log file. It does not scan the game's memory, list the modules or processes on the system, or query Windows services — deliberately, because software that does those things from inside a game process looks like the thing this tool is trying not to be mistaken for.
- FrameLedger injects into a game only after you enable that game individually. For every other game — and for any game where the safety checks refuse — it records the session's start, end and duration together with whatever hardware sensor readings your machine provides and the game's own memory use as Windows reports it (§1), and reports every other measurement as not available. **There is no measurement mode that works without injecting**; an earlier version of this document described one, and it was never built. FrameLedger never estimates a value it could not measure, and it always shows which of the two modes produced a session. Neither mode requires administrator rights.
**However, these protections cannot be complete:**
@@ -85,6 +77,33 @@ FrameLedger is designed to reduce that risk substantially:
**FrameLedger is intended for offline and single-player play. If you enable injection for a game with any online or competitive component, you do so entirely at your own risk and are solely responsible for the consequences, including compliance with that game's terms of service.**
## 2A. There is no way past the guard — and one narrow exception you can make yourself
Versions 0.1.0-beta.3 and 0.1.0-beta.4 offered a per-game switch to overrule the guard. **It has been removed.** If
FrameLedger finds anti-cheat or anti-tamper software in a game — before it injects, when a session starts, or during a
session — it refuses, turns hooking off for that game, and says so on the game's page. There is no setting, per game or
global, that overrules that. Sessions recorded under the earlier switch stay in your database, marked as such in their
notes.
**Since 0.1.0-beta.9 there is one exception, and it is not a way past the guard.** A Settings option, off unless you
turn it on, lets you make an exception — one game at a time, after a disclosure you must accept — for a game whose only
finding is a single anti-cheat that works entirely in user mode (no kernel driver, no service, and no driver file
anywhere in the game's folder) and that is on no list of titles FrameLedger refuses. Since 0.1.0-beta.11 the game does
not need to have been measured before: **the first two sessions under the exception are a trial**, and if one of them
does not go well — it crashes, records nothing, does not end normally, is stopped for safety, or something new is found
— the exception ends and can never be made again for that game. Under it the guard still runs every check, before
injecting and every 30 seconds, and still refuses anything else it finds; after the trial the exception ends by itself
when something new is found, when a session under it crashes or is stopped for safety, or when the game is updated, and
turning the option off suspends it. Sessions recorded under it are marked with the anti-cheat they ran beside. **Two
good sessions are not evidence that the anti-cheat did not notice** — a ban may still come later.
**It exists because users asked for it, and it carries exactly the risk this document describes.** That anti-cheat
may still detect FrameLedger in the game and warn, block or permanently ban your account — possibly days later — and
FrameLedger cannot know whether it did. Earlier sessions that went well are no promise about the next one. **Do not
use it with a game you play online or competitively unless you accept losing that account;** the developer cannot
reverse a ban.
## 3. Stability
Software running inside another process can, in principle, destabilize it. FrameLedger guards every intercepted call, disables itself automatically after repeated internal faults, and automatically stops injecting into a game that crashes shortly after injection twice. Despite this, the developer is not responsible for crashes, lost progress, corrupted saves, or any other loss arising from use of the software. **Save your game before benchmarking.**
@@ -94,24 +113,29 @@ Software running inside another process can, in principle, destabilize it. Frame
Frame timing is derived from high-resolution timestamps taken at the moment the game presents each frame; upscaling, frame-generation and ray-tracing state are read from the parameters the game passes to those APIs. This is substantially more accurate than inferring settings from files on disk, but **no measurement is guaranteed to be exact**:
<!-- accuracy-block:begin -->
> ⚠ **What FrameLedger actually measures today — 2026-09-15.** The software is pre-alpha and
> **unreleased**: no tagged build or installer has been published. The source holds the desktop app
> ⚠ **What FrameLedger actually measures today — 2026-10-13.** The software is a beta; its latest
> **pre-release is `0.1.0-beta.22`** (2026-10-13), an unsigned installer built from that tag with its
> checksums published beside it. 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, injects only into games you enabled and only past the safety guard, and
> game in the library runs (unless you switched its recording off), injects only into games you enabled
> and only past the safety guard, and
> stores sessions in a local database. What that path measures:
>
> - **Frame times and output resolution:** measured from the present call for Direct3D 11/12 and
> OpenGL titles FrameLedger injects into. Vulkan titles are measured only when FrameLedger itself
> starts the game with its Vulkan layer enabled, which today only the Agent's command-line launch
> does. A Vulkan title started any other way is not observed by the layer; FrameLedger injects its
> starts the game with its Vulkan layer enabled, which the Play button set to *Start directly* (since
> beta.21) and the Agent's command-line launch do. A Vulkan title started any other way is not
> observed by the layer; FrameLedger injects its
> Direct3D component into it instead, and what that records on a Vulkan title has not been
> verified. Direct3D 9 and every 32-bit title are not measured.
> - **Which upscaler is running:** measured from the API a Direct3D title calls — DLSS or NIS through
> NVIDIA Streamline (with Ray Reconstruction Yes/No), and FSR through AMD's shipped FidelityFX DLLs:
> named FSR 3 from the older DLLs, and FSR without a version from the newer ones, which host both
> FSR 3.1 and FSR 4. FSR 2, and FSR shipped any other way, is not identified. For DLSS titles that
> bypass Streamline, the NVIDIA driver's own per-process record is stored with the session, labelled
> *driver-reported*; the app does not display it yet. Intel XeSS is **not** read (its SDK licence
> bypass Streamline, the NVIDIA driver's own per-process record is stored with the session and shown
> as *DLSS (driver-reported)*. The NVIDIA driver's profile for the game — the DLSS and frame-generation
> overrides the NVIDIA App sets — is read, never changed, and shown as the driver's settings beside what
> was measured. Intel XeSS is **not** read (its SDK licence
> forbids it), and neither is an upscaler compiled into the game: those read `N/A`, or "Unknown
> upscaler" when another vendor's hook ran in the game. Vulkan and OpenGL titles read `N/A`.
> - **Quality preset:** not reported on any title measured. The one route this software may use — the
@@ -124,22 +148,64 @@ Frame timing is derived from high-resolution timestamps taken at the moment the
> - **Frame generation (Direct3D titles only):** the Displayed rate is counted from presents, plus the
> presents DXGI's own counter saw on the same swap chain that the hook did not; the Native rate from
> the vendor's own per-frame calls (NVIDIA Streamline, AMD FidelityFX) where the title makes them, and
> `N/A` where it does not. DLSS-G and FSR FG are named from the calls the game makes; any other
> generator (XeSS-FG, one compiled into the game) is shown only as active with the technology not
> identified, and is never named. Where a technology is named but its frames could not be counted, or
> frame generation is not measured, the software shows **Presented FPS** with a note on what it may
> include — never a Native figure.
> `N/A` where it does not. When frame generation did not stay in one state for the whole session
> (menus, loading screens, a settings change), no session-wide factor is shown: the factor, Native and
> Displayed are those of the state that held longest — five-second windows whose ratios agree within
> 10 %, covering at least 10 s and 10 % of the time the game was presenting — and are always shown with
> the share of the session they cover; with no such state, the reason is shown instead. DLSS-G and FSR
> FG are named from the calls the game makes; any other generator (XeSS-FG, one compiled into the game)
> is shown only as active with the technology not identified, and is never named. Where a technology is
> named but its frames could not be counted, or frame generation is not measured, the software shows
> **Presented FPS** with a note on what it may include — never a Native figure. Where generated frames
> were counted, the lows, median and stutter are taken over application frames only.
> - **Ray tracing:** Yes/No measured on Direct3D 12 from ray-dispatch and acceleration-structure-build
> calls; the technique and path tracing are `N/A`, and so is ray tracing on other APIs.
> - **Display mode:** how each game's window was shown — exclusive full-screen, borderless, windowed or
> minimised — as a share of the session, with the window's size and the monitor's, in every session.
> Exclusive full-screen is known only for Direct3D titles FrameLedger injects into, from the game's own
> swap chain; for every other session the window alone is read, and a window covering its monitor reads
> *full-screen or borderless*. What Windows does behind the game (fullscreen optimizations) is not visible.
> - **Engine version:** the exact Unreal Engine 4 or 5 version, read from the game's executable on disk and
> labelled with what it rests on; `N/A` where the executable names none. Since beta.19 also Unity's (from its
> player library or its data file — without the release letter where only the library's number is readable),
> Godot's (from its data pack) and RPG Maker's maker and version (MV and MZ from their core script; XP, VX and VX
> Ace by their runtime library's version, which is not the editor's). RPG Maker 2000/2003 is not detected. Since
> beta.20 also Ren'Py's (from its engine's version file). Other engines show what their own files state.
> - **The game's own memory (since beta.12):** its dedicated and shared GPU memory and its private
> working set — the numbers Task Manager's Details tab shows — with its working set and commit, read
> once a second from Windows' own counters, from outside the game, in every session: a game
> FrameLedger injects into through the handle it already holds, any other by opening it briefly with
> the least access Windows offers (and adding up every process running its executable). Shown with
> mean, median and peak. The game's other processes (launchers, helpers) are not counted.
> - **Video memory:** in use on the whole graphics card, recorded from Windows and GPU-driver telemetry
> and charted. **Not measured at all:** each game's own video-memory use and budget, which frame
> spikes were shader compilation, PC latency (Reflex), HDR, and CPU temperature. Stutter count and
> stutter time are measured from frame times.
> and charted. **Not measured at all:** the video-memory budget Windows gives a game, which frame
> spikes were shader compilation, PC latency (Reflex), and HDR. Stutter count and stutter time are
> measured from frame times.
> - **Pacing, VSync and the graphics card (since beta.14):** the share of the time below 30 FPS, below 60 FPS and below
> the monitor's refresh rate, measured from frame times with small margins so that a game held at its limit is not
> counted as below it (a rate less than 2 % under the line reads partly as at it), and how much one frame's time
> differs from the next; for Direct3D titles, how many frames asked to wait for the display and how many allowed
> tearing — what the game asked, not what the driver did; the graphics card's clock speeds, fan speed and memory
> temperature in every session, and, on NVIDIA cards only, how much of the time its power limit or its temperature held
> it back, read once a second; and frames per watt — the game's own frames per second for each watt the graphics card
> drew, never counting generated frames, `N/A` where the game's own frame rate is not known.
> - **Processor and memory:** how busy the processor was (time busy, all cores together — not the
> frequency-scaled figure Task Manager draws) and how much system memory was in use, read from
> Windows once a second and charted. Processor temperature is read only when the Agent runs as
> administrator — an option, off by default, for which Windows asks at every start of the Agent — with
> PawnIO installed, and that reading has not yet been checked on real hardware; everywhere else it is `N/A`.
> - **Safety:** every pre-injection check runs before injection, including the signed-by-a-known-vendor
> half of the suspicious-module rule. During every capture the Agent re-runs the checks every 30 s and
> stops capturing on a refusal: a Direct3D or OpenGL game's hooks are removed, and the Vulkan layer
> goes passthrough. A global switch in Settings turns all hooking off, and a running capture stops at
> its next check; it can only refuse, never permit. There is no override anywhere.
> its next check; it can only refuse, never permit. **There is no override.** A finding about a game — anti-cheat
> named in its process or in its folder (any kernel driver there counts), or the game on a title list by its
> store id or executable name — turns hooking off for that game, whether found by the Agent's own check of every
> game in the library, before injection, at a session's start or by the 30 s re-check; the game's page says so,
> and nothing turns it back on for that executable — except a user-mode exception you make yourself, per game,
> in Settings (off by default): only where the only finding is one anti-cheat that runs entirely in user mode, with
> no driver file in the game's folder. Its first two sessions are a trial, and one that does not go well ends it
> for good. The guard still runs every check under it and ends it on anything new; a ban remains possible.
>
> Where a value is not measured it reads `N/A`, with two exceptions: FPS then shows Presented FPS with a
> note on what it may include, and ray-tracing flags may show a value you set yourself, labelled as
@@ -153,10 +219,39 @@ Frame timing is derived from high-resolution timestamps taken at the moment the
Do not use FrameLedger's output as the sole basis for purchasing, warranty, overclocking, or safety decisions.
## 4A. Your PC must meet the game's own requirements
FrameLedger measures a game; it does not make one run. **Make sure your PC meets at least the minimum system
requirements published by the game's developer or publisher before you measure it** — read them first.
If you run FrameLedger with a game on a machine below that game's minimum requirements, low frame rates, stutter,
crashes, overheating, failures to start, and readings that look wrong are consequences of that choice. **They are your
responsibility, not the developer's**, and they are not defects of FrameLedger. The same applies to unstable overclocks
or undervolts, overheating or failing hardware, out-of-date or beta graphics drivers, a Windows installation that is
missing updates, and other overlays, injectors or "optimizer" tools running at the same time.
FrameLedger adds a small cost of its own while it records. On a machine that is already at its limit, that cost can
be the difference between a game that runs and one that does not. Turn hooking off for that game if so.
## 5. Hardware and drivers
FrameLedger reads GPU telemetry through vendor libraries that ship with your graphics driver. It **only reads** — it never changes clocks, fan curves, power limits, or any other hardware setting. Optional CPU-temperature support relies on the separate third-party **PawnIO** driver, which you install at your own discretion under its own license; some anti-cheat systems object to third-party kernel drivers regardless of what they are used for.
## 5A. Running the capture agent as administrator — optional, and your decision
Since 0.1.0-beta.10 a Settings option, off unless you turn it on, starts FrameLedger's capture agent as administrator.
**Windows asks you every time the agent starts** — also when you sign in — and the prompt names an unknown publisher,
because FrameLedger is not code-signed. It lets FrameLedger open and measure a game that itself runs as administrator,
and read the CPU temperature where PawnIO is installed. It changes nothing in the anti-cheat guard (§2, §2A), opens no
process that Windows or an anti-cheat driver protects, and never starts a game as administrator: games you start from
FrameLedger run with your standard rights.
**The risk is yours.** FrameLedger is installed in your user folder, which any program running under your Windows
account can change (§1). If such a program replaced FrameLedger's files, it would run with administrator rights the next
time you accept the prompt. Accept it only for a copy you installed from the project's GitHub Releases, and turn the
option on only if you trust everything that runs under your account. The developer is not responsible for what runs
under an administrator prompt you accept.
## 6. Third-party names
Windows and DirectX are trademarks of Microsoft Corporation. NVIDIA, DLSS, Reflex, NVAPI, AMD, FSR, Intel, XeSS, Vulkan, Steam, GOG, Epic Games, itch.io, Unity, Unreal Engine, and all other product names are trademarks of their respective owners. FrameLedger is an independent project and is **not affiliated with, endorsed by, or sponsored by** any of them, including any game publisher or anti-cheat vendor.
@@ -165,6 +260,24 @@ Windows and DirectX are trademarks of Microsoft Corporation. NVIDIA, DLSS, Refle
If you publish benchmarks or videos using FrameLedger data, you are responsible for how you present the numbers. The software deliberately shows native frame rate alongside frame-generation-boosted output, and labels which measurement tier produced each session; keeping both visible in published material is strongly encouraged.
## 7A. Your data, unsigned builds, and third parties
- **Your recordings are yours to back up.** They live in one folder on your PC (`%LOCALAPPDATA%\FrameLedger`). A bug, an
update, a disk problem or an uninstall can damage or remove them. The developer cannot recover them.
- **Builds are not code-signed.** Windows SmartScreen and antivirus products may warn about or block the installer or
the component loaded into a game. Verify the download against the published `SHA256SUMS.txt`; only download from the
project's own GitHub Releases page. A build obtained anywhere else is not the developer's and is not covered by
anything here.
- **FrameLedger is not affiliated with any game, publisher, platform, GPU vendor or anti-cheat vendor** (§6). None of
them supports it. If a game's or a platform's terms forbid third-party software that loads into the game, using
FrameLedger with it is your decision and your responsibility.
- **Numbers are for your own information.** Do not rely on them for a purchase, a warranty claim, a refund dispute, a
review you are paid for, or any decision where being wrong costs money, without checking them another way (§4).
## 8. No professional advice
Nothing in the software or its documentation constitutes professional, legal, or engineering advice.
---
Contact: <contact@poli0981.dev> · Developer: <https://poli0981.dev/> · Project: <https://github.com/poli0981/frameledger>
+21 -8
View File
@@ -1,8 +1,6 @@
# FrameLedger — End User License Agreement (EULA)
**Version:** 1.0-draft · **Effective:** {{RELEASE_DATE}}
> ⚠ Draft for review. Not legal advice. The developer should review before first public release.
**Version:** 1.5 · **Effective:** {{RELEASE_DATE}}
This End User License Agreement ("Agreement") applies to **FrameLedger** ("the Software"), developed and published by **poli0981** ("the Developer"), contactable at <contact@poli0981.dev> — see <https://poli0981.dev/> for other contact channels.
@@ -12,11 +10,11 @@ The Software is free and open-source software licensed to you under the **GNU Ge
## 2. What the Software does
The Software records game performance data, hardware telemetry (temperatures, load, memory usage), and game metadata, and stores this data **locally on your device**. Details are described in the Privacy Policy and Disclaimer accompanying the Software.
The Software records game performance data, hardware telemetry (temperatures, load, memory usage), each game's own memory use as Windows reports it, and game metadata, and stores this data **locally on your device**. Details are described in the Privacy Policy and Disclaimer accompanying the Software.
## 2A. Code injection — your responsibility
To measure rendering settings accurately, the Software can load a component into a game process, **but only for games you have individually enabled**, after a consent prompt that explains the risk. The Software refuses to do so when it detects anti-cheat or anti-tamper software, and provides no means to override that refusal.
To measure rendering settings accurately, the Software can load a component into a game process, **but only for games you have individually enabled**, after a consent prompt that explains the risk. The Software refuses to do so when it detects anti-cheat or anti-tamper software, turns hooking off for that game, and provides no means to override that refusal — except a narrow, per-game exception for anti-cheat that works entirely in user mode, which you may make yourself, after a separate disclosure, whose first two sessions are a trial that ends it for good if one of them does not go well, and under which the Software still runs every check (Disclaimer §2A). By making such an exception you accept, for that game, the risk described in (b) below.
By enabling this feature for a game, you confirm that:
@@ -30,15 +28,26 @@ By enabling this feature for a game, you confirm that:
(e) the Developer has no ability to reverse a ban, recover lost progress, or intervene with any game publisher on your behalf, and accepts no liability for such outcomes.
The Software records without injecting unless you enable injection for a specific game. In that mode it records only the session's duration and whatever hardware sensor data is available, indicates that mode on the session, and reports unavailable measurements as such rather than estimating them. Neither mode requires the Software's agent to run with administrator rights.
The Software records without injecting unless you enable injection for a specific game. In that mode it records only the session's duration, whatever hardware sensor data is available, and the game's own memory use as Windows reports it — read from outside the game, never from the game's memory — indicates that mode on the session, and reports unavailable measurements as such rather than estimating them. Neither mode requires the Software's agent to run with administrator rights.
## 2B. Pre-release software, and your PC
The Software is currently distributed only as **pre-release (beta) builds**, which certainly still contain defects
(Disclaimer §0). You use a pre-release build at your own risk, and the Developer is not responsible for any incident
that results.
You are responsible for making sure your PC meets at least the minimum system requirements published by the developer
or publisher of each game you measure. Problems that arise from running a game below its minimum requirements, or on
unstable, overheating, overclocked or faulty hardware, are your responsibility and not the Developer's (Disclaimer
§4A).
## 3. Acceptance
By clicking "Accept" in the first-run dialog or by using the Software, you confirm that you have read this Agreement, the Disclaimer, and the Privacy Policy.
By clicking "Accept" in the first-run dialog or by using the Software, you confirm that you have read this Agreement, the Disclaimer, and the Privacy Policy. The GPL-3.0 is shown in the same dialog for your information: it is your licence to the Software, and you need not accept it to run the Software (GPL-3.0 §9).
## 4. Third-party components
The Software includes and interoperates with third-party components listed in `legal/THIRD_PARTY_NOTICES.md`, each under its own license. The optional **PawnIO** kernel driver is a separate third-party product installed by you at your discretion and governed by its own license and terms.
The Software includes and interoperates with third-party components listed in `legal/THIRD_PARTY_NOTICES.md` — in an installed copy, `licenses\THIRD_PARTY_NOTICES.md` beside the Software, and Help ▸ About — each under its own license. The optional **PawnIO** kernel driver is a separate third-party product installed by you at your discretion and governed by its own license and terms.
## 5. No warranty
@@ -60,6 +69,10 @@ The Software can check for updates via GitHub. Installing updates is always your
Your rights under the GPL-3.0 continue as described in that license. You may stop using the Software at any time by uninstalling it; local data removal options are offered during uninstall.
## 10. Your rights as a consumer, and the rest of this Agreement
Nothing in this Agreement limits any right you have under consumer protection law that cannot be limited or waived by agreement; where such a law applies, the warranty and liability terms above apply only as far as that law allows. If a court finds any provision of this Agreement unenforceable, that provision is enforced to the extent permitted, and the rest of the Agreement remains in effect.
---
Contact: <contact@poli0981.dev> · Developer: <https://poli0981.dev/> · Project: <https://github.com/poli0981/frameledger>
+18 -14
View File
@@ -1,6 +1,6 @@
# FrameLedger — Privacy Policy
**Version:** 2.1-draft · **Effective:** {{RELEASE_DATE}}
**Version:** 2.11 · **Effective:** {{RELEASE_DATE}}
**Short version: everything stays on your PC. FrameLedger has no accounts, no telemetry, no analytics, and never uploads your data anywhere.**
@@ -8,39 +8,43 @@
Stored in `%LOCALAPPDATA%\FrameLedger` on your device:
- Your game library entries (names, executable paths, cover art, metadata you or the app filled in).
- Performance sessions: frame timing series, computed statistics, hardware sensor series (temperatures, load, memory usage), session duration, crash flags, tags and notes you write.
- Your game library entries (names, executable paths, metadata you or the app filled in, and whether each one is recorded).
- Images you choose for a game (Edit…), copied into the `covers` folder; choosing the store's image again, or removing the game together with its sessions, deletes the copy. Artwork a store's app keeps on your PC is shown from where it is and not copied.
- Performance sessions: frame timing series, computed statistics, hardware sensor series (temperatures, load, power, memory usage, and the graphics card's clock speeds, fan speed, memory temperature and whether its power limit or heat held it back), the game's own memory use (its dedicated and shared video memory, private working set, working set and commit, once a second), session duration, crash flags, the graphics driver's settings the game ran under (NVIDIA only), how the game's window was shown (full-screen, borderless or windowed, for how long, its size and the monitor's), tags and notes you write.
- A hardware snapshot per session (CPU/GPU model, driver version, RAM size, OS build, display mode) used for the "what changed between sessions" feature.
- App settings, logs (7-day rotation, including logs written by the component loaded into games), and, after a crash of the app itself, crash dump files.
- App settings, logs (rotated daily — the app keeps 7 days, the capture agent 14 — including the logs written by the component loaded into games), and, after a crash of the app itself, crash dump files.
- Which games you enabled code injection for, and when you consented.
This data never leaves your device unless **you** export it or attach it to a bug report yourself. Deleting the app offers deletion of this folder; you can also delete it manually at any time.
## 2. Network connections the app can make
FrameLedger makes **no network connections except the following**, each visible in settings:
FrameLedger makes **no network connections except the following two**, both from an installed copy only, and the first can be switched off in Settings ▸ Updates:
| Purpose | Endpoint | When | Data sent |
|---|---|---|---|
| Update check | GitHub Releases API for `poli0981/frameledger` | At startup (can be disabled) and on manual check | Standard HTTP request metadata only (no identifiers beyond your IP as seen by GitHub) |
| Safety list update | Raw file on the project repository | Weekly, and **regardless of your other rules-update settings** | Same as above — this list is what stops FrameLedger injecting into newly-protected games, so it is not optional |
| Update download | GitHub release assets | Only after an update is found | Same as above |
| Detection-rules update | Raw file on the project repository | Weekly check (can be disabled) and manual | Same as above |
| Store metadata lookup | Steam public store API | **Off by default — opt-in** | The Steam AppID of a game you added |
| Update check | GitHub Releases API for `poli0981/frameledger` | A few seconds after startup (can be disabled) and when you choose Help ▸ Check for updates | Standard HTTP request metadata only — the request carries `User-Agent: FrameLedger/<version>` and nothing else of ours; no identifiers beyond your IP as seen by GitHub |
| Update download | GitHub release assets | Only after an update is found, and applied only after you restart (never while a game is being measured) | Same as above |
> ⚠ **Accuracy audit, 2026-08-04, amended 2026-09-14: the "Safety list update" and "Detection-rules update" rows describe outbound requests the software does not make.** The "Update check" and "Update download" rows are real since 2026-09-14 (version 2.1 of this document — a new outbound request is a material change): Velopack, against GitHub's release API and release assets, from an installed copy only, the startup check off with one switch in Settings ▸ Updates, and the request carries `User-Agent: FrameLedger/<version>` and nothing else of ours. The rules rows are not real: there is no rules HTTP client anywhere in the product; the anti-cheat blocklist currently ships with the build and is installed locally on first run (`docs/20_OPEN_QUESTIONS.md` §S20 — the seed half is done, the feed half is not). **Over-disclosure is a defect in this document too**: a privacy policy that lists a transmission which never happens is as wrong as one that omits a transmission which does. Either the fetch exists at first release or these rows change.
There is no other request. In particular, the anti-cheat safety list and the detection rules ship **with the build** and are installed locally on first run; the software fetches no rules from anywhere, and it looks nothing up on any store. When a rules feed exists it will be a new version of this document, which the app shows you again before continuing (§6).
GitHub's own privacy practices apply to requests it receives: <https://docs.github.com/privacy>. The Steam lookup, if enabled, is governed by Valve's policies.
GitHub's own privacy practices apply to requests it receives: <https://docs.github.com/privacy>.
Pressing Play hands the game to its store's app on your PC, which may connect to its store as it does whenever you start a game from it; FrameLedger itself connects to nothing.
## 3. Bug reports — always manual
The "Report a bug" feature builds a zip file **on your device**, shows you exactly which files it contains, and lets you inspect them. Nothing is transmitted by the app; **you** decide whether to attach the file to a GitHub issue in your browser. Logs are redacted (user directory paths removed) before bundling. Optional items (crash dumps, last-session metadata) are included only when you tick their checkboxes.
## 3A. Sharing an export or a bug report
An exported session (CSV or JSON) and a bug report can contain your games' names and **the paths to their files** — which include your **Windows user name** when a game is installed under your user folder — your hardware model, graphics driver and Windows build, the times you played, and your tags and notes. A bug report removes user directory paths from its logs; an export is written as it is. Look at a file before you share it. Once you share it, it is outside FrameLedger: whoever receives it, and the site you post it to, can read it under their own terms.
## 4. What the app can technically observe
To do its job, FrameLedger observes: which of *your tracked* executables are running and their process trees; the parameters your games pass to the graphics APIs it intercepts (presentation, upscaling, ray tracing, pipeline creation); video-memory usage reported by the graphics runtime; loaded module names of a game being captured (for detection and for the anti-cheat safety check); and hardware sensor values from your graphics driver's own libraries.
To do its job, FrameLedger observes: which of *your tracked* executables — the entries in your library whose recording is on — are running, and their process trees; the parameters your games pass to the graphics APIs it intercepts (presentation, upscaling, ray tracing, pipeline creation); the memory use of a tracked game's process — its dedicated and shared video memory, from Windows' GPU performance counters, and its working sets and commit, from Windows' process-memory information, for which a game it does not inject into is opened with the least access Windows offers and closed again (never its memory's content); loaded module names of a game being captured (for detection and for the anti-cheat safety check); the names of the files in each library game's install folder, the version information of its executable and of the upscaling libraries it ships, the content of its executable file (the markers of the engine and of the graphics libraries it carries, the libraries it imports, and the engine build name an Unreal Engine game carries), the version marks an engine keeps in its own files (Unity's player library and the header of its data file, the header of a Godot data pack, an RPG Maker game's title, core script and Game.ini, the library Game.ini names, and the version file of a Ren'Py game's engine), and the store files that name it (Steam's and GOG's, on your disk) — to detect its engine, its engine version and its features and to check it for anti-cheat before any injection is possible; the lists of installed games that the Steam, GOG GALAXY, Epic Games and itch apps keep on your disk, and where GOG GALAXY is installed — read when you import your library and when you press Play, to find the store that installed a game and hand the game to that store's app — Steam's and GOG GALAXY's also when you open a game's page, to find the artwork their apps keep for it; the cover and banner images that the Steam and GOG GALAXY apps keep on your disk for a game in your library — read to show them on its page, never copied or sent anywhere; the size, position and state of a tracked game's window and the monitor it is on, read from Windows and not from the game, and — for a game FrameLedger injects into — whether the game asked for exclusive full-screen; the NVIDIA driver's settings for your tracked executables (read only: the DLSS and frame-generation overrides the NVIDIA App set); hardware sensor values from your graphics driver's own libraries; how busy the processor is and how much memory is in use, from Windows' own counters; the crash reports Windows keeps in its Application log about a tracked game's executable while it ran (to tell a crash from an ordinary exit — the reports are read, never sent anywhere); and the names of the programs a tracked game starts, so that a game's own crash reporter is recognised.
It does **not** read game memory outside those API parameters, and does not read game saves, chat, input content, network traffic, or anything unrelated to performance measurement. It records only for games you added to your library, and injects only into games you individually enabled.
It does **not** read game memory outside those API parameters, and does not read game saves, chat, input content, network traffic, or anything unrelated to performance measurement. It records only for programs you added to your library and did not switch recording off for — a program whose recording is off is not watched at all — and injects only into games you individually enabled.
All of this stays on your device. None of it is transmitted anywhere.
+8 -5
View File
@@ -29,7 +29,6 @@ FrameLedger is licensed under **GPL-3.0-only**. It includes or depends on the th
| Component | Use | License | Notes |
|---|---|---|---|
| **MinHook** | Inline function hooking in `FrameLedger.Overlay` | BSD-2-Clause | Vendored and built from source, pinned by commit. Copyright notice must ship in `legal/licenses/` |
*(The **Intel PresentMon** row was removed on 2026-08-27. It is not bundled, not fetched, not redistributed and no longer used at all — §S31 retired it as a measurement oracle and the owner then dropped it outright — so a notice for it would be over-disclosure, which this document treats as a defect in the same way an omission is. `tools/license-check.ps1`'s matching claim was removed in the same commit, because a bidirectional check whose subject no longer exists cannot go green honestly: it would be asserting agreement about nothing.)*
| Vulkan headers / loader interfaces | `FrameLedger.VkLayer` implicit layer | Apache-2.0 | Khronos headers; layer implemented against the documented loader–layer interface |
| LibreHardwareMonitorLib | GPU sensors (all vendors) + CPU/motherboard sensors (optional, elevated) | MPL-2.0 | See §GPU telemetry below. Consumed unmodified |
| WPF UI (`Wpf.Ui`, lepoco) | Fluent UI theme/controls/navigation | MIT | © lepo.co, Leszek Pomianowski and contributors. License copy must ship with the app (MIT requirement) — `legal/licenses/nuget/WPF-UI.txt`, the package's own LICENSE.md |
@@ -43,11 +42,15 @@ FrameLedger is licensed under **GPL-3.0-only**. It includes or depends on the th
| CsWin32 (build-time) | Win32 interop source generator | MIT | Build-time only |
| NVIDIA NVAPI SDK | NVIDIA GPU telemetry + Reflex latency | MIT | **Vendored 2026-08-05** — nine headers + `amd64/nvapi64.lib`, at `src/native/third_party/nvapi/`. See §GPU telemetry below |
| H.NotifyIcon.Wpf | Tray icon | MIT | |
| Markdig | Markdown rendering in the App (since beta.12): the Legal Gate, Help, About, the update notes | BSD-2-Clause | © Alexandre Mutel. The package ships no licence file; its text is the project's own `license.txt` at the packaged commit, a reviewed override (`tools/license-overrides/Markdig.txt`) → `legal/licenses/nuget/Markdig.txt`. Consumed unmodified; HTML in a document is shown as text, never interpreted, and no image is fetched |
| **Transitive, under LibreHardwareMonitorLib** — BlackSharp.Core, DiskInfoToolkit, RAMSPDToolkit-NDD | Hardware access helpers LHM 0.9.6 depends on | MPL-2.0 | Not named by this table until 2026-09-15. **Exhibit B clear:** authenticated code search of each upstream repository (Blacktempel/BlackSharp, /DiskInfoToolkit, /RAMSPDToolkit) finds the sentence once, in `LICENSE` — the template — and no source file carries an MPL notice at all, so the repository licence governs and §3.3 Secondary Licenses applies. Default branch as searched; the nuspecs pin commits `c70b735c`, `25319eae`, `3b47b960`. Source Code Form links are in each package's text |
| **Transitive, under LibreHardwareMonitorLib** — HidSharp; Mono.Posix.NETStandard; System.IO.Ports, System.Management, System.CodeDom, System.IO.FileSystem.AccessControl | USB HID, POSIX helpers, serial ports, WMI | Apache-2.0 (HidSharp's LICENSE.txt); MIT (Mono's LICENSE, reviewed override); MIT (Microsoft) | Mono.Posix.NETStandard declares only a URL; its text is the Mono LICENSE file that URL resolves to, fetched 2026-09-15 and committed as `tools/license-overrides/Mono.Posix.NETStandard.txt` |
| **Transitive, under ScottPlot.WPF** — SkiaSharp, HarfBuzzSharp and their Win32 native assets; OpenTK 4.x; OpenTK.GLWpfControl; OpenTK.redist.glfw | 2-D rendering, text shaping, OpenGL host | MIT; GLFW is zlib (its COPYING.md) | The native Skia and HarfBuzz builds carry their own third-party notices, shipped once each in `legal/licenses/nuget/notices-*.txt`. OpenTK.GLWpfControl declares only a URL (reviewed override, like Mono.Posix) |
| **Transitive** — Microsoft.Extensions.* (Hosting, DependencyInjection, Logging, Configuration, Options, …), Serilog.Extensions.*, Serilog.Sinks.Console, SQLite (SourceGear's native build), SQLitePCLRaw.* | Host, DI, logging plumbing; the SQLite engine | MIT; Apache-2.0; SQLite is public domain | The complete, versioned list is `legal/licenses/nuget/INDEX.md` — 77 packages on 2026-09-15 |
| Roslynator, Meziantou.Analyzer, VS Threading Analyzers (build-time) | Static analysis | Apache-2.0 / MIT | Build-time only |
| **Test-time only, never shipped** — xUnit.net v3 4.x (`xunit.v3.mtp-off`, `xunit.runner.visualstudio`), Microsoft.NET.Test.Sdk, coverlet.collector, FluentAssertions 7.x, NSubstitute; Catch2 (native) | Unit and integration tests, coverage | Apache-2.0 (xUnit.net, <https://github.com/xunit/xunit>; FluentAssertions **7.x only**) · MIT (Test.Sdk, coverlet) · BSD-3-Clause (NSubstitute) · BSL-1.0 (Catch2) | Not named by this table until 2026-09-21. None of them is in a published package: `12_BUILD` publishes App and Agent only, `tools/package-closure-check.ps1` keeps the test projects out of that closure, and `legal/licenses/nuget/` therefore lists none of them. xUnit.net moved 3.2.2 → 4.0.1 on 2026-09-21, same licence. **FluentAssertions is pinned to `[7.2.2]` on purpose**: 8.x is Xceed's Community Licence, not an OSI licence (`Directory.Packages.props`, `20_OPEN_QUESTIONS` §G). Catch2's text is `legal/licenses/catch2-BSL-1.0.txt` |
*(The **Intel PresentMon** row was removed on 2026-08-27. It is not bundled, not fetched, not redistributed and no longer used at all — §S31 retired it as a measurement oracle and the owner then dropped it outright — so a notice for it would be over-disclosure, which this document treats as a defect in the same way an omission is. `tools/license-check.ps1`'s matching claim was removed in the same commit, because a bidirectional check whose subject no longer exists cannot go green honestly: it would be asserting agreement about nothing.)* *(Moved out of the table on 2026-10-03: a line without cells inside a table ended it for Markdig, so the App drew the whole table as text; GitHub draws it either way.)*
## GPU telemetry — what is bundled and what is not
@@ -89,20 +92,20 @@ Any proposal to add a vendor SDK must first pass the checklist in `docs/18_GPU_V
|---|---|---|
| **PawnIO** | Optional kernel driver required by LibreHardwareMonitor for CPU/motherboard sensors; installed separately by the user from <https://pawnio.eu/> | Its own license and signing; not distributed by FrameLedger |
| Windows ETW, DXGI, Event Log | OS facilities | Microsoft Windows license |
| Steam / GOG Galaxy / Epic Games Launcher / itch.io | Local manifest files read for library import | Respective platform terms; read-only local access |
| Steam / GOG Galaxy / Epic Games Launcher / itch.io | Local manifest files read for library import and Play; the artwork the Steam and GOG Galaxy apps keep on disk, shown on a game's page (beta.23) | Respective platform terms; read-only local access, nothing copied or downloaded |
## Trademarks
All product names, logos, and brands are property of their respective owners and are used for identification purposes only (see `DISCLAIMER.md` §4).
All product names, logos, and brands are property of their respective owners and are used for identification purposes only (see `DISCLAIMER.md` §6).
## Attribution requirements checklist (release gate)
- [x] `legal/licenses/` contains full texts: MIT (per-project copies, **including `nvapi-MIT.txt`**), BSD-2-Clause (MinHook), MPL-2.0, Apache-2.0 — **2026-09-15 (P4 PR-6):** the vendored natives' copies as before, plus one generated text per shipped NuGet package in `legal/licenses/nuget/` (77), gated by `license-check` §3; the .NET runtime's licence and notices are added to the package by `release.yml`. The copies ship: the App's publish carries `legal/licenses/` as `licenses/`
- [ ] About → Third-party tab lists this table with versions filled from `Directory.Packages.props`
- [x] About → Third-party tab lists this table with versions ~~filled from `Directory.Packages.props`~~ — **built beta.12 (2026-10-03)**: Help ▸ About ▸ *Third-party licences* renders this file and `licenses/nuget/INDEX.md` — every shipped package with its version and licence, generated from what the build restores rather than from `Directory.Packages.props` — with a button that opens the published `licenses\` folder. ~~not built as of 2026-09-16 and not a gate for the first pre-release: the texts ship as files (`licenses/` beside the App, `licenses/nuget/INDEX.md` lists every package with its version), and Help ▸ Documentation opens this file; the tab is an open UI item~~
- ~~PresentMon license + copyright shipped beside the bundled binary~~ — **removed 2026-08-27 with the dependency.** Nothing Intel-authored is distributed by this project
- [x] MPL-2.0 source-availability note points to upstream LibreHardwareMonitor repository — every MPL-2.0 package text in `legal/licenses/nuget/` names its Source Code Form (MPL-2.0 §3.2), LHM's `https://github.com/LibreHardwareMonitor/LibreHardwareMonitor` included (2026-09-15)
- [x] LHM checked for MPL-2.0 Exhibit B on any depended-upon file — clear as of 0.9.6 / commit `3d331e33`, 2026-08-02
- [x] **AMD FidelityFX headers are vendored** (2026-09-04) — five headers, MIT **by exception**: `license-check.ps1` §2d asserts each vendored path against the exception list inside the vendored `license.md` and each header's own banner, file by file. No binary, no source
- [x] **AMD FidelityFX SDK 3.0 host headers are vendored** (2026-09-05) — ten headers at tag `fsr3-v3.0.4`, MIT at the root **and** inline: `license-check.ps1` §2e asserts the root grant and every header's banner, file by file, in a directory of its own because the licence shape differs from the row above. No binary, no source, no shaders
- [x] **NVAPI is vendored** (2026-08-05) and all nine headers carry their `SPDX-License-Identifier: MIT` blocks unmodified — asserted file by file, not sampled. `license-check.ps1` enforces that this line and the table agree with the filesystem, **in both directions**: vendoring the material while the table still said "Not yet" failed the build, which is how this row came to be flipped
- [ ] No Intel IGCL or AMD ADLX material anywhere in the tree (CI grep, see `docs/13_CI_CD.md`)
- [x] No Intel IGCL or AMD ADLX material anywhere in the tree — `tools/license-check.ps1` §1 greps for both SDKs' identifiers on every `build.ps1 check` and therefore in CI (`docs/13_CI_CD.md` §Licence guard); ticked 2026-09-16, the check had existed since P0
+50
View File
@@ -0,0 +1,50 @@
# Names and trademarks
FrameLedger measures games on hardware, drivers and platforms made by other companies, so its software and its
documents name their products constantly. This page says how those names are used, and how the name *FrameLedger*
itself may be used. It is information for readers of the repository and of the documentation; it is not one of the
documents the app asks you to accept.
## Other companies' names
Microsoft, Windows, DirectX, Direct3D and DXGI are trademarks of Microsoft Corporation. NVIDIA, GeForce, RTX, DLSS,
Reflex, NVAPI and Streamline are trademarks of NVIDIA Corporation. AMD, Radeon, FSR and FidelityFX are trademarks of
Advanced Micro Devices, Inc. Intel, Arc and XeSS are trademarks of Intel Corporation. Vulkan is a registered trademark
of the Khronos Group Inc.; OpenGL is a registered trademark of Hewlett Packard Enterprise, used under licence by the
Khronos Group. Steam and Valve are trademarks of Valve Corporation; Epic Games, the Epic Games Store and Unreal Engine of
Epic Games, Inc.; Unity of Unity Technologies. GOG, GOG Galaxy and itch.io are trademarks of their respective owners. The
names of anti-cheat and anti-tamper products, and the names and store identifiers of games, belong to their respective
owners. All other product names are trademarks of their respective owners.
They are used **only to say what FrameLedger works with or measures** — for example, which upscaler a game used, or
which anti-cheat product made FrameLedger refuse to load into a game. Such a mention is a statement of fact about
compatibility or detection; it is not a claim about the quality of anyone's product.
**FrameLedger is an independent project.** It is not affiliated with, endorsed by or sponsored by any of these
companies, by any game's developer or publisher, or by any anti-cheat vendor, and none of them supports it.
- The anti-cheat products named in `rules/detection-rules.json` are listed so that FrameLedger can **refuse** to load
into a game protected by them; the list says nothing else about them.
- The games named in `docs/LIST_GAME_TESTED.md` are games the developer ran FrameLedger with, on one machine; the list is
not a benchmark claim and not a recommendation.
- **A game's artwork belongs to its owners.** FrameLedger ships none and downloads none: a game's page shows the image you
chose for it, or the cover and banner the Steam or GOG GALAXY app already keeps on your PC, read from where that app
keeps it and never copied (since 0.1.0-beta.23).
## The name FrameLedger
*FrameLedger* is the name of this project. The licence (`LICENSE`, `NOTICE`) gives you broad rights in the software
but, by its additional term (e), **no rights in the name**, the project's logo or its icon, beyond describing truthfully
where a work comes from:
- **fine:** "based on FrameLedger", "a fork of FrameLedger", "compatible with FrameLedger's export format", a link to
the project, an article or video about FrameLedger;
- **not fine:** naming a modified version "FrameLedger", using the icon or name for a build the project did not make,
or suggesting the developer made or endorses something they did not (NOTICE (c)).
`FORKING.md` says what a fork that ships builds should rename.
## Questions
If you represent one of the companies above and believe a mention here is wrong, or you want to ask about using the
FrameLedger name, write to contact@poli0981.dev.
+2 -2
View File
@@ -1,10 +1,10 @@
Dapper 2.1.79
Dapper 2.1.86
Licence declared: Apache-2.0
Text below: the shared Apache-2.0 text; the package ships no licence file
Copyright: 2019 Stack Exchange, Inc.
Authors: Sam Saffron,Marc Gravell,Nick Craver
Project: https://github.com/DapperLib/Dapper
Project: https://dapperlib.dev/
Ships in: Agent, App
-------------------------------------------------------------------------------
+31 -30
View File
@@ -9,7 +9,7 @@ from the runtime packs the publish used.
|---|---|---|---|---|
| BlackSharp.Core | 1.0.7 | MPL-2.0 | Agent, App | [BlackSharp.Core.txt](BlackSharp.Core.txt) |
| CommunityToolkit.Mvvm | 8.4.2 | MIT | App | [CommunityToolkit.Mvvm.txt](CommunityToolkit.Mvvm.txt) |
| Dapper | 2.1.79 | Apache-2.0 | Agent, App | [Dapper.txt](Dapper.txt) |
| Dapper | 2.1.86 | Apache-2.0 | Agent, App | [Dapper.txt](Dapper.txt) |
| DiskInfoToolkit | 1.1.2 | MPL-2.0 | Agent, App | [DiskInfoToolkit.txt](DiskInfoToolkit.txt) |
| H.GeneratedIcons.System.Drawing | 2.4.1 | MIT | App | [H.GeneratedIcons.System.Drawing.txt](H.GeneratedIcons.System.Drawing.txt) |
| H.NotifyIcon | 2.4.1 | MIT | App | [H.NotifyIcon.txt](H.NotifyIcon.txt) |
@@ -18,34 +18,35 @@ from the runtime packs the publish used.
| HarfBuzzSharp.NativeAssets.Win32 | 8.3.1.1 | MIT | App | [HarfBuzzSharp.NativeAssets.Win32.txt](HarfBuzzSharp.NativeAssets.Win32.txt) |
| HidSharp | 2.6.4 | the file LICENSE.txt in the package | Agent, App | [HidSharp.txt](HidSharp.txt) |
| LibreHardwareMonitorLib | 0.9.6 | MPL-2.0 | Agent, App | [LibreHardwareMonitorLib.txt](LibreHardwareMonitorLib.txt) |
| Microsoft.Data.Sqlite.Core | 10.0.10 | MIT | Agent, App | [Microsoft.Data.Sqlite.Core.txt](Microsoft.Data.Sqlite.Core.txt) |
| Microsoft.Extensions.Configuration | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Configuration.txt](Microsoft.Extensions.Configuration.txt) |
| Microsoft.Extensions.Configuration.Abstractions | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Configuration.Abstractions.txt](Microsoft.Extensions.Configuration.Abstractions.txt) |
| Microsoft.Extensions.Configuration.Binder | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Configuration.Binder.txt](Microsoft.Extensions.Configuration.Binder.txt) |
| Microsoft.Extensions.Configuration.CommandLine | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Configuration.CommandLine.txt](Microsoft.Extensions.Configuration.CommandLine.txt) |
| Microsoft.Extensions.Configuration.EnvironmentVariables | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Configuration.EnvironmentVariables.txt](Microsoft.Extensions.Configuration.EnvironmentVariables.txt) |
| Microsoft.Extensions.Configuration.FileExtensions | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Configuration.FileExtensions.txt](Microsoft.Extensions.Configuration.FileExtensions.txt) |
| Microsoft.Extensions.Configuration.Json | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Configuration.Json.txt](Microsoft.Extensions.Configuration.Json.txt) |
| Microsoft.Extensions.Configuration.UserSecrets | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Configuration.UserSecrets.txt](Microsoft.Extensions.Configuration.UserSecrets.txt) |
| Microsoft.Extensions.DependencyInjection | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.DependencyInjection.txt](Microsoft.Extensions.DependencyInjection.txt) |
| Microsoft.Extensions.DependencyInjection.Abstractions | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.DependencyInjection.Abstractions.txt](Microsoft.Extensions.DependencyInjection.Abstractions.txt) |
| Microsoft.Extensions.Diagnostics | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Diagnostics.txt](Microsoft.Extensions.Diagnostics.txt) |
| Microsoft.Extensions.Diagnostics.Abstractions | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Diagnostics.Abstractions.txt](Microsoft.Extensions.Diagnostics.Abstractions.txt) |
| Microsoft.Extensions.FileProviders.Abstractions | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.FileProviders.Abstractions.txt](Microsoft.Extensions.FileProviders.Abstractions.txt) |
| Microsoft.Extensions.FileProviders.Physical | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.FileProviders.Physical.txt](Microsoft.Extensions.FileProviders.Physical.txt) |
| Microsoft.Extensions.FileSystemGlobbing | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.FileSystemGlobbing.txt](Microsoft.Extensions.FileSystemGlobbing.txt) |
| Microsoft.Extensions.Hosting | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Hosting.txt](Microsoft.Extensions.Hosting.txt) |
| Microsoft.Extensions.Hosting.Abstractions | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Hosting.Abstractions.txt](Microsoft.Extensions.Hosting.Abstractions.txt) |
| Microsoft.Extensions.Logging | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Logging.txt](Microsoft.Extensions.Logging.txt) |
| Microsoft.Extensions.Logging.Abstractions | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Logging.Abstractions.txt](Microsoft.Extensions.Logging.Abstractions.txt) |
| Microsoft.Extensions.Logging.Configuration | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Logging.Configuration.txt](Microsoft.Extensions.Logging.Configuration.txt) |
| Microsoft.Extensions.Logging.Console | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Logging.Console.txt](Microsoft.Extensions.Logging.Console.txt) |
| Microsoft.Extensions.Logging.Debug | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Logging.Debug.txt](Microsoft.Extensions.Logging.Debug.txt) |
| Microsoft.Extensions.Logging.EventLog | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Logging.EventLog.txt](Microsoft.Extensions.Logging.EventLog.txt) |
| Microsoft.Extensions.Logging.EventSource | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Logging.EventSource.txt](Microsoft.Extensions.Logging.EventSource.txt) |
| Microsoft.Extensions.Options | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Options.txt](Microsoft.Extensions.Options.txt) |
| Microsoft.Extensions.Options.ConfigurationExtensions | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Options.ConfigurationExtensions.txt](Microsoft.Extensions.Options.ConfigurationExtensions.txt) |
| Microsoft.Extensions.Primitives | 10.0.10 | MIT | Agent, App | [Microsoft.Extensions.Primitives.txt](Microsoft.Extensions.Primitives.txt) |
| Markdig | 1.4.0 | BSD-2-Clause | App | [Markdig.txt](Markdig.txt) |
| Microsoft.Data.Sqlite.Core | 10.0.12 | MIT | Agent, App | [Microsoft.Data.Sqlite.Core.txt](Microsoft.Data.Sqlite.Core.txt) |
| Microsoft.Extensions.Configuration | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Configuration.txt](Microsoft.Extensions.Configuration.txt) |
| Microsoft.Extensions.Configuration.Abstractions | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Configuration.Abstractions.txt](Microsoft.Extensions.Configuration.Abstractions.txt) |
| Microsoft.Extensions.Configuration.Binder | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Configuration.Binder.txt](Microsoft.Extensions.Configuration.Binder.txt) |
| Microsoft.Extensions.Configuration.CommandLine | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Configuration.CommandLine.txt](Microsoft.Extensions.Configuration.CommandLine.txt) |
| Microsoft.Extensions.Configuration.EnvironmentVariables | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Configuration.EnvironmentVariables.txt](Microsoft.Extensions.Configuration.EnvironmentVariables.txt) |
| Microsoft.Extensions.Configuration.FileExtensions | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Configuration.FileExtensions.txt](Microsoft.Extensions.Configuration.FileExtensions.txt) |
| Microsoft.Extensions.Configuration.Json | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Configuration.Json.txt](Microsoft.Extensions.Configuration.Json.txt) |
| Microsoft.Extensions.Configuration.UserSecrets | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Configuration.UserSecrets.txt](Microsoft.Extensions.Configuration.UserSecrets.txt) |
| Microsoft.Extensions.DependencyInjection | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.DependencyInjection.txt](Microsoft.Extensions.DependencyInjection.txt) |
| Microsoft.Extensions.DependencyInjection.Abstractions | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.DependencyInjection.Abstractions.txt](Microsoft.Extensions.DependencyInjection.Abstractions.txt) |
| Microsoft.Extensions.Diagnostics | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Diagnostics.txt](Microsoft.Extensions.Diagnostics.txt) |
| Microsoft.Extensions.Diagnostics.Abstractions | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Diagnostics.Abstractions.txt](Microsoft.Extensions.Diagnostics.Abstractions.txt) |
| Microsoft.Extensions.FileProviders.Abstractions | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.FileProviders.Abstractions.txt](Microsoft.Extensions.FileProviders.Abstractions.txt) |
| Microsoft.Extensions.FileProviders.Physical | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.FileProviders.Physical.txt](Microsoft.Extensions.FileProviders.Physical.txt) |
| Microsoft.Extensions.FileSystemGlobbing | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.FileSystemGlobbing.txt](Microsoft.Extensions.FileSystemGlobbing.txt) |
| Microsoft.Extensions.Hosting | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Hosting.txt](Microsoft.Extensions.Hosting.txt) |
| Microsoft.Extensions.Hosting.Abstractions | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Hosting.Abstractions.txt](Microsoft.Extensions.Hosting.Abstractions.txt) |
| Microsoft.Extensions.Logging | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Logging.txt](Microsoft.Extensions.Logging.txt) |
| Microsoft.Extensions.Logging.Abstractions | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Logging.Abstractions.txt](Microsoft.Extensions.Logging.Abstractions.txt) |
| Microsoft.Extensions.Logging.Configuration | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Logging.Configuration.txt](Microsoft.Extensions.Logging.Configuration.txt) |
| Microsoft.Extensions.Logging.Console | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Logging.Console.txt](Microsoft.Extensions.Logging.Console.txt) |
| Microsoft.Extensions.Logging.Debug | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Logging.Debug.txt](Microsoft.Extensions.Logging.Debug.txt) |
| Microsoft.Extensions.Logging.EventLog | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Logging.EventLog.txt](Microsoft.Extensions.Logging.EventLog.txt) |
| Microsoft.Extensions.Logging.EventSource | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Logging.EventSource.txt](Microsoft.Extensions.Logging.EventSource.txt) |
| Microsoft.Extensions.Options | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Options.txt](Microsoft.Extensions.Options.txt) |
| Microsoft.Extensions.Options.ConfigurationExtensions | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Options.ConfigurationExtensions.txt](Microsoft.Extensions.Options.ConfigurationExtensions.txt) |
| Microsoft.Extensions.Primitives | 10.0.12 | MIT | Agent, App | [Microsoft.Extensions.Primitives.txt](Microsoft.Extensions.Primitives.txt) |
| Mono.Posix.NETStandard | 1.0.0 | a URL only: https://go.microsoft.com/fwlink/?linkid=869050 | Agent, App | [Mono.Posix.NETStandard.txt](Mono.Posix.NETStandard.txt) |
| OpenTK.Audio.OpenAL | 4.9.4 | MIT | App | [OpenTK.Audio.OpenAL.txt](OpenTK.Audio.OpenAL.txt) |
| OpenTK.Compute | 4.9.4 | MIT | App | [OpenTK.Compute.txt](OpenTK.Compute.txt) |
@@ -76,7 +77,7 @@ from the runtime packs the publish used.
| SQLitePCLRaw.core | 3.0.5 | Apache-2.0 | Agent, App | [SQLitePCLRaw.core.txt](SQLitePCLRaw.core.txt) |
| SQLitePCLRaw.provider.e_sqlite3 | 3.0.5 | Apache-2.0 | Agent, App | [SQLitePCLRaw.provider.e_sqlite3.txt](SQLitePCLRaw.provider.e_sqlite3.txt) |
| System.CodeDom | 10.0.2 | MIT | Agent | [System.CodeDom.txt](System.CodeDom.txt) |
| System.Diagnostics.EventLog | 10.0.10 | MIT | Agent | [System.Diagnostics.EventLog.txt](System.Diagnostics.EventLog.txt) |
| System.Diagnostics.EventLog | 10.0.12 | MIT | Agent | [System.Diagnostics.EventLog.txt](System.Diagnostics.EventLog.txt) |
| System.IO.FileSystem.AccessControl | 5.0.0 | MIT | Agent, App | [System.IO.FileSystem.AccessControl.txt](System.IO.FileSystem.AccessControl.txt) |
| System.IO.Ports | 10.0.3 | MIT | Agent, App | [System.IO.Ports.txt](System.IO.Ports.txt) |
| System.Management | 10.0.2 | MIT | Agent, App | [System.Management.txt](System.Management.txt) |
+47
View File
@@ -0,0 +1,47 @@
Markdig 1.4.0
Licence declared: BSD-2-Clause
Text below: tools/license-overrides/Markdig.txt, a reviewed copy of the project's own licence file; the package ships none
Copyright: Alexandre Mutel
Authors: Alexandre Mutel
Project: https://xoofx.github.io/markdig
Ships in: App
-------------------------------------------------------------------------------
Reviewed override for Markdig 1.4.0 (tools/license-gather.ps1).
The package declares <license type="expression">BSD-2-Clause</license> and ships no licence file. The text
below is the project's own license.txt at the commit the package names (<repository commit=
"56e9c238584a44a169f174c881855c049768634c">), fetched on 2026-10-03 from
https://raw.githubusercontent.com/xoofx/markdig/56e9c238584a44a169f174c881855c049768634c/license.txt,
verbatim. The package's <copyright> field is "Alexandre Mutel"; the file names the same holder.
Used by the App since beta.12 to render the documents it shows (the Legal Gate, Help, About, the user guide);
consumed unmodified.
-------------------------------------------------------------------------------
Copyright (c) 2016-2026, Alexandre Mutel
All rights reserved.
Redistribution and use in source and binary forms, with or without modification
, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -1,4 +1,4 @@
Microsoft.Data.Sqlite.Core 10.0.10
Microsoft.Data.Sqlite.Core 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Configuration.Abstractions 10.0.10
Microsoft.Extensions.Configuration.Abstractions 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Configuration.Binder 10.0.10
Microsoft.Extensions.Configuration.Binder 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Configuration.CommandLine 10.0.10
Microsoft.Extensions.Configuration.CommandLine 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Configuration.EnvironmentVariables 10.0.10
Microsoft.Extensions.Configuration.EnvironmentVariables 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Configuration.FileExtensions 10.0.10
Microsoft.Extensions.Configuration.FileExtensions 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Configuration.Json 10.0.10
Microsoft.Extensions.Configuration.Json 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Configuration.UserSecrets 10.0.10
Microsoft.Extensions.Configuration.UserSecrets 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Configuration 10.0.10
Microsoft.Extensions.Configuration 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.DependencyInjection.Abstractions 10.0.10
Microsoft.Extensions.DependencyInjection.Abstractions 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.DependencyInjection 10.0.10
Microsoft.Extensions.DependencyInjection 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Diagnostics.Abstractions 10.0.10
Microsoft.Extensions.Diagnostics.Abstractions 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Diagnostics 10.0.10
Microsoft.Extensions.Diagnostics 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.FileProviders.Abstractions 10.0.10
Microsoft.Extensions.FileProviders.Abstractions 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.FileProviders.Physical 10.0.10
Microsoft.Extensions.FileProviders.Physical 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.FileSystemGlobbing 10.0.10
Microsoft.Extensions.FileSystemGlobbing 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Hosting.Abstractions 10.0.10
Microsoft.Extensions.Hosting.Abstractions 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Hosting 10.0.10
Microsoft.Extensions.Hosting 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Logging.Abstractions 10.0.10
Microsoft.Extensions.Logging.Abstractions 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Logging.Configuration 10.0.10
Microsoft.Extensions.Logging.Configuration 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Logging.Console 10.0.10
Microsoft.Extensions.Logging.Console 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Logging.Debug 10.0.10
Microsoft.Extensions.Logging.Debug 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Logging.EventLog 10.0.10
Microsoft.Extensions.Logging.EventLog 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Logging.EventSource 10.0.10
Microsoft.Extensions.Logging.EventSource 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Logging 10.0.10
Microsoft.Extensions.Logging 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Options.ConfigurationExtensions 10.0.10
Microsoft.Extensions.Options.ConfigurationExtensions 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Options 10.0.10
Microsoft.Extensions.Options 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Microsoft.Extensions.Primitives 10.0.10
Microsoft.Extensions.Primitives 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
System.Diagnostics.EventLog 10.0.10
System.Diagnostics.EventLog 10.0.12
Licence declared: MIT
Text below: the standard MIT text; the package ships no licence file
@@ -1,4 +1,4 @@
Third-party notices first found in Microsoft.Extensions.Configuration 10.0.10 THIRD-PARTY-NOTICES.TXT
Third-party notices first found in Microsoft.Extensions.Configuration 10.0.12 THIRD-PARTY-NOTICES.TXT
.NET Runtime uses third-party libraries or other resources that may be
distributed under licenses different than the .NET Runtime software.
+233 -34
View File
@@ -1,13 +1,14 @@
{
"$comment": [
"Rules are DATA, not code (docs/05_DETECTION.md). This file ships with the",
"app and is updatable from the repository independently of releases.",
"app. It is NOT fetched: there is no rules feed (docs/20_OPEN_QUESTIONS.md",
"§S20 feed half), so a change here reaches users with a release, seeded by",
"the Agent from the copy beside it. (This comment said otherwise until",
"2026-10-04.)",
"",
"The `anticheat` block is what feeds the hard gate in",
"docs/19_SAFETY_AND_ANTICHEAT.md. Updates to it are treated as security",
"updates: applied on the next check regardless of the user's auto-update",
"preference for other rules. Removing an entry is a safety change and needs",
"the same review as a security fix (docs/13_CI_CD.md §rules-publish).",
"docs/19_SAFETY_AND_ANTICHEAT.md. Removing an entry is a safety change and",
"needs the same review as a security fix (docs/13_CI_CD.md §rules-publish).",
"",
"Shape is fixed by rules/detection-rules.schema.json (JSON Schema 2020-12),",
"which closes docs/20_OPEN_QUESTIONS.md §S5. Constraints a schema cannot",
@@ -15,16 +16,16 @@
"compilability, case-insensitive duplicate values — stay imperative in",
"tools/rules-validate.ps1.",
"",
"STILL INCOMPLETE AS DATA: docs/19_SAFETY §Blocklist seed names two families",
"with no representation here at all — Activision Ricochet (driver/service",
"names not yet confirmed) and Valve VAC (needs blockedStoreIds entries).",
"Every family docs/19_SAFETY §Blocklist seed names is represented since",
"2026-09-25: Valve VAC through blockedStoreIds and blockedExecutables (VAC",
"runs inside Steam, so no file of the game's own names it), and Activision",
"Ricochet through its driver and services from Activision's own support",
"pages.",
"",
"PRE-INJECTION CHECK 3 MATCHES NOTHING, because `blockedExecutables` and",
"`blockedStoreIds` are both empty. That is a fact about THIS DATA, which is",
"why it is stated here; seeding the lists is a product decision (which",
"titles, and what an unresolvable store id means) tracked as",
"docs/20_OPEN_QUESTIONS.md §S14. Recorded rather than left to be inferred",
"from two empty arrays.",
"PRE-INJECTION CHECK 3 MATCHED NOTHING until 2026-09-25, because",
"`blockedExecutables` and `blockedStoreIds` were both empty. The owner seeded",
"them that day (rules 2026.09.4); what an unresolvable store id means is",
"the matrix in docs/19_SAFETY check 3 (docs/20_OPEN_QUESTIONS.md §S14).",
"",
"WHICH CHECKS RUN IS DELIBERATELY NOT STATED HERE ANY MORE. This comment used",
"to list them — a FOURTH restatement of the gate's composition, in the one",
@@ -41,7 +42,7 @@
"level, which made it a check that could not fire."
],
"schemaVersion": 2,
"rulesVersion": "2026.08.2",
"rulesVersion": "2026.10.4",
"engines": [
{
@@ -51,7 +52,7 @@
{ "type": "sibling_glob", "value": "UnityPlayer.dll" },
{ "type": "dir_exists", "value": "${ExeName}_Data" }
] },
"version": { "type": "pe_file_version", "from": "UnityPlayer.dll" }
"version": { "type": "unity_build" }
},
{
"id": "unreal",
@@ -60,7 +61,46 @@
{ "type": "sibling_glob", "value": "*-Win64-Shipping.exe" },
{ "type": "sibling_glob", "value": "*/Content/Paks/*.pak" }
] },
"version": { "type": "pe_product_version_regex", "value": "\\+\\+UE(4|5)\\+Release-(\\d+\\.\\d+)" }
"version": { "type": "unreal_build" }
},
{
"id": "rpgmaker_mv",
"name": "RPG Maker MV/MZ",
"signals": { "all": [
{ "type": "sibling_glob", "value": "nw.dll" },
{ "type": "sibling_glob", "value": "package.json" }
] },
"version": { "type": "rpgmaker_build" }
},
{
"id": "rpgmaker_rgss",
"name": "RPG Maker XP/VX/VX Ace",
"signals": { "any": [
{ "type": "sibling_glob", "value": "RGSS1*.dll" },
{ "type": "sibling_glob", "value": "RGSS2*.dll" },
{ "type": "sibling_glob", "value": "RGSS3*.dll" },
{ "type": "sibling_glob", "value": "*.rgssad" },
{ "type": "sibling_glob", "value": "*.rgss2a" },
{ "type": "sibling_glob", "value": "*.rgss3a" }
] },
"version": { "type": "rpgmaker_build" }
},
{
"id": "re_engine",
"name": "RE Engine",
"signals": { "any": [
{ "type": "sibling_glob", "value": "re_chunk_000.pak" }
] },
"version": null
},
{
"id": "fromsoftware",
"name": "FromSoftware",
"signals": { "all": [
{ "type": "sibling_glob", "value": "*.bhd" },
{ "type": "sibling_glob", "value": "*.bdt" }
] },
"version": null
},
{
"id": "godot",
@@ -69,7 +109,7 @@
{ "type": "sibling_glob", "value": "*.pck" },
{ "type": "strings_contains", "value": "Godot Engine v" }
] },
"version": { "type": "strings_regex", "value": "Godot Engine v(\\d+\\.\\d+[\\.\\d]*)" }
"version": { "type": "godot_build" }
},
{
"id": "gamemaker",
@@ -84,7 +124,7 @@
{ "type": "dir_exists", "value": "renpy" },
{ "type": "sibling_glob", "value": "*.rpa" }
] },
"version": null
"version": { "type": "renpy_build" }
},
{
"id": "cryengine",
@@ -144,8 +184,8 @@
{ "id": "dlss_g", "name": "DLSS Frame Gen", "signals": [ "nvngx_dlssg.dll", "sl.dlss_g.dll" ] },
{ "id": "dlss_rr", "name": "Ray Reconstruction","signals": [ "nvngx_dlssd.dll" ] },
{ "id": "streamline", "name": "Streamline", "signals": [ "sl.interposer.dll", "sl.reflex.dll" ] },
{ "id": "fsr", "name": "FSR", "signals": [ "ffx_fsr2_*.dll", "ffx_frameinterpolation_*.dll", "amd_fidelityfx_*.dll", "ffx_api*.dll" ] },
{ "id": "xess", "name": "XeSS", "signals": [ "libxess.dll" ] },
{ "id": "fsr", "name": "FSR", "signals": [ "ffx_fsr2_*.dll", "ffx_fsr3*.dll", "ffx_frameinterpolation_*.dll", "amd_fidelityfx_*.dll", "ffx_api*.dll" ] },
{ "id": "xess", "name": "XeSS", "signals": [ "libxess.dll", "libxess_dx11.dll" ] },
{ "id": "xefg", "name": "XeSS Frame Gen", "signals": [ "libxess_fg.dll" ] }
],
@@ -159,30 +199,135 @@
{ "family": "Xigncode3", "match": "prefix", "values": [ "xhunter" ] },
{ "family": "PunkBuster", "match": "prefix", "values": [ "PnkBstr", "pbcl", "pbsv" ] },
{ "family": "FACEIT", "match": "prefix", "values": [ "faceit" ] },
{ "family": "ESEA", "match": "prefix", "values": [ "esea" ] }
{ "family": "ESEA", "match": "prefix", "values": [ "esea" ] },
{ "family": "Anti-Cheat Expert", "match": "prefix", "values": [ "SGuard", "AntiCheatExpert" ],
"note": "APPENDED 2026-09-25, as every row below: the Overlay reports a 1-based index into this array (sessions.early_stop_family), so a row inserted above shifts what stored indexes mean. SGuard64/SGuardSvc64 are ACE's guard processes (documented, file.net; unmeasured)." },
{ "family": "EA AntiCheat", "match": "prefix", "values": [ "EAAntiCheat" ],
"note": "EA Javelin: EAAntiCheat.GameServiceLauncher.dll / EAAntiCheat.GameService.exe (documented, EA forums). Unmeasured." },
{ "family": "NetEase Anti-Cheat", "match": "prefix", "values": [ "NeacSafe", "NeacClient" ],
"note": "NEAC (Naraka, Marvel Rivals, FragPunk). NeacSafe64 is documented (LOLDrivers, SteamDB NetEase_AntiCheatExperts); NeacClient unmeasured." },
{ "family": "NetEase Yidun", "match": "exact", "values": [ "NEP2.dll" ],
"note": "Documented (SteamDB FileDetectionRuleSets, NetEase_Yidun). Unmeasured." },
{ "family": "Nexon Game Security", "match": "prefix", "values": [ "BlackCipher", "BlackCall", "BlackXchg" ],
"note": "BlackCipher64.aes runs as its own process in the game's tree (The First Descendant, MapleStory). Documented (SteamDB BlackCipher). Unmeasured." },
{ "family": "mihoyo protect", "match": "prefix", "values": [ "mhypbase" ],
"note": "mhypbase.dll is the user-mode half HoYoverse titles load. Documented; unmeasured." },
{ "family": "TenProtect", "match": "prefix", "values": [ "TP3Helper", "TenSafe" ],
"note": "Tencent TenProtect. TP3Helper documented (SteamDB); TenSafe unmeasured." },
{ "family": "AhnLab HackShield", "match": "prefix", "values": [ "EhSvc", "HShield", "HSInst" ],
"note": "Documented (SteamDB HackShield: HShield/HSInst.dll). Unmeasured." },
{ "family": "Anybrain", "match": "exact", "values": [ "anybrainSDK.dll", "Cerebro.dll" ],
"note": "Behavioural, user-mode. Documented (SteamDB AnyBrain). Unmeasured." },
{ "family": "Roblox Hyperion", "match": "exact", "values": [ "RobloxPlayerBeta.dll" ],
"note": "Hyperion (Byfron) protects this module inside the Roblox player. Documented; unmeasured." },
{ "family": "EQU8", "match": "prefix", "values": [ "equ8" ],
"note": "Splitgate. Documented (SteamDB EQU8); module names unmeasured." },
{ "family": "Xigncode3", "match": "exact", "values": [ "x3.xem" ],
"note": "x3.xem is XIGNCODE3's loader, LoadLibrary'd as an ordinary module (documented). The files row names the same token in the install tree." },
{ "family": "Anti-Cheat Expert", "match": "exact", "values": [ "ACE-Base64.dll" ],
"note": "ACE's user-mode module, MEASURED on disk 2026-10-13 in Wuthering Waves' AntiCheatExpert/ folder; that the game loads it is unmeasured. Exact, not prefix: 'ACE-' is four characters over a namespace we do not own. Appended, as every row since 2026-09-25." }
],
"drivers": [
{ "family": "Riot Vanguard", "match": "exact", "values": [ "vgk.sys" ], "scope": "machine" },
{ "family": "mihoyo protect", "match": "prefix", "values": [ "mhyprot" ], "scope": "machine" },
{ "family": "mihoyo protect", "match": "prefix", "values": [ "mhyprot", "HoYoKProtect" ], "scope": "machine",
"note": "HoYoKProtect.sys (Genshin Impact's overseas client, 2025) is NOT matched by the mhyprot prefix, so it is named here (documented; unmeasured)." },
{ "family": "Easy Anti-Cheat", "match": "prefix", "values": [ "EasyAntiCheat" ], "scope": "machine",
"note": "MEASURED 2026-08-04: EasyAntiCheat_EOSSys was Running as a kernel driver while a real EAC title played, and matched NOTHING in this group — the refusal came from the service check instead. A family caught through only one of five groups is one rename away from being missed." },
{ "family": "Anti-Cheat Expert", "match": "exact", "values": [ "ACE-BASE.sys", "ACE-ADVT.sys", "ACE-GAME.sys" ], "scope": "machine",
"note": "ACE-BASE.sys and ACE-ADVT.sys MEASURED under System32\\drivers on the dev machine 2026-08-04. ACE-GAME.sys is a documented sibling and is UNMEASURED: a blocklist may over-cover, never under-cover. Exact not prefix — 'ACE-' is four characters over a namespace we do not own." }
"note": "ACE-BASE.sys and ACE-ADVT.sys MEASURED under System32\\drivers on the dev machine 2026-08-04. ACE-GAME.sys is a documented sibling and is UNMEASURED: a blocklist may over-cover, never under-cover. Exact not prefix — 'ACE-' is four characters over a namespace we do not own." },
{ "family": "Anti-Cheat Expert", "match": "exact", "values": [ "ACE-CORE.sys" ], "scope": "machine",
"note": "On disk beside ACE-BASE.sys in Wuthering Waves' AntiCheatExpert/ folder (MEASURED 2026-10-13); that it loads is unmeasured. Exact, as the row above." },
{ "family": "BattlEye", "match": "exact", "values": [ "BEDaisy.sys" ], "scope": "machine",
"note": "BattlEye's kernel driver, loaded by BEService while a protected game runs and unloaded after (documented, BattlEye FAQ). Unmeasured." },
{ "family": "FACEIT", "match": "exact", "values": [ "FACEIT.sys" ], "scope": "machine",
"note": "Loaded while the FACEIT AC client runs (documented, FACEIT support). Unmeasured." },
{ "family": "ESEA", "match": "prefix", "values": [ "ESEADriver" ], "scope": "machine",
"note": "ESEADriver2.sys (documented). Unmeasured." },
{ "family": "EA AntiCheat", "match": "exact", "values": [ "EAAntiCheat.sys" ], "scope": "machine",
"note": "EA Javelin's kernel driver, loaded with the game (documented, EA forums). Unmeasured. Its user-mode EAAntiCheatService is deliberately NOT listed: it can be set to start automatically, and a service that is always running would refuse every session on the machine." },
{ "family": "Activision Ricochet", "match": "exact", "values": [ "randgrid.sys", "brynhildr.sys", "atvi-brynhildr.sys" ], "scope": "machine",
"note": "RICOCHET's kernel driver randgrid.sys (documented, Activision support; a kernel service pointing at the file in the game folder); brynhildr is its 2021 predecessor (Microsoft Q&A). Unmeasured." },
{ "family": "NetEase Anti-Cheat", "match": "prefix", "values": [ "NeacSafe" ], "scope": "machine",
"note": "NeacSafe64.sys, a minifilter loaded during play (documented, LOLDrivers). Unmeasured." },
{ "family": "Xigncode3", "match": "prefix", "values": [ "xhunter" ], "scope": "machine",
"note": "xhunter1.sys, XIGNCODE3's kernel driver (documented, LOLDrivers / Wellbia FAQ). Unmeasured." },
{ "family": "Denuvo Anti-Cheat", "match": "exact", "values": [ "denuvo-anti-cheat.sys" ], "scope": "machine",
"note": "Loaded only while a protected game runs (documented, Irdeto Q&A; file name from DRML). Unmeasured." },
{ "family": "EQU8", "match": "prefix", "values": [ "EQU8_HELPER" ], "scope": "machine",
"note": "EQU8_HELPER_<n>.sys (documented). Unmeasured." },
{ "family": "PunkBuster", "match": "prefix", "values": [ "PnkBstrK" ], "scope": "machine",
"note": "PnkBstrK.sys, PunkBuster's kernel component. Unmeasured." },
{ "family": "TenProtect", "match": "exact", "values": [ "TesSafe.sys" ], "scope": "machine",
"note": "Tencent game-protection driver (documented). Unmeasured." },
{ "family": "Nexon Game Security", "match": "exact", "values": [ "BlackCat64.sys" ], "scope": "machine",
"note": "Documented (SteamDB BlackCipher). Unmeasured." }
],
"directories": [
{ "family": "Easy Anti-Cheat", "values": [ "EasyAntiCheat" ] },
{ "family": "BattlEye", "values": [ "BattlEye" ] }
{ "family": "Easy Anti-Cheat", "values": [ "EasyAntiCheat", "EasyAntiCheat_EOS" ] },
{ "family": "BattlEye", "values": [ "BattlEye" ] },
{ "family": "Anti-Cheat Expert", "values": [ "AntiCheatExpert", "AceAntibotClient" ],
"note": "Documented (SteamDB FileDetectionRuleSets). AntiCheatExpert MEASURED 2026-10-13 beside the executables of Wuthering Waves and Neverness To Everness, reached from the executable's own folder and never from the root. AceAntibotClient is unmeasured." },
{ "family": "nProtect GameGuard", "values": [ "GameGuard" ] },
{ "family": "Xigncode3", "values": [ "XIGNCODE", "XIGNCODE3" ] },
{ "family": "AhnLab HackShield", "values": [ "HShield" ],
"note": "Documented (SteamDB HackShield). Unmeasured." },
{ "family": "Nexon Game Security", "values": [ "BlackCipher" ],
"note": "Measured by others at M1/Binaries/Win64/BlackCipher/ (The First Descendant, Steam community); unmeasured here." },
{ "family": "PunkBuster", "values": [ "PunkBuster" ],
"note": "Documented (SteamDB PunkBuster). The two-letter pb/ folder some titles use is deliberately NOT a token: too short to be a signal." },
{ "family": "FredaikisAntiCheat", "values": [ "FredaikisAntiCheat" ],
"note": "Documented (SteamDB FileDetectionRuleSets). Unmeasured." }
],
"services": [
{ "family": "Easy Anti-Cheat", "values": [ "EasyAntiCheat", "EasyAntiCheat_EOS", "EasyAntiCheat_EOSSys" ] },
{ "family": "Riot Vanguard", "values": [ "vgc" ] },
{ "family": "Anti-Cheat Expert", "values": [ "AntiCheatExpert Protection", "AntiCheatExpert Service" ],
"note": "'AntiCheatExpert Protection' MEASURED registered on the dev machine 2026-08-04 by Neverness To Everness. The sibling name is unmeasured." }
{ "family": "Riot Vanguard", "values": [ "vgc", "vgk" ],
"note": "vgk is the kernel driver's service, started at boot like vgk.sys itself." },
{ "family": "Anti-Cheat Expert", "values": [ "AntiCheatExpert Protection", "AntiCheatExpert Service", "ACE-BASE" ],
"note": "'AntiCheatExpert Protection' MEASURED registered on the dev machine 2026-08-04 by Neverness To Everness; 'ACE-BASE', the kernel service of ACE-BASE.sys, MEASURED registered there 2026-10-13. 'AntiCheatExpert Service' is unmeasured." },
{ "family": "BattlEye", "values": [ "BEService", "BEDaisy" ],
"note": "BEService is started by a protected game and stops after it; BEDaisy is the driver's service. A stopped service is absent (19_SAFETY). Unmeasured." },
{ "family": "FACEIT", "values": [ "FACEIT", "FACEITService" ],
"note": "Running while the FACEIT AC client runs (documented, FACEIT support). Unmeasured." },
{ "family": "ESEA", "values": [ "ESEADriver2" ] },
{ "family": "Activision Ricochet", "values": [ "atvi-randgrid_sr", "atvi-randgrid_msstore" ],
"note": "Kernel services pointing at randgrid.sys; running only while Call of Duty runs (documented, Activision support). Unmeasured." },
{ "family": "mihoyo protect", "values": [ "mhyprot2", "mhyprot3", "HoYoKProtect" ] },
{ "family": "Xigncode3", "values": [ "xhunter1" ] },
{ "family": "Denuvo Anti-Cheat", "values": [ "denuvo-anti-cheat" ],
"note": "The driver's service. The separate update service runs outside play and is deliberately NOT listed." },
{ "family": "nProtect GameGuard", "values": [ "npggsvc" ] }
],
"files": [
{ "family": "Xigncode3", "values": [ "x3.xem" ], "note": "Data file shipped beside the game, not a loadable module." },
{ "family": "Anti-Cheat Expert", "values": [ "PGameProtectDriver_X64.sys" ],
"note": "A KERNEL DRIVER shipped inside the game install. MEASURED at 'Neverness To Everness/NTEGlobal/driver/' 2026-08-04, where check 4 returned Allow: no group named it, and the fuzzy tier is modules-only — so a name containing 'protect' sat in the game's tree and the static scan walked past." }
{ "family": "Xigncode3", "values": [ "x3.xem", "xhunter1.sys" ],
"note": "Shipped beside the game. This note said 'not a loadable module' until 2026-09-25: XIGNCODE3 LoadLibrary's x3.xem as its loader (documented), which is why the modules group names it too." },
{ "family": "Anti-Cheat Expert", "values": [ "PGameProtectDriver_X64.sys", "SGuard64.exe", "SGuardSvc64.exe" ],
"note": "A KERNEL DRIVER shipped inside the game install. MEASURED at 'Neverness To Everness/NTEGlobal/driver/' 2026-08-04, where check 4 returned Allow: no group named it, and the fuzzy tier is modules-only — so a name containing 'protect' sat in the game's tree and the static scan walked past." },
{ "family": "Anti-Cheat Expert", "values": [ "ACE-BASE.sys", "ACE-CORE.sys", "ACE-Base64.dll", "ACE-Service64.exe", "ACE-Setup64.exe" ],
"note": "MEASURED 2026-10-13 in Wuthering Waves' Client/Binaries/Win64/AntiCheatExpert/, beside its executable and four levels under its install root, which the walk from the root never opened: check 4 also walks the executable's own folder since then." },
{ "family": "Easy Anti-Cheat", "values": [ "EasyAntiCheat_EOS_Setup.exe", "EasyAntiCheat_Setup.exe", "EasyAntiCheat_x64.dll", "EasyAntiCheat_x86.dll", "EasyAntiCheat_EOS.sys", "start_protected_game.exe", "eac_server64.dll" ],
"note": "For a layout where the EasyAntiCheat folder sits deeper than the scan reaches. start_protected_game.exe is the EAC launcher FromSoftware titles ship (ELDEN RING's appeared in the owner's Windows Application log on 2026-09-21)." },
{ "family": "BattlEye", "values": [ "BEService.exe", "BEService_x64.exe", "BEClient.dll", "BEClient_x64.dll", "BEDaisy.sys" ],
"note": "Documented (SteamDB BattlEye). Unmeasured." },
{ "family": "EA AntiCheat", "values": [ "EAAntiCheat.Installer.exe", "EAAntiCheat.GameServiceLauncher.exe", "EAAntiCheat.GameServiceLauncher.dll" ],
"note": "Documented (SteamDB EA_AntiCheat; EA forums). Unmeasured." },
{ "family": "Activision Ricochet", "values": [ "randgrid.sys" ],
"note": "The driver ships inside the game folder (documented, Activision support). Unmeasured." },
{ "family": "mihoyo protect", "values": [ "mhypbase.dll", "mhyprot2.sys", "mhyprot3.sys", "HoYoKProtect.sys" ] },
{ "family": "NetEase Anti-Cheat", "values": [ "NeacSafe64.sys", "NeacSafe64_ex.sys" ],
"note": "Documented (SteamDB NetEase_AntiCheatExperts). Unmeasured." },
{ "family": "NetEase Yidun", "values": [ "NEP2.dll" ] },
{ "family": "Nexon Game Security", "values": [ "BlackCipher.aes", "BlackCipher64.aes", "BlackCall.aes", "BlackCall64.aes", "BlackCat64.sys" ] },
{ "family": "TenProtect", "values": [ "TP3Helper.exe" ] },
{ "family": "EQU8", "values": [ "equ8_conf.json" ] },
{ "family": "AhnLab HackShield", "values": [ "HSInst.dll", "EhSvc.dll" ] },
{ "family": "nProtect GameGuard", "values": [ "GameGuard.des", "GameMon.des", "GameMon64.des", "npggNT.des", "npggNT64.des", "npsc.des" ],
"note": "GameGuard's engine files (documented, file.net / SteamDB). Unmeasured." },
{ "family": "PunkBuster", "values": [ "pbsvc.exe", "PnkBstrA.exe", "PnkBstrB.exe", "pbsv.dll", "pbcl.dll", "pbag.dll" ],
"note": "Files in the install tree, not services: PnkBstrA runs at every boot once installed, so as a service it would refuse every session on the machine." },
{ "family": "Anybrain", "values": [ "anybrainSDK.dll", "Cerebro.dll" ] },
{ "family": "Denuvo Anti-Cheat", "values": [ "denuvo-anti-cheat.sys", "denuvo-anti-cheat-runtime.dll", "denuvo-anti-cheat-update-service.exe" ],
"note": "Documented (DRML). Unmeasured." },
{ "family": "Roblox Hyperion", "values": [ "RobloxPlayerBeta.dll" ] }
],
"heuristic": {
"$comment": [
@@ -232,7 +377,61 @@
],
"action": "warn_and_refuse"
},
"blockedExecutables": [],
"blockedStoreIds": []
"blockedExecutables": [
{ "family": "Valve VAC", "match": "exact", "values": [ "cs2.exe", "csgo.exe", "dota2.exe", "tf_win64.exe", "deadlock.exe", "project8.exe", "left4dead2.exe", "gmod.exe" ],
"reason": "A VAC-secured online title. VAC runs inside Steam, so no file of the game's own names it." },
{ "family": "Riot Vanguard", "match": "exact", "values": [ "VALORANT-Win64-Shipping.exe", "League of Legends.exe" ],
"reason": "Protected by Riot Vanguard, a kernel anti-cheat that loads at boot." },
{ "family": "Roblox Hyperion", "match": "exact", "values": [ "RobloxPlayerBeta.exe" ],
"reason": "The Roblox player is protected by Hyperion anti-tamper." },
{ "family": "Blizzard Warden", "match": "exact", "values": [ "Overwatch.exe", "Diablo IV.exe", "Diablo III64.exe", "Wow.exe", "WowClassic.exe", "SC2_x64.exe", "HeroesOfTheStorm_x64.exe" ],
"reason": "An online Blizzard title: its anti-cheat is built into the game and ships no file of its own." },
{ "family": "Activision Ricochet", "match": "exact", "values": [ "cod.exe", "ModernWarfare.exe", "BlackOpsColdWar.exe" ],
"reason": "Call of Duty, protected by the RICOCHET kernel anti-cheat." },
{ "family": "NetEase Anti-Cheat", "match": "exact", "values": [ "Marvel-Win64-Shipping.exe", "NarakaBladepoint.exe" ],
"reason": "Protected by NetEase's kernel anti-cheat (NEAC)." },
{ "family": "Anti-Cheat Expert", "match": "exact", "values": [ "DeltaForceClient-Win64-Shipping.exe" ],
"reason": "Protected by Tencent Anti-Cheat Expert (ACE), a kernel anti-cheat." },
{ "family": "mihoyo protect", "match": "exact", "values": [ "GenshinImpact.exe", "YuanShen.exe", "StarRail.exe", "ZenlessZoneZero.exe", "BH3.exe" ],
"reason": "A HoYoverse title, protected by its kernel anti-cheat driver." },
{ "family": "EA AntiCheat", "match": "exact", "values": [ "bf2042.exe", "bf6.exe", "FC25.exe", "FC26.exe" ],
"reason": "Protected by EA AntiCheat (Javelin), a kernel anti-cheat." }
],
"blockedStoreIds": [
{ "store": "steam", "id": "730", "family": "Valve VAC", "reason": "A VAC-secured online title. VAC runs inside Steam, so no file of the game's own names it." },
{ "store": "steam", "id": "570", "family": "Valve VAC", "reason": "A VAC-secured online title. VAC runs inside Steam, so no file of the game's own names it." },
{ "store": "steam", "id": "440", "family": "Valve VAC", "reason": "A VAC-secured online title. VAC runs inside Steam, so no file of the game's own names it." },
{ "store": "steam", "id": "1422450", "family": "Valve VAC", "reason": "A VAC-secured online title. VAC runs inside Steam, so no file of the game's own names it." },
{ "store": "steam", "id": "240", "family": "Valve VAC", "reason": "A VAC-secured online title. VAC runs inside Steam, so no file of the game's own names it." },
{ "store": "steam", "id": "10", "family": "Valve VAC", "reason": "A VAC-secured online title. VAC runs inside Steam, so no file of the game's own names it." },
{ "store": "steam", "id": "80", "family": "Valve VAC", "reason": "A VAC-secured online title. VAC runs inside Steam, so no file of the game's own names it." },
{ "store": "steam", "id": "550", "family": "Valve VAC", "reason": "A VAC-secured online title. VAC runs inside Steam, so no file of the game's own names it." },
{ "store": "steam", "id": "500", "family": "Valve VAC", "reason": "A VAC-secured online title. VAC runs inside Steam, so no file of the game's own names it." },
{ "store": "steam", "id": "4000", "family": "Valve VAC", "reason": "A VAC-secured online title. VAC runs inside Steam, so no file of the game's own names it." },
{ "store": "steam", "id": "320", "family": "Valve VAC", "reason": "A VAC-secured online title. VAC runs inside Steam, so no file of the game's own names it." },
{ "store": "steam", "id": "300", "family": "Valve VAC", "reason": "A VAC-secured online title. VAC runs inside Steam, so no file of the game's own names it." },
{ "store": "steam", "id": "20", "family": "Valve VAC", "reason": "A VAC-secured online title. VAC runs inside Steam, so no file of the game's own names it." },
{ "store": "steam", "id": "1938090", "family": "Activision Ricochet", "reason": "Call of Duty, protected by the RICOCHET kernel anti-cheat." },
{ "store": "steam", "id": "1962663", "family": "Activision Ricochet", "reason": "Call of Duty, protected by the RICOCHET kernel anti-cheat." },
{ "store": "steam", "id": "3595270", "family": "Activision Ricochet", "reason": "Call of Duty, protected by the RICOCHET kernel anti-cheat." },
{ "store": "steam", "id": "4384550", "family": "Activision Ricochet", "reason": "Call of Duty, protected by the RICOCHET kernel anti-cheat." },
{ "store": "steam", "id": "2519060", "family": "Activision Ricochet", "reason": "Call of Duty, protected by the RICOCHET kernel anti-cheat." },
{ "store": "steam", "id": "2357570", "family": "Blizzard Warden", "reason": "An online Blizzard title: its anti-cheat is built into the game and ships no file of its own." },
{ "store": "steam", "id": "2344520", "family": "Blizzard Warden", "reason": "An online Blizzard title: its anti-cheat is built into the game and ships no file of its own." },
{ "store": "steam", "id": "2767030", "family": "NetEase Anti-Cheat", "reason": "Protected by NetEase's kernel anti-cheat (NEAC)." },
{ "store": "steam", "id": "1203220", "family": "NetEase Anti-Cheat", "reason": "Protected by NetEase's kernel anti-cheat (NEAC)." },
{ "store": "steam", "id": "2943650", "family": "NetEase Anti-Cheat", "reason": "Protected by NetEase's kernel anti-cheat (NEAC)." },
{ "store": "steam", "id": "2139460", "family": "NetEase Anti-Cheat", "reason": "Protected by NetEase's kernel anti-cheat (NEAC)." },
{ "store": "steam", "id": "2507950", "family": "Anti-Cheat Expert", "reason": "Protected by Tencent Anti-Cheat Expert (ACE), a kernel anti-cheat." },
{ "store": "steam", "id": "2073620", "family": "Anti-Cheat Expert", "reason": "Protected by Tencent Anti-Cheat Expert (ACE), a kernel anti-cheat." },
{ "store": "steam", "id": "3513350", "family": "Anti-Cheat Expert", "reason": "Wuthering Waves, protected by Tencent Anti-Cheat Expert (ACE), a kernel anti-cheat." },
{ "store": "steam", "id": "1517290", "family": "EA AntiCheat", "reason": "Protected by EA AntiCheat (Javelin), a kernel anti-cheat." },
{ "store": "steam", "id": "2807960", "family": "EA AntiCheat", "reason": "Protected by EA AntiCheat (Javelin), a kernel anti-cheat." },
{ "store": "steam", "id": "2669320", "family": "EA AntiCheat", "reason": "Protected by EA AntiCheat (Javelin), a kernel anti-cheat." },
{ "store": "steam", "id": "3405690", "family": "EA AntiCheat", "reason": "Protected by EA AntiCheat (Javelin), a kernel anti-cheat." },
{ "store": "steam", "id": "3224770", "family": "CrackProof", "reason": "Protected by CrackProof (HyperTech), a kernel anti-cheat; its driver is not in the game's folder." },
{ "store": "steam", "id": "1973710", "family": "CrackProof", "reason": "Protected by CrackProof (HyperTech), a kernel anti-cheat; its driver is not in the game's folder." },
{ "store": "steam", "id": "2987800", "family": "CrackProof", "reason": "Protected by CrackProof (HyperTech), a kernel anti-cheat; its driver is not in the game's folder." }
]
}
}
+18 -9
View File
@@ -196,6 +196,15 @@
"type": { "const": "manifest_field" },
"field": { "$ref": "#/$defs/manifestFieldPath" }
}
},
{
"$comment": "beta.10: Unreal Engine's build facts (the shipping executable's numeric file version and the engine's branch name inside it), decided in code (Domain.Detection.UnrealVersion) rather than by a pattern - which is why it takes no parameter. beta.19 adds Unity's (the player library's version resource, the data file's header), Godot's (a data pack's header, the executable's version resource) and RPG Maker's (MV/MZ's core-script header, the RGSS library Game.ini names), decided by UnityVersion, GodotVersion and RpgMakerVersion. beta.20 adds Ren'Py's (the version line of the engine's renpy/vc_version.py), decided by RenPyVersion.",
"type": "object",
"additionalProperties": false,
"required": ["type"],
"properties": {
"type": { "enum": ["unreal_build", "unity_build", "godot_build", "rpgmaker_build", "renpy_build"] }
}
}
]
}
@@ -404,7 +413,7 @@
"$comment": "maxItems is fl::guard::kMaxFamilies, and it bounds the SUM of all five groups, not this one array - the parser fills a single families[kMaxFamilies] from all of them. A schema cannot express a cross-array total, so the per-array cap is set to the total (no single array can breach it alone) and tools/rules-validate.ps1 checks the sum imperatively. Exceeding it is ParseResult::kTooLarge for the whole file, i.e. the guard refuses every title.",
"type": "array",
"minItems": 1,
"maxItems": 64,
"maxItems": 256,
"items": { "$ref": "#/$defs/acMatchGroup" },
"allOf": [
{
@@ -420,7 +429,7 @@
"drivers": {
"type": "array",
"minItems": 1,
"maxItems": 64,
"maxItems": 256,
"items": { "$ref": "#/$defs/acDriverGroup" },
"allOf": [
{
@@ -429,29 +438,29 @@
]
},
"directories": { "type": "array", "minItems": 1, "maxItems": 64, "items": { "$ref": "#/$defs/acNameGroup" } },
"services": { "type": "array", "minItems": 1, "maxItems": 64, "items": { "$ref": "#/$defs/acNameGroup" } },
"directories": { "type": "array", "minItems": 1, "maxItems": 256, "items": { "$ref": "#/$defs/acNameGroup" } },
"services": { "type": "array", "minItems": 1, "maxItems": 256, "items": { "$ref": "#/$defs/acNameGroup" } },
"files": {
"$comment": "NEW in this schema. 19_SAFETY lists Xigncode3's `x3.xem`, which is a data file shipped beside the game rather than a loadable module - the previous seed had nowhere to put it. Also the home for the anti-cheat SDK payloads that 19_SAFETY check 4 (multiplayer heuristic) looks for during the static pre-scan.",
"$comment": "NEW in this schema. 19_SAFETY lists Xigncode3's `x3.xem`, which is a data file shipped beside the game rather than a loadable module - the previous seed had nowhere to put it (2026-09-25: XIGNCODE3 also LoadLibrary's it as its loader, so modules names it too). Also the home for the anti-cheat SDK payloads that 19_SAFETY check 4 (multiplayer heuristic) looks for during the static pre-scan.",
"type": "array",
"minItems": 1,
"maxItems": 64,
"maxItems": 256,
"items": { "$ref": "#/$defs/acNameGroup" }
},
"heuristic": { "$ref": "#/$defs/heuristic" },
"blockedExecutables": {
"$comment": "May legitimately be empty - a per-title list, not the family blocklist. minItems is deliberately absent here and deliberately present on modules/drivers. maxItems is fl::guard::kMaxTitleRules; at kMaxValuesPerTitleRule values each that is 512 blockable names, more than the 4096 this used to claim could ever have survived the parser.",
"$comment": "May legitimately be empty - a per-title list, not the family blocklist. minItems is deliberately absent here and deliberately present on modules/drivers. maxItems is fl::guard::kMaxTitleRules (128 since 2026-09-25); at kMaxValuesPerTitleRule values each that is 1024 blockable names, more than the 4096 this used to claim could ever have survived the parser.",
"type": "array",
"maxItems": 64,
"maxItems": 128,
"items": { "$ref": "#/$defs/acBlockedExecutable" }
},
"blockedStoreIds": {
"type": "array",
"maxItems": 64,
"maxItems": 128,
"items": { "$ref": "#/$defs/acBlockedStoreId" }
}
}
+3
View File
@@ -1,3 +1,6 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
namespace FrameLedger.Agent;
/// <summary>
+3
View File
@@ -1,3 +1,6 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using FrameLedger.Infrastructure.Persistence;
namespace FrameLedger.Agent;
+66 -4
View File
@@ -1,4 +1,9 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using System.Globalization;
using System.Security.Principal;
using FrameLedger.Infrastructure.Startup;
namespace FrameLedger.Agent.Cli;
@@ -11,6 +16,13 @@ namespace FrameLedger.Agent.Cli;
/// <b><c>--data-dir</c> exists only under <c>--console</c></b> (HANDOFF §P2 decision D6): an integration test
/// needs a scratch ledger, and CI must never touch the profile. <c>--serve</c> with it is an error rather than an
/// ignored option, because an ignored option is how the product directory becomes selectable by accident.
/// <para>
/// <b><c>--serve</c> takes two options since beta.10, and only these</b> (the Agent's admin mode, owner decision D34):
/// <c>--for-user &lt;SID&gt;</c>, which the starter passes to the Agent it asked Windows to elevate — the Agent refuses to run
/// as any other account (<c>AgentElevation.ExitOtherAccount</c>) — and <c>--elevation &lt;outcome&gt;</c>, which says the
/// starter asked and was not granted, so this Agent does not ask again. Neither names a directory, a target or a check; the
/// data folder is still the profile's and nothing else.
/// </para>
/// </remarks>
internal sealed record AgentCommandLine
{
@@ -29,8 +41,9 @@ internal sealed record AgentCommandLine
};
private const string _usage =
"usage: FrameLedger.Agent --serve\n"
"usage: FrameLedger.Agent --serve [--for-user <SID> | --elevation declined|other-account|failed]\n"
+ " FrameLedger.Agent --register-vklayer | --unregister-vklayer | --install-task | --uninstall-task\n"
+ " FrameLedger.Agent --write-crash-dump <file> (started by a crashing App or Agent; dumps that parent)\n"
+ " FrameLedger.Agent --console [--data-dir <dir>] consent list | consent grant --exe <path> | consent revoke --exe <path>\n"
+ " | capture --exe <path> [--seconds <n>] | launch --exe <path> [--args \"<string>\"] [--seconds <n>]\n"
+ " | recover | sessions [--last <n>] | db path | games add --exe <path>\n"
@@ -58,6 +71,15 @@ internal sealed record AgentCommandLine
public string? DataDirectory { get; init; }
/// <summary><c>--serve --for-user</c>: the account whose Agent this elevated process must be (beta.10, D34).</summary>
public string? ForUser { get; init; }
/// <summary><c>--serve --elevation</c>: the starter asked for elevation and got this instead (<c>AgentElevation.Refusals</c>).</summary>
public string? ElevationRefusal { get; init; }
/// <summary>The file <see cref="AgentVerb.WriteCrashDump"/> writes — a path, never a pid.</summary>
public string? CrashDumpFile { get; init; }
/// <summary>The flag behind <see cref="AgentVerb.NotImplemented"/>.</summary>
public string? Flag { get; init; }
@@ -84,11 +106,16 @@ internal sealed record AgentCommandLine
: new AgentCommandLine { Error = $"{args[0]} takes no options" };
}
if (string.Equals(args[0], "--write-crash-dump", StringComparison.Ordinal))
{
return args.Length == 2 && !string.IsNullOrWhiteSpace(args[1])
? new AgentCommandLine { Verb = AgentVerb.WriteCrashDump, CrashDumpFile = args[1] }
: new AgentCommandLine { Error = "--write-crash-dump takes exactly one argument, the dump's file" };
}
if (string.Equals(args[0], "--serve", StringComparison.Ordinal))
{
return args.Length == 1
? new AgentCommandLine { Verb = AgentVerb.Serve }
: new AgentCommandLine { Error = "--serve takes no options; --data-dir exists only under --console (the product directory is not selectable)" };
return ParseServe(args[1..]);
}
if (!string.Equals(args[0], "--console", StringComparison.Ordinal))
@@ -99,6 +126,41 @@ internal sealed record AgentCommandLine
return ParseConsole(args[1..]);
}
/// <summary><c>--serve</c>, alone or with ONE of its two admin-mode options (beta.10).</summary>
private static AgentCommandLine ParseServe(string[] rest)
{
const string onlyThese = "--serve takes only --for-user <SID> or --elevation declined|other-account|failed (the agent's admin mode); "
+ "--data-dir exists only under --console (the product directory is not selectable)";
if (rest.Length == 0)
{
return new AgentCommandLine { Verb = AgentVerb.Serve };
}
if (rest.Length != 2)
{
return new AgentCommandLine { Error = onlyThese };
}
switch (rest[0])
{
case "--for-user":
try
{
// A SID in its string form, validated as one: the Agent compares it with its own token's user.
return new AgentCommandLine { Verb = AgentVerb.Serve, ForUser = new SecurityIdentifier(rest[1]).Value };
}
catch (ArgumentException)
{
return new AgentCommandLine { Error = $"--for-user needs a SID, not '{rest[1]}'" };
}
case "--elevation" when AgentElevation.Refusals.Contains(rest[1], StringComparer.Ordinal):
return new AgentCommandLine { Verb = AgentVerb.Serve, ElevationRefusal = rest[1] };
default:
return new AgentCommandLine { Error = onlyThese };
}
}
private static AgentCommandLine ParseConsole(string[] rest)
{
(AgentVerb verb, int at, int words) = VerbOf(rest);
+10
View File
@@ -1,3 +1,6 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
namespace FrameLedger.Agent.Cli;
/// <summary>What the Agent can be asked to do (P2 PR-F). The surface is pinned by <c>AgentCommandLineSurfaceTests</c>.</summary>
@@ -35,4 +38,11 @@ internal enum AgentVerb
/// <summary><c>--uninstall-task</c>.</summary>
UninstallTask,
/// <summary>
/// <c>--write-crash-dump &lt;file&gt;</c> (2026-09-17): the crash-dump helper. Dumps this process's PARENT — the App or
/// Agent that crashed and started it — when that parent's image is in this binary's directory; takes no pid
/// (<c>Infrastructure.Diagnostics.ParentDump</c>).
/// </summary>
WriteCrashDump,
}
+4 -1
View File
@@ -1,3 +1,6 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using FrameLedger.Agent.Composition;
using FrameLedger.Application.Capture;
using FrameLedger.Application.Consent;
@@ -276,7 +279,7 @@ internal sealed class ConsoleVerbs(IServiceProvider services, AgentPaths paths)
return result.Reason switch
{
SessionEndReason.TargetExited or SessionEndReason.Running => _exitOk,
SessionEndReason.TargetNotRunning or SessionEndReason.TargetAmbiguous
SessionEndReason.TargetNotRunning or SessionEndReason.TargetAmbiguous or SessionEndReason.TargetUnreadable
or SessionEndReason.TargetCannotBePinned or SessionEndReason.LaunchCannotStart => _exitTargetNotResolved,
SessionEndReason.AttachRefused => _exitAttachRefused,
SessionEndReason.SafetyUnhook or SessionEndReason.SupervisionLost or SessionEndReason.KillSwitchEngaged
Loaded 100 of 1409 files, more files were not shown because too many files have changed in this diff. Show more