Compare commits
65
Commits
No files matched your search
@@ -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.
|
||||
@@ -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,18 @@ 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)"
|
||||
|
||||
# 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
|
||||
@@ -205,6 +233,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 +250,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
|
||||
|
||||
+1103
-2
File diff suppressed because it is too large.
Load diff
@@ -12,6 +12,12 @@ 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, 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).
|
||||
@@ -22,6 +28,8 @@ A C++ DLL (`FrameLedger.Overlay.dll`) is injected into games the user explicitly
|
||||
> **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*).
|
||||
@@ -169,6 +177,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
|
||||
|
||||
+19
-12
@@ -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>
|
||||
@@ -28,7 +28,7 @@
|
||||
</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 +37,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 +56,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 +64,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.0" />
|
||||
<PackageVersion Include="Meziantou.Analyzer" Version="3.0.266" />
|
||||
<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 +101,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>
|
||||
|
||||
|
||||
+130
@@ -0,0 +1,130 @@
|
||||
# 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.11.*
|
||||
|
||||
## 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; 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) 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))
|
||||
|
||||
## 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))
|
||||
|
||||
## Upscaling and ray tracing
|
||||
|
||||
- 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, each game's own video-memory use and shader-compilation stutter are
|
||||
**not measured yet** — they read N/A. Video memory in use on the whole graphics card is recorded.
|
||||
([Accuracy](legal/ACCURACY.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.** 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.
|
||||
- **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))
|
||||
|
||||
## 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.
|
||||
- **No real Vulkan or OpenGL game has been measured yet** — only FrameLedger's own test program.
|
||||
- There is **no in-game overlay**; everything is shown in the FrameLedger window.
|
||||
|
||||
## 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.
|
||||
@@ -5,10 +5,12 @@
|
||||
> No telemetry. No accounts. All data stays on your machine.
|
||||
|
||||
<!-- 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-03.** The software is a beta; its latest
|
||||
> **pre-release is `0.1.0-beta.11`** (2026-10-03), 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
|
||||
@@ -21,8 +23,10 @@
|
||||
> 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 +39,47 @@
|
||||
> - **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. Other engines show what their own
|
||||
> files state.
|
||||
> - **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.
|
||||
> spikes were shader compilation, PC latency (Reflex), and HDR. Stutter count and stutter time are
|
||||
> measured from frame times.
|
||||
> - **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
|
||||
@@ -86,7 +115,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 decision D33):** 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 — and that FrameLedger has measured successfully at least twice may be hooked under a user-mode exception. 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 |
|
||||
@@ -109,21 +138,21 @@ The tier is recorded on every session and shown in the UI. Metrics unavailable a
|
||||
| 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.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) |
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## 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
|
||||
|
||||
## 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.11` (2026-10-03); before it `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,9 +160,7 @@ 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
|
||||
|
||||
@@ -147,10 +174,10 @@ Developer/AI-facing docs in [`docs/`](docs/). Start with `CLAUDE.md`, then `docs
|
||||
|
||||
## 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.
|
||||
|
||||
---
|
||||
|
||||
**Status:** pre-alpha, under active development. Roadmap: [`docs/15_ROADMAP.md`](docs/15_ROADMAP.md).
|
||||
**Status:** pre-release (beta). Eleven 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
@@ -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.
|
||||
@@ -68,6 +68,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 +272,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 +299,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,12 +311,8 @@ 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
|
||||
|
||||
@@ -93,6 +93,16 @@ Guard re-runs every 30 s for the life of the session; anti-cheat appearing late
|
||||
- UI exit does not stop the Agent when background capture is enabled; otherwise UI sends `Shutdown`.
|
||||
- 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 |
|
||||
@@ -132,3 +142,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.
|
||||
+15
-5
@@ -10,12 +10,16 @@ Requirement IDs (`FR-x`, `NFR-x`) are referenced by other docs, commits, and tes
|
||||
- FR-1.3 Editable metadata (name, cover, publisher, version, notes); auto-detected fields badged and overridable.
|
||||
- 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.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.
|
||||
|
||||
@@ -52,12 +56,14 @@ 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.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.**
|
||||
|
||||
### FR-8 Tri-state flags
|
||||
@@ -71,7 +77,11 @@ 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. **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.
|
||||
|
||||
+151
-3
@@ -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 |
|
||||
@@ -55,8 +55,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
|
||||
@@ -369,6 +393,36 @@ 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
|
||||
@@ -447,6 +501,15 @@ 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.
|
||||
@@ -460,6 +523,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 +584,18 @@ 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.
|
||||
|
||||
## RT / PT / RR — evidence-based tri-state
|
||||
|
||||
@@ -600,6 +681,70 @@ 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`.
|
||||
|
||||
## Display mode — both tiers (beta.10)
|
||||
|
||||
**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.
|
||||
|
||||
## Per-process VRAM (Tier 1)
|
||||
|
||||
`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).
|
||||
@@ -619,8 +764,11 @@ Per session over 1 Hz samples: `avg` (mean of non-null), `max`. Sensor timeline
|
||||
| Path tracing | heuristic, confidence-scored, never asserted | not available |
|
||||
| Per-process VRAM | exact | not available |
|
||||
| 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 |
|
||||
| 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.
|
||||
|
||||
@@ -649,4 +797,4 @@ Per-column sources, and what a *Tier-2* export does instead:
|
||||
| `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` |
|
||||
| `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 tier belongs in the header because a Tier-2 export is missing whole columns and anyone reading it later must know why.
|
||||
+117
-6
@@ -38,7 +38,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 +76,28 @@ 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. **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 +127,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` — 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 +137,20 @@ 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. **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,11 +162,28 @@ 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.
|
||||
|
||||
> **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
|
||||
> loaded nothing and the module scan *fails* against it (`ERROR_PARTIAL_COPY`, §S1 measured), so the guard
|
||||
@@ -182,6 +236,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 +300,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
|
||||
@@ -254,7 +321,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,6 +337,12 @@ 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.
|
||||
@@ -317,6 +390,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,8 +431,8 @@ 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]`.
|
||||
- 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 within `[start, end + 30 s]`.
|
||||
- `unhooked_safety`: the guard fired mid-session.
|
||||
- `degraded`: Overlay self-disabled after faults, or ring layout mismatch mid-session.
|
||||
- `interrupted`: Agent died mid-session; recovered from `.partial` on next start.
|
||||
@@ -361,6 +450,21 @@ 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
|
||||
|
||||
@@ -373,6 +477,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)
|
||||
|
||||
|
||||
+155
-18
@@ -26,11 +26,16 @@ 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.
|
||||
|
||||
> **"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,7 +47,7 @@ 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 since beta.10 is how its window was shown** (the display-mode row), which the Agent reads from outside the game in either tier.
|
||||
|
||||
## Static hints — rules engine
|
||||
|
||||
@@ -61,7 +66,7 @@ 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.
|
||||
|
||||
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
|
||||
@@ -132,11 +137,13 @@ 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+)` |
|
||||
| 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")` | strings regex `Godot Engine v(\d+\.\d+[\.\d]*)` |
|
||||
| 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 |
|
||||
| RPG Maker MV/MZ | `nw.dll` **and** `package.json` siblings (since 2026-09-16) | `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) | `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 |
|
||||
| CryEngine | `CrySystem.dll` | FileVersion |
|
||||
| Source | `gameinfo.txt` + `bin/engine.dll` | `N/A` |
|
||||
@@ -146,13 +153,92 @@ 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.
|
||||
|
||||
### Platform signatures & metadata
|
||||
|
||||
| Platform | Signals | Metadata |
|
||||
@@ -160,19 +246,36 @@ Everything else in the table is in the data and has a fixture; `rules-validate.p
|
||||
| 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 |
|
||||
| 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.
|
||||
**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 +286,7 @@ 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.
|
||||
**Publisher/version order:** store manifest → PE `CompanyName`/`ProductVersion` → *(opt-in)* Steam `appdetails` lookup, cached 7 days. *(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 +294,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,11 +308,42 @@ 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).
|
||||
|
||||
Three things this section previously implied that are not true, and are worth stating:
|
||||
|
||||
@@ -225,7 +359,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
|
||||
|
||||
+205
-7
@@ -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 is the one Agent write that deletes a `games` row; it never touches a consent column. **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. **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).
|
||||
|
||||
## Schema (v2 — hook architecture)
|
||||
|
||||
@@ -40,10 +40,15 @@ 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, 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,
|
||||
removed_at INTEGER, -- schema 0002 (P3 PR-3): FR-1.4 "remove, keep sessions" — the row stays
|
||||
@@ -53,7 +58,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 +97,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
|
||||
@@ -238,7 +276,23 @@ 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 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);
|
||||
|
||||
@@ -276,12 +330,22 @@ CREATE TABLE frame_blobs (
|
||||
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
|
||||
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
|
||||
-- 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)
|
||||
);
|
||||
@@ -325,14 +389,19 @@ 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) |
|
||||
| `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.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) |
|
||||
| `capture.background` | bool | `1` | | Agent |
|
||||
| `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) |
|
||||
| `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
|
||||
@@ -350,6 +419,9 @@ Because Tier-1 and Tier-2 sessions carry different fields, every query that comp
|
||||
> 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).
|
||||
|
||||
@@ -380,6 +452,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
|
||||
|
||||
@@ -422,11 +504,127 @@ 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.
|
||||
|
||||
> **`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`.
|
||||
|
||||
> **`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`.
|
||||
|
||||
> **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
|
||||
|
||||
+128
-16
@@ -12,13 +12,15 @@ Three channels, each chosen for its constraints:
|
||||
|
||||
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 +51,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 +73,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 +301,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 +354,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`.)*
|
||||
@@ -306,23 +386,27 @@ Unchanged in spirit from v1, bumped to `v2` for the new message set.
|
||||
|
||||
| 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) 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 | `{ 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.)* |
|
||||
| `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? }` — how long it has run and the machine's sensors. **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? }` — 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 }` — **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` 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.)* |
|
||||
| `SafetyUnhook` | A→UI | `{ sessionGuid, family?, signal?, hookingTurnedOff }` — 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.)* |
|
||||
| `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 +447,38 @@ message, and that message always re-scans.
|
||||
|
||||
## Client behavior (UI)
|
||||
|
||||
- **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.
|
||||
|
||||
> **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.
|
||||
- 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
|
||||
|
||||
|
||||
+304
-6
@@ -24,7 +24,11 @@ WPF + **WPF UI (Wpf.Ui, Fluent)**. Shell = `ui:FluentWindow` with custom `ui:Tit
|
||||
**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:** Check for updates · Report a bug… · Documentation · Limitations · About FrameLedger (App / Developer / Third-party licenses tabs)
|
||||
|
||||
> **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*. It is information, not one of FR-11's documents:
|
||||
> nothing is accepted or recorded, and the Disclaimer points at it.
|
||||
|
||||
The Menu sits in its own row **below** the TitleBar (never inside the drag region — 16 §Gotchas).
|
||||
|
||||
@@ -55,6 +59,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`,
|
||||
@@ -92,7 +97,12 @@ 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).
|
||||
@@ -105,6 +115,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,7 +131,8 @@ 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).
|
||||
|
||||
@@ -140,9 +159,41 @@ All screens are `Page`s registered with the navigation page provider and navigat
|
||||
> 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.
|
||||
>
|
||||
> **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). **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.
|
||||
- **Two clearly separated rows** (`05_DETECTION` §Capability hints — conflating these was the old design's core mistake):
|
||||
@@ -158,7 +209,10 @@ All screens are `Page`s registered with the navigation page provider and navigat
|
||||
> 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), **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,11 +222,98 @@ 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`.
|
||||
- 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.
|
||||
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).
|
||||
|
||||
> **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`).
|
||||
5. **Sensors** — temp/load/power/VRAM timelines per session; per-process VRAM and adapter-wide VRAM as separate, differently-labelled series.
|
||||
6. **Latency** *(Tier 1 + Reflex only)* — PC latency timeline, avg/p95.
|
||||
|
||||
@@ -188,9 +329,36 @@ All screens are `Page`s registered with the navigation page provider and navigat
|
||||
> 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.
|
||||
>
|
||||
> **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).
|
||||
|
||||
### 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), 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.
|
||||
|
||||
> **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
|
||||
@@ -207,6 +375,41 @@ 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, 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 `#`
|
||||
@@ -215,6 +418,32 @@ Stat cards (Avg uses `FpsReadout`, Median, 1% Low, 0.1% Low, Min/Max, σ, stutte
|
||||
> 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 +459,9 @@ 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.
|
||||
|
||||
### 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).
|
||||
@@ -245,10 +477,30 @@ Tail view of `ui-*.log` / `agent-*.log` (toggle), level filter, search (`ui:Auto
|
||||
> `PagesLoadTests`.
|
||||
|
||||
### Settings
|
||||
> **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`.
|
||||
|
||||
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.
|
||||
|
||||
**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. Privacy: online-metadata opt-in with plain-language explanation. 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
|
||||
@@ -269,7 +521,7 @@ Agent section: elevation state with a plain explanation of what elevation *optio
|
||||
> 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.
|
||||
> 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), 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
|
||||
@@ -286,6 +538,25 @@ 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.
|
||||
@@ -367,6 +638,33 @@ meet it — and cannot be broken locally: `AccessibilityTests.NoXamlHardCodesACo
|
||||
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).
|
||||
|
||||
> **"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.
|
||||
|
||||
### DPI
|
||||
|
||||
`app.manifest` declares Per-Monitor V2 (`AccessibilityTests.TheManifestIsPerMonitorV2`).
|
||||
|
||||
@@ -2,6 +2,13 @@
|
||||
|
||||
Languages: **en** (neutral/default) · **vi** · **ja**. Same `.resx` pattern as the rest of the poli0981 portfolio.
|
||||
|
||||
> **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.
|
||||
@@ -55,6 +62,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
|
||||
|
||||
@@ -15,6 +15,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
|
||||
@@ -144,6 +155,10 @@ Tails the active files (shared read), level filter, text search, pause autoscrol
|
||||
- **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
|
||||
|
||||
+15
-3
@@ -36,6 +36,11 @@ Binaries are not code-signed (project policy). Consequences and mitigations, doc
|
||||
|
||||
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 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
|
||||
@@ -58,12 +63,19 @@ flow, and the tests run the flow over a fake client because nothing here may tou
|
||||
- **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
|
||||
|
||||
+13
-2
@@ -88,7 +88,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 +100,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.
|
||||
@@ -203,7 +214,7 @@ 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()`.
|
||||
- `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). **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.
|
||||
|
||||
## Release-time token substitution
|
||||
|
||||
+68
-8
@@ -26,6 +26,32 @@ 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.
|
||||
- **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
|
||||
@@ -69,11 +95,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.
|
||||
@@ -152,10 +198,24 @@ Central package management makes Dependabot PRs single-file diffs.
|
||||
- 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).
|
||||
- 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
|
||||
- [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):**
|
||||
|
||||
- [ ] Branch protection as §Branch & release policy states; `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)
|
||||
- [ ] Private vulnerability reporting enabled (Settings ▸ Security), so `config.yml`'s link resolves
|
||||
- [ ] Repo topics: `windows`, `wpf`, `benchmark`, `fps`, `game-performance` (~~`presentmon`~~ — dropped 2026-08-27, §G)
|
||||
+6
-5
@@ -1,19 +1,20 @@
|
||||
# 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 native suites on every gate (`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. **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.
|
||||
|
||||
## Native unit tests (Catch2)
|
||||
|
||||
@@ -130,7 +131,7 @@ 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* |
|
||||
|
||||
## Release smoke
|
||||
|
||||
|
||||
+3
-3
@@ -298,7 +298,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,7 +311,7 @@ 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.*
|
||||
@@ -320,7 +320,7 @@ WPF UI shell (`16_WPFUI_SYNTAX`), library, per-game hooking consent flow, Dashbo
|
||||
~~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** (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.
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ 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` | **= 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 | 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) |
|
||||
@@ -144,6 +144,13 @@ 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.
|
||||
- **`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.
|
||||
|
||||
|
||||
+13
-3
@@ -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.
|
||||
@@ -133,7 +143,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
|
||||
@@ -169,7 +179,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 |
|
||||
@@ -614,7 +624,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.
|
||||
|
||||
|
||||
@@ -112,6 +112,24 @@ L1 gives no temperatures on its own (unless the D3DKMT probe pans out). That is
|
||||
|
||||
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 — 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 +164,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 +308,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)
|
||||
|
||||
|
||||
+395
-29
@@ -18,7 +18,7 @@ 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
|
||||
|
||||
@@ -220,6 +220,43 @@ Implemented in `FrameLedger.Injector` and reached from managed code through a th
|
||||
> 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).
|
||||
|
||||
> **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 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).
|
||||
> 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
|
||||
> module scan and the pre-scan, and an unresolvable identity refuses with
|
||||
@@ -250,6 +287,23 @@ 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
|
||||
> **depth 3** — raised from 2 on 2026-08-04 (§S22, `spike-notes.md` §13), because a
|
||||
@@ -311,7 +365,7 @@ Implemented in `FrameLedger.Injector` and reached from managed code through a th
|
||||
> 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 +402,175 @@ 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.)*
|
||||
|
||||
**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 and
|
||||
FredaikisAntiCheat; 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 — 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 +644,108 @@ 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 | `drivers` | exact | `ACE-BASE.sys`, `ACE-ADVT.sys`, `ACE-GAME.sys` — **machine-wide refusal** (check 2) | seed |
|
||||
| Anti-Cheat Expert | `directories` | name | `AntiCheatExpert`, `AceAntibotClient` | 2026-09-25 |
|
||||
| Anti-Cheat Expert | `services` | name | `AntiCheatExpert Protection`, `AntiCheatExpert Service` | seed |
|
||||
| Anti-Cheat Expert | `files` | name | `PGameProtectDriver_X64.sys`, `SGuard64.exe`, `SGuardSvc64.exe` | seed; `SGuard64.exe`, `SGuardSvc64.exe` 2026-09-25 |
|
||||
| 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); VAC's stays until its per-title route exists.
|
||||
|
||||
> **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`
|
||||
@@ -605,6 +903,26 @@ injected or layered**.
|
||||
|
||||
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 +986,55 @@ 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).
|
||||
|
||||
### 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
|
||||
|
||||
@@ -697,7 +1063,7 @@ rules feed can switch injection on for a game without anyone looking.
|
||||
|
||||
## 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).*
|
||||
- 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.
|
||||
|
||||
|
||||
@@ -23,6 +23,36 @@ 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 |
|
||||
@@ -76,7 +106,7 @@ or it becomes the next stale status claim this file exists to record.
|
||||
| **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 |
|
||||
@@ -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
|
||||
@@ -1619,7 +1653,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?
|
||||
@@ -2620,8 +2656,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
|
||||
@@ -3139,7 +3176,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`
|
||||
@@ -4259,6 +4303,7 @@ instead, which needs no thread at all.
|
||||
| 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 |
|
||||
| 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. |
|
||||
| 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,12 +4350,12 @@ 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 |
|
||||
| **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. **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) | `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` |
|
||||
| **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 (`08_UI` §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` |
|
||||
|
||||
+487
-7
@@ -746,8 +746,11 @@ Cyberpunk 2077 never chains `sl::DLSSOptions`, so 0xFF there is the title's trut
|
||||
call, and if built, the byte stays 0xFF and the report says *derived*.
|
||||
- **Do not** reach for `slDLSSSetOptions` via `slGetFeatureFunction`: §2b refused it on five
|
||||
grounds that have not changed, and NGX-direct `NVSDK_NGX_Parameter_GetUI` is licence-blocked.
|
||||
- **Alan Wake 2 did not run on 2026-09-04** (the owner tried every workaround; the title is
|
||||
broken on this machine), so the measurement moved to **Dying Light: The Beast at DLSS**, the
|
||||
- ~~**Alan Wake 2 did not run on 2026-09-04** (the owner tried every workaround; the title is
|
||||
broken on this machine)~~ **Corrected 2026-09-27 (owner):** it did run late that evening — the run reports
|
||||
`alanwake2-224851` and `alanwake2-230707` hold two captures (DLSS + RR, ray tracing *Yes*, 92.52 FPS; then ray
|
||||
tracing off, Presented 114.52), neither with the quality preset, which is what this item needed. The earlier
|
||||
attempts that day failed, so the measurement moved to **Dying Light: The Beast at DLSS**, the
|
||||
first Streamline title measured whose batches carry `kFeatureDLSS` — identity `Dlss` on 4,575
|
||||
of 4,575 batches. It read `UpscalerParams = 0` on three captures, because DL:TB ships
|
||||
**Streamline 2.8.0, which deprecates `slSetTag` for `slSetTagForFrame`**, and only the
|
||||
@@ -1310,9 +1313,13 @@ charts (6) after Games (5) because the summary opens from the Sessions tab; Sett
|
||||
(`PipeTransmissionMode.Message`, `PipeOptions.Asynchronous | CurrentUserOnly`, remote clients rejected,
|
||||
two instances), the ACL a `PipeSecurity` of the current user's SID plus Administrators~~ **`CreateNamedPipe`
|
||||
itself (CsWin32), so the flags and the DACL are stated in code rather than left to a library default:**
|
||||
message mode, overlapped, `PIPE_REJECT_REMOTE_CLIENTS`, two instances, the SDDL `D:P(A;;GA;;;<user>)(A;;GA;;;BA)`
|
||||
on every instance, and the client's token user compared to the server's by impersonation on the client's
|
||||
first frame (the kernel refuses it earlier). The CLIENT uses `PipeOptions.CurrentUserOnly`. *(As built
|
||||
message mode, overlapped, `PIPE_REJECT_REMOTE_CLIENTS`, two instances, the SDDL ~~`D:P(A;;GA;;;<user>)(A;;GA;;;BA)`~~
|
||||
`O:<user>D:P(A;;GA;;;<user>)(A;;GA;;;BA)` (the owner stated since 2026-09-17) on every instance, and the client's
|
||||
token user compared to the server's by impersonation on the client's first frame (the kernel refuses it earlier).
|
||||
The CLIENT ~~uses `PipeOptions.CurrentUserOnly`~~ checks the pipe's owner against its own token USER
|
||||
(`PipeAccessControl.RequireOwnedByCurrentUser`, 2026-09-17) — `CurrentUserOnly` compares the token's default owner,
|
||||
which an elevated token sets to Administrators, and refused the same user's Agent across elevation (corrected
|
||||
2026-09-27). *(As built
|
||||
2026-09-13; the wording above was the plan's, kept struck because it named a library path the build did not
|
||||
take.)* Framing is
|
||||
`07_IPC` §C as written: 4-byte LE length + UTF-8 JSON ≤ 1 MB, `Shared.Ipc.IpcEnvelope { type, id?, payload }`,
|
||||
@@ -1356,6 +1363,446 @@ charts (6) after Games (5) because the summary opens from the Sessions tab; Sett
|
||||
- **D17 — `FL_MOCK`, if the owner wants it, is `--serve --mock` under `--data-dir` only** (D6's shape), so a
|
||||
synthetic session can never land in the profile's ledger.
|
||||
|
||||
## 0.1.0-beta.3 (2026-09-21) — what it decided, and the traps it paid for
|
||||
|
||||
*PRs #204-#210. Status is where status lives (`CHANGELOG.md` `[0.1.0-beta.3]`); this is only what no other file carries.*
|
||||
|
||||
**Decisions (owner, 2026-09-21).**
|
||||
- ~~**D18 — the guard has one override, and its shape is fixed.**~~ **Withdrawn 2026-09-22 (D22, below).** Per game, off by default, never global, a two-act
|
||||
disclosure stamped by the Agent, overruling the guard's JUDGEMENT only, never changing HOW FrameLedger injects.
|
||||
`19_SAFETY` §The user's bypass is the specification and CLAUDE.md rule 2 carries it as a rule. The owner chose this
|
||||
over a global switch and over a variant that kept kernel-level families refused. **Do not widen it**: no settings key,
|
||||
no CLI verb (`--console` has none on purpose), no rules-file field. A Vulkan title the guard refuses stays refused.
|
||||
- **D19 — the DLSS preset derived from the render scale is STILL not shown.** `Domain.Metrics.UpscalerNames` names the
|
||||
measured byte only; §7a's decision stands open. The driver-reported rung reached the App, identity only.
|
||||
- **D20 — the bug bundle does not get the machine's hardware.** `sysinfo.json`'s keys are the issue link's prefill;
|
||||
`--diag` and Settings ▸ System (with Copy) carry it instead.
|
||||
|
||||
**Owed by the owner after this release.** `20_OPEN_QUESTIONS` M10 (one elevated session with PawnIO beside a reference
|
||||
tool decides whether `cpu_temp` stays); a look at the light theme's pills ~~, the bypass dialog~~ and Settings ▸ System in the
|
||||
running App — no FrameLedger binary was run against the owner's data folder in the session that built them ~~; the ja
|
||||
review of `Safety_Bypass_*`, which ships as English until signed~~ (moot since 2026-09-22: the strings are gone).
|
||||
|
||||
**Traps.**
|
||||
- **xUnit.net v3 4.x defaults to Microsoft Testing Platform v2.** `build.ps1` is VSTest-shaped (collector, `results.trx`);
|
||||
the projects reference `xunit.v3.mtp-off`. Moving to MTP is a `build.ps1` change, never a version bump.
|
||||
- **4.0.1's scheduler found a race 3.2.2 never did**: test classes that WRITE the static `Strings.Culture` must share
|
||||
`StringsCultureCollection`. A new App test that sets the culture and is not in it will fail one run in N.
|
||||
- **A bash heredoc mangles apostrophes and `\\`, even quoted.** Every patch script in this session that carried C#
|
||||
verbatim strings, `\n` escapes or prose with `'` was written with the Write tool and run by path.
|
||||
- **A WPF page property named `System` does not compile** — the generated `.g.cs` resolves `System.` against it.
|
||||
- **NSubstitute: never build a substitute inside another's `Returns(...)`** (`CouldNotSetReturnDueToNoLastCall`).
|
||||
- **Branch protection requires an up-to-date branch.** A small PR merged in the middle of a train puts every open PR
|
||||
`BEHIND`; `gh pr update-branch N` and a second CI cycle is the price. Merge the train in order and keep side PRs out.
|
||||
- **`guard_test.cpp`'s native-log test slept a fixed 1500 ms** and was read between two lines on a loaded runner; it
|
||||
polls now. Record a flake on the PR BEFORE `gh run rerun --failed` erases it.
|
||||
|
||||
## 0.1.0-beta.4 (2026-09-21) — four faults from beta.3's first day
|
||||
|
||||
*Status is `CHANGELOG.md` `[0.1.0-beta.4]`; this is what no other file carries.*
|
||||
|
||||
**Decision (D21).** A process an anti-cheat driver protects is `TargetUnreadable`, and nothing FrameLedger offers changes
|
||||
that: it is not, and may not become, a way past another product's protection (rule 3, not rule 2). ~~"the bypass
|
||||
stops there"~~ — the override itself is gone since 2026-09-22 (D22).
|
||||
|
||||
**Found and NOT fixed — each needs its own PR.**
|
||||
- ~~**A refused session is not recorded, though the notice says it is.**~~ **Fixed 2026-09-22 (D23):** the loop holds a
|
||||
refused session open until the target exits, so Tier 2 has a producer and the sentence is true for every refusal.
|
||||
- **A released Overlay logs its build as `v0.1.0-beta.3-dirty`**: the CI checkout is dirty by the time CMake runs
|
||||
`git describe`. Both sides of the handshake compile the same string, so nothing breaks; it is a release that calls
|
||||
itself dirty.
|
||||
- ~~**An install over a running Agent half-replaces the folder** (three failed starts, `Microsoft.Data.Sqlite` not
|
||||
found).~~ **A GUESS, WITHDRAWN the same evening, and it had already been published in beta.4's notes.** Nothing was
|
||||
installed between the failures (20:59–21:01) and the start that worked (21:02); the PC had been restarted at 20:57
|
||||
and was again at 21:02 (System log 1074), and the owner's external USB drive was failing all evening. The three
|
||||
failed starts are UNEXPLAINED. What is still true and still unbuilt: `Setup.exe` run by hand does not stop the Agent,
|
||||
and only the CHANGELOG says to.
|
||||
- **A GF2 session ended `SafetyUnhook` 35 s in (2026-09-21 21:45) and nothing recorded which finding fired.** ~~read it
|
||||
the next time it happens before guessing~~ **Mostly explained by the owner's report:** the game is on the failing
|
||||
drive, `GF2_Exilium.exe` crashed at 21:45:50 with `0xc0000006` (in-page I/O error, Application log 1000/1005, eleven
|
||||
Ntfs errors in that minute), and the Agent saved the session at 21:45:52. The 30 s re-scan reads the game's directory
|
||||
(check 4) and the process; either failing is a refusal by design, so a dying drive reads as a safety unhook. **Open:**
|
||||
that row says `UnhookedSafety` about a game Windows says crashed — whether a crash witness should outrank the unhook
|
||||
in `ExitStatusMapper` is a decision, not a bug fix. The log line's new `guard=` detail will say which check it was.
|
||||
- **Read Windows' event logs before attributing a symptom** (`Get-WinEvent` System: disk 51/153, UASPStor 129, Ntfs;
|
||||
Application: 1000/1005). On 2026-09-21 the first pass published one cause that was wrong and left one 'unknown' that
|
||||
those two logs answered in a minute.
|
||||
|
||||
**Traps.**
|
||||
- **`CultureInfo.CurrentUICulture` set inside an `async` start does not reach later dispatcher operations.** A resource
|
||||
accessor with no explicit `Culture` follows whichever thread asks. Give every string family its culture explicitly.
|
||||
- **`TargetResolver` counts a process it cannot read, and zero readable + some unreadable is not "ambiguous".** A test
|
||||
against a real protected process exists (`csrss.exe`); it needs no fixture and runs elevated or not.
|
||||
- **`Mutex` is thread-affine**: `SingleInstance` is claimed and disposed on `Main`'s thread; its tests are synchronous
|
||||
on purpose.
|
||||
|
||||
## 2026-09-22 — the override withdrawn; a finding turns hooking off; Tier 2 exists; a moved drive is followed
|
||||
|
||||
*Status is `CHANGELOG.md` `[0.1.0-beta.5]`; this is what no other file carries.*
|
||||
|
||||
**Decision (D23, owner: "Tier 2 does not work — what does it record, and show it").** Tier 2 is now a held session
|
||||
(`04_CAPTURE` §Tier selection): duration, telemetry and the reason, saved under the same 30 s rule as Tier 1. **Two
|
||||
choices inside it that a later session may want to revisit:** (a) *every* library row is still watched, so a
|
||||
hooking-off game accumulates play-time rows — the documented behaviour (`06_DATA_MODEL` "0 = Tier 2"), kept; the
|
||||
alternative, watching only rows the user enabled or FrameLedger itself disabled, is one predicate in
|
||||
`CaptureOrchestrator` and a doc change; (b) a hooking-off row is decided BEFORE the process is opened, so an
|
||||
elevated utility in the library (the owner's Borderless Gaming) is a quiet Tier-2 row rather than a red notice — and
|
||||
`SteamLibrarySource.KnownTools` keeps the next import from adding one. The owner's existing Borderless Gaming row is
|
||||
theirs to remove.
|
||||
|
||||
**Decision (D24, owner: "handle the drive changing its letter while the data does not").** A row may follow its
|
||||
executable to another drive-letter root when the file is gone from the row's path and exactly one other root holds a
|
||||
file with the same size and mtime — with consent, block and detection kept (`19_SAFETY` §A moved drive is the same
|
||||
executable). Three callers: the 15 s sweep, the watcher's file-name match, the enable-hooking command. The owner's
|
||||
log of the same morning is the case: 46 rows unreadable on `D:` while the drive sat on `H:`, GF2 and ELDEN RING
|
||||
running from `H:` "BY FILE NAME ONLY". ~~**Not done, on purpose:** re-import does not merge a duplicate row an earlier
|
||||
re-scan created at the new path (`LibraryImporter` still dedupes on path); the relocator refuses to move onto a path
|
||||
another row owns and says so in the log.~~ **Done 2026-09-23 (D26/D27, the beta.6 section below):** twins with the
|
||||
same bytes merge, a changed file is followed with hooking off, and the import no longer adds a twin.
|
||||
|
||||
**Trap.** `FakeIdentity` in three test classes answers the same fingerprint for ANY path; a relocation test needs one
|
||||
that answers per path, or the "exactly one candidate" rule reads every root as a match.
|
||||
|
||||
**Decision (D22, owner).** The per-game guard override (D18) is withdrawn entirely — the owner's words: a switch that
|
||||
can be turned on and still does nothing is meaningless. In its place a finding about the game turns that game's hooking
|
||||
off, at the pre-scan (as before), at a session's start and at the 30 s re-scan (new): `19_SAFETY` §What a finding does to the game.
|
||||
Machine-wide drivers and services refuse the session only. D18 and D21's "the bypass stops there" are history; D21's
|
||||
fact stands.
|
||||
|
||||
**Traps.**
|
||||
- **Removing an enum value that is LAST on both sides of the ABI renumbers nothing**, and `GuardMirrorTests` fails until
|
||||
the native DLL in the test output is rebuilt (`./build.ps1 native`) — it looks like a managed defect and is not.
|
||||
- **The first `DROP COLUMN` migration.** SQLite ≥ 3.35 is asserted in `LedgerDatabaseTests`. The test helper
|
||||
`RewindSchemaAsync` deletes `schema_migrations` rows and leaves columns in place; a rewind to below 8 followed by a
|
||||
re-migration would run 0008 against columns that are gone. Today it rewinds to 2 and never re-migrates.
|
||||
- **Meziantou MA0004 fires on the SECOND await of a test method** once a lambda inside it used `ConfigureAwait(false)`.
|
||||
- **A patch script must not carry `\r\n` inside a bash heredoc**; the helper module is written with the Write tool.
|
||||
|
||||
## 2026-09-23 — the beta.6 train: a file name is not an identity, one entry per executable, Tier 2 shown live
|
||||
|
||||
*Status is `CHANGELOG.md` `[0.1.0-beta.6]`; this is what no other file carries. The owner's list and the
|
||||
evidence behind each item are in the approved plan the PRs cite; the decisions it took are D25–D28.*
|
||||
|
||||
**Decision (D25, owner: "HELLO, HELLO WORLD! was recorded as Flower in Us, twice").** A file name is not an identity:
|
||||
a process that matches an entry by file name only starts nothing unless the relocator moves that entry to it, and the
|
||||
relocator accepts only the entry's own path with its drive letter changed. The stranger session is gone (it created a
|
||||
wrongly-named entry through `SessionRecorder`'s `EnsureAsync`); the running table is keyed by executable path; the
|
||||
launch election registers its session and defers to the watcher's. **What it costs:** a game whose FOLDER moved records
|
||||
nothing until *Change executable* — accepted, because the alternative is exactly what put HHW's sessions under Flower
|
||||
in Us. **D28 (owner, same day):** HHW itself is measured by pointing an entry at `swiftshader\Game.exe` (the NW.js
|
||||
runtime its .NET launcher starts); no launcher-following in beta.6.
|
||||
|
||||
**Decision (D26, owner: "the library still shows two entries side by side after the drive letter changed, with the
|
||||
data unchanged").** The Agent merges two entries for one executable under two drive letters by itself: the stale
|
||||
entry's file is gone, the other entry holds the same path on another letter, and the file there has the bytes the
|
||||
stale entry recorded. The entry made first stays; the other's sessions join it; a block or a crash auto-disable in
|
||||
force is kept; no consent moves between them; it waits while a session of either runs or waits to be recovered
|
||||
(`CaptureOrchestrator.IsRecording`, `IPartialSessionStore.PendingGameIds`). `19_SAFETY` §A moved drive has the rules,
|
||||
`06_DATA_MODEL` the writer. The import no longer adds a twin: a store's 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" and skipped.
|
||||
**D27 (owner, same day):** when the only file at the entry's path on another letter has other bytes, the entry follows
|
||||
it with hooking off (`ChangeExecutableAsync`, the *Change executable* write). Other bytes under a twin are NOT merged
|
||||
— the log says once which entry to remove.
|
||||
|
||||
**Traps.**
|
||||
- **`IGameMerge` is a second writer that can delete a `games` row.** Only the relocator calls it; a test that removes
|
||||
rows under a running session must expect the merge to wait (busy), not to race it.
|
||||
- **Python patch scripts: `\"` inside a normal triple-quoted string is an escaped quote**, so `@"C:\"` silently loses
|
||||
its backslash and the replace finds nothing (or worse, writes the wrong text). Use raw strings (`r"""…"""`) for C#.
|
||||
- **`FakeIdentity` in `CaptureOrchestratorTests` answers every path with the same bytes — which is exactly the hazard
|
||||
D25 closed**, so it is the right fake for "identical bytes in another folder are another game" and the wrong one for
|
||||
any test that needs a relocation to succeed (use `ExecutableRelocatorTests.DiskByPath`).
|
||||
- **A background service that throws stops the Agent's host, and until 2026-09-23 it said so nowhere.** The Generic
|
||||
Host's default `BackgroundServiceExceptionBehavior` is `StopHost`, and `ServeAsync` never routed
|
||||
Microsoft.Extensions.Logging into Serilog, so the reason reached no file. `WatcherHostedService` runs recovery before
|
||||
the watcher: one `.partial` whose finalize threw would have stopped every start, and the App would have started a new
|
||||
Agent into the same failure each time. `PartialRecovery` never throws now, and the host logs through `AddSerilog`.
|
||||
- **Removing an entry while its game runs used to lose the session.** Both of the owner's GIRLS' FRONTLINE 2 faults
|
||||
were a removal (to clean up an `H:` twin) under a running session. The finalize now resolves the owner; a test that
|
||||
deletes a row mid-session must expect `GameRemoved` or a re-keyed row, never an exception.
|
||||
|
||||
**Tier 2 on the wire (item 4a, owner: "capture still does not show when some titles are launched").** `SessionStarted`
|
||||
is published ONCE per session — at the attach, or at a held session's first tick carrying `hold` — so the card never
|
||||
flickers between tiers; a held session's 1 Hz is `SessionHeld`, never `SessionProgress` (its required fields would put
|
||||
zeros that look measured on the wire); the refusal's event goes out when the hold begins and is not repeated at the
|
||||
end; a faulted session completes with `finalize: faulted`. Every list of running sessions the App keeps is seeded from
|
||||
the status at each connect (`07_IPC` §Client behavior). All fields are additive: `IpcProtocol.Version` stays 2.
|
||||
|
||||
**Traps.**
|
||||
- **Only `hold` means held.** The status lists every session that has not attached yet at tier 2 (beta.5's shape,
|
||||
kept), so a tier-2 `ActiveSession` without `hold` is a session STARTING. The card shows its name and badge and
|
||||
nothing else; "nothing is measured" and "Attached — waiting for the first frames…" would both be false there.
|
||||
- **`sed -i` in this machine's Git Bash writes a CRLF file back as LF.** Twice on 2026-09-23 a one-line `sed -i` turned
|
||||
a test file into `w/lf` (`git ls-files --eol`), which `dotnet format` then fails on for no visible reason. Check
|
||||
`git ls-files --eol -m -o --exclude-standard | grep -v w/crlf` after any shell edit; `unix2dos` repairs it.
|
||||
- **Heredocs that carry C# with nested quotes can fail to parse in the Bash tool** ("unexpected EOF while looking for
|
||||
matching `'`") even when quoted `<<'EOF'` — write the script with the Write tool and run it by path, as the traps
|
||||
above already say for patches.
|
||||
|
||||
## 2026-09-23 (after 0.1.0-beta.6) — the recording switch
|
||||
|
||||
*Status is `CHANGELOG.md` `[0.1.0-beta.7]`; this is what no other file carries.*
|
||||
|
||||
**Decision (D29, owner: "the Agent records Borderless Gaming although hooking is off, and it starts with Windows —
|
||||
propose an ignore list, a disable, or something suitable").** Both, as one mechanism: a per-entry **Recording**
|
||||
switch (`games.record_sessions`, schema 0009, FR-1.6) the user owns, and the import's known-tools list
|
||||
(`SteamLibrarySource.KnownTools`) applied once to the entries an earlier import made, which start with it off. Off
|
||||
means the program is not watched at all (the watchlist is the entries whose recording is on), a running session of it
|
||||
stops at the next poll, and `LaunchGame` answers `RecordingOff`. Not chosen: a hard-coded list the watcher consults
|
||||
(no user control, and a list is never complete), and D23's recorded alternative of recording Tier 2 only for entries
|
||||
hooking was once enabled for (it would take back the Tier-2 sessions the owner asked for). The Privacy Policy (2.3) and
|
||||
the Disclaimer (2.6, whose accuracy block also carries #224's correction) were bumped with the owner's leave ("sửa docs
|
||||
và legal"), so the Legal Gate shows both once.
|
||||
|
||||
**Traps.**
|
||||
- **A pid the watcher matched stays matched.** Switching recording off stops the session but leaves the process in
|
||||
`ProcessWatcher`'s table, so switching it back on while the same process still runs starts nothing until it restarts.
|
||||
A process the watcher never matched (off from the start) is picked up by the next poll.
|
||||
- **A migration that changes data needs its own rewind in a test.** `RewindSchemaAsync` leaves columns in place, so
|
||||
`ScriptNineAddsTheRecordingSwitchOffForSteamToolsOnly` drops the column itself before re-applying 0009.
|
||||
- **`SqliteGameRepository._columns` is read by ordinal** (`ReadMore`): a new column goes at the end of the list, and the
|
||||
twin merge reads its own columns — both had to learn `record_sessions`.
|
||||
|
||||
## 2026-09-25 — the beta.8 train
|
||||
|
||||
*Status is `CHANGELOG.md` `[0.1.0-beta.8]`; this is what no other file carries. The owner's list
|
||||
(eight items: the anti-cheat set as large and strict as possible, hiding the hook part for anti-cheat games, more
|
||||
metadata, NVIDIA App overrides, clearer reasons, a working Trend, FPS decimals, chart fixes) is planned as nine PRs in
|
||||
one approved plan; each PR cites it.*
|
||||
|
||||
**Decision (D30, owner, asked before any code: "which strict rules, beyond named tokens?").** Two of three: **any
|
||||
kernel driver (`*.sys`) inside a game's install tree** is a finding (code, not data — `kKernelDriverInTreeFamily`),
|
||||
and **per-title lists** (30 Steam ids, 33 executables across nine families, floored like the families). **Not** the
|
||||
AreWeAntiCheatYet bulk import (~250 Steam ids): community data that keeps listing a game after it drops its anti-cheat
|
||||
would turn hooking off for good, since nothing clears a block. Recorded because the next person to "expand the list"
|
||||
will find that import one search away.
|
||||
|
||||
**Decision (D31, owner): the store half's matrix.** Listed → refuse; no store identity (a loose folder, an Epic
|
||||
install, a Steam folder no manifest names) → not applicable, recorded as nothing; a store layout whose metadata cannot
|
||||
be read → refuse (`PreScanFailed`). §S14's "unknown must never read clean" is kept by the third row; the second is not
|
||||
an unknown — it is the answer "this is not a store title", and refusing it would be the gate that cannot pass.
|
||||
|
||||
**Decision (D32, owner, item 2: "an option to hide the hook part for games with anti-cheat").** Hide **and** scan:
|
||||
the Agent pre-scans every library entry itself (`AntiCheatPreScanSweep`, checks 3 and 4, once per rules version and
|
||||
executable — schema 0010's key), a finding is the same block every other moment writes, and the game's page shows
|
||||
the finding in place of the Hooking card while `ui.hide_anticheat_hooking` is on (default on). Tier 2 is still
|
||||
recorded. **Why not the setting alone:** most entries sat at `hook_prescan_state = 'not_run'` — the pre-scan ran only
|
||||
when someone asked for hooking — so a hide keyed on a finding would have hidden nothing on most libraries. **What it
|
||||
must never become:** a gate. The chokepoint runs checks 1–4 at every session start whatever the sweep wrote; the sweep
|
||||
only answers early, writes through the consent store's block-preserving `UPDATE`, and hides a control that could
|
||||
only be refused, never the finding (FR-2.2).
|
||||
|
||||
**Traps.**
|
||||
- **`Rules` is ~650 KB now** (256 families, 128 per-title rules). `x = Rules{}` builds that on the stack before
|
||||
copying — use `ResetRules`. The Vulkan layer parses on a game's own `vkCreateInstance` thread, and native tests hold
|
||||
it on the heap (two in one test function overflowed the 1 MB default).
|
||||
- **New `anticheat.modules` rows go at the END.** The Overlay's early stop reports a 1-based index into that order, and
|
||||
`sessions.early_stop_family` stores it.
|
||||
- **`sed -i` and the Bash tool's heredocs strike again**: a heredoc halved `\\` in a Python patch (a C# verbatim path
|
||||
still matched by luck), and a one-line `sed -i` turned `layer.cpp` into LF. Scripts go through the Write tool and run
|
||||
by path; `git ls-files --eol -m` after any shell edit.
|
||||
- **`'clean'` is not new.** `AgentCommandHandler` has stamped it on every consented enable since P3; the sweep adds it
|
||||
for entries nobody enabled. Nothing gates on it — a reader that treats `'clean'` as "may hook" is a second gate.
|
||||
- **The sweep's notice is not a refusal.** `HookingTurnedOff` is `SafetyNoticeKind.HookingOff` with Dismiss: a
|
||||
`Refused` kind would offer "record this session without measuring it" with no session running.
|
||||
- **Analyzers on tests:** CA2000 flags a disposable passed into a record's constructor (construct it inside a class
|
||||
that disposes it), MA0023 a regex with numbered groups (name them), CA1062 a `[Theory]` string parameter
|
||||
dereferenced without a check.
|
||||
- **`exe_machine` NULL is stale (schema 0011).** The detection sweep re-reads any row whose executable facts this build
|
||||
has not written — so a test double of `IGameRepository.ApplyDetectionAsync` that drops the new fields makes every
|
||||
sweep test re-scan forever. `unknown` is the stored "looked, could not tell".
|
||||
- **`FileVersionInfo` on a System32 file reads its `.mui`.** `version.dll` read in place said 6.2.x, its copy in a temp
|
||||
folder 10.0.x: compare a version against the file that was read, never against its source.
|
||||
- **`PASS_REGULAR_EXPRESSION` alone makes ctest ignore the exit code.** `fl_nvapi_bridge` passed for weeks with a failing
|
||||
assertion on every GPU machine (CI has no driver, so never took the branch). Any test that must print a line AND
|
||||
pass needs a `FAIL_REGULAR_EXPRESSION` beside it; running the test binary directly is the check.
|
||||
- **A C ABI cannot give a function and a struct one name** (`FlNvDriverProfile` the export, `FlNvDriverProfileRead` the
|
||||
struct): C puts typedefs and functions in one namespace, and MSVC's error names neither clearly.
|
||||
- **The driver profile is a configuration.** `sessions.driver_profile` says what the NVIDIA App set; it never feeds
|
||||
the upscaler ladder or the factor. The bridge has no DRS writer, and a PR that adds one is a different product.
|
||||
- **Present-to-present is not a frame time on a frame-generation title.** DLSS FG submits its generated frames in a
|
||||
burst (measured: half a millisecond apart on the owner's Onimusha capture); anything over `ft_app` — lows, median,
|
||||
σ, stutter, the charts' default line — is application frame to application frame (`FrameTimeSeries.ApplicationFrames`,
|
||||
`SessionSeriesLoader.ApplicationFrames`).
|
||||
- **A gap is neither a frame time nor time** (beta.8): `FrameTimeSeries.MeasuredSeconds` and `FgWindow.Seconds` leave
|
||||
out every interval a gap sat in. A pause is a gap (`CaptureSession.MarkResume`); do not mark one any other way.
|
||||
- **Reading the owner's ledger for evidence: copy it (`ledger.db` + `-wal`) to the scratchpad and read the copy** with
|
||||
plain SQLite — never a FrameLedger binary against the data folder. `capture_tier` is an integer (1 = hooked); the
|
||||
frame flags are Generated = 1, Gap = 4.
|
||||
- **A view model that loads in its constructor raises its events to nobody** until the page subscribes; a page must
|
||||
draw what the view model already holds when it is made (the Trend tab was blank on every first open).
|
||||
- **`Axes.DateTimeTicksBottom()` replaces the bottom axis**: call it before the theme and the label, or both are lost.
|
||||
- **A local property value outranks a style trigger** (Compare's best cell was never accent-coloured): defaults a
|
||||
trigger may change go in the Style as Setters.
|
||||
- **`ui.fps_decimals` is process-wide state** (`FpsDecimals`): a test that moves it belongs to `StringsCultureCollection`
|
||||
with every test that reads FPS text, and restores it.
|
||||
- **A status is not a policy input.** Splitting End task (exit 1) out of `crashed` would have loosened the crash
|
||||
auto-disable had the policy kept reading the status alone; it takes the exit code too. Check every reader of a value
|
||||
whose meaning you narrow.
|
||||
- **The gate's own refusals carry a label in the family slot** (`not enabled`, `no consent`, `kill switch`, `previously
|
||||
blocked`, `HookedCaptureGate`), so "has a family" does not mean "is a finding" — `IsFindingAboutTheGame` is the test.
|
||||
- **`add_strings.py` replaced an existing key in place** (`Exit_Normal`, the Sessions grid's word) — it now refuses
|
||||
without `--replace`; diff the resx for `-.*<value>` before committing new strings.
|
||||
- **A 32-bit refusal is not a block.** `ExecutableNotX64` writes nothing — no `hook_blocked_reason`, no stamp — so a
|
||||
64-bit build of the same game under *Change executable* can be hooked; the sweep's turn-off uses
|
||||
`hook_autodisabled_reason`, which the page does not offer to undo while the file is still 32-bit.
|
||||
|
||||
## 2026-09-26 — the beta.9 train: the user-mode exception (D33)
|
||||
|
||||
*Status is `CHANGELOG.md` `[0.1.0-beta.9]`; this is what no other file carries. The approved plan
|
||||
is four PRs: PR-1 the guard's tolerance and the Overlay's channel, PR-2 the Agent (eligibility, gate, records, schema
|
||||
0014, IPC), PR-3 the App, strings, docs and legal text, PR-4 the release.*
|
||||
|
||||
**Decision (D33, owner, 2026-09-26, asked with rule 2 and D22 quoted back).** The beta.8 sweep turned hooking off for
|
||||
GIRLS' FRONTLINE 2: EXILIUM (NetEase Yidun, `AntiCheatFile NEP2.dll`, a documented and unmeasured rule) after it had
|
||||
been measured hooked; the owner asked for an exception list for user-mode anti-cheat games measured at Tier 1 before.
|
||||
Chosen, all four options as recommended: **evidence-bound, per game** (a Settings option off by default, then the user
|
||||
ticks each eligible game); **≥ 2 successful Tier-1 sessions**; **Aniimo stays blocked** (it unpacks `NEPKernel.sys` beside
|
||||
`NEP2.dll` — the D30 `.sys` rule is never excepted); **the legal text changes** (Disclaimer §2A 2.7, EULA 1.3, the
|
||||
accuracy block, SECURITY.md, FR-2.3; Privacy stays 2.4). Eligibility, what is never excepted and every lapse are in
|
||||
`19_SAFETY` §The user-mode exception; the rule-2 amendment is in CLAUDE.md.
|
||||
|
||||
**Evidence it rests on (read from a COPY of the owner's ledger and their logs, 2026-09-26).** GF2: three normal Tier-1
|
||||
sessions under the current entry (474,143 frames; three more from 2026-09-21 went with a removed entry), no `.sys` in
|
||||
its tree. Aniimo: one Tier-1 session stored `crashed` (End task before beta.8, no exit code kept). A randomly named
|
||||
kernel driver (`lyoxztfx.sys`) was installed on 2026-09-21 at 15:38 and is gone now, service and file, by something
|
||||
the logs cannot name — the residual the disclosure states: a driver outside the game folder that no rule names is
|
||||
invisible to every check.
|
||||
|
||||
**Traps met on the way:**
|
||||
- **The ring cannot carry anything the Overlay needs before its detour is armed** — the Overlay creates it. Hence the
|
||||
separate `Local\FrameLedger.Tolerate.<pid>` mapping the Agent creates BEFORE the injection (`fl_tolerance.h`).
|
||||
- **A tolerant scan must keep scanning.** Every sink that used to stop at the first hit returns `true` on a tolerated
|
||||
one, or a second family / a `.sys` further in would pass: the same load-order fail-open §S22(b) closed for the
|
||||
exemption.
|
||||
- **A prefix value of a user-mode family can match a `.sys`**; the tolerant file sink refuses any `.sys` itself.
|
||||
- **CA2101 rejects `[MarshalAs(LPUTF8Str)] string`** on a P/Invoke; the tolerance crosses as NUL-terminated UTF-8
|
||||
`byte[]`, the shape `FlGuardCheckRules` already used.
|
||||
- **The Vulkan branch evaluates strictly**: the layer's self-scan goes inert on any anti-cheat module, so an exception
|
||||
there could only buy a session that measures nothing.
|
||||
- **An elevated Agent's default DACL omits the user** (`PipeAccessControl`'s remarks): a tolerance mapping created with
|
||||
it could not be opened by the Overlay in an unelevated game, and the exception would fail as the Overlay's own stop.
|
||||
`OverlayToleranceChannel` states `O:<user>D:P(A;;GR;;;<user>)`; a test proves the user can read it and nobody can
|
||||
open it to write.
|
||||
- **`hook_enabled` can be 1 on a blocked row now** — only because an exception once applied. `CaptureSession.RunAsync`
|
||||
therefore treats a blocked row whose exception does not apply right now as hooking-off BEFORE the resolver opens
|
||||
anything, or the option off would reopen the Borderless-Gaming problem of 2026-09-22.
|
||||
- **The store applies the eligibility rule itself** (`GrantAntiCheatExceptionAsync` answers `NotEligible`), and the
|
||||
grant and the eligibility are bound in SQL to the block text they were reached about: a block rewritten between the
|
||||
read and the write leaves the row alone. SQLite evaluates every `SET` from the old row, which is what lets
|
||||
`ChangeExecutableAsync`'s `CASE WHEN ac_exception_at IS NOT NULL` record the end of the grant it clears.
|
||||
- **CA1711 rejects a type whose name ends in `Exception`**: the rules class is `UserModeExceptionRules`, the reasons
|
||||
`UserModeExceptionLapse`.
|
||||
|
||||
## 2026-09-27 — the beta.10 train: the display mode, the admin mode, the Unreal Engine version
|
||||
|
||||
*Status is `CHANGELOG.md` `[0.1.0-beta.10]`; this is what no other file carries. The approved plan was six PRs:
|
||||
PR-1 the Unreal version (schema 0015), PR-2 the Overlay's display region (shared-memory layout 4), PR-3 the display mode
|
||||
in the Agent and the App (schema 0016), PR-4 the admin mode, PR-5 docs, legal text and the tested-games list, PR-6 the
|
||||
release.*
|
||||
|
||||
**Decisions (owner, 2026-09-27, asked before the plan — do not re-ask):**
|
||||
|
||||
- **D34 — the admin mode asks Windows at EVERY Agent start.** The UAC prompt appears whenever the Agent starts with
|
||||
`capture.run_elevated` on — owned by the App's window when the App starts it, flashing on the taskbar when the logon
|
||||
task does. No "highest privileges" task, no service, no silent path. Games an elevated Agent starts get the desktop
|
||||
shell's token. The elevated Agent is started for one user (`--for-user <SID>`) and exits 11 as any other account.
|
||||
- **D35 — the tested-games list comes from a COPY of the owner's ledger** (scratchpad, Python `sqlite3`; never a
|
||||
FrameLedger binary against the data folder) plus the repository's own evidence, and **the owner reviews it before it
|
||||
is committed** — the repository is public.
|
||||
- **D36 — legal text changes where it would become false** (Privacy 2.5, Disclaimer 2.8; EULA stays 1.3), **and
|
||||
`LIMITATIONS.md` exists**: a user-facing list of what the WHOLE software cannot do, at the repository root and in the
|
||||
App under Help ▸ Limitations — not one of FR-11's accepted documents (the Legal Gate records an acceptance per
|
||||
document, and this is information, not terms).
|
||||
- **D37 — each PR merges when its CI is green**, then the release PR and the GPG-signed tag.
|
||||
|
||||
**What was measured before it was written:**
|
||||
|
||||
- **Unreal versions, ten installed titles, read-only** (`spike-notes` §15): eight read (4.26.1 … 5.5.4), two honestly
|
||||
none (Cronos demo, Rune Factory). Black Myth: Wukong's executable is protected (`.rdata` empty) and its build name sits
|
||||
in `.code` — the whole-file fallback read it in 7.5 s from the owner's USB drive.
|
||||
- **The display region's cost** (hook-harness `--probe-frames`, WARP): `GetFullscreenState` 12.6–13.1 ns, `GetDesc`
|
||||
13.6–14.5 ns per call, at most twice a second per swap chain.
|
||||
|
||||
**Traps met on the way:**
|
||||
|
||||
- **A test run reseeds the rules file in the REAL data folder** (`RulesSeeder` in the integration tests writes
|
||||
`%LOCALAPPDATA%\FrameLedger\rules`). PR-1's rules `2026.09.6` carry an extractor type (`unreal_build`) the installed
|
||||
beta.9 cannot parse: its detection sweep says "rules unusable" until that Agent restarts — its seeder sees a file it
|
||||
wrote itself (the marker's hash) and puts its own back — or beta.10 is installed. The guard reads the same file and is
|
||||
unaffected (it ignores version extractors). Worth a scratch rules folder for the tests one day.
|
||||
- **`DXGI_SWAP_EFFECT_DISCARD` is 0** — region 4 stores the effect plus one, the vendor-zero trap.
|
||||
- **A minimised game presents only what the hook drops** (occlusion probes): a region-4 sample older than 2 s says
|
||||
nothing about exclusivity now; the Agent keeps its window and drops its exclusive bits.
|
||||
- **The Agent is DPI-unaware**: Windows scales another process's window coordinates for it. The window reader switches
|
||||
its thread to per-monitor-aware (V2) for the calls and back.
|
||||
- **A Tier-2 session never reaches the aggregator** — display columns live on the recorder's skeleton, or a Tier-2 row
|
||||
would carry none.
|
||||
- **`SessionRowColumns` is generated by a script that is not in the repository** — edit it by hand, by name.
|
||||
- **`CreateProcessWithTokenW` needs `SeImpersonatePrivilege`**, which an unelevated (filtered) token does not hold: the
|
||||
shell-token start is testable only on the elevated CI runner, and a runner with UAC off has an elevated shell — so the
|
||||
test compares the child's elevation with the SHELL's, never with "unelevated".
|
||||
- **An elevated token's default DACL omits the user** (again): the ledger's migration lock is now a `SharedMutex` with a
|
||||
stated descriptor; the instance lock and the elevation marker are only probed, and a refused probe reads as held.
|
||||
- **`CA2025` flags a disposable handed to an un-awaited task** even when ownership moves to it; the launcher says so in
|
||||
a suppression with its reason, or splits the method so the analyzer can see it.
|
||||
- **Heredocs mangle backslashes and `\a`** (`D:\another` became `D:<BEL>nother` in a test). Patch scripts are written
|
||||
with the Write tool and run by path; a scan for control characters before the gate catches the rest.
|
||||
|
||||
**Owner-only, added to the list below:** item 7.
|
||||
|
||||
## 2026-10-03 — the beta.11 train: the exception's trial, the library, sessions across
|
||||
|
||||
*Status is `CHANGELOG.md` `[0.1.0-beta.11]`; this is what no other file carries. The approved plan was five PRs: PR-1 the
|
||||
CrackProof titles (rules `2026.10.1`), PR-2 the exception's trial (schema 0017, Disclaimer 2.9, EULA 1.4), PR-3 the
|
||||
library and the import, PR-4 delete sessions, the charts across sessions and the Settings clean-up, PR-5 the release.*
|
||||
|
||||
**Decisions (owner, 2026-10-03, asked before the plan — do not re-ask):**
|
||||
|
||||
- **D38 — the user-mode exception's evidence moved under 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: since beta.8 a game is
|
||||
blocked the moment it is added, a blocked game is never hooked without a grant, so D33's two sessions were unreachable
|
||||
for every game blocked from the start and lost with a reset ledger. Chosen: a grant needs no session; the first two
|
||||
hooked sessions under it are a trial; any end during the trial (every D33 end, or a stored hooked session with no frames
|
||||
or an abnormal exit) ends it for good (`games.ac_exception_trial_failed_at`). Every other condition is unchanged.
|
||||
Legal text: Disclaimer 2.9 (§2A) and EULA 1.4 — the EULA's "a game the Software has already measured successfully"
|
||||
would have become false (D36's rule).
|
||||
- **D39 — charts across a game's sessions: both** — *Sessions at a glance* on the Sessions tab, and *Also draw* on the
|
||||
Trend (two units at most, the second on the right axis).
|
||||
- **D40 — Delete all sessions: both places** — the game's page and Settings ▸ Data. The Agent deletes (the rows are its),
|
||||
never while a session it would delete under is being recorded.
|
||||
- **D41 — Refresh does all three**: reload the library, offer the games the stores installed since, mark the entries
|
||||
whose executable is gone (*Not installed*; nothing is removed).
|
||||
- **D42 — the library switches between a grid that fills the window and a list** (`ui.library_view`).
|
||||
- **CrackProof (owner's list, "a few, by Steam id")**: three titles whose own store pages say *"Uses Kernel Level
|
||||
Anti-Cheat"* and name CrackProof; ANOTHER EDEN, named only by a community list, is left out.
|
||||
|
||||
**Traps met on the way:**
|
||||
|
||||
- **A fresh git worktree cannot configure the native build**: CMake's MinHook FetchContent clone runs `git submodule`,
|
||||
which fails there ("'submodule' appears to be a git command, but we were not able to execute it"). Run the gate in the
|
||||
primary checkout, whose `build/native/x64-release/_deps` is cached; a worktree is for writing code and managed tests.
|
||||
- **A `DataGrid` laid out outside a window draws its star columns at their minimum** (no Loaded pass): a visual check
|
||||
renders a hosted, off-screen `Window` and pumps the dispatcher (`Dispatcher.PushFrame`), not Measure/Arrange on a page.
|
||||
- **`Native FPS` includes a measured-none session**, whose native rate is the presented one: beside Presented it is a
|
||||
second line on the same points, so the overview keeps Native and Displayed to sessions that generated frames.
|
||||
- **Both processes may change the library while the Games page is open**, and WPF UI 4.3.0 does nothing on a navigation
|
||||
to the page already on screen: the page reloads on `SessionCompleted` and on the App's own `LibraryChanges`.
|
||||
- **A grant's trial is counted from the sessions, not kept as a counter**: the lapse policy counts at each finalize
|
||||
(`CountSuccessfulUnderGrantAsync`: that family, started at or after the grant), and `ac_exception_sessions` is only
|
||||
the sweep's copy for the card. Deleting sessions can only lengthen a trial; the mark that ends one for good
|
||||
(`ac_exception_trial_failed_at`) is the only stored decision.
|
||||
- **A session summary is a window of its own, outside every page**: deleting sessions must close the ones open on a
|
||||
deleted session and let go of File ▸ Export's selection, asking the ledger whether the session is still there (both in
|
||||
`SessionDeletion`, so Settings ▸ Data does it too) — ids are reused once the newest is gone. The plan said so; PR-4's
|
||||
first version did neither, and a self-review caught it before the merge.
|
||||
- **Analyzers met:** `MA0048` (one type per file), `CA1003`/`MA0046` (an `EventArgs` type for an event), `IDE1006` (a `_`
|
||||
prefix on private consts), `CA1030` (no method named `Raise`), `MA0051` (60 lines), and `RevokeAntiCheatExceptionAsync`'s
|
||||
new `bool` before the token turned every `(path, reason, ct)` call into a compile error — pass `ct: ct`.
|
||||
- **The Bash tool's heredocs break on an odd number of apostrophes and halve backslashes**: patch scripts are files.
|
||||
|
||||
**Owner-only, added to the list below:** item 8.
|
||||
|
||||
## Owner-only — no PR can close these
|
||||
|
||||
1. **§S23-2 — branch protection.** `Rules / validate` is not a required status check on
|
||||
@@ -1371,8 +1818,9 @@ charts (6) after Games (5) because the summary opens from the Sessions tab; Sett
|
||||
2026-09-03 (P4) and 2026-09-04 (P1); done.** What is still owed here is the **quality
|
||||
preset** on a title that chains `sl::DLSSOptions` — Alan Wake 2 is the candidate — and
|
||||
the DLSS-G identity on a title where `kFeatureDLSS_G` is evaluated, if one exists.
|
||||
3. **Which titles** go in `blockedExecutables` — a product decision with false-refusal
|
||||
consequences. The list ships empty until it is taken.
|
||||
3. ~~**Which titles** go in `blockedExecutables` — a product decision with false-refusal
|
||||
consequences. The list ships empty until it is taken.~~ **Taken 2026-09-25 (D30):** per-title
|
||||
lists by Steam id and executable name, seeded and floored (§2026-09-25 — the beta.8 train).
|
||||
4. **§H7's confirmation against the overlays actually resident on the dev machine.** The
|
||||
compare-and-restore path is proven against a fixture (ctest `fl_unhook_inline`); §H7 still
|
||||
says the six real overlays are *"worth doing once the Overlay has real hooks"*, and it has
|
||||
@@ -1380,6 +1828,30 @@ charts (6) after Games (5) because the summary opens from the Sessions tab; Sett
|
||||
5. **Re-ratify §S18 blocker 3 and §S27's basis** once P2's PR-C/PR-F make the Agent the shipped
|
||||
injecting entry point (§P2, decision D4). The PRs restate both entries; whether the
|
||||
restatement stands is the owner's.
|
||||
6. ~~**D33's first real use (beta.9).**~~ **Done by 2026-09-27, read from a copy of the owner's ledger:** three normal
|
||||
hooked sessions of GIRLS' FRONTLINE 2 under the exception (NetEase Yidun) on 2026-09-26 and 09-27, the longest
|
||||
3 h 9 min; the `ja` review below is still owed. *(The item as written:)* Turn the option on; GIRLS' FRONTLINE 2 should be listed eligible (NetEase
|
||||
Yidun, `NEP2.dll`, three sessions); make the exception, turn hooking on and play one session: hooked, marked
|
||||
*Hooked · exception*, not stopped by the 30 s re-scan or by the Overlay when `NEP2.dll` loads. Aniimo should read
|
||||
*not eligible* with its `NEPKernel.sys`; the option off makes the next session Tier 2 with the exception kept. And
|
||||
the `ja` text of `Safety_Exception_*`, which ships as English until a reviewer signs.
|
||||
7. **beta.10 on real hardware.** (a) **The display mode:** one DXGI game taken through exclusive full-screen →
|
||||
borderless → windowed in one session — the summary's shares, the Sessions column, the Trend's three share metrics —
|
||||
with a note of what the game's own menu called each mode. (b) **The admin mode:** turn it on → the disclosure → the
|
||||
UAC prompt → Settings says *Running elevated*; decline it → *the administrator prompt was declined*; sign out and in
|
||||
with the logon task → the prompt waits on the taskbar and one Agent results; start a game from FrameLedger while
|
||||
elevated → Task Manager's *Elevated* column says *No*; a game that runs as administrator → hooked; the CPU temperature
|
||||
with PawnIO (closes §M10 if it reads). (c) **The Unreal Engine version** on each Unreal game's page. (d) The Legal
|
||||
Gate shows Privacy 2.5 and Disclaimer 2.8 once. (e) The `ja` text of `Safety_AdminMode_*`, English until reviewed.
|
||||
(f) `docs/LIST_GAME_TESTED.md` — reviewed and approved by the owner before it was committed (D35, 2026-09-27);
|
||||
keep it current as games are run.
|
||||
8. **beta.11 on real hardware.** (a) GIRLS' FRONTLINE 2: the option on → *Eligible* → *Make exception…* (the disclosure
|
||||
`ac-exception-dialog/2`, with its *Trial* paragraph) → hooking on → two sessions: the card says *trial: 0 of 2*, then
|
||||
*1 of 2*, then *Exception in force since …* alone. (b) The library at your window's width, and the list; Refresh
|
||||
after installing a game, and with the USB drive unplugged (*Not installed*, the drive named). (c) Delete all sessions
|
||||
on a game's page and in Settings ▸ Data. (d) *Sessions at a glance* and the Trend with a second unit. (e) The Legal
|
||||
Gate shows the Disclaimer 2.9 and the EULA 1.4 once. (f) The `ja` text of `Safety_Exception_Trial` (English until
|
||||
reviewed) and the App strings marked `review`.
|
||||
|
||||
**Answered 2026-08-05, do not re-ask:** remove `gameguard` and keep `guard` (approved
|
||||
over a red `Rules` gate, with the reasoning recorded in the merge commit); vendor NVAPI
|
||||
@@ -1410,6 +1882,14 @@ deferred with a written rationale.
|
||||
The mechanical ones live in the toolchain notes; these are the ones that cost a *wrong
|
||||
diagnosis*.
|
||||
|
||||
- **A VERB THAT PRINTS WAS A WRITER UNTIL 2026-09-16, AND THE OWNER'S LEDGER IS NOT A FIXTURE.** `--console
|
||||
sessions` against `%LOCALAPPDATA%\FrameLedger\ledger.db` applied two migration scripts, because every verb opened
|
||||
through the one migrating path. The print verbs open read-only now (`Program.PrintsOnly`; a schema older than the
|
||||
build is refused, exit 7) — but the rule that outlives the fix is: **nothing from a session is run against the
|
||||
owner's data directory unless the owner asks for exactly that**; `--data-dir` exists for everything else. The same
|
||||
day's ledger held a whole day of rows only in a WAL a fresh connection discarded (`06_DATA_MODEL` §Migrations
|
||||
carries the shape); if `ledger: wal at open` in `agent-*.log` or `ui-*.log` reports frames that a passive checkpoint
|
||||
did not move while no other FrameLedger process is running, stop and read that note before touching the file.
|
||||
- **THE TESTS WRITE INTO THE REAL DATA FOLDER, AND THAT IS NOT A SWITCH TO ADD.** The Overlay's log path is
|
||||
`SHGetKnownFolderPath`, never the environment (§S21), and the tests inject the shipped DLL, so 2492 hook-harness
|
||||
logs had piled up in the owner's `%LOCALAPPDATA%\FrameLedger\logs` by 2026-09-15. Each test binary now sweeps the
|
||||
|
||||
@@ -0,0 +1,71 @@
|
||||
# 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.*
|
||||
|
||||
**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. 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 |
|
||||
|
||||
## 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 | 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) |
|
||||
| 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))
|
||||
@@ -0,0 +1,36 @@
|
||||
# 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).
|
||||
+46
-7
@@ -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.
|
||||
|
||||
@@ -2545,3 +2566,21 @@ 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.
|
||||
+42
-13
@@ -11,10 +11,12 @@
|
||||
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-03.** The software is a beta; its latest
|
||||
> **pre-release is `0.1.0-beta.11`** (2026-10-03), 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
|
||||
@@ -27,8 +29,10 @@
|
||||
> 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 +45,47 @@
|
||||
> - **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. Other engines show what their own
|
||||
> files state.
|
||||
> - **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.
|
||||
> spikes were shader compilation, PC latency (Reflex), and HDR. Stutter count and stutter time are
|
||||
> measured from frame times.
|
||||
> - **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
|
||||
|
||||
+140
-41
@@ -1,34 +1,30 @@
|
||||
# FrameLedger — Disclaimer
|
||||
|
||||
**Version:** 2.1-draft · **Effective:** {{RELEASE_DATE}}
|
||||
**Version:** 2.9 · **Effective:** {{RELEASE_DATE}}
|
||||
|
||||
> ⚠ Draft for review. Not legal advice. Review before first public release — this version covers code injection and should be read carefully.
|
||||
> **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.
|
||||
|
||||
> ⚠ **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).
|
||||
## 0. This is pre-release (beta) software
|
||||
|
||||
**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)
|
||||
|
||||
@@ -59,7 +55,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.
|
||||
|
||||
@@ -85,6 +81,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,10 +117,12 @@ 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-03.** The software is a beta; its latest
|
||||
> **pre-release is `0.1.0-beta.11`** (2026-10-03), 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
|
||||
@@ -110,8 +135,10 @@ Frame timing is derived from high-resolution timestamps taken at the moment the
|
||||
> 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 +151,47 @@ 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. Other engines show what their own
|
||||
> files state.
|
||||
> - **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.
|
||||
> spikes were shader compilation, PC latency (Reflex), and HDR. Stutter count and stutter time are
|
||||
> measured from frame times.
|
||||
> - **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 +205,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 +246,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>
|
||||
+13
-4
@@ -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.4 · **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.
|
||||
|
||||
@@ -16,7 +14,7 @@ The Software records game performance data, hardware telemetry (temperatures, lo
|
||||
|
||||
## 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:
|
||||
|
||||
@@ -32,6 +30,17 @@ By enabling this feature for a game, you confirm that:
|
||||
|
||||
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.
|
||||
|
||||
## 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.
|
||||
|
||||
+19
-14
@@ -1,6 +1,6 @@
|
||||
# FrameLedger — Privacy Policy
|
||||
|
||||
**Version:** 2.1-draft · **Effective:** {{RELEASE_DATE}}
|
||||
**Version:** 2.5 · **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,29 +8,28 @@
|
||||
|
||||
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).
|
||||
- Performance sessions: frame timing series, computed statistics, hardware sensor series (temperatures, load, memory usage), 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.
|
||||
> **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.
|
||||
|
||||
GitHub's own privacy practices apply to requests it receives: <https://docs.github.com/privacy>.
|
||||
|
||||
## 3. Bug reports — always manual
|
||||
|
||||
@@ -38,9 +37,15 @@ The "Report a bug" feature builds a zip file **on your device**, shows you exact
|
||||
|
||||
## 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); 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); 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), 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 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; and how busy the processor is and how much memory is in use, from Windows' own counters.
|
||||
|
||||
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.
|
||||
|
||||
> **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.
|
||||
|
||||
All of this stays on your device. None of it is transmitted anywhere.
|
||||
|
||||
|
||||
@@ -48,6 +48,7 @@ FrameLedger is licensed under **GPL-3.0-only**. It includes or depends on the th
|
||||
| **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` |
|
||||
|
||||
## GPU telemetry — what is bundled and what is not
|
||||
|
||||
@@ -93,16 +94,16 @@ Any proposal to add a vendor SDK must first pass the checklist in `docs/18_GPU_V
|
||||
|
||||
## 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`
|
||||
- [ ] About → Third-party tab lists this table with versions filled from `Directory.Packages.props` — **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
|
||||
@@ -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
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
@@ -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,34 @@ 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) |
|
||||
| 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 +76,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) |
|
||||
|
||||
@@ -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.
|
||||
|
||||
+215
-25
@@ -15,16 +15,15 @@
|
||||
"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).",
|
||||
"STILL INCOMPLETE AS DATA: docs/19_SAFETY §Blocklist seed names one family",
|
||||
"with no representation here at all — Valve VAC (needs blockedStoreIds",
|
||||
"entries). Activision Ricochet was the other until 2026-09-25, when its",
|
||||
"driver and services arrived 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 +40,7 @@
|
||||
"level, which made it a check that could not fire."
|
||||
],
|
||||
"schemaVersion": 2,
|
||||
"rulesVersion": "2026.08.2",
|
||||
"rulesVersion": "2026.10.1",
|
||||
|
||||
"engines": [
|
||||
{
|
||||
@@ -60,7 +59,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": null
|
||||
},
|
||||
{
|
||||
"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": null
|
||||
},
|
||||
{
|
||||
"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",
|
||||
@@ -144,8 +182,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 +197,129 @@
|
||||
{ "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." }
|
||||
],
|
||||
"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": "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). 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": "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" ],
|
||||
"note": "'AntiCheatExpert Protection' MEASURED registered on the dev machine 2026-08-04 by Neverness To Everness. The sibling name is unmeasured." }
|
||||
"note": "'AntiCheatExpert Protection' MEASURED registered on the dev machine 2026-08-04 by Neverness To Everness. The sibling name 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": "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 +369,60 @@
|
||||
],
|
||||
"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": "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." }
|
||||
]
|
||||
}
|
||||
}
|
||||
@@ -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.",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": ["type"],
|
||||
"properties": {
|
||||
"type": { "const": "unreal_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" }
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
using System.Globalization;
|
||||
using System.Security.Principal;
|
||||
using FrameLedger.Infrastructure.Startup;
|
||||
|
||||
namespace FrameLedger.Agent.Cli;
|
||||
|
||||
@@ -11,6 +13,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 <SID></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 <outcome></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 +38,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 +68,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 +103,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 +123,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);
|
||||
|
||||
@@ -35,4 +35,11 @@ internal enum AgentVerb
|
||||
|
||||
/// <summary><c>--uninstall-task</c>.</summary>
|
||||
UninstallTask,
|
||||
|
||||
/// <summary>
|
||||
/// <c>--write-crash-dump <file></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,
|
||||
}
|
||||
@@ -276,7 +276,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
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
namespace FrameLedger.Agent.Composition;
|
||||
|
||||
/// <summary>
|
||||
/// The admin mode's answer at this Agent's start (beta.10, owner decision D34): registered by <c>--serve</c> alone, read into
|
||||
/// <c>HelloAck.ElevationOutcome</c>. Null when nobody asked — the option off, or elevation inherited from whoever started it.
|
||||
/// </summary>
|
||||
/// <param name="Outcome">One of <c>Infrastructure.Startup.AgentElevation</c>'s outcomes, or null.</param>
|
||||
internal sealed record AgentElevationState(string? Outcome);
|
||||
@@ -9,7 +9,7 @@ namespace FrameLedger.Agent.Composition;
|
||||
/// <summary>What <c>HelloAck</c> says about this process, read once at composition.</summary>
|
||||
internal static class AgentIdentityFactory
|
||||
{
|
||||
public static AgentIdentity OfThisProcess(string vkLayerDirectory)
|
||||
public static AgentIdentity OfThisProcess(string vkLayerDirectory, string? elevationOutcome = null)
|
||||
{
|
||||
ArgumentException.ThrowIfNullOrWhiteSpace(vkLayerDirectory);
|
||||
string buildId = NativeAntiCheatGuard.BuildId();
|
||||
@@ -21,10 +21,15 @@ internal static class AgentIdentityFactory
|
||||
// The layer reaches a launched process through VK_ADD_IMPLICIT_LAYER_PATH; the HKCU registration is the
|
||||
// repair tool --register-vklayer writes (P3 PR-8b), read here as it stands at this process's start.
|
||||
VulkanLayerRegistered: new VkLayerRegistration().IsRegistered(Path.Combine(vkLayerDirectory, VkLayerLaunchEnvironment.ManifestFileName)),
|
||||
// AgentRecording.Poller composes LhmComputerAdapter(enableCpuAndMemory: false): no CPU sensor unelevated.
|
||||
CpuTempAvailable: false,
|
||||
// The same two conditions SystemTelemetrySource.Create opens the CPU reader under (2026-09-21): elevated AND
|
||||
// PawnIO installed. It was a constant false while nothing read a CPU sensor at all.
|
||||
CpuTempAvailable: Infrastructure.Telemetry.LhmEnvironment.IsElevated && Infrastructure.Telemetry.LhmEnvironment.IsPawnIoInstalled == true,
|
||||
// D14: the FR-2.1 text this build stamps against; the App compares it with its own before showing the dialog.
|
||||
DisclosureVersion: SafetyDisclosure.Version);
|
||||
DisclosureVersion: SafetyDisclosure.Version,
|
||||
// D33: the user-mode exception's disclosure, under the same rule.
|
||||
ExceptionDisclosureVersion: AntiCheatExceptionDisclosure.Version,
|
||||
// beta.10 (D34): what the admin mode's prompt answered at this start; null when nobody asked.
|
||||
ElevationOutcome: elevationOutcome);
|
||||
}
|
||||
|
||||
private static string Version()
|
||||
|
||||
@@ -4,6 +4,7 @@ using FrameLedger.Application.Consent;
|
||||
using FrameLedger.Application.Persistence;
|
||||
using FrameLedger.Application.Recording;
|
||||
using FrameLedger.Application.Telemetry;
|
||||
using FrameLedger.Infrastructure.Display;
|
||||
using FrameLedger.Infrastructure.Telemetry;
|
||||
|
||||
namespace FrameLedger.Agent.Composition;
|
||||
@@ -34,6 +35,11 @@ internal sealed class AgentRecording
|
||||
private readonly ISessionObserver _observer;
|
||||
private readonly CapturePause _pause;
|
||||
private readonly IRecorderPolicy _policy;
|
||||
private readonly IDriverProfileSource _profiles;
|
||||
private readonly IUserModeExceptionSwitch _exceptions;
|
||||
private readonly IOverlayToleranceChannel _tolerance;
|
||||
private readonly WindowGeometryProbe _display = new();
|
||||
private readonly UserModeExceptionLapsePolicy _exceptionLapse;
|
||||
|
||||
public AgentRecording(
|
||||
IGameConsentStore store,
|
||||
@@ -53,8 +59,16 @@ internal sealed class AgentRecording
|
||||
ICrashEventSource crashes,
|
||||
ISessionObserver observer,
|
||||
CapturePause pause,
|
||||
IRecorderPolicy policy)
|
||||
IRecorderPolicy policy,
|
||||
IDriverProfileSource profiles,
|
||||
IUserModeExceptionSwitch exceptions,
|
||||
IOverlayToleranceChannel tolerance,
|
||||
UserModeExceptionLapsePolicy exceptionLapse)
|
||||
{
|
||||
_profiles = profiles;
|
||||
_exceptions = exceptions;
|
||||
_tolerance = tolerance;
|
||||
_exceptionLapse = exceptionLapse;
|
||||
_store = store;
|
||||
_gate = gate;
|
||||
_guard = guard;
|
||||
@@ -104,7 +118,9 @@ internal sealed class AgentRecording
|
||||
TimeProvider.System,
|
||||
new RecorderOptions { MinimumSessionLength = minimum, PartialFlushInterval = flush },
|
||||
_observer,
|
||||
_policy);
|
||||
_policy,
|
||||
_profiles,
|
||||
_exceptionLapse);
|
||||
}
|
||||
|
||||
/// <summary>L1 + L2 + L3 under the composite, one poller per session; the poller owns and disposes the layers. The interval is the session's (<c>telemetry.interval_ms</c>, D16).</summary>
|
||||
@@ -117,6 +133,7 @@ internal sealed class AgentRecording
|
||||
LhmTelemetrySource? l2 = null;
|
||||
NvapiTelemetrySource? l3 = null;
|
||||
CompositeTelemetrySource? composite = null;
|
||||
SystemTelemetrySource? system = null;
|
||||
try
|
||||
{
|
||||
pdh = new PdhAdapterMemoryCounter();
|
||||
@@ -131,8 +148,12 @@ internal sealed class AgentRecording
|
||||
l1 = null;
|
||||
l2 = null;
|
||||
l3 = null;
|
||||
var poller = new TelemetryPoller(composite, new TelemetryPollerOptions { Interval = interval }, TimeProvider.System, ownsSource: true);
|
||||
// The machine beside the GPU (2026-09-21): CPU busy time and memory unprivileged, the CPU temperature only
|
||||
// where this process is elevated and PawnIO is installed. The poller owns it with the layers.
|
||||
system = SystemTelemetrySource.Create();
|
||||
var poller = new TelemetryPoller(composite, new TelemetryPollerOptions { Interval = interval }, TimeProvider.System, ownsSource: true, system);
|
||||
composite = null;
|
||||
system = null;
|
||||
return poller;
|
||||
}
|
||||
finally
|
||||
@@ -142,6 +163,7 @@ internal sealed class AgentRecording
|
||||
l2?.Dispose();
|
||||
l3?.Dispose();
|
||||
composite?.Dispose();
|
||||
system?.Dispose();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -164,7 +186,11 @@ internal sealed class AgentRecording
|
||||
launcher,
|
||||
observer,
|
||||
_killSwitch,
|
||||
_pause);
|
||||
_pause,
|
||||
_exceptions,
|
||||
_tolerance,
|
||||
// beta.10: the game's window, read out of process on the loop's ticks (03_METRICS §Display mode).
|
||||
_display);
|
||||
|
||||
/// <summary>The session and its collaborators, wired the only way the Agent allows; the recorder supplies the observer.</summary>
|
||||
private sealed class Factory(AgentRecording owner, int seconds, IProcessLauncher? launcher) : ICaptureSessionFactory
|
||||
|
||||
@@ -70,18 +70,26 @@ internal static class AgentServices
|
||||
services.AddSingleton<IRecorderPolicy, SettingsRecorderPolicy>();
|
||||
services.AddSingleton<SettingsKillSwitch>();
|
||||
services.AddSingleton<IKillSwitch>(static sp => sp.GetRequiredService<SettingsKillSwitch>());
|
||||
AddUserModeException(services);
|
||||
|
||||
// The gate and the guard: one native facade, one managed gate in front of it.
|
||||
services.AddSingleton<IAntiCheatGuard, NativeAntiCheatGuard>();
|
||||
services.AddSingleton<HookedCaptureGate>();
|
||||
|
||||
// The capture path's adapters (PR-C).
|
||||
services.AddSingleton<ITargetResolver>(static _ => new TargetResolver(AgentConsole.Line));
|
||||
// The capture path's adapters (PR-C). The resolver's notes reach the Agent's log too (2026-09-23: there were none in
|
||||
// it), and its Tier-2 liveness reads the watcher's snapshot by image path, never a process of its own.
|
||||
services.AddSingleton<LatestProcessSnapshot>();
|
||||
services.AddSingleton<ITargetResolver>(static sp => new TargetResolver(
|
||||
static line =>
|
||||
{
|
||||
AgentConsole.Line(line);
|
||||
Serilog.Log.Information("{Line}", line);
|
||||
},
|
||||
sp.GetRequiredService<LatestProcessSnapshot>()));
|
||||
services.AddSingleton<ITargetLivenessSource, HeldProcessLivenessSource>();
|
||||
services.AddSingleton<IRingAttacher>(static _ => new ShmRingAttacher(NativeAntiCheatGuard.BuildId()));
|
||||
services.AddSingleton<IRuntimeModuleSnapshot>(static _ => new RuntimeModuleSnapshot(CensusNames.ModuleFileNames));
|
||||
services.AddSingleton<NvapiNgxStateProbe>();
|
||||
services.AddSingleton<INgxDriverProbe>(static sp => sp.GetRequiredService<NvapiNgxStateProbe>());
|
||||
AddNvidia(services);
|
||||
|
||||
// The recorder's adapters (PR-D).
|
||||
services.AddSingleton<IPartialSessionStore>(_ => new PartialSessionStore(paths.Tmp));
|
||||
@@ -104,6 +112,31 @@ internal static class AgentServices
|
||||
return services;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// D33 (owner decision 2026-09-26): the user-mode exception's option (one row in <c>settings</c>), its channel to the
|
||||
/// Overlay (<c>Local\FrameLedger.Tolerate.<pid></c>, created before an injection under it), and the policy that ends
|
||||
/// it when a session under it ends badly.
|
||||
/// </summary>
|
||||
private static void AddUserModeException(IServiceCollection services)
|
||||
{
|
||||
services.AddSingleton<IUserModeExceptionSwitch, SettingsUserModeExceptionSwitch>();
|
||||
services.AddSingleton<IOverlayToleranceChannel>(static _ => new OverlayToleranceChannel(static line => Serilog.Log.Information("{Line}", line)));
|
||||
services.AddSingleton(static sp => new UserModeExceptionLapsePolicy(sp.GetRequiredService<IGameConsentStore>(), sp.GetRequiredService<ISessionRepository>()));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// What the NVIDIA driver says about a session, through the bridge (never into a game): the per-process NGX words (P2
|
||||
/// PR-E2), and since beta.8 the driver profile each session's executable runs under — the NVIDIA App's DLSS and
|
||||
/// frame-generation overrides — read from the driver's settings store through the bridge's read-only DRS entry point.
|
||||
/// </summary>
|
||||
private static void AddNvidia(IServiceCollection services)
|
||||
{
|
||||
services.AddSingleton<NvapiNgxStateProbe>();
|
||||
services.AddSingleton<INgxDriverProbe>(static sp => sp.GetRequiredService<NvapiNgxStateProbe>());
|
||||
services.AddSingleton<NvapiDriverProfileSource>();
|
||||
services.AddSingleton<IDriverProfileSource>(static sp => sp.GetRequiredService<NvapiDriverProfileSource>());
|
||||
}
|
||||
|
||||
/// <summary>The static detection sweep (P4 PR-1, <c>05_DETECTION</c> §Caching): hosted under <c>--serve</c> only, composed and inert under <c>--console</c>.</summary>
|
||||
private static void AddDetection(IServiceCollection services, AgentPaths paths)
|
||||
{
|
||||
@@ -112,12 +145,43 @@ internal static class AgentServices
|
||||
// --serve only (DetectionHostedService); composed and inert under --console.
|
||||
services.AddSingleton<IDetectionRulesSource>(static _ => new DetectionRulesFile());
|
||||
services.AddSingleton<IGameFileProbe, GameFileProbe>();
|
||||
// A drive that changed its letter (2026-09-22): one relocator, asked by the sweep, the watcher and the enable-hooking
|
||||
// command, over the BCL's drive list. Since 2026-09-23 it also merges two entries for one executable (D26), and waits
|
||||
// while a session of either runs — the orchestrator's table, read when asked (it holds the relocator itself) — or
|
||||
// waits in a .partial to be recovered.
|
||||
services.AddSingleton<IGameMerge>(static sp => new SqliteGameMerge(sp.GetRequiredService<LedgerDatabase>()));
|
||||
services.AddSingleton(static sp => new ExecutableRelocator(
|
||||
sp.GetRequiredService<IGameRepository>(),
|
||||
sp.GetRequiredService<IExecutableIdentitySource>(),
|
||||
VolumeRoots.Ready,
|
||||
static line => Serilog.Log.Information("{Line}", line),
|
||||
merge: sp.GetRequiredService<IGameMerge>(),
|
||||
busy: id => sp.GetRequiredService<CaptureOrchestrator>().IsRecording(id)
|
||||
|| sp.GetRequiredService<IPartialSessionStore>().PendingGameIds().Contains(id)));
|
||||
services.AddSingleton(static sp => new DetectionSweep(
|
||||
sp.GetRequiredService<IGameRepository>(),
|
||||
sp.GetRequiredService<IDetectionRulesSource>(),
|
||||
sp.GetRequiredService<IGameFileProbe>(),
|
||||
sp.GetRequiredService<IExecutableIdentitySource>(),
|
||||
static line => Serilog.Log.Information("{Line}", line)));
|
||||
static line => Serilog.Log.Information("{Line}", line),
|
||||
sp.GetRequiredService<ExecutableRelocator>()));
|
||||
|
||||
// The anti-cheat pre-scan of the library (beta.8, 19_SAFETY §What a finding does to the game): every entry through
|
||||
// the guard's advisory checks 3 and 4, again whenever the rules or the executable change. It waits while a session
|
||||
// of the entry runs (the session's own checks are running then), and tells the App only when it turned hooking off
|
||||
// for an entry the user had turned on. Hosted under --serve only, beside the detection sweep.
|
||||
services.AddSingleton(static sp => new AntiCheatPreScanSweep(
|
||||
sp.GetRequiredService<IGameRepository>(),
|
||||
sp.GetRequiredService<IGameConsentStore>(),
|
||||
sp.GetRequiredService<IAntiCheatGuard>(),
|
||||
sp.GetRequiredService<IDetectionRulesSource>(),
|
||||
sp.GetRequiredService<IExecutableIdentitySource>(),
|
||||
static line => Serilog.Log.Information("{Line}", line),
|
||||
sp.GetRequiredService<IIpcEventPublisher>(),
|
||||
id => sp.GetRequiredService<CaptureOrchestrator>().IsRecording(id),
|
||||
// D33: the evidence and the option the user-mode exception's eligibility needs.
|
||||
sp.GetRequiredService<ISessionRepository>(),
|
||||
sp.GetRequiredService<IUserModeExceptionSwitch>()));
|
||||
|
||||
// The layer's registration follows the ledger (P4 PR-2, 12_BUILD §The Vulkan layer is not registered at
|
||||
// install time): the same manifest and key --register-vklayer writes, reconciled after every consent change
|
||||
@@ -149,30 +213,9 @@ internal static class AgentServices
|
||||
// host's under --serve and a logged no-op under --console (TryAdd: --serve registers its own first).
|
||||
services.AddSingleton<CapturePause>();
|
||||
services.TryAddSingleton<IAgentLifetime, NoAgentLifetime>();
|
||||
services.AddSingleton(static sp => new AgentCommandHandler(
|
||||
sp.GetRequiredService<IGameRepository>(),
|
||||
sp.GetRequiredService<IGameConsentStore>(),
|
||||
sp.GetRequiredService<IAntiCheatGuard>(),
|
||||
sp.GetRequiredService<IExecutableIdentitySource>(),
|
||||
sp.GetRequiredService<CaptureOrchestrator>(),
|
||||
sp.GetRequiredService<CapturePause>(),
|
||||
sp.GetRequiredService<IAgentLifetime>(),
|
||||
// UpdateRules: re-seed the rules file, then wake the detection sweep (P4 PR-1) — a rules change is the
|
||||
// re-run trigger 05_DETECTION §Caching names, so the games table follows within the same second.
|
||||
async ct =>
|
||||
{
|
||||
RulesSeedOutcome outcome = await new RulesSeeder(new FileSystemRulesStore()).EnsureSeededAsync(ct).ConfigureAwait(false);
|
||||
sp.GetRequiredService<DetectionSweep>().RequestNow();
|
||||
return outcome.ToString();
|
||||
},
|
||||
// P3 PR-4 (D14): the reviewed disclosure this Agent stamps against, and its own clock for the stamp.
|
||||
SafetyDisclosure.Version,
|
||||
TimeProvider.System,
|
||||
sp.GetRequiredService<VkLayerReconciler>(),
|
||||
// P4 PR-7: the on-demand retention sweep, over the Agent's own settings read and its own blob tables.
|
||||
ct => new RetentionSweep(sp.GetRequiredService<ISessionRepository>(), sp.GetRequiredService<RegisteredSettings>()).RunAsync(ct)));
|
||||
services.AddSingleton(static sp => CommandHandler(sp));
|
||||
services.AddSingleton<IIpcRequestHandler>(static sp => new AgentRequestHandler(
|
||||
AgentIdentityFactory.OfThisProcess(sp.GetRequiredService<AgentPaths>().VkLayerDirectory),
|
||||
AgentIdentityFactory.OfThisProcess(sp.GetRequiredService<AgentPaths>().VkLayerDirectory, sp.GetService<AgentElevationState>()?.Outcome),
|
||||
TelemetryDescriptor(),
|
||||
() => sp.GetRequiredService<SessionEventPublisher>().Status,
|
||||
() => sp.GetRequiredService<AgentCommandHandler>()));
|
||||
@@ -190,11 +233,49 @@ internal static class AgentServices
|
||||
sp.GetRequiredService<IExecutableIdentitySource>(),
|
||||
new OrchestratorOptions { PayloadPath = AgentPaths.Payload },
|
||||
static line => Serilog.Log.Information("{Line}", line),
|
||||
sp.GetRequiredService<ILaunchRecorderFactory>()));
|
||||
sp.GetRequiredService<ILaunchRecorderFactory>(),
|
||||
sp.GetRequiredService<ExecutableRelocator>(),
|
||||
sp.GetRequiredService<LatestProcessSnapshot>()));
|
||||
services.AddSingleton<ILaunchRecorderFactory, AgentLaunches>();
|
||||
|
||||
}
|
||||
|
||||
/// <summary>The command half of the pipe (P3 PR-1b) over the Agent's own adapters — every command it answers, D33's included.</summary>
|
||||
private static AgentCommandHandler CommandHandler(IServiceProvider sp) =>
|
||||
new AgentCommandHandler(
|
||||
sp.GetRequiredService<IGameRepository>(),
|
||||
sp.GetRequiredService<IGameConsentStore>(),
|
||||
sp.GetRequiredService<IAntiCheatGuard>(),
|
||||
sp.GetRequiredService<IExecutableIdentitySource>(),
|
||||
sp.GetRequiredService<CaptureOrchestrator>(),
|
||||
sp.GetRequiredService<CapturePause>(),
|
||||
sp.GetRequiredService<IAgentLifetime>(),
|
||||
// UpdateRules: re-seed the rules file, then wake the detection sweep (P4 PR-1) — a rules change is the
|
||||
// re-run trigger 05_DETECTION §Caching names, so the games table follows within the same second.
|
||||
async ct =>
|
||||
{
|
||||
RulesSeedOutcome outcome = await new RulesSeeder(new FileSystemRulesStore()).EnsureSeededAsync(ct).ConfigureAwait(false);
|
||||
sp.GetRequiredService<DetectionSweep>().RequestNow();
|
||||
// And the anti-cheat pre-scan: new rules may name a game the library already holds (2026-09-25).
|
||||
sp.GetRequiredService<AntiCheatPreScanSweep>().RequestNow();
|
||||
return outcome.ToString();
|
||||
},
|
||||
// P3 PR-4 (D14): the reviewed disclosure this Agent stamps against, and its own clock for the stamp.
|
||||
SafetyDisclosure.Version,
|
||||
TimeProvider.System,
|
||||
sp.GetRequiredService<VkLayerReconciler>(),
|
||||
// P4 PR-7: the on-demand retention sweep, over the Agent's own settings read and its own blob tables.
|
||||
ct => new RetentionSweep(sp.GetRequiredService<ISessionRepository>(), sp.GetRequiredService<RegisteredSettings>()).RunAsync(ct),
|
||||
sp.GetRequiredService<ExecutableRelocator>(),
|
||||
// beta.8: an executable that cannot run as x64 is refused before anything is scanned or stamped.
|
||||
new PeArchitectureSource(),
|
||||
// D33: the user-mode exception's option and disclosure version (D38: no session count any more).
|
||||
new AntiCheatExceptionCommands(
|
||||
sp.GetRequiredService<IUserModeExceptionSwitch>(),
|
||||
AntiCheatExceptionDisclosure.Version),
|
||||
// beta.11 (D40): Delete all sessions, of one game or of every game — the Agent's rows, deleted by the Agent.
|
||||
sp.GetRequiredService<ISessionRepository>());
|
||||
|
||||
/// <summary>
|
||||
/// <c>HelloAck.telemetrySource</c>: the layers this machine composes, read once on the first <c>Hello</c> by
|
||||
/// standing the composite up and taking it down again — a library start, which is why it is not done at
|
||||
|
||||
@@ -0,0 +1,61 @@
|
||||
using System.Data.Common;
|
||||
using FrameLedger.Application.AntiCheat;
|
||||
using Microsoft.Extensions.Hosting;
|
||||
using Serilog;
|
||||
|
||||
namespace FrameLedger.Agent.Hosting;
|
||||
|
||||
/// <summary>
|
||||
/// <c>--serve</c> (beta.8, 2026-09-25): the anti-cheat pre-scan of the library on its own background task. One pass at
|
||||
/// start, then one every <see cref="Interval"/>, and one as soon as <c>UpdateRules</c> re-seeds the rules file
|
||||
/// (<see cref="AntiCheatPreScanSweep.RequestNow"/>). It reads executables' paths, install folders and the stores' own
|
||||
/// files, and writes the pre-scan's hook-state columns of <c>games</c>; it never opens a game's process
|
||||
/// (<c>19_SAFETY</c> §What a finding does to the game, CLAUDE.md rule 4).
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Its own task, like <see cref="DetectionHostedService"/>'s, because the guard's directory walk blocks on file I/O.
|
||||
/// A pass that throws is logged and retried on the next tick rather than ending the service: a game's folder going away
|
||||
/// mid-walk is ordinary, a busy ledger is a retry, and a service that throws stops the Agent's host.
|
||||
/// </remarks>
|
||||
internal sealed class AntiCheatPreScanHostedService(AntiCheatPreScanSweep sweep) : BackgroundService
|
||||
{
|
||||
/// <summary>The idle cadence, the detection sweep's: a game the App just added is scanned within it.</summary>
|
||||
public static readonly TimeSpan Interval = TimeSpan.FromSeconds(15);
|
||||
|
||||
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
|
||||
{
|
||||
Log.Information("prescan: scanning the library for anti-cheat every {Seconds} s, and on every rules update", Interval.TotalSeconds);
|
||||
while (!stoppingToken.IsCancellationRequested)
|
||||
{
|
||||
try
|
||||
{
|
||||
AntiCheatPreScanReport r = await sweep.SweepOnceAsync(stoppingToken).ConfigureAwait(false);
|
||||
// Said when something happened: a pass over an unchanged library scans nothing and says nothing.
|
||||
if (r.Scanned > 0 || r.RulesUnusable)
|
||||
{
|
||||
Log.Information("prescan: scanned {Scanned} — anti-cheat {Found}, clean {Clean}, could not verify {Unverified}; blocked {Blocked}, current {Current}{Rules}",
|
||||
r.Scanned, r.Found, r.Clean, r.Unverified, r.Blocked, r.Current, r.RulesUnusable ? ", rules unusable" : string.Empty);
|
||||
}
|
||||
}
|
||||
catch (OperationCanceledException) when (stoppingToken.IsCancellationRequested)
|
||||
{
|
||||
break;
|
||||
}
|
||||
catch (Exception ex) when (ex is IOException or UnauthorizedAccessException or InvalidOperationException or DbException)
|
||||
{
|
||||
Log.Warning(ex, "prescan: pass did not complete; retrying on the next tick");
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
await sweep.WaitAsync(Interval, stoppingToken).ConfigureAwait(false);
|
||||
}
|
||||
catch (OperationCanceledException) when (stoppingToken.IsCancellationRequested)
|
||||
{
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
Log.Information("prescan: stopped");
|
||||
}
|
||||
}
|
||||
@@ -1,3 +1,4 @@
|
||||
using System.Data.Common;
|
||||
using FrameLedger.Application.Detection;
|
||||
using FrameLedger.Application.Vulkan;
|
||||
using Microsoft.Extensions.Hosting;
|
||||
@@ -15,7 +16,9 @@ namespace FrameLedger.Agent.Hosting;
|
||||
/// Its own task because <c>GameFileProbe</c> blocks on file I/O (a bounded directory walk, an 8 MB strings pass):
|
||||
/// the orchestrator's 1 Hz poll must not wait on it, and a session's drain must never share a thread with it.
|
||||
/// A sweep that throws is logged and retried on the next tick rather than ending the service — a game's
|
||||
/// directory going away mid-walk is ordinary, and one bad game must not stop the scan of the rest.
|
||||
/// directory going away mid-walk is ordinary, and one bad game must not stop the scan of the rest. A database error
|
||||
/// is one of those since 2026-09-23: the sweep writes rows (a relocation, a merge), a service that throws stops the
|
||||
/// Agent's host (the Generic Host's default), and a busy or locked ledger is a retry, not a reason to stop capturing.
|
||||
/// </remarks>
|
||||
internal sealed class DetectionHostedService(DetectionSweep sweep, VkLayerReconciler layer) : BackgroundService
|
||||
{
|
||||
@@ -25,17 +28,22 @@ internal sealed class DetectionHostedService(DetectionSweep sweep, VkLayerReconc
|
||||
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
|
||||
{
|
||||
Log.Information("detect: sweeping the library every {Seconds} s, and on every rules update", Interval.TotalSeconds);
|
||||
DetectionSweepReport? previous = null;
|
||||
while (!stoppingToken.IsCancellationRequested)
|
||||
{
|
||||
try
|
||||
{
|
||||
DetectionSweepReport r = await sweep.SweepOnceAsync(stoppingToken).ConfigureAwait(false);
|
||||
if (r.Scanned > 0 || r.Unreadable > 0 || r.RulesUnusable)
|
||||
// Said when something happened or changed (2026-09-23): an unreadable entry used to repeat this line every
|
||||
// 15 s — 5,760 a day — with nothing new in it.
|
||||
if (r.Scanned > 0 || r.Relocated > 0 || r.RulesUnusable || (r.Unreadable > 0 && r.Unreadable != previous?.Unreadable))
|
||||
{
|
||||
Log.Information("detect: sweep scanned {Scanned}, current {Current}, unreadable {Unreadable}{Rules}",
|
||||
r.Scanned, r.Current, r.Unreadable, r.RulesUnusable ? ", rules unusable" : string.Empty);
|
||||
}
|
||||
|
||||
previous = r;
|
||||
|
||||
// The layer follows the ledger after every sweep (P4 PR-2): a Vulkan fact that arrived after the
|
||||
// consent, and the crash policy's auto-disable, both converge here within one interval.
|
||||
_ = await layer.ReconcileAsync(stoppingToken).ConfigureAwait(false);
|
||||
@@ -44,7 +52,7 @@ internal sealed class DetectionHostedService(DetectionSweep sweep, VkLayerReconc
|
||||
{
|
||||
break;
|
||||
}
|
||||
catch (Exception ex) when (ex is IOException or UnauthorizedAccessException or InvalidOperationException)
|
||||
catch (Exception ex) when (ex is IOException or UnauthorizedAccessException or InvalidOperationException or DbException)
|
||||
{
|
||||
Log.Warning(ex, "detect: sweep did not complete; retrying on the next tick");
|
||||
}
|
||||
|
||||
@@ -14,19 +14,30 @@ namespace FrameLedger.Agent.Hosting;
|
||||
/// a session somebody lost, and it becomes an <c>interrupted</c> row before any new session can write beside
|
||||
/// it. Then the orchestrator polls until the host stops; its sessions finalize inside the host's shutdown
|
||||
/// grace, and one that does not make it leaves its <c>.partial</c> for the next start — the same rule.
|
||||
/// <b>Nothing recovery does can keep the watcher from starting (2026-09-23)</b>: the host's default for a background
|
||||
/// service that throws is to stop the whole Agent, so a file recovery could not finalize would have stopped every start
|
||||
/// after it. <see cref="PartialRecovery"/> no longer throws; the guard here is for what it cannot foresee.
|
||||
/// </remarks>
|
||||
internal sealed class WatcherHostedService(PartialRecovery recovery, CaptureOrchestrator orchestrator) : BackgroundService
|
||||
{
|
||||
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
|
||||
{
|
||||
IReadOnlyList<RecoveryOutcome> recovered = await recovery.RecoverAsync(stoppingToken).ConfigureAwait(false);
|
||||
Log.Information("recover: {Count} pending .partial file(s)", recovered.Count);
|
||||
foreach (RecoveryOutcome o in recovered)
|
||||
try
|
||||
{
|
||||
Log.Information("recover: {Guid} {Status} {Detail}", o.SessionGuid.ToString("N"), o.Status, o.Detail);
|
||||
IReadOnlyList<RecoveryOutcome> recovered = await recovery.RecoverAsync(stoppingToken).ConfigureAwait(false);
|
||||
Log.Information("recover: {Count} pending .partial file(s)", recovered.Count);
|
||||
foreach (RecoveryOutcome o in recovered)
|
||||
{
|
||||
Log.Information("recover: {Guid} {Status} {Detail}", o.SessionGuid.ToString("N"), o.Status, o.Detail);
|
||||
}
|
||||
}
|
||||
catch (Exception ex) when (ex is not OperationCanceledException and not OutOfMemoryException)
|
||||
{
|
||||
Log.Warning(ex, "recover: did not complete; the watcher starts anyway and the files stay for the next start");
|
||||
}
|
||||
|
||||
Log.Information("serve: watching the games table at 1 Hz; hooking only where a game is enabled and consented");
|
||||
Log.Information("serve: watching the games table at 1 Hz; hooking only where a game is enabled and consented ({Elevation}, pid {Pid})",
|
||||
Environment.IsPrivilegedProcess ? "elevated" : "not elevated", Environment.ProcessId);
|
||||
await orchestrator.RunAsync(stoppingToken).ConfigureAwait(false);
|
||||
Log.Information("serve: stopped");
|
||||
}
|
||||
|
||||
@@ -9,9 +9,17 @@
|
||||
// The Agent is the sole owner of %LOCALAPPDATA%\FrameLedger (§S18 blocker 3, ratified) and the only
|
||||
// thing that may write there; `--data-dir` exists only under `--console` (HANDOFF §P2 decision D6).
|
||||
//
|
||||
// One process per data folder runs the capturing verbs (--serve, capture, launch, recover): Infrastructure.Startup's
|
||||
// AgentInstanceLock, claimed before logging, and a second exits 10 (2026-09-17 — beta.1 ran four Agents at once).
|
||||
//
|
||||
// The maintenance flags (P3 PR-8b) — --register-vklayer, --unregister-vklayer, --install-task, --uninstall-task —
|
||||
// run over the product directory and exit; --diag is the App's (10_LOGGING) and answers "not implemented", exit 2.
|
||||
//
|
||||
// The admin mode (beta.10, owner decision D34): with capture.run_elevated on, a plain --serve that is not elevated — the
|
||||
// logon task's — asks Windows once (a UAC prompt on the taskbar) to start an elevated Agent for this user and hands over to
|
||||
// it; declined, it serves as before and says so. Decided before the folder is claimed or anything is written.
|
||||
|
||||
using System.Diagnostics;
|
||||
using FrameLedger.Agent.Cli;
|
||||
using FrameLedger.Agent.Composition;
|
||||
using FrameLedger.Agent.Hosting;
|
||||
@@ -20,6 +28,7 @@ using FrameLedger.Application.Rules;
|
||||
using FrameLedger.Infrastructure.Diagnostics;
|
||||
using FrameLedger.Infrastructure.Persistence;
|
||||
using FrameLedger.Infrastructure.Rules;
|
||||
using FrameLedger.Infrastructure.Startup;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.Extensions.Hosting;
|
||||
using Serilog;
|
||||
@@ -32,6 +41,7 @@ internal static class Program
|
||||
private const int _exitUsage = 1;
|
||||
private const int _exitNotImplemented = 2;
|
||||
private const int _exitRulesFailed = 3;
|
||||
private const int _exitLedgerRefused = 7;
|
||||
|
||||
private static int _crashReported;
|
||||
|
||||
@@ -40,47 +50,31 @@ internal static class Program
|
||||
ArgumentNullException.ThrowIfNull(args);
|
||||
|
||||
AgentCommandLine cmd = AgentCommandLine.Parse(args);
|
||||
if (cmd.Error is not null)
|
||||
if (AnswerWithoutLogging(cmd) is { } answered)
|
||||
{
|
||||
AgentConsole.Problem(cmd.Error);
|
||||
return _exitUsage;
|
||||
}
|
||||
|
||||
if (cmd.Verb == AgentVerb.NotImplemented)
|
||||
{
|
||||
AgentConsole.Problem($"{cmd.Flag}: not this binary's — FrameLedger.exe --diag writes the report (10_LOGGING §Diagnostics extras)");
|
||||
return _exitNotImplemented;
|
||||
return answered;
|
||||
}
|
||||
|
||||
AgentPaths paths = cmd.DataDirectory is { } dir ? new AgentPaths(Path.GetFullPath(dir)) : AgentPaths.Default;
|
||||
ElevationDecision elevation = cmd.Verb == AgentVerb.Serve ? await DecideElevationAsync(cmd, paths).ConfigureAwait(false) : ElevationDecision.NotAsked;
|
||||
if (elevation.Exit is { } decided)
|
||||
{
|
||||
return decided;
|
||||
}
|
||||
|
||||
using AgentInstanceLock? claim = ClaimDataDirectory(cmd.Verb, paths, out bool heldElsewhere);
|
||||
if (heldElsewhere)
|
||||
{
|
||||
return AgentInstanceLock.ExitHeldElsewhere;
|
||||
}
|
||||
|
||||
ConfigureLogging(paths);
|
||||
HookCrashHandlers(paths);
|
||||
LogElevation(elevation);
|
||||
|
||||
try
|
||||
{
|
||||
// Before anything else. The guard reads this file on every evaluation and refuses every title
|
||||
// when it is absent, so a capture started before the seed lands would fail for a reason that
|
||||
// has nothing to do with the game (§S20).
|
||||
RulesSeedOutcome seeded = await new RulesSeeder(new FileSystemRulesStore()).EnsureSeededAsync().ConfigureAwait(false);
|
||||
AgentConsole.Line($"rules: {Describe(seeded)}");
|
||||
Log.Information("rules: {Outcome}", seeded);
|
||||
if (seeded is RulesSeedOutcome.WriteFailed or RulesSeedOutcome.PackagedSeedUnusable)
|
||||
{
|
||||
return _exitRulesFailed;
|
||||
}
|
||||
|
||||
LedgerDatabase db = await LedgerDatabase.OpenAsync(paths.Database).ConfigureAwait(false);
|
||||
await using (db.ConfigureAwait(false))
|
||||
{
|
||||
Log.Information("ledger: {Path} (schema {Schema}, migration {Migration})", db.Path, db.SchemaVersion, db.Migration);
|
||||
return cmd.Verb switch
|
||||
{
|
||||
AgentVerb.Serve => await ServeAsync(db, paths).ConfigureAwait(false),
|
||||
AgentVerb.RegisterVkLayer or AgentVerb.UnregisterVkLayer or AgentVerb.InstallTask or AgentVerb.UninstallTask =>
|
||||
await new MaintenanceVerbs(db, paths).RunAsync(cmd).ConfigureAwait(false),
|
||||
_ => await ConsoleAsync(cmd, db, paths).ConfigureAwait(false),
|
||||
};
|
||||
}
|
||||
return await RunAsync(cmd, paths, elevation.Outcome).ConfigureAwait(false);
|
||||
}
|
||||
catch (Exception ex) when (ex is not OutOfMemoryException)
|
||||
{
|
||||
@@ -95,11 +89,215 @@ internal static class Program
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>The rules, the ledger and the verb, once the folder is claimed and the log is open.</summary>
|
||||
private static async Task<int> RunAsync(AgentCommandLine cmd, AgentPaths paths, string? elevationOutcome)
|
||||
{
|
||||
// Before anything else. The guard reads this file on every evaluation and refuses every title
|
||||
// when it is absent, so a capture started before the seed lands would fail for a reason that
|
||||
// has nothing to do with the game (§S20).
|
||||
RulesSeedOutcome seeded = await new RulesSeeder(new FileSystemRulesStore()).EnsureSeededAsync().ConfigureAwait(false);
|
||||
AgentConsole.Line($"rules: {Describe(seeded)}");
|
||||
Log.Information("rules: {Outcome}", seeded);
|
||||
if (seeded is RulesSeedOutcome.WriteFailed or RulesSeedOutcome.PackagedSeedUnusable)
|
||||
{
|
||||
return _exitRulesFailed;
|
||||
}
|
||||
|
||||
LedgerDatabase? db = await OpenLedgerOrSayWhyAsync(cmd.Verb, paths).ConfigureAwait(false);
|
||||
if (db is null)
|
||||
{
|
||||
return cmd.Verb == AgentVerb.DbPath ? _exitOk : _exitLedgerRefused;
|
||||
}
|
||||
|
||||
await using (db.ConfigureAwait(false))
|
||||
{
|
||||
return cmd.Verb switch
|
||||
{
|
||||
AgentVerb.Serve => await ServeAsync(db, paths, elevationOutcome).ConfigureAwait(false),
|
||||
AgentVerb.RegisterVkLayer or AgentVerb.UnregisterVkLayer or AgentVerb.InstallTask or AgentVerb.UninstallTask =>
|
||||
await new MaintenanceVerbs(db, paths).RunAsync(cmd).ConfigureAwait(false),
|
||||
_ => await ConsoleAsync(cmd, db, paths).ConfigureAwait(false),
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>A usage error or a flag this binary does not implement is answered before any file is touched.</summary>
|
||||
private static int? AnswerWithoutLogging(AgentCommandLine cmd)
|
||||
{
|
||||
if (cmd.Verb == AgentVerb.WriteCrashDump)
|
||||
{
|
||||
// Before logging, rules and the ledger: the crashed parent still holds the day's log file, and a helper that
|
||||
// waited on anything the parent holds would be the deadlock it exists to avoid.
|
||||
return ParentDump.Run(cmd.CrashDumpFile!, AgentConsole.Problem);
|
||||
}
|
||||
|
||||
if (cmd.Error is not null)
|
||||
{
|
||||
AgentConsole.Problem(cmd.Error);
|
||||
return _exitUsage;
|
||||
}
|
||||
|
||||
if (cmd.Verb == AgentVerb.NotImplemented)
|
||||
{
|
||||
AgentConsole.Problem($"{cmd.Flag}: not this binary's — FrameLedger.exe --diag writes the report (10_LOGGING §Diagnostics extras)");
|
||||
return _exitNotImplemented;
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The verbs that only print open the ledger read-only — no migration, no write — so that running one against a
|
||||
/// ledger at another schema changes nothing on disk (2026-09-16: <c>sessions</c> against the owner's own ledger
|
||||
/// applied two scripts to it). Every other verb is a writer and opens read-write, migrating as before.
|
||||
/// </summary>
|
||||
internal static bool PrintsOnly(AgentVerb verb) =>
|
||||
verb is AgentVerb.Sessions or AgentVerb.ConsentList or AgentVerb.KillSwitchStatus or AgentVerb.DbPath;
|
||||
|
||||
/// <summary>
|
||||
/// The verbs that inject, read a ring or finalize sessions: one process per data folder may run them (2026-09-17). The
|
||||
/// others (consent, games, the kill switch, the maintenance flags, the read-only verbs) run beside a serving Agent, as
|
||||
/// the App's own <c>--install-task</c> does.
|
||||
/// </summary>
|
||||
internal static bool Captures(AgentVerb verb) =>
|
||||
verb is AgentVerb.Serve or AgentVerb.Capture or AgentVerb.Launch or AgentVerb.Recover;
|
||||
|
||||
private static AgentInstanceLock? ClaimDataDirectory(AgentVerb verb, AgentPaths paths, out bool heldElsewhere)
|
||||
{
|
||||
heldElsewhere = false;
|
||||
if (!Captures(verb))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
AgentInstanceLock? claim = AgentInstanceLock.TryAcquire(paths.DataDirectory);
|
||||
if (claim is null)
|
||||
{
|
||||
// Before logging, rules and the ledger: the Agent holding the folder holds the day's log file too, so a second one
|
||||
// leaves nothing behind but this line and its exit code, which the App's log records when the App started it.
|
||||
heldElsewhere = true;
|
||||
AgentConsole.Problem($"another FrameLedger Agent is already capturing for {paths.DataDirectory}; this one exits (exit {AgentInstanceLock.ExitHeldElsewhere})");
|
||||
}
|
||||
|
||||
return claim;
|
||||
}
|
||||
|
||||
/// <summary>What the admin mode decided at this start: the outcome <c>HelloAck</c> reports, and an exit code when this process stops here.</summary>
|
||||
private sealed record ElevationDecision(string? Outcome, int? Exit, string? Detail)
|
||||
{
|
||||
public static readonly ElevationDecision NotAsked = new(null, null, null);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The admin mode (beta.10, D34), before anything is claimed or written: an elevated Agent started for another account
|
||||
/// stops (exit 11); an Agent told the answer was no says so; a plain <c>--serve</c> with the option on and no elevation —
|
||||
/// the logon task's — asks Windows once and hands over to the elevated Agent, or carries on as a standard user's.
|
||||
/// </summary>
|
||||
private static async Task<ElevationDecision> DecideElevationAsync(AgentCommandLine cmd, AgentPaths paths)
|
||||
{
|
||||
if (cmd.ForUser is { } sid)
|
||||
{
|
||||
if (!AgentElevation.IsCurrentUser(sid))
|
||||
{
|
||||
// The prompt was answered with another account's credentials: its %LOCALAPPDATA% is not this user's ledger.
|
||||
AgentConsole.Problem($"this elevated Agent runs as another account than the one that asked ({sid}); it exits (exit {AgentElevation.ExitOtherAccount})");
|
||||
return new ElevationDecision(null, AgentElevation.ExitOtherAccount, null);
|
||||
}
|
||||
|
||||
return new ElevationDecision(Environment.IsPrivilegedProcess ? AgentElevation.Granted : null, null, "started for this user by a UAC prompt");
|
||||
}
|
||||
|
||||
if (cmd.ElevationRefusal is { } refusal)
|
||||
{
|
||||
return new ElevationDecision(refusal, null, "the process that started this Agent asked Windows and got: " + refusal);
|
||||
}
|
||||
|
||||
if (Environment.IsPrivilegedProcess || !RunElevatedSetting.Read(paths.Database) || AgentInstanceLock.IsHeld(paths.DataDirectory))
|
||||
{
|
||||
// Elevated already (inherited), the option off, or an Agent already serves: nothing to ask; the claim decides the rest.
|
||||
return ElevationDecision.NotAsked;
|
||||
}
|
||||
|
||||
using ElevationMarker? marker = ElevationMarker.TryAcquire(paths.DataDirectory);
|
||||
if (marker is null)
|
||||
{
|
||||
AgentConsole.Problem($"another FrameLedger Agent is being started as administrator for {paths.DataDirectory}; this one exits (exit {AgentInstanceLock.ExitHeldElsewhere})");
|
||||
return new ElevationDecision(null, AgentInstanceLock.ExitHeldElsewhere, null);
|
||||
}
|
||||
|
||||
string arguments = "--serve --for-user " + AgentElevation.CurrentUserSid();
|
||||
using Process? elevated = AgentElevation.Start(Environment.ProcessPath ?? Path.Combine(AppContext.BaseDirectory, "FrameLedger.Agent.exe"),
|
||||
arguments, ownerWindow: 0, out string? refused, out int? error);
|
||||
if (elevated is null)
|
||||
{
|
||||
return new ElevationDecision(refused, null, $"the UAC prompt was {(string.Equals(refused, AgentElevation.Declined, StringComparison.Ordinal) ? "declined" : "not shown")} (error {error?.ToString(System.Globalization.CultureInfo.InvariantCulture) ?? "none"})");
|
||||
}
|
||||
|
||||
(bool claimed, int? code) = await AgentElevation.WaitForClaimAsync(elevated, paths.DataDirectory, TimeSpan.FromMinutes(2)).ConfigureAwait(false);
|
||||
if (claimed)
|
||||
{
|
||||
// Handed over: the elevated Agent logs its own start; this one writes nothing and leaves.
|
||||
return new ElevationDecision(null, _exitOk, null);
|
||||
}
|
||||
|
||||
return code == AgentElevation.ExitOtherAccount
|
||||
? new ElevationDecision(AgentElevation.OtherAccount, null, "the UAC prompt was answered with another account, whose Agent refused to run")
|
||||
: new ElevationDecision(AgentElevation.Failed, null, $"the elevated Agent did not start serving (exit {code?.ToString(System.Globalization.CultureInfo.InvariantCulture) ?? "none"})");
|
||||
}
|
||||
|
||||
/// <summary>The decision in the log, and what an elevated Agent's token has enabled (read, never changed: TokenPrivileges).</summary>
|
||||
private static void LogElevation(ElevationDecision elevation)
|
||||
{
|
||||
if (elevation.Outcome is { } outcome)
|
||||
{
|
||||
Log.Information("elevation: {Outcome} — {Detail}", outcome, elevation.Detail);
|
||||
}
|
||||
|
||||
if (Environment.IsPrivilegedProcess)
|
||||
{
|
||||
Log.Information("elevation: this Agent runs as administrator; enabled privileges: {Privileges}", string.Join(", ", TokenPrivileges.Enabled()));
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Null when a print verb refuses the ledger — at another schema, or not there — said on the console and in the log
|
||||
/// rather than as a crash: nothing about this machine is broken.
|
||||
/// </summary>
|
||||
private static async Task<LedgerDatabase?> OpenLedgerOrSayWhyAsync(AgentVerb verb, AgentPaths paths)
|
||||
{
|
||||
if (verb == AgentVerb.DbPath)
|
||||
{
|
||||
// Prints a path; opens nothing. A machine with no ledger yet still has an answer, and the verb never reaches
|
||||
// ConsoleVerbs because the answer is complete here.
|
||||
AgentConsole.Line(paths.Database);
|
||||
return null;
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
LedgerDatabase db = PrintsOnly(verb)
|
||||
? await LedgerDatabase.OpenReadOnlyAsync(paths.Database).ConfigureAwait(false)
|
||||
: await LedgerDatabase.OpenAsync(paths.Database, diagnostics: static line => Log.Information("{Line}", line)).ConfigureAwait(false);
|
||||
Log.Information("ledger: {Path} (schema {Schema}, migration {Migration}{ReadOnly})", db.Path, db.SchemaVersion, db.Migration,
|
||||
db.IsReadOnly ? ", read-only" : string.Empty);
|
||||
return db;
|
||||
}
|
||||
catch (Exception ex) when (ex is LedgerSchemaException or FileNotFoundException)
|
||||
{
|
||||
AgentConsole.Problem(ex.Message);
|
||||
Log.Warning("ledger: {Message}", ex.Message);
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
private static void ConfigureLogging(AgentPaths paths)
|
||||
{
|
||||
Directory.CreateDirectory(paths.Logs);
|
||||
Log.Logger = new LoggerConfiguration()
|
||||
.MinimumLevel.Information()
|
||||
// The host's own lines reach this file since 2026-09-23 (ServeAsync's AddSerilog): its warnings and errors —
|
||||
// a background service that stopped the host — not its start/stop chatter.
|
||||
.MinimumLevel.Override("Microsoft", Serilog.Events.LogEventLevel.Warning)
|
||||
.WriteTo.File(Path.Combine(paths.Logs, "agent-.log"), formatProvider: System.Globalization.CultureInfo.InvariantCulture,
|
||||
rollingInterval: RollingInterval.Day, retainedFileCountLimit: 14)
|
||||
.CreateLogger();
|
||||
@@ -128,20 +326,26 @@ internal static class Program
|
||||
}
|
||||
|
||||
Log.Fatal(exception, "agent: unhandled exception ({Source}); the Agent exits", source);
|
||||
string? dump = CrashDumpWriter.TryWrite(paths.CrashDumps, "agent", DateTimeOffset.UtcNow, static line => Log.Warning("{Line}", line));
|
||||
string? dump = CrashDumpWriter.TryWrite(paths.CrashDumps, "agent", DateTimeOffset.UtcNow, Environment.ProcessPath, static line => Log.Warning("{Line}", line));
|
||||
Log.Information("agent: crash dump {Dump}", dump ?? "not written");
|
||||
}
|
||||
|
||||
/// <summary>The product's mode: a Generic Host around the watcher, stopped by Ctrl+C or the service manager.</summary>
|
||||
private static async Task<int> ServeAsync(LedgerDatabase db, AgentPaths paths)
|
||||
private static async Task<int> ServeAsync(LedgerDatabase db, AgentPaths paths, string? elevationOutcome)
|
||||
{
|
||||
HostApplicationBuilder builder = Host.CreateApplicationBuilder();
|
||||
// The admin mode's answer at this start (beta.10), for HelloAck.
|
||||
builder.Services.AddSingleton(new AgentElevationState(elevationOutcome));
|
||||
// The host's log into agent-*.log (2026-09-23). A background service that threw stopped the host with nothing in
|
||||
// the file: the Generic Host logs that through Microsoft.Extensions.Logging, which was never routed here.
|
||||
builder.Services.AddSerilog();
|
||||
// Before the composition, so its TryAdd keeps this one: Shutdown over the pipe stops the host (PR-1b).
|
||||
builder.Services.AddSingleton<IAgentLifetime, HostAgentLifetime>();
|
||||
builder.Services.AddFrameLedgerAgent(db, paths);
|
||||
builder.Services.AddHostedService<WatcherHostedService>();
|
||||
// The static detection sweep (P4 PR-1, 05_DETECTION §Caching): its own task, because the probe blocks on file I/O.
|
||||
builder.Services.AddHostedService<DetectionHostedService>();
|
||||
builder.Services.AddHostedService<AntiCheatPreScanHostedService>();
|
||||
// The pipe (07_IPC §C), the product's UI channel: --serve only, never under --console (P3 PR-1).
|
||||
builder.Services.AddHostedService<PipeServerHostedService>();
|
||||
// Finalize's grace on shutdown (04_CAPTURE §Threading model): a session that does not make it leaves
|
||||
|
||||
@@ -38,7 +38,7 @@ public partial class App : System.Windows.Application
|
||||
{
|
||||
/// <summary><c>10_LOGGING</c> §Crash handling (P4 PR-9): Fatal, the minidump, the crash dialog offering the bug report.</summary>
|
||||
private readonly CrashReporter _crashes = new(
|
||||
static () => CrashDumpWriter.TryWrite(UiPaths.CrashDumps, "ui", DateTimeOffset.UtcNow, static line => Log.Warning("{Line}", line)),
|
||||
static () => CrashDumpWriter.TryWrite(UiPaths.CrashDumps, "ui", DateTimeOffset.UtcNow, CrashDumper, static line => Log.Warning("{Line}", line)),
|
||||
CrashDialog.AskToReport,
|
||||
static () =>
|
||||
{
|
||||
@@ -47,7 +47,13 @@ public partial class App : System.Windows.Application
|
||||
return Services.GetRequiredService<BugReportFlow>().RunAsync();
|
||||
});
|
||||
|
||||
/// <summary>The crash-dump helper: the Agent binary beside the App dumps this process from outside (<c>10_LOGGING</c> §Crash handling).</summary>
|
||||
private static string CrashDumper => Path.Combine(AppContext.BaseDirectory, "FrameLedger.Agent.exe");
|
||||
|
||||
private IHost? _host;
|
||||
|
||||
/// <summary>This process's claim on the data folder (<see cref="SingleInstance"/>); null under <c>--diag</c> and in tests.</summary>
|
||||
internal SingleInstance? Instance { get; init; }
|
||||
private LedgerDatabase? _db;
|
||||
private Task? _run;
|
||||
|
||||
@@ -85,19 +91,33 @@ public partial class App : System.Windows.Application
|
||||
int exitCode = 0;
|
||||
try
|
||||
{
|
||||
_db = await LedgerDatabase.OpenAsync(UiPaths.Database).ConfigureAwait(true);
|
||||
_db = await LedgerDatabase.OpenAsync(UiPaths.Database, diagnostics: static line => Log.Information("{Line}", line)).ConfigureAwait(true);
|
||||
var store = new SqliteSettingsStore(_db);
|
||||
var appearance = new AppearanceSettings(store);
|
||||
await appearance.LoadAsync().ConfigureAwait(true);
|
||||
ApplyCulture(appearance.Language);
|
||||
var registered = new RegisteredSettings(store);
|
||||
LoggingLevel.SetDebug(await registered.GetBooleanAsync(SettingsRegistry.LogDebug).ConfigureAwait(true));
|
||||
FpsDecimals.Two = await registered.GetBooleanAsync(SettingsRegistry.UiFpsDecimals).ConfigureAwait(true);
|
||||
var closePolicy = new WindowClosePolicy { MinimizeToTray = await registered.GetBooleanAsync(SettingsRegistry.UiMinimizeToTray).ConfigureAwait(true) };
|
||||
|
||||
_host = BuildHost(_db, appearance, registered, closePolicy);
|
||||
await _host.StartAsync().ConfigureAwait(true);
|
||||
Log.Information("ui: started ({Version}), ledger {Ledger}", UiIdentity.Version, UiPaths.Database);
|
||||
await _host.WaitForShutdownAsync().ConfigureAwait(true);
|
||||
|
||||
// A second start of the App hands over to this one: bring the window forward, from the tray too.
|
||||
if (Instance is not null)
|
||||
{
|
||||
// Captured HERE, on the dispatcher: the event arrives on a thread-pool thread and is posted back.
|
||||
IHost host = _host;
|
||||
var ui = new UiThread();
|
||||
Instance.RevealRequested += (_, _) => ui.Post(() =>
|
||||
{
|
||||
Log.Information("ui: another start handed over to this instance; revealing the window");
|
||||
host.Services.GetRequiredService<ShellHost>().Reveal();
|
||||
});
|
||||
}
|
||||
await WaitForStopRequestAsync(_host).ConfigureAwait(true);
|
||||
}
|
||||
catch (Exception ex) when (ex is not OutOfMemoryException)
|
||||
{
|
||||
@@ -135,7 +155,8 @@ public partial class App : System.Windows.Application
|
||||
var values = new Dictionary<string, string>(StringComparer.Ordinal);
|
||||
try
|
||||
{
|
||||
LedgerDatabase db = await LedgerDatabase.OpenAsync(UiPaths.Database).ConfigureAwait(true);
|
||||
// Read-only: a diagnostic run against a ledger at another schema must report it, not migrate it (2026-09-16).
|
||||
LedgerDatabase db = await LedgerDatabase.OpenReadOnlyAsync(UiPaths.Database).ConfigureAwait(true);
|
||||
await using (db.ConfigureAwait(true))
|
||||
{
|
||||
schema = db.SchemaVersion;
|
||||
@@ -151,7 +172,17 @@ public partial class App : System.Windows.Application
|
||||
Log.Warning(ex, "diag: the ledger could not be opened; settings are reported at their defaults");
|
||||
}
|
||||
|
||||
string report = DiagReport.Build(UiIdentity.Version, UiPaths.DataDirectory, UiPaths.Logs, schema, values, new AgentLauncher().CanLaunch, now);
|
||||
Application.Persistence.HardwareSnapshot? hardware = null;
|
||||
try
|
||||
{
|
||||
hardware = new Infrastructure.Recording.HardwareSnapshotSource(new Infrastructure.Telemetry.DxgiAdapters()).Take();
|
||||
}
|
||||
catch (Exception ex) when (ex is not OutOfMemoryException)
|
||||
{
|
||||
Log.Warning(ex, "diag: the hardware could not be read; its lines are n/a");
|
||||
}
|
||||
|
||||
string report = DiagReport.Build(UiIdentity.Version, UiPaths.DataDirectory, UiPaths.Logs, schema, values, new AgentLauncher().CanLaunch, now, hardware);
|
||||
string path = DiagReport.Write(UiPaths.Logs, report, now);
|
||||
await Console.Out.WriteLineAsync(string.Format(CultureInfo.CurrentCulture, Strings.Diag_Written_Format, path)).ConfigureAwait(true);
|
||||
Log.Information("ui: --diag written to {Path}", path);
|
||||
@@ -165,6 +196,22 @@ public partial class App : System.Windows.Application
|
||||
Shutdown(exitCode);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Waits for a stop request ON the dispatcher, and stops nothing: <see cref="TearDownAsync"/> stops the host once,
|
||||
/// from the UI thread. <c>WaitForShutdownAsync</c> resumed on the thread pool (it awaits with
|
||||
/// <c>ConfigureAwait(false)</c>) and stopped the hosted services there, which is how the tray was disposed off its
|
||||
/// thread on 0.1.0-beta.1 — and TearDownAsync then stopped every service a second time.
|
||||
/// </summary>
|
||||
private static async Task WaitForStopRequestAsync(IHost host)
|
||||
{
|
||||
IHostApplicationLifetime lifetime = host.Services.GetRequiredService<IHostApplicationLifetime>();
|
||||
using var stopping = new SemaphoreSlim(0, 1);
|
||||
using (lifetime.ApplicationStopping.Register(static state => ((SemaphoreSlim)state!).Release(), stopping))
|
||||
{
|
||||
await stopping.WaitAsync().ConfigureAwait(true);
|
||||
}
|
||||
}
|
||||
|
||||
private async Task TearDownAsync()
|
||||
{
|
||||
try
|
||||
@@ -195,6 +242,12 @@ public partial class App : System.Windows.Application
|
||||
CultureInfo.DefaultThreadCurrentUICulture = culture;
|
||||
CultureInfo.CurrentUICulture = culture;
|
||||
Strings.Culture = culture;
|
||||
|
||||
// THE SAFETY FAMILY TOO (2026-09-21). FrameLedger.Shared's Strings had no culture of its own and fell back to the
|
||||
// thread's - and CurrentUICulture set inside this async start does not reach the dispatcher's later operations,
|
||||
// so on an English Windows a Vietnamese UI showed the consent dialog and the refusal notices in English (the
|
||||
// owner's screenshot, beta.3). An explicit culture does not depend on which thread asks.
|
||||
Shared.Strings.Culture = culture;
|
||||
}
|
||||
|
||||
private static IHost BuildHost(LedgerDatabase db, AppearanceSettings appearance, RegisteredSettings registered, WindowClosePolicy closePolicy)
|
||||
@@ -216,20 +269,19 @@ public partial class App : System.Windows.Application
|
||||
builder.Services.AddSingleton(closePolicy);
|
||||
builder.Services.AddSingleton<IThemeApplier, WpfThemeApplier>();
|
||||
|
||||
// The Agent over the pipe (07_IPC §Client behavior): connect, start it when it is not there, tell the shell.
|
||||
builder.Services.AddSingleton<IAgentLauncher, AgentLauncher>();
|
||||
builder.Services.AddSingleton(static sp => new AgentConnection(
|
||||
sp.GetRequiredService<IAgentLauncher>(),
|
||||
static () => new PipeClient(),
|
||||
new AgentConnectionOptions(),
|
||||
UiIdentity.Version));
|
||||
builder.Services.AddHostedService<AgentConnectionHostedService>();
|
||||
builder.Services.AddSingleton<IAgentRequests>(static sp => sp.GetRequiredService<AgentConnection>());
|
||||
builder.Services.AddSingleton<IAgentLink>(static sp => sp.GetRequiredService<AgentConnection>());
|
||||
AddAgentLink(builder.Services);
|
||||
|
||||
// FR-2.1 (P3 PR-4): the consent dialog and the request it ends in; the toggle that opens it is the game page's (PR-5).
|
||||
builder.Services.AddSingleton<IConsentPrompt, ConsentPrompt>();
|
||||
builder.Services.AddSingleton<HookingConsent>();
|
||||
// D33 (owner decision 2026-09-26): the user-mode exception's disclosure and the request it ends in; the list is
|
||||
// Settings', the button on a blocked game's page.
|
||||
builder.Services.AddSingleton<IAntiCheatExceptionPrompt, AntiCheatExceptionPrompt>();
|
||||
// The admin mode's disclosure (beta.10, D34), shown before capture.run_elevated is turned on.
|
||||
builder.Services.AddSingleton<IAgentAdminPrompt, AgentAdminPrompt>();
|
||||
builder.Services.AddSingleton<AntiCheatExceptions>();
|
||||
// beta.11 (D40): Delete all sessions, of one game (its page) or of every game (Settings ▸ Data), through the Agent.
|
||||
builder.Services.AddSingleton<SessionDeletion>();
|
||||
|
||||
AddLibrary(builder.Services);
|
||||
|
||||
@@ -257,6 +309,24 @@ public partial class App : System.Windows.Application
|
||||
return builder.Build();
|
||||
}
|
||||
|
||||
/// <summary>The Agent over the pipe (07_IPC §Client behavior): connect, start it when it is not there, tell the shell.</summary>
|
||||
private static void AddAgentLink(IServiceCollection services)
|
||||
{
|
||||
// The admin mode's prompt (beta.10) belongs to the main window; the handle is read when a start asks, never earlier.
|
||||
services.AddSingleton<IAgentLauncher>(static sp => AgentLauncher.ForApp(() => sp.GetRequiredService<ShellHost>().Handle));
|
||||
services.AddSingleton(static sp => new AgentConnection(
|
||||
sp.GetRequiredService<IAgentLauncher>(),
|
||||
static () => new PipeClient(),
|
||||
new AgentConnectionOptions(),
|
||||
UiIdentity.Version));
|
||||
services.AddHostedService<AgentConnectionHostedService>();
|
||||
services.AddSingleton<IAgentRequests>(static sp => sp.GetRequiredService<AgentConnection>());
|
||||
services.AddSingleton<IAgentLink>(static sp => sp.GetRequiredService<AgentConnection>());
|
||||
// What the Agent runs right now (2026-09-23), for the pages rebuilt on every visit; built before the connection's
|
||||
// first round by AgentConnectionHostedService, so it never misses a session.
|
||||
services.AddSingleton(static sp => new LiveSessions(sp.GetRequiredService<IAgentLink>()));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The library (P3 PR-5): the ports the pages read and write, the selection that travels between pages, and the
|
||||
/// pickers, prompts and confirmations behind interfaces so the view models are testable without a window.
|
||||
@@ -277,9 +347,14 @@ public partial class App : System.Windows.Application
|
||||
|
||||
// The session summary (P3 PR-6): the series loader over the ports, the exports' file picker, the window opener.
|
||||
services.AddSingleton<IHardwareSnapshotRepository, SqliteHardwareSnapshotRepository>();
|
||||
// Settings > System (2026-09-21): the same source the Agent stamps every session with, read for this PC now.
|
||||
services.AddSingleton<Application.Recording.IHardwareSnapshotSource>(static _ => new Infrastructure.Recording.HardwareSnapshotSource(new Infrastructure.Telemetry.DxgiAdapters()));
|
||||
services.AddTransient<SystemInfoViewModel>();
|
||||
services.AddSingleton<Charts.SessionSeriesLoader>();
|
||||
services.AddSingleton<IFileSaver, FileSaver>();
|
||||
services.AddSingleton<ISessionSummaryOpener, SessionSummaryOpener>();
|
||||
services.AddSingleton<SessionSummaryOpener>();
|
||||
services.AddSingleton<ISessionSummaryOpener>(static sp => sp.GetRequiredService<SessionSummaryOpener>());
|
||||
services.AddSingleton<ISessionWindows>(static sp => sp.GetRequiredService<SessionSummaryOpener>()); // beta.11: Delete all sessions closes them
|
||||
services.AddSingleton<IMixedTierPrompt, MixedTierPrompt>();
|
||||
|
||||
// Settings, the safety notices and the Logs page (P3 PR-8a): the Run entry, the notices over the pipe's
|
||||
@@ -336,7 +411,7 @@ public partial class App : System.Windows.Application
|
||||
services.AddSingleton<IStoreLibrarySource>(static _ => new SteamLibrarySource());
|
||||
services.AddSingleton<IStoreLibrarySource>(static _ => new GogLibrarySource());
|
||||
services.AddSingleton<IStoreLibrarySource>(static _ => new EpicLibrarySource());
|
||||
services.AddSingleton<IStoreLibrarySource>(static _ => new ItchLibrarySource());
|
||||
services.AddSingleton<IStoreLibrarySource>(static _ => new ItchLibrarySource(log: static line => Serilog.Log.Information("{Line}", line)));
|
||||
services.AddSingleton<IExecutableLocator, ExecutableLocator>();
|
||||
services.AddSingleton<IExecutableIdentitySource, ExecutableIdentitySource>();
|
||||
services.AddSingleton(static sp => new LibraryImporter(
|
||||
@@ -346,6 +421,8 @@ public partial class App : System.Windows.Application
|
||||
sp.GetRequiredService<IExecutableLocator>(),
|
||||
static line => Serilog.Log.Information("{Line}", line)));
|
||||
services.AddSingleton<IImportReview, ImportReviewPrompt>();
|
||||
// beta.11: the Games page on screen reloads when an import adds games (navigating to itself does nothing).
|
||||
services.AddSingleton<LibraryChanges>();
|
||||
services.AddSingleton<ImportLibraryFlow>();
|
||||
}
|
||||
|
||||
@@ -377,7 +454,7 @@ public partial class App : System.Windows.Application
|
||||
AppDomain.CurrentDomain.UnhandledException += static (_, args) =>
|
||||
{
|
||||
Log.Fatal(args.ExceptionObject as Exception, "ui: unhandled exception (AppDomain, terminating {Terminating})", args.IsTerminating);
|
||||
string? dump = CrashDumpWriter.TryWrite(UiPaths.CrashDumps, "ui", DateTimeOffset.UtcNow, static line => Log.Warning("{Line}", line));
|
||||
string? dump = CrashDumpWriter.TryWrite(UiPaths.CrashDumps, "ui", DateTimeOffset.UtcNow, CrashDumper, static line => Log.Warning("{Line}", line));
|
||||
Log.Information("ui: crash dump {Dump}", dump ?? "not written");
|
||||
Log.CloseAndFlush();
|
||||
};
|
||||
|
||||
@@ -57,6 +57,25 @@ public sealed record ChartPalette(
|
||||
return new ChartPalette(c[0], c[1], c[2], c[3], c[4], c[5], c[6], c[7], c[8], c[9], c[10], c[11], c[12]);
|
||||
}
|
||||
|
||||
/// <summary>The colour a key names — how a chart that assigns palette entries to series by name reads them (<c>SensorsChart</c>).</summary>
|
||||
public Color ByKey(string key) => key switch
|
||||
{
|
||||
"Chart_Figure" => Figure,
|
||||
"Chart_Data" => Data,
|
||||
"Chart_Axis" => Axis,
|
||||
"Chart_Grid" => Grid,
|
||||
"Chart_Native" => Native,
|
||||
"Chart_Displayed" => Displayed,
|
||||
"Chart_Stutter" => Stutter,
|
||||
"Chart_StutterPso" => StutterPso,
|
||||
"Chart_Sensor" => Sensor,
|
||||
"Chart_SensorSecondary" => SensorSecondary,
|
||||
"Chart_Segment" => Segment,
|
||||
"Chart_Histogram" => Histogram,
|
||||
"Chart_Percentile" => Percentile,
|
||||
_ => throw new ArgumentOutOfRangeException(nameof(key), key, "not a chart palette key"),
|
||||
};
|
||||
|
||||
private static ChartPalette Load(ApplicationTheme theme)
|
||||
{
|
||||
string file = theme == ApplicationTheme.Light ? "ChartPalette.Light.xaml" : "ChartPalette.Dark.xaml";
|
||||
|
||||
@@ -32,6 +32,41 @@ public static class ChartTheme
|
||||
plot.Legend.FontColor = p.Axis;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Save the plot as a PNG with an OPAQUE background (beta.8): on screen the figure is transparent over its card, but an
|
||||
/// exported image has no card behind it, and a viewer painted its own colour under the theme's text — white axis labels
|
||||
/// on a white page. The window's colour is painted for the file and the plot restored.
|
||||
/// </summary>
|
||||
public static void SavePng(Plot plot, string path, int width, int height)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(plot);
|
||||
ArgumentException.ThrowIfNullOrWhiteSpace(path);
|
||||
Color figure = plot.FigureBackground.Color;
|
||||
Color data = plot.DataBackground.Color;
|
||||
Color window = ApplicationThemeManager.GetAppTheme() == ApplicationTheme.Light ? Color.FromHex("#F3F3F3") : Color.FromHex("#202020");
|
||||
try
|
||||
{
|
||||
plot.FigureBackground.Color = Over(figure, window);
|
||||
plot.DataBackground.Color = Over(data, Over(figure, window));
|
||||
plot.SavePng(path, width, height);
|
||||
}
|
||||
finally
|
||||
{
|
||||
plot.FigureBackground.Color = figure;
|
||||
plot.DataBackground.Color = data;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Source-over: <paramref name="top"/> composited on an opaque <paramref name="under"/>.</summary>
|
||||
internal static Color Over(Color top, Color under)
|
||||
{
|
||||
double a = top.A / 255.0;
|
||||
return new Color(
|
||||
(byte)Math.Round((top.R * a) + (under.R * (1 - a))),
|
||||
(byte)Math.Round((top.G * a) + (under.G * (1 - a))),
|
||||
(byte)Math.Round((top.B * a) + (under.B * (1 - a))));
|
||||
}
|
||||
|
||||
/// <summary>Registers a control so a theme change re-applies and refreshes it (weakly held; a closed window is forgotten).</summary>
|
||||
public static void Attach(WpfPlot control)
|
||||
{
|
||||
|
||||
@@ -44,8 +44,10 @@ public partial class CompareChart : UserControl
|
||||
|
||||
if (DrawnCurves > 0)
|
||||
{
|
||||
plot.Axes.SetLimitsX(0, 100);
|
||||
// The percentile axis is 0–100 whatever the data: AutoScale first, then the X limits (beta.8 — the other way
|
||||
// round, AutoScale undid them).
|
||||
plot.Axes.AutoScale();
|
||||
plot.Axes.SetLimitsX(0, 100);
|
||||
plot.ShowLegend(Alignment.UpperRight);
|
||||
}
|
||||
|
||||
|
||||
@@ -1,10 +1,15 @@
|
||||
<UserControl x:Class="FrameLedger.App.Charts.DistributionChart"
|
||||
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
|
||||
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
|
||||
xmlns:ui="http://schemas.lepo.co/wpfui/2022/xaml"
|
||||
xmlns:sp="clr-namespace:ScottPlot.WPF;assembly=ScottPlot.WPF"
|
||||
MinHeight="240">
|
||||
<!-- FR-5.1: the FPS histogram and the percentile curve, side by side. -->
|
||||
<!-- FR-5.1: the FPS histogram and the percentile curve, side by side; the note says what the histogram's range left out (beta.8). -->
|
||||
<Grid>
|
||||
<Grid.RowDefinitions>
|
||||
<RowDefinition Height="*" />
|
||||
<RowDefinition Height="Auto" />
|
||||
</Grid.RowDefinitions>
|
||||
<Grid.ColumnDefinitions>
|
||||
<ColumnDefinition Width="*" />
|
||||
<ColumnDefinition Width="12" />
|
||||
@@ -12,5 +17,6 @@
|
||||
</Grid.ColumnDefinitions>
|
||||
<sp:WpfPlot x:Name="Histogram" Grid.Column="0" />
|
||||
<sp:WpfPlot x:Name="Percentiles" Grid.Column="2" />
|
||||
<ui:TextBlock x:Name="Note" Grid.Row="1" Grid.ColumnSpan="3" Margin="0,4,0,0" Appearance="Tertiary" TextWrapping="Wrap" Visibility="Collapsed" />
|
||||
</Grid>
|
||||
</UserControl>
|
||||
@@ -1,3 +1,5 @@
|
||||
using System.Globalization;
|
||||
using System.Windows;
|
||||
using System.Windows.Controls;
|
||||
using ScottPlot;
|
||||
using ScottPlot.Plottables;
|
||||
@@ -7,8 +9,10 @@ namespace FrameLedger.App.Charts;
|
||||
/// <summary>
|
||||
/// FR-5.1's distribution: a histogram of instantaneous FPS over application frames, and the percentile curve —
|
||||
/// FPS at each percentile of frametime under <c>03_METRICS</c>' linear method (<c>Domain.Metrics.Percentile</c>),
|
||||
/// so the 1% and 0.1% lows on the stat cards are two points on this curve.
|
||||
/// so the 1% and 0.1% lows on the stat cards are two points on this curve, marked where the session has the frames for
|
||||
/// them (<see cref="PercentileCurve"/>).
|
||||
/// </summary>
|
||||
[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1863:Use 'CompositeFormat'", Justification = "the format strings are resources that follow the UI culture, which changes at runtime")]
|
||||
public partial class DistributionChart : UserControl
|
||||
{
|
||||
private const int _bins = 60;
|
||||
@@ -22,38 +26,46 @@ public partial class DistributionChart : UserControl
|
||||
|
||||
public ScottPlot.Plot HistogramPlot => Histogram.Plot;
|
||||
|
||||
/// <summary>The percentile plot, for a test's look at its axis.</summary>
|
||||
public ScottPlot.Plot PercentilePlot => Percentiles.Plot;
|
||||
|
||||
public void Show(SessionSeries? series)
|
||||
{
|
||||
DrawHistogram(series);
|
||||
int outside = DrawHistogram(series);
|
||||
DrawPercentiles(series);
|
||||
Note.Text = outside > 0 ? string.Format(CultureInfo.CurrentCulture, Strings.Chart_Note_OutsideRange_Format, outside) : string.Empty;
|
||||
Note.Visibility = outside > 0 ? Visibility.Visible : Visibility.Collapsed;
|
||||
}
|
||||
|
||||
private void DrawHistogram(SessionSeries? series)
|
||||
/// <summary>Draws the histogram; the frames its range left out.</summary>
|
||||
private int DrawHistogram(SessionSeries? series)
|
||||
{
|
||||
ScottPlot.Plot plot = Histogram.Plot;
|
||||
plot.Clear();
|
||||
ChartTheme.Apply(plot);
|
||||
plot.XLabel(Strings.Chart_Axis_Fps);
|
||||
plot.YLabel(Strings.Chart_Axis_Count);
|
||||
int outside = 0;
|
||||
if (series is { AppFrameTimesMs.Length: > 1 })
|
||||
{
|
||||
double[] fps = [.. series.AppFrameTimesMs.Where(static f => f > 0).Select(static f => 1000.0 / f)];
|
||||
if (fps.Length > 1)
|
||||
FpsHistogram histogram = FpsHistogram.Of(series.AppFrameTimesMs, _bins);
|
||||
if (histogram.Centers.Length > 0)
|
||||
{
|
||||
var histogram = ScottPlot.Statistics.Histogram.WithBinCount(_bins, fps);
|
||||
BarPlot bars = plot.Add.Bars(histogram.Bins, histogram.Counts.Select(static c => (double)c));
|
||||
BarPlot bars = plot.Add.Bars(histogram.Centers, histogram.Counts);
|
||||
bars.Color = ChartTheme.Current.Histogram;
|
||||
foreach (Bar bar in bars.Bars)
|
||||
{
|
||||
bar.Size = histogram.FirstBinSize;
|
||||
bar.Size = histogram.BinWidth;
|
||||
bar.LineWidth = 0;
|
||||
}
|
||||
|
||||
outside = histogram.Outside;
|
||||
plot.Axes.AutoScale();
|
||||
}
|
||||
}
|
||||
|
||||
Histogram.Refresh();
|
||||
return outside;
|
||||
}
|
||||
|
||||
private void DrawPercentiles(SessionSeries? series)
|
||||
@@ -66,11 +78,24 @@ public partial class DistributionChart : UserControl
|
||||
if (series is { AppFrameTimesMs.Length: > 1 })
|
||||
{
|
||||
(double[] xs, double[] ys) = PercentileCurve.Of(series.AppFrameTimesMs);
|
||||
Scatter line = plot.Add.ScatterLine(xs, ys, ChartTheme.Current.Percentile);
|
||||
line.LineWidth = 2;
|
||||
line.LegendText = Strings.Chart_Series_Percentile;
|
||||
plot.Axes.SetLimitsX(0, 100);
|
||||
if (xs.Length > 0)
|
||||
{
|
||||
Scatter line = plot.Add.ScatterLine(xs, ys, ChartTheme.Current.Percentile);
|
||||
line.LineWidth = 2;
|
||||
line.LegendText = Strings.Chart_Series_Percentile;
|
||||
}
|
||||
|
||||
foreach ((double x, double fps, bool pointOne) in PercentileCurve.Lows(series.AppFrameTimesMs))
|
||||
{
|
||||
Scatter low = plot.Add.ScatterPoints(new[] { x }, new[] { fps }, ChartTheme.Current.Stutter);
|
||||
low.MarkerSize = 7;
|
||||
low.LegendText = pointOne ? Strings.Summary_Stat_P01Low : Strings.Summary_Stat_P1Low;
|
||||
}
|
||||
|
||||
// The axis is 0–100 whatever the curve covers: AutoScale first, then the X limits (AutoScale afterwards undid them).
|
||||
plot.Axes.AutoScale();
|
||||
plot.Axes.SetLimitsX(0, 100);
|
||||
plot.ShowLegend(Alignment.LowerLeft);
|
||||
}
|
||||
|
||||
Percentiles.Refresh();
|
||||
|
||||
@@ -0,0 +1,54 @@
|
||||
using FrameLedger.Domain.Metrics;
|
||||
|
||||
namespace FrameLedger.App.Charts;
|
||||
|
||||
/// <summary>
|
||||
/// The distribution tab's histogram of instantaneous FPS over application frames (FR-5.1), binned over the 0.5th to the
|
||||
/// 99.5th percentile and drawn at each bin's CENTRE (beta.8). Binned over min to max, one frame of a fraction of a
|
||||
/// millisecond — a present that followed another by nothing — stretched the axis to thousands of FPS and squeezed every
|
||||
/// real frame into two bars; and a bar is drawn centred on its position, where ScottPlot's bins are lower edges, so every
|
||||
/// bar sat half a bin to the left of what it counted.
|
||||
/// </summary>
|
||||
[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1819:Properties should not return arrays", Justification = "a data carrier for ScottPlot, which draws double[]")]
|
||||
public sealed record FpsHistogram(double[] Centers, double[] Counts, double BinWidth, int Outside)
|
||||
{
|
||||
/// <summary>The share cut from each end before binning.</summary>
|
||||
public const double TailFraction = 0.005;
|
||||
|
||||
public static FpsHistogram Of(IReadOnlyList<double> appFrameTimesMs, int bins = 60)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(appFrameTimesMs);
|
||||
ArgumentOutOfRangeException.ThrowIfNegativeOrZero(bins);
|
||||
double[] fps = [.. appFrameTimesMs.Where(static f => f > 0).Select(static f => 1000.0 / f)];
|
||||
if (fps.Length == 0)
|
||||
{
|
||||
return new FpsHistogram([], [], 0, 0);
|
||||
}
|
||||
|
||||
IReadOnlyList<double> sorted = Percentile.Sorted(fps);
|
||||
double lo = Percentile.Linear(sorted, TailFraction) ?? sorted[0];
|
||||
double hi = Percentile.Linear(sorted, 1 - TailFraction) ?? sorted[^1];
|
||||
if (hi - lo < 1e-9)
|
||||
{
|
||||
// Every frame at one rate: one bar, a frame per second wide, centred on it.
|
||||
return new FpsHistogram([lo], [fps.Length], 1, 0);
|
||||
}
|
||||
|
||||
double width = (hi - lo) / bins;
|
||||
var counts = new double[bins];
|
||||
int outside = 0;
|
||||
foreach (double v in fps)
|
||||
{
|
||||
if (v < lo || v > hi)
|
||||
{
|
||||
outside++;
|
||||
continue;
|
||||
}
|
||||
|
||||
counts[Math.Min(bins - 1, (int)((v - lo) / width))]++;
|
||||
}
|
||||
|
||||
double[] centers = [.. Enumerable.Range(0, bins).Select(b => lo + ((b + 0.5) * width))];
|
||||
return new FpsHistogram(centers, counts, width, outside);
|
||||
}
|
||||
}
|
||||
@@ -1,8 +1,17 @@
|
||||
<UserControl x:Class="FrameLedger.App.Charts.FrametimeChart"
|
||||
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
|
||||
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
|
||||
xmlns:ui="http://schemas.lepo.co/wpfui/2022/xaml"
|
||||
xmlns:sp="clr-namespace:ScottPlot.WPF;assembly=ScottPlot.WPF"
|
||||
MinHeight="260">
|
||||
<!-- 08_UI §Session summary / FR-5.1: the frametime timeline, min/max decimated (FR-5.3); zoom and pan are ScottPlot's. -->
|
||||
<sp:WpfPlot x:Name="Plot" />
|
||||
<!-- 08_UI §Session summary / FR-5.1: the frametime timeline, min/max decimated (FR-5.3); zoom and pan are ScottPlot's.
|
||||
The note above it says what the lines are not, when that is not obvious (beta.8). -->
|
||||
<Grid>
|
||||
<Grid.RowDefinitions>
|
||||
<RowDefinition Height="Auto" />
|
||||
<RowDefinition Height="*" />
|
||||
</Grid.RowDefinitions>
|
||||
<ui:TextBlock x:Name="Note" Grid.Row="0" Margin="0,0,0,4" Appearance="Tertiary" TextWrapping="Wrap" Visibility="Collapsed" />
|
||||
<sp:WpfPlot x:Name="Plot" Grid.Row="1" />
|
||||
</Grid>
|
||||
</UserControl>
|
||||
@@ -1,3 +1,5 @@
|
||||
using System.Globalization;
|
||||
using System.Windows;
|
||||
using System.Windows.Controls;
|
||||
using ScottPlot;
|
||||
using ScottPlot.Plottables;
|
||||
@@ -5,13 +7,17 @@ using ScottPlot.Plottables;
|
||||
namespace FrameLedger.App.Charts;
|
||||
|
||||
/// <summary>
|
||||
/// The frametime timeline (FR-5.1, FR-5.3, FR-5.4, FR-5.5): the application-frame series by default, the
|
||||
/// displayed (every present) series on request, stutter markers coloured by cause where the PSO count says so,
|
||||
/// the segment ribbon as translucent spans, and the sensor overlay on the right axis. Series are min/max
|
||||
/// decimated per draw; the raw arrays stay in the <see cref="SessionSeries"/>.
|
||||
/// The frametime timeline (FR-5.1, FR-5.3, FR-5.4, FR-5.5): the application-frame series by default, every present on
|
||||
/// request, stutter markers coloured by cause where the PSO count says so, the segment ribbon as translucent spans with
|
||||
/// their settings named, and the sensor overlay on the right axis. Series are min/max decimated per draw; the raw arrays
|
||||
/// stay in the <see cref="SessionSeries"/>.
|
||||
/// </summary>
|
||||
[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1863:Use 'CompositeFormat'", Justification = "the format strings are resources that follow the UI culture, which changes at runtime")]
|
||||
public partial class FrametimeChart : UserControl
|
||||
{
|
||||
/// <summary>A segment narrower than this share of the axis keeps its shading and loses its label (the labels would overlap).</summary>
|
||||
private const double _labelledSegmentShare = 0.12;
|
||||
|
||||
private SessionSeries? _series;
|
||||
private bool _displayed;
|
||||
private bool _sensors;
|
||||
@@ -28,6 +34,9 @@ public partial class FrametimeChart : UserControl
|
||||
/// <summary>How many points the last draw put on the axes (a test's window into the decimation).</summary>
|
||||
public int DrawnPoints { get; private set; }
|
||||
|
||||
/// <summary>The note the last draw showed above the plot; empty when it had nothing to say.</summary>
|
||||
public string NoteText => Note.Text;
|
||||
|
||||
public void Show(SessionSeries? series, bool displayed, bool sensors)
|
||||
{
|
||||
_series = series;
|
||||
@@ -48,6 +57,37 @@ public partial class FrametimeChart : UserControl
|
||||
Redraw();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// What the lines are not, when that is not obvious (beta.8): a session whose presents were all generated is charted as
|
||||
/// presents; every present is timed at submission, which is not the display's cadence; and the overlay's sensors run ahead
|
||||
/// of the frames past every gap the time axis closes up.
|
||||
/// </summary>
|
||||
internal static string NoteFor(SessionSeries? series, bool displayed, bool sensors)
|
||||
{
|
||||
if (series is null || series.Presents == 0)
|
||||
{
|
||||
return string.Empty;
|
||||
}
|
||||
|
||||
var lines = new List<string>(2);
|
||||
if (series.NoApplicationFrames)
|
||||
{
|
||||
lines.Add(Strings.Chart_Note_NoApplicationFrames);
|
||||
}
|
||||
else if (displayed && series.HasGenerated)
|
||||
{
|
||||
lines.Add(Strings.Chart_Note_PresentsTiming);
|
||||
}
|
||||
|
||||
int gaps = series.Gap.Skip(1).Count(static g => g);
|
||||
if (sensors && series.SensorsAligned && gaps > 0)
|
||||
{
|
||||
lines.Add(string.Format(CultureInfo.CurrentCulture, Strings.Chart_Note_GapsClosed_Format, gaps));
|
||||
}
|
||||
|
||||
return string.Join(Environment.NewLine, lines);
|
||||
}
|
||||
|
||||
private void Redraw()
|
||||
{
|
||||
ScottPlot.Plot plot = Plot.Plot;
|
||||
@@ -56,6 +96,8 @@ public partial class FrametimeChart : UserControl
|
||||
ChartTheme.Apply(plot);
|
||||
plot.XLabel(Strings.Chart_Axis_Time);
|
||||
plot.YLabel(Strings.Chart_Axis_Frametime);
|
||||
Note.Text = NoteFor(_series, _displayed, _sensors);
|
||||
Note.Visibility = Note.Text.Length > 0 ? Visibility.Visible : Visibility.Collapsed;
|
||||
if (_series is null || _series.Presents == 0)
|
||||
{
|
||||
Plot.Refresh();
|
||||
@@ -63,26 +105,33 @@ public partial class FrametimeChart : UserControl
|
||||
}
|
||||
|
||||
ChartPalette p = ChartTheme.Current;
|
||||
bool generating = _series.HasGenerated && !_series.NoApplicationFrames;
|
||||
DrawSegments(plot, p);
|
||||
if (_displayed && _series.HasGenerated)
|
||||
if (_displayed && generating)
|
||||
{
|
||||
DrawSeries(plot, _series.TimesS, [.. _series.FrameTimesMs.Select(static f => (double)f)], p.Displayed, Strings.Chart_Series_Displayed);
|
||||
DrawPresents(plot, p);
|
||||
}
|
||||
|
||||
DrawSeries(plot, _series.AppTimesS, _series.AppFrameTimesMs, p.Native, Strings.Chart_Series_Native);
|
||||
DrawSeries(plot, _series.AppTimesS, _series.AppFrameTimesMs, p.Native, generating ? Strings.Chart_Series_AppFrames : Strings.Chart_Series_Presents);
|
||||
DrawStutter(plot, p);
|
||||
if (_sensors)
|
||||
if (_sensors && _series.SensorsAligned)
|
||||
{
|
||||
DrawSensors(plot, p);
|
||||
}
|
||||
|
||||
plot.Axes.AutoScale();
|
||||
LabelSegments(plot, p);
|
||||
plot.ShowLegend(Alignment.UpperRight);
|
||||
Plot.Refresh();
|
||||
}
|
||||
|
||||
private void DrawSeries(ScottPlot.Plot plot, double[] xs, double[] ys, Color color, string label)
|
||||
private void DrawSeries(ScottPlot.Plot plot, IReadOnlyList<double> xs, IReadOnlyList<double> ys, Color color, string label)
|
||||
{
|
||||
if (xs.Count == 0)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
(double[] dx, double[] dy) = Decimator.MinMax(xs, ys);
|
||||
DrawnPoints += dx.Length;
|
||||
SignalXY line = plot.Add.SignalXY(dx, dy, color);
|
||||
@@ -90,6 +139,23 @@ public partial class FrametimeChart : UserControl
|
||||
line.LegendText = label;
|
||||
}
|
||||
|
||||
/// <summary>Every present but those after a gap, whose stored interval is 0 — not a frame, and it was drawn as a 0 ms one.</summary>
|
||||
private void DrawPresents(ScottPlot.Plot plot, ChartPalette p)
|
||||
{
|
||||
var xs = new List<double>(_series!.Presents);
|
||||
var ys = new List<double>(_series.Presents);
|
||||
for (int i = 0; i < _series.Presents; i++)
|
||||
{
|
||||
if (!_series.Gap[i])
|
||||
{
|
||||
xs.Add(_series.TimesS[i]);
|
||||
ys.Add(_series.FrameTimesMs[i]);
|
||||
}
|
||||
}
|
||||
|
||||
DrawSeries(plot, xs, ys, p.Displayed, Strings.Chart_Series_Displayed);
|
||||
}
|
||||
|
||||
private void DrawStutter(ScottPlot.Plot plot, ChartPalette p)
|
||||
{
|
||||
if (_series?.Stutter is null)
|
||||
@@ -152,6 +218,34 @@ public partial class FrametimeChart : UserControl
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Each segment's settings at its top-left corner (beta.8: the label was computed for every segment and drawn for none),
|
||||
/// where the segment is wide enough to hold it. Placed after the axes are scaled, at their top.
|
||||
/// </summary>
|
||||
private void LabelSegments(ScottPlot.Plot plot, ChartPalette p)
|
||||
{
|
||||
if (_series is null || _series.Segments.Count < 2)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
AxisLimits limits = plot.Axes.GetLimits();
|
||||
double width = limits.Right - limits.Left;
|
||||
foreach (SegmentSpan segment in _series.Segments.Where(s => s.Label.Length > 0 && s.EndS - s.StartS >= width * _labelledSegmentShare))
|
||||
{
|
||||
Text label = plot.Add.Text(segment.Label, segment.StartS, limits.Top);
|
||||
label.LabelFontSize = 11;
|
||||
label.LabelFontColor = p.Axis;
|
||||
label.LabelAlignment = Alignment.UpperLeft;
|
||||
label.LabelOffsetX = 4;
|
||||
label.LabelOffsetY = 4;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// GPU temperature and load on the right axis, over the frames' span only: the sensors sit on the frames' axis when the
|
||||
/// blob said where the first present is (schema 0013), and ticks before it are the launch and the loading screen.
|
||||
/// </summary>
|
||||
private void DrawSensors(ScottPlot.Plot plot, ChartPalette p)
|
||||
{
|
||||
if (_series is null)
|
||||
@@ -162,14 +256,16 @@ public partial class FrametimeChart : UserControl
|
||||
IYAxis right = plot.Axes.Right;
|
||||
right.Label.Text = Strings.Chart_Axis_Sensor;
|
||||
int n = 0;
|
||||
double end = _series.DurationS;
|
||||
foreach (SensorSeries sensor in _series.Sensors.Where(static s => s.Name is "gpu_temp" or "gpu_load"))
|
||||
{
|
||||
if (sensor.TimesS.Length == 0)
|
||||
int[] inside = [.. Enumerable.Range(0, sensor.TimesS.Length).Where(i => sensor.TimesS[i] >= 0 && sensor.TimesS[i] <= end)];
|
||||
if (inside.Length == 0)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
(double[] dx, double[] dy) = Decimator.MinMax(sensor.TimesS, sensor.Values, 1000);
|
||||
(double[] dx, double[] dy) = Decimator.MinMax([.. inside.Select(i => sensor.TimesS[i])], [.. inside.Select(i => sensor.Values[i])], 1000);
|
||||
DrawnPoints += dx.Length;
|
||||
Scatter line = plot.Add.ScatterLine(dx, dy, n++ == 0 ? p.Sensor : p.SensorSecondary);
|
||||
line.LineWidth = 1;
|
||||
|
||||
@@ -2,9 +2,22 @@ using FrameLedger.Domain.Metrics;
|
||||
|
||||
namespace FrameLedger.App.Charts;
|
||||
|
||||
/// <summary>FPS at each percentile (0…100) of frametime, under <c>03_METRICS</c>' linear method — the distribution tab's curve and Compare's overlay.</summary>
|
||||
/// <summary>
|
||||
/// FPS at each percentile of frametime, under <c>03_METRICS</c>' linear method — the distribution tab's curve and Compare's
|
||||
/// overlay — drawn only where the session has the frames to say it (beta.8).
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <b>A percentile is drawn when at least <see cref="FramesBeyond"/> frames lie beyond it on each side</b> — FR-4.8's rule
|
||||
/// generalised: the 1% low (the 99th percentile) needs 1,000 frames and the 0.1% low (the 99.9th) 10,000, which is exactly
|
||||
/// ten frames beyond each. The curve drew 0 to 100 whatever the count: its 100th point was the single worst frame, its 0th
|
||||
/// the single shortest interval — thousands of FPS that set the axis for every other point — and its 99th was a 1% low the
|
||||
/// stat card beside it refused to publish.
|
||||
/// </remarks>
|
||||
public static class PercentileCurve
|
||||
{
|
||||
/// <summary>Frames that must lie beyond a percentile, on each side, for it to be drawn.</summary>
|
||||
public const int FramesBeyond = 10;
|
||||
|
||||
public static (double[] Xs, double[] Ys) Of(IReadOnlyList<double> appFrameTimesMs)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(appFrameTimesMs);
|
||||
@@ -14,15 +27,57 @@ public static class PercentileCurve
|
||||
}
|
||||
|
||||
IReadOnlyList<double> sorted = Percentile.Sorted(appFrameTimesMs);
|
||||
var xs = new double[101];
|
||||
var ys = new double[101];
|
||||
for (int i = 0; i <= 100; i++)
|
||||
var xs = new List<double>(103);
|
||||
var ys = new List<double>(103);
|
||||
foreach (double p in Percents())
|
||||
{
|
||||
xs[i] = i;
|
||||
double? ft = Percentile.Linear(sorted, i / 100.0);
|
||||
ys[i] = ft is > 0 ? 1000.0 / ft.Value : 0;
|
||||
if (Supported(sorted.Count, p) && Fps(sorted, p) is double fps)
|
||||
{
|
||||
xs.Add(p);
|
||||
ys.Add(fps);
|
||||
}
|
||||
}
|
||||
|
||||
return (xs, ys);
|
||||
return ([.. xs], [.. ys]);
|
||||
}
|
||||
|
||||
/// <summary>The 1% and 0.1% lows as points on the curve (x 99 and 99.9), each only where the session has the frames for it.</summary>
|
||||
public static IReadOnlyList<(double X, double Fps, bool PointOne)> Lows(IReadOnlyList<double> appFrameTimesMs)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(appFrameTimesMs);
|
||||
IReadOnlyList<double> sorted = Percentile.Sorted(appFrameTimesMs);
|
||||
var lows = new List<(double, double, bool)>(2);
|
||||
if (Supported(sorted.Count, 99) && Fps(sorted, 99) is double p1)
|
||||
{
|
||||
lows.Add((99, p1, false));
|
||||
}
|
||||
|
||||
if (Supported(sorted.Count, 99.9) && Fps(sorted, 99.9) is double p01)
|
||||
{
|
||||
lows.Add((99.9, p01, true));
|
||||
}
|
||||
|
||||
return lows;
|
||||
}
|
||||
|
||||
/// <summary>At least <see cref="FramesBeyond"/> of <paramref name="frames"/> lie beyond <paramref name="percent"/> on each side.</summary>
|
||||
public static bool Supported(int frames, double percent) =>
|
||||
frames * Math.Min(percent, 100 - percent) / 100.0 >= FramesBeyond - 1e-9;
|
||||
|
||||
/// <summary>0, 0.1, 1 … 99, 99.9, 100 — in order, because the curve is drawn as a line through them.</summary>
|
||||
private static IEnumerable<double> Percents()
|
||||
{
|
||||
yield return 0;
|
||||
yield return 0.1;
|
||||
for (int i = 1; i <= 99; i++)
|
||||
{
|
||||
yield return i;
|
||||
}
|
||||
|
||||
yield return 99.9;
|
||||
yield return 100;
|
||||
}
|
||||
|
||||
private static double? Fps(IReadOnlyList<double> sorted, double percent) =>
|
||||
Percentile.Linear(sorted, percent / 100.0) is > 0 and double ft ? 1000.0 / ft : null;
|
||||
}
|
||||
@@ -5,12 +5,32 @@ using ScottPlot.Plottables;
|
||||
namespace FrameLedger.App.Charts;
|
||||
|
||||
/// <summary>
|
||||
/// The Sensors tab: GPU core / hotspot temperature and load / power on one plot (°C and % left, W right),
|
||||
/// and VRAM on another — the game's own usage (the per-present <c>vram_proc</c> blob, a held 1 Hz sample)
|
||||
/// and the adapter-wide figure (the <c>vram_adapter</c> sensor) as two differently-labelled series.
|
||||
/// The Sensors tab: GPU core / hotspot temperature, load, CPU temperature and load on one plot (°C and % left) with the GPU's
|
||||
/// power on a watt axis at the right, and memory on another — the game's own VRAM (the per-present <c>vram_proc</c> blob, a
|
||||
/// held 1 Hz sample), the adapter-wide VRAM (the <c>vram_adapter</c> sensor) and the system's RAM as differently-labelled
|
||||
/// series. Since beta.8 it draws a session that was not hooked too: its sensors are all it has.
|
||||
/// </summary>
|
||||
public partial class SensorsChart : UserControl
|
||||
{
|
||||
/// <summary>The temperatures-and-load plot's series, each with the palette key it is drawn in and whether it is on the watt axis.</summary>
|
||||
internal static readonly IReadOnlyList<(string Series, string PaletteKey, bool Watts)> TempsPlot =
|
||||
[
|
||||
("gpu_temp", "Chart_Sensor", false),
|
||||
("gpu_hotspot", "Chart_Stutter", false),
|
||||
("gpu_load", "Chart_Native", false),
|
||||
("gpu_power", "Chart_SensorSecondary", true),
|
||||
("cpu_temp", "Chart_Percentile", false),
|
||||
("cpu_load", "Chart_Displayed", false),
|
||||
];
|
||||
|
||||
/// <summary>The memory plot's series and their palette keys; <c>vram_proc</c> is the per-present blob, the others sensors.</summary>
|
||||
internal static readonly IReadOnlyList<(string Series, string PaletteKey)> MemoryPlot =
|
||||
[
|
||||
("vram_proc", "Chart_Displayed"),
|
||||
("vram_adapter", "Chart_SensorSecondary"),
|
||||
("ram_mb", "Chart_Percentile"),
|
||||
];
|
||||
|
||||
public SensorsChart()
|
||||
{
|
||||
InitializeComponent();
|
||||
@@ -20,27 +40,38 @@ public partial class SensorsChart : UserControl
|
||||
|
||||
public int DrawnSeries { get; private set; }
|
||||
|
||||
/// <summary>The temperatures plot, for a test's look at its axes.</summary>
|
||||
public ScottPlot.Plot TempsPlotView => Temps.Plot;
|
||||
|
||||
public void Show(SessionSeries? series)
|
||||
{
|
||||
DrawnSeries = 0;
|
||||
DrawTemps(series);
|
||||
DrawVram(series);
|
||||
DrawMemory(series);
|
||||
}
|
||||
|
||||
/// <summary>The time axis says where its zero is: the first frame when the sensors sit on the frames' axis, the session's start otherwise.</summary>
|
||||
internal static string TimeAxisLabel(SessionSeries? series) =>
|
||||
series is { SensorsAligned: true, Presents: > 0 } ? Strings.Chart_Axis_TimeFromFirstFrame : Strings.Chart_Axis_TimeFromStart;
|
||||
|
||||
private void DrawTemps(SessionSeries? series)
|
||||
{
|
||||
ScottPlot.Plot plot = Temps.Plot;
|
||||
plot.Clear();
|
||||
ChartTheme.Apply(plot);
|
||||
plot.XLabel(Strings.Chart_Axis_Time);
|
||||
plot.XLabel(TimeAxisLabel(series));
|
||||
plot.YLabel(Strings.Chart_Axis_Sensor);
|
||||
if (series is not null)
|
||||
{
|
||||
ChartPalette p = ChartTheme.Current;
|
||||
Line(plot, series, "gpu_temp", Strings.Sensors_Series_GpuTemp, p.Sensor, null);
|
||||
Line(plot, series, "gpu_hotspot", Strings.Sensors_Series_GpuHotspot, p.Stutter, null);
|
||||
Line(plot, series, "gpu_load", Strings.Sensors_Series_GpuLoad, p.Native, null);
|
||||
Line(plot, series, "gpu_power", Strings.Sensors_Series_GpuPower, p.SensorSecondary, plot.Axes.Right);
|
||||
foreach ((string name, string key, bool watts) in TempsPlot)
|
||||
{
|
||||
if (Line(plot, series, name, Label(name), p.ByKey(key), watts ? plot.Axes.Right : null) && watts)
|
||||
{
|
||||
plot.Axes.Right.Label.Text = Strings.Sensors_Axis_Watts;
|
||||
}
|
||||
}
|
||||
|
||||
plot.Axes.AutoScale();
|
||||
plot.ShowLegend(Alignment.UpperRight);
|
||||
}
|
||||
@@ -48,27 +79,19 @@ public partial class SensorsChart : UserControl
|
||||
Temps.Refresh();
|
||||
}
|
||||
|
||||
private void DrawVram(SessionSeries? series)
|
||||
private void DrawMemory(SessionSeries? series)
|
||||
{
|
||||
ScottPlot.Plot plot = Vram.Plot;
|
||||
plot.Clear();
|
||||
ChartTheme.Apply(plot);
|
||||
plot.XLabel(Strings.Chart_Axis_Time);
|
||||
plot.XLabel(TimeAxisLabel(series));
|
||||
plot.YLabel(Strings.Sensors_Axis_Mb);
|
||||
if (series is not null)
|
||||
{
|
||||
ChartPalette p = ChartTheme.Current;
|
||||
if (series.VramProcMb is { Length: > 0 } proc)
|
||||
{
|
||||
int n = Math.Min(proc.Length, series.TimesS.Length);
|
||||
(double[] xs, double[] ys) = Decimator.MinMax(series.TimesS[..n], [.. proc.Take(n).Select(static v => (double)v)], 1000);
|
||||
Scatter line = plot.Add.ScatterLine(xs, ys, p.Displayed);
|
||||
line.LineWidth = 1;
|
||||
line.LegendText = Strings.Sensors_Series_VramProcess;
|
||||
DrawnSeries++;
|
||||
}
|
||||
|
||||
Line(plot, series, "vram_adapter", Strings.Sensors_Series_VramAdapter, p.SensorSecondary, null);
|
||||
DrawProcessVram(plot, series, p.ByKey(MemoryPlot[0].PaletteKey));
|
||||
Line(plot, series, "vram_adapter", Strings.Sensors_Series_VramAdapter, p.ByKey(MemoryPlot[1].PaletteKey), null);
|
||||
Line(plot, series, "ram_mb", Strings.Sensors_Series_Ram, p.ByKey(MemoryPlot[2].PaletteKey), null);
|
||||
plot.Axes.AutoScale();
|
||||
plot.ShowLegend(Alignment.UpperRight);
|
||||
}
|
||||
@@ -76,12 +99,49 @@ public partial class SensorsChart : UserControl
|
||||
Vram.Refresh();
|
||||
}
|
||||
|
||||
private void Line(ScottPlot.Plot plot, SessionSeries series, string name, string label, Color color, IYAxis? axis)
|
||||
/// <summary>
|
||||
/// The game's own VRAM, per present on the frames' axis — a 0 is a present the sample did not reach (the record's zero,
|
||||
/// SessionFinalizer.Series), never a reading, and is left out (beta.8).
|
||||
/// </summary>
|
||||
private void DrawProcessVram(ScottPlot.Plot plot, SessionSeries series, Color color)
|
||||
{
|
||||
if (series.VramProcMb is not { Length: > 0 } proc)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
int n = Math.Min(proc.Length, series.TimesS.Length);
|
||||
int[] read = [.. Enumerable.Range(0, n).Where(i => proc[i] > 0)];
|
||||
if (read.Length == 0)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
(double[] xs, double[] ys) = Decimator.MinMax([.. read.Select(i => series.TimesS[i])], [.. read.Select(i => (double)proc[i])], 1000);
|
||||
Scatter line = plot.Add.ScatterLine(xs, ys, color);
|
||||
line.LineWidth = 1;
|
||||
line.LegendText = Strings.Sensors_Series_VramProcess;
|
||||
DrawnSeries++;
|
||||
}
|
||||
|
||||
private static string Label(string series) => series switch
|
||||
{
|
||||
"gpu_temp" => Strings.Sensors_Series_GpuTemp,
|
||||
"gpu_hotspot" => Strings.Sensors_Series_GpuHotspot,
|
||||
"gpu_load" => Strings.Sensors_Series_GpuLoad,
|
||||
"gpu_power" => Strings.Sensors_Series_GpuPower,
|
||||
"cpu_temp" => Strings.Sensors_Series_CpuTemp,
|
||||
"cpu_load" => Strings.Sensors_Series_CpuLoad,
|
||||
_ => series,
|
||||
};
|
||||
|
||||
/// <summary>Draws one sensor series if the session has it; whether it did.</summary>
|
||||
private bool Line(ScottPlot.Plot plot, SessionSeries series, string name, string label, Color color, IYAxis? axis)
|
||||
{
|
||||
SensorSeries? sensor = series.Sensors.FirstOrDefault(s => string.Equals(s.Name, name, StringComparison.Ordinal));
|
||||
if (sensor is null || sensor.TimesS.Length == 0)
|
||||
{
|
||||
return;
|
||||
return false;
|
||||
}
|
||||
|
||||
(double[] xs, double[] ys) = Decimator.MinMax(sensor.TimesS, sensor.Values, 1000);
|
||||
@@ -94,5 +154,6 @@ public partial class SensorsChart : UserControl
|
||||
}
|
||||
|
||||
DrawnSeries++;
|
||||
return true;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,7 @@
|
||||
namespace FrameLedger.App.Charts;
|
||||
|
||||
/// <summary>A click on a trend landed on a session's points (beta.11, D39): which session.</summary>
|
||||
public sealed class SessionClickedEventArgs(long sessionId) : EventArgs
|
||||
{
|
||||
public long SessionId { get; } = sessionId;
|
||||
}
|
||||
@@ -1,15 +1,20 @@
|
||||
namespace FrameLedger.App.Charts;
|
||||
|
||||
/// <summary>
|
||||
/// A session's per-present series decoded for the charts and the export: every present in drained order with its
|
||||
/// time from the session start, its interval, whether it was generated, whether a gap sat before it; the
|
||||
/// application-frame view (non-generated, non-gap) with the stutter flags over it; the segments on the time
|
||||
/// axis; the sensor series. Decoded once per window, decimated per draw.
|
||||
/// A session's per-present series decoded for the charts and the export: every present of the charted stream in drained
|
||||
/// order with its time from the stream's first present, its interval, whether it was generated, whether a gap sat before
|
||||
/// it; the application-frame view with the stutter flags over it; the segments on the time axis; the sensor series.
|
||||
/// Decoded once per window, decimated per draw.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <b>One stream (beta.8).</b> A session that presented to more than one swapchain is charted on the one its statistics are
|
||||
/// over (<c>SegmentBuilder.DominantStream</c>: identified first, then the most presents) — the stored intervals are per
|
||||
/// swapchain, and interleaving two streams' intervals on one time axis drew neither.
|
||||
/// </remarks>
|
||||
[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1819:Properties should not return arrays", Justification = "a data carrier for the charts: ScottPlot draws double[] and a 500k-frame session is decimated per draw, not copied per read")]
|
||||
public sealed record SessionSeries
|
||||
{
|
||||
/// <summary>Seconds from the first present, per present (a cumulative sum of the intervals).</summary>
|
||||
/// <summary>Seconds from the stream's first present, per present (a cumulative sum of the intervals; a gap adds none).</summary>
|
||||
public required double[] TimesS { get; init; }
|
||||
|
||||
/// <summary>The stored interval per present, ms; 0 on the first present and after a gap.</summary>
|
||||
@@ -37,23 +42,59 @@ public sealed record SessionSeries
|
||||
public ushort[]? RenderRes { get; init; }
|
||||
|
||||
// the application-frame view
|
||||
|
||||
/// <summary>The time of each application frame's present, seconds.</summary>
|
||||
public required double[] AppTimesS { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// Each application frame's time, ms: from the previous application frame's present to its own (beta.8) — the generated
|
||||
/// presents between them add no interval, and a gap breaks the chain. Every present's interval where nothing was generated.
|
||||
/// </summary>
|
||||
public required double[] AppFrameTimesMs { get; init; }
|
||||
|
||||
/// <summary>Index into the per-present arrays for each application frame.</summary>
|
||||
public required int[] AppPresentIndex { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// Every present was generated — frame generation counted and no application frame's token arrived (the <c>no_evaluations</c>
|
||||
/// refusal) — so the application-frame view is every present instead, and the chart says so.
|
||||
/// </summary>
|
||||
public bool NoApplicationFrames { get; init; }
|
||||
|
||||
/// <summary>Per application frame, from <c>Domain.Metrics.StutterDetector</c>; null when the session is too short for the window.</summary>
|
||||
public bool[]? Stutter { get; init; }
|
||||
|
||||
public required IReadOnlyList<SegmentSpan> Segments { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// The sensor series. On the frames' axis — seconds from the first present, negative before it — when
|
||||
/// <see cref="SensorsAligned"/>; from the session's start otherwise.
|
||||
/// </summary>
|
||||
public required IReadOnlyList<SensorSeries> Sensors { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// The sensors are placed on the frames' time axis: the blob said where the first present sits on the sensors' clock
|
||||
/// (schema 0013). A session recorded before cannot draw them over its frames.
|
||||
/// </summary>
|
||||
public bool SensorsAligned { get; init; }
|
||||
|
||||
public int Presents => TimesS.Length;
|
||||
|
||||
public bool HasGenerated => Generated.Any(static g => g);
|
||||
|
||||
public double DurationS => TimesS.Length == 0 ? 0 : TimesS[^1];
|
||||
|
||||
/// <summary>A series with no frames: a session that was not hooked still has its sensors (beta.8).</summary>
|
||||
public static SessionSeries SensorsOnly(IReadOnlyList<SensorSeries> sensors) => new()
|
||||
{
|
||||
TimesS = [],
|
||||
FrameTimesMs = [],
|
||||
Generated = [],
|
||||
Gap = [],
|
||||
AppTimesS = [],
|
||||
AppFrameTimesMs = [],
|
||||
AppPresentIndex = [],
|
||||
Segments = [],
|
||||
Sensors = sensors,
|
||||
};
|
||||
}
|
||||
@@ -6,10 +6,11 @@ using FrameLedger.Infrastructure.Blobs;
|
||||
namespace FrameLedger.App.Charts;
|
||||
|
||||
/// <summary>
|
||||
/// Decodes one session's blobs into a <see cref="SessionSeries"/>: the frametime series with the gap and
|
||||
/// generated bits, the application-frame view with <c>StutterDetector</c> over it (the same rule the stored
|
||||
/// <c>stutter_count</c> came from), the segments mapped from frame index to seconds, and the sensors aligned to
|
||||
/// their <c>t_ms</c>. Null when the session has no frame blob (Tier 2, or swept by retention).
|
||||
/// Decodes one session's blobs into a <see cref="SessionSeries"/>: the charted stream's frametime series with the gap
|
||||
/// and generated bits, the application-frame view with <c>StutterDetector</c> over it (the rule the stored
|
||||
/// <c>stutter_count</c> came from), the segments mapped from frame index to seconds, and the sensors. Null when the
|
||||
/// session has no frame blob (Tier 2, or swept by retention); <see cref="LoadSensorsAsync"/> reads a Tier-2 session's
|
||||
/// sensors on their own.
|
||||
/// </summary>
|
||||
public sealed class SessionSeriesLoader
|
||||
{
|
||||
@@ -30,61 +31,165 @@ public sealed class SessionSeriesLoader
|
||||
return Decode(frames, segments, sensors);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The sensor series alone, timed from the session's start — what a session that was not hooked has to chart (beta.8: the
|
||||
/// Tier-2 row has kept its sensors since 2026-09-22, and no chart read them). Empty when none were recorded.
|
||||
/// </summary>
|
||||
public async Task<IReadOnlyList<SensorSeries>> LoadSensorsAsync(long sessionId, CancellationToken ct = default) =>
|
||||
DecodeSensors(await _sessions.FindSensorsAsync(sessionId, ct).ConfigureAwait(false), offsetS: 0);
|
||||
|
||||
public static SessionSeries Decode(FrameBlobs frames, IReadOnlyList<SegmentRow> segments, IReadOnlyList<SensorBlob> sensors)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(frames);
|
||||
ArgumentNullException.ThrowIfNull(segments);
|
||||
ArgumentNullException.ThrowIfNull(sensors);
|
||||
float[] frametimes = SeriesCodec.DecodeFloat32(frames.FrameTimes.ToArray());
|
||||
byte[] flags = SeriesCodec.DecodeBytes(frames.FrameFlags.ToArray());
|
||||
int n = Math.Min(frametimes.Length, flags.Length);
|
||||
float[] allFrametimes = SeriesCodec.DecodeFloat32(frames.FrameTimes.ToArray());
|
||||
byte[] allFlags = SeriesCodec.DecodeBytes(frames.FrameFlags.ToArray());
|
||||
int total = Math.Min(allFrametimes.Length, allFlags.Length);
|
||||
uint[]? swapchains = frames.SwapchainIds is { } ids ? SeriesCodec.DecodeUInt32(ids.ToArray()) : null;
|
||||
(int[] keep, uint? swapchain) = ChartedStream(total, swapchains);
|
||||
|
||||
float[] frametimes = Pick(allFrametimes, keep);
|
||||
byte[] flags = Pick(allFlags, keep);
|
||||
int n = keep.Length;
|
||||
var times = new double[n];
|
||||
var generated = new bool[n];
|
||||
var gap = new bool[n];
|
||||
double t = 0;
|
||||
var appTimes = new List<double>(n);
|
||||
var appFrametimes = new List<double>(n);
|
||||
var appIndex = new List<int>(n);
|
||||
for (int i = 0; i < n; i++)
|
||||
{
|
||||
t += frametimes[i] / 1000.0;
|
||||
times[i] = t;
|
||||
generated[i] = (flags[i] & (byte)FrameFlagBits.Generated) != 0;
|
||||
gap[i] = (flags[i] & (byte)FrameFlagBits.Gap) != 0;
|
||||
if (i > 0 && !generated[i] && !gap[i] && frametimes[i] > 0)
|
||||
{
|
||||
appTimes.Add(t);
|
||||
appFrametimes.Add(frametimes[i]);
|
||||
appIndex.Add(i);
|
||||
}
|
||||
}
|
||||
|
||||
(List<int> appIndex, List<double> appFrametimes, bool noApplicationFrames) = ApplicationFrames(frametimes, generated, gap);
|
||||
StutterResult? stutter = StutterDetector.Detect(appFrametimes);
|
||||
uint[]? frameIndex = frames.FrameIndex is { } fi ? SeriesCodec.DecodeUInt32(fi.ToArray()) : null;
|
||||
uint[]? frameIndex = frames.FrameIndex is { } fi ? PickOptional(SeriesCodec.DecodeUInt32(fi.ToArray()), keep) : null;
|
||||
double? offsetS = frames.FirstPresentMs / 1000.0;
|
||||
return new SessionSeries
|
||||
{
|
||||
TimesS = times,
|
||||
FrameTimesMs = frametimes.Length == n ? frametimes : frametimes[..n],
|
||||
FrameTimesMs = frametimes,
|
||||
Generated = generated,
|
||||
Gap = gap,
|
||||
FrameIndex = frameIndex,
|
||||
RtFlags = frames.RtFlags is { } rt ? SeriesCodec.DecodeBytes(rt.ToArray()) : null,
|
||||
DispatchRays = frames.DispatchRays is { } dr ? SeriesCodec.DecodeUInt32(dr.ToArray()) : null,
|
||||
PsoCreated = frames.PsoCreated is { } pso ? SeriesCodec.DecodeUInt16(pso.ToArray()) : null,
|
||||
VramProcMb = frames.VramProc is { } vram ? SeriesCodec.DecodeUInt32(vram.ToArray()) : null,
|
||||
LatencyUs = frames.LatencyUs is { } lat ? SeriesCodec.DecodeUInt32(lat.ToArray()) : null,
|
||||
RenderRes = frames.RenderRes is { } rr ? SeriesCodec.DecodeUInt16(rr.ToArray()) : null,
|
||||
AppTimesS = [.. appTimes],
|
||||
RtFlags = frames.RtFlags is { } rt ? PickOptional(SeriesCodec.DecodeBytes(rt.ToArray()), keep) : null,
|
||||
DispatchRays = frames.DispatchRays is { } dr ? PickOptional(SeriesCodec.DecodeUInt32(dr.ToArray()), keep) : null,
|
||||
PsoCreated = frames.PsoCreated is { } pso ? PickOptional(SeriesCodec.DecodeUInt16(pso.ToArray()), keep) : null,
|
||||
VramProcMb = frames.VramProc is { } vram ? PickOptional(SeriesCodec.DecodeUInt32(vram.ToArray()), keep) : null,
|
||||
LatencyUs = frames.LatencyUs is { } lat ? PickOptional(SeriesCodec.DecodeUInt32(lat.ToArray()), keep) : null,
|
||||
RenderRes = frames.RenderRes is { } rr ? PickQuads(SeriesCodec.DecodeUInt16(rr.ToArray()), keep) : null,
|
||||
AppTimesS = [.. appIndex.Select(i => times[i])],
|
||||
AppFrameTimesMs = [.. appFrametimes],
|
||||
AppPresentIndex = [.. appIndex],
|
||||
NoApplicationFrames = noApplicationFrames,
|
||||
Stutter = stutter is null ? null : [.. stutter.IsStutter],
|
||||
Segments = MapSegments(segments, times, frameIndex),
|
||||
Sensors = DecodeSensors(sensors),
|
||||
Segments = MapSegments([.. segments.Where(s => swapchain is null || s.SwapchainId == swapchain.Value)], times, frameIndex),
|
||||
Sensors = DecodeSensors(sensors, offsetS ?? 0),
|
||||
SensorsAligned = offsetS is not null,
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The presents of the stream the charts draw — the one the session's statistics are over (<c>SegmentBuilder.DominantStream</c>:
|
||||
/// identified first, then the most presents) — as indices into the blob, and that stream's id; every present, and no id,
|
||||
/// when the blob held one stream.
|
||||
/// </summary>
|
||||
internal static (int[] Keep, uint? Swapchain) ChartedStream(int count, uint[]? swapchains)
|
||||
{
|
||||
if (swapchains is null || swapchains.Length < count)
|
||||
{
|
||||
return ([.. Enumerable.Range(0, count)], null);
|
||||
}
|
||||
|
||||
IReadOnlyList<int> keep = SegmentBuilder.DominantStream([.. Enumerable.Range(0, count)], i => swapchains[i]);
|
||||
return ([.. keep], keep.Count > 0 ? swapchains[keep[0]] : null);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The application-frame view: each application frame's time is from the previous application frame's present to its own —
|
||||
/// the generated presents between them add their intervals to it, never an interval of their own — and a gap breaks the
|
||||
/// chain. Where every present was generated, every present's interval, and the flag that says so.
|
||||
/// </summary>
|
||||
internal static (List<int> Index, List<double> FrametimesMs, bool NoApplicationFrames) ApplicationFrames(float[] frametimes, bool[] generated, bool[] gap)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(frametimes);
|
||||
ArgumentNullException.ThrowIfNull(generated);
|
||||
ArgumentNullException.ThrowIfNull(gap);
|
||||
bool noApplicationFrames = generated.Length > 0 && generated.All(static g => g);
|
||||
var index = new List<int>(frametimes.Length);
|
||||
var ms = new List<double>(frametimes.Length);
|
||||
bool chain = false;
|
||||
double sinceApplicationFrame = 0;
|
||||
for (int i = 0; i < frametimes.Length; i++)
|
||||
{
|
||||
if (gap[i])
|
||||
{
|
||||
chain = false;
|
||||
sinceApplicationFrame = 0;
|
||||
}
|
||||
else
|
||||
{
|
||||
sinceApplicationFrame += frametimes[i];
|
||||
}
|
||||
|
||||
if (generated[i] && !noApplicationFrames)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
if (chain && sinceApplicationFrame > 0)
|
||||
{
|
||||
index.Add(i);
|
||||
ms.Add(sinceApplicationFrame);
|
||||
}
|
||||
|
||||
chain = true;
|
||||
sinceApplicationFrame = 0;
|
||||
}
|
||||
|
||||
return (index, ms, noApplicationFrames);
|
||||
}
|
||||
|
||||
private static T[] Pick<T>(T[] values, int[] keep)
|
||||
{
|
||||
if (keep.Length == values.Length)
|
||||
{
|
||||
return values;
|
||||
}
|
||||
|
||||
var picked = new T[keep.Length];
|
||||
for (int i = 0; i < keep.Length; i++)
|
||||
{
|
||||
picked[i] = values[keep[i]];
|
||||
}
|
||||
|
||||
return picked;
|
||||
}
|
||||
|
||||
/// <summary>A per-present series the blob may have written shorter than the frames: only the kept presents it covers.</summary>
|
||||
private static T[] PickOptional<T>(T[] values, int[] keep) => keep.Length == values.Length ? values : [.. keep.Where(i => i < values.Length).Select(i => values[i])];
|
||||
|
||||
private static ushort[] PickQuads(ushort[] values, int[] keep)
|
||||
{
|
||||
if (keep.Length * 4 == values.Length)
|
||||
{
|
||||
return values;
|
||||
}
|
||||
|
||||
var picked = new List<ushort>(keep.Length * 4);
|
||||
foreach (int i in keep.Where(i => (i * 4) + 3 < values.Length))
|
||||
{
|
||||
picked.AddRange(values.AsSpan(i * 4, 4).ToArray());
|
||||
}
|
||||
|
||||
return [.. picked];
|
||||
}
|
||||
|
||||
/// <summary>A segment's <c>start_frame</c>/<c>end_frame</c> are frame indices; the present at that index (or the nearest) gives the seconds.</summary>
|
||||
private static IReadOnlyList<SegmentSpan> MapSegments(IReadOnlyList<SegmentRow> segments, double[] times, uint[]? frameIndex)
|
||||
private static List<SegmentSpan> MapSegments(IReadOnlyList<SegmentRow> segments, double[] times, uint[]? frameIndex)
|
||||
{
|
||||
if (times.Length == 0)
|
||||
{
|
||||
@@ -117,18 +222,19 @@ public sealed class SessionSeriesLoader
|
||||
|
||||
private static string SegmentLabel(SegmentRow s)
|
||||
{
|
||||
string upscaler = Services.Formats.Upscaler(s.Upscaler);
|
||||
if (s.UpscalerQuality is { Length: > 0 } q)
|
||||
{
|
||||
upscaler += " " + q;
|
||||
}
|
||||
// A segment carries no driver word: the driver's bookkeeping is per process, not per settings change.
|
||||
string upscaler = Services.Formats.Upscaler(s.Upscaler, s.UpscalerQuality, driverReported: null);
|
||||
|
||||
string resolution = Services.Formats.Resolution(s.RenderW, s.RenderH, s.OutputW, s.OutputH);
|
||||
string fg = Services.Formats.FrameGeneration(s.FgMode);
|
||||
return string.Join(" · ", new[] { upscaler, resolution, fg }.Where(static x => x.Length > 0));
|
||||
}
|
||||
|
||||
private static List<SensorSeries> DecodeSensors(IReadOnlyList<SensorBlob> sensors)
|
||||
/// <summary>
|
||||
/// Every sensor series against <c>t_ms</c> less <paramref name="offsetS"/> — the first present's place on the sensors'
|
||||
/// clock, so they share the frames' axis (schema 0013) — and −1 dropped: a tick with no reading, never a zero.
|
||||
/// </summary>
|
||||
private static List<SensorSeries> DecodeSensors(IReadOnlyList<SensorBlob> sensors, double offsetS)
|
||||
{
|
||||
SensorBlob? clock = sensors.FirstOrDefault(static s => string.Equals(s.Series, "t_ms", StringComparison.Ordinal));
|
||||
float[]? tMs = clock is null ? null : SeriesCodec.DecodeFloat32(clock.Data.ToArray());
|
||||
@@ -150,7 +256,7 @@ public sealed class SessionSeriesLoader
|
||||
continue; // SessionFinalizer.SensorMissing: a tick with no reading, never a zero
|
||||
}
|
||||
|
||||
xs.Add(tMs is not null && i < tMs.Length ? tMs[i] / 1000.0 : i / Math.Max(blob.Hz, 0.001));
|
||||
xs.Add((tMs is not null && i < tMs.Length ? tMs[i] / 1000.0 : i / Math.Max(blob.Hz, 0.001)) - offsetS);
|
||||
ys.Add(values[i]);
|
||||
}
|
||||
|
||||
|
||||
@@ -1,43 +1,93 @@
|
||||
using System.Windows.Controls;
|
||||
using System.Windows.Input;
|
||||
using ScottPlot;
|
||||
using ScottPlot.Plottables;
|
||||
|
||||
namespace FrameLedger.App.Charts;
|
||||
|
||||
/// <summary>The trend line (one point per session, oldest first) with FR-6.3's hardware-change markers as labelled vertical lines.</summary>
|
||||
/// <summary>
|
||||
/// The trend: one point per session, oldest first, with FR-6.3's hardware-change markers as labelled vertical lines. Since
|
||||
/// beta.11 (owner decision D39) it draws several metrics at once — every line in the first unit against the left axis, a
|
||||
/// second unit against the right — and a click near a session's points raises <see cref="SessionClicked"/>, which the
|
||||
/// Sessions tab's overview uses to select that session.
|
||||
/// </summary>
|
||||
public partial class TrendChart : UserControl
|
||||
{
|
||||
/// <summary>How near a click must land to a session's points, in device-independent pixels.</summary>
|
||||
private const double _clickReach = 14;
|
||||
|
||||
private TrendPoint[] _all = [];
|
||||
|
||||
public TrendChart()
|
||||
{
|
||||
InitializeComponent();
|
||||
ChartTheme.Attach(Plot);
|
||||
Plot.MouseLeftButtonUp += OnPlotClicked;
|
||||
}
|
||||
|
||||
/// <summary>The session whose points a click landed on (<see cref="TrendPoint.SessionId"/>).</summary>
|
||||
public event EventHandler<SessionClickedEventArgs>? SessionClicked;
|
||||
|
||||
public ScottPlot.Plot ScottPlot => Plot.Plot;
|
||||
|
||||
public int DrawnPoints { get; private set; }
|
||||
|
||||
public void Show(IReadOnlyList<TrendPoint> points, IReadOnlyList<HardwareChange> changes, string metricLabel)
|
||||
/// <summary>How many of <see cref="DrawnPoints"/> were drawn hollow (a part of their session).</summary>
|
||||
public int HollowPoints { get; private set; }
|
||||
|
||||
/// <summary>How many lines were drawn against the right axis (a second unit).</summary>
|
||||
public int RightAxisLines { get; private set; }
|
||||
|
||||
/// <summary>One metric — what the Trend drew before beta.11.</summary>
|
||||
public void Show(IReadOnlyList<TrendPoint> points, IReadOnlyList<HardwareChange> changes, string metricLabel) =>
|
||||
Show([new TrendLine(metricLabel, metricLabel, points)], changes);
|
||||
|
||||
/// <summary>
|
||||
/// Every line in <paramref name="lines"/>: the first line's unit on the left axis, the first other unit on the right,
|
||||
/// and a line in any further unit is not drawn (the selector allows two).
|
||||
/// </summary>
|
||||
public void Show(IReadOnlyList<TrendLine> lines, IReadOnlyList<HardwareChange> changes)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(points);
|
||||
ArgumentNullException.ThrowIfNull(lines);
|
||||
ArgumentNullException.ThrowIfNull(changes);
|
||||
ScottPlot.Plot plot = Plot.Plot;
|
||||
plot.Clear();
|
||||
// The date axis REPLACES the bottom axis, so it goes first (beta.8): made after the theme and the label, it dropped
|
||||
// both — an unlabelled axis in the default colours, unreadable in the dark theme.
|
||||
plot.Axes.DateTimeTicksBottom();
|
||||
ChartTheme.Apply(plot);
|
||||
plot.XLabel(Strings.Trend_Axis_Date);
|
||||
plot.YLabel(metricLabel);
|
||||
plot.Axes.DateTimeTicksBottom();
|
||||
DrawnPoints = points.Count;
|
||||
if (points.Count > 0)
|
||||
string? left = lines.Count > 0 ? lines[0].Unit : null;
|
||||
string? right = lines.Select(static l => l.Unit).FirstOrDefault(u => !string.Equals(u, left, StringComparison.Ordinal));
|
||||
plot.YLabel(left ?? string.Empty);
|
||||
plot.Axes.Right.Label.Text = right ?? string.Empty;
|
||||
|
||||
ChartPalette p = ChartTheme.Current;
|
||||
Color[] palette = [p.Native, p.Displayed, p.Percentile, p.Sensor, p.SensorSecondary, p.Stutter, p.Histogram, p.Segment];
|
||||
var drawn = new List<TrendPoint>();
|
||||
int hollow = 0;
|
||||
int onRight = 0;
|
||||
for (int i = 0; i < lines.Count; i++)
|
||||
{
|
||||
ChartPalette p = ChartTheme.Current;
|
||||
double[] xs = [.. points.Select(static t => t.At.LocalDateTime.ToOADate())];
|
||||
double[] ys = [.. points.Select(static t => t.Value)];
|
||||
Scatter line = plot.Add.Scatter(xs, ys, p.Native);
|
||||
line.LineWidth = 2;
|
||||
line.MarkerSize = 7;
|
||||
line.LegendText = metricLabel;
|
||||
foreach (HardwareChange change in changes)
|
||||
TrendLine line = lines[i];
|
||||
bool isRight = right is not null && string.Equals(line.Unit, right, StringComparison.Ordinal);
|
||||
if (line.Points.Count == 0 || (!isRight && !string.Equals(line.Unit, left, StringComparison.Ordinal)))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
hollow += AddLine(plot, line, palette[i % palette.Length], p.Data, isRight);
|
||||
onRight += isRight ? 1 : 0;
|
||||
drawn.AddRange(line.Points);
|
||||
}
|
||||
|
||||
_all = [.. drawn];
|
||||
DrawnPoints = drawn.Count;
|
||||
HollowPoints = hollow;
|
||||
RightAxisLines = onRight;
|
||||
if (drawn.Count > 0)
|
||||
{
|
||||
foreach (HardwareChange change in TrendSeriesBuilder.MergedByDay(changes))
|
||||
{
|
||||
VerticalLine marker = plot.Add.VerticalLine(change.At.LocalDateTime.ToOADate(), 1, p.StutterPso, LinePattern.Dashed);
|
||||
marker.LabelText = change.Text;
|
||||
@@ -51,4 +101,67 @@ public partial class TrendChart : UserControl
|
||||
|
||||
Plot.Refresh();
|
||||
}
|
||||
|
||||
/// <summary>One line, its hollow points, against the left or the right axis; how many were hollow.</summary>
|
||||
private static int AddLine(ScottPlot.Plot plot, TrendLine line, Color color, Color hollowColor, bool isRight)
|
||||
{
|
||||
double[] xs = [.. line.Points.Select(static t => t.At.LocalDateTime.ToOADate())];
|
||||
double[] ys = [.. line.Points.Select(static t => t.Value)];
|
||||
Scatter scatter = plot.Add.Scatter(xs, ys, color);
|
||||
scatter.LineWidth = 2;
|
||||
scatter.MarkerSize = 7;
|
||||
scatter.LegendText = isRight ? line.Label + " ▸" : line.Label;
|
||||
if (isRight)
|
||||
{
|
||||
scatter.Axes.YAxis = plot.Axes.Right;
|
||||
}
|
||||
|
||||
// A point that describes part of its session (settings changed, or a steady state) is drawn hollow over its filled
|
||||
// one: the line still passes through it, and it cannot be read as the session's own number.
|
||||
TrendPoint[] partial = [.. line.Points.Where(static t => t.SettingsChangedMidSession)];
|
||||
if (partial.Length > 0)
|
||||
{
|
||||
double[] hx = [.. partial.Select(static t => t.At.LocalDateTime.ToOADate())];
|
||||
double[] hy = [.. partial.Select(static t => t.Value)];
|
||||
Scatter dots = plot.Add.ScatterPoints(hx, hy, hollowColor);
|
||||
dots.MarkerSize = 6;
|
||||
dots.MarkerShape = MarkerShape.FilledCircle;
|
||||
if (isRight)
|
||||
{
|
||||
dots.Axes.YAxis = plot.Axes.Right;
|
||||
}
|
||||
}
|
||||
|
||||
return partial.Length;
|
||||
}
|
||||
|
||||
/// <summary>The session whose points are nearest the click along the date axis, if any is within <see cref="_clickReach"/>.</summary>
|
||||
private void OnPlotClicked(object sender, MouseButtonEventArgs e)
|
||||
{
|
||||
if (_all.Length == 0 || SessionClicked is null)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
System.Windows.Point at = e.GetPosition(Plot);
|
||||
float scale = Plot.DisplayScale;
|
||||
double clickX = at.X * scale;
|
||||
ScottPlot.Plot plot = Plot.Plot;
|
||||
TrendPoint? nearest = null;
|
||||
double best = double.MaxValue;
|
||||
foreach (TrendPoint point in _all)
|
||||
{
|
||||
double distance = Math.Abs(plot.GetPixel(new Coordinates(point.At.LocalDateTime.ToOADate(), 0)).X - clickX);
|
||||
if (distance < best)
|
||||
{
|
||||
best = distance;
|
||||
nearest = point;
|
||||
}
|
||||
}
|
||||
|
||||
if (nearest is { } hit && best <= _clickReach * scale)
|
||||
{
|
||||
SessionClicked.Invoke(this, new SessionClickedEventArgs(hit.SessionId));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
namespace FrameLedger.App.Charts;
|
||||
|
||||
/// <summary>
|
||||
/// One metric's line on a trend (beta.11, owner decision D39: several metrics at once): its label, the unit that decides
|
||||
/// which axis it is drawn against, and its points (one per session, oldest first).
|
||||
/// </summary>
|
||||
/// <param name="Label">The metric, as the legend names it.</param>
|
||||
/// <param name="Unit">The axis label every line in the same unit shares.</param>
|
||||
/// <param name="Points">The sessions that have the metric.</param>
|
||||
public sealed record TrendLine(string Label, string Unit, IReadOnlyList<TrendPoint> Points);
|
||||
@@ -3,8 +3,15 @@ namespace FrameLedger.App.Charts;
|
||||
/// <summary>The Trend tab's selector (<c>08_UI</c> §Games › Trend).</summary>
|
||||
public enum TrendMetric
|
||||
{
|
||||
/// <summary>Native FPS where frame generation was measured; Presented FPS where it was not (the row's headline, per <c>03_METRICS</c> Avg FPS).</summary>
|
||||
Average,
|
||||
/// <summary>
|
||||
/// Presented FPS — every frame presented — on the sessions where no generated frame was counted (beta.8: "Average" mixed
|
||||
/// it with Native in one line). A session that counted generated frames has none here: its presented rate includes them,
|
||||
/// the single inflated number CLAUDE.md rule 6 forbids; it is on <see cref="NativeFps"/> and <see cref="Displayed"/>.
|
||||
/// </summary>
|
||||
PresentedFps,
|
||||
|
||||
/// <summary>Native FPS — the game's own frames — only where frame generation was measured (counted, or measured none).</summary>
|
||||
NativeFps,
|
||||
|
||||
/// <summary>Displayed FPS — only sessions that measured frame generation have one.</summary>
|
||||
Displayed,
|
||||
@@ -14,4 +21,35 @@ public enum TrendMetric
|
||||
P01Low,
|
||||
|
||||
MaxGpuTemp,
|
||||
|
||||
/// <summary>The seven below are 2026-09-21's: one game's sessions over time, beyond the frame rate.</summary>
|
||||
AvgGpuLoad,
|
||||
|
||||
AvgGpuPower,
|
||||
|
||||
MaxVramProcess,
|
||||
|
||||
AvgCpuLoad,
|
||||
|
||||
MaxCpuTemp,
|
||||
|
||||
AvgRam,
|
||||
|
||||
/// <summary>
|
||||
/// The counted ×FG factor. A session whose factor is its STEADY STATE's (CLAUDE.md rule 6, 2026-09-17) describes part
|
||||
/// of the session, so it is treated as a mid-session change: left out by default, drawn marked when those are included.
|
||||
/// </summary>
|
||||
FgFactor,
|
||||
|
||||
/// <summary>
|
||||
/// The three below are beta.10's (<c>03_METRICS</c> §Display mode): the share of the session's observed time in a mode,
|
||||
/// every session whatever its tier — the window is read out of process. Exclusive fullscreen and borderless have a point
|
||||
/// only where the whole observed time could be told apart; a window that covered its monitor while nothing could ask the
|
||||
/// swap chain counts as neither.
|
||||
/// </summary>
|
||||
DisplayExclusiveShare,
|
||||
|
||||
DisplayBorderlessShare,
|
||||
|
||||
DisplayWindowedShare,
|
||||
}
|
||||
Loaded 100 of 584 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user