Compare commits
95
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.
|
||||
+48
-17
@@ -92,25 +92,21 @@ jobs:
|
||||
# not part of `build.ps1 check`: it mutates HKCU, and a CI runner is the
|
||||
# wrong place to be registering machine-wide Vulkan layers.
|
||||
|
||||
# -SkipIntegration, and the reason is a MEASURED property of the hard gate
|
||||
# rather than CI being awkward.
|
||||
#
|
||||
# The drain end-to-end tests inject the Overlay into hook-harness, which
|
||||
# makes the TEST HOST the target's parent — and §S16 puts a target's
|
||||
# ancestors in the scan set. A .NET host can load
|
||||
# System.Security.Cryptography.ProtectedData.dll, whose name contains the
|
||||
# heuristic fragment `protect`, so the guard refuses our own harness with
|
||||
# SuspiciousUnsigned. Measured here on 2026-08-05; it passes on a dev box
|
||||
# whose test host happens not to load that assembly, which is why CI is the
|
||||
# machine that found it.
|
||||
#
|
||||
# That is the guard behaving as specified. The defect is §S19(b) — the
|
||||
# fragment matching a benign, widely-loaded Microsoft assembly — and fixing
|
||||
# it is a guard change with its own PR, not something to work around here.
|
||||
# Until then these run locally and CI says out loud that it skipped them.
|
||||
# NO -SkipIntegration, since 2026-09-06, and the reason it was here is worth
|
||||
# keeping: the drain end-to-end tests inject the Overlay into hook-harness,
|
||||
# which makes the TEST HOST the target's parent — §S16 puts ancestors in the
|
||||
# scan set — and a .NET host loads System.Security.Cryptography.ProtectedData.dll,
|
||||
# whose name carries the heuristic fragment `protect`. From 2026-08-05 the
|
||||
# guard refused our own harness here with SuspiciousUnsigned, and CI said out
|
||||
# loud that it skipped nine cases. §S19(b)'s signer half now verifies that
|
||||
# module's embedded signature offline and reads O=Microsoft Corporation, so
|
||||
# the refusal is gone for the reason 19_SAFETY always gave ("fragment AND not
|
||||
# signed by a known vendor"), and the nine cases are in the merge gate. The
|
||||
# switch still exists in build.ps1 for a developer who must, and it skips
|
||||
# loudly; CI is no longer a place it is passed.
|
||||
- name: Quality gate
|
||||
shell: pwsh
|
||||
run: ./build.ps1 check -SkipIntegration
|
||||
run: ./build.ps1 check
|
||||
env:
|
||||
CI: 'true'
|
||||
|
||||
@@ -135,6 +131,41 @@ jobs:
|
||||
# from `git diff`, so a shallow checkout cannot silently produce a short
|
||||
# list — and the script refuses an EMPTY list rather than reading it as
|
||||
# "no src/ changes, therefore fine".
|
||||
# THE SIGNER PROBE'S CI LEG, printed. `ctest fl_signer_probe` runs inside the
|
||||
# gate and passes on a regular expression, so its ANSWERS never reach this
|
||||
# log — and §S19(b)'s rows G3/G4/G5 are pre-committed for exactly this
|
||||
# machine's copy of the blocker. Run here, AFTER the gate, because the gate's
|
||||
# restore is what fills the NuGet cache the probe searches first. A
|
||||
# measurement, not a gate: continue-on-error so a surprise (row G6) is
|
||||
# printed rather than turned into a red that hides it. Reading the row off
|
||||
# the table is a separate PR (the probe says so itself).
|
||||
- name: Signer probe (§S19(b) CI leg — measurement, not a gate)
|
||||
if: always()
|
||||
continue-on-error: true
|
||||
shell: pwsh
|
||||
run: ./build/native/x64-release/tools/fl-probe-signer/fl-probe-signer.exe
|
||||
|
||||
# §S29(d)'s pre-committed measurement: can tools/vklayer-blastradius.ps1 run
|
||||
# HERE? It needs a Vulkan loader and vulkaninfo.exe, which ship with a GPU
|
||||
# driver's runtime, not with Windows. A census, printed, never a gate.
|
||||
# READ 2026-09-06 and again 2026-09-10 (run 34427267214): vulkan-1.dll
|
||||
# PRESENT, vulkaninfo.exe ABSENT (System32 and PATH), no ICD registry key.
|
||||
# So the "absent" row of 20_OPEN_QUESTIONS §S29(d) applies — deferred on
|
||||
# that measurement, the script stays hand-run — and the "next PR wires the
|
||||
# script" clause this comment used to carry is struck (2026-09-13). The
|
||||
# step stays so a change in the runner image is noticed rather than assumed.
|
||||
- name: Vulkan runtime census (§S29(d) — measurement, not a gate)
|
||||
if: always()
|
||||
continue-on-error: true
|
||||
shell: pwsh
|
||||
run: |
|
||||
foreach ($f in 'C:\Windows\System32\vulkan-1.dll', 'C:\Windows\System32\vulkaninfo.exe') {
|
||||
Write-Host ("{0}: {1}" -f $f, (Test-Path $f))
|
||||
}
|
||||
$cmd = Get-Command vulkaninfo.exe -ErrorAction SilentlyContinue
|
||||
Write-Host ("vulkaninfo.exe on PATH: {0}" -f ($(if ($cmd) { $cmd.Source } else { 'no' })))
|
||||
Write-Host ("HKLM:\SOFTWARE\Khronos\Vulkan\Drivers present: {0}" -f (Test-Path 'HKLM:\SOFTWARE\Khronos\Vulkan\Drivers'))
|
||||
|
||||
- name: Changelog
|
||||
if: github.event_name == 'pull_request'
|
||||
shell: pwsh
|
||||
|
||||
@@ -0,0 +1,258 @@
|
||||
# FrameLedger release (docs/13_CI_CD.md §release.yml, docs/12_BUILD.md §Publish & package).
|
||||
#
|
||||
# On a tag `v*`: the same gate ci.yml runs, then publish → pack → checksums →
|
||||
# a GitHub Release whose body is CHANGELOG.md's section for the version. Three
|
||||
# things are refused loudly rather than papered over, because a release is the
|
||||
# one artefact nobody can re-run:
|
||||
# - the tag's numeric core must equal the VERSION file (the one version source;
|
||||
# the native VERSIONINFO blocks are built from it and versioninfo-check
|
||||
# compares them);
|
||||
# - CHANGELOG.md must carry a non-empty `## [x.y.z]` section for the tag
|
||||
# (tools/release-notes.ps1) — an empty release body is a defect, not a default;
|
||||
# - the published tree must hold both entry points and every shipped native
|
||||
# binary, checked by name, because `dotnet publish` warns rather than fails
|
||||
# when a .targets-staged DLL is missing.
|
||||
#
|
||||
# Unsigned by policy (11_UPDATER §Unsigned releases): SHA256SUMS.txt is published
|
||||
# beside the assets and printed into the release body.
|
||||
#
|
||||
# A pre-release tag (`v0.1.0-beta.1`, 13_CI_CD §Branch & release policy) marks the
|
||||
# GitHub release as pre-release; the App's stable channel ignores it and the beta
|
||||
# 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:
|
||||
contents: write
|
||||
|
||||
concurrency:
|
||||
group: release-${{ github.ref }}
|
||||
cancel-in-progress: false
|
||||
|
||||
jobs:
|
||||
release:
|
||||
runs-on: windows-latest
|
||||
timeout-minutes: 60
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v7
|
||||
|
||||
- name: Set up .NET
|
||||
uses: actions/setup-dotnet@v6
|
||||
with:
|
||||
global-json-file: global.json
|
||||
|
||||
- name: Set up MSVC (x64)
|
||||
uses: ilammy/msvc-dev-cmd@v1
|
||||
with:
|
||||
arch: x64
|
||||
|
||||
# Same pin as ci.yml, for the same reason (the gate's clang-format step).
|
||||
- name: Pin clang-format
|
||||
shell: pwsh
|
||||
run: |
|
||||
pip install --disable-pip-version-check "clang-format==22.1.3"
|
||||
clang-format --version
|
||||
|
||||
- name: Cache NuGet
|
||||
uses: actions/cache@v6
|
||||
with:
|
||||
path: ~/.nuget/packages
|
||||
key: nuget-${{ runner.os }}-${{ hashFiles('**/Directory.Packages.props', 'global.json') }}
|
||||
restore-keys: nuget-${{ runner.os }}-
|
||||
|
||||
- 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'
|
||||
$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)
|
||||
$core = $m.Groups[1].Value
|
||||
$pre = if ($m.Groups[2].Success) { 'true' } else { 'false' }
|
||||
$file = (Get-Content VERSION -Raw).Trim()
|
||||
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) {
|
||||
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
|
||||
"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
|
||||
# repository, substituted here and nowhere else; the App embeds legal/*.md at
|
||||
# build time, so this runs BEFORE the build.
|
||||
- name: Substitute {{RELEASE_DATE}}
|
||||
shell: pwsh
|
||||
run: |
|
||||
$ErrorActionPreference = 'Stop'
|
||||
$date = (Get-Date).ToUniversalTime().ToString('yyyy-MM-dd')
|
||||
$n = 0
|
||||
foreach ($f in Get-ChildItem legal -Filter *.md) {
|
||||
$t = Get-Content $f.FullName -Raw
|
||||
if ($t.Contains('{{RELEASE_DATE}}')) {
|
||||
[System.IO.File]::WriteAllText($f.FullName, $t.Replace('{{RELEASE_DATE}}', $date), [System.Text.UTF8Encoding]::new($false))
|
||||
$n++
|
||||
}
|
||||
}
|
||||
Write-Host "RELEASE_DATE = $date in $n file(s)"
|
||||
if (Select-String -Path legal/*.md, README.md -Pattern '\{\{' -Quiet) { throw 'a {{ token survived substitution' }
|
||||
|
||||
# The identical gate ci.yml runs — native build, tests, every check including
|
||||
# versioninfo-check against VERSION. A release never skips it.
|
||||
- name: Quality gate
|
||||
shell: pwsh
|
||||
run: ./build.ps1 check
|
||||
env:
|
||||
CI: 'true'
|
||||
|
||||
- name: Publish App + Agent (self-contained, ReadyToRun)
|
||||
shell: pwsh
|
||||
run: |
|
||||
$ErrorActionPreference = 'Stop'
|
||||
$v = '${{ steps.version.outputs.version }}'
|
||||
dotnet publish src/FrameLedger.App -c Release -r win-x64 --self-contained -p:PublishReadyToRun=true -p:Version=$v -o out/app
|
||||
if ($LASTEXITCODE -ne 0) { throw 'App publish failed' }
|
||||
dotnet publish src/FrameLedger.Agent -c Release -r win-x64 --self-contained -p:PublishReadyToRun=true -p:Version=$v -o out/app
|
||||
if ($LASTEXITCODE -ne 0) { throw 'Agent publish failed' }
|
||||
|
||||
# A self-contained package redistributes the .NET runtime, and its licence and
|
||||
# third-party notices are ours to pass on (P4 PR-6). Not committed with the
|
||||
# NuGet texts in legal/licenses/nuget: the runtime version follows the SDK of
|
||||
# the machine that publishes, so the exact packs are read from the published
|
||||
# runtimeconfig and copied from the NuGet cache the publish just used.
|
||||
- name: Ship the .NET runtime's licence and notices
|
||||
shell: pwsh
|
||||
run: |
|
||||
$ErrorActionPreference = 'Stop'
|
||||
$config = Get-Content out/app/FrameLedger.runtimeconfig.json -Raw | ConvertFrom-Json
|
||||
$frameworks = @($config.runtimeOptions.includedFrameworks)
|
||||
if ($frameworks.Count -eq 0) { throw 'FrameLedger.runtimeconfig.json lists no included framework -- the publish was not self-contained' }
|
||||
$cache = if ($env:NUGET_PACKAGES) { $env:NUGET_PACKAGES } else { Join-Path $HOME '.nuget/packages' }
|
||||
$dest = New-Item -ItemType Directory -Force out/app/licenses/dotnet
|
||||
foreach ($fw in $frameworks) {
|
||||
$pack = Join-Path $cache ('{0}.runtime.win-x64/{1}' -f $fw.name.ToLowerInvariant(), $fw.version)
|
||||
$files = @(Get-ChildItem $pack -File | Where-Object { $_.Name -match '^(LICENSE|THIRD-PARTY-NOTICES)(\.TXT)?$' })
|
||||
if ($files.Count -eq 0) { throw "no licence file in $pack" }
|
||||
foreach ($f in $files) {
|
||||
Copy-Item $f.FullName (Join-Path $dest ('{0}-{1}-{2}' -f $fw.name, $fw.version, $f.Name))
|
||||
}
|
||||
}
|
||||
Get-ChildItem $dest | ForEach-Object { Write-Host (" {0,-64} {1,8:N0}" -f $_.Name, $_.Length) }
|
||||
|
||||
# What ships is what matters: the two entry points and the four shipped native
|
||||
# binaries (versioninfo-check's list) must be in the tree, and the unshipped
|
||||
# capture host must not be (package-closure-check proves it statically; this
|
||||
# reads the directory).
|
||||
- name: Assert the published tree
|
||||
shell: pwsh
|
||||
run: |
|
||||
$ErrorActionPreference = 'Stop'
|
||||
$required = 'FrameLedger.exe', 'FrameLedger.Agent.exe', 'FrameLedger.Overlay.dll', 'FrameLedger.VkLayer.dll', 'FrameLedger.Guard.dll', 'FrameLedger.NvapiBridge.dll', 'rules/detection-rules.json',
|
||||
'licenses/nuget/INDEX.md', 'licenses/THIRD_PARTY_NOTICES.md', 'licenses/FrameLedger-GPL-3.0.txt', 'licenses/mpl-2.0.txt', 'licenses/apache-2.0.txt'
|
||||
$missing = @($required | Where-Object { -not (Test-Path (Join-Path out/app $_)) })
|
||||
if ($missing.Count -gt 0) { throw "out/app is missing: $($missing -join ', ')" }
|
||||
if (Test-Path out/app/FrameLedger.CaptureHost.exe) { throw 'out/app contains the unshipped capture host (12_BUILD: exactly two roots)' }
|
||||
if (@(Get-ChildItem out/app/licenses/dotnet -File -ErrorAction SilentlyContinue).Count -lt 2) { throw 'out/app/licenses/dotnet holds fewer than two files -- the runtime licence step did not run' }
|
||||
./tools/versioninfo-check.ps1 -BuildDir out/app
|
||||
if ($LASTEXITCODE -ne 0) { throw 'versioninfo-check over the published tree' }
|
||||
$size = (Get-ChildItem out/app -Recurse -File | Measure-Object Length -Sum).Sum / 1MB
|
||||
Write-Host ("published tree: {0:N0} MB" -f $size)
|
||||
|
||||
# Velopack's packer, pinned to the library version the App references
|
||||
# (Directory.Packages.props). No --icon: assets/icon.ico does not exist yet
|
||||
# (12_BUILD §Publish & package says so rather than pointing at a file that is not there).
|
||||
#
|
||||
# --packId is FrameLedger.App, NOT FrameLedger, and that is a data-loss rule:
|
||||
# Velopack installs into %LOCALAPPDATA%\<packId> and deletes that directory on
|
||||
# uninstall, and %LOCALAPPDATA%\FrameLedger is the DATA folder (LedgerPaths:
|
||||
# ledger.db, logs, the layer manifest). The same id would put the install inside
|
||||
# the ledger's folder and have the uninstaller remove every session without the
|
||||
# question 12_BUILD promises. The title the user sees is still "FrameLedger".
|
||||
- name: Pack (Velopack)
|
||||
shell: pwsh
|
||||
run: |
|
||||
$ErrorActionPreference = 'Stop'
|
||||
dotnet tool install -g vpk --version 1.2.0
|
||||
if ($LASTEXITCODE -ne 0) { throw 'vpk install failed' }
|
||||
$v = '${{ steps.version.outputs.version }}'
|
||||
vpk pack --packId FrameLedger.App --packVersion $v --packDir out/app --mainExe FrameLedger.exe --packTitle FrameLedger --packAuthors FrameLedger --releaseNotes out/notes.md --outputDir out/release
|
||||
if ($LASTEXITCODE -ne 0) { throw 'vpk pack failed' }
|
||||
Get-ChildItem out/release | ForEach-Object { Write-Host (" {0,-48} {1,12:N0}" -f $_.Name, $_.Length) }
|
||||
if (-not (Test-Path out/release/FrameLedger.App-win-Setup.exe)) { throw 'vpk did not produce FrameLedger.App-win-Setup.exe (README §Install names it)' }
|
||||
|
||||
- name: Checksums
|
||||
shell: pwsh
|
||||
run: |
|
||||
$ErrorActionPreference = 'Stop'
|
||||
$lines = Get-ChildItem out/release -File | Sort-Object Name | ForEach-Object {
|
||||
'{0} {1}' -f (Get-FileHash $_.FullName -Algorithm SHA256).Hash.ToLowerInvariant(), $_.Name
|
||||
}
|
||||
[System.IO.File]::WriteAllLines('out/release/SHA256SUMS.txt', $lines, [System.Text.UTF8Encoding]::new($false))
|
||||
$notes = Get-Content out/notes.md -Raw
|
||||
$notes += "`n`n## SHA-256`n`nReleases are not code-signed (11_UPDATER). Verify before running:`n`n``````text`n" + ($lines -join "`n") + "`n``````"
|
||||
[System.IO.File]::WriteAllText('out/notes.md', $notes, [System.Text.UTF8Encoding]::new($false))
|
||||
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 }}
|
||||
run: |
|
||||
$ErrorActionPreference = 'Stop'
|
||||
$v = '${{ steps.version.outputs.version }}'
|
||||
$ghArgs = @('release', 'create', $env:GITHUB_REF_NAME, '--title', "FrameLedger $v", '--notes-file', 'out/notes.md', '--verify-tag')
|
||||
if ('${{ steps.version.outputs.prerelease }}' -eq 'true') { $ghArgs += '--prerelease' }
|
||||
$ghArgs += Get-ChildItem out/release -File | ForEach-Object { $_.FullName }
|
||||
gh @ghArgs
|
||||
if ($LASTEXITCODE -ne 0) { throw 'gh release create failed' }
|
||||
|
||||
- name: Upload the published tree (for the smoke checklist)
|
||||
if: always()
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: release-${{ steps.version.outputs.version || github.ref_name }}${{ steps.version.outputs.dry_run == 'true' && '-dry-run' || '' }}
|
||||
path: |
|
||||
out/release/**
|
||||
out/notes.md
|
||||
if-no-files-found: warn
|
||||
retention-days: 30
|
||||
+1645
-7
File diff suppressed because it is too large.
Load diff
@@ -11,13 +11,26 @@ A C++ DLL (`FrameLedger.Overlay.dll`) is injected into games the user explicitly
|
||||
## Non-negotiable rules
|
||||
|
||||
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.
|
||||
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-21 (owner decision): there is exactly ONE override, and its shape is the rule now.** The owner asked for a "bypass the guard" mode at the user's own risk. It exists (`docs/19_SAFETY_AND_ANTICHEAT.md` §The user's bypass) and everything about it is a constraint a PR may not loosen:
|
||||
> - **Per game, OFF by default, never global.** There is no settings key, no CLI switch, no environment variable, no field in `rules/detection-rules.json` (its schema still makes one a validation error) and no "apply to all". Do not add one.
|
||||
> - **A recorded human act.** It is turned on only through its own disclosure — which states the ban risk and that the user carries the entire risk and the developers none — accepted by BOTH a ticked acknowledgement and the typed phrase, stamped by the Agent with the disclosure's version, keyed on the executable's fingerprint like consent, and gone when hooking is turned off or the executable changes.
|
||||
> - **It overrules the guard's JUDGEMENT and nothing else.** The kill switch, a game that was merely added, a missing consent, a foreign payload, a 32-bit target and a failed injection refuse exactly as before. The guard still runs every check, still reports what it found, and the verdict is `AllowedUnderUserBypass` — never `Allow`. A Vulkan title the guard refuses stays refused.
|
||||
> - **Rule 3 is untouched, and that is the line.** The bypass changes WHETHER FrameLedger injects, never HOW: the same documented `LoadLibraryW`, the DLL's real name, exports and version info, in one chokepoint file. Nothing about it makes FrameLedger harder for anti-cheat to see, and a PR that did would still be rejected on principle.
|
||||
> - **It is visible afterwards.** A session that started under it is marked on its row, with what the guard found, on every surface and in every export.
|
||||
3. **Never implement evasion.** No manual mapping, no PE header erasure, no thread hiding, no signature obfuscation, no unlinking from the PEB module list. Injection uses documented `LoadLibraryW`. The DLL keeps its real name, real exports, and version info. A performance tool must be *visible* to anti-cheat, not hidden from it. Any PR that makes FrameLedger harder to detect is rejected on principle.
|
||||
4. **Never read or write game memory outside our own hooks.** We read arguments passed to APIs we hooked and COM/handle objects we legitimately own. No pattern scanning for game internals, no reading player/entity state, no writing to game memory. Ever.
|
||||
5. **The hook must never crash the game.** Every hook body: SEH-guarded, allocation-free, lock-free, no logging, no exceptions crossing the boundary. On repeated faults, self-disable (`17_HOOK_ENGINE` §Fault policy).
|
||||
6. **FPS display rule (product requirement):** wherever FPS is shown and Frame Generation is active, show *Native FPS*, *Displayed FPS*, and the FG factor together (`62 → 118 FPS (×1.9 FG)`). Never a single inflated number. See `docs/03_METRICS.md`.
|
||||
|
||||
> **Amended 2026-09-03 (owner decision).** When frame generation is *not measured* — `FL_MEASURED_FG` clear, which is every title on today's writer — the one number that may stand alone is **Presented FPS** (`presents / D`), with a mandatory qualifier from the **runtime census** (`FlWriterState.runtimeCensus`): "no frame-generation runtime was loaded, so this cannot include in-process generated frames" or "a frame-generation runtime is loaded and nothing was observed — this MAY include generated frames". The word "Native" never appears alone. **The census never produces `none`**: a statically linked FSR has no module to see, and a census-`none` there would be exactly the inflated number this rule forbids.
|
||||
>
|
||||
> **Amended 2026-09-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*).
|
||||
@@ -35,7 +48,7 @@ A C++ DLL (`FrameLedger.Overlay.dll`) is injected into games the user explicitly
|
||||
| UI | WPF + WPF UI (`WPF-UI` pinned = 4.3.0) + CommunityToolkit.Mvvm — `docs/16_WPFUI_SYNTAX.md` |
|
||||
| App composition | .NET Generic Host + DI in `FrameLedger.App` |
|
||||
| Charts | ScottPlot 5 |
|
||||
| GPU telemetry | Layered: DXGI + PDH counters (all vendors) → LibreHardwareMonitorLib (MPL-2.0, all vendors) → **NVAPI (MIT, headers + `amd64/nvapi64.lib` vendored 2026-08-05** at `src/native/third_party/nvapi/`, consumed via the `fl_nvapi` target; NVIDIA extras + Reflex). **No AMD/Intel vendor SDK** — `docs/18_GPU_VENDOR_APIS.md`. **No telemetry source exists in code yet** — `ctest fl_nvapi_probe` is the only consumer, and it exists so the vendoring is verified rather than asserted. This row previously claimed the vendoring in the present tense while `third_party/` held only `vulkan-headers`; `legal/` had already caught the identical claim about itself and gained a bidirectional gate, which is what made the real vendoring a red-then-green |
|
||||
| GPU telemetry | Layered: DXGI + PDH counters (all vendors) → LibreHardwareMonitorLib (MPL-2.0, all vendors) → **NVAPI (MIT, headers + `amd64/nvapi64.lib` vendored 2026-08-05** at `src/native/third_party/nvapi/`, consumed via the `fl_nvapi` target; NVIDIA extras + Reflex). **No AMD/Intel vendor SDK** — `docs/18_GPU_VENDOR_APIS.md`. ~~**No telemetry source exists in code yet**~~ **`LhmTelemetrySource` (L2) exists since 2026-09-03 (`20_OPEN_QUESTIONS` §M5 row R1, eight GPU fields unelevated); L1 (`BaselineTelemetrySource`: DXGI identity + the PDH adapter-memory counter, the first CsWin32 consumer), `CompositeTelemetrySource` and the 1 Hz `TelemetryPoller` since 2026-09-09; L3 (`NvapiTelemetrySource` over the native `FrameLedger.NvapiBridge.dll` — the only shipped binary linking `nvapi64.lib`, loaded by the Agent into its own process and never into a game) since 2026-09-10 (PR-E2)** — `ctest fl_nvapi_probe` was the only NVAPI consumer until then, and it exists so the vendoring is verified rather than asserted. This row said no source existed for six days after one did, recorded 2026-09-09 rather than repaired quietly. This row previously claimed the vendoring in the present tense while `third_party/` held only `vulkan-headers`; `legal/` had already caught the identical claim about itself and gained a bidirectional gate, which is what made the real vendoring a red-then-green |
|
||||
| CPU/board sensors | LibreHardwareMonitorLib ≥ 0.9.6 (PawnIO) — **optional**, elevated only |
|
||||
| Tier-2 fallback | **There is none, and Tier 2 is not a measurement.** Owner decision 2026-08-28: the ladder is two rungs — hooked, or duration + sensors + the reason. ~~ETW-based, no injection~~; ~~Intel PresentMon console binary~~ dropped 2026-08-27 after §S31 retired it. Whether a shipped build ever regains a no-injection measurement is `docs/20_OPEN_QUESTIONS.md` §G |
|
||||
| Storage | SQLite via Microsoft.Data.Sqlite + Dapper (no EF) |
|
||||
@@ -59,25 +72,51 @@ src/
|
||||
FrameLedger.VkLayer/ # C++20 Vulkan implicit layer DLL + manifest JSON
|
||||
FrameLedger.Shm/ # header-only: ring buffer + record layout, shared by native & C# (mirrored)
|
||||
FrameLedger.Domain/ # entities, metric calculators — zero dependencies
|
||||
# (calculators UNWRITTEN: Domain holds AntiCheat/,
|
||||
# Consent/ and Detection/ only. Nothing in Domain
|
||||
# computes a frame time or an FPS low. measuredMask ->
|
||||
# rule 7's tri-state and Displayed FPS now exist, in the
|
||||
# UNSHIPPED FrameLedger.CaptureHost as a throwaway that
|
||||
# P2's recorder replaces — deliberately not in
|
||||
# Domain.Metrics.*, which carries a 95% coverage floor)
|
||||
FrameLedger.Application/ # use cases, ports
|
||||
FrameLedger.Infrastructure/ # SQLite, shm reader, vendor APIs, injector interop, parsers
|
||||
# (Metrics/ WRITTEN 2026-09-09, P2 PR-A: frame times,
|
||||
# percentiles, lows, stutter, the FG window and its
|
||||
# refusals, extent, segments, RT/HDR tri-states,
|
||||
# aggregates — over Domain's own FrameSample, under the
|
||||
# 95% per-class floor. The CaptureHost's consumer now
|
||||
# calls it; the FG ladder's prose is still there, PR-D's)
|
||||
FrameLedger.Application/ # use cases, ports — incl. Capture/ since 2026-09-09 (P2 PR-C):
|
||||
# CaptureSession (the loop: gate -> inject -> attach -> drain
|
||||
# under the 30 s re-scan), ICaptureSink and the ports the Agent
|
||||
# composes it from, SessionEndReason, the census/NGX/marker facts;
|
||||
# and Recording/ since 2026-09-10 (PR-D): SessionRecorder,
|
||||
# SessionAggregator + FgLadder, SessionFinalizer, the .partial
|
||||
# writer and PartialRecovery, ExitStatusMapper, the crash policy
|
||||
FrameLedger.Infrastructure/ # SQLite, shm reader, vendor APIs, injector interop, parsers,
|
||||
# and Capture/ (PR-C): ShmRingAttacher/ShmCaptureSink over the
|
||||
# reader, HeldProcessLivenessSource, TargetResolver (path only,
|
||||
# never a pid), ProcessLauncher, the module snapshot, the marker scan
|
||||
FrameLedger.Shared/ # IPC contracts (System.Text.Json source-gen) + ShmRecord struct mirror
|
||||
FrameLedger.Agent/ # capture orchestrator: watcher, injector control, shm drain, recorder
|
||||
FrameLedger.App/ # WPF UI
|
||||
FrameLedger.CaptureHost/ # UNSHIPPED. The first production driver of the guard loop:
|
||||
# HookedCaptureGate -> FlGuardedInject -> ShmRingReader ->
|
||||
# 10 Hz drain + GuardSupervisor + PublishGuardResult, plus the
|
||||
# file-backed consent store and a throwaway consumer.
|
||||
# 12_BUILD publishes App and Agent ONLY, and neither references
|
||||
# this — tools/package-closure-check.ps1 is what keeps that true.
|
||||
# §S27 is closed on exactly that basis.
|
||||
# BUILT 2026-09-10 (P2 PR-F): a Generic Host. `--serve` = watcher
|
||||
# (Application.Watch: ProcessWatcher, ProcessTree, DescendantElection,
|
||||
# CaptureOrchestrator over ISessionRecorder) -> recorder -> the gate;
|
||||
# `--console` = the operator's verbs incl. `consent grant` (decision D4,
|
||||
# ConsentProvenance.AgentConsoleOperator — the DEVELOPER path since P3 PR-4
|
||||
# built FR-2.1's dialog, ConsentProvenance.ConsentDialog) and `killswitch` (FR-2.4,
|
||||
# the gate's FOURTH input, decision D7). --data-dir under --console only.
|
||||
FrameLedger.App/ # WPF UI — the SHELL since 2026-09-13 (P3 PR-2): Generic Host,
|
||||
# FluentWindow + TitleBar/Menu/NavigationView, theme + language
|
||||
# persisted in `settings`, the Agent pill over the pipe (starts
|
||||
# `FrameLedger.Agent.exe --serve` beside itself when absent),
|
||||
# ~~five pages of which four are empty states~~ — every 08_UI screen
|
||||
# is built as of 2026-09-14 (PR-5 Games/Dashboard, PR-6 summary +
|
||||
# charts, PR-7 trend/compare, PR-8a Settings/safety notices/Logs/
|
||||
# --diag, PR-8b tray + the Agent's maintenance flags, PR-9 first run
|
||||
# + Legal Gate FR-11); Strings.resx en/vi/ja
|
||||
FrameLedger.CaptureHost/ # UNSHIPPED, and since P2 PR-C (2026-09-09) a THIN SHELL: verbs,
|
||||
# the operator disclosure, the report consumer, and the composition
|
||||
# of Application.Capture.CaptureSession over Infrastructure's
|
||||
# adapters — the loop itself no longer lives here. Its consent
|
||||
# store is SQLite (PR-B) over its OWN ledger.db beside the binary,
|
||||
# never the Agent's (D5). 12_BUILD publishes App and Agent ONLY,
|
||||
# and neither references this — tools/package-closure-check.ps1
|
||||
# keeps that true. §S27 was closed on that basis and is RESTATED
|
||||
# there: the consent adapter AND the loop now ship, so packaging
|
||||
# is not what holds rule 1.
|
||||
tests/
|
||||
FrameLedger.Domain.Tests/ FrameLedger.Application.Tests/ FrameLedger.Infrastructure.Tests/
|
||||
FrameLedger.CaptureHost.Tests/ # incl. the Category=Integration end-to-end case
|
||||
@@ -87,15 +126,17 @@ tools/ # changelog-check, chokepoint-check, coverage-gat
|
||||
# rules-validate, vendor-exports, versioninfo-check,
|
||||
# vklayer-blastradius
|
||||
# (PowerShell). This line used to name three, one of which
|
||||
# — resx-audit — does not exist.
|
||||
# — resx-audit — ~~does not exist~~ exists since 2026-09-13 with
|
||||
# resx-gen (the committed Strings.Designer.cs generator).
|
||||
# native tooling lives under src/native/tools:
|
||||
# fl-layout-dump -> struct offsets for the C# mirror test
|
||||
# hook-harness -> dummy D3D11 + D3D12 app (Vulkan/OpenGL unwritten)
|
||||
# hook-harness -> dummy D3D11 + D3D12 + Vulkan + OpenGL app
|
||||
# (--vulkan since #140, --opengl since #141)
|
||||
rules/detection-rules.json # engine/platform/capability + anticheat blocklist
|
||||
docs/ legal/ legal/licenses/
|
||||
```
|
||||
|
||||
Dependency direction unchanged: `App/Agent → Application → Domain`; `Infrastructure` implements `Application` ports; Domain references nothing. **The native layer is reachable only through `Infrastructure`** — no P/Invoke anywhere else.
|
||||
Dependency direction: `App/Agent → Application → Domain`; **`Application → Shared` since 2026-09-09** (P2 PR-A, decision D1 — `Application.Metrics.FrameSampleMapper` is where `FlFrameRecord` becomes Domain's `FrameSample`, and `Application.Capture.CaptureSession`, hosted there since PR-C the same day, is written over the record; `DrainResult` moved to Shared with it); `Infrastructure` implements `Application` ports; Domain references nothing. **The native layer is reachable only through `Infrastructure`** — no P/Invoke anywhere else. **Two facades since 2026-09-10:** `NativeAntiCheatGuard` (required — absent throws) and `NativeNvapiBridge` (optional — absent is a missing telemetry layer that reports itself), both by absolute path beside the assembly through its one `DllImport` resolver, `Infrastructure.Native.BesideThisAssembly`; the runtime allows one resolver per assembly, which is why a third facade claims a name there rather than setting its own.
|
||||
|
||||
## Coding conventions
|
||||
|
||||
@@ -111,7 +152,7 @@ It also asserts **blittability** (`RuntimeHelpers.IsReferenceOrContainsReference
|
||||
|
||||
The version handshake is wired end to end as of 2026-08-05: `FlGuardBuildId` gives the Agent a build id of its own and `ShmHandshakeValidator` performs the refuse-to-attach comparison `07_IPC` specifies (§S23-1). **Its default is `NotEvaluated`, not `Ok`** — a result nobody produced has validated nothing, the same rule `AntiCheatVerdict` follows.
|
||||
|
||||
**Dev mode —** `FL_MOCK=1` is **specified but not implemented** — `grep -rn FL_MOCK src tests tools build.ps1` returns nothing (recorded 2026-08-04). When it exists it runs the whole app with a synthetic frame source and no injection at all, and it is how the UI is meant to be developed; until then, do not plan work on the assumption that it is there. `tools/hook-harness` is a dummy **D3D11 + D3D12** app used to exercise hooks without a real game; Vulkan and OpenGL modes are unwritten (`docs/12_BUILD.md` §Targets is the accurate list).
|
||||
**Dev mode —** `FL_MOCK=1` is **specified but not implemented** — `grep -rn FL_MOCK src tests tools build.ps1` returns nothing (recorded 2026-08-04). When it exists it runs the whole app with a synthetic frame source and no injection at all, and it is how the UI is meant to be developed; until then, do not plan work on the assumption that it is there. `tools/hook-harness` is a dummy **D3D11 + D3D12 + Vulkan + OpenGL** app used to exercise hooks without a real game — `--vulkan` since #140 and `--opengl` since #141 (2026-09-06); this sentence said both were unwritten until 2026-09-09 (`docs/12_BUILD.md` §Targets is the accurate list).
|
||||
|
||||
## Definition of done (per PR)
|
||||
|
||||
|
||||
@@ -54,6 +54,19 @@
|
||||
<SatelliteResourceLanguages>en;vi;ja</SatelliteResourceLanguages>
|
||||
|
||||
<ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
|
||||
|
||||
<!-- ONE version source (P4 PR-5, docs/12_BUILD.md §Version): the VERSION file
|
||||
at the repository root. src/native/CMakeLists.txt reads the same file for
|
||||
the VERSIONINFO blocks, and tools/versioninfo-check.ps1 compares the built
|
||||
binaries against it, so the managed and native halves cannot drift. The
|
||||
condition lets release.yml pass -p:Version=<tag> for a pre-release
|
||||
(0.1.0-beta.1 is not a number CMake's project() accepts, so the native
|
||||
FileVersion stays the numeric core). SourceLink's "+sha" suffix is off so
|
||||
About, Hello and the bug bundle print the version a user can find on the
|
||||
releases page. -->
|
||||
<FrameLedgerVersionFile>$(MSBuildThisFileDirectory)VERSION</FrameLedgerVersionFile>
|
||||
<Version Condition="'$(Version)' == '' And Exists('$(FrameLedgerVersionFile)')">$([System.IO.File]::ReadAllText('$(FrameLedgerVersionFile)').Trim())</Version>
|
||||
<IncludeSourceRevisionInInformationalVersion>false</IncludeSourceRevisionInInformationalVersion>
|
||||
</PropertyGroup>
|
||||
|
||||
<!-- Test projects: documentation comments are noise, and xUnit's own
|
||||
|
||||
+21
-11
@@ -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,24 +56,34 @@
|
||||
</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
|
||||
depended-upon file carries MPL-2.0 Exhibit B. Consume UNMODIFIED. -->
|
||||
<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.12" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup Label="Analyzers (build-time only)">
|
||||
<PackageVersion Include="Roslynator.Analyzers" Version="4.16.0" />
|
||||
<PackageVersion Include="Meziantou.Analyzer" Version="3.0.141" />
|
||||
<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.
|
||||
@@ -91,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>
|
||||
|
||||
|
||||
@@ -39,6 +39,18 @@
|
||||
</None>
|
||||
</ItemGroup>
|
||||
|
||||
<!--
|
||||
THE HARNESS'S LOGS LEAVE WITH THE ASSEMBLY THAT CAUSED THEM. The Overlay logs to the real
|
||||
%LOCALAPPDATA%\FrameLedger\logs by design (§S21), so every TEST project that stages hook-harness
|
||||
compiles tests/Shared/HarnessOverlayLogSweep.cs, an xUnit assembly fixture that removes, when the
|
||||
assembly finishes, the overlay logs of the harness copies it owns (17_HOOK_ENGINE §Native logging).
|
||||
The CaptureHost imports this file too and is not a test project, so it does not get the sweep.
|
||||
tools/test-artifacts-check.ps1 is what makes a missing sweep red.
|
||||
-->
|
||||
<ItemGroup Condition="'$(IsTestProject)' == 'true'">
|
||||
<Compile Include="$(MSBuildThisFileDirectory)tests\Shared\HarnessOverlayLogSweep.cs" Link="Shared\HarnessOverlayLogSweep.cs" />
|
||||
</ItemGroup>
|
||||
|
||||
<!--
|
||||
Warn at build, fail at test. build.ps1 runs the native build first, so by the
|
||||
time this evaluates both exist; a hard error here would break `dotnet build` on
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
<Project>
|
||||
|
||||
<!--
|
||||
Ships FrameLedger.NvapiBridge.dll beside the importing project's output (P2 PR-E2).
|
||||
|
||||
The second P/Invoke facade after the guard's (docs/18_GPU_VENDOR_APIS.md §L3):
|
||||
NativeNvapiBridge loads it BY ABSOLUTE PATH from AppContext.BaseDirectory and
|
||||
never falls back to a search, so it has to actually be there. Read-only, and
|
||||
NEVER loaded into a game — the Agent (and the unshipped capture host) load it
|
||||
into their own process for the 1 Hz telemetry read and the NGX per-process word.
|
||||
|
||||
Imported by exactly three projects, for the same reasons the guard's is:
|
||||
- FrameLedger.Agent — the host of the telemetry stack.
|
||||
- FrameLedger.CaptureHost — the unshipped driver, same stack, own ledger.
|
||||
- FrameLedger.Infrastructure.Tests — NvapiBridgeLayoutTests and the real-hardware
|
||||
case P/Invoke into the real DLL.
|
||||
|
||||
Warn rather than fail when absent: build.ps1 runs the native build first, so by
|
||||
the time this evaluates the DLL exists; a hard error would fail `dotnet build`
|
||||
on a fresh clone for a reason that has nothing to do with the managed code.
|
||||
Unlike the guard, an absent bridge is NOT a safety hole — L3 disables cleanly
|
||||
and the session records `telemetry_source` without `nvapi`.
|
||||
-->
|
||||
<PropertyGroup>
|
||||
<FlNvapiBridgeOutDir>$(MSBuildThisFileDirectory)build\native\x64-release\FrameLedger.NvapiBridge\</FlNvapiBridgeOutDir>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<None Include="$(FlNvapiBridgeOutDir)FrameLedger.NvapiBridge.dll" Condition="Exists('$(FlNvapiBridgeOutDir)FrameLedger.NvapiBridge.dll')">
|
||||
<Link>FrameLedger.NvapiBridge.dll</Link>
|
||||
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
|
||||
</None>
|
||||
</ItemGroup>
|
||||
|
||||
<Target Name="FlWarnOnMissingNvapiBridge" AfterTargets="Build"
|
||||
Condition="!Exists('$(FlNvapiBridgeOutDir)FrameLedger.NvapiBridge.dll')">
|
||||
<Warning Text="FrameLedger.NvapiBridge.dll was not found at $(FlNvapiBridgeOutDir). Run build.ps1 native first; L3 telemetry will report itself unavailable." />
|
||||
</Target>
|
||||
|
||||
</Project>
|
||||
@@ -9,6 +9,8 @@
|
||||
<Project Path="src/FrameLedger.Shared/FrameLedger.Shared.csproj" />
|
||||
</Folder>
|
||||
<Folder Name="/tests/">
|
||||
<Project Path="tests/FrameLedger.Agent.Tests/FrameLedger.Agent.Tests.csproj" />
|
||||
<Project Path="tests/FrameLedger.App.Tests/FrameLedger.App.Tests.csproj" />
|
||||
<Project Path="tests/FrameLedger.Application.Tests/FrameLedger.Application.Tests.csproj" />
|
||||
<Project Path="tests/FrameLedger.CaptureHost.Tests/FrameLedger.CaptureHost.Tests.csproj" />
|
||||
<Project Path="tests/FrameLedger.Domain.Tests/FrameLedger.Domain.Tests.csproj" />
|
||||
|
||||
@@ -4,36 +4,85 @@
|
||||
|
||||
> No telemetry. No accounts. All data stays on your machine.
|
||||
|
||||
> ⚠ **Accuracy note — 2026-08-05. This README describes the finished product; the software
|
||||
> is pre-alpha and most of what follows is not built yet.** Added because every other
|
||||
> user-facing document here carries such a note and this one — the first thing anyone
|
||||
> reads — carried none, while `legal/DISCLAIMER.md` had already been through two rounds of
|
||||
> exactly this correction.
|
||||
<!-- accuracy-block:begin -->
|
||||
> ⚠ **What FrameLedger actually measures today — 2026-09-21.** The software is a beta; its latest
|
||||
> **pre-release is `0.1.0-beta.4`** (2026-09-21), 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 (or,
|
||||
> for a game whose guard bypass you turned on yourself, past your own acceptance of that risk), and
|
||||
> stores sessions in a local database. What that path measures:
|
||||
>
|
||||
> **What actually works today:** frame boundaries, frame times and output resolution, from
|
||||
> a Direct3D 11/12 present hook, written into shared memory and read back by the Agent's
|
||||
> ring reader. Plus, for titles that go through NVIDIA Streamline, **which upscaler is
|
||||
> executing** and **whether Ray Reconstruction is running with it** — identity only, not the
|
||||
> quality preset and not the render resolution. The anti-cheat guard runs all of its
|
||||
> pre-injection checks and refuses.
|
||||
> - **Frame times and output resolution:** measured from the present call for Direct3D 11/12 and
|
||||
> OpenGL titles FrameLedger injects into. Vulkan titles are measured only when FrameLedger itself
|
||||
> starts the game with its Vulkan layer enabled, which today only the Agent's command-line launch
|
||||
> does. A Vulkan title started any other way is not observed by the layer; FrameLedger injects its
|
||||
> Direct3D component into it instead, and what that records on a Vulkan title has not been
|
||||
> verified. Direct3D 9 and every 32-bit title are not measured.
|
||||
> - **Which upscaler is running:** measured from the API a Direct3D title calls — DLSS or NIS through
|
||||
> NVIDIA Streamline (with Ray Reconstruction Yes/No), and FSR through AMD's shipped FidelityFX DLLs:
|
||||
> named FSR 3 from the older DLLs, and FSR without a version from the newer ones, which host both
|
||||
> FSR 3.1 and FSR 4. FSR 2, and FSR shipped any other way, is not identified. For DLSS titles that
|
||||
> bypass Streamline, the NVIDIA driver's own per-process record is stored with the session, labelled
|
||||
> *driver-reported*; the app does not display it yet. Intel XeSS is **not** read (its SDK licence
|
||||
> 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
|
||||
> DLSS options a Streamline title passes with its per-frame call — has not been seen on a real
|
||||
> title, and AMD's per-frame call carries no preset.
|
||||
> - **Render → output resolution:** measured where the vendor's own per-frame call carries the render
|
||||
> size (AMD FidelityFX dispatches, and Streamline titles whose resource tags state it); `N/A` where it
|
||||
> does not: DLSS titles that bypass Streamline, Streamline titles whose tags carry no size, and Vulkan
|
||||
> and OpenGL titles.
|
||||
> - **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. 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.
|
||||
> - **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.
|
||||
> - **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), 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 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 one override, and only one:** a per-game
|
||||
> "bypass the anti-cheat guard" switch, off by default, that you can turn on only by accepting its own
|
||||
> warning (a tick and a typed word). With it on, FrameLedger injects into that game even where the
|
||||
> checks find anti-cheat, the 30 s re-check no longer stops the capture for that finding, and every
|
||||
> session started that way is marked. It never changes HOW FrameLedger injects: nothing is hidden.
|
||||
>
|
||||
> **What does not yet exist**, and is written above in the present tense: every bullet
|
||||
> under *What makes it different* except output resolution and upscaler identity — no
|
||||
> quality preset, render resolution, frame generation, ray tracing, VRAM, shader-stutter or
|
||||
> Reflex hook has been written. The capture side says so in its own data rather than defaulting to "none"
|
||||
> (`docs/03_METRICS.md`, CLAUDE.md rules 6 and 7). There is also no storage, no charts, no
|
||||
> library import, no UI and no installer.
|
||||
>
|
||||
> The two rows that describe **safety behaviour** are qualified where they sit, rather than
|
||||
> here, because that is where a reader checking their own risk will look.
|
||||
> 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
|
||||
> yours. The software never substitutes an estimate.
|
||||
<!-- accuracy-block:end -->
|
||||
|
||||
> The rows below that describe **safety behaviour** are qualified where they sit, rather than
|
||||
> here, because that is where a reader checking their own risk will look. What this README
|
||||
> describes beyond the block above is the finished product; the block is what exists.
|
||||
|
||||
## What makes it different
|
||||
|
||||
Most tools tell you your frame rate. FrameLedger tells you **what produced that frame rate**:
|
||||
|
||||
- **Real render resolution vs output resolution** — the actual internal resolution, not the one in the settings menu.
|
||||
- **Which upscaler is running, at which quality preset** — DLSS / FSR / XeSS, read from the API the game calls, not guessed from files on disk.
|
||||
- **Frame Generation, measured** — native and generated frames counted separately. Always shown as `62 → 118 FPS (×1.9 FG)`, never as one inflated number.
|
||||
- **Which upscaler is running** — DLSS / FSR, read from the API the game calls, not guessed from files on disk. Intel XeSS is not read: its SDK licence forbids it.
|
||||
- **Frame Generation, measured** — native and generated frames counted separately. Shown as `62 → 118 FPS (×1.9 FG)` when both are counted, and as a qualified Presented FPS when they are not — never as one inflated number.
|
||||
- **Ray tracing, actually detected** — including inline ray tracing (DXR 1.1 `RayQuery`), which frame-counting tools miss entirely.
|
||||
- **Per-process VRAM** and whether the driver was exceeding its budget (a real stutter explanation).
|
||||
- **Shader-compilation stutter attribution** — which frame spikes were pipeline compiles.
|
||||
@@ -43,7 +92,7 @@ Plus the usual: Avg / Min / Max / Median FPS, 1% Low, 0.1% Low, frametime distri
|
||||
|
||||
## How it works — and the trade-off, stated plainly
|
||||
|
||||
None of the settings data above is visible from outside a game process. To read it, FrameLedger loads a component into the game and observes the calls the game makes to graphics APIs — the same class of technique used by frame-rate overlays, recording software, and post-processing injectors. Vulkan titles use a standard Vulkan layer instead.
|
||||
None of the settings data above is visible from outside a game process. To read it, FrameLedger loads a component into the game and observes the calls the game makes to graphics APIs — the same class of technique used by frame-rate overlays, recording software, and post-processing injectors. Vulkan titles use a standard Vulkan layer instead, when FrameLedger starts them.
|
||||
|
||||
**That carries a real risk: anti-cheat systems can detect injected code and may ban accounts.**
|
||||
|
||||
@@ -52,7 +101,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>⚠ **Half of this is built.** The *pre-injection* refusal is real and runs every documented check. The **in-session re-scan does not run at all**: 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 — but nothing yet drives the scanner during a session, so nothing ever tells it. `legal/DISCLAIMER.md` §2 states this in full. The Vulkan layer additionally intercepts nothing yet, so there is no Vulkan capture to stop. |
|
||||
| **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. |
|
||||
| **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 |
|
||||
@@ -79,31 +128,31 @@ The tier is recorded on every session and shown in the UI. Metrics unavailable a
|
||||
| `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, 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 — see the block above), and attaching to games that themselves run elevated. ~~and the Tier-2 ETW fallback. If you expect to rely on Tier 2, run the Agent elevated.~~ — there is no ETW fallback to rely on.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Windows 10 (22H2) or Windows 11, 64-bit
|
||||
- A 64-bit DirectX 11/12, Vulkan, or OpenGL game for full (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 (GPU telemetry works without it, through your graphics driver's own libraries)
|
||||
- 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, 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
|
||||
|
||||
1. Download the latest `FrameLedger-win-Setup.exe` from [Releases](https://github.com/poli0981/frameledger/releases).
|
||||
> **The latest pre-release is `v0.1.0-beta.4` (2026-09-21); before it `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**.
|
||||
3. Follow the first-run Legal Gate and Agent setup. Nothing is injected until you enable it for a specific game.
|
||||
|
||||
## 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 none of them.** The rules feed in particular does not exist — the blocklist ships with the build and updates only when you install a new one (`docs/20_OPEN_QUESTIONS.md` §S20). Listing a fetch that has no code is over-disclosure, and this document was already corrected once for describing a weekly outbound request the software never made.
|
||||
Everything lives locally in `%LOCALAPPDATA%\FrameLedger`. The only network calls FrameLedger makes are **the update check** — a few seconds after launch unless you turn it off in Settings ▸ Updates, and when you choose Help ▸ Check for updates — and **the download of an update you accepted**; both go to GitHub Releases, from an installed copy only, and nothing is applied until you restart (never while a game is hooked). There is no other request: the anti-cheat blocklist and the detection rules ship with the build and update only when you install a new one (`docs/20_OPEN_QUESTIONS.md` §S20), and nothing is looked up on any store. Bug reports are always built locally, shown to you, and submitted by you. Full policy: [`legal/PRIVACY_POLICY.md`](legal/PRIVACY_POLICY.md) — version 2.2 removed the three rows (a rules feed twice over, a Steam lookup) that earlier versions listed for requests the software never made.
|
||||
|
||||
## License
|
||||
|
||||
GPL-3.0-only. See `LICENSE`. Third-party components: [`legal/THIRD_PARTY_NOTICES.md`](legal/THIRD_PARTY_NOTICES.md).
|
||||
|
||||
GPU telemetry is layered so the project never depends on a proprietary vendor licence: a vendor-neutral DXGI/performance-counter baseline, LibreHardwareMonitor (MPL-2.0) for sensors on all vendors, and NVIDIA's NVAPI SDK (MIT) for NVIDIA-only extras such as Reflex latency. No Intel or AMD GPU *telemetry* SDK is bundled — see `docs/18_GPU_VENDOR_APIS.md` for why. The one AMD component in the tree is five MIT headers from the FidelityFX SDK, used for types only so the upscaler hook can read an FSR title's own dispatch descriptor; nothing AMD-built is linked or redistributed.
|
||||
GPU telemetry is layered so the project never depends on a proprietary vendor licence: a vendor-neutral DXGI/performance-counter baseline, LibreHardwareMonitor (MPL-2.0) for sensors on all vendors, and NVIDIA's NVAPI SDK (MIT) for NVIDIA-only extras (telemetry and the driver's DLSS record today; Reflex latency is not read yet). No Intel or AMD GPU *telemetry* SDK is bundled — see `docs/18_GPU_VENDOR_APIS.md` for why. The one AMD component in the tree is five MIT headers from the FidelityFX SDK, used for types only so the upscaler hook can read an FSR title's own dispatch descriptor; nothing AMD-built is linked or redistributed.
|
||||
|
||||
## Documentation
|
||||
|
||||
@@ -111,10 +160,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). Four 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.
|
||||
+49
@@ -0,0 +1,49 @@
|
||||
# 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 bypass is a feature, not a vulnerability
|
||||
|
||||
Since 0.1.0-beta.3 a user can overrule the anti-cheat guard for one game through a disclosure they must accept by two
|
||||
separate acts (`docs/19_SAFETY_AND_ANTICHEAT.md` §The user's bypass). That is documented behaviour. What IS a security
|
||||
report: any way to reach an injection past the guard WITHOUT that disclosure having been accepted for that game — a
|
||||
flag, a setting, a crafted rules file, a pipe message, a database edit the Agent then honours without the stamp's
|
||||
version — or any session that ran under the bypass and is not marked as such.
|
||||
|
||||
## 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.
|
||||
@@ -29,18 +29,18 @@ param(
|
||||
# Excludes tests traited Category=Integration -- today, the drain end-to-end
|
||||
# cases, which inject the Overlay into hook-harness.
|
||||
#
|
||||
# CI PASSES THIS AND A DEVELOPER MUST NOT. The reason is a MEASURED property of
|
||||
# the hard gate, not flakiness: §S16 puts the injecting process's ancestors in
|
||||
# the scan set, so the test host is scanned, and a .NET host can load
|
||||
# System.Security.Cryptography.ProtectedData.dll -- which contains the
|
||||
# heuristic fragment `protect`. The guard then refuses our own harness with
|
||||
# SuspiciousUnsigned. That is the gate working exactly as specified;
|
||||
# 20_OPEN_QUESTIONS §S19(b) is the defect, and it is a guard change with its
|
||||
# own PR rather than something to paper over here.
|
||||
# NOBODY PASSES THIS ANY MORE, and it is kept so that the day someone must, the
|
||||
# skip is loud. CI passed it from 2026-08-05 to 2026-09-06 for a MEASURED reason:
|
||||
# §S16 puts the injecting process's ancestors in the scan set, a .NET test host
|
||||
# loads System.Security.Cryptography.ProtectedData.dll (heuristic fragment
|
||||
# `protect`), and the guard refused our own harness with SuspiciousUnsigned.
|
||||
# 20_OPEN_QUESTIONS §S19(b)'s signer half now verifies that module's embedded
|
||||
# signature offline (O=Microsoft Corporation, on the compiled-in bound), so the
|
||||
# refusal is gone for the reason the heuristic always stated, and CI runs
|
||||
# `./build.ps1 check` with no switches — the same command a developer runs.
|
||||
#
|
||||
# It skips LOUDLY, because a suite that quietly stops running one class is how
|
||||
# a gate rots. Whatever CI does, `./build.ps1 check` with no switches runs
|
||||
# everything.
|
||||
# a gate rots.
|
||||
[switch]$SkipIntegration
|
||||
)
|
||||
|
||||
@@ -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
|
||||
@@ -387,6 +406,9 @@ function Invoke-ProjectGates {
|
||||
Write-Step 'license-check'
|
||||
$licenseTool = Join-Path $repo 'tools/license-check.ps1'
|
||||
if (Test-Path $licenseTool) {
|
||||
# P4 PR-6: the NuGet half's generator proves itself first (fourteen cases, five that must be RED), then
|
||||
# license-check runs its live -Check over this build's restore output as its section 3.
|
||||
Invoke-Checked 'license-gather (self-test)' { & (Join-Path $repo 'tools/license-gather.ps1') -SelfTest }
|
||||
Invoke-Checked 'license-check' { & $licenseTool }
|
||||
}
|
||||
else {
|
||||
@@ -405,6 +427,18 @@ function Invoke-ProjectGates {
|
||||
# It found a defect in its own filter on its first run: a whitespace-only path
|
||||
# is truthy in PowerShell, so the empty-list refusal was unreachable for that
|
||||
# input.
|
||||
# §S23-6: the accuracy blocks are one text in legal/ACCURACY.md; a copy that
|
||||
# drifted is red. Self-test first, both directions, so the gate is seen to work.
|
||||
Write-Step 'accuracy-check'
|
||||
$accuracyTool = Join-Path $repo 'tools/accuracy-check.ps1'
|
||||
if (Test-Path $accuracyTool) {
|
||||
Invoke-Checked 'accuracy-check (self-test)' { & $accuracyTool -SelfTest }
|
||||
Invoke-Checked 'accuracy-check' { & $accuracyTool }
|
||||
}
|
||||
else {
|
||||
Skip-Gate 'accuracy-check' 'tools/accuracy-check.ps1 not implemented yet'
|
||||
}
|
||||
|
||||
Write-Step 'changelog-check'
|
||||
$changelogTool = Join-Path $repo 'tools/changelog-check.ps1'
|
||||
if (Test-Path $changelogTool) {
|
||||
@@ -414,13 +448,23 @@ function Invoke-ProjectGates {
|
||||
Skip-Gate 'changelog-check' 'tools/changelog-check.ps1 not implemented yet'
|
||||
}
|
||||
|
||||
# The release body's extractor (P4 PR-5, 13_CI_CD §release.yml): self-test only
|
||||
# here — the live pass needs a tag's version and runs in release.yml, where a
|
||||
# missing or empty `## [x.y.z]` section is a red release rather than an empty note.
|
||||
Write-Step 'release-notes'
|
||||
Invoke-Checked 'release-notes (self-test)' { & (Join-Path $repo 'tools/release-notes.ps1') -SelfTest }
|
||||
|
||||
# 09_I18N's gate, built with the first .resx family (P3 PR-2, 2026-09-13): every key in en/vi/ja, ja
|
||||
# Safety_* marked for human review, the generated accessor current. Self-test first (at least four
|
||||
# cases must go red), then the live pass; a tree with no family is red, not skipped.
|
||||
Write-Step 'resx-audit'
|
||||
$resxTool = Join-Path $repo 'tools/resx-audit'
|
||||
$resxTool = Join-Path $repo 'tools/resx-audit.ps1'
|
||||
if (Test-Path $resxTool) {
|
||||
Invoke-Checked 'resx-audit' { & $resxTool }
|
||||
Invoke-Checked 'resx-audit (self-test)' { & $resxTool -SelfTest }
|
||||
Invoke-Checked 'resx-audit' { & $resxTool -Root $repo }
|
||||
}
|
||||
else {
|
||||
Skip-Gate 'resx-audit' 'tools/resx-audit not implemented yet (no .resx files exist)'
|
||||
throw 'resx-audit: tools/resx-audit.ps1 is missing — 09_I18N names it and build.ps1 used to skip it loudly'
|
||||
}
|
||||
|
||||
# The shared-memory struct mirror. CLAUDE.md §Struct mirroring calls this the
|
||||
@@ -463,6 +507,15 @@ function Invoke-ProjectGates {
|
||||
}
|
||||
Write-Host " $($mirrorResults.Count) mirror assertion(s) executed and passed (fl_shm.h vs FrameLedger.Shared)" -ForegroundColor DarkGray
|
||||
|
||||
# Test hygiene (17_HOOK_ENGINE §Native logging). The injection tests use the shipped Overlay, whose log goes to the
|
||||
# real data folder by design (§S21), and 2492 hook-harness logs had piled up there by 2026-09-15. Each test binary
|
||||
# that starts the harness now removes the logs it caused; this is what makes a missing sweep red: a hook-harness
|
||||
# overlay log created since this gate started and still there after the tests fails it. A game's log never counts.
|
||||
Write-Step 'test-artifacts'
|
||||
$artifactsTool = Join-Path $repo 'tools/test-artifacts-check.ps1'
|
||||
Invoke-Checked 'test-artifacts (self-test)' { & $artifactsTool -SelfTest }
|
||||
Invoke-Checked 'test-artifacts' { & $artifactsTool -SinceUtc $script:GateStartedUtc }
|
||||
|
||||
Write-Step 'placeholder guard'
|
||||
# {{RELEASE_DATE}} is substituted at release time and is the only token
|
||||
# allowed to survive. Anything else in a document FR-11 displays for
|
||||
@@ -478,6 +531,8 @@ function Invoke-ProjectGates {
|
||||
|
||||
# --- Entry point ------------------------------------------------------------
|
||||
$sw = [Diagnostics.Stopwatch]::StartNew()
|
||||
# The test-artifacts gate counts only what this run could have written.
|
||||
$script:GateStartedUtc = [DateTime]::UtcNow
|
||||
switch ($Task) {
|
||||
'native' { Invoke-Native $false }
|
||||
'managed' { Invoke-Managed $false }
|
||||
|
||||
@@ -34,6 +34,18 @@
|
||||
> matches a blocklist — two matchers that can disagree is a fail-open by
|
||||
> construction, and a test asserts there is only one (§S15 item 1).
|
||||
|
||||
> **The Agent box exists as of 2026-09-10 (P2 PR-F).** `ProcessWatcher` is `Application.Watch`
|
||||
> (`CaptureOrchestrator` over `ToolhelpProcessSnapshotSource`); `Injector` is the guard facade reached
|
||||
> through `HookedCaptureGate`; `ShmReader` is `CaptureSession` over `ShmRingReader`; `VendorTelemetry` is
|
||||
> the L1 + L2 + L3 composite; `SessionRecorder` is `Application.Recording`. ~~The named pipe on the left
|
||||
> is **not** built (P3, `07_IPC`), so today's Agent has no UI client: `--serve` logs, `--console` prints.~~
|
||||
> **The pipe's read half is built 2026-09-13 (P3 PR-1):** `--serve` listens on `\\.\pipe\FrameLedger.v2`,
|
||||
> answers `Hello` / `GetStatus` / `Ping`, and narrates every session (`SessionStarted` at the attach, `SessionProgress`
|
||||
> at 1 Hz, the safety and error events, `SessionCompleted`); `--console` still prints and hosts no pipe. The
|
||||
> command half — the messages a client sends to change a state — ~~is PR-1b~~ is built the same day (PR-1b:
|
||||
> `SetWatchlist`, `LaunchGame`, `SetHookEnabled` with the pre-scan and no stamp until PR-4, pause/resume,
|
||||
> `StopSession`, `UpdateRules`, `Shutdown`), and the App that connects is PR-2.
|
||||
|
||||
## Why this shape
|
||||
|
||||
- **Hooking in-process is the only way to get the facts we care about.** Render resolution vs output resolution, upscaler identity and quality preset, whether frame generation is actually running, whether rays are actually being traced — none of these are observable from outside the process. The previous ETW-only design could only guess from file/module presence, which measured badly against real games.
|
||||
@@ -66,6 +78,11 @@ watcher sees tracked exe launch
|
||||
|
||||
**Launch mode (preferred when FrameLedger starts the game):** `CreateProcess(CREATE_SUSPENDED)` → guard → inject → `ResumeThread`. This catches swapchain creation and early upscaler init, which attach mode can miss. Attach mode remains for games launched from Steam/GOG directly.
|
||||
|
||||
> **Built 2026-09-06 as start → the guard waits for a presentation runtime → the full guard → inject**
|
||||
> (`FlGuardedInjectWhenReady`, P1 item 2), because a suspended target has loaded nothing for the module
|
||||
> scan to read (`20_OPEN_QUESTIONS` §S1). What it costs is measured by the session itself:
|
||||
> `FlWriterState.dxgiPresentsBeforeHook`. `04_CAPTURE` §Launch mode carries the shape.
|
||||
|
||||
Guard re-runs every 30 s for the life of the session; anti-cheat appearing late ⇒ clean unhook (`19_SAFETY` §During a session).
|
||||
|
||||
## Lifecycle
|
||||
@@ -76,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 |
|
||||
|
||||
+2
-1
@@ -16,6 +16,7 @@ Requirement IDs (`FR-x`, `NFR-x`) are referenced by other docs, commits, and tes
|
||||
- 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.4 Global "disable all hooking" kill switch in Settings; also honored by the Vulkan layer.
|
||||
- FR-2.7 (owner decision 2026-09-21) A per-game **"bypass the anti-cheat guard"** switch, off by default, never global. Turning it on requires its own disclosure — naming the ban risk and that the user carries the entire risk and the developers none — accepted by a ticked acknowledgement AND a typed phrase, stamped by the Agent. It overrules the guard's judgement only (`19_SAFETY` §The user's bypass lists both sides), never changes how FrameLedger injects (CLAUDE.md rule 3), and every session started under it is marked as such permanently.
|
||||
- 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.
|
||||
|
||||
@@ -100,7 +101,7 @@ Draw live FPS/frametime/upscaler info inside the game. Only for games already ho
|
||||
- **NFR-6 Accuracy:** per `03_METRICS` §Accuracy budget, stated per tier.
|
||||
- **NFR-7 Resilience:** power loss loses at most the last 60 s of raw data; DB never corrupts (WAL + transactions); Agent restart recovers `.partial` sessions as `interrupted`.
|
||||
- **NFR-8 OS support:** Windows 10 22H2+ and Windows 11, x64. No ARM64 in v1.
|
||||
- **NFR-9 Accessibility:** full keyboard navigation, adequate contrast in both Fluent themes, Per-Monitor V2 DPI awareness.
|
||||
- **NFR-9 Accessibility:** full keyboard navigation, adequate contrast in both Fluent themes, Per-Monitor V2 DPI awareness. *(What each clause means for this app, and the check that holds it: `08_UI` §Accessibility, P4 PR-8.)*
|
||||
- **NFR-10 Offline-first:** everything except updates and opt-in metadata works with zero connectivity.
|
||||
- **NFR-11 Auditability:** the entire set of hooks is enumerable in `17_HOOK_ENGINE` §Hook inventory and matches the code; a reviewer must be able to verify in minutes that nothing reads game memory.
|
||||
|
||||
|
||||
+179
-6
@@ -1,6 +1,6 @@
|
||||
# 03 — Metrics
|
||||
|
||||
**Single source of truth** for every number FrameLedger displays. Implement in `FrameLedger.Domain.Metrics` with golden tests (`14_TESTING`).
|
||||
**Single source of truth** for every number FrameLedger displays. ~~Implement in `FrameLedger.Domain.Metrics` with golden tests (`14_TESTING`).~~ **Implemented in `FrameLedger.Domain.Metrics` since 2026-09-09 (P2 PR-A), with the goldens `14_TESTING` names:** `FrameTimeSeries` (frame times from QPC, gaps excluded), `Percentile` (linear), `FrameStatistics` (median / lows / min / max / σ with the sufficiency guards), `RollingMedian` + `StutterDetector`, `FgWindow` + `FgRefusal` (the factor and every refusal, as facts — the English lives with the report), `UpscaleExtent`, `SegmentBuilder`, `RtVerdict` / `HdrVerdict` (the tri-states), `VramAggregates` / `LatencyAggregates` / `SeriesAggregates`. They consume `FrameSample` and `WriterFacts` — Domain's own types, since Domain references nothing — and `Application.Metrics.FrameSampleMapper` is the one place a shared-memory record becomes one; the Domain enums are pinned to `FrameLedger.Shared`'s in both directions by `MetricEnumMirrorTests`. The frame-generation LADDER (rung 0 / 1 / 3 / 4 as a verdict, and the withheld `none`) is not yet a Domain type: it is still the capture host's prose in `MeasuredFacts`, and lands with the recorder that stores `fg_mode` (PR-D).
|
||||
|
||||
Every metric declares which **capture tier** it requires (`01_ARCHITECTURE` §Capture tiers). A Tier-2 session simply has `N/A` where Tier-1 data is missing — never a silently degraded estimate presented as fact.
|
||||
|
||||
@@ -27,7 +27,7 @@ Let `D` = session duration (first → last present), `F_app` = frames the *game*
|
||||
| **Native FPS (avg)** | `count(F_app) / D` | 1 |
|
||||
| **Displayed FPS (avg)** | `count(F_disp) / D` | 1 |
|
||||
| **Presented FPS (avg)** | `presents / D` — **numerically Displayed FPS; the name for the one number that stands alone.** "Native" and "Displayed" are printed only *together* (rule 6); when frame generation is not measured, this is the headline, with a mandatory qualifier (§Frame Generation, rung 0's qualifier) | 1 |
|
||||
| **FG factor** | `DisplayedFPS / NativeFPS`, shown `×N.N`; `—` when FG inactive; **`N/A` when FG is not measured** | 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 |
|
||||
@@ -77,6 +77,41 @@ This is the metric the rewrite exists for. Resolution ladder, highest confidence
|
||||
published `presents / tokens` at or below 1.05 over a uniform window (§The source, below).
|
||||
Never from a hook that merely saw nothing (rung 0), and never from the census.
|
||||
|
||||
> ### Displayed may be DXGI-COUNTED — measured 2026-09-05 on Dying Light: The Beast
|
||||
>
|
||||
> `F_disp = presents observed by the hook` (§Counting, below) assumed every present reaches the
|
||||
> `Present` / `Present1` bodies the Overlay inline-patches. On Streamline 2.8.0 with DLSS Frame
|
||||
> Generation ×4 it does not: the hook timed 4,392 presents while `IDXGISwapChain::GetLastPresentCount`,
|
||||
> read on the same chain at every hooked present, moved by 17,133 — **2.90 unseen presents per hooked
|
||||
> one** (2.95 on the second capture) — against **0.00** on Streamline 2.7.3 (Hell Is Us, ×3.86) and
|
||||
> 2.10.3 (the Onimusha demo, ×3.67), where the generated presents come through the patched bodies. So
|
||||
> the record carries `dxgiUnseen` (@52, under `FL_MEASURED_DXGI_PRESENTS`) and the consumer's window
|
||||
> counts
|
||||
>
|
||||
> ```
|
||||
> F_disp = hooked presents + Σ dxgiUnseen (DXGI-COUNTED when the sum is > 0)
|
||||
> ```
|
||||
>
|
||||
> **When the sum is above zero the report says so on its own line — "Displayed is DXGI-COUNTED" —
|
||||
> because the number is then a count DXGI made, on the hooked chain, of presents this hook never
|
||||
> timed.** It may stand in the rule-6 trio and in `presents/batch`; it may NOT stand in a frame-time
|
||||
> distribution, which has no timestamps for those presents. The uniformity buckets take the same
|
||||
> numerator, so a session whose pacer stopped mid-way refuses exactly as one whose tokens stopped. A
|
||||
> saturated byte (255) is refused like a saturated `fgEvaluations`, and a present the hook saw and
|
||||
> declined (a paused session) is not unseen — the resume's first record differences nothing.
|
||||
>
|
||||
> **Landed 2026-09-06 (`spike-notes` §9): `Native FPS: 70.52 -> Displayed FPS: 282.08 (x4 FG) over 16516
|
||||
> present(s)` on Dying Light: The Beast, 12,387 of them DXGI-counted, `frame generation: DlssG`** — the
|
||||
> rule-6 trio on the title that could not print it. **And the counter decides `none` on that shape.**
|
||||
> Leg 0 the same morning (frame generation off, twice) read presents = tokens with `unseen=0` over 3,659
|
||||
> and 4,519 samples, census unchanged (`sl.dlss_g.dll` is a startup-time load), so the withheld gate is
|
||||
> narrowed rather than withdrawn: a counted `none` beside a READ counter with zero unseen prints as
|
||||
> `none` with DXGI's agreement on the line; only a session where the counter was not read withholds.
|
||||
> A writer state that counted unseen presents the records do not carry is a contradiction and is
|
||||
> refused as neither. `20_OPEN_QUESTIONS` §H5 keeps the
|
||||
> rows this landed on; which body the 2.8.0 pacer presents through is unlocalised and does not need
|
||||
> to be for the count.
|
||||
>
|
||||
> **RUNG 2 IS CONDITIONAL ON THE VENDOR, measured 2026-08-20, and this list read as
|
||||
> though it were not.** `--track_frame_type` is a **beta** option in PresentMon 2.5.1
|
||||
> and its own help says it *"requires application and/or driver instrumentation using
|
||||
@@ -234,8 +269,42 @@ F_app = Σ fgEvaluations (APPLICATION frames, counted at the
|
||||
> Streamline batch is an application frame on that title — with a second count rather than an
|
||||
> oracle.
|
||||
>
|
||||
> **And one shape on which the counted `none` is WITHHELD, measured 2026-09-04/05.** Dying Light:
|
||||
> The Beast ships Streamline **2.8.0**; five captures at DLSS with DLSS Frame Generation ON read
|
||||
> `presents = tokens` (1.00), and the owner's reading settled it: the title runs at ×4, the frames
|
||||
> this hook records are the native ones, the generated presents never reach the `Present` bodies
|
||||
> the Overlay patches (`20_OPEN_QUESTIONS` §H5 case 3). On that shape the count is right about the
|
||||
> application frames and wrong about the presents, and a `none` computed from it is the affirmative
|
||||
> negative this document forbids. So the consumer withholds `none` — and prints **Presented FPS** with
|
||||
> a qualifier saying the number counts *application* frames and the Displayed rate is unknown — when
|
||||
> `sl.dlss_g.dll` is in the census beside an interposer whose **file version** (read out of process by
|
||||
> the capture host, never by the hook) is ≥ 2.8.0 or unreadable. **The key is the Streamline plugin,
|
||||
> not `nvngx_dlssg.dll`:** every validated `none` above has the NGX module loaded and the plugin bit
|
||||
> clear, so the gate leaves each of them byte-identical. It is interim: §H5 pre-commits the session
|
||||
> that keeps, narrows or withdraws it.
|
||||
>
|
||||
> **What `fgMode` still is.** Identity — `DLSS_G` when a `kFeatureDLSS_G` evaluation drained,
|
||||
> `UNKNOWN` otherwise — from the evaluate detour, unchanged. A factor ≥ 1.5 with `UNKNOWN`
|
||||
> `UNKNOWN` otherwise — from the evaluate detour, unchanged. **And since 2026-09-05, `DLSS_G` when the
|
||||
> present drained a HUD-less or UI tag** (`kBufferTypeHUDLessColor`, `kBufferTypeUIColorAndAlpha`,
|
||||
> `kBufferTypeUIAlpha`) on any of the three tag routes the Overlay already hooks: Streamline's DLSS-G
|
||||
> programming guide §5.0 requires a title running frame generation to tag those buffers every frame, and
|
||||
> nothing else a title evaluates through Streamline that generates frames consumes them. Read off the
|
||||
> argument of an API already hooked (rule 4), zero new hooks — the identity `kFeatureDLSS_G` evaluations
|
||||
> were supposed to give and gave on no measured title. **Identity only.** A title may tag the inputs with
|
||||
> frame generation switched off in its menu, so the consumer's rule is: **the count decides `none`,
|
||||
> identity decides the name** — an active count beside the mark prints `DlssG`; a counted 1.0 beside it
|
||||
> prints `none` with the inputs noted; the withheld shape (§H5) keeps its N/A with the tags reported in
|
||||
> the census line — narrowed 2026-09-06 to sessions where DXGI's counter was not read (§Displayed may be
|
||||
> DXGI-COUNTED). `FsrFg` keeps precedence over the count, because a drained FRAMEGENERATION dispatch
|
||||
> is a generated batch. `FlWriterState.slTagCensus` carries which types arrived on which route for the
|
||||
> session (`fl_shm.h` §slTagCensus).
|
||||
>
|
||||
> **Refused, with the reason written:** `slDLSSGGetState`, the API the DLSS-G guide §14.0 names for
|
||||
> "the actual number of frames presented". Its `numFramesActuallyPresented` is *"the number of frames
|
||||
> presented since the last `slDLSSGGetState` call"* — the call RESETS the plugin's counter, so a
|
||||
> measurement tool calling it would corrupt the very number a title reads for its own FPS display; and
|
||||
> `sl_dlss_g.h` marks it *"NOT thread safe"*. Observing is the whole posture; a query with a side
|
||||
> effect on the host is not observing. A factor ≥ 1.5 with `UNKNOWN`
|
||||
> identity is *frame generation active, technology not identified*, which on a UE5 title with
|
||||
> both Streamline and FidelityFX loaded is the honest answer.
|
||||
|
||||
@@ -269,8 +338,13 @@ F_app = Σ fgEvaluations (APPLICATION frames, counted at the
|
||||
> the first** is 7c's own rule, and this is it.
|
||||
>
|
||||
> The acceptance table for the owner's three launches is pre-committed in `20_OPEN_QUESTIONS` §H11.
|
||||
> What this route does NOT reach: the FSR 3.0 host DLLs (`ffx_fsr3_x64.dll`, named exports, deferred
|
||||
> to their own PR), statically linked FSR (§Scope decisions), and Intel (closed at the census).
|
||||
> What this route does NOT reach: statically linked FSR (§Scope decisions) and Intel (closed at the
|
||||
> census). **The FSR 3.0 host DLL is reached since 2026-09-05** — a fifth AMD target,
|
||||
> `ffx_fsr3_x64.dll!ffxFsr3ContextDispatchUpscale` (Cyberpunk 2077's copy; named export, its own
|
||||
> descriptor, tag `fsr3-v3.0.4`), whose UPSCALE feeds the same drain word: identity `FSR3` as a
|
||||
> fact, `renderSize` as the extent, and the count from its upscales when neither Streamline nor a
|
||||
> PREPARE has ever spoken. On Cyberpunk the count stays Streamline's and `FsrFg` stays the
|
||||
> monolith's; the host adds the identity the leaf-only build printed as `N/A`.
|
||||
|
||||
> **MEASURED 2026-08-15, AND IT CHANGES WHAT THIS SECTION CAN PROMISE.** On the one title
|
||||
> measured — Cyberpunk 2077, SL 2.7.1 — `slEvaluateFeature(kFeatureDLSS_G)` is **never
|
||||
@@ -295,6 +369,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
|
||||
@@ -349,6 +453,22 @@ rung identified the mode — only the *identification* comes from the ladder.
|
||||
|
||||
**Display rule (product requirement, CLAUDE.md rule 6):** wherever FPS appears and FG is active, render `"{native} → {displayed} FPS (×{factor} FG)"`. Cards show Native large, Displayed + factor secondary. Charts default to Native with a Displayed toggle. Exports contain all three.
|
||||
|
||||
**Rung 3's line carries its exclusions (2026-09-06, `HANDOFF` 7b / §H11).** `Active (technology not
|
||||
identified)` is printed *by elimination among what this session saw*: not DLSS-G when the NVIDIA
|
||||
driver's FG word reports no feature created and no HUD-less / UI tag was sent (or "not excluded"
|
||||
when the driver did not answer); no FSR frame-generation dispatch reached a hooked module; the
|
||||
frame-generation runtime modules the census names, or that none is loaded; and the vendor SDK
|
||||
strings the executable FILE carries. Never a vendor named as measured — XeFG cannot be hooked or
|
||||
declared (licence), a compiled-in FSR 3 has no module — and the line says a frame generator compiled
|
||||
into the executable would read the same.
|
||||
|
||||
**And the census's "cannot include generated frames" is now second-witnessed by the executable
|
||||
file (2026-09-06).** A frame generator compiled into the exe loads no module (Rune Factory, Wukong),
|
||||
so the capture host scans the executable on disk for the SDK strings (`ffxFsr3`,
|
||||
`ffxFrameInterpolation`, `xefgSwapChain`, and the non-FG ones for the reader) and the clear-census
|
||||
qualifier reads *MAY include generated frames* when a frame-generation-capable marker is in the
|
||||
file. A marker is code or a symbol name in the file, never proof it ran, and never an identity.
|
||||
|
||||
**And when FG is not measured (2026-09-03):** render the one number as **Presented FPS** —
|
||||
`144 FPS` with a qualifier chip chosen by the census above, never the word "Native", never
|
||||
a factor, never `—` (which means `none`, a measured negative). The chip is muted when no
|
||||
@@ -370,6 +490,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
|
||||
@@ -393,6 +519,51 @@ From the upscaler hooks we get, per frame:
|
||||
|
||||
Tier 2 has none of this: `upscaler = unknown`, ratio `N/A`.
|
||||
|
||||
> ### The driver-reported rung — owner decision 2026-09-06, identity only
|
||||
>
|
||||
> Three NGX-direct titles (Lies of P, Hell Is Us, Expedition 33) evaluate DLSS super resolution through
|
||||
> a path no hook of this build sees, and printed `upscaler: N/A` on every capture. The NVIDIA driver
|
||||
> keeps per-process bookkeeping of the feature — `NvAPI_NGX_GetNGXOverrideState` (R570+, MIT NVAPI,
|
||||
> `18_GPU_VENDOR_APIS` L3) returns a feedback word per feature — and **measured 2026-09-06 (driver
|
||||
> 616.64) its `CREATED | EVALUATE` bits are set for a process with NO NVIDIA-app override** on both
|
||||
> no-override titles (`20_OPEN_QUESTIONS` §H5). So the capture host probes it out of process beside
|
||||
> each module snapshot (in-process through `FrameLedger.NvapiBridge.dll` since 2026-09-10, P2 PR-E2;
|
||||
> `fl-probe-nvapi --ngx-state <pid>` spawned before that — no injection, no consent either way), and the
|
||||
> `upscaler:` line has a rung between the hooks and `N/A`:
|
||||
>
|
||||
> ```
|
||||
> upscaler: Dlss (driver-reported: the NVIDIA driver reports an NGX super-resolution feature created
|
||||
> and evaluated in this process - not counted by this hook)
|
||||
> ```
|
||||
>
|
||||
> **What it may claim: the vendor and the feature, attributed to the driver.** What it may NOT claim,
|
||||
> each one measured: a quality (`performanceMode` / `renderPreset` are populated only under an
|
||||
> NVIDIA-app override and are then the OVERRIDE's values), a ratio or render size (`scalingRatio` is
|
||||
> 0 even under the override), a frame-generation multiplier (`FG_MODE` / `FG_MULTI_FRAME` stay clear
|
||||
> and `frameGenerationCount` is 0 at ×4 — it is the override target). **Corrected the same day, on the
|
||||
> loop's own readings:** the FG word DOES follow DLSS-G once the feature exists — `CREATED | EVALUATE`
|
||||
> on Hell Is Us, Onimusha and DL:TB at ×4, the word CHANGING between the session's readings; the
|
||||
> morning's `INITIALIZED | DLL_EXISTS` was read before creation. So the FG word is a second witness
|
||||
> for the DLSS-G IDENTITY, printed beside `frame generation:` as agreement or a printed disagreement,
|
||||
> and promoted to `DlssG (driver-reported: …)` only where the count is active and no tag named the
|
||||
> technology. The COUNT is never the driver's. A hook's name always outranks it, and
|
||||
> beside a hook's name the driver's word is printed as agreement, or as a disagreement *printed rather
|
||||
> 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
|
||||
|
||||
Tri-state `Yes | No | N/A` per session with `source` (`measured | manual | inherited`).
|
||||
@@ -497,7 +668,9 @@ Per session over 1 Hz samples: `avg` (mean of non-null), `max`. Sensor timeline
|
||||
| Per-process VRAM | exact | not available |
|
||||
| PC latency | as reported by Reflex | not available |
|
||||
| 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.
|
||||
|
||||
|
||||
+181
-7
@@ -4,19 +4,52 @@ The Agent decides *whether* to capture, *how* (tier), starts it, drains data, an
|
||||
|
||||
## Frame source abstraction (retained from the ETW design — and now with ONE implementation, which is the point)
|
||||
|
||||
```csharp
|
||||
~~```csharp
|
||||
public interface IFrameSource : IAsyncDisposable
|
||||
{
|
||||
CaptureTier Tier { get; }
|
||||
IAsyncEnumerable<FrameEvent> StreamAsync(CaptureTarget target, CancellationToken ct);
|
||||
}
|
||||
```
|
||||
```~~
|
||||
|
||||
> **Never written, and replaced rather than built — 2026-09-09 (P2 PR-C).** No `IFrameSource`,
|
||||
> `FrameEvent` or `IAsyncEnumerable` stream ever existed in a `.cs` file; what ran every hooked
|
||||
> session since 2026-08-06 is a *loop over a sink*, and that is the shape promoted into the
|
||||
> shipped assemblies:
|
||||
>
|
||||
> ```csharp
|
||||
> public interface ICaptureSink : IDisposable // Application.Capture — what the loop needs from the ring
|
||||
> {
|
||||
> FlWriterState WriterState { get; } FlShmHandshake Handshake { get; }
|
||||
> long TotalDropped { get; } long TotalGaps { get; }
|
||||
> DrainResult Drain(Span<FlFrameRecord> into, IList<ulong> gapIndices);
|
||||
> void PublishGuardResult(uint completedEvaluations, bool unhookRequested);
|
||||
> void SetPaused(bool paused); void RequestLogFlush();
|
||||
> }
|
||||
> public sealed class CaptureSession(...) // the loop: gate → inject → attach → drain, until something ends it
|
||||
> {
|
||||
> Task<CaptureOutcome> RunAsync(normalisedExePath, observed, payloadPath, ct); // attach mode
|
||||
> Task<CaptureOutcome> RunLaunchedAsync(normalisedExePath, observed, payloadPath, args, ct); // launch mode
|
||||
> }
|
||||
> ```
|
||||
>
|
||||
> `CaptureSession` takes ports, not delegates, so the Agent's composition root supplies the
|
||||
> adapters: `IRingAttacher` (`Infrastructure.Capture.ShmRingAttacher` over `ShmRingReader.TryAttach`
|
||||
> 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
|
||||
> (`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.
|
||||
> `MockFrameSource` / `FL_MOCK=1` remains specified and unwritten (CLAUDE.md §Dev mode); when it
|
||||
> exists it is a second `ICaptureSink`, not a second loop.
|
||||
|
||||
| Implementation | Tier | Notes |
|
||||
|---|---|---|
|
||||
| `HookedFrameSource` | 1 | Injects (or relies on the Vulkan layer), maps the ring, drains at 10 Hz |
|
||||
| ~~`HookedFrameSource`~~ `CaptureSession` + `ShmCaptureSink` | 1 | Injects (or relies on the Vulkan layer), attaches to the ring, drains at 10 Hz under the 30 s re-scan |
|
||||
| ~~`EtwFrameSource`~~ | — | **Deleted from the design, 2026-08-28.** Tier 2 is not a frame source: it produces no frames. PresentMon was dropped (§S31 row P2), no mechanism replaced it (§G), and a port with no adapter on a tier that measures nothing is a row that only invites someone to implement it. The interface keeps its shape for `MockFrameSource` and for whatever Vulkan needs |
|
||||
| `MockFrameSource` | dev | Synthetic frames incl. simulated FG/upscaler/RT records; `FL_MOCK=1` |
|
||||
| `MockFrameSource` | dev | Synthetic frames incl. simulated FG/upscaler/RT records; `FL_MOCK=1` — unwritten; would be a second `ICaptureSink` |
|
||||
|
||||
Tier selection per launch:
|
||||
|
||||
@@ -73,10 +106,65 @@ which makes the notification more important than it was, not less.
|
||||
- Watchlist match on normalized full path (`GetFinalPathNameByHandle` — junctions/symlinks), filename fallback with a stale-path warning badge.
|
||||
- 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`
|
||||
> (`Infrastructure.Watch`) takes the 1 Hz snapshot — pid, parent pid and image name from
|
||||
> `CreateToolhelp32Snapshot`; the full image path (normalised the way a consent record's is) and the creation
|
||||
> time through a `PROCESS_QUERY_LIMITED_INFORMATION` handle, and a process that refuses even that is listed with
|
||||
> 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
|
||||
> 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
|
||||
> at a time through `ISessionRecorder`, attach mode only; it decides nothing about hooking, the recorder's loop
|
||||
> reaches the gate exactly as a console verb does. `WatcherHostedService` runs `PartialRecovery` first, every
|
||||
> start, then the orchestrator. There is no `Channel` and no second consumer: `PollOnceAsync` is the only writer
|
||||
> of the running-session table, and the sessions run on their own tasks. **Since P4 PR-1 (2026-09-14) a second
|
||||
> hosted service runs beside it under `--serve`: `DetectionHostedService`, the static detection sweep
|
||||
> (`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.**
|
||||
|
||||
## 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.
|
||||
|
||||
> **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
|
||||
> cannot run before the loader has. The built order is **start → the guard WAITS → inject**: the host
|
||||
> starts the consented executable (`ProcessLauncher`: working directory beside the exe,
|
||||
> `FRAMELEDGER_ENABLE_VK_LAYER=1` in its environment for the Vulkan layer, the handle held from birth so
|
||||
> the pid cannot recycle), then asks the guard through its new waiting entry, `FlGuardedInjectWhenReady`,
|
||||
> which polls the loader every 50 ms — through the module seam, matching **no** blocklist — until
|
||||
> `dxgi.dll` with `d3d11.dll` or `d3d12.dll`, or `opengl32.dll`, or `vulkan-1.dll` is mapped, and *then*
|
||||
> runs every check and injects exactly as attach mode does. The poll decides **when** the full scan runs,
|
||||
> never whether it passes. **Vulkan wins over a D3D or OpenGL runtime beside it, and since 2026-09-10 over
|
||||
> one mapped a poll ahead of it:** a static D3D/OpenGL import is in the module list from the first
|
||||
> instruction while a Vulkan title's loader arrives milliseconds later, so the guard reads once more, one
|
||||
> interval later, before it commits to the injecting branch (measured on the harness's own `--vulkan` mode
|
||||
> the moment PR-D's warmer host reached the poll 20 ms sooner; `fl_guard` pins it in both directions). A target that exits first, or maps no runtime inside the budget (60 s in the
|
||||
> host), answers `LaunchTargetExited` / `LaunchNoPresentationRuntime` with nothing injected; a launcher
|
||||
> that spawns the real game and quits lands on the first, and re-electing the descendant is the Agent's
|
||||
> (P2, §Process watcher) — **built 2026-09-10 (PR-F)**: the Agent's `--console launch` hands either
|
||||
> answer to `DescendantElection` and runs an attach-mode session against the newest tracked descendant.
|
||||
> **The host never terminates what it launched**: any refusal after the start
|
||||
> leaves the title running unhooked, which is Tier 2.
|
||||
>
|
||||
> **What it measures about itself, which is the input §S1 deferred on.** The report prints the wait
|
||||
> (`launch: the guard injected N ms after the process was started`) and `FlWriterState.dxgiPresentsBeforeHook`
|
||||
> — DXGI's own count, read at the first hooked present on the first hooked chain, of presents completed
|
||||
> before the hook was in. **0 means nothing ran unhooked on that chain**; N is the early-init cost, per
|
||||
> title, from the title itself. On `hook-harness` (device at startup, presenting every 8 ms) the real-seam
|
||||
> fixture injects within one poll and reports the ~1 s of presents the fixture ran before asking — a
|
||||
> measurement of the fixture, not a bound on a title. What launch mode can *never* see is anything before
|
||||
> its own injection, and a swapchain created before the runtime-mapped poll fired is exactly that; the
|
||||
> number says how much.
|
||||
>
|
||||
> The CaptureHost's verb is `launch --exe <path> [--args "<game's own arguments>"] [--seconds <n>]`; the
|
||||
> consent record, the gate and the payload are the ones `capture` uses, reached one process later.
|
||||
|
||||
**Attach mode.** Game launched from Steam/GOG/Epic normally; watcher sees it, guard runs, inject. Feature hooks install late, so early-init facts may be missed; the Overlay compensates by re-reading state on the first `EvaluateFeature` call it does observe, and the session is flagged `late_attach = true` so the UI can note that startup-time settings may be incomplete.
|
||||
|
||||
Steam users can also set FrameLedger as a launch option wrapper; documented in the UI rather than automated (never modify a user's Steam config for them).
|
||||
@@ -97,10 +185,16 @@ What the Agent checks **before** asking the guard is the thing the native side s
|
||||
> **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
|
||||
> `Application.Consent.IGameConsentStore`; **SQLite is P2's adapter for it** and is still
|
||||
> `Application.Consent.IGameConsentStore`; ~~**SQLite is P2's adapter for it** and is still
|
||||
> unwritten, and `06_DATA_MODEL` declines to guess `0001_init.sql` before its consumers exist.
|
||||
> The only adapter today is a file-backed store inside the unshipped `FrameLedger.CaptureHost`,
|
||||
> whose record dies with the build tree and is **not** a migration source.
|
||||
> whose record dies with the build tree and is **not** a migration source.~~ **Written 2026-09-09
|
||||
> (P2 PR-B): `Infrastructure.Persistence.SqliteGameConsentStore` over the `games` table of
|
||||
> `0001_init.sql`, with the file store deleted rather than migrated.** The unshipped host now opens
|
||||
> its OWN `ledger.db` beside its binary (HANDOFF §P2 decision D5), so the Agent stays the sole owner
|
||||
> of `%LOCALAPPDATA%\FrameLedger`; the Agent's console verb (PR-F, D4) and the UI's dialog (P3) are
|
||||
> the producers that stamp from the Agent's clock, which is the property the paragraph below says a
|
||||
> file could not uphold.
|
||||
>
|
||||
> **A file cannot uphold the Agent-stamp property, and saying so is the honest position.**
|
||||
> `19_SAFETY` §User-facing consent requires the timestamp to be *"stamped by the Agent, never
|
||||
@@ -153,6 +247,29 @@ What the Agent checks **before** asking the guard is the thing the native side s
|
||||
- **A torn record is a gap, not a skipped frame.** Silently dropping it merges two frame times into one double-length interval, i.e. fabricates a stutter. Record an explicit gap at that index; `03_METRICS` excludes gap-adjacent intervals from frame-time statistics.
|
||||
- Records go into an in-memory buffer (`ArrayPool<FlFrameRecord>` segments). Every 60 s, a crash-safety flush writes raw buffers to `%LOCALAPPDATA%\FrameLedger\tmp\<sessionGuid>.partial`.
|
||||
|
||||
## Threading model
|
||||
|
||||
> **Written 2026-09-09 (P2 PR-C), because `20_OPEN_QUESTIONS` §G listed it as unspecified and the
|
||||
> loop had just become shipped code.** Four kinds of thread, one owner per shared object.
|
||||
|
||||
| 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) |
|
||||
| **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 |
|
||||
| **Pipe** (built 2026-09-13, P3 PR-1: `PipeServer.RunAsync` accepting, one reader and one writer task per client) | Per frame | Each client's bounded outbound queue (drop-oldest, so a publisher never waits) and the answer to each request | `Hello` / `GetStatus` / `Ping` read `AgentStatus`, an immutable snapshot the publisher swaps whole; **never the ring, never the recorder**. The events themselves are handed over ON the session loop's task by `SessionEventPublisher` (`ISessionObserver`, called after the recorder's own work each tick) — the loop enqueues a frame and returns |
|
||||
|
||||
Rules the table encodes: **nothing but the session loop touches `ShmRingReader`** — no lock is
|
||||
added to the reader, because there is no second party; a diagnostic wanting a look at the ring
|
||||
is a second consumer on a single-consumer ring and is refused by review and by
|
||||
`NoSecondRingReaderTests`. The ring holds ~16 s at a game's present rate, so a 100 ms cadence
|
||||
has two orders of magnitude of headroom, and `TotalDropped > 0` stays a session warning rather
|
||||
than a tuning knob. ~~There is no UI thread in P2; the pipe reader (P3) joins as one more
|
||||
`Channel` producer, not as a reader of anything above.~~ **The pipe's read half joined 2026-09-13 exactly so** (the row above): nothing on
|
||||
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.
|
||||
|
||||
## 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.
|
||||
@@ -176,7 +293,21 @@ Idle → Detected(pid) → Guarded → Injecting → Capturing → Finalizing
|
||||
|
||||
**Vulkan sessions do not pass through `Injecting`.** The layer is loaded by the
|
||||
Vulkan loader when the Agent launches an opted-in game, so the path is
|
||||
`Detected(pid) → Guarded → Capturing`, skipping injection entirely. This is
|
||||
`Detected(pid) → Guarded → Capturing`, skipping injection entirely.
|
||||
|
||||
> **Built 2026-09-06 (P1 item 3), through launch mode.** The guard's waiting entry classifies the
|
||||
> launched target by what it mapped: `vulkan-1.dll` with no D3D or OpenGL runtime runs the **full** guard
|
||||
> and, on a pass, injects nothing — `TargetIsVulkanLayered`, which the loop reads as "attach to the
|
||||
> layer's ring" with launch mode's budget (the ring appears at the title's first `vkCreateDevice`). The
|
||||
> CaptureHost's `launch` gives the process the layer's environment (`VkLayerLaunchEnvironment`:
|
||||
> `VK_ADD_IMPLICIT_LAYER_PATH`, the enable variable, the enable-list line for the session); a D3D title
|
||||
> ignores all of it. One ring per process, the first creator owns it (`fl_shm_host.h`). ~~Attach mode on a
|
||||
> running Vulkan title stays Tier 2~~ **— not what the code does, found 2026-09-15 while checking `legal/ACCURACY.md`:
|
||||
> attach mode calls `FlGuardedInject`, which has no presentation-runtime branch (only launch mode's
|
||||
> `GuardedInjectWhenReady` refuses a Vulkan title with `TargetIsVulkanLayered`), so a running Vulkan title that
|
||||
> passes the guard gets the Direct3D Overlay injected. What it records there is unverified and nothing tests it;
|
||||
> whether attach mode should refuse a Vulkan title instead is the owner's open decision.** Only a launch can set
|
||||
> the loader's environment. This is
|
||||
stated because the state machine above, read literally, meant the 30 s guard
|
||||
re-scan — which `19_SAFETY` calls the most important runtime behaviour in the
|
||||
capture layer — was not specified to run for Vulkan at all. It runs for **every
|
||||
@@ -186,6 +317,29 @@ because a layer cannot leave a running game's loader chain.
|
||||
|
||||
**Discard rule:** duration < min session length (default 30 s) → discard silently (log only).
|
||||
|
||||
> **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
|
||||
> `games` and `hardware_snapshots` rows, the telemetry poller for the session, the `.partial` from before
|
||||
> the first record to after the last, the loop, the classification, the finalize, the crash policy. The
|
||||
> loop (`CaptureSession`) owns `Guarded → Injecting → Capturing` and reports them as ONE outcome, so what
|
||||
> the recorder observes and writes as breadcrumbs is `started` (the file exists) → `attached` (the ring is
|
||||
> ours; Tier 1 from here) → `ended <reason>` → `finalizing <exit_status>`; a loop that never attached is a
|
||||
> Tier-2 row with the reason in `capture_notes` (`tier2: attach=…; guard=<reason>/<family>/<signal>`).
|
||||
> Everything the recorder does runs on the loop's task through `ICaptureObserver`: after every drain it
|
||||
> drains the poller's queue and, on the flush interval, appends to the `.partial` — the loop stays the
|
||||
> ring's only reader (§Threading model). **Finalizing as built:** step 1 is the loop's own last drain;
|
||||
> steps 2–3 are `SessionAggregator` over Domain's calculators and `FgLadder` (the identity and withhold
|
||||
> rules, moved out of the host's report so the row and the report read one implementation); step 4 is the
|
||||
> FULL blob set through `ISeriesCodec` — every column of `frame_blobs` that any record claimed, `latency_us`
|
||||
> included, and one `sensor_blobs` series per field any sample carried, aligned to `t_ms` with −1 where a
|
||||
> tick had no reading; step 5 is `ISessionRepository.InsertFinalizedAsync` (one transaction) then the
|
||||
> retention sweep, and the `.partial` is deleted only on `Saved` or `Discarded`. `Interrupted` is
|
||||
> `PartialRecovery`'s alone: at startup every pending file becomes an `interrupted` row from its valid
|
||||
> prefix, or is dropped for one of three stated reasons (already stored, too short, unreadable). The
|
||||
> unshipped host lowers the discard threshold to 5 s for bounded operator captures; the Agent keeps 30 s
|
||||
> for every session nobody bounded and lowers it to the bound for a `--console capture --seconds N` (PR-F).
|
||||
|
||||
## Crash & exit classification
|
||||
|
||||
- Normal: presenting PID exit code 0.
|
||||
@@ -193,13 +347,33 @@ because a layer cannot leave a running game's loader chain.
|
||||
- `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.
|
||||
- A **user stop** (FR-3.6; `StopSession` over the pipe, P3 PR-1b) is `normal`: the loop ends as `SessionEndReason.StoppedByUser` at its next tick, drains once more and finalizes; the target keeps running, unhooked from here. It is the session's own stop token, not the host's cancellation — the latter leaves a `.partial`.
|
||||
|
||||
Crash-within-60s-of-injection happening twice for the same game ⇒ **hooking auto-disabled for that game** and the reason stored on the `games` row (`19_SAFETY` §Crash safety). The UI explains it and offers a manual re-enable after the user has, e.g., updated their GPU driver.
|
||||
|
||||
> **Built 2026-09-10 (P2 PR-D).** `ExitStatusMapper` is the table above as one function of what the
|
||||
> session saw: our own safety stop is `unhooked_safety` whatever the process did next; the capture side
|
||||
> stopping on its own (self-disabled, blocklisted mid-session, supervision lost, hooks never installed) is
|
||||
> `degraded`; a non-zero exit code — read from the held handle, so it is the target's own — or an
|
||||
> Application Error (1000) / WER (1001) event naming the executable inside `[start, end + 30 s]`
|
||||
> (`EventLogCrashSource`, read-only, unprivileged, false when the log cannot be read) is `crashed`; a
|
||||
> target still running when a bounded capture ends is `normal`. `capture_notes` keeps the fine reason, the
|
||||
> 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.
|
||||
|
||||
## Live progress
|
||||
|
||||
`SessionProgress` at 1 Hz to the UI (`07_IPC`): rolling 5 s Native FPS, Displayed FPS, FG factor, current render→output resolution, upscaler + quality, RT active flag, GPU/CPU temp, per-process VRAM, elapsed. Suppressed when no UI client is connected. This is what makes the Dashboard live card genuinely useful — it is showing *measured* settings, not guesses.
|
||||
|
||||
> **Built 2026-09-13 (P3 PR-1, HANDOFF §P3 decision D13): `Application.Ipc.SessionProgressCalculator`**, over the last 5 s of the
|
||||
> ring's records through the same calculators the row uses — `FrameTimeSeries` for the presented rate, `FgWindow` + the FG ladder for
|
||||
> Native / Displayed / factor, `UpscaleExtent` for the resolutions — so the live number and the stored one cannot disagree. Rule 6 holds
|
||||
> at the wire: Native / Displayed / factor appear only when frame generation was measured in the window; otherwise the presented rate
|
||||
> 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.
|
||||
|
||||
## Overhead rules (NFR-1)
|
||||
|
||||
| Where | Budget |
|
||||
|
||||
+85
-7
@@ -18,7 +18,7 @@ Derived in the Agent from the record stream; the mapping is in `03_METRICS`. Sum
|
||||
| Graphics API + swapchain format, buffer count, swap effect, flags | `CreateSwapChain*` / present hooks |
|
||||
| Present mode (flip / blt / independent flip) | swapchain desc + `presentFlags` + `syncInterval` |
|
||||
| HDR output | `SetColorSpace1` |
|
||||
| Upscaler identity + quality preset | NGX / Streamline / FFX / XeSS create+evaluate calls |
|
||||
| Upscaler identity + quality preset | NGX / Streamline / FFX / XeSS create+evaluate calls — **or, when no hook saw one, the NVIDIA driver's per-process NGX word, out of process and attributed (`03_METRICS` §Upscaling, the driver-reported rung, 2026-09-06): identity only, never the preset** |
|
||||
| Render resolution vs output resolution (incl. mid-session changes) | upscaler parameter reads + `ResizeBuffers` |
|
||||
| Frame Generation mode + factor | NGX/SL/FFX FG feature evaluation, then cadence — **Tier 1 only**. ~~then (Tier 2 only) PresentMon `FrameType`~~ retired (§S31 row P2), and Tier 2 no longer produces frames to run cadence over either |
|
||||
| Ray Tracing active | AS builds + `DispatchRays` (both, to catch inline RayQuery) |
|
||||
@@ -27,6 +27,11 @@ Derived in the Agent from the record stream; the mapping is in `03_METRICS`. Sum
|
||||
| Per-process VRAM | `QueryVideoMemoryInfo` |
|
||||
| PSO compilation events | pipeline-creation hooks |
|
||||
|
||||
> **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.
|
||||
|
||||
> **"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
|
||||
> 2026-08-05: `IDXGISwapChain::GetFrameStatistics().PresentCount` counts presents *the
|
||||
@@ -130,8 +135,8 @@ Recorded as a residual risk, not as a solved problem.
|
||||
| Unreal 4/5 | exe matches `*-Win64-Shipping.exe` **or** `*/Content/Paks/*.pak` | ProductVersion regex `\+\+UE(4\|5)\+Release-(\d+\.\d+)` |
|
||||
| Godot | `.pck` sibling **or** `strings_contains("Godot Engine v")` | strings regex `Godot Engine v(\d+\.\d+[\.\d]*)` |
|
||||
| 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 |
|
||||
| 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` |
|
||||
@@ -141,10 +146,24 @@ 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.
|
||||
⛔ *(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.
|
||||
|
||||
@@ -155,11 +174,46 @@ 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.
|
||||
|
||||
> **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`~~ — **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
|
||||
> provenance rule as a detection write (a value the user typed is never overwritten). The table above says
|
||||
> "walk up to the nearest manifest" for the per-game metadata extractors; those are still unbuilt
|
||||
> (`GameFileProbe` keeps `manifest_field` uncollected) — the import reads the launchers' own indexes instead.
|
||||
> **Privacy:** local files and registry keys the launchers already wrote, read-only; no process is touched, nothing
|
||||
> 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.
|
||||
|
||||
## Capability hints (explicitly labelled as such)
|
||||
@@ -171,6 +225,14 @@ Files shipped with a game tell us what it *supports*. These populate a **"Suppor
|
||||
- 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`
|
||||
- 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
|
||||
`GameFileProbe` reads the executable's import and delay-load tables (`Infrastructure.Detection.PeImports`,
|
||||
bounded and read-only) and looks for the loader's name as an ASCII or UTF-16 string in the bounded scan;
|
||||
`StaticDetectionResult.UsesVulkan` is true / false / null (could not read), and the sweep stores a true as the
|
||||
id `vulkan` in `capability_flags` beside the rule ids. It is what `17_HOOK_ENGINE` §Vulkan's register-on-consent
|
||||
automation keys on, and what the game page shows as "Supports Vulkan". Never a claim about what a session
|
||||
presented — that is `sessions.api`, measured.
|
||||
|
||||
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.
|
||||
|
||||
@@ -190,6 +252,22 @@ Three things this section previously implied that are not true, and are worth st
|
||||
|
||||
- Detection results cached per game; refreshed when exe timestamp/size changes or `rulesVersion` changes. Implemented as `DetectionCacheKey` (path + size + mtime + `rulesVersion`).
|
||||
- **A re-run never overwrites a field the user supplied.** `games.field_provenance` records where each value came from; anything not marked `detected` is left alone, and an absent or unrecognised provenance reads as *user*. Without this rule the re-run triggered by every rules update silently clobbers every correction the user has ever made — a data-loss bug that surfaces weeks later on somebody else's machine. Stated here because no document said it before, and the safe default is the one that costs a badge rather than a value.
|
||||
> **Built 2026-09-14 (P4 PR-1), and two things this section did not say.** *When it runs:* the Agent's
|
||||
> `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
|
||||
> 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
|
||||
> `detection_exe_size_bytes` / `detection_exe_mtime_ms` beside `detection_rules_version`. *And the provenance
|
||||
> rule, applied per field in the repository:* a `user` entry, an unrecognised entry, or a value with no entry is
|
||||
> the user's and stays; a `detected` entry is refreshed; **an empty field with no entry has nothing to protect
|
||||
> and is filled and badged `detected`** — without that clause a freshly added game could never receive an
|
||||
> engine at all, since `EnsureAsync` writes no provenance. A null detected value erases nothing.
|
||||
> `capability_flags` is written whole every run (a JSON array of the rule ids — `dlss`, `dlss_g`, `dlss_rr`,
|
||||
> `streamline`, `fsr`, `xess`, `xefg`) because the Supports row has no user-edit surface and a stale "Supports
|
||||
> DLSS-G" after the DLL left is the confusion §Capability hints exists to prevent.
|
||||
- Strings scans bounded to 8 MB, local only.
|
||||
- Module enumeration uses read-only handles (`PROCESS_QUERY_LIMITED_INFORMATION | PROCESS_VM_READ`); never a handle with write access outside the injection call itself.
|
||||
- No game memory is read for detection purposes — all runtime facts come from arguments to APIs we hooked (CLAUDE.md rule 4).
|
||||
+231
-12
@@ -2,10 +2,38 @@
|
||||
|
||||
`%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`, and the hook-state columns on `games`. UI writes `games` (user-editable fields), `session_annotations`, `settings`, `legal_acceptance`. Both read everything.
|
||||
**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).
|
||||
|
||||
## Schema (v2 — hook architecture)
|
||||
|
||||
> **`src/FrameLedger.Infrastructure/Persistence/Migrations/0001_init.sql` is normative since 2026-09-09
|
||||
> (P2 PR-B).** The block below is the shape as drafted and is kept for its comments; the script adds
|
||||
> what this document had no column for, each with the reason beside it in the script:
|
||||
>
|
||||
> - `sessions.session_guid` (UNIQUE) — the identity the `.partial` file, the pipe and recovery key on
|
||||
> (`20_OPEN_QUESTIONS` §G "Session identity"); `qpc_epoch` + `qpc_frequency` — the time base the
|
||||
> blobs and sensor series are aligned to (`03_METRICS` §Export, §Sensor aggregates);
|
||||
> `capture_mode` (`attach|launch`); the drain's own accounting (`drain_ticks`, `foreground_ticks`,
|
||||
> `records_before_attach`, `dxgi_presents_before_hook`, `gap_count`, `guard_ticks_published`,
|
||||
> `launch_wait_ms`); the 2026-09 metric additions (`presented_fps` + `presented_qualifier`,
|
||||
> `dxgi_unseen_total` / `dxgi_present_samples` / `displayed_counted_by`, `sl_tag_census`,
|
||||
> `sl_interposer_version`, `upscaler_driver_reported` / `fg_driver_reported` / `ngx_driver_words`,
|
||||
> `fg_none_withheld_reason`, `runtime_modules`, `executable_markers`, `writer_status_at_end`,
|
||||
> `early_stop_family`, `loader_signals`).
|
||||
> - `games.exe_size_bytes` / `exe_mtime_ms` (the `ExecutableFingerprint`),
|
||||
> `hook_consent_provenance` (the `ConsentProvenance` NAME, default `NotRecorded`),
|
||||
> `hook_consent_disclosure_version`, **`hook_prescan_state`** (`not_run|clean|blocked|unverified` —
|
||||
> the third state one nullable `hook_blocked_reason` could not carry; nothing in P2 clears the
|
||||
> reason, per the owner question below), `hook_autodisabled_at`, `hook_last_injected_at`.
|
||||
> - `frame_blobs.frame_index`, `swapchain_ids`; `sensor_blobs` gains the `t_ms` series.
|
||||
> - **`fg_source`'s domain is `api|cadence|none|manual`, NULL = not measured** — this document said
|
||||
> `api|cadence|manual` while `03_METRICS` names rung 4 `none`; the CHECK carries the union.
|
||||
> - **Every `*_at` / `*_ms` INTEGER is unix-ms UTC** (CLAUDE.md §Coding conventions), stated in the
|
||||
> script because it was stated nowhere in this file. QPC never leaves the pipeline except
|
||||
> `qpc_epoch` / `qpc_frequency`.
|
||||
> - `exe_path` is `UNIQUE COLLATE NOCASE`, because consent matches `OrdinalIgnoreCase` on the
|
||||
> normalised full path and the index must agree with the lookup.
|
||||
|
||||
```sql
|
||||
CREATE TABLE schema_migrations (version INTEGER PRIMARY KEY, applied_at INTEGER NOT NULL);
|
||||
|
||||
@@ -18,6 +46,9 @@ CREATE TABLE games (
|
||||
engine TEXT, engine_version TEXT,
|
||||
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
|
||||
-- (sessions.game_id is NOT NULL, ON DELETE CASCADE) but leaves the
|
||||
-- library; a later launch of the same exe restores it (removed_at = NULL)
|
||||
|
||||
-- hooking state (19_SAFETY)
|
||||
hook_enabled INTEGER NOT NULL DEFAULT 0, -- 0 = Tier 2, i.e. nothing measured; default for every new game
|
||||
@@ -25,7 +56,10 @@ CREATE TABLE games (
|
||||
hook_blocked_reason TEXT, -- set by the static AC pre-scan; non-null = toggle disabled in UI
|
||||
hook_autodisabled_reason TEXT, -- set after repeated crashes
|
||||
hook_crash_count INTEGER NOT NULL DEFAULT 0,
|
||||
capability_flags TEXT, -- JSON: what the game SHIPS (dlss/dlssg/dlssd/fsr/xess) — never a measurement
|
||||
capability_flags TEXT, -- JSON: what the game SHIPS — never a measurement. Since P4 PR-1 (2026-09-14) a JSON
|
||||
-- array of the rule ids of rules/detection-rules.json (dlss, dlss_g, dlss_rr, streamline,
|
||||
-- fsr, xess, xefg), written whole by the Agent's detection sweep; this line used to spell
|
||||
-- the App's tokens (dlssg/dlssd), which the App still reads for older rows
|
||||
|
||||
-- tri-state defaults inherited by new sessions
|
||||
rt_default TEXT NOT NULL DEFAULT 'na',
|
||||
@@ -54,10 +88,12 @@ CREATE TABLE games (
|
||||
> `05_DETECTION` §Caching and is enforced by `StaticDetectionResult.ShouldWrite`,
|
||||
> which is tested even though nothing persists yet.
|
||||
>
|
||||
> No migration is written here. There is no SQLite layer at all, and §Migrations
|
||||
> ~~No migration is written here. There is no SQLite layer at all, and §Migrations
|
||||
> forbids editing an applied script — so guessing the shape into `0001_init.sql`
|
||||
> before its consumers exist maximises the chance of baking in a wrong guess that
|
||||
> can only be appended to.
|
||||
> can only be appended to.~~ **Written 2026-09-09 (P2 PR-B), with its first consumer:** the
|
||||
> column exists in `0001_init.sql`; the writer (the detection cache, P4) and the reader (the
|
||||
> library card, P3) are still unbuilt, so it is decided, created, and empty.
|
||||
|
||||
> **The three hook-state columns have a consumer before they have a table, and two
|
||||
> fields it needs are not here.** Added 2026-08-06 with `IGameConsentStore`, whose
|
||||
@@ -80,10 +116,15 @@ CREATE TABLE games (
|
||||
> toggle (a false refusal with no appeal) nor be cleared (a fail-open). One nullable
|
||||
> TEXT column cannot carry three states.
|
||||
>
|
||||
> **The file-backed record is NOT a migration source.** It lives in a build output,
|
||||
> `git clean` removes it, and this section's own argument against guessing a schema
|
||||
> applies just as well to inheriting one from a throwaway. When the `games` table is
|
||||
> written it is written from this document.
|
||||
> **The file-backed record was NOT a migration source, and was not migrated.** It lived in a
|
||||
> build output, `git clean` removed it, and when the `games` table was written (2026-09-09, P2
|
||||
> PR-B) it was written from this document — the file store and its DTOs were deleted the same day.
|
||||
> The two fields the consumer needed and this table lacked are columns now:
|
||||
> `hook_consent_provenance` and `hook_consent_disclosure_version`; the third pre-scan state is
|
||||
> `hook_prescan_state`. **`ConsentProvenance` has a third name since 2026-09-10 (P2 PR-F)** — and a fourth, `ConsentDialog`, since 2026-09-13 (P3 PR-4), the only one a shipped user path produces:
|
||||
> `AgentConsoleOperator`, the Agent's own `--console consent grant` (HANDOFF §P2 decision D4) — a
|
||||
> shipped producer, still not FR-2.1, stamped by the Agent's clock; the store writes the NAME the
|
||||
> acknowledgement carries and refuses `NotRecorded`.
|
||||
>
|
||||
> **Still unanswered, and it is an owner decision rather than a coding one:** who
|
||||
> clears `hook_blocked_reason` when a re-scan comes back clean. `19_SAFETY` §A game
|
||||
@@ -154,6 +195,10 @@ CREATE TABLE sessions (
|
||||
fg_mode TEXT NOT NULL DEFAULT 'na',
|
||||
fg_source TEXT, -- api|cadence|manual (`etw` removed 2026-08-28: no producer, no tier)
|
||||
fg_factor REAL,
|
||||
-- schema 0003 (2026-09-14): why fg_factor is NULL while fg_mode names a technology — FgRefusalKind as
|
||||
-- Vocabulary.FgRefusal spells it (not_counted, no_evaluations, non_uniform, dxgi_saturated, …). NULL when a
|
||||
-- factor stands or the writer predates the column. A REASON for the UI, never an input to fg_mode or a number.
|
||||
fg_refusal TEXT,
|
||||
-- FlWriterState.runtimeCensus, raw (FlRuntimeCensus bits). Which vendor runtime modules
|
||||
-- the loader reported in the process. NOT a measurement and never a source for fg_mode
|
||||
-- or upscaler: it qualifies the presented figure when fg_mode is 'na' (03_METRICS §Rung
|
||||
@@ -236,35 +281,209 @@ CREATE TABLE frame_blobs (
|
||||
|
||||
CREATE TABLE sensor_blobs (
|
||||
session_id INTEGER NOT NULL REFERENCES sessions(id) ON DELETE CASCADE,
|
||||
-- (schema 0007, 2026-09-21 - 19_SAFETY §The user's bypass) lives on TWO tables and nowhere else:
|
||||
-- games.guard_bypass_at INTEGER, games.guard_bypass_disclosure_version TEXT NOT NULL DEFAULT ''
|
||||
-- NULL/'' = off, every row's default. Both or neither: a timestamp without its version is not an
|
||||
-- acknowledgement. Written only through IGuardBypassStore; cleared by revoking consent and by Change executable.
|
||||
-- sessions.guard_bypassed INTEGER NOT NULL DEFAULT 0, guard_bypass_family TEXT, guard_bypass_signal TEXT
|
||||
-- 1 when the session STARTED under the bypass. A session recovered from a .partial does not carry it.
|
||||
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)
|
||||
);
|
||||
|
||||
CREATE TABLE session_annotations (
|
||||
session_id INTEGER PRIMARY KEY REFERENCES sessions(id) ON DELETE CASCADE,
|
||||
tags TEXT, notes TEXT
|
||||
tags TEXT, notes TEXT, -- tags: a JSON string array (P3 PR-3); a row that would be all NULL is deleted
|
||||
-- schema 0002 (P3 PR-3): FR-8.3's per-session overrides live HERE, on the UI's table, beside the
|
||||
-- measurement on sessions and never over it — clearing an override restores what was measured.
|
||||
-- NULL = no override. sessions.rt_source stays the measurement's word.
|
||||
rt_override TEXT CHECK (rt_override IS NULL OR rt_override IN ('yes', 'no', 'na')),
|
||||
pt_override TEXT CHECK (pt_override IS NULL OR pt_override IN ('yes', 'no', 'na')),
|
||||
rr_override TEXT CHECK (rr_override IS NULL OR rr_override IN ('yes', 'no', 'na'))
|
||||
);
|
||||
|
||||
CREATE TABLE settings (key TEXT PRIMARY KEY, value TEXT NOT NULL);
|
||||
-- keys in use: hooking.kill_switch = '1' (FR-2.4, P2 PR-F; anything else, or no row, is off)
|
||||
-- the full key list is §Settings registry below (P3 PR-3)
|
||||
CREATE TABLE legal_acceptance (doc TEXT PRIMARY KEY, version TEXT NOT NULL, accepted_at INTEGER NOT NULL);
|
||||
```
|
||||
|
||||
> **Written since 2026-09-14 (P3 PR-9).** `doc` is one of `eula` / `gpl` / `disclaimer` / `privacy`
|
||||
> (`App.Services.LegalDocuments.Keys`); `version` is the document's own `**Version:**` line as embedded in the
|
||||
> App at build (`GPL-3.0-only` for the licence text) — the App is the only writer, one row per document per
|
||||
> Accept, re-recorded when the embedded version differs from the row's. `20_OPEN_QUESTIONS` §G "Legal doc
|
||||
> versioning" closes on that.
|
||||
|
||||
## Settings registry
|
||||
|
||||
HANDOFF §P3 decision D16, built as `Application.Settings.SettingsRegistry` (P3 PR-3, 2026-09-13) and
|
||||
closing `20_OPEN_QUESTIONS` §G's row. `settings` is key/value TEXT; the registry is the only key list, and
|
||||
`RegisteredSettings` over `ISettingsStore` **validates writes and tolerates reads** — a hand-edited or
|
||||
out-of-range row reads as the default, never as an exception. Booleans are exactly `1`/`0` (the kill
|
||||
switch's rule); integers are invariant-culture within an inclusive range; choices are compared ordinally.
|
||||
**No "setting changed" message exists:** the Agent re-reads its keys at each session start
|
||||
(`SettingsRecorderPolicy` → `RecorderOptions`), and the UI owns the rest.
|
||||
|
||||
| Key | Kind | Default | Range / choices | Read by |
|
||||
|---|---|---|---|---|
|
||||
| `ui.language` | choice | `en` | `en` · `vi` · `ja` | UI |
|
||||
| `ui.theme` | choice | `system` | `system` · `light` · `dark` | UI |
|
||||
| `ui.start_with_windows` | bool | `0` | | UI (P4) |
|
||||
| `ui.minimize_to_tray` | bool | `0` | | UI (PR-8) |
|
||||
| `capture.background` | bool | `1` | | Agent |
|
||||
| `hooking.kill_switch` | bool | `0` | | Agent (FR-2.4, since P2 PR-F) |
|
||||
| `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` | | *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
|
||||
its bound under any `capture.min_session_s`: the setting moves the product's rule, not the operator's.
|
||||
|
||||
## Comparison safety
|
||||
|
||||
Because Tier-1 and Tier-2 sessions carry different fields, every query that compares sessions **must** filter or group by `capture_tier`. **Since 2026-08-28 the difference is total rather than partial** — a Tier-2 session has no frame data at all — so a mixed-tier overlay is not a degraded comparison, it is a comparison with nothing on one side. The Compare view refuses to overlay mixed tiers without an explicit "compare across tiers anyway" acknowledgement, and marks the chart accordingly. Likewise `settings_changed_midsession = 1` sessions are excluded from trend lines by default (they average across a settings change and are misleading), with a toggle to include them.
|
||||
|
||||
## Blob encoding
|
||||
|
||||
`float32`/`uint16`/`uint32` little-endian arrays through `DeflateStream` (Optimal). One hour at 100 fps ≈ 360k frames ≈ 1.4 MB raw frametimes ≈ **≤ 0.7 MB stored**; flags compress far better; render-res only stored when it varies. Decode helpers in `Infrastructure.Blobs` with round-trip tests (NaN forbidden — assert).
|
||||
`float32`/`uint16`/`uint32` little-endian arrays through `DeflateStream` (Optimal). One hour at 100 fps ≈ 360k frames ≈ 1.4 MB raw frametimes ≈ **≤ 0.7 MB stored**; flags compress far better; render-res only stored when it varies. Decode helpers in `Infrastructure.Blobs` with round-trip test
|
||||
|
||||
> **Two rules the finalizer applies (2026-09-10, P2 PR-D).** `frametimes[i]` is the interval from the previous
|
||||
> record ON THE SAME SWAPCHAIN; the first record of a stream, and any record after a torn slot or an
|
||||
> overwrite skip, carries 0 with the `frame_flags` gap bit set, so the statistics exclude it and the export
|
||||
> still reconstructs `qpc_ms`. `swapchain_ids` is present only when the session held more than one stream.
|
||||
> 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).
|
||||
|
||||
## The `.partial` file
|
||||
|
||||
> **Built 2026-09-10 (P2 PR-D), as HANDOFF §P2 pre-committed it.** `%LOCALAPPDATA%\FrameLedger\tmp\<sessionGuid>.partial`
|
||||
> (the unshipped host: `tmp\` beside its binary, decision D5), one per session, append-only, written at every
|
||||
> state transition and every flush interval (60 s), deleted by the finalize's success, read by recovery at the
|
||||
> next start. Format: `chunk := u32 type | u32 length | payload | u32 crc32(type ‖ length ‖ payload)`,
|
||||
> little-endian, and **the valid prefix wins** — the reader stops at the first chunk that is short or fails
|
||||
> its check, so a kill at any byte loses at most the chunk being written (`PartialSessionFileTests` kills
|
||||
> at every offset of a fixture and asserts exactly the complete chunks survive). The file is flushed to the
|
||||
> OS after every chunk; the threat is the Agent dying, not the machine losing power.
|
||||
>
|
||||
> | type | payload | when |
|
||||
> |---|---|---|
|
||||
> | 1 `Header` | UTF-8 JSON: format version, `session_guid`, `started_at`, `qpc_epoch`/`qpc_frequency`, `game_id`, `snapshot_id`, exe path, pid, tier, mode, Overlay build id, telemetry descriptor, launch wait | on create — the breadcrumb `19_SAFETY` §Crash safety asks for before injection |
|
||||
> | 2 `Records` | `i64` first ordinal, then N raw `FlFrameRecord` (64 B each); a chunk that does not continue the sequence is refused | each flush |
|
||||
> | 3 `Gaps` | N × `i32` gap-before record indices | each flush |
|
||||
> | 4 `Sensors` | N × one telemetry sample: QPC, wall clock, layer, presence mask, then only the fields that carry a value — null stays null | each flush |
|
||||
> | 5 `Tick` | drain/foreground ticks, dropped, gaps, guard ticks, wall clock, the raw `FlWriterState`; the last one wins | each flush |
|
||||
> | 6 `Note` | wall clock + UTF-8 text: a state transition | each transition |
|
||||
> | 7 `Touches` | N × `i64` QPC at which the host touched the target | each flush |
|
||||
>
|
||||
> Recovery (`PartialRecovery`): a file whose guid is already a row is deleted (the finalize had landed);
|
||||
> one under the minimum session length is discarded; one with no readable header is dropped; the rest
|
||||
> become `interrupted` rows ended at the last flush (or the last record's clock), with every measured
|
||||
> 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\`.
|
||||
|
||||
## Retention
|
||||
|
||||
Default: raw blobs for the **last 20 sessions per game** (configurable N or unlimited). Aggregates and segments kept forever. Sweep at finalize + on demand (Tools → DB maintenance, which also offers `PRAGMA integrity_check`, `VACUUM`, backup).
|
||||
Default: raw blobs for the **last 20 sessions per game** (configurable N or unlimited — `retention.raw_sessions_per_game`, 0 = unlimited, §Settings registry). Aggregates and segments kept forever. Sweep at finalize + on demand (Tools → DB maintenance, which also offers `PRAGMA integrity_check`, `VACUUM`, backup).
|
||||
|
||||
> **Built 2026-09-15 (P4 PR-7).** The on-demand sweep is the **Agent's**: the App sends `SweepRetention` (`07_IPC`),
|
||||
> and the Agent runs `ISessionRepository.SweepRetentionAllAsync` — the finalize's per-game rule for every game in one
|
||||
> transaction, `ROW_NUMBER() OVER (PARTITION BY game_id ORDER BY started_at DESC, id DESC)`, so the two can never
|
||||
> disagree about which session is the Nth, and a removed game's kept sessions are swept like any other. A keep of 0
|
||||
> never reaches it: unlimited is honoured by not sweeping. The other three run in the App through
|
||||
> `Infrastructure.Persistence.LedgerMaintenance` and change no row: `PRAGMA integrity_check`; a backup through
|
||||
> `VACUUM INTO` (a complete, consistent copy while the Agent keeps writing; never over an existing file and never onto
|
||||
> the ledger, its WAL or its shared-memory file — the save dialog's "replace?" would otherwise have deleted the live
|
||||
> database); and compaction, `VACUUM` + `wal_checkpoint(TRUNCATE)`, refused while a fresh `GetStatus` reports a
|
||||
> session. `LedgerDatabase.MaintainAsync` is the one way to run a statement outside a transaction, and it is for
|
||||
> these statements only.
|
||||
|
||||
## Migrations
|
||||
|
||||
Sequential embedded SQL (`Migrations/0001_init.sql`, `0002_*.sql`, …), applied at startup by whichever process opens the DB first, guarded by `schema_migrations` + a global mutex. Never edit an applied script; only append.
|
||||
Sequential embedded SQL (`Migrations/0001_init.sql`, `0002_*.sql`, …), applied at startup by whichever process opens the DB first, guarded by `schema_migrations` + a named mutex. Never edit an applied script; only append.
|
||||
|
||||
> **`0002_annotation_overrides_and_removal.sql` (P3 PR-3, 2026-09-13) — the first append**, and the first
|
||||
> time the runner ran two scripts on a real file: `ALTER TABLE ADD COLUMN` only — the three override
|
||||
> columns on `session_annotations` and `games.removed_at`. `LedgerDatabaseTests` asserts one
|
||||
> `schema_migrations` row per script, so `LatestVersion` is 2.
|
||||
|
||||
> **`0002_annotation_overrides_and_removal.sql` (P3 PR-3, 2026-09-13) — the first append**, and the first
|
||||
> time the runner ran two scripts on a real file: `ALTER TABLE ADD COLUMN` only — the three override
|
||||
> columns on `session_annotations` and `games.removed_at`. `LedgerDatabaseTests` asserts one
|
||||
> `schema_migrations` row per script, so `LatestVersion` is 2.
|
||||
|
||||
> **`0003_fg_refusal.sql` (2026-09-14) — `sessions.fg_refusal`.** The owner's ledger held two hooked rows with
|
||||
> `fg_mode = 'dlssg'`, `fg_source = 'api'` and `fg_factor` NULL — the identity stood, the count refused — and
|
||||
> nothing recorded which refusal; every FG surface said N/A beside a detection that had succeeded. One
|
||||
> `ALTER TABLE ADD COLUMN`, written by the Agent (`SessionAggregator.ApplyFg`), read by the UI for the "factor not
|
||||
> counted" tooltip (`08_UI` §FPS display rule). `LatestVersion` is 3; `LedgerDatabaseTests` asserts the column.
|
||||
|
||||
> **`0004_detection_cache.sql` (P4 PR-1, 2026-09-14) — `games.detection_exe_size_bytes` / `detection_exe_mtime_ms`.**
|
||||
> The detection cache key's exe half (`05_DETECTION` §Caching), apart from `exe_size_bytes` / `exe_mtime_ms`,
|
||||
> 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.
|
||||
|
||||
> **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. *(One name per ledger FILE since 2026-09-17 — `Migrate.<hash of the path>`,
|
||||
> `MigrationRunner.LockNameFor`: with one name for every ledger, a test process frozen mid-migration held
|
||||
> every other process's scratch ledger, and seven App and Agent tests failed after 30 s on #199's run.)* **A ledger at a version newer than the build's scripts is refused, not read**
|
||||
> (`LedgerSchemaException`): guessing at a schema we do not understand is the one option that could
|
||||
> turn a newer file into wrong answers. `LedgerDatabase` opens with the four pragmas above, one
|
||||
> connection per process behind a gate, and every write in an explicit transaction — a failing blob
|
||||
> insert leaves no session row behind (`SqliteSessionRepositoryTests`).
|
||||
|
||||
**`0001_init.sql` creates the schema above directly.** There is no v1 → v2
|
||||
upgrade path, because there is no released v1: nothing has shipped, so no
|
||||
|
||||
+81
-20
@@ -57,7 +57,8 @@ struct alignas(64) FlControlBlock { // Agent-written
|
||||
uint32_t unhookRequested; // @4 19_SAFETY: set when the guard fires mid-session
|
||||
uint32_t overlayEnabled; // @8 in-game overlay draw toggle (v1.1)
|
||||
uint32_t guardTicks; // @12 completed guard evaluations, NOT a timer
|
||||
uint32_t reserved[12]; // @16..63 must be zero
|
||||
uint32_t logFlushRequested; // @16 a COUNTER: bumped by the Agent at session end; the watchdog flushes the native log on a change (17_HOOK_ENGINE §Native logging, 2026-09-06)
|
||||
uint32_t reserved[11]; // @20..63 must be zero
|
||||
};
|
||||
|
||||
static_assert(sizeof(FlShmHandshake) == 64);
|
||||
@@ -263,32 +264,84 @@ same class of bug as record drift.
|
||||
|
||||
Unchanged in spirit from v1, bumped to `v2` for the new message set.
|
||||
|
||||
- Message mode, single server (Agent), max 2 clients (UI + future CLI), `PIPE_REJECT_REMOTE_CLIENTS`.
|
||||
- ACL: current interactive user's SID + Administrators. Reject clients whose token user differs.
|
||||
> ~~**P3, not P2** (HANDOFF §P2 decision D10, restated 2026-09-10 with PR-F): the Agent's `--serve` is
|
||||
> watcher-driven and logs to `logs\agent-*.log`; nothing below exists in code yet, and the P2 Agent has no
|
||||
> client. The pipe reader joins the threading model as one more producer when it is written (`04_CAPTURE`).~~
|
||||
>
|
||||
> **The READ half is built, 2026-09-13 (P3 PR-1; HANDOFF §P3 decisions D11–D13).** `FrameLedger.Shared.Ipc`
|
||||
> holds the envelope, the message set below (read half only), `IpcJsonContext` and `IpcFraming`;
|
||||
> `Infrastructure.Ipc.PipeServer` is the Agent's end and `PipeClient` the UI's; `PipeServerHostedService` runs
|
||||
> the server under `--serve` only — `--console` composes it and never starts it, so it publishes to nobody.
|
||||
> The events come from `Application.Ipc.SessionEventPublisher`, the recorder's second observer
|
||||
> (`ISessionObserver`), on each session's own task; `SessionProgress` is computed once a second and only
|
||||
> while a client is connected. ~~**The command half — `SetWatchlist`, `SetHookEnabled`, `LaunchGame`,
|
||||
> `PauseCapture`/`ResumeCapture`, `StopSession`, `UpdateRules`, `Shutdown` — is PR-1b**: none of those types
|
||||
> is declared in `Shared.Ipc` until its handler exists, and the Agent answers them `Error UnknownType` today.~~
|
||||
> **The command half is built the same day (P3 PR-1b): `Application.Ipc.AgentCommandHandler`**, every row
|
||||
> below with its ack, and the one rule §The pipe is not a trust boundary states is what each handler does —
|
||||
> the Agent establishes the fact itself. Two things a reader must not assume: `SetHookEnabled true` **stamps
|
||||
> nothing yet** (the pre-scan runs, a block is recorded, and a clean scan is answered `Error
|
||||
> DisclosureUnavailable` until FR-2.1's reviewed text ships in PR-4), and `SetWatchlist` **removes nothing**
|
||||
> (removal is FR-1.4's, with its "keep the sessions?" question — never a bulk message's).
|
||||
|
||||
- Message mode, single server (Agent), max 2 clients (UI + future CLI), `PIPE_REJECT_REMOTE_CLIENTS`. *(Built:
|
||||
`CreateNamedPipe` through CsWin32 with these flags stated in code, two instances, a semaphore slot per client
|
||||
so a third connection waits rather than a third instance existing — `PipeServerClientTests`.)*
|
||||
- ACL: current interactive user's SID + Administrators. Reject clients whose token user differs. *(Built as the
|
||||
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.~~)*
|
||||
|
||||
> **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`.
|
||||
- Envelope: `{ "type": …, "id": …, "payload": … }`; `Ack` correlates by `id`; events have no `id`.
|
||||
*(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`.)*
|
||||
- Envelope: `{ "type": …, "id": …, "payload": … }`; `Ack` correlates by `id`; events have no `id`. *(camelCase
|
||||
on the wire, nulls omitted, unknown fields skipped both ways — `IpcCodecTests` pins the last, which is what
|
||||
makes an additive field safe.)*
|
||||
- A request the Agent cannot answer gets `Error { code, message }` with the request's `id`: `UnknownType`,
|
||||
`Malformed` (no `id` when the envelope itself could not be read), `ProtocolMismatch`, `HandlerFaulted`. The
|
||||
connection survives all four.
|
||||
|
||||
### Messages
|
||||
|
||||
| Type | Dir | Payload / notes |
|
||||
|---|---|---|
|
||||
| `Hello` | UI→A | `{ appVersion, protocol: 2 }` → `HelloAck { agentVersion, protocol, elevated, overlayBuildId, vulkanLayerRegistered, telemetrySource /* composite, e.g. l1+lhm+nvapi */, cpuTempAvailable, etwAvailable }` |
|
||||
| `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? }` |
|
||||
| `SetWatchlist` | UI→A | `{ entries: [{ gameId, exePath }] }` — full replace; UI re-sends on connect. **Carries no hooking state** (see §The pipe is not a trust boundary) |
|
||||
| `LaunchGame` | UI→A | `{ gameId }` → suspended-launch + inject path (`04_CAPTURE` §Launch mode) |
|
||||
| `SetHookEnabled` | UI→A | `{ gameId, enabled }` — Agent re-runs the static AC pre-scan and may reply `Refused`. **The Agent stamps the consent timestamp itself** |
|
||||
| `PauseCapture` / `ResumeCapture` | UI→A | global |
|
||||
| `StopSession` | UI→A | `{ sessionGuid }` — graceful unhook + finalize |
|
||||
| `UpdateRules` | UI→A | **no payload** — a trigger, not a source. The Agent re-reads only its own `%LOCALAPPDATA%\FrameLedger\rules\` copy |
|
||||
| `Shutdown` | UI→A | graceful stop |
|
||||
| `SessionStarted` | A→UI | `{ sessionGuid, gameId, pid, tier, startedAt }` |
|
||||
| `SessionProgress` | A→UI | 1 Hz: `{ elapsedS, nativeFps5s, displayedFps5s, fgFactor?, fgMode, upscaler, upscalerQuality, renderW/H, outputW/H, rtActive, gpuTempC?, cpuTempC?, vramProcMb, latencyUs? }` |
|
||||
| `SessionCompleted` | A→UI | `{ sessionGuid, sessionId, exitStatus, tier }` — UI loads the full row from SQLite |
|
||||
| `CaptureRefused` | A→UI | `{ gameId, reason, 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) |
|
||||
| `CaptureDegraded` | A→UI | `{ sessionGuid, from, to, 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 |
|
||||
| `SafetyUnhook` | A→UI | `{ sessionGuid, signal }` — anti-cheat appeared mid-session; prominent UI notice |
|
||||
| `CaptureError` | A→UI | `{ code, message }` — `InjectFailed`, `RingVersionMismatch`, `EtwAccessDenied`, ~~`PresentMonMissing`~~ (retired with the tool, 2026-08-27 — a code naming an implementation nobody chose), `TelemetryUnavailable`, `DbWriteFailed` |
|
||||
| `Ping`/`Pong` | both | 15 s keepalive |
|
||||
| `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.)* |
|
||||
| `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`.)* |
|
||||
| `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 |
|
||||
| `SetGuardBypass` | UI→A | `{ gameId, enabled, disclosureVersion? }` → `GuardBypassAck { gameId, enabled, outcome }` (owner decision 2026-09-21, `19_SAFETY` §The user's bypass). `enabled: true` records that the user accepted the bypass disclosure for this game's executable: refused with `DisclosureVersionMismatch` for any version but the Agent's own `GuardBypassDisclosure.Version`, `ExecutableUnreadable`, `UnknownGame`, or `DisclosureUnavailable` where no store was composed; `outcome` is the store's `ConsentWriteOutcome` (`StaleFingerprint` when the binary is not the row's). `enabled: false` withdraws it. It writes two columns and enables nothing. **There is no global form of this message.** `HookEnabledAck.prescan` gains the value `"bypassed"`: the pre-scan refused, the finding was written, and the consent was stamped beside it |
|
||||
| `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 }` — UI loads the full row from SQLite; `sessionId` is null and `finalize` is `discarded` when the row was not stored (under the minimum length); `exitStatus` is the row's vocabulary (`normal` · `crashed` · `unhooked_safety` · `degraded`); `reason` is the loop's `SessionEndReason` |
|
||||
| `CaptureRefused` | A→UI | `{ gameId, gameName, reason, family?, signal? }` — **guard fired**; UI shows the plain-language explanation — ~~and the Tier-2 offer~~; there is no alternative measurement to offer, only the option to record the session unmeasured (`08_UI` §Safety events). *(Built: for `RefusedByGuard`, `RefusedPreviouslyBlocked`, `RefusedKillSwitch` and `PreScanCouldNotVerify` — the last with no family, because "could not verify" is neither a hit nor a pass; `family`/`signal` are the verdict's. A game merely not enabled or not consented raises nothing: that is an ordinary Tier-2 row, not a refusal to explain.)* |
|
||||
| `CaptureDegraded` | A→UI | `{ sessionGuid, from: 1, to: 2, reason }` — Tier 1 → Tier 2 mid-flight, or overlay self-disabled. **Under a two-rung ladder this means measurement STOPPED**, not that it continued at lower fidelity, and the notice must say so. *(Built: `SupervisionLost`, `WriterSelfDisabled`, `WriterStoppedBlocklisted`, `WriterNeverInstalledHooks`, `SupervisionFaulted`, `KillSwitchEngaged` — `RecordedSessionEvents.Classify` is the table.)* |
|
||||
| `SafetyUnhook` | A→UI | `{ sessionGuid, family?, signal? }` — anti-cheat appeared mid-session; prominent UI notice. *(Built: the verdict that FIRED, not the pass that started the session — `CaptureOutcome.Verdict` carries the supervisor's last verdict on this reason since 2026-09-13.)* |
|
||||
| `CaptureError` | A→UI | `{ sessionGuid?, code, message }` — `InjectFailed`, `RingVersionMismatch`, `AttachRefused`, ~~`EtwAccessDenied`~~ (struck 2026-09-13 with the tier), ~~`PresentMonMissing`~~ (retired with the tool, 2026-08-27 — a code naming an implementation nobody chose), `TelemetryUnavailable`, `DbWriteFailed`, `SessionFaulted` (the session's task threw before finalize; the `.partial` stays for recovery, and no `SessionCompleted` follows). *(Built: `RingVersionMismatch` for a layout / record-size / build-id refusal — the "restart the game after an update" case — `AttachRefused` for the rest of the ring's refusals, `InjectFailed` for a target that could not be started, pinned, read or singled out.)* |
|
||||
| `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
|
||||
|
||||
@@ -329,6 +382,14 @@ message, and that message always re-scans.
|
||||
## Client behavior (UI)
|
||||
|
||||
- Connect with 250 ms × 8 backoff; on failure start the Agent, retry; then show an Agent status banner with Repair.
|
||||
|
||||
> **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.
|
||||
- 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).
|
||||
|
||||
+300
-1
@@ -28,6 +28,49 @@ WPF + **WPF UI (Wpf.Ui, Fluent)**. Shell = `ui:FluentWindow` with custom `ui:Tit
|
||||
|
||||
The Menu sits in its own row **below** the TitleBar (never inside the drag region — 16 §Gotchas).
|
||||
|
||||
> **Menu bar as of 2026-09-14 (P4 PR-3).** File ▸ Export is the submenu this section specifies — Session CSV /
|
||||
> Session JSON write the session last selected on a Sessions tab or opened in a summary window
|
||||
> (`Services/SessionSelection`, `SessionExportService` over the summary window's own writers; no selection says
|
||||
> so in the strip), Chart PNG opens that session's summary window, where the plot is. Help ▸ Documentation opens
|
||||
> the README (`IssueLink.Documentation`; `docs/` is developer-facing). Help ▸ Report a bug… runs
|
||||
> `BugReportFlow` (`10_LOGGING` §Bug report flow steps 2–4). Tools ▸ Update detection rules is PR-1's. **File ▸
|
||||
> Import library… is PR-4's** (`ImportLibraryFlow` → the review checklist `ImportReviewPrompt` / `Dialogs/ImportReviewContent`,
|
||||
> a `DataGrid` with a tick column like Compare's picker — store, game, the executable to add, a note for
|
||||
> "already in the library" / "no executable found" / "guessed — check it"; Add selected lands every row hooking
|
||||
> off and shows the Games page; `05_DETECTION` §Platform signatures built note). **Help ▸ Check for updates is PR-5's** (`Update/UpdateService.CheckInteractivelyAsync`, the
|
||||
> dialogs of `11_UPDATER` §Flow; a downloaded update is the shell's persistent InfoBar with the one button,
|
||||
> disabled while a session runs — FR-12 — and "update available" is a tray balloon only while the window is off
|
||||
> screen). ~~Still "later build": Tools ▸ Database maintenance.~~ **Tools ▸ Database maintenance… is PR-7's (2026-09-15)**:
|
||||
> a `ContentDialog` (`Dialogs/DatabaseMaintenanceContent`, `ViewModels/DatabaseMaintenanceViewModel`) with four cards —
|
||||
> Check integrity, Back up…, Sweep raw data…, Compact — and one status line; the sweep confirms in a `MessageBox` with a
|
||||
> Danger button (§UX rules) and is sent to the Agent, compaction is refused while a session runs, and a backup is never
|
||||
> written onto the ledger itself (`06_DATA_MODEL` §Retention built note). No menu item says "not built yet" any more:
|
||||
> `NotYetCommand` and its two strings are gone.
|
||||
>
|
||||
> **Built 2026-09-13 (P3 PR-2): the shell, and only the shell.** `FluentWindow`, the TitleBar with the
|
||||
> Agent pill as trailing content, the Menu row (every item that a later slice builds says so in a 4 s
|
||||
> snackbar rather than doing nothing), the NavigationView with the four items and Settings in the footer,
|
||||
> the offline `InfoBar` with Retry, `SnackbarPresenter` and `ContentDialogHost`. The Dashboard shows the
|
||||
> Agent status card (`HelloAck`/`StatusAck`, every value `N/A` until answered); Games, Compare and Logs
|
||||
> 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`,
|
||||
> because H.NotifyIcon 2.4.1 converts only file-backed image sources) and follow the pipe's session events —
|
||||
> ● when any running session is Tier 1, ◐ when sessions run and none is measured, ⏸ when the Agent reports
|
||||
> paused, the ring otherwise; the tooltip names the game. Menu: Open, Pause/Resume capture (one
|
||||
> `PauseCapture`/`ResumeCapture` request; the state shown is the `PauseAck`'s, never assumed), Agent status (the
|
||||
> Dashboard), Exit (a real exit through `ShellHost.Quit`, whatever minimize-to-tray says); a left click opens the
|
||||
> window. **Minimize to tray on close** hides the live window when `ui.minimize_to_tray` is on and a tray icon
|
||||
> exists (`WindowClosePolicy`); a language rebuild's old window is unaffected. **FR-3.8's balloon** — "Session
|
||||
> saved — <game> — click to view" — is raised only while the window is off screen; on screen, the Dashboard's
|
||||
> snackbar carries the same event (one event, exactly one channel), and its click opens the summary window.
|
||||
> A safety event is never a balloon (`TrayViewModelTests` asserts it). Tools ▸ Agent status… and Tools ▸ Vulkan
|
||||
> layer registration… now navigate (Dashboard, Settings) instead of saying "not yet".
|
||||
|
||||
**Tray (H.NotifyIcon):** icon states idle / ● capturing (T1 hooked) / ◐ recording only (T2 — nothing measured) / ⏸ paused; menu: Open, Pause/Resume capture, Agent status, Exit. Closing the window minimizes to tray when enabled.
|
||||
|
||||
## Notifications policy
|
||||
@@ -41,6 +84,28 @@ The Menu sits in its own row **below** the TitleBar (never inside the drag regio
|
||||
|
||||
~~The "capture without injection instead" action is **Tier 2, which needs an elevated Agent**~~ — **rewritten 2026-08-28, and the button's whole meaning changed.** There is no no-injection measurement, so this action cannot be offered as an alternative way to measure. What it may offer is **recording the session anyway**: duration, hardware telemetry and the reason nothing was measured. It needs no elevation. **Label it for what it does** — "record this session without measuring it" — because a button that says "capture without injection" beside a refusal reads as a second measurement path, and the previous wording was corrected once already for exactly that.
|
||||
|
||||
> **Built 2026-09-14 (P3 PR-8a).** `Services/SafetyNotices` subscribes to the pipe's events and turns
|
||||
> `CaptureRefused`, `SafetyUnhook` and `CaptureDegraded` into `SafetyNotice`s the shell renders as an
|
||||
> `ItemsControl` of `ui:InfoBar`s in `MainWindow` row 2, under the Agent banner and above every page — Error for
|
||||
> a refusal and an unhook, Warning for a degrade, `IsClosable="False"`, no timeout. The text is the `Safety_*`
|
||||
> family (`Safety_Refused_Named_Format` with the family and the signal, `_Unnamed`, `_CouldNotVerify`,
|
||||
> `Safety_Unhooked_Format`) followed on a refusal by `Notice_Refused_Recording` ("the session is still recorded —
|
||||
> 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
|
||||
> 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).
|
||||
>
|
||||
> **Corrected 2026-09-14, after the owner saw a red bar with no way out.** WPF UI 4.3.0's `InfoBar` template has
|
||||
> **no `ContentPresenter`**, so the action button above — placed as the InfoBar's Content, the only dismissal once
|
||||
> `IsClosable="False"` removed the X — was never rendered. The view model was right and the screen was wrong.
|
||||
> `Styles/FrameLedger.xaml` now carries the upstream template verbatim plus the presenter (`16_WPFUI_SYNTAX`
|
||||
> §Gotchas), the same fix reaching the Agent-offline banner's Retry and the game page's Re-enable. Guarded by
|
||||
> `PagesLoadTests.TheInfoBarTemplateRendersItsContent`, which renders both templates and fails when upstream
|
||||
> gains a presenter — the signal to delete the copy.
|
||||
|
||||
## FPS display rule (global, FR-4.2 / CLAUDE.md rule 6)
|
||||
|
||||
Reusable control `FpsReadout` (custom control styled with WPF UI theme brushes):
|
||||
@@ -49,6 +114,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".
|
||||
- **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).
|
||||
|
||||
@@ -66,6 +133,16 @@ All screens are `Page`s registered with the navigation page provider and navigat
|
||||
- Recent sessions list (last 10 across games) → click opens session summary.
|
||||
- Totals strip: games tracked, total playtime, sessions this week (`ui:Card` row).
|
||||
|
||||
> **Built 2026-09-14 (P3 PR-5): the Agent card, the live card, the recent list, the totals.** The live card
|
||||
> is `LiveCaptureViewModel` over the pipe's `SessionStarted` / `SessionProgress` / `SessionCompleted`
|
||||
> (marshalled through the captured `SynchronizationContext`): game, tier badge, elapsed, the `FpsReadout` at
|
||||
> 1 Hz under the display rule (Presented FPS with its census chip until frame generation is measured), the
|
||||
> measured `renderW×H → outputW×H` with upscaler + quality, the RT chip, GPU/CPU temperature, per-process VRAM.
|
||||
> The sparkline is PR-6's. Recent = `ISessionRepository.ListRecentAsync(10)` with game names; a completed
|
||||
> 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.
|
||||
|
||||
### 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.
|
||||
- **Game detail:**
|
||||
@@ -74,6 +151,28 @@ All screens are `Page`s registered with the navigation page provider and navigat
|
||||
- **Supports** — greyed capability chips from files on disk ("Supports DLSS-G", "Supports XeSS"). Static inference.
|
||||
- **Last session measured** — accent chips with real values ("DLSS Quality · 1440p → 2160p", "Frame Generation DLSS-G ×1.9", "Ray Tracing: Yes"). Measured.
|
||||
- **Hooking control** (`ui:CardControl` with `ToggleSwitch`): off by default. Turning it on opens the consent dialog (FR-2.1). When the static anti-cheat pre-scan blocked it, the switch is **disabled** with the reason shown inline and no way to force it. When auto-disabled after crashes, an `InfoBar` explains and offers manual re-enable.
|
||||
|
||||
> **Built 2026-09-14 (P3 PR-5): the grid, the detail page's header, the two rows, the hooking control and
|
||||
> the Sessions tab.** Grid: `ui:CardAction` cards with platform / engine / hooking badges, sessions, playtime,
|
||||
> last played (the sparkline is PR-6's); search and sort in memory; FR-1.1 by File ▸ Add game…, the page's
|
||||
> button, or an `.exe` dropped on the page (a `.lnk` needs the shell-link reader, later); FR-1.4 through
|
||||
> `Wpf.Ui.Controls.MessageBox` with **Keep sessions / Delete sessions too**, revoking consent over the pipe
|
||||
> FIRST when it was on. Detail: header (name, publisher · version · store · engine, last session's date and
|
||||
> API, the last hooked session's `FpsReadout`, the three chips resolved with the annotation and the game
|
||||
> default — `Application.TriState.TriStateResolution`), Edit… (FR-1.3, a `ContentDialog` badging detected
|
||||
> fields), **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** (`19_SAFETY` §The user's bypass, FR-2.7: a `CardControl` with a `OneWay` toggle under the hooking card, its body text, and — while it is on — a non-closable **Error** `InfoBar` saying so; ON opens `GuardBypassPrompt`, a `ContentDialog` whose Danger primary button is enabled only while the acknowledgement is ticked AND `BYPASS` is typed, `DefaultButton = Close`; OFF needs no dialog; the switch shows the ROW, never the click; a blocked row's hooking toggle becomes usable while the bypass is on and the block's text stays on the page — as "The guard found: … You chose to bypass it", not as "Hooking is disabled for this game", which is what beta.3 printed beside a hooking switch that was ON; a session that started under it reads "· Guard bypassed: <family>" in the list's exit column and carries an Error `InfoBar` in its summary), **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
|
||||
> switch with `Safety_Blocked_Toggle_Format` inline; an unverified pre-scan leaves it enabled and says so;
|
||||
> auto-disabled shows `Safety_AutoDisabled_Format` with the re-enable button. Sessions tab: the `DataGrid` of
|
||||
> FR-6.1 — every Tier-2 cell that is Tier-1-only reads `N/A`, a measured-none Displayed / FG× reads `—`, both
|
||||
> 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.
|
||||
- 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).
|
||||
@@ -82,33 +181,233 @@ All screens are `Page`s registered with the navigation page provider and navigat
|
||||
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.
|
||||
|
||||
> **Built 2026-09-14 (P3 PR-7): tabs 2–6.** Frametime and Distribution show the session selected in the
|
||||
> Sessions tab (the same `FrametimeChart` / `DistributionChart` as the summary window; a Tier-2 or
|
||||
> retention-swept selection says why there is nothing). **Trend**: `Charts/TrendSeriesBuilder` — one point per
|
||||
> hooked session oldest first under the selector (Average = Native where frame generation was measured and
|
||||
> Presented where it was not, the note beside the chart says so; Displayed only where measured; the lows; max
|
||||
> GPU °C), FR-6.4's exclusion of `settings_changed_midsession` sessions by default with the toggle and the
|
||||
> excluded count, and FR-6.3's markers — labelled dashed lines wherever two consecutive sessions' hardware
|
||||
> snapshots differ in GPU driver, GPU, CPU, display mode or OS ("GPU driver: 572.16 → 576.02"). **Sensors**:
|
||||
> GPU core / hotspot °C, load % and power W (right axis) on one plot; VRAM on another with the game's own
|
||||
> per-present `vram_proc` (a held 1 Hz sample) and the adapter-wide `vram_adapter` sensor as two
|
||||
> differently-labelled series. **Latency**: the `latency_us` blob with the stored avg / p95 lines, shown only
|
||||
> when Reflex reported (`reflex_active`); otherwise the tab says so.
|
||||
|
||||
### 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.
|
||||
|
||||
> **Built 2026-09-14 (P3 PR-6).** `Windows/SessionSummaryWindow` (a secondary `FluentWindow` with its own
|
||||
> `ContentDialogHost`), opened from a Sessions-tab row (double-click or Open) and from the Dashboard's recent
|
||||
> list. Stat cards read the STORED aggregates — never recomputed — with the lows labelled *(presented)* when
|
||||
> frame generation was not measured (`03_METRICS`); a Tier-2 session shows N/A cards, a sentence, and no
|
||||
> charts. Chips resolve through `TriStateResolution` and click into FR-8.3's dialog (`TriStateOverridePrompt`:
|
||||
> measured / Yes / No / N/A, "also this game's default"); the override lands on `session_annotations`, the
|
||||
> measurement stays, clearing restores it. Bars: crash (`Error`), safety unhook (`Warning`). Charts
|
||||
> (`Charts/`): `SessionSeriesLoader` decodes the blobs once — cumulative time, the generated and gap bits, the
|
||||
> application-frame view with `Domain.Metrics.StutterDetector` over it (the stored count's own rule), segments
|
||||
> mapped from frame index to seconds, sensors aligned to `t_ms` with −1 dropped; `FrametimeChart` draws the
|
||||
> application-frame series (the every-present series behind the FR-5.4 toggle, shown only when generated frames
|
||||
> exist), stutter markers coloured by cause where `pso_created` says PSO compile (FR-5.5; the VRAM-budget cause
|
||||
> 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).
|
||||
> **FR-5.3:** `Charts/Decimator` — every bucket's min and max in order, ≤ 4000 points per series per draw, a
|
||||
> 500k-point series keeps its spike and its dip (`DecimatorTests`). Zoom and pan are ScottPlot's.
|
||||
> **FR-9:** `SessionExporter` — the CSV with `03_METRICS` §Export schema's column line verbatim and the `#`
|
||||
> header block (tier, api, hardware, the tri-states with sources, the segments, the 1 Hz VRAM note),
|
||||
> InvariantCulture throughout, no rows for Tier 2; the JSON (`frameledger-session/1`: metadata, the row as
|
||||
> aggregates with N/A omitted, segments, the annotation); PNG through `Plot.SavePng`. Tags (comma-separated,
|
||||
> de-duplicated) and notes save to the annotation row. **FR-3.8** is an in-app notice on `SessionCompleted`
|
||||
> (saved / discarded); the tray toast with "View" arrives with the tray (PR-8).
|
||||
|
||||
### 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.
|
||||
|
||||
**Mixed-tier guard (FR-6.2):** selecting sessions from different capture tiers shows a blocking `ContentDialog` explaining that they measured different things; proceeding stamps the chart with a tier legend and greys out metrics unavailable in the lower tier. Sessions with `settings_changed_midsession` carry a warning icon and are excluded from trend lines by default.
|
||||
|
||||
> **Built 2026-09-14 (P3 PR-7).** `CompareViewModel` over the last 200 sessions across games: a `DataGrid`
|
||||
> picker with a checkbox column (Compare enabled at 2–5), the FR-6.4 warning icon per row; **Compare** asks
|
||||
> `IMixedTierPrompt` (a `ContentDialog`, default button Cancel) when the selection mixes tiers and compares
|
||||
> nothing on a decline; a comparison that proceeds carries `Compare_Mixed_Legend` as the plot's title and an
|
||||
> `InfoBar`. `CompareChart` overlays one percentile curve per hooked session (`Charts/PercentileCurve`, the
|
||||
> distribution tab's own); the stat table is one row per metric — Native, Displayed and Presented FPS as three
|
||||
> 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`.
|
||||
|
||||
### 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).
|
||||
|
||||
> **Built 2026-09-14 (P3 PR-8a).** `LogsViewModel` over `Services/LogTail`: the newest file of the chosen source
|
||||
> (App / Agent) read with `FileShare.ReadWrite` — Serilog keeps it open — capped at the last 2 MB with the partial
|
||||
> first line dropped, refreshed every 2 s while the page is on screen (the page's Loaded/Unloaded start and stop
|
||||
> the timer) and never while paused; the level filter reads the `[HH:mm:ss.fff LVL]` prefix of 10_LOGGING's
|
||||
> template (continuation lines such as stack frames keep only under All); the search is a plain `ui:TextBox`, not
|
||||
> an `AutoSuggestBox` — there is nothing to suggest. The view is a read-only `TextBox` in Consolas that scrolls to
|
||||
> the end on every refresh unless paused. "Export bug bundle" is 10_LOGGING's step 2 and nothing more (see there).
|
||||
> The status line says shown / total / file. Tests: `LogTailTests`, `LogsViewModelTests`, and the page renders in
|
||||
> `PagesLoadTests`.
|
||||
|
||||
### Settings
|
||||
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.
|
||||
|
||||
> **Built 2026-09-14 (P3 PR-8a), with three rows deferred to PR-8b and one to PR-9.** `SettingsViewModel` over
|
||||
> `Application.Settings.RegisteredSettings` (the registry of `06_DATA_MODEL` §Settings registry — every write is
|
||||
> one `settings` row, and a key the Agent reads gets the 4 s "Applied. The capture agent reads it at the next
|
||||
> session start" line, D16). **Capture, first:** the kill switch as a `CardExpander` whose header is the toggle
|
||||
> and whose state line says "All hooking is off" / "Per-game settings decide" — it is `hooking.kill_switch`, the
|
||||
> gate's fourth input (`CaptureSession` consults it at every 30 s re-scan, so a running measured session stops at
|
||||
> its next scan; nothing else needs pushing); the hook-enabled list is `games.hook_enabled` as the ledger has it,
|
||||
> and its per-row "Turn off" is `HookingConsent.DisableAsync` — `SetHookEnabled { enabled: false }` over the
|
||||
> pipe, the Agent clears the column, the App never writes a hook-state column (D15; `SettingsViewModelTests`
|
||||
> asserts the row is still enabled after a fake Agent acked); the Vulkan layer row reads
|
||||
> `HelloAck.VulkanLayerRegistered` and says "unknown" without a HelloAck; the safety link opens
|
||||
> `19_SAFETY_AND_ANTICHEAT.md` at the public repository in the user's browser (nothing is fetched).
|
||||
> **Recording:** minimum session length, sensor interval and raw-series retention as `ui:NumberBox`es bounded by
|
||||
> the registry; a value outside the range is refused in place (the previous value comes back, a warning names the
|
||||
> range, nothing is written); background capture as a toggle with the honest sentence (recorded, measured only if
|
||||
> hook-enabled and not Vulkan). **Agent:** the elevation state from `HelloAck.Elevated` with the paragraph above
|
||||
> (not required by any tier; unlocks CPU temperature through PawnIO and attaching to elevated games); the logon
|
||||
> task row says the scheduled task arrives with the tray build. **Window:** "Start FrameLedger with Windows" is
|
||||
> `Infrastructure.Startup.RunAtLogon` — this user's `HKCU\…\Run` value, quoted executable path, never HKLM —
|
||||
> and the Run entry is the truth the toggle loads from; "Minimize to tray on close" is stored now and honoured
|
||||
> when the tray exists. **Privacy:** ~~`privacy.online_metadata`, off by default, with the network sentence~~ — 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
|
||||
> Agent flags they need. Tests: `SettingsViewModelTests` (seven cases), `RunAtLogonTests` (Infrastructure, under
|
||||
> a test's own value name), and the page renders in `PagesLoadTests`.
|
||||
>
|
||||
> **8b built 2026-09-14.** The Vulkan layer row gained **Register / Unregister** and the logon task row
|
||||
> **Register / Repair / Remove**; each button runs the Agent's flag as a child process (`IAgentTool` →
|
||||
> `FrameLedger.Agent.exe --register-vklayer` / `--unregister-vklayer` / `--install-task` / `--uninstall-task`)
|
||||
> and then re-reads the machine (`IMaintenanceState`: the HKCU key, Task Scheduler) — the text shown is what the
|
||||
> machine holds, never what the button assumed. Register is enabled only while the layer DLL is staged, the
|
||||
> registration is absent and ~~a game has hooking on~~ **a hook-enabled game references the Vulkan loader (P4 PR-2,
|
||||
> 2026-09-14: `HookedGameViewModel.UsesVulkan` from `capability_flags`)** (the same rule the Agent's reconciler
|
||||
> 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.
|
||||
|
||||
### First-run flow
|
||||
1. Legal Gate (FR-11): four documents, scrollable, links to GitHub-hosted versions, single Accept.
|
||||
2. Agent setup: runs **unelevated by default** — a short, honest paragraph explains that elevation is optional and unlocks CPU temperature and elevated-game attach. ~~and the Tier-2 ETW fallback. It must be explicit that **without elevation there is no Tier 2**~~ — **struck 2026-08-28: no tier needs elevation, so there is nothing to warn about here.** Capability check results shown afterwards. ~~with Tier-2 availability listed as its own badge~~ — there is no availability to report.
|
||||
3. Hooking explainer: what Tier 1 vs Tier 2 means — **and it must be explicit that Tier 2 measures nothing**, because the honest version of this screen is the one where a user who declines knows what they are declining — and that hooking stays off until enabled per game.
|
||||
4. Optional library import.
|
||||
|
||||
> **Built 2026-09-14 (P3 PR-9).** `Windows/FirstRunWindow` around `Controls/FirstRunContent` over
|
||||
> `FirstRunViewModel`, shown by `ApplicationHostService` **before the shell** whenever `Services/LegalGate`
|
||||
> says so — a first run, or a document whose version moved — and by Settings ▸ "Reopen the legal documents"
|
||||
> in read-only mode. **(1) The gate:** the four documents ride in the assembly (`LegalDocuments`: `legal/EULA.md`,
|
||||
> the root `LICENSE` as the GPLv3 text, `legal/DISCLAIMER.md`, `legal/PRIVACY_POLICY.md`, embedded at build so the
|
||||
> App shows the text this build was reviewed with; HTML authoring comments stripped; `{{RELEASE_DATE}}` left for
|
||||
> `release.yml`), a list on the left, the text in a read-only box, "View on GitHub" per document, **one Accept**
|
||||
> that writes four `legal_acceptance` rows with each document's own `**Version:**` line (`GPL-3.0-only` for the
|
||||
> licence), and Decline, which ends the host — the shell never appears. Closing the window without deciding is a
|
||||
> decline. **(2) Agent setup:** the honest paragraph (unelevated by default; elevation optional, unlocks CPU
|
||||
> temperature and elevated-game attach, required by no tier) and the facts from `HelloAck` as they arrive —
|
||||
> state, version, telemetry source, overlay build, CPU temperature, elevated — N/A until the Agent answers.
|
||||
> **(3) The explainer:** the consent dialog's own reviewed Tier 1 / Tier 2 paragraphs (`Safety_Consent_Hooked` /
|
||||
> `_NotHooked`, so the two screens cannot drift), that hooking stays off until enabled per game, and that the
|
||||
> Disclaimer states the risk. **(4)** ~~the import placeholder (P4)~~ **since P4 PR-4 (2026-09-14) a real pointer: the stores' libraries are imported from File ▸ Import library… once inside, every row hooking off** (the step itself stays text — the review dialog needs the shell's dialog host, which the first-run window has not). D8 unchanged: the gate is not a consent
|
||||
> precondition. Tests: `LegalDocumentsTests`, `FirstRunViewModelTests` (required on empty, one Accept = four
|
||||
> rows at the documents' versions, a moved version re-shows only that document, decline/close write nothing,
|
||||
> read-only records nothing, the Agent facts), the two steps rendered in `PagesLoadTests`.
|
||||
>
|
||||
> **NFR-4, measured 2026-09-14 on the dev box (Debug build, warm disk):** the first window (the shell, or the
|
||||
> first-run window on a first run) is logged every run as "shown N ms after process start" — 1.3–1.5 s for the
|
||||
> shell across PR-2 to PR-8b's smoke runs and 0.83 s for the first-run window on PR-9's, under the 2 s ceiling; a 100-session game's list + annotations query is a few
|
||||
> milliseconds (`SqliteSessionQueryTests`, ceiling 500 ms asserted); charts draw at most `Decimator.DefaultBuckets × 2`
|
||||
> points per series per draw whatever the session size (`DecimatorTests` over 500 000 points), which is what keeps
|
||||
> pan/zoom interactive. The Win10 22H2 visual pass is the owner's (NFR-8, no VM here).
|
||||
|
||||
## UX rules
|
||||
|
||||
- Empty states for every list ("No sessions yet — launch a tracked game and FrameLedger will do the rest").
|
||||
- All destructive actions confirm via `Wpf.Ui.Controls.MessageBox` (async — 16 §Dialogs): delete game/sessions, DB maintenance.
|
||||
- Notifications strictly per the policy above (snackbar / InfoBar / tray).
|
||||
- Keyboard: NavigationView items Ctrl+1…5; grids fully navigable; Esc closes flyouts/dialogs.
|
||||
- Keyboard: ~~NavigationView items Ctrl+1…5; grids fully navigable; Esc closes flyouts/dialogs~~ — §Accessibility below, since P4 PR-8 (2026-09-15); this bullet named three behaviours and none of them was built or checked.
|
||||
- No blocking dialogs during capture; errors surface as InfoBars/tray toasts.
|
||||
- Charts and stat numbers use culture-aware formatting per active UI culture (09); colors only from theme resources or the per-theme chart palette (16 §ScottPlot).
|
||||
|
||||
## Accessibility
|
||||
|
||||
NFR-9 names three things — full keyboard navigation, adequate contrast in both Fluent themes, Per-Monitor V2 DPI —
|
||||
and this section is what they mean for this app, each with the test that holds it (P4 PR-8, 2026-09-15). Until then
|
||||
the requirement was one bullet under §UX rules, and nothing checked it.
|
||||
|
||||
### Keyboard
|
||||
|
||||
| Keys | Does | Where |
|
||||
|---|---|---|
|
||||
| **Ctrl+1 … Ctrl+5** (and the numeric keypad's 1–5) | Dashboard · Games · Compare · Logs · Settings | `MainWindow` `InputBindings` → `MainWindowViewModel.NavigateToCommand` → `ShellShortcuts` |
|
||||
| **Alt**, **F10** | Focuses the menu bar; arrows and Enter walk File / Tools / Help | WPF `Menu`, nothing custom |
|
||||
| **Tab / Shift+Tab** | Moves through a page in reading order | layout order; no `TabIndex` overrides |
|
||||
| **Arrows, Home/End, Page Up/Down** | Move within a `DataGrid` (Sessions, Compare picker, Import checklist) | `DataGrid` defaults |
|
||||
| **Esc** | Closes the open `ContentDialog` or `MessageBox` with no result — the same as its Close/Cancel button | `DialogKeyboard`, one class handler per dialog type registered at start-up |
|
||||
|
||||
**Esc is the Close button, never the primary one.** On the consent dialog (FR-2.1) that is "Keep it off": nothing is
|
||||
stamped. A dialog that offers no Close button is not dismissed by Esc, and the Legal Gate (FR-11) is a window of its own
|
||||
(`FirstRunWindow`) with explicit Decline and Accept, on which Esc does nothing. WPF UI 4.3.0 handles no key in
|
||||
either dialog type (its `ContentDialog.cs` and `MessageBox.cs` at tag 4.3.0 have no key handler — read 2026-09-15),
|
||||
which is why the handler is ours.
|
||||
|
||||
### Screen readers
|
||||
|
||||
- Every interactive control that shows no text of its own carries `AutomationProperties.Name` from `.resx` — the
|
||||
toggles and choice boxes on Settings, the hooking switch on a game's page, and the icon-only close button in the
|
||||
`InfoBar` template. A control *with* visible text needs nothing: its text is its name.
|
||||
- `PagesLoadTests`-style scan (`AccessibilityTests.EveryTextlessControlHasAName`): every `Button`, `ToggleSwitch`,
|
||||
`ToggleButton`, `CheckBox`, `ComboBox` and `HyperlinkButton` in the App's XAML either has content or a name. A new
|
||||
unnamed one is red.
|
||||
- Status lines that change after an action (the Database maintenance result) are `AutomationProperties.LiveSetting="Polite"`.
|
||||
|
||||
### Contrast
|
||||
|
||||
Colours come from the WPF UI theme dictionaries and nothing else, so contrast is the Fluent themes' — both of which
|
||||
meet it — and cannot be broken locally: `AccessibilityTests.NoXamlHardCodesAColour` fails on any `#RRGGBB` or named
|
||||
colour in the App's XAML. The chart palette is the one deliberate exception (`16_WPFUI_SYNTAX` §ScottPlot: one
|
||||
palette per theme, chosen with the theme).
|
||||
|
||||
> **"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`).
|
||||
|
||||
### Known gaps, stated
|
||||
|
||||
- ScottPlot plots are not keyboard-operable (no focus, no pan/zoom by keys). The numbers behind them are on the
|
||||
session summary's stat cards and in File ▸ Export (CSV/JSON).
|
||||
- No screen-reader pass with Narrator has been done; the names above are necessary, not proven sufficient. That pass
|
||||
is the owner's.
|
||||
+21
-8
@@ -2,9 +2,16 @@
|
||||
|
||||
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 and the guard-bypass card in English. 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).
|
||||
- One `Strings.resx` (+ `Strings.vi.resx`, `Strings.ja.resx`) per assembly that has user-visible text (`App`, `Shared` for error codes). Access through a generated strongly-typed class; **no string literals in XAML/C# for user-visible text** (analyzer TODO: Meziantou MA0011/manual review in PR checklist). **As built (P3 PR-2, 2026-09-13):** the class is `Strings.Designer.cs`, written by `tools/resx-gen.ps1 -Resx <file>` and **committed** — not the SDK's `ResXFileCodeGenerator`, which the SDK-style WPF project does not run — with `Culture`, `ResourceManager`, `Keys`, and one property per key; the audit below fails when it is stale. The first family is `src/FrameLedger.App/Strings.resx` (65 keys); `Shared`'s arrives with PR-4's `Safety_*` text, because an empty family is what the audit refuses.
|
||||
- XAML binding via `{x:Static res:Strings.Key}` plus a `LocalizeExtension` for the few dynamic cases.
|
||||
- **Runtime switching:** setting change → set `CultureInfo.CurrentUICulture` + `Thread` defaults → re-create the main window shell (cheap; state preserved via VM). Persist in `settings`.
|
||||
- `SatelliteResourceLanguages` = `en;vi;ja` in the App csproj to keep publish size down.
|
||||
@@ -25,7 +32,7 @@ Languages: **en** (neutral/default) · **vi** · **ja**. Same `.resx` pattern as
|
||||
- `en` written first, is authoritative.
|
||||
- `vi` authored by the maintainer.
|
||||
- `ja` machine-drafted, each entry marked with `<comment>review</comment>` until reviewed; the About dialog credits reviewers.
|
||||
- CI check (`tools/resx-audit`): every key present in all three files; missing → build warning list artifact.
|
||||
- CI check (`tools/resx-audit`): every key present in all three files; ~~missing → build warning list artifact~~ **missing is RED (2026-09-13)**: `tools/resx-audit.ps1` exists since P3 PR-2 as `build.ps1` step 15, self-test first (11 fixture cases, at least four must go red) then the live pass over every `Strings.resx` under `src/`. Per family it requires C#-identifier keys with non-empty neutral values, **exactly** the neutral key set in `vi` and `ja` (a missing key would fall back to English silently; an extra one is dead text), the `Safety_*` rule below, and a current `Strings.Designer.cs`. A tree with no family is red, not green — the gate must not be vacuous.
|
||||
|
||||
## Glossary (fixed translations)
|
||||
|
||||
@@ -52,7 +59,7 @@ Technical benchmark vocabulary stays in English across all locales where the com
|
||||
|
||||
Consent, refusal, and safety-unhook text (FR-2.1, `19_SAFETY`) is **reviewed like legal text, not like UI text**:
|
||||
|
||||
- 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.
|
||||
- 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.
|
||||
|
||||
@@ -63,10 +70,16 @@ Consent, refusal, and safety-unhook text (FR-2.1, `19_SAFETY`) is **reviewed lik
|
||||
> console text is out of `.resx` scope. That is why the PR that introduced it ships no en/vi/ja
|
||||
> strings.
|
||||
>
|
||||
> **It is also why `ConsentProvenance` has no FR-2.1 member.** The host writes a consent record on
|
||||
> **It is also why `ConsentProvenance` ~~has no FR-2.1 member~~ had no FR-2.1 member until 2026-09-13.** The host writes a consent record on
|
||||
> the strength of an operator acknowledgement whose first line states, in substance, that it is
|
||||
> *not* the FR-2.1 dialog. Drafting that dialog's wording English-only inside a developer tool
|
||||
> would manufacture the reviewed artifact without the review this section requires — no `.resx`
|
||||
> file exists anywhere in the tree yet, and `tools/resx-audit` does not exist either. The enum has
|
||||
> exactly two members and a test asserts it, so adding the FR-2.1 value is a deliberate act that
|
||||
> arrives with its reviewed strings or not at all.
|
||||
> would manufacture the reviewed artifact without the review this section requires — ~~no `.resx`
|
||||
> file exists anywhere in the tree yet, and `tools/resx-audit` does not exist either~~ (both exist
|
||||
> since P3 PR-2, 2026-09-13; the App's family holds ~~shell text~~ every screen's text as of PR-9, 2026-09-14, and still no `Safety_*` key — those live in `FrameLedger.Shared`'s family, shared by both processes). The enum has
|
||||
> ~~exactly two members~~ ~~**exactly three members since 2026-09-10**~~ **exactly four members since 2026-09-13** (P3 PR-4 added `ConsentDialog`, whose reviewed `Safety_Consent_*` text and whose producer — the Agent's `SetHookEnabled` stamp — landed in the same PR; P2 PR-F had added
|
||||
> `AgentConsoleOperator`, the shipped Agent's console verb — HANDOFF §P2 decision D4 — which is
|
||||
> likewise *not* FR-2.1 and says so in its first line; this sentence said "two" for three days after
|
||||
> that) and a test asserts the list, so adding the FR-2.1 value is a deliberate act that arrives with
|
||||
> its reviewed strings or not at all. ~~**P3 is where it arrives** (HANDOFF §P3)~~ **It arrived with P3 PR-4 (2026-09-13)**: `Safety_*` in `en` and
|
||||
> `vi` (`src/FrameLedger.Shared/Strings.resx`, 20 keys), `ja` marked for human review and shown as `en` until signed, and `tools/resx-audit` ~~built in
|
||||
> the same phase~~ built first (PR-2), so PR-4's family landed under a gate that already existed.
|
||||
@@ -2,11 +2,11 @@
|
||||
|
||||
## Serilog configuration
|
||||
|
||||
- Sinks: rolling file per process — `logs/ui-.log`, `logs/agent-.log` (`rollingInterval: Day`, `retainedFileCountLimit: 7`, `fileSizeLimitBytes: 10 MB`, `rollOnFileSizeLimit: true`). Console sink in DEBUG builds.
|
||||
- Sinks: rolling file per process — `logs/ui-.log`, `logs/agent-.log` (`rollingInterval: Day`, `retainedFileCountLimit: 7`, `fileSizeLimitBytes: 10 MB`, `rollOnFileSizeLimit: true`). Console sink in DEBUG builds. *(`ui-.log` is written since 2026-09-13, P3 PR-2, with `Process=ui` enriched and every unhandled path — Dispatcher, AppDomain, unobserved task — logged as Fatal/Error; ~~the crash dialog and minidump of §Crash handling are still P4's~~ — built 2026-09-15, P4 PR-9, §Crash handling's note.)*
|
||||
- Minimum level `Information` (`Debug` toggle in Settings → applies live via `LoggingLevelSwitch`).
|
||||
- Enrichers: process name, version, `SessionGuid` and `GamePid` scoped properties during capture (`LogContext.PushProperty`).
|
||||
- Template: `[{Timestamp:HH:mm:ss.fff} {Level:u3}] {SourceContext} {Message:lj} {Properties:j}{NewLine}{Exception}`.
|
||||
- **Never log:** full user paths outside `%LOCALAPPDATA%\FrameLedger` (redact to `<user>`), machine name, any exe arguments of games. A `RedactingEnricher` enforces the path rule.
|
||||
- **Never log:** full user paths outside `%LOCALAPPDATA%\FrameLedger` (redact to `<user>`), machine name, any exe arguments of games. ~~A `RedactingEnricher` enforces the path rule.~~ *(No such enricher was ever written: found 2026-09-15, checking `legal/PRIVACY_POLICY.md` §3's "logs are redacted (user directory paths removed) before bundling" against the bundle, which copied the logs verbatim. An enricher could not have kept the rule anyway: exception text and the Overlay's native log never pass through one, and the data directory itself sits under the user's profile, so every run logs a user name. The rule is enforced where a log leaves the machine instead: `App/Services/LogRedactor` over every log copy in the bug bundle, §Bug report flow step 2. The files in `logs\` keep their full paths; they leave the PC only if the user copies them.)*
|
||||
- Capture hot path logs nothing per-frame; counters summarized at finalize.
|
||||
|
||||
## Crash handling (the app's own crashes)
|
||||
@@ -15,20 +15,134 @@
|
||||
- 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
|
||||
> path and a Warning line, and the partial file is removed.
|
||||
>
|
||||
> **The App.** A `DispatcherUnhandledException` is marked handled, so the process lives long enough to ask; then
|
||||
> `Services/CrashReporter` runs Fatal → dump → `Services/CrashDialog` → on Yes, the shell window revealed (a window
|
||||
> hidden in the tray would hold the report's dialogs where nobody sees them) and `BugReportFlow` → the host's
|
||||
> `StopApplication`, and `RunAsync` exits with code 1 after the normal teardown (with no host yet, `Shutdown(1)`
|
||||
> directly). The dialog is a **Win32 `MessageBox`**, not a WPF UI one: the shell's dialog host, theme and dispatcher are
|
||||
> what a crash cannot vouch for. It says where the dump is (or that none could be written), that the capture agent keeps
|
||||
> running, and that the report shows every file and includes the dump only when ticked. **One report per process**: a
|
||||
> further exception while the dialog is up shows nothing; the first of those is logged whole and the rest are counted,
|
||||
> because a fault in a layout pass repeats on every pass the dialog's own message loop runs and would flood
|
||||
> `ui-*.log`. A failed dump still asks; a failed report is an Error line, not a second crash. An
|
||||
> `AppDomain.UnhandledException` (any other thread) is Fatal + dump only: the runtime is already ending the process and
|
||||
> no dialog can be relied on to appear, so the next bug report offers that dump instead. An unobserved task stays an
|
||||
> Error line. A startup failure `RunAsync` catches itself (the ledger will not open, the host will not start) is not an
|
||||
> unhandled exception: ~~it is still a Fatal line and exit code 1 with no dialog~~ **since 2026-09-15 it is the Fatal
|
||||
> line and `Services/StartupFailureDialog`**, a Win32 message box with the exception's message and the log folder, whose
|
||||
> Yes opens that folder; exit code 1 either way. Until then nothing on screen said FrameLedger had even tried to start.
|
||||
> Tests: `StartupFailureDialogTests`.
|
||||
>
|
||||
> **The Agent** (no window, so no dialog): the same Fatal + dump from `AppDomain.UnhandledException` and from `Main`'s
|
||||
> own catch, once per process whichever sees it first, then the exception stays unhandled, so the exit is the runtime's
|
||||
> and never the Agent's usage code 1. The catch exists because an exception escaping `Main` runs `Main`'s `finally`
|
||||
> first, which closes the logger; the AppDomain handler alone would dump with no Fatal line.
|
||||
>
|
||||
> Tests: `CrashDumpWriterTests` (a real dump of the test process starts `MDMP` and carries the UTC time in its name; the
|
||||
> prune keeps five and touches no other file; an unusable directory is null and one line), `CrashReporterTests` (the
|
||||
> order, no report on No, three further exceptions show nothing and are counted, a failed dump still asks, a failed
|
||||
> report does not throw, the dialog's text with and without a dump).
|
||||
|
||||
## In-app log viewer (Logs screen)
|
||||
|
||||
Tails the active files (shared read), level filter, text search, pause autoscroll, "Open logs folder", "Export bug bundle". Reads at most last 2 MB per file into the view.
|
||||
|
||||
> **Built 2026-09-14 (P3 PR-8a)** — `App/Services/LogTail` + `LogsViewModel`; `08_UI` §Logs carries the built
|
||||
> note. One file at a time (the newest of the chosen source), not both; the 2 MB cap is `LogTail.MaxBytes` and
|
||||
> the read is `FileShare.ReadWrite | Delete` so Serilog's open handle and its daily roll never block it.
|
||||
|
||||
## Bug report flow (FR-13)
|
||||
|
||||
1. Entry points: Help → Report a bug, crash dialog, Logs screen button.
|
||||
2. **Bundle builder** creates `FrameLedger-bugreport-YYYYMMDD-HHmm.zip` in a user-chosen location:
|
||||
- `logs/` (last 7 days, redacted copies)
|
||||
- `sysinfo.json` (app + agent + **overlay build id**, OS build, CPU/GPU name, driver version, telemetry source, Vulkan layer state, PawnIO present?, elevation state, locale)
|
||||
- `overlay-<pid>-*.log` for the last hooked sessions, plus hook fault details and the ring's dropped/fault counters — these are what make injection bugs diagnosable at all
|
||||
- `overlay-<pid>-*.log` for the last hooked sessions, plus hook fault details and the ring's dropped/fault counters — these are what make injection bugs diagnosable at all. *(The file exists since 2026-09-06 — `17_HOOK_ENGINE` §Native logging: written at init, on the Agent's request at session end, and on the stop; `FAULT` lines carry the exception code and the hook's name, `UNHOOK_*` lines say per patch whether it was restored or left to a later hooker.)*
|
||||
- `settings.json` (sanitized — no paths)
|
||||
- optional checkbox: last session metadata + aggregates JSON (never raw blobs by default)
|
||||
- crash dumps included only when the user ticks the checkbox (size warning shown)
|
||||
|
||||
> **Step 2 built 2026-09-14 (P3 PR-8a), narrower than this list; steps 1 (Help menu, crash dialog), 3, 4 and 5
|
||||
> are P4's.** `App/Services/BugBundleBuilder` writes the zip where the Logs page's save dialog says
|
||||
> (`FrameLedger-bugreport-YYYYMMDD-HHmm.zip`): `logs/` = every `ui-*.log` and `agent-*.log` modified in the last
|
||||
> seven days, ~~**copied verbatim, not redacted** — the files carry no paths beyond the data directory and no
|
||||
> game data, and a redaction pass that nobody has specified would be a claim~~ **redacted since 2026-09-15, note
|
||||
> below** (the data directory is under the user's profile, so the claim was false on every machine); `overlay/` = the five newest
|
||||
> `overlay-<pid>-*.log` (the ring's counters and the `FAULT`/`UNHOOK_*` lines are in those files, not
|
||||
> separately); `sysinfo.json` = app version, and from the Agent's `HelloAck` when connected its version, the
|
||||
> overlay build id, telemetry source, Vulkan layer state, elevation, CPU-temperature availability (the
|
||||
> PawnIO question) and the disclosure version, plus OS version, bitness, locale and the write time — **no
|
||||
> CPU/GPU name or driver version**, which live in the ledger's hardware snapshots and are the session
|
||||
> metadata option this list already has; `settings.json` = every registry key's effective value (there is no
|
||||
> path-valued key). No session JSON ~~and no dumps~~ (PR-9 below). ~~The bundle is written and nothing else happens: no preview
|
||||
> dialog yet, no browser, no clipboard.~~ Tests: `BugBundleBuilderTests` (the seven-day cut, the overlay cap, a
|
||||
> `game-crash.log` beside ours is not shipped, both JSON files), `LogsViewModelTests` (the cancelled save writes
|
||||
> nothing).
|
||||
>
|
||||
> **Steps 1 (the Help menu), 3 and 4 built 2026-09-14 (P4 PR-3)** as `App/Services/BugReportFlow`, the one flow
|
||||
> behind Help ▸ Report a bug… and the Logs page's button: step 2's zip → step 3's `ContentDialog`
|
||||
> (`BugReportPreviewPrompt` / `Dialogs/BugReportPreviewContent`) listing every entry `WriteAsync` returned, with
|
||||
> "Show the zip in Explorer" and the drag instruction → step 4 as the dialog's two buttons: **Open GitHub issue**
|
||||
> opens `issues/new?template=bug_report.yml&title=[Bug]%20&labels=bug&app-version=…&os=…` — the form's field
|
||||
> ids are **hyphenated** (`app-version`, `os`), which is what GitHub prefills by, not the underscores step 4
|
||||
> above spelled; the OS is the form's own spelling (`Windows 11 26100.2314`, `IssueLink.OsText`) — and **Copy
|
||||
> summary as Markdown** puts `sysinfo.json`'s twelve keys on the clipboard as a table. Both behind ports
|
||||
> (`IBugReportPreview`, `IUrlOpener`, `IClipboard`) so `BugReportFlowTests` pins the exact URL without a browser.
|
||||
> ~~Still open from this list: the **crash dialog and the minidump** (§Crash handling, step 1's third entry point)
|
||||
> and the optional session-metadata / dump checkboxes of step 2.~~ PR-9 below, and the session-metadata checkbox after it (2026-09-15).
|
||||
>
|
||||
> **The log copies are redacted since 2026-09-15.** `App/Services/LogRedactor` is what the list's "redacted copies"
|
||||
> and `legal/PRIVACY_POLICY.md` §3 promised: in every `logs/` and `overlay/` entry the name in each
|
||||
> `X:\Users\<name>` path becomes `<user>`, and so does the last segment of this user's profile directory when it
|
||||
> lives elsewhere (`D:\Profiles\<name>`). Every spelling a log carries is covered: backslashes, the doubled
|
||||
> backslashes of Serilog's JSON properties, forward slashes, any case, a name with spaces, and the `?` the Overlay's
|
||||
> ANSI image path writes for a letter its code page lacks. The file is read as bytes through Latin-1, so a UTF-8
|
||||
> log and an ANSI one both come out byte for byte except the names. Over-redaction is the chosen failure:
|
||||
> `C:\Users\Public` reads `<user>` too. The measured need on the dev box: the profile path appeared 8 times in
|
||||
> `ui-*.log`, 7 in `agent-*.log` and in 175 overlay headers; no machine name or bare user name did. A crash dump is
|
||||
> memory and cannot be redacted, which its checkbox says. Tests: `LogRedactorTests` (fifteen cases, both
|
||||
> directions, UTF-8 and ANSI bytes), `BugBundleBuilderTests` (the copies carry no user name, the file on disk is
|
||||
> untouched).
|
||||
>
|
||||
> **The crash dump's checkbox and step 1's third entry point built 2026-09-15 (P4 PR-9).** When
|
||||
> `BugBundleBuilder.LatestCrashDump` finds a `*.dmp` written in the last seven days under `crashdumps\` (either
|
||||
> process's), the flow shows **Optional items** before the save dialog (`BugReportPreviewPrompt.AskCrashDumpAsync` →
|
||||
> `Dialogs/BugBundleOptionsContent`): one checkbox, **clear**, labelled with the dump's local time and its size in MB
|
||||
> (the size warning), and a line saying a dump is FrameLedger's own memory and can hold file paths, game names and
|
||||
> settings. Continue with the box clear writes the bundle without it; ticked, `crashdumps/<name>.dmp` goes in;
|
||||
> Cancel writes nothing. `WriteAsync` refuses a dump from anywhere but that directory, before the zip is created. It
|
||||
> is a dialog before the save rather than a box on step 3's preview because the preview lists a zip that is already
|
||||
> written. The crash dialog (§Crash handling) is step 1's third entry point. ~~Still open: the session-metadata
|
||||
> checkbox.~~ Built the same day, below. Tests: `BugBundleBuilderTests` (only when passed, only from the directory,
|
||||
> the newest of the week), `BugReportFlowTests` (no dump no question; left clear, ticked, cancelled),
|
||||
> `BugBundleOptionsViewModelTests`, `PagesLoadTests`.
|
||||
>
|
||||
> **The last session's checkbox built 2026-09-15**, which completes this list's optional items. The same **Optional
|
||||
> items** dialog carries a second box when the ledger holds a session: the newest one (`App/Services/LastSessionSummary`),
|
||||
> labelled with its game and local start time, with a line saying what the file holds. Ticked, the bundle gains
|
||||
> `session.json`: File ▸ Export's own JSON (`SessionExporter.Document` — metadata, aggregates, segments, hardware)
|
||||
> **without the user's notes and tags**, and passed through `LogRedactor` like a log because it names the executable.
|
||||
> No frame or sensor series, which is the list's "never raw blobs". The dialog now appears when either item exists and
|
||||
> not at all when neither does; the port's answer is `BugBundleOptions` (closed, or which boxes were ticked) where
|
||||
> PR-9's was `CrashDumpChoice`. Tests: `LastSessionSummaryTests` (the newest session, no notes or tags, nothing for an
|
||||
> empty ledger), `BugReportFlowTests` (left clear, and ticked with a profile path redacted in the zip),
|
||||
> `BugBundleOptionsViewModelTests` (every box clear, an absent item cannot be included), `PagesLoadTests`.
|
||||
3. **Preview step:** the dialog lists every file included and lets the user open the zip before continuing. Nothing is ever sent automatically.
|
||||
4. "Open GitHub issue" → launches browser to
|
||||
`https://github.com/poli0981/frameledger/issues/new?template=bug_report.yml&title=[Bug]%20&labels=bug&app_version=…&os=…`
|
||||
@@ -40,3 +154,17 @@ Tails the active files (shared read), level filter, text search, pause autoscrol
|
||||
- `Tools → Agent status…` shows the `HelloAck` capability set (telemetry source, overlay build id, Vulkan layer — ~~tier availability~~, which meant "is the ETW fallback reachable" and has no meaning under a two-rung ladder) + last 20 Agent log lines.
|
||||
- **Never include a game's own logs, saves, or config files** in a bug bundle, even when a crash looks game-related. We ship our logs only.
|
||||
- `--diag` CLI flag on the App prints environment + capability report to stdout (support requests).
|
||||
|
||||
> **Read-only since 2026-09-16:** `DiagAsync` opens the ledger through `LedgerDatabase.OpenReadOnlyAsync`, so a
|
||||
> diagnostic run against a ledger at another schema reports that fact (the schema line reads the refusal) rather
|
||||
> than migrating the file it was asked to describe.
|
||||
>
|
||||
> **Built 2026-09-14 (P3 PR-8a).** `App.OnStartup` sees `--diag` and runs `DiagAsync` instead of the host: no
|
||||
> window, no Agent, the ledger opened read-only for its schema version and the settings, then
|
||||
> `Services/DiagReport.Build` (app version, OS and bitness, runtime, locale, elevation, data and logs
|
||||
> directories, ledger schema or "could not open", whether `FrameLedger.Agent.exe` is beside the App, every
|
||||
> registry key's effective value) written to `logs/diag-<yyyyMMdd-HHmmss>.txt` **and** to stdout — the App is
|
||||
> a WinExe with no console of its own, so stdout carries the report only when the caller attached one or piped
|
||||
> it (`FrameLedger.exe --diag | more` works; a double-click leaves the file). Exit 0, or 1 with a Fatal line in
|
||||
> `ui-*.log`. The Agent's `--diag` stays on its `NotImplementedFlags` list — 10_LOGGING names the flag as the
|
||||
> App's. Tests: `DiagReportTests`.
|
||||
@@ -35,3 +35,65 @@ Binaries are not code-signed (project policy). Consequences and mitigations, doc
|
||||
## Versioning
|
||||
|
||||
SemVer `MAJOR.MINOR.PATCH`. Tag `vX.Y.Z` triggers the release workflow (13_CI_CD). `MAJOR` bumps for DB schema or IPC protocol breaks; migrations must cover every released `MAJOR-1` version.
|
||||
|
||||
## 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
|
||||
this PR) behind the `IUpdateClient` port — `VelopackUpdateClient` is the one implementation, `UpdateService` the
|
||||
flow, and the tests run the flow over a fake client because nothing here may touch the network in a test.
|
||||
|
||||
- **Startup silent check:** `UpdateHostedService`, 5 s after the host starts (the "5 s after UI idle" above —
|
||||
measured from start, because the shell shows synchronously inside it), only for a copy the installer laid down
|
||||
(`UpdateManager.IsInstalled`; a `bin/` build logs one line and does nothing) and only while `update.auto_check`
|
||||
is on (Settings ▸ Updates, default on — the "if enabled" above). Every failure is `Information` in the log,
|
||||
never a dialog. A release found is downloaded in the background; the tray raises a balloon only while the
|
||||
window is off screen (`08_UI` §Notifications policy), and the shell's persistent InfoBar carries the download
|
||||
and the **Restart to update** button.
|
||||
- **Manual check:** Help ▸ Check for updates → `UpdateService.CheckInteractivelyAsync` and the dialogs in
|
||||
`UpdatePrompts` (WPF-UI `MessageBox`): the offer with the release notes (the GitHub release body, shown as text —
|
||||
no Markdown renderer is shipped), the unsigned-release footer, Download / Later; "up to date"; "not an
|
||||
installed copy"; and the error table below. There is no progress *dialog*: progress is the banner's percent. A
|
||||
package that fails its checksum is downloaded once more before the Corrupt row is shown (the table's "auto-retry
|
||||
once").
|
||||
- **FR-12 is the shape of the flow, not a check at the end.** A downloaded package is `Ready` only while the Agent
|
||||
reports no session (its `StatusAck` at connect, then `SessionStarted` / `SessionCompleted` on the pipe);
|
||||
otherwise it is `Deferred`, the button is disabled and the body says why, and it becomes `Ready` when the last
|
||||
session ends. The apply is refused again inside if a session started meanwhile. A recording-only (Tier 2)
|
||||
session 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.
|
||||
- **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),
|
||||
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
|
||||
log — the "re-validated after update" above. Velopack keeps `current` stable, so `Installed` is the expectation.
|
||||
- **Channels:** `stable` = releases GitHub does not mark pre-release; `beta` = those too (`GithubSource(prerelease)`).
|
||||
Not Velopack's own `--channel` mechanism — one package set per tag, the GitHub flag decides. `13_CI_CD` §Branch &
|
||||
release policy.
|
||||
- **Hooks** (`VelopackHooks`, in the hand-written `Program.Main` so `VelopackApp.Run()` precedes any window):
|
||||
install registers nothing; uninstall = `UninstallHook` (`12_BUILD` §Publish & package). `Run()` in a copy the
|
||||
installer did not lay down returns at once and runs no hook (probed on 1.2.0); it does append a line to Velopack's
|
||||
own `%LOCALAPPDATA%\velopack\velopack.log` on every start — local, the library's, and stated here because it is a
|
||||
file outside `%LOCALAPPDATA%\FrameLedger`.
|
||||
- **Where it installs:** `%LOCALAPPDATA%\FrameLedger.App` (the package id), never `%LOCALAPPDATA%\FrameLedger`, which is
|
||||
the data folder Velopack would otherwise delete on uninstall (`12_BUILD` §Publish & package).
|
||||
|
||||
**Deviations from the table and the paragraph above, stated rather than left to be discovered:**
|
||||
|
||||
- `Update_Err_RateLimited` says "try again in about an hour", not "in {n} minutes": Velopack's downloader
|
||||
surfaces the status code (`HttpRequestException.StatusCode`) and not `Retry-After` / `X-RateLimit-Reset`.
|
||||
Likewise **no `If-None-Match` ETag** on the check — the request is Velopack's, not ours. The quota is 60/h
|
||||
anonymous; the App makes one request per start plus manual checks, so the header would change nothing in
|
||||
practice, but the sentence above promised it and this one withdraws it.
|
||||
- **No `GitHubHttpClient`**, no 10 s timeout of ours, no jittered retry: the HTTP is Velopack's
|
||||
`HttpClientFileDownloader`, subclassed as `FrameLedgerFileDownloader` only to put `User-Agent: FrameLedger/{version}`
|
||||
in place of `Velopack/1.2.0` (a read-only static there). The GitHub source adds no `Authorization` header for an
|
||||
empty token — measured on 1.2.0 by reflection, so the request identifies the product and nothing else. When the rules fetch is built
|
||||
(`05_DETECTION` FR-7.3, `20_OPEN_QUESTIONS` §S20 feed half) it needs a client of its own; this paragraph no
|
||||
longer claims the updater provides one.
|
||||
- Release notes are rendered as plain text, not Markdown.
|
||||
|
||||
`UpdateServiceTests` (App.Tests/Update) cover the two skips, the channels, Deferred ↔ Ready, each error row, and
|
||||
the apply's three endings; `UpdateFailureMapperTests` the table; `UninstallHookTests` the hook; a real feed has
|
||||
not been exercised — the first tag is the measurement (`13_CI_CD` §release.yml).
|
||||
+85
-17
@@ -23,12 +23,13 @@ Targets:
|
||||
- `FrameLedger.Overlay` → `FrameLedger.Overlay.dll`
|
||||
- `FrameLedger.VkLayer` → `FrameLedger.VkLayer.dll` + `VkLayer_FRAMELEDGER_overlay.json`
|
||||
- `FrameLedger.Injector` → **static lib only.** There is no `FrameLedger.Injector.exe` and none ships (`20_OPEN_QUESTIONS` §S9, decided 2026-08-02). A standalone `LoadLibraryW` injector that users can run is a path into a game process that the guard does not stand in front of — a bypass, and a bad look for a project whose position is "we refuse where we are not welcome". The Agent links the static lib; the guard owns the chokepoint inside it (§S13(b)), so there is no callable entry point that skips the gate. Manual testing uses `hook-harness`, never a real game (§Debugging).
|
||||
- `FrameLedger.NvapiBridge` → `FrameLedger.NvapiBridge.dll` (**2026-09-10, P2 PR-E2**): the C ABI the Agent reaches NVAPI through (`18_GPU_VENDOR_APIS` §L3) and the **only shipped binary that links `nvapi64.lib`**. Read-only by construction, loaded by the Agent into **its own process** by absolute path through `/FrameLedger.NvapiBridge.targets`, and **never into a game** — its name carries none of the words the guard's §S18 heuristic scans for. `fl_native_flags` only, not the hostile-environment set. `versioninfo-check.ps1` requires its version block like the other three shipped natives. ctest `fl_nvapi_bridge` (`src/native/tests/nvapi_bridge_test.cpp`) exercises every export and requires `BRANCH: AVAILABLE` or `BRANCH: DEGRADED` in the output, so a bridge gutted to `return 0` is red on a runner without the driver too.
|
||||
- `FrameLedger.Overlay.Tests` → Catch2 unit tests (ring buffer, record layout, fault filter, seqlock) **and the guard's fail-closed matrix** (`14_TESTING` §Safety-guard tests) — the guard is native, so its tests are too
|
||||
- `hook-harness` → the dummy **D3D11 + D3D12** app, WARP + composition swapchain so it runs headless on CI (`17_HOOK_ENGINE` §Test harness). D3D12 is device → command queue → swapchain, which is the acquisition asymmetry a D3D11-only fixture cannot exercise. Vulkan and OpenGL modes to follow as those hooks land.
|
||||
- `hook-harness` → the dummy **D3D11 + D3D12** app, WARP + composition swapchain so it runs headless on CI (`17_HOOK_ENGINE` §Test harness). D3D12 is device → command queue → swapchain, which is the acquisition asymmetry a D3D11-only fixture cannot exercise. ~~Vulkan and OpenGL modes to follow as those hooks land.~~ **`--vulkan --hold-presenting N` since 2026-09-06 (P1 item 3):** a real swapchain on a hidden window through the real loader, reached by `LoadLibraryW("vulkan-1.dll")` so only the vendored headers are needed and CI (no loader) still builds it; exit 77 = cannot run here, which the ctest reads as SKIP. **`--opengl --hold-presenting N` since the same day (P1 item 4):** a real context on a hidden window, `SwapBuffers`'d through gdi32 as a title does, on Microsoft's generic renderer — so it runs on CI.
|
||||
- `fl-probe-hookprofile` → build-profile probes for `/guard:cf` and `-D_HAS_EXCEPTIONS=0` (`20_OPEN_QUESTIONS` §H1/§H3)
|
||||
- `fl-probe-guard` → measures the Windows APIs the guard is built on, unelevated (`spike-notes.md` §1). Not the guard, and takes no injection rights.
|
||||
- `fl_stub_sl_interposer` → `sl.interposer.dll`, and `fl_stub_sl_common` → `sl.common.dll` (`src/native/tools/vendor-stubs/`). **Fixtures, never shipped**, built under `FL_BUILD_TOOLS`; nothing `12_BUILD` publishes references them. They export the **measured** vendor names from `docs/vendor-exports.json` so the Overlay's symbol resolution is observable, and the second is a **decoy** exporting the same name from a different module — without it, "we resolve module-scoped" is a property no test can falsify. Their **output filenames are the vendor's and their version blocks are ours**: `fl_add_version_resource` takes the real filename so a file called `sl.interposer.dll` in our build tree still says plainly that it is FrameLedger's, which `19_SAFETY` requires of everything we build.
|
||||
- `fl_stub_ffx_dx12` → `amd_fidelityfx_dx12.dll`, `fl_stub_ffx_upscaler` → `amd_fidelityfx_upscaler_dx12.dll`, `fl_stub_ffx_fg` → `amd_fidelityfx_framegeneration_dx12.dll` — the three AMD **leaves** — and `fl_stub_ffx_loader` → `amd_fidelityfx_loader_dx12.dll`, a **forwarding stand-in** bound to the two 2.x leaves through their FrameLedger-named *direct* entry — the way the real loader was measured to bypass the leaves' exports — so `--hold-presenting-ffx` can push every dispatch through a loader that is hooked along with the leaves and prove the count reads 1× (2026-09-04). Same rules as the Streamline stubs: fixtures, never shipped, vendor filenames with our version blocks.
|
||||
- `fl_stub_ffx_dx12` → `amd_fidelityfx_dx12.dll`, `fl_stub_ffx_upscaler` → `amd_fidelityfx_upscaler_dx12.dll`, `fl_stub_ffx_fg` → `amd_fidelityfx_framegeneration_dx12.dll` — the three AMD **leaves** — and `fl_stub_ffx_loader` → `amd_fidelityfx_loader_dx12.dll`, a **forwarding stand-in** bound to the two 2.x leaves through their FrameLedger-named *direct* entry — the way the real loader was measured to bypass the leaves' exports — so `--hold-presenting-ffx` can push every dispatch through a loader that is hooked along with the leaves and prove the count reads 1× (2026-09-04). Same rules as the Streamline stubs: fixtures, never shipped, vendor filenames with our version blocks. `fl_stub_ffx_fsr3_host` → `ffx_fsr3_x64.dll` (2026-09-05): the FSR 3.0 **host** facade, exporting the four names `SpeaksFsr3Host` probes for through the vendored `fsr3-v3.0.4` header's own `FFX_API`; `--ffx-topology fsr3host|fsr3host+mono` drives it, and `hookinventory-check` Pass C reads it as the export parser's second positive control.
|
||||
- **`fl_fidelityfx_headers`** → an INTERFACE target over the five vendored FidelityFX ffx-api headers (`src/native/third_party/fidelityfx/`, tag v2.3.0, MIT by exception). Three include directories because upstream's headers include each other by relative path; include directories only and nothing to link — no `.lib` is vendored — and `hookinventory-check` Pass C reads the Overlay's export table because `ffx_api.h` declares its entry points `__declspec(dllexport)` unconditionally.
|
||||
- **`fl_streamline_headers`** → an INTERFACE target over the vendored MIT Streamline headers (`src/native/third_party/streamline/`). Include directories only, **never linked**: `SL_API` entry points are `extern "C"` imports, and linking one would make `sl.interposer.dll` a load-time dependency of `FrameLedger.Overlay.dll`, which would stop the Overlay loading in every game that ships no Streamline — in the loader, before any of our code runs, with no message anywhere.
|
||||
|
||||
@@ -36,7 +37,7 @@ Compiler/linker flags (enforced in CMake, not per-target ad hoc): `/std:c++20 /M
|
||||
|
||||
**MinHook** is fetched by CMake `FetchContent` and built from source, pinned to the **commit** behind tag `v1.3.4` (`c3fcafdc`) rather than to the tag name — a tag can be moved, a commit cannot. FetchContent over a submodule so a fresh clone needs no extra step and CI has nothing to remember. Upstream warnings are not subjected to our `/W4 /WX`: warnings in third-party code are upstream's to fix, and failing our build on them would only tempt someone to patch the fetched copy, which drags it out of "consumed unmodified". The BSD-2-Clause notice ships in `legal/licenses/`, and `tools/license-check.ps1` fails the build if it goes missing while the FetchContent declaration is still present.
|
||||
|
||||
**NVAPI SDK** (MIT) **is vendored** at `src/native/third_party/nvapi/` — headers, `amd64/nvapi64.lib`, `License.txt`, consumed through `fl_nvapi` and proven by ctest `fl_nvapi_probe`. `legal/licenses/nvapi-MIT.txt` carries the notice and `license-check.ps1` binds the two bidirectionally.
|
||||
**NVAPI SDK** (MIT) **is vendored** at `src/native/third_party/nvapi/` — headers, `amd64/nvapi64.lib`, `License.txt`, consumed through `fl_nvapi`, proven by ctest `fl_nvapi_probe`, and **linked by a shipped binary since 2026-09-10** (`FrameLedger.NvapiBridge`, above). `legal/licenses/nvapi-MIT.txt` carries the notice and `license-check.ps1` binds the two bidirectionally.
|
||||
|
||||
> **This paragraph said "is not vendored yet" until 2026-08-09**, in the present tense, and added that `src/native/third_party/` *"contains `CMakeLists.txt` and `vulkan-headers` only"*. Both were false from #55 (2026-08-05) onward. The sentence was itself a correction — of an earlier claim that NVAPI *was* vendored when it was not — so this file has now been wrong in both directions about the same fact, which is worth more than the fix: **CLAUDE.md's pinned stack and `18_GPU_VENDOR_APIS` §L3 were updated when the vendoring landed and this one was not.** `legal/` is gated bidirectionally and caught its own version; `docs/` is not gated, and this is what that costs. Link it normally; do **not** resolve NVAPI by ordinal (that was a workaround for a licensing constraint that no longer exists, and it breaks across driver versions). Still guard `NvAPI_Initialize` failure as a normal path — plenty of users have no NVIDIA GPU.
|
||||
|
||||
@@ -54,7 +55,7 @@ Compiler/linker flags (enforced in CMake, not per-target ad hoc): `/std:c++20 /M
|
||||
> **`RuntimeIdentifier` is NOT set here, and this bullet claimed it was until 2026-08-06.** The props file's own comment explains why: forcing a RID onto class libraries pulls RID-specific assets into their restore for no benefit, so each executable sets it — `FrameLedger.App`, `FrameLedger.Agent` and now `FrameLedger.CaptureHost`, plus its test project, which needs the same RID to reference a RID'd exe. A new project copying this document rather than the props file would have inherited nothing.
|
||||
- Nullable enable, ImplicitUsings enable, `TreatWarningsAsErrors=true`, `AnalysisLevel=latest-all`, deterministic, `ContinuousIntegrationBuild` on CI.
|
||||
- `Directory.Packages.props`: central package management, all versions pinned (including `WPF-UI` = 4.3.0 exactly — `16_WPFUI_SYNTAX` §Version hygiene).
|
||||
- **Native output reaches the managed side through `.targets` files imported by `FrameLedger.Agent`**, not through `FrameLedger.Infrastructure`: `/FrameLedger.Guard.targets` (the guard DLL), `/FrameLedger.Overlay.targets` (the payload, §S22) and `/FrameLedger.Rules.targets` (the blocklist seed). Ordering comes from `build.ps1`, which runs the native build first — **not** from the solution: `FrameLedger.slnx` contains no native project.
|
||||
- **Native output reaches the managed side through `.targets` files imported by `FrameLedger.Agent`**, not through `FrameLedger.Infrastructure`: `/FrameLedger.Guard.targets` (the guard DLL), `/FrameLedger.Overlay.targets` (the payload, §S22), `/FrameLedger.Rules.targets` (the blocklist seed) and, since 2026-09-10, `/FrameLedger.NvapiBridge.targets` (the L3 bridge; it **warns rather than fails** when the DLL is absent, because a missing telemetry layer reports itself where a missing guard would be a safety hole). Ordering comes from `build.ps1`, which runs the native build first — **not** from the solution: `FrameLedger.slnx` contains no native project.
|
||||
|
||||
> **This bullet was wrong in four ways and is corrected 2026-08-04.** It named a copy of `FrameLedger.Injector.exe`, which §S9 closed and which line 25 above says does not exist, 24 lines earlier in the same document. It attributed the copying to a build target in `FrameLedger.Infrastructure.csproj`, which contains no `<Target>` at all. It said the copies happen there, when the guard DLL was deliberately moved out to a `.targets` file so it would stop flowing to every referencing project (§S18 blocker 3). And it credited the solution with an ordering the solution cannot express.
|
||||
- **Struct mirror check — ✅ built 2026-08-05.** `ShmLayoutMirrorTests` runs `tools/fl-layout-dump`, reads its JSON, and asserts size plus every field offset against the C# `[StructLayout]` mirrors in `FrameLedger.Shared` — in **both directions**, so a field on either side alone fails. It also asserts blittability, which offsets cannot see. The `struct-mirror` gate reads the run's `.trx` and fails when that test class did not execute, so deleting the test is red as well as breaking it. Struct drift between the two layers is the most dangerous silent bug in this architecture; the build now genuinely catches it.
|
||||
@@ -87,7 +88,28 @@ 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`, `--install-task`, `--uninstall-task`, `--register-vklayer`, `--unregister-vklayer`.
|
||||
Agent flags: `--serve`, `--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
|
||||
> surface, pinned by `AgentCommandLineSurfaceTests`: `consent list | grant --exe | revoke --exe`, `capture --exe
|
||||
> [--seconds n]`, `launch --exe [--args "…"] [--seconds n]`, `recover`, `sessions [--last n]`, `db path`,
|
||||
> `games add --exe`, `killswitch on | off | status`, and `--data-dir <dir>` — **under `--console` only**
|
||||
> (HANDOFF §P2 decision D6): `--serve` never takes one, so the product's `%LOCALAPPDATA%\FrameLedger` is not
|
||||
> selectable and an integration test cannot point the product at a profile. `AgentEndToEndTests` runs the
|
||||
> 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
|
||||
|
||||
@@ -96,7 +118,7 @@ Agent flags: `--serve`, `--console`, `--diag`, `--install-task`, `--uninstall-ta
|
||||
The struck text is kept because the *reason* it was written is still live. What it said next, and what remains true:
|
||||
|
||||
> **planned, not present.** `assets/` does not exist, nothing fetches or verifies the binary, and `EtwFrameSource` is unwritten. `20_OPEN_QUESTIONS` §M2 (does the pinned console binary still exist, run unelevated, and emit the 2.x column set?) is unanswered, so this is not merely unpinned — there is nothing to pin yet.
|
||||
- Vulkan layer manifest, **written** with the installed layer path at install time (Velopack hook) — but **not registered there**. Registration is a separate, later act.
|
||||
- ~~Vulkan layer manifest, **written** with the installed layer path at install time (Velopack hook) — but **not registered there**.~~ **The install hook writes nothing (P4 PR-5):** the manifest is written by the registrar the first time the ledger asks for the layer (`VkLayerRegistrar.Register`, P4 PR-2), so an install that never enables a Vulkan game has no manifest either. Registration is a separate, later act.
|
||||
|
||||
### The Vulkan layer is not registered at install time
|
||||
|
||||
@@ -117,15 +139,57 @@ the `--register-vklayer` Agent flag (§Agent flags — a manual repair tool, not
|
||||
normal path), and the Settings button (`08_UI` §Settings — it reflects and
|
||||
repairs state, it does not grant machine-wide reach on its own).
|
||||
|
||||
> **Enforced 2026-09-14 (P4 PR-2).** "A Vulkan game" is a static fact of the executable — it imports or
|
||||
> `LoadLibrary`s `vulkan-1.dll` — read by the Agent's detection sweep into `capability_flags` as `vulkan`
|
||||
> (`17_HOOK_ENGINE` §Vulkan built note). `Application.Vulkan.VkLayerReconciler` registers when the first
|
||||
> hook-enabled game carries it and unregisters when the last one is disabled, after every consent change and
|
||||
> after every sweep; the flag and the button run the same rule. The uninstall hook is still the updater's
|
||||
> (P4, Velopack).
|
||||
|
||||
## Version
|
||||
|
||||
**One source: the `VERSION` file at the repository root** (`MAJOR.MINOR.PATCH`, nothing else — P4 PR-5,
|
||||
2026-09-14). Before it, the managed assemblies carried the SDK's default `1.0.0` while CMake said `0.1.0`,
|
||||
two products claiming to be one.
|
||||
|
||||
- `Directory.Build.props` reads it into `<Version>` (assembly, file and informational versions; SourceLink's
|
||||
`+sha` suffix is off so About, `Hello` and the bug bundle print the version a user can find on the releases
|
||||
page). The read is conditional on `$(Version)` being empty, so `release.yml` passes `-p:Version=0.1.0-beta.1`
|
||||
for a pre-release and the assemblies carry the tag's full version.
|
||||
- `src/native/CMakeLists.txt` reads the same file into `project(VERSION …)`, which the `.rc` template turns
|
||||
into every VERSIONINFO block. CMake's `project()` accepts numbers only, so the native `FileVersion` is the
|
||||
numeric core even for a pre-release.
|
||||
- `tools/versioninfo-check.ps1` compares every built binary's `FileVersion` against the file (`x.y.z.0`), so a
|
||||
read that silently produced `0.0.0` on either side is red in the gate.
|
||||
- `release.yml` refuses a tag whose numeric core is not the file's. Bumping the version is one edit to
|
||||
`VERSION`, in the same commit as the changelog section, before the tag.
|
||||
|
||||
The Velopack package version is the tag's (`vpk pack --packVersion`), and `UpdateManager.CurrentVersion` reads
|
||||
the installed package's manifest — not the assembly — which is why the two are made to agree here rather than
|
||||
assumed to.
|
||||
|
||||
## Publish & package
|
||||
|
||||
```
|
||||
cmake --build --preset x64-release
|
||||
dotnet publish src/FrameLedger.App -c Release -r win-x64 --self-contained -p:PublishReadyToRun=true -o out/app
|
||||
dotnet publish src/FrameLedger.Agent -c Release -r win-x64 --self-contained -p:PublishReadyToRun=true -o out/app
|
||||
vpk pack --packId FrameLedger --packVersion {ver} --packDir out/app --mainExe FrameLedger.exe --icon assets/icon.ico
|
||||
vpk pack --packId FrameLedger.App --packVersion {ver} --packDir out/app --mainExe FrameLedger.exe --packTitle FrameLedger --releaseNotes out/notes.md --outputDir out/release
|
||||
```
|
||||
|
||||
> **Run by `release.yml` since 2026-09-14 (P4 PR-5)** — `13_CI_CD` §release.yml carries the steps around it
|
||||
> (the version gate, `{{RELEASE_DATE}}`, the published-tree assertion, checksums, the release). Both publishes
|
||||
> take `-p:Version=<tag>` (§Version). No `--icon`: `assets/icon.ico` does not exist, and this line named it
|
||||
> for six weeks.
|
||||
>
|
||||
> **The package id is `FrameLedger.App`, and this line said `FrameLedger` until 2026-09-14 — which would have
|
||||
> deleted every user's ledger on uninstall.** Velopack installs into `%LOCALAPPDATA%\<packId>` and removes that
|
||||
> directory when the app is uninstalled; `%LOCALAPPDATA%\FrameLedger` is the data folder (`LedgerPaths`, `07_IPC`,
|
||||
> `legal/PRIVACY_POLICY.md` §1). With the same id the install would live inside the ledger's folder and the
|
||||
> uninstaller would take `ledger.db` with it, without the question below. The title users see stays "FrameLedger"
|
||||
> (`--packTitle`); the installer is `FrameLedger.App-win-Setup.exe`. `UninstallHook.AreSeparate` refuses the data
|
||||
> delete if the two ever overlap again, so a future id change fails safe rather than silently.
|
||||
>
|
||||
> **Exactly two roots, and a gate now says so.** `src/FrameLedger.CaptureHost` — the unshipped
|
||||
> capture host — is outside the package because neither root references it, and
|
||||
> `tools/package-closure-check.ps1` is what keeps that true rather than remembered. It matters
|
||||
@@ -150,15 +214,15 @@ vpk pack --packId FrameLedger --packVersion {ver} --packDir out/app --mainExe Fr
|
||||
> 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.
|
||||
- Velopack hooks: installed → offer Agent setup + Vulkan layer registration; uninstalled → unregister the layer, remove the scheduled task, ask about the data folder.
|
||||
- `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
|
||||
|
||||
`{{RELEASE_DATE}}` in `legal/*.md` is the **only** placeholder that survives into
|
||||
the repository, and it is deliberate: the effective date of a legal document is
|
||||
the date it ships, which is not knowable at authoring time. `release.yml` — **which
|
||||
does not exist yet; `13_CI_CD` §release.yml records that** —
|
||||
the date it ships, which is not knowable at authoring time. `release.yml` (**built 2026-09-14**, P4 PR-5 — the step runs before the
|
||||
build, because the App embeds `legal/*.md`)
|
||||
substitutes it with the tag date when packaging, and `ci.yml` fails the build if
|
||||
**any other** `{{` token appears in `README.md` or `legal/*.md` (`13_CI_CD.md`
|
||||
§ci.yml). Everything else — repository URL, slug, developer identity, contact
|
||||
@@ -178,14 +242,17 @@ document the app displays for acceptance (FR-11) is a defect, not a template.
|
||||
7. `tools/coverage-gate.ps1` — reads this run's cobertura reports; self-arming, and armed today for
|
||||
`FrameLedger.Domain` and `FrameLedger.Application`
|
||||
8. `tools/rules-validate.ps1` (schema + `anticheat` block sanity — a malformed or empty blocklist is a safety bug)
|
||||
9. `tools/versioninfo-check.ps1` — reads the built binary, because what ships is what an anti-cheat vendor sees
|
||||
9. `tools/versioninfo-check.ps1` — reads the built binary, because what ships is what an anti-cheat vendor sees; since P4 PR-5 it also compares every `FileVersion` against the `VERSION` file (§Version)
|
||||
10. `tools/chokepoint-check.ps1` — injection and evasion primitives confined to one file, native **and** managed, plus the `FL_GUARD_TESTABLE` symbol check against the shipped artifacts
|
||||
11. **`tools/hookinventory-check.ps1`** — three passes: A resolves every vendor symbol the Overlay names against `docs/vendor-exports.json`, B sweeps for stray literals, C reads the BUILT Overlay's import table and asserts it imports no vendor module. C skips loudly under `-SkipNative`. **Missing from this list until 2026-08-28**, which is §R10 happening again
|
||||
12. **`tools/package-closure-check.ps1`** — both halves: the self-test (5 cases, 4 of which must go RED) **and** a live pass over this repository. It walks the transitive `ProjectReference` closure of the two publish roots below and fails on anything outside the allowlist, naming the reference edge. `FrameLedger.CaptureHost` is an injecting entry point kept out of the package by construction, and `20_OPEN_QUESTIONS` §S27 is closed on exactly that basis
|
||||
13. `tools/license-check.ps1` — asserts every vendored third-party has a licence copy in `legal/licenses/`, and that no Intel IGCL / AMD ADLX material has appeared in the tree
|
||||
13. `tools/license-check.ps1` — asserts every vendored third-party has a licence copy in `legal/licenses/`, and that no Intel IGCL / AMD ADLX material has appeared in the tree; since P4 PR-6 (§3) also that `legal/licenses/nuget/` is exactly what `tools/license-gather.ps1` writes for this build's restore output — every NuGet package the App and the Agent ship (77), both directions. `license-gather.ps1 -SelfTest` runs first: fourteen fixture cases, five that must be RED (a hand edit, a package that no longer ships, a URL-only licence with no reviewed override, an applied MPL Exhibit B, a missing restore output), and one run under tr-TR in a child process, because the output must not depend on the machine's culture
|
||||
13b. `tools/accuracy-check.ps1 -SelfTest`, then live — the accuracy block is ONE text (`legal/ACCURACY.md`) embedded verbatim in `README.md` and `legal/DISCLAIMER.md` §4; a copy that drifted, a copy with no markers, or an empty source is red. Four self-test cases, both directions (§S23-6, 2026-09-06)
|
||||
14. `tools/changelog-check.ps1 -SelfTest` — nine cases, five expected RED. The live half needs a pull request's changed-file list and is supplied by `ci.yml`
|
||||
15. `tools/resx-audit` — **skipped loudly; it does not exist, and no `.resx` file does either**
|
||||
14b. `tools/release-notes.ps1 -SelfTest` — five cases over a fixture changelog (a dated and an undated section, a missing one, a prefix that must not match, an empty one). The live half needs a tag's version and runs in `release.yml`, where a missing or empty section is a red release (P4 PR-5)
|
||||
15. `tools/resx-audit.ps1` — ~~**skipped loudly; it does not exist, and no `.resx` file does either**~~ **built 2026-09-13 (P3 PR-2)**: `-SelfTest` first (11 fixture cases, both directions), then the live pass over every `Strings.resx` family under `src/` — key sets equal across en/vi/ja, `Safety_*` in `ja` marked for review or signed, `Strings.Designer.cs` current with `tools/resx-gen.ps1`. A tree with no family is red (`09_I18N` §Translation workflow)
|
||||
16. **struct-mirror** — reads this run's `.trx` and fails when `ShmLayoutMirrorTests` did not execute, so deleting the mirror test is red as well as breaking it
|
||||
16b. **`tools/test-artifacts-check.ps1`** — `-SelfTest` first (seven cases, two RED), then live: an `overlay-*.log` created since this gate started, still in the real `%LOCALAPPDATA%\FrameLedger\logs` after the tests, whose first line names a `hook-harness*` image, fails the gate. It is what makes a test binary without its log sweep red (`17_HOOK_ENGINE` §Native logging, 2026-09-15); a game's log never counts
|
||||
17. Placeholder guard — fails if any `{{` token other than `{{RELEASE_DATE}}` survives in `README.md` or `legal/*.md`
|
||||
|
||||
> **This list was wrong in two ways until 2026-08-06 and both were the same kind of wrong.** Step 6
|
||||
@@ -196,9 +263,10 @@ document the app displays for acceptance (FR-11) is a defect, not a template.
|
||||
> list of what `check` does was missing 40% of it, which is worse than having no list: a reader
|
||||
> plans against it. `13_CI_CD.md` repeats the struct-mirror claim and is corrected with it.
|
||||
|
||||
CI runs the identical script (`13_CI_CD`), **with `-SkipIntegration`** — so a green CI is not
|
||||
evidence for anything touching the managed drain, and `./build.ps1 check` with no switches is what a
|
||||
developer runs before pushing.
|
||||
CI runs the identical script (`13_CI_CD`) with no switches since 2026-09-06 — `-SkipIntegration` was
|
||||
CI's from 2026-08-05 until §S19(b)'s signer half removed the refusal behind it — so a green CI is now
|
||||
evidence for the managed drain too, and `./build.ps1 check` with no switches is what a developer runs
|
||||
before pushing.
|
||||
|
||||
**Gates skip loudly.** A gate whose tool is not installed (no `cl.exe`) or not
|
||||
yet written prints `SKIPPED`, is listed again in the summary, and the run ends
|
||||
|
||||
+141
-24
@@ -1,6 +1,6 @@
|
||||
# 13 — CI/CD
|
||||
|
||||
FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, and repo-local workflows where they do not. `ci.yml` is repo-local **by necessity, not preference**: the ops repo's `reusable-desktop-csharp.yml` runs `dotnet restore` / `build` / `test` directly and exposes no input for a native pre-step, MSVC setup, or the Vulkan SDK. FrameLedger's build is mixed-toolchain and native-first, and `12_BUILD.md` §Local quality gate commits to CI running *the identical script* as local — a promise a pure-managed template cannot keep. CodeQL and release still call the ops repo.
|
||||
FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, and repo-local workflows where they do not. `ci.yml` is repo-local **by necessity, not preference**: the ops repo's `reusable-desktop-csharp.yml` runs `dotnet restore` / `build` / `test` directly and exposes no input for a native pre-step, MSVC setup, or the Vulkan SDK. FrameLedger's build is mixed-toolchain and native-first, and `12_BUILD.md` §Local quality gate commits to CI running *the identical script* as local — a promise a pure-managed template cannot keep. CodeQL is repo-local too (its own heading below says why), and so is `release.yml` since 2026-09-14 — the same native pre-step and the identical gate make a caller stub impossible for it as well; this sentence said both "still call the ops repo" until then.
|
||||
|
||||
> ⚠ Known gotcha (learned on earlier migrations): caller stubs **must declare explicit `permissions:` blocks** — permissions do not inherit into reusable workflows. Every stub below lists its own.
|
||||
|
||||
@@ -8,19 +8,79 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
|
||||
|
||||
### `ci.yml` — push to `main` + all PRs · **repo-local**
|
||||
- `runs-on: windows-latest`, .NET SDK pinned by `global.json` via `actions/setup-dotnet`, MSVC via `ilammy/msvc-dev-cmd`, NuGet cached.
|
||||
- Single step of substance: **`./build.ps1 check -SkipIntegration`** — the same script a developer runs before pushing. The gate list lives in `12_BUILD` §Local quality gate, **once**, rather than being restated here where it goes stale.
|
||||
- **`-SkipIntegration` is the one place local and CI deliberately differ**, and the reason is a measured property of the hard gate rather than flakiness: §S16 puts the injecting process's ancestors in the scan set, a .NET test host can load `System.Security.Cryptography.ProtectedData.dll`, and the guard's `protect` fragment then refuses our own harness (§S19(b)). So a green CI is **not** evidence for anything touching the managed drain or the capture host's end-to-end behaviour.
|
||||
- Single step of substance: **`./build.ps1 check`** — the same script, with the same switches (none), a developer runs before pushing. The gate list lives in `12_BUILD` §Local quality gate, **once**, rather than being restated here where it goes stale.
|
||||
- ~~**`-SkipIntegration` is the one place local and CI deliberately differ**~~ — **gone since 2026-09-06.** From 2026-08-05 CI passed it for a measured reason: §S16 puts the injecting process's ancestors in the scan set, a .NET test host loads `System.Security.Cryptography.ProtectedData.dll`, and the guard's `protect` fragment refused our own harness (§S19(b)). The signer half now verifies that module's embedded signature offline and reads `O=Microsoft Corporation` on the compiled-in bound, so the `Category=Integration` cases run here — **nine** when this was written, **20 across six classes** as of 2026-09-13 (Agent 6, CaptureHost 7, Infrastructure 7); count them with `grep -rl 'Category", "Integration' tests` rather than trusting either number — and a green CI IS evidence for the managed drain and the capture host's end-to-end behaviour. The switch remains in `build.ps1`, loud, for a developer who must.
|
||||
- **The hosted runner refuses guard scans intermittently — THREE failures in eight gate runs, measured
|
||||
2026-09-10 while merging P2's stack.** Every one was an `Category=Integration` case, every one passed on
|
||||
a re-run of the identical commit, and none was caused by the code under review. Two distinct shapes, and
|
||||
the second is not §S19(b):
|
||||
- `ShmDrainIntegrationTests.AnUnhookRequestStopsTheCaptureSideAndTheDrainCanSeeIt` at
|
||||
`GuardedInjectAsync(...).IsAllowed` — the guard refusing our own harness, §S19(b)'s shape.
|
||||
- `CaptureHostEndToEndTests.WhenTheTargetExitsTheHostStopsAndSaysWhy` with
|
||||
**`ProcessTreeUnavailable — could not establish the scan set`**: the guard could not walk the
|
||||
ancestors at all. That is a *different* failure from the fragment/signer one, and §S19(b) does not
|
||||
cover it. A runner under load whose process enumeration fails is the obvious hypothesis and it is
|
||||
**untested** — nobody has instrumented it.
|
||||
So: §S19(b)'s refusal is **reduced, not gone**, and it is not the only way a scan fails here. The
|
||||
earlier version of this bullet said "one run in the low tens", written after the first failure and
|
||||
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
|
||||
this flake rate from the run history will measure zero. Read the job logs, or keep the tally as it
|
||||
happens.
|
||||
- ~~**The step that would diagnose it runs AFTER the thing it diagnoses, so a gate failure skips it.**
|
||||
The signer probe below is step 8; the quality gate is step 7, and the job stops there. On the
|
||||
2026-09-10 failure the probe therefore printed nothing, which is the one run where its output would
|
||||
have named the refusing module. Moving it before the gate (or giving it `if: always()`) is a one-line
|
||||
change nobody has made, recorded here rather than done quietly in an unrelated PR.~~ **FALSE when
|
||||
written, corrected 2026-09-13.** The probe step has carried `if: always()` since #137 (`c5932cc`,
|
||||
2026-09-06) — four days *before* the failure this bullet describes — so a red gate does not skip it.
|
||||
Why the probe's output was not read on 2026-09-10 is therefore **unmeasured**: the run was re-run
|
||||
(`gh run rerun --failed`, next bullet), which replaced its logs, so the original step output is gone.
|
||||
The next Integration failure is the measurement: read the probe step *before* re-running. Struck rather
|
||||
than deleted because a session planned a workflow change on this bullet's word.
|
||||
- **Signer probe step** (2026-09-06): `fl-probe-signer` runs as its own step after the gate — `continue-on-error`, a measurement and not a gate — because `ctest fl_signer_probe` passes on a regular expression and prints nothing, so §S19(b)'s CI leg was never readable from the log. Its answers are read off this step.
|
||||
- Uploads coverage artifacts.
|
||||
- **Changelog gate**, on pull requests only: the changed-file list comes from GitHub's own view of the PR — not `git diff`, so a shallow checkout cannot silently produce a short one — and an empty list is refused rather than read as "no `src/` changes". It is a **step of the required `check` job** and deliberately not a job of its own: `main`'s required contexts are exactly `check` and the two `analyze` jobs, so a new job would go red while the merge button stayed green, which is what already makes `Rules / validate` advisory (§S23-2).
|
||||
|
||||
> **Three claims in this section were false and are corrected 2026-08-06.** There is no Vulkan SDK
|
||||
> step and there will not be one — the Khronos headers are vendored. `resx-audit` does not exist and
|
||||
> is skipped loudly, so no artifact of it is uploaded. And the struct-mirror parenthesis — *"that
|
||||
> step and there will not be one — the Khronos headers are vendored. `resx-audit` ~~does not exist and
|
||||
> is skipped loudly, so no artifact of it is uploaded~~ (exists since 2026-09-13, P3 PR-2, as a hard step
|
||||
> of the gate — red on a missing key, never an artifact; `12_BUILD` line 15). And the struct-mirror parenthesis — *"that
|
||||
> gate does not exist and `build.ps1` skips it loudly"* — has been false since 2026-08-05:
|
||||
> `build.ps1` implements it as a hard throwing gate that reads the run's `.trx` and fails when
|
||||
> `ShmLayoutMirrorTests` did not execute. `12_BUILD` carried the identical stale sentence and is
|
||||
> corrected with it; restating the gate list in two documents is what let one of them rot.
|
||||
- **Licence guard:** `tools/license-check` fails the build if a vendored dependency is missing its licence copy, or if Intel IGCL / AMD ADLX headers appear anywhere in the tree (`docs/18_GPU_VENDOR_APIS.md` §Vendor SDKs we deliberately do not use). Licensing regressions are silent and hard to unwind later — catch them at PR time.
|
||||
- **Licence guard:** `tools/license-check` fails the build if a vendored dependency is missing its licence copy, or if Intel IGCL / AMD ADLX headers appear anywhere in the tree (`docs/18_GPU_VENDOR_APIS.md` §Vendor SDKs we deliberately do not use), or — since P4 PR-6 — if `legal/licenses/nuget/` is not what `tools/license-gather.ps1` writes for the NuGet packages this build ships. A Dependabot bump therefore goes red until someone re-runs the script and commits the texts, which is the point: the new version's licence is read by a person before it ships. Licensing regressions are silent and hard to unwind later — catch them at PR time.
|
||||
- **Placeholder guard:** fails if any `{{` token survives in `README.md` or `legal/*.md`. Those are shipped, legally operative documents (FR-11 displays them in the first-run Legal Gate); an unsubstituted `{{DEVELOPER_NAME}}` in an EULA is not a cosmetic defect.
|
||||
- `permissions: contents: read`.
|
||||
|
||||
@@ -33,17 +93,60 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
|
||||
- Languages: `csharp` **and `cpp`** (manual build mode for C++, driven by the CMake preset). The native layer is where memory-safety bugs would live; excluding it would defeat the purpose. Verify the mixed template exposes a C++ build-command input; if it does not, this one goes repo-local too.
|
||||
- `permissions: security-events: write, contents: read`.
|
||||
|
||||
### `release.yml` — on tag `v*` · **PLANNED, NOT PRESENT**
|
||||
### `release.yml` — on tag `v*` · **repo-local, built 2026-09-14 (P4 PR-5)**
|
||||
|
||||
> `.github/workflows/` contains `ci.yml`, `codeql.yml` and `rules-publish.yml`. There is no release
|
||||
> automation at all: the publish commands exist only as a fenced block in `12_BUILD` §Publish &
|
||||
> package, and **nothing in this repository has ever run `dotnet publish`** — which is why
|
||||
> `out/app`'s real contents had never been asserted by anything until
|
||||
> `tools/package-closure-check.ps1` started walking the reference closure statically. Recorded
|
||||
> 2026-08-06 rather than left describing a workflow that does not exist.
|
||||
- Build + test (same script, native first) → publish App+Agent self-contained → ~~verify PresentMon SHA-256~~ *(retired 2026-08-27 — the console binary is not bundled; owner decision, `20_OPEN_QUESTIONS` §G)* → **verify VERSIONINFO present on `FrameLedger.Overlay.dll` and `FrameLedger.VkLayer.dll`** (identifiability is a safety requirement, `19_SAFETY`) → `vpk pack` → generate `SHA256SUMS.txt` → create GitHub Release with Velopack assets + checksums, release notes from `CHANGELOG.md` section.
|
||||
- Optional final step: submit installer hash to VirusTotal and append the report link to release notes (helps unsigned-binary trust).
|
||||
- `permissions: contents: write`.
|
||||
> **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~~ (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.
|
||||
- **Version gate first.** The tag must be `vMAJOR.MINOR.PATCH[-prerelease]`; its numeric core must equal the
|
||||
`VERSION` file (`12_BUILD` §Version); and `CHANGELOG.md` must carry a **non-empty** `## [x.y.z]` section for the
|
||||
full version, extracted by `tools/release-notes.ps1` (self-tested on every `build.ps1 check`). A missing
|
||||
section is a red release, not an empty note — the ledger's header said the opposite for five weeks.
|
||||
- `{{RELEASE_DATE}}` substituted in `legal/*.md` with the run's UTC date **before the build**, because the App
|
||||
embeds those documents (FR-11); any `{{` token left anywhere after that fails the job.
|
||||
- **The identical gate** — `./build.ps1 check`, native first, every tool including `versioninfo-check` against
|
||||
`VERSION`. A release never skips it.
|
||||
- `dotnet publish` App + Agent, self-contained + ReadyToRun, `-p:Version=<tag>`, into one `out/app`.
|
||||
- **The published tree asserted by name**: `FrameLedger.exe`, `FrameLedger.Agent.exe`, the four shipped natives
|
||||
`versioninfo-check` lists, `rules/detection-rules.json`; `FrameLedger.CaptureHost.exe` absent (`12_BUILD`:
|
||||
exactly two roots — `package-closure-check` proves it statically, this reads the directory); `versioninfo-check`
|
||||
run again over `out/app`, because a `.targets`-staged DLL that failed to copy is a warning to `dotnet publish`.
|
||||
- `vpk pack --packId FrameLedger.App` (the `vpk` tool pinned to the library's 1.2.0) with the release notes;
|
||||
`FrameLedger.App-win-Setup.exe` must come out, because README §Install names it. **Not `--packId FrameLedger`**:
|
||||
Velopack installs into and uninstalls `%LOCALAPPDATA%\<packId>`, which with that id is the data folder
|
||||
(`12_BUILD` §Publish & package). No `--icon` until `assets/icon.ico` exists.
|
||||
- `SHA256SUMS.txt` over every asset, published beside them and printed into the release body (`11_UPDATER`
|
||||
§Unsigned releases).
|
||||
- `gh release create` with the assets, `--verify-tag`, and `--prerelease` for a `-beta.N` tag.
|
||||
- The assets and the notes are also uploaded as a workflow artifact for the smoke checklist (`14_TESTING`
|
||||
§Release smoke).
|
||||
- ~~Optional final step: submit installer hash to VirusTotal~~ — not built; an upload of the installer to a third
|
||||
party is a decision the owner makes, not a step a workflow adds quietly.
|
||||
|
||||
### `rules-publish.yml` — on change to `rules/detection-rules.json` in `main`
|
||||
- Runs `tools/rules-validate` and fails on anti-cheat removals. The raw file on `main` **is** the distribution endpoint (05_DETECTION), so this workflow only gates correctness.
|
||||
@@ -92,13 +195,27 @@ Central package management makes Dependabot PRs single-file diffs.
|
||||
## Branch & release policy
|
||||
|
||||
- `main` protected: CI + CodeQL required, linear history, no direct pushes.
|
||||
- Release: update `CHANGELOG.md` (Keep a Changelog format) → tag `vX.Y.Z` → `release.yml` does the rest → 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; Velopack stable channel ignores them (explicit beta channel is v2 backlog).
|
||||
- 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)
|
||||
+28
-6
@@ -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.
|
||||
- **The user's bypass (2026-09-21) has its own proofs, and they are about what it must NOT do.** Native (`[bypass]` in `guard_test.cpp`): a blocklisted target is refused by the plain entry and injected by the acknowledged one with the same family and signal and a verdict that is not `kAllow`; a clean target is a plain allow; a foreign or absent payload is still refused and nothing is loaded; `IsGuardJudgement` is exactly its list. Managed: `GuardMirrorTests` holds the C# list against the native one for every reason; `HookedCaptureGateTests` proves the kill switch, an un-enabled game and a missing consent still refuse with the guard never asked, that an acknowledged request never takes the plain entry (and the reverse), and that a guard which does not know the bypass is the hard gate (the port's default implementation); `HookRequestFromConsentTests` that the fifth input needs a stored record naming its disclosure and the same executable; `GuardSupervisorTests` that a judgement is counted, kept and overruled while a fact still unhooks; `SqliteGuardBypassStoreTests` that it cannot exist for a game nobody added or another binary, touches neither block nor consent, and ends with consent or the executable; `AgentCommandHandlerTests` that the pipe re-checks everything; `GameDetailViewModelTests` that a declined disclosure sends nothing and the switch shows the row.
|
||||
- **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; the one way past it is `19_SAFETY` §The user's bypass); 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)
|
||||
|
||||
@@ -29,7 +30,7 @@ The anti-cheat guard is the one component where a bug can cost someone an accoun
|
||||
|
||||
### Golden metric tests (write first)
|
||||
- Hand-computed fixtures: time-based avg (not mean-of-FPS), median, p99/p99.9 with **linear interpolation** (include cases where interpolation and nearest-rank differ), min/max, σ, stutter rule, sufficiency guards at 999/1,000 and 9,999/10,000 frames.
|
||||
- FG ladder: records with API-sourced FG → `fg_source = api`; present-count delta only → `presentdelta`; ETW `FrameType` → `etw`; cadence ≥ 1.5 → `cadence`; ambiguous → `none`. Factor always = Displayed/Native regardless of rung.
|
||||
- ~~FG ladder: records with API-sourced FG → `fg_source = api`; present-count delta only → `presentdelta`; ETW `FrameType` → `etw`; cadence ≥ 1.5 → `cadence`; ambiguous → `none`. Factor always = Displayed/Native regardless of rung.~~ **Rewritten 2026-09-09 (P2 PR-A), because two of its rungs no longer exist and its last clause was the affirmative negative `03_METRICS` forbids.** `presentdelta` was retired as structurally zero and `etw` with Tier 2 (2026-08-28); "ambiguous → `none`" is exactly what rung 0 exists to prevent. The goldens now are `03_METRICS` §Frame Generation's: `FL_MEASURED_FG_COUNTS` clear → `N/A`, never `none`; a counted ratio ≤ 1.05 over a uniform window → `none` (reachable by COUNTING only); 1.05–1.5 → refused; a saturated count (255) → refused; a non-uniform window → refused rather than averaged; DXGI-counted Displayed may stand in the trio and in `presents/batch` and never in a frame-time distribution. Each refusal is a `FgRefusalKind`, and `FgWindowTests` / `DxgiCountedWindowTests` drive every one.
|
||||
- Upscaling: exact ratio from render/output pairs; **segment splitting** when resolution changes mid-stream; `settings_changed_midsession` flag; dominant-segment selection.
|
||||
- RT: AS-builds-only stream (inline RayQuery case) → `rt = Yes` — the specific regression the old design got wrong; dispatch-only → `Yes`; RT-capable device with neither → `No`; D3D11 → `N/A`. PT confidence scoring never yields `Yes`.
|
||||
- Tri-state precedence: `manual > measured > inherited > N/A`.
|
||||
@@ -38,7 +39,7 @@ The anti-cheat guard is the one component where a bug can cost someone an accoun
|
||||
### Parsers & infrastructure
|
||||
- Shm reader against a synthetic mapping: version mismatch → refuse; torn records skipped; dropped counter propagated.
|
||||
- ~~PresentMon CSV (Tier 2): header-map building with shuffled/unknown/missing columns, malformed lines, invariant decimal. Fixtures recorded from real runs.~~ **Removed 2026-08-27 with the tool.** Whatever Tier 2 ends up parsing needs its own row, written against the format it actually reads — and the lesson from the one parser that did get written is worth carrying: its CSV's first column was named `Application` while the value it counted was also `Application`, so resolving by NAME rather than position was load-bearing (`spike-notes` §11).
|
||||
- Steam ACF (KeyValues), GOG `.info`, Epic `.item`, itch receipt — real-world fixtures.
|
||||
- Steam ACF (KeyValues), GOG `.info`, Epic `.item`, itch receipt — real-world fixtures. **Since P4 PR-4 (2026-09-14):** the import's readers are driven by fixtures the tests write themselves (`ValveKeyValuesTests`, `StoreLibrarySourcesTests` — Steam's two-file shape across two library folders, GOG under a test HKCU key, Epic `.item` JSON, an itch receipt gzipped in the test), not by committed real-world files; a real-world corpus is still worth adding the day a launcher's format drifts.
|
||||
- `RuleEvaluator`: fixture directory trees per engine, including the "Unity markers present but UE structure too" ordering case.
|
||||
- Blob codecs round-trip for every series in `frame_blobs` (NaN forbidden — assert), including the two-pair `render_res` encoding and the three-bit `rt_flags` byte. SQLite migrations apply cleanly from an empty file to the current schema, and re-applying is a no-op. (There is no v1→v2 upgrade to test — `06_DATA_MODEL` §Migrations.)
|
||||
- IPC pipe: framing, split reads, oversize rejection, unknown fields/types ignored, protocol mismatch.
|
||||
@@ -50,12 +51,33 @@ The anti-cheat guard is the one component where a bug can cost someone an accoun
|
||||
- Harness presents 120 s at a controlled cadence → Overlay injected → ring drained → session written → assert every aggregate against expected values.
|
||||
- Harness simulates: resolution change mid-run (segments), stub upscaler exports (`upscaler` detection), RT PSO + dispatch (RT flags), AS builds without dispatch (inline RayQuery path), PSO compile spikes (stutter attribution), and a fault-triggering hook path (self-disable).
|
||||
- `.partial` recovery: kill the Agent mid-capture, restart, assert `interrupted` session recovered.
|
||||
**Built 2026-09-10 (P2 PR-G): `PartialRecoveryEndToEndTests`** — the shipped `FrameLedger.Agent.exe`
|
||||
captures `hook-harness` with `--partial-flush-seconds 2`, the test polls until a flush has actually
|
||||
landed (never a sleep), `Process.Kill`s the Agent, and then `--console recover` turns the valid prefix
|
||||
into an `interrupted` row whose `frame_count` IS the prefix, deletes the file, and finds nothing on a
|
||||
second pass. `PartialSessionFileTests` already kills at every byte offset; what this adds is that the
|
||||
Agent wrote a recoverable prefix *on its own* before it died.
|
||||
- **Test hygiene: the harness's overlay logs leave with the run.** The Overlay logs to the real
|
||||
`%LOCALAPPDATA%\FrameLedger\logs` by design, so every test binary that starts hook-harness removes the logs it
|
||||
caused when its run ends, and `tools/test-artifacts-check.ps1` fails the gate for one left behind
|
||||
(`17_HOOK_ENGINE` §Native logging, 2026-09-15). A new native test binary that starts the harness needs the listener;
|
||||
a managed test project that stages it gets the sweep from `FrameLedger.DrainFixtures.targets`.
|
||||
- Guard integration: harness loads a **dummy DLL named like an anti-cheat module** → injection refused pre-launch; loaded late → safety unhook. (A renamed harmless DLL, not real anti-cheat software.)
|
||||
|
||||
## Hook overhead measurement (NFR-1, per release)
|
||||
|
||||
1. `hook-harness` in a fixed workload, present-rate uncapped: 3 runs hooked vs 3 unhooked → mean present-call cost delta must be ≤ 1 µs (measured with QPC around the call site in an instrumented harness build).
|
||||
2. Real game, fixed 10-minute scene, capture ON vs OFF, 3 runs each: **game's own Avg FPS delta ≤ 0.5%**, Agent CPU ≤ 1% of a core, Agent RSS ≤ 150 MB, Overlay resident ≤ 8 MB.
|
||||
|
||||
> **NOT MEASURED. The runbook exists as of 2026-09-10 (P2 PR-G); the run is the owner's.**
|
||||
> `tools/fps-impact-runbook.ps1` sequences the six launches, holds consent granted for the ON leg and
|
||||
> revoked for the OFF leg — the same launch path both times, so the only difference is the injection —
|
||||
> reads the Agent's CPU and RSS itself, prompts for the number only the operator can see (the game's own
|
||||
> benchmark average), and prints the block for `spike-notes` §14. **It does not measure FPS and says so
|
||||
> first:** FrameLedger's frame times exist only in the hooked leg, so they cannot be both sides of this
|
||||
> comparison. Dev-only, never in `build.ps1 check` — it launches a real game. The harness-level
|
||||
> per-present cost (item 1's neighbour) is P0's 8.4 ns in `spike-notes` §3, and is not this number.
|
||||
> Until the run happens, the honest state of this line is *unmeasured*, not *passing*.
|
||||
3. Results recorded in the release notes ("measured overhead this release: …").
|
||||
|
||||
## Tier cross-validation (accuracy regression net) — **GONE, 2026-08-28, and this is the entry to read before planning P5**
|
||||
@@ -109,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
|
||||
|
||||
|
||||
+32
-8
@@ -22,6 +22,11 @@ Findings written to `docs/spike-notes.md`. Nothing in P1 starts until the exit c
|
||||
>
|
||||
> **Re-read 2026-09-04:** item 7 ✅ (the FG factor is measured, §S31 row P1), item 8's L2 half is written and measured (§M5 row R1), and exit criterion 1 reads **4 of 5** on Cyberpunk 2077 — the quality preset is the one value left, and `HANDOFF` item 7 carries the three things the next session does.
|
||||
>
|
||||
> **P0 CLOSED 2026-09-06 (owner).** Criterion 1 met with the quality preset amended to an
|
||||
> honest `N/A` (`spike-notes` §Exit criteria carries why); criterion 2 met — §S24 counts zero
|
||||
> S-items against it, with 🚫 S23-2 outside any PR. The measurement path this phase exists to
|
||||
> prove runs end to end in an unshipped capture host, on nine titles. **P1 starts.**
|
||||
>
|
||||
> The 08-06 block below is kept and is now wrong in one specific clause — it says the writer
|
||||
> *"records `measuredMask = FL_MEASURED_OUTPUT_RES | FL_MEASURED_PRESENT_ARGS` and nothing
|
||||
> else"*. It records upscaler identity, upscaler params, frame-generation counts and ray
|
||||
@@ -244,8 +249,8 @@ Findings written to `docs/spike-notes.md`. Nothing in P1 starts until the exit c
|
||||
> **Two things keep this ◐ rather than ✅:**
|
||||
>
|
||||
> - **The baseline side cannot be run.** This item's text says *"compare against what the
|
||||
> item-3 baseline reports"*, and `StaticGameDetector` has **no runnable vehicle** — every
|
||||
> construction of it is in `tests/`. So the comparison has one arm. `HANDOFF` item 5
|
||||
> item-3 baseline reports"*, and `StaticGameDetector` ~~has **no runnable vehicle** — every
|
||||
> construction of it is in `tests/`~~ *(has had one since P4 PR-1, 2026-09-14: the Agent's `DetectionSweep`)*. So the comparison has one arm. `HANDOFF` item 5
|
||||
> records this as uncosted; this file had never said it at all.
|
||||
> - **The README sentence does not exist**, and it is the artifact this item is for. It is
|
||||
> **not a percentage** — item 3 and `spike-notes` §8 already record that the baseline
|
||||
@@ -264,7 +269,7 @@ Findings written to `docs/spike-notes.md`. Nothing in P1 starts until the exit c
|
||||
|
||||
*(The former items 7 "Vulkan layer" and 8 "Guard prototype" are now items 1 and 0. §R1/§R2 are folded in, not pending.)*
|
||||
|
||||
**Exit criteria:** a throwaway build records a real session from a real offline game reporting *correct* upscaler, quality preset, render→output resolution, FG factor and RT state — verified against the game's own settings menu.
|
||||
**Exit criteria:** a throwaway build records a real session from a real offline game reporting *correct* upscaler, quality preset, render→output resolution, FG factor and RT state — verified against the game's own settings menu. *(Met 2026-09-06; the preset is an honest `N/A` by measurement — `spike-notes` §Exit criteria.)*
|
||||
|
||||
> **The FPS-impact criterion moves to the end of P1** (`20_OPEN_QUESTIONS` §R4,
|
||||
> decided 2026-08-02). "Records a real session" with an Agent CPU/RSS budget
|
||||
@@ -279,6 +284,25 @@ Findings written to `docs/spike-notes.md`. Nothing in P1 starts until the exit c
|
||||
## P1 — Native core (1.5 weeks)
|
||||
`FrameLedger.Overlay` proper: hook installation for D3D11/12/9/OGL, feature hooks, ring writer, fault policy, unhook path, native logging. `FrameLedger.Injector` with launch + attach modes. Struct mirror + Catch2 tests. Vulkan layer to parity — `vkQueuePresentKHR` plus the in-layer supervision check §S2 gates on it.
|
||||
|
||||
> **P1 item 1 landed 2026-09-06: the `LoadLibrary` detour** (`kernelbase!LoadLibraryExW`; wake for lazily
|
||||
> loaded runtimes + §S6's in-process anti-cheat stop, `FL_STATUS_STOPPED_BLOCKLISTED`), measured in
|
||||
> ctest `fl_guard` `[loader]` / `[S6]`. Order for the rest, as proposed and accepted: **2** the Injector's
|
||||
> launch mode (§S13(c), §S1's deferred input) — **landed 2026-09-06 as "inject late"**
|
||||
> (`FlGuardedInjectWhenReady`, the CaptureHost `launch` verb, `dxgiPresentsBeforeHook` as the cost meter;
|
||||
> `04_CAPTURE` §Launch mode); **3** the Vulkan layer to `vkQueuePresentKHR` with §S2's
|
||||
> in-layer supervision and a harness Vulkan mode — **landed 2026-09-06** (`layer.cpp` capture side,
|
||||
> `fl_shm_host.h` shared with the Overlay, `hook-harness --vulkan`, ctest `fl_vklayer*`, launch mode's
|
||||
> `TargetIsVulkanLayered` branch; §S2 ✅, §S29(d)'s assertion now a ctest that skips on CI); **4** the
|
||||
> unhook path, native logging, D3D9 / OpenGL — **landed 2026-09-06**: compare-and-restore per inline
|
||||
> patch (`fl_patch_check.h`, ctest `fl_unhook_inline`), the native event ring flushed to
|
||||
> `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`,
|
||||
> `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.
|
||||
|
||||
> **The guard already shipped, in P0.** This line used to read "the guard,
|
||||
> complete and fully tested — it ships before the first real injection, not
|
||||
> after", which was the correct ordering stated in the wrong phase: P0 items 1
|
||||
@@ -287,16 +311,16 @@ Findings written to `docs/spike-notes.md`. Nothing in P1 starts until the exit c
|
||||
> re-scan wired to a real Overlay.
|
||||
|
||||
## P2 — Capture pipeline (1 week)
|
||||
Agent: watcher, tier selection, injection orchestration, shm drain, telemetry poller (NVAPI first), session recorder, segments, `.partial` recovery, ~~Tier-2 `EtwFrameSource` retained as fallback.~~ **There is nothing to retain: Tier 2 has no mechanism as of 2026-08-27** (§G). `EtwFrameSource` is a port with no adapter, and P2 should not be planned as though writing one were scoped. SQLite v2 schema + migrations. Domain metric calculators + golden tests. **Milestone: first real hooked session persisted with measured upscaler/RT data.**
|
||||
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)
|
||||
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.
|
||||
## 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.*
|
||||
|
||||
## P4 — Detection & product polish (1 week)
|
||||
Static rules engine + `detection-rules.json` (engines, platforms, capabilities, **anticheat blocklist**) + validator + fixtures; store auto-import; capability-vs-measured UI separation; i18n en/vi/ja; Legal Gate; Velopack + updater (with the hooked-session deferral); bug bundle incl. overlay logs; tray + toasts; Settings; DB maintenance; accessibility pass.
|
||||
~~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; 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.
|
||||
|
||||
|
||||
+37
-5
@@ -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) |
|
||||
@@ -57,10 +57,12 @@ private static readonly IHost _host = Host.CreateDefaultBuilder()
|
||||
.Build();
|
||||
```
|
||||
|
||||
**As built (P3 PR-2, 2026-09-13), three deviations from the sketch above:** `Host.CreateApplicationBuilder()` rather than `CreateDefaultBuilder`; `MainWindow` is **transient** (a language change rebuilds it in the new culture — `09_I18N` §Mechanics — and `Services.ShellHost` tracks the live one), so `App.xaml` sets `ShutdownMode="OnExplicitShutdown"` and the host's `IHostApplicationLifetime` is what ends the process (the shell host stops it when the live window closes; the old window of a rebuild closing is not an exit); and the run is one `Task` started from a synchronous `OnStartup` (`async void` overrides are VSTHRD100 under this repo's analyzers) that opens the ledger, starts the host, awaits its shutdown, tears down, and only then calls `Shutdown()`.
|
||||
|
||||
Theme rules:
|
||||
- Manual Light/Dark: `ApplicationThemeManager.Apply(ApplicationTheme.Dark)`.
|
||||
- System: `SystemThemeWatcher.Watch(mainWindow)` — call it in the window's `Loaded` handler (needs an HWND), and unwatch when switching to manual.
|
||||
- Persist the choice in `settings`; re-apply before the main window shows to avoid a flash.
|
||||
- Persist the choice in `settings`; re-apply before the main window shows to avoid a flash. **Measured 2026-09-13: this is a correctness rule, not a cosmetic one** — `ApplicationThemeManager.Apply(theme, backdrop, updateAccent: true)` is what registers the `SystemAccentColor*` resources the control templates `StaticResource` at first Measure; a `FluentWindow` shown before any `Apply` throws `XamlParseException: Cannot find resource named 'SystemAccentColorPrimary'`. The shell applies the theme in its constructor before `InitializeComponent()` and again from `Loaded` for the watcher.
|
||||
- Subscribe `ApplicationThemeManager.Changed` once, centrally, to re-theme ScottPlot (below).
|
||||
|
||||
## Main window skeleton
|
||||
@@ -142,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.
|
||||
|
||||
@@ -149,6 +158,7 @@ Native `Menu`, `TabControl`, `ComboBox`, `Slider`, `ListView` are fine — the `
|
||||
|
||||
- Derive from `Control` with `ControlTemplate` in `Styles/FrameLedger.xaml`; template uses only theme brushes above → they re-theme for free.
|
||||
- `TriStateChip`: `Border` CornerRadius 12, states — Yes: `AccentFillColorDefaultBrush` bg + on-accent text; No: transparent bg + `ControlStrokeColorDefaultBrush` 1px border; N/A: dashed `StrokeDashArray="2 2"` border + `TextFillColorTertiaryBrush` text.
|
||||
- **Built 2026-09-14 (P3 PR-5):** both derive from `Control` with one dependency property, `Model` (`FpsReadoutModel` / `TriStateChipModel`, decided by `Services.FpsPresentation` and the view models — the control renders, it never decides), templates in `Styles/FrameLedger.xaml` with `DataTrigger`s on the model's flags; the dashed N/A outline is a `Rectangle` behind the `Border` (a `Border` cannot dash). The source suffix icon became the tooltip: the Fluent System Icons names for 🔍/✎/↧ are not certain in this pinned version and a wrong `SymbolRegular` is a build error. The override flyout is PR-6's.
|
||||
- No `SystemColors.*` anywhere.
|
||||
|
||||
## Dialogs & notifications
|
||||
@@ -167,7 +177,7 @@ var result = await box.ShowDialogAsync(); // Wpf.Ui.Controls.MessageBoxResult.Pr
|
||||
```
|
||||
|
||||
⚠ Name clash with `System.Windows.MessageBox` — in App code, `using MessageBox = Wpf.Ui.Controls.MessageBox;` and ban the System one (BannedSymbols/analyzer note).
|
||||
- Rich in-flow dialogs: `IContentDialogService` (host wired in MainWindow).
|
||||
- Rich in-flow dialogs: `IContentDialogService` (host wired in MainWindow — a `ui:ContentDialogHost`, since 4.3.0 marks `SetDialogHost(ContentPresenter)` obsolete).
|
||||
- Transient in-app: `ISnackbarService.Show(title, message, ControlAppearance.Success, new SymbolIcon(SymbolRegular.Checkmark24), TimeSpan.FromSeconds(4))`.
|
||||
- System/tray notifications: H.NotifyIcon only (08_UI §Notifications policy).
|
||||
|
||||
@@ -175,14 +185,36 @@ var result = await box.ShowDialogAsync(); // Wpf.Ui.Controls.MessageBoxResult.Pr
|
||||
|
||||
On startup and on `ApplicationThemeManager.Changed`: for every live plot set figure/data background, axis/grid/tick colors, and series palette from the current theme resources (`ChartPalette.xaml`), then `Refresh()`. Centralize in `ChartTheme.Apply(Plot plot)` — pages never color plots ad hoc.
|
||||
|
||||
> **Built 2026-09-14 (P3 PR-6).** `Charts/ChartTheme.Apply(Plot)` + `ChartTheme.Attach(WpfPlot)` (weakly held; one
|
||||
> subscription to `ApplicationThemeManager.Changed` re-applies and refreshes every live plot). The palette is
|
||||
> **two** dictionaries, `Styles/ChartPalette.Dark.xaml` and `ChartPalette.Light.xaml`, `Color` resources with
|
||||
> explicit ARGB hex — the one place hex is allowed — read into `Charts/ChartPalette` per theme and cached;
|
||||
> `ChartPaletteTests` fails when the two files' key sets drift from what the record reads. Series colours come
|
||||
> from the palette too (native, displayed, stutter, PSO stutter, sensors, segment span, histogram, percentile).
|
||||
> Pinned `ScottPlot.WPF` 5.1.59: `Add.SignalXY` for the decimated series, `Add.Scatter` (no line) for markers,
|
||||
> `Add.HorizontalSpan` for the ribbon, `Add.Bars` over `Statistics.Histogram.WithBinCount`, `Add.ScatterLine`
|
||||
> for the percentile curve, a series' `Axes.YAxis = plot.Axes.Right` for the sensor overlay.
|
||||
|
||||
## Gotchas checklist
|
||||
|
||||
- [ ] Dictionaries order: `ThemesDictionary` → `ControlsDictionary` → app styles. Wrong order = default-looking controls.
|
||||
- [ ] `SystemThemeWatcher.Watch` after HWND exists (`Loaded`), not in the constructor.
|
||||
- [ ] `SystemThemeWatcher.Watch` after HWND exists (`Loaded`), not in the constructor — but `ApplicationThemeManager.Apply(…, updateAccent: true)` BEFORE the first window's XAML loads, or the accent resources are missing at first Measure (§App bootstrap).
|
||||
- [ ] Menu row lives **outside** `ui:TitleBar` (its area is the drag region; a Menu inside becomes undraggable/unclickable territory).
|
||||
- [ ] Don't set `AllowsTransparency`/`WindowStyle` on `FluentWindow` — it manages its own chrome.
|
||||
- [ ] Mica is Win 11-only: leave `WindowBackdropType="Mica"`; the library falls back on Win 10 — verify visuals in the Win 10 VM pass (14_TESTING matrix).
|
||||
- [ ] VS Designer sometimes renders WPF UI controls unstyled at design time — judge by running, not the previewer.
|
||||
- [ ] `TargetPageType` navigation requires the page registered in DI; a missing registration throws at runtime — smoke-test every nav item.
|
||||
- [ ] resx localization unchanged: `Content="{x:Static res:Strings.Key}"` works on all WPF UI controls (09_I18N).
|
||||
- [ ] MIT license copy for WPF UI ships in `legal/licenses/` (THIRD_PARTY_NOTICES checklist).
|
||||
- [x] MIT license copy for WPF UI ships in `legal/licenses/` (THIRD_PARTY_NOTICES checklist) — ~~`wpfui-MIT.txt`, since 2026-09-14~~ `legal/licenses/nuget/WPF-UI.txt` since 2026-09-15, generated from the package's own LICENSE.md and carried into the published `licenses/`.
|
||||
- [ ] **`ui:InfoBar` renders no Content in 4.3.0.** It is a `ContentControl`, the docs and the §Control mapping row
|
||||
above both say "banner with an action button", and the library template has no `ContentPresenter` — so a
|
||||
`ui:Button` written as the InfoBar's child compiles, binds, and is never drawn. With `IsClosable="False"` that is a
|
||||
bar with no exit, which is exactly how the safety notices shipped (2026-09-14). `Styles/FrameLedger.xaml` carries
|
||||
the upstream template plus one presenter column; `PagesLoadTests.TheInfoBarTemplateRendersItsContent` renders both
|
||||
templates and turns red when upstream gains a presenter, which is when the copy comes out.
|
||||
- [ ] **No dialog in 4.3.0 closes on Esc.** Neither `ContentDialog.cs` nor `MessageBox.cs` at the 4.3.0 tag handles a
|
||||
key (read 2026-09-15), and `ContentDialog.CloseButtonText` DEFAULTS to "Close" — an empty string is how a dialog
|
||||
says it has no Close button. `MessageBox.Close()` is `[Obsolete("Use Close with MessageBoxResult instead")]` while no
|
||||
such overload is public; the Close button's own path is `TemplateButtonCommand.Execute(MessageBoxButton.Close)`.
|
||||
`Services/DialogKeyboard` registers one class handler on `Window` (bubbling `KeyDown`, so a dropdown's Esc wins) and
|
||||
closes through those paths; `AccessibilityTests.EscapeClosesTheOpenDialogWithNoResult` holds it (`08_UI` §Accessibility).
|
||||
+122
-10
@@ -32,6 +32,31 @@ The injected DLL. Its whole job: install hooks, write 64-byte records into a rin
|
||||
1. Open/create shared memory `Local\FrameLedger.Ring.<pid>`; write the handshake header (layout version, build id, pid, api=unknown).
|
||||
2. `MH_Initialize()`.
|
||||
3. Resolve which graphics APIs are present (`GetModuleHandleW` on `d3d11.dll`, `d3d12.dll`, `dxgi.dll`, `opengl32.dll`) — and register a `LoadLibrary` hook so APIs loaded **later** still get hooked (many games load D3D12 lazily). **The `LoadLibrary` hook must not install hooks inline:** it runs under the loader lock, and MinHook suspends all threads to patch, which deadlocks against any thread waiting on that lock. It enqueues the request and signals the init thread, which installs outside the lock (`20_OPEN_QUESTIONS` §H2).
|
||||
|
||||
> **Built 2026-09-06 (P1 item 1), with two differences from the sentence above.** The detour is on
|
||||
> `kernelbase.dll!LoadLibraryExW` — the one body every `LoadLibrary*` variant of `kernel32` reaches —
|
||||
> and it is installed **after** the present hooks, from `InitThread`, outside any loader lock. It
|
||||
> **enqueues nothing**: the module's real file name (`GetModuleFileNameW` on the handle the original
|
||||
> returned, into a stack buffer — never the caller's string, which may be relative or an API set) is
|
||||
> compared against two fixed tables and the detour then does one of two things, both a single store
|
||||
> plus `SetEvent` on the watchdog's auto-reset wake event. **(a)** A name that is in `FL_HOOK_INVENTORY`
|
||||
> or `FL_RUNTIME_CENSUS` bumps a saturating 15-bit wake count and wakes the watchdog, whose next
|
||||
> iteration runs the same lazy installers it always ran — so the install happens on the watchdog
|
||||
> thread, as before, but **within milliseconds of the module rather than on the next 1 Hz tick**
|
||||
> (measured in ctest `fl_guard` `[loader]`: 94 ms from the module appearing to the hook family being
|
||||
> published, against a 500 ms bound that discriminates the wake from the tick). **(b)** A name that
|
||||
> matches a MODULE family of the compiled anti-cheat floor (`fl_ac_floor.generated.h`, the same table
|
||||
> the guard carries — prefix, case-insensitive, allocation-free) records the family's 1-based index in
|
||||
> `earlyStopFamily` and wakes the watchdog; the **present path** stops the Overlay on its next
|
||||
> `MayObserve` and the **watchdog** stops it on its next iteration, whichever comes first, with the new
|
||||
> status `FL_STATUS_STOPPED_BLOCKLISTED` (= 4) — `19_SAFETY` §During a session, the in-process half;
|
||||
> `20_OPEN_QUESTIONS` §S6. The words are `FlWriterState.loaderSignals` @56 (bit 15 = installed, bits
|
||||
> 0..14 = wake count) and `earlyStopFamily` @58, both carved from `reserved[]` so the layout version did
|
||||
> not move. The original is always called first and its result returned untouched, and
|
||||
> `LOAD_LIBRARY_AS_DATAFILE` / `_EXCLUSIVE` / `AS_IMAGE_RESOURCE` loads are skipped — no code runs from
|
||||
> 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.
|
||||
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.
|
||||
@@ -108,7 +133,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`,
|
||||
> `SetFullscreenState`, `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
|
||||
@@ -126,6 +151,13 @@ Every hook must be listed here with a purpose. Anything not on this list is not
|
||||
> so a shipped hook missing from here is invisible to every gate. Flip the row **and this
|
||||
> banner** in the same PR that builds a hook.
|
||||
|
||||
### The one system-module detour — a hook, and the asymmetry stated
|
||||
|
||||
| Hook | Purpose |
|
||||
|---|---|
|
||||
| ✅ `opengl32.dll!wglSwapBuffers` (2026-09-06, P1 item 4) | The OpenGL present hook (§Presentation). A system module, not a vendor one, so — like the row below — it is deliberately **not** in `FL_HOOK_INVENTORY` and `hookinventory-check` does not cover it; listed here so the table above and these two rows together are the whole inventory |
|
||||
| ✅ `kernelbase.dll!LoadLibraryExW` (2026-09-06, P1 item 1) | The wake for lazily loaded runtimes and the in-process anti-cheat stop — §DLL entry step 3 above carries the mechanism. **Rule 4:** it reads one argument the API was given (`flags`) and one property of a handle the loader just returned to *its own caller* (the module file name); nothing of the game's. **It is the only hook on a system module, and it is deliberately not in `FL_HOOK_INVENTORY`:** that table is *vendor* symbols resolved by name and gated by `hookinventory-check` against `vendor-exports.json`, and `LoadLibraryExW` is neither vendor nor uncertain. It is listed here instead so the table above and this row together are the whole inventory. It **never** installs, uninstalls or patches anything itself (§H2) |
|
||||
|
||||
### Watchdog observations — not hooks, and listed here so nobody mistakes them for one
|
||||
|
||||
| Observation | Mechanism | Rule 4 | Why |
|
||||
@@ -135,13 +167,13 @@ Every hook must be listed here with a purpose. Anything not on this list is not
|
||||
### Presentation
|
||||
| Hook | Purpose |
|
||||
|---|---|
|
||||
| ✅ `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) |
|
||||
| ✅ `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 |
|
||||
| ⏳ `IDXGISwapChain3::SetColorSpace1` | HDR output detection. **`IDXGISwapChain3`, not 4** — 4 adds only `SetHDRMetaData` (`20_OPEN_QUESTIONS` §H9). 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 |
|
||||
| ⏳ `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` | OpenGL titles. Unbuilt, and deliberately not attempted before `hook-harness` has an OpenGL mode: the hook is small (a flat export, no vtable) but shipping an unexercised hook into a game process is not something this project does. Measured 2026-08-05: `opengl32!wglSwapBuffers` is a `jmp` thunk (`E9 <rel32>`) into the vendor ICD, which is already mapped before the first call |
|
||||
| ⏳ Vulkan `vkQueuePresentKHR` | via layer, not hook (below). Unbuilt — P1, and §S2's in-layer supervision check lands with it. The layer today loads, gates and self-scans, and intercepts nothing |
|
||||
| ✅ `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 |
|
||||
| ✅ Vulkan `vkQueuePresentKHR` (2026-09-06, P1 item 3) | via layer, not hook (below). Frame boundary and QPC, one record per present; `vkCreateSwapchainKHR` / `vkDestroySwapchainKHR` intercepted beside it for the output size (`imageExtent`, the API's own argument — rule 4). **No `FL_MEASURED_PRESENT_ARGS`**: `vkQueuePresentKHR` carries no sync interval and no flags, which is why that bit exists. §S2's in-layer supervision check landed with it, on the present path. Measured under the real loader on the harness's `--vulkan` mode: 241 records in 4 s, status READY, `apiMask` = Vulkan (ctest `fl_vklayer_real`) |
|
||||
|
||||
### Upscaling / frame generation (the accuracy problem this rewrite exists to solve)
|
||||
| Hook | Yields |
|
||||
@@ -149,11 +181,11 @@ Every hook must be listed here with a purpose. Anything not on this list is not
|
||||
| NGX: `NVSDK_NGX_D3D11/D3D12/VULKAN_CreateFeature`, `EvaluateFeature`, `ReleaseFeature` | Which NGX feature is *actually created and evaluated per frame*: SuperSampling (DLSS), RayReconstruction (DLSS-D), FrameGeneration (DLSS-G) |
|
||||
| NGX parameter accessors (`NVSDK_NGX_Parameter_SetI/GetI/SetUI`) — **exported by `sl.common.dll` only; see below** | `Width`/`Height` (render) vs `OutWidth`/`OutHeight` (output), `PerfQualityValue` (quality preset), sharpness |
|
||||
| ✅ Streamline: `slEvaluateFeature` · ⏳ `slInit`, `slSetFeatureLoaded`, `slSetConstants`, `slGetFeatureRequirements` | Feature set actually active when the game goes through SL rather than NGX directly (`kFeatureDLSS`, `DLSS_G`, `DLSS_RR`, `Reflex`, `NIS`). **Built 2026-08-09**, identity only: one MinHook detour on `sl.interposer.dll!slEvaluateFeature`, resolved **module-scoped** and installed lazily by the watchdog. Sets `FL_MEASURED_UPSCALER` + `FL_HOOK_UPSCALER_IDENTITY`; decodes `kFeatureDLSS`/`kFeatureNIS` and reports `FL_UPSCALER_UNKNOWN` for anything else. **Never `FL_UPSCALER_NONE`** — a Streamline-only writer cannot see FFX, XeSS or NGX-direct, and `NONE` is the only one of the three states that may be aggregated as a negative |
|
||||
| ✅ Streamline: `slSetTag` | The **global** resource tags, where a title states the size of the buffer it is upscaling *from*: `kBufferTypeScalingInputColor`'s extent → `renderW/H` — **or, since 2026-09-05, the size the tagged `sl::Resource` declares when the extent is zero** (`TagSize` in `fl_sl_inputs.h`, shared by all three tag routes; GUID-checked; a Resource declaring no size is still the honest unknown). **Built 2026-08-15** (`FL_HOOK_UPSCALER_PARAMS`), and it is an ALTERNATIVE to the local tags in `slEvaluateFeature`'s `inputs`, not a layer over them — `sl_core_api.h:258` says global and local tags "do NOT interact", so a title using one yields nothing from the other and both are read. Published only on a frame where an evaluation was also seen, because a tag is viewport state that outlives any one frame. This row was MISSING from this table while the hook shipped, which is the gap the banner above now names |
|
||||
| ✅ Streamline: `slSetTagForFrame` | The same global tags through **Streamline 2.8's frame-based entry point**, which deprecates `slSetTag`: `(const FrameToken&, const ViewportHandle&, const ResourceTag*, uint32_t, CommandBuffer*)` — the token first, then exactly `slSetTag`'s list, handed to the same tag walk. **Built 2026-09-04** (`FL_HOOK_UPSCALER_PARAMS`, its own trampoline; the family is now **published when whole** — once every tag export the loaded interposer has is patched — because publishing on the first row entitled records the second was not yet producing, 38 of 41 on the fixture: the ffx leaves' #110 defect again, fixed the same way). Measured need: Dying Light: The Beast (SL 2.8.0) published `Dlss` identity on every batch and the params bit on none across three captures, because a 2.8 title that tags per frame never calls the deprecated export. The token is not read; the frame count stays with `slGetNewFrameToken`. The installer picks this detour by SYMBOL (`kSymbolSlSetTagForFrame`, bound to the row by `static_assert`), not by family, since the two rows share a family bit and differ in signature |
|
||||
| ✅ **FidelityFX ffx-api: `ffxDispatch` on the FOUR modules a game calls** — `amd_fidelityfx_dx12.dll` (SDK 1.1.x monolith), `amd_fidelityfx_upscaler_dx12.dll`, `amd_fidelityfx_framegeneration_dx12.dll`, **and `amd_fidelityfx_loader_dx12.dll`** (added the evening of 2026-09-04: three loader-shipping titles at FSR produced zero dispatches at any leaf export, so the loader is where their calls arrive) · ⏳ FSR 3.0 host route `ffx_fsr3_x64.dll!ffxFsr3ContextDispatchUpscale` / `ffxFsr3DispatchFrameGeneration` · ~~`ffxFsr2ContextCreate`~~ · ~~`ffxCreateContext`~~ | **Built 2026-09-04** (`HANDOFF` item 7c). One observer behind three trampolines reads the DESCRIPTOR the title passed — head type first, body only after the type matched a constant from the vendored MIT headers (`third_party/fidelityfx/`, tag v2.3.0): **UPSCALE** → identity (`FSR3` from the monolith, `FSR_UNVERSIONED` from the 2.x upscaler DLL, which hosts FSR 3.1 and FSR 4 behind one type) + `renderSize` → `renderW/H` (quality and sharpness `0xFF`: the dispatch carries neither) + one COUNT; **PREPARE / PREPARE_V2** → `frameID` counted on a *new* index only — this vendor's `slGetNewFrameToken`, the `fgEvaluations` producer once a title has ever prepared, with the UPSCALE count as the fallback for a title that never does; **FRAMEGENERATION** → `fgMode = FSR_FG` on that present. Rule 4: the argument of the API we hooked, never `context`, `pNext`, a command list or a resource. **Why all four:** a UE5 title ships the two leaves with no loader and calls their exports; a loader-shipping title calls the loader's export and the signed loader reaches its providers through an object, not the leaves' exports (measured: Dying Light: The Beast, KCD2, Wukong). The morning's "never the loader" rested on the export tables alone and was reversed by the run. What guards against a loader that DID re-enter a leaf's export is the K = 1 control with all four hooked and the consumer's `frames/upscale-drained`, both of which read 2× in that case. `ffxCreateContext` is deliberately NOT a row — nothing it carries fills a field the dispatch does not, and its honest family would collide with `slEvaluateFeature`'s under the installer's equality binding. The family is compound (`IDENTITY \| PARAMS \| FG_EVALUATIONS`), pinned by `static_assert`s that also bind the leaf table to the rows both ways and refuse the loader as a row. Streamline keeps precedence for the count once it has ever issued a token, so every §S31-validated title is byte-identical. Second count: the consumer prints `frames/upscale-drained`, the AMD `tokens/batch`. **FSR 3.0** (Cyberpunk's `ffx_fsr3_x64.dll`, named exports) is its own later PR — ten host headers from tag v1.1.4, and one title here to test on |
|
||||
| ✅ Streamline: `slSetTag` — **and, since 2026-09-05, every tag's TYPE** (`slTagCensus`; a HUD-less / UI tag marks the present `FL_FG_DLSS_G`, rule 4: the same argument) | The **global** resource tags, where a title states the size of the buffer it is upscaling *from*: `kBufferTypeScalingInputColor`'s extent → `renderW/H` — **or, since 2026-09-05, the size the tagged `sl::Resource` declares when the extent is zero** (`TagSize` in `fl_sl_inputs.h`, shared by all three tag routes; GUID-checked; a Resource declaring no size is still the honest unknown). **Built 2026-08-15** (`FL_HOOK_UPSCALER_PARAMS`), and it is an ALTERNATIVE to the local tags in `slEvaluateFeature`'s `inputs`, not a layer over them — `sl_core_api.h:258` says global and local tags "do NOT interact", so a title using one yields nothing from the other and both are read. Published only on a frame where an evaluation was also seen, because a tag is viewport state that outlives any one frame. This row was MISSING from this table while the hook shipped, which is the gap the banner above now names |
|
||||
| ✅ Streamline: `slSetTagForFrame` — **and every tag's TYPE, as above** | The same global tags through **Streamline 2.8's frame-based entry point**, which deprecates `slSetTag`: `(const FrameToken&, const ViewportHandle&, const ResourceTag*, uint32_t, CommandBuffer*)` — the token first, then exactly `slSetTag`'s list, handed to the same tag walk. **Built 2026-09-04** (`FL_HOOK_UPSCALER_PARAMS`, its own trampoline; the family is now **published when whole** — once every tag export the loaded interposer has is patched — because publishing on the first row entitled records the second was not yet producing, 38 of 41 on the fixture: the ffx leaves' #110 defect again, fixed the same way). Measured need: Dying Light: The Beast (SL 2.8.0) published `Dlss` identity on every batch and the params bit on none across three captures, because a 2.8 title that tags per frame never calls the deprecated export. The token is not read; the frame count stays with `slGetNewFrameToken`. The installer picks this detour by SYMBOL (`kSymbolSlSetTagForFrame`, bound to the row by `static_assert`), not by family, since the two rows share a family bit and differ in signature |
|
||||
| ✅ **FidelityFX ffx-api: `ffxDispatch` on the FOUR modules a game calls** — `amd_fidelityfx_dx12.dll` (SDK 1.1.x monolith), `amd_fidelityfx_upscaler_dx12.dll`, `amd_fidelityfx_framegeneration_dx12.dll`, **and `amd_fidelityfx_loader_dx12.dll`** (added the evening of 2026-09-04: three loader-shipping titles at FSR produced zero dispatches at any leaf export, so the loader is where their calls arrive) · ⏳ FSR 3.0 host route `ffx_fsr3_x64.dll!ffxFsr3ContextDispatchUpscale` / `ffxFsr3DispatchFrameGeneration` · ~~`ffxFsr2ContextCreate`~~ · ~~`ffxCreateContext`~~ | **Built 2026-09-04** (`HANDOFF` item 7c). One observer behind three trampolines reads the DESCRIPTOR the title passed — head type first, body only after the type matched a constant from the vendored MIT headers (`third_party/fidelityfx/`, tag v2.3.0): **UPSCALE** → identity (`FSR3` from the monolith, `FSR_UNVERSIONED` from the 2.x upscaler DLL, which hosts FSR 3.1 and FSR 4 behind one type) + `renderSize` → `renderW/H` (quality and sharpness `0xFF`: the dispatch carries neither) + one COUNT; **PREPARE / PREPARE_V2** → `frameID` counted on a *new* index only — this vendor's `slGetNewFrameToken`, the `fgEvaluations` producer once a title has ever prepared, with the UPSCALE count as the fallback for a title that never does; **FRAMEGENERATION** → `fgMode = FSR_FG` on that present. Rule 4: the argument of the API we hooked, never `context`, `pNext`, a command list or a resource. **Why all four:** a UE5 title ships the two leaves with no loader and calls their exports; a loader-shipping title calls the loader's export and the signed loader reaches its providers through an object, not the leaves' exports (measured: Dying Light: The Beast, KCD2, Wukong). The morning's "never the loader" rested on the export tables alone and was reversed by the run. What guards against a loader that DID re-enter a leaf's export is the K = 1 control with all four hooked and the consumer's `frames/upscale-drained`, both of which read 2× in that case. `ffxCreateContext` is deliberately NOT a row — nothing it carries fills a field the dispatch does not, and its honest family would collide with `slEvaluateFeature`'s under the installer's equality binding. The family is compound (`IDENTITY \| PARAMS \| FG_EVALUATIONS`), pinned by `static_assert`s that also bind the leaf table to the rows both ways and refuse the loader as a row. Streamline keeps precedence for the count once it has ever issued a token, so every §S31-validated title is byte-identical. Second count: the consumer prints `frames/upscale-drained`, the AMD `tokens/batch`. **FSR 3.0 — BUILT 2026-09-05 as a fifth AMD target:** `ffx_fsr3_x64.dll!ffxFsr3ContextDispatchUpscale` (Cyberpunk's copy; named export, its own descriptor, vendored from tag **`fsr3-v3.0.4`** — the tag whose twelve `ffxFsr3*` declarations match the shipped module, not the `v1.1.4` first named). Rule 4: the detour reads `renderSize` of the descriptor the title passed and nothing else — never the context, a resource or the command list; the offset is pinned to a literal (1256) so a re-vendoring that moved it fails to compile. Same family and publish point as the four rows (`PublishFfxFamilyIfWhole` waits for a loaded host too), keyed by module in the installer; identity `FSR3` as a fact. `ffxFsr3DispatchFrameGeneration` is deliberately not a row (§H11 carries the reversal condition); the `ffx_fsr3upscaler_x64.dll` leaf is the pre-committed alternative if the facade reads silent (row B2) — never both, or `frames/upscale-drained` reads 2.00 |
|
||||
| XeSS: `xessD3D12CreateContext`, `xessD3D12Init`, `xessD3D12Execute` | `outputResolution`, `qualitySetting`, XeSS version; `xess_fg` variants for XeFG |
|
||||
| ✅ **Application frames per present** (`fgEvaluations`) — **`sl.interposer.dll!slGetNewFrameToken` since 2026-09-03** | Native vs Displayed frame counts at Tier 1 — see `03_METRICS` §Frame Generation. **The producer is the frame-token export**: Streamline hands a title one token per application frame and the title must ask; the detour counts distinct tokens between two presents (pointer changes, nothing dereferenced), `FL_HOOK_FG_EVALUATIONS` is its family, and it installs on every Streamline 2 title including the ones that evaluate nothing through `slEvaluateFeature`. Rule 4: the out-parameter of an API we hooked. Premise and its gate in `03_METRICS`; pre-committed table in `20_OPEN_QUESTIONS` §S31. *The row as it stood before:* ~~NGX/SL/FFX/XeSS FG feature evaluations per present. **Built 2026-08-15 for Streamline, and MEASURED TO YIELD NOTHING ON THAT ROUTE**~~ — `slEvaluateFeature(kFeatureDLSS_G)` is never called by Cyberpunk 2077 (0 across ~14,000 batches, four FG settings), so this row installs, is honest, and counts zero; see `docs/HANDOFF.md` item 3. Built on the detour that was already there: `kFeatureDLSS_G` contributes to a saturating COUNT in the same word the feature bits live in (`fl_sl_seen.h`) rather than to a bit, because a bit collapses several evaluations between two presents into one — and under multi-frame generation that is the common case, not the edge. The row's family is therefore compound (`FL_HOOK_UPSCALER_IDENTITY \| FL_HOOK_FG_EVALUATIONS`), pinned by a `static_assert` because `hookinventory-check` reads that column as an opaque identifier. **Counts EVALUATIONS, not generated frames** — the 2026-08-14 owner ruling; the multiplier lives in `sl::DLSSGOptions`, which is only reachable by the route §2b refused. ~~Non-NVIDIA FG vendors are **deferred with a written rationale**: `amd_fidelityfx_framegeneration_dx12.dll` 3.1.5 exports only the five generic `ffx*` entry points, identical to five sibling modules, so identity is in the arguments and we have no headers~~ — **AMD has a producer since 2026-09-04** (the FidelityFX row above: the PREPARE dispatch's `frameID`, or the UPSCALE count on a title that never prepares, feeds `fgEvaluations` when Streamline has never issued a token); Intel stays at the census (`20_OPEN_QUESTIONS` §Scope decisions, by licence); the FSR 3.0 host DLLs are deferred to their own PR |
|
||||
| ✅ **Application frames per present** (`fgEvaluations`) — **`sl.interposer.dll!slGetNewFrameToken` since 2026-09-03** | Native vs Displayed frame counts at Tier 1 — see `03_METRICS` §Frame Generation. **The producer is the frame-token export**: Streamline hands a title one token per application frame and the title must ask; the detour counts distinct tokens between two presents (pointer changes, nothing dereferenced), `FL_HOOK_FG_EVALUATIONS` is its family, and it installs on every Streamline 2 title including the ones that evaluate nothing through `slEvaluateFeature`. Rule 4: the out-parameter of an API we hooked. Premise and its gate in `03_METRICS`; pre-committed table in `20_OPEN_QUESTIONS` §S31. *The row as it stood before:* ~~NGX/SL/FFX/XeSS FG feature evaluations per present. **Built 2026-08-15 for Streamline, and MEASURED TO YIELD NOTHING ON THAT ROUTE**~~ — `slEvaluateFeature(kFeatureDLSS_G)` is never called by Cyberpunk 2077 (0 across ~14,000 batches, four FG settings), so this row installs, is honest, and counts zero; see `docs/HANDOFF.md` item 3. Built on the detour that was already there: `kFeatureDLSS_G` contributes to a saturating COUNT in the same word the feature bits live in (`fl_sl_seen.h`) rather than to a bit, because a bit collapses several evaluations between two presents into one — and under multi-frame generation that is the common case, not the edge. The row's family is therefore compound (`FL_HOOK_UPSCALER_IDENTITY \| FL_HOOK_FG_EVALUATIONS`), pinned by a `static_assert` because `hookinventory-check` reads that column as an opaque identifier. **Counts EVALUATIONS, not generated frames** — the 2026-08-14 owner ruling; the multiplier lives in `sl::DLSSGOptions`, which is only reachable by the route §2b refused. ~~Non-NVIDIA FG vendors are **deferred with a written rationale**: `amd_fidelityfx_framegeneration_dx12.dll` 3.1.5 exports only the five generic `ffx*` entry points, identical to five sibling modules, so identity is in the arguments and we have no headers~~ — **AMD has a producer since 2026-09-04** (the FidelityFX row above: the PREPARE dispatch's `frameID`, or the UPSCALE count on a title that never prepares, feeds `fgEvaluations` when Streamline has never issued a token); Intel stays at the census (`20_OPEN_QUESTIONS` §Scope decisions, by licence); the FSR 3.0 host DLL's UPSCALE (`ffxFsr3ContextDispatchUpscale`, since 2026-09-05) counts like an ffx-api UPSCALE when neither Streamline nor a PREPARE has spoken |
|
||||
|
||||
> `GetFrameStatistics().PresentCount` is **not** in this inventory and must not be
|
||||
> re-added as an FG signal. It counts presents the application submitted through
|
||||
@@ -352,10 +384,45 @@ is not something this loader supports.
|
||||
> admin. Registering under HKCU (below) is the less common choice and the better
|
||||
> one: no elevation, and per-user scope.
|
||||
- Intercepts `vkQueuePresentKHR`, `vkCreateSwapchainKHR`, `vkCmdTraceRaysKHR`, `vkCmdBuildAccelerationStructuresKHR`, `vkCreateGraphicsPipelines`.
|
||||
|
||||
> **Built 2026-09-06 (P1 item 3): the first two, plus `vkDestroySwapchainKHR`; the three feature entries are still ⏳.** How the capture side works, stated once:
|
||||
> - **The ring is the same ring.** `fl_shm_host.h` (header-only, in `FrameLedger.Shm`) now holds the user-only DACL, the `Local\FrameLedger.Ring.<pid>` name, the mapping and the handshake for **both** capture sides; the Overlay calls it too. **One ring per process: whichever side creates the mapping first owns it, the other sees `ERROR_ALREADY_EXISTS` and stays inert** — and stays *forwarding*: the layer registers every device's next pointers before it tries the ring, because a hook with nothing to forward to failed the application's present (measured, `VK_ERROR_DEVICE_LOST` on the harness, the first time the Overlay got there first). That is also why the launch-mode guard **does not inject a presenter that mapped `vulkan-1.dll`** (`Reason::kTargetIsVulkanLayered`, `fl_guard.cpp`) — with or without a D3D runtime beside it, because **an NVIDIA Vulkan ICD maps `dxgi.dll` + `d3d12.dll` itself and presents the Vulkan swapchain through a DXGI flip chain** (measured on the harness's `--vulkan` mode: classified as D3D, the injected Overlay recorded 295 DXGI presents of a Vulkan swapchain and the layer forwarded into nothing). The layer is the capture side for anything that maps the Vulkan loader; a D3D title that happens to is the rarer shape and the one this rule gets wrong.
|
||||
> - **It comes up at the first admitted `vkCreateDevice`**, never at load and never at `vkCreateInstance`, so a process either gate refused never has a mapping with its pid on it. Init is not a hook path; the present hook is, and it follows the Overlay's rules — SEH-guarded, allocation-free, lock-free, three faults → `SELF_DISABLED`.
|
||||
> - **§S2 part three, the in-layer supervision, runs on the present path**, because the layer may not own a thread (the loader owns its mapping). `guardTicks` not advancing for `FL_GUARD_TICK_DEADLINE_MS` → `FL_STATUS_UNHOOKED`; `unhookRequested` → the same within one present; `pauseRequested` → no record, still forwarded. "Stops" means **passthrough forever with the reason on the mapping** — a layer cannot leave a running game's loader chain. A title that stops presenting is not stopped by the deadline, and has nothing to be observed either. Proven with a test-only flavour of the DLL whose deadline is 1.5 s (`fl_vklayer_shortdeadline`, never shipped; ctest `fl_vklayer_supervision`).
|
||||
> - **No registry for the operator host.** Loader 1.4.357 honours `VK_ADD_IMPLICIT_LAYER_PATH` (measured 2026-09-06, `spike-notes` §2): the CaptureHost's `launch` writes a manifest under `%LOCALAPPDATA%\FrameLedger\vklayer`, points the launched process at it, sets the enable variable and adds the image name to the enable-list for the session — discoverable by that process alone, gone when it ends. The Agent's HKCU registration (`12_BUILD`) is unchanged and remains P2's.
|
||||
- The layer respects the same guard, in two steps at init: it checks the enable-list, and it scans **its own process** against the anti-cheat blocklist. Either one saying no means fully passthrough. **A layer is machine-wide by nature — these checks are mandatory, not optional.**
|
||||
- The self-scan uses the **same matcher and the same rules file as the injection guard** (`fl_ac_rules.h`, compiled into both targets). Not a copy: a layer with its own blocklist would be a second matcher that can disagree with the first. Every uncertainty — rules unreadable, malformed, enumeration failed, a truncated list — resolves to passthrough, which is the opposite polarity from the injection guard and the same principle: leave the host alone.
|
||||
- Registered only while at least one Vulkan game has hooking enabled; unregistered on uninstall (Velopack hook) and when the last such game is disabled. **Never at install time** — `12_BUILD` §The Vulkan layer is not registered at install time.
|
||||
|
||||
> **Built 2026-09-14 (P3 PR-8b), as the repair tools and no more.** `Infrastructure.Vulkan.VkLayerRegistration`
|
||||
> writes the one DWORD under `HKCU\SOFTWARE\Khronos\Vulkan\ImplicitLayers` named by the manifest's path
|
||||
> (`%LOCALAPPDATA%\FrameLedger\vklayer\VkLayer_FRAMELEDGER_overlay.json`, written by the same code the launch
|
||||
> path uses); the Agent's `--register-vklayer` refuses unless a game has hooking enabled, `--unregister-vklayer`
|
||||
> also removes a stale value naming our manifest elsewhere, and `HelloAck.vulkanLayerRegistered` reads the key
|
||||
> at the Agent's start. Two things this build does **not** do, stated rather than implied: ~~(1) the automatic
|
||||
> register-on-first-enable / unregister-on-last-disable needs to know which enabled game is a *Vulkan* title,
|
||||
> and the ledger does not hold that fact until P4's capability flags — so the check is "any enabled game"~~
|
||||
> **— closed 2026-09-14 (P4 PR-2).** The fact is static and lives in `capability_flags` under the id `vulkan`:
|
||||
> `GameFileProbe` reads the executable's import and delay-load tables (`Infrastructure.Detection.PeImports`, bounded,
|
||||
> read-only) and looks for `vulkan-1.dll` as an ASCII or UTF-16 string in the bounded scan (a `LoadLibraryW`
|
||||
> loader — the harness's shape and many titles'); null when the file could not be read, never "no". A static
|
||||
> fact was chosen over the runtime one on purpose: the NVIDIA ICD maps `dxgi.dll` + `d3d12.dll` itself (the
|
||||
> 2026-09-06 note above), so runtime module presence is the weaker discriminator, and the automation has to act
|
||||
> at consent time, before the title ever runs. `Application.Vulkan.VkLayerReconciler` computes the desired
|
||||
> registration from the ledger — hook-enabled games whose flags carry `vulkan` — and moves the HKCU value to it,
|
||||
> called after every consent change the pipe handler and the console verbs make and after every detection
|
||||
> sweep (so a guard block, the crash policy's auto-disable, and a Vulkan fact that arrives after the consent all
|
||||
> converge within one 15 s interval). `--register-vklayer` runs the same reconciler and refuses when it finds no
|
||||
> such game; the Settings button follows the same rule (`HookedGameViewModel.UsesVulkan`). Not staged = nothing
|
||||
> to do — and **an Agent off the profile ledger (`--data-dir`) gets an inert registrar**, so the e2e suites'
|
||||
> consent for `hook-harness` (which `LoadLibraryW`s the loader and therefore reads as Vulkan) never reaches the
|
||||
> developer's HKCU (D17's shape). `VkLayerReconcilerTests`, `PeImportsTests` (a synthetic PE32+, both directories, the wide
|
||||
> literal, a malformed file). (2)
|
||||
> a registration buys nothing today: the layer gates on `FRAMELEDGER_ENABLE_VK_LAYER=1`, which only a launch
|
||||
> sets, and a launch already reaches the layer through `VK_ADD_IMPLICIT_LAYER_PATH`. Registration becomes
|
||||
> useful the day background capture sets the variable for a tracked Vulkan title started elsewhere, and not
|
||||
> before; until then the Settings button and the flag reflect and repair a state nothing needs.
|
||||
|
||||
### The enable-list
|
||||
|
||||
Referenced everywhere, specified nowhere until now (`20_OPEN_QUESTIONS` §S4).
|
||||
@@ -553,6 +620,21 @@ Every hook body is wrapped:
|
||||
|
||||
## Unhooking
|
||||
|
||||
> **Built 2026-09-06 (P1 item 4) as compare-and-restore PER INLINE PATCH.** The Overlay swaps no vtable
|
||||
> entries — every hook it installs is a MinHook inline patch on a function's first bytes — so the sentence
|
||||
> below applies in its inline form: `StopObserving` walks a registry of every patch this DLL made (target,
|
||||
> detour, name; filled by `PatchTarget` and the two direct sites) and calls `MH_DisableHook` on a target
|
||||
> **only while the bytes there are still the jump MinHook wrote for us** — `fl_patch_check.h`
|
||||
> `StillOurs`: `E9 rel32` → a `FF 25 00000000 <addr>` relay whose address is our detour, or the
|
||||
> hot-patch `EB F9` form of the same. `MH_DisableHook(MH_ALL_HOOKS)`, which this replaced, wrote every
|
||||
> saved prologue back without looking, and an overlay that patched the same function after us chains
|
||||
> through our jump — that write would have removed their hook silently (§H7). A patch that is no longer
|
||||
> ours is left in place, logged `UNHOOK_DECLINED`, and our detour stays in their chain forwarding (every
|
||||
> body consults `g_observing`). Proven both directions against a real MinHook patch and a simulated
|
||||
> foreign one in ctest `fl_unhook_inline` (the vtable form stays in `fl_unhook_preserves_foreign`), and
|
||||
> against the injected Overlay in ctest `fl_guard` `[log]`, where every patch reads `UNHOOK_RESTORED`
|
||||
> because the harness is alone in its process.
|
||||
|
||||
`FlRequestUnhook()` (or the control flag) ⇒ `MH_DisableHook(MH_ALL_HOOKS)`, restore vtable entries **only where they are still ours**, flush the ring, set status. **The DLL is not `FreeLibrary`'d from the live process** — a thread could still be inside a trampoline. It goes dormant and unloads with the process. This is deliberate and documented.
|
||||
|
||||
### Compare-and-restore, never unconditional restore
|
||||
@@ -590,6 +672,36 @@ compare-and-restore that never restores is not a fix.
|
||||
|
||||
No logging in hook bodies. A small fixed-size in-memory ring of structured events (hook installed, symbol missing, fault, unhook) is flushed to `logs\overlay-<pid>-*.log` by the init thread at session end, on unhook, or on Agent request — never mid-frame.
|
||||
|
||||
> **Built 2026-09-06 (P1 item 4), as specified, with the details a bug report needs.** A ring of 256 ×
|
||||
> 64-byte events (`qpc`, code, two operands, a 40-char name) appended with one `fetch_add` from init and
|
||||
> watchdog paths and from a hook's **SEH handler** — `NoteFault` records the exception code and the hook's
|
||||
> `__func__` — never from a hook body. Codes: `RING_CREATED`, `PRESENT_HOOKS`, `HOOK_INSTALLED` (one per
|
||||
> patch, with the target address), `SYMBOL_MISSING` (once per pair, and only when the module IS mapped),
|
||||
> `FAULT`, `STOP` (the reason), `UNHOOK_RESTORED` / `UNHOOK_DECLINED` (one per patch), `LOADER_DETOUR`,
|
||||
> `SUPERVISION_LOST`. **Three flush points, none on a present path:** the end of `InitThread` (so the
|
||||
> file exists from the start of the session and a crash mid-session still leaves it), the watchdog when
|
||||
> `FlControlBlock.logFlushRequested` changes (a counter the Agent bumps at session end; nothing clears it),
|
||||
> and the watchdog on its way out after any stop. Appended, never recreated; events overwritten before a
|
||||
> flush are counted in a `#` line. Path: `%LOCALAPPDATA%\FrameLedger\logs\overlay-<pid>-<yyyymmdd-hhmmss>.log`,
|
||||
> resolved by `SHGetKnownFolderPath` (§S21's rule, not the environment). No allocation: static ring,
|
||||
> static 64 KiB format buffer, static path. The CaptureHost prints the file and its `FAULT` / `STOP` /
|
||||
> `UNHOOK_*` / `SYMBOL_MISSING` / `SUPERVISION_LOST` lines at the end of every session
|
||||
> (`Consume/OverlayLog.cs`).
|
||||
|
||||
> **Tests and the real logs folder (2026-09-15).** The injection tests use the shipped Overlay, so their harness
|
||||
> logs land in the user's real `logs\` too: measured that day, 2506 overlay logs, **2492 of them hook-harness's**,
|
||||
> left by test runs since 2026-09-06, beside the owner's 14 from real titles. **The path stays not-a-parameter**: an
|
||||
> environment variable or any other switch in the injected DLL would reopen the per-launch vector §S21 closed, and a
|
||||
> test build of the Overlay would stop testing the binary that ships. Instead **each test binary removes what it
|
||||
> caused** when its run ends: an `overlay-*.log` created after the run started whose first line names a hook-harness
|
||||
> image that binary owns. Natively a Catch2 listener in `guard_test.cpp` over `src/native/tests/overlay_log_sweep.h` (the image
|
||||
> must be this build's `FL_HARNESS_EXE`); in managed code `tests/Shared/HarnessOverlayLogSweep.cs`, an xUnit assembly
|
||||
> fixture that `FrameLedger.DrainFixtures.targets` compiles into every test project staging the harness (the copy
|
||||
> beside the test binary, plus directories a test registers — `PipeEndToEndTests` runs a renamed copy from its
|
||||
> scratch directory). Test assemblies run in parallel with their own copies, so none removes a log another is about
|
||||
> to read; a game's log names the game. **`tools/test-artifacts-check.ps1` makes a missing sweep red**: a harness log
|
||||
> created during the gate and still there fails it. The logs from before this change are the owner's to delete.
|
||||
|
||||
## Test harness
|
||||
|
||||
`src/native/tools/hook-harness` — a minimal D3D11 app that presents at a controlled rate. It lets CI and local dev exercise hook paths with **no game and no anti-cheat surface at all** (`14_TESTING`).
|
||||
@@ -600,7 +712,7 @@ verification a dev-machine-only affair before:
|
||||
- **WARP** (`D3D_DRIVER_TYPE_WARP`) — a software rasteriser, so no adapter is required.
|
||||
- **`CreateSwapChainForComposition`** — no `HWND`, so no dependency on a window station or an interactive session.
|
||||
|
||||
Current modes: `--probe-vtable` (§H4, ctest `fl_vtable_indices`), `--probe-proxy` (§H5, ctest `fl_proxy_swapchain`), `--probe-unhook` (§H7, ctest `fl_unhook_preserves_foreign`), `--probe-cost` (NFR-1, measurement only), **`--probe-frames`** (ctest `fl_frame_identity` — what counts as a frame, against `GetLastPresentCount`), **`--probe-d3d12`** (ctest `fl_d3d12_acquisition` — device → command queue → swapchain), `--present N`, `--hold N`, **`--real`** and **`--plus-ui K``**.
|
||||
Current modes: `--probe-vtable` (§H4, ctest `fl_vtable_indices`), `--probe-proxy` (§H5, ctest `fl_proxy_swapchain`), `--probe-unhook` (§H7, ctest `fl_unhook_preserves_foreign`), `--probe-cost` (NFR-1, measurement only), **`--probe-frames`** (ctest `fl_frame_identity` — what counts as a frame, against `GetLastPresentCount`), **`--probe-d3d12`** (ctest `fl_d3d12_acquisition` — device → command queue → swapchain), `--present N`, `--hold N`, **`--real`** and **`--plus-ui K``**, **`--vulkan --hold-presenting N`** (P1 item 3, real loader, exit 77 = cannot run here) and **`--opengl --hold-presenting N`** (P1 item 4, gdi32 `SwapBuffers` on a hidden window, Microsoft's generic renderer — runs on CI).
|
||||
|
||||
> **Every present here used to carry `DXGI_PRESENT_TEST`, which submits nothing.** Measured: 500 of them leave `GetLastPresentCount` at 0 while 37 real presents move it by 37. "N presents → N records" was therefore satisfiable only by a writer counting non-frames. `--real` issues real presents; the test-present path is kept as a named mode because it is what an alt-tabbed title actually runs.
|
||||
|
||||
|
||||
+114
-24
@@ -34,24 +34,50 @@ Implementations compose rather than compete:
|
||||
|
||||
- `BaselineTelemetrySource` (L1) — always constructed.
|
||||
- `LhmTelemetrySource` (L2) — constructed when LHM initialises.
|
||||
- `NvapiTelemetrySource` (L3) — constructed only on NVIDIA hardware.
|
||||
- `NvapiTelemetrySource` (L3) — ~~constructed only on NVIDIA hardware~~ **always constructed since 2026-09-10 (P2 PR-E2)** and disables itself when the bridge DLL or the NVIDIA driver is absent, so the composite's descriptor simply omits `nvapi` and no caller has to know the vendor before composing.
|
||||
- `CompositeTelemetrySource` merges them with a fixed precedence per field (**L3 > L2 > L1**) and records which layer supplied each value.
|
||||
|
||||
`GpuSample`: `takenAt`, `layer`, `adapterName`, `tempCoreC`, `tempHotspotC`, `tempMemoryC`, `loadPct`, `vramAdapterMB`, `coreClockMhz`, `memClockMhz`, `powerW`, `fanRpm`, `throttleReasons`, `pcieGen/Width`. Every field nullable — `Capabilities` says what to trust, and the UI shows `N/A` rather than zero.
|
||||
|
||||
`sessions.telemetry_source` stores the **composite descriptor** (e.g. `l1+lhm+nvapi`), not a single name, so a user can see exactly why a field is missing.
|
||||
|
||||
> **Written 2026-09-09 (P2 PR-E1): `BaselineTelemetrySource` (L1), `CompositeTelemetrySource`
|
||||
> and the 1 Hz thread (`TelemetryPoller`, `fl-telemetry`).** Three things this block did not say
|
||||
> and the code now does. (1) The port gained `IsDisabled`: a layer that has fallen to
|
||||
> `Capabilities.None` because it was disabled and one that has simply not read yet were
|
||||
> indistinguishable through the port, and the **descriptor lists the layers still standing**
|
||||
> — `TelemetryLayerNames.Describe`, lowest first — so a layer disabled mid-session drops out of
|
||||
> the string the session is stored under. (2) The composite is **not a layer**: its `Layer` is
|
||||
> `None`, a merged sample's `Layer` is the highest layer that contributed anything, and
|
||||
> `LayerOf(field)` answers per field. It also applies the two-fault rule one level up — a layer
|
||||
> whose `TryRead` throws (which the port forbids) is excluded on the second throw, the others
|
||||
> untouched. (3) Identity is its own record, `GpuAdapterIdentity` (name, LUID, ids, memory sizes,
|
||||
> user-mode driver version), read once per session from DXGI; the Agent hands the handshake's
|
||||
> `adapterLuid` to `SelectAdapter` so samples describe the adapter the game presented on. Every
|
||||
> poller sample is stamped with QPC (`TelemetrySample.QpcTicks`), the ring's clock, and
|
||||
> `QpcClockTests` pins `Stopwatch` / `TimeProvider.GetTimestamp` to the real counter.
|
||||
|
||||
> Per-process VRAM comes from the **Overlay** (`IDXGIAdapter3::QueryVideoMemoryInfo` inside the game), not from here. Adapter-wide VRAM is a separate series with a different label — they answer different questions and users will otherwise think one of them is broken.
|
||||
|
||||
## L1 — baseline (no licence, all vendors)
|
||||
|
||||
- **DXGI:** `IDXGIFactory6::EnumAdapterByGpuPreference` → adapter description, LUID (matches the swapchain adapter from the Overlay handshake), dedicated/shared memory sizes. `IDXGIAdapter3::QueryVideoMemoryInfo` for adapter-wide usage/budget.
|
||||
- **DXGI:** `IDXGIFactory6::EnumAdapterByGpuPreference` → adapter description, LUID (matches the swapchain adapter from the Overlay handshake), dedicated/shared memory sizes. ~~`IDXGIAdapter3::QueryVideoMemoryInfo` for adapter-wide usage/budget.~~ **Measured wrong, 2026-09-09:** `DXGI_QUERY_VIDEO_MEMORY_INFO.CurrentUsage` is the *calling process's* usage by the structure's own definition — which is exactly why the Overlay reads it inside the game for `vram_proc` — and from the Agent it read **0 bytes** beside a 16 GB adapter. Adapter-wide usage is the PDH counter below, as this list always said; DXGI is identity only (`DxgiAdapters`, the first CsWin32 consumer in the tree).
|
||||
- **PDH performance counters** — the same source Task Manager uses, fully documented, vendor-neutral:
|
||||
- `\GPU Engine(*)\Utilization Percentage` (sum per engine type: 3D, Compute, Copy, VideoDecode)
|
||||
- `\GPU Adapter Memory(*)\Dedicated Usage`
|
||||
- `\GPU Process Memory(*)\Dedicated Usage` (cross-check against the Overlay's figure)
|
||||
- Instance names embed the LUID — parse and filter to our adapter, don't sum blindly across GPUs.
|
||||
- **Driver version:** `SetupAPI` / registry adapter properties. Feeds the hardware snapshot and the trend-chart change markers (`06_DATA_MODEL`).
|
||||
|
||||
> **Built 2026-09-09 (PR-E1), one counter of the three:** `PdhAdapterMemoryCounter` binds
|
||||
> `\GPU Adapter Memory(luid_0x<High>_0x<Low>_phys_0)\Dedicated Usage` by the selected
|
||||
> adapter's LUID — addressed directly, never a wildcard summed — and it is L1's one live field
|
||||
> (`GpuSample.VramAdapterMb`). Measured on the dev box: **1301 MB** in use on the RTX 5080 at an
|
||||
> idle desktop, moving tick to tick. A machine without the counter set fails the open and the
|
||||
> field is N/A with the layer standing — not a fault. **`Utilization Percentage` is deliberately
|
||||
> not read** (`20_OPEN_QUESTIONS` §M10, decided): `LoadPct` is L2's vendor-reported load and is
|
||||
> labelled as such. `GPU Process Memory` is not read either — the Overlay's in-process figure is
|
||||
> the one the pipeline stores, and a cross-check is a diagnostic, not a field.
|
||||
- **Driver version:** ~~`SetupAPI` / registry adapter properties.~~ **`IDXGIAdapter::CheckInterfaceSupport(IDXGIDevice)`** — its documented second output is the user-mode driver version for that interface, four 16-bit fields of one 64-bit value (`32.0.16.1664` on the dev box, 2026-09-09; the WARP adapter answers with the OS build). Neither SetupAPI nor the registry is walked: both need a device-instance enumeration nothing else here has a reason to carry. Feeds the hardware snapshot and the trend-chart change markers (`06_DATA_MODEL`). This is the four-part form the vendor's own tooling shows, not the marketing number (`561.09`), which only L3 knows.
|
||||
- **Optional probe, P0 evaluation only:** `D3DKMTQueryAdapterInfo` with `KMTQAITYPE_ADAPTERPERFDATA` reportedly exposes temperature, power and fan for any vendor. The D3DKMT structures are **not fully documented and have changed across Windows builds**. Treat as an experiment: if it proves stable on both Win 10 22H2 and Win 11 during P0, keep it as an L1 extra behind a capability flag; if it looks fragile, drop it and let L2 handle temperatures. Never let it be load-bearing.
|
||||
|
||||
> **🅓 The two-OS requirement is deferred to Win 11 only — owner decision, 2026-08-05.**
|
||||
@@ -86,6 +112,21 @@ 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. `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.
|
||||
@@ -96,15 +137,41 @@ CPU and motherboard sensors remain LHM-only, elevated-only, PawnIO-dependent, an
|
||||
|
||||
Still resolve **entry points defensively at runtime**: `nvapi64.dll` may be absent (no NVIDIA GPU) or older than our headers. `NvAPI_Initialize` failing is a normal condition that must disable L3 cleanly, not throw.
|
||||
|
||||
> **Built 2026-09-10 (P2 PR-E2).** NVAPI is a C API behind a static import library, so the managed
|
||||
> side reaches it through a native DLL of our own: **`FrameLedger.NvapiBridge.dll`**
|
||||
> (`src/native/FrameLedger.NvapiBridge/`, C ABI in `include/fl_nvapi_bridge.h`) — the **only shipped
|
||||
> binary that links `nvapi64.lib`**, read-only by construction (every export is a query), loaded by the
|
||||
> Agent into **its own process** by absolute path and **never into a game**. Its name carries none of
|
||||
> the words the guard's §S18 heuristic scans a launcher's ancestors for. The ABI is a fixed struct with
|
||||
> a `present` bitmask per field (`FlNvReadSample`), a refcounted `FlNvInit` / `FlNvShutdown`, the driver
|
||||
> version, the per-pid NGX words (`FlNvNgxState`), and size / ABI-version / build-id queries so a mirror
|
||||
> that drifts is refused (`FL_NV_BAD_SIZE`) rather than read. On the managed side, all in
|
||||
> `Infrastructure.Telemetry`: `NativeNvapiBridge` (the second P/Invoke facade after the guard's — same
|
||||
> absolute-path rule, through the assembly's one `DllImport` resolver, `Infrastructure.Native.BesideThisAssembly`,
|
||||
> because the runtime allows exactly one per assembly and two static constructors setting one is an
|
||||
> exception in whichever runs second), `NvapiTelemetrySource` (a clear bit is `null`, never 0; an
|
||||
> `Init` that does not answer 0 disables the layer with **zero faults**, because a machine without the
|
||||
> driver is a normal condition; two throws disable it for the session), and `NvapiNgxStateProbe`
|
||||
> (`INgxDriverProbe` in-process — the capture host **no longer spawns `fl-probe-nvapi.exe`**, and the
|
||||
> probe target is no longer staged beside it). Verified by ctest `fl_nvapi_bridge`
|
||||
> (`src/native/tests/nvapi_bridge_test.cpp`, `BRANCH: AVAILABLE|DEGRADED` required the way
|
||||
> `fl_nvapi_probe` requires it) and by `NvapiBridgeMirrorTests`, which compares `Marshal.SizeOf` of both
|
||||
> mirrors against the DLL's own answers and **fails rather than skips** when the DLL is not staged.
|
||||
>
|
||||
> **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).
|
||||
|
||||
| Purpose | Function |
|
||||
|---|---|
|
||||
| Init / enumerate | `NvAPI_Initialize`, `NvAPI_EnumPhysicalGPUs`, `NvAPI_GPU_GetFullName` |
|
||||
| Temperatures | `NvAPI_GPU_GetThermalSettings` (+ extended thermal query for hotspot/memory where available) |
|
||||
| Utilisation | `NvAPI_GPU_GetDynamicPstatesInfoEx` (GPU / FB / VID / BUS domains) |
|
||||
| Clocks | `NvAPI_GPU_GetAllClockFrequencies` |
|
||||
| Memory | `NvAPI_GPU_GetMemoryInfoEx` — **not `NvAPI_GPU_GetMemoryInfo`**, which this table named until 2026-08-05. The vendored headers mark it `__nvapi_deprecated_function` ("deprecated in release 520"), so under `/W4 /WX` a call to it fails the native build |
|
||||
| **Throttle reasons** | `NvAPI_GPU_GetPerfDecreaseInfo` — not available from L1 or L2 |
|
||||
| Driver version | `NvAPI_SYS_GetDriverAndBranchVersion` |
|
||||
| Temperatures | `NvAPI_GPU_GetThermalSettings` (+ extended thermal query for hotspot/memory where available). **Bridge (2026-09-10):** the public enumeration only — core is the `GPU` target; memory is the `MEMORY` target when the driver lists one, and on the RTX 5080 it does not (bit clear → `null`); hotspot is not read |
|
||||
| Utilisation | `NvAPI_GPU_GetDynamicPstatesInfoEx` (GPU / FB / VID / BUS domains). **Bridge (2026-09-10):** the GPU domain only, as `loadPct` |
|
||||
| Clocks | `NvAPI_GPU_GetAllClockFrequencies` — **bridge (2026-09-10):** current graphics and memory clocks |
|
||||
| Memory | `NvAPI_GPU_GetMemoryInfoEx` — **not `NvAPI_GPU_GetMemoryInfo`**, which this table named until 2026-08-05. The vendored headers mark it `__nvapi_deprecated_function` ("deprecated in release 520"), so under `/W4 /WX` a call to it fails the native build. **Neither is called (2026-09-10):** the vendored `nvapi.h` (`cd6918f6`) does not declare `GetMemoryInfoEx` at all — the deprecation message names a function the same header set does not ship — so the bridge's `vram` field is **reserved**, its bit is never set, and VRAM stays L1's PDH adapter counter. Taking a newer header set is the way to change that, not a call to the deprecated one |
|
||||
| **Throttle reasons** | `NvAPI_GPU_GetPerfDecreaseInfo` — not available from L1 or L2. **Bridge (2026-09-10):** the raw reason mask, and 0 is a measurement (no reason), not a clear bit |
|
||||
| Driver version | `NvAPI_SYS_GetDriverAndBranchVersion` — **bridge (2026-09-10):** `FlNvDriverVersion`, surfaced as `616.64 (r616_41)` |
|
||||
| **NGX per-process state** | `NvAPI_NGX_GetNGXOverrideState` (R570+) — the driver's feedback word per DLSS feature for a PID, read OUT OF PROCESS by `fl-probe-nvapi --ngx-state` and, since 2026-09-06, by the capture host beside each module snapshot — **in-process through the bridge since 2026-09-10** (`NvapiNgxStateProbe`; the spawn is retired and the words, the merge and the printed block are unchanged). Measured: the SR word's `CREATED \| EVALUATE` is set without an NVIDIA-app override; the FG word follows DLSS-G once created (`CREATED \| EVALUATE` at ×4, corrected the same day — the first reading was blind because it was early), the multiplier bits stay clear; `scalingRatio` is 0 even under an override. Identity only, SR and FG (`03_METRICS` §Upscaling) |
|
||||
| **Reflex / PC latency** | `NvAPI_D3D_GetLatency` → per-frame sim/render/present/driver/GPU timestamps; hooking `NvAPI_D3D_SetSleepMode` / `SetLatencyMarker` in the Overlay tells us the game enabled Reflex (`17_HOOK_ENGINE`) |
|
||||
|
||||
Reflex latency is the single strongest reason L3 exists — it is genuinely unavailable anywhere else.
|
||||
@@ -135,10 +202,21 @@ Read off the upstream repository through the GitHub API, not from memory:
|
||||
header of interest carries the same grant inline — the `ffx-api/include/ffx_api/` set and the
|
||||
FSR 3.0 host API under `sdk/include/FidelityFX/host/`. None of step 2's needles appear. **This
|
||||
paragraph said "vendor from this tag", and its own reversal condition fired the same day** —
|
||||
see the third bullet. The host API is still only here: `main` dropped `ffx_fsr3.h`, so the FSR
|
||||
see the third bullet. ~~The host API is still only here: `main` dropped `ffx_fsr3.h`, so the FSR
|
||||
3.0 route (Cyberpunk's `ffx_fsr3_x64.dll`, named exports) vendors from `v1.1.4` when it is built,
|
||||
and its closure is **ten** files, not the nine first listed — `ffx_interface.h` includes
|
||||
`ffx_message.h` — with `<mutex>`/`<shared_mutex>` reached through `ffx_types.h`.
|
||||
`ffx_message.h` — with `<mutex>`/`<shared_mutex>` reached through `ffx_types.h`.~~ **Wrong tag,
|
||||
corrected 2026-09-05 when the route was built.** Cyberpunk's `ffx_fsr3_x64.dll` exports twelve
|
||||
`ffxFsr3*` names (`vendor-exports.json`), which is exactly tag **`fsr3-v3.0.4`**'s declaration
|
||||
list; `v1.1.4` declares fifteen and appends `upscaleSize`, `flags` and `frameID` to
|
||||
`FfxFsr3DispatchUpscaleDescription` *after* `renderSize` — a detour typed against it would read
|
||||
the wrong bytes off the module the title ships. At `fsr3-v3.0.4` the root `LICENSE.txt` is MIT
|
||||
verbatim, every header carries the grant inline, and **`ffx_types.h` includes `<stdint.h>` and
|
||||
nothing else** — the `<mutex>` block exists only from 1.1.x behind `#ifndef FFX_MUTEX`. The
|
||||
closure is ten files with **no `ffx_message.h`** (nine host headers plus
|
||||
`gpu/fsr3upscaler/ffx_fsr3upscaler_resources.h`). Vendored at
|
||||
`src/native/third_party/fidelityfx-fsr3/` in its own directory because the licence *shape*
|
||||
differs from `v2.3.0`'s exception list; `license-check.ps1` §2e asserts it per file.
|
||||
- **`main` == tag `v2.3.0`** (`60f4ea81`, "AMD FSR SDK 2.3.0", 2026-06-24) is a different shape:
|
||||
its `docs/license.md` is a **binary-only, no-reverse-engineering** default licence that
|
||||
"applies to all files except as noted below", followed by an MIT exception list of 845 paths.
|
||||
@@ -187,7 +265,11 @@ refused the same day (delegated by the owner, decided 2026-09-04).** It declares
|
||||
reads no argument, but installing it inline-patches Intel's code inside the game process, and
|
||||
the same licence forbids *"any modification"*; the census is the answer NGX got and Intel gets
|
||||
the same one. Reversal condition: Intel publishing the headers under a licence that clears the
|
||||
checklist, at which point this paragraph is re-run, not argued around.
|
||||
checklist, at which point this paragraph is re-run, not argued around. **Re-run 2026-09-06 against
|
||||
<https://raw.githubusercontent.com/intel/xess/main/LICENSE.txt> and `inc/xess/xess.h`: unchanged** —
|
||||
the same licence, the same three needles, the same header banner. Not fired. Intel's README does
|
||||
state that XeSS-FG runs on *"non-Intel GPUs with SM 6.4 support"*, so an XeFG session is measurable
|
||||
on the NVIDIA dev box even though nothing in it may be hooked or declared.
|
||||
|
||||
### Checklist before adding any vendor SDK
|
||||
|
||||
@@ -228,10 +310,10 @@ as the same thing.
|
||||
|
||||
| Field | NVIDIA | AMD | Intel |
|
||||
|---|---|---|---|
|
||||
| GPU utilisation | ? | untested | untested |
|
||||
| Adapter VRAM | ? | untested | untested |
|
||||
| Per-process VRAM | ? (also from Overlay) | untested | untested |
|
||||
| Driver version | ? | untested | untested |
|
||||
| GPU utilisation | **deferred by decision** (§M10, 2026-09-09) — L2's vendor-reported load is what `LoadPct` carries, labelled as such; the engine counters are not read | untested | untested |
|
||||
| Adapter VRAM | ✓ **measured 2026-09-09** — PDH `GPU Adapter Memory … Dedicated Usage`, 1301 MB at an idle desktop, RTX 5080 (`QueryVideoMemoryInfo` measured **not** adapter-wide: 0 bytes from the Agent) | untested | untested |
|
||||
| Per-process VRAM | `arch` for L1 — the Overlay's in-process `QueryVideoMemoryInfo` is the figure stored; `GPU Process Memory` is not read | `arch` | `arch` |
|
||||
| Driver version | ✓ **measured 2026-09-09** — `CheckInterfaceSupport(IDXGIDevice)` → `32.0.16.1664` | untested | untested |
|
||||
| Core temp | ? (D3DKMT probe, Win 11 only — see below) | untested | untested |
|
||||
| Power | ? (D3DKMT probe) | untested | untested |
|
||||
| Fan | ? (D3DKMT probe) | untested | untested |
|
||||
@@ -269,19 +351,24 @@ answer; the `untested` cells are exactly as untested as before.
|
||||
| Field | NVIDIA | AMD | Intel |
|
||||
|---|---|---|---|
|
||||
| **Initialises at all** | ✓ **measured 2026-08-05** | `arch` | `arch` |
|
||||
| **Driver version** | ✓ **measured** — `610.88`, branch `r610_85` | `arch` | `arch` |
|
||||
| **Driver version** | ✓ **measured** — `610.88`, branch `r610_85`; **through the bridge 2026-09-10:** `616.64`, `r616_41` | `arch` | `arch` |
|
||||
| **GPU enumeration + name** | ✓ **measured** — 1 GPU, "NVIDIA GeForce RTX 5080" | `arch` | `arch` |
|
||||
| **Degrades cleanly when absent** | ✓ **measured** — see below | `arch` | `arch` |
|
||||
| Core / hotspot / memory temp | ? | `arch` | `arch` |
|
||||
| Per-domain utilisation | ? | `arch` | `arch` |
|
||||
| Clocks, Power | ? | `arch` | `arch` |
|
||||
| Throttle reasons | ? | `arch` | `arch` |
|
||||
| Reflex / PC latency | ? | `arch` | `arch` |
|
||||
| Core / hotspot / memory temp | **core ✓ measured 2026-09-10** — 35 °C at an idle desktop; **memory: bit clear** on this GPU (no `MEMORY` thermal target enumerated → `null`, not 0); hotspot not read | `arch` | `arch` |
|
||||
| Per-domain utilisation | **GPU domain ✓ measured 2026-09-10** — 0 % at an idle desktop, present bit set (a measured zero); FB / VID / BUS not read | `arch` | `arch` |
|
||||
| Clocks, Power | **clocks ✓ measured 2026-09-10** — 2670 MHz graphics, 15001 MHz memory; power not read | `arch` | `arch` |
|
||||
| Throttle reasons | ✓ **measured 2026-09-10** — mask 0 at an idle desktop, present bit set | `arch` | `arch` |
|
||||
| Fan | **bit clear at an idle desktop 2026-09-10** — the tach reading is refused while the fans are stopped, and the bridge reports that as absent rather than 0 RPM; a reading under load is the owner's to take | `arch` | `arch` |
|
||||
| PCIe width | ✓ **measured 2026-09-10** — ×16; generation not read | `arch` | `arch` |
|
||||
| Reflex / PC latency | not a poller field (§M8) | `arch` | `arch` |
|
||||
|
||||
The four measured rows come from `ctest fl_nvapi_probe` (`src/native/tools/fl-probe-nvapi`),
|
||||
which exists because vendoring added 2.4 MB of headers and an import library that **nothing
|
||||
else compiles against yet** — an unconsumed vendored dependency is one whose header closure
|
||||
could be short by a file with every gate still green.
|
||||
could be short by a file with every gate still green. **The 2026-09-10 rows** come from one
|
||||
`FlNvReadSample` through `FrameLedger.NvapiBridge.dll` on the dev box (RTX 5080, driver 616.64),
|
||||
read from the staged DLL by hand after `NvapiBridgeMirrorTests` had passed against it; the
|
||||
bridge is the second consumer of the vendored material and the first that ships.
|
||||
|
||||
**"Degrades cleanly when absent" — what is observed, and what is inferred.** `nvapi64.lib`
|
||||
is a *static* library of stubs that reach `nvapi64.dll` through `nvapi_QueryInterface` at
|
||||
@@ -334,6 +421,9 @@ alone could never catch.
|
||||
> The NVIDIA half is **not** deferred and ~~none of it exists in code yet — no PDH, no
|
||||
> DXGI telemetry, no LibreHardwareMonitor, no NVAPI~~ — **L2 exists as of 2026-09-03**
|
||||
> (`LhmTelemetrySource`, `SensorMap`, the port in `FrameLedger.Application.Telemetry`);
|
||||
> L1 and L3 are still unwritten. §M5 in particular (do LHM GPU
|
||||
> ~~L1 and L3 are still unwritten~~ **L1 and the composite exist as of 2026-09-09**
|
||||
> (`BaselineTelemetrySource`, `DxgiAdapters`, `PdhAdapterMemoryCounter`,
|
||||
> `CompositeTelemetrySource`, `TelemetryPoller`); ~~L3 is P2's PR-E2~~ **L3 exists as of 2026-09-10**
|
||||
> (`NvapiTelemetrySource` over `FrameLedger.NvapiBridge.dll`, §L3). §M5 in particular (do LHM GPU
|
||||
> sensors work unelevated, without PawnIO?) decided whether the default unelevated
|
||||
> Agent has temperatures at all — **it does, on NVIDIA; row R1 above.**
|
||||
@@ -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 "stealth mode", or documentation explaining how to defeat the guard below. *(This line also read "'bypass' setting" until 2026-09-21. The owner decided that day that one bypass exists — §The user's bypass, under the guard — and what stays on THIS list is everything that would make FrameLedger harder to see: that bypass changes whether we inject, never how.)*
|
||||
- Reading or writing game memory outside the arguments of APIs we hooked
|
||||
- Kernel drivers of our own
|
||||
|
||||
@@ -50,6 +50,13 @@ Implemented in `FrameLedger.Injector` and reached from managed code through a th
|
||||
> against a suspended target (§S1). Neither is "no modules found". The read
|
||||
> handle rights above are confirmed sufficient for every target this call can
|
||||
> legitimately reach.
|
||||
>
|
||||
> **Launch mode (2026-09-06, P1 item 2) does not weaken this.** `FlGuardedInjectWhenReady` polls
|
||||
> the same enumeration to learn *when* the launched target has mapped a presentation runtime, and a
|
||||
> failing enumeration there means "not yet" — the poll continues. That is not a pass: the poll
|
||||
> matches nothing against the blocklist, and the injection happens only after check 1 has run in
|
||||
> full, with the enumeration succeeding, exactly as in attach mode. A launched target that never
|
||||
> becomes scannable is never injected (`LaunchNoPresentationRuntime`).
|
||||
> **Which processes get scanned: the game's own subtree.** `04_CAPTURE`
|
||||
> §The guard writes `Check(pid)` — singular — while `04_CAPTURE` §Process
|
||||
> watcher says the capture target is a *descendant* elected from a ppid
|
||||
@@ -341,7 +348,54 @@ 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**: 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.
|
||||
|
||||
### The user's bypass — owner decision 2026-09-21
|
||||
|
||||
The owner asked for a mode that skips the guard at the user's own risk, behind a warning the user MUST accept first. This section is that mode's whole specification; CLAUDE.md rule 2 carries the same constraints as a rule.
|
||||
|
||||
**What it is.** A per-game switch on the game's page, **off by default**, that lets a user overrule the guard's *judgement* for that one game. With it on, the Agent reaches the guard through `FlGuardedInjectAcknowledged` / `FlGuardedInjectWhenReadyAcknowledged` instead of the plain entries. The guard still runs **every** check in the same order. Where the evaluation refuses with a reason `fl::guard::IsGuardJudgement` accepts, the injection proceeds and the verdict is **`AllowedUnderUserBypass` (28)** — `family` and `signal` still name what was found. It is not `Allow`: `Verdict::Allowed()` and `AntiCheatVerdict.IsAllowed` stay false for it, so every caller written before it existed keeps refusing, and `CaptureSession` — the one caller that may proceed — asks `IsAllowedUnderBypass` by name.
|
||||
|
||||
**What it overrules: a judgement. What it never overrules: a fact.**
|
||||
|
||||
| Overruled (the guard's judgement) | Never overruled |
|
||||
|---|---|
|
||||
| `BlockedModule`, `BlockedDriver`, `BlockedService`, `BlockedExecutable`, `BlockedStoreId`, `AntiCheatDirectory`, `AntiCheatFile`, `SuspiciousUnsigned` | `KillSwitchEngaged` (FR-2.4 outranks everything) |
|
||||
| the scans that could not look, which the guard treats as findings: `ModuleScanFailed`, `ProcessUnreadable`, `ProcessTreeUnavailable`, `DriverScanFailed`, `ServiceQueryFailed`, `PreScanFailed` | `HookNotEnabled`, `ConsentMissing` — the bypass is not a second way to enable or to consent |
|
||||
| unusable rules: `RulesUnreadable`, `RulesMalformed`, `RulesIncomplete` | `PayloadNotOurs` — no acknowledgement loads a foreign DLL (§S22 stands) |
|
||||
| the latch a past judgement left on the row: `PreviouslyBlocked`, and the pre-scan's "could not verify" | `TargetIsWow64`, `InjectionFailed`, `LaunchTargetExited`, `LaunchNoPresentationRuntime` |
|
||||
| | **a Vulkan title the guard refuses**: the layer has its own in-process guard, and this path does not talk past it |
|
||||
|
||||
The list exists twice — `fl::guard::IsGuardJudgement` and `AntiCheatVerdict.IsGuardJudgement` — and `GuardMirrorTests` holds them against each other for every reason through the exported `FlGuardIsJudgement`. `PreviouslyBlocked` is the one deliberate difference: managed-only, because the native guard never produces it.
|
||||
|
||||
**How it is turned on — a recorded human act, the shape consent has.**
|
||||
1. The App shows its own disclosure (`GuardBypassPrompt`, text in `FrameLedger.Shared` `Safety_Bypass_*`, reviewed as the safety text it is; `ja` ships the English until a reviewer signs, `09_I18N`). It states what the guard found for THIS game, that anti-cheat treats a loaded DLL as tampering whatever it does, that the account can be flagged, suspended or **permanently banned** without warning or appeal, that FrameLedger does not hide and never will, and — in the owner's words — that **by turning it on the user accepts the entire risk and the developers accept no responsibility or liability** for anything that follows.
|
||||
2. The primary button is the Danger one and is enabled only while **both** acts are performed: a ticked acknowledgement **and** the typed phrase `BYPASS` (`GuardBypassDisclosure.ConfirmationPhrase`, the same five letters in every language). Enter keeps the guard on.
|
||||
3. The App writes nothing. It sends `SetGuardBypass` (`07_IPC`); the Agent refuses any disclosure version but its own (`GuardBypassDisclosure.Version`), re-reads the executable, and stamps `games.guard_bypass_at` + `guard_bypass_disclosure_version` (schema 0007) through `IGuardBypassStore` — a port of its own, so nothing that can grant consent can by the same call overrule the guard.
|
||||
4. It enables nothing. Hooking is still its own switch and its own FR-2.1 dialog; with the bypass recorded, `SetHookEnabled` still runs the pre-scan and **still writes the finding** (`hook_blocked_reason` stays on the row and stays true) and then stamps the consent beside it, answering `prescan: "bypassed"`.
|
||||
|
||||
**What it cannot do, measured on its first real use (2026-09-21, the owner, ELDEN RING under Easy Anti-Cheat).** A
|
||||
kernel anti-cheat does not only detect a loaded DLL; its driver strips other processes' handles to the game. From the
|
||||
Agent that looks like this: the watcher sees the process (its image path is readable with limited rights), and
|
||||
`TargetResolver` cannot read its main module — every candidate exists and none can be opened. That is
|
||||
`SessionEndReason.TargetUnreadable` since 2026-09-21 (it was reported as `TargetAmbiguous`, "more than one process is
|
||||
running it", about one process; reached the user as a toast reading `InjectFailed: TargetAmbiguous`; and the one-second
|
||||
session was discarded for being short — so with the bypass ON the whole visible result was nothing). **The bypass does
|
||||
not change this and nothing will be built that does**: it overrules FrameLedger's own refusal, and a process another
|
||||
product's driver has closed to us stays closed — opening it anyway would be defeating that product, which is rule 3,
|
||||
not rule 2. The user now gets a persistent notice that says so (`Safety_Refused_TargetUnreadable`), the bypass
|
||||
disclosure says it before they accept (`GuardBypassDisclosure.Version` is `/2` for that sentence), and
|
||||
`legal/DISCLAIMER.md` §2A says it. The same reason covers a game that runs as administrator while the Agent does not.
|
||||
|
||||
**How it ends.** Turning the switch off (no dialog needed to restore the guard); turning hooking off (`RevokeAsync` clears it — the row returns to its safest state); the executable changing (`HookRequest.FromConsent` drops it on a fingerprint mismatch exactly as it drops consent, and *Change executable…* clears the columns).
|
||||
|
||||
**During a session.** `GuardSupervisor` still scans every 30 s and the tick still counts — the Overlay's own stop is fed by it. A scan that refuses on a *judgement* is kept (`LastVerdict`), counted (`JudgementsOverruled`) and does not unhook: it is the refusal the user overruled, re-discovered. A refusal that is not a judgement still unhooks.
|
||||
|
||||
**Afterwards.** `CaptureOutcome.StartedUnderBypass` carries the start verdict; the row gets `guard_bypassed = 1`, `guard_bypass_family`, `guard_bypass_signal`, and `capture_notes` gains `guard-bypass=<family>/<signal>`. The sessions list, the session summary (an Error `InfoBar`), the CSV header and the JSON export all say so. **Recorded limit:** a session recovered from a `.partial` after an Agent crash does not carry the mark — the verdict is known only to the live loop.
|
||||
|
||||
**What did NOT change, and may not.** `InjectViaLoadLibrary` still has 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. `FloorFamilies` is untouched: the bypass does not shrink what the guard looks for, so §S21 stays closed — that was a bypass a crafted *data file* performed silently; this is one a *person* performs through a disclosure, and the difference is the whole design. The rules schema still rejects any `enabled` / `severity` / `warnOnly` field. There is no global form, and none may be added.
|
||||
|
||||
**Withdrawing it.** Pre-committed: if a report shows a user reached an injection under this path without having seen the disclosure, or the mark failing to appear on a session that ran under it, the switch is removed from the App in the next release and re-enters only with the defect's test.
|
||||
|
||||
### The floor data cannot remove
|
||||
|
||||
@@ -502,6 +556,23 @@ the entire driver stack read as untrusted, and combined with the `guard` and
|
||||
theoretical one. A signature that is absent, invalid, or simply could not be
|
||||
checked stays untrusted and refuses — that direction is deliberate.
|
||||
|
||||
> **Wired 2026-09-06, the EMBEDDED half only, under a compiled-in bound** (`20_OPEN_QUESTIONS`
|
||||
> §S19(b), row G1: the CI leg and the owner's adapters-disabled leg both left every verdict
|
||||
> unchanged). `Sources::ModuleSignerOrganisation` verifies a fragment-matching module's embedded
|
||||
> Authenticode signature with `WinVerifyTrust` under `WTD_REVOKE_NONE | WTD_CACHE_ONLY_URL_RETRIEVAL`
|
||||
> — no CRL or OCSP fetch, measured rather than assumed — and only then reads the subject `O=`. The
|
||||
> guard trusts it only if the organisation is on the rules file's `trustedSigners` **and** on the list
|
||||
> compiled into the binary (`IsCompiledTrustedSigner`): the rules file may narrow that list and may
|
||||
> never widen it, so a rules push cannot widen the hard gate — the boundary of what the gate trusts is
|
||||
> code, as it is for the launcher list. A trusted module keeps the scan looking; it never stops it, so
|
||||
> an untrusted module loaded after it is still judged. It applies to the injection target as well as
|
||||
> to its ancestors — a game that loads a Microsoft-signed key-protection provider is the false refusal
|
||||
> this half exists to remove. **Fail-closed rows:** no embedded signature (catalog-only system
|
||||
> binaries such as `mskeyprotect.dll` — the `CryptCATAdmin*` half is deferred with its own rationale),
|
||||
> an invalid signature, an unreadable `O=`, a null path, a null or failing seam, an organisation on
|
||||
> one list but not the other — every one is untrusted and refuses. Cost: ~2–4 ms per verified module,
|
||||
> reached only on a fragment hit, inside the 30 s loop.
|
||||
|
||||
### During a session
|
||||
|
||||
Re-run **every pre-injection check** every 30 s, for **every Tier-1 session —
|
||||
@@ -561,6 +632,20 @@ injected or layered**.
|
||||
|
||||
**Be honest about the window.** A 30 s poll means anti-cheat can be loaded for up to 30 s before we react — the unhook is immediate *once detected*, not immediate in absolute terms. Consent and disclaimer wording must say "within 30 seconds", never "immediately" (`legal/DISCLAIMER.md` §2). Whether to shrink the window, or to detect the load directly via the `LoadLibrary` hook `17_HOOK_ENGINE` §DLL entry **specifies** for lazily-loaded graphics DLLs, is `20_OPEN_QUESTIONS` §S6.
|
||||
|
||||
> **The in-process half exists since 2026-09-06 (P1 item 1), and the sentence above stays true because
|
||||
> of what it does NOT cover.** The Overlay's `LoadLibrary` detour compares every module the loader maps
|
||||
> mid-session against the **compiled floor's MODULE families — the exact prefix names, and nothing
|
||||
> else** — and stops the Overlay from inside on a match (`FL_STATUS_STOPPED_BLOCKLISTED`; `17_HOOK_ENGINE`
|
||||
> §DLL entry step 3), within one present or one watchdog iteration. That is the same set the Agent's
|
||||
> guard matches by name. **The fragment tier and the signer tier are not in the detour**, on purpose: a
|
||||
> substring scan is not allocation-free in a hook body under the loader lock, and `WinVerifyTrust` from
|
||||
> inside a game process is out of the question — so a module the floor knows only by a fragment, or only
|
||||
> by its signer, is still caught by **this host's 30 s scan and by nothing sooner**. The disclosure
|
||||
> therefore does not change: "within 30 seconds" remains the promise; the exact-name case is now usually
|
||||
> much faster, and the report says which happened (`EARLY STOP` naming the family, or the host's own
|
||||
> stop). Modules loaded **before** the Overlay attached are the pre-injection scan's, as always. The
|
||||
> detour supplements the poll; it replaces nothing (§S6's own ruling).
|
||||
|
||||
> **This sentence used to say the hook "already exists and is currently unused", which was false.** Corrected 2026-08-04: the Overlay installs no hooks at all — `dllmain.cpp` exports one function and nothing in the tree calls `MH_CreateHook` outside a probe. §S6 is therefore downstream of the whole P1 hook layer, not "the cheapest available improvement to the most important behavior in the product". A reader planning work off this paragraph was being told a mechanism was sitting there ready.
|
||||
|
||||
### Elevated / protected targets
|
||||
@@ -601,6 +686,35 @@ Enabling hooking is a **per-game** action, gated by a one-time dialog per game t
|
||||
|
||||
Consent is stored per game (`games.hook_consent_at`), **stamped by the Agent, never supplied by a client** (`07_IPC` §The pipe is not a trust boundary). Wording lives in `.resx` and is reviewed with the same care as the legal documents.
|
||||
|
||||
> **Built 2026-09-13 (P3 PR-4).** The dialog is `FrameLedger.App`'s `ConsentPrompt` over WPF UI's `ContentDialog`,
|
||||
> its text `FrameLedger.Shared`'s `Safety_Consent_*` family and nothing else: the intro (which says it recommends
|
||||
> neither choice), what is injected and why, **Tier 1 and Tier 2 as two paragraphs of the same shape** (each
|
||||
> enumerating what the session records; Tier 2 is described by what it does, never as less), the anti-cheat
|
||||
> statement including the 30 s unhook, the terms-of-service statement, and the typed acknowledgement — the
|
||||
> primary button is disabled until the phrase is typed exactly, and Enter never enables. `en` and `vi` are
|
||||
> written (the owner reviews `vi`); **`ja` is the English verbatim, marked `safety: human review required`**,
|
||||
> which the resx audit enforces (`09_I18N` §Safety-critical strings). The wording carries a version
|
||||
> (`Shared.Safety.SafetyDisclosure.Version = consent-dialog/1`; bump on any change of meaning in any
|
||||
> language): the Agent's `HelloAck` names the version it stamps against, the App **does not open the dialog**
|
||||
> when it differs from its own (D14 — it says "restart both"), the App sends the version it showed, and the
|
||||
> Agent's `SetHookEnabled` handler re-runs the pre-scan, compares the version to its own, and stamps
|
||||
> `ConsentProvenance.ConsentDialog` from its own clock or answers `Error DisclosureVersionMismatch` with
|
||||
> nothing written. `HookingConsentTests` (App), `AgentCommandHandlerTests` (Agent side) and
|
||||
> `PipeEndToEndTests` (the real pipe, the real pre-scan, the row read back) pin each half. The toggle that opens
|
||||
> it is the game page's, PR-5.
|
||||
|
||||
> **The Agent stamps one since 2026-09-10 (P2 PR-F, HANDOFF §P2 decision D4):** `FrameLedger.Agent --console
|
||||
> consent grant` shows `OperatorDisclosure` (the same four statements, first line naming the surface), requires
|
||||
> the typed phrase, refuses redirected stdin, and records `ConsentProvenance.AgentConsoleOperator` with the
|
||||
> Agent's own clock — the property a file store could not uphold. It is still **not FR-2.1's dialog**, and its
|
||||
> text says so first; ~~P3's dialog retires it~~ **P3 PR-4's dialog (2026-09-13, above) is the user path; the verb
|
||||
> stays as the developer path it always said it was** — its provenance value stays distinguishable in the row.
|
||||
> **FR-2.4's kill switch is built the same day as the FOURTH input
|
||||
> of `HookedCaptureGate`** (decision D7): `settings.hooking.kill_switch = 1` refuses every game with
|
||||
> `KillSwitchEngaged` before consent is read, stops a running session at its next guard-scan boundary by
|
||||
> 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.
|
||||
|
||||
### A game already enabled can become blocked later
|
||||
|
||||
+785
-38
File diff suppressed because it is too large.
Load diff
+519
-21
@@ -31,7 +31,24 @@ and traps**. It deliberately carries **no status**.
|
||||
|
||||
## Where P0 actually stands
|
||||
|
||||
Two exit criteria remain (`spike-notes.md` §Exit criteria). Do not re-derive them
|
||||
**P0 is closed (owner, 2026-09-06).** Both criteria read as met in `spike-notes.md`
|
||||
§Exit criteria — criterion 1 with the quality preset amended to an honest `N/A`,
|
||||
criterion 2 with §S24 counting zero S-items against it (🚫 S23-2 is a GitHub setting
|
||||
outside any PR). **What comes next is P1** (`15_ROADMAP` §P1): the Overlay proper —
|
||||
hook installation for D3D11/12/9/OGL, the `LoadLibrary` detour that §S6's early stop
|
||||
and lazily loaded runtimes both hang on, unhook path, native logging; the Injector's
|
||||
launch mode (§S13(c), §S1's deferred input); the Vulkan layer to `vkQueuePresentKHR`
|
||||
with §S2's in-layer supervision. **P1 item 1 — the `LoadLibrary` detour — landed 2026-09-06
|
||||
(§S6 ✅); item 2, launch mode, landed the same day as "inject late" (§S1 ◐, §S13(c) ✅ —
|
||||
`04_CAPTURE` §Launch mode); item 3, the Vulkan layer to `vkQueuePresentKHR` with §S2's in-layer
|
||||
supervision, landed the same day (§S2 ✅; `17_HOOK_ENGINE` §Vulkan); item 4 — compare-and-restore per
|
||||
inline patch, the native log, `wglSwapBuffers` — landed the same day too, and D3D9 is struck per §Scope.
|
||||
P1's core is done; what stays ⏳ is the feature rows `15_ROADMAP` §P1 now lists, and P2 (the Agent, the
|
||||
recorder, SQLite) is next.** The ~~three~~ ~~two~~ one P1-deferred S-item (~~S6~~, ~~S2 part three~~, and
|
||||
the hand-run blast-radius script behind S29(d)) are the reminders. The text below is
|
||||
P0's history and stays as it stood.
|
||||
|
||||
Two exit criteria ~~remain~~ were the gate (`spike-notes.md` §Exit criteria). Do not re-derive them
|
||||
from memory:
|
||||
|
||||
1. **A throwaway build records a real session** from a real offline game reporting
|
||||
@@ -197,7 +214,8 @@ own PR with its own rule-4 justification.
|
||||
watchdog thread runs once a second. No `LoadLibrary` hook is needed for P0 — which
|
||||
keeps §S6 genuinely separable. The Overlay has **no** module-resolution machinery
|
||||
today (`GetProcAddress`/`GetModuleHandle` appear nowhere), so that helper is part of
|
||||
the real cost.
|
||||
the real cost. *(2026-09-06: the detour exists now — P1 item 1 — and it still only
|
||||
WAKES that thread; the installers did not move. `17_HOOK_ENGINE` §DLL entry step 3.)*
|
||||
- `tools/hookinventory-check.ps1`: every symbol the Overlay resolves by name must
|
||||
appear in `vendor-exports.json`. **No drift exists today** — a refuter resolved every
|
||||
inventory symbol against all 34 measured modules — so write it as prevention and do
|
||||
@@ -672,7 +690,7 @@ The README sentence is **not a percentage** — the recorded decision is that th
|
||||
cannot answer four of the five questions at all.
|
||||
|
||||
**Two things nobody has costed** (found by the completeness critic, 2026-08-05):
|
||||
`StaticGameDetector` has **no runnable vehicle** — every construction is in tests — so
|
||||
`StaticGameDetector` ~~has **no runnable vehicle** — every construction is in tests~~ *(runs in the Agent's `DetectionSweep` since P4 PR-1, 2026-09-14)* — so
|
||||
item 4's mandated comparison cannot be re-run on the *baseline* side either; and the
|
||||
only candidate title exercising all five required values is a **Streamline** title,
|
||||
i.e. the one class where the hook premise is recorded INCONCLUSIVE.
|
||||
@@ -683,14 +701,22 @@ Written rationales for whatever is still ❓/⏳/◐ in §S24, and unify the gly
|
||||
disposition currently wears three (`✅ deferred` / `🅓 deferred` / `🔴 deferred`) in a
|
||||
table whose only purpose is being auditable by counting them.
|
||||
|
||||
### 7. **START HERE** — the three things left once the FG blocker fell (2026-09-04, owner's list)
|
||||
### ~~7. **START HERE**~~ — the three things left once the FG blocker fell (2026-09-04, owner's list) — **CLOSED 2026-09-06; the live head is §P2 below (struck 2026-09-09 so this file holds one START HERE, not two)**
|
||||
|
||||
P0 exit criterion 1 reads **4 of 5** as of 2026-09-04: upscaler identity, render → output,
|
||||
FG factor and RT state are measured against the titles' own menus. What follows is the
|
||||
owner's list for the next session, in the order the dependencies run, each with what makes
|
||||
it fail on unmodified `main` — because a criterion already true on `main` is decoration.
|
||||
|
||||
#### 7a. The quality preset — the last value criterion 1 lacks
|
||||
#### ~~7a. The quality preset — the last value criterion 1 lacks~~ — **CLOSED 2026-09-06 (owner): DLSS / DLSS-G done on every measured title**
|
||||
|
||||
*Closed on the Cronos FG-on capture (`20_OPEN_QUESTIONS` §H5 head, `spike-notes` §9): the trio or a counted
|
||||
`none` on every NVIDIA title through the hooked bodies, DXGI's counter where the hook cannot count (DL:TB —
|
||||
that title's integration, not SDK 2.8.0's), and the driver-reported identity where no hook can see it, with
|
||||
its negative measured. The quality preset itself stays `0xFF` / N/A everywhere — the override fields are
|
||||
the override's, the tags carry no size on D3D12 — and the owner closed the item on that. What follows is
|
||||
the history.*
|
||||
|
||||
|
||||
*Fails on `main` because:* every real title measured reads `upscalerQuality = 0xFF`.
|
||||
Cyberpunk 2077 never chains `sl::DLSSOptions`, so 0xFF there is the title's truth; **Alan Wake
|
||||
@@ -729,13 +755,70 @@ Cyberpunk 2077 never chains `sl::DLSSOptions`, so 0xFF there is the title's trut
|
||||
**and the rerun on it still read `UpscalerParams = 0` with both rows live**, so the title
|
||||
tags with a zero extent or not on this route at all. The next build reads the size the
|
||||
tagged `sl::Resource` declares when the extent is zero (`TagSize`, every route); one more
|
||||
DL:TB DLSS capture on it is **owed**. If `render -> output` prints, 7a's measurement is that
|
||||
line plus the quality byte; if it stays `N/A`, the route yields nothing on this title and
|
||||
the honest answer is `N/A`. The derived-label decision above is unchanged until it lands.
|
||||
- **Separately, and more important than the preset:** every DL:TB DLSS run had DLSS Frame
|
||||
Generation ON per the owner, and every one read `presents = tokens`, `frame generation:
|
||||
none`. That is `20_OPEN_QUESTIONS` §H5 case 3's candidate title — read that entry before
|
||||
touching FG counting; the discriminator is pre-committed there.
|
||||
DL:TB DLSS capture on it is ~~owed~~ **ran 2026-09-05 00:53 (#116 build): `N/A` stands** —
|
||||
params 0 of 3523 with both rows live and the fallback in. The route yields nothing on this
|
||||
title; the honest answer is `N/A`, and 7a on DL:TB is closed on that. What would reopen it
|
||||
is a tag-route census (calls per export, zero-extent seen, Resource-size seen), which needs
|
||||
a layout bump and is not worth one for a preset byte. The derived-label decision above is
|
||||
unchanged and applies to the titles that do print the line.
|
||||
- **Separately, and more important than the preset:** every DL:TB DLSS run (five, the last at
|
||||
00:53 on the #116 build) had DLSS Frame Generation ON per the owner, and every one read
|
||||
`presents = tokens`, `frame generation: none`. That is `20_OPEN_QUESTIONS` §H5 case 3's
|
||||
candidate title. **Owner decision 2026-09-05: this is its own session and its own PR.** Read
|
||||
§H5 first; the discriminator (the owner's counter beside our `FPS:` line) is pre-committed
|
||||
there and is the first thing that session asks for. Nothing in FG counting changes before
|
||||
that reading. **The reading came the same day and the first PR landed on it** — the owner:
|
||||
the title runs at DLSS ×4, the frames we record are the native ones (§H5, verbatim). The
|
||||
capture host now prints each census-named module's file version and withholds `none` on
|
||||
that shape (`03_METRICS` §Frame Generation; the key is `sl.dlss_g.dll`, not
|
||||
`nvngx_dlssg.dll`). **What is next is the owner's session pre-committed in §H5** — DL:TB with
|
||||
DLSS FG off and ×4, Cyberpunk MFG ×4 as the control, PresentMon elevated beside each, the
|
||||
counter's NUMBER written down — and the row it lands on decides whether the gate stays, a
|
||||
second present sink is costed (§H5 lists the candidates; the route is the owner's), or the
|
||||
gate is withdrawn. Nothing in the hook changes before that row. **The counter half of Leg 1
|
||||
is read (2026-09-05): ~300 against our 76.7, reading (a) with its number; the PresentMon half
|
||||
is still owed.** And the owner's eleven-capture run the same day (`spike-notes` §9) put the
|
||||
remaining NVIDIA gap in one sentence: the COUNT is right on every title and the IDENTITY is
|
||||
what this build cannot say — DLSS on the NGX-direct UE titles, DLSS-G everywhere. **The identity half landed 2026-09-05 from the Streamline docs** (DLSS-G guide §5.0: the HUD-less / UI tags a
|
||||
frame-generating title MUST send, through exports already hooked): `frame generation: DlssG` is expected on
|
||||
Cyberpunk at MFG and on the UE titles at ×4 on the next run, with the new `Streamline tag census:` line saying
|
||||
which route carried the tags — and DL:TB's census line says whether that title feeds DLSS-G through a route
|
||||
this build sees. `slDLSSGGetState` was refused (`03_METRICS` §FG: it resets the plugin's own counter).
|
||||
~~**START HERE next:** `fl-probe-nvapi --ngx-state <pid>` against a running Lies of P, Hell Is Us, DL:TB
|
||||
and Cyberpunk (no capture, no injection) — the super-resolution identity on NGX-direct titles is still the
|
||||
gap the tags cannot close.~~ **RAN 2026-09-06 on Hell Is Us, Expedition 33 and Lies of P (§H5, `spike-notes`
|
||||
§9): `CREATED | EVALUATE` on the SR word without an override on both no-override titles — the identity
|
||||
exists in the driver's bookkeeping; the FG word does not see DLSS-G at ×4; `frameGenerationCount` is the
|
||||
override target, `scalingRatio` is 0 even under an override.** ~~**START HERE next: the owner decides the
|
||||
driver-reported rung (§H5 says exactly what it may claim: `Dlss (driver-reported …)` on a session where
|
||||
every hook says N/A, nothing about quality, ratio or FG), and the negative is owed first — the probe on
|
||||
Lies of P with DLSS switched OFF, expected `CREATED` clear.**~~ **Decided and BUILT 2026-09-06: the capture
|
||||
host probes the driver beside every module snapshot and the `upscaler:` line has the driver-reported rung
|
||||
(`03_METRICS` §Upscaling). START HERE next: the owner's run — §H5 rows N1–N4, and N3 (Lies of P with DLSS
|
||||
OFF) is the one that keeps or withdraws the rung — LANDED 2026-09-06 midday: N3 read `CREATED` clear with
|
||||
upscaling off, N1 prints `Dlss (driver-reported …)` on four NGX-direct titles, N2 prints agreement on two,
|
||||
and the FG word turned out to follow DLSS-G too (identity, never the multiplier). START HERE next: Cronos
|
||||
(a second Streamline 2.8.0 title, UE) with frame generation ON — does the 2.8.0 pacer bypass the patched
|
||||
bodies there too (`DXGI present counter` ≈ 3) or is it Techland's (0)? — ANSWERED 12:17: Cronos FG on reads
|
||||
`86.8 → 172.72 (×1.99 FG)` with `unseen=0`; the bypass is Techland's. Item closed; the next item is the
|
||||
owner's pick from 7b / 7c below.** **The tag route LANDED on the owner's evening run (`spike-notes` §9): `DlssG` on
|
||||
six of six Streamline titles, and DL:TB's census shows its scaling-input tag arrives with no size, which
|
||||
closes 7a's last question.** If the driver's per-process NGX feedback is
|
||||
populated without an NVIDIA-app override, the identity question has a producer that is not a
|
||||
hook and the owner decides whether `03_METRICS` gains a *driver-reported* rung (§H5 says what
|
||||
that rung may and may not claim). If it is not populated, the answer stays `N/A` and the
|
||||
session goes back to the PresentMon leg. **The in-process half of that leg LANDED (2026-09-05,
|
||||
night): DL:TB at DLSS FG ×4 read 2.90 and 2.95 unseen presents per hooked one on the same chain —
|
||||
§H5 row P1-DXGI — while Streamline 2.7.3 (Hell Is Us) and 2.10.3 (the Onimusha demo) read 0.00, so
|
||||
2.8.0's pacer is the one that bypasses the patched bodies. The record now carries `dxgiUnseen` and
|
||||
the window counts `Displayed = hooked + unseen`, labelled DXGI-COUNTED (`03_METRICS`); DL:TB's next
|
||||
capture is expected to print the trio at ≈ ×3.9 with that label and no withheld line — LANDED
|
||||
2026-09-06: `70.52 → 282.08 (×4 FG)`, DXGI-COUNTED 12,387, `DlssG`. Leg 0 the same morning (FG off,
|
||||
twice) showed the plugin is a startup-time load and the report withheld as pre-committed, so the
|
||||
gate is now narrowed to sessions where the DXGI counter was not read; a read counter with zero
|
||||
unseen prints `none` with DXGI's agreement.** The
|
||||
"sl.common must be loaded on 2.8" lead is closed by the 2.10.3 title, which injects and counts like
|
||||
2.7 (§H5).
|
||||
|
||||
#### 7b. Titles whose upscaler or frame generation is compiled into the executable
|
||||
|
||||
@@ -759,7 +842,15 @@ hole; it does not close it.
|
||||
title cannot give. **The honest ceiling for a statically linked title in attach mode is
|
||||
Presented FPS with the census's qualifier** — which is what ships today, with the hole named.
|
||||
- **The only cheap improvement is wording**, and it is already in: the qualifier says
|
||||
*statically linked FSR3-FG … outside what this can see*. If a title is found, the first PR is
|
||||
*statically linked FSR3-FG … outside what this can see*. **Built 2026-09-06, two steps past that
|
||||
(owner's choice over "return native", which rule 6 forbids):** the executable FILE is scanned on
|
||||
disk after the session for the vendor SDK strings, and a frame-generation-capable one flips the
|
||||
clear-census sentence from *cannot* to *MAY*; and the rung-3 line prints its exclusions (the
|
||||
driver's FG word, the tags, the ffx census, the module census, the file's markers). The ceiling
|
||||
for a title that is both compiled-in and token-less stays Presented FPS + that qualifier. **LANDED
|
||||
2026-09-06 14:02: Rune Factory at FSR + FSR FG prints the pre-committed line verbatim (§H11); 7b is at its
|
||||
ceiling and closed.** Hell Is Us at XeSS + XeSS-FG the same run: no token, so Displayed measured (186.47,
|
||||
0 unseen) and Native unknown — the N/A now carries its witnesses, and that is the XeFG ceiling too. If a title is found, the first PR is
|
||||
a `spike-notes` row and a `20_OPEN_QUESTIONS` §Scope entry with the measured shape, not code.
|
||||
- ~~**Measured 2026-09-04: no such title is installed.**~~ **Found the same evening, by running
|
||||
rather than by scanning: Rune Factory: Guardians of Azuma.** The scan was right that every FSR
|
||||
@@ -772,7 +863,18 @@ hole; it does not close it.
|
||||
capture with the census line can. **Black Myth: Wukong is the second** — its FSR upscaling
|
||||
dispatches to neither the loaded monolith nor the loader, and it offers no FSR frame generation.
|
||||
|
||||
#### ~~7c. AMD and Intel identity, measured rather than inferred~~ — **AMD LANDED 2026-09-04; Intel closed; the owner's three launches are owed**
|
||||
#### ~~7c. AMD and Intel identity, measured rather than inferred~~ — **AMD LANDED 2026-09-04 and re-confirmed complete 2026-09-06 on Lies of P; Intel closed by licence (re-checked 2026-09-06, unchanged)**
|
||||
|
||||
*2026-09-06, 12:46: Lies of P at FSR 3.1 + FSR FG prints `Fsr3` / `FsrFg` / `59.77 → 119.55 (×2 FG)` /
|
||||
`2560x1440 -> 2560x1440` with every count agreeing (`spike-notes` §9) — acceptance step 5 in full, beside
|
||||
the DXGI counter (0 unseen) and the NVIDIA driver's word (nothing created). The owner called the AMD half
|
||||
done. Intel: the licence was re-fetched the same day — Intel Simplified Software License, October 2022,
|
||||
binary-only, "nor any modification", termination; the header banner still forbids copying — so the
|
||||
reversal condition has not fired and the census stays the answer. What is new: Intel's own README says
|
||||
XeSS-FG runs on non-Intel GPUs with SM 6.4, so an XeFG session IS capturable on this box (DL:TB, Hell Is
|
||||
Us, Cronos, Expedition 33 ship `libxess_fg.dll`), and the proposal on the table is identity BY ELIMINATION,
|
||||
labelled — see `20_OPEN_QUESTIONS` §H11's 2026-09-06 note.*
|
||||
|
||||
|
||||
**Do not start here.** The three ffx-api leaves are hooked, the FidelityFX headers are vendored
|
||||
at tag **`v2.3.0`** (not the `v1.1.4` step 1 below names — its own reversal condition fired:
|
||||
@@ -812,9 +914,19 @@ at 1.01, KCD2 at FSR printed the identity and `none` by count at 1.00 — the lo
|
||||
both, once. **Wukong at FSR read silent at the monolith AND the loader with the monolith loaded**:
|
||||
FSR upscaling compiled into its UE plugin (Rune Factory's shape) with the monolith loaded and
|
||||
unused — ~~owed: Wukong with FSR frame generation ON~~ **the title has no FSR frame-generation
|
||||
option (owner, same night)**, so Wukong is the second static title and nothing is owed on it. **The FSR 3.0 host route
|
||||
option (owner, same night)**, so Wukong is the second static title and nothing is owed on it. ~~**The FSR 3.0 host route
|
||||
(`ffx_fsr3_x64.dll`, step 3 below) is deferred to its own PR** — ten host headers from `v1.1.4`;
|
||||
Cyberpunk at FSR 3 is its oracle and already prints `FsrFg` from the monolith beside it.
|
||||
Cyberpunk at FSR 3 is its oracle and already prints `FsrFg` from the monolith beside it.~~
|
||||
**BUILT 2026-09-05, and the tag was not `v1.1.4`.** Cyberpunk's module exports exactly
|
||||
`fsr3-v3.0.4`'s twelve `ffxFsr3*` names; 1.1.4 appends fields after `renderSize` and declares
|
||||
three exports the module lacks. One row — `ffx_fsr3_x64.dll!ffxFsr3ContextDispatchUpscale`,
|
||||
the same family and publish point as the ffx-api rows, keyed by module in the installer —
|
||||
reads `renderSize` and nothing else; `ffxFsr3DispatchFrameGeneration` is deliberately not a
|
||||
row (the monolith generates on the one title; §H11 pre-commits the reversal). **What is owed
|
||||
is the owner's acceptance run**, rows B1–B4 in §H11: Cyberpunk at FSR 3 + FG must print
|
||||
`upscaler: Fsr3` with one extent agreeing between the host and the monolith's PREPARE, and
|
||||
`frames/upscale-drained = 1.00`; B2 (facade silent, `upscale-drained = 0`) is the pre-committed
|
||||
condition for adding the `ffx_fsr3upscaler_x64.dll` row instead — never both.
|
||||
|
||||
<details>
|
||||
<summary>The entry as it stood, kept for the reasoning it carries</summary>
|
||||
@@ -837,7 +949,7 @@ exports `xessD3D12Init` / `xessD3D12Execute` and XeFG `xefgSwapChainD3D12InitFro
|
||||
ffx_framegeneration.h, dx12/ffx_api_dx12.h, vk/ffx_api_vk.h}` for the 3.1 facade the
|
||||
installed titles call, and `sdk/include/FidelityFX/host/{ffx_fsr3.h, ffx_fsr3upscaler.h,
|
||||
ffx_frameinterpolation.h, ffx_opticalflow.h, ffx_types.h, ffx_error.h, ffx_interface.h,
|
||||
ffx_util.h, ffx_assert.h}` for the FSR 3.0 host API. Do not take `main`: it is SDK 2.x under
|
||||
ffx_util.h, ffx_assert.h}` for the FSR 3.0 host API *(2026-09-05: vendored from **`fsr3-v3.0.4`**, not `v1.1.4` — the tag whose declarations match the module Cyberpunk ships; see the banner above)*. Do not take `main`: it is SDK 2.x under
|
||||
a binary-only `docs/license.md` that excepts these headers as MIT only by an 845-line list.
|
||||
Extend `hookinventory-check` Pass C's forbidden-import list with `amd_fidelityfx_*.dll` /
|
||||
`ffx_*.dll` in the same PR — the Streamline lesson, one vendor over. *Intel XeSS SDK*:
|
||||
@@ -864,8 +976,10 @@ exports `xessD3D12Init` / `xessD3D12Execute` and XeFG `xefgSwapChainD3D12InitFro
|
||||
same five names, and the plugin modules are called by the facade, not by the game — an
|
||||
unscoped hook would count each dispatch twice, straight into `fg_factor`.
|
||||
3. **AMD 3.0 (`ffx_fsr3_x64.dll`, Cyberpunk's copy):** named exports, no struct decode needed —
|
||||
`ffxFsr3ContextDispatchUpscale` for identity and extent, `ffxFsr3DispatchFrameGeneration`
|
||||
once per application frame.
|
||||
`ffxFsr3ContextDispatchUpscale` for identity and extent, ~~`ffxFsr3DispatchFrameGeneration`
|
||||
once per application frame~~ *(built 2026-09-05 without the FG row: on the one title the
|
||||
monolith generates and the count is Streamline's; the host's FG export fires per generated
|
||||
batch and is not a count producer. §H11 carries the reversal condition.)*
|
||||
4. **Intel — closed at the census (step 1).** No hook on any `libxess*.dll` export. The
|
||||
report line for an Intel title is what the writer already produces: upscaler
|
||||
`NOT_REPORTED`, and if `libxess_fg.dll` is in the census, Presented FPS with the *"MAY
|
||||
@@ -906,6 +1020,25 @@ feature hooks — §S29(a) said it was and was wrong; see below. What it buys is
|
||||
> drop the switch as well. Anyone costing this as "fix the signer half" is costing
|
||||
> half of it.
|
||||
|
||||
**Picked up 2026-09-06 (the owner's next item after item 7).** The sequence, with what
|
||||
each step needs, so nothing here is started out of order:
|
||||
|
||||
1. **The CI leg, made readable** (2026-09-06, this PR): the probe's ctest printed nothing,
|
||||
so `ci.yml` runs `fl-probe-signer` as its own step after the gate and the answers land in
|
||||
the log. Rows G3/G4/G5 are read off the next run on `main`.
|
||||
2. ~~**The adapters-disabled leg — owner-only, a network setting.** Same three subjects,
|
||||
`ctest fl_signer_probe` (or the exe) with every network adapter disabled, compare the
|
||||
verdicts with `spike-notes` §1. Unchanged → G1; any change → G2 and the route retires.~~
|
||||
**RUN 2026-09-06 by the owner: every verdict unchanged — row G1 (§S19(b)).**
|
||||
3. ~~**The allow-widening bound — owner-only, a decision no PR may take (§S19(b)).**~~ **DECIDED
|
||||
2026-09-06: option 1, the compiled-in allowlist `trustedSigners` may only intersect.**
|
||||
4. ~~**Then the PR:** …~~ **BUILT 2026-09-06 (§S19(b) ✅ BUILT):** `ModuleSignerOrganisation` in
|
||||
`fl_guard_sources.cpp`, `IsCompiledTrustedSigner` as the bound, the trusted module keeps the
|
||||
scan looking, every failure refuses, the catalog half deferred with its rationale, both
|
||||
directions proved against the real seams through `hook-harness --load`, and `-SkipIntegration`
|
||||
dropped from `ci.yml`. **The Separable item is closed**: the nine integration cases are in the
|
||||
merge gate, and CI runs the command a developer runs.
|
||||
|
||||
### ~~§M5 — **START HERE**~~ — MEASURED 2026-09-03, row R1, and the head moves
|
||||
|
||||
**Do not start here.** `LhmTelemetrySource` exists, `probe-lhm` ran unelevated and elevated,
|
||||
@@ -987,6 +1120,318 @@ reference comes out.~~ — **L2 was written, 2026-09-03.** The obligation now bu
|
||||
|
||||
---
|
||||
|
||||
## ~~P2 — **START HERE**~~ — CODE COMPLETE 2026-09-10; the live head is §P3 below (struck 2026-09-13 so this file holds one START HERE, not two)
|
||||
|
||||
P1's core is merged (`15_ROADMAP` §P1). What comes next is P2 — the Agent, the recorder,
|
||||
SQLite — and this section carries its **order**, the **decisions that live in no other file**,
|
||||
and what each slice must make fail on unmodified `main`. Status lives where it lives.
|
||||
|
||||
> ### What is left, as of 2026-09-10: **two measurements, no code.**
|
||||
>
|
||||
> All nine slices below are written and their gates are green (PR-0 #143, A #144, B #145, E1 #146,
|
||||
> C #147, D #148, E2 #149, F #150, G #151 — ~~stacked and open~~ **all merged 2026-09-10**). What P2
|
||||
> still owes is what a PR cannot produce:
|
||||
>
|
||||
> 1. **The milestone session** — a real title, Tier 1, its `upscaler` / render→output / `fg_mode` /
|
||||
> `rt_flag` read against the game's own settings menu. The *technical* half is in the merge gate
|
||||
> (`AgentEndToEndTests`: the shipped Agent, `hook-harness`, one hooked row), and the harness has
|
||||
> no upscaler to measure, which is exactly what the real title supplies.
|
||||
> 2. **The ≤ 0.5 % FPS-impact run** (`14_TESTING` §Hook overhead item 2, P1's last debt via §R4).
|
||||
> `tools/fps-impact-runbook.ps1` sequences it; the number it needs is the game's own benchmark
|
||||
> average, which only the operator can read.
|
||||
>
|
||||
> Both have slots, with the exact commands, in `docs/spike-notes.md` §14 — plus §S1's
|
||||
> launcher-fronted election run, whose code is built and whose first real launcher is still owed.
|
||||
> **Nothing in that section has been run.** Do not read an empty table as a passing one.
|
||||
|
||||
**The order, one PR each, merged one at a time** (`main` is `strict: true` — every merge puts
|
||||
the next PR `BEHIND`, and every PR touching `src/` conflicts in `CHANGELOG.md`):
|
||||
|
||||
| PR | Slice | Fails on unmodified `main` because… |
|
||||
|---|---|---|
|
||||
| A | `FrameLedger.Domain.Metrics` + golden tests; the CaptureHost's throwaway consumer re-pointed at it | no type in Domain computes a frame time, and `tools/coverage-gate.ps1` prints `metric calculators none found` — the 95 % floor has never been evaluated against anything |
|
||||
| B | SQLite core: `0001_init.sql`, migrations, blob codecs, `SqliteGameConsentStore`, repositories | `Microsoft.Data.Sqlite` and `Dapper` are referenced by zero lines; `IGameConsentStore` has one adapter and it is a file in an unshipped host |
|
||||
| C | Promote the capture path (`CaptureLoop` → `Application.Capture.CaptureSession` + Infrastructure adapters); the CaptureHost becomes a thin shell | every capture type is `internal` to `FrameLedger.CaptureHost`, and the Agent referencing it turns `package-closure-check` red |
|
||||
| E1 | Telemetry L1 (`BaselineTelemetrySource`), `CompositeTelemetrySource`, the 1 Hz poller | `IGpuTelemetrySource` has one adapter; nothing produces the `l1+lhm+nvapi` descriptor or stamps a sample with the session QPC epoch |
|
||||
| D | Session recorder: state machine, `.partial`, five-step finalize, exit classification, crash auto-disable, recovery | nothing persists a session; no `.partial` is ever written; `exit_status` has no producer |
|
||||
| F | Agent Generic Host: DI, watcher, `DescendantElection`, `--serve` / `--console`, kill switch, consent verb | `Agent/Program.cs` is 61 lines that seed the rules file and exit |
|
||||
| E2 | NVAPI bridge (native `FrameLedger.NvapiBridge.dll`, C ABI) + L3 + the NGX probe in-process | the only NVAPI consumer is `fl-probe-nvapi.exe`, unshipped and spawned |
|
||||
| G | Real-title milestone, kill-and-recover e2e, the ≤ 0.5 % FPS-impact run, doc sweep | no `ledger.db` anywhere holds a hooked session; `14_TESTING` §Hook overhead item 2 has no number |
|
||||
|
||||
**Why A first:** it is pure, it arms the 95 % gate *before* any calculator exists (the gate's own
|
||||
rationale), and every later slice consumes it. **Why D before F:** the orchestrator is thin over the
|
||||
recorder; building F first re-creates the recorder inside the Agent. **Why E2 after F:** the
|
||||
milestone must not wait on a new native target crossing every gate — it lands LHM-only
|
||||
(`telemetry_source = 'l1+lhm'`) and L3 joins afterwards.
|
||||
|
||||
**Decisions taken 2026-09-09 (owner), so nobody re-derives them:**
|
||||
|
||||
- **D4 — the Agent ships `--console consent grant`.** It prints the operator disclosure, requires a
|
||||
typed acknowledgement, and stamps `hook_consent_at` from the Agent's own clock under a new
|
||||
`ConsentProvenance.AgentConsoleOperator` — the stamp `19_SAFETY` §User-facing consent requires and
|
||||
a file store cannot uphold. **This changes the basis §S27 was closed on**: the Agent becomes the
|
||||
shipped injecting entry point *by design* (`01_ARCHITECTURE` always said so); what holds rule 1
|
||||
is the consent store, its provenance and the disclosure, and `package-closure-check` keeps only
|
||||
the CaptureHost out. Restate §S27 and §S18 blocker 3 in the PRs that do it (C, F); the
|
||||
re-ratification is the owner's (below). P3's dialog retires the console provenance.
|
||||
**Built 2026-09-10 (PR-F):** `Agent --console consent grant`, `OperatorDisclosure` moved to
|
||||
`Application.Consent` with an `OperatorSurface`, `ConsentProvenance.AgentConsoleOperator`, the
|
||||
acknowledgement carrying its provenance and the store refusing a nameless one.
|
||||
- **D7 — the FR-2.4 kill switch is the FOURTH input of `HookedCaptureGate`**, not an upstream
|
||||
check: the gate's own remark calls itself *"the ONLY managed logic between the user's intent and
|
||||
the guard"*, and a global switch is intent. `HookRequest.FromConsent` gains the parameter. The
|
||||
Vulkan layer honours it by the Agent **not** setting `FRAMELEDGER_ENABLE_VK_LAYER`; mid-session it
|
||||
is `unhookRequested`. **Built 2026-09-10 (PR-F):** `HookRequest.FromConsent(…, killSwitchEngaged)`,
|
||||
`AntiCheatRefusalReason.KillSwitchEngaged` (27, mirrored natively), `IKillSwitch` read by
|
||||
`CaptureSession` before the request and at every scan boundary, `ProcessLauncher(enableVulkanLayer:
|
||||
false)`, `settings.hooking.kill_switch`, `Agent --console killswitch on|off|status`.
|
||||
- **D8 — FR-11 is NOT a consent precondition in P2.** `ILegalAcceptanceStore` (read-only ~~until P3~~ — the writer exists since P3 PR-3, the gate that calls it is PR-9's) is declared
|
||||
in B so the precondition is one `if` when the owner turns it on.
|
||||
- **D9 — P2 never clears `hook_blocked_reason`.** A tri-state `hook_prescan_state`
|
||||
(`not_run|clean|blocked|unverified`) carries *could not verify* without touching the column
|
||||
(`06_DATA_MODEL` §games' open question stays the owner's).
|
||||
- **No `FlWriterState` field may be added** — it has no slack (every reserved word was taken
|
||||
2026-09-03/05/06), so any new field is a layout bump. P2 needs none: finalize's "stop writing" is
|
||||
`SetPaused`, and every counter to be stored already exists. `FlControlBlock.Reserved[11]` is the
|
||||
Agent-side slack if one is ever needed.
|
||||
- **D1 — `FrameLedger.Application` gains a reference to `FrameLedger.Shared`** (A); Domain still
|
||||
references nothing and mirrors the record enums with a bidirectional test.
|
||||
- **D10 — the pipe (`07_IPC`) is P3**, not P2; `--serve` is watcher-driven and logs. **No `EtwFrameSource`**
|
||||
(§G). **D5 — `FileGameConsentStore` is retired in B**; the CaptureHost writes a build-tree `ledger.db`
|
||||
so the Agent stays the sole owner of `%LOCALAPPDATA%\FrameLedger`.
|
||||
- **D6 — `--data-dir` exists only under `--console`** (F; `12_BUILD` §Debugging), so `--serve` can never
|
||||
be pointed at a ledger that is not the Agent's own.
|
||||
- *(Numbering, recorded 2026-09-13: D1, D5, D6 and D10 were cited by number from `CHANGELOG`, `04_CAPTURE`,
|
||||
`12_BUILD` and `07_IPC` while this list carried them unlabelled — labels added above. **D2 and D3 were
|
||||
never assigned**; the numbering skips them. Nobody needs to hunt for a missing decision.)*
|
||||
|
||||
**What P1 still owes, and where it lands:** the ≤ 0.5 % real-game FPS-impact measurement
|
||||
(`14_TESTING` §Hook overhead item 2, moved to the end of P1 by §R4) needs the drain and the
|
||||
recorder to exist — it runs in **G**; §S1's first real-title launch-mode run and the descendant
|
||||
election are **F** and **G**; the ⏳ feature rows in `17_HOOK_ENGINE` §Hook inventory are not P2 —
|
||||
their columns (`hdr_flag`, `pt_confidence`, `pso_stutter_pct`, `vram_proc*`, `latency_*`) are an
|
||||
honest NULL in P2's schema, never a 0.
|
||||
|
||||
## P4 — **START HERE** (2026-09-14: P3 is code-complete; the stack awaits the owner's merges) — **code-complete 2026-09-15 with PR-9**: every item below is struck; what follows is `15_ROADMAP` §P5 and §Owner-only
|
||||
|
||||
P3's slices are all struck below. What is left of P3 is not code: the owner merges #154 → #155 → #156 → #158 →
|
||||
#159 → #160 → #161 → #162 → #163 → PR-9 in order (squash; after each merge the next branch is rebased
|
||||
`--onto origin/main`), reviews the `vi` strings, and signs the `ja` `Safety_*` family when a human can.
|
||||
The owner-only measurements of §P2 (`spike-notes` §14) are still open and still owner-only.
|
||||
|
||||
**P4 is `15_ROADMAP` §P4**, in this order, each a PR that fails on unpatched `main` for a stated reason:
|
||||
~~detection rules engine + `detection-rules.json` validator and fixtures (the anticheat blocklist is already
|
||||
consumed by the guard; the engine/platform/capability halves are not)~~ **LANDED 2026-09-14 (P4 PR-1)** — the
|
||||
engine, validator and corpus already existed; what was missing was a caller and a writer: `DetectionSweep` +
|
||||
`DetectionHostedService` under `--serve`, `IGameRepository.ApplyDetectionAsync` under the provenance rule,
|
||||
schema 0004 for the key's exe half (NOT the consent fingerprint), Tools ▸ Update rules wired, the Supports row
|
||||
filled — status in `CHANGELOG.md`, the decisions in `05_DETECTION` §Caching's built note; ~~store auto-import (Steam / GOG / Epic /
|
||||
itch.io — the first-run flow's step 4 and File ▸ Import library both say "later build")~~ **LANDED 2026-09-14 (P4 PR-4:
|
||||
`LibraryImporter` over four `IStoreLibrarySource` adapters, the review checklist, `ApplyStoreMetadataAsync` under
|
||||
the provenance rule, hooking off for every row — `05_DETECTION` §Platform signatures built note)**, ~~the
|
||||
capability-vs-measured separation in the UI (the game page's Supports row is empty until this)~~ **(PR-1)**, ~~Velopack +
|
||||
the updater (`11_UPDATER`; the Settings channel row is stored and unused)~~ **LANDED 2026-09-14 (P4 PR-5: `App/Update/` — `VelopackUpdateClient` behind `IUpdateClient`, `UpdateService` with FR-12 as its shape, the banner, the install/uninstall hooks in `Program.Main`, `release.yml`, one `VERSION` source — `11_UPDATER` built note)**, ~~the bug-report flow's steps 3–5
|
||||
(`10_LOGGING`: the preview dialog, the GitHub issue link — step 2's bundle exists)~~ **LANDED 2026-09-14 (P4 PR-3:
|
||||
`BugReportFlow`, the preview dialog, the issue link with the form's real field ids, the Markdown clipboard fallback;
|
||||
~~the crash dialog + minidump stay open~~ — they landed 2026-09-15 with PR-9, and the dump is the bundle's opt-in — `10_LOGGING` built notes)**, ~~the "is Vulkan" fact the
|
||||
layer's register/unregister-on-consent automation needs (`17_HOOK_ENGINE` §Vulkan built note)~~ **LANDED
|
||||
2026-09-14 (P4 PR-2): a static PE fact (`PeImports` + the bounded scan) stored as `vulkan` in `capability_flags`,
|
||||
and `VkLayerReconciler` moving the HKCU registration after every consent change and sweep — the built note
|
||||
carries it**, the Help menu's
|
||||
~~Documentation~~ / ~~Check for updates~~ / ~~Report a bug~~ items **(Documentation and Report a bug landed with PR-3;
|
||||
~~Check for updates waits for the updater~~ — PR-5; File ▸ Export became the three-leaf submenu `08_UI` specifies)**, and
|
||||
~~`legal/licenses/` populated by the license-gathering
|
||||
script~~ **LANDED 2026-09-15 (P4 PR-6: `tools/license-gather.ps1` → `legal/licenses/nuget/`, 77 packages, `license-check` §3 both directions; the runtime's notices by `release.yml`)**. Decisions that live only here: D11–D17 below still hold; nothing in P4 may add a third writer to
|
||||
`ledger.db` or a message that carries a safety fact over the pipe.
|
||||
|
||||
`15_ROADMAP` §P4's last two items were not in the list above: ~~DB maintenance~~ **LANDED 2026-09-15 (P4 PR-7:
|
||||
Tools ▸ Database maintenance — the retention sweep on demand is the Agent's, over a new `SweepRetention` command with
|
||||
no payload; integrity check, `VACUUM INTO` backup and compaction run in the App and change no row — `06_DATA_MODEL`
|
||||
§Retention built note)**, and ~~the accessibility pass, which needs `08_UI` §Accessibility written before any code~~ **LANDED 2026-09-15 (P4 PR-8: the section first, then `AccessibilityTests` — Ctrl+1…5, Esc on every dialog, an automation name on every textless input, theme colours only)**.
|
||||
|
||||
## P3 — ~~**START HERE**~~ (2026-09-13, owner-approved plan; **code-complete 2026-09-14** — every row below is struck with its PR)
|
||||
|
||||
`15_ROADMAP` §P3 is the UI — and since 2026-09-13 it is **all of `08_UI`**, Settings, Logs, the tray
|
||||
and the first-run Legal Gate included (the owner chose the full surface over a shell-first cut; the
|
||||
roadmap's §P3/§P4 split is amended to say so). Two items P2 deliberately left standing are P3's
|
||||
first, and both are *replacements* rather than new ground:
|
||||
|
||||
1. **The pipe (`07_IPC` §C).** Decision D10 put it here. The P2 Agent has no client: `--serve` logs
|
||||
to `%LOCALAPPDATA%\FrameLedger\logs\agent-*.log` and `--console` prints. `04_CAPTURE`
|
||||
§Threading model already says where the reader joins — one more producer, never a second reader
|
||||
of the ring — and `07_IPC` §Messages is written and unimplemented. `SessionProgress` at 1 Hz is
|
||||
what makes the Dashboard's live card worth having.
|
||||
2. ~~**FR-2.1's consent dialog, which retires `ConsentProvenance.AgentConsoleOperator`.**~~ **LANDED 2026-09-13 (PR-4)** — the dialog, the `Shared` family, `ConsentProvenance.ConsentDialog` and the Agent's stamp; the console verb is not retired but demoted to the developer path (`19_SAFETY` §User-facing consent). The paragraph below is kept as the reasoning that held until then. The console
|
||||
verb exists because the reviewed wording does not: `09_I18N` reviews `Safety_*` strings as legal
|
||||
text in en/vi/ja, and ~~no `.resx` exists anywhere in this tree~~ (the App's shell family exists
|
||||
since PR-2, 2026-09-13, under the audit; `Shared`'s `Safety_*` family is still this item's). The
|
||||
dialog is the first thing that needs a REVIEWED one. When it lands, the enum gains its FR-2.1 member, the console verb becomes the
|
||||
developer path it always said it was, and `19_SAFETY` §User-facing consent stops carrying an
|
||||
exception. **Do not add the enum member before the reviewed text exists** — a declared value no
|
||||
code can produce is the §S29(c) shape, and `GameConsentRecordTests` turns red on purpose.
|
||||
|
||||
Everything else in P3 is `08_UI` and `16_WPFUI_SYNTAX` as written.
|
||||
|
||||
> ### What P2 still owes while P3 runs — measurements, not code
|
||||
>
|
||||
> `spike-notes` §14 holds four empty slots and says in its first line that nothing in it has been run:
|
||||
> the milestone session on a real title against its own menus (§14.1), §S1's launcher-fronted election
|
||||
> (§14.2), the ≤ 0.5 % FPS-impact run (§14.3) and §H7's six overlays (§14.4). All four are the owner's,
|
||||
> none blocks a P3 slice, and a P3 session must not read an empty table as a passing one.
|
||||
|
||||
**The order, one PR each, merged one at a time** (`main` is `strict: true`; every PR touching `src/`
|
||||
conflicts in `CHANGELOG.md` — §Traps). Each row names what makes it fail on unmodified `main`,
|
||||
because a criterion already true on `main` is decoration.
|
||||
|
||||
| PR | Slice | Fails on unmodified `main` because… |
|
||||
|---|---|---|
|
||||
| 0 | P2 sweep: the doc/tool drift PR-G left (`coverage-gate.ps1` prose, `13_CI_CD`'s count and its signer-probe claim, `09_I18N`'s member count, `17_HOOK_ENGINE`'s §H9 cite, this file's D-labels, `ci.yml`'s census comment), this head, the roadmap amendment | `grep -n "exactly two members" docs/09_I18N.md` matched; `§H9` resolved to nothing; two START HEREs |
|
||||
| ~~1~~ | ~~**The pipe, read half**: `Shared.Ipc` contracts + `JsonSerializerContext`; the Agent's `PipeServerHostedService`; `Hello`/`HelloAck`, `GetStatus`/`StatusAck`, `Ping`/`Pong`; the events (`SessionStarted`/`Progress`/`Completed`/`CaptureRefused`/`CaptureDegraded`/`SafetyUnhook`/`CaptureError`); a 1 Hz `SessionProgress` publisher; `Infrastructure.Ipc.PipeClient`~~ **LANDED 2026-09-13** — status in `CHANGELOG.md`; `07_IPC` §C carries what was built and the one deviation (`etwAvailable` struck) | ~~`grep -rn NamedPipeServerStream src` is empty; `FrameLedger.Shared` holds no JSON type; `04_CAPTURE` §Live progress has no producer~~ |
|
||||
| ~~1b~~ | ~~**The pipe, command half**: `SetWatchlist` (identity only), `SetHookEnabled` (the Agent re-scans and stamps), `LaunchGame`, `PauseCapture`/`ResumeCapture`, `StopSession`, `UpdateRules` (a trigger, no payload), `Shutdown`~~ **LANDED 2026-09-13** — status in `CHANGELOG.md`; `07_IPC` §Messages carries each row as built. **One thing stayed with PR-4 on purpose:** `SetHookEnabled true` stamps nothing — the pre-scan runs and a block is recorded, then `Error DisclosureUnavailable` — because the reviewed text it would stamp against does not exist, and a member no code can produce is the §S29(c) shape | ~~the Agent accepts no command from outside; `CaptureOrchestrator` has no stop/pause surface; `SetHookEnabled` has no handler~~ |
|
||||
| ~~2~~ | ~~**resx + the App shell**: `Strings.resx` en/vi/ja for App and Shared, the generated class, `tools/resx-audit.ps1` (+`-SelfTest`) as `build.ps1` step 15; the Generic Host bootstrap, `FluentWindow`, TitleBar/Menu/NavigationView, theme + persistence, `INavigationService`, Serilog `ui-*.log`, five empty pages, the Agent status pill over `Hello`, auto-start of `--serve` on connect failure; `tests/FrameLedger.App.Tests`~~ **LANDED 2026-09-13** — status in `CHANGELOG.md`; `08_UI` §Shell and `16_WPFUI_SYNTAX` §App bootstrap carry what was built and the deviations. **Two things moved on purpose:** `Shared`'s family waits for PR-4 (it would hold only `Safety_*`, and an empty family is what the audit refuses), and the generator is ours (`tools/resx-gen.ps1`, committed output) because the SDK-style WPF project runs no `ResXFileCodeGenerator` | ~~`find . -name '*.resx'` is empty; step 15 prints "skipped loudly"; `App.xaml` uses `StartupUri` and `MainWindow` is a plain `Window`~~ |
|
||||
| 2b *(owner decides)* | `FL_MOCK=1` / `Agent --serve --mock`, `--data-dir` only: a `MockSessionSource` hosted service that emits pipe events and inserts synthesised sessions through `ISessionRepository` — and can never resolve `HookedCaptureGate` (asserted) | CLAUDE.md says "specified but not implemented"; `grep FL_MOCK src` is empty |
|
||||
| ~~3~~ | ~~**Ports the UI reads and writes**: `ISessionRepository.ListByGameAsync` / segments / sensors, `ISessionAnnotationRepository`, `ILegalAcceptanceStore.RecordAsync`, `IGameRepository.UpdateMetadataAsync` / `RemoveAsync`, the **settings registry** (closes §G's row — D16 below), `IRtOverrideRepository` (FR-8.3), `display_res`/`display_hz` producer; tests for the four PR-B adapters that have none~~ **LANDED 2026-09-13** — status in `CHANGELOG.md`; `06_DATA_MODEL` §Settings registry, §Writer ownership and §Migrations (schema 0002) carry what was built. **One deviation on purpose:** there is no `IRtOverrideRepository` — the FR-8.3 per-session overrides are columns on `session_annotations` (the UI's table) written through `ISessionAnnotationRepository`, and the game defaults through `IGameRepository.SetTriStateDefaultAsync`, because an override on `sessions` would have been the UI writing the Agent's table; `Application.TriState.TriStateResolution` is the precedence (manual → measured → inherited → N/A) | ~~no port lists sessions by game; `session_annotations` has no repository; `legal_acceptance` has no writer; `ISettingsStore`'s own doc calls the registry open~~ |
|
||||
| ~~4~~ | ~~**FR-2.1's consent dialog**: `Safety_*` en + vi (ja marked `safety: human review required`, shown as en) in `Shared`, `SafetyDisclosureVersion`; `ConsentProvenance.ConsentDialog` whose only producer is the Agent's `SetHookEnabled` handler; `HelloAck.disclosureVersion` and the App **refusing to open the dialog** on mismatch (§S23-1's shape); the dialog itself per `19_SAFETY` §User-facing consent; FR-2.2's disabled toggle with the reason inline; FR-2.5's InfoBar; `GameConsentRecordTests`, `19_SAFETY`, `09_I18N` and item 2 above updated~~ **LANDED 2026-09-13** — status in `CHANGELOG.md`; `19_SAFETY` §User-facing consent carries what was built. **Two things wait for PR-5 on purpose:** FR-2.2's disabled toggle and FR-2.5's InfoBar are the game page's controls, and the page does not exist yet — their text (`Safety_Blocked_Toggle_Format`, `Safety_AutoDisabled_Format`, `Safety_Refused_*`, `Safety_Unhooked_Format`, `Safety_RecordWithoutMeasuring`) shipped here so the reviewed family is complete before anything renders it | ~~`Enum.GetNames<ConsentProvenance>()` has three names; no `Safety_*` key exists; `19_SAFETY` still carries the console exception~~ |
|
||||
| ~~5~~ | ~~**Games + Dashboard**: the grid, game detail (header, **Supports** vs **Last session measured**, the hooking control → PR-4's dialog, the Sessions tab), Dashboard (Agent status + capability badges, the live card over `SessionProgress`, recent sessions, totals), FR-1.1 add / FR-1.4 remove; `FpsReadout` and `TriStateChip`~~ **LANDED 2026-09-14** — status in `CHANGELOG.md`; `08_UI` §Dashboard and §Games carry what was built. **Deferred on purpose:** the card sparkline and the chip override flyout (PR-6, with the charts), the capability badges and Repair on the Agent card (PR-8, with the Agent section), a dropped `.lnk` (needs the shell-link reader) | ~~no page binds a `SessionRow`; nothing renders `62 → 118 FPS (×1.9 FG)`; `SessionProgress` has no consumer~~ |
|
||||
| ~~6~~ | ~~**Session summary + charts**: `ChartTheme` + `ChartPalette.xaml`, min/max decimation (FR-5.3), frametime timeline with stutter markers, segment ribbon and sensor overlay, distribution, the summary window (stat cards, chips + override flyout, crash InfoBar, tags/notes), CSV/JSON/PNG export, the post-session toast~~ **LANDED 2026-09-14** — status in `CHANGELOG.md`; `08_UI` §Session summary and `16_WPFUI` §ScottPlot theme sync carry what was built. **Two things on purpose:** the override is a `ContentDialog`, not a `ui:Flyout` (a flyout anchored to a chip inside an `ItemsControl` has no reliable placement target across the three places chips appear), and FR-3.8's toast is an in-app notice until the tray exists (PR-8) — the "View" action needs a balloon with an action, which the snackbar has not | ~~no ScottPlot plot exists; no decimator; no exporter~~ |
|
||||
| ~~7~~ | ~~**Trend / Sensors / Latency / Compare**: hardware-change markers (FR-6.3), the mid-session-change exclusion + toggle (FR-6.4), sensors with per-process and adapter VRAM as separate series, the latency tab, Compare 2–5 with the **mixed-tier `ContentDialog` guard** (FR-6.2) and tier legend~~ **LANDED 2026-09-14** — status in `CHANGELOG.md`; `08_UI` §Games (tabs 2–6) and §Compare carry what was built. **One thing on purpose:** the tier grouping is done in memory over the loaded rows (`06_DATA_MODEL` §Comparison safety's rule is that a comparison never crosses tiers unasked — `TrendSeriesBuilder` takes hooked rows only and `CompareViewModel` gates the mix), not as a SQL `GROUP BY capture_tier`; the row's criterion said "query" and the honest statement of what holds the rule is the two classes | ~~no query groups by `capture_tier`; no Compare page~~ |
|
||||
| ~~8~~ | ~~**Settings + safety UI + Logs + tray**: FR-10 with the kill switch first, hook-enabled list + revoke, Vulkan layer state with real `--register-vklayer`/`--unregister-vklayer`, language switch, retention, the Agent section with real `--install-task`/`--uninstall-task`, privacy opt-in; the **safety notices** (`CaptureRefused`/`SafetyUnhook`/auto-disable as persistent InfoBar or dialog, never a toast, with "record this session without measuring it"); the Logs page; the tray with FR-3.9; the App's `--diag`~~ — **struck 2026-09-14: 8a (#162) built Settings, the safety notices, Logs and `--diag`; 8b built the tray (H.NotifyIcon, four states, pause over the pipe, the FR-3.8 balloon only while the window is off screen), the four Agent maintenance flags (the logon task through the Task Scheduler COM API — `schtasks` is denied unelevated; the HKCU layer value) and the Settings buttons over them. Two honest gaps in `17_HOOK_ENGINE` §Vulkan's built note: the register/unregister-on-consent automation needs the "is Vulkan" fact (P4), and a registration buys nothing until background capture sets the enable variable.** | ~~the kill switch has a console verb only; `AgentCommandLine.NotImplementedFlags` still lists five; no Logs page~~ |
|
||||
| ~~9~~ | ~~**First run + Legal Gate (FR-11) + closing sweep**: the four documents from `legal/*.md` through `ILegalAcceptanceStore.RecordAsync`, re-shown on a version increment, the Agent-setup and hooking-explainer screens, D8 unchanged unless the owner turns it on; the docs sweep (`01_ARCHITECTURE`, `07_IPC`, `19_SAFETY`, `09_I18N`, CLAUDE.md, this section struck); NFR-4 measured~~ — **struck 2026-09-14: built (`08_UI` §First-run flow built note carries the gate, the embedded documents, the version rule and the NFR-4 numbers; `06_DATA_MODEL` §legal_acceptance and `20_OPEN_QUESTIONS` §G's versioning row say who writes the version). D8 unchanged.** | ~~no code writes a `legal_acceptance` row; the App has no first run~~ |
|
||||
|
||||
**Why this order:** the pipe (1) first because the Dashboard's live card (5), the consent stamp (4) and
|
||||
the tray's pause (8) all need it; resx (2) before the dialog (4) because the dialog is the first thing
|
||||
that needs a reviewed `.resx`; ports (3) before Games (5) because every page reads through a port;
|
||||
charts (6) after Games (5) because the summary opens from the Sessions tab; Settings and the Legal Gate
|
||||
(8–9) last because nothing depends on them and the roadmap used to place them in P4.
|
||||
|
||||
**Decisions taken 2026-09-13 (owner, with the plan), so nobody re-derives them:**
|
||||
|
||||
- **D11 — the pipe's transport.** `Infrastructure.Ipc.PipeServer` over ~~`NamedPipeServerStream`
|
||||
(`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
|
||||
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 }`,
|
||||
`IpcJsonContext : JsonSerializerContext` on the `RecordingJsonContext` pattern, unknown fields ignored and
|
||||
tested in both directions.
|
||||
- **D12 — commands join as one more producer.** A `Channel<AgentCommand>` with a single consumer
|
||||
(`PipeCommandHostedService`) that calls `CaptureOrchestrator` — which gains `StopSessionAsync(guid)` and
|
||||
`SetPaused(bool)`, the latter reaching `ShmRingReader.SetPaused` on the session loop's own task, never
|
||||
from the pipe thread (`04_CAPTURE` §Threading model; `NoSecondRingReaderTests` stands). `SetHookEnabled true`
|
||||
is: the static pre-scan (`RecordGuardBlockAsync` on a block) → `RecordOperatorAcknowledgementAsync` with
|
||||
`Provenance = ConsentDialog`, the disclosure version from the Agent's own copy of the string, and
|
||||
`AcknowledgedAt` from the Agent's clock. A client can request; it cannot attest (`07_IPC` §The pipe is not a
|
||||
trust boundary). *(As built 2026-09-13, PR-1b: **no `Channel` and no `PipeCommandHostedService`** — the
|
||||
handler runs on the pipe client's reader task and the orchestrator's running-session table gained one lock;
|
||||
two commands did not justify a queue and a second place a start can wait. The pause is `CapturePause`, read by
|
||||
the loop at each tick and told to the ring once per transition. The stop is the session's own token in
|
||||
`RecordRequest`, ending the loop as `StoppedByUser`. The stamp branch is PR-4's, exactly as written above;
|
||||
until then it answers `DisclosureUnavailable`.)*
|
||||
- **D13 — `SessionProgress` is a third `ICaptureObserver`.** `ProgressPublisher` in `AgentRecording`,
|
||||
rate-limited to 1 Hz inside `Tick`, snapshots the live lists there and never holds them; `nativeFps5s` /
|
||||
`displayedFps5s` / `fgFactor` come from Domain's calculators over the last 5 s of records through
|
||||
`FrameSampleMapper`, upscaler and resolutions from the newest record, temperatures and VRAM from the newest
|
||||
`TelemetrySample`. Suppressed when no client is connected. A field that is not measured is null, never 0.
|
||||
- **D14 — `Safety_*` lives in `FrameLedger.Shared`, once.** Both processes reference the same resource;
|
||||
`SafetyDisclosureVersion` is a constant beside it; `HelloAck` carries the Agent's; on a mismatch the App
|
||||
says "restart both" and does not show the dialog — the ring handshake's rule (§S23-1) one layer up.
|
||||
**Built in PR-4 (2026-09-13)** as `Shared.Safety.SafetyDisclosure.Version = consent-dialog/1`; the Agent side
|
||||
also refuses (`Error DisclosureVersionMismatch`) so neither side's check is the only one.
|
||||
- **D15 — the App opens `ledger.db` directly**, under `06_DATA_MODEL` §Writer ownership: it writes `games`'
|
||||
user-editable fields, `session_annotations`, `settings` and `legal_acceptance`, reads everything, and never
|
||||
writes a hook-state column — `IGameRepository` has no method that could, and stays that way.
|
||||
- **D16 — the settings registry** (closes §G's row, written into `06_DATA_MODEL` in PR-3): `ui.language`,
|
||||
`ui.theme`, `ui.start_with_windows`, `ui.minimize_to_tray`, `capture.background`, `hooking.kill_switch`
|
||||
(exists), `capture.min_session_s` (30), `telemetry.interval_ms` (1000; 500–2000), `retention.raw_sessions_per_game`
|
||||
(20), `update.channel`, `privacy.online_metadata` (0), `log.debug` (0). The Agent reads `hooking.*`,
|
||||
`capture.*`, `telemetry.*` and `retention.*` at each session start, so no "setting changed" message is needed;
|
||||
the UI owns the rest. **Built in PR-3 (2026-09-13)** as `06_DATA_MODEL` §Settings registry; two things it
|
||||
settled that this bullet did not say: `retention.raw_sessions_per_game = 0` is unlimited (a sweep that keeps
|
||||
everything, never one that keeps nothing), and an operator's bounded `--seconds N` keeps its bound under any
|
||||
`capture.min_session_s`.
|
||||
- **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.** 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.
|
||||
|
||||
**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 **the bypass stops there**: D18's
|
||||
override overrules FrameLedger's own guard; it is not, and may not become, a way past another product's protection.
|
||||
Any proposal to "make the bypass work on EAC titles" is rule 3, not rule 2 — refuse it.
|
||||
|
||||
**Found and NOT fixed — each needs its own PR.**
|
||||
- **A refused session is not recorded, though the notice says it is.** `Notice_Refused_Recording` ("the session is still
|
||||
recorded — duration and hardware telemetry") is appended to every refusal, and `CaptureSession` returns at the
|
||||
refusal: the run lasts about a second and `SessionFinalizer` discards it as under the minimum length. CLAUDE.md's
|
||||
Tier 2 ("duration + sensors + the reason") has no producer for a refusal. The new `TargetUnreadable` notice does not
|
||||
make the claim; the older refusals still do.
|
||||
- **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.
|
||||
|
||||
## Owner-only — no PR can close these
|
||||
|
||||
1. **§S23-2 — branch protection.** `Rules / validate` is not a required status check on
|
||||
@@ -1004,6 +1449,13 @@ reference comes out.~~ — **L2 was written, 2026-09-03.** The obligation now bu
|
||||
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.
|
||||
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
|
||||
them since P1. One capture with each overlay active; the result is a `spike-notes` row.
|
||||
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.
|
||||
|
||||
**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
|
||||
@@ -1034,6 +1486,21 @@ 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
|
||||
harness logs it caused (`17_HOOK_ENGINE` §Native logging) and the `test-artifacts` gate is red for one left behind.
|
||||
A new native test executable that starts hook-harness needs the Catch2 listener from `guard_test.cpp`; do not "fix"
|
||||
a red `test-artifacts` by pointing the Overlay somewhere else.
|
||||
|
||||
- **A CHROMIUM-BASED TITLE IS SEVERAL PROCESSES WITH ONE IMAGE PATH.** *Flower in Us* (NW.js /
|
||||
RPG Maker) returned `TargetAmbiguous`, exit 6, on 2026-09-03: three processes match the
|
||||
consented path. The presenting one is the GPU process, which owns no window — so do not "fix"
|
||||
@@ -1101,6 +1568,26 @@ diagnosis*.
|
||||
the *wrong* PR to prove none of its own work had been lost. This is wrong by design rather
|
||||
than by bad luck — the tree has one HEAD, and a background job racing you for it will
|
||||
sometimes win. Use a separate worktree, or keep it in the foreground.
|
||||
- **CI's Integration cases fail on the runner about one run in three, and it is never the code.**
|
||||
Measured 2026-09-10 while merging P2's stack: **three failures in eight gate runs**, every one an
|
||||
`Category=Integration` case, every one green on a re-run of the identical commit. Two shapes were guard
|
||||
scans failing — `GuardedInjectAsync(...).IsAllowed` false (§S19(b)'s fragment/signer shape) and
|
||||
`ProcessTreeUnavailable — could not establish the scan set`, which §S19(b) does **not** cover — and one
|
||||
was a fixture bug this repo owned (a pooled SQLite handle on `ledger.db` outliving `DisposeAsync`, so a
|
||||
recursive `Directory.Delete` threw and xUnit blamed an unrelated test). **Re-run first. If it
|
||||
reproduces, read the module list and the scan-set reason rather than the test.**
|
||||
Two traps inside this one: `ci.yml`'s signer probe — the step that would name the refusing module —
|
||||
runs *after* the gate, so the one run that needed it printed nothing; and `gh run rerun --failed`
|
||||
rewrites the original run's conclusion, so the run history shows those three failures as **successes**
|
||||
and the flake rate reads zero (`13_CI_CD`).
|
||||
- **MA0004 and xUnit1030 are all-or-nothing PER METHOD, in opposite directions.** A test method may
|
||||
not `ConfigureAwait(false)` (xUnit1030) and, once ANY await in it carries a `ConfigureAwait`, MA0004
|
||||
demands one on every other await too — so a helper's `.ConfigureAwait(false)` copied into a test
|
||||
method turns every neighbouring `await` red. Rule: helpers `false`, test methods either none at all
|
||||
or `true` on every await; measured 2026-09-10 across three rebuilds of one test file.
|
||||
- **A Bash heredoc rewrites `\n` inside a Python string even when the heredoc is quoted.** The
|
||||
replacement text arrived with real newlines, the assert that it matched the file failed, and the
|
||||
diagnosis pointed at the file. Write patch scripts with the editor tool and run them by path.
|
||||
- **Anything that writes a file with a script writes LF, and `.gitattributes` hides it until
|
||||
it does not.** `dotnet format --verify-no-changes` is the documented victim, but a Python
|
||||
or PowerShell `write` is the usual cause. `git commit` prints *"LF will be replaced by
|
||||
@@ -1117,8 +1604,8 @@ diagnosis*.
|
||||
needle containing `` `blockedExecutables` `` silently became something else, `.Replace`
|
||||
matched nothing, the file was unchanged — and the validator correctly passed. Print
|
||||
the mutated text before validating.
|
||||
- **`./build.ps1 check` with no switches** after every PR. CI runs `-SkipIntegration`,
|
||||
so a green CI is not evidence for anything touching the managed drain.
|
||||
- **`./build.ps1 check` with no switches** after every PR. ~~CI runs `-SkipIntegration`,~~ CI runs the same since 2026-09-06,
|
||||
so a green CI is evidence for the managed drain too (§S19(b) BUILT).
|
||||
- **A canary that does not compile is not a canary, and this repo's analyzers make that
|
||||
easy to hit.** Removing a call to prove a gate goes red can leave a constructor
|
||||
parameter unread — `CS9113` under `TreatWarningsAsErrors` — so the build fails, the
|
||||
@@ -1272,6 +1759,17 @@ diagnosis*.
|
||||
`origin/main`; capture old base SHAs *before* merging a stacked pair.
|
||||
- **Do not pass `--delete-branch`**: `main` is checked out in the primary worktree,
|
||||
which blocks it. GitHub deletes the remote branch anyway.
|
||||
- **A control that compiles, binds and passes its view-model tests can still draw nothing.** WPF UI 4.3.0's
|
||||
`InfoBar` has no `ContentPresenter`, so every action button this repo placed as an InfoBar's child — the one
|
||||
dismissal of a safety notice — was silently dropped, and the owner met a red bar with no exit (2026-09-14).
|
||||
`SafetyNoticesTests` was green throughout: it asserted the model, and nothing instantiated the template.
|
||||
When a control's affordance matters, render it (`PagesLoadTests` has the STA harness) and walk the visual
|
||||
tree for the element — `16_WPFUI_SYNTAX` §Gotchas carries the fix and the test that retires it.
|
||||
- **A test that finds a file by pid finds the wrong one on a machine that has run the tests before.** The native
|
||||
log test looked up `overlay-<pid>-*.log` in the real `%LOCALAPPDATA%\FrameLedger\logs`, which keeps every run's
|
||||
log (2130 on the dev box by 2026-09-14). A reused pid read a stale log and failed on the STOP line; the re-run
|
||||
drew a new pid and passed, so it was called a flake four times while the failure output printed the September 6
|
||||
path. **Read the path in a failure before calling it a flake**, and select by creation time, not by name.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -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).
|
||||
+344
-8
@@ -312,8 +312,20 @@ offline retires the route, and §S19(b)'s row G2 says so before the run.
|
||||
yields no organisation — so a green result discriminates rather than merely running.
|
||||
`fl-baseline-probe` was retired by exactly this class of test.
|
||||
|
||||
**Not measured here:** the CI leg (a different machine stages a different copy), and
|
||||
the adapters-disabled leg. Both have pre-committed rows. An unrun leg is unrun.
|
||||
~~**Not measured here:** the CI leg (a different machine stages a different copy), and
|
||||
the adapters-disabled leg. Both have pre-committed rows. An unrun leg is unrun.~~
|
||||
**The CI leg, 2026-09-06** (the ctest printed nothing for eleven days; `ci.yml` now runs the
|
||||
probe as a step): `windows-latest`, elevated. Blocker copy from the runner's NuGet cache,
|
||||
6.0.0, embedded/offline `ERROR_SUCCESS` 3.47 ms, `O= Microsoft Corporation`, no catalog;
|
||||
`mskeyprotect.dll` embedded `TRUST_E_NOSIGNATURE`, catalog `ERROR_SUCCESS`; `kernel32.dll`
|
||||
both; cold 3.45 / warm 3.53 ms; `cryptnet.dll` newly loaded under the offline flags; canary
|
||||
`TRUST_E_NOSIGNATURE`; *"G1 is a CANDIDATE"*. Rows G3, G4, G5 do not fire.
|
||||
**The adapters-disabled leg, the owner's run, 2026-09-06** (dev box, elevated): every verdict
|
||||
unchanged — `kernel32.dll` both `ERROR_SUCCESS`; `mskeyprotect.dll` embedded `TRUST_E_NOSIGNATURE`,
|
||||
catalog `ERROR_SUCCESS`; the blocker embedded `ERROR_SUCCESS`, `O= Microsoft Corporation`, subject
|
||||
now `CN=.NET` (the August copy read `CN=Microsoft Windows`; same `O=`); cold 2.14 / warm 2.15 ms;
|
||||
`cryptnet.dll` mapped; canary `TRUST_E_NOSIGNATURE`. **Row G1 reads**; the bound decision is the
|
||||
owner's before anything is built.
|
||||
|
||||
### Still open
|
||||
|
||||
@@ -323,6 +335,9 @@ the adapters-disabled leg. Both have pre-committed rows. An unrun leg is unrun.
|
||||
loads a presentation runtime lazily, and the only local fixtures are
|
||||
`hook-harness` (creates D3D at startup) and a 2D GOG prologue. A number from
|
||||
those would not generalise, which is worse than recording it as unmeasured.
|
||||
*(2026-09-06: built as "inject late" — P1 item 2 — and the number now comes
|
||||
from every launched session, as `dxgiPresentsBeforeHook` plus the reported
|
||||
wait. `20_OPEN_QUESTIONS` §S1.)*
|
||||
|
||||
### ✅ Signer field for the unknown-but-suspicious heuristic — **`O=`, not `CN=`**
|
||||
|
||||
@@ -428,6 +443,31 @@ the same shape as defects found elsewhere in this project:
|
||||
The unambiguous signal is the loader printing `Insert instance layer` /
|
||||
`Inserted device layer` with our name and DLL path.
|
||||
|
||||
### ✅ `VK_ADD_IMPLICIT_LAYER_PATH` is honoured, and it needs no registry (2026-09-06, P1 item 3)
|
||||
|
||||
Measured against the same loader 1.4.357 with `vulkaninfo --summary` and `VK_LOADER_DEBUG=layer`: with
|
||||
`VK_ADD_IMPLICIT_LAYER_PATH` pointed at the build tree's `FrameLedger.VkLayer` directory and
|
||||
`FRAMELEDGER_ENABLE_VK_LAYER=1`, the loader prints `Insert instance layer "VK_LAYER_FRAMELEDGER_overlay"
|
||||
(…\FrameLedger.VkLayer.dll)` and `Inserted device layer …` — the unambiguous signal above — with nothing
|
||||
under `HKCU` or `HKLM`, and `vulkaninfo` exits 0 with the layer inert (no enable-list entry for it). The
|
||||
first run's `grep … | head` cut the log before the `Insert` lines and read as "found, not inserted"; the
|
||||
lines are at the instance-creation point, ~850 lines in. So the operator host launches Vulkan titles with
|
||||
no registration at all, and the real-loader ctest (`fl_vklayer_real`) does the same: the harness's
|
||||
`--vulkan` mode presented 241 frames in 4 s on a hidden 240-wide window and the layer recorded every one.
|
||||
|
||||
### ✅ On NVIDIA a Vulkan swapchain presents through DXGI — and the DXGI hook sees it (2026-09-06)
|
||||
|
||||
Found by the first end-to-end run of `launch` on the harness's `--vulkan` mode: the guard's poll saw
|
||||
`dxgi.dll` + `d3d12.dll` (the fixture imports d3d11/dxgi; but the NVIDIA Vulkan ICD `nvoglv64` maps them
|
||||
too) and injected the Overlay, whose `Present` hook then recorded **295 DXGI presents in 5 s with
|
||||
`apiMask = D3D12` and DXGI's counter agreeing (248 samples, 0 unseen)** — the Vulkan swapchain's own
|
||||
presents, made by the driver on an internal DXGI flip-model chain. So on this driver the injected Overlay
|
||||
*can* measure a Vulkan title's presents; that is a driver property, not a portable one (AMD's and Intel's
|
||||
WSI need not do it), which is why the layer stays the capture side. Two consequences landed: the
|
||||
launch-mode guard now classifies **any** process that mapped `vulkan-1.dll` as the layer's, and the
|
||||
harness's `--vulkan` mode maps the loader before anything else so the fixture looks like a real Vulkan
|
||||
title to the first poll.
|
||||
|
||||
### ✅ The in-layer blocklist scan — §S2's second half
|
||||
|
||||
The layer scans its own process at init and goes fully passthrough on any hit,
|
||||
@@ -1702,7 +1742,7 @@ one launch per capture, consent granted after launch. Exit codes and full report
|
||||
| Expedition 33 | upscaler 4.0.2 + frame generation 3.1.5, **no loader** | UE5: the plugin's built-in loader calls the leaves directly |
|
||||
| Hell Is Us | upscaler **4.0.3** + frame generation **4.0.0** under `Plugins/FSR/Source/fidelityfx-sdk/Kits/FidelityFX/signedbin/`, **no loader** | UE5, SDK 2.1.x |
|
||||
| Red Dead Redemption 2 | `ffx_fsr2_api_x64.dll` + `_dx12_` + `_vk_` | FSR 2, dynamic |
|
||||
| Cyberpunk 2077 (also) | `ffx_fsr3_x64.dll`, `ffx_backend_dx12_x64.dll`, `ffx_frameinterpolation_x64.dll`, `ffx_fsr3upscaler_x64.dll`, `ffx_opticalflow_x64.dll` | FSR 3.0 host DLLs, named exports — the deferred route |
|
||||
| Cyberpunk 2077 (also) | `ffx_fsr3_x64.dll`, `ffx_backend_dx12_x64.dll`, `ffx_frameinterpolation_x64.dll`, `ffx_fsr3upscaler_x64.dll`, `ffx_opticalflow_x64.dll` | FSR 3.0 host DLLs, named exports — ~~the deferred route~~ hooked 2026-09-05 at the host facade (`ffxFsr3ContextDispatchUpscale`, tag `fsr3-v3.0.4`: the module's twelve exports match that tag, not `v1.1.4`) |
|
||||
|
||||
Every module in the ffx-api family exports the same five names and nothing else
|
||||
(`vendor-exports.json`) — which the morning read as "the loader can only reach a leaf through
|
||||
@@ -1718,7 +1758,7 @@ one launch per capture, consent granted after launch. Exit codes and full report
|
||||
and `none` by count with FG off; **Hell Is Us** `FSR (3.1 or 4 …)` / `FsrFg` / ×2 / 1.00, and
|
||||
`none` with FG off; **Expedition 33** FSR upscale under DLSS FG ×3 → `×2.97`, *technology not
|
||||
identified*, count from UPSCALE dispatches (no PREPARE, no token); **Cyberpunk** at FSR 3: the FSR
|
||||
3.0 host DLLs upscale (`upscaler: N/A`, deferred route) while the 1.1.x monolith generates
|
||||
3.0 host DLLs upscale (`upscaler: N/A` on that build; the host row landed 2026-09-05, §H11 B1 owed) while the 1.1.x monolith generates
|
||||
(`FsrFg`, 4261 batches, ×2); **Dying Light: The Beast** (FSR + FSR FG), **KCD2** (FSR) and
|
||||
**Wukong** (FSR): **zero dispatches at any leaf export**, `upscaler: N/A` — the loader-row
|
||||
reversal; **Rune Factory** (FSR FG): no AMD module in the census, `59.99 → 119.95 (×2)` from
|
||||
@@ -1754,10 +1794,190 @@ one launch per capture, consent granted after launch. Exit codes and full report
|
||||
local and both global — GUID-checked, from the argument the hooked API received. If the
|
||||
next run prints a `render -> output` line, that was the shape; if not, the title does not
|
||||
state the size on this route at all and the honest line stays `N/A`.
|
||||
- **2026-09-05 00:53, DL:TB at DLSS on the #116 build (payload rebuilt 00:51): `N/A` stands.**
|
||||
`Dlss` 3460/3523, `FPS 58.87`, **`UpscalerParams` 0 of 3523**, both tag rows live, the
|
||||
whole-resource fallback in. So on this title the scaling-input tag reaches neither global
|
||||
export with a size in either place, or does not reach them at all — the record cannot
|
||||
separate those two, and that is the one thing left to instrument if 7a is ever reopened on
|
||||
this title (a tag-route census: calls seen per export, zero-extent seen, Resource-size seen —
|
||||
a record bit or a writer-state word, so a layout bump). **7a on DL:TB closes as measured
|
||||
`N/A`** for the quality byte and the render size; the derived label has no input here and
|
||||
stays the owner's decision for the titles that do print the line (Cyberpunk).
|
||||
`frame generation: none` again with presents = tokens = 3441 and DLSS FG on — the fifth
|
||||
such run, §H5.
|
||||
- **And the owner's answer to the FG question: all four DLSS runs had DLSS Frame Generation
|
||||
ON.** `presents = tokens` on every one, against ×2 with FSR FG on the same title and ×3.99
|
||||
on Cyberpunk (SL 2.7.1, DLSS-G 310.8) — recorded in `20_OPEN_QUESTIONS` §H5 as case 3's
|
||||
candidate, with the discriminator (the owner's counter reading) pre-committed there.
|
||||
- **2026-09-05, the owner's run on #118 + #119 — eleven captures, seven titles, every one with
|
||||
DLSS or frame generation on**, the first with the `module:` lines (interposer versions read off
|
||||
the files: DL:TB 2.8.0, Cyberpunk 2.7.1, Hell Is Us 2.7.3, Expedition 33 2.7.30, Wukong 2.7.4;
|
||||
`_nvngx.dll` 32.0.16.1664 from the driver store on every NVIDIA title):
|
||||
|
||||
| Title / setting | What printed | Reading |
|
||||
|---|---|---|
|
||||
| **Cyberpunk 2077**, FSR 3 + FSR FG | `upscaler: Fsr3` (host route, 4332 records at 1506×847), `FsrFg`, `74.31 → 148.56 (×2)`, `frames/upscale-drained 1.01` | **§H11 B1 accepted** |
|
||||
| **Cyberpunk 2077**, FSR 3, FG off | `Fsr3`, `none` by count 4919/4919, `1506x847 -> 2560x1440 = 1.7x (59%)` | **B1-off accepted** |
|
||||
| **Cyberpunk 2077**, DLSS + RR + MFG ×3 | `Dlss` (via RR, 3704 batches), `62.86 → 187.49 (×2.98)`, `Active (technology not identified)`, `render 1707x960` on 3677 records | count right, DLSS-G unnamed (`kFeatureDLSS_G` never evaluated) |
|
||||
| **Dying Light: The Beast**, DLSS FG ×4 (twice) | `Presented FPS 76.7` / `93.24`, **`none` WITHHELD** with the §H5 qualifier, `sl.interposer.dll 2.8.0.0` named | **owner's counter ~300 = 3.9× ours** — reading (a) with its number |
|
||||
| **Hell Is Us**, DLSS + FG ×4 (twice) | `82.23 → 328.98 (×4)`, `Active (technology not identified)`, `upscaler: N/A`; the first run refused the factor (bucket 2.25 vs 3.65 — 53 unfocused ticks) | NGX-direct SR, Streamline tokens still count |
|
||||
| **Expedition 33**, DLSS + FG (twice) | `54.9 → 218.38 (×3.98)`, `Active (technology not identified)`, `upscaler: N/A` | same shape |
|
||||
| **Black Myth: Wukong**, DLSS + FG ×4 | `55.39 → 221.53 (×4)`, `Active (technology not identified)`, `upscaler: N/A`, `sl.dlss_g.dll 2.7.4.0` loaded | same shape; the plugin bit is set on a 2.7 title, and the gate correctly did not fire (factor active) |
|
||||
| **Lies of P**, DLSS, no FG (owner) | `Presented FPS 59.77`, WARNING naming `amd_fidelityfx_dx12.dll`, `upscaler: N/A`, `tokens=0` | NGX-direct SR with no Streamline at all: nothing this build hooks fires |
|
||||
|
||||
Two things the run found beyond the rows. **A consumer defect:** `render -> output: N/A` on every
|
||||
FG-on capture — Cyberpunk at FSR 3 + FG printed it two lines under `render 1506x847 on 4332
|
||||
record(s)` — because `UpscaleExtent` keyed its window on the params bit, which under frame
|
||||
generation rides on one present in N; fixed the same day (identity-bit window). **And the shape
|
||||
of what is left:** on every NVIDIA title measured the *count* is right and the *identity* is
|
||||
what this build cannot say — DLSS on four NGX-direct titles, DLSS-G on all of them — because
|
||||
the NGX SDK is licence-blocked and `kFeatureDLSS_G` is never evaluated through the export the
|
||||
Streamline hook owns. `20_OPEN_QUESTIONS` §H5 carries the one candidate that is not a hook
|
||||
(`NvAPI_NGX_GetNGXOverrideState`, by PID) and the probe that measures it before anything is
|
||||
built on it.
|
||||
|
||||
- **2026-09-05 evening, the owner's run on #121 (the tag route) — eight captures, six titles, every one at DLSS**
|
||||
**with frame generation on**, the first with the `Streamline tag census:` line. The pre-commitment in
|
||||
`20_OPEN_QUESTIONS` §H5 landed on every title that goes through Streamline:
|
||||
|
||||
| Title / setting | `frame generation:` | Trio | Tag census (route: types) |
|
||||
|---|---|---|---|
|
||||
| **Hell Is Us**, DLSS + FG ×4 (twice) | **`DlssG`** | `38.5 → 154.04 (×4)`, `81.41 → 325.58 (×4)` | global: depth, mvec, hudless, ui-color-alpha, backbuffer, other |
|
||||
| **Expedition 33**, DLSS + FG ×2 | **`DlssG`** | `75.95 → 149.83 (×1.97)` | global: same set |
|
||||
| **Black Myth: Wukong**, DLSS + FG ×4 | **`DlssG`** | `47.99 → 191.89 (×4)` | global: depth, mvec, hudless, ui-color-alpha, backbuffer |
|
||||
| **Rune Factory**, DLSS + FG ×4 | **`DlssG`** | `128.85 → 513.02 (×3.98)` | global: same as Hell Is Us |
|
||||
| **Cyberpunk 2077**, DLSS + RR + MFG | **`DlssG`**, `upscaler: Dlss`, `1707x960 -> 2560x1440 = 1.5x (67%)` | **factor refused** — bucket 1 of 8 reads 3.0 against 1.67 overall; `tokens/batch 2.97` | global: depth, mvec, hudless, scaling-in, scaling-out, other (no UI tag) |
|
||||
| **Dying Light: The Beast**, DLSS FG ×4 | N/A (`none` withheld, §H5) + *"it is FEEDING frame generation"* | `Presented FPS 67.13` | **frame** (`slSetTagForFrame`): depth, mvec, hudless, scaling-in, scaling-out, ui-color-alpha, other |
|
||||
|
||||
Three readings. **The identity is measured on six of six Streamline titles** — the UE Streamline plugin tags
|
||||
the DLSS-G inputs globally (`slSetTag`) on every UE title, Cyberpunk on 2.7.1 tags globally too, DL:TB on 2.8
|
||||
tags through `slSetTagForFrame` — so `Active (technology not identified)` is gone from every one of them,
|
||||
and `upscaler: N/A` on the UE titles is now the ONLY NVIDIA gap (NGX-direct super-resolution, the NVAPI
|
||||
probe's job). **DL:TB's 7a question is answered by the census, at no layout cost**: the title DOES tag
|
||||
`kBufferTypeScalingInputColor`, through the 2.8 export, and `UpscalerParams` is still 0 of 4030 — so the tag
|
||||
carries neither an extent nor a Resource size, which is exactly the shape #116 named and could not see; the
|
||||
`N/A` there is the title's truth. **Cyberpunk's refusal is the guard working**: `tokens/batch 2.97` with
|
||||
`presents/batch 4.97` and bucket 1 at 3.0 is a session whose state changed after the first eighth — tokens
|
||||
kept flowing while Ray Reconstruction stopped being evaluated, which is what a menu or a pause does — and the
|
||||
report refused the session-level number rather than averaging two configurations (the 2026-08-16 alt-tab
|
||||
lesson). The owner's settings for that run are recorded when known; the earlier 14:01 run at MFG ×3 read
|
||||
`×2.98` with `tokens/batch 1.00` on the same title.
|
||||
|
||||
- **2026-09-05 night, the owner's run on #124 (the DXGI present counter) — DL:TB twice, Hell Is Us, and a
|
||||
new title, the Onimusha: Way of the Sword demo on Streamline 2.10.3.** `20_OPEN_QUESTIONS` §H5 row
|
||||
P1-DXGI landed on the first title and both controls read zero:
|
||||
|
||||
| Title / Streamline | Trio or Presented | `DXGI present counter:` | `frame generation:` |
|
||||
|---|---|---|---|
|
||||
| **Dying Light: The Beast**, 2.8.0, DLSS FG ×4 (21:56) | `Presented FPS 69.99` (withheld) | `unseen=12204 over samples=4136 (2.95)` | N/A (withheld) + *FEEDING* |
|
||||
| **Dying Light: The Beast**, 2.8.0, DLSS FG ×4 (22:06) | `Presented FPS 73.19` (withheld) | `unseen=12741 over samples=4392 (2.90)` | same |
|
||||
| **Hell Is Us**, 2.7.3, DLSS + FG ×4 | `79.89 → 308.14 (×3.86)` | `unseen=0 over samples=18207` | `DlssG` |
|
||||
| **Onimusha: Way of the Sword demo**, **2.10.3**, DLSS + FG | `60.04 → 220.33 (×3.67)` | `unseen=0 over samples=12914` | `DlssG`, `upscaler: Dlss`, RT Yes (27.1 %) |
|
||||
|
||||
The 2.8.0 pacer presents on the hooked chain through a body the inline patches do not cover; 2.7.3 and
|
||||
2.10.3 present through the body they do. The owner's "`sl.interposer.dll` + `sl.common.dll` must be
|
||||
loaded on ≥ 2.8" lead is closed by the 2.10.3 title: it injects, tags on the frame route (`depth, mvec,
|
||||
hudless, scaling-in, scaling-out, ui-color-alpha, backbuffer, other`) and counts like 2.7. Onimusha's
|
||||
`render -> output: N/A` with `UpscalerParams 0/13014` is DL:TB's shape again — the frame-route tags carry
|
||||
no size on D3D12, where `sl::Resource` declares none. The PR after #124 turns the 2.8.0 reading into a
|
||||
DXGI-COUNTED Displayed (`03_METRICS` §Displayed may be DXGI-COUNTED).
|
||||
|
||||
- **2026-09-06 morning, the owner's run on #125 — DL:TB three times (frame generation on, then off twice)
|
||||
and Expedition 33 with frame generation off.** The promotion landed and §H5's Leg 0 answered:
|
||||
|
||||
| Title / setting | Line | `DXGI present counter:` | `frame generation:` |
|
||||
|---|---|---|---|
|
||||
| **Dying Light: The Beast**, DLSS FG ×4 (07:31) | `Native FPS: 70.52 -> Displayed FPS: 282.08 (x4 FG) over 16516 present(s)` + *Displayed is DXGI-COUNTED: 12387* | `unseen=12483 over samples=4202 (2.97)` | **`DlssG`** |
|
||||
| **Dying Light: The Beast**, DLSS, FG **off** (07:45) | `Presented FPS 75.52` (withheld) | `unseen=0 over samples=4519` | N/A (withheld) — census still `0x25F0F`, tags `0x23600` (no hudless / UI) |
|
||||
| **Dying Light: The Beast**, DLSS, FG **off** (07:55) | `Presented FPS 61.14` (withheld) | `unseen=0 over samples=3659` | same |
|
||||
| **Expedition 33**, FG off (Streamline 2.7.30) | `FPS: 85.86` | `unseen=0 over samples=5063` | `none` by count; tag census `0x0` |
|
||||
|
||||
Two readings. **The trio is printed on the title that could not print it**, from a count DXGI made
|
||||
(12,387 presents this hook never timed), and it is the number the owner's own counter showed (~300 at
|
||||
×4 against ~75 native). **Leg 0: `sl.dlss_g.dll` is a startup-time load** — the census cannot tell FG
|
||||
off from FG on, exactly the cost the gate pre-committed — but the DXGI counter can (0 unseen with FG
|
||||
off, 2.9–3.0 with it on), so the gate is narrowed to sessions where the counter was not read, and the
|
||||
two FG-off captures above print `none` with DXGI's agreement on the next build. Also visible: with FG
|
||||
off DL:TB sends no hudless / UI tag and the UE plugin sends no tags at all, so the DLSS-G identity is
|
||||
per-setting on both.
|
||||
|
||||
- **2026-09-06, 09:20–09:35, the NVAPI probe against three running titles (`fl-probe-nvapi --ngx-state
|
||||
<pid>`, driver 616.64), each beside a capture on the #126 build.** The question §H5 opened on 2026-09-05 —
|
||||
are the driver's per-process NGX feedback bits populated without an NVIDIA-app override? — is answered
|
||||
YES for super resolution and NO for frame generation:
|
||||
|
||||
| Title / override / capture beside it | SR | RR | FG | `scalingRatio` / `performanceMode` / `renderPreset` / `frameGenerationCount` |
|
||||
|---|---|---|---|---|
|
||||
| **Hell Is Us**, no override, `83.21 → 332.82 (×4 FG)` `DlssG`, `upscaler: N/A` | `0x80605` CREATED EVALUATE (+ INITIALIZED DLL_EXISTS ERR_NOT_FOUND) | INITIALIZED DLL_EXISTS ERR_NOT_FOUND | `0x5` INITIALIZED DLL_EXISTS only | 0 / 0 / 0 / 0 |
|
||||
| **Expedition 33**, override ON, FG off, `FPS: 79.4` `none` (DXGI agrees), `upscaler: N/A` | `0x8067F` CREATED EVALUATE ENABLED DLL_LOADED DLL_SELECTED PRESET PERF_MODE (+ …) | INITIALIZED DLL_EXISTS ERR_NOT_FOUND | `0x1F` INITIALIZED ENABLED DLL_EXISTS DLL_LOADED DLL_SELECTED | 0 / 2 / 11 / 0 |
|
||||
| **Lies of P**, no override, `Presented FPS 59.89`, `upscaler: N/A` | `0x605` CREATED EVALUATE (+ INITIALIZED DLL_EXISTS) | INITIALIZED ERR_FAILED ERR_NOT_FOUND | INITIALIZED ERR_FAILED ERR_NOT_FOUND | 0 / 0 / 0 / 0 |
|
||||
|
||||
The SR word carries the identity the hooks cannot see on these three titles; the FG word does not see
|
||||
DLSS-G running at ×4 (it tracks the override machinery's DLL, not the plugin), `frameGenerationCount` is
|
||||
the override target and not the multiplier, and `scalingRatio` is 0 even under the override. §H5 carries
|
||||
what a driver-reported rung may and may not claim, and the negative still owed (DLSS off in the menu).
|
||||
Also on this run: Expedition 33 with FG off now prints `none` with *DXGI's own present counter agrees:
|
||||
0 unseen over 4774* (#126), and Lies of P's `Presented FPS` keeps its "MAY include generated frames"
|
||||
qualifier because `amd_fidelityfx_dx12.dll` is loaded there — the census cannot say `none` and the
|
||||
token count is 0 on that title, so that line is right as printed.
|
||||
|
||||
- **2026-09-06, 10:39–11:36, the owner's run on #128 (the driver-reported rung) — §H5 rows N1–N4 and one
|
||||
correction.** The standalone probe first: Lies of P with upscaling OFF reads `SR 0x5` (CREATED clear), with
|
||||
DLSS on `0x605` — N3 keeps the rung. Then the captures:
|
||||
|
||||
| Title / setting | `upscaler:` | `NVIDIA driver NGX state:` SR / RR / FG | FG line |
|
||||
|---|---|---|---|
|
||||
| **Lies of P**, DLSS (no override) | **`Dlss (driver-reported: …)`** | `0x605` / `0x90001` / `0x90001` | N/A (no FG in this title) |
|
||||
| **Expedition 33**, override ON, FG off | **`Dlss (driver-reported: …)`** | `0x8067F` (mode 2, preset 11) / `0x80005` / `0x1F` | `none`, DXGI agrees |
|
||||
| **Hell Is Us**, DLSS + FG ×4 | **`Dlss (driver-reported: …)`** | `0x80605` / `0x80005` / **`0x605`** (CHANGED between readings) | `81.32 → 321.73 (×3.96)`, `DlssG` |
|
||||
| **Onimusha demo**, SL 2.10.3, DLSS + FG | `Dlss — the NVIDIA driver agrees` | `0x605` / `0x5` / **`0x605`** (CHANGED) | `59.99 → 235.47 (×3.93)`, `DlssG` |
|
||||
| **Dying Light: The Beast**, DLSS + FG ×4 | `Dlss — the NVIDIA driver agrees` | `0x605` / `0x90001` / **`0x605`** (CHANGED) | `39.63 → 158.5 (×4)` DXGI-COUNTED, `DlssG` |
|
||||
| **Cronos: The New Dawn demo** (new; UE, **SL 2.8.0**), DLSS, FG off | **`Dlss (driver-reported: …)`** | `0x80605` / `0x80005` / `0x5` | `FPS 105.01`, `none`, DXGI agrees; RT Yes |
|
||||
| **Dying Light: The Beast**, **FSR upscaling + DLSS FG** | `FSR (3.1 or 4 …)`, `2560x1440 -> 2560x1440` | **`0x205`** (CREATED, not EVALUATE) / `0x90001` / `0x605` | `DlssG` from the tags; factor REFUSED (bucket 8 of 8 at 1.96 vs 2.85); DXGI 1.80 unseen / present |
|
||||
|
||||
Three readings. **The rung works as written and its negative held.** **The FG word is not blind** — the
|
||||
morning's Hell Is Us reading was taken before the feature came up, and every ×4 session's loop readings
|
||||
show `CREATED | EVALUATE` with the word changing mid-session; the multiplier bits never set, so it is an
|
||||
identity witness and is now printed beside `frame generation:`. **`SR 0x205` on the FSR session is the
|
||||
word telling the truth finely**: DLSS was created at some point (the title initialises it) and not
|
||||
evaluated, and the rung's two-bit key keeps it from claiming DLSS beside FSR. The FSR + DLSS-G session
|
||||
also exposed a wrong qualifier ("no evaluation was observed" beside 4,415 tokens and a refused factor),
|
||||
fixed the same day. Cronos is a second Streamline 2.8.0 title; its FG-on capture is the one that says
|
||||
whether the pacer bypass measured on DL:TB belongs to SDK 2.8.0 or to that title.
|
||||
|
||||
- **2026-09-06, 12:17, Cronos: The New Dawn demo with frame generation ON — the row that closed §H5's
|
||||
DLSS / DLSS-G question.** Streamline 2.8.0, UE: `Native FPS: 86.8 -> Displayed FPS: 172.72 (x1.99 FG)`
|
||||
over 9,948 presents, `unseen=0 over samples=10063`, tag census `frame=[depth, mvec, hudless,
|
||||
ui-color-alpha, backbuffer, other]`, `frame generation: DlssG — the NVIDIA driver agrees`, `upscaler: Dlss
|
||||
(driver-reported)`, RT Yes. The 2.8.0 SDK presents its generated frames through the body the inline
|
||||
patches cover; the bypass measured on Dying Light: The Beast is that title's integration. With this row
|
||||
every measured NVIDIA title prints the rule-6 trio or a counted `none`, and the owner closed the item.
|
||||
|
||||
- **2026-09-06, 12:46, Lies of P at FSR 3.1 + FSR frame generation, on the #129 build — §H11 row A1 again,
|
||||
now with every witness on the page.** `upscaler: Fsr3`, `render -> output: 2560x1440 -> 2560x1440 = 1x` on
|
||||
3,538 records, `frame generation: FsrFg`, `Native FPS: 59.77 -> Displayed FPS: 119.55 (x2 FG)` over 7,042
|
||||
presents; the ffx census `upscale-drained=3518 fg-dispatch-drained=3518 frames=3520`, `presents/frame=2.00`,
|
||||
`frames/upscale-drained=1.00`; `DXGI present counter: unseen=0 over samples=7096` (the FSR 3.1 pacer presents
|
||||
through the patched body); the NVIDIA driver's word `SR 0x5` / `FG 0x90001` — nothing created, so the
|
||||
driver-reported rung correctly says nothing beside an AMD identity. The census names only
|
||||
`amd_fidelityfx_dx12.dll` (the 3.1 monolith Lies of P calls) — the AMD half of 7c is complete on its oracle.
|
||||
Same run, Rune Factory at DLSS + FG ×4: `125.45 → 498.51 (×3.97)`, `Dlss (driver-reported)`, `DlssG` with the
|
||||
driver agreeing — the 7b title on its NVIDIA path.
|
||||
|
||||
- **2026-09-06, 13:45–14:02, the owner's run on #132 (rung 3 by elimination + the executable scan): Cronos at
|
||||
XeSS (no FG option), Hell Is Us at XeSS + XeSS-FG, Rune Factory at FSR + FSR FG.**
|
||||
|
||||
| Title / setting | Line | `frame generation:` | `executable markers:` |
|
||||
|---|---|---|---|
|
||||
| **Cronos**, XeSS, no FG | `FPS: 110.02`, `none` by count, DXGI agrees | `None` | ffxFrameInterpolation ×1, NVSDK_NGX ×112, xefgSwapChain ×13 |
|
||||
| **Hell Is Us**, XeSS + **XeSS-FG** | `Presented FPS: 186.47`, **`tokens=0`**, `unseen=0` | N/A — no token on this plugin at XeSS; witnesses: not DLSS-G, no FSR dispatch, runtimes nvngx_dlssg + libxess_fg + amd FG, file carries xefgSwapChain | same set |
|
||||
| **Rune Factory**, FSR + **FSR FG** (compiled in) | `30.05 → 60.05 (×2 FG)` from the token, `unseen=0` | `Active (technology not identified) — by elimination …; the executable itself carries ffxFsr3, ffxFrameInterpolation` | ffxFsr3 ×13, ffxFrameInterpolation ×9, NVSDK_NGX ×112 |
|
||||
|
||||
Three readings. Rune Factory is the pre-committed 7b line, verbatim. XeFG presents through the patched
|
||||
body (0 unseen) so its Displayed rate is measured; its Native is not, because Hell Is Us's plugin requests
|
||||
no Streamline token at XeSS (it does at DLSS, and Cronos's does at XeSS) — the count producer is the
|
||||
plugin's choice, and nothing in policy replaces it. The Steam overlay could not show FG on that session
|
||||
either. The upscaler N/A on both XeSS titles now names Intel's licence as the reason (7c item 4).
|
||||
|
||||
## 10 · Telemetry layering
|
||||
|
||||
@@ -2211,16 +2431,25 @@ produced no false refusal on any real install.
|
||||
|
||||
`15_ROADMAP` §P0. Nothing in P1 starts until all are met.
|
||||
|
||||
- [ ] A throwaway build records a real session from a real offline game
|
||||
- [x] A throwaway build records a real session from a real offline game
|
||||
reporting **correct** upscaler, quality preset, render → output
|
||||
resolution, FG factor and RT state — verified against the game's own
|
||||
settings menu.
|
||||
settings menu. **Met 2026-09-06 with one amendment, the owner's:** the
|
||||
quality preset reads `N/A` on every title, by measurement — Streamline's tags
|
||||
carry no size or preset on Direct3D 12, NVIDIA's override fields are the
|
||||
override's, XeSS is closed by licence — and an honest `N/A` where measurement
|
||||
is impossible is the *correct* value CLAUDE.md rule 7 asks for. Upscaler,
|
||||
render → output (where the vendor's call carries it), FG factor and RT state
|
||||
are verified against the menus of nine titles (§9). The owner closed 7a on
|
||||
this reading and closed P0 on it here.
|
||||
- [x] **Moved to the end of P1** (§R4, decided 2026-08-02) — ~~measured game FPS
|
||||
impact under 0.5%~~. As written it imported P2's drain, aggregate and
|
||||
recorder paths; the harness-level per-present cost stayed in P0 and is
|
||||
measured in §3 (8.4 ns).
|
||||
- [ ] Every S-series item in `20_OPEN_QUESTIONS.md` resolved, or explicitly
|
||||
deferred with a written rationale.
|
||||
- [x] Every S-series item in `20_OPEN_QUESTIONS.md` resolved, or explicitly
|
||||
deferred with a written rationale. **Met 2026-09-06** (§S24: zero counted
|
||||
against it). 🚫 S23-2 is a branch-protection setting outside any PR and is
|
||||
recorded as such, not as met.
|
||||
- [x] M3 and M4 answered **before** any NVAPI or LHM code is written — both
|
||||
CLEAR, §0 above.
|
||||
|
||||
@@ -2228,3 +2457,110 @@ produced no false refusal on any real install.
|
||||
> 2026-08-02** — the FPS-impact criterion moved to the end of P1, and the
|
||||
> harness-level per-present cost stayed in P0 as item 2. This file went on asking
|
||||
> for a decision that two other documents had already recorded.
|
||||
|
||||
---
|
||||
|
||||
## 14 · The P2 milestone and the FPS-impact run *(slots — the owner's runs)*
|
||||
|
||||
**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
|
||||
"not required" — the failure mode this file's own rules name first.
|
||||
|
||||
### 14.1 · The milestone session — Tier 1, a real title, against its menus
|
||||
|
||||
`15_ROADMAP` §P2: *"first real hooked session persisted with measured upscaler/RT data."*
|
||||
|
||||
**The technical half is met and is in the merge gate (2026-09-10, P2 PR-F):**
|
||||
`AgentEndToEndTests` runs the shipped `FrameLedger.Agent.exe --console capture --exe hook-harness.exe`
|
||||
and reads back one `sessions` row — tier 1, `d3d11`, > 100 frames, `guard_ticks_published ≥ 1`, the
|
||||
blobs beside it, no `.partial` left. What the harness cannot supply is a *game*: it has no upscaler,
|
||||
no frame generation and no ray tracing, so `upscaler`, `fg_mode` and `rt_flag` are honestly `N/A`
|
||||
there. The milestone is the row where they are not.
|
||||
|
||||
**The run, when the owner takes it** (candidates from §9: Cyberpunk 2077, Lies of P, Cronos):
|
||||
|
||||
```
|
||||
FrameLedger.Agent --console consent grant --exe "<title>.exe" # type the phrase
|
||||
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, 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` | `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.
|
||||
|
||||
### 14.2 · §S1's launcher-fronted title — launch mode and the descendant election
|
||||
|
||||
The election is built (P2 PR-F, `DescendantElection`) and unit-tested against fabricated snapshots;
|
||||
what has never happened is a real launcher spawning a real game under it. An Epic- or
|
||||
Ubisoft-fronted title is the case: the consented executable exits or never presents, the guard
|
||||
answers `LaunchTargetExited` / `LaunchNoPresentationRuntime` with nothing injected, and the Agent
|
||||
then elects the newest tracked descendant and attaches.
|
||||
|
||||
**The elected image needs its own consent record** — a launcher's consent does not extend to what it
|
||||
spawns — so the run is: `consent grant` the launcher, `launch` it, read the `election:` line, then
|
||||
`consent grant` the game the election named and `launch` again.
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| Title / launcher | |
|
||||
| Guard's answer for the launcher | |
|
||||
| `election:` line | |
|
||||
| Session row for the elected image | |
|
||||
|
||||
### 14.3 · FPS impact ≤ 0.5 % — `14_TESTING` §Hook overhead item 2
|
||||
|
||||
The last thing P1 owes (§R4 moved it here because it needs P2's drain and recorder). Run
|
||||
`tools/fps-impact-runbook.ps1`; it prints the block that replaces this one.
|
||||
|
||||
```
|
||||
./tools/fps-impact-runbook.ps1 -Exe "<title>.exe" -GameArgs "-benchmark" -Seconds 600
|
||||
```
|
||||
|
||||
| Run | Leg | Game avg FPS | Agent CPU (% of a core) | Agent RSS (MB) |
|
||||
|---|---|---|---|---|
|
||||
| 1 | ON | | | |
|
||||
| 2 | ON | | | |
|
||||
| 3 | ON | | | |
|
||||
| 1 | OFF | | | |
|
||||
| 2 | OFF | | | |
|
||||
| 3 | OFF | | | |
|
||||
|
||||
Gates: FPS delta ≤ 0.5 %, Agent CPU ≤ 1 % of a core, Agent RSS ≤ 150 MB. **Overlay resident ≤ 8 MB is
|
||||
not measured by the runbook** and is left blank rather than guessed: it is a module inside the game
|
||||
process, and reading the target's memory is what CLAUDE.md rule 4 forbids — an external tool that
|
||||
inspects module sizes is the way to fill it.
|
||||
|
||||
### 14.4 · §H7's six overlays — still owner-only
|
||||
|
||||
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.
|
||||
@@ -0,0 +1,78 @@
|
||||
<!--
|
||||
THE ONE ACCURACY BLOCK. Embedded verbatim in README.md and legal/DISCLAIMER.md
|
||||
between the two HTML-comment markers named `accuracy-block:begin` and
|
||||
`accuracy-block:end` (spelled out in tools/accuracy-check.ps1 — not here, because a
|
||||
literal marker inside this comment would end the comment early), and that gate
|
||||
fails the build when any copy differs from this file
|
||||
(20_OPEN_QUESTIONS §S23-6: the accuracy blocks were hand-maintained prose that
|
||||
nothing verified, and DISCLAIMER's went stale four times in one direction and once
|
||||
in the other). Whether the sentences below are TRUE is still a human's job — the
|
||||
gate only makes there be one place to get them wrong. Re-read this file in the PR
|
||||
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-21.** The software is a beta; its latest
|
||||
> **pre-release is `0.1.0-beta.4`** (2026-09-21), 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 (or,
|
||||
> for a game whose guard bypass you turned on yourself, past your own acceptance of that risk), and
|
||||
> stores sessions in a local database. What that path measures:
|
||||
>
|
||||
> - **Frame times and output resolution:** measured from the present call for Direct3D 11/12 and
|
||||
> OpenGL titles FrameLedger injects into. Vulkan titles are measured only when FrameLedger itself
|
||||
> starts the game with its Vulkan layer enabled, which today only the Agent's command-line launch
|
||||
> does. A Vulkan title started any other way is not observed by the layer; FrameLedger injects its
|
||||
> Direct3D component into it instead, and what that records on a Vulkan title has not been
|
||||
> verified. Direct3D 9 and every 32-bit title are not measured.
|
||||
> - **Which upscaler is running:** measured from the API a Direct3D title calls — DLSS or NIS through
|
||||
> NVIDIA Streamline (with Ray Reconstruction Yes/No), and FSR through AMD's shipped FidelityFX DLLs:
|
||||
> named FSR 3 from the older DLLs, and FSR without a version from the newer ones, which host both
|
||||
> FSR 3.1 and FSR 4. FSR 2, and FSR shipped any other way, is not identified. For DLSS titles that
|
||||
> bypass Streamline, the NVIDIA driver's own per-process record is stored with the session, labelled
|
||||
> *driver-reported*; the app does not display it yet. Intel XeSS is **not** read (its SDK licence
|
||||
> 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
|
||||
> DLSS options a Streamline title passes with its per-frame call — has not been seen on a real
|
||||
> title, and AMD's per-frame call carries no preset.
|
||||
> - **Render → output resolution:** measured where the vendor's own per-frame call carries the render
|
||||
> size (AMD FidelityFX dispatches, and Streamline titles whose resource tags state it); `N/A` where it
|
||||
> does not: DLSS titles that bypass Streamline, Streamline titles whose tags carry no size, and Vulkan
|
||||
> and OpenGL titles.
|
||||
> - **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. 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.
|
||||
> - **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.
|
||||
> - **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), 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 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 one override, and only one:** a per-game
|
||||
> "bypass the anti-cheat guard" switch, off by default, that you can turn on only by accepting its own
|
||||
> warning (a tick and a typed word). With it on, FrameLedger injects into that game even where the
|
||||
> checks find anti-cheat, the 30 s re-check no longer stops the capture for that finding, and every
|
||||
> session started that way is marked. It never changes HOW FrameLedger injects: nothing is hidden.
|
||||
>
|
||||
> 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
|
||||
> yours. The software never substitutes an estimate.
|
||||
+151
-27
@@ -1,30 +1,28 @@
|
||||
# FrameLedger — Disclaimer
|
||||
|
||||
**Version:** 2.0-draft · **Effective:** {{RELEASE_DATE}}
|
||||
**Version:** 2.4 · **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.
|
||||
>
|
||||
> **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.**
|
||||
> - §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: it covers **injected Direct3D titles only**, because the Vulkan layer intercepts nothing yet, 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.
|
||||
> - §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, 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)
|
||||
|
||||
@@ -44,7 +42,7 @@ Install it somewhere only you can write to, and verify the published SHA-256 che
|
||||
|
||||
**What it observes:** arguments the game passes to graphics APIs we intercept (presentation, upscaling, ray tracing, pipeline creation) and video-memory usage reported by the graphics runtime.
|
||||
|
||||
> **Today that list is two items long: presentation and upscaling** — and the upscaling half is *identity only*. The software can say which upscaler is executing, and whether Ray Reconstruction is active alongside it; it cannot yet say at what quality preset or at what render resolution. No ray-tracing or pipeline hook exists yet, and video-memory usage is not read. The list describes what the software is designed to observe, and the boundary — API arguments and nothing else — holds for all of it. See the accuracy audit at the top.
|
||||
> **What of that list is observed today is stated once, in §4 below** (the block `legal/ACCURACY.md` carries, dated). The list here describes what the software is designed to observe, and the boundary — API arguments and nothing else — holds for all of it.
|
||||
|
||||
**What it never does:** read or write the game's memory outside those API arguments; read save files, input, chat, or network traffic; modify game behavior; hide itself from any security software; or install a kernel driver of its own.
|
||||
|
||||
@@ -55,7 +53,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; the one exception is the per-game bypass described in §2A, which only you can turn on, one game at a time. 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.
|
||||
|
||||
@@ -81,6 +79,34 @@ 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. The guard bypass — entirely at your own risk
|
||||
|
||||
Since version 0.1.0-beta.3 each game's page has a switch labelled **"Bypass the anti-cheat guard (at your own risk)"**.
|
||||
It is **off by default**, it applies to that one game only, and there is no way to turn it on for all games at once.
|
||||
|
||||
Turning it on tells FrameLedger to inject into that game **even where its checks find anti-cheat or anti-tamper
|
||||
software** — that is, in exactly the situation §2 says can get an account banned. The checks still run and what they
|
||||
found is still recorded; they simply no longer stop the injection or the running session for that game. FrameLedger
|
||||
still does nothing to hide itself: it loads under its real name and is fully visible to the anti-cheat.
|
||||
|
||||
**It does not make FrameLedger work everywhere.** Several anti-cheat systems protect the game's process so that no
|
||||
other program can open it. FrameLedger cannot measure such a game with or without the bypass, it says so when that
|
||||
happens, and it will never try to get around another product's protection. Turning the bypass on for such a game
|
||||
gains you nothing and still marks your intent to load software into it.
|
||||
|
||||
You can turn it on only by accepting a warning inside the application, by **both** ticking a statement and typing a
|
||||
word. **BY TURNING IT ON YOU ACCEPT THE ENTIRE RISK YOURSELF.** The developer and the contributors accept **no
|
||||
responsibility and no liability whatsoever** for anything that happens on your side as a result — including, without
|
||||
limitation, an account that is flagged, suspended or **permanently banned** (in that game or in others from the same
|
||||
publisher or platform), purchases, progress or data that are lost, a game that crashes or will not start, or any
|
||||
dispute with a publisher or platform under their terms of service. Nobody can undo a ban for you.
|
||||
|
||||
Every session started with the bypass on is permanently marked as such in the application and in every export,
|
||||
together with what the checks found. The bypass turns itself off when you turn hooking off for the game or when the
|
||||
game's executable changes.
|
||||
|
||||
**If you are not certain, leave it off.**
|
||||
|
||||
## 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.**
|
||||
@@ -89,15 +115,95 @@ 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**:
|
||||
|
||||
> **Frame timing is measured today, and so are two of the settings.** Which upscaler is executing, and whether Ray Reconstruction is running with it, are read from the arguments the game passes — for titles that go through Streamline. **The rest are not measured at all yet**: quality preset, render resolution, frame generation and ray tracing have no hook behind them. Where a value has not been measured the software marks it as unmeasured rather than reporting a zero, so it will read `N/A` and never a confident wrong answer — including for a title whose upscaler runs by a route this hook cannot see, which reports `unknown` rather than "none". See the accuracy audit at the top.
|
||||
<!-- accuracy-block:begin -->
|
||||
> ⚠ **What FrameLedger actually measures today — 2026-09-21.** The software is a beta; its latest
|
||||
> **pre-release is `0.1.0-beta.4`** (2026-09-21), 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 (or,
|
||||
> for a game whose guard bypass you turned on yourself, past your own acceptance of that risk), and
|
||||
> stores sessions in a local database. What that path measures:
|
||||
>
|
||||
> - **Frame times and output resolution:** measured from the present call for Direct3D 11/12 and
|
||||
> OpenGL titles FrameLedger injects into. Vulkan titles are measured only when FrameLedger itself
|
||||
> starts the game with its Vulkan layer enabled, which today only the Agent's command-line launch
|
||||
> does. A Vulkan title started any other way is not observed by the layer; FrameLedger injects its
|
||||
> Direct3D component into it instead, and what that records on a Vulkan title has not been
|
||||
> verified. Direct3D 9 and every 32-bit title are not measured.
|
||||
> - **Which upscaler is running:** measured from the API a Direct3D title calls — DLSS or NIS through
|
||||
> NVIDIA Streamline (with Ray Reconstruction Yes/No), and FSR through AMD's shipped FidelityFX DLLs:
|
||||
> named FSR 3 from the older DLLs, and FSR without a version from the newer ones, which host both
|
||||
> FSR 3.1 and FSR 4. FSR 2, and FSR shipped any other way, is not identified. For DLSS titles that
|
||||
> bypass Streamline, the NVIDIA driver's own per-process record is stored with the session, labelled
|
||||
> *driver-reported*; the app does not display it yet. Intel XeSS is **not** read (its SDK licence
|
||||
> 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
|
||||
> DLSS options a Streamline title passes with its per-frame call — has not been seen on a real
|
||||
> title, and AMD's per-frame call carries no preset.
|
||||
> - **Render → output resolution:** measured where the vendor's own per-frame call carries the render
|
||||
> size (AMD FidelityFX dispatches, and Streamline titles whose resource tags state it); `N/A` where it
|
||||
> does not: DLSS titles that bypass Streamline, Streamline titles whose tags carry no size, and Vulkan
|
||||
> and OpenGL titles.
|
||||
> - **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. 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.
|
||||
> - **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.
|
||||
> - **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), 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 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 one override, and only one:** a per-game
|
||||
> "bypass the anti-cheat guard" switch, off by default, that you can turn on only by accepting its own
|
||||
> warning (a tick and a typed word). With it on, FrameLedger injects into that game even where the
|
||||
> checks find anti-cheat, the 30 s re-check no longer stops the capture for that finding, and every
|
||||
> session started that way is marked. It never changes HOW FrameLedger injects: nothing is hidden.
|
||||
>
|
||||
> 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
|
||||
> yours. The software never substitutes an estimate.
|
||||
<!-- accuracy-block:end -->
|
||||
|
||||
- Frame timing: typically better than 0.05% error; hardware sensors carry their own accuracy limits (±1–2 °C is normal).
|
||||
- 1% Low and 0.1% Low are statistical and are hidden when the sample size is insufficient.
|
||||
- Path tracing has no reliable technical signature; FrameLedger reports it as a confidence-scored suggestion only and never asserts it.
|
||||
- Path tracing has no reliable technical signature; FrameLedger reports it as `N/A` and never asserts it. *(This line promised a confidence-scored suggestion; none is computed. Corrected 2026-09-15.)*
|
||||
- When measurement is unavailable (no-injection mode, unsupported API, missing vendor support), fields read `N/A`. FrameLedger does not substitute estimates for measurements.
|
||||
|
||||
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.
|
||||
@@ -110,6 +216,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.1 · **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. It provides exactly one means to override that refusal: a per-game "bypass the anti-cheat guard" switch, off by default, which you can turn on only by accepting a separate in-application warning by two distinct acts (Disclaimer §2A). **If you turn it on, you do so entirely at your own risk, and the Developer accepts no responsibility or liability for any consequence**, including a suspended or permanently banned account.
|
||||
|
||||
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.
|
||||
|
||||
+10
-11
@@ -1,6 +1,6 @@
|
||||
# FrameLedger — Privacy Policy
|
||||
|
||||
**Version:** 2.0-draft · **Effective:** {{RELEASE_DATE}}
|
||||
**Version:** 2.2 · **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).
|
||||
- Your game library entries (names, executable paths, 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.
|
||||
- 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: the "Safety list update" and "Detection-rules update" rows describe outbound requests the software does not make.** There is no 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
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# FrameLedger — Third-Party Notices
|
||||
|
||||
FrameLedger is licensed under **GPL-3.0-only**. It includes or depends on the third-party components below, each under its own license. All listed licenses are compatible with distribution alongside/within a GPL-3.0 application. Full license texts must be shipped in `legal/licenses/` in release packages. Populating that directory is a P4 task, driven by a license-gathering script and enforced at build time by `tools/license-check` (`docs/12_BUILD.md` §Local quality gate).
|
||||
FrameLedger is licensed under **GPL-3.0-only**. It includes or depends on the third-party components below, each under its own license. All listed licenses are compatible with distribution alongside/within a GPL-3.0 application. Full license texts must be shipped in `legal/licenses/` in release packages. Populating that directory was a P4 task, driven by a license-gathering script and enforced at build time by `tools/license-check` (`docs/12_BUILD.md` §Local quality gate) — **built 2026-09-15 (P4 PR-6):** `tools/license-gather.ps1` writes one text per NuGet package the App and the Agent ship into `legal/licenses/nuget/` (the list, `INDEX.md`, is read from the build's restore output, not from this table), the gate fails when that directory is not what the script writes, and a release carries the directory plus the .NET runtime's own licence and notices (`release.yml`).
|
||||
|
||||
> ⚠ **Bundling audit — last checked 2026-08-05.** Two rows below claimed material
|
||||
> this repository does not contain, and the licence gate could not have caught
|
||||
@@ -32,18 +32,23 @@ FrameLedger is licensed under **GPL-3.0-only**. It includes or depends on the th
|
||||
*(The **Intel PresentMon** row was removed on 2026-08-27. It is not bundled, not fetched, not redistributed and no longer used at all — §S31 retired it as a measurement oracle and the owner then dropped it outright — so a notice for it would be over-disclosure, which this document treats as a defect in the same way an omission is. `tools/license-check.ps1`'s matching claim was removed in the same commit, because a bidirectional check whose subject no longer exists cannot go green honestly: it would be asserting agreement about nothing.)*
|
||||
| Vulkan headers / loader interfaces | `FrameLedger.VkLayer` implicit layer | Apache-2.0 | Khronos headers; layer implemented against the documented loader–layer interface |
|
||||
| LibreHardwareMonitorLib | GPU sensors (all vendors) + CPU/motherboard sensors (optional, elevated) | MPL-2.0 | See §GPU telemetry below. Consumed unmodified |
|
||||
| WPF UI (`Wpf.Ui`, lepoco) | Fluent UI theme/controls/navigation | MIT | © lepo.co, Leszek Pomianowski and contributors. License copy must ship with the app (MIT requirement) |
|
||||
| WPF UI (`Wpf.Ui`, lepoco) | Fluent UI theme/controls/navigation | MIT | © lepo.co, Leszek Pomianowski and contributors. License copy must ship with the app (MIT requirement) — `legal/licenses/nuget/WPF-UI.txt`, the package's own LICENSE.md |
|
||||
| Fluent UI System Icons | Icon font bundled inside WPF UI | MIT | © Microsoft. Segoe Fluent Icons is **not** bundled (its EULA forbids redistribution) and must not be used |
|
||||
| CommunityToolkit.Mvvm | MVVM framework | MIT | |
|
||||
| ScottPlot 5 | Charts | MIT | |
|
||||
| Serilog (+ file sink) | Logging | Apache-2.0 | |
|
||||
| Velopack | Installer/updater | MIT | |
|
||||
| Velopack | Installer/updater | MIT | © Velopack Ltd. (the package's copyright field). Referenced by the App since 2026-09-14 (P4 PR-5); the package ships no licence file, so the text is `legal/licenses/nuget/Velopack.txt` |
|
||||
| Microsoft.Data.Sqlite / SQLitePCLraw | Database | MIT / Apache-2.0 | SQLite itself: public domain |
|
||||
| Dapper | Data access | Apache-2.0 | |
|
||||
| CsWin32 (build-time) | Win32 interop source generator | MIT | Build-time only |
|
||||
| NVIDIA NVAPI SDK | NVIDIA GPU telemetry + Reflex latency | MIT | **Vendored 2026-08-05** — nine headers + `amd64/nvapi64.lib`, at `src/native/third_party/nvapi/`. See §GPU telemetry below |
|
||||
| H.NotifyIcon.Wpf | Tray icon | MIT | |
|
||||
| **Transitive, under LibreHardwareMonitorLib** — BlackSharp.Core, DiskInfoToolkit, RAMSPDToolkit-NDD | Hardware access helpers LHM 0.9.6 depends on | MPL-2.0 | Not named by this table until 2026-09-15. **Exhibit B clear:** authenticated code search of each upstream repository (Blacktempel/BlackSharp, /DiskInfoToolkit, /RAMSPDToolkit) finds the sentence once, in `LICENSE` — the template — and no source file carries an MPL notice at all, so the repository licence governs and §3.3 Secondary Licenses applies. Default branch as searched; the nuspecs pin commits `c70b735c`, `25319eae`, `3b47b960`. Source Code Form links are in each package's text |
|
||||
| **Transitive, under LibreHardwareMonitorLib** — HidSharp; Mono.Posix.NETStandard; System.IO.Ports, System.Management, System.CodeDom, System.IO.FileSystem.AccessControl | USB HID, POSIX helpers, serial ports, WMI | Apache-2.0 (HidSharp's LICENSE.txt); MIT (Mono's LICENSE, reviewed override); MIT (Microsoft) | Mono.Posix.NETStandard declares only a URL; its text is the Mono LICENSE file that URL resolves to, fetched 2026-09-15 and committed as `tools/license-overrides/Mono.Posix.NETStandard.txt` |
|
||||
| **Transitive, under ScottPlot.WPF** — SkiaSharp, HarfBuzzSharp and their Win32 native assets; OpenTK 4.x; OpenTK.GLWpfControl; OpenTK.redist.glfw | 2-D rendering, text shaping, OpenGL host | MIT; GLFW is zlib (its COPYING.md) | The native Skia and HarfBuzz builds carry their own third-party notices, shipped once each in `legal/licenses/nuget/notices-*.txt`. OpenTK.GLWpfControl declares only a URL (reviewed override, like Mono.Posix) |
|
||||
| **Transitive** — Microsoft.Extensions.* (Hosting, DependencyInjection, Logging, Configuration, Options, …), Serilog.Extensions.*, Serilog.Sinks.Console, SQLite (SourceGear's native build), SQLitePCLRaw.* | Host, DI, logging plumbing; the SQLite engine | MIT; Apache-2.0; SQLite is public domain | The complete, versioned list is `legal/licenses/nuget/INDEX.md` — 77 packages on 2026-09-15 |
|
||||
| Roslynator, Meziantou.Analyzer, VS Threading Analyzers (build-time) | Static analysis | Apache-2.0 / MIT | Build-time only |
|
||||
| **Test-time only, never shipped** — xUnit.net v3 4.x (`xunit.v3.mtp-off`, `xunit.runner.visualstudio`), Microsoft.NET.Test.Sdk, coverlet.collector, FluentAssertions 7.x, NSubstitute; Catch2 (native) | Unit and integration tests, coverage | Apache-2.0 (xUnit.net, <https://github.com/xunit/xunit>; FluentAssertions **7.x only**) · MIT (Test.Sdk, coverlet) · BSD-3-Clause (NSubstitute) · BSL-1.0 (Catch2) | Not named by this table until 2026-09-21. None of them is in a published package: `12_BUILD` publishes App and Agent only, `tools/package-closure-check.ps1` keeps the test projects out of that closure, and `legal/licenses/nuget/` therefore lists none of them. xUnit.net moved 3.2.2 → 4.0.1 on 2026-09-21, same licence. **FluentAssertions is pinned to `[7.2.2]` on purpose**: 8.x is Xceed's Community Licence, not an OSI licence (`Directory.Packages.props`, `20_OPEN_QUESTIONS` §G). Catch2's text is `legal/licenses/catch2-BSL-1.0.txt` |
|
||||
|
||||
## GPU telemetry — what is bundled and what is not
|
||||
|
||||
@@ -51,12 +56,13 @@ Telemetry is layered so no proprietary vendor licence is ever required (`docs/18
|
||||
|
||||
| Component | How we use it | Licence | Bundled? |
|
||||
|---|---|---|---|
|
||||
| **NVIDIA NVAPI SDK** (headers, interface definitions, `nvapi64.lib`) | Planned: NVIDIA-only telemetry, throttle reasons, Reflex/PC latency. **No code links it yet** — the `fl_nvapi` target exists and nothing consumes it | **MIT** — <https://github.com/NVIDIA/nvapi> @ `cd6918f6` (2026-06-24) | **Vendored 2026-08-05** at `src/native/third_party/nvapi/`: nine headers (`nvapi.h` and its include closure, plus `nvapi_interface.h`), `License.txt`, and `amd64/nvapi64.lib` — **x64 only**, `x86/nvapi.lib` deliberately not taken. **Verified 2026-08-02 and re-verified on the vendored copy:** `License.txt` opens "nvapi.lib and nvapi64.lib are licensed under the following terms" + `SPDX-License-Identifier: MIT`, so the grant names the import libraries explicitly and the binary is covered rather than only the headers. Every vendored header retains its own SPDX MIT block, which `license-check.ps1` asserts file by file |
|
||||
| **NVIDIA NVAPI SDK** (headers, interface definitions, `nvapi64.lib`) | NVIDIA-only telemetry — temperatures, GPU-domain utilisation, clocks, fan, throttle reasons, PCIe width, driver version, and the driver's per-process NGX words. ~~**No code links it yet** — the `fl_nvapi` target exists and nothing consumes it~~ **Linked by `FrameLedger.NvapiBridge.dll` since 2026-09-10** (P2 PR-E2): the only shipped binary that links `nvapi64.lib`, loaded by the Agent into its own process and never into a game; the unshipped `fl-probe-nvapi` links it too. Reflex/PC latency is a hook fact, not an NVAPI query (`docs/20_OPEN_QUESTIONS` §M8) | **MIT** — <https://github.com/NVIDIA/nvapi> @ `cd6918f6` (2026-06-24) | **Vendored 2026-08-05** at `src/native/third_party/nvapi/`: nine headers (`nvapi.h` and its include closure, plus `nvapi_interface.h`), `License.txt`, and `amd64/nvapi64.lib` — **x64 only**, `x86/nvapi.lib` deliberately not taken. **Verified 2026-08-02 and re-verified on the vendored copy:** `License.txt` opens "nvapi.lib and nvapi64.lib are licensed under the following terms" + `SPDX-License-Identifier: MIT`, so the grant names the import libraries explicitly and the binary is covered rather than only the headers. Every vendored header retains its own SPDX MIT block, which `license-check.ps1` asserts file by file |
|
||||
| `nvapi64.dll` (runtime implementation) | Loaded at runtime from the user's system | Part of the NVIDIA graphics driver | No — never redistributed by us |
|
||||
| **LibreHardwareMonitorLib** | GPU sensors for **all vendors** (AMD, Intel, NVIDIA) + CPU/board sensors when elevated | **MPL-2.0** | Yes, as an unmodified NuGet package |
|
||||
| **DXGI + Windows performance counters (PDH)** | Vendor-neutral baseline: utilisation, VRAM, adapter identity | Windows OS APIs | n/a |
|
||||
| **NVIDIA Streamline headers** (`sl.h`, its eight-file include closure, and `sl_dlss.h`) | Declarations only — `sl::Feature`, the `kFeature*` ids and `PFun_slEvaluateFeature` — so the Overlay's upscaler hook has the vendor's own signature instead of a hand-written guess. **Types and `decltype` only: never linked**, or `sl.interposer.dll` would become a load-time dependency and the Overlay would fail to load in every game that ships no Streamline | **MIT** — <https://github.com/NVIDIA-RTX/Streamline>, `main`, 2026-08-09 | **Vendored 2026-08-09** at `src/native/third_party/streamline/`: `license.txt` and ten headers. **`sl_nvperf.h` is excluded** — the same `license.txt` carries a second, proprietary "NSight Perf SDK License, Version 2023.3" block naming `sl_nvperf.h` and `sl_nvperf.dll`. **All of `external/` is excluded** — upstream's `external/ngx-sdk/` is the RTX SDKs Licence. `license-check.ps1` asserts both exclusions and the grant text |
|
||||
| **AMD FidelityFX SDK headers** (`ffx_api.h`, `ffx_api_types.h`, `ffx_upscale.h`, `ffx_framegeneration.h`, `ffx_framegeneration_api_types.h`) | Declarations only — `ffxApiHeader::type`, the `FFX_API_*_DESC_TYPE_*` values, `ffxDispatchDescUpscale::renderSize`, the frame-generation `Prepare` descriptors' `frameID` and `PfnFfxDispatch` — so the Overlay's AMD hook decodes the dispatch descriptor by the vendor's own layout instead of a guess. **Types only: never linked**, and the Overlay defines none of the names the header declares `dllexport` (`hookinventory-check` Pass C reads its export table) | **MIT, by exception** — <https://github.com/GPUOpen-LibrariesAndSDKs/FidelityFX-SDK> tag `v2.3.0` (`60f4ea81`, 2026-06-24). Upstream's `docs/license.md` is a binary-only default licence followed by an MIT exception list; on 2026-09-04 that list named all 845 files in the tree, these five among them, and each header carries the grant in its own banner | **Vendored 2026-09-04** at `src/native/third_party/fidelityfx/`: `license.md` verbatim (exception list included) and five headers in upstream's `Kits/FidelityFX/…` layout. **No `signedbin/`, no `.lib`, no source, no `dx12/` backend headers** (no consumer yet). `license-check.ps1` §2d asserts every vendored path is on the exception list and every header carries the grant |
|
||||
| **AMD FidelityFX SDK 3.0 host headers** (`ffx_fsr3.h` and its nine-file include closure: `ffx_interface.h`, `ffx_fsr3upscaler.h`, `ffx_frameinterpolation.h`, `ffx_opticalflow.h`, `ffx_assert.h`, `ffx_types.h`, `ffx_error.h`, `ffx_util.h`, `gpu/fsr3upscaler/ffx_fsr3upscaler_resources.h`) | Declarations only — `FfxFsr3DispatchUpscaleDescription::renderSize` and the type of `ffxFsr3ContextDispatchUpscale` — so the Overlay's hook on the FSR 3.0 **host** DLL (`ffx_fsr3_x64.dll`, Cyberpunk 2077's copy, which upscales through named exports rather than the ffx-api facade) reads the render extent by the vendor's own layout. **Types and `decltype` only: never linked**, and the Overlay defines none of the names the header declares `dllexport` (`hookinventory-check` Pass C reads its export table; the `ffx_fsr3_x64.dll` fixture in `tools/vendor-stubs` is that parser's second positive control) | **MIT** — <https://github.com/GPUOpen-LibrariesAndSDKs/FidelityFX-SDK> tag `fsr3-v3.0.4` (`55ff22bb`). The root `LICENSE.txt` at that tag is the MIT grant verbatim and every header carries it inline — a different licence *shape* from the `v2.3.0` row above, which is why it is a separate directory and `license-check.ps1` §2e rather than §2d. The tag is the one whose declarations match the module the title ships (twelve `ffxFsr3*` exports); `v1.1.4`, which the docs first named, declares three more and appends fields to the dispatch descriptor | **Vendored 2026-09-05** at `src/native/third_party/fidelityfx-fsr3/`: `LICENSE.txt` verbatim and ten headers in upstream's `sdk/include/FidelityFX/…` layout, each blob sha checked against the upstream tree. **No backends, no `.cpp`, no shaders, no samples.** `license-check.ps1` §2e asserts the root grant and every header's banner, file by file. Same MIT text as the row above, so `legal/licenses/fidelityfx-MIT.txt` is the notice for both |
|
||||
| NVIDIA **NGX** / **Streamline**, AMD **FidelityFX**, Intel **XeSS** **runtimes** (the DLLs themselves) | Not loaded, not linked, not redistributed. We observe the calls a *game* makes to the copies it ships (`docs/17_HOOK_ENGINE.md`). Unchanged by the row above, which vendors **headers** and no runtime | — | **No vendor upscaler code is distributed by FrameLedger** |
|
||||
|
||||
### GPL-3.0 compatibility
|
||||
@@ -88,15 +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)
|
||||
|
||||
- [ ] `legal/licenses/` contains full texts: MIT (per-project copies, **including `nvapi-MIT.txt`**), BSD-2-Clause (MinHook), MPL-2.0, Apache-2.0
|
||||
- [ ] About → Third-party tab lists this table with versions filled from `Directory.Packages.props`
|
||||
- [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` — **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
|
||||
- [ ] MPL-2.0 source-availability note points to upstream LibreHardwareMonitor repository
|
||||
- [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
|
||||
+23
-23
@@ -1,29 +1,29 @@
|
||||
# Third-party licence texts
|
||||
|
||||
Full licence texts for everything FrameLedger bundles or links. Populated at P4
|
||||
by a licence-gathering script; `tools/license-check.ps1` fails the build if a
|
||||
vendored component is present here without its licence copy.
|
||||
Full licence texts for everything FrameLedger bundles or links. The App's publish carries this directory as
|
||||
`licenses/` beside the executables; `release.yml` adds `licenses/dotnet/` (the .NET runtime's licence and
|
||||
third-party notices, from the runtime packs that publish used).
|
||||
|
||||
Required before the first release
|
||||
(`legal/THIRD_PARTY_NOTICES.md` §Attribution requirements checklist):
|
||||
| Path | What it is | Who writes it |
|
||||
|---|---|---|
|
||||
| `nuget/` | One text per NuGet package the App and the Agent ship (77 on 2026-09-15), the distinct third-party notice files those packages carry (`notices-*.txt`), and `INDEX.md` | **Generated** by `tools/license-gather.ps1` from the build's restore output — never edited by hand; `tools/license-check.ps1` §3 fails when it differs |
|
||||
| `apache-2.0.txt` | The Apache-2.0 text: the Vulkan headers, and every Apache-2.0 package in `nuget/` that ships no licence file of its own | Hand-committed |
|
||||
| `mpl-2.0.txt` | The MPL-2.0 text: LibreHardwareMonitorLib and its three MPL-2.0 dependencies (their packages ship no licence file, so distributing it is our obligation, §3.1) | Hand-committed; `license-check` §2b requires it |
|
||||
| `minhook-BSD-2-Clause.txt` | MinHook — vendored and built from source | Hand-committed; §2 |
|
||||
| `nvapi-MIT.txt` | NVIDIA NVAPI SDK — headers + import library vendored | Hand-committed; §2 |
|
||||
| `streamline-MIT.txt`, `fidelityfx-MIT.txt` | NVIDIA Streamline headers; AMD FidelityFX headers (2.x and 3.0 host) | Hand-committed; §2b, §2d, §2e |
|
||||
| `jsmn-MIT.txt`, `catch2-BSL-1.0.txt` | jsmn (built into the Overlay); Catch2 (tests only) | Hand-committed; §2 |
|
||||
|
||||
| File | Component |
|
||||
|---|---|
|
||||
| `minhook-BSD-2-Clause.txt` | MinHook — vendored and built from source |
|
||||
| `nvapi-MIT.txt` | NVIDIA NVAPI SDK — headers + import library vendored |
|
||||
| `wpfui-MIT.txt` | WPF UI (lepoco) — MIT requires the notice to ship |
|
||||
| `librehardwaremonitor-MPL-2.0.txt` | LibreHardwareMonitorLib, consumed unmodified |
|
||||
| `apache-2.0.txt` | Serilog, Dapper, the analyzers, Vulkan headers |
|
||||
| `mit.txt` | Shared text for the MIT-licensed NuGet packages |
|
||||
`wpfui-MIT.txt` (2026-09-14) and `velopack-MIT.txt` (2026-09-14) were hand copies of texts the generator now
|
||||
writes as `nuget/WPF-UI.txt` and `nuget/Velopack.txt`; they were removed with P4 PR-6 so each package has one
|
||||
source. ~~`librehardwaremonitor-MPL-2.0.txt`~~ and ~~`mit.txt`~~ were planned names in this file that never
|
||||
existed: the MPL text is `mpl-2.0.txt`, and MIT is written per package because its notice names the holder.
|
||||
|
||||
Two of these are release-blocking questions, not paperwork
|
||||
(`docs/20_OPEN_QUESTIONS.md` §M3, §M4):
|
||||
~~Two of these are release-blocking questions, not paperwork~~ — **both came back clean on 2026-08-02**
|
||||
(`docs/spike-notes.md` §M3, §M4; `docs/20_OPEN_QUESTIONS.md` records them resolved):
|
||||
|
||||
- **NVAPI** — confirm the exact vendored artifact is MIT, *including*
|
||||
`nvapi64.lib`. The import library may not be covered by the same grant as the
|
||||
headers. If it is not, Reflex / PC latency has no alternative source.
|
||||
- **LibreHardwareMonitor** — confirm no depended-upon file carries MPL-2.0
|
||||
**Exhibit B** ("Incompatible With Secondary Licenses"), which would remove the
|
||||
GPL-compatibility route and leave no sensor layer for any vendor.
|
||||
|
||||
Answer both before writing NVAPI or LHM code, not after.
|
||||
- **NVAPI** — the vendored artifact, `nvapi64.lib` included, is MIT.
|
||||
- **LibreHardwareMonitor** — no depended-upon file applies MPL-2.0 **Exhibit B**, so the GPL-compatibility route
|
||||
holds. The three MPL-2.0 packages LHM 0.9.6 pulls in (BlackSharp.Core, DiskInfoToolkit, RAMSPDToolkit-NDD) were
|
||||
not part of that search; they were checked the same way on 2026-09-15 and are recorded in
|
||||
`legal/THIRD_PARTY_NOTICES.md`. A version bump of any of them is a new search, not an inherited answer.
|
||||
@@ -0,0 +1,17 @@
|
||||
BlackSharp.Core 1.0.7
|
||||
|
||||
Licence declared: MPL-2.0
|
||||
Text below: the shared MPL-2.0 text; the package ships no licence file
|
||||
Copyright: Florian K.
|
||||
Authors: BlackSharp.Core
|
||||
Project: https://github.com/Blacktempel/BlackSharp
|
||||
Ships in: Agent, App
|
||||
MPL-2.0 Exhibit B: not found in the package's 2 text file(s); the package ships no source, so the upstream repository is where it would have to be ruled out
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
Subject to the terms of the Mozilla Public License, Version 2.0. The full text is mpl-2.0.txt in the directory above this one.
|
||||
|
||||
Source Code Form (MPL-2.0 section 3.2): https://github.com/Blacktempel/BlackSharp
|
||||
|
||||
Copyright: Florian K.
|
||||
@@ -0,0 +1,25 @@
|
||||
CommunityToolkit.Mvvm 8.4.2
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: License.md, verbatim from the package
|
||||
Copyright: (c) .NET Foundation and Contributors. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://github.com/CommunityToolkit/dotnet
|
||||
Ships in: App
|
||||
Third-party notices: notices-79498b27081b.txt (ThirdPartyNotices.txt)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
# .NET Community Toolkit
|
||||
|
||||
Copyright © .NET Foundation and Contributors
|
||||
|
||||
All rights reserved.
|
||||
|
||||
## MIT License (MIT)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
@@ -0,0 +1,14 @@
|
||||
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://dapperlib.dev/
|
||||
Ships in: Agent, App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
Licensed under the Apache License, Version 2.0. The full text is apache-2.0.txt in the directory above this one.
|
||||
|
||||
Copyright: 2019 Stack Exchange, Inc.
|
||||
@@ -0,0 +1,17 @@
|
||||
DiskInfoToolkit 1.1.2
|
||||
|
||||
Licence declared: MPL-2.0
|
||||
Text below: the shared MPL-2.0 text; the package ships no licence file
|
||||
Copyright: Florian K.
|
||||
Authors: DiskInfoToolkit
|
||||
Project: https://github.com/Blacktempel/DiskInfoToolkit
|
||||
Ships in: Agent, App
|
||||
MPL-2.0 Exhibit B: not found in the package's 2 text file(s); the package ships no source, so the upstream repository is where it would have to be ruled out
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
Subject to the terms of the Mozilla Public License, Version 2.0. The full text is mpl-2.0.txt in the directory above this one.
|
||||
|
||||
Source Code Form (MPL-2.0 section 3.2): https://github.com/Blacktempel/DiskInfoToolkit
|
||||
|
||||
Copyright: Florian K.
|
||||
@@ -0,0 +1,32 @@
|
||||
H.GeneratedIcons.System.Drawing 2.4.1
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: not stated by the package
|
||||
Authors: havendv
|
||||
Project: https://github.com/HavenDV/H.NotifyIcon
|
||||
Ships in: App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: not stated by the package (authors: havendv)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,32 @@
|
||||
H.NotifyIcon.Wpf 2.4.1
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: not stated by the package
|
||||
Authors: havendv
|
||||
Project: https://github.com/HavenDV/H.NotifyIcon
|
||||
Ships in: App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: not stated by the package (authors: havendv)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,32 @@
|
||||
H.NotifyIcon 2.4.1
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: not stated by the package
|
||||
Authors: havendv
|
||||
Project: https://github.com/HavenDV/H.NotifyIcon
|
||||
Ships in: App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: not stated by the package (authors: havendv)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,31 @@
|
||||
HarfBuzzSharp.NativeAssets.Win32 8.3.1.1
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: LICENSE.txt, verbatim from the package
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://go.microsoft.com/fwlink/?linkid=868515
|
||||
Ships in: App
|
||||
Third-party notices: notices-78954f26302a.txt (THIRD-PARTY-NOTICES.txt)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
Copyright (c) 2015-2016 Xamarin, Inc.
|
||||
Copyright (c) 2017-2018 Microsoft Corporation.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
@@ -0,0 +1,30 @@
|
||||
HarfBuzzSharp 8.3.1.1
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: LICENSE.txt, verbatim from the package
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://go.microsoft.com/fwlink/?linkid=868515
|
||||
Ships in: App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
Copyright (c) 2015-2016 Xamarin, Inc.
|
||||
Copyright (c) 2017-2018 Microsoft Corporation.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
@@ -0,0 +1,203 @@
|
||||
HidSharp 2.6.4
|
||||
|
||||
Licence declared: the file LICENSE.txt in the package
|
||||
Text below: LICENSE.txt, verbatim from the package
|
||||
Copyright: Copyright 2010-2025 James Bellinger
|
||||
Authors: James F. Bellinger
|
||||
Project: https://software.seekye.com/hidsharp
|
||||
Ships in: Agent, App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
HIDSharp
|
||||
Copyright 2010-2025 James F. Bellinger <http://software.seekye.com/hidsharp>
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
@@ -0,0 +1,86 @@
|
||||
# Packages the App and the Agent ship
|
||||
|
||||
Generated by `tools/license-gather.ps1` from the restore output of the two publish roots. Do not edit a
|
||||
file here by hand: `tools/license-check.ps1` fails when this directory differs from what the script writes.
|
||||
The .NET runtime a self-contained package carries is not listed; `release.yml` copies its licence and notices
|
||||
from the runtime packs the publish used.
|
||||
|
||||
| Package | Version | Licence | Ships in | Text |
|
||||
|---|---|---|---|---|
|
||||
| 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.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) |
|
||||
| H.NotifyIcon.Wpf | 2.4.1 | MIT | App | [H.NotifyIcon.Wpf.txt](H.NotifyIcon.Wpf.txt) |
|
||||
| HarfBuzzSharp | 8.3.1.1 | MIT | App | [HarfBuzzSharp.txt](HarfBuzzSharp.txt) |
|
||||
| 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.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) |
|
||||
| OpenTK.Core | 4.9.4 | MIT | App | [OpenTK.Core.txt](OpenTK.Core.txt) |
|
||||
| OpenTK.GLWpfControl | 4.3.3 | a URL only: https://github.com/varon/GLWpfControl/blob/master/LICENSE.md | App | [OpenTK.GLWpfControl.txt](OpenTK.GLWpfControl.txt) |
|
||||
| OpenTK.Graphics | 4.9.4 | MIT | App | [OpenTK.Graphics.txt](OpenTK.Graphics.txt) |
|
||||
| OpenTK.Input | 4.9.4 | MIT | App | [OpenTK.Input.txt](OpenTK.Input.txt) |
|
||||
| OpenTK.Mathematics | 4.9.4 | MIT | App | [OpenTK.Mathematics.txt](OpenTK.Mathematics.txt) |
|
||||
| OpenTK.redist.glfw | 3.4.0.44 | the file COPYING.md in the package | App | [OpenTK.redist.glfw.txt](OpenTK.redist.glfw.txt) |
|
||||
| OpenTK.Windowing.Common | 4.9.4 | MIT | App | [OpenTK.Windowing.Common.txt](OpenTK.Windowing.Common.txt) |
|
||||
| OpenTK.Windowing.Desktop | 4.9.4 | MIT | App | [OpenTK.Windowing.Desktop.txt](OpenTK.Windowing.Desktop.txt) |
|
||||
| OpenTK.Windowing.GraphicsLibraryFramework | 4.9.4 | MIT | App | [OpenTK.Windowing.GraphicsLibraryFramework.txt](OpenTK.Windowing.GraphicsLibraryFramework.txt) |
|
||||
| RAMSPDToolkit-NDD | 1.4.2 | MPL-2.0 | Agent, App | [RAMSPDToolkit-NDD.txt](RAMSPDToolkit-NDD.txt) |
|
||||
| ScottPlot | 5.1.59 | MIT | App | [ScottPlot.txt](ScottPlot.txt) |
|
||||
| ScottPlot.WPF | 5.1.59 | MIT | App | [ScottPlot.WPF.txt](ScottPlot.WPF.txt) |
|
||||
| Serilog | 4.4.0 | Apache-2.0 | Agent, App | [Serilog.txt](Serilog.txt) |
|
||||
| Serilog.Extensions.Hosting | 10.0.0 | Apache-2.0 | Agent, App | [Serilog.Extensions.Hosting.txt](Serilog.Extensions.Hosting.txt) |
|
||||
| Serilog.Extensions.Logging | 10.0.0 | Apache-2.0 | Agent, App | [Serilog.Extensions.Logging.txt](Serilog.Extensions.Logging.txt) |
|
||||
| Serilog.Sinks.Console | 6.1.1 | Apache-2.0 | Agent | [Serilog.Sinks.Console.txt](Serilog.Sinks.Console.txt) |
|
||||
| Serilog.Sinks.File | 7.0.0 | Apache-2.0 | Agent, App | [Serilog.Sinks.File.txt](Serilog.Sinks.File.txt) |
|
||||
| SkiaSharp | 3.119.0 | MIT | App | [SkiaSharp.txt](SkiaSharp.txt) |
|
||||
| SkiaSharp.HarfBuzz | 3.119.0 | MIT | App | [SkiaSharp.HarfBuzz.txt](SkiaSharp.HarfBuzz.txt) |
|
||||
| SkiaSharp.NativeAssets.Win32 | 3.119.0 | MIT | App | [SkiaSharp.NativeAssets.Win32.txt](SkiaSharp.NativeAssets.Win32.txt) |
|
||||
| SkiaSharp.Views.Desktop.Common | 3.119.0 | MIT | App | [SkiaSharp.Views.Desktop.Common.txt](SkiaSharp.Views.Desktop.Common.txt) |
|
||||
| SkiaSharp.Views.WPF | 3.119.0 | MIT | App | [SkiaSharp.Views.WPF.txt](SkiaSharp.Views.WPF.txt) |
|
||||
| SQLite | 3.53.4 | the file LICENSE.txt in the package | Agent, App | [SQLite.txt](SQLite.txt) |
|
||||
| SQLitePCLRaw.config.e_sqlite3 | 3.0.5 | Apache-2.0 | Agent, App | [SQLitePCLRaw.config.e_sqlite3.txt](SQLitePCLRaw.config.e_sqlite3.txt) |
|
||||
| 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.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) |
|
||||
| Velopack | 1.2.0 | MIT | App | [Velopack.txt](Velopack.txt) |
|
||||
| WPF-UI | 4.3.0 | MIT | App | [WPF-UI.txt](WPF-UI.txt) |
|
||||
| WPF-UI.Abstractions | 4.3.0 | MIT | App | [WPF-UI.Abstractions.txt](WPF-UI.Abstractions.txt) |
|
||||
| WPF-UI.DependencyInjection | 4.3.0 | MIT | App | [WPF-UI.DependencyInjection.txt](WPF-UI.DependencyInjection.txt) |
|
||||
@@ -0,0 +1,17 @@
|
||||
LibreHardwareMonitorLib 0.9.6
|
||||
|
||||
Licence declared: MPL-2.0
|
||||
Text below: the shared MPL-2.0 text; the package ships no licence file
|
||||
Copyright: LibreHardwareMonitor
|
||||
Authors: LibreHardwareMonitorLib
|
||||
Project: https://github.com/LibreHardwareMonitor/LibreHardwareMonitor
|
||||
Ships in: Agent, App
|
||||
MPL-2.0 Exhibit B: not found in the package's 1 text file(s); the package ships no source, so the upstream repository is where it would have to be ruled out
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
Subject to the terms of the Mozilla Public License, Version 2.0. The full text is mpl-2.0.txt in the directory above this one.
|
||||
|
||||
Source Code Form (MPL-2.0 section 3.2): https://github.com/LibreHardwareMonitor/LibreHardwareMonitor
|
||||
|
||||
Copyright: LibreHardwareMonitor
|
||||
@@ -0,0 +1,32 @@
|
||||
Microsoft.Data.Sqlite.Core 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://docs.microsoft.com/dotnet/standard/data/sqlite/
|
||||
Ships in: Agent, App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Configuration.Abstractions 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Configuration.Binder 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Configuration.CommandLine 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Configuration.EnvironmentVariables 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Configuration.FileExtensions 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Configuration.Json 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Configuration.UserSecrets 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Configuration 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.DependencyInjection.Abstractions 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.DependencyInjection 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Diagnostics.Abstractions 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Diagnostics 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.FileProviders.Abstractions 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.FileProviders.Physical 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.FileSystemGlobbing 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Hosting.Abstractions 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Hosting 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Logging.Abstractions 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Logging.Configuration 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Logging.Console 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Logging.Debug 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Logging.EventLog 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Logging.EventSource 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Logging 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Options.ConfigurationExtensions 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Options 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
Microsoft.Extensions.Primitives 10.0.12
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,32 @@
|
||||
OpenTK.Audio.OpenAL 4.9.4
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: not stated by the package
|
||||
Authors: Team OpenTK
|
||||
Project: https://github.com/opentk/opentk
|
||||
Ships in: App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: not stated by the package (authors: Team OpenTK)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,32 @@
|
||||
OpenTK.Compute 4.9.4
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: not stated by the package
|
||||
Authors: Team OpenTK
|
||||
Project: https://github.com/opentk/opentk
|
||||
Ships in: App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: not stated by the package (authors: Team OpenTK)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,32 @@
|
||||
OpenTK.Core 4.9.4
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: not stated by the package
|
||||
Authors: Team OpenTK
|
||||
Project: https://github.com/opentk/opentk
|
||||
Ships in: App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: not stated by the package (authors: Team OpenTK)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,42 @@
|
||||
OpenTK.GLWpfControl 4.3.3
|
||||
|
||||
Licence declared: a URL only: https://github.com/varon/GLWpfControl/blob/master/LICENSE.md
|
||||
Text below: tools/license-overrides/OpenTK.GLWpfControl.txt, a reviewed copy of the text behind that URL
|
||||
Copyright: Copyright (c) 2022 Team OpenTK.
|
||||
Authors: varon NogginBops
|
||||
Project: https://www.opentk.net
|
||||
Ships in: App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
Reviewed override for OpenTK.GLWpfControl 4.3.3 (tools/license-gather.ps1).
|
||||
|
||||
The package declares no licence expression and no licence file, only
|
||||
<licenseUrl>https://github.com/varon/GLWpfControl/blob/master/LICENSE.md</licenseUrl>. The text below
|
||||
is that file, fetched from https://raw.githubusercontent.com/varon/GLWpfControl/master/LICENSE.md on
|
||||
2026-09-14, verbatim. It is the default branch as of that day, not a copy pinned to the 4.3.3 tag.
|
||||
OpenTK.GLWpfControl arrives transitively under ScottPlot.WPF.
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2019 varon
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,32 @@
|
||||
OpenTK.Graphics 4.9.4
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: not stated by the package
|
||||
Authors: Team OpenTK
|
||||
Project: https://github.com/opentk/opentk
|
||||
Ships in: App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: not stated by the package (authors: Team OpenTK)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,32 @@
|
||||
OpenTK.Input 4.9.4
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: not stated by the package
|
||||
Authors: Team OpenTK
|
||||
Project: https://github.com/opentk/opentk
|
||||
Ships in: App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: not stated by the package (authors: Team OpenTK)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,32 @@
|
||||
OpenTK.Mathematics 4.9.4
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: not stated by the package
|
||||
Authors: Team OpenTK
|
||||
Project: https://github.com/opentk/opentk
|
||||
Ships in: App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: not stated by the package (authors: Team OpenTK)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,32 @@
|
||||
OpenTK.Windowing.Common 4.9.4
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: not stated by the package
|
||||
Authors: Team OpenTK
|
||||
Project: https://github.com/opentk/opentk
|
||||
Ships in: App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: not stated by the package (authors: Team OpenTK)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,32 @@
|
||||
OpenTK.Windowing.Desktop 4.9.4
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: not stated by the package
|
||||
Authors: Team OpenTK
|
||||
Project: https://github.com/opentk/opentk
|
||||
Ships in: App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: not stated by the package (authors: Team OpenTK)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,32 @@
|
||||
OpenTK.Windowing.GraphicsLibraryFramework 4.9.4
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: not stated by the package
|
||||
Authors: Team OpenTK
|
||||
Project: https://github.com/opentk/opentk
|
||||
Ships in: App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: not stated by the package (authors: Team OpenTK)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,33 @@
|
||||
OpenTK.redist.glfw 3.4.0.44
|
||||
|
||||
Licence declared: the file COPYING.md in the package
|
||||
Text below: COPYING.md, verbatim from the package
|
||||
Copyright: not stated by the package
|
||||
Authors: Team OpenTK
|
||||
Project: https://www.glfw.org/
|
||||
Ships in: App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
Copyright (c) 2002-2006 Marcus Geelnard
|
||||
|
||||
Copyright (c) 2006-2019 Camilla Löwy
|
||||
|
||||
This software is provided 'as-is', without any express or implied
|
||||
warranty. In no event will the authors be held liable for any damages
|
||||
arising from the use of this software.
|
||||
|
||||
Permission is granted to anyone to use this software for any purpose,
|
||||
including commercial applications, and to alter it and redistribute it
|
||||
freely, subject to the following restrictions:
|
||||
|
||||
1. The origin of this software must not be misrepresented; you must not
|
||||
claim that you wrote the original software. If you use this software
|
||||
in a product, an acknowledgment in the product documentation would
|
||||
be appreciated but is not required.
|
||||
|
||||
2. Altered source versions must be plainly marked as such, and must not
|
||||
be misrepresented as being the original software.
|
||||
|
||||
3. This notice may not be removed or altered from any source
|
||||
distribution.
|
||||
@@ -0,0 +1,17 @@
|
||||
RAMSPDToolkit-NDD 1.4.2
|
||||
|
||||
Licence declared: MPL-2.0
|
||||
Text below: the shared MPL-2.0 text; the package ships no licence file
|
||||
Copyright: Florian K.
|
||||
Authors: RAMSPDToolkit-NDD
|
||||
Project: https://github.com/Blacktempel/RAMSPDToolkit
|
||||
Ships in: Agent, App
|
||||
MPL-2.0 Exhibit B: not found in the package's 2 text file(s); the package ships no source, so the upstream repository is where it would have to be ruled out
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
Subject to the terms of the Mozilla Public License, Version 2.0. The full text is mpl-2.0.txt in the directory above this one.
|
||||
|
||||
Source Code Form (MPL-2.0 section 3.2): https://github.com/Blacktempel/RAMSPDToolkit
|
||||
|
||||
Copyright: Florian K.
|
||||
@@ -0,0 +1,15 @@
|
||||
SQLite 3.53.4
|
||||
|
||||
Licence declared: the file LICENSE.txt in the package
|
||||
Text below: LICENSE.txt, verbatim from the package
|
||||
Copyright: Copyright 2014-2026 SourceGear, LLC
|
||||
Authors: Eric Sink
|
||||
Project: https://sqlite.org/
|
||||
Ships in: Agent, App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
|
||||
SQLite is Public Domain
|
||||
|
||||
https://sqlite.org/copyright.html
|
||||
@@ -0,0 +1,14 @@
|
||||
SQLitePCLRaw.config.e_sqlite3 3.0.5
|
||||
|
||||
Licence declared: Apache-2.0
|
||||
Text below: the shared Apache-2.0 text; the package ships no licence file
|
||||
Copyright: Copyright 2014-2026 SourceGear, LLC
|
||||
Authors: Eric Sink
|
||||
Project: not stated
|
||||
Ships in: Agent, App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
Licensed under the Apache License, Version 2.0. The full text is apache-2.0.txt in the directory above this one.
|
||||
|
||||
Copyright: Copyright 2014-2026 SourceGear, LLC
|
||||
@@ -0,0 +1,14 @@
|
||||
SQLitePCLRaw.core 3.0.5
|
||||
|
||||
Licence declared: Apache-2.0
|
||||
Text below: the shared Apache-2.0 text; the package ships no licence file
|
||||
Copyright: Copyright 2014-2025 SourceGear, LLC
|
||||
Authors: Eric Sink
|
||||
Project: not stated
|
||||
Ships in: Agent, App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
Licensed under the Apache License, Version 2.0. The full text is apache-2.0.txt in the directory above this one.
|
||||
|
||||
Copyright: Copyright 2014-2025 SourceGear, LLC
|
||||
@@ -0,0 +1,14 @@
|
||||
SQLitePCLRaw.provider.e_sqlite3 3.0.5
|
||||
|
||||
Licence declared: Apache-2.0
|
||||
Text below: the shared Apache-2.0 text; the package ships no licence file
|
||||
Copyright: Copyright 2014-2025 SourceGear, LLC
|
||||
Authors: Eric Sink
|
||||
Project: not stated
|
||||
Ships in: Agent, App
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
Licensed under the Apache License, Version 2.0. The full text is apache-2.0.txt in the directory above this one.
|
||||
|
||||
Copyright: Copyright 2014-2025 SourceGear, LLC
|
||||
Loaded 100 of 1035 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user