Compare commits
70
Commits
beta23/pr4-docs
...
alpha
No files matched your search
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"version": 1,
|
||||
"isRoot": true,
|
||||
"tools": {
|
||||
"dotnet-sonarscanner": {
|
||||
"version": "12.0.0",
|
||||
"commands": [
|
||||
"dotnet-sonarscanner"
|
||||
],
|
||||
"rollForward": false
|
||||
}
|
||||
}
|
||||
}
|
||||
+104
@@ -59,6 +59,94 @@ dotnet_diagnostic.MA0011.severity = warning
|
||||
# and GenerateDocumentationFile is on for the shipping ones.
|
||||
dotnet_diagnostic.CS1591.severity = suggestion
|
||||
|
||||
# --- ReSharper inspections: what Qodana reads (docs/13_CI_CD.md §Qodana, D93) ---
|
||||
# Qodana Community for .NET is ReSharper's InspectCode, and InspectCode reads these keys - so does Rider or ReSharper
|
||||
# in the editor, which is why they are here and not in qodana.yaml: the same list everywhere. An inspection is off
|
||||
# only where it argues with a choice this project made; each line says which. Everything else it reports is fixed.
|
||||
[*.{cs,xaml}]
|
||||
# The compiler's missing-XML-comment warning, already a suggestion above (CS1591): InspectCode reports suggestions.
|
||||
resharper_c_sharp_warnings_cs1591_highlighting = none
|
||||
# Naming is this file's rule and the .NET analyzers'. ReSharper's own scheme would rename product names and units
|
||||
# (OpenGL -> OpenGl, XeSS -> XeSs, Presents5s -> Presents5S) and every Chart_* resource key.
|
||||
resharper_inconsistent_naming_highlighting = none
|
||||
# `x is long v` / `x is > 0 and int v` is how this code unwraps a nullable AND names its type; `{ } v` or `var v`
|
||||
# hides it, against csharp_style_var_for_built_in_types above.
|
||||
resharper_convert_type_check_pattern_to_null_check_highlighting = none
|
||||
resharper_pattern_always_matches_highlighting = none
|
||||
# A code-behind class names its base so that the type reads whole without the half XAML generates.
|
||||
resharper_redundant_extends_list_entry_highlighting = none
|
||||
# An argument that repeats a default says which value the call relies on.
|
||||
resharper_redundant_argument_default_value_highlighting = none
|
||||
# `partial void OnXChanged(T value)`: the signature is CommunityToolkit.Mvvm's generator's, used or not.
|
||||
resharper_unused_parameter_in_partial_method_highlighting = none
|
||||
# Exception messages and log lines are English by design (docs/09_I18N.md); what a user reads comes from .resx,
|
||||
# and tools/resx-audit.ps1 gates that.
|
||||
resharper_localizable_element_highlighting = none
|
||||
# WPF UI's styles (DefaultImageStyle ...) arrive with ui:ControlsDictionary at run time, from a package's compiled
|
||||
# resources the inspection does not read. A key that does not exist fails PagesLoadTests.
|
||||
resharper_xaml_static_resource_not_resolved_highlighting = none
|
||||
# Proposals, not findings - ReSharper's suggestions for a style this project did not take. Its style is this file,
|
||||
# `dotnet format` and the analyzers the build treats as errors.
|
||||
resharper_convert_to_primary_constructor_highlighting = none
|
||||
resharper_merge_into_pattern_highlighting = none
|
||||
resharper_merge_conditional_expression_highlighting = none
|
||||
resharper_use_object_or_collection_initializer_highlighting = none
|
||||
resharper_use_utf8_string_literal_highlighting = none
|
||||
resharper_redundant_explicit_params_array_creation_highlighting = none
|
||||
resharper_arrange_object_creation_when_type_evident_highlighting = none
|
||||
resharper_convert_to_using_declaration_highlighting = none
|
||||
resharper_convert_closure_to_method_group_highlighting = none
|
||||
resharper_redundant_type_declaration_body_highlighting = none
|
||||
resharper_replace_with_field_keyword_highlighting = none
|
||||
resharper_replace_conditional_expression_with_null_coalescing_highlighting = none
|
||||
resharper_append_to_collection_expression_highlighting = none
|
||||
resharper_use_collection_expression_highlighting = none
|
||||
resharper_use_with_expression_to_copy_struct_highlighting = none
|
||||
resharper_convert_to_auto_property_highlighting = none
|
||||
resharper_convert_to_static_class_highlighting = none
|
||||
resharper_use_index_from_end_expression_highlighting = none
|
||||
# A notice for code moving to C# 14, which this code was written in.
|
||||
resharper_c_sharp14_overload_resolution_with_span_breaking_change_highlighting = none
|
||||
# `await using` needs ConfigureAwait(false) on the disposable under CA2007, which reads worse than the `using` it
|
||||
# replaces; the streams these name are closed synchronously on purpose.
|
||||
resharper_use_await_using_highlighting = none
|
||||
# A member's accessibility is what its type offers, not a count of today's callers.
|
||||
resharper_member_can_be_private_global_highlighting = none
|
||||
resharper_member_can_be_private_local_highlighting = none
|
||||
resharper_property_can_be_made_init_only_global_highlighting = none
|
||||
resharper_property_can_be_made_init_only_local_highlighting = none
|
||||
resharper_auto_property_can_be_made_get_only_global_highlighting = none
|
||||
resharper_auto_property_can_be_made_get_only_local_highlighting = none
|
||||
# "Never used" across the solution is not what decides for a member other code can reach: an enum's values mirror
|
||||
# the native layout and the stored columns, an exception type carries the constructors CA1032 asks for, a row or a
|
||||
# message is read by Dapper and System.Text.Json, an interface states a contract. The private kind (.Local) stays on.
|
||||
resharper_unused_member_global_highlighting = none
|
||||
resharper_unused_type_global_highlighting = none
|
||||
resharper_unused_auto_property_accessor_global_highlighting = none
|
||||
resharper_unused_member_in_super_global_highlighting = none
|
||||
resharper_unused_method_return_value_global_highlighting = none
|
||||
resharper_unused_parameter_global_highlighting = none
|
||||
resharper_class_never_instantiated_global_highlighting = none
|
||||
resharper_event_never_subscribed_to_global_highlighting = none
|
||||
|
||||
# The compiler's nullable analysis is the gate (warnings are errors). These three go further and call a guard
|
||||
# redundant because an annotation promises non-null - where a dependency property, a JSON document or a WPF event
|
||||
# hands over null all the same.
|
||||
resharper_null_coalescing_condition_is_always_not_null_according_to_api_contract_highlighting = none
|
||||
resharper_conditional_access_qualifier_is_non_nullable_according_to_api_contract_highlighting = none
|
||||
resharper_condition_is_always_true_or_false_according_to_nullable_api_contract_highlighting = none
|
||||
# A record's positional property is part of its equality and of what it prints, read by name or not.
|
||||
resharper_not_accessed_positional_property_global_highlighting = none
|
||||
resharper_not_accessed_positional_property_local_highlighting = none
|
||||
# Every one compares a value with the one it was copied from (max == r) or with an exact sentinel (scale == 1.0).
|
||||
resharper_compare_of_floats_by_equality_operator_highlighting = none
|
||||
# A nested record may name a property as the type that holds it names a helper; the compiler tells them apart.
|
||||
resharper_member_hides_static_from_outer_class_highlighting = none
|
||||
# `default: break;` is how a switch over a kind says that the rest is left alone on purpose.
|
||||
resharper_redundant_empty_switch_section_highlighting = none
|
||||
# A binding path through a null yields no value, and the template shows nothing: that is the design.
|
||||
resharper_xaml_possible_null_reference_exception_highlighting = none
|
||||
|
||||
[src/FrameLedger.App/**.cs]
|
||||
# WPF codegen constraints, not style choices. The generated App.g.cs and
|
||||
# *.g.cs partials declare these types public, so making them internal is a
|
||||
@@ -72,3 +160,19 @@ dotnet_diagnostic.MA0049.severity = none # type name matches containing names
|
||||
[tests/**/*.cs]
|
||||
dotnet_diagnostic.CA1707.severity = none # underscores in test method names
|
||||
dotnet_diagnostic.CA2007.severity = none
|
||||
# A test's assertion lambda runs inside the `using` scope it captures from - and reads a variable the test changes
|
||||
# on purpose - and a test's `using var x = new T { ... }` leaks nothing a test process keeps.
|
||||
resharper_access_to_disposed_closure_highlighting = none
|
||||
resharper_access_to_modified_closure_highlighting = none
|
||||
resharper_using_statement_resource_initialization_highlighting = none
|
||||
# A test that dereferences a null fails, which is what it is for.
|
||||
resharper_assign_null_to_not_null_attribute_highlighting = none
|
||||
resharper_possible_null_reference_exception_highlighting = none
|
||||
# A test double keeps the shape of what it stands for: an accessor nothing reads, a collection only filled, a result
|
||||
# only some tests look at, a value an arrange step sets before the lambda that reads it runs.
|
||||
resharper_unused_auto_property_accessor_local_highlighting = none
|
||||
resharper_collection_never_queried_local_highlighting = none
|
||||
resharper_collection_never_updated_local_highlighting = none
|
||||
resharper_unused_method_return_value_local_highlighting = none
|
||||
resharper_redundant_assignment_highlighting = none
|
||||
resharper_return_type_can_be_not_nullable_highlighting = none
|
||||
@@ -0,0 +1,100 @@
|
||||
# ACCESSIBILITY.md (beta.35, D88) sends every accessibility barrier here. It is its own form rather than part of the bug
|
||||
# report because a barrier needs different facts: what the reporter uses to read or operate the screen, and how far it
|
||||
# stops them. Nothing here asks about the reporter themself.
|
||||
name: Accessibility problem
|
||||
description: Something in FrameLedger cannot be reached, read or seen — with the keyboard, a screen reader, a contrast theme, Magnifier or another aid
|
||||
labels: [accessibility]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thank you for telling us. **You never need to tell us anything about yourself or a disability** — what you use
|
||||
and what happened is enough. Screenshots and recordings help but are optional.
|
||||
|
||||
If FrameLedger refused to hook a game, stopped measuring or turned hooking off **without your knowing** — a
|
||||
safety notice you could not perceive — say so below: it is a safety problem too, and it is handled first.
|
||||
|
||||
What FrameLedger aims for and what it cannot do yet: [ACCESSIBILITY.md](https://github.com/poli0981/frameledger/blob/main/ACCESSIBILITY.md).
|
||||
|
||||
- type: textarea
|
||||
id: task
|
||||
attributes:
|
||||
label: What were you trying to do?
|
||||
placeholder: 'e.g. switch hooking on for a game, read a session''s frame rate, answer the terms window'
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: what-happened
|
||||
attributes:
|
||||
label: What happened instead?
|
||||
description: What you heard, saw or could not do — and what you expected.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: steps
|
||||
attributes:
|
||||
label: How to get there
|
||||
placeholder: |
|
||||
1. Open Games (Ctrl+2)
|
||||
2. Tab to …
|
||||
3. …
|
||||
|
||||
- type: input
|
||||
id: app-version
|
||||
attributes:
|
||||
label: FrameLedger version
|
||||
description: Help ▸ About
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: os
|
||||
attributes:
|
||||
label: Windows version
|
||||
placeholder: 'Windows 11 26100.2314'
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: aid
|
||||
attributes:
|
||||
label: What do you use?
|
||||
multiple: true
|
||||
options:
|
||||
- Keyboard only
|
||||
- Narrator
|
||||
- NVDA
|
||||
- JAWS
|
||||
- Windows Magnifier
|
||||
- A Windows contrast theme
|
||||
- Voice Access or other speech input
|
||||
- Display scaling or a large text size
|
||||
- Something else (say below)
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: aid-version
|
||||
attributes:
|
||||
label: Its version, if you know it
|
||||
placeholder: 'e.g. NVDA 2026.1'
|
||||
|
||||
- type: dropdown
|
||||
id: severity
|
||||
attributes:
|
||||
label: How much does it stop you?
|
||||
description: Optional — the maintainer sets it when reading the report (ACCESSIBILITY.md, How serious it is).
|
||||
options:
|
||||
- Not sure
|
||||
- Critical — I cannot do the task at all
|
||||
- Serious — only with great difficulty or a workaround
|
||||
- Moderate — it is tiring or inconsistent
|
||||
- Minor — it barely gets in the way
|
||||
|
||||
- type: textarea
|
||||
id: more
|
||||
attributes:
|
||||
label: Anything else
|
||||
description: A screenshot, a recording, or a diagnostic file from Help ▸ Report a bug (built on your PC; you choose what to attach).
|
||||
@@ -1,5 +1,16 @@
|
||||
# Central package management makes NuGet PRs single-file diffs
|
||||
# (docs/12_BUILD.md, docs/13_CI_CD.md).
|
||||
#
|
||||
# The nuget entry also covers .config/dotnet-tools.json (the SonarScanner for
|
||||
# .NET, since 2026-10-25). No dotnet-sdk entry, on purpose: global.json is a
|
||||
# floor (11.0.100 since beta.37, D94) with rollForward latestFeature, so every
|
||||
# machine and the CI runner already build with the newest 11.0 SDK they have;
|
||||
# raising the floor is a decision, not an update (docs/12_BUILD.md).
|
||||
#
|
||||
# COOLDOWN (2026-10-25): a version update waits seven days after a release is
|
||||
# published, so a release that is pulled or found compromised in its first
|
||||
# week never reaches a pull request here. Security updates do not wait — the
|
||||
# option does not apply to them.
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: nuget
|
||||
@@ -7,6 +18,8 @@ updates:
|
||||
schedule:
|
||||
interval: weekly
|
||||
open-pull-requests-limit: 5
|
||||
cooldown:
|
||||
default-days: 7
|
||||
groups:
|
||||
minor-and-patch:
|
||||
update-types: [minor, patch]
|
||||
@@ -21,7 +34,14 @@ updates:
|
||||
- dependency-name: FluentAssertions
|
||||
update-types: [version-update:semver-major]
|
||||
|
||||
# One pull request a week for the actions' minor and patch releases; a new
|
||||
# major still comes alone, because it is the one that changes inputs.
|
||||
- package-ecosystem: github-actions
|
||||
directory: /
|
||||
schedule:
|
||||
interval: weekly
|
||||
cooldown:
|
||||
default-days: 7
|
||||
groups:
|
||||
actions-minor-and-patch:
|
||||
update-types: [minor, patch]
|
||||
@@ -30,6 +30,18 @@ review questions from `docs/19_SAFETY_AND_ANTICHEAT.md` §Review checklist.
|
||||
|
||||
**Measured overhead:** <!-- e.g. "0.31 µs/present, game Avg FPS delta -0.2%" -->
|
||||
|
||||
## User-interface changes only
|
||||
|
||||
Skip this section if the PR does not change what the App shows. Otherwise — `ACCESSIBILITY.md` §For contributors,
|
||||
`docs/08_UI.md` §Accessibility:
|
||||
|
||||
- [ ] Every control that shows no text of its own has a name, from `.resx` in `en`, `vi` and `ja`
|
||||
- [ ] Colours come from the theme only, and nothing is shown by colour alone
|
||||
- [ ] Everything new can be reached and used with the keyboard, in reading order, and Esc leaves a new dialog
|
||||
- [ ] `ACCESSIBILITY.md` (and `LIMITATIONS.md`) changed in this PR if what works or what does not moved
|
||||
|
||||
**Checked by hand:** <!-- e.g. "Tab through the new card with the mouse unplugged; Narrator reads its name and value" -->
|
||||
|
||||
## Safety-string changes only
|
||||
|
||||
- [ ] `Safety_*` resx keys have human-reviewed `ja` (never machine-drafted — `docs/09_I18N.md`)
|
||||
@@ -38,4 +50,6 @@ review questions from `docs/19_SAFETY_AND_ANTICHEAT.md` §Review checklist.
|
||||
## Notes for the reviewer
|
||||
|
||||
<!-- Anything that would be hard to see from the diff. If you resolved an item
|
||||
in docs/20_OPEN_QUESTIONS.md, say which one and delete it from that file. -->
|
||||
in docs/20_OPEN_QUESTIONS.md, say which one, mark it resolved in §S24, and move
|
||||
the entry verbatim to docs/open-questions/closed-*.md with its row in the table
|
||||
at the end of its series (beta.24, D66). -->
|
||||
+156
-11
@@ -9,23 +9,29 @@
|
||||
#
|
||||
# So this workflow does exactly one thing of substance: ./build.ps1 check.
|
||||
# Anything CI checks that local does not is a way for the two to disagree.
|
||||
#
|
||||
# Since 2026-10-25 (owner decision D68) a second job, `sonarcloud`, hands that
|
||||
# run's coverage to SonarCloud and analyses the tree there. It is not the gate
|
||||
# and not a required check: it builds again in a build of its own, and a
|
||||
# SonarCloud outage or a failed quality gate is a red job beside a green
|
||||
# `check`, never a blocked merge (docs/13_CI_CD.md §SonarCloud).
|
||||
|
||||
name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
# `alpha` since 2026-10-31 (D73, docs/13_CI_CD.md §The alpha line): the same source on the .NET that line is
|
||||
# trying, whose merges and syncs from main need the same gate under its own global.json.
|
||||
branches: [main, alpha]
|
||||
pull_request:
|
||||
workflow_dispatch:
|
||||
|
||||
# Permissions do not inherit into reusable workflows, and defaults are broader
|
||||
# than this job needs either way (docs/13_CI_CD.md).
|
||||
permissions:
|
||||
contents: read
|
||||
# For the Changelog step below only: listing a pull request's changed files is
|
||||
# the Pull Requests API, and an explicit `permissions:` block grants nothing it
|
||||
# does not name. Read-only, and the job writes nothing back.
|
||||
pull-requests: read
|
||||
# than this job needs either way (docs/13_CI_CD.md). Since the second job
|
||||
# (2026-10-25) they are granted per job and the workflow grants none: a grant at
|
||||
# this level reaches every job, so `sonarcloud` would have held `check`'s
|
||||
# pull-requests read for nothing (SonarCloud githubactions:S8264).
|
||||
permissions: {}
|
||||
|
||||
concurrency:
|
||||
group: ci-${{ github.ref }}
|
||||
@@ -35,6 +41,12 @@ jobs:
|
||||
check:
|
||||
runs-on: windows-latest
|
||||
timeout-minutes: 40
|
||||
permissions:
|
||||
contents: read
|
||||
# For the Changelog step below only: listing a pull request's changed files is
|
||||
# the Pull Requests API, and an explicit `permissions:` block grants nothing it
|
||||
# does not name. Read-only, and the job writes nothing back.
|
||||
pull-requests: read
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v7
|
||||
@@ -47,7 +59,7 @@ jobs:
|
||||
global-json-file: global.json
|
||||
|
||||
- name: Set up MSVC (x64)
|
||||
uses: ilammy/msvc-dev-cmd@v1
|
||||
uses: ilammy/msvc-dev-cmd@0b201ec74fa43914dc39ae48a89fd1d8cb592756 # v1.13.0
|
||||
with:
|
||||
arch: x64
|
||||
|
||||
@@ -166,8 +178,11 @@ jobs:
|
||||
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'))
|
||||
|
||||
# Not for a pull request into `alpha` (D73): what the alpha line changes is written in its release's own file on
|
||||
# main (docs/changelog/x.y.z-alpha.N.md), and an [Unreleased] entry on the alpha branch would collide with main's
|
||||
# at every sync.
|
||||
- name: Changelog
|
||||
if: github.event_name == 'pull_request'
|
||||
if: github.event_name == 'pull_request' && github.base_ref != 'alpha'
|
||||
shell: pwsh
|
||||
env:
|
||||
GH_TOKEN: ${{ github.token }}
|
||||
@@ -178,11 +193,141 @@ jobs:
|
||||
if ($LASTEXITCODE -ne 0) { throw "could not list the pull request's changed files" }
|
||||
./tools/changelog-check.ps1 -ChangedFiles @($files)
|
||||
|
||||
# Cobertura for a person reading it, OpenCover for the sonarcloud job below
|
||||
# (build.ps1 writes both from the one test run since 2026-10-25).
|
||||
- name: Upload coverage
|
||||
if: always()
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: coverage
|
||||
path: '**/TestResults/**/coverage.cobertura.xml'
|
||||
path: |
|
||||
**/TestResults/**/coverage.cobertura.xml
|
||||
**/TestResults/**/coverage.opencover.xml
|
||||
if-no-files-found: warn
|
||||
retention-days: 14
|
||||
|
||||
# SonarCloud, analysed from CI (owner decision D68, 2026-10-25; docs/13_CI_CD.md
|
||||
# §SonarCloud). A job of its own, after `check`, for two reasons:
|
||||
#
|
||||
# - The scanner instruments the build it wraps and turns TreatWarningsAsErrors
|
||||
# off in it (SonarQube.Integration.targets), so it cannot wrap the gate's
|
||||
# build without weakening the gate. It gets a build of its own here.
|
||||
# - It is advisory. `main`'s required contexts stay `check` and the two
|
||||
# `analyze` jobs; a failed quality gate or a SonarCloud outage turns this job
|
||||
# red and blocks nothing.
|
||||
#
|
||||
# It takes the gate's coverage (the `coverage` artifact) rather than running
|
||||
# the tests a second time, and CMake's compilation database for the C++.
|
||||
# Settings: SonarQube.Analysis.xml. The scanner: .config/dotnet-tools.json.
|
||||
sonarcloud:
|
||||
needs: check
|
||||
# A pull request from this repository, or main. SONAR_TOKEN reaches neither a
|
||||
# fork's pull request nor Dependabot's, and the scanner cannot start without
|
||||
# it. Any other branch is refused by the organisation's plan - "Organization
|
||||
# is not allowed to access data from non main branches", measured on a
|
||||
# workflow_dispatch run of a feature branch, 2026-10-25 - so a dispatch on
|
||||
# one runs `check` alone. The same plan is why a pull request INTO `alpha`
|
||||
# (D73) and a push to it run `check` alone: SonarCloud analyses main's line.
|
||||
if: >-
|
||||
(github.event_name == 'pull_request' &&
|
||||
github.base_ref != 'alpha' &&
|
||||
github.event.pull_request.head.repo.full_name == github.repository &&
|
||||
github.event.pull_request.user.login != 'dependabot[bot]') ||
|
||||
(github.event_name != 'pull_request' && github.ref == 'refs/heads/main')
|
||||
runs-on: windows-latest
|
||||
timeout-minutes: 40
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
# Blame for the new-code period, and the tags for the version.
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Set up .NET
|
||||
uses: actions/setup-dotnet@v6
|
||||
with:
|
||||
global-json-file: global.json
|
||||
|
||||
# The analysis of the C++ runs the compiler of the compilation database.
|
||||
- name: Set up MSVC (x64)
|
||||
uses: ilammy/msvc-dev-cmd@0b201ec74fa43914dc39ae48a89fd1d8cb592756 # v1.13.0
|
||||
with:
|
||||
arch: x64
|
||||
|
||||
- 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 }}-
|
||||
|
||||
# The JRE the scanner provisions, and SonarCloud's analysers.
|
||||
- name: Cache SonarCloud
|
||||
uses: actions/cache@v6
|
||||
with:
|
||||
path: ~/.sonar/cache
|
||||
key: sonar-${{ runner.os }}-${{ hashFiles('.config/dotnet-tools.json') }}
|
||||
restore-keys: sonar-${{ runner.os }}-
|
||||
|
||||
# tests/<project>/TestResults/<guid>/coverage.opencover.xml, as `check` wrote
|
||||
# them. Same workspace path on every hosted Windows runner, so the reports'
|
||||
# absolute paths name these sources.
|
||||
- name: Download the gate's coverage
|
||||
uses: actions/download-artifact@v8
|
||||
with:
|
||||
name: coverage
|
||||
|
||||
# Configure only, plus the one header the build generates: the analysis
|
||||
# reads the sources with the flags and defines CMake gives each one, and
|
||||
# needs nothing built. FetchContent's sources land in build/, excluded.
|
||||
#
|
||||
# CMAKE_CXX_SCAN_FOR_MODULES=OFF: with C++20 and Ninja, CMake (3.28 on)
|
||||
# scans every source for modules and gives each compile command an
|
||||
# `@<object>.modmap` response file that only the BUILD writes, and the
|
||||
# C/C++ analyser stops on a response file it cannot open ("unexpanded
|
||||
# response file", the first run, 2026-10-25). Nothing here uses a module.
|
||||
- name: Native compilation database
|
||||
shell: pwsh
|
||||
working-directory: src/native
|
||||
run: |
|
||||
cmake --preset x64-release -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DCMAKE_CXX_SCAN_FOR_MODULES=OFF
|
||||
if ($LASTEXITCODE -ne 0) { throw 'cmake configure failed' }
|
||||
cmake --build --preset x64-release --target fl_ac_floor_gen
|
||||
if ($LASTEXITCODE -ne 0) { throw 'generating the blocklist floor failed' }
|
||||
|
||||
# The version is the newest release tag the commit descends from, so the
|
||||
# project's new-code period ("previous version") is everything since the
|
||||
# last release.
|
||||
- name: Begin the analysis
|
||||
shell: pwsh
|
||||
env:
|
||||
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
||||
run: |
|
||||
$ErrorActionPreference = 'Stop'
|
||||
dotnet tool restore
|
||||
if ($LASTEXITCODE -ne 0) { throw 'dotnet tool restore failed' }
|
||||
$tag = git describe --tags --abbrev=0 --match 'v*' 2>$null
|
||||
$version = if ($LASTEXITCODE -eq 0 -and $tag) { $tag.Substring(1) } else { (Get-Content VERSION -Raw).Trim() }
|
||||
Write-Host "sonar.projectVersion: $version"
|
||||
dotnet tool run dotnet-sonarscanner begin /k:poli0981_frameledger /o:poli0981 /v:$version `
|
||||
/s:"$PWD\SonarQube.Analysis.xml" /d:sonar.token=$env:SONAR_TOKEN
|
||||
if ($LASTEXITCODE -ne 0) { throw 'the scanner did not begin' }
|
||||
|
||||
# Platform: see build.ps1's Clear-VcxprojPlatform (the MSVC step exports
|
||||
# Platform=x64, which MSBuild reads as a solution platform).
|
||||
- name: Build for the analysis
|
||||
shell: pwsh
|
||||
run: |
|
||||
Remove-Item Env:Platform -ErrorAction SilentlyContinue
|
||||
dotnet build FrameLedger.slnx -c Release
|
||||
if ($LASTEXITCODE -ne 0) { throw 'the analysis build failed' }
|
||||
|
||||
- name: End the analysis
|
||||
shell: pwsh
|
||||
env:
|
||||
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
||||
run: |
|
||||
dotnet tool run dotnet-sonarscanner end /d:sonar.token=$env:SONAR_TOKEN
|
||||
if ($LASTEXITCODE -ne 0) { throw 'the analysis failed, or its quality gate did' }
|
||||
@@ -7,9 +7,20 @@
|
||||
# Repo-local for now. The ops repo has codeql-mixed.yml, but C++ needs manual
|
||||
# build mode driven by the CMake preset, and that input surface has not been
|
||||
# verified. Switch to a caller stub once it has.
|
||||
#
|
||||
# AND the workflows themselves, since 2026-10-25: CodeQL's `actions` language
|
||||
# reads .github/workflows for injection from event data, untrusted checkouts
|
||||
# and over-broad tokens — the same class of finding SonarCloud raised once
|
||||
# (githubactions:S7631, wiki.yml, beta.26). Its context, `analyze (actions,
|
||||
# none)`, is not one of main's required checks.
|
||||
|
||||
name: CodeQL
|
||||
|
||||
# `workflow_dispatch` since 2026-11-11 (beta.37): on a pull request the C# analysis
|
||||
# is an OVERLAY - it extracts the changed files on top of the database cached from
|
||||
# `main` - so it cannot show what the extractor makes of the whole source, or of a
|
||||
# construct it has not met (the move to .NET 11, a C# 15 feature). A dispatch on a
|
||||
# branch is a full analysis of that branch (docs/13_CI_CD.md §C# 15 and the analyses).
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
@@ -17,11 +28,20 @@ on:
|
||||
branches: [main]
|
||||
schedule:
|
||||
- cron: '27 4 * * 1'
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
security-events: write
|
||||
|
||||
# A new push to a pull request replaces its run. A push to main and the weekly
|
||||
# scan each get a group of their own (the run id), so none of them is ever
|
||||
# cancelled or left pending behind another, and the default branch's alerts
|
||||
# always come from a finished analysis.
|
||||
concurrency:
|
||||
group: codeql-${{ github.event_name == 'pull_request' && github.ref || github.run_id }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
analyze:
|
||||
runs-on: windows-latest
|
||||
@@ -35,6 +55,8 @@ jobs:
|
||||
build-mode: none
|
||||
- language: cpp
|
||||
build-mode: manual
|
||||
- language: actions
|
||||
build-mode: none
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v7
|
||||
@@ -47,7 +69,7 @@ jobs:
|
||||
|
||||
- name: Set up MSVC (x64)
|
||||
if: matrix.language == 'cpp'
|
||||
uses: ilammy/msvc-dev-cmd@v1
|
||||
uses: ilammy/msvc-dev-cmd@0b201ec74fa43914dc39ae48a89fd1d8cb592756 # v1.13.0
|
||||
with:
|
||||
arch: x64
|
||||
|
||||
|
||||
@@ -0,0 +1,82 @@
|
||||
# Qodana (owner decision D93, 2026-11-10; docs/13_CI_CD.md §Qodana).
|
||||
#
|
||||
# JetBrains' template for the Qodana Scan action, changed where FrameLedger differs
|
||||
# and each change said here:
|
||||
#
|
||||
# - The linter is Qodana Community for .NET (qodana.yaml names it and says why): a
|
||||
# Linux container, which is why this job alone runs on ubuntu-latest in a
|
||||
# Windows-only project. EnableWindowsTargeting lets the .NET SDK there build and
|
||||
# load projects whose target is Windows; it is passed to the container rather than
|
||||
# written into Directory.Build.props, because no build of the product is meant to
|
||||
# run anywhere but Windows.
|
||||
# - The action is pinned to a commit (v2026.2.2, the newest; the template names
|
||||
# v2026.1), as every action that is not GitHub's own is here.
|
||||
# - Permissions are the ones the job uses: it reads the repository, writes a check
|
||||
# run with the annotations and one comment on the pull request. The template's
|
||||
# `contents: write` is for pushing quick-fixes, which this job never does.
|
||||
# - A workflow of its own, as JetBrains advises, and ADVISORY: `main`'s required
|
||||
# contexts stay `check` and the two `analyze` jobs. A problem Qodana finds, or a
|
||||
# Qodana Cloud outage, is a red job beside a green `check`, never a blocked merge.
|
||||
# - `main` only: the `alpha` branch is main's source under another release line
|
||||
# (docs/13_CI_CD.md §The alpha line), and main's is what is analysed.
|
||||
# - INTERIM since beta.37 (D94, 2026-11-11): main builds on .NET 11, which the
|
||||
# linter's image does not carry (SDKs 8 to 10), so qodana.yaml's `bootstrap`
|
||||
# installs the SDK global.json names into the container first. The Ultimate
|
||||
# linter's pull request replaces this job with one on Windows.
|
||||
|
||||
name: Qodana
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
pull_request:
|
||||
branches: [main]
|
||||
push:
|
||||
branches: [main]
|
||||
|
||||
permissions: {}
|
||||
|
||||
concurrency:
|
||||
group: qodana-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
qodana:
|
||||
# A pull request from this repository, or a push or a dispatch. QODANA_TOKEN
|
||||
# reaches neither a fork's pull request nor Dependabot's, and their token cannot
|
||||
# write the check run or the comment.
|
||||
if: >-
|
||||
github.event_name != 'pull_request' ||
|
||||
(github.event.pull_request.head.repo.full_name == github.repository &&
|
||||
github.event.pull_request.user.login != 'dependabot[bot]')
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 60
|
||||
permissions:
|
||||
contents: read
|
||||
checks: write
|
||||
pull-requests: write
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
# The pull request's own commit, not its merge commit (empty on a push or
|
||||
# a dispatch, which then check out the commit that started them).
|
||||
ref: ${{ github.event.pull_request.head.sha }}
|
||||
# A full history is required for pull request analysis.
|
||||
fetch-depth: 0
|
||||
|
||||
# pr-mode false: the whole solution every time, so a pull request and `main`
|
||||
# are judged by the same list. upload-result: the SARIF and the linter's log
|
||||
# as an artifact of the run, for a reader with no Qodana Cloud account.
|
||||
# Caches are saved from `main` only (a pull request reads them): one per
|
||||
# branch would crowd the repository's cache quota, which NuGet's share.
|
||||
- name: Qodana Scan
|
||||
uses: JetBrains/qodana-action@3e8d76ff0e0241618abd808682f426afe84bab3f # v2026.2.2
|
||||
with:
|
||||
pr-mode: false
|
||||
upload-result: true
|
||||
cache-default-branch-only: true
|
||||
env-vars-to-linter: EnableWindowsTargeting
|
||||
env:
|
||||
QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}
|
||||
QODANA_ENDPOINT: 'https://qodana.cloud'
|
||||
EnableWindowsTargeting: 'true'
|
||||
@@ -22,6 +22,13 @@
|
||||
# -p:Version; the native blocks keep the numeric core (CMake's project() accepts
|
||||
# nothing else).
|
||||
#
|
||||
# THE ALPHA LINE (2026-10-31, owner decisions D73-D76; 12_BUILD §The alpha line): the
|
||||
# RELEASE_LINE file says `alpha` on the long-lived `alpha` branch, where the same source
|
||||
# builds on the .NET the line is trying. Its tags are `vX.Y.Z-alpha.N` and nothing else, no other
|
||||
# line may carry one, and its packages go to Velopack's `alpha` channel
|
||||
# (releases.alpha.json) - which no beta reads, as no alpha reads releases.win.json
|
||||
# (11_UPDATER §Channels). The version gate below enforces all three.
|
||||
#
|
||||
# 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.
|
||||
@@ -60,13 +67,18 @@ jobs:
|
||||
steps:
|
||||
- uses: actions/checkout@v7
|
||||
|
||||
# The SDK global.json names builds everything. The .NET 10 line beside it is for `vpk` (the Pack step): 1.2.161
|
||||
# ships net8.0, net9.0 and net10.0 builds and none that rolls forward to another major, so on a machine with
|
||||
# .NET 11 alone the tool would not start. The alphas were packed under an 11 SDK because the hosted image
|
||||
# happened to carry a .NET 10 runtime; this states the dependency (2026-11-11, beta.37, D94).
|
||||
- name: Set up .NET
|
||||
uses: actions/setup-dotnet@v6
|
||||
with:
|
||||
global-json-file: global.json
|
||||
dotnet-version: 10.0.x
|
||||
|
||||
- name: Set up MSVC (x64)
|
||||
uses: ilammy/msvc-dev-cmd@v1
|
||||
uses: ilammy/msvc-dev-cmd@0b201ec74fa43914dc39ae48a89fd1d8cb592756 # v1.13.0
|
||||
with:
|
||||
arch: x64
|
||||
|
||||
@@ -101,6 +113,14 @@ jobs:
|
||||
$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" }
|
||||
# D73: the release line this commit builds (Directory.Build.props refuses any other value too) and the tags it may
|
||||
# carry - an alpha's on the alpha line only, and nothing else there.
|
||||
$line = (Get-Content RELEASE_LINE -Raw).Trim()
|
||||
if ($line -cnotin @('main', 'alpha')) { throw "RELEASE_LINE says '$line'; it must be main or alpha" }
|
||||
$suffix = $m.Groups[2].Value
|
||||
if ($line -eq 'alpha' -and $suffix -cnotmatch '^-alpha\.\d+$') { throw "this commit is on the alpha line (RELEASE_LINE); its tag must be vX.Y.Z-alpha.N, not $tag" }
|
||||
if ($line -ne 'alpha' -and $suffix -match 'alpha') { throw "tag $tag names an alpha, but RELEASE_LINE says '$line': an alpha is tagged on the alpha branch, nowhere else" }
|
||||
$channel = if ($line -eq 'alpha') { 'alpha' } else { 'win' }
|
||||
New-Item -ItemType Directory -Force out | Out-Null
|
||||
./tools/release-notes.ps1 -Version $full -OutFile out/notes.md
|
||||
if ($LASTEXITCODE -ne 0) {
|
||||
@@ -113,8 +133,9 @@ jobs:
|
||||
}
|
||||
"version=$full" >> $env:GITHUB_OUTPUT
|
||||
"prerelease=$pre" >> $env:GITHUB_OUTPUT
|
||||
"channel=$channel" >> $env:GITHUB_OUTPUT
|
||||
"dry_run=$($dry.ToString().ToLowerInvariant())" >> $env:GITHUB_OUTPUT
|
||||
Write-Host "$(if ($dry) { 'DRY RUN of' } else { 'releasing' }) $full (pre-release: $pre)"
|
||||
Write-Host "$(if ($dry) { 'DRY RUN of' } else { 'releasing' }) $full (pre-release: $pre; line: $line; Velopack channel: $channel)"
|
||||
|
||||
# The Overlay's build id is `git describe --dirty` at CMake's configure
|
||||
# (src/native/FrameLedger.Shm/CMakeLists.txt), and the next step edits tracked
|
||||
@@ -244,38 +265,51 @@ jobs:
|
||||
GH_TOKEN: ${{ github.token }}
|
||||
run: |
|
||||
$ErrorActionPreference = 'Stop'
|
||||
dotnet tool install -g vpk --version 1.2.0
|
||||
dotnet tool install -g vpk --version 1.2.161
|
||||
if ($LASTEXITCODE -ne 0) { throw 'vpk install failed' }
|
||||
$v = '${{ steps.version.outputs.version }}'
|
||||
# D73: `win` (Velopack's default on Windows) for the main line, `alpha` for the alpha line - each release's feed
|
||||
# and the previous release its delta is made from are its own line's. The main line's pack keeps its exact
|
||||
# command (no --channel), so a beta is packed as every beta before the alpha line existed.
|
||||
$channel = '${{ steps.version.outputs.channel }}'
|
||||
New-Item -ItemType Directory out/release -Force | Out-Null
|
||||
vpk download github --repoUrl "https://github.com/${{ github.repository }}" --channel win --pre --token $env:GH_TOKEN --outputDir out/release
|
||||
vpk download github --repoUrl "https://github.com/${{ github.repository }}" --channel $channel --pre --token $env:GH_TOKEN --outputDir out/release
|
||||
if ($LASTEXITCODE -ne 0) { Write-Host '::warning::the previous release could not be downloaded - this release carries a full package only' }
|
||||
Write-Host 'previous release:'
|
||||
Get-ChildItem out/release -File | ForEach-Object { Write-Host (" {0,-48} {1,12:N0}" -f $_.Name, $_.Length) }
|
||||
vpk pack --packId FrameLedger.App --packVersion $v --packDir out/app --mainExe FrameLedger.exe --packTitle FrameLedger --packAuthors FrameLedger --releaseNotes out/notes.md --outputDir out/release
|
||||
$pack = @('pack', '--packId', 'FrameLedger.App', '--packVersion', $v, '--packDir', 'out/app', '--mainExe', 'FrameLedger.exe', '--packTitle', 'FrameLedger', '--packAuthors', 'FrameLedger', '--releaseNotes', 'out/notes.md', '--outputDir', 'out/release')
|
||||
if ($channel -ne 'win') { $pack += @('--channel', $channel) }
|
||||
vpk @pack
|
||||
if ($LASTEXITCODE -ne 0) { throw 'vpk pack failed' }
|
||||
|
||||
$built = @((Get-Content out/release/assets.win.json -Raw | ConvertFrom-Json) | ForEach-Object { $_.RelativeFileName })
|
||||
if ($built.Count -eq 0) { throw 'vpk pack wrote no assets.win.json entries' }
|
||||
$keep = $built + @('releases.win.json', 'assets.win.json', 'RELEASES')
|
||||
$assets = "assets.$channel.json"
|
||||
$index = "releases.$channel.json"
|
||||
$legacyName = if ($channel -eq 'win') { 'RELEASES' } else { "RELEASES-$channel" }
|
||||
$built = @((Get-Content "out/release/$assets" -Raw | ConvertFrom-Json) | ForEach-Object { $_.RelativeFileName })
|
||||
if ($built.Count -eq 0) { throw "vpk pack wrote no $assets entries" }
|
||||
$keep = $built + @($index, $assets, $legacyName)
|
||||
New-Item -ItemType Directory out/previous -Force | Out-Null
|
||||
Get-ChildItem out/release -File | Where-Object { $keep -notcontains $_.Name } | Move-Item -Destination out/previous
|
||||
$feed = Get-Content out/release/releases.win.json -Raw | ConvertFrom-Json
|
||||
$feed = Get-Content "out/release/$index" -Raw | ConvertFrom-Json
|
||||
$feed.Assets = @($feed.Assets | Where-Object { $built -contains $_.FileName })
|
||||
if ($feed.Assets.Count -eq 0) { throw 'the feed lists none of this build''s packages' }
|
||||
[System.IO.File]::WriteAllText((Join-Path $PWD 'out/release/releases.win.json'), ($feed | ConvertTo-Json -Depth 8 -Compress), [System.Text.UTF8Encoding]::new($false))
|
||||
if (Test-Path out/release/RELEASES) {
|
||||
$legacy = @(Get-Content out/release/RELEASES | Where-Object { $built -contains ($_ -split ' ')[1] })
|
||||
[System.IO.File]::WriteAllLines((Join-Path $PWD 'out/release/RELEASES'), [string[]]$legacy, [System.Text.UTF8Encoding]::new($false))
|
||||
[System.IO.File]::WriteAllText((Join-Path $PWD "out/release/$index"), ($feed | ConvertTo-Json -Depth 8 -Compress), [System.Text.UTF8Encoding]::new($false))
|
||||
if (Test-Path "out/release/$legacyName") {
|
||||
$legacy = @(Get-Content "out/release/$legacyName" | Where-Object { $built -contains ($_ -split ' ')[1] })
|
||||
[System.IO.File]::WriteAllLines((Join-Path $PWD "out/release/$legacyName"), [string[]]$legacy, [System.Text.UTF8Encoding]::new($false))
|
||||
}
|
||||
|
||||
Write-Host 'this release:'
|
||||
Get-ChildItem out/release | ForEach-Object { Write-Host (" {0,-48} {1,12:N0}" -f $_.Name, $_.Length) }
|
||||
Write-Host ('feed: ' + (($feed.Assets | ForEach-Object { '{0} {1} {2}' -f $_.Type, $_.Version, $_.FileName }) -join '; '))
|
||||
if (-not (Test-Path out/release/FrameLedger.App-win-Setup.exe)) { throw 'vpk did not produce FrameLedger.App-win-Setup.exe (README §Install names it)' }
|
||||
$delta = "out/release/FrameLedger.App-$v-delta.nupkg"
|
||||
$setup = "FrameLedger.App-$channel-Setup.exe"
|
||||
if (-not (Test-Path "out/release/$setup")) { throw "vpk did not produce $setup (README §Install names the beta's, guide/11-alpha-builds.md the alpha's)" }
|
||||
# The delta is the one this pack listed, not a name built here: Velopack puts a non-default channel in its packages'
|
||||
# names (FrameLedger.App-<v>-alpha-full.nupkg - measured on the 0.1.0-alpha.1 rehearsal, 2026-10-31), so the name
|
||||
# this step built for the default channel would have failed the second alpha.
|
||||
$delta = @($built | Where-Object { $_ -like '*-delta.nupkg' })
|
||||
if (Get-ChildItem out/previous -Filter '*-full.nupkg' -ErrorAction SilentlyContinue) {
|
||||
if (-not (Test-Path $delta)) { throw "the previous full package was downloaded, but vpk produced no delta ($delta)" }
|
||||
if ($delta.Count -ne 1) { throw "the previous full package was downloaded, but vpk produced no delta ($assets lists: $($built -join ', '))" }
|
||||
} else {
|
||||
Write-Host '::warning::no previous full package - this release carries no delta'
|
||||
}
|
||||
@@ -301,7 +335,9 @@ jobs:
|
||||
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')
|
||||
# An alpha says what it is in the list of releases too, not only in its notes (D74).
|
||||
$title = if ('${{ steps.version.outputs.channel }}' -eq 'alpha') { "FrameLedger $v (experimental alpha)" } else { "FrameLedger $v" }
|
||||
$ghArgs = @('release', 'create', $env:GITHUB_REF_NAME, '--title', $title, '--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
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# The GitHub Wiki is a copy of the repository's own pages (D53/D54, the owner, 2026-10-07): wiki/ (Home, the sidebar,
|
||||
# the developer pages) and guide/ (the user guide, which is the End-user part) with LIMITATIONS.md, assembled and checked
|
||||
# the developer pages) and guide/ (the user guide, which is the End-user part) with LIMITATIONS.md and ACCESSIBILITY.md, assembled and checked
|
||||
# by tools/wiki-build.ps1 - the check build.ps1 runs as `wiki-check`. A page edited on the Wiki tab is overwritten here;
|
||||
# edit wiki/ or guide/ instead (docs/13_CI_CD.md §wiki.yml).
|
||||
#
|
||||
@@ -41,12 +41,18 @@ concurrency:
|
||||
jobs:
|
||||
wiki:
|
||||
# A rehearsal of release.yml (workflow_dispatch) never publishes the wiki: only a run started by a pushed v* tag
|
||||
# that succeeded.
|
||||
# that succeeded - in THIS repository. A fork cannot start this repository's Release run (it runs on a tag push or by
|
||||
# hand), so the head checked out below is always the owner's; the repository check says so in the condition rather
|
||||
# than leaving it to release.yml's triggers (SonarCloud githubactions:S7631, beta.26).
|
||||
# Nor does an alpha's release (D73, 2026-10-31): the wiki shows the newest beta, and an alpha's tag is on the `alpha`
|
||||
# branch, whose guide is the beta's it was cut from - publishing it would only move the wiki's links off main's line.
|
||||
if: >-
|
||||
github.event_name == 'workflow_dispatch' ||
|
||||
(github.event.workflow_run.conclusion == 'success' &&
|
||||
github.event.workflow_run.event == 'push' &&
|
||||
startsWith(github.event.workflow_run.head_branch, 'v'))
|
||||
github.event.workflow_run.head_repository.full_name == github.repository &&
|
||||
startsWith(github.event.workflow_run.head_branch, 'v') &&
|
||||
!contains(github.event.workflow_run.head_branch, '-alpha.'))
|
||||
runs-on: windows-latest
|
||||
timeout-minutes: 10
|
||||
env:
|
||||
|
||||
@@ -0,0 +1,168 @@
|
||||
# Accessibility
|
||||
|
||||
FrameLedger should be usable by everyone who plays games on a Windows PC — with a keyboard alone, with a screen reader,
|
||||
with a Windows contrast theme or Magnifier, and without telling colours apart. This page says what FrameLedger aims
|
||||
for, what works today, how that was checked, what does not work yet and what to do instead, and how to tell us about a
|
||||
barrier. It is written for the person who has just met one; the details for developers are in
|
||||
[`docs/08_UI.md`](docs/08_UI.md#accessibility).
|
||||
|
||||
FrameLedger is a desktop program: its own window, its dialogs, its document windows, the icon by the clock and the
|
||||
notices Windows shows for it. It draws nothing inside a game, so it cannot make a game itself any easier to use.
|
||||
|
||||
*Beta software: this page describes version 0.1.0-beta.37. In the app: Help ▸ Accessibility.*
|
||||
|
||||
## What FrameLedger aims for
|
||||
|
||||
- **WCAG 2.2 at level AA**, applied to desktop software as W3C's
|
||||
[WCAG2ICT](https://www.w3.org/TR/wcag2ict-22/) guidance explains. This is a goal that guides the work, not a claim:
|
||||
no formal evaluation has been made, and FrameLedger does not say it conforms to any standard.
|
||||
- **Every task can be done with the keyboard alone.**
|
||||
- **A screen reader can read every control and every value**, in the language FrameLedger is shown in, and hears what
|
||||
changes — a notice, a result.
|
||||
- **Text and controls keep their contrast** in the light and the dark theme and under Windows contrast themes, and
|
||||
**colour is never the only way something is shown.**
|
||||
- **Everything stays sharp at any display scale**, and when the window moves between screens.
|
||||
|
||||
## What works today
|
||||
|
||||
### The keyboard
|
||||
|
||||
| Keys | What they do |
|
||||
|---|---|
|
||||
| **Ctrl+1** … **Ctrl+5** (also with the numeric keypad) | Open Dashboard, Games, Compare, Logs and Settings, and move the keyboard into that page; a screen reader hears its title. |
|
||||
| **Alt** or **F10**, then the arrow keys and **Enter** | Move to the menus. **Alt** with a menu's underlined letter opens it (*File*, *Tools*, *Help* in English). |
|
||||
| **Tab** and **Shift+Tab** | Move through a page or a dialog in reading order. |
|
||||
| The **arrow keys**, **Home**, **End**, **Page Up**, **Page Down** | Move inside a list or a table — a game's sessions, the games list, the Compare list, the import checklist. |
|
||||
| **Enter** or **Space** | Press the button, switch or box that has the focus. **Enter** on a game in the list opens its page. |
|
||||
| **Esc** | Closes a dialog the way its **Close** or **Cancel** button does: nothing is changed. A dialog that has no Close button waits for an answer, and the terms window has its own **Decline** and **Accept**. |
|
||||
| **Enter** in the hooking warning | Switches hooking on once the phrase is typed exactly; before that it does nothing. |
|
||||
| On a chart: the **arrow keys**, **Ctrl** with an arrow, **A** | Tab reaches every chart. The arrows move its view, Ctrl with an arrow zooms, A shows all of it again (so does a double-click); the page around it stays put. |
|
||||
|
||||
The same keys are in the user guide, [The screens](guide/07-screens.md#keyboard-and-mouse).
|
||||
|
||||
### Screen readers
|
||||
|
||||
- **Every page, menu, dialog and setting can be reached and used with Narrator.** The owner checked this on
|
||||
2026-11-09, keyboard only with the mouse disconnected, on 0.1.0-beta.34 and 0.1.0-alpha.3, and found no fault.
|
||||
- **Every page has headings**: its title is a heading of the first level, each section one of the second, so a screen
|
||||
reader's heading keys move from section to section.
|
||||
- **Every chart says what it is and where its numbers are written as text**, and which keys move it.
|
||||
- **Every button, switch and box that shows no text of its own has a name**, from the same translations as the screen.
|
||||
- **Lists, drop-down options and table cells are read by the words they show**, and a button repeated on each row names
|
||||
its row — *Open: 11/9/2026 14:03*, *Play: Cyberpunk 2077*, *Turn off: Cyberpunk 2077*.
|
||||
- **The frame-rate readout says the game's own frames, the displayed frames and the frame-generation factor together**
|
||||
(*Native 62 FPS, displayed 118 FPS, frame generation ×1.9*) — never the larger number alone; a ray-tracing chip says its
|
||||
value and where it came from (*Ray Tracing: Yes, measured*).
|
||||
- **What appears is said as it appears**: a safety notice (hooking refused, measuring stopped, hooking turned off), the
|
||||
capture agent going away and coming back, an update's steps, a short message at the bottom of the window, a notice on a
|
||||
game's page and a result of **Tools ▸ Database maintenance** — in the words shown, while FrameLedger's window is the
|
||||
active one. While a game has the screen nothing interrupts it; the notice stays in the window, and Windows' own
|
||||
notifications from the icon by the clock are read by the screen reader itself.
|
||||
- **The notices above the page can be read where they are shown**, and the button that answers one says which notice it
|
||||
answers.
|
||||
- **Tab goes from control to control**: pictures, lists and the rows of Settings are not stops of their own.
|
||||
- **Dialogs say they are dialogs**, keep the focus inside them until they close, and then give it back to the control
|
||||
that opened them. A message box opens over FrameLedger's window, never behind it.
|
||||
|
||||
### Seeing the screen
|
||||
|
||||
- **Light, dark, or the same as Windows** (Settings ▸ Theme). FrameLedger takes every colour from the theme, and every
|
||||
text is measured against what is painted under it, in both themes.
|
||||
- **Windows contrast themes** (Settings ▸ Accessibility ▸ Contrast themes) — Aquatic, Desert, Dusk, Night sky, or one
|
||||
whose colours you changed: every colour in the window becomes one of the theme's, whatever Settings ▸ Theme says, as
|
||||
soon as you turn one on, edit it or turn it off. The charts draw in its colours too, their lines and marks still told
|
||||
apart by pattern, and Settings ▸ Theme says a contrast theme is in use.
|
||||
- **The colour a game's picture lends its page** is used only as far as every text on it still reads, and never under a
|
||||
contrast theme.
|
||||
- **Windows display scaling** at any size, on every screen; **Magnifier** (Windows logo key + Plus) works as with any
|
||||
program.
|
||||
- Labels such as *Hooking on* and *Not installed*, and the ray-tracing chips, always carry their words; a chip that reads
|
||||
*N/A* is also drawn with a dashed edge.
|
||||
- **No chart tells two series apart by colour alone**: its lines are solid, dashed or dotted, its points circles,
|
||||
triangles or squares, its shaded stretches striped or dotted.
|
||||
|
||||
### Languages
|
||||
|
||||
FrameLedger is shown in English, Vietnamese or Japanese (Settings ▸ Language), and the names a screen reader reads come
|
||||
from the same translations. The documents — the user guide, this page, the legal texts — are in English.
|
||||
|
||||
## How it is checked
|
||||
|
||||
- **On every build**, by the project's own tests: what a screen reader is given for every page, window and dialog —
|
||||
every place Tab stops has a name, no list or table item is read by its program name, no text is hidden from a screen
|
||||
reader inside a control, no two buttons in a list share a name; each thing that appears is said once, in its words;
|
||||
every page has one first-level heading and every section title a level; no chart tells two series apart by colour
|
||||
alone; a chart's keys move it and stay its own; every control that shows no text has a name; no colour is written
|
||||
into a screen; every text reads against its background in both themes and after a theme switch, and under Windows'
|
||||
four contrast themes and two edited ones is drawn in the theme's own colours at 4.5:1 or better; **Esc** closes the
|
||||
open dialog without an answer, and a dialog gives the focus back; **Ctrl+1** … **Ctrl+5** open the pages in their
|
||||
order and move the keyboard into them; a page slides in only while Windows' animation effects are on; the program
|
||||
declares it follows each screen's scaling.
|
||||
- **By hand**: the owner's pass of 2026-11-09 above, repeated for each release that changes a screen.
|
||||
- **Not tested yet**: NVDA, JAWS, Voice Access, touch, Windows 10, and other people's PCs. They should work through the
|
||||
same Windows interface Narrator uses, but nobody has checked. Contrast themes are checked by the tests above and have
|
||||
not yet been looked at on a screen.
|
||||
|
||||
## Known limitations
|
||||
|
||||
Each one with what to do instead. A barrier that is not on this list is worth reporting.
|
||||
|
||||
- **A chart's points cannot be read one by one.** A screen reader hears the chart's name and where its numbers are:
|
||||
a session's figures and *Statistics per series* in its summary, the table under the Compare chart, the Sessions table
|
||||
and the list of changes under a trend chart, and **File ▸ Export ▸ Session CSV** or **Session JSON**.
|
||||
- **In the user guide and the other documents the app shows, headings are read as ordinary text**: Windows' document
|
||||
view gives them no heading role. Their links and their order work as on any page.
|
||||
- **The short messages at the bottom of the window close after four seconds**, and cannot be read again once closed. A
|
||||
screen reader is told each one as it appears.
|
||||
- **Windows' text size setting** (Settings ▸ Accessibility ▸ Text size) **is not followed.** Use display scaling
|
||||
(Settings ▸ System ▸ Display ▸ Scale) or Magnifier.
|
||||
- **Pausing capture is only in the menu of the icon by the clock.**
|
||||
- **The windows Windows itself shows** — choosing a file, the administrator prompt — are Windows', not FrameLedger's.
|
||||
|
||||
## Report an accessibility problem
|
||||
|
||||
1. Open an issue with the
|
||||
[Accessibility problem form](https://github.com/poli0981/frameledger/issues/new?template=accessibility.yml).
|
||||
2. Say what you were trying to do and what happened instead; your FrameLedger version (Help ▸ About) and your Windows
|
||||
version; and what you use — the keyboard alone, Narrator, NVDA, JAWS, Magnifier, a contrast theme — with its version.
|
||||
The steps to get there help, and so does a screenshot or a recording, but neither is required. **You never need to
|
||||
tell us anything about yourself or a disability.**
|
||||
3. If you want to attach details from your PC, **Help ▸ Report a bug** builds them into a file on your PC and shows you
|
||||
what is inside first; nothing is uploaded by itself.
|
||||
|
||||
**A safety notice you could not perceive** — hooking refused, measuring stopped or hooking turned off, without your
|
||||
knowing — is a safety problem as well: say so in the report, and it is handled first.
|
||||
|
||||
### How serious it is
|
||||
|
||||
You do not have to choose; the maintainer sets it when reading the report.
|
||||
|
||||
| Severity | What it means | For example |
|
||||
|---|---|---|
|
||||
| **Critical** | A task cannot be done at all. | Hooking cannot be switched off with the keyboard; the terms window or the hooking warning cannot be answered; a safety notice cannot be read. |
|
||||
| **Serious** | It can be done only with great difficulty or a workaround. | A value can be read only by exporting the session. |
|
||||
| **Moderate** | It is tiring or inconsistent. | A name that differs from what the screen shows; an extra stop for Tab. |
|
||||
| **Minor** | It barely gets in the way. | A tooltip the keyboard cannot reach, when its words are shown elsewhere too. |
|
||||
|
||||
### What happens next
|
||||
|
||||
FrameLedger has one maintainer, so there are no promised times. Every report is read and answered, without doubting what
|
||||
you describe. Critical problems come before other work; a workaround, when there is one, is written on the issue; the
|
||||
fix ships in a release, and the issue is closed once you say it works for you — or when a fix has been out for a while
|
||||
and nobody has answered.
|
||||
|
||||
## Who looks after this
|
||||
|
||||
The project's owner, poli0981, keeps this page and the checks behind it, and reviews both for each release that changes
|
||||
a screen. A change to FrameLedger that moves anything on this page changes the page in the same pull request.
|
||||
|
||||
## For contributors
|
||||
|
||||
A change to the App keeps what the tests above hold: a name, from the translations in all three languages, for every
|
||||
control that shows no text; colours only from the theme. Say in the pull request what you checked with the keyboard
|
||||
and with Narrator. The rules and the checks are in [`docs/08_UI.md`](docs/08_UI.md#accessibility) and
|
||||
[`CONTRIBUTING.md`](CONTRIBUTING.md).
|
||||
|
||||
## Feedback
|
||||
|
||||
To improve this page, open an issue or a pull request. A barrier goes through the form above, so that it is not lost.
|
||||
+62
-6050
File diff suppressed because it is too large.
Load diff
@@ -30,6 +30,8 @@ A C++ DLL (`FrameLedger.Overlay.dll`) is injected into games the user explicitly
|
||||
> **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).
|
||||
>
|
||||
> **Amended 2026-10-19 (owner decision D62): the mix.** Beside the steady state, the session summary lists every frame-generation state the session held — each with its own *Native → Displayed*, its factor and its share of the presenting time (`×4.0 frame generation · 35.33% · 70 → 282 FPS`) — then the time with no frame generation and the time no state claims. Every row is one state's own numbers; nothing is averaged across states, and a state's factor never appears without its rates (`docs/03_METRICS.md` §The mix).
|
||||
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*).
|
||||
@@ -40,14 +42,14 @@ A C++ DLL (`FrameLedger.Overlay.dll`) is injected into games the user explicitly
|
||||
|
||||
| Concern | Choice |
|
||||
|---|---|
|
||||
| Managed runtime | .NET 10 (LTS, pinned via `global.json`), C# 14, TFM `net10.0-windows10.0.22621.0` with `SupportedOSPlatformVersion=10.0.19045.0` (Win10 22H2 floor, NFR-8), x64 only — `docs/12_BUILD.md` |
|
||||
| Managed runtime | .NET 11 (STS, pinned via `global.json`: the 11.0 SDK band) and C# 15 since 0.1.0-beta.37 (owner decisions D94 and D96, 2026-11-11; .NET 10 and C# 14 until beta.36), TFM `net11.0-windows10.0.22621.0` with `SupportedOSPlatformVersion=10.0.19045.0` (NFR-8 as D95 amended it: Windows 11 is the supported platform; Windows 10 22H2 is not blocked, and is neither tested nor supported), x64 only — `docs/12_BUILD.md` §The main line's .NET. No preview feature (`runtime-async`, the updated memory-safety rules). **No C# 15 construct is used yet** — collection expression arguments, `closed`, `union`, labeled jumps: a construct is used only where the build, CodeQL and Qodana all read it, and Qodana's engine reads none of the four (`docs/13_CI_CD.md` §C# 15 and the analyses). .NET 11's API is used freely. **The `alpha` branch** (D73–D76, 2026-10-31) builds a released beta's source to try a newer .NET; it rests since 0.1.0-alpha.4 (D98) and then differs from main in `RELEASE_LINE` alone — `docs/12_BUILD.md` §The alpha line |
|
||||
| Native | **C++20, MSVC v143+, `/MT` static CRT, `/GS`, `/guard:cf`, no RTTI, no C++ exceptions in hook paths** |
|
||||
| Hooking | **MinHook** (BSD-2-Clause) for inline hooks; direct vtable-entry swap for COM interfaces |
|
||||
| Vulkan | **Implicit Vulkan layer** (`VK_LAYER_FRAMELEDGER_overlay`), not hooking — `17_HOOK_ENGINE` §Vulkan |
|
||||
| UI | WPF + WPF UI (`WPF-UI` pinned = 4.3.0) + CommunityToolkit.Mvvm — `docs/16_WPFUI_SYNTAX.md` |
|
||||
| App composition | .NET Generic Host + DI in `FrameLedger.App` |
|
||||
| Charts | ScottPlot 5 |
|
||||
| Markdown in the App | **Markdig** (BSD-2-Clause, pinned 1.4.0) → WPF `FlowDocument`, HTML off, no image fetched — the Legal Gate, the user guide, Help ▸ Limitations, the update notes, About (beta.12; row added 2026-10-04) |
|
||||
| Markdown in the App | **Markdig** (BSD-2-Clause, pinned ~~1.4.0~~ 1.5.0 since beta.31 — 1.4.2 in beta.30) → WPF `FlowDocument`, HTML off, no image fetched — the Legal Gate, the user guide, Help ▸ Limitations, Help ▸ Accessibility (beta.35, D88), the update notes, About (beta.12; row added 2026-10-04) |
|
||||
| GPU telemetry | **The game process's own memory since beta.12 (D43):** `FrameLedger.ProcessStats.dll` (C++, loaded by the Agent, never into a game) reads its dedicated/shared GPU memory from the `GPU Process Memory` counters and its working sets from `GetProcessMemoryInfo` — `18_GPU_VENDOR_APIS` §The game process's memory. Layered: DXGI + PDH counters (all vendors) → LibreHardwareMonitorLib (MPL-2.0, all vendors) → **NVAPI (MIT, headers + `amd64/nvapi64.lib` vendored 2026-08-05** at `src/native/third_party/nvapi/`, consumed via the `fl_nvapi` target; NVIDIA extras + Reflex). **No AMD/Intel vendor SDK** — `docs/18_GPU_VENDOR_APIS.md`. ~~**No telemetry source exists in code yet**~~ **`LhmTelemetrySource` (L2) exists since 2026-09-03 (`20_OPEN_QUESTIONS` §M5 row R1, eight GPU fields unelevated); L1 (`BaselineTelemetrySource`: DXGI identity + the PDH adapter-memory counter, the first CsWin32 consumer), `CompositeTelemetrySource` and the 1 Hz `TelemetryPoller` since 2026-09-09; L3 (`NvapiTelemetrySource` over the native `FrameLedger.NvapiBridge.dll` — the only shipped binary linking `nvapi64.lib`, loaded by the Agent into its own process and never into a game) since 2026-09-10 (PR-E2)** — `ctest fl_nvapi_probe` was the only NVAPI consumer until then, and it exists so the vendoring is verified rather than asserted. This row said no source existed for six days after one did, recorded 2026-09-09 rather than repaired quietly. This row previously claimed the vendoring in the present tense while `third_party/` held only `vulkan-headers`; `legal/` had already caught the identical claim about itself and gained a bidirectional gate, which is what made the real vendoring a red-then-green |
|
||||
| CPU/board sensors | LibreHardwareMonitorLib ≥ 0.9.6 (PawnIO) — **optional**, elevated only |
|
||||
| Tier-2 fallback | **There is none, and Tier 2 is not a measurement.** Owner decision 2026-08-28: the ladder is two rungs — hooked, or duration + sensors + the reason. ~~ETW-based, no injection~~; ~~Intel PresentMon console binary~~ dropped 2026-08-27 after §S31 retired it. Whether a shipped build ever regains a no-injection measurement is `docs/20_OPEN_QUESTIONS.md` §G |
|
||||
@@ -65,12 +67,20 @@ A C++ DLL (`FrameLedger.Overlay.dll`) is injected into games the user explicitly
|
||||
FrameLedger.slnx # XML solution format (SDK default since .NET 10)
|
||||
NOTICE # copyright + the GPLv3 section 7 additional terms (beta.12, D45)
|
||||
CONTRIBUTING.md FORKING.md CODE_OF_CONDUCT.md # for people who build, contribute or redistribute
|
||||
LIMITATIONS.md ACCESSIBILITY.md # what the software cannot do; the accessibility statement (D36, D88)
|
||||
global.json # pins the SDK band — see 12_BUILD
|
||||
RELEASE_LINE # `main`, or `alpha` on the alpha branch (D73, 2026-10-31) — 12_BUILD §The alpha line
|
||||
build.ps1 # the quality gate; CI runs this identical script
|
||||
SonarQube.Analysis.xml # SonarCloud's settings for ci.yml's sonarcloud job (D68, 2026-10-25; it replaced
|
||||
.config/dotnet-tools.json # .sonarcloud.properties) and the scanner it runs — 13_CI_CD §SonarCloud
|
||||
qodana.yaml # Qodana's settings for .github/workflows/qodana.yml (D93, 2026-11-10): the linter, the
|
||||
# solution, a gate of zero problems; the inspections' severities are .editorconfig's
|
||||
# resharper_* keys — 13_CI_CD §Qodana
|
||||
src/
|
||||
native/
|
||||
FrameLedger.Overlay/ # C++20 DLL injected into the game (hooks + ring writer + optional overlay)
|
||||
FrameLedger.Injector/ # C++20 static lib: launch/attach injection, AC guard probe
|
||||
FrameLedger.Injector/ # C++20 static lib: launch/attach injection, AC guard probe; also builds
|
||||
# FrameLedger.Guard.dll, the guard's C ABI the Agent loads (line added 2026-10-14)
|
||||
FrameLedger.VkLayer/ # C++20 Vulkan implicit layer DLL + manifest JSON
|
||||
FrameLedger.Shm/ # header-only: ring buffer + record layout, shared by native & C# (mirrored)
|
||||
FrameLedger.NvapiBridge/ # C++ DLL loaded by the Agent (never a game): NVAPI telemetry, NGX state (P2 PR-E2)
|
||||
@@ -140,7 +150,8 @@ tools/ # accuracy-check, changelog-check, chokepoint-che
|
||||
# release-notes, rules-validate, test-artifacts-check, vendor-exports,
|
||||
# versioninfo-check, vklayer-blastradius, fps-impact-runbook,
|
||||
# wiki-build (beta.17: builds and checks the wiki; the wiki-check gate),
|
||||
# buildid-check (beta.18: the release's build id in the shipped natives)
|
||||
# buildid-check (beta.18: the release's build id in the shipped natives),
|
||||
# docs-split-check (beta.24, D66: CHANGELOG/HANDOFF and their parts agree)
|
||||
# (six names added 2026-10-04)
|
||||
# (PowerShell). This line used to name three, one of which
|
||||
# — resx-audit — ~~does not exist~~ exists since 2026-09-13 with
|
||||
@@ -158,7 +169,7 @@ guide/ # the user guide (beta.12, D44): ~~eight~~ short
|
||||
# (twelve since beta.17, D54: the screens, every setting, troubleshooting, a glossary;
|
||||
# and the guide is the wiki's End-user part)
|
||||
wiki/ # the wiki's own pages (beta.17, D53): Home, _Sidebar, the developer pages. wiki.yml
|
||||
# publishes them with guide/ and LIMITATIONS.md to the Wiki tab at a release;
|
||||
# publishes them with guide/, LIMITATIONS.md and ACCESSIBILITY.md to the Wiki tab at a release;
|
||||
# tools/wiki-build.ps1 assembles and checks them (build.ps1 wiki-check)
|
||||
docs/ legal/ legal/licenses/
|
||||
```
|
||||
@@ -167,9 +178,9 @@ Dependency direction: `App/Agent → Application → Domain`; **`Application →
|
||||
|
||||
## Coding conventions
|
||||
|
||||
**C# —** `Nullable enable`, `TreatWarningsAsErrors`, `AnalysisLevel latest-all`, file-scoped namespaces, Roslynator + Meziantou + VS Threading analyzers, `dotnet format` clean. Async suffixed `Async`, `ConfigureAwait(false)` off the UI. All user-visible strings from `.resx`. Timestamps UTC (unix-ms in SQLite); QPC ticks only inside the capture pipeline.
|
||||
**C# —** `Nullable enable`, `TreatWarningsAsErrors`, `AnalysisLevel latest-all`, file-scoped namespaces, Roslynator + Meziantou + VS Threading analyzers, `dotnet format` clean. Qodana Community for .NET (ReSharper's inspections) reads the C# and the XAML in an advisory workflow of its own, with a gate of zero problems *(since 2026-11-10, D93 — `13_CI_CD` §Qodana)*: fix what it reports, or switch the inspection off in `.editorconfig` with the reason beside it — never in `qodana.yaml`, never without one. Async suffixed `Async`, `ConfigureAwait(false)` off the UI. All user-visible strings from `.resx`. Timestamps UTC (unix-ms in SQLite); QPC ticks only inside the capture pipeline.
|
||||
|
||||
**C++ —** `clang-format` (LLVM base, 4-space, 120 col) enforced in CI. No STL containers that allocate in hook paths. No `std::mutex` in hook paths. `-D_HAS_EXCEPTIONS=0` in the Overlay target. Every hook entry point wrapped per the `FL_HOOK_GUARD` macro (`17_HOOK_ENGINE`). Static analysis: ~~`/analyze` + clang-tidy (`bugprone-*`, `cert-*`, `concurrency-*`)~~ CodeQL (`codeql.yml`, a required check); `/analyze` and clang-tidy are not configured *(corrected 2026-10-04)*.
|
||||
**C++ —** `clang-format` (LLVM base, 4-space, 120 col) enforced in CI. No STL containers that allocate in hook paths. No `std::mutex` in hook paths. `-D_HAS_EXCEPTIONS=0` in the Overlay target. Every hook entry point wrapped per the `FL_HOOK_GUARD` macro (`17_HOOK_ENGINE`). Static analysis: ~~`/analyze` + clang-tidy (`bugprone-*`, `cert-*`, `concurrency-*`)~~ CodeQL (`codeql.yml`, a required check); `/analyze` and clang-tidy are not configured *(corrected 2026-10-04)*. SonarCloud analyses the C++ too, from CMake's compilation database, in `ci.yml`'s advisory `sonarcloud` job *(since 2026-10-25, D68 — `13_CI_CD` §SonarCloud)*.
|
||||
|
||||
**Licence header —** every first-party source file (`.cs .cpp .h .inl .ps1 .xaml`) opens with two comment lines, `SPDX-License-Identifier: GPL-3.0-only` and `Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE` (beta.12, owner decision D45). GPLv3 §7 requires additional terms to be named in the source files, and `NOTICE` holds them — (b) preserve the notices, (c) mark modified versions, (e) no trademark rights in the name. `tools/notice-check.ps1` is a `build.ps1` gate; `-Fix` writes a missing header. `src/native/third_party/` is excluded.
|
||||
|
||||
@@ -189,6 +200,8 @@ The version handshake is wired end to end as of 2026-08-05: `FlGuardBuildId` giv
|
||||
- Hook-path changes state measured overhead in the PR body (`14_TESTING` §Hook overhead).
|
||||
- Any new hook is listed in `17_HOOK_ENGINE` §Hook inventory and justified against rule 4.
|
||||
- New user-visible strings exist in `en`, `vi`, `ja`.
|
||||
- A change to what the App shows keeps `ACCESSIBILITY.md` §For contributors (names, theme colours, nothing by colour alone,
|
||||
keyboard reach) and updates that page when it moves what works or what does not (D88).
|
||||
- Any deviation from a doc updates that doc in the same PR.
|
||||
|
||||
## Reading order
|
||||
@@ -196,7 +209,10 @@ The version handshake is wired end to end as of 2026-08-05: `FlGuardBuildId` giv
|
||||
0. **`docs/HANDOFF.md` — what to do next and in what order.** It carries sequencing,
|
||||
decisions that live in no other file, and the traps that cost a cycle each. It
|
||||
deliberately carries **no status**: it points at the four files that do. Start there
|
||||
if you are picking up work; start at 1 if you are learning the system.
|
||||
if you are picking up work; start at 1 if you are learning the system. *(Since beta.24, D66, the history of every
|
||||
train, the passed owner-only items and the traps live in `docs/handoff/`; HANDOFF.md's §How this file is split and
|
||||
§Decisions index resolve every old citation. CHANGELOG.md likewise keeps `[Unreleased]` and links each release's
|
||||
file under `docs/changelog/`.)*
|
||||
1. `docs/19_SAFETY_AND_ANTICHEAT.md` — the guard, the refusal list, what we will not build
|
||||
2. `docs/01_ARCHITECTURE.md` — processes, injection flow, lifecycle
|
||||
3. `docs/02_SPEC.md` — FR/NFR ids used everywhere
|
||||
@@ -209,10 +225,14 @@ The version handshake is wired end to end as of 2026-08-05: `FlGuardBuildId` giv
|
||||
10. Remaining (`09`–`15`).
|
||||
11. **`LIMITATIONS.md`** (repository root; shown in the App under Help ▸ Limitations) — what the WHOLE software cannot
|
||||
do, in the user's words, each item linked to its details. When a change moves a limit, the page changes in the same
|
||||
PR (D36, 2026-09-27). **`docs/LIST_GAME_TESTED.md`** — the real games FrameLedger has been run with and what each
|
||||
PR (D36, 2026-09-27). **`ACCESSIBILITY.md`** (repository root; Help ▸ Accessibility) — the accessibility statement:
|
||||
WCAG 2.2 AA through WCAG2ICT as a goal, never a claim; what works with the keyboard, a screen reader and contrast
|
||||
themes, what does not, how a barrier is reported (D88, 2026-11-09); `docs/08_UI.md` §Accessibility holds its checks.
|
||||
**`docs/LIST_GAME_TESTED.md`** — the real games FrameLedger has been run with and what each
|
||||
session measured, from a copy of the owner's ledger and the repository's own evidence (D35).
|
||||
|
||||
**Before writing native or capture code, read `docs/20_OPEN_QUESTIONS.md`.** It
|
||||
**Before writing native or capture code, read `docs/20_OPEN_QUESTIONS.md`** (its open entries; since beta.24 the
|
||||
resolved ones are in `docs/open-questions/`, a table at the end of each series lists them). It
|
||||
lists the defects and gaps that survived the doc audit — things the other
|
||||
documents cannot answer because they need an empirical result or a decision. The
|
||||
S-series items are safety items and block the first real injection. If you are
|
||||
|
||||
+10
-3
@@ -11,12 +11,15 @@ merged, and under what licence your contribution is accepted.
|
||||
- **Open an issue before anything larger than a fix**, so the approach can be agreed before the work is done.
|
||||
- **A game with anti-cheat that FrameLedger fails to detect** is a safety bug: use the *Safety gap* issue form.
|
||||
- **A vulnerability in FrameLedger itself** goes the private route in `SECURITY.md`, never a public issue.
|
||||
- **Something that cannot be reached, read or seen** — with the keyboard, a screen reader, a contrast theme — uses the
|
||||
*Accessibility problem* form; `ACCESSIBILITY.md` says what the App aims for.
|
||||
- Everyone who takes part follows the `CODE_OF_CONDUCT.md`.
|
||||
|
||||
## Building
|
||||
|
||||
You need Windows 10 22H2 or later (x64), Visual Studio 2022 with the C++ workload (MSVC v143), CMake 3.28 or later,
|
||||
PowerShell 7, and the .NET SDK that `global.json` pins. Then:
|
||||
You need Windows 11 (x64), Visual Studio 2022 or later with the C++ workload (MSVC v143 or later), CMake 3.28 or later,
|
||||
PowerShell 7, and the .NET SDK that `global.json` pins — .NET 11 since 0.1.0-beta.37, which Microsoft does not support
|
||||
on Windows 10 Home or Pro. Then:
|
||||
|
||||
```powershell
|
||||
./build.ps1 check
|
||||
@@ -45,13 +48,17 @@ The definition of done is the one in `CLAUDE.md`:
|
||||
- a change to the hook path states its measured overhead in the PR (`docs/14_TESTING.md` §Hook overhead);
|
||||
- a new hook is listed in `docs/17_HOOK_ENGINE.md` §Hook inventory and justified against rule 4;
|
||||
- every new user-visible string exists in `en`, `vi` and `ja` (`docs/09_I18N.md`);
|
||||
- a change to what the App shows keeps `ACCESSIBILITY.md` §For contributors — a name for every control that shows no
|
||||
text, theme colours only, nothing shown by colour alone, everything reachable by keyboard — and says in the PR what was
|
||||
checked with the keyboard and Narrator; if it moves what works or what does not, `ACCESSIBILITY.md` changes with it;
|
||||
- a change that makes a document wrong updates that document in the same PR;
|
||||
- a change under `src/` adds an entry under `## [Unreleased]` in `CHANGELOG.md`;
|
||||
- every new source file carries the licence header — `./tools/notice-check.ps1 -Fix` writes it. A file you wrote
|
||||
yourself may name you in its second line instead, in the same form:
|
||||
`Copyright (C) <year> <your name> - additional terms under GPLv3 section 7: see NOTICE`.
|
||||
|
||||
The pull-request template lists the safety checks for changes to the capture layer.
|
||||
The pull-request template lists the safety checks for changes to the capture layer, and the accessibility checks for
|
||||
changes to the user interface.
|
||||
|
||||
## What will not be merged
|
||||
|
||||
|
||||
+48
-6
@@ -8,12 +8,14 @@
|
||||
- TargetFramework's platform version selects which Windows API
|
||||
projections are available to compile against.
|
||||
- SupportedOSPlatformVersion is the floor CA1416 enforces.
|
||||
NFR-8 requires Windows 10 22H2 = build 19045. Letting the supported version
|
||||
default to the TFM's 19041 would silently accept installs three releases
|
||||
below the stated floor.
|
||||
NFR-8 names Windows 10 22H2 = build 19045 as the oldest Windows the code is
|
||||
held to (since 2026-11-11, D95: not blocked there, and neither tested nor
|
||||
supported - Microsoft supports .NET 11 on Windows 11). Letting the supported
|
||||
version default to the TFM's 19041 would silently accept installs three
|
||||
releases below that floor.
|
||||
|
||||
A bare `net10.0-windows` is wrong for a different reason: it resolves to
|
||||
net10.0-windows7.0, and CA1416 would then error on Mica, MiniDumpWriteDump
|
||||
A bare `net11.0-windows` is wrong for a different reason: it resolves to
|
||||
net11.0-windows7.0, and CA1416 would then error on Mica, MiniDumpWriteDump
|
||||
and IDXGIAdapter3::QueryVideoMemoryInfo — every Windows-10-era API this
|
||||
application is built on.
|
||||
|
||||
@@ -25,7 +27,9 @@
|
||||
nothing and CA1416 still enforces the 19045 floor at the API level.
|
||||
-->
|
||||
<PropertyGroup>
|
||||
<TargetFramework>net10.0-windows10.0.22621.0</TargetFramework>
|
||||
<!-- .NET 11 since 0.1.0-beta.37 (owner decision D94, 2026-11-11; docs/12_BUILD.md). net10.0 until then, and
|
||||
net11.0 on the alpha branch from 2026-10-31. -->
|
||||
<TargetFramework>net11.0-windows10.0.22621.0</TargetFramework>
|
||||
<SupportedOSPlatformVersion>10.0.19045.0</SupportedOSPlatformVersion>
|
||||
|
||||
<!-- x64 only (CLAUDE.md pinned stack, NFR-8). Previously asserted in prose
|
||||
@@ -67,6 +71,44 @@
|
||||
<FrameLedgerVersionFile>$(MSBuildThisFileDirectory)VERSION</FrameLedgerVersionFile>
|
||||
<Version Condition="'$(Version)' == '' And Exists('$(FrameLedgerVersionFile)')">$([System.IO.File]::ReadAllText('$(FrameLedgerVersionFile)').Trim())</Version>
|
||||
<IncludeSourceRevisionInInformationalVersion>false</IncludeSourceRevisionInInformationalVersion>
|
||||
|
||||
<!-- D73 (2026-10-31): the RELEASE LINE, from the RELEASE_LINE file beside VERSION - `main`, the betas and releases on
|
||||
the .NET that global.json pins, or `alpha`, a beta's source built to try a newer .NET from the long-lived `alpha`
|
||||
branch, where this file and global.json are two of the few lines that differ while it does (docs/12_BUILD.md
|
||||
§The alpha line).
|
||||
Not a property a command line sets: the file is the one source, release.yml refuses a tag that disagrees with it,
|
||||
and the target below refuses a value that is neither line. Every assembly carries it (the ItemGroup below), and
|
||||
Shared.BuildLine reads it at run time. -->
|
||||
<FrameLedgerReleaseLineFile>$(MSBuildThisFileDirectory)RELEASE_LINE</FrameLedgerReleaseLineFile>
|
||||
<FlReleaseLine Condition="Exists('$(FrameLedgerReleaseLineFile)')">$([System.IO.File]::ReadAllText('$(FrameLedgerReleaseLineFile)').Trim())</FlReleaseLine>
|
||||
|
||||
<!-- D98 (2026-11-11): THE ALPHA LINE RESTS - the betas build on the same .NET as the newest alpha (0.1.0-alpha.4,
|
||||
.NET 11.0.0), so no alpha is cut until a newer .NET is tried. An alpha built while this says true tells its user
|
||||
that the line is paused and to install the beta: a resting alpha gets no update, its anti-cheat list included
|
||||
(Shared.AlphaLine, App/Services/AlphaTexts). Stamped on both lines, read by an alpha alone. When the `alpha`
|
||||
branch starts trying a newer .NET it sets this to false there - one more line of its switch (docs/12_BUILD.md
|
||||
§The alpha line). -->
|
||||
<FlAlphaLineRests>true</FlAlphaLineRests>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<AssemblyMetadata Include="FrameLedger.ReleaseLine" Value="$(FlReleaseLine)" />
|
||||
<AssemblyMetadata Include="FrameLedger.AlphaLineRests" Value="$(FlAlphaLineRests)" />
|
||||
</ItemGroup>
|
||||
|
||||
<Target Name="FrameLedgerReleaseLineCheck" BeforeTargets="BeforeBuild" Condition="'$(FlReleaseLine)' != 'main' And '$(FlReleaseLine)' != 'alpha'">
|
||||
<Error Text="RELEASE_LINE at the repository root must say 'main' or 'alpha', and it says '$(FlReleaseLine)' (docs/12_BUILD.md §The alpha line)" />
|
||||
</Target>
|
||||
|
||||
<!-- The NuGet audit (2026-10-25, docs/13_CI_CD.md §Dependabot and the NuGet audit): every restore checks the WHOLE
|
||||
package graph, transitive packages included, against the advisory database, at every severity. These were the
|
||||
SDK's defaults for net10.0, written down so that a later SDK's defaults cannot move them. With
|
||||
TreatWarningsAsErrors, a vulnerable package is NU1901-NU1904 and the restore - and so the gate - is red, which
|
||||
is what happened with SQLitePCLRaw 2.1.11 (Directory.Packages.props). -->
|
||||
<PropertyGroup>
|
||||
<NuGetAudit>true</NuGetAudit>
|
||||
<NuGetAuditMode>all</NuGetAuditMode>
|
||||
<NuGetAuditLevel>low</NuGetAuditLevel>
|
||||
</PropertyGroup>
|
||||
|
||||
<!-- beta.14 (D50): every managed binary names the product and who wrote it, as the native ones always have
|
||||
|
||||
+36
-26
@@ -3,7 +3,11 @@
|
||||
<!--
|
||||
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; re-verified and bumped 2026-09-21.
|
||||
All versions verified against nuget.org on 2026-08-02; re-verified and bumped 2026-09-21; bumped again
|
||||
2026-10-25 (beta.29 PR-2) with the updates Dependabot had never proposed (docs/13_CI_CD.md §Dependabot and
|
||||
the NuGet audit), and 2026-10-26 (beta.30 PR-3): Velopack and Markdig, the SQLitePCLRaw pin dropped; and again
|
||||
2026-10-26 (beta.31, the owner's request): the .NET 10.0.14 servicing packages and the updates beta.30 had left;
|
||||
and 2026-11-11 (beta.37, D94): the three packages serviced with the runtime follow it to .NET 11.0.0.
|
||||
-->
|
||||
<PropertyGroup>
|
||||
<ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
|
||||
@@ -31,11 +35,13 @@
|
||||
net10.0. The package ships no licence file, so its text is a reviewed override
|
||||
(tools/license-overrides/Markdig.txt). HTML is disabled in the pipeline (App/Markdown/MarkdownRenderer.cs).
|
||||
-->
|
||||
<PackageVersion Include="Markdig" Version="1.4.0" />
|
||||
<PackageVersion Include="Markdig" Version="1.5.0" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup Label="Hosting and logging">
|
||||
<PackageVersion Include="Microsoft.Extensions.Hosting" Version="10.0.12" />
|
||||
<!-- The three packages serviced with the runtime follow it: this one, Microsoft.Data.Sqlite and
|
||||
System.Diagnostics.EventLog (docs/12_BUILD.md). -->
|
||||
<PackageVersion Include="Microsoft.Extensions.Hosting" Version="11.0.0" />
|
||||
<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" />
|
||||
@@ -44,44 +50,42 @@
|
||||
|
||||
<ItemGroup Label="Storage">
|
||||
<!-- No EF: Dapper over Microsoft.Data.Sqlite (CLAUDE.md pinned stack). -->
|
||||
<PackageVersion Include="Microsoft.Data.Sqlite" Version="10.0.12" />
|
||||
<PackageVersion Include="Dapper" Version="2.1.86" />
|
||||
<PackageVersion Include="Microsoft.Data.Sqlite" Version="11.0.0" />
|
||||
<PackageVersion Include="Dapper" Version="2.1.89" />
|
||||
<!--
|
||||
Transitive pin, not a direct dependency.
|
||||
|
||||
Microsoft.Data.Sqlite 10.0.10 resolves SQLitePCLRaw.lib.e_sqlite3 2.1.11,
|
||||
which carries GHSA-2m69-gcr7-jv3q (high severity, vulnerable range
|
||||
<= 2.1.11) via its bundled SQLite. With TreatWarningsAsErrors that is
|
||||
NU1903 and the build fails — correctly. Pinning the bundle forward to the
|
||||
3.x line pulls a patched native library.
|
||||
|
||||
CentralPackageTransitivePinningEnabled is what makes this work from here.
|
||||
Revisit when Microsoft.Data.Sqlite ships a build that resolves a patched
|
||||
version on its own, and drop this pin rather than carrying it forever.
|
||||
No transitive pin on SQLitePCLRaw since beta.30 (2026-10-26). From the scaffold (2026-08-02) to beta.29 this held
|
||||
SQLitePCLRaw.bundle_e_sqlite3 at 3.0.5: Microsoft.Data.Sqlite 10.0.10 resolved SQLitePCLRaw.lib.e_sqlite3 2.1.11,
|
||||
which carries GHSA-2m69-gcr7-jv3q (vulnerable range <= 2.1.11) through its bundled SQLite, NU1903 under
|
||||
TreatWarningsAsErrors. Its own comment said to drop it once Microsoft.Data.Sqlite resolved a patched version on
|
||||
its own; 10.0.13 declares SQLitePCLRaw 2.1.13, and the pin had become a conflict NuGet does not report - it put a
|
||||
package built against the 2.x line on SQLitePCLRaw's 3.x line. The NuGet audit (Directory.Build.props) still
|
||||
turns a vulnerable SQLite red (docs/13_CI_CD.md §Dependabot and the NuGet audit).
|
||||
Since beta.37 (2026-11-11): Microsoft.Data.Sqlite 11 declares SQLitePCLRaw 3.0.5 itself - the 3.x line, built for
|
||||
it this time, whose engine is SourceGear's SQLite package; still no pin here. The alphas shipped that graph from
|
||||
2026-10-31.
|
||||
-->
|
||||
<PackageVersion Include="SQLitePCLRaw.bundle_e_sqlite3" Version="3.0.5" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup Label="Interop, telemetry and packaging">
|
||||
<PackageVersion Include="Microsoft.Windows.CsWin32" Version="0.3.333" />
|
||||
<PackageVersion Include="Velopack" Version="1.2.0" />
|
||||
<PackageVersion Include="Microsoft.Windows.CsWin32" Version="0.3.367" />
|
||||
<PackageVersion Include="Velopack" Version="1.2.161" />
|
||||
<!-- 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" />
|
||||
<PackageVersion Include="System.Diagnostics.EventLog" Version="11.0.0" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup Label="Analyzers (build-time only)">
|
||||
<PackageVersion Include="Roslynator.Analyzers" Version="5.0.1" />
|
||||
<PackageVersion Include="Meziantou.Analyzer" Version="3.0.299" />
|
||||
<PackageVersion Include="Microsoft.VisualStudio.Threading.Analyzers" Version="18.7.23" />
|
||||
<PackageVersion Include="Meziantou.Analyzer" Version="3.0.319" />
|
||||
<PackageVersion Include="Microsoft.VisualStudio.Threading.Analyzers" Version="18.12.1" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup Label="Testing">
|
||||
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.10.1" />
|
||||
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.11.0" />
|
||||
<!--
|
||||
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
|
||||
@@ -89,8 +93,8 @@
|
||||
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" />
|
||||
<PackageVersion Include="xunit.v3.mtp-off" Version="4.0.2" />
|
||||
<PackageVersion Include="xunit.runner.visualstudio" Version="4.0.1" />
|
||||
<!--
|
||||
FluentAssertions is pinned to the 7.x line ON PURPOSE, and must not be
|
||||
bumped to 8.x without redoing the licence analysis.
|
||||
@@ -109,7 +113,13 @@
|
||||
-->
|
||||
<PackageVersion Include="FluentAssertions" Version="[7.2.2]" />
|
||||
<PackageVersion Include="NSubstitute" Version="6.2.0" />
|
||||
<PackageVersion Include="coverlet.collector" Version="10.0.1" />
|
||||
<!--
|
||||
10.1.0 not taken on 2026-10-25: the tracker it injects into each instrumented assembly declares a constant,
|
||||
ModuleTrackerRegistryKey, whose value reflection cannot read ("Literal value was not found"), and
|
||||
NoSecondMatcherTests reads every string constant in Application, Domain and Infrastructure. Taken in beta.31
|
||||
(2026-10-26): that test now leaves out the types coverlet adds (namespace Coverlet.*), which are not ours.
|
||||
-->
|
||||
<PackageVersion Include="coverlet.collector" Version="10.1.0" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
@@ -49,6 +49,8 @@
|
||||
-->
|
||||
<ItemGroup Condition="'$(IsTestProject)' == 'true'">
|
||||
<Compile Include="$(MSBuildThisFileDirectory)tests\Shared\HarnessOverlayLogSweep.cs" Link="Shared\HarnessOverlayLogSweep.cs" />
|
||||
<!-- When a started harness is really up (beta.27): the injection tests wait for its own "presenting" line. -->
|
||||
<Compile Include="$(MSBuildThisFileDirectory)tests\Shared\HarnessReady.cs" Link="Shared\HarnessReady.cs" />
|
||||
</ItemGroup>
|
||||
|
||||
<!--
|
||||
|
||||
+105
-11
@@ -5,7 +5,7 @@ hooking on for — and reading the graphics calls the game makes. That is why it
|
||||
resolution, the upscaler, frame generation and ray tracing apart. It is also where its limits come from. This
|
||||
page lists them in plain words; each item links to the document that has the details.
|
||||
|
||||
*Beta software: this page describes version 0.1.0-beta.22.*
|
||||
*Beta software: this page describes version 0.1.0-beta.37.*
|
||||
|
||||
## Games it will not measure
|
||||
|
||||
@@ -65,6 +65,17 @@ shown is recorded too, from outside the game. ([Capture](docs/04_CAPTURE.md))
|
||||
- **A session whose frame generation changed** (menus, loading, a settings change) shows the factor of the
|
||||
state it spent most of its time in, with the share of the session it covers — never an average of the two.
|
||||
([Metrics](docs/03_METRICS.md))
|
||||
- **The mix of frame-generation states** in a session's summary (since 0.1.0-beta.24) is read over five-second
|
||||
windows: frame generation that changes faster than that — the NVIDIA App's *Dynamic* mode can — reads partly as
|
||||
*Not classified*: a window in which the multiplier stepped reads between two whole multipliers and, since
|
||||
0.1.0-beta.27, is never a state of its own. A state shorter than 10 seconds is not listed. A stretch the game
|
||||
presents with almost no frame
|
||||
count of its own — shaders compiling at start, a loading screen, a menu drawn outside frame generation — reads as
|
||||
*Not classified* too. The
|
||||
multiplier chosen in a game's own menu is not read; the measured factor is its evidence. How the NVIDIA App's
|
||||
*Dynamic* ceiling and *Max refresh rate* target are stored by the driver is read from NVIDIA's own setting names,
|
||||
and has been checked against the App on one game. Sessions recorded before 0.1.0-beta.24 have no mix.
|
||||
([Metrics](docs/03_METRICS.md))
|
||||
- **Time below 30, 60 FPS and below the refresh rate** (since 0.1.0-beta.14) leaves out the small wobble of a game
|
||||
held at its limit: a frame counts as below 60 when it took 10 % longer than 1/60 s, or when the frames around it ran
|
||||
2 % slower. So a game running steadily just under the line — 59 FPS against 60 — reads partly as at it. Time below
|
||||
@@ -81,8 +92,28 @@ shown is recorded too, from outside the game. ([Capture](docs/04_CAPTURE.md))
|
||||
FidelityFX libraries. **Intel XeSS is not read** (its licence forbids it), FSR 2 and upscalers built into the
|
||||
game are not identified, and Vulkan and OpenGL games read N/A. Where no hook saw DLSS but the NVIDIA driver
|
||||
reports it, the page says it is the driver's report.
|
||||
- **The quality preset** (Quality, Balanced, …) has not been reported on any game yet, and the render
|
||||
resolution is N/A where the game's own calls do not carry it (DLSS without Streamline, for one).
|
||||
- **The quality mode** (Quality, Balanced, DLAA, …) is shown only when it is known: the NVIDIA App's override
|
||||
where the NVIDIA driver reports it applied (marked *· NVIDIA App*, since 0.1.0-beta.24), or the mode the game
|
||||
passed to a call FrameLedger reads. For FSR through AMD's FidelityFX libraries (since 0.1.0-beta.25) that is the
|
||||
mode whose render size the game asked AMD's library for and then rendered at — checked on a test program, not yet
|
||||
on a real game; a game at a dynamic resolution, one that sizes its frames without asking, and a game FrameLedger
|
||||
joined after it asked show none. For DLSS it is the options a Streamline game passes, which no game has done yet.
|
||||
The mode chosen in a game's own menu is not readable for DLSS without Streamline, and is not inferred from the
|
||||
render scale. How the driver numbers DLAA in
|
||||
its report is NVIDIA's documented value, not yet seen on a real game. The render resolution is N/A where the
|
||||
game's own calls do not carry it (DLSS without Streamline, for one). Sessions recorded before 0.1.0-beta.27 kept
|
||||
the NVIDIA driver's answer from after the game had closed, which never says DLSS ran: on a game no hook names, they
|
||||
show neither the driver's report nor the NVIDIA App's mode. ([Metrics](docs/03_METRICS.md))
|
||||
- **Which DLSS ran** (since 0.1.0-beta.24) is named only from what the session showed: the model preset the NVIDIA
|
||||
driver reports (L or M: DLSS 4.5; J or K: DLSS 4), a measured multi-frame factor (×5 or ×6: DLSS 4.5; ×3 or ×4:
|
||||
DLSS 4), the NVIDIA App's *Dynamic* frame generation that the driver reports applied (DLSS 4.5, whatever multiplier
|
||||
it chose — since 0.1.0-beta.34), or a library whose major version names one (2.x, 3.x). A *Fixed* ×5 or ×6 set in
|
||||
the App names DLSS 4.5 only when the frames show it. A 310 library with no such evidence shows its
|
||||
version only. **DLSS 5**
|
||||
(since 0.1.0-beta.34) is named where the game was seen running its neural rendering through Streamline, with the share
|
||||
of rendered frames; its library loaded and nothing seen reads *runtime loaded* — *not seen running* only where the
|
||||
Overlay looked. A game that runs neural rendering outside Streamline is not seen. Where each
|
||||
library was loaded from is read from its folder, for sessions recorded since 0.1.0-beta.24.
|
||||
- **Ray tracing** is *Yes*, *No* or *N/A* — measured from the game's ray-tracing calls on Direct3D 12, and
|
||||
N/A where FrameLedger could not look. **Path tracing is never stated as a fact**: there is no API signal
|
||||
for it. You can correct any of these by hand, and your correction is labelled as yours.
|
||||
@@ -112,7 +143,9 @@ shown is recorded too, from outside the game. ([Capture](docs/04_CAPTURE.md))
|
||||
"Fullscreen". FrameLedger reports what the game asked for.
|
||||
- The mode is sampled ten times a second in a measured session and once a second in an unmeasured one; very
|
||||
short switches can be missed. A session recovered after a crash, and every session recorded before
|
||||
beta.10, read N/A. ([Display mode](docs/03_METRICS.md#display-mode--both-tiers-beta10))
|
||||
beta.10, read N/A. Some sessions recorded before 0.1.0-beta.27 of a game in exclusive full-screen show no window or
|
||||
monitor size: the game's last moments, after its window had closed, replaced them.
|
||||
([Display mode](docs/03_METRICS.md#display-mode--both-tiers-beta10))
|
||||
|
||||
## Engine version
|
||||
|
||||
@@ -158,16 +191,32 @@ you accept the prompt. Turn it on only if you trust everything that runs under y
|
||||
|
||||
## Platform and what has been tested
|
||||
|
||||
- **Windows 10 22H2 or Windows 11, 64-bit only.**
|
||||
- **Windows 11, 64-bit only.** FrameLedger is built on .NET 11 since 0.1.0-beta.37, which Microsoft supports on
|
||||
Windows 11 and, on Windows 10, only in its LTSC and IoT editions. **Windows 10 22H2 Home and Pro are not blocked,
|
||||
not tested and not supported**: FrameLedger may run there, and nobody has checked that it does
|
||||
([Build](docs/12_BUILD.md)).
|
||||
- **It does not start at all on a processor without SSE4.2 and POPCNT** — .NET 11's requirement, which every
|
||||
processor Windows 11 accepts meets. On such a PC an update from 0.1.0-beta.36 or older installs and then does not
|
||||
start; installing 0.1.0-beta.36 again brings FrameLedger back, with your data as it was.
|
||||
- The games FrameLedger has actually been run with, and what was measured on each, are listed in
|
||||
[LIST_GAME_TESTED.md](docs/LIST_GAME_TESTED.md). Everything was measured on one machine (an NVIDIA
|
||||
GeForce RTX 5080 with an Intel Core i7-14700KF on Windows 11); other hardware is untested.
|
||||
- **No real Vulkan or OpenGL game has been measured yet** — only FrameLedger's own test program.
|
||||
- **One real Vulkan game has been measured** (Everhex Demo, 2026-10-13) **and no OpenGL game**, beyond FrameLedger's
|
||||
own test program.
|
||||
- There is **no in-game overlay**; everything is shown in the FrameLedger window.
|
||||
- **FrameLedger does not tell whether a game is safe to run.** It reads a game's files to find its engine and its
|
||||
anti-cheat, never to judge it, and recording or measuring a game vouches for nothing. Four itch.io downloads this
|
||||
project once used as examples turned out to carry malware ([details](docs/spike-notes.md)).
|
||||
|
||||
## Accessibility
|
||||
|
||||
What works with the keyboard alone, a screen reader, a contrast theme or Magnifier, what does not yet, and how to report
|
||||
a barrier is on its own page: [Accessibility](ACCESSIBILITY.md) (in the app: Help ▸ Accessibility). The largest limits:
|
||||
|
||||
- **A chart's points cannot be read one by one.** A screen reader hears its name and where its numbers are written —
|
||||
the session's figures, the tables, **File ▸ Export**; its keys move it.
|
||||
- **Windows' text size setting is not followed** — use display scaling or Magnifier.
|
||||
|
||||
## Play
|
||||
|
||||
- **Through GOG GALAXY or itch, you finish in their app.** GOG GALAXY runs the game as its own shortcuts do, and the
|
||||
@@ -176,14 +225,42 @@ you accept the prompt. Turn it on only if you trust everything that runs under y
|
||||
- **FrameLedger never starts a game as administrator.** *Start directly* does not start a game that asks for it — start
|
||||
that one from its store or its own shortcut — nor a game whose recording is off: FrameLedger starts only what it
|
||||
records. While FrameLedger itself runs as administrator, Play starts every game directly, with your standard rights.
|
||||
- **Some games will not start directly** (seen on two Steam games, 2026-10-19 and 20). Lies of P, started by *Start
|
||||
directly*, hands itself to Steam within seconds — since 0.1.0-beta.27 the game Steam then starts is recorded —, and
|
||||
Clair Obscur: Expedition 33 closes within seconds, with or without FrameLedger's hook. Each such start ends a
|
||||
measured session early, which the crash safety counts: two turn hooking off for the game. Start such a game through
|
||||
its store (Settings ▸ Games ▸ *Play button*); the notice after Play says when a Steam game may hand itself to Steam.
|
||||
([details](docs/spike-notes/23-owner-runs-2026-10-20.md))
|
||||
|
||||
## Xbox app and Microsoft Store games
|
||||
|
||||
- **Only games built on Microsoft's GDK** (since 0.1.0-beta.33) — what the Xbox app and the Microsoft Store install into
|
||||
a games folder you chose, PC Game Pass games included — are found by **Import library**. An older Store app (UWP) is
|
||||
not listed, and a game Windows has not installed for you, such as one left behind on a drive, is not offered.
|
||||
([details](docs/spike-notes/25-xbox-gdk.md))
|
||||
- **Their executables cannot be read by other programs** — Windows refuses it to anything outside the game's own
|
||||
package — so FrameLedger shows no Unreal Engine version and no *Runs as* for them, and says what it could not read
|
||||
rather than guessing. A Unity game's version still reads, from its player library.
|
||||
- **The anti-cheat list's per-game entries know Steam ids only.** An Xbox copy of a game listed there by its Steam id is
|
||||
checked like any other game — its files, its executables, the anti-cheat drivers and services on your PC — but not
|
||||
by that entry. ([Safety](docs/19_SAFETY_AND_ANTICHEAT.md), [open question](docs/20_OPEN_QUESTIONS.md))
|
||||
- **Play starts them through Windows, in either Play mode** — as their Start-menu tile does — because Windows starts
|
||||
such a game only through its package: *Start directly* cannot start one, so it is recorded once it appears, a few
|
||||
seconds after its start, and the first frames before then are not measured. ([Play](docs/08_UI.md),
|
||||
[capture](docs/04_CAPTURE.md))
|
||||
- **An older Store app (UWP), and a game Windows runs under code protection the hook cannot live under** — only
|
||||
Microsoft-signed code, no generated code, strict stack or control-flow protection — **is never hooked**: its session
|
||||
keeps its duration, your PC's sensors and the reason. Measuring a game from the Xbox app with the Vulkan graphics API
|
||||
has not been tried. ([Safety](docs/19_SAFETY_AND_ANTICHEAT.md), [open question](docs/20_OPEN_QUESTIONS.md))
|
||||
|
||||
## Game artwork
|
||||
|
||||
- **Only the Steam and GOG GALAXY apps keep pictures FrameLedger can show** (since 0.1.0-beta.23). A game's page shows
|
||||
the cover and banner those apps keep on your PC for a game they installed, read where they keep them — nothing is
|
||||
downloaded or copied. A game from itch, the Epic Games Launcher or another store, or one whose `.exe` is outside a
|
||||
store's own folder, shows a picture only once you choose one (**Edit… ▸ Choose image…**). A GOG picture needs Windows'
|
||||
WebP support, which Windows 11 and most Windows 10 installs have. ([Game page](docs/08_UI.md))
|
||||
- **Only the Steam and GOG GALAXY apps keep pictures FrameLedger can show** (since 0.1.0-beta.23) — **and, since
|
||||
0.1.0-beta.33, an Xbox game ships its own**: its square logo and its splash image, shown from its own folder. A game's
|
||||
page shows the cover and banner those apps keep on your PC for a game they installed, read where they keep them —
|
||||
nothing is downloaded or copied. A game from itch, the Epic Games Launcher or another store, or one whose `.exe` is
|
||||
outside a store's own folder, shows a picture only once you choose one (**Edit… ▸ Choose image…**). A GOG picture needs
|
||||
Windows' WebP support, which Windows 11 and most Windows 10 installs have. ([Game page](docs/08_UI.md))
|
||||
- The pictures belong to the games' owners; FrameLedger ships none ([names and trademarks](legal/TRADEMARKS.md)).
|
||||
|
||||
## Your data
|
||||
@@ -206,3 +283,20 @@ administrator prompt names an unknown publisher. Each release publishes SHA-256
|
||||
loaded until the game exits, and Windows will not let the update replace it; *Restart to update* says which file is held
|
||||
until you close that game ([details](docs/11_UPDATER.md)). Copies older than 0.1.0-beta.14 look only for stable
|
||||
releases unless you choose *Beta* in Settings ▸ Updates, and apply a downloaded update the next time they start.
|
||||
|
||||
## Alpha builds
|
||||
|
||||
*Only for an alpha — a version ending in `-alpha.N`, an experimental build on a new .NET
|
||||
([Alpha builds](guide/11-alpha-builds.md)).*
|
||||
|
||||
- **It is built to try a newer .NET — at times one Microsoft has not finished** — and has not been tested the way a
|
||||
beta is: everything on this page applies to it, and so can problems no beta has shown
|
||||
([Alpha notice](legal/ALPHA_NOTICE.md)).
|
||||
- **The alphas are paused since 0.1.0-alpha.4, and a paused alpha gets no updates** — the list of anti-cheat software
|
||||
it refuses included, which arrives only inside an update. The betas run on the same .NET 11 since 0.1.0-beta.37:
|
||||
install the latest beta over the alpha. Once ten betas have followed 0.1.0-alpha.4, an older alpha no longer finds
|
||||
it as an update ([Updater](docs/11_UPDATER.md)).
|
||||
- **It shares the beta's data folder.** It copies the database into `backups` before it first opens it, and does not
|
||||
open it if the copy cannot be made; the newest three copies are kept and older ones it made are deleted.
|
||||
- **It updates only to newer alphas**, and its update channel is locked; going back to the beta means installing the
|
||||
beta over it.
|
||||
@@ -6,14 +6,15 @@
|
||||
|
||||
**New here? Start with the [user guide](guide/README.md)** — install, record a game, read your results, stay safe with
|
||||
anti-cheat, and look after your data, a page each, then every screen, every setting and what to do when something goes
|
||||
wrong. What FrameLedger cannot do is on one page: [Limitations](LIMITATIONS.md). Both are in the app too (Help ▸ User
|
||||
guide, Help ▸ Limitations), and on the project's [wiki](https://github.com/poli0981/frameledger/wiki) with the developer
|
||||
pages.
|
||||
wrong. What FrameLedger cannot do is on one page: [Limitations](LIMITATIONS.md). How it works with the keyboard alone, a
|
||||
screen reader or a contrast theme, and how to report a barrier: [Accessibility](ACCESSIBILITY.md). All three are in the
|
||||
app too (Help ▸ User guide, Help ▸ Limitations, Help ▸ Accessibility), and on the project's
|
||||
[wiki](https://github.com/poli0981/frameledger/wiki) with the developer pages.
|
||||
|
||||
<!-- accuracy-block:begin -->
|
||||
> ⚠ **What FrameLedger actually measures today — 2026-10-13.** The software is a beta; its latest
|
||||
> **pre-release is `0.1.0-beta.22`** (2026-10-13), an unsigned installer built from that tag with its
|
||||
> checksums published beside it. The source holds the desktop app
|
||||
> ⚠ **What FrameLedger actually measures today — 2026-11-06.** The software is a beta; its latest
|
||||
> **beta is `0.1.0-beta.37`** (2026-11-11), an unsigned installer built from that tag with its
|
||||
> checksums published beside it (alphas — experimental builds that try a newer .NET — are published apart). The source holds the desktop app
|
||||
> (library, store import, charts, settings) and the background Agent, which records a session when a
|
||||
> game in the library runs (unless you switched its recording off), injects only into games you enabled
|
||||
> and only past the safety guard, and
|
||||
@@ -36,9 +37,17 @@ pages.
|
||||
> was measured. Intel XeSS is **not** read (its SDK licence
|
||||
> forbids it), and neither is an upscaler compiled into the game: those read `N/A`, or "Unknown
|
||||
> upscaler" when another vendor's hook ran in the game. Vulkan and OpenGL titles read `N/A`.
|
||||
> - **Quality preset:** not reported on any title measured. The one route this software may use — the
|
||||
> 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.
|
||||
> - **Quality mode:** shown only when it is known. When the NVIDIA App overrides DLSS Super Resolution for
|
||||
> the game and the NVIDIA driver reports that the override applied in the session, the override's mode is
|
||||
> shown and marked as the NVIDIA App's. Otherwise the mode the game itself passed: the DLSS options a
|
||||
> Streamline title passes with its per-frame call (not yet seen on a real title), or, for FSR through
|
||||
> AMD's FidelityFX libraries, the mode whose render size the game asked for and then rendered at. In
|
||||
> every other case — FSR at a dynamic resolution among them — no mode is shown.
|
||||
> - **DLSS version:** the version of each DLSS library the game loaded and whether it came from the game or from
|
||||
> the NVIDIA driver; "DLSS 4" or "DLSS 4.5" only when the session shows it (the model preset the driver reports,
|
||||
> a measured multi-frame factor, or the NVIDIA App's Dynamic frame generation that the driver reports applied);
|
||||
> "DLSS 5" only when the game was seen running its neural rendering, otherwise "runtime loaded" when its library was
|
||||
> loaded.
|
||||
> - **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
|
||||
@@ -50,12 +59,13 @@ pages.
|
||||
> (menus, loading screens, a settings change), no session-wide factor is shown: the factor, Native and
|
||||
> Displayed are those of the state that held longest — five-second windows whose ratios agree within
|
||||
> 10 %, covering at least 10 s and 10 % of the time the game was presenting — and are always shown with
|
||||
> the share of the session they cover; with no such state, the reason is shown instead. DLSS-G and FSR
|
||||
> FG are named from the calls the game makes; any other generator (XeSS-FG, one compiled into the game)
|
||||
> is shown only as active with the technology not identified, and is never named. Where a technology is
|
||||
> named but its frames could not be counted, or frame generation is not measured, the software shows
|
||||
> **Presented FPS** with a note on what it may include — never a Native figure. Where generated frames
|
||||
> were counted, the lows, median and stutter are taken over application frames only.
|
||||
> the share of the session they cover; with no such state, the reason is shown instead. The session
|
||||
> summary lists each state it held, with its share of the time and its own Native → Displayed rates.
|
||||
> DLSS-G and FSR FG are named from the calls the game makes; any other generator (XeSS-FG, one compiled
|
||||
> into the game) is shown only as active with the technology not identified, and is never named. Where a
|
||||
> technology is named but its frames could not be counted, or frame generation is not measured, the
|
||||
> software shows **Presented FPS** with a note on what it may include — never a Native figure. Where generated
|
||||
> frames were counted, the lows, median and stutter are taken over application frames only.
|
||||
> - **Ray tracing:** Yes/No measured on Direct3D 12 from ray-dispatch and acceleration-structure-build
|
||||
> calls; the technique and path tracing are `N/A`, and so is ray tracing on other APIs.
|
||||
> - **Display mode:** how each game's window was shown — exclusive full-screen, borderless, windowed or
|
||||
@@ -126,7 +136,7 @@ Most tools tell you your frame rate. FrameLedger tells you **what produced that
|
||||
- **Shader-compilation stutter attribution** — which frame spikes were pipeline compiles.
|
||||
- **PC latency** when the game uses Reflex.
|
||||
|
||||
Plus the usual: Avg / Min / Max / Median FPS, 1% Low, 0.1% Low, frametime distributions, stutter metrics, CPU/GPU temperatures, session history, cross-session comparison, and Steam/GOG/Epic/itch.io library import. UI in **English / Tiếng Việt / 日本語**.
|
||||
Plus the usual: Avg / Min / Max / Median FPS, 1% Low, 0.1% Low, frametime distributions, stutter metrics, CPU/GPU temperatures, session history, cross-session comparison, and Steam/GOG/Epic/itch.io/Xbox library import. UI in **English / Tiếng Việt / 日本語**.
|
||||
|
||||
## How it works — and the trade-off, stated plainly
|
||||
|
||||
@@ -159,7 +169,8 @@ The tier is recorded on every session and shown in the UI. Metrics unavailable a
|
||||
|
||||
## Requirements
|
||||
|
||||
- Windows 10 (22H2) or Windows 11, 64-bit
|
||||
- Windows 11, 64-bit. Windows 10 (22H2) is not blocked, but FrameLedger is built on .NET 11 since 0.1.0-beta.37, which Microsoft does not support on Windows 10 Home or Pro, and FrameLedger has never been tested there
|
||||
- A processor with SSE4.2 and POPCNT — any that Windows 11 accepts. Without them FrameLedger does not start
|
||||
- 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
|
||||
|
||||
@@ -167,7 +178,7 @@ Elevation is **optional — for everything.** Hooked capture is the normal path
|
||||
|
||||
## Install
|
||||
|
||||
> **The latest pre-release is `v0.1.0-beta.22` (2026-10-13); before it `v0.1.0-beta.21` (2026-10-13), `v0.1.0-beta.20` (2026-10-12), `v0.1.0-beta.19` (2026-10-12), `v0.1.0-beta.18` (2026-10-07), `v0.1.0-beta.17` (2026-10-07), `v0.1.0-beta.16` (2026-10-06), `v0.1.0-beta.15` (2026-10-06), `v0.1.0-beta.14` (2026-10-06), `v0.1.0-beta.13` (2026-10-04), `v0.1.0-beta.12` (2026-10-04), `v0.1.0-beta.11` (2026-10-03), `v0.1.0-beta.10` (2026-09-28), `v0.1.0-beta.9` (2026-09-26), `v0.1.0-beta.8` (2026-09-25), `v0.1.0-beta.7` (2026-09-23), `v0.1.0-beta.6` (2026-09-23), `v0.1.0-beta.5` (2026-09-22), `v0.1.0-beta.4` (2026-09-21), `v0.1.0-beta.3` (2026-09-21), `v0.1.0-beta.2` (2026-09-17) and `v0.1.0-beta.1` (2026-09-16).** They are pre-releases: read `CHANGELOG.md`'s section for the one you install — what it measures, what it does not yet, and how to update — before installing. A source build is `docs/12_BUILD.md`.
|
||||
> **The latest beta is `v0.1.0-beta.37` (2026-11-11); before it `v0.1.0-beta.36` (2026-11-10), `v0.1.0-beta.35` (2026-11-09), `v0.1.0-beta.34` (2026-11-06), `v0.1.0-beta.33` (2026-11-03), `v0.1.0-beta.32` (2026-10-31), `v0.1.0-beta.31` (2026-10-26), `v0.1.0-beta.30` (2026-10-26), `v0.1.0-beta.29` (2026-10-25), `v0.1.0-beta.28` (2026-10-20), `v0.1.0-beta.27` (2026-10-20), `v0.1.0-beta.26` (2026-10-19), `v0.1.0-beta.25` (2026-10-19), `v0.1.0-beta.24` (2026-10-19), `v0.1.0-beta.23` (2026-10-14), `v0.1.0-beta.22` (2026-10-13), `v0.1.0-beta.21` (2026-10-13), `v0.1.0-beta.20` (2026-10-12), `v0.1.0-beta.19` (2026-10-12), `v0.1.0-beta.18` (2026-10-07), `v0.1.0-beta.17` (2026-10-07), `v0.1.0-beta.16` (2026-10-06), `v0.1.0-beta.15` (2026-10-06), `v0.1.0-beta.14` (2026-10-06), `v0.1.0-beta.13` (2026-10-04), `v0.1.0-beta.12` (2026-10-04), `v0.1.0-beta.11` (2026-10-03), `v0.1.0-beta.10` (2026-09-28), `v0.1.0-beta.9` (2026-09-26), `v0.1.0-beta.8` (2026-09-25), `v0.1.0-beta.7` (2026-09-23), `v0.1.0-beta.6` (2026-09-23), `v0.1.0-beta.5` (2026-09-22), `v0.1.0-beta.4` (2026-09-21), `v0.1.0-beta.3` (2026-09-21), `v0.1.0-beta.2` (2026-09-17) and `v0.1.0-beta.1` (2026-09-16).** They are pre-releases: read the notes of the one you install — `CHANGELOG.md` links each release's own file under `docs/changelog/` — for what it measures, what it does not yet, and how to update, before installing. A source build is `docs/12_BUILD.md`.
|
||||
|
||||
1. Download the latest `FrameLedger.App-win-Setup.exe` from [Releases](https://github.com/poli0981/frameledger/releases). It installs into `%LOCALAPPDATA%\FrameLedger.App`; your data stays in `%LOCALAPPDATA%\FrameLedger`, and uninstalling asks before touching it.
|
||||
2. SmartScreen may warn — releases are not code-signed (free, open-source project). Verify the SHA-256 checksum published with each release, then **More info → Run anyway**.
|
||||
@@ -194,7 +205,8 @@ FrameLedger is GPL-3.0-only free software, and you are welcome to build it, chan
|
||||
- **Build it:** [`docs/12_BUILD.md`](docs/12_BUILD.md) — `./build.ps1 check` is the whole quality gate, the same one CI runs.
|
||||
- **Contribute:** [`CONTRIBUTING.md`](CONTRIBUTING.md) — the definition of done, what will not be merged, and that a
|
||||
contribution is licensed GPL-3.0-only with the [`NOTICE`](NOTICE) terms (no CLA). Conduct:
|
||||
[`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md). Security reports: [`SECURITY.md`](SECURITY.md).
|
||||
[`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md). Security reports: [`SECURITY.md`](SECURITY.md). Accessibility — the goal,
|
||||
the checks and how a barrier is reported: [`ACCESSIBILITY.md`](ACCESSIBILITY.md).
|
||||
- **Fork or redistribute:** [`FORKING.md`](FORKING.md) — what the GPL asks of anyone who distributes builds, and the names
|
||||
a fork must change so it does not share FrameLedger's update feed, install folder, data, pipe or Vulkan layer.
|
||||
- **Find your way around:** the [wiki](https://github.com/poli0981/frameledger/wiki)'s developer pages are short, and each
|
||||
@@ -216,4 +228,4 @@ GPU telemetry is layered so the project never depends on a proprietary vendor li
|
||||
|
||||
---
|
||||
|
||||
**Status:** pre-release (beta). Twenty-two tagged pre-releases so far; see `CHANGELOG.md` for what each one changed and the accuracy block at the top of this file for what is and is not measured. It is not feature-complete, it certainly still has bugs, and `legal/DISCLAIMER.md` §0 says what that means for you.
|
||||
**Status:** pre-release (beta). Twenty-three 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.
|
||||
@@ -0,0 +1 @@
|
||||
alpha
|
||||
@@ -0,0 +1,84 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!--
|
||||
SonarCloud, analysed from CI since 2026-10-25 (docs/13_CI_CD.md §SonarCloud, owner decision D68): ci.yml's
|
||||
`sonarcloud` job passes this file to the SonarScanner for .NET's begin step (/s:). It replaces
|
||||
.sonarcloud.properties, which only Automatic Analysis read (D67). The project key, the organisation, the version
|
||||
and the token are given on the command line; everything that does not change from one run to the next is here.
|
||||
-->
|
||||
<SonarQubeAnalysisProperties xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.sonarsource.com/msbuild/integration/2015/1">
|
||||
|
||||
<Property Name="sonar.host.url">https://sonarcloud.io</Property>
|
||||
|
||||
<!--
|
||||
What is not FrameLedger's code, or not code at all:
|
||||
- src/native/third_party: the vendored SDK headers (NVAPI, Streamline, FidelityFX, Vulkan-Headers), consumed
|
||||
unmodified (each folder's README says so and license-check holds it).
|
||||
- Strings.Designer.cs: generated by tools/resx-gen.ps1.
|
||||
- dxr_raygen_dxil.h: a compiled shader as a byte array, generated.
|
||||
- vendor-stubs: test fixtures that carry the vendors' export names and signatures on purpose.
|
||||
- tests/fixtures: the detection corpus (empty marker binaries and expected JSON).
|
||||
- legal/licenses, docs/vendor-exports.json: licence texts and a generated export list.
|
||||
- Migrations: SQLite scripts, which a SQL analyser reads as another dialect.
|
||||
And, since the scanner reads the whole checkout for the languages it finds outside the projects (PowerShell,
|
||||
YAML, JSON), what a build writes into it: the native build tree with the sources CMake fetched into it, out/,
|
||||
every project's bin/ and obj/, and the test results the coverage comes from.
|
||||
-->
|
||||
<Property Name="sonar.exclusions">src/native/third_party/**,**/Strings.Designer.cs,src/native/tools/hook-harness/dxr_raygen_dxil.h,src/native/tools/vendor-stubs/**,tests/fixtures/**,legal/licenses/**,docs/vendor-exports.json,src/FrameLedger.Infrastructure/Persistence/Migrations/**,build/**,out/**,**/bin/**,**/obj/**,**/TestResults/**</Property>
|
||||
|
||||
<!-- Tests repeat their arrange steps on purpose; duplication there is not a defect. -->
|
||||
<Property Name="sonar.cpd.exclusions">tests/**,src/native/tests/**</Property>
|
||||
|
||||
<Property Name="sonar.sourceEncoding">UTF-8</Property>
|
||||
|
||||
<!--
|
||||
The native code: CMake's compilation database for the x64-release preset, which the job configures before the
|
||||
begin step. The sources reach the analysis through FrameLedger.Infrastructure.csproj's FlNativeSource items,
|
||||
because the scanner analyses only files an MSBuild project names. Reported against C++20, the standard
|
||||
src/native/CMakeLists.txt sets.
|
||||
-->
|
||||
<Property Name="sonar.cfamily.compile-commands">build/native/x64-release/compile_commands.json</Property>
|
||||
<Property Name="sonar.cfamily.reportingCppStandardOverride">c++20</Property>
|
||||
|
||||
<!--
|
||||
The gate's coverage: build.ps1 writes OpenCover beside the Cobertura that tools/coverage-gate.ps1 reads, one
|
||||
report per test project in TestResults/<guid>/. The second copy the trx logger keeps under In/ is not matched.
|
||||
-->
|
||||
<Property Name="sonar.cs.opencover.reportsPaths">tests/*/TestResults/*/coverage.opencover.xml</Property>
|
||||
|
||||
<!--
|
||||
Coverage is measured for the C# only. SonarCloud counts the executable lines of a file no report covers as
|
||||
uncovered - the first analysis read build.ps1's 232 lines to cover, every one uncovered, and failed the gate on the
|
||||
two a pull request changed - so the PowerShell tools (tested by their own -SelfTest cases, which no coverage tool
|
||||
reads) and the native code (Catch2 suites and the injection tests, with no coverage collector) are left out of the
|
||||
coverage figures. They are analysed for issues as everything else is.
|
||||
-->
|
||||
<Property Name="sonar.coverage.exclusions">**/*.ps1,**/*.psm1,src/native/**</Property>
|
||||
|
||||
<!--
|
||||
Roslynator, Meziantou, the VS threading analyzers and the .NET analyzers already gate the build (warnings as
|
||||
errors); what they report at a lower severity is the project's choice. Only SonarCloud's own rules are imported.
|
||||
-->
|
||||
<Property Name="sonar.cs.roslyn.ignoreIssues">true</Property>
|
||||
|
||||
<!--
|
||||
Two rules this project breaks by design everywhere they apply (the triage of 2026-10-19 in docs/13_CI_CD.md
|
||||
accepted every instance):
|
||||
- S8417, sequentially consistent atomics: the SPSC ring and the hook counters use explicit acquire/release and
|
||||
relaxed orders on purpose (07_IPC); sequential consistency would add fences on the per-present path. The rule
|
||||
key's repository is a wildcard because a header is indexed as C and a source file as C++.
|
||||
- csharpsquid:S6640, unsafe code: interop with the native layer and the shared-memory mirror, confined to
|
||||
Infrastructure and Shared (CLAUDE.md: the native layer is reachable only through Infrastructure).
|
||||
-->
|
||||
<Property Name="sonar.issue.ignore.multicriteria">atomics,unsafeInfrastructure,unsafeShared</Property>
|
||||
<Property Name="sonar.issue.ignore.multicriteria.atomics.ruleKey">*:S8417</Property>
|
||||
<Property Name="sonar.issue.ignore.multicriteria.atomics.resourceKey">src/native/**/*</Property>
|
||||
<Property Name="sonar.issue.ignore.multicriteria.unsafeInfrastructure.ruleKey">csharpsquid:S6640</Property>
|
||||
<Property Name="sonar.issue.ignore.multicriteria.unsafeInfrastructure.resourceKey">src/FrameLedger.Infrastructure/**/*</Property>
|
||||
<Property Name="sonar.issue.ignore.multicriteria.unsafeShared.ruleKey">csharpsquid:S6640</Property>
|
||||
<Property Name="sonar.issue.ignore.multicriteria.unsafeShared.resourceKey">src/FrameLedger.Shared/**/*</Property>
|
||||
|
||||
<!-- The end step waits for the quality gate, so a failed gate is a red job, not a check nobody opens. -->
|
||||
<Property Name="sonar.qualitygate.wait">true</Property>
|
||||
<Property Name="sonar.qualitygate.timeout">600</Property>
|
||||
|
||||
</SonarQubeAnalysisProperties>
|
||||
@@ -285,8 +285,11 @@ function Invoke-Managed([bool]$FixFormat) {
|
||||
# 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')
|
||||
#
|
||||
# Two coverage formats from the one run (2026-10-25, D68): Cobertura for the coverage gate below, OpenCover for
|
||||
# SonarCloud, whose C# importer reads no Cobertura. ci.yml's sonarcloud job takes them from this run's artifact.
|
||||
$testArgs = @('test', "`"$solution`"", '-c', $Configuration, '--no-build',
|
||||
'--collect:"XPlat Code Coverage;Format=cobertura,opencover"', '--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-TestsWithin 25 ($testArgs + @('--filter', 'Category!=Integration'))
|
||||
@@ -464,7 +467,7 @@ function Invoke-ProjectGates {
|
||||
Invoke-Checked 'notice-check (self-test)' { & $noticeTool -SelfTest }
|
||||
Invoke-Checked 'notice-check' { & $noticeTool -RepoRoot $repo }
|
||||
|
||||
# beta.17 (D53/D54): the GitHub Wiki is built from wiki/, guide/ and LIMITATIONS.md, and wiki.yml publishes it when a
|
||||
# beta.17 (D53/D54): the GitHub Wiki is built from wiki/, guide/, LIMITATIONS.md and (beta.35) ACCESSIBILITY.md, and wiki.yml publishes it when a
|
||||
# release is made. A link or a section that leads nowhere, a page nothing leads to, a sidebar out of the guide's
|
||||
# order, a path that names nothing or a version written into a page is red here, not on the published wiki.
|
||||
# Self-test first (nine cases, both directions), then the live assembly into a temporary folder.
|
||||
@@ -473,6 +476,14 @@ function Invoke-ProjectGates {
|
||||
Invoke-Checked 'wiki-check (self-test)' { & $wikiTool -RepoRoot $repo -SelfTest }
|
||||
Invoke-Checked 'wiki-check' { & $wikiTool -RepoRoot $repo -Check }
|
||||
|
||||
# beta.24 (D66): CHANGELOG.md and docs/HANDOFF.md keep their paths as the index of their parts under docs/changelog/
|
||||
# and docs/handoff/. A released section left in CHANGELOG.md, a release file whose heading is not its name or that
|
||||
# links relatively, or an index and its files that do not name each other both ways is red here.
|
||||
Write-Step 'docs-split-check'
|
||||
$splitTool = Join-Path $repo 'tools/docs-split-check.ps1'
|
||||
Invoke-Checked 'docs-split-check (self-test)' { & $splitTool -SelfTest }
|
||||
Invoke-Checked 'docs-split-check' { & $splitTool -RepoRoot $repo }
|
||||
|
||||
Write-Step 'changelog-check'
|
||||
$changelogTool = Join-Path $repo 'tools/changelog-check.ps1'
|
||||
if (Test-Path $changelogTool) {
|
||||
|
||||
@@ -99,6 +99,11 @@ Guard re-runs every 30 s for the life of the session; anti-cheat appearing late
|
||||
- The DLL is **not unloaded** from a live process after unhooking (threads may still be inside trampolines). It disables its hooks, stops writing, and goes dormant until the process exits. Documented, deliberate.
|
||||
- ~~UI exit does not stop the Agent when background capture is enabled; otherwise UI sends `Shutdown`.~~ *(Corrected 2026-10-04: closing the UI never stops the Agent. `Shutdown` is sent only for an update, by the uninstall hook and for the admin mode's restart; the background-capture setting was read by nothing, and its switch is gone since beta.12 — `06_DATA_MODEL` §Settings registry.)*
|
||||
- Single instance via named mutexes; the ring name is per-PID so multiple games can be captured simultaneously (rare but supported).
|
||||
- **An alpha build's `--serve` waits for the Alpha notice (D74, 2026-10-31):** it reads `legal_acceptance` after opening the
|
||||
ledger and, until the App's Legal Gate has recorded the notice at the version the build carries (`Shared.AlphaNotice`),
|
||||
logs why and exits **8** — the logon task or the admin mode's prompt can start it before the App ever showed the notice.
|
||||
The App holds its own start of the Agent while the gate is open and starts it at the Accept; the maintenance verbs
|
||||
(`--register-vklayer`, `--install-task` and their reverses) are not held. The main line serves as before.
|
||||
|
||||
> **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
|
||||
@@ -137,6 +142,8 @@ breadcrumbs\<pid>.json (corrected 2026-10-04: never created — the breadc
|
||||
tmp\<sessionGuid>.partial crash-safety flush of raw buffers, every 60 s (04_CAPTURE §Ring draining)
|
||||
covers\game-<id>-<ms>.png the images users chose for their games (beta.23, D60) — ~~covers\*.jpg, never created~~;
|
||||
a store app's own artwork is shown from where that app keeps it, never copied here
|
||||
backups\ledger-before-<v>.db an alpha build's copy of ledger.db before it first opened it, newest three (D73,
|
||||
2026-10-31; 06_DATA_MODEL §Migrations) — the alpha shares this folder with the beta
|
||||
```
|
||||
|
||||
*(beta.15, D52: `FrameLedger.exe --data-dir <folder>` reads a COPY of this folder instead — a viewer that starts and
|
||||
|
||||
+13
-7
@@ -6,13 +6,13 @@ Requirement IDs (`FR-x`, `NFR-x`) are referenced by other docs, commits, and tes
|
||||
|
||||
### FR-1 Game library
|
||||
- FR-1.1 Add game by picking an `.exe`, or drag-dropping an exe/shortcut.
|
||||
- FR-1.2 Auto-import from Steam, GOG Galaxy, Epic, itch.io with a review checklist. **Import never enables hooking for anything.**
|
||||
- FR-1.3 Editable metadata (name, cover, publisher, version, notes); auto-detected fields badged and overridable. *(The cover is built since beta.23, D60: the user's own image, else the Steam or GOG GALAXY app's artwork on this PC — `08_UI` §Games.)*
|
||||
- FR-1.2 Auto-import from Steam, GOG Galaxy, Epic, itch.io with a review checklist — and, since beta.33 (D79), the Xbox app and the Microsoft Store (GDK titles: each drive's `.GamingRoot` folders and each game's package files, `05_DETECTION` §Platform signatures & metadata). **Import never enables hooking for anything.**
|
||||
- FR-1.3 Editable metadata (name, cover, publisher, version, notes); auto-detected fields badged and overridable. *(The cover is built since beta.23, D60: the user's own image, else the Steam or GOG GALAXY app's artwork on this PC — `08_UI` §Games; since beta.33 also the square logo and splash image an Xbox game ships in its own package folder.)*
|
||||
- FR-1.4 Remove game (asks whether to keep or delete its sessions).
|
||||
- FR-1.5 "Supports" row shows shipped-capability hints (DLSS/FSR/XeSS/FG) — visually distinct from measured per-session values (`05_DETECTION` §Capability hints).
|
||||
- FR-1.7 Delete all sessions (beta.11, owner decision D40): of one game from its page, or of every game from Settings ▸ Data, after a confirmation that says how many — with their frame and sensor series and notes; the library, the settings and every consent stay. The Agent deletes them (the rows are its, `06_DATA_MODEL` §Writer ownership) and refuses while a session it would delete under is being recorded.
|
||||
- FR-1.8 Uninstalled games leave the library by themselves (beta.19, owner decision D55, amending D41): an entry whose executable has been gone for ten minutes — its drive connected and the folder it was installed in still there, so an unplugged or re-lettered drive never counts, and neither does a folder Windows will not list (`ExecutablePresenceProbeTests`) — and that has no session (stored, being recorded or waiting to be recovered) is removed by the Agent, behind Settings ▸ Data ▸ *Remove uninstalled games* (on by default). Never an entry carrying an anti-cheat block, an exception or a failed-trial mark (FR-2.2, rule 2). The App is told (`GameRemoved`).
|
||||
- FR-1.9 Play (beta.21, owner decision D59): a game's page and each library entry start the game — through the app of the store whose own records name its folder (Steam, the Epic Games Launcher, GOG GALAXY, itch), or by the agent's launch mode (FR-3.2), as Settings ▸ Games says; never as administrator, and never in a viewer (`08_UI` §Games).
|
||||
- FR-1.9 Play (beta.21, owner decision D59): a game's page and each library entry start the game — through the app of the store whose own records name its folder (Steam, the Epic Games Launcher, GOG GALAXY, itch), or by the agent's launch mode (FR-3.2), as Settings ▸ Games says; never as administrator, and never in a viewer (`08_UI` §Games). *(beta.33, D80: a game the Xbox app or the Microsoft Store installed starts through Windows in either mode — its package activated as its Start-menu tile does — and never by the agent's launch mode, which cannot start it in its package.)*
|
||||
- FR-1.6 Recording switch per entry (2026-09-23, HANDOFF D29): off, the program is not watched at all — no session, no measurement, no injection — and a session of it that is running stops. On by default; entries an old import made for Steam's own tools start with it off. The library card says "Not recorded".
|
||||
|
||||
### FR-2 Hooking consent & control (new, safety-critical — see `19_SAFETY`)
|
||||
@@ -57,7 +57,8 @@ Requirement IDs (`FR-x`, `NFR-x`) are referenced by other docs, commits, and tes
|
||||
### FR-6 History & comparison
|
||||
- FR-6.1 Sessions table per game: date, duration, tier badge, Native, Displayed, FG×, lows, resolution + upscaler, RT/PT/RR chips, crash badge, tags.
|
||||
- FR-6.2 Compare 2–5 sessions; **mixed-tier comparisons require explicit acknowledgement** and are marked on the chart.
|
||||
- FR-6.3 Hardware snapshot per session; trend charts mark changes ("GPU driver 572.16 → 576.02").
|
||||
- FR-6.3 Hardware snapshot per session; trend charts mark changes ("GPU driver 572.16 → 576.02") — since beta.30 a
|
||||
numbered badge per day that changed, its changes listed under the chart (owner decision D70).
|
||||
- FR-6.6 Charts across a game's sessions (beta.11, owner decision D39): the Sessions tab opens with an overview of every hooked session's rate and lows (Presented FPS, or Native and Displayed where frame generation was measured; 1% and 0.1% lows), a click selecting the session; and the Trend draws more metrics beside the selected one, two units at most (the second against the right axis).
|
||||
- FR-6.4 Sessions with mid-session settings changes are excluded from trends by default, with a toggle.
|
||||
- FR-6.5 Session tags and notes.
|
||||
@@ -111,8 +112,13 @@ Draw live FPS/frametime/upscaler info inside the game. Only for games already ho
|
||||
- **NFR-5 Storage:** raw series ≤ 3 MB per hour compressed; 50 games × 50 sessions ≤ 500 MB at default retention.
|
||||
- **NFR-6 Accuracy:** per `03_METRICS` §Accuracy budget, stated per tier.
|
||||
- **NFR-7 Resilience:** power loss loses at most the last 60 s of raw data; DB never corrupts (WAL + transactions); Agent restart recovers `.partial` sessions as `interrupted`.
|
||||
- **NFR-8 OS support:** Windows 10 22H2+ and Windows 11, x64. No ARM64 in v1.
|
||||
- **NFR-9 Accessibility:** full keyboard navigation, adequate contrast in both Fluent themes, Per-Monitor V2 DPI awareness. *(What each clause means for this app, and the check that holds it: `08_UI` §Accessibility, P4 PR-8.)*
|
||||
- **NFR-8 OS support:** ~~Windows 10 22H2+ and Windows 11, x64.~~ **Windows 11, x64** — the Windows that Microsoft
|
||||
supports .NET 11 on, which FrameLedger is built on since 0.1.0-beta.37. **Windows 10 22H2 is not blocked** (the code
|
||||
is still held to it: `SupportedOSPlatformVersion` 10.0.19045.0, CA1416) **and is neither tested nor supported**
|
||||
there; a processor needs SSE4.2 and POPCNT (x86-64-v2), without which .NET 11 does not start. No ARM64 in v1.
|
||||
*(Amended 2026-11-11, owner decisions D94 and D95 — `12_BUILD` §The main line's .NET. Windows 10 was never tested
|
||||
on any version: `ACCESSIBILITY.md`, `08_UI` §Accessibility.)*
|
||||
- **NFR-9 Accessibility:** full keyboard navigation, adequate contrast in both Fluent themes, Per-Monitor V2 DPI awareness. *(What each clause means for this app, and the check that holds it: `08_UI` §Accessibility, P4 PR-8.)* *(Widened 2026-11-09, beta.35, owner decisions D88–D91: and a screen reader reads every control and value and is told what changes; Windows contrast themes are followed; nothing is shown by colour alone. The goal behind all of it is WCAG 2.2 AA as W3C's WCAG2ICT applies it to desktop software — a goal, not a conformance claim — stated to users in `ACCESSIBILITY.md`.)*
|
||||
- **NFR-10 Offline-first:** everything except updates and opt-in metadata works with zero connectivity.
|
||||
- **NFR-11 Auditability:** the entire set of hooks is enumerable in `17_HOOK_ENGINE` §Hook inventory and matches the code; a reviewer must be able to verify in minutes that nothing reads game memory.
|
||||
|
||||
@@ -120,4 +126,4 @@ Draw live FPS/frametime/upscaler info inside the game. Only for games already ho
|
||||
|
||||
**Permanently:** any evasion technique (`19_SAFETY`); reading/writing game memory; kernel drivers; hardware control (overclocking, fan curves, power limits — `18_GPU_VENDOR_APIS` is read-only); online/competitive titles.
|
||||
|
||||
**v1:** Microsoft Store/UWP/Game Pass titles (packaged-app injection constraints); macOS/Linux; cloud sync; benchmark automation; ARM64. **Tier-1 capture of 32-bit games, including most Direct3D 9 titles** — the Overlay is x64-only and an x64 DLL cannot be loaded into a 32-bit process; those titles are Tier 2, which since 2026-08-28 means **not measured at all** — duration, sensors and the reason (`17_HOOK_ENGINE` §Build profile, `20_OPEN_QUESTIONS` §Scope).
|
||||
**v1:** ~~Microsoft Store/UWP/Game Pass titles (packaged-app injection constraints)~~ *(narrowed 2026-11-03, beta.33, owner decisions D78–D80: Microsoft Store, Xbox app and PC Game Pass titles built on the GDK — full-trust packages — are in scope; what "the constraints" are was measured in `spike-notes` §25. UWP apps, which run in an app container, stay out: refused with a reason of their own)*; macOS/Linux; cloud sync; benchmark automation; ARM64. **Tier-1 capture of 32-bit games, including most Direct3D 9 titles** — the Overlay is x64-only and an x64 DLL cannot be loaded into a 32-bit process; those titles are Tier 2, which since 2026-08-28 means **not measured at all** — duration, sensors and the reason (`17_HOOK_ENGINE` §Build profile, `20_OPEN_QUESTIONS` §Scope).
|
||||
+135
-4
@@ -470,6 +470,76 @@ F_app = Σ fgEvaluations (APPLICATION frames, counted at the
|
||||
> *(Settled 2026-08-20 with the RT hooks — §RT/PT/RR, "The denominator": `rt_frame_pct` is a share of presents
|
||||
> and says so, and the tri-state is unaffected. Marked here 2026-10-04.)*
|
||||
|
||||
> ### The mix — owner decision 2026-10-19 (D62)
|
||||
>
|
||||
> **The steady state names one state; a session can hold several.** A player who tries ×2, ×3 and ×4 in one session,
|
||||
> or whose NVIDIA App runs frame generation as *Dynamic*, got the longest state alone. Since beta.24 **every** state is
|
||||
> stored beside it: `Domain.Metrics.FgMix`, over the same five-second windows the steady state is read over (one cut,
|
||||
> `FgSlices.Cut`), from where `FgWindow` starts (the claimed suffix).
|
||||
>
|
||||
> **The rule.** Each window is classified by its own `presents ÷ tokens`: **active** (≥ 1.5, with ≥ 8 samples and
|
||||
> tokens), **no frame generation** (≤ 1.05, with ≥ 8 samples and tokens — and only where a counted `none` is allowed:
|
||||
> not on the shape `FgLadder.WithholdNone` withholds, §Frame Generation), else **not classified** (too few samples, no
|
||||
> tokens, the band between 1.05 and 1.5, or a withheld `none`). The active windows are grouped by repeating the steady
|
||||
> state's own extraction on what is left — the ±10 % cluster holding the most time, pooled, redrawn once — until no
|
||||
> cluster remains; a cluster under **10 s** returns its windows to *not classified*. A state's factor, Native and
|
||||
> Displayed are its own (Σ presents ÷ Σ tokens over its windows; each rate over its own seconds); a row's share is its
|
||||
> seconds over every window's, so the rows sum to 100 % and the longest state's share is `fg_steady_share` when the
|
||||
> session has one. Rows: the states by rising factor, then *no frame generation*, then *not classified*. **Never an
|
||||
> average across states** (CLAUDE.md rule 6), and ×5 and ×6 are 20 % apart and never pool.
|
||||
>
|
||||
> **Amended 2026-10-19 (beta.26): a window needs application frames, and a ratio frame generation can produce.**
|
||||
> "≥ 8 samples and tokens" was built as eight presents and ONE token, and the owner's Silent Hill 2 session listed a
|
||||
> ×1336.0 state — the session's first ten seconds, the game compiling its shaders, presented with one token per window
|
||||
> (`spike-notes` §22); the DLSS line cited it. A window is now read only with ≥ 8 presents AND ≥ 8 application frames (`FgSlices.Slice.IsReadable`, both
|
||||
> active and *no frame generation*), and is active only up to **×8** (`FgWindow.GenerationCeiling`: no shipping
|
||||
> technology generates more than five frames per application frame, DLSS 4.5's ×6); every other window is *not
|
||||
> classified*. The steady state reads the same windows, so it can no longer pick such a stretch either. A session-wide
|
||||
> or live ratio that held above ×8 is refused as **`beyond_generation`** (after uniformity: a session that changed
|
||||
> state stays `non_uniform` and keeps its steady state and its mix). **A stored mix is read by today's rule**
|
||||
> (`FgMixRecord.Parse`): a row above ×8, or whose windows averaged fewer than eight application frames, joins the
|
||||
> not-classified time — so the session stored with the ×1336.0 row reads ×2.0, ×3.0, ×6.1, no frame generation and
|
||||
> 30 s not classified, and its shares still add up.
|
||||
>
|
||||
> **Amended 2026-10-20 (beta.27): a state is near a whole multiplier.** Every frame generation that ships multiplies by
|
||||
> a whole number — ×2 for FSR, XeSS and DLSS 3, up to ×4 for DLSS 4, up to ×6 for DLSS 4.5 — and its windows read near
|
||||
> one: 1.98, 3.01, 6.06. The owner's Silent Hill 2 session of 2026-10-20 under the NVIDIA App's *Dynamic* mode listed
|
||||
> a **×2.52** state for 12.8 s: windows in which the multiplier stepped between ×2 and ×3 read ×2.21–×2.70 — at 135 s,
|
||||
> 251 application frames followed by one generated frame and 270 by two — and three of them pooled into a state nobody
|
||||
> held (`spike-notes` §23). A window is now active only within **10 %** of a whole multiplier of two or more
|
||||
> (`FgWindow.IsNearWholeMultiplier`: ×1.8–×2.2, ×2.7–×3.3, … ×5.4–×6.6); a window between two is *not classified*, and
|
||||
> the steady state reads the same windows. A stored mix is read by the same rule (`FgMixRecord.Parse`): that session
|
||||
> reads ×2.0 27.30 %, ×3.0 62.41 %, no frame generation 2.93 % and 7.36 % not classified. Of the 70 sessions in the
|
||||
> owner's ledger copy it was the only stored row between two multipliers.
|
||||
>
|
||||
> **When there is a mix.** Only where the session's frame generation was named (`Named` / `ActiveUnidentified`) and the
|
||||
> session-wide count either stood or was refused as `NonUniform` / `AmbiguousBand` — a change of state is exactly what a
|
||||
> mix describes. Every other refusal (not counted, unattributed, interleaved streams, either saturation, no
|
||||
> evaluations, too short, no batches, and since beta.26 a ratio beyond any frame generation) gets none — slicing does not make a refused record set trustworthy, the steady
|
||||
> state's rule — and so does a session in which no state formed.
|
||||
>
|
||||
> **Stored, never replayed.** `sessions.fg_mix` (schema 0020) holds the rows as JSON (`FgMixRecord`), written by the
|
||||
> recorder's aggregation beside the steady state. A session recorded before has none and is not rebuilt: `frame_blobs`
|
||||
> keep one Generated bit per frame and lose the presents only DXGI counted, so a mix rebuilt from them would be wrong on
|
||||
> exactly the titles that need one. The summary says so in one line for a session that counted frame generation and has
|
||||
> no mix.
|
||||
>
|
||||
> **What it shows, and what it cannot.** The summary's block (`08_UI` §Session summary): a bar of the shares, then a
|
||||
> row per state — `×4.0 frame generation · 35.33% · 70 → 282 FPS · 2m 05s` —, *No frame generation* with its one rate,
|
||||
> *Not classified* with its time; shown when the mix has two rows or more (one state throughout is the readout's own
|
||||
> number). Frame generation that changes faster than the five-second windows — the NVIDIA App's *Dynamic* mode can —
|
||||
> reads partly as *not classified* rather than as a factor nobody held. Above the rows, how frame generation was SET:
|
||||
> the NVIDIA App's Frame Generation Mode from the driver profile stored with the session (*Dynamic, up to ×6, target:
|
||||
> max refresh rate*; *Fixed ×4*), or that the profile sets none — the game's own menu chose
|
||||
> (`NvidiaOverrides.FrameGenerationContext`). That line is configuration, never one of the rows. The multiplier chosen
|
||||
> in a game's menu is not read — it reaches the runtime through `sl::DLSSGOptions`, the route `HANDOFF` §2b refused —
|
||||
> so the measured row is its evidence. The dynamic ceiling (`NGX_DLSSG_DYNAMIC_MULTI_FRAME_COUNT_MAX`) is decoded as
|
||||
> `NGX_DLSSG_MULTI_FRAME_COUNT` is (frames generated per rendered frame) and the automatic target as "max refresh
|
||||
> rate"; NVIDIA's header names neither, and owner-only item 20(a) checks both against the App. *(2026-11-06, beta.34:
|
||||
> the ceiling's decode held on the owner's Phantom Blade Zero — a ceiling of 5 held states up to ×6.0, a ceiling of 2
|
||||
> nothing above ×3.0 — `spike-notes` §26. And the context line is no longer the only place the Dynamic mode shows: the
|
||||
> DLSS line names DLSS 4.5 where the driver reports Dynamic applied, D83, `05_DETECTION` §DLSS generation.)*
|
||||
|
||||
`fgEvaluations` is recorded per present by ~~the NGX/Streamline/FFX/XeSS FG hooks~~ the `slGetNewFrameToken`
|
||||
detour; where Streamline never issued a token, by the FidelityFX dispatches — new PREPARE `frameID`s, else UPSCALE
|
||||
dispatches, the FSR 3.0 host's included *(corrected 2026-10-04: NGX and XeSS have no hook)*
|
||||
@@ -550,8 +620,30 @@ carries the three shapes.
|
||||
> or memory, CLAUDE.md rule 4) and the driver's own per-process override report in full (`ngx_driver_words`: preset,
|
||||
> mode, ratio beside the masks). Both are shown as what the driver was set to do and what it says it did — "NVIDIA
|
||||
> profile …: DLSS override (preset K, Quality)" — and neither changes a measured value, a rung of the upscaler ladder or
|
||||
> the frame-generation factor: those stay what the hooks saw. A profile override the hooks contradict is two true
|
||||
> statements about different things, and the page shows both.
|
||||
> the frame-generation factor: those stay what the hooks saw. ~~A profile override the hooks contradict is two true
|
||||
> statements about different things, and the page shows both.~~ *(Struck 2026-10-19 for the quality mode only — the
|
||||
> amendment below; render size, ratio and the frame-generation factor are unchanged.)*
|
||||
>
|
||||
> **Amended 2026-10-19 (owner decision D63): the override is the standard for the quality MODE — when the driver
|
||||
> confirms it applied.** The owner, shown the note above: an NVIDIA App override is what the game ran at, so it is the
|
||||
> mode a session states. `Application.Recording.QualityResolver`, read at display time from what every session already
|
||||
> stores (`ngx_driver_words` since P2, `driver_profile` since beta.8 — so a session recorded before reads alike): when
|
||||
> DLSS super resolution ran (a hook named it, or the driver reports the feature created and evaluated) and the driver's
|
||||
> per-process report says the override applied (`ENABLED` with `PERF_MODE`, `SR_DLAA_MODE` or `SCALING_RATIO`), the mode
|
||||
> is the profile's `NGX_DLSS_SR_MODE` (documented: 0 Performance, 1 Balanced, 2 Quality, 4 DLAA, 5 Ultra Performance,
|
||||
> 6 a custom ratio with `NGX_DLSS_SR_OVERRIDE_SCALING_RATIO`), checked against the report's `performanceMode`; DLAA from
|
||||
> its bit. **The report is in NGX's own numbering, not the profile's** — measured on the owner's ledger: Silent Hill 2
|
||||
> (2026-10-13) under the App's *Ultra Performance* (profile 5) was reported as **3**, NGX's Ultra Performance, where the
|
||||
> profile's 3 is "the game's own" (Expedition 33's Quality was 2 in both). When the two disagree, or the report alone
|
||||
> carries a value that does not settle, the session reads as overridden with no mode — never the game's own value,
|
||||
> which the override replaced. Otherwise the mode the game passed to a hooked call (the Streamline byte); otherwise
|
||||
> none. Every surface says it the same way (`Formats.UpscalerOf`): *DLSS (driver-reported) Quality · NVIDIA App*,
|
||||
> *DLSS · NVIDIA App override*, *DLSS Quality*. The live card names what the report settles by itself
|
||||
> (`upscalerQualityOverride`, `07_IPC`). Nothing infers a mode from the render scale (`HANDOFF` §7a). Silent Hill 2's
|
||||
> own session reads no mode: its word lacks `CREATED | EVALUATE`, so no super resolution ran that the driver saw.
|
||||
> *(Corrected 2026-10-20: it lacked them because the word stored had been read after the game closed — §The
|
||||
> driver-reported rung. A session recorded from beta.27 keeps them; one recorded before, on a title no hook names, never
|
||||
> reads the override's mode.)*
|
||||
|
||||
From the upscaler hooks we get, per frame:
|
||||
|
||||
@@ -572,6 +664,29 @@ From the upscaler hooks we get, per frame:
|
||||
> `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.
|
||||
> *(Corrected 2026-10-19, beta.25: the ffx-api dispatch still carries no quality, and FSR's mode now comes from the
|
||||
> vendor's own query — the next note. XeSS still has no hook.)*
|
||||
|
||||
> **A second producer since beta.25 (2026-10-19, owner decision D65): FSR's mode, from the vendor's own query.**
|
||||
> `FfxApiUpscaleQualityMode` is an input to `ffxQuery`, which a title calls before it sizes its targets — "what
|
||||
> render size (`…GETRENDERRESOLUTIONFROMQUALITYMODE`) or ratio (`…GETUPSCALERATIOFROMQUALITYMODE`) does this mode
|
||||
> give at this display size?" — never to the per-frame dispatch, which carries the size alone. The Overlay hooks
|
||||
> `ffxQuery` on the four modules it hooks `ffxDispatch` on (`17_HOOK_ENGINE` §Hook inventory), keeps each answer the
|
||||
> vendor returned (one slot per mode), and an UPSCALE dispatch whose `renderSize` (and `upscaleSize`, where the title
|
||||
> states it) fits exactly ONE kept answer — a size answer exactly, a ratio answer within one pixel of
|
||||
> `display / ratio`, the vendor truncating and an engine perhaps rounding — publishes `0x10 + mode`: 16 Native AA ·
|
||||
> 17 Quality · 18 Balanced · 19 Performance · 20 Ultra Performance (offset so FSR's Native AA, 0, can never be read
|
||||
> as Streamline's `eOff`). No fit, two fits, or no query seen → `0xFF`. **A session, its segments and the live card
|
||||
> read one rule (`Domain.Metrics.QualityByte`)**: the most common told byte, and for FSR none when any FSR record
|
||||
> was rendered at a size no FSR-named record has. A dynamic resolution still matches an answer at the top of its
|
||||
> range, so the plain modal would name a mode the session mostly did not render at; `legal/ACCURACY.md` promises
|
||||
> none ("FSR at a dynamic resolution among them — no mode is shown"). A "not told" record at a named size — a
|
||||
> present that drained a frame-generation PREPARE alone, a frame before the title asked — is not that evidence. A
|
||||
> title that sizes its targets without asking, or asked before the Overlay was loaded, reads none: the honest
|
||||
> answer, not a gap. `Domain.Metrics.UpscalerNames` decodes the byte for the `fsr`, `fsr3` and `fsr4` tokens.
|
||||
> Measured on the hook harness with the vendor stub answering as the SDK documents (`fl_guard` "FSR's quality
|
||||
> mode", by size through the SDK 2.x loader and by ratio through the 1.1.x monolith); a real title is owner-only
|
||||
> item 21 (Lies of P at Quality, then Performance).
|
||||
- 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
|
||||
@@ -614,7 +729,9 @@ Tier 2 has none of this: `upscaler = unknown`, ratio `N/A`.
|
||||
>
|
||||
> **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
|
||||
> NVIDIA-app override and are then the OVERRIDE's values — *which is why, since 2026-10-19 (D63), the
|
||||
> override's mode IS the session's mode where the report says it applied: §Upscaling's amendment above*),
|
||||
> 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`
|
||||
@@ -639,6 +756,16 @@ Tier 2 has none of this: `upscaler = unknown`, ratio `N/A`.
|
||||
> 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.
|
||||
>
|
||||
> **Corrected 2026-10-20 (beta.27): every stored word had lost the rung.** The loop asked the driver once more after its
|
||||
> last drain — on a session that ended because the game closed, after the game had gone — and that answer, the last,
|
||||
> was the state (`NgxDriverState`: "the last ANSWERED reading is the state"). The driver still answers for the pid,
|
||||
> with `CREATED | EVALUATE` cleared: Expedition 33 read `0x8067F` while it ran (2026-09-06) and its stored sessions
|
||||
> `0x8007F`, the same word without the two bits. Of the 14 sessions in the owner's ledger copy in which the driver
|
||||
> answered, none kept them — so no stored session reads *DLSS (driver-reported)*, and none on an NGX-direct title under
|
||||
> an NVIDIA App override reads its mode (D63). Since beta.27 the driver is not asked once the game has gone, and the
|
||||
> two bits stand once a reading carried them: a game releasing its features on its way out no longer unsays them, and
|
||||
> every other bit is still the last reading's. Sessions recorded before keep what they stored (`spike-notes` §23).
|
||||
|
||||
**The render scale over time (beta.14, D49).** The session summary draws `100 × √(render pixels / output pixels)` — the
|
||||
per-axis scale, `100 / upscale_ratio` — as steps over the session: from the `render_res` blob where the resolution
|
||||
@@ -768,7 +895,11 @@ and how much of the time". Schema 0016 (`06_DATA_MODEL`), shared-memory region 4
|
||||
excludes a pause to within one tick at each edge, as the frame series' gap does. A mode's **share** is its milliseconds
|
||||
over the observed time (every mode but *No window*). `display_changes` counts samples whose mode differs from the one
|
||||
before, no-window samples skipped. The sizes — `display_window_*` (client area), `display_buffer_*` (back buffer),
|
||||
`display_monitor_*` and `display_monitor_hz` — are the ones seen in the mode that lasted longest; `display_source` is the
|
||||
`display_monitor_*` and `display_monitor_hz` — are the ones seen in the mode that lasted longest *(corrected 2026-10-20,
|
||||
beta.27: the last ones a sample of that mode SAW — a game leaving exclusive fullscreen closes its window while its swap
|
||||
chain's last word is under 2 s old, and those last samples, exclusive with no window, had replaced every size: two Lies
|
||||
of P and three Dark Souls III sessions stored none. A mode no sample of which saw its window keeps the back buffer
|
||||
alone)*; `display_source` is the
|
||||
strongest witness any sample had (`swapchain` > `opengl` > `window`). `sessions.swap_effect`, a column since 0001 with no
|
||||
writer, is written from region 4.
|
||||
|
||||
|
||||
+11
-2
@@ -132,6 +132,7 @@ which makes the notification more important than it was, not less.
|
||||
## Process watcher
|
||||
|
||||
- 1 Hz snapshot via `CreateToolhelp32Snapshot` (CsWin32): pid, ppid, exe path (`QueryFullProcessImageName`).
|
||||
- **One spelling of the exe path for the whole capture path (beta.33).** The watcher keys a game on the kernel's image name (`QueryFullProcessImageName`), and `TargetResolver`, which re-finds the game just before the guard, read the loader's (`Process.MainModule`) until beta.33: for a game started through a junction — a package Windows activates from `C:\Program Files\WindowsApps\<package>`, a junction to the game's own folder — the two could differ, and the session would end `TargetNotRunning` about a game the watcher had just matched. Both read `Infrastructure.Io.ProcessImagePath` now; the resolver still opens a candidate with the guard's own rights (`PROCESS_QUERY_LIMITED_INFORMATION | PROCESS_VM_READ`), so a process an anti-cheat driver closes stays `TargetUnreadable` (D21). `spike-notes` §25 measured the two spellings equal on the owner's eleven Xbox titles; one reader keeps them equal by construction (`TargetResolverTests`).
|
||||
- Watchlist match on normalized full path (~~`GetFinalPathNameByHandle`~~ `File.ResolveLinkTarget` *(corrected 2026-10-04 — `ExecutableIdentity` says why)* — junctions/symlinks), ~~filename fallback with a stale-path warning badge~~ **and a file name alone never starts a session (2026-09-23, HANDOFF D25): it can only be the entry's own executable on a drive that changed its letter (the relocator's rule), or it is not in the library.**
|
||||
- Process tree assembled from ppid chains; the **capture target** is the descendant that actually presents. In launch mode we know it; in attach mode we wait for the first ring handshake. ~~or (Tier 2) elect the PID with the most presents in the first 10 s~~ — there is no Tier-2 present stream to elect from. Re-elect if the presenting PID dies while the tree lives (level-transition relaunches).
|
||||
|
||||
@@ -160,7 +161,12 @@ which makes the notification more important than it was, not less.
|
||||
> now remembers the newest such process per executable and starts its session when the running one ends, if that one
|
||||
> ended on its own (not cancelled with the host), the process is the same (pid and start time) and it is then the
|
||||
> executable's ONLY process — a helper of a game still running has the game beside it and stays turned away, as before
|
||||
> (`CaptureOrchestratorTests`: the restart recorded, the helper not, a process that left meanwhile not). **Behaviour change:** a game whose folder moved (not its drive letter) records nothing until
|
||||
> (`CaptureOrchestratorTests`: the restart recorded, the helper not, a process that left meanwhile not). *(beta.27,
|
||||
> 2026-10-20:)* a launch never said it had ended on its own, so after **Play** ▸ *Start directly* nothing turned away
|
||||
> while it ran was ever recorded — Lies of P hands itself to Steam within seconds, and twice on 2026-10-19 the game
|
||||
> Steam started went unrecorded (`spike-notes` §23). A launch now says so, with the processes it and its election
|
||||
> recorded: the one it started appears to the watcher after the launch began and is turned away like any other, and a
|
||||
> launch the user stopped does not start again on it. **Behaviour change:** a game whose folder moved (not its drive letter) records nothing until
|
||||
> *Change executable* points its entry at the new file. `ProcessTree` reads ppid chains with the one rule that defeats pid
|
||||
> reuse: a child that started before its parent is not its child. `DescendantElection` picks the newest-started
|
||||
> descendant whose image is tracked — a launcher's consent does not extend to what it spawns, so the elected image
|
||||
@@ -237,6 +243,8 @@ which makes the notification more important than it was, not less.
|
||||
|
||||
**Attach mode.** Game launched from Steam/GOG/Epic normally; watcher sees it, guard runs, inject. Feature hooks install late, so early-init facts may be missed; the Overlay compensates by re-reading state on the first `EvaluateFeature` call it does observe, and the session is flagged `late_attach = true` so the UI can note that startup-time settings may be incomplete.
|
||||
|
||||
> **A game the Xbox app or the Microsoft Store installed is always attach mode (beta.33, D80).** Windows starts it through its package — **Play** runs `explorer.exe shell:AppsFolder\<AUMID>` in either mode — and started by its path it is never the game in its package (`spike-notes` §25: `CreateProcess` of the launch executable makes Windows activate the package itself, so the game is not the launcher's descendant; of an Unreal shipping executable, the game runs outside its package). So `LaunchGame` for an executable whose install root is a GDK package root answers `PackagedGame` and starts nothing (`OrchestratorOptions.IsPackaged` = `GdkPackageFiles.IsInPackage`), the watcher records the game when it appears, and the session is `late_attach`: §25 measured an Unreal title's D3D device 2.4–3.7 s after its process, a Unity title's 0.1–1.2 s, so what ran before the hook is in `dxgiPresentsBeforeHook`. The Vulkan layer's switch (`FRAMELEDGER_ENABLE_VK_LAYER=1`) is set only by `ProcessLauncher`, so a Vulkan GDK title cannot get it (`20_OPEN_QUESTIONS` §G).
|
||||
|
||||
~~Steam users can also set FrameLedger as a launch option wrapper; documented in the UI rather than automated (never modify a user's Steam config for them).~~ *(Corrected 2026-10-04: not built — there is no wrapper entry point and no UI text; a game started from Steam is recorded in attach mode. The parenthesis still holds: never modify a user's Steam config for them.)*
|
||||
|
||||
## The guard
|
||||
@@ -420,7 +428,8 @@ because a layer cannot leave a running game's loader chain.
|
||||
> - **Recovery never throws.** A file it cannot finalize is set aside as `<guid>.partial.failed` (never retried, kept for
|
||||
> a bug report) and reported `Failed`; the next file is recovered, and the watcher starts either way.
|
||||
> - The Agent's host logs through Serilog since the same day: a background service that stops the host is now in
|
||||
> `agent-*.log`, where before it was in no file at all.
|
||||
> `agent-*.log`, where before it was in no file at all. *(Since beta.37, on .NET 11, that service's exception also
|
||||
> ends the Agent through its crash report instead of an exit 0 — `10_LOGGING` §Crash handling.)*
|
||||
|
||||
> **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
|
||||
|
||||
+91
-10
@@ -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 — **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** |
|
||||
| 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 game's preset** — since beta.24 (D63) an NVIDIA App override's mode, where that report says the override applied, is the session's quality mode, marked as the App's (`QualityResolver`) — and since beta.25 (D65) FSR's mode where the title asked FidelityFX's `ffxQuery` for the size it then dispatched, none at a dynamic resolution (`03_METRICS` §Upscaling) |
|
||||
| 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) |
|
||||
@@ -70,7 +70,7 @@ Rules are **data, not code**: `rules/detection-rules.json`, bundled ~~and updata
|
||||
|
||||
The `anticheat` block is the same file that feeds the hard guard in `19_SAFETY` — shipping it as updatable data is what lets a newly-protected game be blocked without waiting for an app release. ~~**Rules updates that touch the `anticheat` block are treated as security updates:** applied on next check regardless of the user's auto-update preference for other rules.~~ *(Corrected 2026-10-04: there is no feed and no auto-update preference, so today a newly-protected game waits for a release; the sentence is what a feed must do once built, §S20.)*
|
||||
|
||||
Signal types evaluated by `RuleEvaluator` (Domain): `file_exists`, `dir_exists`, `sibling_glob`, **`path_contains`**, `pe_company_contains`, `pe_product_contains`, `strings_contains` (bounded 8 MB scan), `manifest_field`. Combine with `all` / `any` — **not nested**, which schemaVersion 2 forbids. Version extractors: `pe_file_version` (of the sibling its `from` names, not of the executable), `pe_product_version_regex`, **`strings_regex`**, `manifest_field`, and since 2026-09-27 **`unreal_build`** (no parameter; decided in code, §Engine version). A regex extractor must capture exactly **one** group — the evaluator returns the first — and `rules-validate.ps1` refuses any other count and any pattern that does not compile (both promised by the rules file's `$comment` and enforced by nothing until beta.10).
|
||||
Signal types evaluated by `RuleEvaluator` (Domain): `file_exists`, `dir_exists`, `sibling_glob`, **`path_contains`**, `pe_company_contains`, `pe_product_contains`, `strings_contains` (bounded 8 MB scan), `manifest_field`, and since beta.33 **`root_file`** — an exact file name directly in the install root, answered from that one folder's own listing (`GameFileSnapshot.RootFiles`), so a deep walk that ran short makes its miss no less certain; a root that could not be listed makes it `Unknown`. Combine with `all` / `any` — **not nested**, which schemaVersion 2 forbids. Version extractors: `pe_file_version` (of the sibling its `from` names, not of the executable), `pe_product_version_regex`, **`strings_regex`**, `manifest_field`, and since 2026-09-27 **`unreal_build`** (no parameter; decided in code, §Engine version). A regex extractor must capture exactly **one** group — the evaluator returns the first — and `rules-validate.ps1` refuses any other count and any pattern that does not compile (both promised by the rules file's `$comment` and enforced by nothing until beta.10).
|
||||
|
||||
> `path_contains` and `strings_regex` were in the shipped data and the schema
|
||||
> and missing from this list; the schema's own `$comment` said so and nobody had
|
||||
@@ -312,6 +312,7 @@ engine compiled only, reads as not found. One Ren'Py install was measured.
|
||||
|
||||
| Platform | Signals | Metadata |
|
||||
|---|---|---|
|
||||
| Xbox *(beta.33, D79; first in the array)* | **both** `MicrosoftGame.config` and `appxmanifest.xml` directly in the install root (`root_file`, `all`): a GDK package root. First because a GDK build can ship Steam's DLL — every FINAL FANTASY Pixel Remaster from the Xbox app carries `Plugins\x86_64\steam_api64.dll` (`spike-notes` §25) — and a `root_file` miss is never `Unknown` for want of a deep walk, so a large Steam install behind it still reads *steam* | each drive's `.GamingRoot` → `<games folder>\<Game>\Content\`: `MicrosoftGame.config` (Identity, ShellVisuals, ExecutableList, StoreId) and `appxmanifest.xml` (the Application id); the package family name and its registration from Windows (`PackageFamilyNameFromId`, `GetPackagesByPackageFamily`) |
|
||||
| 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~~ *(corrected 2026-10-04: the rule has no path signal)* | `%ProgramData%\Epic\EpicGamesLauncher\Data\Manifests\*.item` matched by `InstallLocation` |
|
||||
@@ -324,9 +325,12 @@ engine compiled only, reads as not found. One Ren'Py install was measured.
|
||||
> (`StoreRecords.Owning`, as Play finds it). `Infrastructure.Art.SteamArtCache` and `GogArtCache` read them; nothing is
|
||||
> downloaded, so the *(opt-in)* online lookup in the publisher/version order below still does not exist. Epic, itch and
|
||||
> other stores keep no image files: their games show the image the user chooses, or none. The detail: `08_UI` §Games ›
|
||||
> Game detail, *The header's cover*.
|
||||
> Game detail, *The header's cover*. *(beta.33: an Xbox game ships its own — `Infrastructure.Art.XboxArtCache` reads the
|
||||
> `Square480x480Logo` (else `Square150x150Logo`) and the `SplashScreenImage` its `MicrosoftGame.config` names, inside
|
||||
> the package root only, as a square cover and the banner; `IStoreArtCache.Find` takes the owning record rather than the
|
||||
> id, because those pictures live in the install folder.)*
|
||||
|
||||
**Auto-import (FR-1.2):** Steam via `libraryfolders.vdf` → all `appmanifest_*.acf` except `SteamLibrarySource.KnownTools` (2026-09-22: Steamworks Common Redistributables, Borderless Gaming, Wallpaper Engine, SteamVR, the Proton and Steam Linux Runtime entries, Blender — tools Steam's manifests do not distinguish from games, and which became library rows the watcher recorded); GOG via `HKLM\SOFTWARE\WOW6432Node\GOG.com\Games\*`; Epic via `Manifests\*.item`; itch by receipt scan. Import presents a review checklist; nothing is launched, nothing is hooked on import.
|
||||
**Auto-import (FR-1.2):** Steam via `libraryfolders.vdf` → all `appmanifest_*.acf` except `SteamLibrarySource.KnownTools` (2026-09-22: Steamworks Common Redistributables, Borderless Gaming, Wallpaper Engine, SteamVR, the Proton and Steam Linux Runtime entries, Blender — tools Steam's manifests do not distinguish from games, and which became library rows the watcher recorded); GOG via `HKLM\SOFTWARE\WOW6432Node\GOG.com\Games\*`; Epic via `Manifests\*.item`; itch by receipt scan; *(beta.33)* Xbox by each drive's `.GamingRoot` and each game's package files. 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
|
||||
@@ -363,6 +367,22 @@ engine compiled only, reads as not found. One Ren'Py install was measured.
|
||||
> 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".
|
||||
|
||||
> **beta.33 (owner decisions D78/D79, `spike-notes` §25): the Xbox app's and the Microsoft Store's games.**
|
||||
> `XboxLibrarySource` reads each ready fixed or removable drive's `.GamingRoot` (`GamingRoots`: `RGBX`, a count, UTF-16
|
||||
> folder names relative to the drive), lists the `<games folder>\<Game>\Content\` folders that are GDK package roots
|
||||
> (`GdkPackageFiles`: `MicrosoftGame.config` beside `appxmanifest.xml`, read with DTDs prohibited and a 1 MB cap), and
|
||||
> keeps those whose package Windows says is installed for this user (`PackageFamilyNameFromId`, then
|
||||
> `GetPackagesByPackageFamily`). The record: the store id is the package family name, the install directory is `Content`
|
||||
> (the spelling the game's own process reports — never the `C:\Program Files\WindowsApps` junction, whose name carries
|
||||
> the version), the launch key is the AUMID `<family name>!<Application Id>` that Play activates, the version is the
|
||||
> package's. It names no executable, so `ExecutableLocator` ranks: the WinGDK or Win64 shipping binary over the stub the
|
||||
> package launches, the Unity player over its crash handler, never `gamelaunchhelper.exe` (a runtime helper since
|
||||
> beta.33), with the folder above `Content` as the install's name. **What cannot be read:** every game `.exe` under
|
||||
> `Content` refuses `FILE_READ_DATA` to a process outside its package, so its PE header, version resource, imports and
|
||||
> strings are not read — the architecture reads `unknown` (never "not x64", so nothing is turned off for it), no Unreal
|
||||
> version is shown, and the Unity version still reads, from `UnityPlayer.dll`. A UWP app has no `MicrosoftGame.config`
|
||||
> and is not listed (D78).
|
||||
|
||||
> **beta.19 (owner report 2026-10-12): a store's own pick can be a helper, and a launcher is not the game.** The owner's
|
||||
> A Doll's Locket - Remake (itch 5085165, RPG Maker MZ) was imported as `Dolls Locket\notification_helper.exe` — NW.js's
|
||||
> toast helper. The pick was **butler's verdict**, taken as is: butler stores a *filtered* verdict (the shallowest
|
||||
@@ -392,7 +412,7 @@ engine compiled only, reads as not found. One Ren'Py install was measured.
|
||||
> `StoreLibrarySourcesTests.ItchSkipsAVerdictCandidateThatIsARuntimeHelper` (the verdict as stored),
|
||||
> `LibraryImporterTests.AStoreTitleAlreadyInTheLibraryAtAnotherExecutableIsNotOfferedAgain`.
|
||||
|
||||
**Publisher/version order:** store manifest → PE `CompanyName`/`ProductVersion` → *(opt-in)* Steam `appdetails` lookup, cached 7 days. *(Since beta.8 the PE versions are stored beside the store's rather than instead of it — §What the files say about themselves; the page labels a store's value with its store, "Steam build 20374416".)*
|
||||
**Publisher/version order:** store manifest → PE `CompanyName`/`ProductVersion` ~~→ *(opt-in)* Steam `appdetails` lookup, cached 7 days~~ *(never built — FrameLedger makes no request to a store, `privacy.online_metadata` is reserved, and a game's artwork (beta.23, D60) is read from the store app's own files on the disk; struck 2026-10-14)*. *(Since beta.8 the PE versions are stored beside the store's rather than instead of it — §What the files say about themselves; the page labels a store's value with its store, "Steam build 20374416".)*
|
||||
|
||||
## Capability hints (explicitly labelled as such)
|
||||
|
||||
@@ -440,10 +460,71 @@ detection (`DetectionWrite`, `games.exe_machine` / `exe_file_version` / `exe_pro
|
||||
"FSR 2.2" number: the DLL's version is the SDK's, and no table of that mapping has been measured.
|
||||
|
||||
**Shipped is not loaded.** `library_versions` is what the game folder holds. What the process loaded is
|
||||
`sessions.runtime_modules` (Tier 1), and the two differ exactly when something else supplied the DLL — the NVIDIA
|
||||
App's DLSS override loads the driver's `nvngx_dlss.dll` from the driver store under the same name. The session
|
||||
summary prints the loaded list and names such a difference ("the game ships 3.7.10.0: another copy was loaded");
|
||||
it does not claim who loaded it.
|
||||
`sessions.runtime_modules` (Tier 1), and the two differ exactly when something else supplied the DLL. ~~— the NVIDIA
|
||||
App's DLSS override loads the driver's `nvngx_dlss.dll` from the driver store under the same name.~~ *(Struck
|
||||
2026-10-19: unmeasured, and the one measurement says otherwise — the owner's Silent Hill 2 session ran ×6 frame
|
||||
generation through the NVIDIA App's override and no module with a census name was loaded. Since beta.24 every module
|
||||
under `%ProgramData%\NVIDIA\NGX` is recorded whatever its name, with its folder class — §DLSS generation below —, and
|
||||
owner-only item 20(c) records what the override loads.)* *(Measured 2026-10-19, `spike-notes` §22: under the
|
||||
override, Silent Hill 2 loaded `160_E658700.bin` 310.9.16.0 and `1B0_E658703.dll` 2.14.16.0 from the NGX folder —
|
||||
names no census lists; which feature each serves is not established.)* The session summary prints the loaded list and names such a
|
||||
difference ("the game ships 3.7.10.0: another copy was loaded"); since beta.24 the DLSS line says where each DLSS
|
||||
library was loaded from (the game, the graphics driver, Windows) — by folder, never who put it there.
|
||||
|
||||
## DLSS generation — evidence-bound (beta.24, owner decision D64)
|
||||
|
||||
**What a session can say about which DLSS ran, and nothing more.** `Domain.Detection.DlssGeneration` names a
|
||||
generation only from something the session observed, strongest first; `App.Services.DlssText` prints it with what it
|
||||
rests on, every DLSS library's version and folder class (`sessions.runtime_module_sources`, schema 0021 — the class,
|
||||
never the path), and the super-resolution preset the driver reports applied:
|
||||
|
||||
| Evidence (strongest first) | Label | Where it comes from |
|
||||
|---|---|---|
|
||||
| Super-resolution render preset **L or M** that the NVIDIA driver reports applied, in a session where super resolution ran | DLSS 4.5 (2nd-gen transformer) | `ngx_driver_words` — the SR word's `PRESET` bit and `renderPreset`; presets L/M arrived with DLL 310.5.0 (NVIDIA's DLSS 4.5 release, driver 591.74) |
|
||||
| A DLSS Frame Generation state measured at **×5 or more** | DLSS 4.5 (Dynamic / 6× multi-frame generation) | `fg_mix` / `fg_factor` with `fg_mode = dlssg` |
|
||||
| The NVIDIA App's **Dynamic** frame generation — set in the game's profile and reported applied by the driver — in a session where DLSS Frame Generation was identified *(beta.34, owner decision D83)* | DLSS 4.5 (Dynamic multi frame generation, set in the NVIDIA App) | `driver_profile`'s `NGX_DLSSG_MODE` = 4 (dynamic), `ngx_driver_words`' FG word with `FG_MODE` (bit 13), `fg_mode = dlssg` |
|
||||
| Preset **J or K** reported applied | DLSS 4 (transformer) | as above |
|
||||
| A DLSS Frame Generation state at **×3 or ×4** | DLSS 4 (multi-frame generation) | as above |
|
||||
| `nvngx_dlss.dll` **2.x** | DLSS 2 | `runtime_modules` |
|
||||
| `nvngx_dlss.dll` **3.x**, or `nvngx_dlssg.dll` **1.x–3.x** | DLSS 3 | `runtime_modules` |
|
||||
| A **310.x** library alone, a CNN preset (A–F), ×2 | *no label* — the versions are shown | DLSS 4 and 4.5 ship the same major number; the preset is what names the model |
|
||||
| ~~`nvngx_dlssnr.dll` loaded~~ | ~~"DLSS 5 runtime loaded" — never a generation of these features~~ | ~~the module name is community-sourced until owner-only item 20(d) sees it load~~ *(replaced 2026-11-06 by the two rows below, D84)* |
|
||||
| DLSS 5's neural rendering **evaluated** — `kFeatureDLSS_NR` (Streamline 2.14) on some of the frames the game rendered through Streamline, seen by an Overlay that decodes it *(beta.34, owner decision D84)* | DLSS 5 (neural rendering on N % of rendered frames) — **heads the table** | `dlss_nr_pct` (schema 0022), from `FL_FEAT_SL_NEURAL_RENDERING` under `FL_HOOK_SL_NEURAL_RENDERING` |
|
||||
| `nvngx_dlssnr.dll` loaded, neural rendering not seen evaluated | "DLSS 5 runtime loaded" — and "…, not seen running" where an Overlay that decodes it drained Streamline batches and none carried it (0 %); never a generation | `runtime_modules` (the name seen on Hogwarts Legacy, 2026-11-06) and `dlss_nr_pct` |
|
||||
|
||||
**Amended 2026-11-06 (beta.34, owner decision D83): Dynamic is DLSS 4.5's.** The NVIDIA App's *Dynamic* frame
|
||||
generation and its ×6 mode exist only in DLSS 4.5, so a session the driver reports running Dynamic is DLSS 4.5 whatever
|
||||
multiplier the mode chose: the owner's Phantom Blade Zero under *Dynamic, up to ×3* held ×2.0 and ×3.0 — nine hooked sessions
|
||||
from 2026-11-03 to 11-05 — and read *DLSS 4 (a ×3.0 frame-generation state)* until then. The row needs all three: the
|
||||
profile's Dynamic (`NGX_DLSSG_MODE` = 4, NVIDIA's own name for the value), the driver's report that its frame-generation
|
||||
override applied in the game's process (the FG word's `FG_MODE` bit), and DLSS Frame Generation identified in the session
|
||||
(`fg_mode = dlssg`; its factor need not have been counted) —
|
||||
a profile set to Dynamic that the driver never applied is a setting, not evidence. The driver's own mode number is not
|
||||
read: it answers 3 under Dynamic and 1 under *Fixed* on every stored session (`spike-notes` §26), and NVIDIA's header
|
||||
names neither. A *Fixed* ×5 or ×6 is not this row — Witcher 3 under the App's Fixed ×6 still presented ×2.0 — and
|
||||
names DLSS 4.5 only where a state is measured at ×5 or more, which ranks above it.
|
||||
|
||||
Never a default preset inferred from a version: what a DLL "would" run by default is the game's and the driver's to
|
||||
decide. A preset the driver applied to a super resolution it never saw created and evaluated names the model of
|
||||
nothing and is not used (the owner's Silent Hill 2 session: preset L applied, no SR feature created — its label is
|
||||
the ×6.0 state's). **Sources:** NVAPI's `NV_NGX_DLSS_OVERRIDE_GET_STATE_PARAMS_V1` (the vendored
|
||||
`src/native/third_party/nvapi/nvapi.h`); presets L/M with DLL 310.5.0 — PCGH's DLSS 4.5 test and NVIDIA's driver
|
||||
591.74 release notes; DLSS 4.5's Dynamic MFG and 6× — NVIDIA's announcement (driver 595, RTX 50); DLSS 5 — NVIDIA's
|
||||
GTC 2026 announcement and its 2026-09-03 launch; ~~`nvngx_dlssnr.dll` — community reports only~~ `nvngx_dlssnr.dll` —
|
||||
loaded by the owner's Hogwarts Legacy with Neural Rendering on, 310.9.16.0 from the game's folder (2026-11-06,
|
||||
`spike-notes` §26), beside its Streamline plugin `sl.dlss_nr.dll`; `kFeatureDLSS_NR = 1004` — Streamline `v2.14.16`'s
|
||||
public `sl_core_types.h` (re-vendored for it, `src/native/third_party/streamline/README.md`).
|
||||
|
||||
**Amended 2026-11-06 (beta.34, owner decision D84): DLSS 5 is named where it ran.** Until then a session could say only
|
||||
that DLSS 5's runtime was LOADED — and Hogwarts Legacy, Neural Rendering on, loaded it. The Overlay's
|
||||
`slEvaluateFeature` detour now decodes `kFeatureDLSS_NR` into its own per-frame fact (`FL_FEAT_SL_NEURAL_RENDERING`,
|
||||
the feature byte's last bit, under the condition every Streamline fact shares) and publishes
|
||||
`FL_HOOK_SL_NEURAL_RENDERING` with the detour; the Agent stores the share of Streamline batches that carried it
|
||||
(`dlss_nr_pct`) **only from a writer that published that family** — an older Overlay drains the same batches and never
|
||||
sets the bit, and its silence must not read as 0 %. Above every other row because DLSS 5 is named for that feature as
|
||||
DLSS 4.5 is for its own: the session's super resolution, ray reconstruction and frame generation are the libraries the
|
||||
line lists after it. Whether the game routes neural rendering through `slEvaluateFeature` at all is owner-only item
|
||||
30(a)'s run; a title that does not reads *runtime loaded*, never *not running*.
|
||||
|
||||
## Anti-cheat pre-scan (static)
|
||||
|
||||
@@ -477,7 +558,7 @@ Three things this section previously implied that are not true, and are worth st
|
||||
> 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`,
|
||||
> `capability_flags` is written whole every run (a JSON array of the rule ids — `dlss`, `dlss_g`, `dlss_rr`, `dlss_nr` (beta.34),
|
||||
> `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.
|
||||
|
||||
+64
-6
@@ -43,7 +43,7 @@ CREATE TABLE games (
|
||||
exe_path TEXT NOT NULL UNIQUE, -- where the executable lives; rewritten by ExecutableRelocator when the
|
||||
-- SAME bytes (exe_size_bytes, exe_mtime_ms) turn up under another drive
|
||||
-- letter (2026-09-22), and by Change executable for a DIFFERENT binary
|
||||
platform TEXT NOT NULL DEFAULT 'none', -- steam|gog|epic|itch|none
|
||||
platform TEXT NOT NULL DEFAULT 'none', -- steam|gog|epic|itch|xbox|none (xbox since beta.33, D79; no CHECK constraint, so no migration)
|
||||
store_id TEXT,
|
||||
engine TEXT, engine_version TEXT,
|
||||
-- (schema 0015, ALTERed last) engine_version_source TEXT: where engine_version came from — a
|
||||
@@ -56,7 +56,8 @@ CREATE TABLE games (
|
||||
cover_path TEXT, notes TEXT, -- cover_path: written since beta.23 (D60) — the image the user chose, as
|
||||
-- covers\game-<id>-<unix ms>.png relative to the data folder (a PNG copy
|
||||
-- <= 1200 px); followed only when it is one of those names under covers\
|
||||
-- (a viewer's copy could name a share); NULL = the store app's own artwork
|
||||
-- and never through a junction or a symbolic link (a viewer's copy could
|
||||
-- name a share); NULL = the store app's own artwork
|
||||
removed_at INTEGER, -- schema 0002 (P3 PR-3): FR-1.4 "remove, keep sessions" — the row stays
|
||||
-- (sessions.game_id is NOT NULL, ON DELETE CASCADE) but leaves the
|
||||
-- library; a later launch of the same exe restores it (removed_at = NULL)
|
||||
@@ -234,7 +235,8 @@ CREATE TABLE sessions (
|
||||
|
||||
-- upscaling / FG (measured at tier 1)
|
||||
upscaler TEXT, -- none|dlss|fsr2|fsr3|fsr4|xess|nis|unknown, and fsr since 2026-09-04 (FL_UPSCALER_FSR_UNVERSIONED; added 2026-10-04)
|
||||
upscaler_quality TEXT,
|
||||
upscaler_quality TEXT, -- the hooked byte, invariant: dlss 1-6 (sl::DLSSMode); fsr/fsr3 16-20 =
|
||||
-- 0x10 + FfxApiUpscaleQualityMode since beta.25 (D65); NULL when none told
|
||||
upscaler_sharpness INTEGER, -- percent; NULL when the API reports none
|
||||
render_w INTEGER, render_h INTEGER, -- dominant segment
|
||||
output_w INTEGER, output_h INTEGER,
|
||||
@@ -250,7 +252,8 @@ CREATE TABLE sessions (
|
||||
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
|
||||
-- Vocabulary.FgRefusal spells it (not_counted, no_evaluations, non_uniform, dxgi_saturated, …; beyond_generation
|
||||
-- since beta.26: a ratio above FgWindow.GenerationCeiling that held throughout). 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
|
||||
@@ -314,6 +317,17 @@ CREATE TABLE sessions (
|
||||
power_limit_pct REAL, thermal_limit_pct REAL, -- shares of the ticks that carried reasons: NVIDIA (L3) only
|
||||
app_frames_per_joule REAL, -- application FPS / average GPU board power; never displayed frames (rule 6)
|
||||
|
||||
-- schema 0021 (2026-10-19, beta.24, D64): each loaded runtime module's folder class — 05_DETECTION §DLSS generation
|
||||
runtime_module_sources TEXT, -- {"nvngx_dlss.dll":"graphics_driver", …}: game | graphics_driver | windows; never a path
|
||||
|
||||
-- schema 0022 (2026-11-06, beta.34, D84): DLSS 5's neural rendering — 05_DETECTION §DLSS generation
|
||||
dlss_nr_pct REAL, -- 0–100 of the Streamline batches that evaluated kFeatureDLSS_NR; NULL = nothing could tell
|
||||
|
||||
-- schema 0020 (2026-10-19, beta.24, D62): every frame-generation state the session held — 03_METRICS §The mix
|
||||
fg_mix TEXT, -- {"Rows":[{"Kind":"generated","Factor":4.0,"NativeFps":…,"DisplayedFps":…,
|
||||
-- "Seconds":…,"Share":…,"Windows":…}, …]}: states by rising factor, then
|
||||
-- "none", then "unclassified"; NULL with no state, and before 0020
|
||||
|
||||
-- schema 0016 (2026-09-27, beta.10): the display mode, both tiers (03_METRICS §Display mode). Milliseconds per mode,
|
||||
-- each sample standing for the time until the next (100 ms hooked, 1 s at Tier 2), a pause not counted; nowindow is
|
||||
-- outside every share. NULL before, on a session recovered from its .partial file, and where the loop never sampled —
|
||||
@@ -326,7 +340,7 @@ CREATE TABLE sessions (
|
||||
display_nowindow_ms INTEGER, -- no window could be read
|
||||
display_changes INTEGER, -- mode changes between samples
|
||||
display_source TEXT, -- swapchain | opengl | window: the strongest witness any sample had
|
||||
display_window_w INTEGER, display_window_h INTEGER, -- client area, in the mode that lasted longest
|
||||
display_window_w INTEGER, display_window_h INTEGER, -- client area, in the mode that lasted longest (the last seen, beta.27)
|
||||
display_buffer_w INTEGER, display_buffer_h INTEGER, -- the swap chain's back buffer, same mode
|
||||
display_monitor_w INTEGER, display_monitor_h INTEGER, display_monitor_hz INTEGER
|
||||
);
|
||||
@@ -409,7 +423,9 @@ CREATE TABLE settings (key TEXT PRIMARY KEY, value TEXT NOT NULL);
|
||||
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`
|
||||
> **Written since 2026-09-14 (P3 PR-9).** `doc` is one of `eula` / `gpl` / `disclaimer` / `privacy` *(and `alpha` since
|
||||
> 2026-10-31, D74: the Alpha notice, written by an alpha build's gate only and read by an alpha's Agent before it serves;
|
||||
> a beta never reads that row)*
|
||||
> (`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
|
||||
@@ -533,6 +549,16 @@ Default: raw blobs for the **last 20 sessions per game** (configurable N or unli
|
||||
|
||||
## Migrations
|
||||
|
||||
> **The alpha's copy before it opens the ledger (D73, 2026-10-31).** An alpha build shares this file with the beta, so
|
||||
> before it first opens it — the App or the Agent, whichever comes first — `LedgerDatabase.OpenAsync(backupFirst:)`
|
||||
> copies it whole with SQLite's online backup into `backups\ledger-before-<version>.db` beside it
|
||||
> (`Infrastructure.Persistence.LedgerBackup`), once per alpha version, under a lock of its own
|
||||
> (`Local\FrameLedger.Ledger.Backup.<hash of the path>`, waited on for five minutes — the migration lock gives a waiter
|
||||
> 30 s). The newest three copies are kept and only files so named are deleted. A copy that cannot be made — no room, the
|
||||
> folder unwritable — throws `LedgerBackupException` and the ledger is not opened: the App says so in its start-failure
|
||||
> dialog, the Agent exits 7 (*ledger refused*) with the reason in its log. The main line passes no request and copies
|
||||
> nothing; a viewer (D52) reads a copy and makes none. Every case is `LedgerBackupTests`', in scratch folders.
|
||||
|
||||
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
|
||||
@@ -670,6 +696,38 @@ Sequential embedded SQL (`Migrations/0001_init.sql`, `0002_*.sql`, …), applied
|
||||
> already carried. `LatestVersion` is 19; `LedgerDatabaseTests.ScriptNineteenAddsThePacingAndCardColumnsAndAnEarlierSessionHasNone`,
|
||||
> `SqliteSessionRepositoryTests.ASessionRoundTripsColumnForColumn`. **A beta.13 cannot open a ledger beta.14 migrated.**
|
||||
|
||||
> **`0020_fg_mix.sql` (beta.24, 2026-10-19, owner decision D62) — every frame-generation state a session held.** One
|
||||
> TEXT column, ADD COLUMN only: `fg_mix`, `Application.Recording.FgMixRecord`'s JSON of `Domain.Metrics.FgMix` — each
|
||||
> state's pooled factor, its own Native and Displayed rates, its seconds, its share of the presenting time and its
|
||||
> five-second windows; then the time with no frame generation and the time no state claims (`03_METRICS` §The mix).
|
||||
> Written by the recorder's aggregation (`SessionAggregator.ApplyFg`, beside the steady state) for a hooked session whose
|
||||
> frame generation was named and whose count stood or was refused only as `non_uniform` / `ambiguous_band`; NULL
|
||||
> otherwise. A session before it has none and is **never rebuilt** from its `frame_blobs` (one Generated bit per frame,
|
||||
> the DXGI-counted presents lost). The `.partial` needs no change: a recovered session is aggregated from its records
|
||||
> like any other. **Read by today's rule since beta.26:** `FgMixRecord.Parse` folds a stored state no window of the build
|
||||
> would form (above ×8, or under eight application frames a window) into the not-classified time — beta.24 and beta.25
|
||||
> stored one (`spike-notes` §22). `LatestVersion` is 20; `LedgerDatabaseTests.ScriptTwentyAddsTheFgMixColumnAndAnEarlierSessionHasNone`,
|
||||
> `SqliteSessionRepositoryTests.ASessionRoundTripsColumnForColumn`. **A beta.23 cannot open a ledger beta.24 migrated.**
|
||||
|
||||
> **`0021_runtime_module_sources.sql` (beta.24, 2026-10-19, owner decision D64) — where each loaded module lived.** One
|
||||
> TEXT column, ADD COLUMN only: `runtime_module_sources`, `{file: class}` beside `runtime_modules` — `game`,
|
||||
> `graphics_driver` (Windows' driver store or `%ProgramData%\NVIDIA`) or `windows`, from the path the module snapshot
|
||||
> read (`Application.Capture.RuntimeModuleSources`). The class is stored; **the path never is** (Privacy Policy 2.12).
|
||||
> Since the same release the snapshot also records every module under `%ProgramData%\NVIDIA\NGX` whatever its name.
|
||||
> Written by the recorder's aggregation (`SessionAggregator.ApplyWitnesses`); NULL before, and on a session recovered
|
||||
> from its crash file (which carries no module list). `LatestVersion` is 21;
|
||||
> `LedgerDatabaseTests.ScriptTwentyOneAddsTheModuleSourcesColumnAndAnEarlierSessionHasNone`, the repository round trip.
|
||||
|
||||
> **`0022_dlss_nr.sql` (beta.34, 2026-11-06, owner decision D84) — DLSS 5's neural rendering, measured.** One REAL column,
|
||||
> ADD COLUMN only: `dlss_nr_pct`, the share (0–100) of the presents that drained a Streamline evaluation on which the game
|
||||
> evaluated `kFeatureDLSS_NR` (`Domain.Metrics.NeuralRendering`). Written by the recorder's aggregation
|
||||
> (`SessionAggregator.ApplyRt`) **only when the writer published `FL_HOOK_SL_NEURAL_RENDERING`** — an Overlay older than
|
||||
> the script drains the same batches and never sets the bit, so its NULL is "could not tell", never 0. NULL before, and
|
||||
> never rebuilt (`frame_blobs` keep no feature byte); a session recovered from its crash file is re-aggregated from its
|
||||
> raw records and keeps it. `LatestVersion` is 22;
|
||||
> `LedgerDatabaseTests.ScriptTwentyTwoAddsTheNeuralRenderingColumnAndAnEarlierSessionHasNone`, the repository round trip.
|
||||
> **A beta.33 or alpha.2 cannot open a ledger beta.34 migrated** (the alpha keeps its copy first, D73).
|
||||
|
||||
> **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
|
||||
|
||||
+2
-2
@@ -393,7 +393,7 @@ Unchanged in spirit from v1, bumped to `v2` for the new message set.
|
||||
| `Hello` | UI→A | `{ appVersion, protocol: 2 }` → `HelloAck { agentVersion, protocol, pid, elevated, overlayBuildId, vulkanLayerRegistered, telemetrySource /* composite, e.g. l1+lhm+nvapi */, cpuTempAvailable, disclosureVersion /* P3 PR-4, D14: the FR-2.1 text this Agent stamps against */, exceptionDisclosureVersion /* D33, 2026-09-26: the user-mode exception's disclosure this Agent grants against */, elevationOutcome /* beta.10, D34: the admin mode's answer at this start — granted, declined, other-account, failed — or null when nobody asked */, ~~etwAvailable~~ }` — `etwAvailable` struck 2026-09-13 with the tier it described (2026-08-28); `pid` added. ~~`vulkanLayerRegistered` is **false by construction** today (the layer is per-launch, never registered)~~ `vulkanLayerRegistered` is the HKCU implicit-layer registration as the Agent found it at start *(corrected 2026-10-04: since P3 PR-8b; true while `VkLayerReconciler` keeps the layer registered for a hook-enabled Vulkan game, P4 PR-2)* and `cpuTempAvailable` false unelevated; `telemetrySource` is the composite stood up once on the first `Hello` |
|
||||
| `GetStatus` | UI→A | → `StatusAck { state, activeSession?, tier? }` — and `activeSessions[]`, one `{ sessionGuid, gameId, gameName?, pid, tier, startedAt, hold? }` per running session. **`hold` added 2026-09-23, optional:** present on a session held unhooked (Tier 2), with the same words `SessionStarted.hold` carries; a session listed at tier 2 WITHOUT a `hold` has not attached yet — it is starting, not held. The App reads this list on every (re)connect (§Client behavior) |
|
||||
| `SetWatchlist` | UI→A | `{ entries: [{ gameId?, exePath }] }` — ~~full replace~~ **ensure, never remove** (built 2026-09-13, PR-1b): each entry's path is normalised by the Agent, its row ensured with hooking OFF when new, and the ack is `WatchlistAck { games: [{ gameId, exePath, name }], unreadable: [exePath] }`; `gameId` in a request is a hint and never trusted over the path. UI re-sends on connect. **Carries no hooking state** (see §The pipe is not a trust boundary). *Since the App writes `games` rows itself under `06_DATA_MODEL` §Writer ownership (HANDOFF §P3 D15), this is the pipe's way of adding a row, not the only one; the watcher reads the table at 1 Hz either way.* |
|
||||
| `LaunchGame` | UI→A *(the App sends it since beta.21: Play in its Start directly mode, and in the store mode where no store installed the game — `App.Services.GamePlayer`, D59)* | `{ gameId, arguments? }` → ~~suspended-launch~~ launch mode as built ("inject late", `04_CAPTURE` §Launch mode) → `LaunchAck { gameId, accepted, outcome, sessionGuid? }` — `outcome` is `Accepted` · `UnknownGame` · `SessionRunning` (one per game at a time) · `Unavailable` · `RecordingOff` (2026-09-23: the entry's recording switch is off, FR-1.6 — FrameLedger does not start what it will not record). *(Built 2026-09-13, PR-1b: `CaptureOrchestrator.LaunchAsync` over an `ILaunchRecorderFactory` the Agent composes with the Vulkan layer's environment — or none when FR-2.4's switch is on — and the launcher election runs after, as the console's `launch` does; the elected session is not addressable by the launch's guid.)* |
|
||||
| `LaunchGame` | UI→A *(the App sends it since beta.21: Play in its Start directly mode, and in the store mode where no store installed the game — `App.Services.GamePlayer`, D59)* | `{ gameId, arguments? }` → ~~suspended-launch~~ launch mode as built ("inject late", `04_CAPTURE` §Launch mode) → `LaunchAck { gameId, accepted, outcome, sessionGuid? }` — `outcome` is `Accepted` · `UnknownGame` · `SessionRunning` (one per game at a time) · `Unavailable` · `RecordingOff` (2026-09-23: the entry's recording switch is off, FR-1.6 — FrameLedger does not start what it will not record) · `PackagedGame` (beta.33, D80: the executable's install root is a GDK package root — a game the Xbox app or the Microsoft Store installed, which Windows starts through its package and never by its path, `spike-notes` §25; nothing is started, and the App says to start it from the Xbox app or the Start menu. The App hands such a game to Windows itself and sends this only when it found no package record for it. Additive: an older App says the unknown outcome as a failure). *(Built 2026-09-13, PR-1b: `CaptureOrchestrator.LaunchAsync` over an `ILaunchRecorderFactory` the Agent composes with the Vulkan layer's environment — or none when FR-2.4's switch is on — and the launcher election runs after, as the console's `launch` does; the elected session is not addressable by the launch's guid.)* |
|
||||
| `SetHookEnabled` | UI→A | `{ gameId, enabled, disclosureVersion? }` — Agent re-runs the static AC pre-scan and may reply `Refused`. **The Agent stamps the consent timestamp itself.** *(Built 2026-09-13, PR-1b, as far as it can be: `enabled: false` → `RevokeAsync` → `HookEnabledAck { gameId, enabled: false, outcome }`; `enabled: true` → the pre-scan of the executable's directory, a refusal or a "could not verify" recorded through `RecordGuardBlockAsync` and answered `Refused { gameId, reason, family?, signal? }`; a clean scan → ~~**`Error DisclosureUnavailable`, nothing stamped** — the reviewed FR-2.1 text does not exist, and a client's `disclosureVersion` is a claim, not a disclosure shown. PR-4 replaces that last branch with the stamp~~ **since PR-4 (2026-09-13): the client's `disclosureVersion` compared with the Agent's own `SafetyDisclosure.Version`; equal → the stamp from the Agent's clock with `ConsentProvenance.ConsentDialog`, answered `HookEnabledAck { enabled, outcome, prescan: "clean" }`; anything else → `Error DisclosureVersionMismatch`, nothing written (D14). `DisclosureUnavailable` remains for a composition that wired no version, which `--serve` never is.)* **Since beta.8 (2026-09-25):** the pre-scan is of the executable (the guard resolves the install root, PR-2 of that train), and BEFORE it an executable known not to run as x64 is answered `Refused { gameId, reason: "ExecutableNotX64", signal: "x86" | "anycpu32" | "arm64" | "arm" }` with nothing scanned and nothing written — not a guard reason and not a block (`05_DETECTION` §What the files say about themselves). **Since D33 (2026-09-26):** for a blocked game whose user-mode exception is in force for the executable on disk (the option on, a grant made on these bytes, the block naming that family) the pre-scan NAMES the family, and a pass under it is stamped as ever and answered `prescan: "exception"`; a finding about the game under it also ends the exception. |
|
||||
| `SetAntiCheatException` | UI→A | **Added 2026-09-26 (D33).** `{ gameId, enabled, disclosureVersion? }` — grant or withdraw a game's user-mode anti-cheat exception (`19_SAFETY` §The user-mode exception). `enabled: false` → the exception ends (`Withdrawn`), hooking goes off while the block stands → `AntiCheatExceptionAck { gameId, granted: false, outcome, family? }`. `enabled: true` → `Error DisclosureVersionMismatch` unless `disclosureVersion` is the Agent's `AntiCheatExceptionDisclosure.Version`; `Error ExceptionsOff` while `hooking.usermode_ac_exceptions` is off; `Refused { reason: "BlockNotExceptionable" }` for a title list or an unreadable block; then the Agent's OWN facts — ~~the successful Tier-1 sessions (`Refused { reason: "TooFewSessions", signal: <count> }` under two)~~ *(D38, 2026-10-03: no session is needed)*; a game an exception of which ended during its trial is refused before anything is scanned (`Refused { reason: "TrialFailed", family, signal: <unix ms> }`); a tolerant pre-scan of the executable on disk naming the block's family (`Refused { reason, family, signal }` unless the guard let exactly that family through) — and the store writes the grant only over facts that make the game eligible, and never over a failed trial → `AntiCheatExceptionAck { granted, outcome, family }`. **A grant turns nothing on**: hooking is FR-2.1's `SetHookEnabled`, afterwards. Not answered (`UnknownType`) by an Agent composed without the exception. |
|
||||
| `PauseCapture` / `ResumeCapture` | UI→A | global → `PauseAck { paused }`; `StatusAck.paused` reports it. *(Built 2026-09-13, PR-1b: one in-memory flag, `CapturePause`, read by every session loop at its tick and told to the ring once per transition; supervision — the guard scan, the kill switch, the safety stop — never pauses. Not persisted: an Agent that restarts resumes.)* |
|
||||
@@ -404,7 +404,7 @@ Unchanged in spirit from v1, bumped to `v2` for the new message set.
|
||||
| `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, hold? }` — **published once per session**: at the attach (tier 1, `startedAt` the attach), or — **since 2026-09-23** — at the first tick of a session held unhooked (tier 2, `startedAt` the session's start, `pid` 0 when the loop never opened the process, as a hooking-off hold never does). ~~a session that never attaches has no `SessionStarted`, only its `SessionCompleted` (tier 2)~~ — that was the beta.5 wire, and every hooking-off, refused or unreadable game read "Nothing is being captured." for as long as it ran. **`hold` (optional, tier 2 only)** is why nothing is measured: `{ reason, guardReason?, family?, signal?, hookingTurnedOff }` — the loop's `SessionEndReason` and, when the guard said anything but allow, its reason, family and signal: the same words the row's `capture_notes` will carry, so the live card and the summary read one sentence (`Formats.Tier2HoldReason` / `Tier2Reason`). The refusal's own event (`CaptureRefused` and the rest, below) goes out with this start rather than when the game exits, and is not repeated at the end |
|
||||
| `SessionHeld` | A→UI | **Added 2026-09-23.** 1 Hz while a client listens, for a session held unhooked only: `{ sessionGuid, elapsedS, gpuTempC?, cpuTempC?, gpuLoadPct?, cpuLoadPct?, gameVramDedicatedMb?, gameRamPrivateMb? }` — how long it has run and the machine's sensors (and since beta.12 the game process's own memory, read from outside it — optional, an older client ignores them). **Never `SessionProgress`**: its `presents5s`, `presentedQualifier` and `fgMode` are required, and zeros there would put measured-looking numbers on the wire for a session that measures nothing (rule 6 has nothing to show and shows nothing) |
|
||||
| `SessionProgress` | A→UI | 1 Hz: `{ sessionGuid, elapsedS, presents5s, presentedFps5s?, presentedQualifier, nativeFps5s?, displayedFps5s?, fgFactor?, fgMode, upscaler?, upscalerQuality?, upscalerDriverReported?, renderW/H?, outputW/H?, rtActive?, gpuTempC?, cpuTempC?, cpuLoadPct?, vramProcMb?, latencyUs?, fgRefusal?, fgRuntimeCensus?, gameVramDedicatedMb?, gameRamPrivateMb? }` (the last two added 2026-10-03, beta.12, optional: the game process's dedicated GPU memory and private working set, MiB, from the newest telemetry tick; `vramProcMb` stays reserved for the in-process figure and has no producer) — a 5 s rolling window over the ring through the SAME Domain calculators the row uses (`SessionProgressCalculator`, D13). **`upscalerDriverReported` added 2026-09-21, optional:** `dlss` when the NVIDIA driver reports an NGX super-resolution feature created and evaluated in the target (`03_METRICS` §The driver-reported rung), so the live card says `DLSS (driver-reported)` where no hook can name the upscaler; identity only. **`cpuLoadPct` added 2026-09-21, optional** (CPU time busy over the last telemetry tick, 0–100; `cpuTempC` has a producer from the same date, present only when the Agent is elevated with PawnIO). **Two fields added 2026-09-14, both optional (an older client ignores them, §C):** `fgRefusal` is the row's `fg_refusal` (schema 0003) — present when `fgMode` names a technology and `fgFactor` is absent, so the live card can say "DLSS-G active — factor not counted" rather than N/A; `fgRuntimeCensus` is the raw census so the `fg_runtime_loaded` chip can name the module. **Rule 6 at the wire (2026-09-13):** `nativeFps5s` / `displayedFps5s` / `fgFactor` are present only when frame generation was measured in the window; otherwise `presentedFps5s` stands alone with `presentedQualifier` (`census_not_run` · `no_fg_runtime` · `fg_runtime_loaded` · `none_withheld`, the row's `presented_qualifier` from the same function). Every unmeasured field is absent, never 0. Suppressed when no client is connected |
|
||||
| `SessionProgress` | A→UI | 1 Hz: `{ sessionGuid, elapsedS, presents5s, presentedFps5s?, presentedQualifier, nativeFps5s?, displayedFps5s?, fgFactor?, fgMode, upscaler?, upscalerQuality?, upscalerDriverReported?, renderW/H?, outputW/H?, rtActive?, gpuTempC?, cpuTempC?, cpuLoadPct?, vramProcMb?, latencyUs?, fgRefusal?, fgRuntimeCensus?, gameVramDedicatedMb?, gameRamPrivateMb? }` (the last two added 2026-10-03, beta.12, optional: the game process's dedicated GPU memory and private working set, MiB, from the newest telemetry tick; `vramProcMb` stays reserved for the in-process figure and has no producer) — a 5 s rolling window over the ring through the SAME Domain calculators the row uses (`SessionProgressCalculator`, D13). **`upscalerQualityOverride` added 2026-10-19 (beta.24, D63), optional:** the mode an NVIDIA App override set when the driver reports it applied in the target and DLSS super resolution ran there — `performance`, `balanced`, `quality`, `ultra_performance`, `ultra_quality`, `dlaa`, or `override` when the driver's report alone does not settle the mode (the profile is the stored session's); absent otherwise. **`upscalerDriverReported` added 2026-09-21, optional:** `dlss` when the NVIDIA driver reports an NGX super-resolution feature created and evaluated in the target (`03_METRICS` §The driver-reported rung), so the live card says `DLSS (driver-reported)` where no hook can name the upscaler; identity only. **`cpuLoadPct` added 2026-09-21, optional** (CPU time busy over the last telemetry tick, 0–100; `cpuTempC` has a producer from the same date, present only when the Agent is elevated with PawnIO). **Two fields added 2026-09-14, both optional (an older client ignores them, §C):** `fgRefusal` is the row's `fg_refusal` (schema 0003) — present when `fgMode` names a technology and `fgFactor` is absent, so the live card can say "DLSS-G active — factor not counted" rather than N/A; `fgRuntimeCensus` is the raw census so the `fg_runtime_loaded` chip can name the module. **Rule 6 at the wire (2026-09-13):** `nativeFps5s` / `displayedFps5s` / `fgFactor` are present only when frame generation was measured in the window; otherwise `presentedFps5s` stands alone with `presentedQualifier` (`census_not_run` · `no_fg_runtime` · `fg_runtime_loaded` · `none_withheld`, the row's `presented_qualifier` from the same function). Every unmeasured field is absent, never 0. Suppressed when no client is connected |
|
||||
| `SessionCompleted` | A→UI | `{ sessionGuid, sessionId?, exitStatus, tier, finalize, reason, gameId?, gameName? }` — UI loads the full row from SQLite; `sessionId` is null and `finalize` is `discarded` when the row was not stored (under the minimum length), or `game_removed` when its entry was removed with its sessions while it ran (2026-09-23), or **`faulted` when the session's task threw before it could finalize** (2026-09-23: it follows the `CaptureError SessionFaulted`, with `exitStatus` `interrupted` and `reason` `SessionFaulted`, so the live card and the tray let go of a session that no longer runs; the `.partial` stays for recovery); `exitStatus` is the row's vocabulary (`normal` · `crashed` · `unhooked_safety` · `degraded`); `reason` is the loop's `SessionEndReason`. **`gameId` / `gameName` added 2026-09-23, optional:** the entry the session was stored under — the finalizer's owner when it re-keyed a session whose entry was removed, else the one it started under — so the notice names the session that completed, not whatever the live card last showed |
|
||||
| `CaptureRefused` | A→UI | `{ gameId, gameName, reason, family?, signal?, hookingTurnedOff, guardReason? }` — **`guardReason` (beta.13, optional)** is the guard's own reason ~~when it named a family~~ **whenever it refused (beta.18; beside a family only until then)**: `BlockedService` / `BlockedDriver` is a finding on the PC, not in the game, and the notice says so (§S23-3), and a refusal no family names is said in the guard's words (`Formats.GuardSentence`) — it printed the end's name, "reason RefusedByGuard"; `reason` stays the session's end reason — **guard fired**; `hookingTurnedOff` (2026-09-22) is true when the finding turned the game's hooking off (`19_SAFETY` §What a finding does to the game); UI shows the plain-language explanation — ~~and the Tier-2 offer~~; there is no alternative measurement to offer, only the option to record the session unmeasured (`08_UI` §Safety events). *(Built: for `RefusedByGuard`, `RefusedPreviouslyBlocked`, `RefusedKillSwitch`, `PreScanCouldNotVerify` and, since 2026-09-21 (beta.4), `TargetUnreadable` — a protected process the Agent could not open (added 2026-10-04) — `PreScanCouldNotVerify` with no family, because "could not verify" is neither a hit nor a pass; `family`/`signal` are the verdict's. A game merely not enabled or not consented raises nothing: that is an ordinary Tier-2 row, not a refusal to explain.)* |
|
||||
| `CaptureDegraded` | A→UI | `{ sessionGuid, from: 1, to: 2, reason }` — Tier 1 → Tier 2 mid-flight, or overlay self-disabled. **Under a two-rung ladder this means measurement STOPPED**, not that it continued at lower fidelity, and the notice must say so. *(Since beta.18 it says the end in words, `Formats.EndReasonText`; it printed `reason` raw — "The hook stopped (WriterSelfDisabled); the session continues without measuring" — and a stop ends the session, it does not continue it.)* *(Built: `SupervisionLost`, `WriterSelfDisabled`, `WriterStoppedBlocklisted`, `WriterNeverInstalledHooks`, `SupervisionFaulted`, `KillSwitchEngaged` — `RecordedSessionEvents.Classify` is the table.)* |
|
||||
|
||||
+315
-34
@@ -1,6 +1,9 @@
|
||||
# 08 — UI
|
||||
|
||||
WPF + **WPF UI (Wpf.Ui, Fluent)**. Shell = `ui:FluentWindow` with custom `ui:TitleBar`, a thin classic **Menu bar** (file-level operations), and a left **`ui:NavigationView`** (`PaneDisplayMode="LeftFluent"`) as primary navigation. Light/Dark/System themes via `ApplicationThemeManager` + `SystemThemeWatcher`; Mica backdrop on Windows 11 with automatic solid fallback on Windows 10. All XAML follows `16_WPFUI_SYNTAX.md` — that doc is mandatory reading before writing views.
|
||||
WPF + **WPF UI (Wpf.Ui, Fluent)**. Shell = `ui:FluentWindow` with custom `ui:TitleBar`, a thin classic **Menu bar** (file-level operations), and a left **`ui:NavigationView`** (`PaneDisplayMode="LeftFluent"`) as primary navigation *(since beta.34, D86, its items use
|
||||
our copy of WPF UI 4.3.0's LeftFluent item template — `FlLeftFluentNavigationViewItemTemplate` in `Styles/FrameLedger.xaml` —
|
||||
whose only change is that the selected page keeps its label; WPF UI's animates it away, and the owner's screenshot of
|
||||
Compare showed the icon alone)*. Light/Dark/System themes via `ApplicationThemeManager` + `SystemThemeWatcher`; Mica backdrop on Windows 11 with automatic solid fallback on Windows 10. *(beta.35, D91: a Windows contrast theme wins over all three while it is on — §Contrast.)* All XAML follows `16_WPFUI_SYNTAX.md` — that doc is mandatory reading before writing views.
|
||||
|
||||
## Shell
|
||||
|
||||
@@ -38,10 +41,15 @@ WPF + **WPF UI (Wpf.Ui, Fluent)**. Shell = `ui:FluentWindow` with custom `ui:Tit
|
||||
**NavigationView items:** Dashboard · Games · Compare · Logs — `Settings` lives in `FooterMenuItems`. Icons from `SymbolIcon` (Fluent System Icons; pick from the `SymbolRegular` enum — see 16 §Icons).
|
||||
|
||||
**Menu bar**
|
||||
- **File:** Add game… · Import library (Steam / GOG / Epic / itch.io) · Export ▸ (Session CSV / Session JSON / Chart PNG) · Exit
|
||||
- **File:** Add game… · Import library (Steam / GOG / Epic / itch.io / Xbox *— since beta.33*) · Export ▸ (Session CSV / Session JSON / Chart PNG) · Exit
|
||||
- **Tools:** Agent status… · Update detection rules · Vulkan layer registration… · Open data folder · Database maintenance…
|
||||
- **Help:** User guide (beta.12) · Check for updates · Report a bug… · ~~Documentation~~ Online documentation · Limitations · About FrameLedger (~~App / Developer / Third-party licenses tabs~~ — built beta.12 as *This app* / *Third-party licences* / *Legal documents*, below)
|
||||
- **Help:** User guide (beta.12) · Check for updates · Report a bug… · ~~Documentation~~ Online documentation · Limitations · Accessibility (beta.35) · About FrameLedger (~~App / Developer / Third-party licenses tabs~~ — built beta.12 as *This app* / *Third-party licences* / *Legal documents*, below)
|
||||
|
||||
> **Help ▸ Accessibility, beta.35 (owner decision D88, 2026-11-09):** `ACCESSIBILITY.md` — the accessibility statement —
|
||||
> as the build embeds it (`Services.AccessibilityDocument`), in a `Windows/DocumentWindow` of its own like Limitations,
|
||||
> and after Limitations in the user guide's window so the guide's links to it open there. Information, not one of
|
||||
> FR-11's documents. What it says and the checks behind it are §Accessibility below.
|
||||
>
|
||||
> **Help ▸ Limitations, beta.10 (D36):** `LIMITATIONS.md` as the build embeds it (`Services.LimitationsDocument`), in a
|
||||
> ~~read-only, scrolling WPF UI `MessageBox` with *Open on GitHub*~~ window of its own since beta.12 (`Windows/DocumentWindow`,
|
||||
> rendered — below; corrected 2026-10-04). It is information, not one of FR-11's documents:
|
||||
@@ -60,7 +68,7 @@ WPF + **WPF UI (Wpf.Ui, Fluent)**. Shell = `ui:FluentWindow` with custom `ui:Tit
|
||||
>
|
||||
> **Documents are rendered, beta.12 (owner request 4, D45).** Every Markdown document the App shows — the Legal Gate's
|
||||
> three texts, Help ▸ Limitations, the update notes, About's documents — is drawn by `Markdown/MarkdownRenderer`
|
||||
> (Markdig 1.4.0, BSD-2-Clause) into a WPF `FlowDocument` inside `Controls/MarkdownView` (a read-only
|
||||
> (Markdig ~~1.4.0~~ 1.5.0 since beta.31 — 1.4.2 in beta.30 —, BSD-2-Clause) into a WPF `FlowDocument` inside `Controls/MarkdownView` (a read-only
|
||||
> `FlowDocumentScrollViewer`: selectable, Ctrl+C, Ctrl+wheel zoom): headings, emphasis and strikethrough, inline and
|
||||
> fenced code in monospace, quotes, nested and numbered lists, pipe tables with a header row, rules, links. **HTML is
|
||||
> off** — a tag is shown as the text it is; **no image is fetched** — its description stands in; a node the renderer
|
||||
@@ -141,8 +149,12 @@ The Menu sits in its own row **below** the TitleBar (never inside the drag regio
|
||||
|
||||
## Notifications policy
|
||||
|
||||
- **In-app, transient** (rules updated, export done, non-fatal capture warning): `ISnackbarService` snackbar, 4 s.
|
||||
- **In-app, persistent** (Agent offline, ~~PawnIO missing,~~ update downloaded, a viewer's folder, the safety notices): `ui:InfoBar` banner pinned above content with action button. *(Corrected 2026-10-07: no PawnIO banner was ever built — CPU temperature reads N/A, and Settings ▸ System says it needs the admin mode and PawnIO; the viewer's banner (D52) and the safety notices were missing from the list.)*
|
||||
- **In-app, transient** (rules updated, export done, non-fatal capture warning): `ISnackbarService` snackbar, 4 s — shown
|
||||
only through `IMessageStrip` (`Services/SnackbarStrip`) since beta.35, which says it to a screen reader as it shows it
|
||||
(D89; `AnnouncementsTests.OnlyTheStripShowsASnackbarAndNoXamlSetsALiveSetting`).
|
||||
- **Every one of these is said to a screen reader as it appears (beta.35, owner decision D89)** — §Accessibility, Screen
|
||||
readers.
|
||||
- **In-app, persistent** (Agent offline, ~~PawnIO missing,~~ update downloaded, a viewer's folder, the safety notices, *an alpha build* — since 2026-10-31, D74): `ui:InfoBar` banner pinned above content with action button. *(Corrected 2026-10-07: no PawnIO banner was ever built — CPU temperature reads N/A, and Settings ▸ System says it needs the admin mode and PawnIO; the viewer's banner (D52) and the safety notices were missing from the list.)*
|
||||
- **System-level, app possibly minimized** (session saved with "View" action, capture error while in tray, update available): tray balloon/toast via H.NotifyIcon.
|
||||
- One event → exactly one channel; never duplicate the same event across snackbar *and* tray.
|
||||
|
||||
@@ -240,7 +252,7 @@ All screens are `Page`s registered with the navigation page provider and navigat
|
||||
|
||||
### Dashboard
|
||||
- Agent status `ui:CardControl` (state, capability badges as `InfoBadge`: telemetry source, Vulkan layer, ~~ETW fallback~~, PawnIO/CPU-temp, elevation — Repair button on error).
|
||||
- **Live capture card** (visible during capture): game name, **tier badge**, elapsed, live `FpsReadout` (5 s rolling), **measured** `renderW×H → outputW×H` with upscaler + quality, RT-active dot, CPU/GPU temp, ~~per-process VRAM~~ the game's own VRAM and RAM (beta.12: read from outside the game, so a held session has them too), sparkline (last 120 s) fed by `SessionProgress`. Tier 1 shows measured settings — this is the payoff of hooking and should read as facts, not guesses.
|
||||
- **Live capture cards** (one per running session since beta.28, two to a row): game name, **tier badge**, elapsed, live `FpsReadout` (5 s rolling), **measured** `renderW×H → outputW×H` with upscaler + quality, RT-active dot, CPU/GPU temp, ~~per-process VRAM~~ the game's own VRAM and RAM (beta.12: read from outside the game, so a held session has them too), sparkline (last 120 s) fed by `SessionProgress`. Tier 1 shows measured settings — this is the payoff of hooking and should read as facts, not guesses.
|
||||
- Recent sessions list (last 10 across games) → click opens session summary.
|
||||
- Totals strip: games tracked, total playtime, sessions this week (`ui:Card` row).
|
||||
|
||||
@@ -270,9 +282,28 @@ All screens are `Page`s registered with the navigation page provider and navigat
|
||||
> open is on it at once; the completion notice names the session that completed (`SessionCompleted.gameName`)
|
||||
> and a `faulted` completion is no notice (the strip's `CaptureError` already said it). Until this date the
|
||||
> Agent announced only hooked sessions: every other game read "Nothing is being captured." while it ran.
|
||||
>
|
||||
> **beta.28: one card per running session** (the owner, 2026-10-20: "Thêm cơ chế hiển thị UI/UX Dashboard khi chạy >=2
|
||||
> game trong cùng 1 thời điểm"). The Agent records one session per executable, so two games run as two sessions, and
|
||||
> until beta.28 the second showed only as *Running sessions: 2* — the one card went to a hooked session and stayed with
|
||||
> it. `DashboardViewModel.LiveCards` keeps a `LiveCaptureViewModel` per session, each fed only its own session's events
|
||||
> (a card is made by its session's first event or seed and is one session's for life); hooked sessions come first, each
|
||||
> kind in the order it started, and a card that changes place is moved, never rebuilt. The header counts the games from
|
||||
> two on (*2 games recording*, `Dashboard_Live_Count_Format`) and the cards stand two to a row (`LiveColumns`); with none
|
||||
> running, one card says *Nothing is being captured.* Each card is the card it was — name, tier badge, elapsed, the
|
||||
> readout or why nothing is measured, the measured settings, the temperatures (the machine's, so alike on every card) and
|
||||
> the game's own memory. Tests: `DashboardViewModelTests` (two games, a third, each ending), `LiveCaptureViewModelTests`,
|
||||
> and the page in `PagesLoadTests`' surfaces with a hooked and a held session, in both themes and through a switch.
|
||||
|
||||
### Games (grid → detail)
|
||||
- `GridView`-style panel of cover cards (`ui:CardAction`): name, platform badge, engine badge, total playtime, last played, mini trend sparkline (avg Native FPS last 10 sessions). Sort/filter/`ui:AutoSuggestBox` search.
|
||||
> **The filters, beta.34 (owner request 2026-11-06, D85)** — specified here since P3 and never built: a row under the
|
||||
> search and sort with **Store**, **Engine** (the stores and engines the library holds, each list naming its
|
||||
> "everything" first; *Added by hand* for an entry with no store, *Engine not identified* for one with none),
|
||||
> **State** (the card's one state, as its pill says it), **Installed** and **Played**, and *Clear filters*. While a filter
|
||||
> or the search narrows the list the title counts what is shown of all (*Games · 12 of 65*). Kept while the App runs —
|
||||
> the page is the window's (`WindowPageCache`) — and not saved. Tests:
|
||||
> `GamesViewModelTests.TheFiltersNarrowTheLibraryAndTheHeaderCountsWhatIsShown`.
|
||||
> **The library, beta.11 (owner requests 2026-10-03).** *The empty band on the right:* the cards were 300 px in a plain
|
||||
> `WrapPanel`, so at ~1350 px three fitted and a card's width was left unused; the grid is now
|
||||
> `Controls.UniformWrapPanel` — as many columns as fit at 300 px or wider, every card an equal share of the width, each row
|
||||
@@ -293,7 +324,14 @@ All screens are `Page`s registered with the navigation page provider and navigat
|
||||
> message at once in its one snackbar, so only the last name stayed on screen. And only the newest read of the library is
|
||||
> shown: reads overlap — a session that ends, an import, a removal — and the one that started first could finish last,
|
||||
> its executable checks waiting on a slow drive, and put back a removed game's card (`GamesViewModel.LoadAsync`,
|
||||
> `GamesViewModelTests.AnOlderReadThatFinishesLastIsNotShownOverANewerOne`)*). **The page reloads by itself** while it is on screen when a session ends (`SessionCompleted`) or an
|
||||
> `GamesViewModelTests.AnOlderReadThatFinishesLastIsNotShownOverANewerOne`)*). *(beta.34, owner request 2026-11-06 —
|
||||
> "switching to Games stalls 0.5–1.5 s", `spike-notes` §27: the window keeps the page it built and shows it again on
|
||||
> every later visit, reading the library again behind it; the library is read on the thread pool; the cards appear
|
||||
> before any executable is checked — 39 of the owner's 41 Steam games are on a USB drive that sleeps — and each card
|
||||
> gets its *Not installed* pill when its check answers; a read keeps every card that would look the same; the list
|
||||
> view is bounded (`MaxHeight` 640) so it builds the rows on screen. `GamesViewModelTests`
|
||||
> `.TheCardsComeBeforeTheExecutableChecksAndThePillAfter`, `.APageShownAgainReadsTheLibraryAndKeepsTheCardsThatLookTheSame`,
|
||||
> `WindowPageCacheTests`.)* **The page reloads by itself** while it is on screen when a session ends (`SessionCompleted`) or an
|
||||
> import adds games (`LibraryChanges` — navigating to the page already on screen does nothing in WPF UI 4.3.0, so an
|
||||
> import from the menu never showed until the page was left). **Import** (FR-1.2): the games already in the library — at
|
||||
> this path or under another drive letter — are hidden by default (*Show the N games already in the library* brings them
|
||||
@@ -331,17 +369,26 @@ All screens are `Page`s registered with the navigation page provider and navigat
|
||||
> (`privacy.online_metadata` stays reserved). The page: a band (`ArtBand`, rounded) holding the banner (`ui:Image`, as tall
|
||||
> as its proportions make it, ≤ 240, fading into the band through an alpha mask set in code) above the usual header with the
|
||||
> cover beside the name (120×180, or 230×107 for a landscape header); a game with no artwork shows no band. No text is
|
||||
> drawn on a picture. **The band's colour** (`Controls.ArtTint`, D61): the cover's dominant colour (`Services.ColorMath`: a
|
||||
> drawn on a picture. **The band's colour** (`Controls.ArtTint`, D61): the cover's — else the banner's — dominant colour (`Services.ColorMath`: a
|
||||
> hue histogram of a 48-px copy, vivid pixels weighted, a grey picture none) over the card's fill at the strongest opacity
|
||||
> — ≤ 30 % on a dark theme, ≤ 22 % on a light one — at which primary and secondary text keep 4.5:1, tertiary 3:1, and the
|
||||
> pills' and the warning's text 4.5:1 on their fills; recomputed through a resource reference when the theme changes;
|
||||
> untinted with the option off, a grey picture or high contrast. Everything is read and decoded on the thread pool
|
||||
> (`Services.GameArt`; the twelve newest images kept); the text shows first and the picture when ready. A chosen image's
|
||||
> path is followed only when it is one of these names under the folder's `covers` — a viewer's copy (D52) could name a
|
||||
> share. Settings ▸ Games: *Show game artwork* (`ui.game_art`) and *Colour the game page from its artwork*
|
||||
> path is followed only when it is one of these names in the data folder's `covers`, and never through a junction or a
|
||||
> symbolic link — a viewer's copy (D52) could name a share, or hold a link to one. Settings ▸ Games: *Show game artwork* (`ui.game_art`) and *Colour the game page from its artwork*
|
||||
> (`ui.game_art_tint`), both on. Tests: `GameArtTests`, `CoverStoreTests`, `ColorMathTests` (the hardest colours in both
|
||||
> themes against the tests' own WCAG), `EditGameViewModelTests`, `PagesLoadTests.EveryTextIsReadableInBothThemes` (the
|
||||
> surfaces' game page has artwork) and `…TheArtworkBandFollowsAThemeSwitch`. The library's cards still have no image.
|
||||
> surfaces' game page has artwork), `…TheArtworkBandFollowsAThemeSwitch` and `…TheGamePagesArtworkIsDrawn` with
|
||||
> `AccessibilityTests.NoStyleOfAWpfUiControlLeavesOutItsTemplate` (the cover once took its place and drew nothing, a
|
||||
> `ui:Image` style not based on WPF UI's; caught in a render before it shipped). The library's cards still have no image.
|
||||
>
|
||||
> **beta.33 (D79): an Xbox game's own pictures.** A game the Xbox app or the Microsoft Store installed ships its pictures
|
||||
> in its package folder, and `MicrosoftGame.config` names them: the `Square480x480Logo` (else `Square150x150Logo`) is the
|
||||
> cover, drawn **square** (150×150, `ArtCoverIsSquare`) so a logo is never cropped to a portrait, and the
|
||||
> `SplashScreenImage` (1920×1080 on the owner's titles) is the banner. The square logo comes before a landscape header.
|
||||
> Read from inside the package root only; the tooltip says *Artwork from the game's own files (Xbox app)*
|
||||
> (`Art_Source_Xbox`). `GameArtTests.AnXboxGamesSquareLogoIsItsCoverDrawnSquareAndItsSplashTheBanner`.
|
||||
|
||||
> **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,
|
||||
@@ -359,7 +406,10 @@ All screens are `Page`s registered with the navigation page provider and navigat
|
||||
> the executable's folder, and the nearest folder still there when that one is gone; nothing for a drive that is not
|
||||
> connected, where Windows opens its last folder; owner request 2026-10-12, `GameFolderTests`), **one App per data folder since 2026-09-21** (`Services.SingleInstance`: a named mutex and a named event keyed on a hash of the data directory, claimed in `Program.Main` after Velopack's hooks and before any window; a later start sets the event and exits 0, and the first instance brings its window forward through `ShellHost.Reveal` — from the tray too. Nothing stopped a second App before: the owner's log shows two started 360 ms apart, two tray icons, a second log file. `--diag` never claims), ~~**the guard-bypass switch since 2026-09-21**~~ **withdrawn 2026-09-22** (the card, its dialog, the session mark and the export line are gone; a blocked row's toggle is disabled and `Safety_Blocked_Toggle_Format` is the whole story; a refusal or unhook notice that turned hooking off ends with `Safety_HookingTurnedOff` — `19_SAFETY` §What a finding does to the game), **Supports** (from `capability_flags`; ~~empty until P4's scan writes it, and the card says so~~ **written by the Agent's detection sweep since P4 PR-1, 2026-09-14** — the rule ids as product names via `CapabilityNames`, "not scanned yet" only until the Agent's next tick) beside
|
||||
> **Last session measured** (upscaler · resolution, frame generation, the non-N/A chips — accent pills, from the
|
||||
> hooks). Hooking: the toggle is `OneWay` from the row and its command runs `HookingConsent`; a refusal, a
|
||||
> hooks). Hooking: the toggle is `OneWay` from the row and its command runs `HookingConsent` *(since beta.30 the command
|
||||
> raises the switch's property whatever happened, so the switch reads the row again: a click flips it through
|
||||
> `SetCurrentValue`, and a command that changed nothing — declined, refused, no Agent — used to leave it showing *on*
|
||||
> beside *off*, the owner's report of 2026-10-26)*; 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
|
||||
@@ -370,7 +420,8 @@ All screens are `Page`s registered with the navigation page provider and navigat
|
||||
>
|
||||
> **The recording switch (2026-09-23, FR-1.6).** A `ui:CardControl` **Recording** above the hooking control, its
|
||||
> `ToggleSwitch` `OneWay` from `games.record_sessions` and its command writing the row through
|
||||
> `GameLibrary.SetRecordingAsync` — no dialog (it deletes nothing; sessions already recorded stay) and nothing over
|
||||
> `GameLibrary.SetRecordingAsync` (and, since beta.30, raising the switch's property after it, as the hooking switch's
|
||||
> does) — no dialog (it deletes nothing; sessions already recorded stay) and nothing over
|
||||
> the pipe (the Agent reads the table each tick). Status line *Recorded when it runs* / *Ignored — nothing is
|
||||
> recorded*; the body says what off means (the program is not watched; a running session stops) and when to use it
|
||||
> (a utility that starts with Windows). The library card shows **Not recorded** in place of the hooking badge, since an
|
||||
@@ -423,7 +474,8 @@ All screens are `Page`s registered with the navigation page provider and navigat
|
||||
> what the game's files and its store say (`05_DETECTION` §What the files say about themselves): *Runs as* (64-bit
|
||||
> (x64) · 32-bit (x86) · ARM64 · .NET, any CPU (runs as 64-bit) · …), *File version* and *Product version* (the
|
||||
> executable's PE resource — for an Unreal title often the engine's), *Store* ("Steam build 20374416", "GOG version
|
||||
> 1.2.3" — or *Version* when the user typed it), *Engine*, and *Ships with*, one line per capability file: "DLSS:
|
||||
> 1.2.3", since beta.33 "Xbox version 1.3.5124.0" — or *Version* when the user typed it), *Engine*, and *Ships with*,
|
||||
> one line per capability file: "DLSS:
|
||||
> nvngx_dlss.dll 3.7.10.0", "XeSS: libxess.dll (no version)". A row the Agent has not read yet says so. The subtitle
|
||||
> labels the store's version the same way and then drops the bare store name it would repeat. **An executable that
|
||||
> cannot run as x64** (x86, 32-bit-preferring .NET, ARM) disables the hooking switch with `Hooking_NotX64_Format` under
|
||||
@@ -444,7 +496,7 @@ All screens are `Page`s registered with the navigation page provider and navigat
|
||||
1. **Sessions** — `DataGrid`: date, duration, **tier badge (T1/T2)**, Native, Displayed, FG×, 1% Low, 0.1% Low, resolution + upscaler, max GPU temp, API, chips, ⚠ crash badge, tags. Row → Session summary. ~~Multi-select → "Compare".~~ (not built; Compare's own picker chooses) Tier-2 rows render ~~`—`~~ `N/A` (not blank, not zero) in Tier-1-only columns, with a tooltip explaining why *(corrected 2026-10-04: as built — `—` means a measured none, §FPS display rule)*.
|
||||
2. **Frametime** — ScottPlot timeline of selected session (decimated), stutter markers, sensor overlay toggle (temp on right axis).
|
||||
3. **Distribution** — FPS histogram + percentile curve of selected session(s).
|
||||
4. **Trend** — metric-over-date line (selector: Native avg / Displayed avg / 1% Low / 0.1% Low / max GPU temp), vertical **hardware-change markers** with tooltip "GPU driver 572.16 → 576.02" (FR-6.3).
|
||||
4. **Trend** — metric-over-date line (selector: Native avg / Displayed avg / 1% Low / 0.1% Low / max GPU temp), vertical **hardware-change markers** with tooltip "GPU driver 572.16 → 576.02" (FR-6.3). *(The tooltip stood here unbuilt until beta.30 — 2026-10-26, owner decision D70: a numbered badge per day that changed, its changes in the list under the chart, the same text in the tooltip; below.)*
|
||||
|
||||
> **Across sessions, beta.11 (owner decision D39, FR-6.6).** The **Sessions** tab opens with *Sessions at a glance*: a
|
||||
> `TrendChart` of every hooked session's Presented FPS (sessions that counted no generated frame), Native and Displayed
|
||||
@@ -500,7 +552,8 @@ All screens are `Page`s registered with the navigation page provider and navigat
|
||||
> 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**:
|
||||
> snapshots differ in GPU driver, GPU, CPU, display mode or OS ("GPU driver: 572.16 → 576.02") *(numbered since
|
||||
> beta.30, the label's text in the list under the chart — below)*. **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~~ (corrected 2026-10-03: the Overlay never produced `vram_proc`, so the game's line was
|
||||
@@ -524,8 +577,30 @@ All screens are `Page`s registered with the navigation page provider and navigat
|
||||
> measured — and the trend opens on Native when the newest measured session counted generated frames; the machine
|
||||
> metrics count **Tier-2 sessions too** (a game never hooked had no trend); a point that describes part of its session —
|
||||
> settings changed, or a steady state, for Native and Displayed as well as the factor — is drawn **hollow** and the
|
||||
> note says so; hardware changes on one day are **one** marker; the metric list is built in the language the page opens
|
||||
> in; the empty text names the metric.
|
||||
> note says so; hardware changes on one day are **one** marker *(numbered since beta.30, its changes listed under the
|
||||
> chart)*; the metric list is built in the language the page opens in; the empty text names the metric.
|
||||
>
|
||||
> **Hardware-change markers, numbered — beta.30 (owner decision D70, "Số + danh sách").** The owner's screenshot of
|
||||
> 2026-10-26 showed the label "Driver GPU: 32.0.16.1742 → 32.0.16.2101" with its top cut off: ScottPlot's `VerticalLine`
|
||||
> label grows up from the data area into the top-axis panel, which nothing sized for it (about 15 px for a 25 px box),
|
||||
> every further line of a day's label was lost above the control's edge, and its white on the orange read 1.78:1 (dark)
|
||||
> and 2.63:1 (light). Asked, the owner chose numbers and a list. `TrendSeriesBuilder.Markers` numbers the days that
|
||||
> changed oldest first (`ChangeMarker`: the number, the day, each change once) and the view model hands the same list to
|
||||
> both charts and both lists, so a number means one day everywhere on the page. On the chart, `ChangeMarkerPlottable`
|
||||
> draws each day's dashed line in the data area and, in a band kept above it (`Axes.Top.MinimumSize`, measured from the
|
||||
> badge's font), a numbered badge in the palette's orange with `ChartTheme.TextOn`'s text — black in both themes, 11.79:1
|
||||
> and 8.00:1 — joined to its line by a short connector; `ChangeBadgeLayout` keeps every badge inside the data area's
|
||||
> width and off every other: too close, they stand aside in their lines' order; farther than about one badge from their
|
||||
> lines, or with no room at all, the nearest neighbours become one badge for the run (*3–5*). A badge is never cut off
|
||||
> and never over another, at any width; a day outside a zoomed range has no line and no badge. Under each chart
|
||||
> `ChangeMarkerList` gives every number its day (`Formats.Day`, the regional short date) and its changes in full,
|
||||
> wrapping, with a `ChangeBadge` chip in the badge's colours; the Trend's list stands with its chart. Pointing within
|
||||
> 14 px of a line, or at a badge, shows the same text in a tooltip, which closes on a press, a wheel or leaving the
|
||||
> chart. The pointer is read through the element's DPI now (`GetPlotPixelPosition`): `WpfPlot.DisplayScale` is taken
|
||||
> once, before the control has a window, and the overview's click used it. `ChangeBadgeLayoutTests`,
|
||||
> `PagesLoadTests.EveryChangeBadgeIsWholeInsideTheChartAndNoneIsOverAnother` (the Trend's 640×320, the overview's 220
|
||||
> px, a 300 px window, markers on the data area's edges, thirty days in a row), `ChartMathTests` (the badge's text in
|
||||
> both palettes) and the readable and theme-switch sweeps over the game page's list hold it.
|
||||
>
|
||||
> **FPS with two decimals (same day, owner item 7).** Settings ▸ Window: *Show FPS with two decimals*
|
||||
> (`ui.fps_decimals`, off by default) — every FPS figure through `Formats.FpsNumber`: "62.40" when on, "62" when off,
|
||||
@@ -555,10 +630,66 @@ All screens are `Page`s registered with the navigation page provider and navigat
|
||||
> mode): recorded from the first frame, never as administrator, refused for a recording-off entry. A viewer's (D52) Play is
|
||||
> off and its composition holds no `ShellStarter`. Tests: `StoreLaunchesTests`, `StoreRecordsTests`, `GamePlayerTests`,
|
||||
> `ViewerModeTests`.
|
||||
>
|
||||
> **beta.27: a Steam game may hand itself to Steam.** Started by the agent — *Start directly*, or every press while the
|
||||
> App runs as administrator — a game Steam's records name may leave within seconds and have Steam start it again (Lies
|
||||
> of P, 2026-10-19; `spike-notes` §23), and since beta.27 the game Steam starts is recorded. The notice says so for such
|
||||
> a game (`Play_Started_Steam_Format`, `Play_Elevated_Steam_Format`; `PlayResult.SteamGame` from the same store records
|
||||
> the store mode reads), and the *Start directly* tooltip and Settings ▸ Games ▸ Play button say it for every Steam
|
||||
> game, the latter adding that a few will not start outside Steam at all. The owner offered two ways (2026-10-20: a note
|
||||
> in the UI, or a fixed rule that Steam's games always go through Steam) and left the choice open; the note was taken
|
||||
> because the rule would cost too much: three of the five Steam games started directly on 2026-10-20 ran and were
|
||||
> measured from their first frame, and a Vulkan game is measured only when FrameLedger starts it (Everhex Demo).
|
||||
>
|
||||
> **beta.33 (D80): a game the Xbox app or the Microsoft Store installed always starts through Windows.** In either mode, and from an App running as administrator too, **Play** runs `explorer.exe shell:AppsFolder\<AUMID>` — the user's shell activates the game's package, unelevated, as its Start-menu tile does (`StoreLaunches`: the AUMID is the record's `<family name>!<application id>`, checked against the shape Windows gives one). Started by its path a GDK game is never the game in its package (`spike-notes` §25), so no mode sends `LaunchGame` for it, and the agent answers `PackagedGame` to one that reaches it anyway (an entry the App found no package record for). The notices: `Play_Xbox_Format` (started), `Play_Xbox_NotStarted_Format` and `Play_PackagedGame_Format` (start it from the Xbox app or the Start menu), all warnings but the first; the *Through the store* and *Start directly* tooltips and Settings ▸ Games ▸ Play button say it. The session is attach mode, `late_attach` (`04_CAPTURE` §Launch mode vs attach mode). Tests: `StoreLaunchesTests`, `GamePlayerTests`, `CaptureOrchestratorTests`.
|
||||
|
||||
### 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, **Display** — beta.10: the mode shown longest with its share and the window's size, both tiers; **VRAM (this game)** and **RAM (this game)** — beta.12: the median with the peak beneath, both tiers), **Statistics per series** (beta.12: every stored series' mean / median / minimum / peak), TriState chips, API/PresentMode/upscaler line, **the display line** (beta.10: every mode's share, the changes, the window on its monitor at its refresh rate, the back buffer and swap effect, and what the facts rested on — "the swap chain said whether it was exclusive" or "from the window alone: exclusive fullscreen cannot be told from borderless"; absent for a session recorded before), crash `InfoBar` (Severity=Error) when `crashed`, frametime chart, sensor strip, tags/notes editor, Export buttons.
|
||||
|
||||
> **beta.24 (D64): the DLSS line.** Under the header's library line, the summary says which DLSS ran (`DlssText.Line`): a
|
||||
> generation only where the session shows one, with what it rests on — *DLSS 4.5 (preset L)*, *DLSS 4.5 (a ×6.0
|
||||
> frame-generation state)*, *DLSS 3 (library 3.7.10)* — else *DLSS*; then each DLSS library with its version and where
|
||||
> it was loaded from (*Super Resolution 310.5.0, from the graphics driver, preset L (2nd-gen transformer model)*), then
|
||||
> *DLSS 5 runtime loaded* when it was. The game page's *Last session measured* repeats the label; the CSV export gains
|
||||
> `# dlss:`. `DlssTextTests`. *(beta.34: two more rows — the NVIDIA App's Dynamic frame generation the driver reports
|
||||
> applied is *DLSS 4.5 (Dynamic multi frame generation, set in the NVIDIA App)* (D83), and *DLSS 5 (neural rendering on
|
||||
> N % of rendered frames)* heads the line where the game was seen running it, its library listed like the others, *runtime
|
||||
> loaded, not seen running* where the Overlay looked and saw none (D84) — `05_DETECTION` §DLSS generation.)*
|
||||
|
||||
> **beta.27: one window per session, and no DLSS line that says only *DLSS*.** Opening a session whose summary window is
|
||||
> open — from a Sessions tab, a notification, the game page — brings that window forward, restored if minimised, rather
|
||||
> than opening a second (`SessionSummaryOpener`; the owner had two windows of one Silent Hill 2 session, 2026-10-20). The
|
||||
> DLSS line is not shown where it would say only *DLSS*: the header names the upscaler, and the NVIDIA App's override
|
||||
> loads its libraries under names no census lists, which the *Loaded:* line prints (The Witcher 3, 2026-10-20).
|
||||
> `PagesLoadTests.OpeningAnOpenSessionAgainBringsItsOneWindowForward`, `DlssTextTests`.
|
||||
|
||||
> **beta.24 (D63): the quality mode, on every surface alike.** The summary's header line, a Sessions-tab row, the game
|
||||
> page's *Last session measured* and the live card name the upscaler through one entry point (`Formats.UpscalerOf`):
|
||||
> the NVIDIA App's override where the driver reports it applied — *DLSS (driver-reported) Quality · NVIDIA App*, or
|
||||
> *DLSS · NVIDIA App override* when its mode is not settled —, else the mode the game passed (*DLSS Quality*), else the
|
||||
> name alone. Mode names come from the resources (`Nv_Mode_*`). Chart segments stay the hooks' (a segment carries no
|
||||
> driver report). The driver line reads the report's mode in NGX's numbering (it read it through the profile's table
|
||||
> until beta.24). CSV export: `# quality_mode:` (`quality (nvidia_app)`, `stored 9 (game)`, `N/A`).
|
||||
>
|
||||
> **beta.25 (D65): FSR's mode reads the same way** — *FSR 3 Quality*, *FSR Native AA* (`Fsr_Mode_NativeAa`), and
|
||||
> `native_aa (game)` in the export — wherever the session's byte names one (`03_METRICS` §Upscaling).
|
||||
|
||||
> **beta.24 (D62): the frame-generation mix.** Under the stat cards, **Frame generation in this session** — shown when
|
||||
> the session stored a mix of two rows or more (`sessions.fg_mix`, `03_METRICS` §The mix): a line saying how frame
|
||||
> generation was set (the NVIDIA App's Frame Generation Mode from the stored driver profile — *Set in the NVIDIA App:
|
||||
> Dynamic, up to ×6, target: max refresh rate*, *Fixed ×4* — or *Set in the game — no NVIDIA App frame-generation
|
||||
> override*; a value the driver ships in its own profile is said as the driver's; no line where no NVIDIA profile was
|
||||
> read), a bar of the shares (`Controls/FgMixBar`: drawn from code in the chart palette — a state by its multiplier,
|
||||
> `Chart_MixNone` and `Chart_MixUnclassified` for the other two — following a theme switch through
|
||||
> `ApplicationBackgroundColor` as `ArtTint` does; announced by its `AutomationProperties.Name`), and a table: a colour
|
||||
> swatch, the row (*×4.0 frame generation*, *No frame generation*, *Not classified*), its share to two decimals
|
||||
> (`<0.01%` for a sliver, never 0), its own *Native → Displayed* (one rate with no frame generation, none where no state
|
||||
> was read), and its time. A sentence explains *Not classified* when the table has it. A session that counted frame
|
||||
> generation and stored no mix — recorded before beta.24, or no state of 10 s — says so in one tertiary line. The CSV
|
||||
> export gains `# fg_mix:`; the JSON carries the column in its aggregates. Tests: `FgMixPresentationTests`,
|
||||
> `NvidiaOverridesTests`, `SessionSummaryViewModelTests`, `SessionExporterTests`, and the summary surface in
|
||||
> `PagesLoadTests` carries a mix so the block is read in both themes and through a switch.
|
||||
|
||||
> **beta.14 (D49): the new measurements, as cards and charts.** The cards come in three methods (`AddFrameCards`,
|
||||
> `AddPacingCards`, `AddMachineCards`), every value read from the row — never recomputed — and N/A on a row written before
|
||||
> beta.14:
|
||||
@@ -671,10 +802,20 @@ Stat cards (Avg uses `FpsReadout`, Median, 1% Low, 0.1% Low, Min/Max, σ, stutte
|
||||
|
||||
### 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.
|
||||
> **beta.34 (owner request 2026-11-06, with a screenshot; D85).** The list holds **every session** — it was the newest
|
||||
> 200, read on the UI thread with one game lookup each; now one read of the names, on the thread pool — and filters by
|
||||
> **Game**, **Tier** and **Frame generation** (with / without; a session that measured none is neither), with a count
|
||||
> (*6 of 131 sessions*); a ticked session stays listed whatever the filters say. The selection bar — *Pick 2 to 5
|
||||
> sessions*, the count, *Clear selection*, *Compare* — sits above the list on the left: it was a window's width away. The
|
||||
> columns are sized to what they hold with one filler column after them (three star columns spread a wide window into
|
||||
> gaps, and the Tier column was exactly its header's width, so *Tier* and *FPS* touched); the date sorts by when; the
|
||||
> settings-changed cell says *Changed mid-session* beside its icon, or a dash (it was blank). The result table's session
|
||||
> labels sit over their columns: the header row has the metric column's 140 px first, as every row does. Tests:
|
||||
> `CompareViewModelTests.TheFiltersNarrowTheListAndATickedSessionStaysOnIt`, the page in `PagesLoadTests`' surfaces.
|
||||
|
||||
**Mixed-tier guard (FR-6.2):** selecting sessions from different capture tiers shows a blocking `ContentDialog` explaining that they measured different things; proceeding stamps the chart with a tier legend and greys out metrics unavailable in the lower tier. Sessions with `settings_changed_midsession` carry a warning icon and are excluded from trend lines by default.
|
||||
|
||||
> **Built 2026-09-14 (P3 PR-7).** `CompareViewModel` over the last 200 sessions across games: a `DataGrid`
|
||||
> **Built 2026-09-14 (P3 PR-7).** `CompareViewModel` over ~~the last 200 sessions~~ every session *(since beta.34)* across games: a `DataGrid`
|
||||
> picker with a checkbox column (Compare enabled at 2–5), the FR-6.4 warning icon per row; **Compare** asks
|
||||
> `IMixedTierPrompt` (a `ContentDialog`, default button Cancel) when the selection mixes tiers and compares
|
||||
> nothing on a decline; a comparison that proceeds carries `Compare_Mixed_Legend` as the plot's title and an
|
||||
@@ -742,11 +883,11 @@ Tail view of `ui-*.log` / `agent-*.log` (toggle), level filter, search (`ui:Auto
|
||||
> (`Settings_RemoveUninstalled_Applied`), not at the next session — the detection sweep reads it at every pass. Tests:
|
||||
> `ViewerModeTests.EverySettingTheAgentReadsIsOffInAViewer`, `GuideDocumentsTests.TheSettingsPageOfTheGuideNamesEverySetting`.
|
||||
|
||||
Sections per FR-10 using the WPF UI settings idiom: `ui:CardControl`/`ui:CardExpander` rows with `ToggleSwitch`, `ComboBox`, `ui:NumberBox` (numeric inputs — min session length, sensor interval, retention). Language switch applies immediately (09_I18N). Theme selector (Light/Dark/System) drives `ApplicationThemeManager` (16 §Theming). **Capture section (top, most important):** the global **hooking kill switch** (`ToggleSwitch`, prominent) with a one-line summary of what it does; a list of games currently hook-enabled with a per-game revoke; Vulkan layer registration state + Register/Unregister; a link to the safety documentation. Turning the global switch off must take effect immediately, including for the Vulkan layer.
|
||||
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) *(beta.35, D91: a Windows contrast theme wins while it is on, §Contrast, and a line under the selector says so, bound to `ContrastTheme.IsOn` so it comes and goes with the page shown)*. **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~~ *(removed in beta.12 — nothing read it; corrected 2026-10-04)*. Privacy: online-metadata opt-in with plain-language explanation. Legal: reopen documents.
|
||||
Agent section: elevation state with a plain explanation of what elevation *optionally* unlocks (CPU temperature, elevated-game attach — ~~ETW fallback~~, which no longer exists) and that it is **not required by any capture tier**; task state, Register/Repair/Remove task, "Start agent at logon", ~~background capture toggle~~ *(removed in beta.12 — nothing read it; corrected 2026-10-04)*. ~~Privacy: online-metadata opt-in with plain-language explanation.~~ *(Not shown since 2026-09-16: no code makes the request and `privacy.online_metadata` stays reserved — the built Settings below; struck 2026-10-14.)* Legal: reopen documents.
|
||||
|
||||
> **The admin mode, beta.10 (owner decision D34; `01_ARCHITECTURE` ADR-9).** The Agent section has a switch, *Run the agent
|
||||
> as administrator* (`capture.run_elevated`, off by default). Turning it on opens a `ContentDialog`
|
||||
@@ -783,6 +924,8 @@ Agent section: elevation state with a plain explanation of what elevation *optio
|
||||
> `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 (alpha, D73, 2026-10-31):** in an alpha build the channel picker is locked and its line reads *An alpha build updates only to newer alphas, whatever is chosen here…* — an alpha's packages are on Velopack's own channel (`11_UPDATER` §Channels). **The alpha's shell (D74):** an **ALPHA** badge left of the Agent pill in the title bar for as long as it runs (its tooltip names `RuntimeInformation.FrameworkDescription`), the window and taskbar titled *FrameLedger Alpha*, and a Warning InfoBar above every page at every start, closable for that run, whose button opens the Alpha notice *(since beta.37, D97 and D98: its text is one of three — the experimental-build warning; the same naming "a prerelease .NET" where the runtime's description is a prerelease's; or, in an alpha cut while the alpha line rests, that the line is paused and to install the beta — `Services/AlphaTexts`, `Shared.AlphaLine`)*; About's version line names the runtime on every line, and `--diag` prints `release_line:` and the runtime's description.
|
||||
>
|
||||
> **Updates:** `update.channel` is read by PR-5's updater (beta = GitHub pre-releases; since beta.14 *Automatic (Beta)* or *(Stable)* first, the default, following the running copy — D47), and `update.auto_check` — the startup check, on by default — sits beside it. **Logging:** `log.debug` moves this app's `LoggingLevelSwitch` at
|
||||
> once; the Agent has no reader for the key yet, and the row says so. **Legal:** reopen is a "not yet" line
|
||||
> until PR-9's gate exists. ~~Register/Unregister the layer, Register/Repair/Remove the task~~ — PR-8b, with the
|
||||
@@ -820,7 +963,7 @@ Agent section: elevation state with a plain explanation of what elevation *optio
|
||||
> is gone. **Refresh** shows only while a row is *Checking…*, the one time it can change anything.
|
||||
|
||||
### First-run flow
|
||||
1. Legal Gate (FR-11): four documents, scrollable, links to GitHub-hosted versions, single Accept. **Since beta.12 (D45) Accept covers three** — the EULA, the Disclaimer, the Privacy Policy; the GPL is listed as *your licence*, with a line saying it needs no acceptance (GPLv3 §9), and gets no `legal_acceptance` row (`06_DATA_MODEL`). **Rendered since beta.12** (§Menu, *Documents are rendered*): the Markdown texts drawn, the GPL as written; a link from one document to another the gate shows opens it in the gate; *View on GitHub* opens the document at this build's source, through `IUrlOpener`.
|
||||
1. Legal Gate (FR-11): four documents, scrollable, links to GitHub-hosted versions, single Accept. **An alpha build's gate shows a fifth (D74, 2026-10-31): the Alpha notice** (`legal/ALPHA_NOTICE.md`), accepted with the others under `legal_acceptance.doc = 'alpha'` — and above the documents, under the summary, a second warning box with a tick box of its own (*I understand that this is an experimental build and I use it at my own risk*): Accept is disabled until it is ticked, every time an alpha's gate is shown. While the notice is outstanding the App holds the Agent's start (`IAgentLink.SetNoticeHold`, a hold of its own beside the updater's), because an alpha's Agent does not serve before it; Accept releases it and starts the Agent at once. About ▸ Legal documents lists the notice on every line, for information. **Since beta.12 (D45) Accept covers three** — the EULA, the Disclaimer, the Privacy Policy; the GPL is listed as *your licence*, with a line saying it needs no acceptance (GPLv3 §9), and gets no `legal_acceptance` row (`06_DATA_MODEL`). **Rendered since beta.12** (§Menu, *Documents are rendered*): the Markdown texts drawn, the GPL as written; a link from one document to another the gate shows opens it in the gate; *View on GitHub* opens the document at this build's source, through `IUrlOpener`.
|
||||
2. Agent setup: runs **unelevated by default** — a short, honest paragraph explains that elevation is optional and unlocks CPU temperature and elevated-game attach. ~~and the Tier-2 ETW fallback. It must be explicit that **without elevation there is no Tier 2**~~ — **struck 2026-08-28: no tier needs elevation, so there is nothing to warn about here.** Capability check results shown afterwards. ~~with Tier-2 availability listed as its own badge~~ — there is no availability to report.
|
||||
3. Hooking explainer: what Tier 1 vs Tier 2 means — **and it must be explicit that Tier 2 measures nothing**, because the honest version of this screen is the one where a user who declines knows what they are declining — and that hooking stays off until enabled per game.
|
||||
4. Optional library import.
|
||||
@@ -864,8 +1007,9 @@ Agent section: elevation state with a plain explanation of what elevation *optio
|
||||
(`ScrollViewer.CanContentScroll="False"` on the `Page` — `16_WPFUI_SYNTAX` §Gotchas: until beta.14 the wheel scrolled
|
||||
nothing on five pages, and the Logs tail did not follow the newest line); a scroller nested in a dialog hands the wheel
|
||||
on at its ends (`ui:PassiveScrollViewer`); over a chart a plain wheel scrolls the page and **Ctrl+wheel zooms the chart**
|
||||
(`Charts/ChartWheel`, every plot through `ChartTheme.Attach`) — drag still pans and double-click still resets, as
|
||||
ScottPlot does. The import checklist scrolls inside its list and nowhere else, so its intro and its count stay put.
|
||||
(`Charts/ChartWheel`, every plot through `ChartTheme.Attach`) — drag still pans and ~~double-click still resets, as
|
||||
ScottPlot does~~ *(corrected 2026-11-09: ScottPlot's left double-click toggled its render-time benchmark overlay; since
|
||||
beta.35 a double-click shows all of the chart, `ChartTheme.ResetOnDoubleClick`, `ChartKeyboardTests`)*. The import checklist scrolls inside its list and nowhere else, so its intro and its count stay put.
|
||||
|
||||
## Accessibility
|
||||
|
||||
@@ -873,22 +1017,50 @@ NFR-9 names three things — full keyboard navigation, adequate contrast in both
|
||||
and this section is what they mean for this app, each with the test that holds it (P4 PR-8, 2026-09-15). Until then
|
||||
the requirement was one bullet under §UX rules, and nothing checked it.
|
||||
|
||||
> **The users' half is `ACCESSIBILITY.md` (beta.35, owner decision D88, 2026-11-09):** the goal — WCAG 2.2 AA as W3C's
|
||||
> WCAG2ICT applies it to desktop software, a goal and never a conformance claim — what works, what does not and what to do
|
||||
> instead, and how a barrier is reported (the *Accessibility problem* form, `labels: [accessibility]`) and handled (by
|
||||
> severity, no promised times). It is embedded and shown under Help ▸ Accessibility. **This section is the design and the
|
||||
> checks; the statement says nothing this section does not hold**, and a change that moves either changes both
|
||||
> (`AccessibilityDocumentTests` holds the statement's own rules: embedded as written, a goal and no claim, a form that
|
||||
> exists, no struck text in a page the App shows). NFR-9 was widened the same day to screen readers and contrast themes
|
||||
> (D88–D91).
|
||||
|
||||
### Keyboard
|
||||
|
||||
| Keys | Does | Where |
|
||||
|---|---|---|
|
||||
| **Ctrl+1 … Ctrl+5** (and the numeric keypad's 1–5) | Dashboard · Games · Compare · Logs · Settings | `MainWindow` `InputBindings` → `MainWindowViewModel.NavigateToCommand` → `ShellShortcuts` |
|
||||
| **Ctrl+1 … Ctrl+5** (and the numeric keypad's 1–5) | Dashboard · Games · Compare · Logs · Settings — and since beta.35 the page's first control takes the focus once it is shown, its title (the page's first-level heading) said to a screen reader; before, the focus stayed where it was, often on the page that had just gone | `MainWindow` `InputBindings` → `MainWindowViewModel.NavigateToCommand` → `ShellShortcuts`, then `Services/PageFocus` (the shell tells it each page shown, from `NavigationView.Navigated`) |
|
||||
| **Alt**, **F10** | Focuses the menu bar; arrows and Enter walk File / Tools / Help | WPF `Menu`, nothing custom |
|
||||
| **Alt** + a menu's access key | Opens that menu — `_File` `_Tools` `_Help`; `_Tệp` `_Công cụ` `Trợ _giúp`; `ファイル(_F)` `ツール(_T)` `ヘルプ(_H)` *(row added 2026-11-09: the keys existed since P3 and this table did not name them)* | the `Menu_*` strings' `_` |
|
||||
| **Tab / Shift+Tab** | Moves through a page in reading order | layout order; no `TabIndex` overrides |
|
||||
| **Arrows, Home/End, Page Up/Down** | Move within a `DataGrid` (Sessions, Compare picker, Import checklist) | `DataGrid` defaults |
|
||||
| On a focused chart: **arrows**, **Ctrl**+arrow, **A** *(beta.35, D90)* | Pan, zoom, show all — ScottPlot's keys; the key is then the chart's, so the page neither scrolls nor moves the focus on (Tab still leaves) | `Charts/ChartPlot`, `Charts/ChartKeys` |
|
||||
| **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 |
|
||||
| **Enter** | In the consent dialog's phrase box: enables hooking once the phrase is typed exactly, does nothing before (beta.30, D69); elsewhere in a `ContentDialog`, the default button | WPF's default button (`ConsentPrompt`: `DefaultButton = Primary`) and `ConsentDialogContent.SwallowsEnter` |
|
||||
|
||||
**Focus after a dialog, and motion (beta.35).** A `ContentDialog` gives the focus back to the control that opened it: WPF
|
||||
UI 4.3.0's `ContentDialogHostController` stores `Keyboard.FocusedElement` when the dialog opens and focuses it again, at
|
||||
`DispatcherPriority.Input`, when it closes — the App adds nothing, and
|
||||
`FocusAndMotionTests.AContentDialogGivesTheFocusBackToTheControlThatOpenedIt` holds it (a first measurement said
|
||||
otherwise; it ran on a thread with no dispatcher context, where the dialog's own `finally` never resumed). A WPF UI
|
||||
`MessageBox` sets no owner — null before and after it is shown — so `Services/MessageBoxes` gives it the App's active
|
||||
window: it opens over it and hands the focus back to it, not to another program; every box goes through it
|
||||
(`EveryMessageBoxGoesThroughMessageBoxes`). A page slides in only while Windows' animation effects are on
|
||||
(`SystemParameters.ClientAreaAnimation`, followed as it changes): `Services/PageMotion` sets the `NavigationView`'s
|
||||
`Transition` to `None` while they are off, where WPF UI 4.3.0 played `FadeInWithSlide` whatever they were.
|
||||
|
||||
**Esc is the Close button, never the primary one.** On the consent dialog (FR-2.1) that is ~~"Keep it off"~~ "Keep hooking
|
||||
off" *(the button's text, corrected 2026-10-07)*: nothing is
|
||||
stamped. A dialog that offers no Close button is not dismissed by Esc, and the Legal Gate (FR-11) is a window of its own
|
||||
(`FirstRunWindow`) with explicit Decline and Accept, on which Esc does nothing. WPF UI 4.3.0 handles no key in
|
||||
either dialog type (its `ContentDialog.cs` and `MessageBox.cs` at tag 4.3.0 have no key handler — read 2026-09-15),
|
||||
which is why the handler is ours.
|
||||
which is why the handler is ours. *(Corrected 2026-10-26, beta.30: its code handles none, but `ContentDialog`'s
|
||||
TEMPLATE binds each button's `IsDefault` to `DefaultButton` and makes Close `IsCancel` — WPF's default and cancel
|
||||
buttons, read at the 4.3.0 tag. So Enter goes to the default button: in the consent dialog that was Close until
|
||||
beta.30, and a typed phrase followed by Enter declined (the owner's report; D69 above in the table). Esc reaches
|
||||
`DialogKeyboard` first — it handles the bubbling `KeyDown`, and WPF's access keys run after the routing and skip a
|
||||
handled key — so whether Esc alone would close a dialog through `IsCancel` is read from the template, not measured.)*
|
||||
|
||||
### Screen readers
|
||||
|
||||
@@ -899,7 +1071,54 @@ which is why the handler is ours.
|
||||
— corrected 2026-10-04): every `Button`, `ToggleButton`, `ToggleSwitch`, `CheckBox`, `RadioButton`, `ComboBox`,
|
||||
`TextBox`, `NumberBox`, `PasswordBox`, `Slider` and `HyperlinkButton` in the App's XAML either has content or a name. A new
|
||||
unnamed one is red.
|
||||
- Status lines that change after an action (the Database maintenance result) are `AutomationProperties.LiveSetting="Polite"`.
|
||||
- **What a screen reader is given, swept on every surface (beta.35, D88).** `PagesLoadTests.Automation` hosts every page,
|
||||
window, dialog and control as the App hosts it, every tab shown in turn, and reads the UI Automation tree WPF builds — the
|
||||
tree Narrator reads: **no Tab stop without an automation peer** (a plain `Control`, WPF UI's `Image`, `Card` and
|
||||
`CardControl` take the focus with no peer or an empty name), **no item named by its type** (WPF names a list's, a
|
||||
drop-down's and a grid row's item by `ToString()`, and a template column's cell, which has no text of its own, by
|
||||
`Item: <row>, Column Display Index: n`), **every focusable control named**, **no shown text hidden in a template** (a
|
||||
`TextBlock` whose templated parent is not a `ContentPresenter` is no control element), and **no two buttons in a list
|
||||
sharing a name**. All five went red on `main` first — the type-named items filled 190 lines over the surfaces and their
|
||||
tabs, the silent stops 37, and the safety InfoBar's title and message were hidden — and the fixes are: every item type speaks (`ToString()` through `Services/SpokenText`: `Choice` its
|
||||
label, a notice its title and text, a document page its title, a session row its date, length and tier…); the display-only
|
||||
controls (`FpsReadout`, `TriStateChip`, `ChangeBadge`) have a `Controls/SpokenTextAutomationPeer` — a Text element named
|
||||
by their words, no children — and leave the tab order; a template column names its cells through
|
||||
`Controls/CellName` (a cell style based on WPF UI's `DefaultDataGridCellStyle`, an empty cell read as *empty*); a row's
|
||||
button names its row (*Open: …*, *Play: …*, *Turn off: …*); the App's InfoBar template draws its title and message through
|
||||
`ContentPresenter`s; implicit styles take a plain `ItemsControl`, WPF UI's `Image` and `CardControl` out of the tab order;
|
||||
a `CardExpander`'s expand button is named after its header (`Controls/ExpanderToggleName` — WPF UI 4.3.0 leaves it
|
||||
unnamed). **The FPS readout says rule 6 aloud**: *Native 62 FPS, displayed 118 FPS, frame generation ×1.9*, a steady factor
|
||||
with its share, a stand-alone number with its qualifier (`FpsPresentation.Spoken`). `ScreenReaderNamesTests` holds each
|
||||
piece.
|
||||
- **Headings (beta.35, owner decision D90).** A page's title (`FontTypography="Title"`) is
|
||||
`AutomationProperties.HeadingLevel="Level1"`, a section title (`Subtitle`) `Level2`; a `Subtitle` that shows a value — the
|
||||
Dashboard's three figures, a stat card's value, the FPS readout's line — says `None` on purpose.
|
||||
`AccessibilityTests.EveryTitleAndSubtitleDeclaresAHeadingLevel` (every Title and Subtitle declares one),
|
||||
`PagesLoadTests.EveryPageHasOneFirstLevelHeadingItsTitle`. A rendered document's headings (the guide, LIMITATIONS, this
|
||||
statement, the legal texts) cannot be: a `FlowDocument` `Paragraph` has no automation peer, so it has no heading level to
|
||||
give — stated in `ACCESSIBILITY.md` §Known limitations.
|
||||
- **Charts (beta.35, D90).** Every plot is a `Charts/ChartPlot` — ScottPlot's `WpfPlot` with a peer: an Image whose
|
||||
localized type is *chart*, named by its `AutomationProperties.Name` (`A11y_Chart_*`), its help text where its numbers are
|
||||
as text (`A11y_ChartData_*`) and its keys (`A11y_Chart_Keys`); no children. Its focus is drawn with WPF UI's
|
||||
`DefaultControlFocusVisualStyle`. **No two series of a chart differ by colour alone** (`Charts/ChartPatterns`: lines
|
||||
cycle solid / dashed / dotted / densely dashed, then take markers; point series cycle circle / triangle / square /
|
||||
diamond; the power and thermal limit spans are striped and dotted) — `PagesLoadTests.NoChartTellsTwoSeriesApartByColourAlone`
|
||||
reads every chart's legend on every surface and the Compare chart with five sessions.
|
||||
- **What appears is said as it appears (beta.35, owner decision D89).** `Services/IAnnouncer`, over UI Automation's
|
||||
notification event in `Services/UiaAnnouncer` — the one place the App raises it, on its **active** window only (a game
|
||||
that has the screen is never interrupted; the tray's Windows notifications cover a hidden window) and only when a
|
||||
screen reader listens (`AutomationPeer.ListenerExists`). An **Alert** (`ImportantAll`, every one read): a safety notice as
|
||||
it arrives (`SafetyNotices`), a warning in the strip, the capture agent going offline, a game page's refusal or warning.
|
||||
A **Status** (`MostRecent` per activity, a newer one replacing one not yet read): the strip's info and success, the agent
|
||||
back (`A11y_Agent_Connected`), an update's step (`Services/ShellAnnouncements` says a *change* only — the first state is
|
||||
read with the window, a download's percent ticks are one step, a rebuilt window re-reads the same state silently), a
|
||||
game page's success, every Database maintenance result line. The words are the window's, in its language.
|
||||
`AnnouncementsTests`, `DatabaseMaintenanceViewModelTests.AResultIsSaidToAScreenReaderAsItAppears`.
|
||||
- ~~Status lines that change after an action (the Database maintenance result) are `AutomationProperties.LiveSetting="Polite"`.~~
|
||||
*(Corrected 2026-11-09: this announces nothing. WPF raises `LiveRegionChanged` only when the app raises it — "you
|
||||
explicitly raise an event", Microsoft's* What's new in accessibility *for 4.7.1 — and `TextBlockAutomationPeer` raises
|
||||
none (dotnet/wpf); the App raised no automation event anywhere. The setting marks the line as a live region and no
|
||||
more. It came out the same day, for the announcement above; no XAML may set one.)*
|
||||
|
||||
### Contrast
|
||||
|
||||
@@ -910,7 +1129,11 @@ palette per theme, chosen with the theme). *(Corrected 2026-10-14, beta.23: the
|
||||
a colour worked out at run time from the artwork and the theme's own text and fill colours, at the strongest opacity at
|
||||
which every text on it keeps 4.5:1 (tertiary 3:1), so it is held by construction rather than by the theme;
|
||||
`ColorMathTests` checks the hardest colours in both themes against the tests' own WCAG, and `PagesLoadTests` measures the
|
||||
rendered band. Its banner's fade is an alpha mask set in code, no colour at all.)*
|
||||
rendered band. Its banner's fade is an alpha mask set in code, no colour at all.)* *(beta.30: the change markers' badges
|
||||
and their chips in the list are the palette's orange under black or white chosen by contrast — `ChartTheme.TextOn`,
|
||||
black in both themes, 11.79:1 and 8.00:1, where ScottPlot's white label read 1.78:1 and 2.63:1;
|
||||
`ChartMathTests.AChangeBadgesTextReadsOnItsOrangeInEachTheme`. The orange LINE stays under 3:1 against the light
|
||||
theme's background, as it was before; the badge and the list carry its information.)*
|
||||
|
||||
> **"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
|
||||
@@ -978,13 +1201,71 @@ rendered band. Its banner's fade is an alpha mask set in code, no colour at all.
|
||||
> under it, in both themes. `EveryTextFollowsAThemeSwitch` hosts its pages in the presenter too since, and went red with
|
||||
> them: a page made after a switch stayed black. All three went red on the unfixed XAML before they went green.
|
||||
|
||||
> **Windows contrast themes, followed (beta.35, owner decision D91).** WPF UI 4.3.0 cannot be asked to do it:
|
||||
> `ApplicationTheme.HighContrast` names no dictionary; its four high-contrast files (HC1 Dusk, HC2 Night sky, HCBlack
|
||||
> Aquatic, HCWhite Desert) each hold 84 red `#FFFF0000` placeholders among 97 colours and 17 brushes that throw when the
|
||||
> file is read alone; their colours are Windows 11's defaults, not the user's; and they put the window text on the accent.
|
||||
> So while `SystemParameters.HighContrast` is on, `Services/WpfThemeApplier` applies the light or the dark Fluent theme as
|
||||
> the contrast theme is (by its window colour), with no Mica and no `SystemThemeWatcher`, and `Services/ContrastOverlay`
|
||||
> over it: every key of those four files in the user's colour for its role (`Services/ContrastRoles` — a key's role is the
|
||||
> colour it has in all four, opaque colours only, because inside the App a brush that throws alone falls back to the
|
||||
> Fluent theme's translucent fill: `MenuBarItemBackgroundPressed` read as the white of the window text, and a pressed menu
|
||||
> item was white on white; ties and placeholders by the key's name), the keys transparent there transparent, three
|
||||
> Fluent-only keys by role, the 21 accent keys WPF UI writes into the application's resources as the highlight, and the
|
||||
> text on the accent as the highlight's text. The colours are `SystemColors` (`ContrastPalette.FromSystem`) — the user's
|
||||
> own, edited or not, Windows 10's as well — and turning a theme on, editing it or turning it off is followed at once
|
||||
> (`SystemContrastSource`). What the App draws itself reads `ContrastTheme.Active`: the charts (`ChartPalette.ForContrast`,
|
||||
> the theme's colours only, the series told apart by `ChartPatterns`), a badge's text (`ChartTheme.TextOn`, the theme's
|
||||
> colour that reads best on the fill), the mix bar, the artwork band (no tint), the Import list (no dimmed rows), the
|
||||
> unsigned-update footer (the secondary text style, not an opacity). WPF UI's Danger button paints a fixed `#F44336` in its
|
||||
> style, out of any resource's reach, so every `ui:Button` takes the App's implicit style (`Styles/FrameLedger.xaml`): a
|
||||
> Danger button is the theme's own button while one is on, the message boxes' Delete included. Held by `ContrastThemeTests` — the four files still placeholders; every key a role or
|
||||
> transparent, none red; the roles the same over either Fluent theme; with each default theme's own colours the overlay
|
||||
> is WPF UI's colours key for key, the text on the accent apart; an edited theme's colours reach every key; every Fluent
|
||||
> colour key covered; every resource the App reads resolves; `ThemePlan`; the applier on and off at once — and
|
||||
> `PagesLoadTests.EveryTextIsInTheContrastThemesColoursAndReadable`: every surface rendered under the four default themes
|
||||
> and two edited ones, every text the theme's colour on the theme's colour at 4.5:1 or better. It went red first on the
|
||||
> chips (window text on the highlight, 1.26–1.78:1), the Remove button (3.06–4.42:1 on `#F44336`) and the badges' black.
|
||||
|
||||
> **A sixth hole, closed 2026-11-09 (beta.35), found by measuring what no sweep renders.** The title bar and the snackbars
|
||||
> are no surface, and the 3:1 sweep let 3.68:1 pass. The capture agent's pill was a `ui:Badge` whose appearance was
|
||||
> BOUND — Success, Info, Caution, Danger, WPF UI's `Palette*Brush` under `BadgeForeground` — so `ContrastTests`, which reads
|
||||
> literal attributes, never saw it: in the light theme 2.78, 2.63, 2.16 and 3.68:1. It is `AgentPill` now (a `Pill` on
|
||||
> `SystemFillColor{Success,Caution,Critical}BackgroundBrush`, the theme's text), and a bound badge appearance is refused.
|
||||
> WPF UI's Success and Caution snackbars are fixed colours under white in both themes, 2.78:1 and 2.16:1: the strip shows
|
||||
> every message as Secondary, the theme's, 13.97:1 and 16.53:1, its icon saying the kind. And a Danger button's text was
|
||||
> the theme's button text on `#F44336` — white in the dark theme, 3.68:1: the App's implicit button style puts
|
||||
> `TextFillColorDarkPrimaryBrush` there, 5.3:1 and 5.7:1. `ContrastThemeTests.TheTitleBarsMarksReadInEveryState`,
|
||||
> `ADangerButtonReadsInBothThemesAndIsTheThemesOwnButtonUnderAContrastTheme`,
|
||||
> `NoButtonOrBadgeTakesAnAppearanceThatPaintsAFixedColour` and
|
||||
> `AnnouncementsTests.EveryMessageOfTheStripIsDrawnInTheThemesOwnColours` hold the three.
|
||||
|
||||
### DPI
|
||||
|
||||
`app.manifest` declares Per-Monitor V2 (`AccessibilityTests.TheManifestIsPerMonitorV2`).
|
||||
`app.manifest` declares Per-Monitor V2 (`AccessibilityTests.TheManifestIsPerMonitorV2`). A chart reads the pointer
|
||||
through the element's DPI at that moment (`WpfPlot.GetPlotPixelPosition`, beta.30) — not `WpfPlot.DisplayScale`, which
|
||||
ScottPlot reads once when the control is made, before it has a window.
|
||||
|
||||
### Known gaps, stated
|
||||
|
||||
- ScottPlot plots are not keyboard-operable (no focus, no pan/zoom by keys). The numbers behind them are on the
|
||||
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.
|
||||
- ~~ScottPlot plots are not keyboard-operable (no focus, no pan/zoom by keys).~~ *(Corrected 2026-11-09, measured by
|
||||
`ChartKeyboardTests` in a window off the screen: a plot takes focus — ScottPlot's control is focusable and a Tab stop —
|
||||
and the keys ScottPlot reads reach it: the arrows pan, Ctrl with an arrow zooms, A shows all of it. ~~What it is not is
|
||||
usable: it has no automation peer, so Narrator says nothing on reaching it, and it marks no key handled, so the page
|
||||
around it acts on the same arrow too.~~ Since beta.35 it has a peer and keeps its keys, §Screen readers.)* A chart's
|
||||
points are still not read one by one. The numbers behind them are on the
|
||||
session summary's stat cards and in File ▸ Export (CSV/JSON); the hardware-change markers' text is WPF text in the
|
||||
list under each trend chart (beta.30).
|
||||
- ~~No screen-reader pass with Narrator has been done; the names above are necessary, not proven sufficient. That pass
|
||||
is the owner's.~~ **The owner's pass, 2026-11-09: keyboard only with the mouse disconnected, and Narrator, on
|
||||
0.1.0-beta.34 and 0.1.0-alpha.3 — every page, menu, dialog and setting reached and used, no fault.**
|
||||
- **What that pass could not show**, found the same day by measuring the UI Automation tree WPF builds (in memory, on
|
||||
.NET 10.0.14 — not by listening): ~~a drop-down's items are named by a record's printed form (`Choice { Value = dark,
|
||||
Label = Dark }`) and plain lists' items by their type; a control with no automation peer that still takes focus — a
|
||||
chart, the FPS readout, the RT/PT/RR chips, the game's artwork — is a Tab stop Narrator says nothing about; text inside
|
||||
a control template (the safety notices' title and message, the readout, the chips) is hidden from the control view;
|
||||
nothing is announced; no text is a heading; several charts tell series apart by colour alone~~ *(closed the same day,
|
||||
§Screen readers above)*; ~~page transitions play with Windows' animation effects off~~ *(not since beta.35,
|
||||
§Keyboard)*; ~~Windows contrast themes are not
|
||||
followed~~ *(followed since beta.35, D91 — §Contrast)*. `ACCESSIBILITY.md` §Known limitations
|
||||
states each to users with what to do instead.
|
||||
@@ -17,6 +17,10 @@ Languages: **en** (neutral/default) · **vi** · **ja**. Same `.resx` pattern as
|
||||
- One `Strings.resx` (+ `Strings.vi.resx`, `Strings.ja.resx`) per assembly that has user-visible text (`App`, `Shared` ~~for error codes~~ for the safety family, the `Safety_*` keys — corrected 2026-10-04). Access through a generated strongly-typed class; **no string literals in XAML/C# for user-visible text** (analyzer TODO: Meziantou MA0011/manual review in PR checklist). **As built (P3 PR-2, 2026-09-13):** the class is `Strings.Designer.cs`, written by `tools/resx-gen.ps1 -Resx <file>` and **committed** — not the SDK's `ResXFileCodeGenerator`, which the SDK-style WPF project does not run — with `Culture`, `ResourceManager`, `Keys`, and one property per key; the audit below fails when it is stale. The first family is `src/FrameLedger.App/Strings.resx` (65 keys); `Shared`'s arrives with PR-4's `Safety_*` text, because an empty family is what the audit refuses.
|
||||
- XAML binding via `{x:Static res:Strings.Key}` ~~plus a `LocalizeExtension` for the few dynamic cases~~ *(corrected 2026-10-04: no `LocalizeExtension` exists; text that varies is composed in the view model from `Strings.*`)*.
|
||||
- **Runtime switching:** setting change → set `CultureInfo.CurrentUICulture` + `Thread` defaults → re-create the main window shell (cheap; state preserved via VM). Persist in `settings`.
|
||||
**The new window opens on the page that was on screen** *(beta.34, owner request 2026-11-06)* — Settings, after a
|
||||
change made there. `ShellHost` remembered only the pages opened from code (`PageNavigator`), never a click in the
|
||||
pane, so a language changed on Settings brought back the last game page opened; it now notes every page the live
|
||||
window's NavigationView shows (`ShellHost.NoteShown`).
|
||||
**Two kinds of text did not follow, until beta.15:** a list of choices built once in a static (Settings' themes and update
|
||||
channels, the Logs page's two lists, the Games page's sort order — `x:Static` read the list built in the language the
|
||||
App started in), and the singletons that outlive the rebuilt window (the tray's menu, the title bar's Agent pill and the
|
||||
|
||||
@@ -64,6 +64,16 @@
|
||||
> 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.
|
||||
>
|
||||
> **A background service that fails, since 0.1.0-beta.37 (.NET 11, D94).** `--serve` awaits the Generic Host's
|
||||
> `RunAsync` and catches nothing. On .NET 10 a `BackgroundService` whose `ExecuteAsync` threw stopped the host and
|
||||
> `RunAsync` completed, so the Agent exited 0 with the fault in the log alone (the host's own line, in `agent-*.log`
|
||||
> since 2026-09-23). On .NET 11 `RunAsync` rethrows that exception — an `AggregateException` when several services
|
||||
> failed — so it reaches `Main`'s catch above: Fatal, the dump, and the runtime's exit code. Nothing was changed to get
|
||||
> this and nothing wraps it: an Agent that stopped because a piece of it broke should not report success. The App
|
||||
> hosts with `StartAsync` and `StopAsync` inside its own try/catch and is not affected. `HostBackgroundFailureTests`
|
||||
> holds the runtime's behaviour — a host with one throwing service fails `RunAsync` with that exception; the three
|
||||
> alphas shipped with it unobserved (`spike-notes` §24).
|
||||
>
|
||||
> 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
|
||||
|
||||
+13
-3
@@ -1,6 +1,6 @@
|
||||
# 11 — Updater
|
||||
|
||||
Velopack, feeding from GitHub Releases of `https://github.com/poli0981/frameledger`. ~~Stable channel only in v1.~~ *(Corrected 2026-10-04: two channels since P4 PR-5 — `update.channel`, ~~stable by default~~ or beta, which adds pre-releases. Every release so far is a pre-release; see §Built, Channels.)* *(Corrected 2026-10-05: the default is `auto` since beta.14, which follows the running copy — §The update audit, beta.14.)*
|
||||
Velopack, feeding from GitHub Releases of `https://github.com/poli0981/frameledger`. ~~Stable channel only in v1.~~ *(Corrected 2026-10-04: two channels since P4 PR-5 — `update.channel`, ~~stable by default~~ or beta, which adds pre-releases. Every release so far is a pre-release; see §Built, Channels.)* *(Corrected 2026-10-05: the default is `auto` since beta.14, which follows the running copy — §The update audit, beta.14.)* *(2026-10-31, D73: an **alpha line** beside them, on Velopack's `alpha` channel — §Built, Channels.)*
|
||||
|
||||
## Flow
|
||||
|
||||
@@ -52,7 +52,7 @@ SemVer `MAJOR.MINOR.PATCH`. Tag `vX.Y.Z` triggers the release workflow (13_CI_CD
|
||||
## 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
|
||||
this PR; **1.2.161 since beta.30**, owner decision D71 — the library and `vpk` together) 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 —
|
||||
@@ -90,7 +90,17 @@ flow, and the tests run the flow over a fake client because nothing here may tou
|
||||
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.
|
||||
release policy. *(Corrected 2026-10-31, D73: true of the main line, whose packages are on Velopack's default `win`
|
||||
channel. **The alpha line uses Velopack's channels**: an alpha is packed with `--channel alpha`, so its feed is
|
||||
`releases.alpha.json`, and an installed copy reads only its own channel's feed — `VelopackUpdateClient` passes no
|
||||
`ExplicitChannel`, so the channel is the one the installed package was built for (its `sq.version` names it). Velopack's
|
||||
`GithubSource` merges the assets of every release that carries that feed, so a beta never sees an alpha and an alpha
|
||||
never sees a beta, under either setting of `update.channel` — and in an alpha build that picker is locked, its line
|
||||
saying so (`08_UI` §Settings). **One limit follows from the source, read from Velopack's code 2026-10-31:** it asks
|
||||
GitHub for one page of ten releases, newest first, so ten releases of one line in a row would hide the other line's
|
||||
newest from its update check. The cadence is one alpha per beta (`13_CI_CD` §The alpha line) — *while the line tries a .NET; it rests since 0.1.0-alpha.4 (D98, 2026-11-11), betas then follow one another with no alpha between, and once ten of them have been published after alpha.4 a copy of alpha.3 or older no longer finds it: the alpha's notes, the guide and its banner say to install the beta.* Moving between the lines
|
||||
is a deliberate install, never an update: the other line's `Setup.exe` over the installed copy, which Velopack answers
|
||||
with its overwrite prompt — the packId, the install folder and the data folder are the same.)*
|
||||
- **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
|
||||
|
||||
+100
-7
@@ -1,10 +1,11 @@
|
||||
# 12 — Build & development environment
|
||||
|
||||
Mixed toolchain: .NET 10 for managed projects, MSVC for the native layer.
|
||||
Mixed toolchain: .NET 11 for managed projects *(since 0.1.0-beta.37, owner decision D94, 2026-11-11; .NET 10 until
|
||||
0.1.0-beta.36 — §The main line's .NET)*, MSVC for the native layer.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Windows 11 (dev), **.NET 10 SDK**, **Visual Studio 2026** with: .NET desktop development, **Desktop development with C++** (MSVC v143+, Windows 11 SDK ≥ 10.0.22621), C++ ATL not required.
|
||||
- Windows 11 (dev), **.NET 11 SDK** (11.0.100 or a later 11.0 feature band), **Visual Studio 2026** with: .NET desktop development, **Desktop development with C++** (MSVC v143+, Windows 11 SDK ≥ 10.0.22621), C++ ATL not required.
|
||||
- **Vulkan SDK** (~~for the layer +~~ validation layers during development, and to run `tools/vklayer-blastradius.ps1`) *(corrected 2026-10-04: the layer builds against the vendored `third_party/vulkan-headers`; CI installs no SDK)*.
|
||||
- CMake ≥ 3.28 (native projects use CMake; consumed by the solution via a build target — see below).
|
||||
- Optional: PawnIO for CPU-temperature testing; an NVIDIA GPU for the NVAPI/Reflex paths (dev machine: RTX 5080). AMD/Intel telemetry paths need no SDK — if you have such hardware, testing L1/L2 coverage there is valuable.
|
||||
@@ -48,9 +49,9 @@ Compiler/linker flags (enforced in CMake, not per-target ad hoc): `/std:c++20 /M
|
||||
|
||||
## Managed build & native integration
|
||||
|
||||
- **`global.json` pins the SDK band** (`10.0.x`, `rollForward: latestFeature`). Without it `dotnet build` picks the newest installed SDK — on a machine with a .NET 11 preview installed that silently changes analyzer behaviour under `TreatWarningsAsErrors`, and makes local and CI disagree for reasons nobody can see in a diff.
|
||||
- **`global.json` pins the SDK band** (`11.0.x` since beta.37 — `10.0.x` before — `rollForward: latestFeature`, `allowPrerelease: false`). Without it `dotnet build` picks the newest installed SDK — on a machine with a preview of the next .NET installed that silently changes analyzer behaviour under `TreatWarningsAsErrors`, and makes local and CI disagree for reasons nobody can see in a diff. *(The `alpha` branch carries the same file while its line rests, and pins the SDK it is trying when it does not — §The alpha line.)*
|
||||
- `Directory.Build.props`:
|
||||
- **`TargetFramework` = `net10.0-windows10.0.22621.0`** and **`SupportedOSPlatformVersion` = `10.0.19045.0`**. These are two different knobs and must not be conflated: the TFM platform version selects which Windows API projections are available to compile against, while the supported version is the floor CA1416 enforces. NFR-8 requires Windows 10 **22H2** = build **19045**; letting the supported version default to the TFM's would silently accept installs below the stated floor. Two constraints pin the target to 22621 rather than something closer to the floor: the SDK rejects `SupportedOSPlatformVersion` above `TargetPlatformVersion` (NETSDK1135), and 19045 is not a targeting-pack version in any case — the packs are cut at 19041, 20348, 22000, 22621, 26100. The Windows 11 SDK ≥ 10.0.22621 is already a prerequisite above, so this costs nothing. A bare `net10.0-windows` is wrong for a different reason: it resolves to `net10.0-windows7.0`, and CA1416 would then error on Mica, `MiniDumpWriteDump` and `QueryVideoMemoryInfo` — every Windows-10-era API this app is built on.
|
||||
- **`TargetFramework` = `net11.0-windows10.0.22621.0`** *(`net10.0-…` until beta.36)* and **`SupportedOSPlatformVersion` = `10.0.19045.0`**. These are two different knobs and must not be conflated: the TFM platform version selects which Windows API projections are available to compile against, while the supported version is the floor CA1416 enforces. NFR-8 names Windows 10 **22H2** = build **19045** as the oldest Windows the code is held to *(since D95, 2026-11-11: not blocked there, and neither tested nor supported — Microsoft supports .NET 11 on Windows 11)*; letting the supported version default to the TFM's would silently accept installs below that floor. Two constraints pin the target to 22621 rather than something closer to the floor: the SDK rejects `SupportedOSPlatformVersion` above `TargetPlatformVersion` (NETSDK1135), and 19045 is not a targeting-pack version in any case — the packs are cut at 19041, 20348, 22000, 22621, 26100. The Windows 11 SDK ≥ 10.0.22621 is already a prerequisite above, so this costs nothing. A bare `net11.0-windows` is wrong for a different reason: it resolves to `net11.0-windows7.0`, and CA1416 would then error on Mica, `MiniDumpWriteDump` and `QueryVideoMemoryInfo` — every Windows-10-era API this app is built on.
|
||||
- `Platforms`/`PlatformTarget` = `x64`. "x64 only" is asserted in CLAUDE.md and NFR-8 but was previously enforced nowhere except an ad-hoc `-r win-x64` on the publish command.
|
||||
|
||||
> **`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.
|
||||
@@ -162,6 +163,90 @@ repairs state, it does not grant machine-wide reach on its own).
|
||||
> after every sweep; the flag and the button run the same rule. The uninstall hook is still the updater's
|
||||
> (P4, Velopack).
|
||||
|
||||
## The main line's .NET (owner decisions D94 and D95, 2026-11-11)
|
||||
|
||||
**The main line — the betas and the first release — builds on .NET 11 since 0.1.0-beta.37**: SDK `11.0.100` (the band
|
||||
`global.json` pins), runtime and Windows Desktop `11.0.0`, C# 15 by `LangVersion latest`, and the three packages that are
|
||||
serviced with the runtime (`Microsoft.Extensions.Hosting`, `System.Diagnostics.EventLog`, `Microsoft.Data.Sqlite`) at
|
||||
`11.0.0`. .NET 11 shipped on 2026-11-10; the owner moved the line the next day.
|
||||
|
||||
- **What decided it, and what did not.** `20_OPEN_QUESTIONS` §G held a decision table written on 2026-10-31, before any
|
||||
evidence: move only after (a) two alphas on the released runtime had passed the gate and an owner's run of a hooked
|
||||
title, (b) the owner's word on Windows 10, and (c) something .NET 11 brings being wanted. **The owner set (a) aside** —
|
||||
no alpha had run on the released runtime; three had run on Release Candidate 3 (alpha.1 to alpha.3, the gate green
|
||||
each time) — decided (b) as D95, below, and for (c) asked for C# 15 in the same release (D96). What stands in for (a)
|
||||
is this release's own gate on 11.0.100 (`spike-notes` §28) and owner-only item 34.
|
||||
- **Windows 10 (D95).** Microsoft supports .NET 11 on Windows 11, and on Windows 10 only in its LTSC and IoT editions.
|
||||
FrameLedger does not block Windows 10 22H2: `SupportedOSPlatformVersion` stays `10.0.19045.0`, so CA1416 still holds
|
||||
the code to it, and nothing checks the Windows version at start. It is **untested** there — it always was
|
||||
(`ACCESSIBILITY.md`, `08_UI` §Accessibility) — and now **unsupported** too; NFR-8, `LIMITATIONS.md`, the README and the
|
||||
guide say so.
|
||||
- **The processor.** .NET 11 needs x86-64-v2 — SSE4.2 and POPCNT among its instruction sets — and does not start without
|
||||
it ("The current CPU is missing one or more of the baseline instruction sets"). Its ReadyToRun code targets x86-64-v3
|
||||
(AVX2 among others); Microsoft says a processor that lacks those may pay for it at start-up, where that code is
|
||||
compiled again. Every processor Windows 11 accepts has x86-64-v2.
|
||||
- **What .NET 11 changes in the software**, measured or read: `IHost.RunAsync` rethrows the exception of a
|
||||
`BackgroundService` that failed, so the Agent's `--serve` leaves through its crash report where on .NET 10 it exited 0
|
||||
(`10_LOGGING` §Crash handling; `HostBackgroundFailureTests` holds it); `Microsoft.Data.Sqlite` 11 declares SQLitePCLRaw
|
||||
3.0.5, whose engine is SourceGear's `SQLite` package; nine `Microsoft.Extensions.*` libraries are part of the runtime
|
||||
and no longer packages beside it (`legal/licenses/nuget/`: 78 packages became 69).
|
||||
- **C# 15 (D96)** is the language the main line compiles, and none of its constructs is used yet: the analyses do not
|
||||
read them (`13_CI_CD` §C# 15 and the analyses, `spike-notes` §29). What beta.37 takes from .NET 11 is API.
|
||||
- **Going back** is installing 0.1.0-beta.36 over a later build: the ledger's schema did not move with the runtime.
|
||||
|
||||
## The alpha line (owner decisions D73–D76, 2026-10-31; resting since D98, 2026-11-11)
|
||||
|
||||
The owner, 2026-10-31: an alpha build, "a place where new .NET versions are tried", with code updated where needed and a
|
||||
warning that it is an experiment used at one's own risk. **The alpha line** is the source of a released beta built to
|
||||
try a newer .NET — at times a prerelease one — from the long-lived `alpha` branch, published as `vX.Y.Z-alpha.N` GitHub
|
||||
pre-releases on Velopack's `alpha` channel (`13_CI_CD` §The alpha line, `11_UPDATER` §Channels). It tried .NET 11:
|
||||
Release Candidate 3 in alpha.1 to alpha.3 (2026-10-31 to 2026-11-06), the release itself in alpha.4.
|
||||
|
||||
- **The line rests since 0.1.0-alpha.4 (D98, 2026-11-11).** The main line moved to .NET 11 the day after it shipped
|
||||
(§The main line's .NET), so alpha.4 is 0.1.0-beta.37's source on the same .NET 11.0.0 — published so that a copy of
|
||||
alpha.3 leaves the release candidate by an update, since an alpha never updates to a beta. After it no alpha is cut
|
||||
until a newer .NET has a preview to try (.NET 12's, expected in 2027). While the line rests, the `alpha` branch differs
|
||||
from main in **`RELEASE_LINE` alone** (`git diff main alpha --name-only` prints that one name), and a resting alpha
|
||||
gets no update: its anti-cheat list, which reaches a user only inside a release (`13_CI_CD` §rules-publish.yml), stays
|
||||
the one it shipped with. Its notes, the guide and the Alpha notice tell its user to install the beta — **and the build
|
||||
itself does**: `Directory.Build.props` stamps its `FlAlphaLineRests` property (true on main since beta.37) into every
|
||||
assembly, `Shared.AlphaLine.Rests` reads it, and an alpha cut while it is true shows a banner that says the line is
|
||||
paused and to install the beta, in place of the experimental-build one (`App/Services/AlphaTexts`; D97: the words
|
||||
"a prerelease .NET" appear only where the runtime's own description is a prerelease's).
|
||||
- **The switch — what `alpha` differs from main in while it tries a newer .NET, and nothing else:** `RELEASE_LINE`
|
||||
(`alpha`); `global.json` (that SDK, with `allowPrerelease: true` when it is a prerelease); the TFM in
|
||||
`Directory.Build.props` (`SupportedOSPlatformVersion` stays `10.0.19045.0`); the three Microsoft packages in
|
||||
`Directory.Packages.props` that are serviced with the runtime (`Microsoft.Extensions.Hosting`,
|
||||
`System.Diagnostics.EventLog`, `Microsoft.Data.Sqlite`); `legal/licenses/nuget/` regenerated for that package set and
|
||||
the *Transitive* row of `legal/THIRD_PARTY_NOTICES.md`; `FlAlphaLineRests` set to `false` in `Directory.Build.props`;
|
||||
and a fix only the newer .NET can take, if one is ever forced.
|
||||
As it stood for .NET 11 RC3: SDK `11.0.100-rc.3.26522.148`, `net11.0-windows10.0.22621.0`, the three packages at
|
||||
`11.0.0-rc.3.26522.148` (`spike-notes` §24). **No newer language syntax and no preview feature on `alpha`** (D76): the
|
||||
source is main's, and main compiles with its own SDK.
|
||||
- **Everything else lives on main**, dormant on the main line. `RELEASE_LINE` is read like `VERSION` and stamped into
|
||||
every assembly as the `FrameLedger.ReleaseLine` metadata (`Directory.Build.props` refuses any value but `main` and
|
||||
`alpha`); `Shared.BuildLine` reads it back for the App and the Agent, which compose with it rather than reading it
|
||||
where they act, so a test hands either line to the code it tests. On the alpha line they act on it (D74): the Alpha
|
||||
notice in the Legal Gate with its own tick box, the Agent's wait for it, the ALPHA badge and banner, the locked update
|
||||
channel (`08_UI`), and the ledger's copy before an alpha first opens it (D73, `06_DATA_MODEL` §Migrations). What the
|
||||
alpha's SDK asks of the source and main's can also take lands on main.
|
||||
- **The native layer does not change.** MSVC builds it from the same source; only its build id differs (the alpha's
|
||||
tag). The hook, the guard and the Vulkan layer in an alpha are the beta's.
|
||||
- **Sync, and the cadence while it tries a .NET.** After each beta release a pull request merges main into `alpha` with
|
||||
a merge commit (the repository allows them; the linear rule is main's) and the next alpha is cut from it — **one alpha
|
||||
per beta, never several in a row**, because Velopack reads only the newest ten releases (`11_UPDATER` §Channels). A
|
||||
conflict in a switch file is resolved for the switch; `legal/licenses/nuget/` by regenerating it on `alpha`
|
||||
(`tools/license-gather.ps1`). An alpha older than the ledger's schema refuses to open it (`LedgerSchemaException`), so
|
||||
a beta that adds a migration is followed by an alpha soon. **The sync that ended the .NET 11 trial** (alpha.4) went
|
||||
the other way round: every switch file conflicted and main's version was taken for each, leaving `RELEASE_LINE`.
|
||||
- **Building it locally:** check out `alpha` with the SDK its `global.json` names installed and run `./build.ps1 check`
|
||||
as on main.
|
||||
- **Starting the next trial** (a preview of the next .NET): the switch above on `alpha`, the whole gate in a throwaway
|
||||
worktree first (`spike-notes` §24 is the pattern, with its decision table written before the run), and the Alpha
|
||||
notice's sentence naming the .NET.
|
||||
- **Whether the main line follows a trial** is the owner's each time: `20_OPEN_QUESTIONS` §G, *The main line's .NET*,
|
||||
holds the table and what happened to it for .NET 11.
|
||||
|
||||
## Version
|
||||
|
||||
**One source: the `VERSION` file at the repository root** (`MAJOR.MINOR.PATCH`, nothing else — P4 PR-5,
|
||||
@@ -217,6 +302,10 @@ vpk download github --repoUrl https://github.com/poli0981/frameledger --channel
|
||||
vpk pack --packId FrameLedger.App --packVersion {ver} --packDir out/app --mainExe FrameLedger.exe --packTitle FrameLedger --packAuthors FrameLedger --releaseNotes out/notes.md --outputDir out/release
|
||||
```
|
||||
|
||||
> **On the alpha line (D73, 2026-10-31) both vpk commands take `--channel alpha`** — the download, so an alpha's delta
|
||||
> is made from the previous alpha, and the pack, so its feed is `releases.alpha.json`, which no beta reads. The main
|
||||
> line's pack keeps the command above exactly (no `--channel`: Velopack's default on Windows is `win`). §The alpha line.
|
||||
|
||||
> **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
|
||||
@@ -299,7 +388,10 @@ would not fit).
|
||||
`release.yml` call `./build.ps1 check` with no switches since 2026-09-06, as the paragraph after this list says;
|
||||
only `-SkipIntegration`, which nobody passes, leaves them out, loudly)*
|
||||
7. `tools/coverage-gate.ps1` — reads this run's cobertura reports; self-arming, and armed today for
|
||||
`FrameLedger.Domain` and `FrameLedger.Application`
|
||||
`FrameLedger.Domain` and `FrameLedger.Application`. *(Since 2026-10-25 step 6 writes OpenCover beside each
|
||||
Cobertura report — `--collect:"XPlat Code Coverage;Format=cobertura,opencover"` — for SonarCloud, whose C# importer
|
||||
reads no Cobertura; `ci.yml`'s `sonarcloud` job takes them from the gate's artifact, `13_CI_CD` §SonarCloud. This
|
||||
gate still reads Cobertura only.)*
|
||||
8. `tools/rules-validate.ps1` (schema + `anticheat` block sanity — a malformed or empty blocklist is a safety bug)
|
||||
9. `tools/versioninfo-check.ps1` — reads the built binary, because what ships is what an anti-cheat vendor sees; since P4 PR-5 it also compares every `FileVersion` against the `VERSION` file (§Version); **since beta.14 (D50) both halves run — the self-test, then the native five and the managed eight from the App's and the Agent's build output** (`-ManagedDir`, `-ExpectedProductVersion` = `VERSION`), one copyright across all of them (§Version, *Identity*). Under `-SkipNative` the managed half still runs
|
||||
10. `tools/chokepoint-check.ps1` — injection and evasion primitives confined to one file, native **and** managed, plus the `FL_GUARD_TESTABLE` symbol check against the shipped artifacts
|
||||
@@ -309,9 +401,10 @@ would not fit).
|
||||
13b. `tools/accuracy-check.ps1 -SelfTest`, then live — the accuracy block is ONE text (`legal/ACCURACY.md`) embedded verbatim in `README.md` and `legal/DISCLAIMER.md` §4; a copy that drifted, a copy with no markers, or an empty source is red. Four self-test cases, both directions (§S23-6, 2026-09-06)
|
||||
13c. **`tools/notice-check.ps1 -SelfTest`, then live** (beta.12, owner decision D45, 2026-10-03) — every first-party source file (`.cs .cpp .h .inl .ps1 .xaml`, tracked or new, minus `src/native/third_party/`) opens with `SPDX-License-Identifier: GPL-3.0-only` and `Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE` in its own comment syntax, because GPLv3 §7 wants additional terms named "in the relevant source files" (`NOTICE` carries them); the second line may name another holder and year in the same form (a contributor's own file).
|
||||
Seven self-test cases, both directions; `./tools/notice-check.ps1 -Fix` writes a missing header, and `tools/resx-gen.ps1` generates the accessor with it
|
||||
13d. **`tools/wiki-build.ps1 -SelfTest`, then `-Check`** (beta.17, owner decisions D53/D54, 2026-10-07) — assembles the GitHub Wiki from `wiki/`, `guide/` and `LIMITATIONS.md` into a temporary folder, as `wiki.yml` does at a release (`13_CI_CD` §wiki.yml), and fails on a link to a file, folder or section that does not exist, two sources for one page, a page that neither Home nor the sidebar leads to, a sidebar that lists the guide in another order than `guide/README.md`, a backticked repository path in a `wiki/` page that names nothing, and a version number written into a `wiki/` page (the footer says which release the wiki shows). Nine self-test cases, both directions
|
||||
13d. **`tools/wiki-build.ps1 -SelfTest`, then `-Check`** (beta.17, owner decisions D53/D54, 2026-10-07) — assembles the GitHub Wiki from `wiki/`, `guide/`, `LIMITATIONS.md` and (beta.35) `ACCESSIBILITY.md` into a temporary folder, as `wiki.yml` does at a release (`13_CI_CD` §wiki.yml), and fails on a link to a file, folder or section that does not exist, two sources for one page, a page that neither Home nor the sidebar leads to, a sidebar that lists the guide in another order than `guide/README.md`, a backticked repository path in a `wiki/` page that names nothing, and a version number written into a `wiki/` page (the footer says which release the wiki shows). ~~Nine~~ Ten self-test cases since beta.35 (the statement's page, D88), both directions
|
||||
14. `tools/changelog-check.ps1 -SelfTest` — nine cases, five expected RED. The live half needs a pull request's changed-file list and is supplied by `ci.yml`
|
||||
14b. `tools/release-notes.ps1 -SelfTest` — five cases over a fixture changelog (a dated and an undated section, a missing one, a prefix that must not match, an empty one). 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)
|
||||
14b. `tools/release-notes.ps1 -SelfTest` — five cases over a fixture changelog (a dated and an undated section, a missing one, a prefix that must not match, an empty one), and since beta.24 three over a temporary tree: a version with its own `docs/changelog/<version>.md` is read from it, one without from `CHANGELOG.md`, a prefix of a file name is not that file. The live half needs a tag's version and runs in `release.yml`, where a missing or empty section is a red release (P4 PR-5)
|
||||
14d. **`tools/docs-split-check.ps1 -SelfTest`, then live** (beta.24, owner decision D66) — `CHANGELOG.md` holds no released section beside `[Unreleased]`; each `docs/changelog/<version>.md` holds one `## ` heading, its own `## [<version>] - date`, and no relative link (the App renders release notes as `CHANGELOG.md`); `CHANGELOG.md` and the files under `docs/changelog/`, and `docs/HANDOFF.md` and the files under `docs/handoff/` — and since PR-5 `docs/20_OPEN_QUESTIONS.md` and `docs/open-questions/`, `docs/spike-notes.md` and `docs/spike-notes/` — name each other in both directions. Eleven self-test cases, both directions
|
||||
14c. **`tools/buildid-check.ps1 -SelfTest`** (beta.18) — eight cases, both directions: a binary built from a dirty tree (`-dirty`, or the short form's `+`), one with no id, a missing one, and an expected id that is dirty or not an id are red. The live half needs the release's clean-checkout id and runs in `release.yml` over the published tree (§Release-time token substitution)
|
||||
15. `tools/resx-audit.ps1` — ~~**skipped loudly; it does not exist, and no `.resx` file does either**~~ **built 2026-09-13 (P3 PR-2)**: `-SelfTest` first (11 fixture cases, both directions), then the live pass over every `Strings.resx` family under `src/` — key sets equal across en/vi/ja, `Safety_*` in `ja` marked for review or signed, `Strings.Designer.cs` current with `tools/resx-gen.ps1`. A tree with no family is red (`09_I18N` §Translation workflow)
|
||||
16. **struct-mirror** — reads this run's `.trx` and fails when `ShmLayoutMirrorTests` did not execute, so deleting the mirror test is red as well as breaking it
|
||||
|
||||
+501
-19
@@ -6,9 +6,9 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
|
||||
|
||||
## Workflows (`.github/workflows/`)
|
||||
|
||||
### `ci.yml` — push to `main` + all PRs + `workflow_dispatch` (added 2026-10-04) · **repo-local**
|
||||
- `runs-on: windows-latest`, .NET SDK pinned by `global.json` via `actions/setup-dotnet`, MSVC via `ilammy/msvc-dev-cmd`, NuGet cached.
|
||||
- Single step of substance: **`./build.ps1 check`** — the same script, with the same switches (none), a developer runs before pushing. The gate list lives in `12_BUILD` §Local quality gate, **once**, rather than being restated here where it goes stale.
|
||||
### `ci.yml` — push to `main` *(and to `alpha` since 2026-10-31, D73 — §The alpha line)* + all PRs + `workflow_dispatch` (added 2026-10-04) · **repo-local**
|
||||
- `runs-on: windows-latest`, .NET SDK pinned by `global.json` via `actions/setup-dotnet`, MSVC via `ilammy/msvc-dev-cmd` (pinned to its v1.13.0 commit since beta.24 — the one third-party action, SonarCloud `githubactions:S7637`; Dependabot moves the pin), NuGet cached.
|
||||
- Single step of substance: **`./build.ps1 check`** — the same script, with the same switches (none), a developer runs before pushing. The gate list lives in `12_BUILD` §Local quality gate, **once**, rather than being restated here where it goes stale. *(That is the `check` job. Since 2026-10-25 a second job, `sonarcloud`, runs after it — §SonarCloud below; it is not the gate and not a required context.)*
|
||||
- ~~**`-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
|
||||
@@ -80,7 +80,7 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
|
||||
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.
|
||||
- Uploads coverage artifacts — ~~Cobertura~~ Cobertura and OpenCover since 2026-10-25, one pair per test project, as the `coverage` artifact the `sonarcloud` job reads (§SonarCloud).
|
||||
- **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
|
||||
@@ -93,16 +93,45 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
|
||||
> corrected with it; restating the gate list in two documents is what let one of them rot.
|
||||
- **Licence guard:** `tools/license-check` fails the build if a vendored dependency is missing its licence copy, or if Intel IGCL / AMD ADLX headers appear anywhere in the tree (`docs/18_GPU_VENDOR_APIS.md` §Vendor SDKs we deliberately do not use), or — since P4 PR-6 — if `legal/licenses/nuget/` is not what `tools/license-gather.ps1` writes for the NuGet packages this build ships. A Dependabot bump therefore goes red until someone re-runs the script and commits the texts, which is the point: the new version's licence is read by a person before it ships. Licensing regressions are silent and hard to unwind later — catch them at PR time.
|
||||
- **Placeholder guard:** fails if any `{{` token survives in `README.md` or `legal/*.md` *(other than `{{RELEASE_DATE}}`, which `release.yml` substitutes — added 2026-10-04)*. Those are shipped, legally operative documents (FR-11 displays them in the first-run Legal Gate); an unsubstituted `{{DEVELOPER_NAME}}` in an EULA is not a cosmetic defect.
|
||||
- ~~`permissions: contents: read`.~~ `permissions: contents: read, pull-requests: read` — the second for the Changelog step's list of a pull request's files, read-only *(corrected 2026-10-04)*.
|
||||
- ~~`permissions: contents: read`.~~ `permissions: contents: read, pull-requests: read` — the second for the Changelog step's list of a pull request's files, read-only *(corrected 2026-10-04)*. *Since 2026-10-25 per job:* the workflow grants nothing (`permissions: {}`), `check` holds those two and `sonarcloud` `contents: read` alone — a workflow-level grant reaches every job (SonarCloud `githubactions:S8264` on the first analysis from CI).
|
||||
|
||||
### `codeql.yml` — push, PR, weekly cron · **repo-local**
|
||||
### `codeql.yml` — push, PR, weekly cron, `workflow_dispatch` (since 2026-11-11) · **repo-local**
|
||||
|
||||
> **Not a caller stub, which this heading said until 2026-08-06.** `codeql.yml`'s own header says
|
||||
> the opposite: the ops repo has `codeql-mixed.yml`, but C++ needs manual build mode driven by the
|
||||
> CMake preset and that input surface has not been verified. The paragraph below already anticipated
|
||||
> exactly this outcome; the heading was never updated when it happened.
|
||||
- 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.
|
||||
- **And `actions`, since 2026-10-25** (build mode `none`): CodeQL reads `.github/workflows` for injection from event data, untrusted checkouts and over-broad tokens — the class of finding SonarCloud raised once (`githubactions:S7631`, `wiki.yml`, beta.26). Its context, `analyze (actions, none)`, is not one of `main`'s required checks; adding it to them is the owner's setting.
|
||||
- **Concurrency, since 2026-10-25:** a new push to a pull request cancels that pull request's run; a push to `main` and the weekly scan each run in a group of their own (the run id), so none is cancelled or left pending, and the default branch's alerts come from a finished analysis.
|
||||
- `permissions: security-events: write, contents: read`.
|
||||
- **On .NET 11 since beta.37 (D94) — measured on the pull request that moved the line (#376, run 42916491104, CodeQL
|
||||
2.27.4).** CodeQL's documentation lists C# up to 14 and .NET up to 10, and `analyze (csharp, none)`, a required
|
||||
context, had never met `net11.0`. With build mode `none` the extractor reads the source with its own compiler front
|
||||
end and uses a `dotnet` only for references: it found the 11.0.100 SDK `setup-dotnet` had installed and used that (on
|
||||
.NET 10 it downloaded 10.0.100 for itself), restored, and reported 363 resolved references and none unresolved, 9
|
||||
types it could not resolve (main's last run on .NET 10, 42862718138: 23, in three `Windows.Win32` namespaces), and
|
||||
**`CodeQL scanned 1220 out of 1220 C# files`** — main's line, word for word — in 4 min 5 s. The source it read used
|
||||
no C# 15 construct. **What it reads of C# 15 is measured construct by construct before one is used** (D96): a
|
||||
construct in whose file the extractor reports an error is not used on main until CodeQL reads it, and the same holds
|
||||
for Qodana's engine (§Qodana).
|
||||
*(Corrected the same day, two pull requests later: that run was an **overlay** — on a pull request the C# analysis
|
||||
extracts the files it changed on top of the database cached from `main`, then a .NET 10 one — so its "1220 out of
|
||||
1220" was `main`'s baseline figure and its other numbers the changed files'. The whole source on `net11.0` was first
|
||||
read by `main`'s own run after the merge (42921492229, "Overlay mode not enabled"): 1,221 source files, 363
|
||||
references resolved and none unresolved, 23 types unresolved in the three `Windows.Win32` namespaces — the figure it
|
||||
had on .NET 10 — and "CodeQL scanned 1221 out of 1221 C# files", in 4 min 45 s. So CodeQL reads `net11.0` as it
|
||||
read `net10.0`; and for a construct it has not met, a pull request's run is not the evidence — a
|
||||
`workflow_dispatch` on the branch is, §C# 15 and the analyses.)*
|
||||
|
||||
### `qodana.yml` — push to `main`, pull requests into `main`, `workflow_dispatch` · **repo-local, built 2026-11-10 (D93)**
|
||||
- One job, `qodana`, on `ubuntu-latest` — the only Linux job in this repository, because the linter is a Linux
|
||||
container: `JetBrains/qodana-action` (pinned to `v2026.2.2`'s commit; Dependabot moves the pin) runs Qodana Community
|
||||
for .NET over `FrameLedger.slnx` with `qodana.yaml`'s settings. §Qodana below says what it reads, what was changed
|
||||
from JetBrains' template and where an inspection is switched off.
|
||||
- **Advisory, with a gate of zero problems:** one problem turns the job red; it is not a required context.
|
||||
- `permissions: contents: read, checks: write, pull-requests: write` — the annotations and the one comment; granted to
|
||||
the job, the workflow grants none.
|
||||
|
||||
### `release.yml` — on tag `v*` · **repo-local, built 2026-09-14 (P4 PR-5)**
|
||||
|
||||
@@ -159,13 +188,21 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
|
||||
package) moves to `out/previous`, the feed and `RELEASES` are filtered to this build, and a downloaded previous package
|
||||
with no delta beside it fails the job. A failed download is a warning: the release is full-only, as every one before it
|
||||
was (`11_UPDATER` §Built).
|
||||
- `vpk pack --packId FrameLedger.App` (the `vpk` tool pinned to the library's 1.2.0) with the release notes;
|
||||
- `vpk pack --packId FrameLedger.App` (the `vpk` tool pinned to the library's ~~1.2.0~~ 1.2.161 since beta.30, D71) 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 alpha line (D73, 2026-10-31):** the version gate reads `RELEASE_LINE` beside `VERSION` and refuses a tag that
|
||||
disagrees with it — on the `alpha` line only `vX.Y.Z-alpha.N`, and an `-alpha.` tag nowhere else. An alpha's download
|
||||
and pack take `--channel alpha`, so the feed, the asset list, the legacy index and the installer are named for that
|
||||
channel (`releases.alpha.json`, `assets.alpha.json`, `RELEASES-alpha`, `FrameLedger.App-alpha-Setup.exe`, and the
|
||||
packages themselves, `FrameLedger.App-<version>-alpha-full.nupkg` / `-alpha-delta.nupkg` — measured on the first alpha's
|
||||
rehearsal, after which the delta check reads the name from `assets.<channel>.json` rather than building it) and its delta
|
||||
is made from the previous alpha; the main line's pack is unchanged. The release is titled *(experimental alpha)*, and
|
||||
its notes — the alpha's own file, `docs/changelog/x.y.z-alpha.N.md` — open with the warning (§The alpha line).
|
||||
- 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
|
||||
@@ -201,15 +238,18 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
|
||||
|
||||
### `wiki.yml` — after a successful Release run, and by hand · **repo-local, built 2026-10-07 (beta.17, D53/D54)**
|
||||
- **What:** the GitHub Wiki is a copy of the repository's own pages — `wiki/` (Home, the sidebar, the developer pages)
|
||||
and `guide/` (the user guide: the End-user part, the same pages the App shows) with `LIMITATIONS.md`.
|
||||
`tools/wiki-build.ps1` names each page (a guide page after its first heading, `guide/README.md` as *User-guide*,
|
||||
`LIMITATIONS.md` as *Limitations*), rewrites links between pages to page names and every other repository link to
|
||||
and `guide/` (the user guide: the End-user part, the same pages the App shows) with `LIMITATIONS.md` and, since
|
||||
beta.35 (D88), `ACCESSIBILITY.md`. `tools/wiki-build.ps1` names each page (a guide page after its first heading,
|
||||
`guide/README.md` as *User-guide*, `LIMITATIONS.md` as *Limitations*, `ACCESSIBILITY.md` as *Accessibility*), rewrites links between pages to page names and every other repository link to
|
||||
its address on GitHub **at the release's tag**, drops each page's first heading (the wiki prints the page name), and
|
||||
writes a footer naming the tag. The same assembly is `build.ps1`'s `wiki-check` gate (`12_BUILD` §Local quality gate,
|
||||
13d), so a dead link is red on the pull request, never on the published wiki.
|
||||
- **When:** `workflow_run` on `Release`, completed — the job runs only when that run succeeded and was started by a
|
||||
pushed `v*` tag, so a `workflow_dispatch` rehearsal of `release.yml` never publishes. It checks out the run's
|
||||
`head_sha` (a `workflow_run` job runs `main`'s copy of this file) and links at `head_branch`, the tag. By hand:
|
||||
pushed `v*` tag in this repository (`head_repository` is checked since beta.26: a fork cannot start the Release run,
|
||||
and the condition now says so — SonarCloud `githubactions:S7631`), so a `workflow_dispatch` rehearsal of
|
||||
`release.yml` never publishes. It checks out the run's
|
||||
`head_sha` (a `workflow_run` job runs `main`'s copy of this file) and links at `head_branch`, the tag. **Not after an
|
||||
alpha's release** (D73, 2026-10-31: a `-alpha.` tag is skipped): the wiki shows the newest beta. By hand:
|
||||
`gh workflow run wiki.yml -f ref=main -f publish=false` builds, checks and uploads the pages as an artifact; with
|
||||
`publish=true` it publishes them.
|
||||
- **Why not a step of `release.yml`:** the release stays as it was, its rehearsal stays a pure rehearsal, and a wiki
|
||||
@@ -222,27 +262,467 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
|
||||
- `permissions: contents: write` — the repository's default workflow token is read-only (read from the API,
|
||||
2026-10-07), and pushing to the wiki repository needs write.
|
||||
|
||||
## Dependabot (`.github/dependabot.yml`)
|
||||
## The alpha line — the `alpha` branch (owner decisions D73–D76, 2026-10-31; resting since D98, 2026-11-11)
|
||||
|
||||
What it is, what differs on the branch and why it rests since 0.1.0-alpha.4: `12_BUILD` §The alpha line. What CI and the
|
||||
release do with it:
|
||||
|
||||
- **`ci.yml`** runs `check` on a push to `alpha` and on every pull request into it, under the branch's own `global.json`
|
||||
— `setup-dotnet` installs the exact SDK it names whatever the `rollForward`, a prerelease one included. The
|
||||
`sonarcloud` job does not run for the branch (the organisation's plan analyses main alone, §SonarCloud), and neither
|
||||
does the `Changelog` step: what an alpha changes is written in its release's own file on main, never in an
|
||||
`[Unreleased]` entry on `alpha`, which would collide with main's at every sync.
|
||||
- **`codeql.yml` and `qodana.yml`** stay on main: the source is main's, and it is analysed there. *(Until beta.37 the
|
||||
reason given here was the alpha's compiler — C# 15, where CodeQL's extractor read C# 14. Main compiles C# 15 since
|
||||
beta.37; what CodeQL reads of it is §`codeql.yml`'s to say.)*
|
||||
- **The branch is not protected** (an owner's setting; none was asked for): pull requests into it are how changes land
|
||||
(squash), and the sync from main is a pull request merged with a merge commit — main's linear rule is main's alone.
|
||||
- **A release of the line**, in order: the alpha's notes on main (`docs/changelog/x.y.z-alpha.N.md` opening with the
|
||||
warning, its row in `CHANGELOG.md`'s Releases table, a line in HANDOFF's START HERE) → the sync pull request into
|
||||
`alpha` → a `release.yml` dispatch on `alpha` (`gh workflow run release.yml --ref alpha -f version=x.y.z-alpha.N`) →
|
||||
the signed tag on `alpha`'s head → the run (§release.yml: the line's tag rule, `--channel alpha`). **No wiki publish**
|
||||
(`wiki.yml` skips an `-alpha.` tag) and **no release line moves**: README, ACCURACY, the Disclaimer's copy,
|
||||
LIMITATIONS and ACCESSIBILITY keep naming the newest beta.
|
||||
- **The cadence while the line tries a .NET:** one alpha per beta, cut from it. Velopack's GitHub source reads the
|
||||
newest ten releases (one page, `perPage` 10), so ten alphas in a row would hide every beta from the betas' own update
|
||||
check, and the other way round (`11_UPDATER` §Channels). **While it rests** no alpha is cut, and that limit has a
|
||||
consequence the alpha's notes state: once ten betas have followed alpha.4, a copy of alpha.3 no longer finds it.
|
||||
|
||||
## SonarCloud — from CI, `ci.yml`'s `sonarcloud` job (owner decision D68, 2026-10-25)
|
||||
|
||||
**D68 — SonarCloud is analysed from CI.** The owner turned SonarCloud's Automatic Analysis off and set the
|
||||
`SONAR_TOKEN` secret (2026-10-24), and asked for the CI-based analysis with the newest scanner, run until its quality
|
||||
gate passed on issues and coverage both. It replaces D67 (the subsection below, as it stood): `.sonarcloud.properties`
|
||||
is gone, `SonarQube.Analysis.xml` holds what it held, and the two rules broken by design everywhere are configuration
|
||||
rather than marks in the UI.
|
||||
|
||||
**How it runs.** A second job of `ci.yml`, after `check` (`needs: check`), on every pull request from this
|
||||
repository and every push to `main` (or a `workflow_dispatch` of `main`) — never another branch: the organisation's
|
||||
plan refuses a branch analysis ("Organization is not allowed to access data from non main branches", a dispatch of
|
||||
the feature branch, 2026-10-25), so a dispatch of any other branch runs `check` alone:
|
||||
|
||||
1. a full-depth checkout (blame dates the new code; the tags name the version), .NET, MSVC, the NuGet and
|
||||
`~/.sonar/cache` caches;
|
||||
2. the gate's coverage — the `coverage` artifact `check` uploaded, not a second test run;
|
||||
3. `cmake --preset x64-release -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DCMAKE_CXX_SCAN_FOR_MODULES=OFF` and the one
|
||||
header the build generates (`fl_ac_floor_gen`) — the compilation database, with nothing compiled. *Scanning off
|
||||
because the first run failed on it:* with C++20 and Ninja, CMake gives every compile command an
|
||||
`@<object>.modmap` response file that only the build writes, and the C/C++ analyser (CFamily 6.85) stops with
|
||||
`IllegalStateException: unexpanded response file`; no source here uses a module;
|
||||
4. **SonarScanner for .NET 12.0.0** (2026-10-15, the newest), a local tool (`.config/dotnet-tools.json`, `dotnet tool
|
||||
restore`; Dependabot's nuget entry moves it), which provisions its own JRE: `begin` with `/s:SonarQube.Analysis.xml`
|
||||
→ `dotnet build FrameLedger.slnx -c Release` → `end`.
|
||||
|
||||
**Why a job of its own, and a build of its own.** The scanner's targets turn `TreatWarningsAsErrors` off and empty
|
||||
`WarningsAsErrors` in every build they instrument (`SonarQube.Integration.targets`, read in 12.0.0's source), so
|
||||
wrapping the gate's build would quietly weaken the gate. And the job is **advisory**: `main`'s required contexts stay
|
||||
`check`, `analyze (csharp, none)` and `analyze (cpp, manual)`. It waits for the quality gate
|
||||
(`sonar.qualitygate.wait`), so a failed gate — or a SonarCloud outage — is a red job beside a green `check`, never a
|
||||
blocked merge, and SonarCloud's app still posts its own *SonarCloud Code Analysis* check on the pull request.
|
||||
|
||||
**The C++.** The SonarScanner for .NET analyses only files an MSBuild project names: it drops `sonar.sources`, and
|
||||
its scan of the files outside the projects (`sonar.scanner.scanAll`: PowerShell, YAML, JSON and a dozen more) has no
|
||||
C or C++ in its list (`AdditionalFilesService`, 12.0.0). So `FrameLedger.Infrastructure.csproj` — the project that
|
||||
reaches the native layer — names `src/native`'s `.cpp` and `.h` files, `third_party` excepted, as `FlNativeSource`
|
||||
items, read through the scanner's `SQAdditionalAnalysisFileItemTypes`. The items exist only in a build the scanner
|
||||
instruments (its ImportBefore targets set `SonarQubeTempPath`), so a normal build, an IDE and a publish never see them;
|
||||
because they lie outside the project's folder, the scanner analyses them at the root, with the compilation database:
|
||||
MSVC's own flags and defines, where Automatic Analysis guessed them. Native code has no coverage report (below).
|
||||
|
||||
**Coverage.** `build.ps1` collects `"XPlat Code Coverage;Format=cobertura,opencover"`: Cobertura for
|
||||
`tools/coverage-gate.ps1`, as before, and OpenCover for SonarCloud, whose C# importer reads no Cobertura. The
|
||||
reports' paths are absolute, and every hosted Windows runner checks out to the same path, so the reports `check`
|
||||
wrote name the sources this job reads. Only `tests/*/TestResults/<guid>/` is read; the trx logger's second copy under
|
||||
`In/` is not. **Coverage is the C#'s alone** (`sonar.coverage.exclusions`): SonarCloud counts the executable lines of
|
||||
a file no report covers as uncovered — the first pull request analysis read `build.ps1`'s 232 lines to cover, every
|
||||
one uncovered, and failed the gate at 0 % on the two it changed — so the PowerShell tools (proven by their own
|
||||
`-SelfTest` cases, which no coverage tool reads) and the native code (Catch2 and the injection tests, with no coverage
|
||||
collector) are left out of the coverage figures; they are analysed for issues as everything else is. Measuring the
|
||||
native code would be the runner's Visual Studio coverage tool and `sonar.cfamily.*` coverage paths — not done.
|
||||
|
||||
**The version, and so the new code.** The project's new-code period is SonarCloud's *Previous version*. Until now
|
||||
every analysis was "not provided", so the new code was everything since the first analysis (2026-09-27): 34,268 lines
|
||||
on 2026-10-20. The job now passes `/v:` the newest `v*` tag the commit descends from, so new code is everything
|
||||
since the last release — **from the second analysis with a version on**, measured on `main` (below): the first,
|
||||
`main`'s first from CI, still counted from before any version existed; the second set the start at the last analysis
|
||||
without one (2026-10-20 05:11; 257 new lines on 2026-10-25). An issue the CI analysis raises on an older line is
|
||||
dated by blame — the newest line of its path — and is new code only when that line is. The gate is *Sonar way*: its
|
||||
coverage condition (80 % on new code) was skipped while no analysis had coverage, and applies from the first analysis
|
||||
from CI.
|
||||
|
||||
**What it reads** — `SonarQube.Analysis.xml`: the exclusions of `.sonarcloud.properties` (below) and what a build
|
||||
writes into the checkout, since the scanner walks all of it (`build/`, with the sources CMake fetches there, `out/`,
|
||||
every `bin/` and `obj/`, `TestResults/`) — SonarCloud also drops what `.gitignore` names (the first run: "63 files
|
||||
ignored because of scm ignore settings"), and the patterns say it in the file rather than rely on that; the same
|
||||
duplication exclusions; C++20; UTF-8; the OpenCover paths; the compilation database;
|
||||
**`sonar.cs.roslyn.ignoreIssues`** — Roslynator, Meziantou, the VS threading and the .NET
|
||||
analyzers already gate the build, warnings as errors, and what they report at a lower severity is this project's
|
||||
choice, so only SonarCloud's own rules are imported; and **two rules ignored where they apply by design** — `S8417`
|
||||
(sequentially consistent atomics) in `src/native`, any repository because a header is indexed as C, and
|
||||
`csharpsquid:S6640` (unsafe code) in Infrastructure and Shared. Those are the optional rows of the owner's steps below,
|
||||
which the UI's *Ignore issues on multiple criteria* would have held; a pull request adding atomics no longer fails the
|
||||
gate on them.
|
||||
|
||||
**What it does not cover.** A fork's pull request and Dependabot's get no secrets, so the job is skipped for them;
|
||||
Dependabot's would run if the owner added `SONAR_TOKEN` to the repository's *Dependabot secrets*. A pull request's
|
||||
analysis lists only the issues on the lines it changed, and no other branch can be analysed (above), so what the
|
||||
analysis from CI finds in the older code shows on `main`'s first analysis from CI and nowhere before it.
|
||||
|
||||
**The first analyses (2026-10-25, PR #334).** Run 40147463349: the scanner began, the build ran, the C# coverage was
|
||||
imported (635 files) — and CFamily stopped on the `.modmap` response files (step 3). Run 40148541525, with scanning
|
||||
off: everything analysed — 1,300 files indexed, 249 left out by the exclusions and 63 by `.gitignore`; of the
|
||||
compilation database's 181 units, 32 analysed in full (none partly; 118 whose sources are not analysed — the vendor
|
||||
stubs and what CMake fetched, Catch2 and MinHook —, 18 duplicates, 13 it does not support) in 139 s; 21 C and 32 C++
|
||||
files indexed (a `.h` is C to SonarCloud) — and the
|
||||
gate failed on two conditions, both fixed the same day: `githubactions:S8264` (a C security rating: workflow-level
|
||||
permissions reaching both jobs) and 0 % coverage on new code (`build.ps1`'s lines, before the coverage exclusions).
|
||||
A dispatch of the branch (40148544753) analysed it and was refused the gate, which is how the plan's limit was found.
|
||||
|
||||
**`main`'s first analysis from CI (run 40160302893, the merge of #334).** The gate failed on one condition, a C
|
||||
reliability rating on new code, and passed the others (84.7 % coverage on new code). The 34 open issues were all C++,
|
||||
raised there for the first time — the real MSVC flags let CFamily see them — and each dated by blame, 2026-08-02 to
|
||||
2026-10-19. Two were new code: `hook-harness`'s null dereferences, whose paths reach lines changed on 2026-10-19 — two
|
||||
MAJOR bugs, so C; the BLOCKERs were older lines. (A pull request's analysis never showed any of them: it reports no new
|
||||
issue on an old line.) The next analysis, the merge of #335 at 05:20, moved the new code's start to 2026-10-20 05:11
|
||||
and turned the gate green with nothing fixed; the merge of #336 at 06:17 closed 33 of the 34. The 34th, `S3519` in
|
||||
`fl_patch_check.h`, stayed open: its `NOSONAR` sat on `p -= 5`, and SonarCloud reports the read on the line after —
|
||||
moved there by the release pull request. The C# had none open. Beta.29 PR-3 settled them — fixed where the code was
|
||||
wrong, `// NOSONAR` with its reason above it where the analyser was (five):
|
||||
|
||||
| Rule | Where | n | What it was | Done |
|
||||
|---|---|---|---|---|
|
||||
| `cpp:S2275` format/argument | `fl-probe-nvapi` | 19 | `%u` for `NvU32`, an `unsigned long` (32 bits on Windows, so nothing printed was wrong) | `%lu`; the machine line `CaptureHost` parses prints the same |
|
||||
| `cpp:S2259` null dereference | `hook-harness` `main.cpp` ×2, `proxy_swapchain.h` | 3 | **real:** `--vulkan` and `--opengl` create no D3D11 objects, and `--opengl` alone ran the default probes through a null swapchain, as did any D3D11 mode beside either flag | `HaveD3D11`, asked first by every mode that drives the D3D11 swapchain; the duplicate mode flags are one |
|
||||
| `cpp:S2259` | `fl_ring.h` `Publish` | 1 | the path runs on past a failed `REQUIRE(w.Init(...))` in `ring_test`, which ends the test case; every real caller publishes through a writer whose `Init` succeeded, before any hook is installed | `NOSONAR` — a comment on the per-present path, no code |
|
||||
| `cpp:S3519` negative offset | `fl_patch_check.h` | 1 | by design: the 5 bytes before a hot-patchable function are its patch area, which the check reads under `StillOurs`' SEH guard | `NOSONAR`, no code |
|
||||
| `cpp:S6232` union pun | `dllmain.cpp`, the log's QPC epoch | 2 | `LARGE_INTEGER f{}` makes the union's first member, the `LowPart`/`HighPart` struct, the active one, so reading `QuadPart` reads a member that is not — undefined in C++, whatever `QueryPerformanceFrequency` wrote | initialised through the member read, `{.QuadPart = 0}` |
|
||||
| `cpp:S6232` | `guard_test.cpp` | 2 | a `ULARGE_INTEGER` to take a second off a `FILETIME` | 64-bit arithmetic on the two halves |
|
||||
| `cpp:S5813` `strlen` | `guard_test.cpp` | 1 | `strlen` of a fixed-size rules value | `strnlen(…, kMaxValueLen)` |
|
||||
| `cppsecurity:S9340` index from input | `layer.cpp`, `fl-baseline-probe` | 2 | the terminator written at the count `ReadFile` / `fread` returned, which never exceeds the request | the bound tested first (in the layer, its once-per-process enable-list read — whose `LARGE_INTEGER size{}` drew this PR's own `S6232` twice, and is initialised through `QuadPart` too) |
|
||||
| `cppsecurity:S5145` log injection | `rules_budget_test.cpp`, `fl-baseline-probe` ×2 | 3 | console output of a test and a probe: four numbers, and the ids of the seed rules file fixed at build time | `NOSONAR` |
|
||||
|
||||
**The C# gate is the server's profile, not the analyser's defaults.** SonarCloud applies *Sonar way core* here (166 C#
|
||||
rules, 176 C++). A local build with the `SonarAnalyzer.CSharp` package and its own default rules reports about 240
|
||||
findings in this code, nearly all from rules that profile does not activate (`S3358`, `S6667`, `S3267`, `S108`,
|
||||
`S3236`, `S2094`, `S927` among them); chasing them changes code for nothing the gate reads. What counts is
|
||||
`api/issues/search` for `main` or the pull request.
|
||||
|
||||
### Until 2026-10-25 — Automatic Analysis, no workflow (beta.24, owner decision D67)
|
||||
|
||||
*The text from here to the end of this section stood as written; what changed is marked.* ~~The project
|
||||
`poli0981_frameledger` is analysed by SonarCloud's GitHub app in **Automatic Analysis** mode: on every~~ The project
|
||||
`poli0981_frameledger` was analysed by SonarCloud's GitHub app in **Automatic Analysis** mode: on every
|
||||
push to `main` and on every pull request, with no workflow in this repository and no logs published. Its check on a
|
||||
pull request (*SonarCloud Code Analysis*) is advisory — it is not a required status.
|
||||
|
||||
**What it reads is set by `.sonarcloud.properties`** at the root, the only file Automatic Analysis reads, from the
|
||||
default branch. It excludes what is not FrameLedger's code or not code: the vendored SDK headers under
|
||||
`src/native/third_party/` (51 headers, 66 thousand lines — before this file they were 41.7 thousand of the project's
|
||||
94 thousand counted lines, classed C), the generated `Strings.Designer.cs` and `dxr_raygen_dxil.h`, the vendor stubs
|
||||
(fixtures that carry the vendors' export names on purpose), `tests/fixtures/`, the licence texts, the generated
|
||||
`docs/vendor-exports.json` and the SQLite migrations (a SQL analyser reads them as another dialect). It reports C++
|
||||
against C++20, the standard `src/native/CMakeLists.txt` sets. `build/`, `bin/`, `obj/` and `presentmon/` are
|
||||
git-ignored and never reach it.
|
||||
|
||||
**What it cannot do.** `sonar.issue.ignore.*` is not read by Automatic Analysis, so a rule this project breaks by
|
||||
design is recorded here and marked in SonarCloud's own UI — by the owner, who holds the account. A CI-based scan (the
|
||||
only way to import coverage or analyse one build variant of the C++) would mean turning Automatic Analysis off, a
|
||||
`SONAR_TOKEN` secret, OpenCover output beside today's Cobertura and a full-depth checkout; ~~it is not done~~ *done
|
||||
2026-10-25 (D68, above)*.
|
||||
|
||||
**The triage of 2026-10-19** — the analysis of `main` at `372389c` (2026-09-28; nothing had been analysed since),
|
||||
341 open issues, none resolved. Rules broken by design are *Accept*ed and false positives marked as such, each with
|
||||
the comment below; the rest are fixed in the same train (beta.24 PR-2).
|
||||
|
||||
| Rule | Issues | Verdict | Comment for the UI |
|
||||
|---|---|---|---|
|
||||
| `cpp:S8417` atomics should be sequentially consistent | 225 | **Accept** — by design | The SPSC ring and the hook counters use explicit acquire/release and relaxed orders on purpose (`07_IPC`); sequential consistency would add fences on the per-present path. |
|
||||
| `csharpsquid:S6640` unsafe code blocks | 31 | **Accept** — by design | Interop with the native layer and the shared-memory mirror, confined to `Infrastructure` and `Shared` (CLAUDE.md: the native layer is reachable only through `Infrastructure`). |
|
||||
| `cpp:S6232` union type-punning | 24 | **False positive** | `LARGE_INTEGER.QuadPart` is how the Windows API returns the value. |
|
||||
| `cpp:S5813` bounds when computing string length | 19 | **Accept** for the 17 below; the 2 with a buffer bound at hand were bounded (beta.24 PR-2: `FlGuardRulesFilePath` reads `wcsnlen(out, cap)`, the NVAPI bridge `strnlen` over the driver's `NvAPI_ShortString`) | Every string measured is NUL-terminated by construction — see the list under this table. |
|
||||
| `csharpsquid:S2077` dynamic SQL | 3 | **False positive** | A `PRAGMA` argument cannot be bound; the values are an `int` and closed sets of constants (`wal_checkpoint` mode, the tri-state column), never user text. |
|
||||
| `cpp:S935` `FlGetBuildId` returns no value | 1 | **False positive** | `FL_BUILD_ID` is defined by the build (`12_BUILD` §Version); the analysis compiles without it. |
|
||||
| `cpp:S3519` out-of-bounds `memcpy` | 1 | **False positive** | `fl_patch_check.h` reads the prologue of a function this DLL hooked, under SEH, by design (`17_HOOK_ENGINE` §Unhooking). |
|
||||
| `cpp:S836` garbage value returned | 1 | **False positive** | `hook-harness`'s `VtableOf` reads the vtable of a COM object it created itself. |
|
||||
| `csharpsquid:S3869` `DangerousGetHandle` | 1 | **Accept** | `ParentDump` passes the dump file's handle to `MiniDumpWriteDump` inside the `using` that owns the stream, on the same thread, so it cannot be released during the call; CsWin32 generates no `SafeHandle` overload here (`NativeMethods.json`: `useSafeHandles: false`). |
|
||||
| `cpp:S1669`, `cpp:S6191`, `csharpsquid:S4036`, `githubactions:S7637`, `csharpsquid:S2190`, `S3427`, `S8949` | 35 | **Fixed** in beta.24 PR-2 — 5 of the 23 `S1669` were in the vendored Vulkan headers and leave with the exclusions | — |
|
||||
|
||||
**`cpp:S5813`, the 17 accepted, and why each string is terminated** (lines as of beta.24):
|
||||
|
||||
- `fl_ac_rules.cpp` — `IStartsWith`/`IContains` (`:38`, `:43-44`) and `TokenIs` (`:74`) measure rule fragments and
|
||||
literals the guard itself holds; `:151` and `:288` measure a value `CopyToken` has just written, which refuses a token
|
||||
that does not fit and always writes the terminator; `CopyLiteral` (`:176`) measures a compiled literal; `:834`
|
||||
measures `SHGetKnownFolderPath`'s answer, terminated by the API.
|
||||
- `fl_guard.cpp:109` — the guard's own DLL path, built and terminated by its caller before injection.
|
||||
- `fl_guard_sources.cpp` — `:345` measures the executable's path the guard read itself and walked to its terminator
|
||||
in the loop just above; `:753` the install root the guard resolved from it; `VdfValue` (`:582`) measures the
|
||||
compiled keys its callers pass (`"installdir"`, `"appid"`), and `AllDigits` (`:617`) a value `VdfValue` copied with
|
||||
its own bound.
|
||||
- `fl_prescan.cpp` — `IsKernelDriverName` (`:40`) measures a name the directory walk handed over terminated;
|
||||
`SegmentIs` (`:181`) a literal; `:337` the executable's folder the pre-scan built itself.
|
||||
- `layer.cpp:99` (the Vulkan layer) — a leaf of `GetModuleFileNameA`'s result, which the line above has already
|
||||
checked is shorter than `MAX_PATH`, so it is terminated.
|
||||
- `fl-baseline-probe/main.cpp:55` — a literal (a developer probe, not shipped).
|
||||
|
||||
**The six left open after the trains (2026-10-19, beta.26)** — the analysis of `main` at `e35b971` (0.1.0-beta.25),
|
||||
after the owner's marking: 366 issues resolved (284 fixed — the exclusions and beta.24 PR-2 —, 49 accepted, 33 false
|
||||
positives) and six open, all in the new-code period, which is why its quality gate read C for reliability and security.
|
||||
Five were written after the analysis of `372389c` the table above was built from.
|
||||
|
||||
| Rule | Issues | Verdict | Comment for the UI |
|
||||
|---|---|---|---|
|
||||
| `csharpsquid:S3869` `DangerousGetHandle` | 1 | **Accept** — the row above | as above |
|
||||
| `csharpsquid:S1244` floating-point equality | 4 | **False positive** | Exact on purpose. `ColorMath.Hsv` compares `max` with `r` and `g` — `Math.Max` returned one of them, the same double; `MarkdownView`'s `next == _wheelTarget` is true only when `next` was assigned `_wheelTarget` (the snap that ends the easing); `SensorsChart.Line`'s `scale == 1.0` compares a parameter with its own default literal to skip a copy. |
|
||||
| `githubactions:S7631` untrusted code from a fork | 1 | **False positive**, and hardened in beta.26 | `wiki.yml` checks out `workflow_run.head_sha` only after a successful Release run started by a pushed `v*` tag, which a fork cannot start; since beta.26 it also requires `workflow_run.head_repository` to be this repository. |
|
||||
|
||||
**Marked by the owner the same day** (2026-10-19, 14:27–14:29 UTC), each as the table says: the four `S1244` and
|
||||
`S7631` as false positives, `S3869` accepted. `main`'s next analysis (`6b07eb2`) has no open issue and its quality gate
|
||||
passes.
|
||||
|
||||
**The owner's steps** after the next analysis of `main`: for each rule above, open
|
||||
`https://sonarcloud.io/project/issues?id=poli0981_frameledger&resolved=false&rules=<rule>`, select all, *Bulk change*,
|
||||
choose *Accept* or *False positive* and paste the comment. Optionally, *Administration ▸ General Settings ▸ Analysis
|
||||
Scope ▸ Ignore issues on multiple criteria*: `cpp:S8417` and `cpp:S6232` on `src/native/**/*`, `csharpsquid:S6640`
|
||||
on `src/FrameLedger.Infrastructure/**/*` and `src/FrameLedger.Shared/**/*`, so new instances of the by-design rules
|
||||
stop reappearing on pull requests. *(Since D68 the `S8417` and `S6640` rows are `SonarQube.Analysis.xml`'s, in the
|
||||
repository; `S6232`'s are not — a union read outside `LARGE_INTEGER` would be a finding — and its 24 stay marked.)*
|
||||
|
||||
## Qodana — `qodana.yml`, a workflow of its own (owner decision D93, 2026-11-10)
|
||||
|
||||
**D93 — Qodana reads the C# and the XAML from CI.** The owner made the project on Qodana Cloud, set the `QODANA_TOKEN`
|
||||
secret (2026-11-10) and asked for Qodana in CI from the workflow JetBrains gives, changed where it had to be, with what
|
||||
it reports fixed. Asked which licence the Qodana Cloud organisation holds, the owner answered: a 30-day trial. So the
|
||||
linter is **Qodana Community for .NET** (`qodana-cdnet`) — ReSharper's InspectCode in a Linux container, which runs
|
||||
under every licence — and not Qodana for .NET (`qodana-dotnet`, Rider), which needs Ultimate and would turn the job red
|
||||
the day the trial ends. JetBrains calls the Community linter Early Access.
|
||||
|
||||
**How it runs.** `.github/workflows/qodana.yml`, on every pull request into `main` from this repository, every push to
|
||||
`main`, and by hand: a full-depth checkout of the pull request's own commit, then `JetBrains/qodana-action` pinned to
|
||||
the commit of `v2026.2.2` (the newest; the template names `v2026.1`, and every action that is not GitHub's own is pinned
|
||||
by commit here). The action brings the Qodana CLI of its own version, the CLI the linter's image
|
||||
(`jetbrains/qodana-cdnet:2026.2` — InspectCode 2026.2.3.1 on the image's .NET SDK 10.0.403), and the linter reads
|
||||
`qodana.yaml`: the solution (`FrameLedger.slnx`), the configuration (Release), the gate. It builds the solution itself,
|
||||
then inspects it — the whole solution every time (`pr-mode: false`), so a pull request and `main` are judged by one
|
||||
list. The report goes to Qodana Cloud, a summary to the pull request as a comment and annotations, and the SARIF and
|
||||
the linter's logs to the run as the `qodana-report` artifact.
|
||||
|
||||
**What had to change from the template, and why.**
|
||||
|
||||
- **`EnableWindowsTargeting=true`, passed to the container** (`env-vars-to-linter`). Every project here targets
|
||||
`net10.0-windows`, and the .NET SDK on Linux refuses such a project unless that property is set. With it, the
|
||||
container restores, builds and loads all thirteen projects — WPF's markup compiler and CsWin32's generator are managed
|
||||
code — which the first run showed (below). It is the workflow's, not `Directory.Build.props`': no build of the product
|
||||
is meant to run anywhere but Windows. JetBrains' own page says a project with an OS-specific target needs Qodana for
|
||||
.NET in native mode; that is the Ultimate linter, and the Community one did the work.
|
||||
- **`ubuntu-latest`, the one Linux job here** — the Community linter ships as a Linux image only.
|
||||
- **Permissions:** `contents: read`, `checks: write` (the annotations), `pull-requests: write` (the comment). The
|
||||
template's `contents: write` is for pushing quick-fixes, an Ultimate feature this job never uses.
|
||||
- **`main` only.** The `alpha` branch is main's source under another release line (§The alpha line); main's is what
|
||||
is analysed. *(Until beta.37 the reason was the alpha's prerelease .NET, which the image does not carry.)*
|
||||
- **Interim since beta.37 (D94, 2026-11-11): the .NET 11 SDK is installed into the container first.** Main builds on
|
||||
.NET 11 and the image carries the SDKs 8 to 10, so `qodana.yaml` has the `bootstrap` line JetBrains' page gives for
|
||||
an SDK the image lacks — `dotnet-install.sh` with `global.json`, into `/usr/share/dotnet`. It lasts until the
|
||||
Ultimate linter's pull request replaces this job with one on Windows, where `setup-dotnet` does it. Measured on its
|
||||
first run (#376, run 42916491047): the script installed SDK 11.0.100 beside the image's own, InspectCode 2026.2.3.1
|
||||
loaded and inspected all thirteen `net11.0-windows` projects, and it reported one problem — a redundant `!` in the
|
||||
test that pull request added, fixed there. So the 63 keys and the zero held across the move.
|
||||
- **Not a fork's pull request, nor Dependabot's:** neither gets the secret or a token that can write the comment.
|
||||
- **Caches are saved from `main` only** (`cache-default-branch-only`); a pull request reads them.
|
||||
|
||||
**What it reads, and what it does not.** The C# of the thirteen projects, their XAML and `.resx`. **Not the C++:**
|
||||
`src/native` is a CMake tree no solution names, and it is MSVC-only, which no Linux container compiles — CodeQL and
|
||||
SonarCloud read it. The native DLLs are absent in the container, so the `.targets` that copy them warn and the build
|
||||
goes on, as on a fresh clone (measured here the same day: `dotnet build` of a clean worktree, 15 warnings, 0 errors).
|
||||
|
||||
**The gate is zero, and it is advisory.** `qodana.yaml` sets `failureConditions.severityThresholds.any: 0`: one
|
||||
problem and the job is red. `main`'s required contexts stay `check`, `analyze (csharp, none)` and
|
||||
`analyze (cpp, manual)`, so a problem Qodana finds — or a Qodana Cloud outage — is a red job beside a green `check`,
|
||||
never a blocked merge. That it can fail was shown before it was
|
||||
relied on: run 42847369329 had the settings and none of the fixes, found 409 problems and ended red — "Detected 409
|
||||
problems across all severities, fail threshold 0".
|
||||
|
||||
**Where an inspection is switched off: `.editorconfig`, never `qodana.yaml`.** InspectCode reads its severities from
|
||||
`.editorconfig`'s `resharper_*_highlighting` keys, and so do Rider and ReSharper in the editor — one list for the job
|
||||
and for the person at the keyboard, beside the analyzer severities already kept there, and testable without CI. Each
|
||||
key has its reason on the line above it. The rule: **what Qodana reports is fixed, unless the inspection argues with a
|
||||
choice this project made** — then it is off, and the reason says which choice. Sixty-three keys, in these groups:
|
||||
|
||||
| Group | Inspections | The choice it argues with |
|
||||
|---|---|---|
|
||||
| The compiler's missing-XML-comment warning | `CS1591` | already a suggestion in this file; InspectCode reports suggestions — 2,050 of the first run's 3,679 |
|
||||
| Naming | `InconsistentNaming` | names follow this file's rule and the .NET analyzers'; ReSharper's scheme renames `OpenGL`, `XeSS`, `Presents5s` and every `Chart_*` resource key |
|
||||
| Unwrapping a nullable | `ConvertTypeCheckPatternToNullCheck`, `PatternAlwaysMatches` | `x is long v` and `x is > 0 and int v` name the type, as `csharp_style_var_for_built_in_types = false` asks |
|
||||
| What a guard is for | three `…AccordingToAPIContract` inspections | the compiler's nullable analysis is the gate; a dependency property, a JSON document and a WPF event hand over null whatever an annotation promises |
|
||||
| Said on purpose | `RedundantExtendsListEntry`, `RedundantArgumentDefaultValue`, `RedundantEmptySwitchSection`, `MemberHidesStaticFromOuterClass`, `CompareOfFloatsByEqualityOperator` | a code-behind names its base; an argument repeats a default it relies on; `default: break;` says the rest is left alone; exact float comparisons are with a copied value or a sentinel |
|
||||
| Not this code's to change | `UnusedParameterInPartialMethod`, `Xaml.StaticResourceNotResolved`, `Xaml.PossibleNullReferenceException`, `LocalizableElement` | CommunityToolkit's generated signatures; WPF UI's run-time resources (`PagesLoadTests` fails a wrong key); a binding through null shows nothing, by design; exception and log text is English (`09_I18N`), and `resx-audit` gates what a user reads |
|
||||
| Records | `NotAccessedPositionalProperty.*` | a positional property is part of equality and of what the record prints |
|
||||
| Style proposals | twenty, from `ConvertToPrimaryConstructor` to `UseAwaitUsing` | the style is this file, `dotnet format` and the analyzers; `await using` under CA2007 reads worse than what it replaces |
|
||||
| Accessibility proposals | `MemberCanBePrivate.*`, `PropertyCanBeMadeInitOnly.*`, `AutoPropertyCanBeMadeGetOnly.*` | a member's accessibility is what its type offers, not a count of today's callers |
|
||||
| "Never used" across the solution | eight `.Global` inspections | enum values mirror the native layout and stored columns, exception types carry CA1032's constructors, rows and messages are read by Dapper and System.Text.Json; the private kind (`.Local`) stays on — and what this group named on 2026-11-10 is listed below |
|
||||
| In `tests/` only | eleven | an assertion lambda runs inside the `using` it captures from; a test that dereferences null fails, which is its job; a test double keeps the shape of what it stands for |
|
||||
|
||||
Five places carry a `// ReSharper disable once …` comment with its reason instead, where the inspection is right in
|
||||
general and wrong once: the tolerance channel closed early in `CaptureSession`, the volatile read in
|
||||
`SessionEventPublisher`, the awaited `Task.Run` in `CaptureOrchestrator`, the window read lazily in
|
||||
`SessionSummaryOpener`, and a test row that is never on.
|
||||
|
||||
**The first run, and what was done (2026-11-10, PR #373).** Run 42842741359, the template's shape with no settings:
|
||||
the container built the solution and inspected it in under six minutes, and reported **3,679 problems** — 858 warnings
|
||||
and 2,821 suggestions, in 93 inspections. About 400 were fixed in the code, in 181 files, none changing what the
|
||||
software does:
|
||||
|
||||
| What | n | Done |
|
||||
|---|---|---|
|
||||
| Redundant qualifiers, casts, `using` directives, `!` suppressions, `unsafe` modifiers, tuple names | 290 | removed, by script from the report's own positions; the build (warnings as errors, Release and Debug) and `dotnet format` held every one — one cast of a pair in `SqliteGameMerge` was needed after all, and stayed |
|
||||
| `var` for a built-in type, a block body for a one-line method | 52 | this file's own style (`csharp_style_var_for_built_in_types`, `…expression_bodied_methods`), applied by `dotnet format` |
|
||||
| XAML bindings the inspection could not resolve | 35 | every item template names its `DataType`; a binding that reached the page through `DataContext.ViewModel` with `AncestorType=Page` names the page's type and its `ViewModel` — the same object at run time, and now navigable in the editor (`ViewerModeTests` pins the new text) |
|
||||
| Left over in the code | 12 | `LogsViewModel`'s unread `_strip` field and `PipeServer.Client`'s unread `_run`; two initialisers a constructor overwrote; `GameFileProbe.UnityDataFile`'s unused parameter; `SpokenTextAutomationPeer` no longer assumes `GetNameCore` returns a string; a redundant setter and two grid positions in XAML; a `$` on a string with no hole; `!Any(==)` as `All(!=)`; a `foreach` variable's type |
|
||||
| In the tests | 14 | unused variables, lambda parameters and an accessor; a linear `Contains` on a set; three simplifications |
|
||||
|
||||
The rest was settled by the settings above — 2,050 of it the one inspection the project had already made a
|
||||
suggestion. A suggestion to use `m[^1]` inside an expression tree was wrong (CS8790) and its inspection is off.
|
||||
|
||||
**The runs (PR #373).** 42842741359 — the template's shape, no settings: 3,679 problems, the job green (no gate yet).
|
||||
42847369329 — the settings and the gate, none of the fixes: 409 problems, every one in an inspection left on, the job
|
||||
red; so `.editorconfig`'s keys are read in the container as they are on Windows, and the 3,270 others were the
|
||||
settings'. 42849331796 — the fixes: **0 problems**, the job green; and `main`'s first run, the merge of #373
|
||||
(run 42852304026): 0 problems. A job takes about ten minutes.
|
||||
|
||||
**Named by the "never used" group and left as it is (2026-11-10).** Nothing in the solution, its tests included, uses
|
||||
these; whether each is vocabulary, a piece not wired yet, or dead is the owner's to say, so none was removed:
|
||||
`AtomicFileWrite` (the class and `PublishAsync`), `ExecutableMarkerScan` and `IExecutableMarkerScan.Scan`,
|
||||
`FpsPresentation.GeneratedLine`, `IPageNavigator.GoBack`, `OperatorDisclosure.VersionOf` and `ProvenanceOf`,
|
||||
`CrashReporterCatalog.AlwaysOn`, `ProcessWatcher.Tracked`, `LedgerWalCheckpoint.Complete`,
|
||||
`LhmTelemetryOptions.EnableCpuAndMemory`, `MeasuredFacts.StreamlineNoneWithheldFrom`, `ILegalAcceptanceStore.ListAsync`
|
||||
and `ITelemetryPoller.Dropped` (only their implementations are called), `DocumentBrowser.PageChanged` and
|
||||
`UrlOpener`'s getter, the charts' `PercentilePlot`, `NoteText` and `TempsPlotView`, `GameDetailViewModel`'s
|
||||
`TrendEmptyText`, `LatencyHeader` and `SensorsEmptyText`, `GamesViewModel.SortLabel`, `TriStateChipModel.IsNo`,
|
||||
`AboutWindow`'s `AppTab` and `ThirdPartyTab`, `NvapiNgxWords.Degraded`, `IpcMessages`' `TelemetryUnavailable` and
|
||||
`DbWriteFailed`, `IpcProtocol.Keepalive`, `ShmLayout.GuardTickDeadlineMs`, `HarnessOverlayLogSweep.Own`; and the
|
||||
getters of 49 auto-properties, among them view-model texts no page binds and columns of stored rows. The list is
|
||||
`UnusedMember.Global` and its siblings in run 42842741359's report.
|
||||
|
||||
**Running it on a developer's PC.** The same InspectCode is a .NET tool:
|
||||
`dotnet tool install JetBrains.ReSharper.GlobalTools --version 2026.2.3.1 --tool-path <somewhere>`, then, after
|
||||
`dotnet build FrameLedger.slnx -c Release`:
|
||||
`jb inspectcode FrameLedger.slnx --no-build --format=Sarif --output=<file> --caches-home=<folder> --properties:Configuration=Release --toolset-path="C:\Program Files\dotnet\sdk\<11.0.x>\MSBuild.dll" --dotnetcore="C:\Program Files\dotnet\dotnet.exe"`.
|
||||
Two things measured on the owner's PC: without `--toolset-path` it picked Visual Studio 18 Insiders' MSBuild, which
|
||||
crashed at start ("No files to inspect were found"); and a `--caches-home` a failed run had written left one project
|
||||
unloaded on the next (2,875 false compile errors, all in `Infrastructure.Tests`) — a fresh folder loaded all thirteen.
|
||||
A clean run there reports what the container does, to within a handful of findings that differ between Windows and
|
||||
Linux (3,679 in the container, the same inspections on Windows with counts a few apart).
|
||||
|
||||
**What it does not cover, and what would change it.** No C++ (above); no `alpha`; no pull request from a fork or from
|
||||
Dependabot; no quick-fixes, coverage or licence audit (Ultimate). **If the organisation gets an Ultimate licence** —
|
||||
JetBrains has a programme for open-source projects — Qodana for .NET runs natively on Windows: `linter: qodana-dotnet` in
|
||||
`qodana.yaml`, `runs-on: windows-latest`, `args: --within-docker false`, .NET set up from `global.json` first, and
|
||||
`EnableWindowsTargeting` dropped. Until then the trial's end changes nothing here: the token only names the project
|
||||
the report is sent to.
|
||||
|
||||
## C# 15 and the analyses (owner decision D96, 2026-11-11)
|
||||
|
||||
The main line compiles C# 15 since beta.37 — `LangVersion latest` on the .NET 11 SDK — and the owner asked for its
|
||||
constructs to be used. **None is used yet, and this section is why.** The rule the plan was approved with: a construct
|
||||
is used on main only where (1) the build, its analyzers and `dotnet format` take it with no analyzer switched off,
|
||||
(2) CodeQL extracts its file without an error, and (3) Qodana reports nothing that is only its engine not knowing the
|
||||
syntax — the first two are required checks, and Qodana's gate is zero. Each construct was written once, in a file of its
|
||||
own, and shown to each tool (`spike-notes` §29, the canary):
|
||||
|
||||
| Construct | Build and analyzers | ReSharper's engine — InspectCode 2026.2.3.1, which Qodana 2026.2 runs, and 2026.3.0 | Used on main |
|
||||
|---|---|---|---|
|
||||
| Collection expression arguments, `[with(…), …]` | taken | an error: "Feature 'collection expression arguments' is not available. Please use language version 'preview'." | no |
|
||||
| Closed hierarchies, `closed` | taken | not parsed ("Cannot resolve symbol 'closed'") | no |
|
||||
| Unions, `union` | CA1815, from the SDK's own rules, on every union | not parsed ("Cannot resolve symbol 'union'") | no |
|
||||
| Labeled `break` / `continue` | taken; `dotnet format` moves the label one indent to the left | not parsed by 2026.2.3.1; "not available… language version 'preview'" in 2026.3.0 | no |
|
||||
|
||||
**CodeQL's reading of them is not established**: its documentation lists C# up to 14, and a pull request's C# analysis
|
||||
is an overlay that prints no per-file result (§`codeql.yml`). A full analysis of a branch is a `workflow_dispatch` of
|
||||
`codeql.yml` on it.
|
||||
|
||||
**What moves this:** a ReSharper engine that reads C# 15 as a released language, in the Qodana linter this repository
|
||||
runs; then the canary again, and a dispatched CodeQL run. `spike-notes` §29 lists where each construct would go.
|
||||
**What main does take from .NET 11:** its API — the `string` overloads that name the comparison of a `char` search, and
|
||||
`Process.TryGetProcessById`. The two preview features (runtime-async, the updated memory-safety rules) stay out, as D76
|
||||
kept them out of the alphas.
|
||||
|
||||
## Dependabot (`.github/dependabot.yml`) and the NuGet audit
|
||||
|
||||
```yaml
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: nuget
|
||||
- package-ecosystem: nuget # also .config/dotnet-tools.json (the SonarScanner, since 2026-10-25)
|
||||
directory: /
|
||||
schedule: { interval: weekly }
|
||||
cooldown: { default-days: 7 } # since 2026-10-25
|
||||
groups: { minor-and-patch: { update-types: [minor, patch] } }
|
||||
# ignore: WPF-UI*, FluentAssertions majors — the file says why
|
||||
- package-ecosystem: github-actions
|
||||
directory: /
|
||||
schedule: { interval: weekly }
|
||||
cooldown: { default-days: 7 } # since 2026-10-25
|
||||
groups: { actions-minor-and-patch: { update-types: [minor, patch] } }
|
||||
```
|
||||
|
||||
Central package management makes Dependabot PRs single-file diffs.
|
||||
|
||||
- **Cooldown (2026-10-25):** a version update waits seven days after its release is published, so a release that is
|
||||
pulled or found compromised in its first week never becomes a pull request here. Security updates do not wait — the
|
||||
option does not apply to them. The actions' minor and patch releases come as one pull request; a new major comes
|
||||
alone, because it is the one that changes inputs.
|
||||
- **No `dotnet-sdk` entry, on purpose:** `global.json` is a floor (11.0.100 since beta.37, D94; 10.0.100 before) with
|
||||
`rollForward: latestFeature`, so a developer's machine and the runner already build with the newest SDK of that band
|
||||
they have (the runner installed 10.0.402 on 2026-10-20, 10.0.404 on 2026-11-10). Raising the floor is a decision
|
||||
about what a contributor must install, not an update — the owner's, as D94 was.
|
||||
- **Dependabot has never proposed a NuGet library update here — measured 2026-10-25.** Every NuGet pull request it
|
||||
opened, #66 (2026-08-09) through #314 (2026-10-18), updated analyzers only (Meziantou, Roslynator, the VS threading
|
||||
analyzers), while Dapper 2.1.89 (published 2026-09-23), coverlet 10.1.0 (09-27), xunit.v3.mtp-off 4.0.2 (10-09) and
|
||||
the 10.0.13 servicing packages (10-13) were never proposed. Its update runs are GitHub Actions runs of their own (`gh
|
||||
run list`, event `dynamic`), and the run of 2026-10-18 (39134906593) logs the test projects' resolution failing —
|
||||
`Requested dependency resolution to include coverlet.collector/10.1.0 but it was instead resolved to 10.0.1`, `The
|
||||
package FluentAssertions.7.2.2 is not compatible. Incompatible project frameworks: net10.0-windows10.0.22621` — and
|
||||
opens nothing for them. The run of 2026-10-25 (40160307095), the first with the cooldown, says it of the shipped
|
||||
libraries too, the versions in use among them — `The package Dapper.2.1.86 is not compatible. Incompatible project
|
||||
frameworks: net10.0-windows10.0.22621`, and the same of Hosting, Sqlite, EventLog, Markdig and Velopack. Why its
|
||||
resolver reads a package that targets `netstandard2.0` as incompatible with this framework is **unmeasured**. So a
|
||||
quiet Dependabot is not evidence that the packages are current: `dotnet list FrameLedger.slnx package --outdated` is,
|
||||
and the updates it had missed were made by hand in beta.29 PR-2 (#335) — `coverlet.collector` 10.1.0 excepted,
|
||||
whose reason `Directory.Packages.props` gives beside it.
|
||||
- **beta.30 (2026-10-26), by hand under the same cooldown** (the owner: "check the dependencies and conflicts, update if
|
||||
needed"): Velopack and `vpk` 1.2.0 → 1.2.161 (the owner's decision, D71 — never 1.2.158, NuGet-deprecated), Markdig
|
||||
1.4.0 → 1.4.2 (parser fixes; its licence text unchanged at the packaged commit), and **the `SQLitePCLRaw` pin
|
||||
dropped**: `Microsoft.Data.Sqlite` 10.0.13 declares the patched 2.1.13, and the 3.0.5 pin had put it on SQLitePCLRaw's
|
||||
3.x line — a cross-major resolution NuGet does not report, because the declared range has no upper bound. The engine
|
||||
is now 2.1.13's, SQLite 3.53.3 (it was 3.53.4 under the pin; 2.1.14 carries 3.54.0 and comes with Microsoft's next
|
||||
servicing). Not taken: the 10.0.14 servicing packages (published 2026-10-25, the out-of-band Brotli fix — which is
|
||||
the RUNTIME's, shipped by the SDK the release builds with, not in a package referenced here), Markdig 1.5.0
|
||||
(2026-10-24), CsWin32 0.3.366 (it changes how SafeHandles are generated; 0.3.367, its fix, is from 2026-10-22), and,
|
||||
as before, `coverlet.collector` 10.1.0 and FluentAssertions 8. Catch2 3.16, NVAPI R615 (its licence file changed),
|
||||
the Vulkan and Streamline headers and clang-format (paired with Visual Studio's) were read and not needed.
|
||||
- **beta.31 (2026-10-26), the owner's request — inside the cooldown, on purpose** ("làm thêm bản beta 31 với các deps
|
||||
còn lại (.net 10.0.14) và 1 số thư viện khác"; owner decision D72): `Microsoft.Extensions.Hosting`,
|
||||
`Microsoft.Data.Sqlite` and `System.Diagnostics.EventLog` 10.0.14 (published the day before; `Microsoft.Data.Sqlite`
|
||||
10.0.14 still declares `SQLitePCLRaw` 2.1.13), Markdig 1.5.0 (its licence text again byte-identical at the packaged
|
||||
commit), CsWin32 0.3.367 (0.3.366 changed how SafeHandles are generated, 0.3.367 fixed its overflow; nothing here
|
||||
needed a change), Meziantou.Analyzer 3.0.317 (no new finding), Catch2 3.16.1 for the native tests (clean under
|
||||
`/W4 /WX`, the `/EHsc` fix kept), and `coverlet.collector` 10.1.0 — `NoSecondMatcherTests` now leaves out the
|
||||
`Coverlet.*` types the collector injects, whose constant reflection cannot read; they were never ours. Still not
|
||||
taken: FluentAssertions 8 (its licence), and the vendored native SDKs (NVAPI R615's licence file changed; the Vulkan
|
||||
and Streamline headers follow the measured loader and titles).
|
||||
- **The NuGet audit** (`Directory.Build.props`, written down 2026-10-25): `NuGetAudit` on, `NuGetAuditMode` `all`
|
||||
(transitive packages too), `NuGetAuditLevel` `low` — the SDK's defaults for net10.0 when they were written down,
|
||||
stated so that a later SDK's defaults cannot move them (and net11.0's did not). With `TreatWarningsAsErrors` a vulnerable package is NU1901–NU1904 and the restore, so
|
||||
the gate, is red — what `SQLitePCLRaw` 2.1.11 did (`Directory.Packages.props`). `dotnet list FrameLedger.slnx
|
||||
package --vulnerable --include-transitive` read none on 2026-10-25.
|
||||
- **The repository's own alerts:** Dependabot alerts and security updates are enabled, and so are secret scanning and
|
||||
its push protection (read from the API, 2026-10-25); no alert of either kind, and no code-scanning alert, was open.
|
||||
|
||||
## Branch & release policy
|
||||
|
||||
- `main` protected: CI + CodeQL required, linear history, no direct pushes.
|
||||
- Release: in ONE commit, bump `VERSION` and move the `[Unreleased]` entries of `CHANGELOG.md` under `## [X.Y.Z] - date` (Keep a Changelog format) → tag `vX.Y.Z` → `release.yml` does the rest (and refuses a tag that disagrees with either file) *(corrected 2026-10-04: for a pre-release tag `vX.Y.Z-beta.N`, do not bump `VERSION` — it already holds the numeric core the gate compares, and it read `0.1.0` through eleven betas; the section is `## [X.Y.Z-beta.N] - date`, the full version. Bump `VERSION` only when the numeric core moves)* → smoke-test the produced installer on a clean Win 10 VM + Win 11 (manual checklist in 14_TESTING §Release smoke).
|
||||
- Release: in ONE commit, bump `VERSION` and move the `[Unreleased]` entries of `CHANGELOG.md` under `## [X.Y.Z] - date` (Keep a Changelog format) *(since beta.24, D66: into their own file, `docs/changelog/X.Y.Z.md`, which opens with that heading, plus its row in `CHANGELOG.md`'s Releases table — `release-notes.ps1` reads the version's own file)* → tag `vX.Y.Z` → `release.yml` does the rest (and refuses a tag that disagrees with either file) *(corrected 2026-10-04: for a pre-release tag `vX.Y.Z-beta.N`, do not bump `VERSION` — it already holds the numeric core the gate compares, and it read `0.1.0` through eleven betas; the section is `## [X.Y.Z-beta.N] - date`, the full version. Bump `VERSION` only when the numeric core moves)* → smoke-test the produced installer on a clean Win 10 VM + Win 11 (manual checklist in 14_TESTING §Release smoke).
|
||||
- Pre-releases: `vX.Y.Z-beta.N` tags mark the GitHub release as pre-release; the App's `stable` channel ignores them and its `beta` channel (Settings ▸ Updates, `update.channel`) includes them — built with P4 PR-5, so ~~explicit beta channel is v2 backlog~~ is struck. The managed assemblies carry the full tag version; the native VERSIONINFO blocks carry the numeric core (`12_BUILD` §Version).
|
||||
- **Alphas (D73, 2026-10-31):** `vX.Y.Z-alpha.N`, tagged on the `alpha` branch only — `release.yml` refuses one anywhere
|
||||
else, and any other tag there — published as GitHub pre-releases on Velopack's `alpha` channel. §The alpha line above.
|
||||
|
||||
## Repo hygiene checklist
|
||||
|
||||
@@ -253,9 +733,11 @@ Central package management makes Dependabot PRs single-file diffs.
|
||||
|
||||
**In the tree — done:**
|
||||
|
||||
- [x] Repo-local `ci.yml`, `codeql.yml`, `release.yml`, `rules-publish.yml` (all four repo-local by decision, §Workflows); ~~caller stubs pointing at `poli0981/.github`~~ — never the design, see the first paragraph *(and `wiki.yml` since beta.17, repo-local too: five)*
|
||||
- [x] Issue forms `bug_report.yml`, `feature_request.yml`, `safety_gap.yml`; `ISSUE_TEMPLATE/config.yml` pointing a vulnerability at private reporting; PR template referencing CLAUDE.md's definition of done
|
||||
- [x] `.github/dependabot.yml` (nuget + github-actions, weekly)
|
||||
- [x] Repo-local `ci.yml`, `codeql.yml`, `release.yml`, `rules-publish.yml` (all four repo-local by decision, §Workflows); ~~caller stubs pointing at `poli0981/.github`~~ — never the design, see the first paragraph *(and `wiki.yml` since beta.17, repo-local too: five; and `qodana.yml` since 2026-11-10, D93: six)*
|
||||
- [x] Issue forms `bug_report.yml`, `feature_request.yml`, `safety_gap.yml`; `ISSUE_TEMPLATE/config.yml` pointing a vulnerability at private reporting; PR template referencing CLAUDE.md's definition of done *(and since 2026-11-09, beta.35, D88: `accessibility.yml`, the form `ACCESSIBILITY.md` sends a barrier to, and the PR template's user-interface section)*
|
||||
- [x] The labels the forms apply exist *(2026-11-09: `accessibility`, and `safety` and `priority-high`, which `safety_gap.yml` had named since it was written (2026-08-02) while the repository had neither — GitHub applies only a label that exists, so no Safety gap report was ever labelled)*
|
||||
- [x] `ACCESSIBILITY.md` — the accessibility statement: WCAG 2.2 AA through WCAG2ICT as a goal, never a claim; how a barrier is reported and handled (2026-11-09, D88)
|
||||
- [x] `.github/dependabot.yml` (nuget + github-actions, weekly; a seven-day cooldown and the actions grouped since 2026-10-25 — and a NuGet library update it never proposed is `dotnet list package --outdated`'s to find, §Dependabot and the NuGet audit)
|
||||
- [x] `SECURITY.md` — the private route for a vulnerability, the public route for a safety gap, and the honest response intent (2026-09-16)
|
||||
- [x] A release rehearsal: `release.yml` `workflow_dispatch` runs every step but the Release itself (§release.yml)
|
||||
|
||||
@@ -263,7 +745,7 @@ Central package management makes Dependabot PRs single-file diffs.
|
||||
|
||||
- [x] Branch protection as §Branch & release policy states *(marked 2026-10-04, read from the API: required checks `check`, `analyze (csharp, none)` and `analyze (cpp, manual)`; linear history; a pull request required; force pushes off; enforced for admins)*
|
||||
- [ ] `Rules / validate` as a required check (§S23-2, after its skip-shim)
|
||||
- [ ] Dependabot alerts + security updates (the manifest is in the tree; the alerts are a setting)
|
||||
- [x] Dependabot alerts + security updates (the manifest is in the tree; the alerts are a setting) *(marked 2026-10-25, read from the API: both enabled, with secret scanning and its push protection)*
|
||||
- [x] Private vulnerability reporting enabled (Settings ▸ Security), so `config.yml`'s link resolves *(marked 2026-10-04: GitHub reports it enabled)*
|
||||
- [ ] Wiki editing restricted to collaborators (Settings ▸ General ▸ Features ▸ Wikis ▸ *Restrict editing to collaborators only*): otherwise anyone with a GitHub account can change a page until the next release overwrites it (§wiki.yml, beta.17)
|
||||
- [ ] Repo topics: `windows`, `wpf`, `benchmark`, `fps`, `game-performance` (~~`presentmon`~~ — dropped 2026-08-27, §G)
|
||||
+21
-1
@@ -125,6 +125,21 @@ own work item on the STA thread and puts back — and with the keys a parameter,
|
||||
`AnotherHookHarnessRunningBesideTheSuiteDoesNotMakeTheTargetAmbiguous` runs a second harness beside the capture (red
|
||||
against the shared name: `TargetAmbiguous`). A suite that attaches by pid (`ShmDrainIntegrationTests`, the native
|
||||
`fl_guard_test`) is not exposed and keeps the staged name.
|
||||
- **Test readiness: an injection test waits for the harness to say it presents** (beta.27). The suites that start
|
||||
hook-harness and then inject into it or look for it — `ShmDrainIntegrationTests`, `CaptureHostEndToEndTests`,
|
||||
`AgentEndToEndTests`, `PartialRecoveryEndToEndTests` — slept 800 ms after starting it, a guess at when it presents.
|
||||
They now wait, bounded at 30 s, for the line the harness prints and flushes right before its present loop
|
||||
(`tests/Shared/HarnessReady.cs`, compiled in by `FrameLedger.DrainFixtures.targets`), and the pause case — which read
|
||||
the writer's status as INIT once under a full gate on 2026-10-19 — waits for the writer's READY
|
||||
(`WaitUntilInitFinishedAsync`) before it pauses.
|
||||
- **The guard reads the test host too** (beta.27). The guard's scan set is the target and its ancestors up to a platform
|
||||
launcher, so for an injection test it includes the test host that started the harness, `dotnet test` and the shell
|
||||
above them. Under a full gate the test host is still starting its other test classes, and a module it releases
|
||||
between the guard's list and the module's name refuses as `ModuleScanFailed` — measured 2026-10-20, once in the gate
|
||||
and once in twelve runs of `FrameLedger.Infrastructure.Tests` with coverage, never in a run of the class alone;
|
||||
`ProcessUnreadable` (2026-10-19, twice) is the same race met at the list. `ShmDrainIntegrationTests.InjectAsync` asks
|
||||
again, four times at most, on those two reasons only. The end-to-end suites inject through the Agent or the capture
|
||||
host, which records such a session as Tier 2; they have the same exposure and have not shown it.
|
||||
- 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)
|
||||
@@ -186,7 +201,7 @@ that it was checked against anything.
|
||||
|
||||
| Axis | Values |
|
||||
|---|---|
|
||||
| OS | Win 10 22H2 VM · Win 11 dev machine |
|
||||
| OS | Win 11 dev machine · a Win 10 22H2 VM where one exists — since beta.37 (D95) Windows 10 is not blocked and is neither tested nor supported, so a run there is information, not a gate |
|
||||
| GPU vendor | NVIDIA (primary) · AMD or Intel if available, else document as untested |
|
||||
| API | D3D11 · D3D12 · Vulkan (layer path) · OpenGL · **a 32-bit title, asserting it is correctly refused and recorded as Tier 2 with the reason** |
|
||||
| Upscaler | DLSS SR · DLSS-G · DLSS-RR · FSR2/3 · XeSS · none |
|
||||
@@ -194,9 +209,14 @@ that it was checked against anything.
|
||||
| Mode | launch mode · attach mode · mid-session settings change |
|
||||
| Safety | game with anti-cheat → toggle disabled · simulated late AC load → unhook · double-crash → auto-disable |
|
||||
| Tier | forced Tier 2 (records duration, available sensors and the reason — and nothing else) · Tier 1 → Tier 2 degradation notice |
|
||||
| Accessibility *(added 2026-11-09, beta.35, D88)* | **keyboard only** with the mouse disconnected — every page, menu and dialog, Ctrl+1…5, Esc · **Narrator** — names, values, headings, the notices as they appear · a **contrast theme** on and off (Aquatic, Desert) · Windows **animation effects** off · a large **display scale**. The owner's first pass: 2026-11-09, keyboard only and Narrator on 0.1.0-beta.34 and 0.1.0-alpha.3, no fault (`ACCESSIBILITY.md` §How it is checked; the automated half is `08_UI` §Accessibility) |
|
||||
| Update | Velopack delta; update deferred while a game is hooked (FR-12) — *a delta needs a previous release, so this row is reachable from the second release, not the first* *(corrected 2026-10-04: no release has carried a delta — `release.yml` never fetches the previous release before `vpk pack`, `11_UPDATER` §Built — so the update leg is a full package; **since beta.13** a release carries a delta against the previous one, and the first
|
||||
update that can use it is beta.12 → beta.13 — HANDOFF owner-only item 10)* |
|
||||
|
||||
## Release smoke
|
||||
|
||||
Clean-VM install → Legal Gate → Agent setup (unelevated) → add a game → consent dialog → hooked 2-min session → charts render → CSV opens in Excel → Vulkan layer registered/unregistered cleanly → uninstall removes layer registration, task, and asks about data.
|
||||
|
||||
*(Added 2026-11-09, beta.35, D88:)* and an **accessibility smoke**, the same build: the Legal Gate, the consent dialog and
|
||||
the session summary reached and answered with the keyboard alone; Narrator reads the notice a refused game raises; the
|
||||
window readable under one contrast theme. The release's owner-only item in `HANDOFF` lists what that release moved.
|
||||
+2
-2
@@ -328,7 +328,7 @@ WPF UI shell (`16_WPFUI_SYNTAX`), library, per-game hooking consent flow, Dashbo
|
||||
~~Static rules engine + `detection-rules.json` (engines, platforms, capabilities, **anticheat blocklist**) + validator + fixtures~~ **landed 2026-09-14 (P4 PR-1: the engine existed since P0; the Agent's `DetectionSweep` is its first caller, `ApplyDetectionAsync` its first writer — HANDOFF §P4)**; ~~store auto-import~~ **landed 2026-09-14 (P4 PR-4)**; ~~capability-vs-measured UI separation~~ **(PR-1: the Supports row reads the sweep's flags)**; ~~i18n en/vi/ja; Legal Gate;~~ ~~Velopack + updater (with the hooked-session deferral)~~ **landed 2026-09-14 (P4 PR-5 — the deferral is `UpdateService`'s shape, not a flag)**; ~~bug bundle incl. overlay logs~~ **landed (overlay logs since P3 PR-8a; 2026-09-15, P4 PR-9: the crash dialog, the minidump in both processes and the dump as the bundle's opt-in — `10_LOGGING` built notes)**; ~~tray + toasts; Settings;~~ ~~DB maintenance~~ **landed 2026-09-15 (P4 PR-7: the sweep is the Agent's over `SweepRetention`; integrity, backup and compaction in the App)**; ~~accessibility pass~~ **landed 2026-09-15 (P4 PR-8: `08_UI` §Accessibility written first — Ctrl+1…5, Esc on every dialog, an automation name on every textless input, theme colours only — each held by `AccessibilityTests`)**; ~~the scheduled task (`--install-task`)~~ (P3 PR-8b) and ~~the Velopack install hooks~~ **(PR-5: the uninstall hook; install registers nothing, by design — `12_BUILD` §The Vulkan layer is not registered at install time)**. *(The struck items moved to P3 on 2026-09-13 — see §P3.)*
|
||||
|
||||
## P5 — Ship (3–4 days)
|
||||
CI/CD with the native build (`release.yml` exists since P4 PR-5, 2026-09-14 — ~~untested by a tag yet~~ **ran on the first tag 2026-09-16** (`13_CI_CD` §release.yml: cancelled by a test hang once, green on the re-run); **rehearsable without one since 2026-09-16**, `13_CI_CD` §release.yml's dry run); CodeQL (C# + C++); Dependabot; CHANGELOG; README with the P0 accuracy comparison — **which is not a percentage, and this line used to send its author looking for one**. The decision is recorded under item 3 and in `spike-notes.md` §8: the baseline can answer **none** of item 4's four runtime questions, so the defensible claim is *"the baseline cannot answer four of these five questions at all"*, not *"N% more accurate"*. Overhead + tier cross-validation measurements; release smoke on clean VMs; ~~`v0.1.0-beta.1`~~ **tagged and published 2026-09-16** — eleven pre-releases through `0.1.0-beta.11` (2026-10-03), added 2026-10-04 — (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.
|
||||
CI/CD with the native build (`release.yml` exists since P4 PR-5, 2026-09-14 — ~~untested by a tag yet~~ **ran on the first tag 2026-09-16** (`13_CI_CD` §release.yml: cancelled by a test hang once, green on the re-run); **rehearsable without one since 2026-09-16**, `13_CI_CD` §release.yml's dry run); CodeQL (C# + C++); Dependabot; CHANGELOG; README with the P0 accuracy comparison — **which is not a percentage, and this line used to send its author looking for one**. The decision is recorded under item 3 and in `spike-notes.md` §8: the baseline can answer **none** of item 4's four runtime questions, so the defensible claim is *"the baseline cannot answer four of these five questions at all"*, not *"N% more accurate"*. Overhead + tier cross-validation measurements; release smoke on clean VMs; ~~`v0.1.0-beta.1`~~ **tagged and published 2026-09-16** — ~~eleven pre-releases through `0.1.0-beta.11` (2026-10-03), added 2026-10-04~~ a pre-release at each step since, listed in the CHANGELOG *(corrected 2026-10-14: the count went stale at the next release)* — (pre-release, unsigned, `SHA256SUMS.txt` beside the assets). What P5 still owes: the clean-VM smoke (`14_TESTING` §Release smoke — Win 10 22H2 is unmeasured), the overhead run (`spike-notes` §14.3), and the README's accuracy comparison sentence.
|
||||
|
||||
**Total ≈ 5.5–6.5 weeks full-time** — roughly 1.5–2 weeks more than the ETW design, which is the honest price of the accuracy.
|
||||
|
||||
@@ -344,7 +344,7 @@ CI/CD with the native build (`release.yml` exists since P4 PR-5, 2026-09-14 —
|
||||
- ~~PresentMon Service + API2 for a richer Tier 2~~ — **struck 2026-08-27**, and the shape hardened 2026-08-28: v1's ladder has two rungs and Tier 2 is not a measurement. What v2 may want is **a no-injection measurement at all** — which would restore two things at once: the FG oracle §S31 spent four attempts looking for, and `14_TESTING`'s Tier-1 accuracy cross-check, which is struck for the same reason (§G)
|
||||
- **YouTube overlay export**: frametime/FPS graph as transparent PNG sequence for DaVinci Resolve benchmark videos (SkullMute workflow)
|
||||
- CapFrameX-compatible CSV import/export
|
||||
- Microsoft Store / Game Pass titles (packaged-app injection constraints)
|
||||
- ~~Microsoft Store / Game Pass titles (packaged-app injection constraints)~~ *(struck 2026-11-03: GDK titles from the Xbox app and the Microsoft Store are imported, played and measured since beta.33, D77–D82, `spike-notes` §25; UWP apps stay out, refused with a reason of their own)*
|
||||
- AFK segmentation via `GetLastInputInfo`
|
||||
- GPU frame time via timestamp queries (needs care: injecting queries into the game's command lists is more invasive than anything in v1 — needs its own risk review)
|
||||
- ~~Beta update channel;~~ ARM64 *(struck 2026-10-04: the beta channel shipped with P4 PR-5 — `update.channel`, Settings ▸ Updates; `13_CI_CD` §Branch & release policy)*
|
||||
|
||||
+93
-2
@@ -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.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` | **= 4.3.0** (exact; bump deliberately) | Assembly/namespace is `Wpf.Ui`. Targets `net8.0-windows` → resolves cleanly for our `net11.0-windows10.0.22621.0` TFM — `net10.0-…` until beta.36 — (`12_BUILD` §Managed build; this row said `19041` until 2026-09-21, which is no TFM this repository ever built — `Directory.Build.props` has been `22621` with a 19045 floor throughout) |
|
||||
| `WPF-UI.Abstractions` | ~~transitive~~ **= 4.3.0**, referenced directly (corrected 2026-10-04) | Navigation abstractions (`INavigationViewPageProvider`) |
|
||||
| `WPF-UI.DependencyInjection` | match `WPF-UI` | DI glue (`services.AddNavigationViewPageProvider()`); verify exact id/version at scaffold |
|
||||
| `WPF-UI.Tray` | **not used** | Tray stays on H.NotifyIcon.Wpf (CLAUDE.md stack table) |
|
||||
@@ -62,6 +62,7 @@ private static readonly IHost _host = Host.CreateDefaultBuilder()
|
||||
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.
|
||||
- A Windows contrast theme (beta.35, D91): wins over all three while it is on, and is never left to the watcher, which would apply WPF UI's own high-contrast files (§Gotchas). `Services/ThemePlan.For` is the table, `Services/WpfThemeApplier` applies it.
|
||||
- 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).
|
||||
|
||||
@@ -115,6 +116,14 @@ Code-behind wires services once: `navigationService.SetNavigationControl(RootNav
|
||||
- Navigate **only** via `INavigationService.Navigate(typeof(SomePage))` — never manipulate `Frame` directly, never `new` a Page.
|
||||
- Pages implement `INavigableView<TViewModel>` with `ViewModel` injected via constructor DI; `DataContext = this` in the page constructor (WPF UI template idiom) so bindings read `ViewModel.*`.
|
||||
- Page state: pages are Transient; anything that must survive navigation lives in the ViewModel-backing services/DB, not the Page.
|
||||
**Except the library, since beta.34** (owner request 2026-11-06, "Games stalls 0.5–1.5 s"; `spike-notes` §27): the window
|
||||
keeps the `GamesPage` it built — `Services.WindowPageCache`, the window's own `INavigationViewPageProvider`, set after
|
||||
`INavigationService.SetNavigationControl` (which hands the NavigationView the container's provider) — and its view model
|
||||
reads the library again each time the page is shown (`GamesViewModel.Attach`). Still Transient in the container; one
|
||||
instance per window, so a language change's new window builds its own in the new language. **Not**
|
||||
`NavigationViewItem.NavigationCacheMode`: WPF UI 4.3.0 reads it only when the NavigationView has neither a service
|
||||
provider nor a page provider (`NavigationView.Navigation.cs`, `GetNavigationItemInstance`), and this App sets one — the
|
||||
attribute would have changed nothing.
|
||||
|
||||
## Control mapping (always prefer these)
|
||||
|
||||
@@ -160,6 +169,26 @@ Native `Menu`, `TabControl`, `ComboBox`, `Slider`~~, `ListView`~~ are fine — t
|
||||
tertiary 3:1). It follows a theme switch through a **resource reference on the band** (`SetResourceReference` on a
|
||||
private attached property bound to `ApplicationBackgroundColor`), not through `ApplicationThemeManager.Changed`, which
|
||||
only `ApplicationThemeManager.Apply` raises — a page made and switched in the tests' harness would never hear it.
|
||||
- The change markers (beta.30, D70) take the palette's `Chart_StutterPso` under `ChartTheme.TextOn` — black or white by
|
||||
WCAG contrast, black in both themes. The chart reads `ChartTheme.Current` at every render; the WPF chip in the list
|
||||
(`Controls/ChangeBadge`) follows a switch through the same resource reference as `ArtTint` and `FgMixBar`
|
||||
(`ChartPalette.ForBackground`). No colour in XAML.
|
||||
- Third exception (beta.35, D91): **a Windows contrast theme's colours**, read from `SystemColors` in one place
|
||||
(`Services/ContrastPalette.FromSystem`) and laid over the theme by `Services/ContrastOverlay` — never written in XAML. A
|
||||
colour the App works out itself reads `Services.ContrastTheme.Active` first (the charts, the badges, the artwork band);
|
||||
XAML that must change with it binds `{Binding Path=(services:ContrastTheme.IsOn)}`, a static property WPF hears through
|
||||
its `StaticPropertyChanged` event.
|
||||
- **`ui:Button Appearance="Danger"` / `Info` / `Success` / `Caution` / `Dark` / `Light` paint fixed colours** — values in
|
||||
WPF UI 4.3.0's button style (`#F44336` for Danger), not resources, so no theme and no contrast theme reaches them, under
|
||||
the theme's button text (white on the red in the dark theme, 3.68:1). Danger is the one the App uses: its implicit
|
||||
`ui:Button` style (`Styles/FrameLedger.xaml`) puts the theme's dark text on the red, and the theme's own button under a
|
||||
contrast theme — message boxes' buttons included. The other five are refused
|
||||
(`ContrastThemeTests.NoButtonOrBadgeTakesAnAppearanceThatPaintsAFixedColour`).
|
||||
- **A snackbar's appearances are fixed colours too** (`ISnackbarService.Show`): Success, Caution, Info, Danger, Primary,
|
||||
Dark and Light are values under white or black text — Success 2.78:1, Caution 2.16:1 in both themes. Only Secondary is
|
||||
the theme's: `Services/SnackbarStrip`, the one place a snackbar is shown, uses it for every message.
|
||||
- **A `ui:Badge` with a BOUND palette appearance** is the same hole as a literal one, and no XAML scan of literals sees it
|
||||
(the agent's pill, beta.35: `AgentPill` now). A bound badge appearance is refused by the same test.
|
||||
|
||||
## FlowDocument (rendered documents, beta.12)
|
||||
|
||||
@@ -182,6 +211,9 @@ Native `Menu`, `TabControl`, `ComboBox`, `Slider`~~, `ListView`~~ are fine — t
|
||||
- `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.
|
||||
- `ChangeBadge` (beta.30): a `Control` with one `Text` property, not focusable (the row's text carries the meaning), its
|
||||
template a `Border` and a `TextBlock` bound to `Background`/`Foreground`, which the control sets in code from the chart
|
||||
palette (`Styles/FrameLedger.xaml` writes no colour).
|
||||
|
||||
## Dialogs & notifications
|
||||
|
||||
@@ -200,7 +232,12 @@ 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)~~ *(corrected 2026-10-04: nothing bans it. Three paths use the Win32 box on purpose — the crash dialog, the startup-failure dialog and the uninstall question — because they run when the shell's dialog host cannot be trusted. Use the WPF UI one everywhere else.)*
|
||||
- Rich in-flow dialogs: `IContentDialogService` (host wired in MainWindow — a `ui:ContentDialogHost`, since 4.3.0 marks `SetDialogHost(ContentPresenter)` obsolete).
|
||||
- Transient in-app: `ISnackbarService.Show(title, message, ControlAppearance.Success, new SymbolIcon(SymbolRegular.Checkmark24), TimeSpan.FromSeconds(4))`.
|
||||
- Transient in-app: ~~`ISnackbarService.Show(title, message, ControlAppearance.Success, new SymbolIcon(SymbolRegular.Checkmark24), TimeSpan.FromSeconds(4))`~~
|
||||
`IMessageStrip` (`Info` / `Success` / `Warn`) — `Services/SnackbarStrip` is the one caller of `ISnackbarService.Show`, and
|
||||
says each message to a screen reader (beta.35, D89). A view model never holds `ISnackbarService`.
|
||||
- A change a screen reader must hear goes through `IAnnouncer` (`Services/UiaAnnouncer`, UI Automation's notification
|
||||
event). **`AutomationProperties.LiveSetting` alone says nothing in WPF**: the app must raise `LiveRegionChanged` itself,
|
||||
and no XAML of the App's sets one (beta.35).
|
||||
- System/tray notifications: H.NotifyIcon only (08_UI §Notifications policy).
|
||||
|
||||
## ScottPlot theme sync
|
||||
@@ -216,10 +253,43 @@ On startup and on `ApplicationThemeManager.Changed`: for every live plot set fig
|
||||
> 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.
|
||||
>
|
||||
> **Accessible charts, beta.35 (D90).** Every plot in XAML is `charts:ChartPlot` (a `WpfPlot` subclass; ScottPlot's
|
||||
> default style and input stay) with `AutomationProperties.Name` and `HelpText` from `A11y_Chart_*` / `A11y_ChartData_*`.
|
||||
> `ChartTheme.Attach` adds `Charts/ChartKeys` (arrows and A marked handled after ScottPlot's class handler has acted — an
|
||||
> instance handler runs after it) and `ResetOnDoubleClick` (`DoubleLeftClickBenchmark(false)` and a `DoubleClickResponse` on
|
||||
> the left button that autoscales). A series takes `ChartPatterns.Line` / `Points` / `Hatch` by its index — a new series
|
||||
> without one is red in `NoChartTellsTwoSeriesApartByColourAlone`. Under a Windows contrast theme `ChartTheme.Current` is
|
||||
> `ChartPalette.ForContrast(ContrastTheme.Active)` — the theme's window under every plot, its text, link, highlight,
|
||||
> button text and disabled text for the rest — and the patterns carry the series apart (D91).
|
||||
>
|
||||
> **The trend's change markers, beta.30 (D70):** `Charts/ChangeMarkerPlottable`, an `IPlottable` + `IRenderLast` added
|
||||
> with `Add.Plottable` (which assigns no axes: the chart sets `Axes.XAxis`/`YAxis` itself), draws the dashed lines in
|
||||
> `Render` — clipped to the data area — and the numbered badges in `RenderLast`, after the panels and unclipped, in a
|
||||
> band kept with `plot.Axes.Top.MinimumSize` (the top axis is unused and measures 15 px; `MinimumSize` clamps it up, and
|
||||
> `Clear` keeps it, so `Show` sets it every time — 0 with no marker). `LabelStyle.Measure` sizes a badge with a
|
||||
> `Paint.NewDisposablePaint()`; `Charts/ChangeBadgeLayout` places them. `GetAxisLimits` returns
|
||||
> `AxisLimits.HorizontalOnly`, so the markers count toward the date axis's autoscale as `VerticalLine`s did.
|
||||
|
||||
## Gotchas checklist
|
||||
|
||||
- [ ] Dictionaries order: `ThemesDictionary` → `ControlsDictionary` → app styles. Wrong order = default-looking controls.
|
||||
- [ ] **A ScottPlot `VerticalLine` label grows into a panel nothing sizes for it (5.1.59).** With `LabelOppositeAxis` it is
|
||||
anchored 5 px above the data area, its box (text + 5 px padding each side) growing up into the top-axis panel, which
|
||||
an unused axis measures at 15 px; clipping is off, so the control's edge cut it — the owner's "Driver GPU: … → …",
|
||||
beta.30. `LabelAlignment` is overwritten each frame (only `ManualLabelAlignment` holds), and
|
||||
`LabelStyle.LastRenderPixelRect` includes the 3 px default `ShadowOffset` even with no shadow. The trend draws its
|
||||
own badges now (§ScottPlot theme sync).
|
||||
- [ ] **`WpfPlot.DisplayScale` is read once, in the constructor**, from `VisualTreeHelper.GetDpi` before the control has
|
||||
a window. Read a pointer with `GetPlotPixelPosition(e)` (the element's DPI now); ScottPlot's pixels are device
|
||||
pixels while no `Plot.ScaleFactor` is set, and none is.
|
||||
- [ ] **WPF UI 4.3.0's high-contrast theme cannot be applied as it is** (beta.35, D91). `ApplicationTheme.HighContrast` has
|
||||
no dictionary (the watcher picks HC1/HC2/HCBlack/HCWhite by Windows' theme name); each of those holds 84 `#FFFF0000`
|
||||
placeholders among 97 colours and 17 brushes (`SystemFillColor*Brush`, `MenuBar*`) that throw when the file is read
|
||||
alone — inside the App their forward references fall back to the application's resources and read as the Fluent
|
||||
theme's fills; their colours are Windows 11's defaults, not the user's; their text on the accent is the window text.
|
||||
Never let `SystemThemeWatcher` watch while a contrast theme is on: it would apply them. The App reads them for each
|
||||
key's role only (§Theming & brushes; `08_UI` §Contrast).
|
||||
- [ ] `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.
|
||||
@@ -234,6 +304,21 @@ On startup and on `ApplicationThemeManager.Changed`: for every live plot set fig
|
||||
bar with no exit, which is exactly how the safety notices shipped (2026-09-14). `Styles/FrameLedger.xaml` carries
|
||||
the upstream template plus one presenter column; `PagesLoadTests.TheInfoBarTemplateRendersItsContent` renders both
|
||||
templates and turns red when upstream gains a presenter, which is when the copy comes out.
|
||||
- [ ] **What a screen reader is given is the UI Automation tree, and WPF builds it with four holes** (beta.35, D88;
|
||||
`PagesLoadTests.Automation` sweeps every surface for each). (1) **A control with no automation peer** — a plain `Control`
|
||||
or `ContentControl`, WPF UI's `Image`, `Card`, `Badge`, `InfoBar` (measured on .NET 10.0.14) — is skipped by the tree; if
|
||||
it is also focusable (a `Control` is, by default) it is a Tab stop Narrator says nothing about. Give a display-only
|
||||
control a peer (`Controls/SpokenTextAutomationPeer`) and take it out of the tab order; `ui:CardControl` has a peer with an
|
||||
empty name even with a string `Header` — the App's implicit style takes it out of the tab order. (2) **A list's,
|
||||
drop-down's or grid row's item is named by its `ToString()`**: a record's is its printed form (`Choice { Value = dark,
|
||||
Label = Dark }`), a class's its full type name. Every item type overrides it (`Services/SpokenText` builds the words).
|
||||
(3) **A `TextBlock` written straight into a `ControlTemplate` is no control element** (`TextBlockAutomationPeer`: not when
|
||||
its templated parent is something other than a `ContentPresenter`): draw a template's text through a `ContentPresenter`
|
||||
(the App's InfoBar template), or give the control a peer that says it. (4) **A `DataGridTemplateColumn`'s cell has no text
|
||||
of its own**, so WPF names it `Item: <row>, Column Display Index: n`: name it with `controls:CellName.Path` (a cell style
|
||||
based on `DefaultDataGridCellStyle`, the one WPF UI's grid gives every cell). Also: a plain `ItemsControl` is focusable
|
||||
(the App's implicit style says no), and WPF UI's `CardExpander` leaves its expand button (`ExpanderToggleButton`)
|
||||
unnamed (`Controls/ExpanderToggleName`, set by the App's implicit CardExpander style).
|
||||
- [ ] **WPF UI 4.3.0 keys its DataGrid parts' styles and defines no implicit one** (`DefaultDataGridRowStyle`,
|
||||
`DefaultDataGridCellStyle`, `DefaultDataGridColumnHeaderStyle`, handed to the grid by its implicit `DataGrid` style's
|
||||
`RowStyle`/`CellStyle`/`ColumnHeaderStyle` setters). A local `RowStyle` replaces WPF UI's; based on
|
||||
@@ -298,6 +383,12 @@ On startup and on `ApplicationThemeManager.Changed`: for every live plot set fig
|
||||
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).
|
||||
*(Corrected 2026-10-26, beta.30: the CODE handles no key, but `ContentDialog.xaml` does route them — each template
|
||||
button's `IsDefault` follows `DefaultButton`, Close is `IsCancel`, and while the primary is disabled a trigger makes
|
||||
Close the default. Enter therefore clicks the default button from a single-line text box: the consent dialog's
|
||||
`DefaultButton = Close` declined a typed phrase on Enter (the owner's report; D69 made the primary the default and the
|
||||
content keeps Enter until the phrase matches). Esc through `IsCancel` is read from the template, not measured —
|
||||
`DialogKeyboard` handles it first.)*
|
||||
- [ ] **`ui:TextBlock Appearance` keeps the theme a text was made under (4.3.0).** `TextBlock.OnAppearanceChanged` stores
|
||||
`TryFindResource(…)` in the internal `AppearanceForeground`, and `TextBlockMetadata` coerces every TextBlock's `Foreground`
|
||||
to it — the brush found when the element was made, never looked up again (read at tag 4.3.0, 2026-10-07; `main` is the
|
||||
|
||||
+20
-6
@@ -123,7 +123,8 @@ Every hook must be listed here with a purpose. Anything not on this list is not
|
||||
> calls — and the FidelityFX row below is the ninth ✅.~~** *(Corrected 2026-10-04: as of 2026-09-06 it installs up
|
||||
> to SIXTEEN — the nine `FL_HOOK_INVENTORY` rows (four Streamline including `slSetTagForFrame`, four `ffxDispatch`,
|
||||
> `ffxFsr3ContextDispatchUpscale`), the three DXGI slots, the two `ID3D12GraphicsCommandList4` methods,
|
||||
> `wglSwapBuffers` and `LoadLibraryExW`; four hooks landed without this banner moving.)* The counts differed until 2026-09-03, because a
|
||||
> `wglSwapBuffers` and `LoadLibraryExW`; four hooks landed without this banner moving.)* *(And since beta.25,
|
||||
> 2026-10-19: up to TWENTY — four `ffxQuery` rows join them, on the same four AMD modules, D65.)* The counts differed until 2026-09-03, because a
|
||||
> row is a *capability* and a detour is a *patch*, and the FG-count row rode on the
|
||||
> evaluate detour; it has its own now, `sl.interposer.dll!slGetNewFrameToken`. The AMD row
|
||||
> is the opposite shape — **one row-family, four modules, four patches from one
|
||||
@@ -193,10 +194,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: `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`; since beta.34 `kFeatureDLSS_NR` — DLSS 5's neural rendering, its own fact bit and family `FL_HOOK_SL_NEURAL_RENDERING`, D84; rule 4: the `feature` argument of the API hooked, nothing else). **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` — **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 |
|
||||
| ✅ **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 — *since beta.25 the quality byte is the mode the `ffxQuery` row below names for the dispatched size, `0xFF` when none does*) + 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 |
|
||||
| ✅ **FidelityFX ffx-api: `ffxQuery` on the same four modules** (beta.25, owner decision D65) — `amd_fidelityfx_dx12.dll`, `amd_fidelityfx_upscaler_dx12.dll`, `amd_fidelityfx_framegeneration_dx12.dll`, `amd_fidelityfx_loader_dx12.dll` | **Built 2026-10-19.** The mode an FSR title runs at reaches the vendor only as an argument of `ffxQuery` — "what render size (`…GETRENDERRESOLUTIONFROMQUALITYMODE`, `0x00010003`) or ratio (`…GETUPSCALERATIOFROMQUALITYMODE`, `0x00010002`) does this mode give at this display size?" — asked before the title sizes its targets; the per-frame dispatch carries the size alone. The detour calls the original FIRST, exactly once, and only when it returned `FFX_API_RETURN_OK` reads the descriptor's type, display size and mode and the values the vendor wrote through the title's own out pointers, into a five-slot table (one per `FfxApiUpscaleQualityMode`); the `ffxDispatch` UPSCALE arm names the ONE mode whose kept answer fits the dispatched `renderSize` (and `upscaleSize`, where stated) as `0x10 + mode` in `upscalerQuality`, else `0xFF` (`03_METRICS` §Upscaling). **Rule 4:** the arguments of the API we hooked — the descriptor the title passed and the out values of that same call — never `context`, a resource or anything the title did not hand the hooked export; nothing of the title's is written, and every read is under the hook's SEH guard. Both query layouts and type ids are pinned to literals by `static_assert`s, identical at SDK v1.1.4 and v2.3.0. **Its own family**, `FL_HOOK_UPSCALER_QUALITY` (bit 11 of `hooksInstalledMask`, mirrored in `FlHookFamily` and `HookFamilies`): `InstallByFamily` binds a row by equality, and the query entitles no measured field by itself — the byte rides under `FL_MEASURED_UPSCALER_PARAMS` from the dispatch arm — so the bit says only that the query was hooked, which tells "never asked" from "could not have seen it ask". Published like the dispatch family, once every loaded leaf is patched (`PublishFfxQueryFamilyIfWhole`); the FSR 3.0 host has no `ffxQuery` and no row (`static_assert`). A loader that passes a query on to a leaf's export refreshes one kept answer twice; nothing is counted, so nothing is counted twice. **Measured overhead** (a copy of the two bodies, `/O2 /guard:cf /Qspectre /MT`, 20 M calls × 3 runs, every slot holding both a size and a ratio — the worst case): 7.6–8.2 ns added per UPSCALE dispatch, i.e. per application frame, and 1.6 ns per query beside the trampoline; the per-present path gains one load. Harness: `--ffx-query sizes|ratios`; `fl_guard` "FSR's quality mode". |
|
||||
| ~~XeSS: `xessD3D12CreateContext`, `xessD3D12Init`, `xessD3D12Execute`~~ **Closed at the census by licence, 2026-09-04** (`20_OPEN_QUESTIONS` §Scope decisions, `18_GPU_VENDOR_APIS` §Intel XeSS SDK): no hook on any `libxess*.dll` export *(corrected 2026-10-04)* | ~~`outputResolution`, `qualitySetting`, XeSS version; `xess_fg` variants for XeFG~~ |
|
||||
| ✅ **Application frames per present** (`fgEvaluations`) — **`sl.interposer.dll!slGetNewFrameToken` since 2026-09-03** | Native vs Displayed frame counts at Tier 1 — see `03_METRICS` §Frame Generation. **The producer is the frame-token export**: Streamline hands a title one token per application frame and the title must ask; the detour counts distinct tokens between two presents (pointer changes, nothing dereferenced), `FL_HOOK_FG_EVALUATIONS` is its family, and it installs on every Streamline 2 title including the ones that evaluate nothing through `slEvaluateFeature`. Rule 4: the out-parameter of an API we hooked. Premise and its gate in `03_METRICS`; pre-committed table in `20_OPEN_QUESTIONS` §S31. *The row as it stood before:* ~~NGX/SL/FFX/XeSS FG feature evaluations per present. **Built 2026-08-15 for Streamline, and MEASURED TO YIELD NOTHING ON THAT ROUTE**~~ — `slEvaluateFeature(kFeatureDLSS_G)` is never called by Cyberpunk 2077 (0 across ~14,000 batches, four FG settings), so this row installs, is honest, and counts zero; see `docs/HANDOFF.md` item 3. Built on the detour that was already there: `kFeatureDLSS_G` contributes to a saturating COUNT in the same word the feature bits live in (`fl_sl_seen.h`) rather than to a bit, because a bit collapses several evaluations between two presents into one — and under multi-frame generation that is the common case, not the edge. The row's family is therefore compound (`FL_HOOK_UPSCALER_IDENTITY \| FL_HOOK_FG_EVALUATIONS`), pinned by a `static_assert` because `hookinventory-check` reads that column as an opaque identifier. **Counts EVALUATIONS, not generated frames** — the 2026-08-14 owner ruling; the multiplier lives in `sl::DLSSGOptions`, which is only reachable by the route §2b refused. ~~Non-NVIDIA FG vendors are **deferred with a written rationale**: `amd_fidelityfx_framegeneration_dx12.dll` 3.1.5 exports only the five generic `ffx*` entry points, identical to five sibling modules, so identity is in the arguments and we have no headers~~ — **AMD has a producer since 2026-09-04** (the FidelityFX row above: the PREPARE dispatch's `frameID`, or the UPSCALE count on a title that never prepares, feeds `fgEvaluations` when Streamline has never issued a token); Intel stays at the census (`20_OPEN_QUESTIONS` §Scope decisions, by licence); the FSR 3.0 host DLL's UPSCALE (`ffxFsr3ContextDispatchUpscale`, since 2026-09-05) counts like an ffx-api UPSCALE when neither Streamline nor a PREPARE has spoken |
|
||||
|
||||
@@ -479,7 +481,7 @@ struct alignas(64) FlFrameRecord { // 64 bytes exactly, static_assert'd
|
||||
uint16_t outputW, outputH; // @22
|
||||
uint8_t api; // @26 d3d11|d3d12|vulkan|opengl
|
||||
uint8_t upscaler; // @27 0 = NOT_REPORTED; dlss|fsr2..4|xess|nis|none(8)|unknown(0xFF)
|
||||
uint8_t upscalerQuality; // @28 vendor enum; 0xFF = a hook ran and could not tell
|
||||
uint8_t upscalerQuality; // @28 vendor enum (FSR: 0x10 + mode, beta.25); 0xFF = a hook ran and could not tell
|
||||
uint8_t fgMode; // @29 0 = NOT_REPORTED; dlss_g|fsr_fg|xefg|none(4)|unknown(0xFF)
|
||||
uint8_t rtFlags; // @30 bit0 asBuildOBSERVED, bit1 dispatchOBSERVED, bit2 psoCreatedEver
|
||||
uint8_t colorSpace; // @31 0 = NOT_REPORTED, 1 SDR, 2 HDR10, 3 scRGB
|
||||
@@ -705,11 +707,23 @@ No logging in hook bodies. A small fixed-size in-memory ring of structured event
|
||||
> `__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
|
||||
> `SUPERVISION_LOST`, and since beta.24 `STOP_FLUSHED` (the last line after a stop: `a=1` when the stop had finished
|
||||
> writing). **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`,
|
||||
> flush are counted in a `#` line.
|
||||
>
|
||||
> **The stop and the last flush, beta.24 (`fl_guard`'s native-log case, red under load since beta.9).** A stop sets
|
||||
> `g_observing` to 0 first and writes its `STOP` / `UNHOOK_*` lines after, and the watchdog's loop returns the moment
|
||||
> it reads 0. When the stop ran on a presenting thread — `MayObserve`'s one-frame safety stop — the watchdog's one
|
||||
> final flush could run while that thread was still writing, and the lines after it (the kernelbase loader detour is
|
||||
> the last patch) reached the ring after the last flush ever made. The stop now says when its last line is in, and
|
||||
> wakes the watchdog; the final flush waits for that, bounded at 2 s, then writes `STOP_FLUSHED`. And each slot has a
|
||||
> commit word written after its fields: `LogNote` claims a slot with one `fetch_add` and fills it afterwards, so a
|
||||
> flush on another thread could print a slot still being filled. A flush now prints only slots whose writer has
|
||||
> finished — an ordinary flush stops at the first that is not, for the next one; the final flush names it in a `#`
|
||||
> line. Nothing on a present path changed. 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
|
||||
|
||||
@@ -237,7 +237,7 @@ Still resolve **entry points defensively at runtime**: `nvapi64.dll` may be abse
|
||||
| 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) |
|
||||
| **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) — and, since beta.24 (D63), the mode an NVIDIA App override set where the word says it applied; its `performanceMode` is in NGX's own numbering (Silent Hill 2, 2026-10-13: the App's Ultra Performance, profile value 5, reported as 3). *(Beta.27: never read after the game has gone — that reading, the last, had cleared `CREATED \| EVALUATE` on every stored session — and the two bits stand once a reading carried them: `03_METRICS` §The driver-reported rung.)* |
|
||||
| **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.
|
||||
|
||||
@@ -387,6 +387,20 @@ Implemented in `FrameLedger.Injector` and reached from managed code through a th
|
||||
> appeal. A nested executable outside a recognised store layout is therefore
|
||||
> still scanned narrowly; that residual is stated, not closed.
|
||||
>
|
||||
> **Amended 2026-11-03 (beta.33, `spike-notes` §25): a GDK package root is a boundary too, and `GamesInstalled`
|
||||
> is one natively.** The Xbox app and the Microsoft Store install to `<games folder>\<Game>\Content\` under a
|
||||
> folder the user names, which no string can bound — so for the executable the import picks there (an Unreal
|
||||
> title's `Content\<Project>\Binaries\WinGDK\…-Shipping.exe`), check 4 walked `Binaries\WinGDK` alone, and an
|
||||
> `EasyAntiCheat\` at `Content`'s root would have read clean: the residual above, on a whole store. The package
|
||||
> marks its own root — `MicrosoftGame.config` beside `appxmanifest.xml`, both files — so **only when no string
|
||||
> boundary matched**, the nearest folder at or above the executable's that holds both is the root (at most eight
|
||||
> levels up, never a drive's root; `ResolveInstallRoot` and the managed `InstallRoot`). Not a blind walk up: a
|
||||
> marker the package writes, measured as exactly one per package at `Content`'s root on the owner's 11 titles; and
|
||||
> only ever a widening relative to the executable's folder — a Steam build carrying GDK files keeps its Steam root.
|
||||
> The native list also gains `GamesInstalled\<X>`, which the managed one had since #17 and the native one never
|
||||
> did; one case list (`tests/fixtures/install-roots/cases.txt`), read by both suites, holds the two resolvers
|
||||
> together from now on.
|
||||
>
|
||||
> **Amended 2026-10-13: the root AND the executable's folder.** The root replaced the executable's folder, and
|
||||
> that was half the answer. The walk reaches three levels below where it starts, and an Unreal executable is
|
||||
> already three below its root, so a folder **beside** the executable is four: MEASURED on Wuthering Waves, whose
|
||||
@@ -461,6 +475,41 @@ the injection primitive, not a fifth question about the title.
|
||||
|
||||
> **There is no override.** ~~There is one, since 2026-09-21, and it is none of the things this paragraph named~~ *(one day; withdrawn 2026-09-22)*: still no hidden setting, no config-file flag, no CLI switch, no "advanced users" escape hatch, no global form. If a user disagrees with a specific entry, the path is still a GitHub issue against the rules file, reviewed in public. What exists is below — and since 2026-09-26 (D33), one narrow, evidence-bound exception for anti-cheat that is user-mode throughout, which lets a named family through while every check still runs (§The user-mode exception).
|
||||
|
||||
### The target must be able to take the Overlay — beta.33 (D78)
|
||||
|
||||
The last question before the primitive, after checks 1–4 and the payload's identity passed: **can this process take the
|
||||
Overlay at all?** The guard reads it from the target itself (`Sources::TargetIsolationFacts`, one
|
||||
`PROCESS_QUERY_LIMITED_INFORMATION` handle — measured 2026-11-03 to answer both questions, `GetProcessMitigationPolicy`
|
||||
needing no more):
|
||||
|
||||
| Read | Refusal | Why it cannot work |
|
||||
|---|---|---|
|
||||
| `TokenIsAppContainer` | `kTargetAppContainer` | a Microsoft Store app of the UWP kind: the Overlay's shared memory, its `Local\` names and the rules file live in the user's session namespace and profile, which an AppContainer cannot open. D78: GDK games are in, UWP apps are out |
|
||||
| `ProcessSignaturePolicy`: `MicrosoftSignedOnly` or `StoreSignedOnly` | `kTargetMitigation` | the Overlay is neither (CLAUDE.md rule 9: unsigned): the remote `LoadLibraryW` fails |
|
||||
| `ProcessDynamicCodePolicy`: `ProhibitDynamicCode` | `kTargetMitigation` | MinHook's trampolines are dynamic code: the Overlay would load and hook nothing |
|
||||
| `ProcessUserShadowStackPolicy`: strict mode, or `BlockNonCetBinaries` / `BlockNonCetBinariesNonEhcont` | `kTargetMitigation` | the Overlay is not marked CET-compatible: refused at load, or a violation ends the game |
|
||||
| `ProcessControlFlowGuardPolicy`: `StrictMode` | `kTargetMitigation` | `native/CMakeLists.txt` H1: measured safe with strict mode off only; a host in strict mode could still `__fastfail` on the trampolines, which no fault policy can catch (rule 5) |
|
||||
|
||||
**The policy is the signal**, and only the enforcing flags count: an `Audit*` flag refuses nothing, and
|
||||
`SetContextIpValidation` without strict mode is what every CET-compatible process carries (measured: `pwsh.exe`
|
||||
`0x105`). A policy the running Windows does not know answers `ERROR_INVALID_PARAMETER` (measured) and cannot be in
|
||||
effect. **"Could not tell" refuses** — a seam that fails, or none wired — as `kProcessUnreadable`, the module check's word
|
||||
for a process it could not read. ctest `fl_guard` `[isolation]` holds each refusal through fakes, and two of them against
|
||||
Windows itself: a child started under "no dynamic code" and "Microsoft-signed images only".
|
||||
|
||||
**Neither is a finding.** Nothing is written to the game's row and no family is named; the session is Tier 2 with the
|
||||
reason, as for a 32-bit game. **No game that measured before is refused now**: each of these ended as a failed injection,
|
||||
an Overlay that installed no hooks, or a risk of ending the game. It is asked once, before the injection — never by the 30 s
|
||||
re-scan, which runs inside a process the Overlay is already in — and, like the payload check, it is not numbered as a
|
||||
check: it is a precondition of the primitive, not a question about the title.
|
||||
|
||||
**A GDK game's tree, measured (`spike-notes` §25, six titles activated through their packages):** the chain is
|
||||
`GameLaunchHelper.exe` → `gamingservicesui.exe` → `XboxPcTray.exe` → the launch executable (→ an Unreal title's shipping
|
||||
executable), `GameLaunchHelper` exits first, and its parent is the activator — the user's shell when **Play** starts it,
|
||||
which is where the scan set already stops. Every member opened with the guard's rights as a standard user, none is an
|
||||
AppContainer, none runs under any of the policies above, and no member's module matched a fuzzy fragment or a blocklist
|
||||
name. So the scan set needs nothing new for these titles; an Xbox title that ships anti-cheat is unmeasured
|
||||
(`20_OPEN_QUESTIONS` §G).
|
||||
### What a finding does to the game — owner decision 2026-09-22
|
||||
|
||||
**The per-game override of 2026-09-21 is withdrawn.** It shipped in `0.1.0-beta.3` and `beta.4`. Its first real use
|
||||
@@ -1036,7 +1085,8 @@ Consent is stored per game (`games.hook_consent_at`), **stamped by the Agent, ne
|
||||
> 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
|
||||
> primary button is disabled until the phrase is typed exactly~~, and Enter never enables~~ *(Enter enables once the
|
||||
> phrase matches since beta.30, owner decision D69 — below)*. `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
|
||||
@@ -1048,6 +1098,18 @@ Consent is stored per game (`games.hook_consent_at`), **stamped by the Agent, ne
|
||||
> `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.
|
||||
|
||||
> **Amended 2026-10-26 (beta.30, owner decision D69): Enter enables once the phrase is typed exactly.** "Enter never
|
||||
> enables" was built as `DefaultButton = Close`, and WPF UI 4.3.0's template sends Enter to the default button (each
|
||||
> button's `IsDefault` follows `DefaultButton`, read at the tag) — so the owner typed the phrase, pressed Enter and
|
||||
> declined without a word, while the game page's switch went on showing *on* beside *off*. Asked with that, the owner
|
||||
> chose: the primary button is the default; while the phrase does not match, the dialog's content keeps Enter
|
||||
> (`ConsentDialogContent.SwallowsEnter`) and nothing happens; once it matches, Enter enables, as a click on the
|
||||
> then-visible *Enable hooking* does. **The typed phrase is still the gate**: the button Enter reaches is disabled — and
|
||||
> hidden — until the phrase is typed exactly, so a reflexive Enter cannot enable; Esc and *Keep hooking off* still
|
||||
> decline. No `Safety_Consent_*` string changed, so `consent-dialog/1` stands. `ConsentDialogKeysTests` holds both
|
||||
> halves on the real template. The tick-box dialogs (D33's exception, D34's admin mode) are unchanged: Enter keeps them
|
||||
> declined.
|
||||
|
||||
> **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
|
||||
@@ -1145,6 +1207,13 @@ outlives a rules change, a game update and *Change executable*; §What a finding
|
||||
## Crash & stability safety
|
||||
|
||||
- Two crashes of the same game within 60 s of injection ⇒ hooking auto-disabled for that game, UI explains, Tier-2 takes over. Recorded in `games.hook_autodisabled_reason`. *"Crash" here is any abnormal end: since beta.8 a session whose exit code is not an exception's (End task's 1) is `normal` on its row, and this policy still counts it inside the window — a hang our hook caused, ended by the user, is the case it exists for. The row's reason says "ended abnormally twice within 60 s of injection" (`04_CAPTURE` §Crash & exit classification).*
|
||||
- **Measured 2026-10-19/20 (`spike-notes` §23): direct starts turned hooking off for exits no hook caused.** Lies of P
|
||||
started by **Play** ▸ *Start directly* hands itself to Steam within seconds — its process leaves with nothing
|
||||
presented and Steam starts the game again —, and Clair Obscur: Expedition 33 started directly closes within five
|
||||
seconds and reads *crashed*, hooked or not (its third start, refused and unhooked, closed the same way). Each was a
|
||||
hooked session's early abnormal end; the policy counted them, and two turned hooking off. It cannot tell either from
|
||||
the hang it exists for, so it stands as written; whether a witness — the same executable started again within
|
||||
seconds — may exempt a hand-off is the owner's decision, not taken. Users are told in `LIMITATIONS.md` §Play.
|
||||
- **What reads as a crash changed in beta.14, in both directions** (`04_CAPTURE` §Crash & exit classification): a
|
||||
Windows report that is not a crash (a memory-leak or hang report) no longer makes one, and an engine's crash reporter
|
||||
started by a game that then left does — Unreal's crash ended with exit code 3 and read `normal`. Both feed this policy,
|
||||
|
||||
+49
-2505
File diff suppressed because it is too large.
Load diff
+437
-2637
File diff suppressed because it is too large.
Load diff
+50
-18
@@ -1,48 +1,69 @@
|
||||
# Games FrameLedger has been run with
|
||||
|
||||
*As of 2026-09-27 (0.1.0-beta.10). Built from a copy of the developer's own FrameLedger database and the repository's
|
||||
*As of 2026-11-06 (0.1.0-beta.34). Built from a copy of the developer's own FrameLedger database and the repository's
|
||||
measurement notes, and reviewed by the project's owner before it was published. It lists what happened on one machine;
|
||||
it promises nothing about any other.*
|
||||
|
||||
*(Not re-read for 0.1.0-beta.11 or 0.1.0-beta.12 — noted 2026-10-04. Refreshing it needs a new copy of the database and
|
||||
the owner's review; sessions since 2026-09-27, and the game-memory figures beta.12 adds, are not here.)*
|
||||
*~~(Not re-read for 0.1.0-beta.11 or 0.1.0-beta.12 — noted 2026-10-04. Refreshing it needs a new copy of the database and
|
||||
the owner's review; sessions since 2026-09-27, and the game-memory figures beta.12 adds, are not here.)~~ Refreshed
|
||||
2026-11-06 from a copy of the database taken that day, and reviewed by the owner with the plan of 0.1.0-beta.34: the
|
||||
sessions since 2026-09-27 are below, with the graphics memory a game used where it adds something.*
|
||||
|
||||
**The machine.** Every row below was run on one PC: an NVIDIA GeForce RTX 5080 (the only graphics card), an Intel Core
|
||||
i7-14700KF, 32 GB of DDR5, Windows 11 (Insider builds 26300 → 29648) and a 2560×1440, 240 Hz monitor. **No AMD or Intel
|
||||
graphics card and no second machine has been tested**, and **no real Vulkan or OpenGL game has been measured** — every
|
||||
measurement below is Direct3D 11 or 12. What the tiers mean and what FrameLedger cannot do: [LIMITATIONS.md](../LIMITATIONS.md).
|
||||
i7-14700KF, 32 GB of DDR5, Windows 11 (Insider builds 26300 → 29648) and a 2560×1440, 240 Hz monitor; the graphics
|
||||
driver went from 32.0.16.1714 to 32.0.16.2114 over the sessions in the database. **No AMD or Intel
|
||||
graphics card and no second machine has been tested**, and ~~**no real Vulkan or OpenGL game has been measured** — every
|
||||
measurement below is Direct3D 11 or 12~~ **one real Vulkan game has been measured (Everhex Demo, 2026-10-13) and no
|
||||
OpenGL game** — every other measurement below is Direct3D 11 or 12 *(corrected 2026-10-14)*. What the tiers mean and what FrameLedger cannot do: [LIMITATIONS.md](../LIMITATIONS.md).
|
||||
|
||||
**Two periods.** From 2026-08-03 to 2026-09-06 the games were measured with the developer's capture tool, one run at a
|
||||
time against the game's own settings menu (reports in [spike-notes.md](spike-notes.md)). From 2026-09-16 the shipped
|
||||
app and agent recorded them as a user would; the database holds the sessions from 2026-09-22 on — earlier ones went
|
||||
with the 2026-09-16 recovery and with library entries removed since.
|
||||
app and agent recorded them as a user would; ~~the database holds the sessions from 2026-09-22 on~~ the copy of
|
||||
2026-11-06 holds the sessions from 2026-10-04 on — earlier ones went with the 2026-09-16 recovery and with library
|
||||
entries and sessions removed since; a row citing the database before 2026-10-04 was read from the copy of 2026-09-27.
|
||||
|
||||
## Measured — hooked (Tier 1)
|
||||
|
||||
| Game | Engine | API | What was measured | When | Evidence |
|
||||
|---|---|---|---|---|---|
|
||||
| Cyberpunk 2077 | — | D3D12 | DLSS Balanced 1485×835 → 2560×1440, exact against its settings file; DLSS Frame Generation off ×1.00, ×3 (61.4 → 183.5 FPS), ×4 (58.7 → 234.1); FSR 3 + FSR frame generation ×2 (74.3 → 148.6); ray tracing *Yes* with path tracing on and *No* with it off, as set | 2026-08-15 → 09-05, about 25 runs | [spike-notes §8, §9, §11](spike-notes.md) |
|
||||
| Cyberpunk 2077 | — | D3D12 | DLSS Balanced 1485×835 → 2560×1440, exact against its settings file; DLSS Frame Generation off ×1.00, ×3 (61.4 → 183.5 FPS), ×4 (58.7 → 234.1); FSR 3 + FSR frame generation ×2 (74.3 → 148.6); ray tracing *Yes* with path tracing on and *No* with it off, as set; on 2026-10-20, ×2, ×3 and ×4 chosen in the game's menu within one session read as separate states, ×4.0 at 63.8 → 255.3 FPS, with ray tracing and Ray Reconstruction *Yes* | 2026-08-15 → 10-20, about 26 runs | [spike-notes §8, §9, §11, §23](spike-notes.md), database |
|
||||
| Dying Light: The Beast | — | D3D12 | DLSS Frame Generation ×4: Native 70.5 → Displayed 282.1 FPS, counted through DXGI; FSR + FSR frame generation ×2 (70.5 → 140.9); ray tracing *Yes* | 2026-09-04 → 09-06 | [spike-notes §9](spike-notes.md), [03_METRICS §Frame Generation](03_METRICS.md) |
|
||||
| Hell Is Us | Unreal Engine 5.5.4 | D3D12 | DLSS Frame Generation ×4 (76.5 → 306.2); DLSS shown as *driver-reported* (it bypasses Streamline); FSR + FSR frame generation ×2 (85.7 → 171.4); XeSS frame generation shown as Presented FPS only; ray tracing *No* | 2026-09-03 → 09-16 | [spike-notes §8, §9](spike-notes.md) |
|
||||
| Black Myth: Wukong | Unreal Engine 5.0.0 | D3D12 | DLSS Frame Generation ×4 (55.4 → 221.5); ray tracing *Yes* (16.2 % of frames in the app's session); a session that changed state showed its steady state (×4.1) instead of an average | 2026-08-20 → 09-16 | [spike-notes §9, §14](spike-notes.md) |
|
||||
| Clair Obscur: Expedition 33 | Unreal Engine 5.4.4 | D3D12 | DLSS + Frame Generation ×4 (54.9 → 218.4) and ×2 (76.0 → 149.8); frame generation off read *none*, with DXGI agreeing; ray tracing *No* | 2026-09-04 → 09-06 | [spike-notes §9](spike-notes.md) |
|
||||
| Clair Obscur: Expedition 33 | Unreal Engine 5.4.4 | D3D12 | DLSS + Frame Generation ×4 (54.9 → 218.4) and ×2 (76.0 → 149.8); frame generation off read *none*, with DXGI agreeing; ray tracing *No*; the NVIDIA App's *Fixed ×6* read ×6.0 (81.8 → 490.9) on 2026-10-20 | 2026-09-04 → 10-20 | [spike-notes §9, §23](spike-notes.md), database |
|
||||
| Rune Factory: Guardians of Azuma | Unreal Engine (version not in the executable) | D3D12 | DLSS Frame Generation ×4 (128.9 → 513.0); FSR frame generation compiled into the game counted ×2 but not named; ray tracing *No* (the game has none) | 2026-08-20 → 09-06 | [spike-notes §9](spike-notes.md) |
|
||||
| Kingdom Come: Deliverance II | — | D3D12 | FSR (3.1 or 4) at 1505×847 → 2560×1440; frame generation *none* (the game ships none); ray tracing *No* | 2026-09-04 | [spike-notes §9](spike-notes.md) |
|
||||
| Lies of P | Unreal Engine 4.27.2 | D3D12 | FSR 3 at 1506×848 → 2560×1440 with FSR frame generation ×2.04 (57.1 → 116.4) in the app; frame generation off read *none*; DLSS shown as *driver-reported*; ray tracing *No* | 2026-08-03 → 09-16 | [spike-notes §7, §9, §14](spike-notes.md) |
|
||||
| Lies of P | Unreal Engine 4.27.2 | D3D12 | FSR 3 at 1506×848 → 2560×1440 with FSR frame generation ×2.04 (57.1 → 116.4) in the app; frame generation off read *none*; DLSS shown as *driver-reported*; ray tracing *No*; on 2026-10-19 and 10-20, FSR 3 at 1707×961 and at 1280×720 → 2560×1440 with FSR frame generation ×2.0 (54.6 → 109.6, 57.6 → 116.7) and no FSR quality mode — the game never asked for one while the hook was in | 2026-08-03 → 10-20 | [spike-notes §7, §9, §14, §22, §23](spike-notes.md), database |
|
||||
| Onimusha: Way of the Sword (demo) | RE Engine | D3D12 | DLSS + DLSS Frame Generation: ×3.67 and ×3.93 with the capture tool, ×4.00 in the app's steady state (60 → 240 FPS), ×3.0 (60 → 180) in the app on 2026-09-22; ray tracing *Yes* | 2026-09-05 → 09-22 | [spike-notes §9, §14](spike-notes.md), database |
|
||||
| Cronos: The New Dawn (demo) | Unreal Engine (version not in the executable) | D3D12 | DLSS with frame generation off (105 FPS, *none*); on ×2 (86.8 → 172.7), DLSS Frame Generation named; ray tracing *Yes* | 2026-09-06 → 09-16 | [spike-notes §9, §14](spike-notes.md) |
|
||||
| Alan Wake 2 | — | D3D12 | Path tracing Ultra with DLSS and Ray Reconstruction: ray tracing *Yes* (96.8 % of frames), frame generation read ×1.00 (the game did not apply the setting that run). On 2026-09-04: DLSS with ray tracing *Yes* (99 % of frames), 92.5 FPS, frame generation *none* by count; then ray tracing off (*No*), DLSS, Presented 114.5 FPS. The quality preset was never read | 2026-08-04 → 09-04 | [spike-notes §8](spike-notes.md), run reports |
|
||||
| SILENT HILL 2 | Unreal Engine 5.1 | D3D12 | DLSS Frame Generation identified, frames not counted (Presented 78 FPS); DLSS *driver-reported*; ray tracing *Yes* | 2026-09-25 | database |
|
||||
| DARK SOULS III | FromSoftware | D3D11 | Presented 59.8 FPS; no upscaler, frame generation or ray tracing loaded | 2026-09-03 | [spike-notes §9](spike-notes.md) |
|
||||
| Sekiro: Shadows Die Twice | FromSoftware | D3D11 | Presented 60 FPS (the game's cap), two sessions of 15 min and 2 h 18 min | 2026-09-26 | database |
|
||||
| SILENT HILL 2 | Unreal Engine 5.1 | D3D12 | DLSS Frame Generation identified, frames not counted (Presented 78 FPS) on 2026-09-25; then under the NVIDIA App's *Fixed ×6* ×6.0 (53.3 → 320.0) and under its *Dynamic, up to ×6* states ×2.0, ×3.0 and ×6.1; DLSS *driver-reported*; ray tracing *Yes* | 2026-09-25 → 10-20 | database, [spike-notes §22, §23](spike-notes.md) |
|
||||
| DARK SOULS III | FromSoftware | D3D11 | Presented 59.8 FPS; no upscaler, frame generation or ray tracing loaded; then 34 sessions at the game's 60 FPS cap, the longest 6 h 12 min, four of them ended by the game crashing | 2026-09-03 → 10-25 | [spike-notes §9](spike-notes.md), database |
|
||||
| Sekiro: Shadows Die Twice | FromSoftware | D3D11 | Presented 60 FPS (the game's cap): two sessions of 15 min and 2 h 18 min, then three more of up to 1 h 6 min | 2026-09-26 → 10-29 | database |
|
||||
| Yu-Gi-Oh! Master Duel | Unity 6000.0 | D3D11 | Presented 239 FPS across six sessions (up to 5 h 25 min) | 2026-09-22 → 09-25 | database |
|
||||
| GIRLS' FRONTLINE 2: EXILIUM | Unity 2019.4 | D3D11 | Presented 53–101 FPS; the last three sessions under the user-mode anti-cheat exception (NetEase Yidun), one of them 3 h 9 min, all ended normally | 2026-09-21 → 09-27 | database, [HANDOFF](HANDOFF.md) |
|
||||
| GIRLS' FRONTLINE 2: EXILIUM | Unity 2019.4 | D3D11 | Presented 53–101 FPS; the last three sessions under the user-mode anti-cheat exception (NetEase Yidun), one of them 3 h 9 min, all ended normally; ten more under the exception, 28–72 FPS, the longest 2 h 9 min, all ended normally | 2026-09-21 → 10-20 | database, [HANDOFF](HANDOFF.md) |
|
||||
| Aniimo | Unity 2022.3 | D3D12 | DLSS at 1707×960 → 2560×1440, frame generation *none* (×1.00, 205 FPS), ray tracing *No* — then blocked (below) | 2026-09-22 | database |
|
||||
| AbyssMemory | Unreal Engine 4.26.1 | D3D11 | Presented 55 FPS, one short session | 2026-09-22 | database |
|
||||
| Umamusume: Pretty Derby | Unity 2022.3 | D3D11 | Presented 37 FPS, one session | 2026-09-27 | database |
|
||||
| 恋しかるべき (KOISHIKARUBEKI) | Unity 6000.3 | D3D11 | Presented 59.6 FPS | 2026-09-03 | [spike-notes §9](spike-notes.md) |
|
||||
| Flower in Us | RPG Maker MV/MZ (NW.js) | D3D11 | Presented 59.8 FPS over three swap chains, after two refusals that found the game's browser process ambiguous (fixed) | 2026-09-03 → 09-04 | [spike-notes §9](spike-notes.md) |
|
||||
| UMIGARI | Unreal Engine 5.5.4 | D3D12 | Presented 95–97 FPS, frame generation *none*, ray tracing *No* | 2026-09-05 → 09-06 | run reports only |
|
||||
| Everhex Demo | — | Vulkan | Presented 239.7 FPS (1 % low 213.5), 14,955 frames in 69 s, through FrameLedger's Vulkan layer — the first real Vulkan game measured; started by Play set to *Start directly* | 2026-10-13 | database *(row added 2026-10-14 from a copy of the database)* |
|
||||
| The Witcher 3: Wild Hunt — Remastered | — | D3D12 | DLSS 1707×960 → 2560×1440 with DLSS Frame Generation ×2.0 (118.8 → 237.4 FPS); ray tracing and Ray Reconstruction *Yes*; under the NVIDIA App's *Fixed ×6* it still presented ×2.0 — the setting is not the frames | 2026-10-04 → 10-20 | database, [spike-notes §23](spike-notes.md) |
|
||||
| Phantom Blade Zero | Unreal Engine (version not in the executable) | D3D12 | DLSS *driver-reported*; DLSS Frame Generation under the NVIDIA App's *Dynamic* mode: up to ×6 held ×4.0 (59.5 → 235.6 FPS) and ×5.2 (44.3 → 231.2), up to ×3 held ×3.0 (58–76 → 175–227) for 75–94 % of each session longer than an hour; ray tracing *Yes*; thirteen sessions, the longest 6 h 29 min (5.26 million frames); up to 9.6 GB of graphics memory | 2026-11-01 → 11-05 | database, [spike-notes §26](spike-notes.md) |
|
||||
| Hogwarts Legacy | Unreal Engine (version not in the executable) | D3D12 | With the game's *Neural Rendering* on, DLSS 5's runtime (`nvngx_dlssnr.dll` 310.9.16.0) loaded from the game's folder — the first game seen loading it; DLSS *driver-reported*; DLSS Frame Generation not counted (non-uniform, ×1.97 overall), Presented 140.2 FPS; ray tracing *Yes*, Ray Reconstruction *No* | 2026-11-06 | database, [spike-notes §26](spike-notes.md) |
|
||||
| Valor Mortis (Xbox app) | Unreal Engine | D3D12 | DLSS Frame Generation ×6.0 (39.9 → 239.2 FPS), DLSS *driver-reported*, ray tracing *No*; recorded in attach mode | 2026-11-04 | database |
|
||||
| inKONBINI (Xbox app) | Unity 6000.0 | D3D11 | Presented 205.9 FPS, one short session | 2026-11-03 | database |
|
||||
| DARK SOULS II: Scholar of the First Sin | FromSoftware | D3D11 | The game's 60 FPS cap, nine sessions up to 5 h 29 min; one was unhooked by the safety check and recorded on | 2026-10-09 → 10-12 | database |
|
||||
| Mithril | Unreal Engine (version not in the executable) | D3D12 | Presented 91.5–119.4 FPS, ray tracing *Yes*, four sessions up to 3 h 4 min | 2026-10-12 → 10-16 | database |
|
||||
| KEEP IT ON HER | Unreal Engine 5.8 | D3D12 | Presented 59.5–108.8 FPS, ray tracing *Yes* | 2026-10-12 → 10-13 | database |
|
||||
| WALTO | Unity 6000.3 | D3D12 | Presented 212.5 FPS over 2 h 41 min (2,057,022 frames) | 2026-10-08 | database |
|
||||
| White Mask Mansion | Unity 6000.1 | D3D12 | Presented 286–309 FPS, five sessions | 2026-10-27 | database |
|
||||
| LIMINAL: Within Demo | Unity 2022.3 | D3D11 | Presented 222.5–228.6 FPS | 2026-10-12 | database |
|
||||
| Sleepytime Village | Unity 2021.3 | D3D11 | Presented 906–1,440 FPS (the game sets no cap) | 2026-10-25 → 10-26 | database |
|
||||
| Scarlet Wolf | Unity 2021.3 | D3D11 | Presented 128.5 FPS | 2026-10-15 | database |
|
||||
| March Out! Playtest | Unity 2022.3 | D3D11 | Presented 118.2 FPS | 2026-10-08 | database |
|
||||
| A Space for the Unbound – Prologue (GOG) | Unity 2019.4 | D3D11 | Presented 61.0 FPS, started by FrameLedger | 2026-10-20 | database |
|
||||
|
||||
## Recorded without measurement (Tier 2)
|
||||
|
||||
@@ -50,8 +71,14 @@ with the 2026-09-16 recovery and with library entries removed since.
|
||||
|---|---|---|---|
|
||||
| HELLO, HELLO WORLD! | A 32-bit game (RPG Maker MV): refused by the guard once, and two sessions with hooking switched off — each recorded with its duration and sensors. *Its itch.io download puts malware in front of the game — do not run it (noted 2026-10-13, [spike-notes §20](spike-notes.md))* | 2026-09-23 | database |
|
||||
| Umamusume: Pretty Derby | Three sessions played with hooking switched off for the game | 2026-09-27 | database |
|
||||
| Sekiro: Shadows Die Twice | One session played with hooking switched off | 2026-09-25 | database |
|
||||
| Sekiro: Shadows Die Twice | Two sessions played with hooking switched off | 2026-09-25, 10-07 | database |
|
||||
| GIRLS' FRONTLINE 2: EXILIUM | One session whose process Windows would not let FrameLedger open, and two recovered after the agent itself stopped mid-session (*interrupted*) | 2026-09-22 → 09-23 | database |
|
||||
| Bound Between Desks | Two sessions with hooking switched off (a Ren'Py 8.5 game) | 2026-10-15 → 10-20 | database |
|
||||
| Phantom Blade Zero | Three sessions after a game update changed its executable on 2026-11-04, until hooking was consented to again on 11-05; one refused because a module list came back incomplete | 2026-11-04 → 11-05 | database |
|
||||
| The Witcher 3: Wild Hunt — Remastered | Three sessions before hooking was consented to | 2026-10-13 → 10-20 | database |
|
||||
| Mithril | Two sessions before hooking was consented to | 2026-10-16 | database |
|
||||
| Hogwarts Legacy | One session with hooking switched off; Windows logged a crash of the game | 2026-11-06 | database |
|
||||
| Valor Mortis, WALTO, Scarlet Wolf, Lies of P, A Space for the Unbound – Prologue | One session each with hooking switched off | 2026-10-08 → 11-04 | database |
|
||||
|
||||
## Refused by the anti-cheat guard
|
||||
|
||||
@@ -62,7 +89,10 @@ with the 2026-09-16 recovery and with library entries removed since.
|
||||
| Aniimo | NetEase Yidun with a kernel driver (`NEPKernel.sys`) in the game's folder — never eligible for an exception | 2026-09-25 | [19_SAFETY](19_SAFETY_AND_ANTICHEAT.md) |
|
||||
| Goose Goose Duck | Easy Anti-Cheat's service running, and its folder | 2026-08-04 | [spike-notes §13](spike-notes.md) |
|
||||
| Neverness To Everness | Anti-Cheat Expert's kernel driver in the game's folder | 2026-08-04 | [spike-notes §13](spike-notes.md) |
|
||||
| Wuthering Waves | Anti-Cheat Expert, kept beside the game's executable four folder levels in, where the check did not look before beta.21: a session with hooking on was injected and unhooked 37 seconds later, when the 30-second re-check met ACE's driver (`ACE-BASE.sys`); nothing was measured. Since beta.21 its folder and its Steam id refuse it before any injection *(row added 2026-10-13 from the agent's log)* | 2026-10-12 | [spike-notes §19](spike-notes.md) |
|
||||
| Wuthering Waves | Anti-Cheat Expert, kept beside the game's executable four folder levels in, where the check did not look before beta.21: a session with hooking on was injected and unhooked 37 seconds later, when the 30-second re-check met ACE's driver (`ACE-BASE.sys`); nothing was measured. Since beta.21 its folder and its Steam id refuse it before any injection *(row added 2026-10-13 from the agent's log)*; two sessions recorded without measurement on 2026-10-31 | 2026-10-12 → 10-31 | [spike-notes §19](spike-notes.md), database |
|
||||
| Arknights: Endfield | Anti-Cheat Expert's folder (`AntiCheatExpert`) beside the game; one session recorded without measurement | 2026-10-31 | database |
|
||||
| Stella Sora | Anti-Cheat Expert's folder (`AntiCheatExpert`); three sessions recorded without measurement | 2026-10-30 → 10-31 | database |
|
||||
| Umamusume: Pretty Derby | CrackProof, on FrameLedger's title list since beta.11 (Steam 3224770) — measured before the list named it (above) | 2026-10-03 | [19_SAFETY](19_SAFETY_AND_ANTICHEAT.md) |
|
||||
| Counter-Strike 2 | Valve Anti-Cheat — refused by FrameLedger's title list since beta.8. On 2026-08-04 the checks alone allowed it (VAC is invisible to them); nothing was injected | 2026-08-04, beta.8 | [spike-notes §13](spike-notes.md), [19_SAFETY](19_SAFETY_AND_ANTICHEAT.md) |
|
||||
|
||||
Also refused before any injection: **Deadly Heart Gambit** — a 32-bit game (2026-08-03).
|
||||
@@ -72,4 +102,6 @@ Also refused before any injection: **Deadly Heart Gambit** — a 32-bit game (20
|
||||
The Unreal Engine version (beta.10) was checked against ten installed Unreal games without running them: Hell Is Us
|
||||
5.5.4, Black Myth: Wukong 5.0.0, Clair Obscur: Expedition 33 5.4.4, Lies of P 4.27.2, SILENT HILL 2 5.1, UMIGARI 5.5.4,
|
||||
AbyssMemory 4.26.1, **Martha Is Dead 4.27.0**; Cronos (demo) and Rune Factory name no version in their executables and
|
||||
read *not found*. ([spike-notes §15](spike-notes.md), [05_DETECTION §Engine version](05_DETECTION.md))
|
||||
read *not found*. ([spike-notes §15](spike-notes.md), [05_DETECTION §Engine version](05_DETECTION.md)) Read since on the games
|
||||
in the database: KEEP IT ON HER 5.8 and Wuthering Waves 4.26.2; Phantom Blade Zero, Hogwarts Legacy and Mithril name no
|
||||
version in their executables, and an Xbox game's executable cannot be read outside its package (Valor Mortis).
|
||||
+10
-2
@@ -11,7 +11,7 @@ This folder is for people who build, change or review FrameLedger. **If you only
|
||||
| Find your way around first | The [wiki](https://github.com/poli0981/frameledger/wiki)'s developer pages (source: [`../wiki/`](../wiki/), beta.17) — a short page per part, each linking here |
|
||||
| Learn the system | [`../CLAUDE.md`](../CLAUDE.md) (the rules and the layout), then the reading order below |
|
||||
| Build it | [`12_BUILD.md`](12_BUILD.md) — `./build.ps1 check` is the whole gate, the same one CI runs |
|
||||
| Contribute or fork | [`../CONTRIBUTING.md`](../CONTRIBUTING.md), [`../FORKING.md`](../FORKING.md), [`../NOTICE`](../NOTICE) |
|
||||
| Contribute or fork | [`../CONTRIBUTING.md`](../CONTRIBUTING.md), [`../FORKING.md`](../FORKING.md), [`../NOTICE`](../NOTICE), [`../CODE_OF_CONDUCT.md`](../CODE_OF_CONDUCT.md) *(it and `SECURITY.md`, below, added 2026-11-09: the index named neither)* |
|
||||
|
||||
**Status lives in four places, and nowhere else** — check a status claim against the code before you plan on it:
|
||||
|
||||
@@ -69,7 +69,11 @@ are safety items, and something listed there as unresolved should not be built t
|
||||
| [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) | Telemetry layers (DXGI/PDH, LibreHardwareMonitor, NVAPI), the game process's memory, licences |
|
||||
| [`19_SAFETY_AND_ANTICHEAT.md`](19_SAFETY_AND_ANTICHEAT.md) | The anti-cheat guard, what a finding does, the user-mode exception, what will never be built |
|
||||
| [`20_OPEN_QUESTIONS.md`](20_OPEN_QUESTIONS.md) | Every unresolved question, defect and measurement, with its status marker |
|
||||
| [`HANDOFF.md`](HANDOFF.md) | Sequencing, the owner's decisions, traps |
|
||||
| [`HANDOFF.md`](HANDOFF.md) | Sequencing, the open owner-only items, the index of the owner's decisions |
|
||||
| [`handoff/`](handoff/) | Since beta.24 (D66): the history of every train and phase, the passed owner-only items, the traps — moved out of `HANDOFF.md` verbatim |
|
||||
| [`open-questions/`](open-questions/) | Since beta.24 (D66): the entries §S24 marks resolved, moved out of `20_OPEN_QUESTIONS.md` verbatim — a table there lists them |
|
||||
| [`spike-notes/`](spike-notes/) | Since beta.24 (D66): one file per measurement section; `spike-notes.md` is the index that resolves `spike-notes §N` |
|
||||
| [`changelog/`](changelog/) | Since beta.24 (D66): each release's notes in its own file, and the ledger kept before the first tag; `../CHANGELOG.md` keeps `[Unreleased]` and the list |
|
||||
| [`spike-notes.md`](spike-notes.md) | What was measured, how, on which machine, and what each result decided |
|
||||
| [`LIST_GAME_TESTED.md`](LIST_GAME_TESTED.md) | The real games FrameLedger has been run with, and what each session measured (changes need the owner's review) |
|
||||
| [`legal-drift-history.md`](legal-drift-history.md) | How the legal documents once drifted from the software, and the maintainers' notes moved out of them |
|
||||
@@ -83,5 +87,9 @@ are safety items, and something listed there as unresolved should not be built t
|
||||
- [`../legal/`](../legal/) — the documents a user accepts, the accuracy statement, the third-party notices and licence
|
||||
texts, the trademark note.
|
||||
- [`../LIMITATIONS.md`](../LIMITATIONS.md) — what the whole software cannot do, in a player's words.
|
||||
- [`../ACCESSIBILITY.md`](../ACCESSIBILITY.md) — the accessibility statement (beta.35, D88): the goal, what works with the
|
||||
keyboard, a screen reader and contrast themes, the known limits and how a barrier is reported; shown in the App under
|
||||
Help ▸ Accessibility. Its checks are [`08_UI.md`](08_UI.md) §Accessibility.
|
||||
- [`../SECURITY.md`](../SECURITY.md) — the private route for a vulnerability, and why the guard has no override.
|
||||
- [`../rules/detection-rules.json`](../rules/detection-rules.json) — engine, platform and capability signatures and the
|
||||
anti-cheat blocklist, validated by `tools/rules-validate.ps1`.
|
||||
@@ -0,0 +1,40 @@
|
||||
<!-- The first alpha's notes (D73-D76), on main as every release's are; the alpha branch takes them with its sync. CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-alpha.1] - 2026-10-31
|
||||
|
||||
> ⚠ **EXPERIMENTAL BUILD — YOU USE IT AT YOUR OWN RISK.** This is an **alpha**: the source of `0.1.0-beta.32` built on
|
||||
> **.NET 11 Release Candidate 3** (SDK `11.0.100-rc.3.26522.148`, runtime `11.0.0-rc.3.26522.148`), a version of .NET
|
||||
> Microsoft has not finished, with the C# 15 compiler. It has not been tested the way a beta is, and it can crash, record
|
||||
> wrongly or fail to update in ways no beta has. **If you want results you can rely on, use the beta.** Before it runs it
|
||||
> shows the *Alpha notice* (`legal/ALPHA_NOTICE.md` 1.0), which you must accept, with its own box to tick.
|
||||
|
||||
**The first alpha.** What it is and how to go back: the user guide's *Alpha builds* page
|
||||
(`guide/11-alpha-builds.md`), and the *Alpha builds* section of `LIMITATIONS.md`.
|
||||
|
||||
**Installing it:** download `FrameLedger.App-alpha-Setup.exe` below, verify its hash against `SHA256SUMS.txt`, run it,
|
||||
and let it replace the FrameLedger already installed. **It replaces the beta** — one of them is installed at a time — and
|
||||
uses the same data folder: before it first opens your database it copies it to
|
||||
`%LOCALAPPDATA%\FrameLedger\backups\ledger-before-0.1.0-alpha.1.db`, and it does not open the database if the copy cannot
|
||||
be made. It never arrives as an update to a beta, and it updates only to newer alphas.
|
||||
|
||||
**Going back:** install the newest beta's `FrameLedger.App-win-Setup.exe` over it; your database stays where it is, with
|
||||
any sessions the alpha recorded.
|
||||
|
||||
**Windows and your PC:** Microsoft supports .NET 11 on Windows 11 24H2 and later, and on Windows 10 only in its LTSC and
|
||||
IoT editions; on Windows 10 22H2 Home or Pro this alpha may run, but nobody supports it there. It needs a processor with
|
||||
SSE4.2 and POPCNT. .NET 11 RC3 is supported by Microsoft until .NET 11 ships (10 November 2026); the next alpha moves to
|
||||
the final release.
|
||||
|
||||
### What differs from 0.1.0-beta.32
|
||||
|
||||
- **The runtime and the compiler**: .NET 11 RC3 in place of .NET 10.0.14, self-contained as always; C# 15. The source
|
||||
uses no C# 15 syntax and no preview feature (owner decision D76) — what .NET 11's SDK asked of it was taken on main in
|
||||
forms .NET 10 also compiles (`docs/spike-notes/24-dotnet11-probe.md`), so a beta and this alpha are the same code.
|
||||
- **Three libraries serviced with the runtime**: `Microsoft.Extensions.Hosting`, `System.Diagnostics.EventLog` and
|
||||
`Microsoft.Data.Sqlite` `11.0.0-rc.3.26522.148`. The database engine is SQLite 3.53.4 (`SQLitePCLRaw` 3.0.5, which
|
||||
`Microsoft.Data.Sqlite` 11 declares), where the beta's is 3.53.3; the database file is the same format. Nine
|
||||
`Microsoft.Extensions.*` libraries are now part of the runtime and no longer ship beside it.
|
||||
- **What .NET 11 itself changes**: a failure in the capture agent's own background work ends the agent with a crash report
|
||||
where the beta's exits quietly (`IHost` now reports it); the runtime's ReadyToRun code targets processors with AVX2, so
|
||||
an older processor starts the program a little slower.
|
||||
- **The part of FrameLedger loaded into a game is the beta's**, built from the same C++ source: it does not use .NET.
|
||||
@@ -0,0 +1,33 @@
|
||||
<!-- The second alpha's notes (D73, D82), on main as every release's are; the alpha branch takes them with its sync. CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-alpha.2] - 2026-11-03
|
||||
|
||||
> ⚠ **EXPERIMENTAL BUILD — YOU USE IT AT YOUR OWN RISK.** This is an **alpha**: the source of `0.1.0-beta.33` built on
|
||||
> **.NET 11 Release Candidate 3** (SDK `11.0.100-rc.3.26522.148`, runtime `11.0.0-rc.3.26522.148`), a version of .NET
|
||||
> Microsoft has not finished, with the C# 15 compiler. It has not been tested the way a beta is, and it can crash, record
|
||||
> wrongly or fail to update in ways no beta has. **If you want results you can rely on, use the beta.** Before it runs it
|
||||
> shows the *Alpha notice* (`legal/ALPHA_NOTICE.md` 1.0), which you must accept, with its own box to tick.
|
||||
|
||||
**The second alpha: `0.1.0-beta.33` on .NET 11 RC3** — games from the Xbox app and the Microsoft Store (the beta's
|
||||
notes, `docs/changelog/0.1.0-beta.33.md`, say what that brings). What an alpha is and how to go back: the user guide's
|
||||
*Alpha builds* page (`guide/11-alpha-builds.md`), and the *Alpha builds* section of `LIMITATIONS.md`.
|
||||
|
||||
**Updating from `0.1.0-alpha.1`:** Help ▸ Check for updates, then *Restart to update* with no game running — an alpha
|
||||
updates only to newer alphas. Before it first opens your database it copies it to
|
||||
`%LOCALAPPDATA%\FrameLedger\backups\ledger-before-0.1.0-alpha.2.db` (the newest three copies are kept). The terms window
|
||||
shows the **Privacy Policy 2.13** once and, as every time an alpha's terms window opens, waits for the Alpha notice's box
|
||||
to be ticked again; the notice itself stays 1.0. The ledger stays at schema 21; the detection rules move to `2026.11.1`.
|
||||
|
||||
**Installing it over a beta:** download `FrameLedger.App-alpha-Setup.exe` below, verify its hash against
|
||||
`SHA256SUMS.txt`, and let it replace the FrameLedger already installed; the Alpha notice is shown first. **Going back:**
|
||||
install the newest beta's `FrameLedger.App-win-Setup.exe` over it; your database stays where it is.
|
||||
|
||||
**Windows and your PC:** as for the first alpha — Microsoft supports .NET 11 on Windows 11 24H2 and later, and on Windows
|
||||
10 only in its LTSC and IoT editions; it needs a processor with SSE4.2 and POPCNT. .NET 11 RC3 is supported until .NET 11
|
||||
ships (10 November 2026); the next alpha moves to the final release.
|
||||
|
||||
### What differs from 0.1.0-beta.33
|
||||
|
||||
The same as `0.1.0-alpha.1` differed from `0.1.0-beta.32` (`docs/changelog/0.1.0-alpha.1.md`): the runtime and the
|
||||
compiler, the three libraries serviced with the runtime, what .NET 11 itself changes — and the part of FrameLedger loaded
|
||||
into a game is the beta's.
|
||||
@@ -0,0 +1,36 @@
|
||||
<!-- The third alpha's notes (D73, D87), on main as every release's are; the alpha branch takes them with its sync. CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-alpha.3] - 2026-11-06
|
||||
|
||||
> ⚠ **EXPERIMENTAL BUILD — YOU USE IT AT YOUR OWN RISK.** This is an **alpha**: the source of `0.1.0-beta.34` built on
|
||||
> **.NET 11 Release Candidate 3** (SDK `11.0.100-rc.3.26522.148`, runtime `11.0.0-rc.3.26522.148`), a version of .NET
|
||||
> Microsoft has not finished, with the C# 15 compiler. It has not been tested the way a beta is, and it can crash, record
|
||||
> wrongly or fail to update in ways no beta has. **If you want results you can rely on, use the beta.** Before it runs it
|
||||
> shows the *Alpha notice* (`legal/ALPHA_NOTICE.md` 1.0), which you must accept, with its own box to tick.
|
||||
|
||||
**The third alpha: `0.1.0-beta.34` on .NET 11 RC3** — DLSS 5 and DLSS 4.5 named from what the game and the driver did,
|
||||
filters on Games and Compare, and a Games page that opens at once (the beta's notes, `docs/changelog/0.1.0-beta.34.md`,
|
||||
say what that brings). What an alpha is and how to go back: the user guide's *Alpha builds* page
|
||||
(`guide/11-alpha-builds.md`), and the *Alpha builds* section of `LIMITATIONS.md`.
|
||||
|
||||
**Updating from `0.1.0-alpha.2`:** Help ▸ Check for updates, then *Restart to update* with no game running — an alpha
|
||||
updates only to newer alphas. Before it first opens your database it copies it to
|
||||
`%LOCALAPPDATA%\FrameLedger\backups\ledger-before-0.1.0-alpha.3.db` (the newest three copies are kept). The terms window
|
||||
shows the **Disclaimer 2.13** and the **Privacy Policy 2.14** once and, as every time an alpha's terms window opens, waits
|
||||
for the Alpha notice's box to be ticked again; the notice itself stays 1.0. The ledger moves to schema 22, which an
|
||||
alpha.2 cannot open (the copy is the database as alpha.2 left it; going back is to the newest beta, which opens it); the
|
||||
detection rules move to `2026.11.2`.
|
||||
|
||||
**Installing it over a beta:** download `FrameLedger.App-alpha-Setup.exe` below, verify its hash against
|
||||
`SHA256SUMS.txt`, and let it replace the FrameLedger already installed; the Alpha notice is shown first. **Going back:**
|
||||
install the newest beta's `FrameLedger.App-win-Setup.exe` over it; your database stays where it is.
|
||||
|
||||
**Windows and your PC:** as for the first alpha — Microsoft supports .NET 11 on Windows 11 24H2 and later, and on Windows
|
||||
10 only in its LTSC and IoT editions; it needs a processor with SSE4.2 and POPCNT. .NET 11 RC3 is supported until .NET 11
|
||||
ships (10 November 2026); the next alpha moves to the final release.
|
||||
|
||||
### What differs from 0.1.0-beta.34
|
||||
|
||||
The same as `0.1.0-alpha.1` differed from `0.1.0-beta.32` (`docs/changelog/0.1.0-alpha.1.md`): the runtime and the
|
||||
compiler, the three libraries serviced with the runtime, what .NET 11 itself changes — and the part of FrameLedger loaded
|
||||
into a game is the beta's.
|
||||
@@ -0,0 +1,42 @@
|
||||
<!-- The fourth alpha's notes (D73, D98), on main as every release's are; the alpha branch takes them with its sync. CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-alpha.4] - 2026-11-11
|
||||
|
||||
> ⚠ **EXPERIMENTAL BUILD — YOU USE IT AT YOUR OWN RISK — AND THE LAST ALPHA FOR NOW.** This is an **alpha**: the source
|
||||
> of `0.1.0-beta.37` built on **.NET 11.0.0**, Microsoft's final release of .NET 11 (SDK `11.0.100`) — the same .NET the
|
||||
> betas run on from `0.1.0-beta.37`. It exists to bring an installed alpha off the release candidate. **After it the
|
||||
> alphas pause**, and a paused alpha gets no update — the list of anti-cheat software FrameLedger refuses included.
|
||||
> **Install the latest beta over it.** Before it runs it shows the *Alpha notice* (`legal/ALPHA_NOTICE.md` 1.1), which
|
||||
> you must accept, with its own box to tick.
|
||||
|
||||
**The fourth alpha: `0.1.0-beta.37` on .NET 11.0.0.** The alphas were made to try .NET 11 before the betas relied on it.
|
||||
.NET 11 shipped on 10 November 2026 and the betas moved to it the next day (the beta's notes,
|
||||
`docs/changelog/0.1.0-beta.37.md`), so an alpha and a beta now differ in nothing but what an alpha adds for itself. This
|
||||
one is published so that a copy of `0.1.0-alpha.3`, which runs on a release candidate Microsoft no longer supports,
|
||||
reaches the finished .NET 11 by an update — an alpha never updates to a beta.
|
||||
|
||||
**Then install the beta.** No alpha will follow until there is a newer .NET to try (.NET 12's first previews, expected
|
||||
in 2027). Until then this build stands still: no fixes, and **its anti-cheat list is the one it shipped with**, because
|
||||
that list reaches FrameLedger only inside an update. Its banner says so each time it starts. Download the newest beta's
|
||||
`FrameLedger.App-win-Setup.exe`, verify its hash against that release's `SHA256SUMS.txt`, and let it replace the alpha;
|
||||
your database stays where it is, and the beta opens it. What an alpha is and how to go back: the user guide's *Alpha
|
||||
builds* page (`guide/11-alpha-builds.md`), and the *Alpha builds* section of `LIMITATIONS.md`.
|
||||
|
||||
**Updating from `0.1.0-alpha.3`:** Help ▸ Check for updates, then *Restart to update* with no game running. Before it
|
||||
first opens your database it copies it to `%LOCALAPPDATA%\FrameLedger\backups\ledger-before-0.1.0-alpha.4.db` (the
|
||||
newest three copies are kept). The terms window shows the **EULA 1.7**, the **Disclaimer 2.14** and the **Alpha notice
|
||||
1.1**, and waits for the notice's box to be ticked. The ledger stays at schema 22 and the detection rules at
|
||||
`2026.11.2`. The download is large, because the .NET runtime inside the package is replaced whole. **One limit:**
|
||||
FrameLedger's updater looks at the newest ten releases, so once ten betas have been published after this alpha, an
|
||||
older alpha no longer finds it — install the beta by hand then, as above.
|
||||
|
||||
**Windows and your PC:** as for the beta from `0.1.0-beta.37` — Microsoft supports .NET 11 on Windows 11, and on Windows
|
||||
10 only in its LTSC and IoT editions; FrameLedger is untested and unsupported on Windows 10 22H2; a processor without
|
||||
SSE4.2 and POPCNT cannot start it.
|
||||
|
||||
### What differs from 0.1.0-beta.37
|
||||
|
||||
Nothing in the runtime, the compiler or the libraries: both are built on .NET 11.0.0 from the same source, and the part
|
||||
of FrameLedger loaded into a game is the beta's. What an alpha adds is its own: the Alpha notice in the terms window, the
|
||||
ALPHA badge and the banner — which in this build says that the alphas are paused — the locked update channel, and the
|
||||
copy of the database before it is first opened.
|
||||
@@ -0,0 +1,59 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.1] - 2026-09-16
|
||||
|
||||
**The first pre-release.** An unsigned installer, `FrameLedger.App-win-Setup.exe`, built by `release.yml` from
|
||||
this tag; `SHA256SUMS.txt` is published beside it and printed below. SmartScreen will warn (no code signing —
|
||||
`docs/11_UPDATER.md`); verify the hash, then *More info → Run anyway*. It installs into `%LOCALAPPDATA%\FrameLedger.App`
|
||||
and keeps its data in `%LOCALAPPDATA%\FrameLedger`; uninstalling asks before touching the data. Windows 10 22H2 is
|
||||
the supported floor and is **unmeasured** — every measurement below was taken on one Windows 11 machine with an NVIDIA
|
||||
GPU (`docs/spike-notes.md`).
|
||||
|
||||
### What it is
|
||||
|
||||
- **A desktop app and a background Agent.** The App (WPF) holds the library, imports it from Steam, GOG, Epic and
|
||||
itch.io, shows the Dashboard, session summaries, charts, trends and comparisons, Settings, Logs, the tray, the
|
||||
first-run Legal Gate and the bug report. The Agent watches the library at 1 Hz, records a session whenever a
|
||||
library game runs, and stores it in a local SQLite ledger. Nothing leaves the machine except the update check
|
||||
(`legal/PRIVACY_POLICY.md` 2.2).
|
||||
- **Measurement by hooking, opt-in per game, behind a hard anti-cheat gate.** For a game you enabled — and only
|
||||
after the consent dialog — the Agent loads `FrameLedger.Overlay.dll` into the game and reads what the game passes
|
||||
to the graphics APIs: frame times and output resolution from the present call (Direct3D 11/12, OpenGL; Vulkan
|
||||
through an implicit layer, today only when the Agent itself launches the title); upscaler identity and
|
||||
render→output resolution from Streamline and FidelityFX calls; the frame-generation factor from Streamline's frame
|
||||
token and FidelityFX's dispatches, **counted, never assumed**; ray tracing from DXR dispatch and
|
||||
acceleration-structure hooks. Before injecting, and every 30 s during a session, the guard scans the process
|
||||
tree for anti-cheat and anti-tamper modules, services and drivers and **refuses** — there is no override — and a
|
||||
refusal mid-session unhooks within a frame. A game that is not enabled, or is refused, is recorded as duration
|
||||
and hardware sensors with the reason, and every measured field reads N/A.
|
||||
- **Honest numbers by rule.** Where frame generation is active the readout is *Native → Displayed (×N FG)*;
|
||||
where it was identified but the count refused — a session whose frame-generation state changed (menus,
|
||||
loading screens, alt-tab), or a title with two swapchains — the chip says "factor not counted" and its tooltip
|
||||
says which bucket and by how much. Ray tracing, path tracing and Ray Reconstruction are Yes / No / N/A, measured
|
||||
or not at all. The one number that stands alone carries a qualifier saying whether a frame-generation runtime
|
||||
was loaded.
|
||||
- **Telemetry** from DXGI and PDH (every vendor), LibreHardwareMonitor (GPU sensors unelevated), and NVAPI on
|
||||
NVIDIA. CPU and board sensors need PawnIO and elevation and are off by default.
|
||||
- **Safety and legal surface:** the consent dialog with the disclosure text in en/vi/ja (ja machine-drafted,
|
||||
marked for review), the kill switch, a crash within 60 s of injection twice auto-disabling hooking for that game,
|
||||
the Legal Gate (EULA 1.0, Disclaimer 2.2, Privacy Policy 2.2), the bug bundle built locally and redacted,
|
||||
crash dumps offered only when ticked.
|
||||
|
||||
### What it is not, yet
|
||||
|
||||
- **No rules feed.** The anti-cheat blocklist and the detection rules ship with the build and update only with the
|
||||
next release (`docs/20_OPEN_QUESTIONS.md` §S20). A missed anti-cheat is a safety report (`SECURITY.md`).
|
||||
- **Vulkan in attach mode is unmeasured**, and the layer is registered only when you ask (Settings).
|
||||
- **The DLSS quality preset reads N/A** on every title measured: no title chains the structure that carries it.
|
||||
- **AMD and Intel GPUs are unmeasured** for telemetry and for their frame-generation runtimes; XeSS and the newer
|
||||
FidelityFX frame generation are identified by module, not counted.
|
||||
- **The frame-generation factor is refused rather than guessed** on whole play sessions that changed state; a
|
||||
steady-state figure over the uniform part of a session is a decision not yet taken.
|
||||
- **The ≤ 0.5 % FPS-impact run and the "against the game's own menu" readings** in `docs/spike-notes.md` §14 are
|
||||
still the owner's to take.
|
||||
|
||||
### The record
|
||||
|
||||
Everything that landed before this tag — every PR from 2026-08-04 to 2026-09-16, with its reasoning — is the
|
||||
section *Ledger before 0.1.0-beta.1* below, kept verbatim.
|
||||
|
||||
@@ -0,0 +1,95 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.10] - 2026-09-28
|
||||
|
||||
**The tenth pre-release: how each game was shown, the agent as administrator if you choose it, and the exact Unreal
|
||||
Engine version.** The same unsigned installer: verify its hash against `SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
What changed for a user:
|
||||
|
||||
- **The display mode** — exclusive full-screen, borderless, windowed or minimised, as a share of each session, with the
|
||||
window's size and the monitor's — on the session summary, the game page, the Trend (three new metrics) and Compare,
|
||||
for measured and unmeasured sessions alike. Only a measured Direct3D game can say *exclusive*; others read
|
||||
*full-screen or borderless* when the window covers the screen.
|
||||
- **Run the agent as administrator** — a Settings option, off by default. Windows asks every time the agent starts;
|
||||
games you start from FrameLedger still run with your standard rights; it changes nothing in the anti-cheat guard.
|
||||
- **The exact Unreal Engine version** on a game's page, read from its executable, with what it rests on.
|
||||
- **What FrameLedger cannot do** is one page — Help ▸ Limitations, and `LIMITATIONS.md` — and the games it has been run
|
||||
with are listed in `docs/LIST_GAME_TESTED.md`.
|
||||
- **The Privacy Policy (2.5) and the Disclaimer (2.8) say so**, so the Legal Gate opens once after the update. The EULA
|
||||
is unchanged.
|
||||
|
||||
**Updating from `0.1.0-beta.9`:**
|
||||
|
||||
- Quit the App (tray icon → Exit) and end `FrameLedger.Agent.exe` before running the installer.
|
||||
- Schemas 0015 and 0016 add columns; the database opens in place. Sessions recorded before show the display mode as N/A.
|
||||
- The shared-memory layout between the agent and a measured game changed (version 4): **a game that was running while
|
||||
you updated must be restarted before it can be measured** — the app says so when it meets the old layout.
|
||||
- Every game is re-detected once (rules `2026.09.6`), which fills in the Unreal Engine versions.
|
||||
|
||||
### Added
|
||||
|
||||
- **The exact Unreal Engine version on a game's page** (owner request, beta.10). The Agent reads it from the game's
|
||||
shipping executable on disk — its version number and the engine's build name compiled into it (`++UE5+Release-5.1`)
|
||||
— and the page says which of the two it rests on: *Unreal Engine 4.27.2* for Lies of P, *5.4.4* for Clair Obscur:
|
||||
Expedition 33, *5.1* for SILENT HILL 2 (whose studio replaced the version number with its own), and "not found in the
|
||||
executable" where neither says anything (Cronos, Rune Factory). Measured on ten installed Unreal titles before it was
|
||||
written: eight read, two honestly none. The file is read, never the game's process; a protected executable is scanned
|
||||
whole, once per version of the file (up to 7.5 s on a USB drive for Black Myth: Wukong), and the scan stops if the Agent
|
||||
is asked to. Rules `2026.09.6`: every game is re-detected once. Schema 0015 adds `games.engine_version_source`.
|
||||
|
||||
- **How each game was shown, and for how much of the session** (owner request, beta.10): exclusive fullscreen, borderless,
|
||||
windowed or minimised, with the window's size, the monitor it was on and its refresh rate, and the swap chain's back
|
||||
buffer. On the session summary (a *Display* card and a line with every share), the game page (the last measured session,
|
||||
and a *Display* column in Sessions), the Trend (three new metrics: the share of each session in exclusive fullscreen,
|
||||
borderless and windowed), Compare (three rows, never ranked) and both exports (the CSV's `# display:` line, the JSON's
|
||||
aggregates). **Both tiers:** a game that was not hooked has its window read from outside, which can say windowed or
|
||||
*fullscreen or borderless* but never which of those two — only the swap chain of a hooked DirectX game can say
|
||||
exclusive. What Windows does with an exclusive game behind the scenes ("fullscreen optimizations") is not visible to
|
||||
FrameLedger, and a game's menu may call a borderless window "Fullscreen": the swap chain's answer is the one shown.
|
||||
Sessions recorded before, and one recovered after a crash, read N/A. Schema 0016 adds fifteen `sessions.display_*`
|
||||
columns, and `sessions.swap_effect` — a column with no writer since the first schema — is now filled.
|
||||
|
||||
- **Run the capture agent as administrator — your choice, off by default** (owner request, beta.10). Settings ▸ Capture
|
||||
agent ▸ *Run the agent as administrator* shows what it adds (measuring a game that itself runs as administrator; the CPU
|
||||
temperature where PawnIO is installed), what it does not change (a game with anti-cheat is still refused; a Vulkan game
|
||||
run as administrator is still not measured) and the risk of a per-user, unsigned install, before it turns on. Then
|
||||
**Windows asks every time the agent starts** — also at logon, when its prompt may wait on the taskbar; there is no
|
||||
silent way. Answer No and the agent runs with your standard rights and says so; answer with another administrator
|
||||
account and that agent refuses to run, because its data would not be yours. **Games you start from FrameLedger always
|
||||
run with your standard rights**, and nothing FrameLedger does enables a privilege (a CI test on an elevated runner and a
|
||||
source check hold both). While the prompt waits, the status pill says so. With the option off, an App started as
|
||||
administrator no longer makes the agent an administrator's too. Updating now also waits for an administrator agent's
|
||||
process to let go of its files.
|
||||
|
||||
- **What FrameLedger cannot do, in one place** (beta.10). `LIMITATIONS.md` lists the limits of the whole software in
|
||||
plain words — the games it will not measure, what an unmeasured session holds, frame generation, upscaling and ray
|
||||
tracing, the display mode, the engine version, sensors, the admin mode, the platform and your data — each linked to its
|
||||
details; the app shows it under **Help ▸ Limitations**. `docs/LIST_GAME_TESTED.md` lists the real games FrameLedger has
|
||||
been run with and what was measured on each.
|
||||
|
||||
### Changed
|
||||
|
||||
- **The legal documents say what beta.10 does** — you will be shown two of them again once. **Privacy Policy 2.5** adds
|
||||
how a tracked game's window is shown (read from Windows) and the engine version read from an Unreal Engine game's
|
||||
executable, and says for the first time two things the software already did: it reads the content of a library game's
|
||||
executable (engine and library markers, its import table) and the processor load and memory in use. **Disclaimer 2.8**
|
||||
adds §5A — running the capture agent as administrator, what it does and does not do, and its risk — and points at the
|
||||
new limitations page and the tested-games list. The End-User License Agreement is unchanged (1.3).
|
||||
|
||||
- **Groundwork for the display mode (beta.10): the injected component reports how the game presents** — whether its swap
|
||||
chain is in exclusive fullscreen, which window it presents to, its back buffer and swap effect — at most twice a second,
|
||||
from two getters on the swap chain the game passed (measured at 13–15 ns each on the test fixture: nothing a frame rate
|
||||
can see). The shared-memory layout moves to version 4 (a new region; the frame ring moved behind it): **a game that is
|
||||
running while FrameLedger is updated must be restarted before it can be measured**, which the app already says when it
|
||||
meets an old layout. What the app shows from it is the display mode under *Added*.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **An Unreal game's engine version was a bare "4" or "5"** — and for most titles nothing at all. The rule's pattern had two
|
||||
capture groups and the evaluator keeps the first, and it read only a version string most executables leave empty.
|
||||
Schema 0015 removes the digits the old rule wrote (only where detection wrote them — a version you typed stays), and the
|
||||
rules validator now refuses any version pattern that does not compile or that captures anything but exactly one group.
|
||||
|
||||
- **A Direct3D 12 game that resized through `ResizeBuffers1` kept its old output size in every later frame.** That call is
|
||||
not hooked; the swap chain's size is now re-read twice a second, so a resize by either route is seen.
|
||||
|
||||
@@ -0,0 +1,94 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.11] - 2026-10-03
|
||||
|
||||
**The eleventh pre-release: a user-mode anti-cheat exception that can be reached, a library that fills the window, and
|
||||
charts and clean-up across a game's sessions.** The same unsigned installer: verify its hash against `SHA256SUMS.txt`,
|
||||
then *More info → Run anyway*. What changed for a user:
|
||||
|
||||
- **The user-mode anti-cheat exception no longer needs earlier sessions.** A game blocked the moment it was added could
|
||||
never qualify; now its first two sessions under the exception are a trial, and one that does not go well ends the
|
||||
exception for good. Everything else it requires is unchanged, and a ban remains possible.
|
||||
- **The Games library** fills the window at any width, can be shown as a list, counts its games and has **Refresh**: it
|
||||
reads the library again, offers the games your stores installed since, and marks games whose executable is gone.
|
||||
- **Import** hides the games already in the library — you can show them, dimmed.
|
||||
- **Delete all sessions** — of one game on its page, or of every game in Settings ▸ Data.
|
||||
- **Charts across a game's sessions**: *Sessions at a glance* on the Sessions tab, and the Trend draws more metrics at once.
|
||||
- **Settings** has no row without a control.
|
||||
- **Three CrackProof games** are on the anti-cheat list (Umamusume: Pretty Derby, Heaven Burns Red, Madoka Magica Magia
|
||||
Exedra).
|
||||
- **The Disclaimer (2.9) and the EULA (1.4) say how the exception works now**, so the Legal Gate opens once after the
|
||||
update. The Privacy Policy is unchanged.
|
||||
|
||||
**Updating from `0.1.0-beta.10`:**
|
||||
|
||||
- Quit the App (tray icon → Exit) and end `FrameLedger.Agent.exe` before running the installer.
|
||||
- Schema 0017 adds one column; the database opens in place, and an older version cannot open it again.
|
||||
- Every game is re-checked once for anti-cheat (rules `2026.10.1`).
|
||||
- An exception made under beta.9 or beta.10 stays in force; if fewer than two sessions were played under it, the rest of
|
||||
its trial applies.
|
||||
|
||||
### Added
|
||||
|
||||
- **The Games library fills the window, switches to a list, counts its games and refreshes** (owner requests, beta.11).
|
||||
The cards were 300 px in a plain wrap, so a wide window left up to a card's width empty at the right and the third pill
|
||||
("Hooking off") was cut; the grid now has as many columns as fit at 300 px or wider, every card an equal share of the
|
||||
width, and the pills wrap. A button beside the sort switches to a **list** — one row per game with its store, engine,
|
||||
status, sessions, playtime and last played — and the choice is remembered (`ui.library_view`). The title counts the
|
||||
games. **Refresh** reads the library again, looks in the stores for games installed since and offers only those (*No
|
||||
new games* when there are none), and marks every entry whose executable is gone **Not installed** — the tooltip says
|
||||
when it is the drive that is not connected; nothing is removed. The page also reloads by itself when a session ends or
|
||||
an import adds games while it is open (an import made from the menu used to show only after leaving the page).
|
||||
|
||||
- **Import hides the games already in the library** (owner request, beta.11): on a re-import they were most of the list
|
||||
and pushed the new ones out of sight. *Show the N games already in the library* brings them back, dimmed, and a row
|
||||
that cannot be imported has its box disabled (a tick on it was taken and ignored).
|
||||
|
||||
- **Delete all sessions** (owner decision D40, beta.11): on a game's page, every session of that game; in Settings ▸
|
||||
**Data**, every session of every game — with their frame and sensor data and notes, after a confirmation that says how
|
||||
many. The library, the settings and every game's hooking consent stay. The capture agent deletes them (the rows are its)
|
||||
and refuses while a session is being recorded; an older agent is told to restart. A summary window still open on a
|
||||
deleted session closes. A new pipe request, `DeleteSessions`.
|
||||
|
||||
- **Charts across a game's sessions** (owner decision D39, beta.11): the Sessions tab opens with *Sessions at a glance* —
|
||||
every hooked session's frame rate (Presented FPS, or Native and Displayed where frame generation was measured, never one
|
||||
inflated line) and its 1% and 0.1% lows, oldest first; click a point to select that session. The Trend keeps its metric
|
||||
and can **draw more beside it** (*Also draw*), a second unit against the right axis, two units at most.
|
||||
|
||||
- **Three CrackProof titles on the anti-cheat title list** (owner request, beta.11): Umamusume: Pretty Derby (Steam
|
||||
`3224770`), Heaven Burns Red (`1973710`) and Madoka Magica Magia Exedra (`2987800`). Each store page states *"Uses
|
||||
Kernel Level Anti-Cheat"* and names HyperTech's CrackProof; its driver loads from `System32` under a numbered name,
|
||||
outside the game's folder, so nothing of the game's own can name it and the list does, by Steam id only (no executable
|
||||
name was verified). ANOTHER EDEN, which a community list also names, is left out: its store page says nothing of the
|
||||
kind. Rules `2026.10.1` — every game is re-checked once, and these games' hooking is turned off like any title-list
|
||||
finding, never under a user-mode exception (`19_SAFETY` check 3).
|
||||
|
||||
### Changed
|
||||
|
||||
- **The user-mode anti-cheat exception no longer needs sessions measured before it — its first two sessions are a
|
||||
trial** (owner decision D38, beta.11). D33 asked for two successful hooked sessions before a grant, but since beta.8 a
|
||||
game is blocked the moment it is added, so a blocked game could never earn them, and a reset ledger lost the ones it
|
||||
had: after the owner deleted theirs, GIRLS' FRONTLINE 2 read *"Not eligible: 0 successful hooked session(s), two are
|
||||
needed"* for good. A grant now needs no session. Until two sessions under it have succeeded, the game page says
|
||||
*trial: N of 2*, and any end during the trial — a crash, a safety unhook, the Overlay's own stop, a new finding, or a
|
||||
stored hooked session that recorded no frame or did not end normally — ends the exception **for good** (schema 0017,
|
||||
`games.ac_exception_trial_failed_at`, set once and never cleared; the Agent refuses a grant with `TrialFailed` and the
|
||||
store refuses one in SQL; a twin merge keeps the mark). Every other condition is unchanged — one user-mode family, no
|
||||
`.sys` in the game's folder, no title list — and after the trial an end is what it was. The disclosure is
|
||||
`ac-exception-dialog/2`: it names no session count and has a *Trial* paragraph (`ja` stays English until reviewed).
|
||||
**Legal text:** Disclaimer 2.9 (§2A) and EULA 1.4, so the Legal Gate opens once; the accuracy block, `SECURITY.md` and
|
||||
`LIMITATIONS.md` say the same; CLAUDE.md rule 2 carries the amendment (`19_SAFETY` §The user-mode exception).
|
||||
|
||||
### Fixed
|
||||
|
||||
- **Settings has no row without a control** (owner request, beta.11): *Games with hooking on* shows only while a game has
|
||||
hooking on, the *Elevation* row became the admin mode row's status line, and the note under the language row is gone.
|
||||
The retention message now names Settings ▸ Recording, where retention lives.
|
||||
|
||||
- **The exception's card and list say what is true** (found with D38): an eligible game's *Anti-cheat* card said hooking
|
||||
"cannot be turned on" beside a usable *Make exception…* — it now says hooking is off unless you make one; the Settings
|
||||
list showed each game's session count twice and listed games that could never qualify, with no action — it lists only
|
||||
games it can act on; a tolerant scan that found nothing of the family was said as "the check could not finish" — it
|
||||
says the family was not found; and a blocked game whose executable could not be read stayed *Checking…* for ever — the
|
||||
sweep now answers it. **Refresh** shows only while a row is being checked, the one time it can change anything.
|
||||
|
||||
@@ -0,0 +1,153 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.12] - 2026-10-04
|
||||
|
||||
**The twelfth pre-release: how much memory each game itself uses, documents you can read, and a user guide.** The same
|
||||
unsigned installer: verify its hash against `SHA256SUMS.txt`, then *More info → Run anyway*. What changed for a user:
|
||||
|
||||
- **The game's own memory, in every session** — its video memory and its RAM, the figures Task Manager's Details tab
|
||||
shows for the game's process, read once a second from outside the game, whether or not the game is hooked. The
|
||||
session summary shows the median and the peak, the Sessions tab has two new columns, the Trend and Compare have the
|
||||
memory metrics, the Sensors charts draw this game's memory beside the whole graphics card's and the whole PC's, and
|
||||
the Dashboard shows it live.
|
||||
- **Statistics per series**: every sensor's mean, median, minimum and peak, at the bottom of a session's summary.
|
||||
- **Documents are rendered**, not shown as raw text: the first-start documents, Help ▸ Limitations, the update notes,
|
||||
and a new **Help ▸ About** with the program's legal notices, the third-party licences and the legal documents.
|
||||
- **A user guide** — eight short pages, under **Help ▸ User guide**.
|
||||
- **The GPL is no longer something you accept**: it is your licence, shown for information. You accept the EULA (now
|
||||
1.5), the Disclaimer (2.10) and the Privacy Policy (2.6), so the first-start window opens once after the update.
|
||||
- Links to the project's documents open the version you run, not the newest one.
|
||||
- **The Logs page's Warning and Error filters show the Agent's lines** too; they showed only the App's.
|
||||
- **Settings no longer has "Record games launched outside FrameLedger"**: the switch never did anything.
|
||||
|
||||
**Updating from `0.1.0-beta.11`:**
|
||||
|
||||
- Quit the App (tray icon → Exit) and end `FrameLedger.Agent.exe` before running the installer.
|
||||
- Schema 0018 adds the memory columns; the database opens in place, and an older version cannot open it again.
|
||||
- Sessions recorded before this version have no memory figures and no per-series statistics: they read N/A, and the
|
||||
summary says so.
|
||||
- The new `FrameLedger.ProcessStats.dll` is installed beside the Agent; without it the memory figures read N/A.
|
||||
|
||||
### Added
|
||||
|
||||
- **The game's own memory, measured from outside the game, in every session** (owner decision D43, beta.12). A new
|
||||
C++ library loaded by the Agent — never into a game — `FrameLedger.ProcessStats.dll`, reads once a second the game
|
||||
process's **dedicated and shared GPU memory** (the documented `GPU Process Memory` performance counters, which need no
|
||||
handle to the game) and its **private working set, working set and commit** (`GetProcessMemoryInfo` with
|
||||
`PROCESS_QUERY_LIMITED_INFORMATION` only) — the numbers Task Manager's Details tab shows. A hooked game is read through
|
||||
the handle the session already holds; a game that is not measured (anti-cheat, hooking off) through a handle opened for
|
||||
the read and closed after it, the same least right the watcher already uses on every process, every process running its
|
||||
executable added up, a reused pid refused. Measured before it was written in (`spike-notes` §16): a 512 MiB allocation
|
||||
read +512.0 MiB, the private working set equals Windows' own counter, one read costs 0.1 ms, 600 reads leak nothing.
|
||||
Stored as five new sensor series and, in schema **0018**, the median / mean / peak columns
|
||||
(`game_vram_dedicated_*`, `game_ram_private_*`, …), the process count, the sources, and every sensor series'
|
||||
n / mean / median / min / max in `sensor_stats_json`; carried live to the Dashboard (`SessionProgress`, `SessionHeld`)
|
||||
and through the crash-recovery file (a new chunk type; beta.11's files still recover). The video-memory **budget** is
|
||||
still not measured (`20_OPEN_QUESTIONS` §M11). The App shows all of it (below).
|
||||
- **Sensor statistics have a median and a minimum** beside the mean and the maximum (`SeriesAggregates`).
|
||||
- **The App shows the game's own memory everywhere a session is** (D43, beta.12), in Task Manager's units — MB below
|
||||
1 GB, GB to two decimals, 1 GB = 1024 MB. The **session summary** has two new cards, *VRAM (this game)* and *RAM (this
|
||||
game)*: the median, with the peak (and the shared GPU memory's or the commit's peak) beneath, and a new table,
|
||||
**Statistics per series** — every series' mean, median, minimum, peak and number of readings, each in its own unit, as
|
||||
stored when the session ended. The **Sessions** tab has *VRAM (game)* and *RAM (game)* columns (median · peak, the rest
|
||||
in the tooltip); the **Trend** has *Median / Peak VRAM (game)* and *Median / Peak RAM (game)*; **Compare** has the same
|
||||
four rows; the **Sensors** charts draw *Video memory* (this game's dedicated and shared beside the whole graphics card's)
|
||||
and *Memory* (this game's private working set beside the whole PC's) in GB; the **live card** reads "This game: VRAM …
|
||||
· RAM …", for a game that is not measured too; and the CSV export has a `# game_memory:` header line. Where Windows does
|
||||
not report the private working set (before the September 2023 update) the working set is shown in its place and says
|
||||
so. A session recorded before beta.12 reads N/A, and its summary says the statistics table did not exist yet.
|
||||
- **Documents are shown rendered, not as raw Markdown** (owner request 4, beta.12): the Legal Gate, Help ▸ Limitations,
|
||||
the update notes and the new About window draw headings, lists, tables, code and links (Markdig 1.4.0, BSD-2-Clause;
|
||||
HTML in a document is shown as text and no image is fetched). The GPL is shown as written. Selectable and copyable;
|
||||
links open in the browser, scroll to a section, or open another document the window holds; a `file:` or
|
||||
`javascript:` link is never followed. **Help ▸ About** is a window with three tabs: the program's legal notices
|
||||
(copyright, no warranty, the licence with the NOTICE terms, this version's source code), the third-party licences
|
||||
with every shipped package's version and a button that opens the licences folder, and the legal documents (EULA,
|
||||
GPL, Disclaimer, Privacy Policy, NOTICE, Trademarks). Help ▸ Limitations is a window of its own.
|
||||
- **Links into the repository open the documents of the version you run**: a release stamps its tag into the App
|
||||
(`-p:FrameLedgerSourceRef`), so *View on GitHub*, the safety document and every document link go to that tag rather
|
||||
than to `main`, where the text may have changed since.
|
||||
- **A user guide** (owner decision D44, beta.12): eight short pages for players — install and first start, record a
|
||||
game, read your results, anti-cheat and safety, your data, questions and answers, and the terms in plain words — in
|
||||
the app under **Help ▸ User guide** (the first item of the Help menu) and in the repository's `guide/` folder. The
|
||||
README now opens with a pointer to it and keeps a separate section for developers and forks.
|
||||
- **`NOTICE`, and the licence header in every source file** (owner decision D45, beta.12). FrameLedger's own material is
|
||||
GPL-3.0-only with three additional terms of the kinds GPLv3 §7 permits: keep the copyright line and the attribution in
|
||||
the program's legal notices (b), mark a modified version as different and do not call it "FrameLedger" alone (c), and
|
||||
no trademark rights in the name (e). Section 7 wants such terms named in the source files themselves, so every
|
||||
first-party `.cs`, `.cpp`, `.h`, `.inl`, `.ps1` and `.xaml` file now opens with an `SPDX-License-Identifier:
|
||||
GPL-3.0-only` line and a line pointing at `NOTICE` (1,053 files; `src/native/third_party/` excluded). A new gate,
|
||||
`tools/notice-check.ps1` (six self-test cases, both directions; `-Fix` writes a missing header), keeps it true, and
|
||||
`tools/resx-gen.ps1` generates the string accessors with it. `NOTICE` ships in every package as
|
||||
`licenses\NOTICE.txt`, and `release.yml` refuses a published tree without it.
|
||||
- **For people who build, contribute or redistribute:** `CONTRIBUTING.md` (the gate, the definition of done, what will
|
||||
not be merged, and that a contribution is licensed GPL-3.0-only with the `NOTICE` terms — no CLA), `FORKING.md` (what
|
||||
the GPL asks of someone who distributes builds, and the names a fork must change so that it does not share
|
||||
FrameLedger's update feed, install folder, database, pipe, shared memory or Vulkan layer), `CODE_OF_CONDUCT.md` (the
|
||||
Contributor Covenant 2.1, adopted by reference) and `legal/TRADEMARKS.md` (third-party names, no affiliation, and how
|
||||
the name FrameLedger may be used).
|
||||
|
||||
### Changed
|
||||
|
||||
- **The GPL is no longer accepted at the first start** (owner decision D45): it is your licence to FrameLedger and is
|
||||
shown beside the documents for information — GPLv3 §9 needs no acceptance to run the program. **Accept** covers the
|
||||
End User License Agreement, the Disclaimer and the Privacy Policy; a row an earlier version wrote for the GPL stays,
|
||||
unread.
|
||||
- **The documents you accept change, and are shown again once:** **EULA 1.5** (an unmeasured session also records the
|
||||
game's own memory use; the GPL needs no acceptance; where the third-party notices are in an installed copy; your
|
||||
rights as a consumer that no agreement can limit, and severability), **Disclaimer 2.10** (what it reads about a game
|
||||
from outside it: the game's memory use, opened with the least access Windows offers; §2 names everything the thread
|
||||
it runs inside the game does, which it understated; the maintainers' preface moves to
|
||||
`docs/legal-drift-history.md`), **Privacy Policy 2.6** (the game's memory use, replacing a video-memory figure the
|
||||
software never read; a new §3A on what an export or a bug report can carry about you before you share it; the version
|
||||
history notes move to `docs/legal-drift-history.md`).
|
||||
- **Help ▸ Documentation is Help ▸ Online documentation**, and opens the README of the version you run.
|
||||
|
||||
### Removed
|
||||
|
||||
- **Settings ▸ Recording no longer shows "Record games launched outside FrameLedger".** Nothing ever read that switch —
|
||||
turning it off recorded every game anyway — and the App has no way to start a game itself, so "off" could only have
|
||||
meant recording nothing. Its stored value is kept, unread, until a launch path exists.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **The Logs page's Warning and Error filters showed no line from the Agent.** The Agent's log starts each line with a
|
||||
date (Serilog's default form) and the filter read only the App's `[HH:mm:ss.fff LVL]` prefix; its test had fed App-form
|
||||
lines into the fake Agent log. Both forms are read now.
|
||||
- **The developer documentation is corrected in place** (owner decision D46): about a hundred statements across
|
||||
`docs/01`–`20`, `HANDOFF`, `CLAUDE.md` and `FORKING.md` that the code contradicted, each struck with a dated
|
||||
correction — among them a rules feed that does not exist (rules reach you with a release, as `LIMITATIONS.md` says),
|
||||
hooks that were never built, the in-game thread described as doing less than it does, a delta update package that was
|
||||
never published, the release steps for a pre-release, the Legal Gate's row count and the logging configuration. The
|
||||
rules file's own comment and the rules workflow's header made the feed claim too, and are corrected. `docs/README.md`
|
||||
is a new index for developers. Code comments that said what is not so (a sparkline, a flyout, a layer flag "false by
|
||||
construction", two self-test counts) are corrected with them.
|
||||
- **The first start's summary said "there is no way to override that refusal"** although a per-game user-mode exception
|
||||
has existed since beta.9, and **"Nothing is sent anywhere"** although the update check is a request to GitHub; it now
|
||||
names the exception and the one request. The README's safety table still said an exception needed two earlier
|
||||
successful sessions — the rule until beta.11 (D38) made them a trial — and its feature list promised "per-process VRAM
|
||||
and whether the driver was exceeding its budget"; both now say what the software does. The tier tooltip names the
|
||||
game's memory beside the duration and the sensors.
|
||||
- **The Legal Gate showed the documents as raw Markdown** (`**bold**`, `| --- |`) in a text box, and Help ▸ Limitations
|
||||
and the update notes the same; they are rendered now (above). The Legal Gate's *View on GitHub* went around the App's
|
||||
link opener; it goes through it.
|
||||
- **The third-party notices' component table did not render as a table** in a Markdown renderer that follows the spec
|
||||
strictly: a note line sat between its rows. The note is moved below the table, unchanged.
|
||||
- **"Max VRAM (game)" on the Trend never had a point, the live card's VRAM was always empty, and the Sensors chart's
|
||||
"VRAM used by this game" line was never drawn**: all three read the Overlay's in-game per-present figure, which nothing
|
||||
ever produced. They read the game's memory measured from outside it now (above), and the CSV's note no longer calls
|
||||
the always-empty `vram_mb` column "a held 1 Hz sample".
|
||||
- **"Avg RAM in use" on the Trend is labelled as the whole PC's**, in GB like every other memory figure, so it is not
|
||||
read as the game's.
|
||||
- **A licence header written by a contributor no longer has to name poli0981**: `tools/notice-check.ps1` accepts any
|
||||
holder and year in the same form (`Copyright (C) <year> <holder> - additional terms under GPLv3 section 7: see NOTICE`),
|
||||
and `CONTRIBUTING.md` says so; seven self-test cases.
|
||||
- **Documents that described a per-process VRAM figure the Overlay never produced** are corrected in place
|
||||
(`03_METRICS`, `17_HOOK_ENGINE`, `18_GPU_VENDOR_APIS`, `20_OPEN_QUESTIONS` §M7/§H10), and the two that said an unmeasured
|
||||
session opens no process (`04_CAPTURE`, `19_SAFETY`) now say what it opens, with which right, and why. The accuracy block
|
||||
and `LIMITATIONS.md` say what is measured now. `ITelemetryPoller`'s remark that the descriptor is read at finalize — it is
|
||||
read at session start — is corrected.
|
||||
- **The native binaries' version block named the wrong licence.** Every DLL's `LegalCopyright` read
|
||||
`GPL-3.0-or-later` while `LICENSE`, the EULA, the README and the third-party notices all say GPL-3.0-only; it now reads
|
||||
`Copyright (C) 2026 poli0981. GPL-3.0-only with additional terms: see NOTICE`.
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.13] - 2026-10-04
|
||||
|
||||
**The thirteenth pre-release: refusal notices that say where the anti-cheat is, GPU sensors that follow the game's graphics
|
||||
card, and smaller updates.** The same unsigned installer: verify its hash against `SHA256SUMS.txt`, then *More info → Run
|
||||
anyway*. What changed for a user:
|
||||
|
||||
- **An anti-cheat driver or service running on the PC is said as that.** While, for example, Easy Anti-Cheat's service
|
||||
runs for another game, FrameLedger hooks no game at all; the notice used to say the anti-cheat "was detected in this
|
||||
game", naming a game that may not even use it. It now says the anti-cheat is running on this PC, and the session's
|
||||
summary says the same. A finding in the game itself still says "in this game".
|
||||
- **The notice for a capture stopped mid-game** no longer promises that FrameLedger will hook the game again "when you
|
||||
enable it again" — which was not true either way. It says where the anti-cheat was found and whether hooking was
|
||||
turned off.
|
||||
- **On a PC with more than one graphics card**, the GPU figures follow the card the game draws on once it has shown its
|
||||
first frame, instead of the first card Windows lists (often a laptop's integrated GPU). Not yet tested on such a PC.
|
||||
- **Updates download only what changed**: this release carries a delta package against `0.1.0-beta.12`, so updating
|
||||
from it through the App downloads a fraction of the full ~107 MB.
|
||||
|
||||
**Updating from `0.1.0-beta.12`:**
|
||||
|
||||
- Help ▸ Check for updates downloads the delta; or quit the App (tray icon → Exit), end `FrameLedger.Agent.exe` and
|
||||
run the installer as before.
|
||||
- No database change, and no document to accept again.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **A refusal because of a driver or service said the anti-cheat "was detected in this game".** The guard's checks for
|
||||
drivers and services are machine-wide: while Easy Anti-Cheat's service runs for another title, every game is refused,
|
||||
and the notice named a game the user may not even own. It now says the anti-cheat is running on this PC — a driver or
|
||||
service that may belong to another game or program — and the session summary says the same; a finding in the game
|
||||
itself still says "in this game" (`20_OPEN_QUESTIONS` §S23-3, closed). The Agent's refusal and unhook events carry the
|
||||
guard's own reason for this (`guardReason`, additive).
|
||||
- **The notice for a mid-session stop promised "FrameLedger will not inject into this game again until you enable it
|
||||
again"**, untrue both ways since beta.5: a driver or service that starts on the PC turns no hooking off, and a finding
|
||||
in the game turns it off for good. It says where the finding was, and whether hooking was turned off.
|
||||
- **On a PC with more than one graphics card, the GPU sensors could describe a card the game was not using.** The
|
||||
adapter the game draws on is now followed once it has shown its first frame: the DXGI layer switches to it,
|
||||
LibreHardwareMonitor reads that brand's GPU rather than the first one it lists (often a laptop's integrated GPU), and
|
||||
NVAPI says nothing when the game runs on an AMD or Intel card — N/A rather than another card's temperature.
|
||||
`LIMITATIONS.md` says what still describes the first card.
|
||||
- **Updates download only what changed**, from this release on: each release now carries a Velopack delta package
|
||||
against the previous one beside the full package, and an installed copy one release behind downloads the delta. No
|
||||
earlier release had one — every update so far downloaded the whole ~107 MB package — so the first update that can use
|
||||
a delta is from `0.1.0-beta.12` to this one; Velopack falls back to the full package whenever the delta does not apply.
|
||||
- **Tests that change the App's language ran beside tests that read its text**, so the second kind could read the
|
||||
wrong language once in many runs; the language-changing tests now run on their own.
|
||||
|
||||
@@ -0,0 +1,117 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.14] - 2026-10-06
|
||||
|
||||
**The fourteenth pre-release: a wheel that scrolls, updates that find this channel and wait for your games, crashes told
|
||||
apart from memory reports, and new measurements.** The same unsigned installer: verify its hash against
|
||||
`SHA256SUMS.txt`, then *More info → Run anyway*. What changed for a user:
|
||||
|
||||
- **The mouse wheel scrolls every page, dialog and chart**; over a chart the wheel scrolls the page and **Ctrl+wheel**
|
||||
zooms the chart. **Settings ▸ Window ▸ Hide scroll bars** draws no bar and still scrolls. The import list is readable
|
||||
in the dark theme.
|
||||
- **Updates come from the channel of the copy you run** — a beta looks for betas — and are never applied on their own
|
||||
when the App starts; restarting to update waits while a game FrameLedger measured is still running, and says so.
|
||||
- **A game that crashed reads *crashed*, and only then**: a Windows memory report about a game no longer counts as a
|
||||
crash, and an Unreal Engine game that opens its crash reporter and closes is recorded as crashed, the reporter named.
|
||||
- **A game starting up or closing during FrameLedger's anti-cheat check** is read again once instead of refused, and a
|
||||
check that could not read a game that had already closed ends the session as the game's own exit.
|
||||
- **New in every session's summary**: time below 30 and 60 FPS and below the monitor's refresh rate, how even the frames
|
||||
were, VSync and tearing, the graphics card's clocks, fan and memory temperature, how much of the time its power limit
|
||||
or heat held it back (NVIDIA), frames per watt, and a render scale chart. Trend and Compare have them too.
|
||||
- **FrameLedger's own programs say what they are** in Explorer and Task Manager (*FrameLedger Agent*).
|
||||
|
||||
**Updating from `0.1.0-beta.13`:**
|
||||
|
||||
1. **First choose *Beta* in Settings ▸ Updates.** beta.13 looks for stable releases by default, and every release so far
|
||||
is a pre-release, so it finds nothing until you do. From beta.14 on the channel follows the copy you run.
|
||||
2. **Update with no game running.** beta.13 still applies a downloaded update the next time the App starts, stopping the
|
||||
Agent to do it; beta.14 no longer does.
|
||||
3. **The database is migrated in place** (schema 0019, new columns only). An earlier version cannot open it afterwards.
|
||||
4. Sessions already stored keep their status — a few may still read *crashed* because Windows logged a memory report
|
||||
about the game. The Privacy Policy (version 2.7) is shown once for you to accept.
|
||||
|
||||
### Added
|
||||
|
||||
- **Settings ▸ Window ▸ Hide scroll bars.** No scroll bar is drawn anywhere in the app while it is on, and everything
|
||||
still scrolls with the mouse wheel, the keyboard and touch. Off by default; it applies at once, to the open windows
|
||||
too, and off brings every bar back.
|
||||
- **New measurements in every session** (recorded from this version on; earlier sessions read N/A):
|
||||
- **time below 30 FPS, below 60 FPS and below the monitor's refresh rate**, and how much one frame's time differs from
|
||||
the next. A game held at its frame limit is not counted as dropping below it for the small wobble every frame limit
|
||||
has — on the developer's machine a game capped at 60 read half its time "below 60" by the plain rule;
|
||||
- **VSync and tearing**: how many of the game's frames asked to wait for the display, and how many allowed tearing
|
||||
(Direct3D games);
|
||||
- **the graphics card's clock speeds, fan speed and memory temperature**, and — on NVIDIA cards — how much of the time
|
||||
its power limit or its temperature held it back;
|
||||
- **frames per watt**: the game's own frames per second for each watt the graphics card drew, never counting generated
|
||||
frames.
|
||||
|
||||
The session's sensor statistics table shows the new card readings in their own units. The database is migrated in
|
||||
place (schema 0019), and an earlier version cannot open it afterwards.
|
||||
- **Where the new measurements are shown:** the session summary has a card for each (the 1% low card also shows the
|
||||
displayed frames' 1% low when frame generation was counted, beside the game's own), a **Render scale** chart — the
|
||||
share of the screen's resolution the game rendered at, over the session — and a **Clocks and fan** chart under
|
||||
Sensors, with the moments the card was held back shaded; the card's memory temperature joins the temperatures chart.
|
||||
A game's **Trend** has nine more metrics and **Compare** nine more rows, where a figure taken over presents says
|
||||
*(presented)* beside one taken over the game's own frames. The **Latency** tab is shown only for a game with a session
|
||||
that measured latency — none does yet.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **A session could read "crashed" when the game had not crashed, and an Unreal game's crash read "ended normally".**
|
||||
Any Windows report that named the game counted as a crash — on the developer's machine a memory-leak report Windows
|
||||
writes about large games marked an ordinary The Witcher 3 session *crashed*; hang reports and another program whose
|
||||
name contains the game's would have done the same. Only a crash report of this game's own process counts now. And
|
||||
Unreal Engine games handle their own crash: they open their crash reporter and exit with code 3, which said nothing;
|
||||
FrameLedger now sees the crash reporter a game starts (Unreal's, CD PROJEKT RED's, Capcom's, BugSplat's) and records
|
||||
the session as crashed when the game exits within a minute of it — the summary names the reporter. Unity's and
|
||||
Chromium's crash handlers start with their game and are never taken for a crash. Sessions already stored keep their
|
||||
status. BugSplat's sender (Kingdom Come: Deliverance II) can no longer be picked as a game's executable by the import.
|
||||
The Privacy Policy (2.7) now says that FrameLedger reads Windows' crash reports and the names of programs a game starts.
|
||||
- **A game that exited as FrameLedger's anti-cheat check ran could be recorded as "unhooked (safety)"** — and, under a
|
||||
user-mode anti-cheat exception, end the exception's trial for good. The check reads every process in the game's
|
||||
tree every 30 s; one that was just starting (an engine's crash reporter as its game dies, any helper the game launched
|
||||
a moment before) or already gone could not be read, and the check refused. Such a process is now read once more a
|
||||
quarter of a second later, and refused only if it is still unreadable (a protected process never gets the second
|
||||
look). And when the check could not read and the game itself has exited, the session ends as that exit, normal or
|
||||
crashed by its exit code. Anything the check *finds* is a refusal exactly as before (owner decision D48).
|
||||
- **An installed copy never found an update unless you had changed its channel.** The update channel was *Stable* by
|
||||
default and every FrameLedger release so far is a pre-release, so the check found nothing. The channel is now
|
||||
*Automatic*: a pre-release looks for pre-releases and a release for releases; choosing *Stable* or *Beta* still decides.
|
||||
- **A downloaded update was applied the next time FrameLedger started, before anything could check for a running game.**
|
||||
The update library applies a waiting package at start unless told not to, and nothing told it: it stopped the capture
|
||||
agent mid-session instead of letting it finish. The App now offers such a package as *Restart to update*, which waits
|
||||
for the session to end and stops the agent properly, as it always did for a download in the same run.
|
||||
- **The update dialog said ~102 MB when the download was the 1.6 MB delta.** It now says the delta's size and names the
|
||||
full package as the fallback; the updater's own lines are in the App's log, so a full download shows there.
|
||||
- **Restart to update could fail half way** when a game FrameLedger had measured was still running — its loaded overlay
|
||||
cannot be replaced — or when an agent was still waiting on the administrator prompt, and it gave the agent 10 s to stop
|
||||
where the agent takes up to 15. It waits for all three now and says why. A full disk no longer reads as "offline",
|
||||
and uninstalling removes the *Start FrameLedger with Windows* entry.
|
||||
- **The import list was unreadable in the dark theme.** File ▸ Import library (and Games ▸ Refresh) drew every row white
|
||||
with white text, and each tick box as a sliver at the row's edge: a row style added in beta.11 to dim the games already
|
||||
in the library fell through to Windows' own row, which is white in every theme, and WPF UI's check box is too wide for
|
||||
its 40 px column. The rows take the theme's colours again and the boxes are whole, and the list is the one thing in the
|
||||
dialog that scrolls — its intro and the count under it stay in view, where a list scrolling inside a scrolling dialog
|
||||
used to carry the intro away. Compare's session picker draws the theme's check boxes too (it drew Windows' old ones).
|
||||
- **The mouse wheel scrolled nothing on the Dashboard, Games, a game's page, Compare and Settings** — only dragging the
|
||||
scroll bar did. WPF UI wraps a page in a scroller of its own unless the page says otherwise, and inside it each page's
|
||||
own scroller had nothing to scroll and still took every wheel. Every page scrolls itself now. The Logs page had the same
|
||||
cause: its tail grew to hold every line and never followed the newest one, as it was meant to. A scroller inside a
|
||||
dialog (the consent, administrator, anti-cheat exception and bug report dialogs) hands the wheel on at its ends.
|
||||
- **The chart-wheel test read the real keyboard** (developers): a Ctrl held anywhere on the machine while the test ran
|
||||
turned its plain wheel into a zoom, and a local gate went red once. The keys held are now the test's own input, and the
|
||||
Ctrl+wheel half is driven end to end as well.
|
||||
|
||||
### Changed
|
||||
|
||||
- **Over a chart, the wheel scrolls the page; Ctrl+wheel zooms the chart.** ScottPlot zoomed on every wheel, which with
|
||||
the pages scrolling again would have zoomed the chart and scrolled the page at once. Dragging still pans and
|
||||
double-click still resets.
|
||||
- **FrameLedger's own programs say what they are.** In Explorer (*Properties ▸ Details*) `FrameLedger.exe` and
|
||||
`FrameLedger.Agent.exe` now name the product, the author's copyright and what each one does, as the native DLLs always
|
||||
have; Task Manager lists the background service as *FrameLedger Agent* rather than *FrameLedger.Agent*. Until this
|
||||
release the Agent called its company and product "FrameLedger.Agent" and no managed file carried a copyright. The
|
||||
release check now reads both kinds of file and fails when one of them does not name FrameLedger or carries a different
|
||||
copyright line.
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.15] - 2026-10-06
|
||||
|
||||
**The fifteenth pre-release: a quick restart recorded, an anti-cheat check that stays on the game's own programs, a
|
||||
change of language that reaches every list, and a launcher followed to its game.** The same unsigned installer: verify
|
||||
its hash against `SHA256SUMS.txt`, then *More info → Run anyway*. What changed for a user:
|
||||
|
||||
- **A game started again a few seconds after closing is recorded** — while the session before it was being saved, the
|
||||
new start used to be turned away and never looked at again.
|
||||
- **The anti-cheat check stays on the game's own programs.** Windows reuses process numbers, and a program that had
|
||||
taken over the number of a game's closed launcher could be scanned as part of the game — refusing the session, or
|
||||
turning the game's measuring off. It no longer is.
|
||||
- **A change of language reaches every list at once** — the theme and update-channel lists, the Logs page, the Games
|
||||
sort order, the tray's menu and the Agent's status — without a restart.
|
||||
- **A game started through its launcher is followed to the game itself** (the Agent's console `launch`).
|
||||
- **`FrameLedger.exe --data-dir <folder>` opens a copy of a data folder to look at**, with no Agent and nothing on the PC
|
||||
changed.
|
||||
|
||||
**Updating from `0.1.0-beta.14`:** Help ▸ Check for updates, then *Restart to update* with no game running — FrameLedger
|
||||
stops its Agent before the update is applied. Nothing in the database changes and nothing is shown again for you to
|
||||
accept; sessions already stored keep their status.
|
||||
|
||||
### Added
|
||||
|
||||
- **`FrameLedger.exe --data-dir <folder>` opens a copy of a data folder to look at**, for checking a build of your own
|
||||
against real data without touching your own. Such a window starts and contacts no Agent, records nothing and changes
|
||||
nothing on the PC — the controls that would are disabled, and a banner says whose data it shows. It refuses
|
||||
FrameLedger's own folder.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **The anti-cheat check could scan a program that had nothing to do with the game**: Windows reuses process numbers, and
|
||||
once a game's launcher had closed, the check followed its number to whatever program held it now — a protected one
|
||||
refused the session, one carrying anti-cheat turned the game's measuring off for good. A program started after the game
|
||||
is no longer taken for its launcher, nor one started before the game for its child; when FrameLedger cannot read when a
|
||||
program started, it still scans it, as before.
|
||||
- **A game started again within a few seconds of closing was not recorded**: while FrameLedger was still saving the
|
||||
session that had just ended, the new start was turned away ("one session at a time") and never looked at again. It is
|
||||
recorded now, as soon as the session before it is saved — unless the game's other processes are still running beside
|
||||
it, as a multi-process game's helpers are.
|
||||
- **A game started through its launcher was never followed to the game itself** (the Agent's `--console launch`): when
|
||||
the launcher exited or never drew a frame, FrameLedger was to find the game the launcher had started and record it, and
|
||||
it never did — the launcher's process id was not passed on, so the search stopped before it began. It is passed on now,
|
||||
and a launch that ends without one says so in the log.
|
||||
- **After a change of language some text stayed in the old one** until FrameLedger restarted: the theme and update-channel
|
||||
lists in Settings, the log and level lists on the Logs page, the sort order on the Games page, the tray icon's menu and
|
||||
the Agent's status in the title bar. They follow the language at once now.
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.16] - 2026-10-06
|
||||
|
||||
**The sixteenth pre-release: nothing changes in the app.** It is 0.1.0-beta.15 as the owner verified it on real hardware
|
||||
the same day, with the developers' end-to-end tests made reliable. The same unsigned installer: verify its hash against
|
||||
`SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.15`:** Help ▸ Check for updates, then *Restart to update* with no game running. Nothing in
|
||||
the database changes and nothing is shown again for you to accept; sessions already stored keep their status.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **Development: the Agent's and the capture host's end-to-end tests no longer fail when another test project starts
|
||||
the test harness at the same moment.** Each such suite now records into a copy of the harness under a name of its
|
||||
own, so the target it asks for is never ambiguous (`14_TESTING`). Nothing in the app changes.
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.17] - 2026-10-07
|
||||
|
||||
**The seventeenth pre-release: text that keeps up with a change of theme, scroll bars hidden everywhere when you ask, a
|
||||
user guide that answers more, and a wiki.** The same unsigned installer: verify its hash against `SHA256SUMS.txt`, then
|
||||
*More info → Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.16`:** Help ▸ Check for updates, then *Restart to update* with no game running. Nothing in
|
||||
the database changes and nothing is shown again for you to accept; sessions already stored keep their status.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **Text keeps up with a change of theme.** After switching between Light and Dark, the descriptions and captions of the
|
||||
page in view — Settings above all, where the theme is chosen — kept the old theme's colour: light grey on white, or dark
|
||||
grey on dark. Every such text now follows the switch, on every page, window and dialog (`08_UI` §Contrast,
|
||||
`16_WPFUI_SYNTAX` §Gotchas).
|
||||
- **Hide scroll bars hides every scroll bar.** With Settings ▸ Window ▸ Hide scroll bars on, the Dashboard still drew its
|
||||
scroll bar — and so did the first run, About, the user guide and a game's wide sessions table; only screens with a
|
||||
switch or a tick box on them lost theirs. Every scroller follows the option now, and still scrolls with the wheel, the
|
||||
keyboard and touch (`08_UI` §Settings, `16_WPFUI_SYNTAX` §Gotchas).
|
||||
- **The first run names the right place to import your library.** Its last step said *File ▸ Import library… on the
|
||||
Games page*; File is the main window's menu, and the Games page has no such button. In Vietnamese it now names the menu
|
||||
as it is shown (*Tệp*).
|
||||
|
||||
### Added
|
||||
|
||||
- **The user guide looks things up too.** Four pages join it, in Help ▸ User guide: *The screens* (every page, menu,
|
||||
button and shortcut), *Every setting* (what each one does and its default), *When something goes wrong* (what you see,
|
||||
what it means, what to do) and *Words FrameLedger uses*. Tests now fail when a setting or a menu item is added without
|
||||
its line in the guide, or a link names a section that does not exist.
|
||||
- **A wiki.** The project's [wiki](https://github.com/poli0981/frameledger/wiki) has two halves: the user guide, the
|
||||
same pages the app shows, and short pages for developers — the architecture, the repository, building and testing,
|
||||
the rules every change keeps, capture, metrics, data, the app's UI and releasing — each linking to its full document.
|
||||
It is published from the repository whenever a release is made (`wiki.yml`), so it always matches the newest
|
||||
release, and `./build.ps1 check` fails on any link in it that leads nowhere (`13_CI_CD` §wiki.yml).
|
||||
|
||||
@@ -0,0 +1,48 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.18] - 2026-10-07
|
||||
|
||||
**The eighteenth pre-release: every page readable in the dark theme, notices that say what happened in words, and a
|
||||
release whose build no longer calls itself dirty.** The same unsigned installer: verify its hash against
|
||||
`SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.17`:** Help ▸ Check for updates, then *Restart to update* with no game running. Nothing in
|
||||
the database changes and nothing is shown again for you to accept; sessions already stored keep their status.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **Page titles and section headings read in the dark theme again.** Every page's title and its section headings — Dashboard,
|
||||
Recent sessions, Games, Compare, Settings and each of its groups, Logs — were drawn near-black on the dark window
|
||||
(owner's screenshots of beta.17; beta.16 had it too). A page is shown in WPF UI's navigation Frame, which passes no text
|
||||
colour into the page, and a text that sets none is black; a page open during a theme switch picked the right colour up,
|
||||
and the next one navigated to did not. Every page now sets the theme's text colour itself. `AccessibilityTests.EveryPageSetsItsOwnTextColour`
|
||||
and `PagesLoadTests.EveryTextIsReadableInBothThemes` (every surface hosted as the App hosts it, ≥ 3:1 in both themes)
|
||||
went red on the unfixed pages first; the theme-switch check now hosts pages in the Frame too, and its harness derives the
|
||||
accent for each theme as the App does (`docs/08_UI.md` §Contrast, `docs/16_WPFUI_SYNTAX.md` §Gotchas, `docs/14_TESTING.md`).
|
||||
- **Every notice says what happened in words.** With *Disable all hooking* on, a game's notice read "kill switch was
|
||||
detected in this game (the global 'disable all hooking' switch is on (FR-2.4); …)" — it reads "All hooking is switched
|
||||
off in Settings, so nothing was measured." now, and a game blocked before reads as that, not as a finding. A refusal no
|
||||
anti-cheat names read "… reason RefusedByGuard." and is said in the guard's words ("the game is 32-bit, and the hook
|
||||
runs in 64-bit games only"); the agent sends the guard's reason for every refusal (`docs/07_IPC.md`). A safety re-scan
|
||||
that could not look while the game ran read "Access is denied. was detected" and says the check could not be made. And
|
||||
*Measurement stopped* printed "The hook stopped (WriterSelfDisabled); the session continues without measuring." — it
|
||||
says why in a sentence, and no longer that the session went on: a stop ends it. `NoticesFromTheAgentTests` builds the
|
||||
agent's own events for every refusal and every stop and went red with each text above (`docs/08_UI.md` §Notifications policy).
|
||||
- **Disable all hooking says when it applies.** Turning it on said "The capture agent reads it at the next session start";
|
||||
a game being measured stops at its next safety scan, within 30 seconds, and the message says so.
|
||||
- **Turning hooking off with no agent says nothing changed** — Settings' *Turn off*, the game page's switch and a
|
||||
withdrawn exception said "Nothing was enabled.", the enabling path's words.
|
||||
- **A viewer over a copy leaves every agent setting alone.** The user-mode exception option, the three Recording numbers
|
||||
and the update channel stayed live in `--data-dir`, where no agent reads them (`ViewerModeTests`).
|
||||
- `docs/08_UI.md` listed a "PawnIO missing" banner that was never built; struck, with the banners that do exist.
|
||||
- **A release's overlay build no longer calls itself dirty.** The Dashboard read *Overlay build v0.1.0-beta.17-dirty* (and
|
||||
beta.16's, and every release's before): the release workflow writes the release date into the legal documents before
|
||||
the build, and the build id was read from the tree after that. It is read from the clean checkout first and handed to
|
||||
the build, and `tools/buildid-check.ps1` reads it back out of the published binaries (`docs/12_BUILD.md` §Release-time
|
||||
token substitution). Nothing changes for a game: both sides of the ring's handshake always carried the same id.
|
||||
- **Two end-to-end tests no longer fail CI by a race** (developers only). The Vulkan launch test asks the test harness
|
||||
whether this machine can present through Vulkan before it starts the capture host: on GitHub's runners the harness's
|
||||
own "skip" line never reached the host's output, and a scan of the exiting harness failed the test instead of skipping
|
||||
it. The target-exit test holds its harness 15 seconds instead of 6, the margin a slow runner's host needed
|
||||
(`docs/13_CI_CD.md`).
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.19] - 2026-10-12
|
||||
|
||||
**The nineteenth pre-release: an imported game that is its own runtime and not a helper, Change executable… in the game's
|
||||
folder, the engine version of Unity, Godot and RPG Maker games, and games you uninstalled leaving the library by
|
||||
themselves.** The same unsigned installer: verify its hash against `SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.18`:** Help ▸ Check for updates, then *Restart to update* with no game running. The Privacy
|
||||
Policy (2.8) is shown once for you to accept. Every game is read once more for its engine (detection rules `2026.10.2`).
|
||||
The agent removes the entries of games you uninstalled that have no sessions, about ten minutes after it sees them gone —
|
||||
turn **Settings ▸ Data ▸ Remove uninstalled games** off first if you want them kept. An entry an earlier import made for a
|
||||
helper is not changed: re-point it with *Change executable…*.
|
||||
|
||||
### Added
|
||||
|
||||
- **The engine version of Unity, Godot and RPG Maker games**, as Unreal Engine's has been shown since beta.10 — on the game's
|
||||
page with what it was read from, and the maker on the library card too: *Unity 2022.3.39f1* (from the player library,
|
||||
else its data file; a game whose data file is encrypted reads without the release letter, *2019.4.40*), *Godot 4.4.1*
|
||||
(from its data pack), *RPG Maker MZ 1.10.0* and *MV 1.6.2* (from the core script), *RPG Maker VX Ace (RGSS 3.0.1)*
|
||||
(from the runtime library its `Game.ini` names — that number is the library's, not the editor's). A Unity version used
|
||||
to read as its library's build number (`2022.3.39.5118735`), and a Godot one was never found. Every game is read once
|
||||
more after the update (detection rules `2026.10.2`). RPG Maker 2000/2003 is not recognised (`docs/05_DETECTION.md`
|
||||
§Engine version — Unity, Godot, RPG Maker).
|
||||
- **The Privacy Policy (version 2.8)** names the files those versions are read from, and two that were already read and
|
||||
never named (Unity's player library and an RPG Maker game's title); it is shown once for you to accept.
|
||||
- **A game you uninstalled leaves the library by itself** when it has no sessions: the agent removes an entry whose `.exe`
|
||||
has been gone for ten minutes, if its drive is connected and the folder it was installed in is still there — an
|
||||
unplugged or re-lettered drive never counts — and never one where anti-cheat was found. A game with sessions stays, with
|
||||
them, and reads *Not installed* as before. The Games page says so when it happens — once, naming them, for all the games
|
||||
one check removes; **Settings ▸ Data ▸ Remove uninstalled games** turns it off (`docs/02_SPEC.md` FR-1.8).
|
||||
|
||||
### Changed
|
||||
|
||||
- **Change executable… opens in the game's own folder** — the install folder a store made (`steamapps\common\<game>`
|
||||
and the like), or above an Unreal game's `Binaries\Win64`, else the folder the executable is in — instead of wherever
|
||||
the last file dialog was. For a game whose folder is gone it opens at the nearest folder still there
|
||||
(`docs/08_UI.md` §Games).
|
||||
|
||||
### Fixed
|
||||
|
||||
- **An imported game is no longer one of its helpers, and an RPG Maker MV/MZ game behind a launcher is its runtime.**
|
||||
A Doll's Locket - Remake (itch) was added as `notification_helper.exe`, NW.js's notification helper, because the itch
|
||||
app's own record named only that file (it leaves out a launcher that asks for administrator and anything a folder
|
||||
deeper) and the import took it as the game. A helper named by the store is skipped now and the executable is guessed —
|
||||
the import list says so — and the guess takes the executable beside NW.js's `nw.dll` and `package.json`, the process
|
||||
that draws (`css\Game.exe` there; its launcher asks for administrator, so it is measured with *Run the agent as
|
||||
administrator* on — *withdrawn 2026-10-13: that launcher is malware, do not run it; [0.1.0-beta.21]'s Security*). The
|
||||
import also no longer offers a store's game again when the library has it at another
|
||||
executable: an entry already there is re-pointed with *Change executable…* (`docs/05_DETECTION.md` §Library import).
|
||||
- **The Games page shows its newest read of the library.** When two reads overlapped — a session ending while an import
|
||||
added games — the one that started first could finish last and be shown, an older list until the next read.
|
||||
|
||||
@@ -0,0 +1,114 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.2] - 2026-09-17
|
||||
|
||||
**The second pre-release.** The same unsigned installer as `0.1.0-beta.1`: verify its hash against
|
||||
`SHA256SUMS.txt`, then *More info → Run anyway*. What changed for a user: a finished session whose frame generation
|
||||
did not stay in one state — a menu, a loading screen — now shows the factor of its steady state with the share of
|
||||
the session it covers, where `0.1.0-beta.1` showed "factor not counted" for most real sessions; and three faults from
|
||||
the first day of use are fixed: an App started as administrator started another Agent every few seconds, and each of
|
||||
them recorded every game; closing the App ended in an error; and a crash dump could hang the process it described.
|
||||
|
||||
**Updating from `0.1.0-beta.1`:**
|
||||
|
||||
- **Quit the App (tray icon → Exit), then end every `FrameLedger.Agent.exe` in Task Manager before installing.** If the
|
||||
App was ever started as administrator, some Agents run elevated, and Task Manager can end those only when it runs
|
||||
as administrator itself.
|
||||
- On its first start the ledger migrates to schema 6. Sessions recorded before keep the frame-generation result they
|
||||
were stored with; the steady state applies to sessions recorded from this version on.
|
||||
- Sessions recorded while more than one Agent was running appear once per Agent. Nothing removes them automatically.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **Closing the App no longer ends in a Fatal error and exit code 1 (2026-09-17).** Measured on the installed
|
||||
0.1.0-beta.1: `ui-*.log` recorded `ui: the run ended in an exception` — "the calling thread cannot access this object
|
||||
because a different thread owns it" — from `TrayHost.Dispose` on every close after an update check. The App waited
|
||||
with `WaitForShutdownAsync`, which resumes on the thread pool and stops the hosted services there, so the tray icon (a
|
||||
WPF object whose disposal unsubscribes `Application.Exit`) was removed off its thread; `TearDownAsync` then stopped every
|
||||
service a second time. The App now waits for the stop request on the dispatcher and stops the host once, from the UI
|
||||
thread, and `TrayHost.Dispose` marshals to the icon's own dispatcher from any thread (bounded at 5 s; skipped when the
|
||||
dispatcher has already shut down). Test: `TrayHostTests` disposes a real tray icon from a pool thread while the UI
|
||||
thread pumps — red on the old code with that exception, green now; skipped where the session has no notification area.
|
||||
|
||||
- **A crash dump can no longer hang the process it describes, and the test suite no longer freezes (2026-09-17).**
|
||||
`FrameLedger.Infrastructure.Tests` hung about one run in eight — it cancelled the first tag's release run after 58
|
||||
minutes — and the verbose reporter of a hung run showed thirteen tests started and none finished, one of them
|
||||
`CrashDumpWriterTests.WritesAMinidumpOfThisProcess…`. That test, and the product's crash path in the App and the Agent,
|
||||
called `MiniDumpWriteDump` on the calling process, which suspends every other thread of it; one holding the heap or
|
||||
loader lock deadlocks the dumper, and the whole process freezes with it. Forty runs without the test: no hang. The dump
|
||||
is written by a child now: `CrashDumpWriter.TryWrite` starts `FrameLedger.Agent.exe --write-crash-dump <file>` and waits
|
||||
up to 30 s, and the helper (`Infrastructure.Diagnostics.ParentDump`) dumps its parent with the same flags — it takes no
|
||||
pid and refuses unless the parent is still running, started before it and sits in the helper's own directory, so it can
|
||||
only ever read the App or the Agent (CLAUDE.md rule 4). Forty runs of the suite with the new tests: no hang.
|
||||
`--blame-hang` (#196) did not stop the hung xUnit v3 executable, so `build.ps1` runs `dotnet test` under a 25-minute
|
||||
wall-clock limit, kills the tree on expiry and names the test projects that wrote no `results.trx`. Tests:
|
||||
`ParentDumpTests` (a real minidump of another process; which parent is ours), `CrashDumpWriterTests` (a failing and a
|
||||
missing dumper), `CrashDumpHelperTests` (the shipped Agent dumps the test process from outside; it refuses a parent
|
||||
from System32; the flag's surface). Docs: `10_LOGGING` §Crash handling, `12_BUILD` Agent flags, `13_CI_CD` tally.
|
||||
**A hang in one test process no longer fails the others.** The migration mutex was one name for every ledger
|
||||
(`Local\FrameLedger.Ledger.Migrate`), so a suite frozen mid-migration held every other process's scratch ledger: on
|
||||
#199's run `Infrastructure.Tests` hung and seven App and Agent tests failed after 30 s with "another process has been
|
||||
migrating the ledger". It is the file's now (`MigrationRunner.LockNameFor`; `MigrationLockTests`; `06_DATA_MODEL`
|
||||
§Migrations). And a failed dump names dbghelp's error instead of 0: CsWin32 declares `MiniDumpWriteDump` without
|
||||
`SetLastError`, so the code is read with `GetLastSystemError` (`ParentDumpTests`: an exited process).
|
||||
|
||||
- **One Agent per data folder: an App started as administrator no longer starts an Agent per connect round
|
||||
(2026-09-17).** On the owner's machine the installed 0.1.0-beta.1 ran four `FrameLedger.Agent.exe --serve`: the App
|
||||
opened at 10:04 was elevated, the pipe of the Agent already serving refused it, and it took the refusal for an absent
|
||||
Agent and started three more, elevated like itself, 17 seconds apart. Nothing in the Agent noticed the first — the
|
||||
single instance `01_ARCHITECTURE` §Lifecycle specified was never built — so every game launched in the next hour was
|
||||
injected, read and recorded by all four (four copies of each session, equal frame counts), and the three extras
|
||||
logged "accept failed" every 260 ms for four hours. The cause of the refusal: `PipeOptions.CurrentUserOnly` compares
|
||||
the pipe's owner with the client token's default *owner*, which an elevated token sets to Administrators (the elevated
|
||||
Agents' log files are owned by Administrators, measured), not with its *user*.
|
||||
- `Infrastructure.Startup.AgentInstanceLock`: a named mutex per data folder, claimed by `--serve` and the console's
|
||||
`capture` / `launch` / `recover` before logging, rules and the ledger; a second process exits **10** with one line.
|
||||
- The App starts an Agent only when no process holds the folder and the one it started last has exited; it logs why a
|
||||
connect failed, once per reason, and the exit code of the Agent it started.
|
||||
- The pipe states its owner (`O:<user>` in the SDDL) and the client checks the owner against its token user
|
||||
(`PipeAccessControl.RequireOwnedByCurrentUser`), so an elevated App and an unelevated Agent reach each other in both
|
||||
directions.
|
||||
- A pipe instance that cannot be created backs off 250 ms → 10 s and is logged with its Win32 error, once per streak
|
||||
(CsWin32 declares `CreateNamedPipeW` without `SetLastError`; the error is read with `GetLastSystemError`).
|
||||
- Tests: `AgentInstanceLockTests`, `OneAgentPerDataFolderTests` (the shipped binary against a claimed scratch folder),
|
||||
`AgentConnectionTests` (an Agent that is up and does not answer is never started again; the real launcher sees the
|
||||
claim), `PipeServerClientTests` (the owner; an Administrators-owning token trusts its user's pipe and refuses an
|
||||
Administrators one — on CI's elevated runner; the backoff logs once with error 231). Docs: `01_ARCHITECTURE`
|
||||
§Lifecycle, `07_IPC` §C and §Client behavior, `08_UI`, `12_BUILD`, `20_OPEN_QUESTIONS` §G.
|
||||
|
||||
### Added
|
||||
|
||||
- **A session whose frame-generation state changed publishes its steady state, with its share (2026-09-17, owner
|
||||
decision — `03_METRICS` §The steady state).** The owner saw the live card show the FG factor all session and the
|
||||
finished session show "factor not counted" most of the time, and suspected the path from the hook to the UI. The
|
||||
path is whole: the stored per-frame counts of all nine hooked sessions of 2026-09-16 read 2.00 / 3.00 / 4.00 inside
|
||||
gameplay. The live card looks at five seconds; the stored row looked at the whole session, split it in eight and
|
||||
refused it when one bucket departed — and every real session opens with a splash, a menu or a loading screen, so
|
||||
one session in nine published. The refusal is right (Wukong's session averages to 2.22; its gameplay ran ×4.1) and
|
||||
stays; what changes is that the gameplay's number is no longer thrown away with the average.
|
||||
`Domain.Metrics.FgSteadyState`: five-second windows (the live card's own), the ACTIVE windows agreeing within 10 %
|
||||
that hold the most time, published at ≥ 10 s and ≥ 10 % of the presenting time — `fg_factor` / `native_fps` /
|
||||
`displayed_fps` from that state's own windows, `fg_factor_scope = 'steady'`, `fg_steady_share` (schema **0006**),
|
||||
the refusal and its detail kept beside it. The readout is the generated shape with the chip **`×2.0 FG · 75%`** —
|
||||
the share is never omitted — and a tooltip saying why there is no session-wide factor. Replayed over the nine
|
||||
sessions through the real `FgWindow`: 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` 25 % → 10 % (at 25 % a ×3-then-×4 session published 3.69, and the one published session read
|
||||
×2.04 for a gameplay of 2.00), and `MultipleStreams` refuses only when the chains' samples interleave — Onimusha
|
||||
recreates its swapchain on entering gameplay, one stream at a time, and had been refused as two on every session.
|
||||
CLAUDE.md rule 6 amended. Two strings (en/vi/ja). Tests: `FgSteadyStateTests`, `FgWindowTests` (interleaved vs
|
||||
sequential), `SessionAggregatorTests`, `FpsPresentationTests`, `LedgerDatabaseTests` (script six), the repository
|
||||
round trip. Existing rows are not re-aggregated.
|
||||
|
||||
### Changed
|
||||
|
||||
- **The first tag ran (2026-09-16).** `v0.1.0-beta.1` on `becc208`; `release.yml` run 35111939019. The first attempt
|
||||
passed the version gate and the substitution and then sat in `Infrastructure.Tests` for 58 minutes — every other
|
||||
suite green, the same suite 42 s in the rehearsal — until the job's 60-minute limit cancelled it with no test named;
|
||||
`gh run rerun --failed` on the same tag went green in 11 minutes and created the pre-release with the section's notes
|
||||
and the checksums appended. `build.ps1` now runs `dotnet test` with `--blame-hang --blame-hang-timeout 15m` (#196) so
|
||||
the next hang is a named failure; the capture-host suite's `Kill` waits for exit (#194) and the layer-registration
|
||||
test deletes only its own registry subtree (#188), the two harness races the same evening's merge train kept hitting.
|
||||
Docs: `13_CI_CD` §release.yml and §ci.yml's tally, `12_BUILD` §Publish & package (the runner's sizes),
|
||||
`15_ROADMAP` §P5.
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.20] - 2026-10-12
|
||||
|
||||
**The twentieth pre-release: the engine version of Ren'Py games.** The same unsigned installer: verify its hash against
|
||||
`SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.19`:** Help ▸ Check for updates, then *Restart to update* with no game running. The Privacy
|
||||
Policy (2.9) is shown once for you to accept. Every game is read once more for its engine (detection rules `2026.10.3`).
|
||||
|
||||
### Added
|
||||
|
||||
- **The engine version of Ren'Py games**, as Unity's, Godot's and RPG Maker's have been shown since beta.19 — on the game's
|
||||
page with what it was read from, the engine's own `renpy/vc_version.py`: *Ren'Py 8.5.0*. A game whose engine names no
|
||||
version there reads as not found. Every game is read once more after the update (detection rules `2026.10.3`;
|
||||
`docs/05_DETECTION.md` §Engine version — Ren'Py).
|
||||
- **The Privacy Policy (version 2.9)** names that file among the version marks it reads; it is shown once for you to
|
||||
accept.
|
||||
|
||||
@@ -0,0 +1,64 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.21] - 2026-10-13
|
||||
|
||||
**The twenty-first pre-release: an anti-cheat kept beside a game's executable found before anything is injected, four
|
||||
itch.io downloads that carry malware, documents that scroll further and smoothly, and Play.** The same unsigned
|
||||
installer: verify its hash against `SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.20`:** Help ▸ Check for updates, then *Restart to update* with no game running. The Privacy
|
||||
Policy (2.10) is shown once for you to accept. Every game is read and checked for anti-cheat once more (detection rules
|
||||
`2026.10.4`): Wuthering Waves, and any game that keeps an anti-cheat beside its executable, has its hooking turned off.
|
||||
If you installed HELLO, HELLO WORLD!, A Doll's Locket - Remake, City of Bones or Träumerei Chapter 2 from itch.io, read
|
||||
*Security* below first.
|
||||
|
||||
### Added
|
||||
|
||||
- **Play, on a game's page and on each game in the library.** Through the store that installed the game — Steam or the
|
||||
Epic Games Launcher starts it, GOG GALAXY runs it, the itch app asks which copy to launch — or started directly by
|
||||
FrameLedger, recorded from its first frame: **Settings ▸ Games ▸ Play button** switches between the two. A game no
|
||||
store installed, and a GOG game without GOG GALAXY, is started directly. FrameLedger never starts a game as
|
||||
administrator: *Start directly* does not start one that asks for it, and while FrameLedger itself runs as
|
||||
administrator, Play starts every game directly so that the game does not. A game whose recording is off is started
|
||||
only through its store. The Epic Games Launcher's link is the one its own shortcuts carry and has not been tried on a
|
||||
real Epic game yet (`docs/08_UI.md` §Games).
|
||||
- **The Privacy Policy (version 2.10)** names the store records Play and the library import read — the lists of installed
|
||||
games the Steam, GOG GALAXY, Epic Games and itch apps keep on your disk, and where GOG GALAXY is installed; the import
|
||||
read the Epic and itch lists before and the policy did not say so — and that Play hands a game to its store's app,
|
||||
which may connect to its store while FrameLedger itself connects to nothing. It is shown once for you to accept.
|
||||
|
||||
### Changed
|
||||
|
||||
- **The documents in the app scroll further and smoothly** — the user guide, Help ▸ Limitations, About's documents, the
|
||||
Legal Gate and the update notes. A wheel notch moved them a fixed short step whatever the wheel or touchpad sent;
|
||||
it now moves the number of lines Windows is set to scroll (a screen if it is set to that), about twice as far by
|
||||
default, in proportion for a touchpad, and glides there unless Windows' animations are off. At the end of the update
|
||||
notes the wheel scrolls the window instead; Ctrl+wheel still zooms. A page is drawn once when it is opened, not two or
|
||||
three times, and going back to a page you have read in the same window is immediate.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **An anti-cheat kept beside a game's executable is found before anything is injected.** The safety check looked three folder
|
||||
levels into a game's install folder and no further, so an anti-cheat beside an executable that is itself three levels down
|
||||
was never seen: Wuthering Waves keeps Tencent's Anti-Cheat Expert in `Client\Binaries\Win64\AntiCheatExpert\`, its
|
||||
page read clean, and a session with hooking turned on was hooked for 37 seconds before the check that runs every 30 seconds
|
||||
met the anti-cheat's driver — and because a driver counts for the whole PC, the game's hooking stayed on. The check now also
|
||||
looks in the executable's own folder, on the game's page and before every injection. Wuthering Waves is also named by its
|
||||
Steam id (owner decision D58), and ACE's files, its second driver, its driver's service and its module are named (detection
|
||||
rules `2026.10.4`). Every game is checked for anti-cheat once more after the update; one found this way has its hooking
|
||||
turned off, as any finding does (`docs/19_SAFETY_AND_ANTICHEAT.md` §Pre-injection checks, item 4).
|
||||
- **A game's Supports card said *Not scanned yet* for a game the agent had read** whenever the game ships none of the
|
||||
upscaler, frame-generation or Vulkan files the rules name — beside a Details card the same read had filled. It says
|
||||
so now only until the agent has read the game, then *None found*.
|
||||
|
||||
### Security
|
||||
|
||||
- **Four itch.io downloads this project's documentation used as examples carry malware.** HELLO, HELLO WORLD!, A Doll's
|
||||
Locket - Remake, City of Bones and Träumerei Chapter 2 put the same 213 MB program in front of their RPG Maker game.
|
||||
Read without running it, it ships a registry file that switches off Windows' script scanning (AMSI) and adds
|
||||
Microsoft Defender exclusions, carries an encrypted payload, and checks for virtual machines and debuggers before it
|
||||
starts the game. The documentation called it a launcher and, for A Doll's Locket, said to measure it with the agent
|
||||
running as administrator: that advice is withdrawn. If you installed one of them, remove it and scan your PC.
|
||||
FrameLedger itself does not change: it reads a game's files to find its engine and anti-cheat, and does not judge
|
||||
whether a game is safe (`docs/spike-notes.md` §20).
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.22] - 2026-10-13
|
||||
|
||||
**The twenty-second pre-release: a request the capture agent never answered is said as such, never as a crash.** The
|
||||
same unsigned installer: verify its hash against `SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.21`:** Help ▸ Check for updates, then *Restart to update* with no game running. Nothing is
|
||||
shown to accept and no game is read again: the legal documents and the detection rules (`2026.10.4`) are beta.21's.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **A request the capture agent never answered is said as such, never as a crash.** When the agent stopped, or restarted
|
||||
for an update, while FrameLedger was asking it something, deleting sessions ended in the crash dialog, and turning a
|
||||
game's hooking on or off or making or withdrawing an anti-cheat exception showed *IOException* or *TimeoutException* as
|
||||
its notice. Each now says that the agent did not answer and that whether it was done is not known, and the page shows
|
||||
what is stored; Play says the same (it said the agent was not running). A request that could not be sent because the
|
||||
agent was already gone still says that nothing was changed (`docs/07_IPC.md` §Client behavior).
|
||||
|
||||
@@ -0,0 +1,55 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.23] - 2026-10-14
|
||||
|
||||
**The twenty-third pre-release: a game's artwork on its page, in a band that takes the picture's colour, and pages
|
||||
that open and change session without freezing.** The same unsigned installer: verify its hash against
|
||||
`SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.22`:** Help ▸ Check for updates, then *Restart to update* with no game running. The
|
||||
Privacy Policy (2.11) is shown once for you to accept. No game is read again: the detection rules (`2026.10.4`) are
|
||||
beta.22's. The artwork shows by itself for the games Steam or GOG GALAXY installed; **Settings ▸ Games** turns it, or
|
||||
its colour, off.
|
||||
|
||||
### Added
|
||||
|
||||
- **A game's page shows its artwork** (owner request 2026-10-14, decisions D60/D61). At the top of the page: the
|
||||
banner and the cover the Steam or GOG GALAXY app already keeps on your PC for the game it installed — read where that
|
||||
app keeps them, never downloaded and never copied — or an image you choose yourself in **Edit… ▸ Choose image…** (a
|
||||
copy is kept in the data folder's `covers` folder; **Use the store's image** goes back). The band they sit in takes the
|
||||
picture's main colour, never so strongly that a text on it gets hard to read (primary and secondary text keep 4.5:1,
|
||||
the faintest 3:1, in both themes), and follows a theme switch. A game from itch, the Epic Games Launcher or another
|
||||
store has a picture only once you choose one, because those apps keep no image files. **Settings ▸ Games** has *Show
|
||||
game artwork* and *Colour the game page from its artwork*, both on. **Privacy Policy 2.11** names the images read and
|
||||
the copies kept; FrameLedger still makes no request to any store.
|
||||
|
||||
### Changed
|
||||
|
||||
- **The list of tested games has its first Vulkan game**: Everhex Demo, measured through FrameLedger's Vulkan layer on
|
||||
2026-10-13 when Play started it directly (`docs/LIST_GAME_TESTED.md`, `LIMITATIONS.md`). Four places in the developer
|
||||
documents that described something never built, or kept a count that went stale, are corrected in place.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **A game's page opens and changes session without freezing the window** (owner request 2026-10-14). Measured on the
|
||||
dev PC over a ledger shaped like the owner's (`docs/spike-notes.md` §21): a game with 100 sessions took 1.2–1.5 s to
|
||||
open — its Sessions list built every row, now only the rows on screen (it scrolls itself and hands the wheel to the
|
||||
page at its ends) — 0.37 s now; choosing a two-million-frame session froze the window 0.8–1.0 s — the session was read
|
||||
and decoded on the UI thread, then sorted three times for the Distribution tab — 17 ms now: it is read on the thread
|
||||
pool and what the charts need from all of it is worked out there once. The page also asks whether the game's `.exe` is
|
||||
on disk off the UI thread (a USB drive that sleeps answered on it), and no longer summarises every game to show one.
|
||||
- **Each visit to the Dashboard or Logs no longer stays in memory.** Every Dashboard ever opened stayed alive and kept
|
||||
listening to the capture agent, so at each session's end each one reloaded its lists and raised its own "Session
|
||||
saved" notice — twenty visits, twenty notices, the last one shown. The Dashboard listens only while it is on screen,
|
||||
and the notice has one home for the App's life, shown once whichever page is open; each Logs page kept its tail of up
|
||||
to 2 MB, twice.
|
||||
- **The Logs page reads its file only when it changed**, not every two seconds, and filters it off the UI thread; **Play**
|
||||
reads the stores' lists of installed games off the UI thread (Steam's manifests sit on whatever drive its libraries
|
||||
are on). At Debug level the App now logs how long each page took to appear (`ui: page … shown … ms`).
|
||||
- **The native ring-buffer tests no longer pass or fail by the scheduler's luck** (developers only). The
|
||||
hammering-writer test required the reader to keep more than half of the stream, which measured how the operating
|
||||
system scheduled two threads: on a hybrid Intel processor it failed 5 of 200 runs with the ring correct every time.
|
||||
Both concurrency tests now start the writer only once the reader is running, repeat until the reader really read
|
||||
the ring while the writer wrote it, and require that; the small-ring test's old check also passed a reader that
|
||||
started after the writer had finished (`src/native/tests/ring_test.cpp`).
|
||||
|
||||
@@ -0,0 +1,99 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.24 was cut, 2026-10-19 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.24] - 2026-10-19
|
||||
|
||||
**The twenty-fourth pre-release: every frame-generation state a session held, the quality mode the NVIDIA App set, and
|
||||
which DLSS ran.** The same unsigned installer: verify its hash against `SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.23`:** Help ▸ Check for updates, then *Restart to update* with no game running. The
|
||||
Disclaimer (2.11) and the Privacy Policy (2.12) are shown once for you to accept. The ledger moves to schema 21, which
|
||||
a beta.23 cannot open. No game is read again: the detection rules (`2026.10.4`) are beta.23's. The mix of
|
||||
frame-generation states and where each DLSS library was loaded from are kept for sessions recorded from now on; the
|
||||
quality mode the NVIDIA App set reads on sessions you already have.
|
||||
|
||||
### Added
|
||||
|
||||
- **Every frame-generation state a session held, in its summary** (owner request 2026-10-19, decision D62). Under the
|
||||
figures, *Frame generation in this session* lists each state — `×2.0`, `×3.0`, `×4.0`, `×6.0`… — with its own
|
||||
Native → Displayed and its share of the time to two decimals, then the time with no frame generation and the time no
|
||||
state explains (*Not classified*: switching, loading, a multiplier that changed faster than five seconds), above a bar
|
||||
of those shares. A line above them says how frame generation was set: in the NVIDIA App (*Dynamic, up to ×6, target:
|
||||
max refresh rate*, *Fixed ×4*, from the driver profile stored with the session) or in the game. Each state is read
|
||||
over the same five-second windows as the steady state and lasts at least 10 seconds; nothing is averaged across
|
||||
states (rule 6). Stored with the session (schema 0020, `sessions.fg_mix`): a session recorded before has none, and
|
||||
its summary says so in one line. The CSV export gains a `# fg_mix:` line; the JSON carries the column. The FG×
|
||||
column's two formats are translated strings now, and the driver-profile line's automatic dynamic target reads as the
|
||||
NVIDIA App says it: *max refresh rate*.
|
||||
|
||||
- **The quality mode the NVIDIA App set, on every page that names the upscaler** (owner request 2026-10-19, decision
|
||||
D63). Where the NVIDIA App overrides DLSS Super Resolution for a game and the NVIDIA driver reports that the
|
||||
override applied in the session, the summary, the Sessions tab, the game page and the live card say so:
|
||||
*DLSS (driver-reported) Quality · NVIDIA App*. It is read from what every session already stores, so sessions
|
||||
recorded before read the same; when the profile and the driver disagree, or the driver's report alone cannot settle
|
||||
the mode, the session reads *· NVIDIA App override* with no mode — never the game's own value in its place. The CSV
|
||||
export gains a `# quality_mode:` line. `legal/ACCURACY.md`'s *Quality mode* bullet says so, in the words approved
|
||||
with the plan; **the Disclaimer is 2.11** and the Legal Gate shows it once.
|
||||
|
||||
- **Which DLSS a session ran** (owner request 2026-10-19, decision D64). The summary's DLSS line gives each DLSS
|
||||
library's version and whether it was loaded from the game or from the graphics driver (the NVIDIA App's override
|
||||
loads the driver's own copy), the model preset the NVIDIA driver reports, and *DLSS 4* or *DLSS 4.5* only where the
|
||||
session shows it — the preset (L or M: 4.5; J or K: 4) or a measured multi-frame factor (×5–×6: 4.5; ×3–×4: 4) —;
|
||||
DLSS 2 and 3 from their libraries; *DLSS 5 runtime loaded* when its library is. The game page repeats the label and
|
||||
the CSV export gains `# dlss:`. The module snapshot now records every library under the NVIDIA override folder,
|
||||
whatever its name, and each module's folder class (schema 0021, `sessions.runtime_module_sources` — never the path),
|
||||
plus five more libraries by name (`sl.dlss_d.dll`, `sl.common.dll`, `sl.reflex.dll`, `amd_fidelityfx_loader_dx12.dll`,
|
||||
`nvngx_dlssnr.dll`). **Privacy Policy 2.12** says so, in the words approved with the plan; `legal/ACCURACY.md` gains
|
||||
the *DLSS version* bullet.
|
||||
|
||||
### Changed
|
||||
|
||||
- **The analyzers are Meziantou.Analyzer 3.0.307 and Microsoft.VisualStudio.Threading.Analyzers 18.12.1**
|
||||
(developers only): the update Dependabot proposed in #314 and then closed itself as "updatable in another way" —
|
||||
applied by hand, with the two suppressions it needed merged earlier in the train.
|
||||
- **SonarCloud analyses only FrameLedger's own code** (developers only; owner request 2026-10-19, decision D67). A
|
||||
`.sonarcloud.properties` at the root keeps the vendored SDK headers, generated files, test fixtures, licence texts and
|
||||
the SQLite migrations out of the analysis and reports the native code against C++20; `docs/13_CI_CD.md` §SonarCloud
|
||||
records the triage of the 341 issues the last analysis left — the rules this project breaks by design and why, the
|
||||
false positives, and the ones the next change fixes — with the steps to mark them in SonarCloud.
|
||||
- **The long documents are split** (developers only; owner request 2026-10-19, decision D66). `CHANGELOG.md`
|
||||
keeps `[Unreleased]` and a table of the releases; each release's section now lives in its own file,
|
||||
`docs/changelog/<version>.md`, and the ledger kept before the first tag in five parts — moved verbatim: the notes
|
||||
`tools/release-notes.ps1` takes for each of the 23 releases are byte for byte what they were, and it reads the
|
||||
version's own file. `docs/HANDOFF.md` (2,844 lines, now 299) keeps what to do next, the open owner-only items and an
|
||||
index of every owner decision; the history of each phase and train, the passed owner-only items and the traps
|
||||
moved to `docs/handoff/`, and a table there resolves every section the code and the documents cite. A new gate,
|
||||
`tools/docs-split-check.ps1`, keeps each index and its files naming each other.
|
||||
- **The open questions and the measurement notes are split too** (developers only, D66). `docs/20_OPEN_QUESTIONS.md`
|
||||
(4,467 lines, now 2,008) keeps its rules, §S24 and every entry not resolved; the 30 entries §S24 marks resolved
|
||||
moved, with their reasoning and in their order, to `docs/open-questions/closed-s.md` and `closed-h.md`, and a table
|
||||
at the end of each series lists them. `docs/spike-notes.md` (2,816 lines) is now the index of its 24 sections, each
|
||||
in its own file under `docs/spike-notes/`; a new measurement gets the next number, its own file and a row. Both
|
||||
rebuild their originals byte for byte, and the same gate holds their indexes to their files.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **The NVIDIA driver line read the driver's mode in the wrong numbering.** The driver reports the mode an override
|
||||
set in NGX's own numbering, not the driver profile's: the owner's Silent Hill 2 session ran under the NVIDIA App's
|
||||
Ultra Performance (profile value 5) and the driver reported 3 — which the line printed as nothing, and a DLAA
|
||||
override's 5 would have printed as "Ultra Performance". Five comments in the native code called a quality byte of
|
||||
0 "NGX MaxPerf" — in the numbering that byte carries, 0 is "DLSS off" (comments only, no code changes).
|
||||
- **Opening a folder in Explorer** — the logs, the data folder, the licences, a bug report's zip and the folder named
|
||||
after a failed start — starts `explorer.exe` from the Windows folder by its full path, never a program of that name
|
||||
found on the search path, and always hands it the path in quotes (three of the five places passed it bare).
|
||||
- **What SonarCloud found that was real** (developers only): the one third-party GitHub Action is pinned to its
|
||||
commit; two string reads in native code are bounded by their buffer (the guard's rules-file path handed to the Agent,
|
||||
and the driver's branch name the NVAPI bridge copies); the pipe server's accept loop states that it ends only when
|
||||
cancelled; a launch's own session names its absent stop token (`CancellationToken.None`, with the reason) where it
|
||||
wrote `default` — the same value, now said on purpose; an unused overload of
|
||||
the process launcher that hid the other is gone; the identifier `module` (a C++20 keyword in some positions) is
|
||||
renamed in the hook layer — a rename only, no code changes; and a hook-overhead probe no longer uses a compound
|
||||
assignment on a `volatile`, which C++20 deprecates. The analyzers Dependabot updates in #314 flag the first-start
|
||||
window's own answer task and one test fake's synchronous wait; both are suppressed with their reasons, so that update
|
||||
can merge.
|
||||
- **The game-side log keeps every line a stop writes.** When hooking stopped on a game's own drawing thread — the
|
||||
capture agent's safety stop takes effect within one frame there — the Overlay's last write of its log could happen
|
||||
while that thread was still listing the hooks it removed, and the last of them never reached the file
|
||||
(`overlay-*.log`, the file a bug report carries). The last write now waits, at most two seconds, for the stop to
|
||||
finish and ends with a `STOP_FLUSHED` line; a line still being written is never printed half-done. Nothing changes
|
||||
on the per-frame path. This was the native test that went red under load since beta.9 (`fl_guard`'s log case),
|
||||
now run 20 times with every processor busy.
|
||||
@@ -0,0 +1,27 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.25 was cut, 2026-10-19 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.25] - 2026-10-19
|
||||
|
||||
**The twenty-fifth pre-release: FSR's quality mode.** The same unsigned installer: verify its hash against
|
||||
`SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.24`:** Help ▸ Check for updates, then *Restart to update* with no game running. Nothing is
|
||||
shown for you to accept again (the Disclaimer stays 2.11, the Privacy Policy 2.12), the ledger stays at schema 21, and
|
||||
no game is read again: the detection rules (`2026.10.4`) are beta.24's. FSR's quality mode is recorded for sessions
|
||||
from now on; a session recorded before keeps what it had.
|
||||
|
||||
### Added
|
||||
|
||||
- **FSR's quality mode** (owner decision D65, planned for beta.24 and moved to this release). For a game that runs FSR
|
||||
through AMD's FidelityFX libraries, the summary, the Sessions tab, the game page and the live card name the mode —
|
||||
*FSR 3 Quality*, *FSR Performance*, *FSR Native AA* — when the game asked AMD's library what render size that mode
|
||||
gives and then rendered at that size. A game at a dynamic resolution, one that sizes its frames without asking, and
|
||||
one FrameLedger joined after it asked show none. FrameLedger reads one more call in those libraries (`ffxQuery`,
|
||||
beside the `ffxDispatch` it already reads): the size or ratio AMD's library answered, nothing else — about 8 ns per
|
||||
upscaled frame. The CSV export's `# quality_mode:` carries it (`native_aa (game)` for Native AA).
|
||||
`legal/ACCURACY.md`'s *Quality mode* bullet gains its FSR clause, in the words approved with the beta.24 plan; the
|
||||
Disclaimer stays 2.11, as it did for the accuracy statement's additions in beta.19 and beta.20. Checked with AMD's
|
||||
interface on the test program; a real game is owner-only item 21. Developers: the hook has its own family bit
|
||||
(`FL_HOOK_UPSCALER_QUALITY`, bit 11 of `hooksInstalledMask`), the byte is `0x10 + FfxApiUpscaleQualityMode`, the
|
||||
harness asks with `--ffx-query sizes|ratios`, and `Domain.Metrics.QualityByte` is the one rule a session, its
|
||||
segments and the live card read.
|
||||
@@ -0,0 +1,35 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.26 was cut, 2026-10-19 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.26] - 2026-10-19
|
||||
|
||||
**The twenty-sixth pre-release: a frame-generation state no frame generation produces, fixed.** The same unsigned
|
||||
installer: verify its hash against `SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.25`:** Help ▸ Check for updates, then *Restart to update* with no game running. Nothing is
|
||||
shown for you to accept again (the Disclaimer stays 2.11, the Privacy Policy 2.12), the ledger stays at schema 21, and
|
||||
no game is read again: the detection rules (`2026.10.4`) are beta.25's. Sessions you already recorded read by the new
|
||||
rule at once — nothing in them is rewritten.
|
||||
|
||||
### Changed
|
||||
|
||||
- **SonarCloud's last six findings on `main`, triaged** (developers only; D67's follow-up). After the owner's marking,
|
||||
the analysis of 0.1.0-beta.25 left six open: `docs/13_CI_CD.md` §SonarCloud lists them with a verdict and the comment
|
||||
to paste — one to accept as the table already said, four false positives (exact floating-point comparisons that are
|
||||
exact on purpose), and one fixed here: `wiki.yml` publishes only after a Release run started by a tag pushed to this
|
||||
repository, now checked by the repository's name in its condition as well as by the run's trigger.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **A frame-generation "state" of ×1336.0.** The owner's Silent Hill 2 session (0.1.0-beta.25, the NVIDIA App's
|
||||
*Dynamic* multi frame generation) listed a ×1336.0 state — 0.20 → 267.20 FPS for ten seconds — under *Frame
|
||||
generation in this session*, and the DLSS line cited it: *DLSS 4.5 (a ×1336.0 frame-generation state)*. Those ten
|
||||
seconds — the game compiling its shaders at start — were presented with one application frame counted per
|
||||
five-second window, and a window needed eight presents but only one counted frame to be read. A window now needs eight
|
||||
application frames and a ratio no higher than ×8 — more than any frame generation produces (DLSS 4.5's ×6 is the
|
||||
most); every other window is *Not classified*, and the steady state reads the same windows. A session-wide or live ratio that held above ×8 is
|
||||
refused and says why (*the ratio is beyond what any frame generation produces*), in en/vi/ja. Sessions already
|
||||
recorded are read by the same rule, so that session now lists ×2.0, ×3.0, ×6.1, no frame generation and 30 seconds
|
||||
not classified, and its DLSS line cites ×6.1. The owner's runs of beta.24 and beta.25 are recorded in
|
||||
`docs/spike-notes/22-owner-runs-2026-10-19.md`: the *Dynamic* settings line matched the NVIDIA App's own words, the
|
||||
override's two library names are written down, and Lies of P read no FSR mode with the query hooked — the title
|
||||
rounds its own render size and asked nothing the hook kept.
|
||||
@@ -0,0 +1,56 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.27 was cut, 2026-10-20 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.27] - 2026-10-20
|
||||
|
||||
**The twenty-seventh pre-release: the owner's eight sessions of 2026-10-20, checked — six faults fixed, and *Start
|
||||
directly* says what a Steam game may do.** The same unsigned installer: verify its hash against `SHA256SUMS.txt`, then
|
||||
*More info → Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.26`:** Help ▸ Check for updates, then *Restart to update* with no game running. Nothing is
|
||||
shown for you to accept again (the Disclaimer stays 2.11, the Privacy Policy 2.12), the ledger stays at schema 21, and
|
||||
no game is read again: the detection rules (`2026.10.4`) are beta.26's. Sessions you already recorded read the
|
||||
frame-generation fix at once; the driver's DLSS report, the display sizes and the game Steam starts are recorded from
|
||||
this version on — nothing already stored is rewritten.
|
||||
|
||||
### Changed
|
||||
|
||||
- **Play ▸ *Start directly* says what a Steam game may do.** Some Steam games hand themselves to Steam when
|
||||
FrameLedger starts them — Lies of P closes within seconds and Steam starts it again. Starting a game Steam installed,
|
||||
the notice now says it may hand itself to Steam first and that the game Steam then starts is recorded; the *Start
|
||||
directly* tooltip and Settings ▸ Games ▸ *Play button* say so too, adding that a few will not start outside Steam at
|
||||
all. Steam games keep *Start directly*: three of the five started directly on 2026-10-20 ran and were measured from
|
||||
their first frame, and a Vulkan game is measured only when FrameLedger starts it. In en/vi/ja (ja marked for review).
|
||||
|
||||
### Fixed
|
||||
|
||||
- **A frame-generation "state" of ×2.52.** The owner's Silent Hill 2 session under the NVIDIA App's *Dynamic* multi
|
||||
frame generation listed ×2.52 for 13 seconds beside ×2.0 and ×3.0: the five-second windows in which the multiplier
|
||||
stepped from ×2 to ×3 read in between, and three of them formed a state nobody held. Every frame generation that
|
||||
ships multiplies by a whole number, so a window now counts toward a state only within 10 % of one; the others are
|
||||
*Not classified*. Sessions already recorded are read by the same rule: that session lists ×2.0, ×3.0, no frame
|
||||
generation and 7.36 % not classified. The owner's runs of 2026-10-20 are recorded in
|
||||
`docs/spike-notes/23-owner-runs-2026-10-20.md`.
|
||||
- **The NVIDIA driver's DLSS report was lost from every stored session.** FrameLedger asked the driver one last time
|
||||
after the game had closed, and that answer — which no longer says DLSS ran — replaced the ones read while the game
|
||||
ran. So no session said *DLSS (driver-reported)* where no hook saw DLSS, and none named the NVIDIA App's quality mode
|
||||
on such a game: Clair Obscur: Expedition 33 under the App's override read *Upscaler not identified*. The driver is no
|
||||
longer asked once the game has closed, and once it reports that DLSS ran, the session keeps it. Sessions recorded
|
||||
before keep what they stored.
|
||||
- **Play ▸ *Start directly* recorded nothing of a game that hands itself to Steam.** Lies of P, started directly, closes
|
||||
within seconds and Steam starts it again; the game Steam started was turned away while the first session ended and
|
||||
never recorded. It is now recorded once that session ends, as a game started again already was. Each such start
|
||||
still counts toward the two early exits that turn hooking off for a game, so Limitations ▸ Play advises starting such
|
||||
a game through its store.
|
||||
- **Opening a session's summary twice opened two windows.** The open window comes forward instead, restored if
|
||||
minimised.
|
||||
- **No window or monitor size for a game in exclusive full-screen.** A game leaving exclusive full-screen closes its
|
||||
window a moment before its swap chain says so, and those last samples replaced the sizes: two Lies of P and three
|
||||
Dark Souls III sessions show none. The sizes are now the last ones the mode saw.
|
||||
- **A DLSS line that said only "DLSS"**, under a header that already did, is no longer shown: the NVIDIA App's override
|
||||
loads its libraries under names FrameLedger does not list (The Witcher 3), and the *Loaded:* line prints them.
|
||||
- **Two integration tests that failed under load** (developers only). The guard reads every process above the test
|
||||
harness too, the test host among them, and under a full `build.ps1 check` the test host is still starting its other
|
||||
test classes: a module it released while the guard read its list refused the injection (`ModuleScanFailed`, and
|
||||
`ProcessUnreadable` on 2026-10-19). The drain suite asks the guard again on those two reasons, four times at most;
|
||||
the pause case, which once read the writer still starting, waits for it to be ready; and every injection test waits
|
||||
for the harness's own "presenting" line instead of 800 ms (`tests/Shared/HarnessReady.cs`).
|
||||
@@ -0,0 +1,26 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.28 was cut, 2026-10-20 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.28] - 2026-10-20
|
||||
|
||||
**The twenty-eighth pre-release: the Dashboard shows every game being recorded.** The same unsigned installer: verify
|
||||
its hash against `SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.27`:** Help ▸ Check for updates, then *Restart to update* with no game running. Nothing is
|
||||
shown for you to accept again (the Disclaimer stays 2.11, the Privacy Policy 2.12), the ledger stays at schema 21, and
|
||||
no game is read again: the detection rules (`2026.10.4`) are beta.27's. Only the App changes; the capture agent and
|
||||
what it records are beta.27's.
|
||||
|
||||
### Added
|
||||
|
||||
- **The Dashboard shows every game being recorded.** Two games running at once are two sessions, and until now the
|
||||
Dashboard's *Live capture* card showed one of them — a measured one first — while the other appeared only as
|
||||
*Running sessions: 2*. Each running game now has its own card, side by side, with its own frame rate, settings,
|
||||
elapsed time and memory, or why it is recorded without being measured; measured games come first, and the title
|
||||
says how many games are being recorded (*2 games recording*). In en/vi/ja (ja marked for review).
|
||||
|
||||
### Fixed
|
||||
|
||||
- **A native injection test that failed under load** (developers only). Two `fl_guard_test` cases — the OpenGL hook,
|
||||
and a swap chain on a real window — waited 4 seconds for twenty frames, and on a loaded CI runner (the suite took
|
||||
115 s) the OpenGL hook, installed, had recorded none. They now wait up to 12 seconds, the harness presenting for 16,
|
||||
and a failure says the writer's state.
|
||||
@@ -0,0 +1,55 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.29 was cut, 2026-10-25 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.29] - 2026-10-25
|
||||
|
||||
**The twenty-ninth pre-release: updated libraries, and SonarCloud analysing every change from CI.** The same unsigned
|
||||
installer: verify its hash against `SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.28`:** Help ▸ Check for updates, then *Restart to update* with no game running. Nothing is
|
||||
shown for you to accept again (the Disclaimer stays 2.11, the Privacy Policy 2.12), the ledger stays at schema 21, and
|
||||
no game is read again: the detection rules (`2026.10.4`) are beta.28's. What you see and what is recorded are
|
||||
beta.28's; the libraries under them are newer.
|
||||
|
||||
### Changed
|
||||
|
||||
- **SonarCloud analyses the repository from CI** (developers only; owner decision D68). The owner turned SonarCloud's
|
||||
Automatic Analysis off and set the `SONAR_TOKEN` secret; `ci.yml`'s new `sonarcloud` job runs the SonarScanner for
|
||||
.NET 12.0.0 (a local tool, `.config/dotnet-tools.json`) after `check`, in a build of its own — the scanner turns
|
||||
warnings-as-errors off in the build it instruments, so it cannot wrap the gate's — with the gate's own test coverage
|
||||
(`build.ps1` now writes OpenCover beside Cobertura; the C# only, since the PowerShell tools and the native code have
|
||||
no coverage report) and CMake's compilation database for the C++, which
|
||||
`FrameLedger.Infrastructure.csproj` names to the scanner only in that build. `SonarQube.Analysis.xml` replaces
|
||||
`.sonarcloud.properties`. The job is advisory, not a required check, and waits for the quality gate, so a failed gate
|
||||
is a red job (`docs/13_CI_CD.md` §SonarCloud).
|
||||
- **Dependabot, the NuGet audit and CodeQL** (developers only). Dependabot's version updates wait seven days after a
|
||||
release (security updates do not), and the actions' minor and patch releases come as one pull request a week. The
|
||||
NuGet audit is written down in `Directory.Build.props` (the whole graph, every severity — the SDK's defaults for
|
||||
net10.0), so a later SDK cannot move it. CodeQL also reads the workflows (`analyze (actions, none)`, not required),
|
||||
and a new push to a pull request replaces its CodeQL run.
|
||||
- **The libraries Dependabot never updated.** Every NuGet pull request Dependabot opened here updated analyzers only,
|
||||
so the libraries fell behind with nothing to say so (`docs/13_CI_CD.md` §Dependabot and the NuGet audit). Updated by
|
||||
hand, each release at least seven days old (the cooldown Dependabot now keeps): the October .NET servicing release of
|
||||
`Microsoft.Extensions.Hosting`, `Microsoft.Data.Sqlite` and `System.Diagnostics.EventLog` (10.0.13) and `Dapper`
|
||||
2.1.89, which ship; the CsWin32 source generator 0.3.363, which writes the Win32 declarations the shipped code calls;
|
||||
for developers, the test SDK 18.11.0 and xunit 4.0.2. The licence texts under `legal/licenses/nuget/` name the new
|
||||
versions; no licence changed. Not taken: Markdig 1.5.0 (published the day before, and its licence is a reviewed copy
|
||||
at the packaged commit), Velopack 1.2.161 (the updater itself — a change to how updates install is the owner's to
|
||||
try), FluentAssertions 8 (its licence) and `coverlet.collector` 10.1.0: the tracker it adds to each assembly it
|
||||
instruments declares a constant whose value reflection cannot read ("Literal value was not found"), and
|
||||
`NoSecondMatcherTests` reads every string constant in three of ours. The first CI run blamed CsWin32 for it; with
|
||||
coverage collected locally the failure followed coverlet, and 10.0.1 passes (`Directory.Packages.props` says so
|
||||
beside it).
|
||||
|
||||
### Fixed
|
||||
|
||||
- **The 34 C++ issues of `main`'s first SonarCloud analysis from CI** (developers only). Read with MSVC's real flags,
|
||||
the native code showed issues Automatic Analysis had not, on older lines; SonarCloud dates each by blame, and the
|
||||
two on lines changed since its new code began failed `main`'s gate on reliability. One was a defect in a test tool: `hook-harness --opengl` or `--vulkan` beside
|
||||
a D3D11 mode — or `--opengl` alone, which ran the default probes — called through a null swapchain; every mode that
|
||||
drives the D3D11 swapchain now asks first. The rest: `NvU32` printed with `%u` in `fl-probe-nvapi` (`%lu`; its
|
||||
machine line reads the same), a union and a `strlen` in the guard's tests, a `LARGE_INTEGER` read through
|
||||
`QuadPart` after `{}` had made its other member the active one (the Overlay's clock epoch, and the Vulkan layer's
|
||||
once-per-process enable-list read — now initialised through `QuadPart`), two terminators written after a read whose
|
||||
bound is now tested first, and five marked `// NOSONAR` with the reason above each. The Overlay compiles to the same
|
||||
instructions: built from either side, in one folder with one build id, its `.text` is byte-identical
|
||||
(`docs/13_CI_CD.md` §SonarCloud has the table).
|
||||
@@ -0,0 +1,140 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.3] - 2026-09-21
|
||||
|
||||
**The third pre-release.** The same unsigned installer as before: verify its hash against `SHA256SUMS.txt`, then
|
||||
*More info → Run anyway*. What changed for a user:
|
||||
|
||||
- **The terms changed, so the Legal Gate opens once after the update.** They now say plainly that this is beta
|
||||
software with bugs, that your PC must meet each game's own minimum requirements, and what the new guard bypass means.
|
||||
- **CPU load, system memory and (when the Agent runs as administrator with PawnIO) CPU temperature are recorded**, and a
|
||||
game's Trend tab can chart them, the GPU's load and power, VRAM and the ×FG factor across that game's sessions.
|
||||
Settings ▸ System shows this PC as FrameLedger records it.
|
||||
- **DLSS is named.** Titles that call DLSS directly read "Unknown upscaler"; they now read "DLSS (driver-reported)"
|
||||
where the NVIDIA driver reports it — including sessions you already recorded.
|
||||
- **A game imported from Steam could never hook** when the import picked a helper executable instead of the game
|
||||
(GIRLS' FRONTLINE 2 was one). The import picks the game now, and the game page shows the executable and can change it.
|
||||
- **The platform and engine tags were blank white boxes in the light theme.** Fixed.
|
||||
- **New, off by default, per game: "Bypass the anti-cheat guard (at your own risk)".** Read its warning. Your account
|
||||
can be permanently banned, and the developers accept no responsibility if you turn it on.
|
||||
|
||||
**Updating from `0.1.0-beta.2`:**
|
||||
|
||||
- Quit the App (tray icon → Exit) before installing, as before.
|
||||
- On its first start the ledger migrates to schema 7 (the guard-bypass columns; nothing existing is rewritten).
|
||||
- **A game an earlier Steam import created for the wrong executable is not rewritten.** Open it, check the path under
|
||||
its name, and use *Change executable…* (hooking is turned off for it and must be enabled again), or remove it.
|
||||
- Sessions recorded before this version keep N/A for CPU load, memory and CPU temperature: nothing measured them.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **DLSS read "Unknown upscaler" on most titles while FSR was named.** Most DLSS titles call NGX directly, and no NGX
|
||||
hook may exist (the SDK's licence; `20_OPEN_QUESTIONS`), so the hook runs and sees nothing. The NVIDIA driver does
|
||||
report the feature per process, the Agent has stored that on every session since P2
|
||||
(`sessions.upscaler_driver_reported`) and the capture host has printed it since 2026-09-06 — **the App never read
|
||||
it.** It does now: where no hook named an upscaler and the driver reports NGX super resolution created and
|
||||
evaluated, the library, the session summary, the game page and the live card say **DLSS (driver-reported)** —
|
||||
attributed, identity only, never a quality. A hook's name still outranks it. Sessions already recorded show it too,
|
||||
because the column was always written. `unknown` itself now reads "Upscaler not identified". Nothing native changed.
|
||||
- **A measured DLSS preset is its name, not its number**: `DLSS Balanced`, not `DLSS 2` (`Domain.Metrics.UpscalerNames`,
|
||||
which `03_METRICS` had promised from the start). Only the Streamline route produces the byte; a value with no name
|
||||
is shown as stored. A preset derived from the render scale is still not shown — that is an open owner decision.
|
||||
|
||||
- **The Games card's platform and engine tags were empty white boxes in the light theme.** They were
|
||||
`ui:Badge Appearance="Secondary"`, whose WPF UI 4.3.0 trigger repaints the background only and keeps the default
|
||||
badge's on-accent foreground: near-white text on a near-white fill. They, and the edit dialog's "Detected" marker,
|
||||
are the App's own `TagPill` now, with the theme's secondary text; `ContrastTests` refuses a Secondary badge in App
|
||||
XAML beside the four palette appearances it already refused (`08_UI` §Contrast).
|
||||
- **A game imported from Steam could be a game that never hooks.** Steam names no executable, so the import guessed
|
||||
"the largest non-helper", and on GIRLS' FRONTLINE 2: EXILIUM that was the embedded browser
|
||||
`GF2_Exilium_Data\Plugins\ZFGameBrowser.exe`, not the 675 KB Unity player `GF2_Exilium.exe`. Everything downstream is
|
||||
keyed on the executable path, so hooking enabled on that row could never match the running game, while the same
|
||||
game added by its exe worked. The locator now ranks by the engines' own layouts (Unity `X.exe` beside `X_Data`,
|
||||
Unreal `*-Win64-Shipping.exe`), then by a name matching the install folder, then by size; it skips `X_Data\Plugins`
|
||||
and redistributables folders, knows `browser`/`webview`/`subprocess`/`analyzer`/`vconsole` as helpers, and walks four
|
||||
levels instead of three. Verified read-only over the owner's Steam library: GF2, Red Dead Redemption 2 (was the
|
||||
Rockstar launcher installer), Counter-Strike 2 (was `vconsole2.exe`), Rune Factory, Dying Light: The Beast (was
|
||||
nothing at all). **A row an earlier import created for the wrong executable is not rewritten**: remove it, or use
|
||||
the new button below.
|
||||
|
||||
### Added
|
||||
|
||||
- **A per-game "bypass the anti-cheat guard" switch, at your own risk (owner decision 2026-09-21).** Off by default,
|
||||
never global: there is no setting, no command-line switch and no rules-file field for it. Turning it on opens its
|
||||
own disclosure, which says what the guard found for that game, that anti-cheat treats a loaded DLL as tampering
|
||||
whatever it does, that **your account can be permanently banned without warning or appeal**, that FrameLedger does
|
||||
not hide and never will, and that **by turning it on you accept the entire risk yourself and the developers accept
|
||||
no responsibility or liability**. It is accepted only by ticking the acknowledgement AND typing `BYPASS`; Enter keeps
|
||||
the guard on. The Agent stamps it (the App writes nothing), keyed on the executable like consent; turning hooking
|
||||
off or the executable changing turns it off again. **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, a failed injection and
|
||||
a Vulkan title the guard refuses all still refuse. The guard still runs every check and still reports what it
|
||||
found; the verdict is `AllowedUnderUserBypass`, never `Allow`. **How FrameLedger injects is unchanged** — the same
|
||||
documented `LoadLibraryW`, the DLL's real name and version info, one chokepoint file (CLAUDE.md rule 3). Every
|
||||
session started under it is marked, permanently, with what the guard found: in the sessions list, the session
|
||||
summary, the CSV and JSON exports (schema 0007: `games.guard_bypass_*`, `sessions.guard_bypassed` /
|
||||
`guard_bypass_family` / `guard_bypass_signal`). A session recovered after an Agent crash does not carry the mark.
|
||||
CLAUDE.md rule 2, `19_SAFETY`, `02_SPEC` FR-2.7, `SECURITY.md` and `tools/chokepoint-check.ps1`'s own description
|
||||
are amended with it. Japanese shows this dialog in English until a reviewer signs the translation.
|
||||
|
||||
- **CPU load, memory in use and (elevated) CPU temperature are measured.** `sessions.avg_cpu_load`, `avg_cpu_temp`,
|
||||
`max_cpu_temp` and `avg_ram_mb`, and the `cpu_load` / `cpu_temp` / `ram_mb` sensor series, were in the schema from
|
||||
0001 with no producer. The telemetry poller now reads the machine beside the GPU on the same 1 Hz tick: CPU time
|
||||
busy across every logical processor (`GetSystemTimes` — not Task Manager's frequency-scaled "utility") and physical
|
||||
memory in use, both unprivileged and opening no process. **CPU temperature is read only when the Agent runs as
|
||||
administrator with PawnIO installed, and has not been checked on real hardware yet**; everywhere else it is N/A,
|
||||
never 0. Sessions recorded before this keep their nulls; no migration. The live card carries CPU load and
|
||||
temperature (`SessionProgress.cpuLoadPct`, optional).
|
||||
- **One game's sessions over time, beyond the frame rate.** The game page's Trend tab gains average GPU load, average
|
||||
GPU power, max VRAM (game), average CPU load, max CPU temperature, average memory in use, and the **×FG factor**. A
|
||||
factor that is its session's steady state (rule 6) covers part of the session, so it is left out by default and
|
||||
drawn marked when "include mid-session changes" is on — never as the session's. The Sensors chart draws CPU
|
||||
temperature, CPU load and system memory; Compare gains average GPU load, average CPU load and max CPU temperature;
|
||||
the session summary gains GPU and CPU cards (average load · peak temperature).
|
||||
- **Settings ▸ System shows this PC** — processor, graphics card and driver, memory, Windows build, primary display —
|
||||
as FrameLedger records it with every session, with a Copy button; nothing is sent anywhere. The session summary
|
||||
shows that session's snapshot under its header, and `--diag` prints the machine's. The bug bundle is unchanged.
|
||||
|
||||
- **Game page: the row's executable is shown, and "Change executable…" re-points it.** The remedy for a wrong import
|
||||
guess used to be remove-and-add. The row comes back exactly as a new game would — hooking off, no consent, pre-scan
|
||||
not run — with consent revoked over the pipe first, as removal does; a block is never cleared by it, and a path
|
||||
another row owns (in the library, or removed with its sessions kept) is refused.
|
||||
|
||||
### Changed
|
||||
|
||||
- **The terms say what an end user needs to hear, and must be accepted again.** `legal/DISCLAIMER.md` 2.2 -> **2.3**:
|
||||
a new §0 (**this is pre-release software — it certainly still has bugs, and the developer is not responsible for
|
||||
incidents that result**), §2A (the guard bypass, entirely at your own risk, no liability), §4A (**your PC must meet
|
||||
at least the minimum requirements the game's developer or publisher states — read them first; problems on a machine
|
||||
below them, or on unstable, overclocked or overheating hardware, are yours and not the developer's**) and §7A (back
|
||||
up your own data; builds are unsigned, download only from the project's Releases page and verify the hash; no
|
||||
affiliation with any game, platform or vendor; numbers are for your own information). `legal/EULA.md` 1.0 -> **1.1**
|
||||
says the same in §2A/§2B. The first-run Legal step shows a short plain-language summary of those points in en/vi/ja
|
||||
above the documents, which remain the terms. Because both versions moved, the Legal Gate opens once after the update.
|
||||
The accuracy block's Safety bullet no longer says "There is no override anywhere".
|
||||
- **Docs that had gone stale.** `legal/THIRD_PARTY_NOTICES.md` gains the test-time row it never had (xUnit.net v3 4.x
|
||||
under Apache-2.0, FluentAssertions 7.x and why it is pinned, NSubstitute, coverlet, Test.Sdk, Catch2);
|
||||
`16_WPFUI_SYNTAX` named a TFM this repository never built; `14_TESTING` still called Catch2 and the blocked toggle
|
||||
future work; README's status line said "pre-alpha" beside three pre-releases; `build.ps1` "skipped" the coverage and
|
||||
rules gates when their tools were missing, which its own header calls worse than no gate — a missing tool fails now.
|
||||
- **Two flaky tests, seen on CI the same day.** The native-log test slept a fixed 1500 ms and read the Overlay's log
|
||||
between two lines (it polls for the last one now); `ParentDumpTests` dumped a child process microseconds after starting
|
||||
it and got `ERROR_PARTIAL_COPY` (it waits for the child to finish loading). Neither was a product defect.
|
||||
- **A local native build no longer fails on an uncommitted change.** After the first tag `git describe --dirty`
|
||||
produces `v0.1.0-beta.2-2-g<12 hex>-dirty`, 35 characters against `FlShmHandshake::buildId`'s 31, so every CMake
|
||||
configure of a dirty tree was fatal and the workaround was "commit before you build". The id now falls back to an
|
||||
8-digit abbreviation with `+` for dirty when the long form does not fit; a release is a clean checkout at a tag and
|
||||
never takes the fallback. Still too long after that is still fatal.
|
||||
- **Dependencies, 2026-09-21.** The test framework moves from xUnit.net v3 3.2.2 to **4.0.1**, referenced as
|
||||
`xunit.v3.mtp-off` with `xunit.runner.visualstudio` 4.0.0: 4.0 makes Microsoft Testing Platform v2 the default of the
|
||||
plain `xunit.v3` package, and `build.ps1`'s gates are VSTest-shaped on purpose (the `XPlat Code Coverage` collector,
|
||||
the `results.trx` the struct-mirror gate and the 25-minute wall clock read), so the projects take the same 4.x
|
||||
framework through the variant xunit publishes for that. The tree carried no v2-era API; the one test change is a
|
||||
race 4.0.1's scheduler found on its first gate run: eight `App.Tests` classes write the process-wide `Strings.Culture`
|
||||
and ran in parallel, so `StringsTests` read "Settings" where it had just written `vi`. They share one collection now.
|
||||
Also: Dapper 2.1.86, Microsoft.Data.Sqlite / Microsoft.Extensions.Hosting / System.Diagnostics.EventLog 10.0.12,
|
||||
CsWin32 0.3.333, Roslynator 5.0.0, Meziantou.Analyzer 3.0.266, Microsoft.NET.Test.Sdk 18.10.1, NSubstitute 6.2.0.
|
||||
**Deliberately not moved:** `WPF-UI [4.3.0]` and `FluentAssertions [7.2.2]` (8.x is not an OSI licence), both pinned
|
||||
with their reasons in `Directory.Packages.props`. `legal/licenses/nuget/` is regenerated for the shipped packages
|
||||
that moved.
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.30 was cut, 2026-10-26 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.30] - 2026-10-26
|
||||
|
||||
**The thirtieth pre-release: Enter in the consent dialog, readable hardware-change markers, updated libraries, and the
|
||||
.NET 10.0.14 runtime.** The same unsigned installer: verify its hash against `SHA256SUMS.txt`, then *More info → Run
|
||||
anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.29`:** Help ▸ Check for updates, then *Restart to update* with no game running — a download
|
||||
of about 5 MB. Nothing is shown for you to accept again (the Disclaimer stays 2.11, the Privacy Policy 2.12), the ledger
|
||||
stays at schema 21, and no game is read again: the detection rules (`2026.10.4`) are beta.29's. This update is installed
|
||||
by beta.29's updater; the next one is the first that this release's updater installs.
|
||||
|
||||
### Changed
|
||||
|
||||
- **Updated libraries, and a version conflict removed** (owner decision D71 for the updater). Velopack, the installer
|
||||
and updater, 1.2.0 → 1.2.161 with its packing tool: the update from beta.29 to this release is still installed by
|
||||
beta.29's updater, and the next one is the first this one installs. Markdig, which draws the documents the App shows,
|
||||
1.4.0 → 1.4.2 (parser fixes; its licence text is unchanged). The database's `SQLitePCLRaw` is again the version
|
||||
`Microsoft.Data.Sqlite` declares, 2.1.13: a pin kept since August for a security issue fixed since had put it on
|
||||
another major version with nothing to say so; the SQLite engine is 3.53.3 (it was 3.53.4). Not taken, each with its
|
||||
reason in `docs/13_CI_CD.md` §Dependabot and the NuGet audit: the .NET 10.0.14 packages (a day old), Markdig 1.5.0,
|
||||
CsWin32 0.3.366 and 0.3.367, `coverlet.collector` 10.1.0 and FluentAssertions 8.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **Enter in the consent dialog declined, and the hooking switch then showed on beside "off"** (owner decision D69).
|
||||
The dialog's default button was *Keep hooking off* — the rule was "Enter never enables" — and WPF UI's template sends
|
||||
Enter to the default button, so typing `I ACCEPT THE INJECTION RISK` and pressing Enter kept hooking off without a
|
||||
word. Asked with that, the owner chose: Enter enables once the phrase is typed exactly, as a click on *Enable hooking*
|
||||
does, and does nothing before it; Esc and *Keep hooking off* still decline. The typed phrase is still the gate — the
|
||||
button Enter reaches stays disabled and hidden until the phrase matches — and no text of the dialog changed
|
||||
(`consent-dialog/1`). The game page's two switches, Hooking and Recording, now read their row again after every
|
||||
click: a click that changed nothing — the dialog declined, a refusal, no agent running — left the switch on while the
|
||||
text beside it said off, and the next click asked to enable again (`docs/19_SAFETY_AND_ANTICHEAT.md` §User-facing
|
||||
consent, `docs/08_UI.md` §Keyboard).
|
||||
- **A hardware change on a game's charts was cut off and hard to read** (owner decision D70). *Sessions at a glance* and
|
||||
the *Trend* marked each day the GPU driver, GPU, CPU, display or Windows changed with a dashed line labelled with the
|
||||
change itself — white on orange, its top cut off by the chart's edge, and a day with several changes showed one at
|
||||
most. Each such day now carries a number — 1 for the oldest, the same on both charts — in a band kept above the chart,
|
||||
dark on the orange in both themes, never cut off and never over another: badges too close for their lines stand aside,
|
||||
joined to them, and a run that still cannot stand side by side is one badge (*3–5*). The list under each chart gives
|
||||
each number's day and every change in full, and pointing at a line or a badge shows the same text. In en/vi/ja (ja
|
||||
marked for review). A click on *Sessions at a glance* now reads the pointer at the monitor's own scale
|
||||
(`docs/08_UI.md` §Games, §DPI).
|
||||
|
||||
### Security
|
||||
|
||||
- **The .NET runtime inside is 10.0.14**, Microsoft's out-of-band security release of 2026-10-25 (CVE-2026-111497, a
|
||||
Brotli decompression flaw; it also completes the SocketAsyncEventArgs fix, CVE-2026-70197, that 10.0.13 left
|
||||
incomplete). FrameLedger is self-contained, so
|
||||
it ships the runtime of the SDK that builds it: beta.29 carried 10.0.13; this release was built with SDK 10.0.403 and
|
||||
carries 10.0.14 — read from the published package's `FrameLedger.deps.json` in the release rehearsal.
|
||||
@@ -0,0 +1,24 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.31 was cut, 2026-10-26 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.31] - 2026-10-26
|
||||
|
||||
**The thirty-first pre-release: the remaining library updates.** The same unsigned installer: verify its hash against
|
||||
`SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.30`:** Help ▸ Check for updates, then *Restart to update* with no game running. Nothing is
|
||||
shown for you to accept again (the Disclaimer stays 2.11, the Privacy Policy 2.12), the ledger stays at schema 21, and
|
||||
no game is read again: the detection rules (`2026.10.4`) are beta.30's. This is the first update that beta.30's updater
|
||||
(Velopack 1.2.161) installs; if it downloads the whole package rather than a few megabytes, or the App does not come back,
|
||||
the installer on this page puts it right. What you see and what is recorded are beta.30's; the libraries under them are
|
||||
newer.
|
||||
|
||||
### Changed
|
||||
|
||||
- **The remaining library updates** (the owner's request after beta.30, owner decision D72 — inside the seven-day wait
|
||||
the project otherwise keeps). The .NET 10.0.14 servicing packages the App and the agent use
|
||||
(`Microsoft.Extensions.Hosting`, `Microsoft.Data.Sqlite`, `System.Diagnostics.EventLog`; beta.30 already carried the
|
||||
10.0.14 runtime) and Markdig 1.5.0 (its licence text unchanged); for developers, the CsWin32 generator 0.3.367,
|
||||
Meziantou.Analyzer 3.0.317, `coverlet.collector` 10.1.0 — a test that reads every constant of three assemblies now
|
||||
leaves out the types the coverage tool adds to them — and Catch2 3.16.1 for the native tests. The SQLite engine stays
|
||||
3.53.3 (`SQLitePCLRaw` 2.1.13, which `Microsoft.Data.Sqlite` 10.0.14 still declares). Still not taken: FluentAssertions
|
||||
8, for its licence (`docs/13_CI_CD.md` §Dependabot and the NuGet audit).
|
||||
@@ -0,0 +1,45 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.32 was cut, 2026-10-31 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.32] - 2026-10-31
|
||||
|
||||
**The thirty-second pre-release: the alpha line's groundwork.** An *alpha* — the same program built on a version of .NET
|
||||
Microsoft has not finished, .NET 11 first — is published beside the betas from now on, and this beta carries what that
|
||||
needs; nothing in a beta's measuring changed. The same unsigned installer: verify its hash against `SHA256SUMS.txt`, then
|
||||
*More info → Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.31`:** Help ▸ Check for updates, then *Restart to update* with no game running. The terms
|
||||
window shows the **EULA 1.6** and the **Disclaimer 2.12** once — each now says the builds are pre-releases, betas *and
|
||||
alphas*; nothing else in them moved — and the Privacy Policy stays 2.12. The ledger stays at schema 21 and the detection
|
||||
rules at `2026.10.4`. A beta never updates to an alpha: an alpha is installed only on purpose, from its own release page
|
||||
(the user guide's new page, *Alpha builds*).
|
||||
|
||||
### Added
|
||||
|
||||
- **The alpha line** (the owner's request of 2026-10-31, owner decisions D73–D76): an `alpha` branch builds this source
|
||||
on a prerelease .NET — .NET 11 RC3 first — and publishes it as `x.y.z-alpha.N` pre-releases on an update channel of
|
||||
their own, so a beta never updates to an alpha and an alpha never to a beta. What the line needs on main changes nothing
|
||||
in a beta: the `RELEASE_LINE` file and the line every assembly is stamped with (`Shared.BuildLine`), `release.yml`'s
|
||||
rule that an alpha is tagged on the alpha line and nowhere else and packed on Velopack's `alpha` channel, CI on the
|
||||
`alpha` branch, and no wiki publish for an alpha (`docs/12_BUILD.md` §The alpha line, `docs/13_CI_CD.md` §The alpha
|
||||
line, `docs/11_UPDATER.md` §Channels). Whether the main line ever leaves .NET 10 is an open question whose decision
|
||||
table is written before the evidence (`docs/20_OPEN_QUESTIONS.md` §G, *The main line's .NET*).
|
||||
- **An alpha says what it is, and asks first** (owner decisions D73 and D74; none of it shows in a beta). Its terms window
|
||||
shows the **Alpha notice** (`legal/ALPHA_NOTICE.md` 1.0) with the other documents and a box of its own to tick — *I
|
||||
understand that this is an experimental build and I use it at my own risk* — and Accept waits for it; until it is
|
||||
accepted the alpha's capture agent does not run. The title bar carries an **ALPHA** badge, a banner says what the build
|
||||
is at every start, Help ▸ About and `--diag` name the .NET it runs on, and its update channel is locked: an alpha updates
|
||||
only to newer alphas. It replaces the beta and shares its data, so before it first opens the database it copies it to
|
||||
`backups\ledger-before-<version>.db` (the newest three are kept) and does not open it if the copy cannot be made. The
|
||||
user guide has a page for it, *Alpha builds*, and `LIMITATIONS.md` a section.
|
||||
|
||||
### Changed
|
||||
|
||||
- **The EULA (1.6) and the Disclaimer (2.12) say the builds are pre-releases — betas, and alphas** (owner decision D75):
|
||||
they said every build was a beta, which an alpha would make untrue. Nothing else in them moved; the terms window shows
|
||||
them once more after the update. About ▸ Legal documents lists the Alpha notice on every build, for information.
|
||||
- **What .NET 11's SDK asks of the source, taken where .NET 10 can take it too** (owner decisions D73–D76): the whole
|
||||
gate run on .NET 11 RC3 before the alpha line was cut found 21 places its analyzers flag — `LastIndexOf`,
|
||||
`StartsWith` and `EndsWith` of a single character, which .NET 11 overloads with a comparison; string sets and maps
|
||||
built with `[]`, which C# 15 can give a comparer; one undisposed `JsonDocument` in a test. Each is rewritten in a form
|
||||
both SDKs compile and that answers exactly as before (ordinal, as it was). Every test suite passed on .NET 11 with no
|
||||
change of answer (`docs/spike-notes/24-dotnet11-probe.md`).
|
||||
@@ -0,0 +1,71 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.33 was cut, 2026-11-03 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.33] - 2026-11-03
|
||||
|
||||
**The thirty-third pre-release: games from the Xbox app and the Microsoft Store.** PC Game Pass games included: Import
|
||||
library finds the games those apps installed, a game's page shows its own logo and splash image, **Play** starts one
|
||||
through Windows as its Start-menu tile does, and, with your consent, FrameLedger hooks it like any other game. How these
|
||||
games are laid out, how Windows starts them and what it lets another program read were measured first on the owner's
|
||||
eleven titles; a hooked session of one is still to be run. The same unsigned installer: verify its hash against
|
||||
`SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.32`:** Help ▸ Check for updates, then *Restart to update* with no game running. The terms
|
||||
window shows the **Privacy Policy 2.13** once — it names what the Xbox library reads, that Play asks Windows to start
|
||||
such a game, and the two facts read from a game before any injection; the EULA and the Disclaimer do not change. The
|
||||
ledger stays at schema 21; the detection rules move to `2026.11.1`, so every game in the library is read again once.
|
||||
|
||||
### Added
|
||||
|
||||
- **Games from the Xbox app and the Microsoft Store** (the owner's request of 2026-11-03, owner decisions D77–D81; PC Game
|
||||
Pass games included): **Import library** finds the games those apps installed into a games folder — each drive's
|
||||
`.GamingRoot` names the folders, each game's own `MicrosoftGame.config` and `appxmanifest.xml` say what it is, and
|
||||
Windows says whether its package is installed for you — and lists them as **Xbox**, with the process that actually
|
||||
draws (an Unreal title's shipping executable, not the stub its package launches; never the GDK's `gamelaunchhelper.exe`).
|
||||
A game's page shows its own square logo and splash image, read from its folder, and its package version (*Xbox version
|
||||
1.3.5124.0*). Only games built on Microsoft's GDK are listed; an older Store app (UWP) is not (`docs/05_DETECTION.md`
|
||||
§Platform signatures & metadata, `LIMITATIONS.md`, the user guide). Everything was measured first, on the owner's eleven
|
||||
titles: the layout, and what Windows lets another program read there — every game executable refuses to be read, so no
|
||||
Unreal Engine version is shown for these games (`docs/spike-notes/25-xbox-gdk.md`).
|
||||
- **The detection rules know Xbox games** (rules `2026.11.1`, so every game in the library is read again once): an `xbox`
|
||||
platform, first in the list — a GDK FINAL FANTASY ships Steam's DLL and read *Steam* — decided by a new signal,
|
||||
`root_file`, from the install folder's own listing, so a very large install whose deep walk ran short still reads as
|
||||
its store (`docs/05_DETECTION.md`).
|
||||
- **Play starts a game from the Xbox app or the Microsoft Store through Windows** (D80), in either Play mode and from an
|
||||
App running as administrator: the user's shell activates the game's package as its Start-menu tile does
|
||||
(`explorer.exe shell:AppsFolder\<AUMID>`), because started by its path such a game is never the game in its package —
|
||||
measured on the owner's titles (`docs/spike-notes/25-xbox-gdk.md`). The capture agent refuses to start one by its path
|
||||
(`LaunchGame` answers `PackagedGame`), and the game is recorded once it appears, a few seconds after its start
|
||||
(`docs/04_CAPTURE.md`, `docs/08_UI.md`, `LIMITATIONS.md`).
|
||||
- **The anti-cheat guard says when a game cannot take the hook at all** (D78), read from the game's own token and code-protection
|
||||
settings just before the injection: `TargetAppContainer` — an older Microsoft Store app (UWP) — and `TargetMitigation` —
|
||||
only Microsoft- or Store-signed code, no generated code, a strict or non-CET-blocking user shadow stack, or strict Control
|
||||
Flow Guard. Neither is a finding: nothing is written to the game, and the session keeps its duration, the sensors and the
|
||||
reason. Each ended before as a failed injection, a hook that installed nothing, or a risk of ending the game, so no game
|
||||
that measured before is refused now (`docs/19_SAFETY_AND_ANTICHEAT.md`).
|
||||
|
||||
### Changed
|
||||
|
||||
- **The Privacy Policy is 2.13**, shown once at the next start: it names what the Xbox library reads — the games folders
|
||||
`.GamingRoot` names, each game's package files, Windows' answer whether its package is installed for you, and the
|
||||
pictures a game ships in its own folder — that Play asks Windows to start such a game, and that before any injection
|
||||
FrameLedger reads whether a game runs in an app container and which of Windows' code protections it runs under. The
|
||||
EULA and the Disclaimer do not change.
|
||||
- **The capture path reads a game's executable path one way** (for developers): `TargetResolver`, which finds the game again
|
||||
just before the guard, read the loader's spelling (`Process.MainModule`) where the watcher had the kernel's, so a game
|
||||
started through a junction could end `TargetNotRunning` about a process the watcher had just matched. Both read
|
||||
`ProcessImagePath` now, and the resolver still opens a candidate with the guard's own rights, so a process an anti-cheat
|
||||
driver closes stays `TargetUnreadable` (`docs/04_CAPTURE.md` §Process watcher).
|
||||
|
||||
### Fixed
|
||||
|
||||
- **The anti-cheat check saw only part of an Xbox game's folder** (safety): no install-root boundary matched the
|
||||
`<games folder>\<Game>\Content\` layout, so for an Unreal title's executable, three levels down, check 4 walked only its
|
||||
`Binaries\WinGDK` folder, and anti-cheat at the root of `Content` would have read clean. A GDK package root — the folder
|
||||
holding `MicrosoftGame.config` beside `appxmanifest.xml` — is now a boundary for the guard and for detection alike, used
|
||||
only where no store boundary matched, so it can only widen what is walked. The guard also gained `GamesInstalled\<X>`,
|
||||
which detection had had alone since #17; one case list read by both test suites now holds the two resolvers together
|
||||
(`docs/19_SAFETY_AND_ANTICHEAT.md`, `tests/fixtures/install-roots/cases.txt`).
|
||||
- **The second alpha's release would have stopped at its delta check** (for developers): Velopack names a non-default
|
||||
channel's packages with the channel (`FrameLedger.App-<version>-alpha-delta.nupkg`), and `release.yml` looked for the
|
||||
default channel's name. It now takes the delta the pack listed in `assets.<channel>.json`; the betas' packages are named
|
||||
as before (seen on the `0.1.0-alpha.1` rehearsal, which had no delta to make).
|
||||
@@ -0,0 +1,81 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.34 was cut, 2026-11-06 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.34] - 2026-11-06
|
||||
|
||||
**The thirty-fourth pre-release: DLSS 5 and DLSS 4.5 named from what the game and the driver did, filters on Games
|
||||
and Compare, and a Games page that opens at once.** The same unsigned installer: verify its hash against
|
||||
`SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.33`:** Help ▸ Check for updates, then *Restart to update* with no game running. The
|
||||
Disclaimer (2.13) and the Privacy Policy (2.14) are shown once for you to accept; the EULA does not change. The ledger
|
||||
moves to schema 22, which a beta.33 cannot open. The detection rules move to `2026.11.2`, so every game in the
|
||||
library is read again once. DLSS 4.5 under the NVIDIA App's *Dynamic* frame generation reads on sessions you already
|
||||
have; whether DLSS 5's neural rendering ran is kept for sessions recorded from now on.
|
||||
|
||||
### Added
|
||||
|
||||
- **Filters on Games and Compare** (owner request 2026-11-06, decision D85). Games: store, engine, state, installed and
|
||||
played, beside the search and sort, with *Clear filters*; the title counts what is shown of all. Compare: game, tier
|
||||
and frame generation over every session (it listed the newest 200), with a count; a ticked session stays listed.
|
||||
|
||||
### Changed
|
||||
|
||||
- **The list of games FrameLedger has been run with is current again** (`docs/LIST_GAME_TESTED.md`, decision D35's
|
||||
method): refreshed from a copy of the owner's database taken 2026-11-06 and reviewed by the owner — fifteen more
|
||||
games measured hooked, among them Phantom Blade Zero under the NVIDIA App's *Dynamic* mode, Hogwarts Legacy loading
|
||||
DLSS 5's runtime and the first two Xbox app games — and the sessions recorded without measurement or refused by the
|
||||
guard since 2026-09-27. The guide's Settings page says a language change stays on Settings; the closed §S30 notes the
|
||||
fifth Streamline id decoded (`docs/open-questions/closed-s.md`).
|
||||
- **The Compare page's layout** (the owner's screenshot): the selection bar beside the list instead of a window's width
|
||||
away, with *Clear selection*; columns sized to what they hold — *Tier* and *FPS* touched, and wide gaps split the rest —;
|
||||
the date sorts by when; the settings-changed column says so in words or shows a dash (it was blank); the result
|
||||
table's session labels sit over their columns.
|
||||
- **The selected page keeps its name in the left pane** (D86): WPF UI's pane animates the selected item's label away
|
||||
(Compare's, in the screenshot — every page's while selected); FrameLedger uses a copy of its template without that.
|
||||
- **Games opens at once from any page** (owner request 2026-11-06: switching to Games stalled 0.5–1.5 s). The window
|
||||
keeps the library page it built and shows it again on every later visit, reading the library again behind it; the
|
||||
library is read off the UI thread; the cards appear before the executables are checked — a USB drive that sleeps
|
||||
took a second or more to answer, and no card was shown until every one had — and each card gets its *Not installed*
|
||||
pill when its check answers; a read keeps every card that would look the same instead of rebuilding them all; the
|
||||
list view builds only the rows on screen (`spike-notes` §27).
|
||||
- **Changing the language keeps the page you are on** — Settings, after a change made there. The App remembered only
|
||||
the pages it opened from code, so the language changed on Settings came back on the last game page opened
|
||||
(`src/FrameLedger.App/Services/ShellHost.cs`).
|
||||
- **DLSS 5 is named where the game ran it** (owner decision D84, amending D64). The owner's Hogwarts Legacy, Neural
|
||||
Rendering on, loaded DLSS 5's runtime (`nvngx_dlssnr.dll` 310.9.16.0, from the game's folder) and the session could say
|
||||
only *DLSS 5 runtime loaded* — nothing measured whether it ran. The Overlay's Streamline hook now decodes DLSS 5's
|
||||
feature (`kFeatureDLSS_NR`, Streamline 2.14) into its own per-frame fact, and the Agent keeps the share of the frames
|
||||
the game rendered through Streamline that carried it (`sessions.dlss_nr_pct`, **schema 0022** — a ledger this build
|
||||
migrated no longer opens in an earlier one). Seen running, the DLSS line reads *DLSS 5 (neural rendering on 97.3% of
|
||||
rendered frames)*, above every other generation; loaded and seen not running, *DLSS 5 runtime loaded, not seen
|
||||
running*; where nothing could tell (an earlier Overlay, a title outside Streamline), *DLSS 5 runtime loaded*, as
|
||||
before. Its library is listed with its version and source like the others, its Streamline plugin `sl.dlss_nr.dll`
|
||||
is recorded when loaded, and a game shipping either file shows *Supports DLSS 5 Neural Rendering* (rules
|
||||
`2026.11.2`, capability `dlss_nr`). The **Privacy Policy 2.14** names neural-rendering libraries among those whose
|
||||
versions are read; the **Disclaimer 2.13**'s accuracy block says when DLSS 5 is named. One hook-path change: one more
|
||||
compare in the `slEvaluateFeature` detour and one more test where a present is recorded (`spike-notes` §26).
|
||||
- **Streamline's headers are `v2.14.16`'s** (developers): the vendored copy was `v2.12.0`, byte for byte; three of its
|
||||
eleven files change — `kFeatureDLSS_NR`, the uplift buffer types 70–72, `kStructVersion7`, the version — and
|
||||
nothing FrameLedger consumed otherwise (`src/native/third_party/streamline/README.md`).
|
||||
- **A session under the NVIDIA App's *Dynamic* frame generation reads DLSS 4.5** (owner decision D83, amending D64).
|
||||
Dynamic and its ×6 mode exist only in DLSS 4.5, and the DLSS line named a generation from the measured multiplier
|
||||
alone: the owner's Phantom Blade Zero under *Dynamic, up to ×3* held ×2.0 and ×3.0 and read *DLSS 4 (a ×3.0
|
||||
frame-generation state)*. It reads *DLSS 4.5 (Dynamic multi frame generation, set in the NVIDIA App)* where the game's
|
||||
driver profile sets Dynamic, the driver reports its frame-generation override applied in the game's process, and DLSS
|
||||
Frame Generation was identified (whether or not its factor was counted); a state measured at ×5 or more still ranks first, and a *Fixed* multiplier names nothing
|
||||
by itself (The Witcher 3 under Fixed ×6 still presented ×2.0). The game page's chip and the CSV's `# dlss:` line
|
||||
(`basis=dynamic_frame_generation`) follow; the **Disclaimer 2.13** says so in its accuracy block
|
||||
(`src/FrameLedger.Domain/Detection/DlssGeneration.cs`, `src/FrameLedger.App/Services/DlssText.cs`; `spike-notes` §26).
|
||||
- **The guard's source reads in order again** (developers only; no behaviour changes): the note that says what runs only
|
||||
for a target the anti-cheat evaluation allowed sits above the function it describes again — beta.33's two isolation
|
||||
checks had come between them — and names that isolation check among what runs
|
||||
(`src/native/FrameLedger.Injector/src/fl_guard.cpp`).
|
||||
|
||||
### Fixed
|
||||
|
||||
- **An Xbox game's page no longer fails on a strange picture name** in the game's own `MicrosoftGame.config` (beta.33's):
|
||||
a name that points at a stream of a file (`a:b.png`) made the search for its scaled variants throw — the page then
|
||||
showed no picture and logged an error, and an action on the page that reloads it could end in the crash report. Such a
|
||||
name is no picture a package ships, so it is passed over like a name outside the package
|
||||
(`src/FrameLedger.Infrastructure/Art/XboxArtCache.cs`). Found by a self-review of #351 and #352 after their gates
|
||||
passed; no install of the owner's eleven titles has such a name.
|
||||
@@ -0,0 +1,91 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.35 was cut, 2026-11-09 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.35] - 2026-11-09
|
||||
|
||||
**The thirty-fifth pre-release: accessibility.** An accessibility statement (Help ▸ Accessibility); a screen reader
|
||||
that reads every control and value in its words and is told what appears; headings and charts it can use; Windows
|
||||
contrast themes followed; the keyboard following a page shortcut, and a message box opening over the window. And three
|
||||
places where text read below WCAG's 4.5:1 in a Fluent theme, found on the way: the agent's pill, two kinds of short
|
||||
message, a destructive button. The same unsigned installer: verify its hash against `SHA256SUMS.txt`, then *More info →
|
||||
Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.34`:** Help ▸ Check for updates, then *Restart to update* with no game running. The legal
|
||||
texts keep their versions, so nothing is shown for you to accept; the ledger stays at schema 22 and the detection rules
|
||||
at `2026.11.2`. Nothing about capture or measurement changes.
|
||||
|
||||
### Added
|
||||
|
||||
- **An accessibility statement** (owner request 2026-11-09, decision D88). `ACCESSIBILITY.md` says what FrameLedger aims
|
||||
for — WCAG 2.2 at level AA as W3C's WCAG2ICT applies it to desktop software, a goal and not a claim of conformance —
|
||||
what works with the keyboard alone, a screen reader, a contrast theme or Magnifier, how it is checked (the project's
|
||||
tests, and the owner's pass of 2026-11-09: keyboard only and Narrator on 0.1.0-beta.34 and 0.1.0-alpha.3, no fault),
|
||||
what does not work yet and what to do instead, and how a barrier is reported and handled — by severity, with no
|
||||
promised times. The app shows it under **Help ▸ Accessibility**, and after Limitations in the user guide's window; the
|
||||
wiki gets an *Accessibility* page.
|
||||
- **An *Accessibility problem* issue form** (`.github/ISSUE_TEMPLATE/accessibility.yml`) asking what was tried, what
|
||||
happened and what the reporter uses — never anything about the reporter themself — and a user-interface section in the
|
||||
pull-request template. The `accessibility` label exists, and so do `safety` and `priority-high`, which the *Safety gap*
|
||||
form had named since its first day without either existing — so GitHub had never applied them.
|
||||
|
||||
- **A screen reader reads what the window shows** (decision D88's goal; measured in the UI Automation tree WPF builds on
|
||||
every page, window and dialog, every tab — `PagesLoadTests.Automation`). Drop-down options were read as an internal
|
||||
record (*Choice { Value = dark, Label = Dark }*), lists and table rows by their program names, table cells drawn by a
|
||||
template as *Item: …, Column Display Index: n*, and the terms window's list by each document's whole text; each now
|
||||
reads the words it shows, and an empty cell reads *empty*. The frame-rate readout says Native, Displayed and the
|
||||
factor together (CLAUDE.md rule 6, in speech), a ray-tracing chip its value and where it came from, a change badge its
|
||||
number. The safety notices' title and message reach a screen reader (they were hidden inside the notice's template),
|
||||
and the notice's button says which notice it answers. A button repeated on each row names its row (*Open: …*, *Play:
|
||||
…*, *Turn off: …*). Tab no longer stops on pictures, lists, Settings' rows, the FPS readout, the chips or the dialog
|
||||
host, where it found nothing to say; an expander's button is named after its header.
|
||||
|
||||
- **A screen reader is told what appears** (owner decision D89): a safety notice as it arrives, the capture agent going
|
||||
offline and coming back, an update's steps (not each percent), every short message at the bottom of the window, a
|
||||
notice on a game's page and each result of Tools ▸ Database maintenance — in the words shown, and only while
|
||||
FrameLedger's window is the active one, so a game that has the screen is never interrupted. The database line's live
|
||||
region, which announced nothing, is gone.
|
||||
|
||||
- **Headings and charts a screen reader can use** (owner decision D90). Every page's title is a first-level heading and
|
||||
each section title a second-level one, so a screen reader's heading keys move between sections. Every chart says what
|
||||
it is and where its numbers are written as text; its keys — arrows to move, Ctrl with an arrow to zoom, A to see all of
|
||||
it — now stay with the chart instead of also scrolling the page or moving the focus on, and its focus is drawn. No
|
||||
chart tells two series apart by colour alone any more: Compare's five sessions, the GPU's temperature and its hot spot,
|
||||
the two kinds of stutter, the two lows and the two limits each have their own line pattern, marker or hatch.
|
||||
|
||||
- **Windows contrast themes are followed** (owner decision D91). With a contrast theme on — Aquatic, Desert, Dusk, Night
|
||||
sky, or one whose colours were edited, on Windows 10 or 11 — every colour in FrameLedger's windows is one of that
|
||||
theme's, whatever Settings ▸ Theme says, and it changes the moment the theme is turned on, edited or turned off;
|
||||
Settings ▸ Theme says so under its box. Before, *System* could apply WPF UI's own high-contrast files, most of whose
|
||||
colours are a red placeholder, and the next window opened put the light or the dark theme back. The charts draw in the
|
||||
theme's colours, their patterns telling the series apart; the frame-generation, ray-tracing and upscaler chips are the
|
||||
theme's highlight and its text (WPF UI's files put the window text there, 1.26–1.78:1); a destructive button is the
|
||||
theme's own button; a pressed menu item is no longer white on white; nothing is drawn translucent, and a game's picture
|
||||
lends its page no colour, as before.
|
||||
|
||||
- **The keyboard follows a page shortcut.** **Ctrl+1** … **Ctrl+5** now move the focus into the page they open — its
|
||||
first control — and a screen reader hears the page's title; before, the focus stayed where it was, often on the page
|
||||
that had just gone, and Tab began again at the top of the window.
|
||||
- **Pages no longer slide in while Windows' animation effects are off** (Settings ▸ Accessibility ▸ Visual effects),
|
||||
followed as the setting changes.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **A message box opens over FrameLedger's window** — Remove game, Delete sessions, the database's and the update's
|
||||
questions. It had no owner, so it could fall behind the window it came from and, closing, give the focus to another
|
||||
program; it is owned by the window that opened it now, and the focus comes back there.
|
||||
- **A double-click on a chart shows all of it again**, as the user guide said; it toggled ScottPlot's render-time overlay.
|
||||
- **The capture agent's state in the title bar reads in the light theme.** It was drawn on WPF UI's fixed green, blue,
|
||||
orange and red under white — 2.78, 2.63, 2.16 and 3.68:1 — and is on the theme's own success, caution and critical
|
||||
fills now, as the notices are; its words say the state.
|
||||
- **The short messages at the bottom of the window read.** A *done* or a *warning* message was white on a fixed green or
|
||||
orange, 2.78:1 and 2.16:1 in both themes; every message is in the theme's colours now, its icon saying which kind.
|
||||
- **A destructive button's label reads in the dark theme** — Remove on a game's page, Delete in the confirmations: the
|
||||
theme's dark text on the red, 5.3:1 and 5.7:1, where white read 3.68:1.
|
||||
|
||||
### Changed
|
||||
|
||||
- **Documents corrected**: charts do take focus and keys (`docs/08_UI.md` said neither — `ChartKeyboardTests` measures
|
||||
it); the database-maintenance result's live region announced nothing, since WPF raises one only when the app does; the
|
||||
"no Narrator pass" gap is the owner's pass now, beside what that pass could not show; the open question "Accessibility
|
||||
/ DPI: no design anywhere" is closed; NFR-9 names screen readers and contrast themes (D88–D91). `LIMITATIONS.md` gains an
|
||||
*Accessibility* section and loses its one struck sentence — a screen reader reads struck text as current, so no page
|
||||
the app shows strikes text through. The guide's menu table names its menu on every row, read one row at a time.
|
||||
@@ -0,0 +1,41 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.36 was cut, 2026-11-10 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.36] - 2026-11-10
|
||||
|
||||
**The thirty-sixth pre-release: the same software, its C# read by a second analyser and tidied.** Nothing you see,
|
||||
record or measure changes. Qodana — JetBrains' code analysis — now reads the C# and the XAML of every change, and what
|
||||
its first run reported is settled: about 400 small corrections in the code, none changing what the program does. The
|
||||
same unsigned installer: verify its hash against `SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.35`:** Help ▸ Check for updates, then *Restart to update* with no game running. The legal
|
||||
texts keep their versions, so nothing is shown for you to accept; the ledger stays at schema 22 and the detection rules
|
||||
at `2026.11.2`. Nothing about capture or measurement changes.
|
||||
|
||||
> **Added the day of the release, after the tag (2026-11-10).** The package carries the **.NET runtime 10.0.15**, where
|
||||
> beta.35's carried 10.0.14: the release was built with SDK 10.0.404, November's servicing release, which the build
|
||||
> machine had that day (10.0.403 the day before), and `global.json` lets a build take the newest 10.0 SDK. Nothing in
|
||||
> FrameLedger's own code asked for it, and the notes above did not name it when the tag was cut. It is why the update
|
||||
> from beta.35 replaces 343 of the package's 456 files (a 5.8 MB download). The NuGet libraries stay at their 10.0.14
|
||||
> versions.
|
||||
|
||||
### Changed
|
||||
|
||||
- **Qodana reads the C# and the XAML from CI** (developers only; owner decision D93). The owner made the project on
|
||||
Qodana Cloud and set the `QODANA_TOKEN` secret; `.github/workflows/qodana.yml` is JetBrains' workflow for its Qodana
|
||||
Scan action, changed where FrameLedger differs: the linter is Qodana Community for .NET — ReSharper's inspections in
|
||||
a Linux container, which runs under every licence, where the Rider-based linter needs the Ultimate licence the
|
||||
organisation holds only as a 30-day trial — over `FrameLedger.slnx`, with `EnableWindowsTargeting` passed to the
|
||||
container so that the Windows-only projects build and load there; the action is pinned to a commit; the job's
|
||||
permissions are the ones it uses. It reads no C++ (CodeQL and SonarCloud do). Its gate is zero problems
|
||||
(`qodana.yaml`), and it is advisory: a red job beside a green `check`, never a blocked merge. An inspection that
|
||||
argues with a choice this project made is switched off in `.editorconfig`, where Rider reads it too, with the reason
|
||||
on the line above — sixty-three keys (`docs/13_CI_CD.md` §Qodana).
|
||||
- **What Qodana's first run reported is settled** — 3,679 problems, 2,050 of them the missing-XML-comment warning the
|
||||
project had already made a suggestion. About 400 were fixed in the code, in 181 files, none changing what the
|
||||
software does: redundant qualifiers, casts, `using` directives, `!` suppressions and `unsafe` modifiers removed (290);
|
||||
`var` for built-in types and one-line block bodies brought to `.editorconfig`'s own style (52); every XAML item
|
||||
template names its `DataType`, and a binding that reached its page through `DataContext.ViewModel` names the page's
|
||||
type (35), so the editor resolves them; two fields nothing read (`LogsViewModel`, `PipeServer.Client`), two
|
||||
initialisers a constructor overwrote and an unused parameter removed; `SpokenTextAutomationPeer` no longer assumes
|
||||
the base peer's name is a string. The members nothing in the solution uses are listed in `docs/13_CI_CD.md` §Qodana
|
||||
and left as they are.
|
||||
@@ -0,0 +1,77 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.37 was cut, 2026-11-11 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.37] - 2026-11-11
|
||||
|
||||
**The thirty-seventh pre-release: FrameLedger runs on .NET 11.** The same program, built on .NET 11.0.0 — released the
|
||||
day before — where every beta until now was built on .NET 10 (owner decision D94). Nothing about how a game is measured
|
||||
changes: the part of FrameLedger loaded into a game is native code, and it is 0.1.0-beta.36's. What changes is what
|
||||
FrameLedger needs from your PC, and two of its legal texts. The same unsigned installer: verify its hash against
|
||||
`SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**Before you update from `0.1.0-beta.36`, three things:**
|
||||
|
||||
- **Your processor.** .NET 11 does not start on a processor without SSE4.2 and POPCNT. Every processor Windows 11
|
||||
accepts has them; one from before about 2010 may not. On such a PC this version installs and then does not start, and
|
||||
0.1.0-beta.36 cannot check that for you. Installing 0.1.0-beta.36 again brings FrameLedger back, with your data as it
|
||||
was.
|
||||
- **Windows 10.** Microsoft supports .NET 11 on Windows 11, and on Windows 10 only in its LTSC and IoT editions.
|
||||
FrameLedger does not block Windows 10 22H2 — but it has never been tested there, on any version, and nobody supports
|
||||
it there (D95).
|
||||
- **The update is a large download** — about 70 MB, where a usual one is a few: the .NET runtime inside the package is
|
||||
replaced whole.
|
||||
|
||||
Then: Help ▸ Check for updates, and *Restart to update* with no game running. **The terms window appears once**, with
|
||||
the **EULA 1.7** and the **Disclaimer 2.14** to accept — what an alpha build is, now that .NET 11 has shipped, and a
|
||||
paragraph on Windows and the processor. The ledger stays at schema 22 and the detection rules at `2026.11.2`, so going
|
||||
back to 0.1.0-beta.36 is installing it over this version.
|
||||
|
||||
**For anyone on an alpha:** `0.1.0-alpha.4` follows this release on the same .NET 11.0.0, and after it the alphas pause
|
||||
— install the beta (`guide/11-alpha-builds.md`).
|
||||
|
||||
### Changed
|
||||
|
||||
- **FrameLedger runs on .NET 11** (owner decisions D94 and D95, 2026-11-11). The betas are built on .NET 11.0.0 —
|
||||
released 2026-11-10 — where they were built on .NET 10: SDK 11.0.100, `net11.0-windows10.0.22621.0`, and the three
|
||||
libraries serviced with the runtime (`Microsoft.Extensions.Hosting`, `Microsoft.Data.Sqlite`,
|
||||
`System.Diagnostics.EventLog`) at 11.0.0. The runtime is inside the package as before; nothing is installed beside
|
||||
it. **What a user should know:** Microsoft supports .NET 11 on Windows 11, and on Windows 10 only in its LTSC and
|
||||
IoT editions — FrameLedger does not block Windows 10 22H2, and it is untested and unsupported there; **on a
|
||||
processor without SSE4.2 and POPCNT it no longer starts** (every processor Windows 11 accepts has them); the
|
||||
ledger's schema is unchanged, so installing 0.1.0-beta.36 again is a way back. The part of FrameLedger loaded into
|
||||
a game is native code and does not change. `docs/12_BUILD.md` §The main line's .NET says what decided the move
|
||||
and what was set aside.
|
||||
- **The capture agent ends with a crash report when a piece of its own background work fails**, where it used to
|
||||
stop and exit as if nothing had happened: .NET 11 passes that failure on, and the Agent's existing crash path — a
|
||||
Fatal log entry and a crash dump — takes it. Nothing was added for it (`docs/10_LOGGING_AND_BUG_REPORTS.md` §Crash
|
||||
handling).
|
||||
- **The NuGet licence texts follow the package set** (`legal/licenses/nuget/`, 69 packages where there were 78):
|
||||
nine `Microsoft.Extensions.*` libraries are part of the .NET 11 runtime, and SQLite's engine is SourceGear's
|
||||
`SQLite` package through SQLitePCLRaw 3.0.5.
|
||||
- **For developers:** `release.yml` installs a .NET 10 runtime beside the SDK for `vpk` 1.2.161, which has no build
|
||||
that runs on .NET 11 alone; Qodana's container installs the .NET 11 SDK before it builds (an interim, until the
|
||||
Ultimate linter); two `string.StartsWith`/`EndsWith(char)` calls in the App's tests name the comparison .NET 11's
|
||||
analyzer asks for; `HostBackgroundFailureTests` holds .NET 11's `IHost.RunAsync` behaviour.
|
||||
- **What an alpha is, now that .NET 11 has shipped** (owner decisions D97 and D98). Until 0.1.0-alpha.3 an alpha was
|
||||
"a beta's source built on a prerelease .NET", and every text said so. 0.1.0-alpha.4 runs on .NET 11's release — the
|
||||
betas' own from this version — so an alpha is now described as *a beta's source built to try a newer version of
|
||||
.NET, at times a prerelease one*: **EULA 1.7** (§2B), **Disclaimer 2.14** (§0, which also gains a paragraph on
|
||||
Windows and the processor), **Alpha notice 1.1** (what an alpha is, the hardware, and a new part on the pause), the
|
||||
accuracy statement's line, the guide and `LIMITATIONS.md`. The terms window shows the EULA and the Disclaimer once
|
||||
more; an alpha asks for its notice's tick again.
|
||||
- **The alphas pause after 0.1.0-alpha.4, and a paused alpha says so** (D98). With the betas on the same .NET there is
|
||||
nothing for an alpha to try, so none is published until a newer .NET has a preview — and a paused alpha gets no
|
||||
update, the anti-cheat list included, which reaches FrameLedger only inside one. An alpha cut while the line rests
|
||||
shows, above every page, that the line is paused and to install the latest beta; the words "a prerelease .NET" now
|
||||
appear only in an alpha that really runs on one. For developers: `FlAlphaLineRests` in `Directory.Build.props`,
|
||||
stamped into every assembly, `Shared.AlphaLine`, `App/Services/AlphaTexts`; three new strings in en, vi and ja.
|
||||
- **.NET 11's API where it reads better, and no C# 15 syntax yet** (developers only; owner decision D96). Sixteen
|
||||
`char` searches name their comparison through the `string` overloads .NET 11 adds
|
||||
(`StartsWith`/`EndsWith`/`LastIndexOf(char, StringComparison)`) where they went through a span to satisfy both .NET
|
||||
10 and 11, and the App finds the Agent it started with `Process.TryGetProcessById` instead of a caught exception;
|
||||
nothing changes in what the software does. **C# 15's constructs were asked for and are not used**: each was tried in
|
||||
a file of its own, and ReSharper's engine — what Qodana runs — reads none of the four (it does not parse `closed`
|
||||
or `union`, and calls collection expression arguments and labeled jumps preview features), so every file using one
|
||||
would be an error on a gate of zero; a union also draws a warning from the SDK's own analyzers.
|
||||
`docs/13_CI_CD.md` §C# 15 and the analyses holds the table and what unblocks each; `docs/spike-notes/29-…` where
|
||||
each would go. `codeql.yml` takes `workflow_dispatch`, so a branch can have a full analysis — a pull request's C#
|
||||
analysis is an overlay on `main`'s database.
|
||||
@@ -0,0 +1,59 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.4] - 2026-09-21
|
||||
|
||||
**The fourth pre-release: four faults found in the first day of `0.1.0-beta.3`.** The same unsigned installer: verify
|
||||
its hash against `SHA256SUMS.txt`, then *More info → Run anyway*. What changed for a user:
|
||||
|
||||
- **Only one FrameLedger window now.** Starting the App while it is already running (a double-click, or the shortcut
|
||||
while it sits in the tray) brings the running one forward instead of opening a second one with a second tray icon.
|
||||
- **The safety texts follow your language.** In a Vietnamese UI the consent dialog, the refusal notices and the
|
||||
guard-bypass card were English.
|
||||
- **The guard bypass is honest about what it cannot do.** A game whose anti-cheat protects its process (ELDEN RING
|
||||
under Easy Anti-Cheat is one) cannot be opened by any other program, so FrameLedger cannot measure it with or without
|
||||
the bypass, and it will not try to get around that protection. beta.3 showed nothing at all in that case; this build
|
||||
shows a notice that says so, the bypass warning says it before you accept, and the game page no longer says
|
||||
"Hooking is disabled" beside a hooking switch that is on.
|
||||
|
||||
**Updating from `0.1.0-beta.3`:**
|
||||
|
||||
- Quit the App (tray icon → Exit) and end `FrameLedger.Agent.exe` before running the installer.
|
||||
> **Corrected the same evening.** This bullet went on to say that on 2026-09-21 "an install over a running Agent left
|
||||
> a half-replaced folder and the App failed to start three times". **That cause was a guess and the logs do not
|
||||
> support it**: nothing was installed between the three failed starts (20:59–21:01, `Could not load …
|
||||
> Microsoft.Data.Sqlite`) and the start that worked at 21:02. What Windows' own event log shows for that hour is a
|
||||
> failing external USB drive (the owner's report: a loose cable) and two restarts of the PC at 20:57 and 21:02. The
|
||||
> three failed starts are **unexplained**; the advice to stop the Agent before installing stands on its own.
|
||||
- The Disclaimer moved to 2.4 (one paragraph about the bypass), so the Legal Gate opens once.
|
||||
- No schema change. A bypass you already accepted stays on; the new warning text is shown the next time you turn one on.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **A second App could be started beside the first.** Nothing enforced one instance: the owner's log of 2026-09-21
|
||||
shows two started 360 ms apart from one double-click — two windows, two tray icons, a second log file, both writing
|
||||
one ledger — and with "minimize to tray" on, every click on the shortcut made another. The App now claims its data
|
||||
folder at start (`Services.SingleInstance`, a named mutex and event keyed on the folder); a later start hands over to
|
||||
the running one, which brings its window forward, and exits. `--diag` still runs beside a running App.
|
||||
- **A Vietnamese (or Japanese) UI showed the safety texts in English** — the consent dialog, the refusal notices, and
|
||||
the whole guard-bypass card in beta.3's screenshot. `FrameLedger.Shared`'s string family was never given the UI
|
||||
culture and fell back to the thread's, which the App's async start does not pass to later dispatcher work.
|
||||
`App.ApplyCulture` sets both families now. (Japanese safety text is still the English by design, until reviewed.)
|
||||
- **Under the guard bypass the game page said "Hooking is disabled for this game: …" beside a hooking switch that was
|
||||
on.** The finding stays on the page and now reads "The guard found: … You chose to bypass it for this game".
|
||||
- **With the bypass on, a game protected by a kernel anti-cheat produced nothing at all** — no session, and a toast
|
||||
reading `InjectFailed: TargetAmbiguous`. Measured on the owner's ELDEN RING (Easy Anti-Cheat): the anti-cheat's
|
||||
driver closes the game's process to other programs, the resolver could read no candidate, and it called that
|
||||
"ambiguous". It is `TargetUnreadable` now, and it reaches the user as a persistent notice that says what happened,
|
||||
that nothing was injected or measured, and that **the bypass does not change this and FrameLedger will not work
|
||||
around another product's protection** (rule 3). The bypass disclosure says the same before it is accepted (its
|
||||
version is `guard-bypass-dialog/2`), and so does `legal/DISCLAIMER.md` §2A (2.3 -> **2.4**, so the Legal Gate opens
|
||||
once). The same reason covers a game running as administrator while the Agent does not.
|
||||
- The refusal notices said "there is no way to override this"; they name the per-game bypass switch and whose risk it is.
|
||||
|
||||
### Changed
|
||||
|
||||
- The Agent's session log line names what the guard said when it was not a plain allow
|
||||
(`…; guard=BlockedService/Easy Anti-Cheat/EasyAntiCheat_EOS`), and `started-under-bypass=` for a bypassed start. A
|
||||
`SafetyUnhook` on the owner's machine left no trace of WHICH finding fired; the pipe event carried it and the log,
|
||||
which is what survives, did not.
|
||||
|
||||
@@ -0,0 +1,86 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.5] - 2026-09-22
|
||||
|
||||
**The fifth pre-release: the guard override is gone, Tier 2 exists, and a drive that changes its letter is followed.**
|
||||
The same unsigned installer: verify its hash against `SHA256SUMS.txt`, then *More info → Run anyway*. What changed for
|
||||
a user:
|
||||
|
||||
- **The "Bypass the anti-cheat guard" switch is removed.** Where FrameLedger finds anti-cheat in a game — before it
|
||||
injects, when a session starts, or during one — it refuses and **turns hooking off for that game**, says so in the
|
||||
notice and on the game's page, and offers no way to turn it back on for that executable. The terms say so
|
||||
(Disclaimer 2.5, EULA 1.2), so the Legal Gate opens once after the update.
|
||||
- **Sessions that could not be hooked are recorded now.** A refused or hooking-off game gets a T2 row with its
|
||||
duration, hardware telemetry and the reason — the summary says why ("the guard refused — …", "hooking was off for
|
||||
this game", "Windows would not let FrameLedger open the process"). Until now every such session was thrown away
|
||||
within a second.
|
||||
- **A hooking-off entry that runs as administrator (Borderless Gaming, imported from Steam) no longer gets the
|
||||
"anti-cheat driver" notice**, and Steam's tools are no longer imported as games. An entry you already have for one
|
||||
stays until you remove it.
|
||||
- **A drive that changes its letter no longer loses your games.** The Agent finds the same file under the new letter
|
||||
and moves the entry to it with its consent kept — within about 15 s in the background, at once when you launch the
|
||||
game, and when you click the hooking switch. The game's page says when its executable is not where the entry points.
|
||||
|
||||
**Updating from `0.1.0-beta.4`:**
|
||||
|
||||
- Quit the App (tray icon → Exit) and end `FrameLedger.Agent.exe` before running the installer.
|
||||
- Schema 0008 drops the five columns of the removed switch; the database opens in place, nothing else changes.
|
||||
- Entries whose switch was on lose it; if the guard blocked such a game, its hooking is off and its page says why.
|
||||
|
||||
### Removed
|
||||
|
||||
- **The per-game guard override ("Bypass the anti-cheat guard") is gone** — owner decision 2026-09-22, two pre-releases
|
||||
after it arrived. Its first real use could not reach a process an anti-cheat driver protects, and where it could
|
||||
inject it only exposed the user to the risk its own warning described. Removed entirely: the native entries
|
||||
(`FlGuardedInjectAcknowledged`, its WhenReady twin, `FlGuardIsJudgement`, reason 28), the `SetGuardBypass` message, the
|
||||
App's card and dialog, the session mark and its export line, the `Safety_Bypass_*` strings, and schema 0007's five
|
||||
columns (schema 0008 drops them — the first `DROP COLUMN` in the migration set). Sessions that ran under it keep
|
||||
`guard-bypass=` in their notes. CLAUDE.md rule 2 reads "there is no override" again; Disclaimer 2.5 and EULA 1.2 say
|
||||
so, so the Legal Gate opens once.
|
||||
|
||||
### Added
|
||||
|
||||
- **Tier 2 exists now: a session that could not be hooked is recorded — duration, hardware telemetry and the
|
||||
reason — instead of being thrown away.** Until 2026-09-22 every refusal returned within a second and the 30 s
|
||||
minimum discarded it (`Discarded (tier 2, exit=Normal, frames=0)` for every one in the owner's log), so "the session
|
||||
is still recorded" in the notice was false. The loop now holds a refused session open, ticking the telemetry poller,
|
||||
until the game exits; the row lands as T2 with N/A everywhere a measurement would be, and its summary says why
|
||||
("Why: the guard refused — Easy Anti-Cheat (…)", "Why: hooking was off for this game", "Why: Windows would not let
|
||||
FrameLedger open the process"). The unshipped operator host keeps returning at the refusal.
|
||||
- **A drive that changes its letter no longer loses your games.** When the drive holding a library comes back as
|
||||
another letter (the owner's external drive: `D:` one evening, `H:` the next morning), every game on it read
|
||||
"executable unreadable" and a game launched from the new letter ran as a stranger with no consent. The Agent now
|
||||
finds the same file — same size, same modified time, under exactly one other drive letter — and moves the entry to
|
||||
it with consent, block and detection kept: within about 15 s in the background sweep, at once when such a game is
|
||||
launched, and when you click the hooking switch. The game's page says when its executable is not where the entry
|
||||
points. *Change executable* is still the way to point an entry at a different file.
|
||||
- **Steam's tools are no longer imported as games**: Steamworks Common Redistributables, Borderless Gaming, Wallpaper
|
||||
Engine, SteamVR, the Proton and Steam Linux Runtime entries and Blender are skipped by app id. A row you already have
|
||||
for one of them stays until you remove it.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **A hooking-off entry that runs as administrator no longer gets the "anti-cheat driver" notice.** Borderless Gaming,
|
||||
imported from Steam with hooking off, produced a red "hooking refused" notice on every launch: the Agent tried to
|
||||
open its process before it looked at whether hooking was on. Hooking-off is decided first now — no process is
|
||||
opened, no resolver, no gate — and the row gets a quiet Tier-2 session like any other hooking-off game.
|
||||
|
||||
### Changed
|
||||
|
||||
- **A finding turns the game's hooking off, wherever the guard makes it** (`19_SAFETY` §What a finding does to the game). The
|
||||
pre-scan always did this; now a finding at a session's start or at the 30 s re-scan writes the same block — hooking
|
||||
off, the reason on the row, the toggle disabled on the game's page — when it names an anti-cheat *in the game* (its
|
||||
process, its folder, its title lists). A machine-wide driver or service refuses that session only. The notice says
|
||||
"Hooking has been turned off for this game", the session's notes carry `hooking-turned-off=`, and `CaptureRefused` /
|
||||
`SafetyUnhook` carry `hookingTurnedOff`.
|
||||
- **`0.1.0-beta.4`'s notes named a cause they had no evidence for, and are corrected in place** (see its *Updating*
|
||||
section). The owner reported afterwards that the external USB drive holding the Steam library had a loose cable that
|
||||
evening. Windows' System and Application logs for 2026-09-21 agree and re-date the day's symptoms: disk resets and
|
||||
paging errors on that drive from 20:42; `start_protected_game.exe` (20:56) and `GF2_Exilium.exe` (21:45) both
|
||||
ended with `0xc0000006`, an in-page I/O error — the drive, not FrameLedger, and **FrameLedger had injected nothing
|
||||
into ELDEN RING in any run**; the Agent's "executable unreadable" for all 46 titles and the two pipe timeouts at
|
||||
21:12–21:13 sit inside a burst of 30 disk errors. **What the drive does NOT explain, and beta.4's fixes stand on:**
|
||||
Easy Anti-Cheat's own log says "successfully loaded in-game" for ELDEN RING at 21:29:28, the second the resolver
|
||||
found a process it could not open (`TargetUnreadable`); the two App instances started 360 ms apart at 21:07; the
|
||||
English safety texts and the contradictory line are in the screenshot itself.
|
||||
|
||||
@@ -0,0 +1,96 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.6] - 2026-09-23
|
||||
|
||||
**The sixth pre-release: a game is recorded under its own entry, one entry per game after a drive changes its
|
||||
letter, a game that is not measured is shown while it runs, and RE Engine and FromSoftware games are detected.** The
|
||||
same unsigned installer: verify its hash against `SHA256SUMS.txt`, then *More info → Run anyway*. What changed for a
|
||||
user:
|
||||
|
||||
- **Another game's `Game.exe` is no longer recorded under your entry.** A process that matches an entry by file name
|
||||
only starts nothing — unless it is that entry's own executable on a drive that changed its letter — so an RPG Maker
|
||||
game can no longer be recorded under another RPG Maker game's name, twice, as *HELLO, HELLO WORLD!* was under
|
||||
*Flower in Us*.
|
||||
- **A game that is not measured is shown while it runs.** Hooking off, refused by the guard, or a process Windows
|
||||
would not open: the Dashboard shows the game, the time and the temperatures, says why nothing is measured, and the
|
||||
tray turns to recording-only — until now it said "Nothing is being captured." for as long as the game ran.
|
||||
- **One entry per game when a drive changes its letter.** Two entries for the same executable under two letters
|
||||
merge on their own (the older one stays, with both histories); a game updated while its drive had another letter is
|
||||
followed with hooking off; the library import no longer adds a game again under the new letter.
|
||||
- **A game removed while it runs keeps its session** (under the entry that holds its executable), and a session file
|
||||
left behind can no longer stop the Agent at every start.
|
||||
- **RE Engine and FromSoftware games are detected**, engines are shown by name, and a game added by hand whose
|
||||
executable is `Game.exe` is named after the game.
|
||||
|
||||
**Updating from `0.1.0-beta.5`:**
|
||||
|
||||
- Quit the App (tray icon → Exit) and end `FrameLedger.Agent.exe` before running the installer.
|
||||
- No schema change; the database opens in place. Every game is re-detected once (rules `2026.09.2`).
|
||||
- Session files in `%LOCALAPPDATA%\FrameLedger\tmp` that beta.5 could not store are stored at the Agent's first start —
|
||||
under the entry that holds their executable — or dropped with a line in `agent-*.log`; the Agent keeps running either
|
||||
way.
|
||||
- An entry that a beta.5 file-name match created for another game keeps its wrong name until you rename it (*Edit…*)
|
||||
or remove it; its executable path says which game it is.
|
||||
- A game whose **folder** moved — not only its drive letter — now records nothing until *Change executable* points its
|
||||
entry at the new file.
|
||||
|
||||
### Added
|
||||
|
||||
- **RE Engine and FromSoftware games are detected.** Capcom's RE Engine titles (RESIDENT EVIL 2/3/4/7/Village, Devil
|
||||
May Cry 5, Monster Hunter Rise/Wilds, Street Fighter 6, Dragon's Dogma 2, Onimusha…) by their `re_chunk_000.pak`
|
||||
archive; FromSoftware's (DARK SOULS II/III, ELDEN RING, Sekiro…) by their `.bhd` + `.bdt` archive pairs. Both are
|
||||
relative signals — a file layout, not a proof — like every engine rule. Every game in the library is re-detected on
|
||||
the next sweep. Engines are now shown by name ("RPG Maker MV/MZ", "Unreal Engine") instead of the rule's id
|
||||
(`rpgmaker_mv`). A game added by hand whose executable says nothing (`Game.exe`) is named after the game — RPG
|
||||
Maker's own title when the folder carries one, else its folder — instead of "Game".
|
||||
|
||||
### Fixed
|
||||
|
||||
- **Another game's `Game.exe` no longer runs under a library entry — no wrong name, no second session.** On
|
||||
2026-09-23 00:16 *HELLO, HELLO WORLD!* (itch) started its RPG Maker runtime, `swiftshader\Game.exe`, and the Agent
|
||||
matched it by FILE NAME to the only entry named `Game.exe`, *Flower in Us*: it recorded the session under that name,
|
||||
which created a new "Flower in Us" entry at HHW's path, and an NW.js child process then matched the new entry and
|
||||
started a second session beside the first (57 s and 56 s). A process that matches an entry by file name only now
|
||||
starts nothing — unless it is that entry's own executable on a drive that changed its letter, in which case the entry
|
||||
follows it as before — and the log says once that it is not in the library. The same match can no longer move an
|
||||
entry onto another game whose `Game.exe` has identical bytes (every RPG Maker MV game ships the same one). One session
|
||||
per executable, whatever id its entry has; a session that could not be hooked is timed by its own executable instead
|
||||
of any process with its file name; the resolver says in the Agent's log why a process could not be read; an
|
||||
unreadable entry is logged once instead of every 15 s. **Changed:** a game whose folder moved records nothing until
|
||||
*Change executable* points its entry at the new file. The "Flower in Us" entry the old match created stays until you
|
||||
rename it (it points at HHW's `swiftshader\Game.exe`, the file to measure HHW by) or remove it.
|
||||
|
||||
- **One entry per game after a drive letter changes — the two side by side become one.** When the owner's USB drive
|
||||
came back as `H:` for a morning, a second entry was made for each game played from it, and once the letter was back
|
||||
neither entry could move onto the other's path: two of each game, and "could not be moved" in the log every 15 s.
|
||||
Now the Agent merges two entries for the same executable (same path on two letters, same size and modification
|
||||
time): the entry made first stays, the other's sessions join it, a block on either is kept, and no consent moves
|
||||
between them — it waits while either game runs. A game whose executable changed on the new letter (it was updated
|
||||
meanwhile) is followed with hooking off, as *Change executable* does; turn hooking on again to measure it. The
|
||||
library import no longer adds a game again when it is already in the library under another drive letter. And a
|
||||
database error during the Agent's 15 s library pass no longer stops the Agent.
|
||||
|
||||
- **A game removed from the library while it runs no longer loses its session — or stops the Agent at the next
|
||||
start.** On 2026-09-22 23:26 and 2026-09-23 00:25 a GIRLS' FRONTLINE 2 session ended `FAULTED` on the database's
|
||||
foreign key: its entry had been removed (and re-imported) while the game ran, and the session was written under the
|
||||
id it started with. Each left a `.partial` file, and the recovery that runs at every start would have failed on it
|
||||
the same way — with no guard, so the Agent's host would have stopped at every start and nothing would have been
|
||||
captured. Now the session is stored under the entry that holds its executable when the one it started with is gone
|
||||
(the re-imported entry); when no entry does — the game was removed with its sessions — it is dropped with a log line
|
||||
that says so. Recovery never throws: a file it cannot finalize is set aside as `<guid>.partial.failed`, kept for a bug
|
||||
report, and the next file is recovered. The `FAULTED` and end-of-session log lines now name the session, the game and
|
||||
its executable, and the Agent's host logs its own warnings and errors into `agent-*.log`.
|
||||
|
||||
- **A game that is recorded without measuring is shown while it runs.** A game with hooking off, one the guard
|
||||
refused, or one whose process could not be read is recorded (duration, sensors, the reason) since beta.5 — but the
|
||||
Agent announced only hooked sessions, so for as long as such a game ran the Dashboard said "Nothing is being
|
||||
captured." and the tray stayed idle. Now the live card shows it with the T2 badge, the elapsed time, the
|
||||
temperatures, "Recording duration and sensors only — nothing is measured." and why, in the sentence its summary will
|
||||
use (no FPS readout: nothing is measured, so nothing is shown); the tray turns to recording-only; the refusal notice
|
||||
appears when the game starts rather than when it exits. A Dashboard opened after a game started shows it at once
|
||||
(it used to wait for the next start), a session running when the App connects is in the tray, the notice after a
|
||||
session names that session's game (it could name the previous one), a session that fails is let go of instead of
|
||||
staying on the card, and an update downloaded after a session ends is ready to install instead of waiting for the
|
||||
App to reconnect. A game whose executable changed since hooking was turned on — after a store update, usually — now
|
||||
says so in its summary instead of `RefusedConsentMissing`.
|
||||
|
||||
@@ -0,0 +1,36 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.7] - 2026-09-23
|
||||
|
||||
**The seventh pre-release: a program in the library can be left unrecorded, and Steam's own tools already are.** The
|
||||
same unsigned installer: verify its hash against `SHA256SUMS.txt`, then *More info → Run anyway*. What changed for a
|
||||
user:
|
||||
|
||||
- **The game page has a Recording switch.** Off, FrameLedger does not watch for that program at all — no session, no
|
||||
measurement, no injection — and a session of it that is running stops; sessions already recorded stay. The library
|
||||
card says **Not recorded**. Use it for a utility that starts with Windows: until now every program in the library was
|
||||
recorded whenever it ran, at every boot.
|
||||
- **Steam's own tools already in your library start with it off** — Borderless Gaming, Wallpaper Engine, SteamVR,
|
||||
Blender, the Steam runtimes and Proton — so a tool imported before 0.1.0-beta.5 stops being recorded without you
|
||||
doing anything.
|
||||
- **The Privacy Policy (2.3) and the Disclaimer (2.6) are updated**, so the Legal Gate opens once after the update.
|
||||
|
||||
**Updating from `0.1.0-beta.6`:**
|
||||
|
||||
- Quit the App (tray icon → Exit) and end `FrameLedger.Agent.exe` before running the installer.
|
||||
- Schema 0009 adds one column; the database opens in place, and the Steam tools above are switched off once.
|
||||
- Sessions a tool recorded before stay in its history; to remove them, remove the entry with *Delete sessions too* —
|
||||
the import will not add it again.
|
||||
|
||||
### Added
|
||||
|
||||
- **A library entry can be left unrecorded.** Borderless Gaming starts with Windows, and every program in the library
|
||||
was recorded whenever it ran — so each boot added a session of it, for as long as it ran, to the playtime totals. The
|
||||
game page now has a **Recording** switch: off, FrameLedger does not watch for that program at all — no session, no
|
||||
measurement, no injection — and a session of it that is running stops (sessions already recorded stay). The library
|
||||
card says **Not recorded**. Entries an earlier import made for Steam's own tools (Borderless Gaming, Wallpaper Engine,
|
||||
SteamVR, Blender, the Steam runtimes and Proton) start with it off; the import has skipped them since 0.1.0-beta.5.
|
||||
The Privacy Policy (2.3) says so — a program whose recording is off is not watched — and the Disclaimer (2.6) carries
|
||||
the updated accuracy statement, including the correction made in 0.1.0-beta.6; the Legal Gate shows both once after
|
||||
the update. Schema 0009 adds one column; the database opens in place.
|
||||
|
||||
@@ -0,0 +1,168 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.8] - 2026-09-25
|
||||
|
||||
**The eighth pre-release: anti-cheat is found before you ask, a session says what the game and the driver were, and
|
||||
a frame-generation session's numbers and charts are the application's.** The same unsigned installer: verify its
|
||||
hash against `SHA256SUMS.txt`, then *More info → Run anyway*. What changed for a user:
|
||||
|
||||
- **Anti-cheat is looked for harder, and before you ask.** Twenty-two families (74 entries), any kernel driver in a
|
||||
game's folder, and per-title lists by Steam app id and executable name. The Agent checks every game in your library
|
||||
on its own, turns hooking off for those with anti-cheat, and their pages show what was found instead of the hooking
|
||||
switch. Their sessions are still recorded, with play time and sensors.
|
||||
- **A game's page says what its files say** — 64-bit or 32-bit, the file and store versions, the DLSS / FSR / XeSS
|
||||
libraries it ships — and a 32-bit game's hooking cannot be turned on.
|
||||
- **NVIDIA App overrides are shown**: each session records the driver profile the game ran under (DLSS preset and
|
||||
mode, frame generation, Smooth Motion), read from the driver and never changed.
|
||||
- **Reasons read as what they are**: End task is not a crash, a refusal says what happened, a launch that could not
|
||||
start says why, a missing executable says whether its drive is disconnected.
|
||||
- **Trend works on first open**, with Native and Presented FPS as two metrics, and FPS can show two decimals
|
||||
(Settings ▸ Window).
|
||||
- **A frame-generation session's lows, median and stutter are over application frames**, a pause no longer counts as
|
||||
one long frame, and the charts draw what they say — including the sensors of a session that was not hooked.
|
||||
- **The Privacy Policy (2.4) is updated**, so the Legal Gate opens once after the update: it now names what the
|
||||
software reads to check every library game for anti-cheat, the version information of the game's files, and the
|
||||
NVIDIA driver's settings for your games — all on your PC, none of it sent anywhere.
|
||||
|
||||
**Updating from `0.1.0-beta.7`:**
|
||||
|
||||
- Quit the App (tray icon → Exit) and end `FrameLedger.Agent.exe` before running the installer.
|
||||
- Schemas 0010–0013 add columns; the database opens in place.
|
||||
- Shortly after the Agent starts it checks every game in your library for anti-cheat, once; a game where it finds
|
||||
some has its hooking turned off for good, with a notice if hooking was on.
|
||||
- Sessions recorded before keep the numbers they were stored with; the corrected lows and the in-step sensor overlay
|
||||
apply to sessions recorded from now on.
|
||||
|
||||
### Added
|
||||
|
||||
- **FrameLedger finds the anti-cheat games in your library on its own, and hides their hooking switch** (owner decision
|
||||
2026-09-25). The Agent now scans every game in the library for anti-cheat — once, and again whenever the rules or the
|
||||
game's executable change — where until now it scanned only a game someone asked to hook, so most games had never
|
||||
been scanned at all. A game it finds anti-cheat in has its hooking turned off for good, as any finding does, and a
|
||||
notice says so when hooking had been on. The library card says **Anti-cheat**; the game's page says what was found —
|
||||
"BattlEye — its module BEClient_x64.dll was loaded in the game", "Easy Anti-Cheat — its folder EasyAntiCheat ships
|
||||
with the game", in your language — in place of the Hooking switch, which could only be refused. Settings ▸ Capture ▸
|
||||
*Hide hooking on anti-cheat games* (on by default) brings the disabled switch back beside the finding. Sessions of
|
||||
such a game are still recorded, with play time and sensors. The scan reads the game's files only: it opens no process
|
||||
and decides nothing on its own — every session start still runs the full check. Schema 0010 adds three columns; the
|
||||
database opens in place, and the first scan of the library runs when the Agent starts.
|
||||
- **The game page has a Details card: what the game's files say about it.** Whether the executable is 64-bit (x64),
|
||||
32-bit (x86), ARM or .NET "any CPU"; its file and product versions; the store's build ("Steam build 20374416" — the
|
||||
subtitle labels it that way too, instead of a bare number); the engine; and the upscaler and frame-generation files
|
||||
it ships with their versions — "DLSS: nvngx_dlss.dll 3.7.10.0", Streamline, FSR, XeSS. FSR is named by its file: its
|
||||
DLL's version is the SDK's, and FrameLedger does not guess which FSR that is. The capture agent reads every game in
|
||||
the library once after the update. Schema 0011 adds four columns; the database opens in place.
|
||||
- **A session's summary lists the libraries the game had loaded** — recorded since the first beta and shown nowhere
|
||||
until now — and says when one differs from the copy the game ships ("nvngx_dlss.dll 310.2.1.0 (the game ships
|
||||
3.7.10.0: another copy was loaded, for example by the driver or the NVIDIA App)").
|
||||
- **FPS with two decimals** (Settings ▸ Window ▸ *Show FPS with two decimals*, off by default): every FPS figure reads
|
||||
"62.40" instead of "62". Whole numbers now round half up (62.5 is 63); they rounded half to even.
|
||||
- **FrameLedger says when the NVIDIA App overrides a game's DLSS.** Each session now records the NVIDIA driver profile
|
||||
the game ran under — read from the driver's own settings, never from the game — and its summary says what that
|
||||
profile overrides: "NVIDIA profile “…”: DLSS override (preset K, Quality) · Frame Generation override (×4)", Ray
|
||||
Reconstruction, Streamline's override, a forced frame-generation mode, Smooth Motion. It also says what the driver
|
||||
reported applying inside the game ("DLSS DLL chosen by the driver · preset K · Quality"), and the game page's Details
|
||||
card names the overrides from the newest session. These are the driver's settings, not measurements: what FrameLedger
|
||||
measured is shown as before. FrameLedger only reads these settings; it never changes them. Schema 0012 adds one
|
||||
column; the database opens in place.
|
||||
- **A 32-bit game's hooking switch cannot be turned on, and the page says why**: FrameLedger's hook runs in 64-bit
|
||||
games only. Until now the switch turned on and every launch was refused by the guard. A 32-bit game whose hooking
|
||||
was already on has it turned off the first time the capture agent reads it; its sessions are still recorded, with
|
||||
play time and sensors.
|
||||
|
||||
### Changed
|
||||
|
||||
- **The anti-cheat blocklist names twenty-two families, twice as many, most through more than one signal.** New:
|
||||
EA AntiCheat, Activision Ricochet (`randgrid.sys` and its `atvi-randgrid_*` services — the family 19_SAFETY carried
|
||||
as "no data yet" since August), NetEase Anti-Cheat, NetEase Yidun, Nexon Game Security (BlackCipher), TenProtect,
|
||||
AhnLab HackShield, EQU8, Anybrain, FredaikisAntiCheat and Roblox Hyperion. Existing families gained the groups they
|
||||
lacked: BattlEye's driver `BEDaisy.sys` and its services, FACEIT's and ESEA's drivers and services, HoYoverse's
|
||||
`HoYoKProtect.sys` (which the `mhyprot` prefix never matched), Xigncode3's driver and service, Denuvo Anti-Cheat's
|
||||
driver, GameGuard's folder, files and service, EAC's `start_protected_game.exe` launcher and setup files. 19 entries
|
||||
became 74 (rules `2026.09.3`). Every new name is documented — SteamDB's file-detection rules (MIT), the vendors'
|
||||
support pages, LOLDrivers, DRML — and none is measured on a real title yet; each entry's `note` says which. Three
|
||||
services are deliberately left out because they run outside play and would refuse every session on the machine:
|
||||
`EAAntiCheatService`, PunkBuster's `PnkBstrA`, and Denuvo's update service.
|
||||
- **Check 3 is live in both halves, and the per-title lists are seeded** (rules `2026.09.4`, owner decision
|
||||
2026-09-25). The store half reads the store's own files through a seam the guard owns — `appmanifest_*.acf` in the
|
||||
Steam library that holds the game, `goggame-<id>.info` for GOG — so nothing is handed in by a caller and nothing is
|
||||
read from the game. 30 Steam app ids and 33 executable names across nine families are listed: Valve's VAC titles
|
||||
(CS2, Dota 2, TF2, Deadlock and the older ones), VALORANT and League of Legends, Roblox, Blizzard's online titles,
|
||||
Call of Duty, Marvel Rivals, NARAKA, FragPunk, Once Human, Delta Force, Arena Breakout: Infinite, HoYoverse's games,
|
||||
Battlefield 2042/6 and EA SPORTS FC 25/26 — the titles whose anti-cheat leaves nothing of the game's own for the
|
||||
other checks to find. A game no store names is not refused by this half; a Steam library whose manifests cannot be
|
||||
read is. Both lists are floored like the families, so a rules file can add a title and never take one off, and the
|
||||
validator refuses names engines share (`Game.exe`, `Client-Win64-Shipping.exe`…). The AreWeAntiCheatYet bulk list was
|
||||
considered and declined: community data that outlives a game's anti-cheat would turn hooking off for good.
|
||||
- **Any kernel driver in a game's folder counts as anti-cheat** (owner decision 2026-09-25). A `*.sys` file in the
|
||||
install tree that no rule names is reported as "Kernel driver in the game folder" and turns that game's hooking off,
|
||||
like any finding. Every driver found in a game so far was an anti-cheat's; this catches the next one before anyone
|
||||
names it. It is code, so no rules file can remove it — and a game that ships a driver for another reason loses
|
||||
hooking with no way back, which is the trade the owner took.
|
||||
- **FSR 3's and XeSS's DX11 libraries count as "Supports FSR" / "Supports XeSS"** (rules `2026.09.5`):
|
||||
`ffx_fsr3_x64.dll` / `ffx_fsr3upscaler_x64.dll` and `libxess_dx11.dll` matched no rule before.
|
||||
- **The guard holds 256 blocklist entries instead of 64** (2 × 74 no longer fitted the worst case of the compiled-in
|
||||
floor plus a drifted file). The parsed rules are ~530 KB, so they are now reset in place instead of being copied from
|
||||
a temporary: the Vulkan layer parses them on whichever of a game's threads creates its Vulkan instance, and a
|
||||
temporary that size on a small thread stack would crash the game. The native tests hold them on the heap.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **A frame-generation session's lows, median, min / max, σ and stutter count are over application frames**, as
|
||||
`03_METRICS` always said they were: they were computed over every present, generated ones included, so a ×2
|
||||
session's 1% low could sit above its native average, and a game that submits its generated frames in a burst —
|
||||
the owner's Onimusha demo capture, DLSS frame generation ×3 — read a median of 2,073 FPS at a native 60. Sessions
|
||||
recorded before this release keep the numbers they were stored with; their charts use the corrected rule.
|
||||
- **Pausing capture no longer puts a pause-long frame and the paused minutes into the session.** The first frame
|
||||
after a resume was measured from the last one before the pause; it follows a gap now, and every average is over
|
||||
the time that was measured. Records lost when the capture agent fell behind are left out of that time the same way,
|
||||
so an average reads the rate the game ran at rather than the survivors spread over the lost time.
|
||||
- **The charts are honest about what they draw.** The frametime chart's default line is application frame to
|
||||
application frame (it was each frame's interval to the generated frame before it), of the one swapchain the
|
||||
statistics are over (two swapchains' intervals were drawn interleaved); the every-present line no longer draws
|
||||
0 ms frames after gaps and says that presents are timed at submission; segments are labelled with their settings;
|
||||
the sensor overlay is in step with the frames (it was drawn from the session's start, tens of seconds early —
|
||||
schema 0013 records where the first frame sits, so sessions recorded before keep the overlay off). The histogram
|
||||
is binned over the 0.5th–99.5th percentile with its bars centred on their bins; the percentile curve and its
|
||||
1% / 0.1% low markers are drawn only where the session has the frames for them, the rule the stat cards follow.
|
||||
The Sensors charts put power on a watt axis, call the memory plot *Memory*, leave out VRAM readings of 0, give
|
||||
every line its own colour in the light theme too, and chart **sessions that were not hooked** — their sensors
|
||||
were recorded and shown nowhere.
|
||||
- **A game's page updates when one of its sessions finishes** — its sessions, trend and header kept what the page
|
||||
opened with until it was left and reopened.
|
||||
- **The Trend tab was blank the first time a game's page opened.** It is drawn at once, on a date axis that keeps its
|
||||
label and the theme's colours. "Average" is two metrics now — Native FPS and Presented FPS — so a line never mixes
|
||||
the two, and never shows a presented rate that includes generated frames. Temperatures, loads, power and memory
|
||||
include sessions recorded without hooking; points that describe only part of their session are drawn hollow; several
|
||||
hardware changes on one day are one marker.
|
||||
- **A steady-state frame-generation factor always shows the share of the session it covers** — the average card,
|
||||
Compare and the Sessions grid's FG× column dropped it. The game header's "Lifetime average" was the last measured
|
||||
session and is labelled so.
|
||||
- **Compare**: the best value is highlighted in the accent colour (it was only bold), two values that read the same are
|
||||
both best, CPU and GPU load are not ranked, the percentile chart spans 0–100 again, and exported PNGs have a solid
|
||||
background.
|
||||
- **Ending a game with End task is no longer a "crash".** Every non-zero exit code was one, and Task Manager leaves 1.
|
||||
A crash is now an exception's exit code or Windows' own crash record, and the session summary says how each session
|
||||
ended: "crashed (0xC0000005 access violation)", "ended with exit code 1 — what End task and taskkill leave". The
|
||||
crash safety still counts an early abnormal exit of either kind, so hooking still turns itself off after two in a row.
|
||||
- **Reasons read as what they are.** Every way a session can end has its own sentence, a refusal that names no
|
||||
anti-cheat says what happened ("the game is 32-bit…", "the game's process could not be opened") instead of calling
|
||||
its detail "detected in this game", a launch that could not start says why (for example "the game requires
|
||||
administrator rights"), and a missing executable says whether its drive is disconnected or the file is gone. A
|
||||
refusal's details were stored so that a detail could be read as an anti-cheat's name; they are stored in three fixed
|
||||
places now, and older sessions are read correctly.
|
||||
- **The NVIDIA bridge's native test could not fail on a machine with an NVIDIA GPU.** It was registered to pass on
|
||||
its "which branch" line alone, which makes ctest ignore the exit code; its reference-counting check had been failing
|
||||
on every GPU machine unseen. The check is corrected and a failed assertion now fails the test.
|
||||
- **Turning hooking on for an Unreal game now sees its `EasyAntiCheat` folder.** The scan that runs when hooking is
|
||||
enabled was given the executable's own folder — `<game>\<Project>\Binaries\Win64\` for Unreal titles — and scanned
|
||||
exactly that, while `EasyAntiCheat\` sits at the game's root. The session-time scan always looked at the root, so no
|
||||
injection was ever allowed by the gap, but the toggle could be switched on and the refusal came only at launch. The
|
||||
guard now takes the executable and finds the root itself, and also checks the executable's name and its store id.
|
||||
- **A game blocked for anti-cheat no longer offers "Turn hooking back on" after a crash auto-disable.** The button
|
||||
could only be refused.
|
||||
- **19_SAFETY's fixture rule is enforced for every family, not eleven.** A generated test walks every value of the
|
||||
shipped seed and requires it to match its own family in its own group — which also catches a later row that an
|
||||
earlier prefix shadows. The rules file's note that called XIGNCODE3's `x3.xem` "not a loadable module" is corrected:
|
||||
XIGNCODE3 loads it as its loader, so the modules group names it too.
|
||||
|
||||
@@ -0,0 +1,65 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.9] - 2026-09-26
|
||||
|
||||
**The ninth pre-release: one narrow exception you can make yourself for a game whose only anti-cheat runs in user
|
||||
mode and that FrameLedger has measured before.** The same unsigned installer: verify its hash against
|
||||
`SHA256SUMS.txt`, then *More info → Run anyway*. What changed for a user:
|
||||
|
||||
- **A user-mode anti-cheat exception, per game, off by default** (Settings ▸ Capture). It is offered only where the
|
||||
only anti-cheat found runs entirely in user mode — no driver or service, no driver file in the game's folder — the
|
||||
game is on no title list, and FrameLedger has measured it hooked successfully at least twice. You make it one game
|
||||
at a time, after a disclosure that states the ban risk; the guard still runs every check under it and ends it on
|
||||
anything new, a crash or safety stop under it, or a game update. Sessions under it are marked.
|
||||
- **The Disclaimer (2.7) and the EULA (1.3) say so**, so the Legal Gate opens once after the update. The Privacy
|
||||
Policy is unchanged.
|
||||
|
||||
**Updating from `0.1.0-beta.8`:**
|
||||
|
||||
- Quit the App (tray icon → Exit) and end `FrameLedger.Agent.exe` before running the installer.
|
||||
- Schema 0014 adds columns; the database opens in place. Nothing changes for any game until you turn the option on.
|
||||
- With the option on, the Agent looks at each game whose hooking it turned off within a minute and lists the ones
|
||||
that qualify; a game shipping a kernel driver (Aniimo's `NEPKernel.sys`, for one) never does.
|
||||
|
||||
### Added
|
||||
|
||||
- **A user-mode anti-cheat exception you can make yourself, per game** (owner decision D33). Settings ▸ Capture ▸
|
||||
*Allow hooking in games with user-mode anti-cheat that were measured before* — off by default. On, it lists the games
|
||||
FrameLedger found eligible: the only anti-cheat in the game runs entirely in user mode (no driver or service, no
|
||||
driver file anywhere in the game's folder), the game is on no title list, and FrameLedger has measured it hooked
|
||||
successfully at least twice. **Make exception…** shows a disclosure — the ban risk, possibly days later and invisible
|
||||
to FrameLedger; what is still refused; how the exception ends — and asks you to accept the risk for that game. The
|
||||
exception turns nothing on: you then turn hooking on for the game on its page, through the usual consent dialog, and
|
||||
the guard still runs every check and refuses anything else it finds. The game's page shows the exception's state
|
||||
(eligible; not eligible and why; in force; suspended; ended and why), the library card says **Exception**, and a
|
||||
session hooked under it is marked in the Sessions tab and its summary. It ends by itself on a new finding, a crash or
|
||||
safety stop under it, FrameLedger stopping because another anti-cheat loaded, or a game update; turning the option
|
||||
off suspends every exception. Aniimo stays blocked: it ships a kernel driver (`NEPKernel.sys`).
|
||||
|
||||
- **Groundwork for the user-mode anti-cheat exception** (owner decision D33, 2026-09-26; the option, the list and the
|
||||
disclosure arrive later in this train). The guard can now be asked to let ONE named anti-cheat family through, and
|
||||
grants it only for a family whose every signal — in the built-in floor and in the rules file — is user-mode: no
|
||||
driver, no service, no `.sys` (on today's rules NetEase Yidun, AhnLab HackShield, Anybrain and FredaikisAntiCheat).
|
||||
It still runs every check and keeps scanning past what it let through, so a second anti-cheat, a kernel driver in
|
||||
the game's folder, a title list, a driver or service on the machine, or a scan that could not finish still refuses;
|
||||
a pass that let something through says so and names it. The injected Overlay learns the same family before it
|
||||
starts watching the game's module loads, so a late-loading module of that family does not stop it and any other
|
||||
anti-cheat still does. Nothing asks for any of this yet: every game is judged exactly as in beta.8.
|
||||
- **The Agent can grant, keep and end a user-mode anti-cheat exception** (D33; the Settings option, the list and the
|
||||
disclosure arrive in the next PR, so nothing in the App asks for one yet). With the option on
|
||||
(`hooking.usermode_ac_exceptions`, off by default), the Agent's library scan asks each blocked game one question —
|
||||
would the guard let exactly its blocking family through, with no kernel driver and nothing else found — and counts
|
||||
its successful hooked sessions; a game with both and at least two sessions is eligible. A grant rests on facts the
|
||||
Agent gathers itself when asked, is bound to the executable's bytes and turns nothing on: hooking is the usual
|
||||
consent dialog afterwards. Under it the Agent tells the Overlay the family before injecting, names it to the guard at
|
||||
the start and at every 30 s re-scan, and marks the session with it. It ends — hooking off, the block standing, the
|
||||
reason kept — on a new finding, a safety unhook, the Overlay stopping for another anti-cheat, a crash while hooked, a
|
||||
game update, or when the user withdraws it; turning the option off suspends every exception without deleting any.
|
||||
Schema 0014 adds the columns; the database opens in place.
|
||||
|
||||
### Changed
|
||||
|
||||
- **Legal: Disclaimer 2.7 and EULA 1.3.** Disclaimer §2A describes the user-mode exception and its risk; the EULA's
|
||||
code-injection clause names it and what making one means. The accuracy block and SECURITY.md say it too. The Legal
|
||||
Gate shows the two changed documents once more; the Privacy Policy is unchanged (2.4).
|
||||
|
||||
@@ -0,0 +1,457 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66): part 1 of 5 of the ledger kept before the first tag, newest first. CHANGELOG.md lists every part. -->
|
||||
|
||||
## Ledger before 0.1.0-beta.1 (2026-08-04 → 2026-09-16)
|
||||
|
||||
_The `[Unreleased]` entries as they stood when the first tag was cut; `release-notes.ps1` stops before this
|
||||
heading. Newest first._
|
||||
|
||||
### Added
|
||||
|
||||
- **P5 prep: a release rehearsal, `SECURITY.md`, and an honest hygiene checklist (2026-09-16).** `release.yml` gains
|
||||
`workflow_dispatch` with a `version` input: the identical job — the gate, publish, runtime licences, the
|
||||
published-tree assertion, `vpk pack`, checksums, the artifact — with no tag and no Release, so the steps that had
|
||||
only ever run by hand on one machine run on the hosted runner before the first tag; a missing `## [x.y.z]` section
|
||||
is a warning with placeholder notes in a rehearsal and stays a stop on a tag. `SECURITY.md`: the private route for
|
||||
a vulnerability (GitHub's private reporting when enabled, else e-mail), the public *Safety gap* form for an
|
||||
undetected anti-cheat, what not to include, and the response *intent* stated as an intent; `ISSUE_TEMPLATE/config.yml`
|
||||
points a vulnerability at the private route; README's safety-gap paragraph links both. `13_CI_CD` §Repo hygiene
|
||||
checklist rewritten: the in-tree items were done and unticked, the first box asked for caller stubs the file's own
|
||||
opening paragraph rejects, and the rest are GitHub settings only the owner can set — listed as such. `14_TESTING`'s
|
||||
Velopack-delta row says it is reachable from the second release.
|
||||
- **The "factor not counted" tooltip says which bucket, and by how much — `sessions.fg_refusal_detail`, schema
|
||||
0005 (2026-09-16).** The owner's Dashboard showed "DLSS-G active — factor not counted" on Hell Is Us, Black Myth:
|
||||
Wukong, Cronos and Onimusha; three refused `non_uniform` (one of eight equal-sample buckets departed more than
|
||||
25 % from the whole, or held no tokens — a menu, a loading screen, an alt-tab inside a whole play session) and
|
||||
one `multiple_streams` (a second swapchain), and the tooltip could only repeat the kind. `FgWindow` had computed
|
||||
the bucket, its ratio and the window's all along; `SessionAggregator` kept only the kind. Now
|
||||
`Application.Recording.FgRefusalDetail` — kind, subject, count, bucket index/count, the bucket's ratio (null when it
|
||||
held no tokens) and the window's — is stored as JSON beside `fg_refusal`, and `FpsPresentation.IdentifiedTooltip`
|
||||
appends its sentence: "Bucket 3 of 8 measured 2.25 against 3.65 for the whole session, over 53 samples." /
|
||||
"2 swapchains presented during the session." / "40 samples; at least 64 are needed to check." A kind with no
|
||||
numbers worth a sentence adds nothing; an unparsable column is the old tooltip. The producer is unchanged and
|
||||
no number is decided by it (owner's decision 2026-09-16: store and show the reason; no steady-state factor, no
|
||||
change to `multiple_streams`). Six strings (en/vi/ja). Tests: `SessionAggregatorTests`, `LedgerDatabaseTests`
|
||||
(script five), `FpsPresentationTests`. Docs: `06_DATA_MODEL` §Migrations, `03_METRICS` §FG factor, `08_UI` §FPS
|
||||
display rule.
|
||||
- **RPG Maker is detected — MV/MZ and XP/VX/VX Ace — and `rulesVersion` is `2026.09.1` (2026-09-16).** Two engine
|
||||
rows `05_DETECTION` marked ⛔ "cannot be expressed in schemaVersion 2": the MV/MZ reasoning wanted a nested group
|
||||
for `nw.dll` **and** (`www/` **or** `package.json`), but MV and MZ both ship `package.json` beside `nw.dll`
|
||||
unconditionally, so `all: [nw.dll, package.json]` is the signal — measured on the owner's *Flower in Us* and a
|
||||
hand-extracted MV title, both `engine=none` until now. The RGSS family is one rule over the three DLL prefixes and
|
||||
the three archive extensions, no version (which DLL matched is not a value any extractor produces). Both sit
|
||||
after `unity`/`unreal` and before `godot`. Fixtures `engines/rpgmaker_mv`, `engines/rpgmaker_rgss`; the
|
||||
`every_engine_marker` canary carries both engines' markers and still expects `unity`. The version bump changes the
|
||||
sweep's cache key, so every game is re-detected on the Agent's next pass. Docs: `05_DETECTION` §Engine signatures.
|
||||
- **The bug report's last optional item: the last session's summary, when ticked (2026-09-15).** `10_LOGGING` §Bug
|
||||
report flow step 2 listed "last session metadata + aggregates JSON (never raw blobs by default)" beside the crash
|
||||
dump, and `legal/PRIVACY_POLICY.md` §3 promises both only when ticked. The Optional items dialog PR-9 added now shows
|
||||
a box for each item that exists: the crash dump, and the newest session in the ledger (`LastSessionSummary`) labelled
|
||||
with its game and start time. Ticked, the zip gains `session.json`, File ▸ Export's own JSON (metadata, aggregates,
|
||||
segments, hardware) without the user's notes and tags, passed through `LogRedactor` because it names the executable;
|
||||
no frame or sensor series. With neither item there is no question. `CrashDumpChoice` became `BugBundleOptions`, and
|
||||
`IBugReportPreview.AskCrashDumpAsync` became `AskOptionsAsync(BugBundleOffer)`. Two strings (en/vi/ja). Tests:
|
||||
`LastSessionSummaryTests`, `BugReportFlowTests`, `BugBundleOptionsViewModelTests`, `PagesLoadTests`. Docs:
|
||||
`10_LOGGING` §Bug report flow step 2.
|
||||
- **P4 PR-9 — the crash dialog, the minidump in both processes, and the crash dump as the bug report's opt-in
|
||||
(2026-09-15).** `10_LOGGING` §Crash handling specified Fatal → `MiniDumpWriteDump` → a dialog offering the bug report
|
||||
→ exit code 1; only the Fatal line existed, and `Crash_Title` / `Crash_Body` were translated for a dialog nothing
|
||||
showed. `Infrastructure/Diagnostics/CrashDumpWriter` writes `crashdumps\<ui|agent>-<UTC time>-<pid>.dmp` through
|
||||
CsWin32 with `MiniDumpWithIndirectlyReferencedMemory | MiniDumpWithThreadInfo`, keeps the five newest and never
|
||||
throws. **The App** marks a dispatcher exception handled; `CrashReporter` logs it, writes the dump and shows
|
||||
`CrashDialog` — a Win32 message box, because a crash cannot vouch for the shell's dialog host — whose Yes reveals the
|
||||
shell window (one hidden in the tray would hold the report's dialogs unseen) and runs `BugReportFlow`; the host then stops and `RunAsync` exits with code 1 after the normal teardown. One dialog per
|
||||
process: a further exception while it is up is logged once and counted, since a layout fault repeats on every pass
|
||||
the dialog's message loop runs. An exception on any other thread is Fatal + dump only. **The Agent** logs and dumps
|
||||
from `AppDomain.UnhandledException` and from `Main`'s own catch (whose `finally` would otherwise close the logger
|
||||
first), once, and leaves the exception unhandled. **The bug report** offers the newest dump of the last seven days
|
||||
before the save dialog, as a checkbox that starts clear, labelled with its time and size, with a line saying a dump
|
||||
can hold file paths, game names and settings (`Dialogs/BugBundleOptionsContent`) — what `legal/PRIVACY_POLICY.md` §3
|
||||
already promised; Cancel writes nothing, and `BugBundleBuilder.WriteAsync` refuses a dump from anywhere but
|
||||
`crashdumps\`. `Crash_Body` becomes `Crash_Body_Format` and keeps its one fact (the capture agent keeps running);
|
||||
seven more strings (en/vi/ja). Tests: `CrashDumpWriterTests` (a real dump of the test process starts `MDMP`; the
|
||||
prune keeps five and touches nothing else; an unusable directory is null and a line), `CrashReporterTests` (the order,
|
||||
no report on No, three further exceptions show nothing, a failed dump still asks, a failed report is not a second
|
||||
crash), `BugBundleBuilderTests`, `BugReportFlowTests` (no dump no question; left clear, ticked, cancelled),
|
||||
`BugBundleOptionsViewModelTests`, `PagesLoadTests`. Docs: `10_LOGGING` §Crash handling and §Bug report flow,
|
||||
`15_ROADMAP`, HANDOFF §P4.
|
||||
- **P4 PR-8 — the accessibility pass, with the section it passes against written first (NFR-9, 2026-09-15).**
|
||||
NFR-9 was one sentence and `08_UI` one bullet ("Ctrl+1…5; grids fully navigable; Esc closes flyouts/dialogs"), none
|
||||
of it built. `08_UI` §Accessibility now says what each clause means here and names the check: **Ctrl+1 … Ctrl+5**
|
||||
and the keypad open Dashboard / Games / Compare / Logs / Settings (`MainWindow` `InputBindings` →
|
||||
`MainWindowViewModel.NavigateToCommand` → `ShellShortcuts`), and `AccessibilityTests` holds the bindings, the map and
|
||||
the NavigationView's order together; **Esc closes the open `ContentDialog` or `MessageBox` with no result**, through
|
||||
its own Close path, and never a dialog that offers no Close button (`Services/DialogKeyboard`, one class handler on
|
||||
`Window` registered in `App.OnStartup`, bubbling so a dropdown's Esc wins) — WPF UI 4.3.0 handles no key in either
|
||||
dialog, measured in its source; **every input that shows no text of its own has an `AutomationProperties.Name`** —
|
||||
thirty controls had none (every Settings toggle, number box and choice box, the hooking switch, the trend metric,
|
||||
the Games and Logs filters and search boxes, the log tail, the edit-game and consent text boxes, the Legal Gate's
|
||||
document, the summary window's tags and notes, and the icon-only close button in the `InfoBar` template), a scan of
|
||||
the App's XAML goes red on the next one (proven by removing one name), and four new strings name the controls that
|
||||
had no label to borrow (en/vi/ja); **no XAML hard-codes a colour** (a second scan), so contrast is the Fluent
|
||||
themes'; the manifest is Per-Monitor V2 (a third). Known gaps are stated there: ScottPlot plots are not
|
||||
keyboard-operable, and no Narrator pass has been done. Docs: `08_UI` §Accessibility and §UX rules, `02_SPEC` NFR-9,
|
||||
`16_WPFUI_SYNTAX` §Gotchas (no Esc in 4.3.0, `CloseButtonText` defaults to "Close", the obsolete `MessageBox.Close`),
|
||||
`15_ROADMAP`, HANDOFF §P4. The Database maintenance dialog's status line is `LiveSetting="Polite"`, so a result is read out.
|
||||
- **P4 PR-7 — Tools ▸ Database maintenance: integrity check, backup, the retention sweep on demand, compaction
|
||||
(2026-09-15).** `06_DATA_MODEL` §Retention promised the four since P0; the menu item said "not built yet". **The
|
||||
sweep is the Agent's**, because `frame_blobs` and `sensor_blobs` are (§Writer ownership): the App sends the new
|
||||
`SweepRetention` command (no payload; `07_IPC` row), and the Agent's `RetentionSweep` reads its own
|
||||
`retention.raw_sessions_per_game` and runs `ISessionRepository.SweepRetentionAllAsync` — the finalize's per-game
|
||||
rule for every game in one transaction (`ROW_NUMBER() OVER (PARTITION BY game_id …)`, a removed game's kept sessions
|
||||
included), answering `SweepRetentionAck { keep, games, sessions }`; unlimited (0) never reaches the repository, which
|
||||
refuses a keep below 1. The other three run in the App through `LedgerMaintenance` and change no row:
|
||||
`PRAGMA integrity_check`; a backup through `VACUUM INTO`, which is consistent while the Agent writes and **refuses
|
||||
the ledger, its WAL and its shared-memory file as a destination** — the save dialog's "replace?" would otherwise have
|
||||
let "delete the existing file first" delete the live database; and compaction (`VACUUM` + `wal_checkpoint(TRUNCATE)`)
|
||||
refused while a fresh `GetStatus` reports a session, with SQLite's busy error a status line rather than a crash.
|
||||
`LedgerDatabase.MaintainAsync` runs a statement outside a transaction, for these only. The dialog
|
||||
(`DatabaseMaintenanceContent` / `DatabaseMaintenanceViewModel`, `DatabaseMaintenancePrompts`) confirms the sweep with a
|
||||
Danger button and shows one status line; the menu's last `NotYetCommand` and the `NotYet_*` strings are gone.
|
||||
Strings en/vi/ja. Tests: `LedgerMaintenanceTests` (healthy, a backup that opens at the same schema with the same rows,
|
||||
never over a file or onto the ledger in any spelling, compaction that returns the space of ten swept series),
|
||||
`SqliteSessionRepositoryTests` (every game keeps its own newest N, a sensors-only session counted once, a second
|
||||
sweep finds nothing, a keep of 0 refused), `RetentionSweepTests`, `AgentCommandHandlerTests` (the composed sweep
|
||||
answers; none composed is not a command), `DatabaseMaintenanceViewModelTests` (twelve cases, the ledger-as-backup
|
||||
refusal among them), `PagesLoadTests` (the dialog loads under the real dictionaries). Docs: `07_IPC`,
|
||||
`06_DATA_MODEL` §Retention and §Writer ownership, `08_UI`, `15_ROADMAP`, HANDOFF §P4.
|
||||
- **P4 PR-6 — every NuGet package the App and the Agent ship has its licence text, and the gate keeps it true
|
||||
(2026-09-15).** `tools/license-gather.ps1` reads the two publish roots' restore output (`obj/project.assets.json`,
|
||||
win-x64, every package with a runtime or native asset that is not a suppressed build-time dependency) and writes
|
||||
one text per package into `legal/licenses/nuget/`: the package's own licence file verbatim when it has one; for a
|
||||
URL-only package a reviewed override (`tools/license-overrides/`: Mono.Posix.NETStandard → the Mono LICENSE file
|
||||
its link resolves to, OpenTK.GLWpfControl → its LICENSE.md, both fetched 2026-09-15 with provenance); for an SPDX
|
||||
expression with no file, MIT's text under the package's own `<copyright>` field (never an invented holder —
|
||||
"not stated" when the package states none) or a pointer to the shared Apache-2.0 / MPL-2.0 text with the MPL
|
||||
Source Code Form link. Distinct third-party notice files are copied once (twenty-seven Microsoft.Extensions
|
||||
packages carry the same 78 KB file). An MPL-2.0 package that *applies* Exhibit B is red — the MPL text itself,
|
||||
which carries the sentence as a template, is excluded, as `spike-notes` §M4 learned. **77 packages ship; the
|
||||
notices table named about fifteen** — LibreHardwareMonitorLib's three MPL-2.0 dependencies (BlackSharp.Core,
|
||||
DiskInfoToolkit, RAMSPDToolkit-NDD), HidSharp, Mono.Posix, the OpenTK/GLFW and SkiaSharp/HarfBuzz families under
|
||||
ScottPlot and the Microsoft.Extensions stack were in every build without a row. The three MPL packages were
|
||||
searched upstream the §M4 way (the sentence once per repository, in LICENSE; no source file carries an MPL
|
||||
notice) and are recorded clear in `legal/THIRD_PARTY_NOTICES.md`. `license-check` §3 runs `-Check` (regenerate,
|
||||
compare both directions — a bump, a removal or a hand edit is red) and asserts the shared texts the generated ones
|
||||
point at exist; `build.ps1` runs the gatherer's fourteen-case self-test first. **The output is culture-invariant, and that
|
||||
was measured rather than assumed:** under tr-TR `-Check` went red on an unchanged tree, because PowerShell's `-match`
|
||||
ignores case in the current culture and "LICENSE" lower-cases to "lıcense" there; file names now match with
|
||||
`CultureInvariant`, ordering is ordinal, and a self-test case runs the gatherer under tr-TR in a child process (in-process
|
||||
it proved nothing — the Regex cache kept the first culture — and a culture-sensitive mutant passed until the case
|
||||
moved out). The App's publish now carries
|
||||
`legal/licenses/` as `licenses/` (plus `THIRD_PARTY_NOTICES.md` and the GPL text), and `release.yml` adds the .NET
|
||||
runtime's licence and notices from the runtime packs the publish used (their version follows the SDK, so they
|
||||
are not committed) and asserts all of it in the published tree — verified on a local publish (runtime 10.0.12,
|
||||
84 generated files). The hand copies `wpfui-MIT.txt` and `velopack-MIT.txt` are folded into the generated
|
||||
`nuget/WPF-UI.txt` and `nuget/Velopack.txt`. The generated directory is `nuget/`, not `packages/`: the
|
||||
repository's `.gitignore` ignores every `packages/` (a NuGet-era rule), which would have left CI comparing
|
||||
against nothing. Docs: `THIRD_PARTY_NOTICES` (intro, four transitive rows, two checklist items ticked),
|
||||
`legal/licenses/README.md` (rewritten: what is generated, what is hand-committed, the stale M3/M4 paragraph),
|
||||
`12_BUILD` gate 13, `13_CI_CD` licence guard, `16_WPFUI_SYNTAX` checklist, HANDOFF §P4.
|
||||
- **P4 PR-5 — Velopack, the updater, `release.yml`, and one version source (`11_UPDATER`, 2026-09-14).**
|
||||
`FrameLedger.App/Update/`: `VelopackUpdateClient` behind the `IUpdateClient` port (Velopack's `UpdateManager` over
|
||||
its GitHub source for this repository; the `stable` channel is the releases GitHub does not mark pre-release, `beta`
|
||||
adds the ones it does), `UpdateFailureMapper` (the §Error mapping rows from the exception: 404 / 403+429 / 5xx /
|
||||
transport / checksum / unknown; an HttpClient timeout is Offline, not a cancel), `FrameLedgerFileDownloader` (Velopack's
|
||||
downloader with `User-Agent: FrameLedger/<version>`), `UpdateService` — the startup silent check 5 s after start when the copy is
|
||||
installed and the new `update.auto_check` setting (default on) says so, every failure a log line; Help ▸ Check for
|
||||
updates with the dialogs (`UpdatePrompts` over WPF-UI's `MessageBox`: the offer with the release notes and the
|
||||
unsigned-release footer, up to date, not an installed copy, the six error rows — a 404 offers the releases page, an
|
||||
unknown failure offers the bug report); the background download, retried once on a checksum failure; and **FR-12 as the shape of the whole thing**: a
|
||||
downloaded package is `Ready` only while the Agent reports no session, otherwise `Deferred` until the last
|
||||
`SessionCompleted`, and the apply itself is refused with a session running. The apply (`Restart to update`, the
|
||||
shell's new persistent InfoBar) sends `Shutdown` to the Agent, holds the connection's relaunch (`IAgentLink.SetLaunchHold`),
|
||||
waits for the pipe to drop (an Agent that does not stop in 10 s leaves everything as it was), hands Velopack the
|
||||
package (`WaitExitThenApplyUpdates`) and ends the host; the restarted App starts the Agent beside itself as always,
|
||||
and — when Velopack reports the restart — re-validates the logon task's action path (`--install-task` on `Stale`).
|
||||
`Program.Main` is now hand-written so `VelopackApp.Run()` precedes any window: the uninstall hook (`UninstallHook`,
|
||||
delegates for the test) asks a running Agent to stop, unregisters the Vulkan layer, removes the logon task and
|
||||
**asks** about the data folder (deleted on Yes only; unanswered inside Velopack's 30 s budget keeps it); install
|
||||
registers nothing. The tray raises "update available" as a balloon only while the window is off screen. Settings ▸
|
||||
Updates gained the startup-check toggle and the channel row's real text. **One version source:** `VERSION` at the
|
||||
repository root, read by `Directory.Build.props` (`<Version>`, SourceLink's `+sha` suffix off) and by
|
||||
`src/native/CMakeLists.txt`, with `versioninfo-check` comparing every built binary's `FileVersion` against it.
|
||||
**`release.yml`** on a `v*` tag: the tag's numeric core must equal `VERSION` and `CHANGELOG.md` must carry a
|
||||
non-empty `## [x.y.z]` section (`tools/release-notes.ps1`, self-tested in `build.ps1`), `{{RELEASE_DATE}}`
|
||||
substituted before the build, the identical gate, publish App + Agent self-contained + ReadyToRun with
|
||||
`-p:Version=<tag>`, the published tree asserted by name (both entry points, the four shipped natives, the rules
|
||||
seed, no capture host), `vpk pack`, `SHA256SUMS.txt` printed into the release body, `gh release create`
|
||||
(`--prerelease` for a `-beta.N` tag). **The package id is `FrameLedger.App`**: Velopack installs into and, on
|
||||
uninstall, deletes `%LOCALAPPDATA%\<packId>`, and `%LOCALAPPDATA%\FrameLedger` is the data folder — the id the docs
|
||||
named would have removed every user's ledger without asking (`UninstallHook.AreSeparate` now refuses the data delete
|
||||
if the two ever overlap). Published locally before the PR: 250 MB in 362 files, every assertion of the workflow's
|
||||
tree step green; `vpk pack` 1.2.0 over it produced `FrameLedger.App-win-Setup.exe` (104 MB) and verified `VelopackApp.Run()` in `Program.Main`. The GitHub release itself is unexercised until a tag. `legal/PRIVACY_POLICY.md` is now **2.1-draft**: the update check and download
|
||||
rows describe requests the software makes, which is a material change the policy's own rule says re-shows the Legal
|
||||
Gate. `legal/licenses/velopack-MIT.txt`. Tests: `UpdateServiceTests` (the skips, the channels, Deferred ↔ Ready,
|
||||
the dialogs and rows, the apply's three endings), `UpdateFailureMapperTests`, `UninstallHookTests`, the
|
||||
connection's hold, the tray's balloon, the settings toggle. Docs: `11_UPDATER` built note, `12_BUILD` §Version and
|
||||
§Publish & package, `13_CI_CD` §release.yml, `08_UI`, `06_DATA_MODEL`, HANDOFF §P4, `15_ROADMAP`, README §Privacy.
|
||||
- **P4 PR-4 — the library import: Steam, GOG Galaxy, Epic and itch.io through a review checklist, hooking off for
|
||||
every row (FR-1.2, 2026-09-14).** `Application.Import.LibraryImporter` over four `IStoreLibrarySource` adapters in
|
||||
`Infrastructure.Import`: `SteamLibrarySource` (`libraryfolders.vdf` + `appmanifest_*.acf` through a new
|
||||
`ValveKeyValues` reader, the root from `HKCU\Software\Valve\Steam\SteamPath`), `GogLibrarySource` (the
|
||||
`HKLM\SOFTWARE\WOW6432Node\GOG.com\Games` keys, read-only, whichever hive and key a caller names so a test uses
|
||||
its own), `EpicLibrarySource` (`Manifests\*.item`: `DisplayName`, `InstallLocation`, `LaunchExecutable`,
|
||||
`AppName`, `AppVersionString`), `ItchLibrarySource` (`apps\*\.itch\receipt.json.gz`). Steam and itch do not name
|
||||
the game's executable: `ExecutableLocator` walks the install three levels deep, drops helpers by name fragment
|
||||
(crash handlers, installers, redistributables, anti-cheat services, updaters) and takes the largest — a guess the
|
||||
review marks "guessed — check it". Discovery joins every title to the ledger: the store's executable or the
|
||||
guess, "already in the library", "no executable found" (a store record that outlived the install). File ▸ Import
|
||||
library… (`ImportLibraryFlow`) shows the checklist (`ImportReviewPrompt` / `Dialogs/ImportReviewContent`, a
|
||||
`DataGrid` with a tick column, select all / none, the count), adds what was ticked exactly as File ▸ Add game…
|
||||
would — **hooking off** — writes the store's platform, id and version through the new
|
||||
`IGameRepository.ApplyStoreMetadataAsync` under the same provenance rule as a detection write (the user's
|
||||
value is never overwritten), and shows the Games page. Nothing is launched, nothing is fetched. The first-run
|
||||
step 4 now points at the menu rather than saying "later build". Tests: `ValveKeyValuesTests`,
|
||||
`StoreLibrarySourcesTests` (fixtures the tests write: two Steam library folders, GOG under a test HKCU key,
|
||||
Epic `.item`, an itch receipt gzipped in the test, the locator), `LibraryImporterTests` (the join, the ticked
|
||||
subset, a store that throws, one executable under two stores), `ImportLibraryFlowTests` (end to end over real
|
||||
files and a scratch ledger; nothing found; cancel; the review's counting), `SqliteGameRepositoryTests` (the
|
||||
store write's provenance). 15 App strings en/vi/ja. Docs: `05_DETECTION` §Platform signatures built note (with
|
||||
the privacy line), `06_DATA_MODEL` §Writer ownership, `08_UI` §Shell menu note + §First-run step 4,
|
||||
`14_TESTING`, HANDOFF §P4, `15_ROADMAP` §P4.
|
||||
- **P4 PR-3 — the bug report's steps 3–4, Help ▸ Documentation, and File ▸ Export as the submenu it was specified
|
||||
as (2026-09-14).** `App/Services/BugReportFlow` is the one flow behind Help ▸ Report a bug… and the Logs page's
|
||||
button: step 2's zip where the user says, then step 3's `ContentDialog` (`BugReportPreviewPrompt` /
|
||||
`Dialogs/BugReportPreviewContent`) listing every entry the builder wrote, with "Show the zip in Explorer" and the
|
||||
drag instruction, then step 4 as its two buttons — **Open GitHub issue** (`IssueLink.NewIssue`:
|
||||
`issues/new?template=bug_report.yml&title=[Bug]%20&labels=bug&app-version=…&os=…`, the form's real hyphenated
|
||||
field ids, the OS in the form's own spelling `Windows 11 26100.2314`) and **Copy summary as Markdown**
|
||||
(`sysinfo.json`'s twelve keys as a table). Nothing is ever sent by itself. Three ports keep it testable without a
|
||||
desktop: `IBugReportPreview`, `IUrlOpener` (`ShellUrlOpener`), `IClipboard` (`WpfClipboard`). Help ▸
|
||||
Documentation opens the README (`docs/` is developer-facing). File ▸ Export is now the submenu `08_UI` §Menu bar
|
||||
specifies: Session CSV / Session JSON for the session last selected on a Sessions tab or opened in a summary
|
||||
window (`SessionSelection`, written by the game page and the summary opener; `SessionExportService` over the
|
||||
summary window's own `SessionExporter` writers), Chart PNG opening that session's summary window where the
|
||||
plot lives; no selection says so in the strip. `BugBundleBuilder.SysInfoOf` is public for the link and the
|
||||
Markdown. Tests: `BugReportFlowTests` (the zip, the preview's entries against the archive, the exact URL, the
|
||||
Markdown, close, cancel), `SessionExportServiceTests` (CSV and JSON where the user says, unknown session,
|
||||
cancelled save, the selection), `LogsViewModelTests` over the flow. 14 App strings en/vi/ja. Docs: `10_LOGGING`
|
||||
§Bug report flow built note (the crash dialog and minidump stay open), `08_UI` §Shell menu note, HANDOFF §P4.
|
||||
- **P4 PR-2 — the "is Vulkan" fact, and the layer's registration following the ledger (2026-09-14).** The rule
|
||||
`12_BUILD` §The Vulkan layer is not registered at install time states — registered only while at least one
|
||||
Vulkan game has hooking enabled, unregistered when the last is disabled — had no way to know which game was
|
||||
Vulkan; the check was "any enabled game". Now the fact is static: `GameFileProbe` reads the executable's import
|
||||
and delay-load tables (`Infrastructure.Detection.PeImports`, bounded, read-only, no exception for a malformed
|
||||
file) and looks for `vulkan-1.dll` as an ASCII or UTF-16 string in the bounded scan (a `LoadLibraryW` loader —
|
||||
`hook-harness --vulkan`'s shape); `StaticDetectionResult.UsesVulkan` is true / false / null, and the sweep
|
||||
stores a true as the id `vulkan` in `capability_flags` beside the rule ids ("Supports Vulkan" on the game page).
|
||||
`Application.Vulkan.VkLayerReconciler` over the new `IVkLayerRegistrar` port (`Infrastructure.Vulkan.VkLayerRegistrar`,
|
||||
the same manifest and HKCU value `--register-vklayer` writes) computes the desired registration from the consent
|
||||
store's enabled games joined to their flags and moves the registration to it — after the pipe handler's stamp,
|
||||
revoke and guard block, after the console `consent grant` / `revoke`, and after every detection sweep, so the
|
||||
crash policy's auto-disable and a fact that arrives after the consent converge within one interval; not staged
|
||||
= nothing to do. `--register-vklayer` runs the reconciler and refuses when no hook-enabled game references the
|
||||
loader; Settings' Register button follows the same rule (`HookedGameViewModel.UsesVulkan`). An Agent off the
|
||||
profile ledger (`--data-dir`) gets an inert registrar: a test or developer ledger never touches HKCU. Tests:
|
||||
`VkLayerReconcilerTests` (first Vulkan game registers, last disables, a D3D game does not, idempotent, not
|
||||
staged), `PeImportsTests` (a synthetic PE32+: both directories, the wide literal through the probe, a malformed
|
||||
file, a non-PE reads as unknown), `DetectionSweepTests` and `StaticGameDetectorTests` (the three-valued fact).
|
||||
`Settings_VkLayer_Note` reworded en/vi/ja. Docs: `17_HOOK_ENGINE` §Vulkan built note gap (1) closed,
|
||||
`12_BUILD` §The Vulkan layer…, `05_DETECTION` §Capability hints, `08_UI` §Settings, HANDOFF §P4.
|
||||
- **P4 PR-1 — the detection rules engine wired into the Agent, and the Supports row (2026-09-14).** The engine,
|
||||
schema, validator and fixture corpus existed since P0 with no production caller and no writer. Now:
|
||||
`Application.Detection.DetectionSweep` runs `StaticGameDetector` over the real `GameFileProbe` for every game in
|
||||
the library whose `DetectionCacheKey` is stale — never scanned, the exe changed, the rules moved on — and
|
||||
persists through the new `IGameRepository.ApplyDetectionAsync`; `Agent.Hosting.DetectionHostedService` hosts it
|
||||
under `--serve` on its own task (the probe blocks on file I/O; the 1 Hz poll never waits on it), every 15 s and
|
||||
at once when `UpdateRules` re-seeds the rules file. **Schema 0004** `games.detection_exe_size_bytes` /
|
||||
`detection_exe_mtime_ms`: the key's exe half apart from `exe_size_bytes` / `exe_mtime_ms`, which are the consent
|
||||
fingerprint the gate reads and which a background scan must never refresh. The repository applies
|
||||
`05_DETECTION` §Caching's provenance rule per field — a `user` field is never touched, a `detected` one is
|
||||
refreshed, an empty field with no entry is filled and badged (without that clause a fresh game could never
|
||||
receive an engine), a null detected value erases nothing — and writes `capability_flags` whole as a JSON array of
|
||||
the rule ids (`dlss`, `dlss_g`, `dlss_rr`, `streamline`, `fsr`, `xess`, `xefg`; the App's `CapabilityNames` reads
|
||||
both spellings). App: Tools ▸ Update detection rules is a real command (`UpdateRules` over the pipe, the seeder's
|
||||
outcome in a snackbar); the game page's Supports row shows what the sweep wrote and says "not scanned yet" only
|
||||
until the Agent's next tick. Tests: `DetectionSweepTests` (5: scanned once then current, exe change and rules
|
||||
change re-scan, unreadable exe and unusable rules, the wake, the key field by field),
|
||||
`SqliteGameRepositoryTests` (the provenance rule end to end, the consent fingerprint untouched),
|
||||
`LedgerDatabaseTests` (0004), `GameDetailViewModelTests` (the Supports row from a detection write, the rule
|
||||
ids). 4 App strings en/vi/ja + the Supports empty-state reworded. Docs: `05_DETECTION` §Caching built note,
|
||||
`06_DATA_MODEL` §Writer ownership / §games / §Migrations, `04_CAPTURE` §Threading model, `08_UI` §Games,
|
||||
HANDOFF §P4 and `15_ROADMAP` §P4 struck.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **The legal documents say what the software does, in release form (2026-09-16).** EULA 1.0, Disclaimer 2.2,
|
||||
Privacy Policy 2.2 — the `-draft` suffix (which `legal_acceptance.version` recorded) and the "Draft for review"
|
||||
banners are gone, so the Legal Gate shows all three again. **Privacy Policy §2** listed three requests the software
|
||||
has never made — a weekly safety-list update, a weekly detection-rules update, an opt-in Steam store lookup —
|
||||
under an audit note saying so since 2026-08-04; version 2.2 keeps the two real rows (Velopack's update check and
|
||||
download) and says there is no other request, with the removal recorded as history in the document itself. §1 no
|
||||
longer mentions cover art (no such feature) and states the log retention the code has (7 days App, 14 Agent).
|
||||
**Disclaimer:** the 25-line accuracy-audit block that sat inside the accepted text moved, unchanged, to
|
||||
`docs/legal-drift-history.md`; a five-line pointer explains how §4 is kept true (`legal/ACCURACY.md` +
|
||||
`accuracy-check`); the contact footer the other two documents carry is added. **Third-party notices:** the IGCL/ADLX
|
||||
box is ticked with its check named (`license-check` §1, in the gate since P0); the About-tab box says it is not
|
||||
built and not a gate for the first pre-release; the trademarks pointer reads §6. **README** §Privacy collapsed to
|
||||
one accurate paragraph. **Settings:** the `privacy.online_metadata` toggle is no longer shown — a switch for a request
|
||||
that has no code is the same over-disclosure — and the setting stays reserved (`06_DATA_MODEL` §Settings registry,
|
||||
`08_UI`). `20_OPEN_QUESTIONS` §S20: the feed lands as a new policy version, not as rows kept in advance. The
|
||||
accuracy block's "unreleased" sentence is deliberately untouched: it becomes false with the tag and is rewritten in
|
||||
the tag commit.
|
||||
- **itch.io import reads butler's database, so an install location outside `%APPDATA%` is found (2026-09-16).**
|
||||
`ItchLibrarySource` scanned `%APPDATA%\itch\apps\*\.itch\receipt.json.gz` and nothing else; on the owner's machine
|
||||
the itch app's one install location is `D:\another\it`, `apps\` is empty, and the import logged `itch — 0 title(s)`
|
||||
with no reason — every itch title had to be added by hand. The app records its installs in
|
||||
`%APPDATA%\itch\db\butler.db`: `install_locations` (the folders the user chose), `caves` (one per install, with the
|
||||
folder name or a custom folder) and its own `verdict` JSON naming the executable butler launches. The adapter now
|
||||
copies that database to a temporary directory (the running app holds it in WAL mode), opens the copy read-only,
|
||||
joins the three tables, takes the first Windows candidate of the verdict as the executable (an HTML or Love2D game
|
||||
leaves the locator's guess), and still scans `apps\` receipts for anything the database does not list; an install
|
||||
found both ways is one row, the database's. It logs one line per run — what was consulted and what each source
|
||||
yielded — through the importer's sink, so `0 title(s)` has a reason beside it. `ItchLibrarySource`'s constructor
|
||||
now takes the itch directory (`%APPDATA%\itch`), not `apps\`. Tests: `StoreLibrarySourcesTests` (a butler.db built
|
||||
in the test with a location elsewhere, a custom folder, a verdict path with forward slashes, an HTML-only verdict,
|
||||
a verdict that will not parse, a receipt beside a cave and a receipt-only install; no database and a garbage
|
||||
database both fall back to receipts and say so). Docs: `05_DETECTION` §Platform signatures.
|
||||
- **The Games card's hooking chip reads at 2.6:1 no more, and the Dashboard's FG qualifier no longer clips
|
||||
(2026-09-16).** "Hooking on/off" was `ui:Badge Appearance="Info"`: WPF UI paints that with `PaletteLightBlueBrush`,
|
||||
a fixed Material colour outside both theme dictionaries, under the theme's white text — `#03A9F4` in dark, below
|
||||
AA-large — and no `#` in our XAML for `NoXamlHardCodesAColour` to catch. It is a `Border` in the new `HookStatePill`
|
||||
style now (ON: the accent pair the ×FG chip uses; OFF: the Pill's muted fill with secondary text), the edit
|
||||
dialog's "Detected" badge is `Secondary`, and `ContrastTests` holds it: no App XAML uses the four palette
|
||||
appearances, and every pill's (text, fill) pair composited over the card and window backgrounds is ≥ 4.5:1 in both
|
||||
theme dictionaries, with the old pair asserted below it so the check is known to bite. The FG qualifier chip on the
|
||||
Dashboard's recent-sessions row was reported with it and had a different defect — a sentence-length qualifier in a
|
||||
star column with no trimming overflowed the row — so 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. Docs: `08_UI` §Contrast, `16_WPFUI_SYNTAX` §Theming.
|
||||
- **A print verb no longer migrates the ledger it prints, and a close checkpoints the WAL it wrote (2026-09-16).**
|
||||
`FrameLedger.Agent --console sessions`, run against the owner's own ledger while its on-disk file was at schema 2,
|
||||
applied scripts 0003 and 0004 to it: every verb opened through the one migrating `LedgerDatabase.OpenAsync`. Found
|
||||
while investigating a ledger whose day of rows lived only in a 4 MB WAL whose 1006 frames carried a salt one
|
||||
generation older than the WAL header, over a main file no checkpoint had reached — a fresh connection (the console,
|
||||
a next launch) saw the 14 September state, while the running App and Agent saw the day through the shared WAL
|
||||
index. The mechanism is unrecorded (`06_DATA_MODEL` §Migrations carries what was observed and what is not known);
|
||||
the data was rebuilt from the old-salt chain by hand. What changed: `LedgerDatabase.OpenReadOnlyAsync` — an
|
||||
existing file, `query_only`, no pragma that writes, no `MigrationRunner`; a schema newer OR older than the build is
|
||||
refused with the reason, and `WriteAsync`/`MaintainAsync` throw. The Agent's `sessions`, `consent list`,
|
||||
`killswitch status` use it (`Program.PrintsOnly`), `db path` opens nothing at all, and a refusal is a console line
|
||||
with exit 7, never a crash dump; the App's `--diag` uses it too. `OpenAsync` now runs a passive checkpoint after
|
||||
migrating and reports it (`LedgerDatabase.OpenDiagnostics`, one `ledger: wal at open` log line), and
|
||||
`DisposeAsync` runs `wal_checkpoint(TRUNCATE)` and reports that, so a clean close leaves the main file complete
|
||||
whether or not SQLite's own close-time checkpoint runs. Tests: `LedgerDatabaseTests` (an older schema is refused
|
||||
byte-for-byte unchanged; a read-only open reads and refuses to write; a missing file creates nothing; a close leaves
|
||||
the row readable through `immutable=1`), `AgentReadOnlyVerbsTests` (the print-verb set, the refusal's exit code and
|
||||
the untouched file, `db path` without a ledger). Docs: `06_DATA_MODEL` §Migrations, `12_BUILD` §Debugging,
|
||||
`10_LOGGING` §Diagnostics, HANDOFF §Traps.
|
||||
- **A start that fails says so on screen (2026-09-15).** When `App.RunAsync` caught its own exception — a ledger
|
||||
that would not open (a newer schema, a locked file), a host that would not start — FrameLedger wrote a Fatal line to
|
||||
`ui-*.log` and exited with code 1 with nothing on screen, so a user saw a click do nothing. It now shows
|
||||
`StartupFailureDialog`, a Win32 message box like the crash dialog (the shell is what failed): the exception's message,
|
||||
the log folder, and Yes to open that folder; the exit code is still 1, and a crash the dispatcher already reported
|
||||
shows no second dialog. Two strings (en/vi/ja). Tests: `StartupFailureDialogTests`. Docs: `10_LOGGING` §Crash
|
||||
handling.
|
||||
- **Bug bundles no longer carry the user's name in log paths, which the privacy policy already promised
|
||||
(2026-09-15).** `legal/PRIVACY_POLICY.md` §3 says "logs are redacted (user directory paths removed) before
|
||||
bundling" and `10_LOGGING` named a `RedactingEnricher`; neither existed, and `BugBundleBuilder` copied `ui-*.log`,
|
||||
`agent-*.log` and `overlay-*.log` verbatim on the stated ground that they carry no paths beyond the data directory,
|
||||
which is itself under the user's profile. On the dev box the profile path appeared 8 times in the UI log, 7 in the
|
||||
Agent's and in 175 overlay headers. `App/Services/LogRedactor` now rewrites every log copy in the zip: the name in
|
||||
each `X:\Users\<name>` path becomes `<user>`, and so does a profile directory's last segment elsewhere, in
|
||||
backslash, doubled-backslash (Serilog's JSON), forward-slash, any-case and ANSI-`?` spellings, byte for byte
|
||||
otherwise (Latin-1 round trip, so UTF-8 and ANSI logs both survive). The files on disk keep their paths; the policy's
|
||||
sentence is now true without a word of it changing. Tests: `LogRedactorTests`, `BugBundleBuilderTests`. Docs:
|
||||
`10_LOGGING` §Serilog configuration (the enricher claim struck, with where the rule is enforced) and §Bug report
|
||||
flow step 2.
|
||||
- **Two unmeasured facts were stored as values (2026-09-15).** The quality byte's `0xFF`, the Overlay's "a hook ran
|
||||
and could not tell" (`fl_shm.h` `upscalerQuality`), was aggregated as a number, so a session and the live card
|
||||
carried the text `255`, which the game page and the Dashboard append to the upscaler's name: every AMD dispatch
|
||||
carries `0xFF`, so an FSR title would read "FSR 255". `SessionAggregator` (row and segments) and
|
||||
`SessionProgressCalculator` now leave those frames out, and a quality nobody told is null (`FrameSample.QualityNotTold`).
|
||||
And `reflex_active` was written `false` on every hooked row with no latency sample, although nothing measures Reflex
|
||||
today; it is null there now, so an export no longer says "off" for a thing never measured. Tests:
|
||||
`SessionAggregatorTests` (not told is null, told frames still count; Reflex null), `SessionProgressCalculatorTests`.
|
||||
Found while checking `legal/ACCURACY.md` against the code. Not done: naming a preset the hook did read, which
|
||||
`03_METRICS` assigns to a `Domain.UpscalerNames` that does not exist; no measured title has produced one.
|
||||
- **Test runs stop filling the real data folder with hook-harness logs (2026-09-15).** The injection tests inject the
|
||||
shipped Overlay, whose log goes to `%LOCALAPPDATA%\FrameLedger\logs` by design (§S21: not the environment, and no
|
||||
switch in the injected DLL), so the owner's folder held 2506 overlay logs, 2492 of them hook-harness's from test
|
||||
runs since 2026-09-06, beside 14 from real titles. Each test binary now removes, when its run ends, exactly the logs
|
||||
it caused: an `overlay-*.log` created after the run started whose first line names a hook-harness image it owns. A
|
||||
Catch2 listener in `guard_test.cpp` does it natively (`src/native/tests/overlay_log_sweep.h`, the image must be this build's
|
||||
`FL_HARNESS_EXE`), and `tests/Shared/HarnessOverlayLogSweep.cs`, an xUnit assembly fixture that
|
||||
`FrameLedger.DrainFixtures.targets` compiles into every test project staging the harness, does it for the managed
|
||||
suites (the copy beside the test binary, plus the renamed copy `PipeEndToEndTests` registers). Assemblies run in
|
||||
parallel with their own copies, so none removes a log another is about to read, and a game's log is never touched.
|
||||
The new `test-artifacts` gate (`tools/test-artifacts-check.ps1`, seven self-test cases) fails for a harness log
|
||||
created during the gate and still there, which is red on the unswept tree. Tests: `[sweep]` in `fl_guard_test`,
|
||||
`HarnessOverlayLogSweepTests`. The logs from before this change are left for the owner. Docs: `17_HOOK_ENGINE`
|
||||
§Native logging, `12_BUILD` gate list, `14_TESTING`, HANDOFF §Traps. No Overlay change, so no hook-path overhead.
|
||||
- **The accuracy block says what the code measures on 2026-09-15 (`legal/ACCURACY.md`, embedded in `README.md` and
|
||||
`legal/DISCLAIMER.md`).** Dated 2026-09-06, it still said there was no Agent loop, storage, charts, library import
|
||||
or UI, that OpenGL intercepted nothing, that no shipped component drove the 30 s re-scan and that video memory was
|
||||
not measured — all false since. Every sentence was re-checked against the code: OpenGL is measured; Vulkan only
|
||||
when FrameLedger starts the game (a running Vulkan title gets the Direct3D component, unverified); FSR is named FSR 3
|
||||
or unversioned, never FSR 2 or 4; the preset is not reported anywhere; frame generation is Direct3D-only and falls
|
||||
back to a qualified Presented FPS; whole-card video memory is recorded while per-game VRAM, shader-stutter
|
||||
attribution, Reflex, HDR and CPU temperature are not; the shipped Agent runs the re-scan and the kill switch can
|
||||
only refuse. Nothing has been released. `README.md` outside the block: the safety row's "re-scan does not run at
|
||||
all", the XeSS and "always shown" promises, the Vulkan requirement, CPU temperature, NVAPI's Reflex, and a note that
|
||||
no release exists. `legal/DISCLAIMER.md` is 2.1-draft (the first-run gate shows it again): two history bullets the
|
||||
software caught up with are struck, and the path-tracing "confidence-scored suggestion" it never computes is
|
||||
corrected. Docs that contradicted the code: `04_CAPTURE` (attach mode on a running Vulkan title is not Tier 2 — an
|
||||
open decision for the owner), `05_DETECTION` (four runtime facts have no writer), `17_HOOK_ENGINE` (`wglSwapBuffers`
|
||||
is built), `15_ROADMAP` and HANDOFF (`StaticGameDetector` runs in `DetectionSweep`). Stale comments in `dllmain.cpp`
|
||||
(OpenGL "NOT HERE"), `layer.cpp` (`vkQueuePresentKHR` "NOT hooked") and `fl_guard.cpp` (the signer lookup "not wired
|
||||
yet") now say what the code does; comments only, no behaviour change.
|
||||
- **The native log test read another process's log, and was filed as a flake four times (2026-09-14).**
|
||||
`guard_test.cpp`'s `FindOverlayLog` took the first `overlay-<pid>-*.log` by name in the real
|
||||
`%LOCALAPPDATA%\FrameLedger\logs`, which keeps every run's log — 2130 on the dev box. A harness that drew a
|
||||
reused pid (6840) read a finished log from 2026-09-06 and failed on its STOP line; a re-run drew a fresh pid and
|
||||
passed. The failure output had printed the stale path every time. It now takes the newest log created at or after
|
||||
the child process started (`GetProcessTimes`), and the test now plants a 1999-dated log under the child's pid
|
||||
before injecting, so the old lookup is red on every run instead of on pid reuse — measured: with the lookup
|
||||
reverted, 9 of 18 assertions failed reading the planted file; with the fix, 18 of 18 pass and the file is removed
|
||||
either way. Test-only: no shipped binary changes.
|
||||
- **A DXGI present counter that went backwards read as four billion unseen presents (2026-09-14).** The Present
|
||||
hook reads `IDXGISwapChain::GetLastPresentCount` before forwarding and took `now − previous` on the chain's slot
|
||||
as unsigned arithmetic. A chain released and re-created at the same address inherits the slot and its old count
|
||||
while DXGI's count for the new chain starts near zero, so the difference wrapped to ~4e9: the owner's ledger
|
||||
held `dxgi_unseen_total = 4294967243` (−53 as `uint32`) on a title whose pacer never presented past the hook, the
|
||||
record byte saturated at 255, and that saturation is the `DxgiSaturated` refusal that took the frame-generation
|
||||
factor with it. `fl_dxgi_count.h` now owns the arithmetic: a regression is a reset — the present claims no delta
|
||||
(as a chain's first hooked present does), nothing is added, the slot re-arms on the new reading — and the
|
||||
session total saturates at `UINT32_MAX` rather than wrapping, the same direction the record byte already took
|
||||
(a numerator must read high and be refused, never low and be believed). Compile-time `static_assert`s pin the
|
||||
algebra; ctest `fl_dxgi_count` (`hook-harness --probe-dxgi-count`) drives the two behaviours. Hook-path cost: one
|
||||
compare on the virtual call the hook already made (`--probe-cost` in the PR). Docs: `fl_shm.h` @48/@52,
|
||||
`17_HOOK_ENGINE` §Hook inventory.
|
||||
- **A safety notice was a red bar with no way to close it (2026-09-14).** WPF UI 4.3.0's `InfoBar` template has no
|
||||
`ContentPresenter`, so the action button every persistent banner carries as the InfoBar's Content — "Record this
|
||||
session without measuring it" on a refusal, Dismiss on an unhook or a degrade, the only dismissal once
|
||||
`IsClosable="False"` removed the X per `08_UI` §Notifications policy — compiled, bound and was never drawn. The
|
||||
Agent-offline banner's Retry and the game page's Re-enable were dropped the same way. `Styles/FrameLedger.xaml`
|
||||
now re-templates `ui:InfoBar` with the upstream template verbatim plus one presenter column, collapsed without
|
||||
content; no view model changed. `PagesLoadTests.TheInfoBarTemplateRendersItsContent` renders the app's template
|
||||
and the library's and asserts the button appears under one and not the other, so it turns red when upstream
|
||||
gains a presenter and the copy should go. `legal/licenses/wpfui-MIT.txt` added (the template is MIT text).
|
||||
Docs: `08_UI` §Notifications policy correction, `16_WPFUI_SYNTAX` §Gotchas, HANDOFF §Traps.
|
||||
- **Frame generation read N/A beside a detection that had succeeded (2026-09-14).** Two of the owner's hooked rows
|
||||
carried `fg_mode = 'dlssg'`, `fg_source = 'api'` and `fg_factor` NULL — the Streamline tags named DLSS-G, the
|
||||
census had `sl.dlss_g.dll`, and the token count refused — and every FG surface in the App said N/A: the readout
|
||||
fell into the "detected" shape and printed `N/A → N/A FPS (×0.0 FG)` (a factor nobody counted, from `factor ?? 0`),
|
||||
the game page said `DLSS-G ` with a trailing space, the grid's Displayed and FG× said N/A with no reason, and the
|
||||
reason existed nowhere — `FgWindow.Refusal` was computed and dropped. Now: **schema 0003** adds `sessions.fg_refusal`
|
||||
(`Vocabulary.FgRefusal`: `not_counted`, `no_evaluations`, `non_uniform`, `dxgi_saturated`, …), written by
|
||||
`SessionAggregator.ApplyFg` whenever no factor is published; `SessionProgress` gains optional `fgRefusal` and
|
||||
`fgRuntimeCensus`; and the UI gains a fourth shape, `FpsReadoutKind.IdentifiedUncounted` — Presented FPS with a
|
||||
warning chip "DLSS-G active — factor not counted", the refusal in plain words as its tooltip ("read it as Displayed,
|
||||
not Native"), `DLSS-G · factor not counted` on the game page, N/A in Displayed and FG× (no factor exists; it is not
|
||||
a measured none). `GeneratedLine` no longer accepts a missing factor. The `fg_runtime_loaded` chip now names the
|
||||
module from the census (`08_UI` §FPS display rule asked for it from the start): `FG runtime loaded (sl.dlss_g.dll)
|
||||
— may include generated frames`. 15 App strings en/vi/ja (`Fg_Refusal_*`, `Fps_Fg_Identified_*`,
|
||||
`Fps_Census_RuntimeLoaded_Named_Format`, `Fg_Factor_NotCounted`). Tests: `FpsPresentationTests` (the shape, the
|
||||
live wire, the module name, the counted label), `GameDetailViewModelTests` (the page and the grid),
|
||||
`SessionAggregatorTests` (identity without a count records the refusal, the owner's zero-token shape, a counted
|
||||
factor carries none), `SessionProgressCalculatorTests`, `LedgerDatabaseTests` (the column). Docs: `03_METRICS`
|
||||
§Metrics FG factor row, `08_UI` §FPS display rule, `06_DATA_MODEL` §sessions + §Migrations, `07_IPC` §Messages.
|
||||
What this does NOT do: decide the count. Why the count refused on those two rows is what the new column will
|
||||
say on the next capture — the `dxgi_unseen_total` of 4294967243 on one of them (a `uint32` gone negative in the
|
||||
Overlay's DXGI delta) is a separate, native fix.
|
||||
- **Two Settings descriptions were centred once they wrapped (2026-09-14).** A `TextBlock` with a `MaxWidth`
|
||||
inside a stretched `StackPanel` is centred by WPF as soon as its text wraps, so the descriptions under
|
||||
*Record games launched outside FrameLedger* and *Fetch store metadata online* showed their second line offset
|
||||
(owner screenshots, en and vi). Both carry `HorizontalAlignment="Left"` now, like the Vulkan layer and logon
|
||||
task rows already did. XAML only.
|
||||
|
||||
@@ -0,0 +1,809 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66): part 2 of 5 of the ledger kept before the first tag, newest first. CHANGELOG.md lists every part. -->
|
||||
|
||||
## Ledger before 0.1.0-beta.1 (continued, part 2 of 5)
|
||||
|
||||
### Added
|
||||
|
||||
- **P3 PR-9 — first run, the Legal Gate (FR-11), the closing sweep (2026-09-14).** `FirstRunWindow` /
|
||||
`FirstRunContent` / `FirstRunViewModel`, shown before the shell whenever `LegalGate` says a document has no
|
||||
acceptance at this build's version: the four documents embedded at build (`legal/EULA.md`, `LICENSE`,
|
||||
`legal/DISCLAIMER.md`, `legal/PRIVACY_POLICY.md` — the text this build was reviewed with, authoring comments
|
||||
stripped, `{{RELEASE_DATE}}` left for release), one Accept writing four `legal_acceptance` rows with each
|
||||
document's own `**Version:**` line, Decline ending the host, a closed window counting as a decline; the
|
||||
Agent-setup step (unelevated by default, elevation optional and required by no tier, the `HelloAck` facts as
|
||||
they arrive); the hooking explainer reusing the consent dialog's reviewed Tier 1 / Tier 2 paragraphs and
|
||||
saying hooking stays off until enabled per game; the import placeholder. Settings ▸ "Reopen the legal
|
||||
documents" shows them read-only. D8 unchanged: the gate is not a consent precondition. NFR-4: the first
|
||||
window's time from process start is logged every run (1.3–1.5 s on the dev box), the 100-session query is
|
||||
asserted under 500 ms, charts draw ≤ 2 × 2000 points per series. Tests (App, 120): `LegalDocumentsTests`,
|
||||
`FirstRunViewModelTests` (6), the Settings reopen, both first-run steps in `PagesLoadTests`. 29 App strings
|
||||
en/vi/ja. Docs: `08_UI` §First-run flow built note with the NFR-4 numbers, `06_DATA_MODEL` §legal_acceptance,
|
||||
`20_OPEN_QUESTIONS` §G legal-versioning row answered, `15_ROADMAP` §P3 code-complete, `09_I18N` scope line,
|
||||
CLAUDE.md's App line, HANDOFF row 9 struck and the one START HERE moved to a P4 pointer.
|
||||
- **P3 PR-8b — the tray, the Agent's maintenance flags, the Settings buttons over them (2026-09-14).** The tray
|
||||
(H.NotifyIcon.Wpf, `TrayHost` over a WPF-free `TrayViewModel`): four drawn icons — ● a Tier-1 session runs,
|
||||
◐ sessions run and none is measured, ⏸ the Agent reports paused, a ring otherwise — the tooltip naming the
|
||||
game; menu Open / Pause–Resume capture (`PauseCapture`/`ResumeCapture`, the state shown is the `PauseAck`'s) /
|
||||
Agent status / Exit; a left click opens the window; **minimize to tray on close** honoured through
|
||||
`WindowClosePolicy` while a tray icon exists; **FR-3.8's balloon** "Session saved — game — click to view" only
|
||||
while the window is off screen (the Dashboard's snackbar otherwise — one event, one channel), its click opening
|
||||
the summary; a safety event is never a balloon. Tools ▸ Agent status… / Vulkan layer registration… navigate.
|
||||
The Agent's `--install-task` / `--uninstall-task` (`Infrastructure.Startup.LogonTask`: `\FrameLedger\FrameLedger.Agent`
|
||||
through the Task Scheduler COM API — `schtasks /Create /SC ONLOGON` is "Access is denied" unelevated, measured —
|
||||
this user's logon trigger, interactive token, lowest run level, `--serve`) and `--register-vklayer` /
|
||||
`--unregister-vklayer` (`Infrastructure.Vulkan.VkLayerRegistration`: the HKCU `ImplicitLayers` DWORD named by
|
||||
the manifest; register refuses while no game has hooking on; unregister also removes a stale value naming our
|
||||
manifest elsewhere); `HelloAck.vulkanLayerRegistered` now reads the key; `--diag` is the one flag the Agent
|
||||
still answers "not this binary's". Settings: Register / Unregister the layer and Register / Repair / Remove the
|
||||
task run the flag as a child process and re-read the machine. Tests: `TrayViewModelTests` (7), the Settings
|
||||
additions (3), `VkLayerRegistrationTests` (under a test's own key), `LogonTaskTests` (Integration: a real task
|
||||
under a test's own name), `AgentCommandLineSurfaceTests` (the flags are verbs), the e2e flags case now `--diag`.
|
||||
27 App strings en/vi/ja. Docs: `08_UI` §Shell tray note and §Settings 8b note, `17_HOOK_ENGINE` §Vulkan built
|
||||
note with its two stated gaps, `12_BUILD` §Agent flags, HANDOFF row 8 struck.
|
||||
- **P3 PR-8a — Settings, the safety notices, the Logs page, `--diag` (2026-09-14).** The Settings page over the
|
||||
registry (`RegisteredSettings`, D16): Capture first — the global kill switch (`hooking.kill_switch`, the gate's
|
||||
fourth input, so a running measured session stops at its next 30 s re-scan) with its state line, the
|
||||
hook-enabled games with a per-row "Turn off" that is `SetHookEnabled { enabled: false }` over the pipe (the
|
||||
App still writes no hook-state column, D15), the Vulkan layer state from `HelloAck`, the safety-document link;
|
||||
then minimum session length / sensor interval / raw-series retention as bounded `NumberBox`es that refuse an
|
||||
out-of-range value in place, background capture, the Agent's elevation state with the "not required by any
|
||||
tier" paragraph, "Start FrameLedger with Windows" as this user's `HKCU\…\Run` value
|
||||
(`Infrastructure.Startup.RunAtLogon`), minimize-to-tray (stored; honoured by PR-8b), online metadata (off),
|
||||
the update channel (stored), debug logging (moves the App's Serilog `LoggingLevelSwitch` at once), and Legal
|
||||
reopen as a "not yet" line until PR-9. **Safety notices** (`Services/SafetyNotices`, `08_UI` §Notifications
|
||||
policy): `CaptureRefused`, `SafetyUnhook` and `CaptureDegraded` become persistent `InfoBar`s above every page
|
||||
with the family and signal named from the `Safety_*` strings, never a toast, never a timeout; the one button
|
||||
on a refusal is "Record this session without measuring it" — the acknowledgement, since the Agent already
|
||||
records Tier 2; `CaptureError` goes to the 4 s strip. **Logs** (`LogTail`, `LogsViewModel`): the newest
|
||||
`ui-*.log` / `agent-*.log` with shared read and a 2 MB cap, level filter over the template's prefix, search,
|
||||
pause, a 2 s refresh only while the page is shown, Open logs folder, and Export bug bundle = `10_LOGGING` step
|
||||
2 (`BugBundleBuilder`: our logs of the last seven days verbatim, the five newest overlay logs, `sysinfo.json`,
|
||||
`settings.json`; nothing is sent, steps 3–5 are P4's). **`FrameLedger.exe --diag`** writes the environment and
|
||||
capability report to `logs/diag-<ts>.txt` and stdout without starting the host. Tests (App, 100; Infrastructure
|
||||
+2): `SettingsViewModelTests`, `SafetyNoticesTests`, `LogTailTests`, `LogsViewModelTests`,
|
||||
`BugBundleBuilderTests`, `DiagReportTests`, `RunAtLogonTests`, and both pages rendered in `PagesLoadTests`. 69
|
||||
new App strings in en/vi/ja. Docs: `08_UI` §Notifications policy/§Logs/§Settings built notes, `10_LOGGING`
|
||||
built notes, HANDOFF row 8 amended (8b: tray, layer and task verbs), CLAUDE.md's App line.
|
||||
- **P3 PR-7 — Trend, Sensors, Latency, and Compare with the mixed-tier guard (2026-09-14).** The game page's tabs
|
||||
2–6: Frametime and Distribution of the selected session (the summary window's own charts); **Trend** through
|
||||
`Charts/TrendSeriesBuilder` — one point per hooked session oldest first (Average = Native where frame generation
|
||||
was measured, Presented where not; Displayed only where measured; the lows; max GPU °C), FR-6.4's exclusion of
|
||||
mid-session-change sessions by default with the toggle and the excluded count, FR-6.3's markers wherever two
|
||||
consecutive sessions' hardware snapshots differ (GPU driver, GPU, CPU, display mode, OS) as labelled lines on
|
||||
a date axis; **Sensors** (core / hotspot °C, load %, power W on one plot; the game's own per-present VRAM and
|
||||
the adapter-wide sensor as two differently-labelled series on another); **Latency** (the `latency_us` blob with
|
||||
the stored avg / p95 lines, only when Reflex reported). **Compare** (`CompareViewModel`): the last 200 sessions
|
||||
across games in a checkbox picker (2–5), `IMixedTierPrompt` — a blocking `ContentDialog` that compares nothing on
|
||||
a decline (FR-6.2), the tier legend on the chart and an `InfoBar` when it proceeds — one percentile curve per
|
||||
hooked session (`Charts/PercentileCurve`, shared with the distribution), the stat table with Native / Displayed /
|
||||
Presented FPS as three separate rows, the best value of each row highlighted (higher wins for FPS, lower for
|
||||
temperature and stutter, N/A never), Tier-2 cells at N/A, PNG export. Tests (App, 74): `TrendSeriesBuilderTests`
|
||||
(order, the exclusion, Average/Displayed per shape, the markers' text), `CompareViewModelTests` (the picker's
|
||||
bounds, a declined guard, an acknowledged mixed comparison with its legend and N/A cells, the best-of-row
|
||||
rule), the selected-session series and the trend toggles on the game page, and all four new charts rendered
|
||||
through Skia in `PagesLoadTests`. 65 new App strings in en/vi/ja. Docs: `08_UI` §Games tabs and §Compare built
|
||||
notes, HANDOFF row 7 struck.
|
||||
- **P3 PR-6 — the session summary window and the charts: `ChartTheme` over two palettes, min/max decimation,
|
||||
the frametime timeline with stutter markers, segment ribbon and sensor overlay, the distribution, FR-8.3's
|
||||
override, tags/notes, and CSV/JSON/PNG export (2026-09-14).** `Charts/SessionSeriesLoader` decodes a session's
|
||||
blobs once (cumulative time, the generated and gap bits, the application-frame view with
|
||||
`Domain.Metrics.StutterDetector` over it, segments from frame index to seconds, sensors aligned to `t_ms`);
|
||||
`Charts/Decimator` is FR-5.3 (every bucket's min and max in order, ≤ 4000 points per draw — a 500k-point
|
||||
series keeps its spike and its dip); `FrametimeChart` (native by default, the every-present series behind the
|
||||
FR-5.4 toggle only when generated frames exist, PSO-compile stutter coloured apart per FR-5.5, alternating
|
||||
segment spans, GPU temperature / load on the right axis) and `DistributionChart` (FPS histogram, the percentile
|
||||
curve through `Domain.Metrics.Percentile`) draw ScottPlot 5.1.59 plots under `ChartTheme` — one subscription to
|
||||
`ApplicationThemeManager.Changed` re-colours every live plot from `Styles/ChartPalette.{Dark,Light}.xaml`, the
|
||||
one place hex colours are allowed, with `ChartPaletteTests` pinning the two files' key parity.
|
||||
`Windows/SessionSummaryWindow` (a secondary `FluentWindow` with its own dialog host) shows the stored
|
||||
aggregates as stat cards — never recomputed, the lows labelled *(presented)* when frame generation was not
|
||||
measured — the chips resolved through `TriStateResolution` with FR-8.3's dialog writing the override to
|
||||
`session_annotations` beside the measurement (and the game default on request), the crash and safety-unhook
|
||||
bars, the tags/notes editor, and FR-9: `SessionExporter` writes the CSV with `03_METRICS` §Export schema's
|
||||
column line verbatim and its `#` header block, InvariantCulture throughout, no rows for Tier 2; the JSON
|
||||
(`frameledger-session/1`); PNG via `Plot.SavePng`. Opened from a Sessions-tab row and from the Dashboard's
|
||||
recent list; FR-3.8 is an in-app notice on `SessionCompleted` until the tray exists. Tests (App, 67):
|
||||
`DecimatorTests`, `ChartPaletteTests`, `SessionSeriesLoaderTests` (the bits, the views, the segment mapping,
|
||||
−1 sensor ticks dropped, a 2000-frame round trip with stutter flags), `SessionExporterTests` (the schema line,
|
||||
the header, invariance under vi-VN, a Tier-2 export with no rows, the JSON with N/A omitted),
|
||||
`SessionSummaryViewModelTests` (cards from the row, the override beside the measurement and its clearing,
|
||||
tags de-duplicated, exports through a scripted saver). 57 new App strings in en/vi/ja. Docs: `08_UI` §Session
|
||||
summary and `16_WPFUI` §ScottPlot theme sync built notes, HANDOFF row 6 struck with the two deliberate
|
||||
deviations (a dialog rather than a flyout; the toast waits for the tray).
|
||||
- **P3 PR-5 — Games and Dashboard: the grid, the game page, the hooking control, the Sessions tab, the live
|
||||
card, `FpsReadout` and `TriStateChip` (2026-09-14).** `Services.FpsPresentation` decides CLAUDE.md rule 6 in ONE
|
||||
place for rows and for 1 Hz progress events — generated (`62 → 118 FPS (×1.9 FG)`, Native first, the factor a
|
||||
chip), measured none (`144 FPS` alone), not measured (Presented FPS with the census qualifier chip, muted or a
|
||||
warning) — and the table's two negatives, `—` (measured none) and `N/A` (not measured), that must not collapse;
|
||||
`FpsPresentationTests` pins all three shapes and both negatives. `Controls/FpsReadout` and `Controls/TriStateChip`
|
||||
render a model and decide nothing. Games: `GamesViewModel` (cards from `GameLibrary.ListCardsAsync`, search and
|
||||
sort in memory), FR-1.1 by pick, menu or a dropped `.exe` (`AddGameFlow`, one flow), FR-1.4 with
|
||||
**Keep sessions / Delete sessions too** revoking consent over the pipe first; `GameDetailViewModel` (header,
|
||||
**Supports** beside **Last session measured**, FR-1.3's edit dialog badging detected fields, the hooking toggle
|
||||
through `HookingConsent` with a refusal / mismatch / failure as a persistent `InfoBar` and FR-2.2's disabled
|
||||
switch with the reason inline, FR-2.5's InfoBar with re-enable, the Sessions `DataGrid` of FR-6.1 with the
|
||||
chips resolved through `TriStateResolution`). Dashboard: `LiveCaptureViewModel` over `SessionStarted` /
|
||||
`SessionProgress` / `SessionCompleted`, the recent list with game names, the totals strip
|
||||
(`ISessionRepository.CountSinceAsync` is new). Pages are navigated by type; `GameSelection` carries the game;
|
||||
`IPageNavigator`, `IGamePicker`, `IConfirmations`, `IEditGamePrompt`, `IMessageStrip`, `IAgentLink` are the
|
||||
seams the tests use. Tests (App, 54): the presentation rule, formats, `GameLibrary` over a scratch ledger, the
|
||||
game page end to end with a scripted Agent (toggle on → dialog → `SetHookEnabled` → reload; refusal → notice
|
||||
and a blocked row disables the switch; remove revokes first), the Dashboard's events, and **`PagesLoadTests`
|
||||
— every page and both templates load under the real theme dictionaries on an STA thread**, so a binding typo
|
||||
is red in CI. 130 new App strings in en/vi/ja. Docs: `08_UI` §Dashboard and §Games built notes, `16_WPFUI`
|
||||
§Custom controls as built, HANDOFF row 5 struck. **Deferred on purpose:** the card sparkline and the chip
|
||||
override flyout (PR-6), the Agent card's capability badges and Repair (PR-8), a dropped `.lnk`.
|
||||
- **P3 PR-4 — FR-2.1's consent dialog: the reviewed `Safety_*` family in `Shared`, `ConsentProvenance.ConsentDialog`,
|
||||
and the Agent's stamp (2026-09-13).** `src/FrameLedger.Shared/Strings.resx` + `.vi` + `.ja` — 20 `Safety_*` keys:
|
||||
the dialog (intro that recommends neither choice, what is injected and why, **Tier 1 and Tier 2 as two
|
||||
paragraphs of the same shape**, the anti-cheat statement with the 30 s unhook, the terms statement, the typed
|
||||
phrase, the two buttons, the version-mismatch and agent-unavailable sentences) and the safety notices PR-5
|
||||
and PR-8 will render (`Safety_Refused_*`, `Safety_Blocked_Toggle_Format`, `Safety_AutoDisabled_Format`,
|
||||
`Safety_Unhooked_Format`, `Safety_RecordWithoutMeasuring`). `en` and `vi` written; **`ja` is the English
|
||||
verbatim under `safety: human review required`**, which `resx-audit` enforces. `Shared.Safety.SafetyDisclosure.Version`
|
||||
= `consent-dialog/1` (D14): `HelloAck.disclosureVersion` names what the Agent stamps against; the App's
|
||||
`HookingConsent` does not open the dialog on a mismatch (and says "restart both"), shows `ConsentPrompt`
|
||||
(WPF UI `ContentDialog`, primary button bound to the typed phrase, Enter keeps hooking off), and sends
|
||||
`SetHookEnabled { enabled: true, disclosureVersion }` — the version it showed, never a timestamp. The Agent's
|
||||
handler re-runs the pre-scan, compares the version to its own, and **stamps `ConsentProvenance.ConsentDialog`
|
||||
from its own clock** (`HookEnabledAck { enabled, outcome, prescan: "clean" }`) or answers the new
|
||||
`Error DisclosureVersionMismatch` with nothing written; `DisclosureUnavailable` remains for a composition
|
||||
that wired no version. `PipeClient.RequestEnvelopeAsync` lets the App tell a `Refused` from a
|
||||
`HookEnabledAck` (both are answers, neither is an error). `ConsentProvenance` has four names and
|
||||
`GameConsentRecordTests` pins them with the number. Tests: `HookingConsentTests` (App: the handshake gates the
|
||||
dialog, a declined dialog sends nothing, the request carries our version, stamped / refused / error each come
|
||||
back as what they are, the phrase is exact), `SafetyStringsTests` (every key in three languages through the
|
||||
satellites, vi translated, ja the English, no recommending word in any consent string), the handler's
|
||||
mismatch and stamp cases with a fake clock, and the real pipe end to end: wrong version → mismatch, our
|
||||
version → `ConsentDialog` on the row with the Agent's clock. Docs: `19_SAFETY` §User-facing consent (built;
|
||||
the console verb is the developer path), `09_I18N` (four members; the family arrived), `07_IPC` (`HelloAck`,
|
||||
`SetHookEnabled` as built), `06_DATA_MODEL` (the fourth name), HANDOFF item 2 and row 4 struck, D14 as built,
|
||||
CLAUDE.md. **Not in this PR:** the toggle that opens the dialog, FR-2.2's disabled state and FR-2.5's InfoBar
|
||||
are the game page's (PR-5); the `ja` review is a human's.
|
||||
- **P3 PR-3 — the ports the UI reads and writes, the settings registry (D16), schema 0002, and the display
|
||||
producer (2026-09-13).** `ISessionRepository` gains `FindByIdAsync`, `ListByGameAsync` (newest first, bounded),
|
||||
`SummariseByGameAsync` (count, hooked count, playtime, last played per game — one query), `FindSegmentsAsync`,
|
||||
`FindSensorsAsync`; `ISessionAnnotationRepository` (new) writes the UI-owned row beside a session — tags as a
|
||||
JSON array, notes, and **FR-8.3's per-session overrides, which live on `session_annotations` and never on
|
||||
`sessions`** (`06_DATA_MODEL` §Writer ownership), beside the measurement rather than over it, so clearing one
|
||||
restores what was measured; `Application.TriState.TriStateResolution` is the precedence (manual → measured →
|
||||
inherited from `games.*_default` → N/A). `IGameRepository` gains `FindByIdAsync`, `UpdateMetadataAsync` (FR-1.3,
|
||||
wholesale; every field that changed is marked `user` in `field_provenance` so detection cannot overwrite it),
|
||||
`SetTriStateDefaultAsync`, and `RemoveAsync(keepSessions)` (FR-1.4: keep = `games.removed_at`, the row leaves
|
||||
the library and a later launch restores it; delete = the cascade). `ILegalAcceptanceStore.RecordAsync` /
|
||||
`ListAsync` (the writer FR-11's gate calls in PR-9). `GameRow` now carries the metadata, the tri-state defaults,
|
||||
`hook_consent_at`, `hook_prescan_state` and `removed_at`. **The settings registry**: `SettingsRegistry` (12 keys,
|
||||
kind, default, range or choices, who reads) and `RegisteredSettings` over `ISettingsStore` — validating writes,
|
||||
tolerant reads, nothing cached; `SettingsRecorderPolicy` resolves `capture.min_session_s`,
|
||||
`retention.raw_sessions_per_game` (0 = unlimited) and `telemetry.interval_ms` at each session start through
|
||||
the new `IRecorderPolicy` on `SessionRecorder`, whose poller factory now takes the session's options; the
|
||||
App's appearance keys are the registry's. `0002_annotation_overrides_and_removal.sql`, the first append
|
||||
(`LatestVersion` = 2). `Infrastructure.Recording.PrimaryDisplay` fills `hardware_snapshots.display_res` /
|
||||
`display_hz` from `EnumDisplaySettingsW` — they were "null until P3" since PR-B. Tests: the four PR-B adapters
|
||||
that had none (`SqliteGameRepositoryTests`, `SqliteHardwareSnapshotRepositoryTests`, `SqliteSettingsStoreTests`,
|
||||
`SqliteLegalAcceptanceStoreTests`), the annotation repository incl. the resolution over stored rows, the
|
||||
session queries incl. **NFR-4 measured: a 100-session game lists in a few ms against the 500 ms ceiling**,
|
||||
the registry both directions, the policy, the resolution, the display producer. `20_OPEN_QUESTIONS` §G's
|
||||
"Settings registry" row is closed; `06_DATA_MODEL` gains §Settings registry and the 0002 note; HANDOFF §P3
|
||||
row 3 is struck with the one deviation (no `IRtOverrideRepository` — see above).
|
||||
- **P3 PR-2 — the first `.resx` family, its generator and its gate, and the App shell (2026-09-13).**
|
||||
`src/FrameLedger.App/Strings.resx` + `.vi` + `.ja` (65 keys, `ja` machine-drafted and marked `review`),
|
||||
`tools/resx-gen.ps1` writing the committed `Strings.Designer.cs` (the SDK-style WPF project runs no
|
||||
`ResXFileCodeGenerator`), and `tools/resx-audit.ps1` as `build.ps1` step 15 — self-test (11 fixture
|
||||
cases, both directions) then live: identifier keys, exact key sets across the three files, `Safety_*`
|
||||
in `ja` marked `safety: human review required` with the English verbatim or `safety: reviewed by <name>`,
|
||||
the accessor current; a tree with no family is red. `09_I18N` §Translation workflow and §Safety-critical
|
||||
strings, `12_BUILD` line 15, `13_CI_CD` and `CLAUDE.md` stop saying the tool does not exist. The App is a
|
||||
Generic Host under `16_WPFUI_SYNTAX` §App bootstrap: `FluentWindow`, TitleBar with the Agent pill, the
|
||||
Menu row (unbuilt items say so in a snackbar), NavigationView (Dashboard · Games · Compare · Logs, Settings
|
||||
in the footer), the offline `InfoBar` with Retry, `SnackbarPresenter`, `ContentDialogHost`; theme
|
||||
(Light/Dark/System with `SystemThemeWatcher`) and language (rebuilds the shell in the new culture) both
|
||||
persisted in `settings` under D16's `ui.theme`/`ui.language` through `SqliteSettingsStore` — the App opens
|
||||
`ledger.db` directly per `06_DATA_MODEL` §Writer ownership (D15). `Services.AgentConnection` is `07_IPC`
|
||||
§Client behavior as a state machine over `PipeClient`: 8 × 250 ms connect, start `FrameLedger.Agent.exe
|
||||
--serve` beside the App when absent, `Hello`/`GetStatus`, keepalive pings, the event stream, retry every
|
||||
5 s; the Dashboard's Agent card shows `HelloAck`/`StatusAck` with `N/A` until answered. Serilog
|
||||
`logs/ui-.log` per `10_LOGGING`. `tests/FrameLedger.App.Tests` (16): every key resolves in en/vi/ja and
|
||||
the satellites really load, the accessor's keys are the resx's, appearance settings round-trip, and the
|
||||
connection against an in-process `PipeServer` — Missing with nothing to start, Connected on `Hello`,
|
||||
Starting → Connected through a launcher that brings the server up, Offline then Connected again when it
|
||||
returns. Measured: first window at 1.3 s. Three things `16_WPFUI` now records: `MainWindow` is transient
|
||||
with `ShutdownMode=OnExplicitShutdown` and the host lifetime ending the process; the run is one task from
|
||||
a synchronous `OnStartup`; and `ApplicationThemeManager.Apply(…, updateAccent: true)` must precede the
|
||||
first window's XAML or the accent resources are missing at first Measure (`XamlParseException`).
|
||||
- **P3 PR-1b — the command pipe, command half: `SetWatchlist`, `LaunchGame`, `SetHookEnabled` (pre-scan, no stamp
|
||||
yet), pause/resume, `StopSession`, `UpdateRules`, `Shutdown` (2026-09-13).** `Application.Ipc.AgentCommandHandler`
|
||||
answers every UI → Agent row of `07_IPC` §Messages under the one rule of §The pipe is not a trust boundary — the
|
||||
Agent establishes each fact itself. `SetHookEnabled false` revokes through the store; `SetHookEnabled true` runs
|
||||
the static pre-scan of the executable's directory, records a block or a "could not verify" through
|
||||
`RecordGuardBlockAsync` and answers `Refused { reason, family?, signal? }`, and answers a clean scan **`Error
|
||||
DisclosureUnavailable` with nothing stamped** — FR-2.1's reviewed text does not exist (PR-4), and a client's
|
||||
`disclosureVersion` is a claim, not a disclosure shown. `SetWatchlist` ensures identity rows (hooking off when
|
||||
new) and removes nothing; `UpdateRules` is the seeder's outcome and ignores any payload; `Shutdown` asks
|
||||
`IAgentLifetime` (the host's under `--serve`, a logged no-op under `--console`). `PauseCapture`/`ResumeCapture`
|
||||
flip `CapturePause`, one in-memory flag every session loop reads at its tick and tells the ring once per
|
||||
transition — supervision never pauses — and `StatusAck` gains `paused`. `StopSession` cancels the session's own
|
||||
stop token (`RecordRequest.StopToken`; the orchestrator now names every session it starts, `RecordRequest.SessionGuid`),
|
||||
which the loop reads at its next tick and ends as the new `SessionEndReason.StoppedByUser`: drained once more,
|
||||
finalized, `exit_status = normal`, the target left running. `LaunchGame` is `CaptureOrchestrator.LaunchAsync`
|
||||
over the new `ILaunchRecorderFactory` (the Agent's `AgentLaunches`: the Vulkan layer's environment unless the
|
||||
kill switch is on, the console's `launch` shape), one session per game, the launcher election after. The
|
||||
orchestrator's running-session table has one lock now that the pipe's tasks reach it (HANDOFF §P3 D12 as built:
|
||||
no `Channel`). `IExecutableIdentitySource` gains `Normalise`, so a client's spelling is never a key. In the gate:
|
||||
`AgentCommandHandlerTests` (over the real SQLite consent store: the block recorded, nothing stamped, a path in
|
||||
an `UpdateRules` payload ignored), `CaptureSessionTests` (a stop token ends as `StoppedByUser` with the last drain
|
||||
run; the pause told once per transition while the guard keeps scanning), `CaptureOrchestratorTests` (stop
|
||||
cancels the request's own token; launch once per game, refused for what it cannot name, the environment
|
||||
released with the session), and `PipeEndToEndTests` grows two scenarios over the real Agent composition and a
|
||||
real ring: the watched harness narrated → paused (status says so, state stays `capturing`) → resumed → stopped
|
||||
by guid (`StoppedByUser`, `normal`, harness still alive) → the session-less commands, including a real pre-scan
|
||||
answered `DisclosureUnavailable`; and `LaunchGame` starting the harness in launch mode and narrating it to
|
||||
`TargetExited`. **Measured on the way:** wiring the command handler into the request handler eagerly is a DI
|
||||
cycle (server → handler → commands → orchestrator → recorder → observer → publisher → server) that the
|
||||
container did not refuse and the first e2e run HUNG on (`--blame-hang` dump, 2026-09-13); the command handler is
|
||||
resolved lazily on the first command, and the e2e now writes the composition's Serilog lines to its scratch
|
||||
directory so the next hang leaves evidence. **Not in this PR:** the consent stamp (PR-4) and the App (PR-2).
|
||||
|
||||
- **P3 PR-1 — the command pipe, read half: `Shared.Ipc`, the Agent's pipe server, the session narration and the
|
||||
1 Hz live progress (2026-09-13).** `FrameLedger.Shared.Ipc` holds channel C's contract (`07_IPC` §C): the
|
||||
envelope, the read-half message set (`Hello`/`HelloAck`, `GetStatus`/`StatusAck`, `Ping`/`Pong`, `Error`, and
|
||||
the seven Agent → UI events), `IpcJsonContext` (source-generated, camelCase, nulls omitted, unknown members
|
||||
skipped both ways — pinned) and `IpcFraming` (4-byte LE length + UTF-8 JSON ≤ 1 MB, one write per frame, every
|
||||
refusal driven). `Infrastructure.Ipc.PipeServer` creates `\\.\pipe\FrameLedger.v2` through `CreateNamedPipe`
|
||||
with the DACL stated as SDDL (`D:P(A;;GA;;;<user>)(A;;GA;;;BA)`, `PipeAccessControl` — what §G asked for),
|
||||
`PIPE_REJECT_REMOTE_CLIENTS`, two instances with a slot each so a third client waits, and the client's token
|
||||
user compared by impersonation on its first frame; a stranger is disconnected without an answer and counted.
|
||||
`PipeClient` is the UI's end (`CurrentUserOnly`, acks correlated by id, events on a channel). `Application.Ipc`:
|
||||
`AgentRequestHandler` answers the three requests (`ProtocolMismatch` / `UnknownType` / `Malformed` /
|
||||
`HandlerFaulted` as `Error`, connection kept), `SessionEventPublisher` is the recorder's new second observer
|
||||
(`ISessionObserver`, decision D13) — `SessionStarted` at the attach, `SessionProgress` once a second and only
|
||||
while a client listens, the finished session's events through `RecordedSessionEvents` (the reason → event
|
||||
table, pinned per reason) — and `AgentStatus` is the snapshot `GetStatus` reads. `SessionProgressCalculator`
|
||||
computes the live window through the SAME Domain calculators as the row, and rule 6 holds at the wire:
|
||||
Native / Displayed / factor only when frame generation was measured, else the presented rate with the census
|
||||
qualifier — now `FgLadder.PresentedQualifier`, one function for the row and the pipe. The Agent hosts it under
|
||||
`--serve` only (`PipeServerHostedService`); `--console` composes it inert. `HelloAck` drops `etwAvailable`
|
||||
(the tier is gone) and gains `pid`; `vulkanLayerRegistered` and `cpuTempAvailable` are honest falses.
|
||||
`CaptureOutcome.Verdict` now carries the verdict that FIRED on a safety unhook, so `SafetyUnhook` names its
|
||||
family and signal. `Vocabulary.ExitStatusText` is the one spelling of `exit_status` for the column and the
|
||||
event. In the gate: `IpcFramingTests`, `IpcCodecTests`, `PipeServerClientTests` (a real pipe, in-process, incl.
|
||||
the refused stranger and the waiting third client), the calculator / events / publisher suites, and
|
||||
`PipeEndToEndTests` (Integration, `agent-harness`): the Agent's own composition in-process on a test-named pipe,
|
||||
the watcher finding `hook-harness`, and a client hearing `SessionStarted` → ≥ 3 `SessionProgress` a second apart
|
||||
→ `SessionCompleted` for the same guid. **One thing that test measured on the way (2026-09-13):** the watcher's
|
||||
file-name fallback (`ProcessWatcher`, `StalePath`) adopted a sibling test assembly's `hook-harness.exe` running
|
||||
from another directory, started a session for it, and refused it for want of consent on THAT path — so the
|
||||
test's target is now a byte-identical copy of the harness under a run-unique name, and the story is keyed on
|
||||
the pid and the guid. Recorded because the same fallback would adopt a second install of a tracked game on a
|
||||
real machine; whether that is the wanted behaviour is `04_CAPTURE` §Process watcher's question, not this PR's.
|
||||
**Not in this PR:** the command half (PR-1b), the App that connects (PR-2), and any keepalive the Agent
|
||||
initiates — `Ping` is the client's.
|
||||
|
||||
- **P2 PR-G — kill-and-recover end to end, the FPS-impact runbook, and P2's closing sweep (2026-09-10).**
|
||||
`PartialRecoveryEndToEndTests` (Integration, in the merge gate) is `14_TESTING`'s long-standing
|
||||
`.partial` line, built: the shipped `FrameLedger.Agent.exe` captures `hook-harness` with the new
|
||||
`--console … --partial-flush-seconds <n>`, the test polls until a flush has actually landed, kills the
|
||||
Agent, and `--console recover` turns the valid prefix into an `interrupted` row whose `frame_count` is
|
||||
that prefix, deletes the file, and finds nothing on a second pass. The new option is under `--console`
|
||||
only and pinned by `AgentCommandLineSurfaceTests` beside the others: it bounds how often a running
|
||||
session writes its own crash-recovery file and names nothing about injection.
|
||||
`tools/fps-impact-runbook.ps1` (dev-only, never in `build.ps1 check`) sequences item 2's six launches —
|
||||
consent granted for the ON leg, 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, prompts for the game's own benchmark
|
||||
average, and prints the `spike-notes` §14 block. **It does not measure FPS and says so first:**
|
||||
FrameLedger's frame times exist only in the hooked leg. `spike-notes` §14 holds the three empty slots
|
||||
(the milestone row against a title's menus, §S1's launcher-fronted election, the FPS table) with the
|
||||
exact commands; `14_TESTING` item 2 now says *unmeasured* rather than nothing. **P2's code is complete;
|
||||
what remains are two measurements only the owner can take.**
|
||||
|
||||
- **P2 PR-F — the Agent host: `--serve` (watcher → orchestrator → recorder), `--console` verbs, the consent
|
||||
grant (decision D4) and the kill switch as the gate's fourth input (decision D7) (2026-09-10).**
|
||||
`FrameLedger.Agent` is a Generic Host now: `Composition.AgentServices` registers every `Application` port
|
||||
to its one shipped adapter, `WatcherHostedService` runs `PartialRecovery` first and then
|
||||
`Application.Watch.CaptureOrchestrator` — one process snapshot per second (`ToolhelpProcessSnapshotSource`),
|
||||
`ProcessWatcher` (exact normalised path, or the file name when exactly one `games` row carries it →
|
||||
`StalePath`, keyed on the real path), `ProcessTree` (a child that started before its parent is a reused
|
||||
pid), `DescendantElection` (the newest tracked descendant; a launcher's consent does not extend to what it
|
||||
spawns), ONE session per game at a time through the new `ISessionRecorder` port. `--console` carries
|
||||
`consent list|grant|revoke`, `capture`, `launch` (with the election after `LaunchTargetExited` /
|
||||
`LaunchNoPresentationRuntime`), `recover`, `sessions`, `db path`, `games add`, `killswitch on|off|status`,
|
||||
and `--data-dir` under `--console` only (decision D6); `--diag`, `--install-task`, `--uninstall-task`,
|
||||
`--register-vklayer`, `--unregister-vklayer` answer "not implemented in P2", exit 2. **D4:** `Agent
|
||||
--console consent grant` shows `OperatorDisclosure` (moved to `Application.Consent`, one text, an
|
||||
`OperatorSurface` for the first line and the stamp), refuses redirected stdin, and records the new
|
||||
`ConsentProvenance.AgentConsoleOperator` with the Agent's clock; `OperatorAcknowledgement` carries its
|
||||
provenance and `SqliteGameConsentStore` writes that name and refuses `NotRecorded`. **D7:** FR-2.4 is
|
||||
`HookRequest.FromConsent`'s fourth input — `AntiCheatRefusalReason.KillSwitchEngaged` (27, added to the
|
||||
native reason table so the mirror holds), checked before consent is read; `IKillSwitch`
|
||||
(`Infrastructure.Settings.SettingsKillSwitch` over `settings.hooking.kill_switch`) is read by
|
||||
`CaptureSession` before the request and at every guard-scan boundary, where an engaged switch publishes
|
||||
`unhookRequested` and ends the session as `KillSwitchEngaged` (`RefusedKillSwitch` when refused up front);
|
||||
`ProcessLauncher(enableVulkanLayer: false)` keeps the layer off by never setting
|
||||
`FRAMELEDGER_ENABLE_VK_LAYER`. A bounded `--console capture --seconds N` lowers the discard threshold to N.
|
||||
Tests: `AgentEndToEndTests` (Integration, in the gate) runs the shipped `FrameLedger.Agent.exe` against
|
||||
`hook-harness` with a scratch ledger and reads back ONE hooked `sessions` row — the milestone's technical
|
||||
half — plus the kill-switch refusal with no ring in the target, `consent grant` refusing redirected stdin,
|
||||
and the unbuilt flags' exit 2; `AgentCommandLineSurfaceTests` pins the surface (no pid, payload, force,
|
||||
yes, override); `ProcessWatcherTests`, `ProcessTreeAndElectionTests`, `CaptureOrchestratorTests`,
|
||||
`ToolhelpProcessSnapshotSourceTests` (this process and a child it starts), `SettingsKillSwitchTests`, the
|
||||
gate's `TheKillSwitchIsTheFourthInputAndOutranksAValidConsent`, the loop's
|
||||
`AnEngagedKillSwitchRefusesBeforeTheGuardAndStopsARunningSessionAtTheNextScan`, and the store's
|
||||
provenance round-trip. The capture host uses the moved disclosure unchanged.
|
||||
|
||||
- **P2 PR-E2 — the NVAPI bridge: `FrameLedger.NvapiBridge.dll`, L3 `NvapiTelemetrySource`, and the NGX probe
|
||||
in-process (2026-09-10).** A new native target, `src/native/FrameLedger.NvapiBridge/` — a C ABI
|
||||
(`fl_nvapi_bridge.h`: refcounted `FlNvInit`/`FlNvShutdown`, `FlNvReadSample` into a fixed struct with a
|
||||
`present` bit per field, `FlNvNgxState` for one pid, `FlNvDriverVersion`, and size / ABI-version / build-id
|
||||
queries so a drifted mirror is refused rather than read) — is the **only shipped binary that links
|
||||
`nvapi64.lib`**, read-only by construction, loaded by the Agent into its own process by absolute path
|
||||
(`/FrameLedger.NvapiBridge.targets`, imported by the Agent, the capture host and `Infrastructure.Tests`)
|
||||
and **never into a game**. `Infrastructure.Telemetry`: `NativeNvapiBridge` (the second P/Invoke facade after
|
||||
the guard's, same absolute-path rule), `NvapiTelemetrySource` (L3 — a clear bit is `null`, never 0; an `Init`
|
||||
that does not answer 0 disables the layer with zero faults, two throws disable it for the session; VRAM is
|
||||
**not** read, because the vendored `nvapi.h` declares neither a non-deprecated memory-info call — L1's PDH
|
||||
counter keeps it), and `NvapiNgxStateProbe`, the `INgxDriverProbe` in-process. The capture host composes
|
||||
L1 + L2 + L3 under the composite (`telemetry_source` can now read `l1+lhm+nvapi`) and **no longer spawns
|
||||
`fl-probe-nvapi.exe`**; the probe is no longer staged beside it. `Infrastructure.Native.BesideThisAssembly`
|
||||
is the assembly's one `DllImport` resolver — the runtime allows one per assembly, and the guard's static
|
||||
constructor already set it, which the first real-hardware test run found. ctest `fl_nvapi_bridge`
|
||||
(`src/native/tests/nvapi_bridge_test.cpp`) exercises every export and requires the `BRANCH:` line;
|
||||
`NvapiBridgeMirrorTests` checks both mirrors' sizes against the DLL's answers and **fails rather than skips**
|
||||
when the DLL is not staged; `NvapiTelemetrySourceTests` and `NvapiNgxStateProbeTests` script the bridge.
|
||||
`tools/versioninfo-check.ps1` requires the new DLL's version block. Measured on the dev box (RTX 5080,
|
||||
driver 616.64 r616_41) and written into `18_GPU_VENDOR_APIS` §L3: core 35 °C, GPU domain 0 %, 2670 / 15001
|
||||
MHz, throttle mask 0, PCIe ×16, memory-temperature and fan bits clear at an idle desktop.
|
||||
|
||||
- **P2 PR-D — the session recorder: `.partial`, five-step finalize, exit classification, crash auto-disable,
|
||||
recovery; the first hooked session stored in SQLite (2026-09-10).** `Application.Recording`:
|
||||
`SessionRecorder` owns a session end to end — identity and QPC time base, the `games` and
|
||||
`hardware_snapshots` rows, one telemetry poller per session, the `.partial` from before the first record
|
||||
to after the last, the loop, the classification, the finalize, the crash policy — on the loop's own task
|
||||
through the new `ICaptureObserver` seam on `CaptureSession` (after every drain: the poller's queue drained,
|
||||
the file flushed on its interval; the loop stays the ring's only reader). `SessionAggregator` fills every
|
||||
measured column of `sessions` and `session_segments` over Domain's calculators; `FgLadder` is the identity
|
||||
and withhold logic MOVED out of the capture host's report so the row and the report read ONE
|
||||
implementation (the report's strings and fixtures unchanged); `Vocabulary` is the tokens the schema stores.
|
||||
`SessionFinalizer`: the discard rule, then the FULL `frame_blobs` set through the new `ISeriesCodec` port —
|
||||
every column any record claimed, `latency_us` included, pinned by a reflection sweep of the DTO —
|
||||
per-stream frame times with the gap bit where an interval is not a frame time (torn slot, overwrite skip,
|
||||
first of a stream), `swapchain_ids` only past one stream, sensor series aligned to `t_ms` with −1 where a
|
||||
tick had no reading; then one transaction and the retention sweep. `ExitStatusMapper` is `04_CAPTURE`'s
|
||||
table as one function (safety stop → `unhooked_safety`; the capture side stopping on its own →
|
||||
`degraded`; non-zero exit code or an Application Error/WER event naming the exe in `[start, end+30 s]` →
|
||||
`crashed`); `CrashAutoDisablePolicy` counts only crashes within 60 s of the attach and disables on the
|
||||
second. The `.partial` (`06_DATA_MODEL` §The `.partial` file): CRC-framed append-only chunks, the valid
|
||||
prefix wins, `PartialSessionFileTests` kills a fixture at every byte offset. `PartialRecovery` turns every
|
||||
pending file into an `interrupted` row or drops it for a stated reason. `Infrastructure.Recording`:
|
||||
`PartialSessionFile`/`Store`, `EventLogCrashSource` (Application log 1000/1001, read-only), `HardwareSnapshotSource`
|
||||
(DXGI identity + registry CPU name + runtime memory + OS build; display fields null until P3);
|
||||
`DrainResult` gained `FirstSlot` so a torn slot is recorded at the RECORD it preceded; `ITargetLiveness`
|
||||
gained `ExitCode`; `TelemetryPoller` can own its source. **The unshipped host records through all of it**
|
||||
(`capture`/`launch` print `ledger: session … SAVED as sessions.id=N`, a 5 s discard threshold for bounded
|
||||
operator captures, a `recover` verb), and `CaptureHostEndToEndTests` now asserts the row, the blobs and the
|
||||
deleted `.partial` after a real launch — the first hooked session in a `ledger.db`. **One native change,
|
||||
measured on the way:** `fl_guard`'s launch-mode classification read the harness's `--vulkan` mode as
|
||||
OpenGL once the warmer host reached the first poll 20 ms sooner (opengl32 is a static import of the
|
||||
binary, vulkan-1 is mapped milliseconds later), injected the Overlay and left the layer's ring unowned;
|
||||
the guard now polls once more before committing to the injecting branch, pinned in both directions in
|
||||
`guard_test`. Hook-path overhead: none (the guard change is pre-injection; the Overlay is untouched).
|
||||
`04_CAPTURE` §Session recorder/§Crash & exit/§Launch mode, `06_DATA_MODEL` §The `.partial` file/§Blob
|
||||
encoding, `20_OPEN_QUESTIONS` §G "Session identity", `CLAUDE.md` §Solution layout.
|
||||
- **P2 PR-C — the capture path promoted into the shipped assemblies; the CaptureHost is a thin shell
|
||||
(2026-09-09).** A pure move: `CaptureLoop` — every hooked session's driver since 2026-08-06 — is now
|
||||
`Application.Capture.CaptureSession`, over ports instead of delegates so the Agent's composition root
|
||||
can supply the adapters (`IRingAttacher`, `ITargetLivenessSource`, `ITargetResolver`, `IProcessLauncher`,
|
||||
`IRuntimeModuleSnapshot`, `INgxDriverProbe`, `IExecutableMarkerScan`), with `ICaptureSink`,
|
||||
`CaptureOptions`, `CaptureOutcome` (was `CaptureResult`), `SessionEndReason`, `SessionEndClassifier`,
|
||||
`FocusTally`, `RuntimeModuleSet`/`Info`, `CensusNames`, `SlTagCensusNames`, `ExecutableMarkers`/`Marker`,
|
||||
`NgxDriverState`/`NgxOverrideFlags`/`NgxProbeOutcome` beside it. `Infrastructure.Capture` holds the OS
|
||||
adapters: `ShmRingAttacher` + `ShmCaptureSink` over `ShmRingReader` (which gains no interface and no
|
||||
second consumer), `HeldProcessLivenessSource` + `ProcessTargetLiveness` (§S29(e)), `TargetResolver`
|
||||
(path only, never a pid; its one report line goes through a callback now, not the host's console) +
|
||||
`ChromiumGpuProcess`, `ProcessLauncher` (an instance over the Vulkan layer's environment, the
|
||||
duplicated enable-variable constant gone), `RuntimeModuleSnapshot`, `ExecutableMarkerScan`.
|
||||
`DrainResult` moved to `Shared` so Application can read it. The report's text for NGX state and
|
||||
markers stays with the report (`NgxDriverStateText`, `ExecutableMarkersText`); `NgxDriverProbe`
|
||||
(spawns `fl-probe-nvapi.exe`) stays in the host until PR-E2 puts it in-process. The loop's tests moved
|
||||
with it — `CaptureSessionTests` / `CaptureSessionLaunchTests` in `Application.Tests`, driven through the
|
||||
real SQLite consent adapter (a test project on Domain's `InternalsVisibleTo` would be a second mint) —
|
||||
and the report fixtures are byte-identical. Two new pins: `HookRequestSoleProducerTests` (no public
|
||||
constructor, no setter, exactly one factory) and `NoSecondRingReaderTests` (nothing but `ShmRingReader`
|
||||
opens the ring). `04_CAPTURE` §Frame source abstraction now describes what exists (`IFrameSource` never
|
||||
did) and gains §Threading model; §S27 restated a second time (the loop ships; the entry point is PR-F's);
|
||||
`CLAUDE.md` §Solution layout. Hook-path overhead: none (managed only).
|
||||
- **P2 PR-E1 — telemetry L1, the composite and the 1 Hz thread (2026-09-09).** `IGpuTelemetrySource`
|
||||
had one adapter; it now has the ladder `18_GPU_VENDOR_APIS` §Abstraction describes.
|
||||
`BaselineTelemetrySource` (L1) reads the adapter's identity from DXGI once — name, LUID, ids, memory
|
||||
sizes, the user-mode driver version via `CheckInterfaceSupport(IDXGIDevice)` — as `GpuAdapterIdentity`,
|
||||
selects the first hardware adapter until the Overlay's handshake LUID names another, and carries one
|
||||
live field: adapter-wide dedicated memory in use from the PDH `GPU Adapter Memory … Dedicated Usage`
|
||||
counter bound by LUID (never a wildcard summed). **Measured on the way:** `IDXGIAdapter3::
|
||||
QueryVideoMemoryInfo`, which the doc listed as L1's adapter-wide usage, reports the *calling process's*
|
||||
usage — 0 bytes from the Agent beside a 16 GB adapter — which is exactly why the Overlay reads it
|
||||
in-process; the doc is corrected, not the number. The engine-utilisation counters are deliberately not
|
||||
read (`20_OPEN_QUESTIONS` §M10 decided: `LoadPct` is L2's vendor-reported load, labelled). `DxgiAdapters`
|
||||
and `PdhAdapterMemoryCounter` are the tree's first CsWin32 consumers (marshaling off: raw vtables, no
|
||||
apartment). `CompositeTelemetrySource` merges L3 > L2 > L1 per field, records which layer supplied
|
||||
each (`LayerOf`), applies the two-fault rule one level up to a layer whose `TryRead` throws, and
|
||||
produces the `l1+lhm+nvapi` descriptor from the layers still standing — the port gained `IsDisabled`
|
||||
so "nothing yet" and "never again" stop reading alike. `TelemetryPoller` is the `fl-telemetry` thread:
|
||||
one read per interval (≥ 500 ms), stamped with QPC (`TelemetrySample`), queued for the session loop,
|
||||
oldest dropped and counted when nobody drains. `QpcClock` names the counter the ring is in, and
|
||||
`QpcClockTests` pins `Stopwatch` / `TimeProvider.GetTimestamp` to it rather than trusting the
|
||||
documentation. §M7 and §M8 closed by the code taking the shape they asked for. Hook-path overhead:
|
||||
none (managed only, nothing in the game). `18_GPU_VENDOR_APIS` §Abstraction/§L1/matrix, `CLAUDE.md`
|
||||
pinned-stack row corrected in place.
|
||||
- **P2 PR-B — the SQLite ledger: `0001_init.sql`, migrations, the consent adapter, the repositories, the
|
||||
blob codecs (2026-09-09).** `Microsoft.Data.Sqlite` and `Dapper` were referenced by zero lines; they now
|
||||
back `Infrastructure.Persistence`: `LedgerDatabase` (WAL, `synchronous=NORMAL`, `foreign_keys=ON`,
|
||||
`busy_timeout=5000`; one connection per process behind a gate; every write an explicit transaction),
|
||||
`MigrationRunner` (scripts embedded in the assembly, one transaction each, under a session-local mutex;
|
||||
a ledger NEWER than the build's scripts is refused — `LedgerSchemaException` — not read on a guess),
|
||||
and `0001_init.sql`, the `06_DATA_MODEL` v2 schema plus the columns it had no home for: `session_guid`,
|
||||
`qpc_epoch` / `qpc_frequency`, `capture_mode`, the drain's own accounting, the 2026-09 metric additions
|
||||
(Presented FPS + qualifier, DXGI-COUNTED, tag census, the driver-reported rungs, the withheld `none`),
|
||||
`fg_source` with `none` in its domain and NULL = not measured, `games.hook_prescan_state` (the third
|
||||
pre-scan state one nullable reason could not carry; nothing clears `hook_blocked_reason`), the consent
|
||||
provenance and disclosure version, and the fingerprint. Every `*_at` is unix-ms UTC, stated in the
|
||||
script. **`SqliteGameConsentStore` replaces the capture host's file store** — same semantics, every case
|
||||
of `FileGameConsentStoreTests` re-targeted (`SqliteGameConsentStoreTests`): a grant cannot clear a
|
||||
block, a block preserves the stamp, a revoke withdraws it, a default verdict is `unverified` and never
|
||||
a block, a re-grant against a different binary cannot inherit a block, an unreadable ledger answers
|
||||
`Failed` and consents to nothing. **It ships**, and `20_OPEN_QUESTIONS` §S27 is restated on that basis
|
||||
(`Domain.csproj`'s `InternalsVisibleTo` names Infrastructure now, not the CaptureHost). The unshipped
|
||||
host opens its OWN `ledger.db` beside its binary (HANDOFF §P2 decision D5) — the Agent stays the sole
|
||||
owner of `%LOCALAPPDATA%\FrameLedger` — and its e2e cases run through that ledger. Also new:
|
||||
`SqliteGameRepository` (the non-consent face of `games`: crash count, auto-disable, last injection),
|
||||
`SqliteSessionRepository` (row + segments + `frame_blobs` + `sensor_blobs` in ONE transaction — a failing
|
||||
blob insert leaves no row behind — `ExistsAsync` by guid for recovery, retention keeps the last N
|
||||
sessions' raw series and every aggregate), `SqliteHardwareSnapshotRepository` (hash-deduplicated),
|
||||
`SqliteSettingsStore`, `SqliteLegalAcceptanceStore` (read-only; FR-11 stays the UI's — decision D8),
|
||||
the Application ports and DTOs behind them (`SessionRow` column for column, generated with the SQL from
|
||||
one table so the INSERT, the parameters and the reader cannot drift), `Domain.Sessions` (`ExitStatus`,
|
||||
`CaptureTier`, `CaptureMode`), and `Infrastructure.Blobs.SeriesCodec` / `RenderResCodec`
|
||||
(`deflate-le-v1`, little-endian arrays through Deflate, NaN refused at encode time, two pairs per frame
|
||||
for `render_res`, all three RT bits preserved; 360k frame times round-trip under half their raw size).
|
||||
Hook-path overhead: none (managed only). `06_DATA_MODEL`, `04_CAPTURE` §The guard, `20_OPEN_QUESTIONS`
|
||||
§S27 and §G "Session identity", `CLAUDE.md` §Solution layout corrected in place. Also fixed in passing:
|
||||
`ShmDrainIntegrationTests.TheReaderReportsRecordsItLostWhileItWasNotDraining` read `INIT` instead of `READY`
|
||||
about one run in four (on unmodified `main` too) — the handshake is published before the present hooks and
|
||||
the present hook records before the READY store, so a case that laps the ring in ~50 ms could assert inside
|
||||
that window; it now polls, bounded, for the writer to leave `INIT` first.
|
||||
- **P2 PR-A — `FrameLedger.Domain.Metrics`, and the capture host's consumer re-pointed at it (2026-09-09).**
|
||||
The calculators `03_METRICS` says to implement in Domain now exist there, under `tools/coverage-gate.ps1`'s
|
||||
95 % per-class floor, which had never evaluated anything: `FrameTimeSeries` (QPC → ms, the interval
|
||||
spanning a gap EXCLUDED rather than counted as a long frame), `Percentile` (linear interpolation, NumPy
|
||||
`linear`), `FrameStatistics` (median / 1 % / 0.1 % lows as `1000 / p`, min / max, population σ, the
|
||||
FR-4.8 guards at exactly 1,000 and 10,000 frames, the `(presented)` label carried not decided),
|
||||
`RollingMedian` (19 frames, truncated symmetric at both edges) + `StutterDetector` (`> 2 × median`, stutter
|
||||
time %, `pso_stutter_pct`), `VramAggregates` / `LatencyAggregates` / `SeriesAggregates` (N/A, never 0).
|
||||
Ported out of `FrameLedger.CaptureHost` with their tests: `FgWindow` (the factor and every refusal —
|
||||
now a `FgRefusalKind` + numbers, the English staying with the report as `FgRefusalText`, byte-identical),
|
||||
`UpscaleExtent`, `StreamSegmenter` → `SegmentBuilder`, `RecordWindow` (generic), `Tri`, and the three
|
||||
tri-states as `RtVerdict` (`RtSummary` carries `rt_frame_pct` over presents and `rays_per_pixel` over
|
||||
RT-active presents, the ×4 falsifier pinned) and `HdrVerdict`. Domain references nothing, so the
|
||||
calculators consume `FrameSample` / `WriterFacts` with Domain's own enums; `FrameLedger.Application`
|
||||
gains a reference to `FrameLedger.Shared` (HANDOFF §P2 decision D1) and
|
||||
`Application.Metrics.FrameSampleMapper` is the one place a record becomes a sample, with the two
|
||||
writer-state sentinels (`VramBudgetMb = 0`, `DxgiPresentsBeforeHook = 0xFFFFFFFF`) resolved to null
|
||||
there. `MetricEnumMirrorTests` pins every Domain enum to its Shared twin in both directions — a member
|
||||
added on one side alone fails. `MeasuredFacts` keeps the prose (which N/A, which qualifier, the withheld
|
||||
`none`) and calls Domain for the numbers; every report fixture in `CaptureHost.Tests` passes unchanged.
|
||||
Not in this PR: the FG ladder as a Domain verdict (`fg_mode` / the withheld `none` are still
|
||||
`MeasuredFacts` strings) — it lands with the recorder that stores it (PR-D). Hook-path overhead: none
|
||||
(managed only). `03_METRICS` §header, `14_TESTING` §Golden metric tests (the FG-ladder row named two
|
||||
retired rungs and an "ambiguous → `none`") and `CLAUDE.md` §Solution layout are corrected in place.
|
||||
- **P1 item 4 — the unhook path, the native log, OpenGL (2026-09-06).** `StopObserving` no longer calls
|
||||
`MH_DisableHook(MH_ALL_HOOKS)`: every patch the Overlay made is in a registry, and each is restored
|
||||
**only while the bytes at its target are still our jump** (`fl_patch_check.h`; §H7 in its inline form —
|
||||
an overlay that patched after us chains through our jump and the blanket restore would have removed it
|
||||
silently). A fixed ring of structured events (`FAULT` with the exception code and the hook's name,
|
||||
`STOP`, `UNHOOK_RESTORED` / `UNHOOK_DECLINED` per patch, `HOOK_INSTALLED`, `SYMBOL_MISSING`,
|
||||
`SUPERVISION_LOST`…) is flushed to `%LOCALAPPDATA%\FrameLedger\logs\overlay-<pid>-*.log` at init, when
|
||||
the Agent bumps the new `FlControlBlock.logFlushRequested` counter at session end, and on the stop —
|
||||
never mid-frame; the CaptureHost prints the file and its notable lines. `opengl32!wglSwapBuffers` is
|
||||
hooked (`api` = OpenGL, output size from the DC's window, no `PRESENT_ARGS`), installed at init or lazily
|
||||
with the `LoadLibrary` detour waking the watchdog for `opengl32.dll`; `hook-harness --opengl
|
||||
--hold-presenting N` exercises it through gdi32's `SwapBuffers`. ctests `fl_unhook_inline`, `fl_guard`
|
||||
`[opengl]` / `[log]`. D3D9 is struck from the P1 line per `20_OPEN_QUESTIONS` §Scope decisions.
|
||||
- **P1 item 3 — the Vulkan layer intercepts `vkQueuePresentKHR` (2026-09-06; `20_OPEN_QUESTIONS` §S2 ✅).**
|
||||
In a process both gates admitted, the layer creates the same ring the Overlay would (`fl_shm_host.h`,
|
||||
now the one home of the DACL / name / handshake for both capture sides; one ring per process, first
|
||||
creator owns it) at the first `vkCreateDevice`, writes one record per present (`api` = Vulkan, output
|
||||
size from `vkCreateSwapchainKHR`'s `imageExtent`, no `PRESENT_ARGS` because the call has none), and
|
||||
forwards everything — including when the ring is not its own, which the first fixture run proved
|
||||
necessary. §S2 part three lands with it: `unhookRequested` and the 07_IPC tick deadline both stop the
|
||||
layer on the present path (passthrough with the reason on the mapping), proven by a fake loader chain
|
||||
(ctest `fl_vklayer`) and a 1.5 s test-only flavour of the DLL (`fl_vklayer_supervision`). The harness
|
||||
gains `--vulkan --hold-presenting N` (real loader via `LoadLibraryW`, hidden window, exit 77 = cannot
|
||||
run here) and ctest `fl_vklayer_real` drives it through the real loader with `VK_ADD_IMPLICIT_LAYER_PATH`
|
||||
— measured honoured by loader 1.4.357 with no registry — skipping on CI. Launch mode classifies a
|
||||
Vulkan-only target as the layer's (`TargetIsVulkanLayered` = 26: full guard, nothing injected, attach to
|
||||
the layer's ring) and the CaptureHost hands the launched process the layer's environment
|
||||
(`VkLayerLaunchEnvironment`: manifest, enable variable, enable-list line for the session).
|
||||
- **P1 item 2 — launch mode, built as "inject late" (2026-09-06; `20_OPEN_QUESTIONS` §S1 ◐, §S13(c) ✅).**
|
||||
The guard gains `FlGuardedInjectWhenReady(pid, dll, timeoutMs)`: it polls the launched target through
|
||||
the module seam — matching no blocklist — until a presentation runtime is mapped, then runs every
|
||||
check and injects exactly as `FlGuardedInject` does; a target that exits first or maps no runtime in
|
||||
the budget answers the new `LaunchTargetExited` / `LaunchNoPresentationRuntime` with nothing injected
|
||||
(ctest `fl_guard` `[launch]`, five cases incl. the real seam against `hook-harness`). The CaptureHost
|
||||
gains `launch --exe <path> [--args "…"] [--seconds n]` (`ProcessLauncher`: handle held from birth,
|
||||
`FRAMELEDGER_ENABLE_VK_LAYER=1`; the host never terminates what it launched), routed through the same
|
||||
gate by `HookRequest.WaitForPresentationRuntimeMs`, with `IAntiCheatGuard.GuardedInjectWhenReadyAsync`
|
||||
as the port's fourth method. The Overlay publishes `FlWriterState.dxgiPresentsBeforeHook` @60 — DXGI's
|
||||
count of presents before the first hooked one, the early-init cost §S1 deferred on — from the last
|
||||
reserved word (no layout bump; the writer state now has no slack), and the report prints it beside the
|
||||
measured wait. `04_CAPTURE` §Launch mode carries the shape and why it is not `CREATE_SUSPENDED`.
|
||||
- **P1 item 1 — the `LoadLibrary` detour, both jobs (2026-09-06).** The Overlay patches
|
||||
`kernelbase.dll!LoadLibraryExW` after its present hooks (`17_HOOK_ENGINE` §DLL entry step 3): a module
|
||||
the hook inventory or runtime census names **wakes the watchdog** through an auto-reset event, so the
|
||||
lazy installers run within milliseconds of the module instead of on the next 1 Hz tick (94 ms measured
|
||||
against a 500 ms bound); a module matching the compiled anti-cheat floor's MODULE families **stops the
|
||||
Overlay from inside** with the new `FL_STATUS_STOPPED_BLOCKLISTED`, on the next present or watchdog
|
||||
iteration — `20_OPEN_QUESTIONS` §S6 ✅, `19_SAFETY` §During a session's in-process half (exact names
|
||||
only; fragment and signer stay the host's 30 s scan, so the Disclaimer's window is unchanged). The
|
||||
detour installs nothing inline (§H2), calls the original first, and skips data-file / resource loads.
|
||||
Two `FlWriterState` words from `reserved[]` (`loaderSignals` @56, `earlyStopFamily` @58; no layout
|
||||
bump), `hook-harness --load-after-ms N PATH`, two real-Overlay ctest cases (`[loader]`, `[S6]`), and
|
||||
the CaptureHost's `loader detour:` / `EARLY STOP` report lines, `SessionEndReason.WriterStoppedBlocklisted`
|
||||
(exit 5) with the family named from the staged rules file.
|
||||
- **P0 closed — the closing sweep (owner: "theo bảng", 2026-09-06).** Exit criterion 1 is met with
|
||||
the quality preset amended to an honest `N/A` by measurement; criterion 2 is met with §S24 counting
|
||||
zero S-items against it. Three items closed by a gate each: **§S19(c)** — `rules-validate` gains a
|
||||
third canary proving the schema rejects `action: "allow"` and `signerField: "CN"`, so the policy is
|
||||
code and the data cannot say otherwise; **§S23-6** — the accuracy blocks are one text,
|
||||
`legal/ACCURACY.md`, embedded verbatim in `README.md` and `legal/DISCLAIMER.md` §4 and gated by
|
||||
`tools/accuracy-check.ps1` (self-tested both directions), and rewritten to 2026-09-06 truth (the old
|
||||
§4 still said frame generation and ray tracing had no hook); **§S29(d)** — `ci.yml` prints a Vulkan
|
||||
runtime census, and the blast-radius script runs as a CI step the day a runner has a loader, deferred
|
||||
on that measurement until then. Six items deferred with their rationale written and their phase named:
|
||||
S6 and S2 part three (P1), S23-3 (P3), S4 signing, S20 feed half and S14's store-id half (P4).
|
||||
`15_ROADMAP` and `HANDOFF` now say P1 starts.
|
||||
|
||||
- **The guard's signer half — the other conjunct of "name fragment AND not signed by a known vendor" —
|
||||
and the nine integration cases in the merge gate (§S19(b) row G1; owner's bound decision 2026-09-06).**
|
||||
Since 2026-08-05 the guard refused FrameLedger's own test host on CI because a .NET host loads
|
||||
`System.Security.Cryptography.ProtectedData.dll` and `protect` is a heuristic fragment, and CI skipped
|
||||
the drain, pause, drop and capture-host end-to-end cases. `fl-probe-signer`'s three legs (dev box, CI,
|
||||
the owner's adapters-disabled run) all read the same: the embedded signature verifies offline with
|
||||
`O=Microsoft Corporation`, ~2–4 ms, no verdict changing without a network. So `Sources` gained
|
||||
`ModuleSignerOrganisation` — `WinVerifyTrust` under `WTD_REVOKE_NONE | WTD_CACHE_ONLY_URL_RETRIEVAL`,
|
||||
then the certificate's `O=` — and the module sink trusts a fragment-matching module only when that
|
||||
organisation is on the rules file's `trustedSigners` AND on the list compiled into the binary
|
||||
(`IsCompiledTrustedSigner`: the data may narrow, never widen). A trusted module keeps the scan
|
||||
looking; the target is judged like its ancestors; no signature, an invalid one, an unreadable `O=`, a
|
||||
null path or seam, a failing seam, one list without the other — all refuse. The catalog half stays
|
||||
deferred with its rationale. `hook-harness --load` proves both directions against the real seams
|
||||
(the NuGet blocker allowed; our own unsigned Overlay under a `protect` name refused, by name); nine
|
||||
fake-seam cases pin the decision. `ci.yml` runs `./build.ps1 check` with no switches; the switch stays
|
||||
in `build.ps1`, loud. `19_SAFETY`, §S19(b), §S29(a), `13_CI_CD`, `12_BUILD`, `HANDOFF` and the rules
|
||||
file's own comment carry it.
|
||||
|
||||
- **Rung 3 by elimination, and the executable file as the census's second witness (HANDOFF 7b / §H11,
|
||||
owner's choice 2026-09-06).** `frame generation: Active (technology not identified)` now prints every
|
||||
exclusion the session can make beside it — 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 SDK strings the executable carries — never a vendor named as measured, and
|
||||
it says a frame generator compiled into the executable would read the same. The capture host scans the
|
||||
executable FILE on disk once after the session (`ExecutableMarkerScan`: `ffxFsr3`, `ffxFrameInterpolation`,
|
||||
`xefgSwapChain` and the non-FG strings for the reader; chunked with overlap, hits capped) and prints
|
||||
`executable markers:`; when a frame-generation-capable string is in the file and no module was loaded, the
|
||||
Presented qualifier reads *MAY include generated frames* instead of *cannot* — the sentence that was wrong
|
||||
in the dangerous direction on Rune Factory and Wukong. A marker is never identity. Intel's licence was
|
||||
re-checked the same day and is unchanged; XeSS-FG runs on non-Intel GPUs, so an XeFG session measures this.
|
||||
|
||||
- **The super-resolution identity from the NVIDIA driver, where no hook can see it — the driver-reported
|
||||
rung (owner decision 2026-09-06).** Three NGX-direct titles printed `upscaler: N/A` on every capture
|
||||
while the driver's per-process NGX word (`NvAPI_NGX_GetNGXOverrideState`, R570+, MIT NVAPI) reads
|
||||
`CREATED | EVALUATE` for them — measured 2026-09-06 without an NVIDIA-app override. The capture host now
|
||||
spawns `fl-probe-nvapi --ngx-state <pid>` beside every module snapshot (the probe gained one machine line,
|
||||
`NGXSTATE status=… sr=0x… …`, and is staged beside the host), merges the readings (`NgxDriverState`: the
|
||||
last answered word is the state, a change between readings is printed), prints `NVIDIA driver NGX state:`
|
||||
in the runtime block, and the `upscaler:` line reads `Dlss (driver-reported: … not counted by this hook)`
|
||||
when no hook named one. Identity only, each limit measured: no quality or preset (override fields), no
|
||||
ratio (`scalingRatio` is 0 even under an override), no frame-generation multiplier (`FG_MODE` /
|
||||
`FG_MULTI_FRAME` stay clear at ×4). **The FG word follows DLSS-G too, corrected on the first run's own
|
||||
readings:** `CREATED | EVALUATE` on every ×4 session, changing between readings as the feature came up, so
|
||||
it is 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. Owner's run (§H5 rows N1–N4): the negative held (`CREATED` clear with upscaling off),
|
||||
four NGX-direct titles now print `Dlss (driver-reported …)`, two hooked titles print agreement, and an
|
||||
FSR + DLSS-G session read `SR 0x205` (created, not evaluated) and correctly claimed nothing. Beside a hook's `Dlss` the driver's word prints as agreement or as a
|
||||
disagreement printed rather than resolved; beside an `N/A` with the bit clear it prints the driver's
|
||||
negative. `20_OPEN_QUESTIONS` §H5 pre-commits rows N1–N4, and N3 — DLSS switched off — withdraws the rung
|
||||
if the bit stays set. `03_METRICS` §Upscaling, `05_DETECTION`, `18_GPU_VENDOR_APIS` carry it.
|
||||
|
||||
### Changed
|
||||
|
||||
- **P3 PR-0 — the P2 sweep: what PR-G's closing sweep left stale, corrected in place (2026-09-13).**
|
||||
Docs and tools only, no `src/`. `tools/coverage-gate.ps1` said Domain and Application were "empty
|
||||
today" and the metric calculators "do not exist yet" four days after both had armed it; `13_CI_CD`
|
||||
counted nine `Category=Integration` cases (20 across six classes) and claimed the signer probe ran
|
||||
after the gate with `if: always()` "a one-line change nobody has made" — the step has carried it since
|
||||
#137, before the failure the bullet describes, so *why* the probe was not read on 2026-09-10 is now
|
||||
recorded as unmeasured rather than as a workflow defect; `09_I18N` said `ConsentProvenance` had two
|
||||
members (three since PR-F); `17_HOOK_ENGINE` cited `20_OPEN_QUESTIONS` §H9, answered and removed in the
|
||||
P0 spike; `ci.yml`'s census comment still promised "the next PR wires the script" after the census had
|
||||
read `vulkaninfo.exe` absent twice. HANDOFF: P2's START HERE struck, **§P3 is the head** with the
|
||||
slice table (0, 1, 1b, 2, 2b, 3–9) and decisions D11–D17; D1/D5/D6/D10 labelled where they were
|
||||
cited by number and defined unlabelled, and D2/D3 recorded as never assigned. `15_ROADMAP` §P3 takes
|
||||
the pipe, i18n, the Legal Gate, Settings, Logs and the tray from §P4 (owner, 2026-09-13). §G's
|
||||
threading-model row struck with its pointer; the settings-registry and pipe-security rows carry the
|
||||
decisions that close them. What P2 still owes is unchanged and is measurement: `spike-notes` §14's
|
||||
four slots, all empty, all the owner's.
|
||||
|
||||
- **The FG `N/A` and the upscaler `N/A` carry their witnesses.** Hell Is Us at XeSS + XeSS-FG (2026-09-06):
|
||||
no Streamline token on that plugin at XeSS, so nothing counted, and the report printed a bare *N/A (a hook
|
||||
ran …)* while the driver's FG word, the tags, the ffx census, the module census and the executable's own
|
||||
strings all had something to say. The N/A now prints the same exclusion clauses as rung 3 (*what this
|
||||
session can still say: not DLSS-G (…); …; the frame-generation runtime(s) loaded: …; the executable itself
|
||||
carries xefgSwapChain*), and the upscaler N/A says *libxess.dll is loaded, and XeSS cannot be hooked or
|
||||
declared under Intel's licence … by policy, not by ignorance* — HANDOFF 7c item 4's string change. Rune
|
||||
Factory at FSR + FSR FG printed the pre-committed 7b line verbatim on the same run.
|
||||
|
||||
- **A counted session whose factor was refused no longer reads "no evaluation was observed".** DL:TB at FSR
|
||||
upscaling + DLSS Frame Generation (2026-09-06): 4,415 tokens, 8,174 DXGI-counted presents, `DlssG` from
|
||||
the tags, factor refused because bucket 8 of 8 read 1.96 against 2.85 — and the Presented qualifier said
|
||||
a runtime was loaded and nothing was seen. It now says frame generation was counted and its factor
|
||||
refused, that DXGI counted presents this hook never saw so the Displayed rate is above the printed
|
||||
number, and that the number is neither Native nor Displayed.
|
||||
|
||||
- **The withheld `none` is narrowed to sessions where DXGI's counter was not read (§H5 Leg 0 landed).**
|
||||
The owner's morning run on the DXGI-counted build printed the rule-6 trio on Dying Light: The Beast
|
||||
(`Native 70.52 -> Displayed 282.08 (x4 FG)`, 12,387 presents DXGI-counted, `DlssG`) and then ran the
|
||||
title twice with frame generation OFF: census unchanged (`sl.dlss_g.dll` is a startup-time load),
|
||||
presents = tokens, `unseen=0` over thousands of samples, and the report withheld `none` exactly as the
|
||||
gate's cost paragraph pre-committed. The counter is the discriminator the gate lacked — on that shape
|
||||
the pacer's presents are DXGI presents on the hooked chain — so a counted `none` beside a READ counter
|
||||
with zero unseen now prints as `none`, with *"DXGI's own present counter agrees: 0 unseen over N hooked
|
||||
present(s)"* on the line; it is withheld only when the counter was not read, with the reason saying so.
|
||||
A writer state that counted unseen presents the records do not carry is refused as a contradiction.
|
||||
On every other title the counter is printed beside `none` as a second witness. CLAUDE.md rule 6 carries
|
||||
the amendment; three cases changed sides and four are new.
|
||||
|
||||
### Added
|
||||
|
||||
- **Displayed FPS counted by DXGI where the hook cannot count it — the 2.8.0 pacer's presents.** The
|
||||
owner's run on the DXGI counter landed `20_OPEN_QUESTIONS` §H5 row P1-DXGI twice: Dying Light: The
|
||||
Beast at DLSS Frame Generation ×4 on Streamline 2.8.0 reads 2.90 and 2.95 presents per hooked present
|
||||
that DXGI counted on the same chain and the inline patches never saw, while Streamline 2.7.3 (Hell Is
|
||||
Us, ×3.86) and 2.10.3 (the Onimusha: Way of the Sword demo, ×3.67) read 0.00 — their generated frames
|
||||
come through the patched bodies. So the record now carries `dxgiUnseen` (@52, from the reserved word,
|
||||
under `FL_MEASURED_DXGI_PRESENTS`, no layout bump; mirror and `fl-layout-dump` follow), and the
|
||||
consumer's window counts `Displayed = hooked + Σ dxgiUnseen` — in the rule-6 trio, in `presents/batch`
|
||||
and in the uniformity buckets, never in a frame-time distribution — printing *"Displayed is
|
||||
DXGI-COUNTED"* on its own line whenever the sum is above zero, because that number is a count DXGI
|
||||
made rather than this hook. `none` withdraws on that title by count; a saturated byte is refused like
|
||||
a saturated `fgEvaluations`; a byte under a clear bit is an honesty violation. A present the hook SAW and
|
||||
declined — a paused session — is not an unseen present: every declined present bumps an epoch that
|
||||
invalidates the chain's last reading, which the paused-session integration case caught (the first record
|
||||
after a resume claimed the whole pause, 0x55, before the guard). On every other title
|
||||
the window is byte-identical (five cases pin it; the injected `[fg]` case checks the byte is claimed
|
||||
and zero on the harness). `03_METRICS` §Displayed may be DXGI-COUNTED carries the rule.
|
||||
|
||||
- **DXGI's own present counter against the hook's, in the writer state and the report.** On the one shape
|
||||
where `none` is withheld (Streamline ≥ 2.8 with `sl.dlss_g.dll` loaded, Dying Light: The Beast), the
|
||||
open question was whether the closed pacer's generated presents reach DXGI through a body the inline
|
||||
patches miss or are displayed below DXGI. The Overlay now reads `IDXGISwapChain::GetLastPresentCount`
|
||||
on every hooked present of the chain it just saw (rule 4: the same object `GetDesc` is already read
|
||||
from) and publishes `dxgiPresentSamples` and `dxgiPresentsUnseen` (`FlWriterState @48/@52`, from
|
||||
`reserved[]`, no layout bump; mirror, `fl-layout-dump` and the offset asserts updated). The report prints
|
||||
`DXGI present counter: unseen=M over samples=N (r unseen per hooked present)` with the reading, and the
|
||||
withheld qualifier says which side of DXGI the generated presents fall on. `20_OPEN_QUESTIONS` §H5
|
||||
carries the rows written before the run: r ≈ 3 at ×4 means the generated presents ARE DXGI presents
|
||||
and the next PR labels a DXGI-counted Displayed rate; r ≈ 0 means below DXGI and only the kernel and
|
||||
vendor reads remain. The harness's presents are the negative control (`fl_guard` `[fg]`: zero unseen);
|
||||
the positive cannot be fixtured. `hook-harness --probe-frames` now prints the call's cost.
|
||||
|
||||
- **A stall diagnostic in the report, placed against FrameLedger's own touches on the target.** The
|
||||
owner saw Cyberpunk 2077 fall to 1 FPS for about a second under capture (2026-09-05) and the report
|
||||
could say nothing about whose it was. The capture host now records the QPC moment of every guard scan
|
||||
and module snapshot (`CaptureResult.TouchQpc`, the records' own clock), and `StallReport` prints the
|
||||
three longest present-to-present intervals with their session time and the nearest host touch: a
|
||||
touch inside or within 1 s names FrameLedger a SUSPECT and asks for a longer run on the 30 s cadence;
|
||||
a far one says *not ours*. It counts intervals at or over 100 ms and calls itself a diagnostic — it is
|
||||
not `03_METRICS`' stutter, which P2's calculators own. Four cases pin the placement.
|
||||
|
||||
- **DLSS Frame Generation is NAMED, from the tags the title already sends.** On every NVIDIA title measured
|
||||
the count was right and the technology unnamed — `Active (technology not identified)` on Cyberpunk at
|
||||
MFG ×3 and on the three UE titles at ×4 — because `kFeatureDLSS_G` is never evaluated through the export
|
||||
the identity hook owns. Streamline's DLSS-G programming guide §5.0 requires a title running frame
|
||||
generation to tag the HUD-less colour and UI buffers every frame through `slSetTag` /
|
||||
`slSetTagForFrame` / `slEvaluateFeature`'s inputs — the three tag routes this build already hooks and
|
||||
read one tag type from. The detours now record every tag's TYPE (rule 4: the same argument), a
|
||||
HUD-less or UI tag drained by a present marks it `FL_FG_DLSS_G`, and `FlWriterState.slTagCensus` (took
|
||||
`reserved[0]`, no layout bump) says which types arrived on which route for the session; the report
|
||||
prints it as `Streamline tag census: global=[…] frame=[…] local=[…]`. **Identity only:** the consumer's
|
||||
rule is the count decides `none`, identity decides the name — an active count beside the mark prints
|
||||
`frame generation: DlssG`; a counted 1.0 beside it prints `none` with the inputs noted; the withheld
|
||||
shape (§H5) keeps its N/A and says the title is feeding frame generation. Two injected cases send the
|
||||
DLSS-G list through each global export with no `kFeatureDLSS_G` evaluation and assert the mark on every
|
||||
record and the census on the right route; the existing tag cases assert its absence. `slDLSSGGetState`
|
||||
— the API the guide names for the presented count — is refused and the reason recorded in `03_METRICS`:
|
||||
the call resets the plugin's counter a title may read for its own FPS display, and the header marks it
|
||||
not thread safe.
|
||||
|
||||
### Changed
|
||||
|
||||
- **The tag route is measured on real titles** (docs): the owner's evening run on #121 read `frame generation:
|
||||
DlssG` on Hell Is Us, Expedition 33, Wukong, Rune Factory and Cyberpunk — every Streamline title tags the
|
||||
DLSS-G inputs through a route this build hooks — and Dying Light: The Beast's census shows the title tags its
|
||||
scaling input through `slSetTagForFrame` with no size, which closes HANDOFF 7a's last question without a
|
||||
layout bump. `spike-notes` §9 carries the table; §H5 records the pre-commitment as landed.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **`render -> output` prints under frame generation.** `UpscaleExtent` keyed its window on the
|
||||
params bit, which the writer publishes only on the present that drained a dispatch or tag — one
|
||||
in N under frame generation — so `ClaimedSuffixStart`'s clean-suffix rule found no window and every
|
||||
FG-on capture since 2026-08-16 read `N/A` two lines under its own raw `render WxH` block
|
||||
(Cyberpunk at FSR 3 + FG, 2026-09-05, was the one that made it visible; the earlier "not computed
|
||||
yet" wording had hidden it). The window is now the identity suffix, which is per-record once the
|
||||
family is live, and every record inside it carrying both sizes counts. Two cases pin the FG shape
|
||||
and the refused intermittent-identity shape; the Cyberpunk FSR 3 consumer case now asserts the line.
|
||||
|
||||
### Added
|
||||
|
||||
- **`fl-probe-nvapi --ngx-state <pid>`: what the NVIDIA driver says about one process's DLSS
|
||||
features.** The owner's eleven-capture run on 2026-09-05 (`spike-notes` §9) left one NVIDIA gap in
|
||||
one sentence — the count is right on every title and the identity is what this build cannot say:
|
||||
DLSS on the four NGX-direct UE titles, DLSS-G everywhere, and the hidden presents on Streamline
|
||||
2.8. The NGX SDK is licence-blocked; `NvAPI_NGX_GetNGXOverrideState` (NVAPI, MIT, vendored, R570+)
|
||||
takes a process id and returns the driver's own feedback bits for SR / RR / FG plus the scaling
|
||||
ratio, quality mode and frame-generation count, out of process. The probe prints the raw words and
|
||||
every decoded bit so the owner's run against a running title measures whether the bits are
|
||||
populated without an NVIDIA-app override, before any report line is built on it. §H5 carries the
|
||||
decision that answer opens (a *driver-reported* rung in `03_METRICS`, the owner's call).
|
||||
|
||||
- **The FSR 3.0 host route: a fifth AMD target, `ffx_fsr3_x64.dll!ffxFsr3ContextDispatchUpscale`.**
|
||||
Cyberpunk 2077 at FSR 3 upscales through the FSR 3.0 **host** DLL's named export while its frame
|
||||
generation goes through the 1.1.x monolith's `ffxDispatch`, so the leaf-only build printed
|
||||
`upscaler: N/A` beside `FsrFg` (§H11, 2026-09-04). The host is hooked at its own export with its own
|
||||
trampoline and latch, keyed by module in the installer, under the same family and publish point as
|
||||
the four ffx-api rows (`PublishFfxFamilyIfWhole` waits for a loaded host as it waits for a loaded
|
||||
leaf); its UPSCALE feeds the same drain word — identity `FSR3` as a fact, `renderSize` as the
|
||||
extent, the count when neither Streamline nor a PREPARE has spoken. Rule 4: `renderSize` of the
|
||||
descriptor the title passed and nothing else; the offset is pinned to a literal (1256).
|
||||
`ffxFsr3DispatchFrameGeneration` is deliberately not a row, with the reversal condition
|
||||
pre-committed in §H11. **The headers are vendored from tag `fsr3-v3.0.4`, not the `v1.1.4` three
|
||||
documents named**: the shipped module's twelve `ffxFsr3*` exports match 3.0.4 exactly, 1.1.4
|
||||
declares fifteen and appends fields after `renderSize`, and at 3.0.4 `ffx_types.h` reaches no
|
||||
`<mutex>` at all (ten files, no `ffx_message.h`; `src/native/third_party/fidelityfx-fsr3/`, root
|
||||
`LICENSE.txt` MIT verbatim, `license-check.ps1` §2e per file, blob shas checked against upstream).
|
||||
The two FidelityFX trees share one struct name, so the 3.0.4 header is included inside a
|
||||
namespace. Fixtures: the `ffx_fsr3_x64.dll` stub (Pass C's second positive control), harness
|
||||
topologies `fsr3host` / `fsr3host+mono`, an `[ffx]` injected case at K = 1 (the row's double-count
|
||||
control) and K ∈ {1, 4} beside the monolith, and a consumer case for Cyberpunk's shape. Owed: the
|
||||
owner's acceptance run, rows B1–B4 in §H11.
|
||||
- **The report names the loaded vendor runtimes with their FILE versions, and a counted `none` is
|
||||
WITHHELD on the one shape measured to be wrong.** Dying Light: The Beast (Streamline 2.8.0) read
|
||||
`presents = tokens` five times with DLSS Frame Generation ON, and the owner's reading on 2026-09-05
|
||||
settled which way to read it: the title runs at DLSS ×4, the frames this hook records are the
|
||||
native ones, and the generated presents never reach the `Present` bodies the Overlay patches
|
||||
(`20_OPEN_QUESTIONS` §H5 case 3, realised). The census could not have said so — it records module
|
||||
NAMES, and Cyberpunk 2077 on 2.7.1 reads ×3.99 through the same hook — so the capture host now takes
|
||||
an out-of-process module snapshot beside every guard scan (`Process.Modules` + the file's version
|
||||
resource, the same documented module list the guard already enumerates; no game memory, no layout
|
||||
change, nothing on the present path) and prints one `module:` line per census-named module with
|
||||
version and path. `MeasuredFacts` withholds `none` when `sl.dlss_g.dll` — the Streamline plugin that
|
||||
would be doing the presenting, NOT `nvngx_dlssg.dll`, which every validated `none` also has loaded —
|
||||
is in the census beside an interposer at or above 2.8.0 (or one whose version could not be read), and
|
||||
the report falls through to `Presented FPS` with a qualifier that says the number counts APPLICATION
|
||||
frames and that the Displayed rate is unknown. Every validated `none` (Cyberpunk off / ×3 / ×4,
|
||||
Expedition 33 and Lies of P with frame generation off) is byte-identical, and eight cases pin that.
|
||||
The gate is interim: §H5 pre-commits the owner's session (DL:TB FG off / FG ×4, Cyberpunk MFG ×4,
|
||||
PresentMon elevated beside each) and the row on which it is withdrawn.
|
||||
|
||||
- **A whole-resource tag now yields the size the tagged `sl::Resource` declares.** Streamline
|
||||
documents a zero `extent` as "use the entire resource"; a title tagging that way stated the
|
||||
render size nowhere the Overlay read, and Dying Light: The Beast (SL 2.8.0) still published no
|
||||
extent on the `slSetTagForFrame` build with both tag rows live. `TagSize` in `fl_sl_inputs.h`
|
||||
reads the extent first and, when it is zero, the Resource's own `width/height` — GUID-checked,
|
||||
from the argument the hooked API received, on the local walk and both global-tag detours alike,
|
||||
so the three routes cannot disagree about what a tag says. A Resource declaring no size is
|
||||
still the honest unknown. Unit cases cover the shape, precedence of a non-zero extent over the
|
||||
Resource, a Resource that fails the GUID check and a half-declared size; the harness tags in
|
||||
that shape under `--sl-tag-whole-resource` and an injected case asserts the exact size arrives
|
||||
on every record through the 2.8 export.
|
||||
|
||||
@@ -0,0 +1,958 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66): part 3 of 5 of the ledger kept before the first tag, newest first. CHANGELOG.md lists every part. -->
|
||||
|
||||
## Ledger before 0.1.0-beta.1 (continued, part 3 of 5)
|
||||
|
||||
### Changed
|
||||
|
||||
- **7a on Dying Light: The Beast closes as measured `N/A`** (docs): the 00:53 capture on the
|
||||
whole-resource build still carried no render size on either global-tag route, so the quality
|
||||
byte and the render size are `N/A` on this title, honestly, and the derived-label decision
|
||||
applies to the titles that print the line. The DLSS-FG-on `presents = tokens` result is now
|
||||
five for five; by owner decision it is handled in its own session and PR (`HANDOFF` 7a, §H5).
|
||||
- **`20_OPEN_QUESTIONS` §H5 has a candidate title for case 3.** Dying Light: The Beast at DLSS
|
||||
with DLSS Frame Generation on read `presents = tokens` on four captures (the same title with
|
||||
FSR FG read ×2; Cyberpunk on Streamline 2.7.1 read ×3.99), so the report printed `frame
|
||||
generation: none` on a generating title. The two readings the record cannot separate and the
|
||||
discriminator — the owner's counter — are pre-committed there.
|
||||
|
||||
- **A row for `sl.interposer.dll!slSetTagForFrame`, Streamline 2.8's frame-based tag entry
|
||||
point.** Dying Light: The Beast ships Streamline 2.8.0, which deprecates `slSetTag` in favour of
|
||||
`slSetTagForFrame` (the frame token first, then the same tag list); the title published `Dlss`
|
||||
identity on every batch across three captures and the params bit on none, because the only
|
||||
params row hooked the deprecated export. The new detour hands the list to the same tag walk, has
|
||||
its own trampoline, and is selected by SYMBOL
|
||||
through a constant the inventory header binds to its row with a `static_assert` — Pass B forbids
|
||||
the literal anywhere else. **The params family is published when whole**, once every tag export
|
||||
the loaded interposer has is patched — a 2.7 interposer is whole with `slSetTag` alone, a 2.8 one
|
||||
needs both — because the first cut published it on the first row and the frame-based fixture
|
||||
measured 38 of 41 records claiming params, the ffx leaves' install-window defect from #110
|
||||
again. The stub exports it, the harness tags through it under `--sl-tag-for-frame`, and a Catch2
|
||||
case asserts the exact tagged extent arrives on every record with `slSetTag` never called.
|
||||
- **`tools/vendor-exports.ps1` unions exports across every copy of a module name** and lists every
|
||||
distinct version seen, instead of recording the first copy the walk reached. With `sl.interposer.dll`
|
||||
installed as 2.7.1 and 2.8.0 side by side, whether the oracle contained `slSetTagForFrame`
|
||||
depended on directory order; `docs/vendor-exports.json` is regenerated (ten interposer copies,
|
||||
eight versions from 1.5.6 to 2.10.3).
|
||||
|
||||
- **The report's `render -> output` line is computed, not "not computed yet".** Every real-title
|
||||
run since 2026-08-15 printed the raw sizes two lines above an N/A. `UpscaleExtent` takes the
|
||||
MODAL (render, output) tuple over the records that claim both `FL_MEASURED_UPSCALER_PARAMS` and
|
||||
`FL_MEASURED_OUTPUT_RES`, and the line prints the two measured sizes, `03_METRICS` §Upscaling's
|
||||
`sqrt((outW×outH)/(renW×renH))`, the reciprocal as a render-scale percentage, the record counts,
|
||||
and a **SETTINGS MOVED** flag when the window held more than one tuple — modal rather than mean,
|
||||
because averaging across a settings change is the classic way a benchmark number stops meaning
|
||||
anything. Cyberpunk's 1485×835 at 2560×1440 reads `1.72x (58% render scale)`. **No preset name is
|
||||
derived from it**: whether a label such as "≈ Balanced" may appear beside a measured field is
|
||||
HANDOFF item 7a's owner decision, and the quality byte stays what the writer measured.
|
||||
|
||||
- **The SDK 2.x loader is the fourth AMD row, because three loader-shipping titles read silent
|
||||
behind the leaf-only build.** The owner's run on #110 (thirteen captures, nine titles, one launch
|
||||
each) landed rows A1–A3 exactly as pre-committed — Lies of P `Fsr3` / `FsrFg` / `118.98 → 238.02
|
||||
(×2)` with the two per-frame counts agreeing at 1.00, `none` by count with frame generation off;
|
||||
Hell Is Us `FSR (3.1 or 4 …)` / `FsrFg` / ×2 — and produced a row the table lacked: Dying Light:
|
||||
The Beast at FSR + FSR frame generation, KCD2 at FSR and Black Myth: Wukong at FSR each dispatched
|
||||
**zero** times at any leaf export while the leaves sat in the census. The game calls the loader's
|
||||
export, and the signed loader reaches its providers through an object rather than the leaves'
|
||||
`ffxDispatch`, so "five identical export tables leave it no other route" was wrong about the
|
||||
loader. `amd_fidelityfx_loader_dx12.dll` is now an inventory row alongside the three leaves, the
|
||||
`static_assert` that refused it asserts the opposite with the measurement in its message, the
|
||||
loader stub forwards through the leaves' FrameLedger-named *direct* entry (never their export) to
|
||||
model what was measured, `--probe-ffx-resolve` asserts the forward touched no leaf export, and a
|
||||
third harness topology (`--ffx-topology ue`: the two effect DLLs called directly, no loader) keeps
|
||||
the leaf detours exercised now that the loader case never reaches them. The K = 1 control with
|
||||
all four modules hooked, and the consumer's `frames/upscale-drained`, are what would read 2× for a
|
||||
loader that re-entered an export. Also from the run: Expedition 33 at FSR upscaling under DLSS
|
||||
frame generation ×3 printed `×2.97`, *technology not identified*, from the UPSCALE count; Cyberpunk
|
||||
at FSR 3 generates through the 1.1.x monolith (`FsrFg`) while upscaling through the deferred FSR
|
||||
3.0 route; and **Rune Factory: Guardians of Azuma is HANDOFF 7b's statically linked title** — the
|
||||
monolith ships beside it and is never loaded, yet the Streamline token count still read
|
||||
`59.99 → 119.95 (×2 FG)`, so the ceiling for such a title is the trio with the vendor missing, not
|
||||
Presented FPS alone. **Row R6 ran the same night on this build:** Dying Light: The Beast at FSR +
|
||||
FSR FG printed `FSR (3.1 or 4 …)` / `FsrFg` / `70.49 → 140.9 (×2 FG)` with `frames/upscale-drained`
|
||||
1.01, and KCD2 at FSR the identity with `none` at 1.00 — the loader row carries both, once, which
|
||||
is the K = 1 control confirmed on a real title. Wukong at FSR with FG off read silent at the
|
||||
monolith and the loader alike with the monolith loaded, and offers no FSR frame generation at
|
||||
all: FSR upscaling compiled into its UE plugin (Rune Factory's shape), the monolith shipped and
|
||||
loaded for nothing this hook sees — the second static title, and nothing more is owed on AMD
|
||||
identity beyond the FSR 3.0 host route.
|
||||
`20_OPEN_QUESTIONS` §H11 carries the run tables; `HANDOFF` 7b/7c and `spike-notes` §9 carry the
|
||||
corrections.
|
||||
|
||||
- **AMD identity is measured through the ffx-api leaves, and the first non-NVIDIA vendor
|
||||
reaches the record.** HANDOFF item 7c. Lies of P at FSR 3.1 + frame generation printed
|
||||
`upscaler: N/A … frame generation: N/A` plus a census WARNING because the three AMD modules
|
||||
export the same five generic names and the identity lives in the descriptor the game passes
|
||||
— which needs the vendor's headers to decode, and `20_OPEN_QUESTIONS` §H11 forbids decoding
|
||||
it from observation. Five headers are vendored from FidelityFX-SDK **tag `v2.3.0`**,
|
||||
types-only under upstream's `Kits/FidelityFX/` layout, with upstream's `docs/license.md`
|
||||
verbatim: a binary-only default licence whose **MIT exception list names every one of the
|
||||
tree's 845 files** (the signed DLLs included), the five among them, and each header carries
|
||||
the grant inline; `license-check.ps1` §2d asserts both per vendored file. `v2.3.0` rather
|
||||
than the `v1.1.4` `18_GPU_VENDOR_APIS` first named, because its own reversal condition
|
||||
fired: installed titles already ship SDK 2.x effect DLLs (Hell Is Us 4.0.x, Expedition 33
|
||||
and Dying Light: The Beast 4.0.2 + 3.1.5) and the sample dispatches `PrepareV2`, which
|
||||
`v1.1.4` does not declare; every value and layout read is identical in both tags.
|
||||
**Three inventory rows, one compound family, one observer, three trampolines, and the rows
|
||||
are the LEAVES** — `amd_fidelityfx_dx12.dll` (the SDK 1.1.x monolith),
|
||||
`amd_fidelityfx_upscaler_dx12.dll`, `amd_fidelityfx_framegeneration_dx12.dll` — **never the
|
||||
SDK 2.x loader**, which forwards to the effect DLLs through their own exports (the only
|
||||
route five identical export tables allow) so hooking it too would count every dispatch
|
||||
twice, straight into `fg_factor`; a UE5 title ships the two leaves with no loader at all.
|
||||
The detour reads the descriptor's head type and, once matched, `renderSize` (UPSCALE,
|
||||
PREPARE) and `frameID` (PREPARE) — rule 4's class of read — and publishes: identity
|
||||
(`FSR3` from the monolith; the new **`FL_UPSCALER_FSR_UNVERSIONED`** from the 2.x upscaler
|
||||
DLL, which hosts FSR 3.1 and FSR 4 behind one dispatch type — an enumerator, no layout
|
||||
change), `renderW/H` exact with quality and sharpness `0xFF` (the ffx-api dispatch carries
|
||||
neither, so that is the true value), `fgMode = FSR_FG` on a present that drained a
|
||||
generated batch, and `fgEvaluations` from PREPARE's `frameID` counted on a **new** index
|
||||
only — this vendor's `slGetNewFrameToken` — falling back to the UPSCALE count on a title that
|
||||
never prepares. Streamline keeps precedence once it has ever issued a token, so every title
|
||||
validated on §S31 is byte-identical to before. Fixtures: three leaf stubs, a **forwarding
|
||||
loader decoy**, `--probe-ffx-resolve` (ctest `fl_ffx_resolve`), and `--hold-presenting-ffx`
|
||||
driven at K = 1 / K = 4 on both topologies with the PREPARE issued twice per frame — the
|
||||
K = 1 control reads 2.0 for a writer that counts calls, or that hooks the loader.
|
||||
`hookinventory-check` Pass C now reads the Overlay's **export table** too: `ffx_api.h`
|
||||
declares its entry points `__declspec(dllexport)` unconditionally. Hook-path overhead: the
|
||||
present path gains two `exchange`, two loads and a branch; the detour is one 8-byte read, a
|
||||
switch and one RMW per dispatch (a CAS loop on PREPARE). Owner-only runs owed: Lies of P at
|
||||
FSR + FG and FSR alone, Hell Is Us at FSR, against the table pre-committed in §H11.
|
||||
|
||||
- **`none` is reachable by counting, §S31 is resolved, and P0's frame-generation blocker is
|
||||
gone.** The owner's second run on #105's monotone count landed on row **P1** of the table
|
||||
pre-committed in `20_OPEN_QUESTIONS` §S31: Cyberpunk 2077 off / ×3 / ×4 at `presents/tokens`
|
||||
**1.00 / 2.99 / 3.99**, Hell Is Us DLSS + FG ×4 at **4.00**, and `tokens/batch` **1.00** on
|
||||
every leg with batches — so a drained Streamline batch *is* an application frame on that
|
||||
title, answered by a second per-frame count rather than by any of the four oracles that fell.
|
||||
The pre-P1 refusal of ratios near 1 is replaced: a published factor ≤ 1.05
|
||||
(`FgWindow.NoneCeiling`) is rung 4's `none` — every present carried an application frame,
|
||||
measured — a factor ≥ 1.5 (`ActiveThreshold`) is active, and the band between is refused as a
|
||||
configuration no vendor ships. `fgMode` reads `None` / `Active (technology not identified)`
|
||||
from the count when the identity hook named nothing; the report gains its third shape, the
|
||||
bare `FPS: 84.02` with a `frame generation: none` line — no pair, no factor, no qualifier.
|
||||
`15_ROADMAP` item 7 ✅; §S24 counts nine. *Flower in Us* resolved to its browser process,
|
||||
injected, and captured three swapchains' worth of presents, so the Overlay loads inside NW.js.
|
||||
|
||||
- **The frame-token count keys on a NEW frame INDEX, and the Chromium resolver knows the shape
|
||||
with no GPU process.** Both from the run that followed #103 / #104 the same evening.
|
||||
Cyberpunk 2077 asks `slGetNewFrameToken` three to four-and-a-half times per application frame
|
||||
and receives a distinct object each time, so a pointer-keyed count read the request rate:
|
||||
`presents/tokens` 0.22 / 0.64 / 1.31 at off / ×2 / ×4 — `20_OPEN_QUESTIONS` §S31 row **P4**,
|
||||
the refinement it prescribed. The detour now reads the frame index — the title-supplied
|
||||
`frameIndex`, or the token's own accessor when none is given — and counts it **only when it is
|
||||
above every index seen so far**: "differs from the last index" would still count every switch
|
||||
between the two or three frames a title keeps in flight. The stub hands back distinct objects,
|
||||
and the harness asks three times per frame with the previous frame's index in the middle, so
|
||||
the K = 1 control is red for a pointer-keyed writer and for a last-index-keyed one. No factor
|
||||
had been published on any leg — the ≥ 1.5 gate held — and the four-leg run is owed again.
|
||||
*Flower in Us* still refused through #104's rule because **NW.js has no `--type=gpu-process`**:
|
||||
six processes, the GPU in-process in the untyped browser. Second rule: exactly one untyped
|
||||
candidate among typed siblings is the browser and the target; two untyped are two instances
|
||||
and refuse. The refusal line prints the tree.
|
||||
|
||||
- **Chromium-based titles resolve to their GPU process instead of refusing as ambiguous.**
|
||||
NW.js, Electron and RPG Maker MV/MZ run several processes from one image path, and *Flower in
|
||||
Us* refused as `TargetAmbiguous` on 2026-09-03. The presenting process is Chromium's GPU
|
||||
process — it owns no window, so no window-based pick is correct — and Chromium labels it with
|
||||
`--type=gpu-process` on its own command line. `TargetResolver` now reads each candidate's
|
||||
command line through `NtQueryInformationProcess(ProcessCommandLineInformation)` — served by
|
||||
the kernel with `PROCESS_QUERY_LIMITED_INFORMATION`, no `ReadProcessMemory`, no PEB walk, the
|
||||
rule-4 line `HeldProcessHandle` already draws — and resolves only when **exactly one** readable
|
||||
candidate carries the flag as a whole argument. Two GPU processes, none, or an unreadable
|
||||
sibling still refuse; §S27 is untouched (consent keyed on the path, every candidate is that
|
||||
path, the guard scans the pid chosen, no `--pid`). `TargetResolverTests` drives it against
|
||||
real processes: a uniquely-named copy of `cmd.exe` started three times, one with the flag.
|
||||
|
||||
- **The frame-generation producer, chosen with no oracle and built: `slGetNewFrameToken`.**
|
||||
HANDOFF item 3 had five candidate routes and four fallen oracles. The one taken needs neither:
|
||||
Streamline hands a title **one frame token per application frame** by contract and the title
|
||||
must ask for it, so a detour on `sl.interposer.dll!slGetNewFrameToken` — a third inventory row,
|
||||
module-scoped, lazily installed — counts distinct tokens between presents, and `fg_factor =
|
||||
presents / tokens`. No premise about Ray Reconstruction batches, and it installs on the titles
|
||||
where `slEvaluateFeature` is never called (three of five measured). `fgEvaluations` keeps its
|
||||
name and its `03_METRICS` definition ("application frames, counted at the source") and changes
|
||||
producer; `FL_HOOK_FG_EVALUATIONS` moves to the new row and the evaluate detour claims identity
|
||||
only, with the `static_assert` flipped to say so.
|
||||
|
||||
**The one premise it carries is gated, not assumed.** From inside the process, "no frames were
|
||||
generated" and "the DLSS-G plugin requested a token for every frame it generated" both read
|
||||
1.0. A ratio ≥ 1.5 cannot come from the second, so the trio is published from it now; a ratio
|
||||
near 1 is refused by name (`FgWindow.PublishableFactor`) until the owner's Cyberpunk off / ×2 /
|
||||
×4 and Hell Is Us ×4 run lands on row P1 of the table pre-committed in `20_OPEN_QUESTIONS`
|
||||
§S31. `none` on a Streamline title is the PR after that run.
|
||||
|
||||
Fixtures: the stub interposer hands out tokens from a pool of eight (a nullptr token would
|
||||
have made every call the same frame); `--hold-presenting-fg` issues one token and one
|
||||
evaluation per K presents, and `fl_guard`'s K = 1 / K = 4 pair now discriminates the token
|
||||
count from the present count. Report labels `evaluations=` → `tokens=`. Hook-path overhead:
|
||||
one atomic exchange and one conditional increment on a call the title makes once per frame;
|
||||
nothing on the present path changed.
|
||||
|
||||
- **Presented FPS, and a runtime census that says what the one number may and may not mean.**
|
||||
With this writer, `03_METRICS`' frame-generation ladder lands on rung 0 for *every* title — no
|
||||
non-Streamline title sets `FL_MEASURED_FG`, and `Σ fgEvaluations` is 0 on every Streamline title
|
||||
measured — so a 2D title with no upscaler and Black Myth: Wukong running DLSS-G through a path
|
||||
this writer does not hook printed the same report line. `08_UI` said *"FG not detected →
|
||||
`144 FPS`"* while `03_METRICS` rung 0 said `N/A`, not `none`; both were half right.
|
||||
|
||||
**The rule (owner decision 2026-09-03, CLAUDE.md rule 6 amended):** when frame generation is
|
||||
not measured, the one number that stands alone is **Presented FPS** — `presents / D`,
|
||||
numerically Displayed FPS, named so that "Native" and "Displayed" are only ever printed
|
||||
*together* — with a mandatory qualifier chosen by the **runtime census**.
|
||||
|
||||
**The census.** `FlWriterState.runtimeCensus` (`reserved[0]`, no layout bump: the build-id
|
||||
handshake refuses an older writer first) is taken on the Overlay's watchdog once a second —
|
||||
`GetModuleHandleExW(UNCHANGED_REFCOUNT)` per name in `FL_RUNTIME_CENSUS`, twenty measured
|
||||
module names in two families, OR-only, nothing on the present path, nothing patched. `Ran` is
|
||||
bit 0 so a writer that never took it publishes 0 and decodes as "nobody looked".
|
||||
`hookinventory-check` gains **Pass D**: every census name must be a module `vendor-exports.json`
|
||||
has actually seen, because a misspelt name reads as "not loaded", which reads as the 2D case.
|
||||
|
||||
**What it changes in the report.** Under Presented FPS, one of three lines: the census did
|
||||
not run; *no known frame-generation runtime was loaded, so this cannot include in-process
|
||||
generated frames (statically linked FSR3-FG and driver-level AFMF excepted)*; or **WARNING:
|
||||
a frame-generation runtime was loaded (`nvngx_dlssg.dll`) and no evaluation was observed —
|
||||
this MAY include generated frames**. The upscaler line stops saying *"our coverage is short,
|
||||
not the title's"* — false in the commonest case — and names the three causes it cannot tell
|
||||
apart: settings off, an unhooked path, an undecoded vendor.
|
||||
|
||||
**What it never does: produce `none`.** `FL_FG_NONE` / `FL_UPSCALER_NONE` mean a hook ran and
|
||||
saw the alternative. FSR is routinely linked statically, so a census-`none` on an FSR3-FG
|
||||
title would print presents as native — the exact number rule 6 forbids — with a confident
|
||||
label. The census narrows an N/A's reason and raises a warning; it does not close the question.
|
||||
|
||||
Fixtures: `fl_guard`'s present-only case asserts `runtimeCensus == FL_CENSUS_RAN` by equality,
|
||||
the Streamline-stub case asserts the interposer bit set and every FG bit clear;
|
||||
`amd_fidelityfx_dx12.dll` — the FSR 3.1 facade, which Lies of P ships ALONE while generating
|
||||
frames — is in the FG group, so its presence warns rather than reassures;
|
||||
`CensusReportTests` drives all three report shapes, the Witcher-3 shape (runtime loaded, no
|
||||
hook) and the inconsistent-writer shape. **Hook-path overhead: none** — the census runs only on
|
||||
the watchdog. **Run the same day on six titles** (`spike-notes` §9): both qualifiers seen on real
|
||||
games with the loader's own names; the census is a startup property on UE5 (identical word at
|
||||
off / FSR / DLSS + FG ×4); Hell Is Us is the third title where DLSS is on and `slEvaluateFeature`
|
||||
sees nothing; a Chromium-based title refuses as `TargetAmbiguous`, now a scope row.
|
||||
|
||||
- **The first telemetry source, and the measurement it exists for: §M5 is answered — GPU
|
||||
sensors work unelevated, without PawnIO, on NVIDIA.** `FrameLedger.Application.Telemetry`
|
||||
gains the port `18_GPU_VENDOR_APIS` specified (`IGpuTelemetrySource`, `GpuSample`,
|
||||
`GpuCapabilities`, `TelemetryLayer`); `FrameLedger.Infrastructure.Telemetry` gains
|
||||
`LhmTelemetrySource` (L2) over LibreHardwareMonitorLib 0.9.6 — GPU group only, its own
|
||||
poller thread, 1 Hz and never under 500 ms, *throws or hangs twice ⇒ disabled for the
|
||||
session*, capabilities value-derived and monotonic so a sensor that never reports is never
|
||||
a capability — behind an `ILhmComputer` seam so every branch of the fault policy runs on
|
||||
CI, which has no GPU. `SensorMap` carries the name heuristics and their two traps (NVIDIA's
|
||||
`GPU Memory` *load* is VRAM-in-use; `Control` is fan duty, not RPM).
|
||||
|
||||
**The instrument is `FrameLedger.CaptureHost probe-lhm [--seconds n]`** — the unshipped
|
||||
host's fifth verb, the only one besides `consent list` that names no game, because it opens
|
||||
a sensor library in its own process and nothing else. It prints the raw tree before the
|
||||
mapped sample before the verdict, and the verdict names a row of the decision table that
|
||||
`20_OPEN_QUESTIONS` §M5 carried **before** the run.
|
||||
|
||||
**Row R1, twice.** Unelevated: core and memory temperature, load, VRAM used, core and memory
|
||||
clock, package power, fan — eight fields, all five deciding ones among them. The elevated
|
||||
control, launched through UAC, returned the same eight. PawnIO was installed on the box and
|
||||
never opened: only LHM's CPU and board groups use it. So the sentence already in `README`,
|
||||
`legal/EULA.md` and `OperatorDisclosure` — *"whatever hardware telemetry this machine can
|
||||
provide"* — is true as written, and `README`'s row now names what that is on NVIDIA.
|
||||
`OperatorDisclosure.Version` stays /2. Hotspot temperature is absent on this driver / GPU /
|
||||
library and is recorded as N/A, not as a defect. Numbers in `spike-notes` §10; the L2 NVIDIA
|
||||
column of the capability matrix is filled; AMD and Intel are exactly as untested as before.
|
||||
|
||||
**One defect the raw tree caught before the verdict did:** the first `SensorMap` mapped
|
||||
`D3D Shared Memory Used` — system RAM — to adapter VRAM by a fragment rule.
|
||||
`SharedMemoryIsNotVram` pins the fix. Printing the evidence ahead of the interpretation is
|
||||
the whole reason the probe is shaped the way it is.
|
||||
|
||||
Closes the `HANDOFF` loose end that `LibreHardwareMonitorLib` shipped into the Agent's
|
||||
output under an MPL-2.0 §3.1 obligation while used by zero lines.
|
||||
|
||||
### Changed
|
||||
|
||||
- **The consent texts now say what DECLINING costs, and the anti-nudge rule is normative.**
|
||||
`README`'s safety row, `legal/DISCLAIMER.md`, `legal/EULA.md` and `19_SAFETY` §User-facing consent
|
||||
all called a no-injection mode *"the default"*. That mode does not exist. The consent disclosure
|
||||
in `OperatorDisclosure` said it too, and added *"Nothing here is required to measure frame
|
||||
times"* — **the worst sentence in the tree**, because it told someone about to type
|
||||
`I ACCEPT THE INJECTION RISK` that the risk was optional when hooking is now the only
|
||||
frame-time path.
|
||||
|
||||
**Removing the fallback makes declining more costly, so the wording gets more careful rather
|
||||
than more persuasive.** §19_SAFETY gains a normative rule: both options are enumerated at the
|
||||
same grain, neither is recommended, *"limited"* / *"reduced"* / *"degraded"* are not acceptable
|
||||
descriptions of Tier 2, no sentence describes what the user **loses**, and Tier 2 is never
|
||||
described as temporary — a user deciding today decides against what exists today.
|
||||
|
||||
**The disclosure is also REORDERED.** The Tier-2 sentence used to be the last thing before the
|
||||
prompt, so whatever it said read as the set-up for accepting. Anti-cheat risk and terms of
|
||||
service now sit there instead.
|
||||
|
||||
**`OperatorDisclosure.Version` bumps /1 → /2**, because /1 carried two sentences that were false
|
||||
rather than differently phrased. Traced while doing it: **nothing re-prompts on a version
|
||||
mismatch.** The field is written, merged forward, cleared on revoke and read by exactly one
|
||||
non-test caller — the `consent list` status line. `HookRequest.FromConsent` never sees it, so a
|
||||
/1 record still yields consent. That limit is now written into the type rather than assumed.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **A candidate with no main module yet is counted as unreadable, not dropped as absent.** `TargetResolverTests.OneInstanceResolves` went red on the hosted runner twice in one hour on 2026-09-04 with `TargetNotRunning` about a process the test had just shown was enumerable: a freshly started process can be in the snapshot before its image is mapped, `Process.MainModule` is then null, and the resolver skipped it without counting it — narrowing the set exactly the way its own comment says "could not look" must not. It is now counted like a process we lack the rights to read (so the answer is `TargetAmbiguous`, never a false `TargetNotRunning`), and the test's "visible" wait means readable, not merely enumerated.
|
||||
|
||||
- **Two review checklists were boxes that could not fail**, in `19_SAFETY` §Review checklist and in
|
||||
the pull-request template: *"Is there a Tier-2 degradation path if the hook is unavailable?"*
|
||||
Under a two-rung ladder the answer is always yes. Replaced with something falsifiable — does the
|
||||
session record `N/A` rather than a fabricated value, **and record why**.
|
||||
|
||||
- **`CommandLineSurfaceTests` could not fail for the thing that changed.** It asserted
|
||||
`Contain("Tier-2")` against the disclosure while claiming to guard `19_SAFETY`'s four statements
|
||||
— so any rewrite keeping that literal token would have passed while the claim behind it changed
|
||||
completely. It now pins the substance (`N/A`, and the absence of both removed false sentences),
|
||||
and the new assertion was **canaried**: restoring one removed sentence turns it red.
|
||||
|
||||
- **The capture ladder collapses to two rungs, and Tier 2 is not a measurement.** Owner decision
|
||||
2026-08-28, and it is the honest shape once PresentMon was dropped: there is no no-injection
|
||||
measurement mode, so nothing holds a middle rung. What was Tier 3 is now Tier 2 — **session
|
||||
duration, whatever hardware telemetry the machine can provide, and the REASON nothing was
|
||||
measured**. Every measured field reads `N/A` (FR-4.9), and the reason is the payload rather than
|
||||
a consolation attached to it.
|
||||
|
||||
**Frame times, FPS and the lows are now Tier-1-only**, which is a real reduction in what this
|
||||
product promises: `README` previously offered them without injection.
|
||||
|
||||
**No capture tier needs an elevated Agent any more.** The requirement came from ETW trace
|
||||
sessions and there is no ETW rung. That closes §Scope's "Tier 2 requires an elevated Agent" row
|
||||
— as false now, not merely vacuous.
|
||||
|
||||
**§M5 was promoted from a design note to a blocker on a user-facing claim.** Whether LHM GPU
|
||||
sensors work unelevated without PawnIO is UNMEASURED; if they do not, the DEFAULT Agent's Tier-2
|
||||
session is **duration only**, which would falsify the sentence this change puts into `README`,
|
||||
the consent dialog and the EULA. All three therefore say *"whatever hardware telemetry this
|
||||
machine can provide"* — honest under either outcome, vague on purpose.
|
||||
|
||||
Twenty files. The ones that changed MEANING without changing WORDS are annotated in place —
|
||||
chiefly the 32-bit / D3D9 catalogue, "Tier 2" before and after, which went from *frame times
|
||||
without injection* to *unmeasurable in v1* across six files.
|
||||
|
||||
### Removed
|
||||
|
||||
- **`14_TESTING` §Tier cross-validation — a RELEASE-BLOCKING accuracy gate — is struck, and nothing
|
||||
replaces it.** It required Tier 1 and Tier 2 over the same frames agreeing within 1%. There is no
|
||||
second instrument. Its own last sentence is why this is recorded rather than dropped: it called
|
||||
itself *"the check that would have caught the original detection-accuracy problem"*.
|
||||
|
||||
**So Tier-1 frame times are not falsifiable by anything inside this project.** This is the same
|
||||
absence that killed the frame-generation oracle — one root cause, two casualties, and until now
|
||||
only §S31 was written down. A Tier-2 mechanism would restore both (§G).
|
||||
|
||||
- `EtwFrameSource` from the design, `fg_source`'s `etw` value, `HelloAck.etwAvailable`,
|
||||
`CaptureError.EtwAccessDenied`, the `PresentMon version` field in `sysinfo.json`, and the
|
||||
three-tier dropdown in the bug-report template.
|
||||
|
||||
- **PresentMon is DROPPED — owner decision 2026-08-27 — and Tier 2 keeps its place while losing
|
||||
its mechanism.** §S31 retired it as a measurement oracle (row P2); this removes it as an
|
||||
implementation. It is not bundled, not fetched, not used, and `tools/frametype-oracle.ps1` — the
|
||||
parser written for its output — is deleted with it, along with its `build.ps1` gate.
|
||||
|
||||
**Twelve documents named it as the Tier-2 mechanism and every one is corrected**: `CLAUDE.md`'s
|
||||
pinned-stack row, `README`'s capture-tier table **and its safety row**, `01_ARCHITECTURE`'s tier
|
||||
table and ADR-3, `03_METRICS` rung 2, `04_CAPTURE`'s source table and tier selection,
|
||||
`05_DETECTION`'s two Tier-2 rows, `07_IPC`'s `PresentMonMissing` error code, `12_BUILD`,
|
||||
`13_CI_CD`, `14_TESTING`'s CSV-parser row, `15_ROADMAP`'s P2 phase and v2 backlog, and
|
||||
`legal/THIRD_PARTY_NOTICES.md` plus `legal/licenses/README.md`.
|
||||
|
||||
**The notices row and `license-check`'s claim had to go together, and that is the gate working.**
|
||||
`tools/license-check.ps1` bound `Intel PresentMon` to `assets/native/PresentMon.exe`
|
||||
bidirectionally; removing the row alone fails with *"no table row mentions Intel PresentMon, so
|
||||
its bundling claim cannot be checked"*. Removing a claim is a deliberate act and is recorded as
|
||||
one. `legal/licenses/README.md` also listed a `presentmon-MIT.txt` that never existed.
|
||||
|
||||
**§M1, §M2 and §M6 close by DECISION, not by measurement**, and each says so: they were questions
|
||||
about a tool that no longer has a subject. §M2's answers are kept in full because every one cost a
|
||||
measurement. **§G is not closed — it gets bigger**: *"is the binary committed or fetched?"* becomes
|
||||
*"by what mechanism does a shipped build reach Tier 2 at all?"*, and nothing in this repository
|
||||
names one.
|
||||
|
||||
**What this costs users, stated where they will read it.** `README`'s **safety** row promises a
|
||||
no-injection mode as *"always a way out"*, and `legal/DISCLAIMER.md` §73 and `legal/EULA.md` §33
|
||||
both call it **the default** for uncertain cases. The README row now carries the fact that it is
|
||||
unbuilt and has no chosen mechanism, so **a refused or unhookable title gets Tier 3** — session
|
||||
duration and hardware telemetry. The two legal documents still say "default" without that
|
||||
qualification; §G owns the gap and names them. Not fixed here, because changing a legal document
|
||||
is not a cleanup.
|
||||
|
||||
**And the discriminator run was attempted and produced nothing**, so it settled nothing: the
|
||||
command targeted `explorer.exe`, which may present nothing PresentMon tracks, and "no CSV" is
|
||||
indistinguishable from "no `FrameType` column" — the §Traps entry about a canary that dies before
|
||||
reaching the gate. Badly chosen target, recorded as such, and moot now.
|
||||
|
||||
- **§S31 ran, and PresentMon is RETIRED as the application-frame oracle — row P2.**
|
||||
Three legs, three game launches, Cyberpunk 2077 at off / ×2 / ×4. `FrameType` is present and
|
||||
**every row of all three legs reads `Application`** — 1,937 / 6,488 / 10,881 rows, no other
|
||||
value anywhere, counted off the raw CSVs rather than off the tool's summary.
|
||||
|
||||
**The half that makes it a measurement rather than a shrug:** the two instruments agree on the
|
||||
present rate to within **0.3% on every leg** (43.16 vs 43.04, 144.31 vs 144.18, 241.84 vs
|
||||
241.80 present/s). They are counting the same stream, displayed rate tracks the configured
|
||||
multiplier, and at ×4 roughly three presents in four cannot be application frames — while
|
||||
PresentMon classifies **100%** of them as application frames. `tools/frametype-oracle.ps1`
|
||||
reported it as a **falsifier** on all three legs and never as a ratio of 1.0, which is the one
|
||||
behaviour it was written to guarantee.
|
||||
|
||||
**What P2 retires and what it leaves untouched.** Retired: PresentMon 2.x `FrameType` as the
|
||||
oracle for NVIDIA frame generation, and `03_METRICS` rung 2 is narrowed — the honest scope is
|
||||
now *no vendor is known to instrument this provider, and one is known NOT to*. **Not answered:**
|
||||
§S31's actual question. *Is a drained Streamline batch an application frame?* is exactly as open
|
||||
as it was; `presents/batch` still reads 2.00 and 3.99 on the same unverified premise and is
|
||||
still unpublishable as `fg_factor`. **Four oracles have now fallen.** `HANDOFF` item 3 goes back
|
||||
to the hook routes — unblocked, unmade, and now without an oracle behind whatever is chosen.
|
||||
|
||||
**One sub-question is unmeasured and it changes the REASON, not the action:** whether
|
||||
`--track_frame_type` was in effect at all. If the column ships by default, the legs recorded a
|
||||
default rather than an absence. Both branches end at *PresentMon did not answer as invoked*,
|
||||
which is why the row landed without waiting. The discriminator is one five-second run without
|
||||
the flag; it needs elevation, and it is recorded in §S31 with the command.
|
||||
|
||||
**Two findings nobody was looking for.** The `off` leg drained **zero** Streamline batches,
|
||||
against `presents/batch = 1.000` at off in §8 — Ray Reconstruction was not on, and §S30
|
||||
established RR is what produces batches when FG is off, so our side had two readable legs and
|
||||
not three. And the CSV's **first column is named `Application`** while the value being counted
|
||||
in column 9 is also `Application`: a parser resolving by position, or grepping for the word,
|
||||
counts process names. That rule was written into the oracle before it had ever seen a real CSV.
|
||||
|
||||
§M2's column set is measured at last — 24 columns — and `kFeatureDLSS_G` is zero on all three
|
||||
legs, taking that to five capture sets across five titles.
|
||||
|
||||
- **Five real-title captures across four titles, and the RT tri-state is complete** —
|
||||
`spike-notes` §6 and §8 carry the numbers; §8's per-title table was empty and now has five
|
||||
rows. Every run: 40 s, one swapchain, one segment, **0 gaps, 0 dropped**, `faults=0`, all six
|
||||
hook families installed, payload hash-verified against the just-built DLL first.
|
||||
|
||||
**`Yes` twice and `No` twice, every verdict agreeing with the game's own settings menu.**
|
||||
Cyberpunk 2077 with path tracing on and Black Myth: Wukong at RT High read `Yes`; Rune
|
||||
Factory: Guardians of Azuma, whose menu has no ray-tracing option, **and Cyberpunk with every
|
||||
RT option switched off** read `No` — the branch that had never been reachable. The second is
|
||||
the harder case: a title that *can* ray-trace and is not doing so. Both negatives satisfy all
|
||||
three conjuncts (`rtTier` 12, `RtAsBuild` installed, zero evidence over 36,575 and 16,871
|
||||
claiming records).
|
||||
|
||||
**The #87 falsifier did not fire, on two independent titles.** `rt_frame_pct` reads **25.0%**
|
||||
of the claiming window at ×4 on Cyberpunk and on Wukong — and Wukong got there through the RT
|
||||
evidence alone, with no Streamline batches involved at all.
|
||||
|
||||
**HANDOFF item 3's premise generalises from one title to four, and gets stronger.**
|
||||
`kFeatureDLSS_G` is zero on every run, and **two of the four titles never call
|
||||
`slEvaluateFeature` at all** — Wukong with `sl.interposer.dll` and `sl.dlss_g.dll` both loaded
|
||||
and DLSS-G demonstrably running, and Rune Factory. So it is not that DLSS-G avoids that
|
||||
export; on half the titles measured nothing goes through it, and `upscaler` correctly reads
|
||||
`Unknown` — *a hook ran and could not identify what it saw* — the first time that distinction
|
||||
has mattered outside a fixture.
|
||||
|
||||
**§S30's closure survived a test in the reverse direction it never had.** It concluded that
|
||||
Ray Reconstruction *replaces* the super-resolution pass, from one configuration. Turning RR
|
||||
off on the same title flips the census from `DLSS_RR` 2578 / `DLSS` 0 to **`DLSS` 4242 /
|
||||
`DLSS_RR` 0**, which is also the **first observation of `kFeatureDLSS` anywhere in this
|
||||
project**, and the local-tag extent arrives on that evaluation exactly as it did on the RR
|
||||
one — the same 1485×835.
|
||||
|
||||
**A second FG proxy, covering what the first cannot.** `presents ÷ RT-active presents` read
|
||||
**5,764 / 1,441 = 4.0000 exactly** on Wukong, where `presents/batch` is unreadable. Same
|
||||
unverified premise, disjoint coverage, still a proxy and not a producer.
|
||||
|
||||
**Two honest absences and one unexplained result.** `FL_MEASURED_UPSCALER_PARAMS` produced
|
||||
nothing on three of four titles — §2b's local-tag route is narrower than that entry assumed,
|
||||
and the writer published nothing rather than something wrong. And **Alan Wake 2 is not
|
||||
explained**: `presents/batch` = 1.00 with `rt_frame_pct` = 96.8% against a menu set to FG 4X
|
||||
fits both "generated presents miss our vtable" (§H5 case 3) and "frame generation was not
|
||||
running". The operator reported that title would not apply its settings, which is evidence for
|
||||
the second, and is why it is **not** written up as §H5 case 3. The discriminating run was not
|
||||
taken.
|
||||
|
||||
### Added
|
||||
|
||||
- **`fl-probe-signer`, and §S19(b)'s three questions answered before anything is designed.**
|
||||
That entry has been deferred since 2026-08-05 and its own rationale names the next step:
|
||||
*"Build `fl-probe-signer` first, in the shape `fl-probe-guard` established, and answer those
|
||||
three questions with measurements before any design is fixed."* This is that probe
|
||||
(`ctest fl_signer_probe`). **Nothing under `FrameLedger.Injector` changes with it** — reading
|
||||
a row off the table is a separate PR, including the row that says build nothing.
|
||||
|
||||
**The two Q1 results cut opposite ways, which is what makes the work affordable.** The CI
|
||||
blocker — `System.Security.Cryptography.ProtectedData.dll` — is embedded-signed and verifies
|
||||
offline as `O=Microsoft Corporation`, already in the shipped `trustedSigners`, so the embedded
|
||||
half alone would clear that refusal. But `mskeyprotect.dll`, the module §S19(b) was *written
|
||||
about*, returns `TRUST_E_NOSIGNATURE` on the embedded route and `ERROR_SUCCESS` only on the
|
||||
catalog one. The entry predicted exactly that; it is now measured rather than argued, and the
|
||||
expensive `CryptCATAdmin*` half is **not** on the path to the merge gate.
|
||||
|
||||
**§S19(b) also mis-describes the module, and the correction closes the cheapest-looking
|
||||
route.** It calls the blocker "a .NET shared-framework assembly". It is not —
|
||||
`Microsoft.NETCore.App` 10.0.11 does not contain it. It is a NuGet package assembly (6.0.0)
|
||||
reached transitively as `Microsoft.NET.Test.Sdk` → `System.Configuration.ConfigurationManager`
|
||||
→ `System.Security.Cryptography.ProtectedData`. So "just drop the package reference" fails:
|
||||
dropping it means dropping the test SDK.
|
||||
|
||||
**Q3 came back neither pass nor fail, and that is the honest answer.** Under
|
||||
`WTD_REVOKE_NONE | WTD_CACHE_ONLY_URL_RETRIEVAL`, `cryptnet.dll` is **newly loaded** — in a
|
||||
census bracketing the offline arm alone. Mapped is not transmitted, and this probe has no
|
||||
packet counter, so it reports the module and refuses to conclude. The discriminating run is the
|
||||
owner's: adapters disabled, same subjects, compare verdicts.
|
||||
|
||||
> **The probe's first version could not have told the two arms apart.** It censused once at
|
||||
> the top and once at the bottom with *both* the offline and the default
|
||||
> `WTD_REVOKE_WHOLECHAIN` calls in between, so `cryptnet.dll` appeared and the delta could not
|
||||
> attribute it — a census spanning both arms of the comparison it exists to discriminate.
|
||||
> Fixed before the recorded run. It read like an answer, which is why it is written down.
|
||||
|
||||
**Q2:** about 3.5 ms per module, and **warm is not cheaper than cold** (3.45 vs 3.54 ms over
|
||||
20 repeats) — there is no amortisation to plan around. Comfortable against the 30 s re-scan
|
||||
only because the scan set is small; a cache *within* one evaluation is admissible, a cache
|
||||
*across* evaluations is a re-scan that did not run.
|
||||
|
||||
**The decision table is honest about what it is.** §S30 and §S31 each pre-committed theirs
|
||||
before the run. This one could not: the probe had to be run to be finished, since its
|
||||
acceptance criterion is that it *prints* answers. The rows are therefore pre-committed only
|
||||
for the legs still **unrun** — CI, and the adapters-disabled run — and the entry says so in
|
||||
its first paragraph rather than borrowing a discipline it did not follow.
|
||||
|
||||
**And a constraint no measurement can lift.** Wiring the signer half makes `trustedSigners` a
|
||||
live allow-widening surface, and the gate over it — `Rules / validate` — is **not** a required
|
||||
status check on `main` (§S23-2). `19_SAFETY` already ruled on this shape: *"the boundary of
|
||||
what the gate looks at is code."* So even a clean result does not authorise the build. Owner
|
||||
decision, recorded in §S19(b).
|
||||
|
||||
Carries a canary: the probe's own unsigned executable must return `TRUST_E_NOSIGNATURE` and
|
||||
yield no organisation, so a green run discriminates rather than merely running —
|
||||
`fl-baseline-probe` was retired by exactly this class of test. The include block is
|
||||
`clang-format`-fenced and says why: `.clang-format`'s `IncludeBlocks: Regroup` sorts
|
||||
`<mscat.h>` ahead of `<wincrypt.h>`, and `mscat.h` uses types `wincrypt.h` declares, so the
|
||||
alphabetical order fails with twenty errors inside the Windows SDK and one in our own code.
|
||||
|
||||
- **`tools/frametype-oracle.ps1`, and §S31 with its decision table written BEFORE the run.**
|
||||
HANDOFF item 3's producer decision needs one measurement: is a drained Streamline batch an
|
||||
application frame? Three oracles have already fallen, so the mapping from measurement to
|
||||
action is committed first, in the file that owns the item — the discipline §S30 used,
|
||||
including the part where its table turned out to have holes and was kept unchanged anyway.
|
||||
Two of §S31's six rows **retire** PresentMon outright. The tool compares **two dimensionless
|
||||
ratios** — PresentMon's `displayed / application` against our `presents / batch` — because
|
||||
§S30's own correction records that comparing *rates* needs a shared span, and the span is
|
||||
where the previous draft went circular. Its `-SelfTest` runs in `build.ps1 check`.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **`03_METRICS`' frame-generation ladder presented rung 2 as unconditional, and it is not.**
|
||||
Measured 2026-08-20: `--track_frame_type` is a **beta** option in PresentMon 2.5.1 whose own
|
||||
help says it *"requires application and/or driver instrumentation using Intel-PresentMon
|
||||
provider"*. So `FrameType` reports events a vendor chose to emit rather than classifying any
|
||||
present from first principles, and whether NVIDIA's DLSS-G driver instruments Intel's
|
||||
provider is unmeasured — which decides whether the rung exists at all on the titles P0 needs.
|
||||
The ladder now says so, and adds the consequence: a `FrameType` column that classifies
|
||||
nothing is an **absence**, so rung 0 turns it into `N/A` rather than rung 4 turning it into
|
||||
`none`.
|
||||
- **Ray tracing has a producer, and the RT tri-state's `Yes` and `No` are reachable for the
|
||||
first time.** `ID3D12GraphicsCommandList4::DispatchRays` and
|
||||
`::BuildRaytracingAccelerationStructure` are detoured, `rtFlags` and `dispatchRaysVolume`
|
||||
are drained per present with `exchange(0)` beside `g_slSeen`'s, and `FL_MEASURED_RT` is set
|
||||
whenever either family is live. `rtTier` and `hooksInstalledMask` already had producers, so
|
||||
all three conjuncts of `03_METRICS`' `No` branch are now live. §S29(f) is closed on both of
|
||||
its halves, and CLAUDE.md rule 7 is amended per the 2026-08-14 owner ruling: `N/A` applies to
|
||||
*naming the technique as RayQuery*, not to whether rays are being traced.
|
||||
|
||||
**Both hooks, because one of them alone is a trap.** A writer with only `DispatchRays` sees
|
||||
nothing on an inline-RayQuery title, and its silence is indistinguishable from a real
|
||||
negative. The injected fixture pair makes that falsifiable rather than a sentence in a
|
||||
document: two harness modes differing by **one recorded call**, sharing their acceleration
|
||||
structure, state object, swapchain and loop — `--hold-presenting-dxr` yields dispatch
|
||||
evidence and an exact multiple of the fixture's own 64×32×1 volume, `--hold-presenting-rayquery`
|
||||
yields AS-build evidence and **zero** dispatch evidence.
|
||||
|
||||
- **`fl_rt_accum.h`** — the dispatch-volume arithmetic in a header, with its identities as
|
||||
`static_assert`s and its behaviour in `ctest fl_dxr_inputs`, the same split `fl_sl_seen.h`
|
||||
uses. **The assertions found a real wrap bug before it ever ran**: `AddedTo(cur, add)` with
|
||||
`add` near `UINT64_MAX` — which the saturating product returns for a hostile descriptor —
|
||||
overflowed the 64-bit sum and wrapped to a small number that passed the ceiling check. They
|
||||
also corrected the justification written above them: two `uint32`s multiply *within* a
|
||||
`uint64`, and it is the third dimension that overflows.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **The ray-tracing hook installed, published its family bit, and never fired — and the reason
|
||||
generalises past ray tracing.** A command list's first `Reset()` replaces its class vtable
|
||||
with a **per-object** one in which the vendor driver has taken methods over: measured on an
|
||||
RTX 5080, `DispatchRays` moves from `D3D12Core.dll` into `nvwgf2umx.dll` while
|
||||
`BuildRaytracingAccelerationStructure` stays put. Every game resets its lists every frame, so
|
||||
the addresses in an unreset throwaway's vtable are ones no title ever calls for the moved
|
||||
methods. The injected fixture caught it exactly — `withDispatch = 0` beside
|
||||
`hooks = RT_DISPATCH | RT_AS_BUILD`, a mask bit with nothing behind it — and because the
|
||||
*other* hook worked it read as a bug in the dispatch detour rather than in the acquisition
|
||||
they share. **The rule: put a throwaway object through the same lifecycle the game's objects
|
||||
go through, or it is not a sample of them.** The fix is one call.
|
||||
|
||||
- **Two of #86's five pre-flight answers were wrong, and this corrects them.** That probe read
|
||||
vtables off **freshly created** lists and compared vtable ARRAYS — neither of which is what a
|
||||
hook depends on, since a game's list is Reset and the Overlay patches the FUNCTION a slot
|
||||
points at. Corrected, measuring reset lists and comparing functions: **Q3** is now *DIRECT and
|
||||
COMPUTE resolve to the SAME functions*, so one detour per method covers both list types
|
||||
(#86 said they did not share and the hook must patch two vtables); **Q4** is now *a WARP list
|
||||
and a hardware list resolve to DIFFERENT functions*, so a throwaway-device acquisition would
|
||||
silently miss every call (#86 said they shared and one would have worked). A new Q5 prints the
|
||||
module on each side of the `Reset` so the next machine answers for itself rather than
|
||||
inheriting one driver's behaviour.
|
||||
|
||||
- **`IsHonest` did not cover `dispatchRaysVolume`**, on either side of the mirror. A volume set
|
||||
with `FL_MEASURED_RT` clear is a writer contradicting itself and is the shape a drain that
|
||||
cleared one word and not the other would produce; 0 is a real measurement, so only the mask
|
||||
bit can tell the two apart. Added to `MeasuredFacts.IsHonest` and to its native twin.
|
||||
|
||||
- **The Overlay's "NOT SET, deliberately" list had gone stale three entries deep**, in a comment
|
||||
block whose whole subject is which measurements have no producer. It still described
|
||||
`FL_MEASURED_UPSCALER_PARAMS` as having "no source in this writer" after `Hook_SlSetTag` gave
|
||||
it one. Rewritten to what is actually absent — PSO, VRAM, latency, HDR — with the staleness
|
||||
itself recorded.
|
||||
|
||||
- **HANDOFF item 4's pre-flight, run before a single ray-tracing hook was written — and it found
|
||||
the defect the hook would have shipped.** `fl_d3d12_vtable.h` records the two
|
||||
`ID3D12GraphicsCommandList4` slots (72 `BuildRaytracingAccelerationStructure`, 76
|
||||
`DispatchRays`), one header and two consumers, and `ctest fl_d3d12_vtable_indices` proves each
|
||||
by **behaviour on both list types** rather than by the COM ABI's say-so. `ctest fl_dxr_probe`
|
||||
answers four questions the hook design must not guess at, and prints an unanswerable one as
|
||||
unanswered rather than as a pass.
|
||||
|
||||
**DIRECT and COMPUTE command lists do NOT share a vtable.** A hook patching only the DIRECT
|
||||
class would have missed every AS build and every `DispatchRays` recorded on a compute list —
|
||||
and async BLAS builds on a compute queue are ordinary practice. The mask bit would still be
|
||||
set and the evidence would be absent, so `03_METRICS`' `No` branch would have published a
|
||||
**confident `Ray Tracing: No` about a title that ray-traces every frame**, with all three of
|
||||
its conjuncts satisfied and none of them watching this direction. The two vtables hold the
|
||||
*same function pointers*, so the fix is a patch applied twice or one inline patch on the
|
||||
shared target; what is now excluded is patching one and stopping.
|
||||
|
||||
Also measured: **WARP reports `RaytracingTier` 12 here**, so a DXR fixture is not condemned to
|
||||
a GPU box — item 4's "check first whether WARP supports DXR" is answered for this machine, and
|
||||
the probe prints the tier on every run so CI answers for itself. And a WARP list and a
|
||||
hardware list **do** share a vtable, so a throwaway-device acquisition would have worked; the
|
||||
design still takes the vtable off the game's own device, because this machine lost WARP's
|
||||
D3D12 path to an Insider build for a fortnight and a design that needs no WARP cannot be taken
|
||||
down by one. `spike-notes.md` §6 carries the numbers, `17_HOOK_ENGINE` §Ray tracing the
|
||||
constraint.
|
||||
|
||||
- **`presents / batch` gets a guard of its own, because the one it had could not fail.**
|
||||
`FgWindow.BucketFactors` splits the window into eight buckets and refuses a factor when one
|
||||
departs from the whole — and it divides by `Σ fgEvaluations`, which is **zero on every record**
|
||||
on the one route a real title has been measured on. So every bucket matched, the check passed
|
||||
vacuously, and `RefusalFor` returned at the data-gap clause before uniformity was ever
|
||||
considered, while `presents / batch` was printed underneath with nothing behind it. Measured
|
||||
2026-08-16: an alt-tab mid-capture produced an achieved ratio of **1.84** against a title
|
||||
configured for ×2 — wrong by 8%, and the report said nothing. `FgWindow.BatchRefusal` is the
|
||||
per-bucket `presents / batch` check §S30 named as a prerequisite, `FgWindow.PresentsPerBatch`
|
||||
moves the arithmetic out of the renderer, and `SessionReport` prints the verdict on the line
|
||||
under the ratio so the number cannot be read without it. Proven both ways: a canary returning
|
||||
`null` from the check turns the two uniformity cases red and leaves the uniform case and the
|
||||
attribution refusals green.
|
||||
- **The capture host samples whether the operator was actually watching the game**, once per
|
||||
10 Hz drain tick, and the session carries the pair `(DrainTicks, ForegroundTicks)`.
|
||||
Out of process — `ForegroundWindowProbe` in `Infrastructure`, two documented Win32 calls — so
|
||||
it costs the hook path nothing, reads nothing belonging to the target, and needs no record
|
||||
byte; §S30 suggested doing it in-process and that would have bought nothing. **The pair,
|
||||
because zero is not a finding:** a target owning no top-level window is unfocused on every
|
||||
tick of every run, which is what `hook-harness` does, so collapsing "never had focus" into
|
||||
"lost focus" would fire on every integration run. It is attribution and never the guard —
|
||||
`BatchRefusal` refuses a mixed window from the records alone, so a caller that never wires
|
||||
focus still cannot publish an averaged ratio.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **`hook-harness/CMakeLists.txt` still carried the pre-2026-08-14 subtraction** in the comment
|
||||
justifying module-scoped resolution — a fifth site for the formula `fl_shm.h` retracts. The
|
||||
argument survives the correction with its polarity flipped: an inflated count now inflates
|
||||
Native FPS and deflates `fg_factor`.
|
||||
- **Ray Reconstruction answered `N/A` on every frame-generating title, and the reason was a
|
||||
consumer bug rather than a coverage gap.** `MeasuredFacts.RayReconstructionOf` required
|
||||
`FL_FEAT_RAY_RECONSTRUCTION_OBSERVED` on **every** record in the stream, while the writer sets
|
||||
that bit only on the present that drained a Streamline batch — roughly one in four at ×4,
|
||||
measured 24% on the Cyberpunk 2077 stream. A condition that cannot hold above ×1 meant the
|
||||
verdict was decided by the frame-generation setting rather than by whether Ray Reconstruction
|
||||
ran: the title evaluated `kFeatureDLSS_RR` on 2,523 of 2,523 batches and this reported `N/A`.
|
||||
The population is now the batch-carrying presents — none ⇒ `N/A`, any carrying the fact bit ⇒
|
||||
`Yes`, batches with none ⇒ `No`, the branch that was unreachable. The lazy-install prefix drops
|
||||
out for free instead of forcing `N/A` over a whole session.
|
||||
|
||||
The comment this replaces reasoned that the alternative would publish a whole-session verdict
|
||||
from a single frame and that fixing it needed the application-frame unit HANDOFF item 3 would
|
||||
introduce. Both halves were wrong — the natural population is thousands of batches, not one
|
||||
frame, and it needs no application-frame unit, which is fortunate because item 3 could not
|
||||
produce one. Proven both ways: restoring the `All` rule turns the three positive cases red and
|
||||
leaves `NoBatchObservedIsNAAndNeverNo` green, so the fix is not "answer `Yes` to everything".
|
||||
- **Four comments still carried the pre-2026-08-14 subtraction `F_app = presents − Σ
|
||||
fgEvaluations`**, which `fl_shm.h` explicitly retracts — `ShmLayout.cs`, `MeasuredFactsTests`,
|
||||
`stub_sl_common.cpp` and `fl-probe-interposer`. The mirror's doc comment also said the count is
|
||||
"3 at ×4"; it is 1 per application frame at every multiplier, and the two forms differ by a
|
||||
factor of four on the one real title measured. The decoy stub's arithmetic argument was
|
||||
reversed by the same correction: an inflated count now INFLATES Native FPS and DEFLATES
|
||||
`fg_factor` rather than the other way round.
|
||||
- **`docs/HANDOFF.md` item 3 contradicted itself inside one entry** — one block recorded that
|
||||
three oracles had been tried and fallen, and a later bullet said neither of the two cheap
|
||||
measurements had been run. `fl-baseline-probe` was run on 2026-08-16 and retired by its own
|
||||
pre-committed falsifier; only the game's own frame counter is still unrun.
|
||||
- **`docs/HANDOFF.md`'s "`./build.ps1 check` cannot go fully green here" is no longer true**, and
|
||||
it was the first thing a new session read. Measured 2026-08-20: the gate is fully green on the
|
||||
dev box, 20/20 native tests, and `hook-harness --probe-d3d12` succeeds. Nothing in this
|
||||
repository fixed it — the machine moved from Insider build 26300/29639 to **29648**, with
|
||||
`d3d10warp.dll` and `D3D12Core.dll` both at `10.0.29648.1000`, so the WARP D3D12 regression was
|
||||
fixed upstream. The trap entry is dated rather than deleted: the durable fact is that this
|
||||
dependency broke and healed under the machine without a code change, twice giving the native
|
||||
suite a colour that said nothing about `main`.
|
||||
|
||||
### Changed
|
||||
|
||||
- **`spike-notes` §11 is filled, and the news is bad in a useful way.** PresentMon **2.5.1**
|
||||
is present and pinned by hash (956,768 bytes, SHA256 `9BEC…A191`) — **it carries no
|
||||
VERSIONINFO at all**, so pinning can only mean hash plus filename, which is worth stating in
|
||||
a repository that requires that metadata of everything it builds. It does **not** run
|
||||
unelevated here: exit 6, and the account is in neither Administrators nor Performance Log
|
||||
Users. `PresentMonSharedService` is installed and running as LocalSystem and **does not
|
||||
help** — the console starts its own trace session — which answers half of §M6 in the
|
||||
direction nobody expected. The 2.x column set is therefore still unmeasured, and
|
||||
`tools/frametype-oracle.ps1` **has never seen a real PresentMon CSV**: it resolves columns by
|
||||
name, prints the whole `FrameType` vocabulary rather than assuming one, and refuses loudly
|
||||
instead of guessing. Said plainly rather than left for the next reader to assume.
|
||||
|
||||
- **XeFG and FSR3-FG identity is deferred with a written rationale (§H11)**, which is what
|
||||
HANDOFF item 3 asked for instead of a guess. `libxess_fg.dll` and `ffx_fsr3_x64.dll` export
|
||||
nameable entry points; the newer `amd_fidelityfx_framegeneration_dx12.dll` (3.1.5, three
|
||||
installed titles) exports only five generic `ffx*` names, so identity lives in a struct field
|
||||
and hand-declaring a vendor ABI from observation is the #71 defect class with another
|
||||
vendor's name on it. The licence checklist has not been run on either SDK either. **The cost
|
||||
is coverage, not correctness**: such a title reports `FL_FG_UNKNOWN`, never `NONE`.
|
||||
|
||||
- **The ledger now records what five real-title captures actually established, and HANDOFF
|
||||
item 3 is struck because its premise is false.** `slEvaluateFeature(kFeatureDLSS_G)` is
|
||||
never called by Cyberpunk 2077 — 0 across ~14,000 Streamline batches at four
|
||||
frame-generation settings, while frame generation was demonstrably active — so the
|
||||
2026-08-14 owner ruling to count evaluations directly is correct arithmetic on a route the
|
||||
vendor does not use. The counter, its drain, its consumer and its fixtures are all in and
|
||||
gated; there is nothing to count. The open question is no longer "build a counter" but
|
||||
"what is the in-policy producer for DLSS-G on Streamline 2.x", and item 3 now lists the
|
||||
candidate routes without choosing one.
|
||||
- **§H5 is NARROWED, not closed, and the wording is deliberate.** `presents / batch` reads
|
||||
1.000 / 2.000 / 4.000 against the title's own off / ×2 / ×4 (×4 three times), one
|
||||
identified swapchain and 0 gaps in every run — so generated presents ARE visible to a hook
|
||||
on the shared `dxgi.dll` vtable and the count tracks the MULTIPLIER, which a two-point
|
||||
sweep could not have shown. Recorded as still open: case 3 is narrowed rather than
|
||||
answered; **case 2 is made worse** — at ×4 roughly 75% of records carry `syncInterval` /
|
||||
`presentFlags` no application call produced, and the writer claims
|
||||
`FL_MEASURED_PRESENT_ARGS` on all of them; the proxy's denominator is unverified, because a
|
||||
batch equals an application frame only if Ray Reconstruction is evaluated once per frame,
|
||||
which no independent oracle has confirmed.
|
||||
- **`03_METRICS` §Frame Generation and §RT/PT/RR both carry the consequence.** `F_app =
|
||||
Σ fgEvaluations` was written when the counter was expected to have a producer; the section
|
||||
now states that on the measured route it yields zero and that `presents / batch` must not
|
||||
be promoted to `fg_factor` without its premise attached. And RT's per-application-frame
|
||||
quantities — `rt_frame_pct`, `rays_per_pixel`, the 5% gate — are left **without a settled
|
||||
denominator**, which is now the first thing HANDOFF item 4 has to decide rather than
|
||||
something it inherits.
|
||||
- `17_HOOK_ENGINE`'s FG row stays ✅ and says it counts zero on the measured route — built,
|
||||
honest, and yielding nothing is three different facts from unbuilt.
|
||||
- `15_ROADMAP` item 7's ETW comparison is struck as blocked on a producer rather than on
|
||||
tooling, and `spike-notes` §9 — three empty bullets since the file was written, and the
|
||||
section named after this item — carries the five-capture table.
|
||||
- §S30 closed in §S24 with the two defects it produced on the way out: the pre-committed
|
||||
decision table had two holes, and the fix contaminated the census that found it.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **§S30 is ANSWERED, and the answer is that Ray Reconstruction was doing the upscaling all
|
||||
along.** Cyberpunk 2077, 2026-08-15, three 40 s captures: with `DLSS_D = True` the title
|
||||
evaluates `kFeatureDLSS_RR` on every application frame and `kFeatureDLSS` **not once** —
|
||||
2,569 of 2,569 batches, zero DLSS, zero NIS, zero undecoded ids. RR replaces the separate
|
||||
super-resolution pass rather than running beside it, and the decode had no arm for it, so
|
||||
every record reported `UNKNOWN`. **What makes this evidence and not an inference:**
|
||||
`renderW/H` are published only on a frame where an evaluation was seen, and they came back
|
||||
`1485x835` against the title's own `DLSS = Balanced` at `2560x1440` — 0.58 exactly. The
|
||||
scaling-input tag arrives ON the RR evaluation. `FL_UPSCALER_DLSS` and not a new value:
|
||||
layout v3 retired `FL_UPSCALER_RETIRED_RAY_RECONSTRUCTION` precisely because RR is an
|
||||
independent axis, which `FL_FEAT_RAY_RECONSTRUCTION` already carries from the same word.
|
||||
- **The census was measuring its own subject, and the decode fix is what exposed it.**
|
||||
`SlCensus` derived "a super-resolution id arrived" from the DECODED `upscaler` byte, so the
|
||||
correction above made it report 2,569 arrivals of an id that arrived zero times — an
|
||||
instrument that moves when its subject moves cannot be evidence about the subject, which is
|
||||
the only job §S30 gave it. `FL_FEAT_SL_SUPER_RESOLUTION` now carries the RAW fact, set from
|
||||
the drain word and independent of any decode. An enumerator, not a field: no layout bump.
|
||||
It deliberately gets **no OBSERVED companion** against this enum's own convention — all
|
||||
three Streamline facts in the byte are published under one condition, so their companions
|
||||
would be equal bit for bit, and `FL_FEAT_RAY_RECONSTRUCTION_OBSERVED` already carries it.
|
||||
- **`UpscalerOf` read the LAST record, which under frame generation is usually the wrong
|
||||
one.** The writer publishes an identity only on presents that drained an evaluation — one
|
||||
in N — so at ×4 the last record is `UNKNOWN` with probability 3/4, and the report printed
|
||||
"a hook ran and could not identify it" three lines below its own raw block printing
|
||||
`upscaler=Dlss on 2561 record(s)`. Now scans for any record naming a technology, exactly as
|
||||
`FgModeOf` already did, and for the same reason.
|
||||
- Two `SlCensusTests` fixtures went red on the raw-fact change and were **right to**: they set
|
||||
a decoded `Dlss` without the raw bit, which is a state no writer produces. Corrected, and a
|
||||
new case pins the discrimination directly — a record with `upscaler == Dlss` and no raw
|
||||
super-resolution fact is the RR-decoded shape and must NOT count as an arrival of
|
||||
`kFeatureDLSS`.
|
||||
|
||||
### Added
|
||||
|
||||
- **The FG factor gets a consumer, and most of it is the refusals.** `FgWindow` takes
|
||||
`F_disp` and `F_app` from **one record set** — every drained record in one QPC span, not
|
||||
the dominant stream — because `g_slSeen` is one process-wide word drained by whichever
|
||||
present arrives first, so an evaluation belonging to the game's frame can be consumed by
|
||||
a UI swapchain's present. Summing the denominator over one stream while counting presents
|
||||
over all of them overstates the factor with no diagnostic. Five refusals, each a number
|
||||
this consumer would otherwise have printed as a measurement: nothing counted (a data gap,
|
||||
never 1.0); a saturated 255 (a sentinel, not a floor to divide by); a record with
|
||||
`swapchainId 0`; more than one stream in the span; and **the frame-generation state
|
||||
changing during the session**.
|
||||
- **That last one was found by an adversarial review of the design, before any of this was
|
||||
written, and it produces a number above the physically achievable one.** Half a session at
|
||||
×4 and half with FG off gives a whole-window factor of 8 from an ×4 configuration, and
|
||||
`NativeFps` inherits the whole error — while every other guard stays silent, because the
|
||||
count is not zero, the factor is not 1.0 and it is not below 1.0. `03_METRICS:133` already
|
||||
forbids this for upscaling ("averaging across a settings change is the classic way
|
||||
benchmark numbers become meaningless") and lists `fg_mode` as a **segment** column. The
|
||||
window is now split into eight buckets and any bucket whose factor departs from the whole
|
||||
refuses the lot.
|
||||
- **`evaluations/batch`, the premise check that needs no oracle.** HANDOFF item 3 rests on
|
||||
`slEvaluateFeature(kFeatureDLSS_G)` firing **once** per application frame, and nothing in
|
||||
this repository had verified it. The quotient of the two ratios a run can compute —
|
||||
`(presents/batches) ÷ (presents/Σ)` — reduces to `Σ/batches`, and it is the ONLY check
|
||||
that catches the k-per-frame case: three evaluations per frame at ×4 yields a factor of
|
||||
1.34, which is above 1.0 so an over-counting guard is silent, is not 1.0 so a
|
||||
structurally-1.0 guard is silent, and still **moves with the setting** so a three-point
|
||||
sweep passes too. Batches come from `FL_FEAT_RAY_RECONSTRUCTION_OBSERVED`, which the
|
||||
writer sets under `seen != 0` and nothing else — an exact indicator, unlike the params bit
|
||||
whose extra tag-validity conjunct makes the ledger's 4.0134 an upper bound.
|
||||
- **`NativeFps` is counted, not derived.** `Σ / seconds`, not `DisplayedFps / factor`.
|
||||
Derived, the rule-6 trio is internally consistent by construction and a reader can
|
||||
conclude nothing from that consistency; computed separately, `Native × Factor ≈ Displayed`
|
||||
is a property a test checks — to within exactly one frame, because Displayed counts
|
||||
intervals and Native counts records, and that difference is asserted rather than rounded
|
||||
away. The renderer now prints all three off **one** window or prints one labelled number
|
||||
and the reason, which is the half of rule 6 that had no test at all.
|
||||
- **`SlCensus` — §S30's "print them first", built rather than promised.** Per record, which
|
||||
of the five Streamline feature classes arrived, including the undecoded one, which is only
|
||||
separable because of the `FL_FEAT_SL_UNDECODED` bit added in the previous commit. It names
|
||||
the §S30 shape directly: batches that generated frames carrying **no** super-resolution id.
|
||||
- **The O1–O5 decision table is committed to `20_OPEN_QUESTIONS` §S30 BEFORE the run.**
|
||||
"Measure, then fix" becomes "fix, then justify" the moment the table is written after the
|
||||
numbers are known, and nobody can tell the two apart afterwards. The table includes the
|
||||
falsifier for its own independent oracle: if `fl-baseline-probe` reports `nvngx_dlssg.dll`
|
||||
LOADED with multi-frame generation off, it is not an oracle for FG engagement and must be
|
||||
retired in the same `spike-notes` row rather than quietly relied on.
|
||||
- **A factor of exactly 1.0 is NOT reported as §H5 case 3.** Three causes produce it and this
|
||||
data cannot separate them — generated presents never reaching the vtable we patch, FG
|
||||
configured off while the feature is still evaluated, and an evaluation that FAILED and was
|
||||
counted anyway, because `Hook_SlEvaluateFeature` increments before forwarding and ignores
|
||||
the `sl::Result`. The report prints all three. Naming one is how the item gets routed down
|
||||
the wrong branch.
|
||||
|
||||
- **`fgEvaluations` and `fgMode` get a producer, and the count is of EVALUATIONS.**
|
||||
`slEvaluateFeature(kFeatureDLSS_G)` now contributes to a saturating 24-bit count in the
|
||||
high field of the same word the feature bits live in (`fl_sl_seen.h`), consumed by the
|
||||
one `exchange(0)` `RecordPresent` already performed. A bit could not carry it: a bit
|
||||
collapses several evaluations between two presents into one, and under multi-frame
|
||||
generation that is the common case rather than the edge — 10,169 presents carried 2,461
|
||||
Streamline batches on the one real title measured.
|
||||
**The five existing consumers of that word are untouched**, which is why the split was
|
||||
chosen over a second atomic: `seen != 0` still means "an evaluation happened this
|
||||
present" (any evaluation either sets a feature bit or increments the count), and the
|
||||
three bit tests read bits 0-2, which the count cannot reach. Still exactly one
|
||||
read-modify-write per call, on either arm — making the count itself the identity removes
|
||||
the need for a compare-exchange rather than paying for one on a hook path.
|
||||
- **`F_app = Σ fgEvaluations`, not `presents − Σ fgEvaluations`** (owner ruling
|
||||
2026-08-14), swept across `03_METRICS` §Frame Generation and its export table,
|
||||
`fl_shm.h`'s field and mask comments, `fl_hook_inventory.h`'s module-scoping rationale
|
||||
and `17_HOOK_ENGINE`'s FG row. The subtraction needs a count of *generated* frames, and
|
||||
nothing can produce that in policy: the evaluation fires once per **application** frame
|
||||
and yields N−1 generated ones, where N lives in `sl::DLSSGOptions` — set out of band
|
||||
through `slDLSSGSetOptions`, the route HANDOFF §2b refused on five grounds. The two
|
||||
forms are not interchangeable: on the one real title measured they differ by ×4.
|
||||
`native_or_generated`'s polarity inverts with it, and the per-frame classification is
|
||||
now documented as exact in aggregate and accurate to one frame per record.
|
||||
- **`FL_FEAT_SL_UNDECODED` + its OBSERVED companion**, so §S30 can be answered rather than
|
||||
guessed at. Once frame generation leaves the feature bitmask, a present carrying
|
||||
`kFeatureDLSS_G` alongside any id that falls to `FL_SL_SEEN_OTHER` — Reflex, PCL,
|
||||
DeepDVC, Latewarp, DirectSR — is byte-identical to one that carried DLSS-G alone, so a
|
||||
consumer counting "presents that carried an id we cannot decode" would read ZERO on a
|
||||
title evaluating one every application frame. Cyberpunk runs Reflex. A decision table
|
||||
keyed on that bucket would have closed §S30 on a number that could not have been
|
||||
anything else. **Enumerators, not fields**: no struct change, so no
|
||||
`FL_SHM_LAYOUT_VERSION` bump, no `fl-layout-dump` entry, no `ShmLayout.cs` struct edit.
|
||||
- **The CONSUMER half is not in this PR, and a capture will still print "FG state not
|
||||
measured".** `MeasuredFacts.FgMode`, `NativeFps` and `FgFactor` stay hard-null: the
|
||||
arithmetic they need — one record set for both sides of the ratio, a refusal to publish a
|
||||
session-level factor across an FG state change, and the presents-per-batch cross-check —
|
||||
is its own change with its own canaries, and shipping half of it would put a number in
|
||||
front of a reader before the thing that decides whether the number is allowed. So the
|
||||
writer measures and the report is silent, on purpose, for exactly one PR.
|
||||
- **The decode is UNCHANGED, deliberately.** §S30 — a real title decoding every
|
||||
params-carrying record as `UNKNOWN` while running DLSS — is not fixed here. HANDOFF
|
||||
forbids by name changing the decode before the ids that actually arrive have been
|
||||
printed, because that turns a wrong answer into a confident wrong answer. This PR builds
|
||||
the instrument.
|
||||
- **`--hold-presenting-fg` and `--presents-per-eval`**, the first fixture in the tree where
|
||||
presents ≠ evaluations. Every other injected fixture evaluates once per present, so a
|
||||
writer counting evaluations and a writer counting presents are indistinguishable in all
|
||||
of them — every ratio is 1. It also passes the scaling-input extent as a **local** tag
|
||||
through `slEvaluateFeature`'s own `inputs` and never calls `slSetTag`, which closes a
|
||||
coverage hole this PR would otherwise have widened: `FindScalingInputExtent` has one
|
||||
production call site, inside the detour, and nothing reached it — every test called the
|
||||
header directly and every fixture passed `inputs = nullptr`. Frame generation now takes a
|
||||
different decode arm, so "the arm must fall through to the walk" became a property
|
||||
somebody could reasonably tidy away.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **Four session calculators asked a question no session could answer yes to.** `UpscalerOf`,
|
||||
`RayTracingOf`, `HdrOf` and `RayReconstructionOf` each gated on `stream.All(... bit ...)`,
|
||||
and feature hooks install lazily from the 1 Hz watchdog — so the opening of every session
|
||||
predates them. Measured on Cyberpunk 2077: **292 of 10,169 records carry no `Upscaler`
|
||||
bit**, and the consumer therefore reported *"no upscaler hook ran"* about a session in
|
||||
which the hook was live for 97% of the presents. `Program.cs` had already grown a per-bit
|
||||
record count to explain that in prose. The three hook-liveness axes now aggregate over the
|
||||
maximal claiming **suffix**, and the boundary must be **clean** — a bit that goes on, off
|
||||
and on again is a writer contradicting itself, and its trailing run must not be averaged as
|
||||
though it were a whole session, which is the same defect reached from the other side.
|
||||
- **`RayReconstructionOf` is deliberately NOT in that sweep, and the reason is now in the
|
||||
code.** It looks identical and is not: the other three gate on a *hook-liveness* bit, which
|
||||
is monotonic, while this one gates on a *per-present observation* (`seen != 0`), which under
|
||||
frame generation is intermittent by construction — one Streamline batch spans ~4 presents on
|
||||
the Cyberpunk stream, so the maximal claiming suffix is ONE record and feeding it to the
|
||||
`Any` below would publish a whole-session Yes/No from a single frame. Worse than the `N/A`
|
||||
it returns today. Fixing it needs the application-frame unit HANDOFF item 3 introduces.
|
||||
- **`guard_test.cpp`'s honesty assertion was a hardcoded equality where the managed twin was a
|
||||
derived subset test.** It compared `measuredMask` against the constant
|
||||
`FL_MEASURED_OUTPUT_RES | FL_MEASURED_PRESENT_ARGS` with `!=` — right while the Overlay
|
||||
hooked only presents, and a statement about **one build** rather than about honesty. It is
|
||||
now derived from `hooksInstalledMask` the way `MeasuredFacts.EntitledBy` is, as a subset
|
||||
test, plus the value-without-bit conjuncts. Left as an equality it would have gone **red on
|
||||
a correct writer** the moment any feature bit is per-frame rather than per-session:
|
||||
`FL_MEASURED_UPSCALER_PARAMS` is gated on `seen != 0`, so under frame generation three
|
||||
records in four legitimately lack it. **The derived form is paired with an equality on
|
||||
`hooksInstalledMask` itself** — without it a writer that installed everything would be
|
||||
"honest" about any claim and the loop would pass while proving nothing.
|
||||
Both sides gained two conjuncts they were missing: `fgEvaluations` with `FG_COUNTS` clear,
|
||||
and `featureFlags` on a writer not entitled to claim an upscaler.
|
||||
**Two copies of one contract with nothing gating their agreement** — the struct mirror has
|
||||
`fl-layout-dump`; this does not. Stated in both files rather than left to be discovered.
|
||||
- **`slSetTag` shipped on 2026-08-15 with no row in `17_HOOK_ENGINE` §Hook inventory**, whose
|
||||
own first line says anything not on the list is not allowed to exist and which NFR-11 makes
|
||||
the enumeration of the hook set. `hookinventory-check` never reads that file — it checks
|
||||
`FL_HOOK_INVENTORY` against `vendor-exports.json` — so a shipped hook missing from the doc
|
||||
is invisible to every gate in the tree. Row added; the banner above it said **three** rows
|
||||
were built when the answer was five, and said a present-only writer's `measuredMask` is what
|
||||
the record carries, which stopped being true at item 2.
|
||||
- **The removed `presentdelta` rung outlived its removal in two more places.**
|
||||
`03_METRICS` retired `GetFrameStatistics().PresentCount` on 2026-08-05 as *structurally*
|
||||
zero rather than unreliable, and `17_HOOK_ENGINE` forbids re-adding it — but
|
||||
`05_DETECTION`'s FG row and `06_DATA_MODEL`'s `fg_source` enum both still named it. Both
|
||||
corrected, with the reasoning kept where a reader of either would need it.
|
||||
- **`sessions.fg_mode` defaulted to `'none'`**, reinstating at the storage layer the exact
|
||||
affirmative negative the writer and the consumer both refuse — `none` is the one FG state
|
||||
`03_METRICS` allows to be aggregated as a negative. Now `'na'`, matching the four tri-state
|
||||
columns beside it. And `frame_blobs.rt_flags` named its third bit `rtPsoAlive`, a name
|
||||
`fl_shm.h` renamed away because the bit **latches**: creation is observed at
|
||||
`CreateStateObject`, destruction is COM `Release`, which is not in the hook inventory and
|
||||
must not be added, so "alive" claimed a present-tense fact the hook set cannot retract.
|
||||
`06_DATA_MODEL:133` records that the schema is free to edit exactly once, before P2 writes
|
||||
`0001_init.sql`; after that these are migrations.
|
||||
|
||||
@@ -0,0 +1,994 @@
|
||||
<!-- Moved verbatim from CHANGELOG.md on 2026-10-19 (beta.24, owner decision D66): part 4 of 5 of the ledger kept before the first tag, newest first. CHANGELOG.md lists every part. -->
|
||||
|
||||
## Ledger before 0.1.0-beta.1 (continued, part 4 of 5)
|
||||
|
||||
### Added
|
||||
|
||||
- **`capture` can be bounded, because a real-title measurement otherwise could not end.**
|
||||
`CaptureLoop` honoured `CaptureOptions.MaxDuration` and tests covered it — **nothing could
|
||||
set it**, so `capture` against a running game ran until the game was closed, and the report
|
||||
only prints at the end. `--seconds <n>` is a **duration bound, not a safety bypass**: the
|
||||
options this host refuses (`--pid`, `--payload`, `--force`, `--yes`) each widen *what* is
|
||||
injected or skip a check, while this only shortens an already-consented, already-guarded
|
||||
session. A non-positive or non-numeric value is an **error, never a silent 0** — 0 means
|
||||
*unbounded*, so leniency would produce the opposite of what the operator asked for.
|
||||
`TheAcceptedOptionsAreExactlyThese` went red, which is the gate working.
|
||||
- **The session report could not tell "no hook ran" from "the hook came up late".** Both
|
||||
produce N/A and the same wording, and against Cyberpunk 2077 it said *"no upscaler hook
|
||||
ran"* while the hook was live for 97% of a 10,169-present session — feature hooks install
|
||||
lazily on a 1 Hz watchdog, and the consumer requires the bit on *every* record. The host now
|
||||
prints `hooksInstalledMask`, `apiMask`, `rtTier`, the per-bit record counts, and the modal
|
||||
raw `renderW/H` / `quality` / `upscaler`, so a partial count reads as *came up mid-session*
|
||||
and a verification run can be checked against the game's own settings file.
|
||||
|
||||
- **`upscalerQuality` gets a real preset, and `sl_dlss.h` is vendored with its consumer** —
|
||||
the last piece of `docs/HANDOFF.md` item 2b that could be built. The same bounded `inputs`
|
||||
walk now also matches `sl::DLSSOptions` and reads `mode`.
|
||||
- **Vendored the way the process requires, not approximately.** Upstream
|
||||
`NVIDIA-RTX/Streamline@main`, 8,489 bytes, **CRLF preserved**,
|
||||
`git hash-object 3aac47be62c9322aef119b88926602d37655d3ed`. Its include closure is
|
||||
**empty** — verified on the upstream file — so it adds no other header. None of
|
||||
`18_GPU_VENDOR_APIS` §Checklist step 2's four needles appear in it, so step 1 applies and
|
||||
step 3 is unreachable. Notices, the vendoring README and `17_HOOK_ENGINE` are corrected in
|
||||
the same commit: nine headers → ten.
|
||||
- **`DLSSMode::eOff` is 0, and `upscalerQuality` reserves 0 for "nobody looked."** Storing
|
||||
the vendor enum verbatim would make *"the title turned DLSS off"* and *"no hook ran"* the
|
||||
same byte — and 0 decodes as NGX MaxPerf, i.e. it would publish **"DLSS Performance"** as
|
||||
a measurement. `QualityFromMode` maps `eOff` and anything at or beyond `eCount` to `0xFF`.
|
||||
**Exactly the collision `D3D12_RAYTRACING_TIER_NOT_SUPPORTED` had against `rtTier`**, in a
|
||||
different vendor's enum, resolved the same way: at the writer, while the two are still
|
||||
distinguishable.
|
||||
- Asserted **exhaustively** rather than by example: no `DLSSMode` value, in range or out,
|
||||
may map to 0. A single mapping mistake publishes a wrong preset rather than an absence.
|
||||
- The walk no longer returns on its first hit. Extent and quality arrive in **different**
|
||||
structures and a title may chain them in either order, so an early return made quality
|
||||
depend on chain order — a property of the title, not of what it is doing.
|
||||
|
||||
|
||||
- **The LOCAL tags too — `slEvaluateFeature`'s `inputs` walk, hardened against input a title
|
||||
should never send.** `sl_core_api.h:258` is explicit that buffer tags passed to
|
||||
`slEvaluateFeature` are *"local"* and *"do NOT interact with same tags sent in the global
|
||||
scope using slSetTag API"*. The two are alternative integration styles, not layers, so a
|
||||
locally-tagging title yields nothing from the `slSetTag` hook and vice versa. Both are now
|
||||
read; the local one wins when present, because it is scoped to the evaluation rather than to
|
||||
the viewport and cannot be older than the frame being measured.
|
||||
- **In a header, `fl_sl_inputs.h`, precisely so it can be tested without a game.** Every
|
||||
branch dereferences caller-supplied pointers, and a fault lands in `FL_HOOK_GUARD` and
|
||||
burns one of the three that self-disable the Overlay — so a malformed input that faults is
|
||||
a **bug**, not degradation. `ctest fl_sl_inputs` drives 12 shapes in microseconds: null
|
||||
array, zero count, null element mid-array, wrong buffer type, wrong struct GUID,
|
||||
`structVersion` below `kStructVersion1`, whole-resource extent, a tag reached through
|
||||
`next`, a **self-referential** `next`, a **two-node cycle**, and a `numInputs` of
|
||||
`0xFFFFFFFF`.
|
||||
- **The cycle handling is the depth cap, and that is deliberate**: a visited-set would
|
||||
allocate, which a hook path may not. A cycle is worse than a fault — no exception, no
|
||||
self-disable, just a frozen game with our DLL in it.
|
||||
- **What the input cap does not buy, stated rather than implied.** It turns
|
||||
`numInputs = 4 billion` into 32 reads. It does **not** protect against a count of 5 with a
|
||||
2-element array: nothing in the ABI carries the allocation's length, so that direction is
|
||||
unprotectable from here. Same for a struct whose GUID matches but whose allocation is
|
||||
short. Both are the vendor's contract to keep, and both are written down.
|
||||
|
||||
- **`FL_MEASURED_UPSCALER_PARAMS` gets its first producer: render resolution, from the global
|
||||
resource tags** — `docs/HANDOFF.md` item 2b, and one of the five values P0 exit criterion 1
|
||||
names. A second inventory row detours `sl.interposer.dll!slSetTag`, reads the
|
||||
`kBufferTypeScalingInputColor` extent, and publishes `renderW/H`.
|
||||
- **`slSetTag` was scheduled for deferral and is included instead**, on measured grounds:
|
||||
`sl_core_api.h` documents the local tags in `slEvaluateFeature`'s `inputs` as merely
|
||||
*allowed* — *"they do NOT interact with same tags sent in the global scope"* — and only
|
||||
**four of the ten** Streamline titles installed here route DLSS super-resolution through
|
||||
Streamline at all. An inputs-only producer could have shipped with a hit rate of zero.
|
||||
- **The installer had to be restructured first, and it was a latent mis-bind.** The
|
||||
expansion over `FL_HOOK_INVENTORY` ignored the `family` column, stopped at the first row
|
||||
that resolved, and hooked it with `Hook_SlEvaluateFeature`. Correct with one row; with two
|
||||
it would have detoured `slSetTag` with a body that reads argument 1 as a feature id. Each
|
||||
row now carries its own detour, family bit and latch, and a row whose family has no detour
|
||||
installs **nothing** rather than borrowing a neighbour's. The install-after-stop guard is
|
||||
factored out of the single installer for the same reason.
|
||||
- **Two conditions to publish, and the second is the one that is easy to drop:** the params
|
||||
hook live, **and** an evaluation seen *this frame*. A tag is viewport state that outlives a
|
||||
frame, so publishing on the tag alone would report a render resolution for every frame
|
||||
after a title stopped upscaling — stale state dressed as a measurement.
|
||||
- `upscalerQuality` is **`0xFF`, never 0** — 0 is NGX MaxPerf, a real preset, so it would
|
||||
publish "DLSS Performance" as a measurement. `upscalerSharpness` is `0xFF` **permanently**:
|
||||
`DLSSOptions::sharpness` is deprecated as unsupported and `optimalSharpness` is
|
||||
Streamline's recommendation, not what the title applied.
|
||||
- **`claimedParams == 0` is inverted, not deleted** — that was the honest assertion while
|
||||
`renderW/H` had no source, and it is the line a reviewer should see change. It now asserts
|
||||
the **exact** tagged extent, the honesty invariant on every claiming record, and the
|
||||
reverse direction (a value set while the bit is clear).
|
||||
- Two fixture bugs the test found rather than reasoning: tagging **once** at startup landed
|
||||
before injection and left the bit set on **0 of 43** records — and `eValidUntilPresent`
|
||||
means a real title re-tags every frame anyway, so tagging once was simply wrong about the
|
||||
vendor contract. And a floor of `> size - 3` hid a real 6-record window where identity was
|
||||
live and params was not; the drain now waits for **both** families and asserts equality.
|
||||
- Proved red by canary: hardcoding a plausible 1920×1080 trips `wrongExtent` on all 40
|
||||
records, and it compiles.
|
||||
- No `#pragma warning` for C4996 on the deprecated `slSetTag`, and that is measured:
|
||||
`/std:c++20` **without** `/Zc:__cplusplus` makes MSVC report `199711L`, so the
|
||||
`#if __cplusplus >= 201402L` guard on the attribute never opens. A pragma would suppress a
|
||||
warning that is not emitted. The condition that would change it is recorded at the
|
||||
declaration.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **The Overlay would hook a Streamline module of the wrong generation, and read its
|
||||
arguments through the wrong signature.** The inventory scopes `slEvaluateFeature` to
|
||||
`sl.interposer.dll` — correct, and not enough. **The Witcher 3 ships that module at
|
||||
1.5.6**, a different API generation: it exports `slInit`, `slEvaluateFeature`, `slSetTag`
|
||||
and `slShutdown` so every name check passes, plus `slGetHooks`, `slIsFeatureEnabled` and
|
||||
`slSetFeatureConstants` which Streamline 2 does not have, and **none** of
|
||||
`slSetD3DDevice` / `slIsFeatureLoaded` / `slGetNewFrameToken`.
|
||||
- **The name survived the version bump and the signature did not**, which is why no gate
|
||||
saw it. `docs/vendor-exports.json` records one copy per module *name*, so
|
||||
`hookinventory-check` Pass A resolves against one machine's 2.7.4 and says nothing about
|
||||
a 1.5.6 in a game. A detour typed with SL2's `PFun_slEvaluateFeature`, called with SL1's
|
||||
argument list, reads argument 1 as a feature id when it is not one — a **wrong upscaler
|
||||
name**, not a crash, which `17_HOOK_ENGINE` calls the highest false-confidence risk in
|
||||
the spike.
|
||||
- `ResolveScoped` now refuses a `sl.interposer.dll` that does not export the three
|
||||
SL2-only entry points. No hook is installed, `FL_HOOK_UPSCALER_IDENTITY` is never
|
||||
published, and the record says `FL_UPSCALER_NOT_REPORTED` — true, rather than a guess.
|
||||
- **Scoped to the interposer by name, and the first version got that wrong.** Those three
|
||||
are *interposer* exports; a real `sl.common.dll` is a plugin and exports none of them, so
|
||||
an `sl.*` prefix test refused modules whose generation it had no business judging. The
|
||||
existing decoy fixture caught it.
|
||||
- New fixture `stub_sl_interposer_v1.cpp` — right module name, right symbol name, SL1 ABI —
|
||||
and `ctest fl_sl_abi_guard`. It is the complement of the decoy: scoping catches a wrong
|
||||
module *name*, and cannot see a wrong *signature*. Its own ctest and its own process,
|
||||
because both fixtures are called `sl.interposer.dll` and `GetModuleHandleExW` resolves by
|
||||
name, so sharing one would have the two silently test each other.
|
||||
- Proved red by canary: neutering the check leaves exactly one assertion failing, and it
|
||||
compiles, so it is a canary rather than a build failure wearing one.
|
||||
- The SL2 stub gains the three markers, so it honestly looks like the generation it stands
|
||||
in for. Found because the guard correctly refused it otherwise.
|
||||
|
||||
### Added
|
||||
|
||||
- **`FlWriterState.rtTier` gets a producer, and the vendor enum it copies had a collision in
|
||||
it** — `docs/HANDOFF.md` queue item 4, the one conjunct that needs no hook. `ResolveApi`
|
||||
already obtained an `ID3D12Device*` on the first present of a D3D12 swapchain and released
|
||||
it three lines later without asking it anything; it now asks
|
||||
`CheckFeatureSupport(D3D12_FEATURE_D3D12_OPTIONS5)` first. No hook, no MinHook, no vtable —
|
||||
a capability query on a device DXGI handed us for a swapchain we were called on.
|
||||
- **`D3D12_RAYTRACING_TIER_NOT_SUPPORTED` is 0, and `rtTier`'s 0 already meant NOT
|
||||
QUERIED.** Storing the enum verbatim — the obvious implementation, and the one
|
||||
`fl_shm.h`'s own field comment described — would have published "nobody looked" about
|
||||
every non-RT device: the affirmative-negative collision layout v3 exists to prevent,
|
||||
reached by copying a vendor enum rather than by a guess. New `FlRtTier` carries three
|
||||
states: `NOT_QUERIED = 0`, `UNSUPPORTED = 1`, and the D3D12 value verbatim otherwise.
|
||||
- **Measured against the Windows SDK header rather than remembered:** `NOT_SUPPORTED = 0`,
|
||||
`TIER_1_0 = 10`, `TIER_1_1 = 11`, **`TIER_1_2 = 12`** — the enum is already "tier ×10", so
|
||||
nothing multiplies it and nothing names the individual tiers. A tier newer than the SDK
|
||||
this was built against arrives intact instead of being clamped to what the build knew.
|
||||
- **Both directions are asserted, in `ctest fl_guard`.** The D3D12 case asserts the field
|
||||
holds a legal `FlRtTier` value; the D3D11 case asserts it is exactly `NOT_QUERIED`,
|
||||
because a writer that stored `UNSUPPORTED` unconditionally would pass the first on its
|
||||
own. What the D3D12 case does **not** assert is *which* tier: the fixture's device is
|
||||
WARP, and whether WARP supports DXR is the open question `HANDOFF` item 4 says to check
|
||||
rather than assume — so the value is `CAPTURE`d and the test records the answer instead
|
||||
of depending on it.
|
||||
- **It does not make RT reachable yet, and the consumer comment now says so precisely.**
|
||||
`MeasuredFacts.RayTracingOf`'s two conjuncts both have producers now, but
|
||||
`FL_MEASURED_RT` still has none, so RT is `N/A` on every session. The gap moved; it did
|
||||
not close.
|
||||
- **`hookinventory-check` grows a third pass, over the one failure the other two cannot
|
||||
see** — and the document that already claimed this pass existed is corrected in the same
|
||||
commit. Passes A and B are source checks: they see what the Overlay *resolves*. Neither
|
||||
sees what it *links*. Taking the address of an `SL_API` declaration in evaluated code makes
|
||||
`sl.interposer.dll` a **load-time dependency** of `FrameLedger.Overlay.dll`, which then
|
||||
fails to load in every game that ships no Streamline — in the loader, before `DllMain`,
|
||||
with no message anywhere. **Pass C reads the binary's own dependency list** and fails on
|
||||
`^(sl\.|_?nvngx|libxess|ffx_|amd_fidelityfx)`.
|
||||
- **`src/native/third_party/streamline/README.md` had asserted this gate since
|
||||
2026-08-09.** It did not exist: the script's only mention of `dumpbin` was a comment
|
||||
about a different tool. Found by an audit that went looking for the code instead of
|
||||
trusting the sentence — the shape this project keeps hitting, and worse here because the
|
||||
failure Pass C catches has no symptom to notice.
|
||||
- **It refuses rather than passes whenever it cannot look.** A zero-length import list is a
|
||||
failure, not a clean result — every way that parse can break produces the same empty list
|
||||
as a binary with no vendor imports. The list must also contain `kernel32.dll` before any
|
||||
verdict is formed, the same discrimination rule the oracle probe already follows.
|
||||
- **It runs only under `-RequireBinaries`.** The first version read whatever binary was in
|
||||
the build tree, so `check -SkipNative` printed a skip line *and* ran the pass anyway,
|
||||
against an artefact the run did not produce. Reporting on the wrong binary is worse than
|
||||
saying nothing.
|
||||
- Proven on real PEs as well as fixtures: out of `AlanWake2.exe`'s 47 imports and
|
||||
`Cyberpunk2077.exe`'s 36, it names exactly `sl.interposer.dll` and — for Cyberpunk —
|
||||
`libxess.dll`, `libxess_fg.dll`, `ffx_fsr3_x64.dll`, `ffx_backend_dx12_x64.dll`, and
|
||||
nothing else. Self-test is 17 cases, both directions, including that the match is
|
||||
anchored so an innocent name merely *containing* a vendor prefix passes.
|
||||
- Pass B's stray-literal sweep gains `xefg[A-Z]`, which `xess[A-Z]` does not cover:
|
||||
`libxess_fg.dll`'s 31 measured exports include 28 `xefgSwapChain*` names and no `xess*`
|
||||
name at all. Widened before the FG hooks land rather than after.
|
||||
- **§H5 case 3 gets an answer, and a second finding cost a crash to get** —
|
||||
`fl-probe-interposer` reported INCONCLUSIVE because it never called `slInit`, blaming a
|
||||
licence question over `sl::Preferences`. #64 vendored Streamline under MIT and removed that
|
||||
blocker; the probe now runs the sequence a real title runs — `slInit` →
|
||||
`D3D12CreateDevice` **through the interposer** → `slSetD3DDevice` — with every entry point
|
||||
resolved by `GetProcAddress`, never linked.
|
||||
- **MEASURED: the swapchain class is not ours.** With `slInit` returning `eOk`, the
|
||||
interposer hands back a swapchain whose vtable sits inside `sl.interposer.dll` while
|
||||
`dxgi.dll`'s own route yields `dxgi.dll`'s. Reproduced on Alan Wake 2 (SL 2.7.0) and
|
||||
Cyberpunk 2077 (SL 2.7.1). **It does not follow that we miss the present** — §H5's
|
||||
`--probe-proxy` result stands, a forwarding proxy is caught one layer down — and the
|
||||
probe says so rather than converting a premise into a verdict.
|
||||
- **The Witcher 3 ships Streamline 1.5.6, and it crashed the probe.** A different API
|
||||
generation: `slGetHooks`, `slIsFeatureEnabled`, `slSetFeatureConstants`, and **no**
|
||||
`slSetD3DDevice` or `slIsFeatureLoaded`. `slInit` exists in both with a different
|
||||
`sl::Preferences` layout, so the vendored 2.x struct access-violates. Now version-guarded
|
||||
on the SL2-only exports, skipping with a reason.
|
||||
- **That reaches the hook inventory.** `docs/vendor-exports.json` records one copy per
|
||||
module *name*, so its `sl.interposer.dll` is one machine's 2.7.4 and says nothing about a
|
||||
1.5.6 a title ships. Pass A would accept `slEvaluateFeature` against such a title — the
|
||||
name exists in both generations — while the **signature** differs. Today's hook reads
|
||||
only `feature` and is probably unharmed; **item 2b's `inputs`/`numInputs` walk is not**,
|
||||
and needs its own version guard before dereferencing anything.
|
||||
- **The engagement read was a race first.** Plugin load is deferred: the first run reported
|
||||
both features unloaded while Streamline's own log — flushed after ours — showed six
|
||||
plugins verifying. Now polled for the state, bounded by a wall clock.
|
||||
- `ctest fl_vtable_identity_control` (Part 1, the control) is unchanged and still runs on
|
||||
CI; the probe imports `d3d11.dll` and `KERNEL32.dll` only, so linking Streamline could
|
||||
not have broken it.
|
||||
|
||||
- **The upscaler identity hook, and a fixture that can prove a wrong symbol name wrong** —
|
||||
`docs/HANDOFF.md` queue item 2. `FrameLedger.Overlay` gains **module-scoped symbol
|
||||
resolution** (it had none: `GetProcAddress`/`GetModuleHandle` appeared nowhere in the
|
||||
target) and one MinHook detour on `sl.interposer.dll!slEvaluateFeature`, installed
|
||||
lazily by the existing 1 Hz watchdog so a title that loads Streamline at device
|
||||
creation is still caught without a `LoadLibrary` hook — which keeps §S6 separable.
|
||||
- **`FlWriterState.hooksInstalledMask` gets its first producer anywhere in the tree.**
|
||||
It had none — not even `FL_HOOK_PRESENT`, which the present hook was always entitled
|
||||
to — and `MeasuredFacts.RayTracingOf` already said so in its own comment while
|
||||
reaching `N/A` on every session because of it.
|
||||
- **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 `fl_shm.h` allows to be
|
||||
aggregated as a negative. An unrecognised feature id reports `UNKNOWN` — "a hook ran
|
||||
and could not identify what it saw" — which is a state this codebase could not
|
||||
previously produce. A ctest drives a target evaluating `0xF00D` to prove it.
|
||||
- **Ray Reconstruction's OBSERVED bit is gated on having seen an SL evaluation *this
|
||||
frame*, not on the hook being installed.** Found by an adversarial refuter over the
|
||||
design: the consumer returns `Tri.No` when OBSERVED is set on every record and no
|
||||
record carries the fact bit, so a writer setting OBSERVED whenever the hook was live
|
||||
would publish **"Ray Reconstruction: No" on an NGX-direct DLSS-RR title**, which
|
||||
never calls `slEvaluateFeature` at all. The honest-looking choice was the wrong one.
|
||||
- **`FL_MEASURED_UPSCALER_PARAMS` is deliberately unset, and the reason is a licence.**
|
||||
`17_HOOK_ENGINE` recommended hooking `NVSDK_NGX_Parameter_SetUI` for quality and
|
||||
render size; that needs NGX declarations, and the NGX/DLSS SDK is the proprietary
|
||||
**NVIDIA RTX SDKs License** — verified upstream, hitting three of
|
||||
`18_GPU_VENDOR_APIS` §Checklist step 2's four needles — so step 3 forbids vendoring
|
||||
it **and** re-declaring it. The document recommended a path its own rule forbids and
|
||||
nothing had noticed, because no code had gone near it. Corrected in place.
|
||||
- **NVIDIA Streamline MIT headers vendored** at `src/native/third_party/streamline/` —
|
||||
the nine-file include closure of `sl.h`, one atomic commit with the licence copy, the
|
||||
notices row and both of `license-check.ps1`'s arrays. It buys the vendor's own
|
||||
`PFun_slEvaluateFeature`: five parameters, every one integer-class, so **nothing
|
||||
travels in XMM** — the exact residual hazard nobody could rule out while the signature
|
||||
was a guess, and a guess wrong by one argument corrupts the stack *inside the original
|
||||
function*, where `FL_HOOK_GUARD`'s `__try` cannot reach. `sl_nvperf.h` is excluded (the
|
||||
same `license.txt` carries a second, proprietary NSight Perf block naming it) and all
|
||||
of `external/` is excluded (upstream's `external/ngx-sdk` is the RTX licence, so a
|
||||
recursive copy does the forbidden thing by default). `license-check` asserts all three,
|
||||
proven red in four directions. This also answers the question `spike-notes` §5 recorded
|
||||
as open: §H5 case 3 was *"blocked on a licence decision, not on hardware"*, and the
|
||||
decision is taken.
|
||||
- **`tools/hookinventory-check.ps1`** — every vendor symbol the Overlay resolves by name
|
||||
must exist, **in the module it takes it from**, in `docs/vendor-exports.json`. Wired
|
||||
into `build.ps1` in both halves. **Prevention: it fixed nothing**, and its own docstring
|
||||
says so, because a gate whose write-up implies it caught something cannot be audited
|
||||
later. Five red cases proven; the load-bearing one is an **oracle-discrimination
|
||||
canary that runs before any verdict**, since every failure mode of such a lookup
|
||||
produces the same answer as "absent".
|
||||
|
||||
- **The params half is designed and not built**, and the design is in `docs/HANDOFF.md` §2b
|
||||
rather than here, because it is a sequencing decision and not a change. Recorded because the
|
||||
panel **rejected the route the documents make obvious**: hooking `slGetFeatureFunction` and
|
||||
MinHook-patching the returned `slDLSSSetOptions` would need an "indirect" inventory class that
|
||||
is an unconditional escape hatch from `hookinventory-check` (its oracle would be "a `PFun_*`
|
||||
exists in a vendored header", and `sl_core_api.h:63` declares one for a symbol **zero measured
|
||||
modules export**); it would reopen the install-after-stop window; MinHook has no function-length
|
||||
oracle for a runtime-returned address, so a short thunk gets patched into its neighbour inside
|
||||
vendor code where `FL_HOOK_GUARD` cannot reach; `GetModuleHandleExW` in a detour takes the
|
||||
loader lock on the game's thread; and it structurally misses the game's FIRST
|
||||
`slDLSSSetOptions` call, which for a benchmark configured before launch is often the only one.
|
||||
The chosen route extends the hook the Overlay already owns — a bounded walk of
|
||||
`slEvaluateFeature`'s `inputs` chain, which it already receives and ignores.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **A failed `REQUIRE` terminated the whole native test binary, hiding every test after
|
||||
it.** Catch2 compiled itself with `CATCH_CONFIG_DISABLE_EXCEPTIONS`: the top-level
|
||||
CMakeLists strips `/EHsc` from `CMAKE_CXX_FLAGS` deliberately, and `tests/CMakeLists.txt`
|
||||
re-added it **only to the test binaries**, never to the Catch2 library that decides the
|
||||
mode — a comment whose premise was right and whose effect was not. On a box where WARP's
|
||||
D3D12 path is broken this silently removed the end-to-end injection cases from `ctest`,
|
||||
**including the honesty assertion §S29(a) names as the merge gate's coverage**, which
|
||||
passes when run alone. `ctest` reported "1 test failed" where the truth was "and 2 never
|
||||
ran". Recovered **70 test cases and 1051 assertions**.
|
||||
- **`MeasuredFacts.IsHonest` compared `measuredMask` against a hardcoded constant**, which
|
||||
was correct for a present-only writer and became wrong the moment a feature hook landed:
|
||||
an honest record claiming `FL_MEASURED_UPSCALER` counted as a violation. Widening the
|
||||
constant would have made the check a statement about one build rather than about
|
||||
honesty, so entitlement is now **derived from `hooksInstalledMask`** — a writer may
|
||||
claim a measurement only where it installed a hook capable of taking it — plus the
|
||||
reverse direction that was missing, a *value* set while its mask bit is clear.
|
||||
- **`docs/12_BUILD.md` said the NVAPI SDK "is not vendored yet"** and that
|
||||
`src/native/third_party/` held only `CMakeLists.txt` and `vulkan-headers`. Both false
|
||||
since #55. That sentence was itself a correction of the opposite error, so this file has
|
||||
now been wrong in both directions about one fact — `legal/` is gated bidirectionally and
|
||||
caught its own version, `docs/` is not.
|
||||
- **`docs/HANDOFF.md` item 2 named `NVSDK_NGX_EvaluateFeature`, which no measured module
|
||||
exports**, and said four modules where `NVSDK_NGX_D3D12_EvaluateFeature` has **seven**.
|
||||
The argument survived both errors; the data was wrong in the bullet whose subject is
|
||||
that a wrong symbol name degrades silently.
|
||||
|
||||
- **The consent store, and the first production driver of the guard loop** — `docs/HANDOFF.md`
|
||||
queue item 1. `HookedCaptureGate`'s three inputs (`hook_enabled`, `hook_consent_at`,
|
||||
`hook_blocked_reason`) have a real source for the first time, and
|
||||
`FlControlBlock.guardTicks` is now advanced by a **non-test binary**. Both ends of that
|
||||
field existed and were tested since #46/#50; only the loop was missing, and a missing loop
|
||||
reads as a missing subsystem.
|
||||
- **`FrameLedger.CaptureHost` is a separate project that nothing publishes**, and
|
||||
`tools/package-closure-check.ps1` is what keeps that true rather than remembered. §S27 was
|
||||
closed on the strength of there being no injecting entry point on any shipped binary; the
|
||||
host **is** one, so what keeps §S27 closed is its absence from the package. The gate walks
|
||||
the transitive `ProjectReference` closure of the two roots `12_BUILD` publishes and names
|
||||
the edge that reached anything else. **Proven:** a reference from `FrameLedger.Agent` leaves
|
||||
the build green and turns the gate red with `FrameLedger.Agent → FrameLedger.CaptureHost`.
|
||||
Both halves are wired — the self-test (5 cases, 4 RED) **and** the live pass, because a gate
|
||||
wired self-test-only never reads the repository, which is the defect it exists to prevent.
|
||||
- **`HookRequest` can no longer be synthesised, and that is what actually closed the hole.**
|
||||
It was a `record` with `required`/`init` members, so
|
||||
`new HookRequest { HookEnabled = true, ConsentedAt = DateTimeOffset.UtcNow }` passed every
|
||||
check in the gate and reached `GuardedInjectAsync` — **verbatim the expression §S27 named and
|
||||
rejected**. A store, a record and a provenance flag do not close that; they add an honest path
|
||||
beside it. It is now get-only with a private constructor and one factory, so the dishonest
|
||||
path is a compile error rather than a discouraged idiom. Found by a safety refuter over the
|
||||
design, before any of it was built.
|
||||
- **`GameConsentRecord.Stored` is `internal`**, because `FrameLedger.Domain` is inside both
|
||||
publish closures: a public minting factory there would be a blessed, *shipped* API for
|
||||
producing consent nobody gave, and the closure gate cannot see it — it walks project
|
||||
references, and Domain legitimately belongs to both. The `InternalsVisibleTo` list is the
|
||||
reviewable artifact; a test asserts the public factory does not exist.
|
||||
- **An acknowledgement cannot clear a block.** `RecordOperatorAcknowledgementAsync` takes an
|
||||
`OperatorAcknowledgement`, which carries neither `BlockedReason` nor `PreScanUnverified`, so
|
||||
the store's merge is their only source. Taking a whole record — the first shape — meant
|
||||
`consent grant` on a title the pre-scan had blocked would write `BlockedReason = null` and
|
||||
the gate's `PreviouslyBlocked` branch would stop firing: the "I understand, continue anyway"
|
||||
button CLAUDE.md rule 2 forbids, arrived at by omission.
|
||||
- **The pre-scan's third state gets its own field.** `05_DETECTION` makes "could not verify"
|
||||
neither a hit nor a pass, while `hook_blocked_reason` is two-state by definition. It is
|
||||
refused in the loop, never mapped to `PreviouslyBlocked` and never cleared — routing it
|
||||
through the gate would force one of the two collapses that document forbids.
|
||||
- **A consent record carries a disclosure provenance and a wording version**, neither of which
|
||||
`06_DATA_MODEL` has. A bare timestamp cannot say whether anything was disclosed, and
|
||||
`ConsentProvenance.NotRecorded = 0` means a record nobody filled in refuses. **FR-2.1's value
|
||||
is deliberately not declared**: no `.resx` exists anywhere in this tree, `09_I18N` reviews
|
||||
`Safety_*` keys as legal text, and a declared-but-producerless value is the "reads as
|
||||
sanctioned" shape §S29(c) was raised for. The version is carried from the *first* record
|
||||
because it cannot be added later — retrofitting one means treating unversioned consent as
|
||||
either current or stale, and both are wrong about some record.
|
||||
- **The command surface has no `--pid`, `--payload`, `--force`, `--yes` or `--diag`**, and a
|
||||
test pins it. §S27's gap was a user-named pid on a binary with no consent record; resolving
|
||||
the target from the same normalised path the record is keyed on makes "consent for A,
|
||||
injection at B" inexpressible rather than discouraged. Two processes of one image refuse as
|
||||
ambiguous rather than picking one.
|
||||
- **`consent grant` refuses redirected stdin**, so no script can acknowledge on a human's
|
||||
behalf, and the disclosure states in its first line that it is *not* FR-2.1 consent.
|
||||
|
||||
- **Session end has a signal (§S29(e) closed).** A held process handle, opened before the
|
||||
injection and never re-resolved — pids recycle and the ring is named after one.
|
||||
- **It was first closed on a handle that was never held, and the correction is the
|
||||
interesting part.** The first version used `Process.GetProcessById` and read
|
||||
`HasExited`. **Measured** on .NET 10.0.10 by a probe over the live object:
|
||||
`_haveProcessHandle == false` and `_processHandle == null` both after construction and
|
||||
after reading `HasExited` — `GetProcessById` opens nothing and `HasExited` opens a
|
||||
transient handle and releases it in its own `finally`. Three source comments, a ledger
|
||||
entry and a changelog line all asserted the pid was pinned; nothing checked it, and it
|
||||
was not. `Infrastructure.Io.HeldProcessHandle` now opens `SYNCHRONIZE |
|
||||
PROCESS_QUERY_LIMITED_INFORMATION` and keeps the `SafeProcessHandle`, a pid that
|
||||
cannot be opened is a refusal (`TargetCannotBePinned`) rather than a session, and the
|
||||
test asserts the *property* — it answers about a fully exited process at a pid
|
||||
`Process.GetProcessById` will not resolve, which nothing holding a handle-less object
|
||||
can do. The ninth entry for "measure Windows APIs, don't trust them", and the first
|
||||
where the API misled by doing **less** than its name implies.
|
||||
`SessionEndClassifier` takes no elapsed-time parameter, so **a frozen `writeIndex` can never
|
||||
end a session**, which is the whole of the defect: `ShmRingReader` holds the section open, so
|
||||
an exited game leaves `status` `READY` and `writeIndex` frozen, byte-for-byte a loading screen.
|
||||
§S26 made it strictly worse by dropping `DXGI_PRESENT_TEST`, removing the accidental heartbeat
|
||||
an occluded title used to emit. It also separates the two stops the mapping cannot: `StopObserving`
|
||||
stores `FL_STATUS_UNHOOKED` for the safety stop **and** for supervision loss, so only the side
|
||||
that caused one knows which — and `legal/DISCLAIMER.md` §2 discloses them differently.
|
||||
|
||||
- **A throwaway consumer**: `measuredMask` → rule 7 tri-state, segmentation, and the one number a
|
||||
present-only writer may publish. In the unshipped host, deliberately not in
|
||||
`FrameLedger.Domain.Metrics.*` — P2 owns the real calculators and `coverage-gate` carries a
|
||||
separate 95% floor for that namespace.
|
||||
- **Segmentation is stream-first, settings-second**, and reversing it manufactures a segment per
|
||||
present. Two axes exist and neither document mentions the other: `03_METRICS` §Upscaling
|
||||
splits on a settings change, `fl_shm.h` says the Agent "segments by [`swapchainId`] and reports
|
||||
the dominant stream". One vtable patch sees every swapchain in the process, so a title with a
|
||||
UI or video swapchain interleaves two streams in one ring.
|
||||
- **`frameIndex` is process-global, so it cannot detect a gap within a stream.** The first design
|
||||
excluded any interval whose index did not advance by one — which would have excluded *every*
|
||||
interval in any multi-swapchain title and reported no duration at all, including for Displayed
|
||||
FPS. `dllmain.cpp` assigns `g_frameIndex++` four lines before `swapchainId`; the overflow
|
||||
harness interleaves 17, so the dominant stream's indices step by ~17. Found by a feasibility
|
||||
refuter over the design.
|
||||
- Everything unmeasurable is `null` or `N/A` with **no fallback**: `fg_factor` is never `1.0`,
|
||||
`fgMode` is never `"none"`, the upscale ratio is not computed at all (`renderW/H` are 0), and
|
||||
the retired `FlUpscaler` value 2 is never decoded as `dlss_rr` — `03_METRICS` §Upscaling
|
||||
listed it as an upscaler value until this PR, which removes it and records why. The
|
||||
renderer is asserted too: rule 6 is a rule about
|
||||
*showing* a single inflated number, and a test matches the rendered text against `×N`.
|
||||
|
||||
- **`--present-interval-ms` on `hook-harness`**, because one test could not be written without it.
|
||||
The Agent's drop accounting fires when the writer laps the reader — 8192 records — and at the
|
||||
default ~120/s that is **68 seconds** of a reader deliberately not draining, so the branch
|
||||
`04_CAPTURE` calls "the Agent stalled for over ~16 s" had never run against the real Overlay in
|
||||
either language. Measured: uncapped, the harness does **171,636 presents in 3 s**, so the ring
|
||||
laps in well under a second.
|
||||
|
||||
### Changed
|
||||
|
||||
- **`HookedCaptureGate.ShouldUnhookAsync` is deleted (§S29(c) closed).** It was a second in-session
|
||||
re-scan that published no tick and did not latch — the two properties `GuardSupervisor` exists to
|
||||
guarantee — and it was the *more discoverable* of the two, because a drain loop already holds the
|
||||
gate. Its polarity was inverted from the survivor's, too: `true` meant STOP where
|
||||
`ScanOnceAsync`'s `true` means MAY CONTINUE. Deleted rather than routed: it had **zero production
|
||||
callers**, its body was strictly weaker than `ScanOnceAsync`, and routing would have given the
|
||||
gate per-session state on a class whose contract is that it "adds no judgement of its own".
|
||||
- **The two Facts that covered it are replaced by one that is stronger.** They asserted the
|
||||
boolean and never the tick or the latch, so they certified the API as sanctioned while saying
|
||||
nothing about what was wrong with it. `TheGateExposesNoSecondInSessionRescanPath` pins the
|
||||
gate's public instance surface to exactly `{StartAsync}` and is red on unmodified `main`.
|
||||
|
||||
- **`ShmDrainIntegrationTests`' honesty helper is split.** `AssertRecordsAreHonest` mixed
|
||||
fixture-independent invariants with assertions about attach *timing* and a single swapchain, and
|
||||
a fixture that deliberately stalls the reader satisfies neither — reusing it produced a red test
|
||||
whose failure message was about frame indices, indistinguishable from a real regression.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **`ShmRingReader.SetPaused` had no test at all.** Both halves of `pauseRequested` existed —
|
||||
`MayObserve()` has read the flag since #46 — and the managed writer had never been driven in
|
||||
either direction. Now both: a merge-gated round trip proving the byte lands at
|
||||
`ControlOffset + 0` and that `unhookRequested` four bytes away is untouched, plus an integration
|
||||
case proving the Overlay acts on it, **ticking throughout**, because the defect #46 fixed only
|
||||
appeared on frames where `guardTicks` had changed. A pause is invisible in the record stream —
|
||||
`MayObserve()` returns false before `frameIndex` is assigned — which the consumer must not read
|
||||
as one enormous frame time.
|
||||
|
||||
- **`ShmHandshakeValidator` never compared `handshake.Pid`**, so a ring left behind by a finished
|
||||
session, or one under a recycled pid, validated `Ok` on build id, layout and capacity alone.
|
||||
Not an ABI change: `ShmAttachRefusal` is managed-only with no native mirror.
|
||||
|
||||
- `NativeAntiCheatGuard`'s §S21 rationale was attached to `NativeCheckRules` by two stacked
|
||||
`<summary>` blocks while `NativeRulesFilePath`, which it describes, had none.
|
||||
|
||||
### A fifth rate-sized budget, and a correction to what I said about WARP
|
||||
|
||||
`TheGuardInjectsTheOverlayAndTheReaderDrainsRealFrames` — pre-existing, from #51 — drained for a
|
||||
fixed twelve iterations and then asserted a floor sized on "the harness presents at ~120/s". It waits
|
||||
for the record count now, bounded by a wall clock, and gained an assertion that the loop supervised
|
||||
more than once so the shortened path cannot pass vacuously. **This is explicitly not presented as the
|
||||
fix for the one failure observed**: it failed once in twelve runs with its message uncaptured, and
|
||||
after #62 — two rounds of the wrong remedy — the rule is that a defect class is a hypothesis about
|
||||
the next failure, not a diagnosis of it. The budget was removed because that is defensible on its own
|
||||
terms. Ten consecutive full runs clean.
|
||||
|
||||
**And the WARP note in `HANDOFF` §Traps said "a reboot clears it", which is false.** That sentence was
|
||||
written on plausibility and never tested. The machine rebooted at 13:58 and the identical failure
|
||||
reproduced at 14:17. Measured properly this time: `D3D12CreateDevice` on the WARP adapter returns
|
||||
`DXGI_ERROR_DRIVER_INTERNAL_ERROR` at **every** valid feature level, while `D3D11CreateDevice` on the
|
||||
**same adapter object** succeeds at FL 11_0 and D3D12 on the RTX 5080 succeeds; `d3d10warp.dll`,
|
||||
`d3d12.dll` and `D3D12Core.dll` all match the OS build (Windows 11 Insider 26300/29639), so nothing is
|
||||
corrupt. It reads as an Insider-build regression in WARP's D3D12 path and it is persistent. CI is not
|
||||
an Insider build and passes the same suite, so `main` is unaffected — but the native suite has a hard
|
||||
dependency on WARP D3D12 that a dev box can lose on its own, which is now written down.
|
||||
|
||||
### A fourth failure that was not a race at all — an off-by-one wearing a flake's costume
|
||||
|
||||
`APausedSessionStopsRecordingAndResumesWhereItLeftOff` failed roughly one run in five, which is
|
||||
exactly what the three fixed above looked like. It was **`EstablishRecordingAsync`'s loop bound and
|
||||
its assertion disagreeing by one**: the loop ran while `seen < 10` and so exited at *exactly* 10,
|
||||
and the assertion demanded `> 10`. It passed only when a single drain happened to bring in eleven or
|
||||
more at once — so the timing decided whether the off-by-one was visible, and two rounds of budget
|
||||
tuning made it rarer without touching it. One constant now serves both.
|
||||
|
||||
**The lesson is the diagnosis, not the fix.** Having just repaired three genuine races, the fourth
|
||||
failure in the same file was assumed to be a fourth race, and it was treated with the remedy for the
|
||||
previous three. What settled it was reading the failure message instead of the pattern: *"Expected
|
||||
seen to be greater than 10 … but found 10"* names the defect exactly and took one run to obtain.
|
||||
|
||||
Swept alongside it, since the class was the thing under review: the pause test now waits for the
|
||||
writer to **settle** — two reads 100 ms apart with nothing between them — rather than assuming a
|
||||
fixed 250 ms covers a present already in flight, and it keeps ticking throughout, because the pause
|
||||
path is only reachable on a frame where `guardTicks` changed (the defect #46 fixed, and the reason
|
||||
this test exists). The resume-drain budget goes 1 s → 3 s for the contention reason.
|
||||
|
||||
Ten consecutive full runs clean afterwards.
|
||||
|
||||
### Three racy assertions that #60 merged, caught by the post-merge run
|
||||
|
||||
`docs/HANDOFF.md` says to run `./build.ps1 check` with no switches **after** every PR. This is what
|
||||
that found, and all three are the same shape: an assertion that reads a state once, at a moment when
|
||||
the state is legitimately still in transit.
|
||||
|
||||
- **`Status == Ready` read immediately after the first guard tick.** `InitThread` publishes
|
||||
`layoutVersion` at step 2 and sets `READY` at step 6 — after `InstallPresentHooks` creates a
|
||||
throwaway WARP device, tens of milliseconds. `TryAttach` succeeds as soon as `layoutVersion` lands
|
||||
and the host publishes its first tick immediately **by design**, because the Overlay's 65 s
|
||||
supervision clock starts at mapping publish. A tick and `INIT` are therefore a legitimate
|
||||
simultaneous state. Polled now, with `INIT` past the budget still failing — that is
|
||||
`WriterNeverInstalledHooks` and must not read as a passing session.
|
||||
- **`ApiMask` asserted as soon as `Status` became `Ready`.** "Hooked and recording" is two events:
|
||||
`apiMask` is set inside `FindOrAdd`, on the first present the hook actually *sees*, so `READY` with
|
||||
`apiMask == 0` is another legitimate window. Failed once in five full-suite runs and never once in
|
||||
six isolated ones — the signature of a window widened by contention.
|
||||
- **QPC ascending asserted across a deliberate lap, and it is unassertable in EITHER direction.**
|
||||
Measured both ways: under the full suite the drop test's first drained record came back ~148 ms
|
||||
*later* than the second; run alone the same batch was perfectly ascending. `Drain` resumes at
|
||||
`writeIndex - capacity`, the oldest survivor, and whether the writer has overwritten that slot when
|
||||
the copy arrives is a race decided in microseconds — the seqlock catches a tear *during* a copy, not
|
||||
a slot cleanly overwritten *before* it. Ascending qpc is a property of a reader that **kept up**, so
|
||||
it now lives only with the other attach-timing assertions. What matters downstream is enforced where
|
||||
it belongs: `MeasuredFacts` skips non-positive deltas, and `04_CAPTURE` requires a non-zero drop
|
||||
count to be surfaced as a session warning.
|
||||
|
||||
Six consecutive full runs clean afterwards. **Two native cases stay red on this machine for an
|
||||
unrelated reason**, recorded in `HANDOFF` §Traps: `D3D12CreateDevice(WARP)` returns
|
||||
`DXGI_ERROR_DRIVER_INTERNAL_ERROR` (0x887A0020) while the same call on the real adapter succeeds. CI
|
||||
runs the same suite on WARP and passes, and nothing in #60 touches that path.
|
||||
|
||||
### What the adversarial review of this diff caught before it landed
|
||||
|
||||
An adversarial pass over the working tree raised 23 candidates; 17 survived a second agent told
|
||||
to refute them. Beyond the process handle above, the ones that were real defects rather than
|
||||
documentation drift:
|
||||
|
||||
- **"Could not read the executable" passed the fingerprint check instead of refusing.**
|
||||
`observed ?? record.Fingerprint` made `FromConsent`'s mismatch comparison compare the record
|
||||
against **itself**, so an unreadable binary decided as "this is the consented one" — the one
|
||||
polarity everything else here is built to avoid. Now `ExecutableUnreadable`.
|
||||
- **`Enum.TryParse` accepts numeric strings**, so `"provenance": "1"` in the consent file yielded
|
||||
`UnshippedHostOperator` and `"42"` an undeclared value cast to the enum — an end-run around the
|
||||
two-member count a test pins. The comment claimed the opposite in as many words. Now
|
||||
`Enum.IsDefined` plus an ordinal name comparison, with the numeric cases tested.
|
||||
- **An unreadable consent file silently cleared a persisted guard block.** "There is no file" and
|
||||
"I could not read the file" both produced an empty store, and every write is a
|
||||
read-modify-write over that — so the merge that carries `BlockedReason` forward carried nulls,
|
||||
and the write republished a file containing only the new entry, dropping every other game's
|
||||
record. The two outcomes are now distinct and an unreadable store refuses every write.
|
||||
- **A guard exception mid-session discarded every record already drained.** Not advancing the tick
|
||||
is correct and required; losing the session's data with the stack was neither. Now
|
||||
`SupervisionFaulted`, with the final drain still running — and the *first* scan still throws,
|
||||
because there is no session to preserve yet.
|
||||
- **`StreamSegmenter` cut a spurious 0×0 segment** when a stream's first records had no measured
|
||||
size: `w`/`h` were both the "no baseline yet" sentinel and a real resolution, so the split fired
|
||||
on the first measured record — cutting a segment on the writer's silence, which the surrounding
|
||||
comment forbids.
|
||||
- **`TargetResolver` narrowed to a false single match.** Its comment claimed skipping an unreadable
|
||||
process avoided that; skipping is what caused it, because `matches.Count == 1` could not tell
|
||||
"one candidate" from "one readable candidate and others invisible". Skips are counted now.
|
||||
- **`ConsentWriteOutcome.StaleFingerprint` had no producer** — a declared-but-producerless value,
|
||||
the shape this same PR invokes two files away to justify `ConsentProvenance` having no FR-2.1
|
||||
member. It is produced now, and only where it matters: a re-grant against a different binary
|
||||
cannot inherit an existing block, while an ordinary re-consent after a patch still works.
|
||||
- **Three of the new tests could not fail for the property they named.**
|
||||
`ATerminalAttachRefusalIsNotRetriedIntoATimeout` asserted only the final reason, which is
|
||||
identical whether the refusal returns immediately or is retried to the budget — it counts
|
||||
attempts now, and gained the green half. `TheFirstTickIsPublishedBeforeAnyDrain` recorded
|
||||
publishes and drains in two independent lists, so no ordering was observable — one ordered event
|
||||
list now. And the end-to-end refusal case called `File.Delete` on a path whose parent directory
|
||||
only exists once some test has written a record, so on a clean build output it threw and its
|
||||
verdict depended on which sibling ran first — in the very test whose comment says a test whose
|
||||
verdict depends on what ran before it is one this repository does not accept.
|
||||
|
||||
- **`docs/HANDOFF.md` — one file to pick the work up from, and it carries no status.**
|
||||
Sequencing, the decisions that live in no other file, and the traps that cost a wrong
|
||||
diagnosis rather than a build cycle. Status stays in `20_OPEN_QUESTIONS` §S24,
|
||||
`spike-notes`, `15_ROADMAP` and this file, and the handoff points at them.
|
||||
- **The rule is written into the file because the alternative is what keeps
|
||||
happening.** A handoff that summarises status becomes the next stale copy within a
|
||||
day — #45's note did, `15_ROADMAP`'s status block did, and `spike-notes` §8 went
|
||||
stale *in the same file* that was correcting an earlier stale claim. It also would
|
||||
have been a fifth statement of the gate's composition, which `rules-validate` now
|
||||
refuses in the shipped data.
|
||||
|
||||
- **Shared-memory layout v3: the zero value of every enum in the record is now "nobody
|
||||
said", not a fact.** `FL_SHM_LAYOUT_VERSION` 2 → 3, spent deliberately in the last window
|
||||
where it costs nothing — nothing has shipped and no user has a session, and after the
|
||||
first release the same edit is a SemVer MAJOR that makes the Agent refuse to attach and
|
||||
tell the user to restart the game.
|
||||
- **The generator of the defect, not four instances of it.** `FlFrameRecord rec{}`
|
||||
zero-initialises, so whatever 0 means is what a writer publishes when it **forgets**. In
|
||||
v2, 0 meant `FL_UPSCALER_NONE`, `FL_FG_NONE`, and an `rtFlags` with no evidence bits —
|
||||
three measured negatives about a title nobody examined, which `03_METRICS` turns into
|
||||
`upscaler none` and `fg_factor 1.0`, the single inflated number rule 6 forbids.
|
||||
`measuredMask` made that safe **by convention**; v3 makes it safe **by construction**,
|
||||
and the mask becomes corroboration rather than the sole defence. `rtFlags`' polarity is
|
||||
flipped so every bit means *observed*.
|
||||
- **Four answers items 4/6/7 owe had no home.** DLSS super-resolution **and** Ray
|
||||
Reconstruction concurrently — RR was a mutually exclusive `upscaler` *value* while
|
||||
`03_METRICS` makes it an independent tri-state axis — plus `upscalerSharpness`, and, in
|
||||
`FlWriterState` because they are session facts rather than per-frame, the device
|
||||
**RT tier** without which rule 7's definite `No` had no producer at all, with
|
||||
`rtStateObjectsCreated` and `rasterPsoCreated`.
|
||||
- **Paid for by two narrowings that are corrections, not sacrifices.** `vramUsedBytes`
|
||||
(u64 bytes → u32 MiB) carried 64 bits of byte precision that every consumer divided
|
||||
away, to feed a comparison against `vramBudgetMb` — **already MiB** — that was
|
||||
unit-mismatched at the point of use. `fgEvaluations` (u32 → u8): ×4 multi-frame
|
||||
generation is 3, so saturating at 255 would mean 256× frame generation.
|
||||
- **`seq` @56 and `swapchainId` @60 did not move**, so `fl_ring.h`'s two pins hold
|
||||
verbatim, the seqlock's payload spans are unchanged, and the ring needed no edit.
|
||||
- **Three mask bits split producers that do not arrive together** — the same defect three
|
||||
times. `FL_MEASURED_UPSCALER_PARAMS`, because an NGX-direct title exports only the
|
||||
parameter-object *factories* so a writer knowing *which* upscaler ran knows nothing
|
||||
about quality (publishing `0` = "DLSS Performance" as measurement);
|
||||
`FL_MEASURED_PRESENT_ARGS`, because `wglSwapBuffers` and `vkQueuePresentKHR` have no
|
||||
such arguments and `syncInterval = 0` is a *real* DXGI value with no in-band sentinel;
|
||||
and `FL_MEASURED_FG_COUNTS`, because identity and per-present counts are two hook rows
|
||||
and a writer with only the first would publish `fg_factor 1.0` having counted nothing.
|
||||
- `FL_RT_PSO_ALIVE` → `FL_RT_PSO_CREATED_EVER`: creation is observed at
|
||||
`CreateStateObject` and destruction is COM `Release`, which is not in the inventory and
|
||||
must not be added — so the bit latches and could only ever mean "created ever".
|
||||
- **`03_METRICS`' RT `No` is now three conjuncts**, and the second is the one that is easy
|
||||
to drop: `hooksInstalledMask` must contain the **AS-build** hook. A writer with only
|
||||
`DispatchRays` sees nothing on an inline-RayQuery title, and its silence would otherwise
|
||||
be indistinguishable from a real negative.
|
||||
- **`pt_confidence` loses its fourth input rather than substituting one.** "The ratio of
|
||||
RT to raster work" has no cheap denominator — counting raster work means a per-draw hook
|
||||
— and §H6 records that a command-list count measures *recorded* rather than *executed*
|
||||
work anyway. The score may only ever *suggest*, so a weaker score is not a fabrication.
|
||||
- **The design came from a four-way panel, three judges and three refuters**, and the most
|
||||
useful thing the refuters found was not in any proposal: see the `FL_MEASURED_OUTPUT_RES`
|
||||
fix under Fixed. They also killed a claim this entry would otherwise have made — that
|
||||
reserved bytes let a future field skip the version bump. They do not: `recordSize` and
|
||||
`layoutVersion` are compared before a reader looks at anything, so an old reader refuses
|
||||
a new writer and never reaches an unknown field. What the reserve buys is that existing
|
||||
offsets do not move.
|
||||
- **Hook-path cost:** `RecordPresent` gains one comparison of two `uint16`s already in
|
||||
registers, and `Publish`'s two memcpy spans are `offsetof`-derived and byte-identical.
|
||||
**Not carried forward: the 8.4 ns figure.** That is `--probe-cost`'s empty-detour floor,
|
||||
which the tool says of itself; no instrument in the tree measures `RecordPresent`.
|
||||
|
||||
- **NVAPI is vendored, and the capability matrix gets the axis it could not be filled
|
||||
without.** `src/native/third_party/nvapi/` now holds nine headers (`nvapi.h`'s include
|
||||
closure plus `nvapi_interface.h`), `License.txt` and `amd64/nvapi64.lib`, from
|
||||
`github.com/NVIDIA/nvapi` @ `cd6918f6` (MIT). **x64 only** — `x86/nvapi.lib` is 438 KB of
|
||||
material we could never link and would still have to disclose. `NvApiDriverSettings.{c,h}`
|
||||
and the HLSL-extension headers are left behind for the same reason.
|
||||
- **Why that repository and not the SDK installer** is the whole licence argument:
|
||||
`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. The same
|
||||
file from the SDK installer arrives under NVIDIA's own agreement and could not be
|
||||
vendored into a GPL-3.0 tree.
|
||||
- **The canary came for free, and it ran in the order that makes it evidence.**
|
||||
`license-check.ps1` was made bidirectional after it was found unable to see
|
||||
*claimed-but-absent* material. Vendoring while `THIRD_PARTY_NOTICES.md` still said
|
||||
"Not yet vendored" failed the build — the *present-but-marked-absent* direction, which
|
||||
was structurally invisible before. The notice was flipped afterwards, not before.
|
||||
- **`ctest fl_nvapi_probe` exists because an unconsumed vendored dependency is
|
||||
unverified.** Nothing else compiles against `fl_nvapi` yet, so a short include closure
|
||||
or a wrong-architecture `.lib` would sit there with every gate green. The probe's
|
||||
*compile* is half the test.
|
||||
- **It is green on both kinds of machine, and exiting 0 is not what makes it green.**
|
||||
`nvapi64.lib` is a **static** stub library reaching `nvapi64.dll` through
|
||||
`nvapi_QueryInterface` at first call, so it is not a load-time dependency: a CI runner
|
||||
with no NVIDIA driver loads the binary and `NvAPI_Initialize` returns an error, which
|
||||
is exactly the degradation §L3 requires. Both branches exit 0 — so ctest additionally
|
||||
requires the string `BRANCH: (AVAILABLE|DEGRADED)`. **Canary: a probe gutted to
|
||||
`int main(){return 0;}` compiles, exits 0, and is now RED** at
|
||||
*"Required regular expression not found"*, with the native build and the other 15
|
||||
ctests still green. The alternation has to stay: pinning one branch would turn the
|
||||
other kind of machine red for being itself.
|
||||
- **What that still does not give you, said rather than implied:** ctest prints a
|
||||
passing test's output nowhere, so a CI log shows a branch was reached and **not
|
||||
which**. On a hosted runner it is inferable — no NVIDIA driver exists there, and the
|
||||
probe returns in ~0.01 s against ~1.4 s here — but inferable is not observed, and
|
||||
`18_GPU_VENDOR_APIS` §L3 now separates the two rather than claiming the stronger
|
||||
thing. What the run *does* prove is the load-time claim: a load-time dependency on an
|
||||
absent `nvapi64.dll` would not have started at all.
|
||||
- It refuses a **zero** GPU count rather than letting the name loop run no iterations,
|
||||
because every assertion inside a loop that never runs is vacuous.
|
||||
- **Measured on this machine:** driver `610.88` (branch `r610_85`), 1 physical GPU,
|
||||
"NVIDIA GeForce RTX 5080".
|
||||
- **A doc error the vendoring found and reading vendor documentation would not have:**
|
||||
§L3's function table named `NvAPI_GPU_GetMemoryInfo`. The headers mark it
|
||||
`__nvapi_deprecated_function` ("deprecated in release 520 — use
|
||||
`NvAPI_GPU_GetMemoryInfoEx`"), so under `/W4 /WX` a call to it **fails the native
|
||||
build**. Corrected. This is the class `17_HOOK_ENGINE:128` calls the highest
|
||||
false-confidence risk in the spike, sitting in a document instead of in code.
|
||||
- **The capability matrix is now vendor × layer**, restructured *before* anything was
|
||||
filled in — `18_GPU_VENDOR_APIS:137` said in its own words that the single-axis table
|
||||
"cannot express" the AMD/Intel deferral and that the axis is "a prerequisite of filling
|
||||
it, not a tidy-up afterwards". The legend separates `?` (a to-do, measurable here) from
|
||||
`untested` (a deferral, not measurable here) from `arch` (not available by
|
||||
architecture), which is precisely what the old table could not distinguish and what the
|
||||
UI consults before advertising a capability.
|
||||
- **The D3DKMT probe's two-OS requirement is deferred to Win 11, with a rationale.** One
|
||||
machine, and it is Win 11; Win 10 22H2 **stays a supported floor** and is explicitly
|
||||
unmeasured. Unlike the AMD/Intel gap this one *could* be closed with a VM and is being
|
||||
left open deliberately — so the deferral is conditional on the probe staying
|
||||
non-load-bearing, which the doc now states as the condition rather than as advice.
|
||||
|
||||
> **These five entries were written retrospectively.** PRs #40–#44 changed 8 files,
|
||||
> every one under `src/native/`, and touched no documentation at all — so for a day the
|
||||
> repository's own ledger described an Overlay with no hooks. CLAUDE.md's "any deviation
|
||||
> from a doc updates that doc in the same PR" did not catch it, because none of the five
|
||||
> deviated from a doc: they implemented specifications that were already written, and
|
||||
> the staleness landed in the *status* claims of other files. `legal/DISCLAIMER.md` §Accuracy
|
||||
> audit records the same drift from the user-facing side.
|
||||
>
|
||||
> > **And then it happened again, immediately, seven more times.** #45 — the PR that wrote
|
||||
> > the five entries above and complained about the gap — was followed by #46 through #52
|
||||
> > with **no changelog entry for any of them**, including the C# struct mirror, the ring
|
||||
> > reader, the handshake validator, the closed write-read loop and check 3's call site.
|
||||
> > The entries below were written retrospectively too, on 2026-08-05, from the diffs.
|
||||
> >
|
||||
> > **A retrospective note is not a mechanism, which is the actual finding.** #45 recorded
|
||||
> > the drift in prose and nothing about the repository changed, so the same failure ran a
|
||||
> > second time at greater length. `ci.yml` now carries a `changelog` job that fails a pull
|
||||
> > request touching `src/` without touching this file. Prose asking people to remember is
|
||||
> > what was already tried.
|
||||
> >
|
||||
> > **One of the seven is worse than missing.** `bd6d367` (#48) carries, verbatim, the
|
||||
> > commit body of `bff0f6a` (#47) — a squash whose `--body-file` came from the wrong
|
||||
> > branch. The subject line describes the occlusion-probe fix; every paragraph beneath it
|
||||
> > describes the struct mirror. Its entry below was reconstructed from the diff, because
|
||||
> > the commit message is evidence about a different PR.
|
||||
|
||||
- **Check 3 gets a call site, and the half that cannot have one** (#52). `19_SAFETY` has
|
||||
listed the per-title blocklist as check 3 from the beginning and it had **no call site**:
|
||||
`MatchesBlockedExecutable` was implemented, tested, and asked by nobody, so "check 3
|
||||
passed" read as "this title is not a known online title" while nothing had looked.
|
||||
`CheckBlockedExecutable` now runs inside `EvaluateImpl`, between the module scan and the
|
||||
pre-scan — one `OpenProcess` and a string compare, ahead of the only check that touches
|
||||
the filesystem.
|
||||
- **It needed a new seam.** `Sources::ImageDirectory` deliberately resolves the *install
|
||||
root* — Unreal puts the exe three levels below it, measured on Lies of P — and the file
|
||||
name is exactly what it discards. `ImageFileName` is a different fact, so it is a
|
||||
different seam and a new row in the fail-closed matrix.
|
||||
- **Unresolvable identity refuses** (`kProcessUnreadable`): `kFailed`, `kIncomplete`, an
|
||||
empty name and a null seam all take one path. The narrow conversion uses
|
||||
`WC_ERR_INVALID_CHARS` with **no** default character, so a name that cannot be
|
||||
represented exactly fails rather than becoming a string containing `?` — §S21's ANSI
|
||||
defect was exactly a silent lossy conversion.
|
||||
- **The store-id half cannot be called**, for three independent reasons: nothing produces
|
||||
a `store_id` (the platform metadata extractors were never built), `FlGuardEvaluate`
|
||||
takes a pid and nothing else *by design* (§S3 forbids a caller asserting a safety
|
||||
fact), and "unknown refuses" applied to it would refuse every title on every machine.
|
||||
It stays implemented, tested and uncalled. **Do not "fix" the second by widening the ABI.**
|
||||
- **The list ships empty**, so nothing is refused today; what changed is that populating
|
||||
it would now do something. The acceptance criterion asserts `kBlockedExecutable`
|
||||
*specifically*, because "it refuses" is indistinguishable from the four refusals the
|
||||
guard already makes.
|
||||
|
||||
- **The write-read loop closes, against our own harness and nothing else** (#51). Real
|
||||
guard, real injection, real Overlay, real reader: `ShmDrainIntegrationTests` seeds the
|
||||
rules with the product's own `RulesSeeder`, starts `hook-harness --real --hold-presenting`,
|
||||
injects through `NativeAntiCheatGuard`, and drains records while driving
|
||||
`GuardSupervisor.ScanOnceAsync` and `PublishGuardResult`. A second case proves the safety
|
||||
stop: >10 records flowing, then `unhookRequested`, then `writeIndex` frozen 700 ms later.
|
||||
- **CI found a hard-gate defect the dev box structurally could not.** Running the test,
|
||||
the guard refused our own harness — `SuspiciousUnsigned unknown
|
||||
System.Security.Cryptography.ProtectedData.dll`. §S16 puts the target's **ancestors**
|
||||
in the scan set and the .NET test host is the harness's parent, which is the
|
||||
launch-mode arrangement. A .NET host that loads that assembly poisons its own scan set.
|
||||
**A gate that cannot pass**, and §S19(b)'s "plausible and unmeasured" is superseded.
|
||||
- **So the drain tests are `Category=Integration` and CI runs `-SkipIntegration`.** The
|
||||
skip is loud, names §S19(b) and says how to run them; a developer running
|
||||
`./build.ps1 check` with no arguments still gets everything. Proven both directions —
|
||||
76 Infrastructure tests by default, 73 with the switch.
|
||||
- **What that costs, stated rather than left to be discovered:** the only end-to-end proof
|
||||
of the capture path does not run in the merge gate. See §Known issues.
|
||||
|
||||
- **The Agent can read the ring, and the pointer trap that would have hidden it** (#50).
|
||||
`ShmRingReader` mirrors `fl_ring.h`'s `RingReader::Drain` rather than re-deriving it —
|
||||
where the two disagree the header is right and the C# is the bug.
|
||||
- **Map at offset 0, and this is measured** (.NET 10, Win 11 26300): a view created at a
|
||||
non-zero offset is mapped from the 64 KiB allocation-granularity boundary *below* it,
|
||||
and `AcquirePointer` returns **that** base. So the obvious way to reach the control
|
||||
block — map region 3 at `0x80`, write `*(uint*)(p + 12)` — writes
|
||||
`FlShmHandshake.pid` instead of `FlControlBlock.guardTicks`. It does not fault, and
|
||||
`Read<T>` does not bounds-check it either, because the handle legitimately spans from
|
||||
byte 0. The supervision counter would have landed silently on the field a reader
|
||||
validates first. `Bind` now asserts `PointerOffset == 0` rather than assuming it.
|
||||
- **Seed the read index from the writer.** `fl_ring.h` starts its reader at 0 because it
|
||||
is created alongside its writer; an Agent attaching to a ring already in flight is a
|
||||
different situation. Canary: seeded at 0 against a ring at `writeIndex` 1,000,000 the
|
||||
first drain reports **999,992 drops** — and `04_CAPTURE` defines any non-zero drop count
|
||||
as "the Agent stalled for over ~16 s". It also re-ingests up to `capacity` stale records
|
||||
from a finished session as current frames. Records already published at attach are
|
||||
reported separately as `RecordsBeforeAttach`, which is not a stall.
|
||||
- **Bound the capacity against the mapping.** The validator accepted any power of two —
|
||||
every value up to 2³¹ — and returned `Ok` having never related that claim to the section
|
||||
it describes. The reader indexes by raw pointer arithmetic (the seqlock needs ordering
|
||||
`Read<T>` does not provide) and so gives up that API's bounds check.
|
||||
`CapacityExceedsMapping` is taken from `ByteLength`, never from `DefaultCapacity`.
|
||||
- **Publish order is a safety property and it is the reverse of the natural one** — flag
|
||||
first, tick second, because a fresh tick *resets* the Overlay's supervision clock.
|
||||
**The suite does not verify that order**, and says so: it asserts both values land,
|
||||
which a publisher writing them the wrong way round also satisfies. What holds the
|
||||
property is `PublishGuardResult` being the only writer of either field.
|
||||
|
||||
- **The Agent gets a build id of its own, so refuse-to-attach can run** (#49). `07_IPC`
|
||||
makes a `buildId` mismatch a hard refuse-to-attach and `04_CAPTURE` says the Agent
|
||||
compares it "against its own" — and the Agent had no own value. Two documents specified a
|
||||
check that could not run in either direction (§S23-1).
|
||||
- `FlGuardBuildId` is observation-only and **refuses rather than truncating**: a shortened
|
||||
id is not a partial answer, it is a *different* id, and returning one would produce a
|
||||
permanent mismatch caused by this function rather than by any real version skew.
|
||||
- **Why the guard carries it and not the Overlay:** reaching `FlGetBuildId` means
|
||||
`LoadLibraryW` on `FrameLedger.Overlay.dll`, which starts its init thread and creates a
|
||||
ring under the *Agent's* own pid. The payload is not something its own host may load.
|
||||
- `ShmHandshakeValidator` is the comparison, as a pure function, so every refusal is
|
||||
drivable without a live target. `layoutVersion == 0` is **`Incomplete`, not a mismatch**
|
||||
(it is published last behind a release fence, so zero means "retry", not "restart the
|
||||
game"); the version is checked **before** the fields it vouches for; and the default is
|
||||
`NotEvaluated`, never `Ok`.
|
||||
- **The fail-open, measured.** The naive implementation compares two strings, and with
|
||||
neither side carrying an id `string.Equals("", "")` is **true** — so the gate reported
|
||||
`Ok` for every process on the machine. **The test for it was nearly missed:** the first
|
||||
draft asserted the two halves as separate cases and never put both in one call, which
|
||||
is the only arrangement that reaches the defect.
|
||||
|
||||
- **The C# mirror exists, and the gate that guards it stops being a `Test-Path`** (#47).
|
||||
CLAUDE.md calls the struct mirror the mechanism protecting the shared-memory ABI; nine
|
||||
files described it in the present tense and none of it existed (§R10).
|
||||
- `ShmLayout.cs` is driven by `tools/fl-layout-dump`'s JSON, never a transcribed table —
|
||||
a hand-written offset table is a *second* statement of the layout, and two statements of
|
||||
one fact drift, which would be the defect the mirror exists to catch, reintroduced
|
||||
inside the catcher.
|
||||
- **Blittability is asserted, and that is not decoration.** Measured: swapping the
|
||||
`fixed byte BuildId[32]` for the `[MarshalAs(ByValTStr)] string` idiom this repository
|
||||
already uses correctly elsewhere keeps `Marshal.SizeOf` at 64 with **every offset
|
||||
assertion still passing**, while `Unsafe.SizeOf` collapses to **40**. That mirror looks
|
||||
correct by every obvious check and cannot be read out of a memory-mapped view.
|
||||
- **Both directions**, and the reverse walk caught something on its first run:
|
||||
`fl-layout-dump` was not emitting the `reserved` tails, so the C# declared members the
|
||||
dump could not confirm. Fixed in the dump rather than excluded from the check.
|
||||
- **The gate was the bigger finding.** `build.ps1`'s struct-mirror step was
|
||||
`Test-Path ShmLayout.cs`, then printed "covered by dotnet test" — it never looked for
|
||||
the test. An *empty* `ShmLayout.cs` would have turned an honest loud skip into a silent
|
||||
green, and deleting the test afterwards would have kept it green forever. It now reads
|
||||
the run's `.trx` and requires the named class to have **executed**. `dotnet test` makes
|
||||
a regression red; this makes *deleting the regression test* red.
|
||||
- Three canaries proven red, and **the harness was broken twice before it proved
|
||||
anything** — a renamed class tripped a file-name analyzer and the run died at *build*;
|
||||
a `sed` rewrite gave the file LF endings and the run died at *`dotnet format`*. Both
|
||||
printed a failure, and a failure upstream of the gate proves nothing about the gate.
|
||||
|
||||
- **`api` is resolved per swapchain, and `GetDevice` does not return what the docs imply**
|
||||
(#44). `api` was hardcoded to `FL_API_D3D11` on every record — a guess written into a
|
||||
field `03_METRICS` consumes and `06_DATA_MODEL` persists. One hook on the shared
|
||||
`dxgi.dll` class vtable catches D3D11 and D3D12 alike, so the present call cannot tell
|
||||
them apart; the Overlay now asks the swapchain which device created it, once per
|
||||
swapchain, and caches it.
|
||||
- **Measured, and the obvious implementation was wrong.**
|
||||
`CreateSwapChainForComposition` takes a **command queue** for D3D12, so the first
|
||||
version queried the returned device for `ID3D12CommandQueue` — and every record from
|
||||
a real D3D12 target came back `FL_API_UNKNOWN`. DXGI resolves the queue to its owning
|
||||
device before storing it, so `ID3D12Device` is what answers. The queue query is kept
|
||||
anyway: it costs one failed QI per swapchain, and a DXGI that *did* hand back the
|
||||
queue would otherwise regress to `UNKNOWN` silently.
|
||||
- `apiMask` now records what was **seen presenting**, not what the process loaded — a
|
||||
title can link `d3d12.dll` and present through D3D11.
|
||||
- Both directions, which is what makes either assertion mean anything: a new
|
||||
`--hold-presenting-d3d12` harness mode builds device → command queue → swapchain, and
|
||||
the D3D11 case gained the mirror assertion, so a resolver that always answered D3D12
|
||||
fails there.
|
||||
- **OpenGL is not attempted.** `wglSwapBuffers` is a flat export and the hook is small,
|
||||
but `hook-harness` has no OpenGL mode, and shipping an unexercised hook into a game
|
||||
process is not something this project does. The harness mode is the prerequisite.
|
||||
|
||||
- **The safety stop and supervision loss, on the present path** (#43). `19_SAFETY` calls
|
||||
the mid-session stop the single most important runtime behaviour in the capture layer,
|
||||
and `legal/DISCLAIMER.md` promises both to the user. Until now neither existed —
|
||||
`FlRequestUnhook` set a status field while the hooks kept running.
|
||||
- `unhookRequested` → hooks out, status `UNHOOKED`. `guardTicks` stalled past
|
||||
`FL_GUARD_TICK_DEADLINE_MS` → the same. The clock starts when the **mapping is
|
||||
published**, not at first present, because `07_IPC` is explicit that "never advanced"
|
||||
and "stopped advancing" are the same state.
|
||||
- **Stopping is one-way.** Resuming ticks does not resume recording; a capture side
|
||||
that can un-stop itself is one whose stop is advisory.
|
||||
- **Two of three canaries red, and the third is recorded rather than hidden.** Removing
|
||||
`g_observing = false` and leaving only `MH_DisableHook` kept the suite **green** — so
|
||||
"the flag is necessary" is *not* a property this suite proves. The flag is kept
|
||||
deliberately (it closes the window for a thread already inside the hook body, and it
|
||||
is the only thing that holds if `MH_DisableHook` fails) and the comment now says so.
|
||||
- **Not covered, and stated rather than left to look covered:** the 65-second expiry in
|
||||
its real configuration. The canary proves the comparison fires, not that 65000 is the
|
||||
number on the shipped path.
|
||||
|
||||
- **The present hook, and a harness that presents while we inject** (#42). MinHook on the
|
||||
shared `dxgi.dll` class vtable, read off a throwaway WARP composition swapchain that is
|
||||
released immediately — slots 8 `Present`, 13 `ResizeBuffers`, 22 `Present1`, proved by
|
||||
behaviour in ctest `fl_vtable_indices`, never hardcoded.
|
||||
- **`--hold-presenting` had to exist first.** `--hold` presents 240 frames and *then*
|
||||
sleeps; those are over in milliseconds while `fl_guard_test` injects ~800 ms later, so
|
||||
an Overlay injected into `--hold` observes exactly **zero**. Every "N presents → N
|
||||
records" assertion written against it would have been vacuous — the same shape as the
|
||||
`DXGI_PRESENT_TEST` defect this harness was already fixed for once. The handshake test
|
||||
now asserts `writeIndex == 0` against `--hold` deliberately, so the trap has a test on
|
||||
it instead of a comment.
|
||||
- **Honesty, which is why #36 spent two bytes.** A present-only writer sets
|
||||
`measuredMask = FL_MEASURED_OUTPUT_RES` and `rtFlags = FL_RT_NOT_MEASURED` and claims
|
||||
nothing else. Leaving the mask at 0 with the zero-defaults would assert "no upscaler,
|
||||
no frame generation, no ray tracing" as measured fact ~118 times a second — producing
|
||||
`fg_factor 1.0` (rule 6) and a definite RT `No` (rule 7) about a title nobody looked at.
|
||||
- `FL_HOOK_GUARD` wraps **only our code, never the call to the original** — otherwise a
|
||||
game's own fault inside the trampoline is counted as ours. Three faults →
|
||||
`MH_DisableHook(MH_ALL_HOOKS)` and `status = self_disabled`.
|
||||
- `status` reaches `READY` only when hooks are actually installed; a failed
|
||||
`MH_Initialize` leaves it `INIT`, because `READY` would claim a capture side that does
|
||||
not exist and the Agent's degradation path is what should run.
|
||||
- Four canaries, each proven red: claiming everything measured, asserting a definite RT
|
||||
`No`, a `frameIndex` that stops advancing, and a swapchain never identified.
|
||||
|
||||
- **The DLL gets inside, maps its ring, and publishes a handshake** (#41). The first real
|
||||
code in `FrameLedger.Overlay`, which until then was a 30-line scaffold exporting one
|
||||
function. `DllMain` does **only** `DisableThreadLibraryCalls` and `CreateThread`;
|
||||
everything else runs on the init thread, outside the loader lock (§H2).
|
||||
- The mapping carries a DACL granting only the current user's SID.
|
||||
`BuildUserOnlySecurity` returns false rather than falling back to a default DACL — a
|
||||
mapping the machine can write is not a degraded version of this one, because the
|
||||
Agent's control block is in it and `unhookRequested` is the safety stop.
|
||||
`ERROR_ALREADY_EXISTS` also refuses.
|
||||
- `layoutVersion` is published **last**, behind a release fence, because it is the field
|
||||
a reader validates first: a reader that saw the version while `capacity` was still
|
||||
zero would compute a ring of no slots and read garbage.
|
||||
- **`status` is `INIT`, not `READY`, and that is the point** — nothing was hooked in that
|
||||
slice, so no record could ever arrive.
|
||||
- Three canaries, each proven red: claiming `READY` with no hooks, leaving `capacity`
|
||||
unpublished, and corrupting `buildId`.
|
||||
|
||||
- **The SPSC ring, and an honest account of which half the suite proves** (#40).
|
||||
`fl_ring.h` implements `07_IPC` §Protocol rules and nothing else; where the two
|
||||
disagree the document wins and the header is the bug. Drop accounting lives on the
|
||||
**reader**, the only side that knows what it consumed.
|
||||
- **Two of four canaries came back GREEN, and that is the finding.** *"The payload write
|
||||
steps over `seq`"* and *"the reader re-reads `seq`"* both survive, because the damage
|
||||
is observable only inside a 64-byte memcpy and neither a 1024-slot nor an 8-slot
|
||||
concurrency case lands in it across 200,000 records. **Those two properties are
|
||||
therefore unverified**, and the file header says so rather than letting nine
|
||||
assertions imply coverage.
|
||||
- **One test was wrong in a way that looked like the code was wrong**: "the payload write
|
||||
never touches `seq`" asserted on slot 1 because the record's `frameIndex` was 1 — but
|
||||
the slot is chosen by the publish counter, which starts at 0. It failed against a
|
||||
correct writer.
|
||||
- Claims `FL_MEASURED_HDR` (bit 7) in the last free window. `hdr` had no "not measured"
|
||||
state; #36 fixed that class for five other fields and missed this one. The byte is
|
||||
already written every frame, so it costs no layout change now — and after the C#
|
||||
mirror exists the identical edit is user-visible and a SemVer MAJOR.
|
||||
|
||||
- **`fl-probe-interposer` — the vtable premise, proven, and the Streamline
|
||||
question narrowed to a licence decision** (`20_OPEN_QUESTIONS` §H5 case 3,
|
||||
`spike-notes.md` §5, previously an empty template). It runs in **our own
|
||||
process**: no game, no injection, no guard, and it needs **no vendor headers**,
|
||||
only `GetProcAddress` and DXGI types from the Windows SDK.
|
||||
- **ctest `fl_vtable_identity_control`** asserts both directions of the property
|
||||
the whole hook design rests on — two independently created composition
|
||||
swapchains share one vtable, and a different interface does not. A comparison
|
||||
never shown to detect a *difference* carries no information when it reports
|
||||
"same", so the negative control is not optional.
|
||||
- **The interposer half is INCONCLUSIVE, and that is the result.** Loaded from
|
||||
Cyberpunk 2077 and Black Myth: Wukong, `sl.interposer.dll` forwards to
|
||||
`dxgi.dll` and leaves the factory *and* swapchain vtables untouched until
|
||||
`slInit()` has run. The probe enumerates its own modules, finds no `sl.*`
|
||||
plugin mapped, and exits 2 rather than rendering a verdict.
|
||||
- **Its first version got this wrong and the fix is the interesting part.** It
|
||||
printed *"the vtable is THE SAME — a hook DOES catch Streamline presents"* for
|
||||
both titles, which would have closed §H5 case 3 on a measurement of
|
||||
passthrough. The tell was already in its own output: an interposing
|
||||
Streamline cannot leave the **factory** vtable unwrapped, because wrapping the
|
||||
factory is how it reaches the swapchain. "Could not look" must not read as
|
||||
"looked and it was clean" — the guard's tri-state discipline, applied to a
|
||||
probe.
|
||||
- **The blocker is now named:** reaching the wrapped path needs `slInit`'s
|
||||
`sl::Preferences`, i.e. vendor ABI — the question `THIRD_PARTY_NOTICES.md`
|
||||
answers for Intel IGCL and nobody has asked for NVIDIA. That is a licence
|
||||
decision, not absent hardware. And the exposure is narrower than §H5 implied:
|
||||
NGX-direct titles never wrap the swapchain.
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,61 @@
|
||||
# HANDOFF history — 0.1.0-beta.10
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` on 2026-10-19 (beta.24, owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" point inside the original file.*
|
||||
|
||||
## 2026-09-27 — the beta.10 train: the display mode, the admin mode, the Unreal Engine version
|
||||
|
||||
*Status is `CHANGELOG.md` `[0.1.0-beta.10]`; this is what no other file carries. The approved plan was six PRs:
|
||||
PR-1 the Unreal version (schema 0015), PR-2 the Overlay's display region (shared-memory layout 4), PR-3 the display mode
|
||||
in the Agent and the App (schema 0016), PR-4 the admin mode, PR-5 docs, legal text and the tested-games list, PR-6 the
|
||||
release.*
|
||||
|
||||
**Decisions (owner, 2026-09-27, asked before the plan — do not re-ask):**
|
||||
|
||||
- **D34 — the admin mode asks Windows at EVERY Agent start.** The UAC prompt appears whenever the Agent starts with
|
||||
`capture.run_elevated` on — owned by the App's window when the App starts it, flashing on the taskbar when the logon
|
||||
task does. No "highest privileges" task, no service, no silent path. Games an elevated Agent starts get the desktop
|
||||
shell's token. The elevated Agent is started for one user (`--for-user <SID>`) and exits 11 as any other account.
|
||||
- **D35 — the tested-games list comes from a COPY of the owner's ledger** (scratchpad, Python `sqlite3`; never a
|
||||
FrameLedger binary against the data folder) plus the repository's own evidence, and **the owner reviews it before it
|
||||
is committed** — the repository is public.
|
||||
- **D36 — legal text changes where it would become false** (Privacy 2.5, Disclaimer 2.8; EULA stays 1.3), **and
|
||||
`LIMITATIONS.md` exists**: a user-facing list of what the WHOLE software cannot do, at the repository root and in the
|
||||
App under Help ▸ Limitations — not one of FR-11's accepted documents (the Legal Gate records an acceptance per
|
||||
document, and this is information, not terms).
|
||||
- **D37 — each PR merges when its CI is green**, then the release PR and the GPG-signed tag.
|
||||
|
||||
**What was measured before it was written:**
|
||||
|
||||
- **Unreal versions, ten installed titles, read-only** (`spike-notes` §15): eight read (4.26.1 … 5.5.4), two honestly
|
||||
none (Cronos demo, Rune Factory). Black Myth: Wukong's executable is protected (`.rdata` empty) and its build name sits
|
||||
in `.code` — the whole-file fallback read it in 7.5 s from the owner's USB drive.
|
||||
- **The display region's cost** (hook-harness `--probe-frames`, WARP): `GetFullscreenState` 12.6–13.1 ns, `GetDesc`
|
||||
13.6–14.5 ns per call, at most twice a second per swap chain.
|
||||
|
||||
**Traps met on the way:**
|
||||
|
||||
- **A test run reseeds the rules file in the REAL data folder** (`RulesSeeder` in the integration tests writes
|
||||
`%LOCALAPPDATA%\FrameLedger\rules`). PR-1's rules `2026.09.6` carry an extractor type (`unreal_build`) the installed
|
||||
beta.9 cannot parse: its detection sweep says "rules unusable" until that Agent restarts — its seeder sees a file it
|
||||
wrote itself (the marker's hash) and puts its own back — or beta.10 is installed. The guard reads the same file and is
|
||||
unaffected (it ignores version extractors). Worth a scratch rules folder for the tests one day.
|
||||
- **`DXGI_SWAP_EFFECT_DISCARD` is 0** — region 4 stores the effect plus one, the vendor-zero trap.
|
||||
- **A minimised game presents only what the hook drops** (occlusion probes): a region-4 sample older than 2 s says
|
||||
nothing about exclusivity now; the Agent keeps its window and drops its exclusive bits.
|
||||
- **The Agent is DPI-unaware**: Windows scales another process's window coordinates for it. The window reader switches
|
||||
its thread to per-monitor-aware (V2) for the calls and back.
|
||||
- **A Tier-2 session never reaches the aggregator** — display columns live on the recorder's skeleton, or a Tier-2 row
|
||||
would carry none.
|
||||
- **`SessionRowColumns` is generated by a script that is not in the repository** — edit it by hand, by name.
|
||||
- **`CreateProcessWithTokenW` needs `SeImpersonatePrivilege`**, which an unelevated (filtered) token does not hold: the
|
||||
shell-token start is testable only on the elevated CI runner, and a runner with UAC off has an elevated shell — so the
|
||||
test compares the child's elevation with the SHELL's, never with "unelevated".
|
||||
- **An elevated token's default DACL omits the user** (again): the ledger's migration lock is now a `SharedMutex` with a
|
||||
stated descriptor; the instance lock and the elevation marker are only probed, and a refused probe reads as held.
|
||||
- **`CA2025` flags a disposable handed to an un-awaited task** even when ownership moves to it; the launcher says so in
|
||||
a suppression with its reason, or splits the method so the analyzer can see it.
|
||||
- **Heredocs mangle backslashes and `\a`** (`D:\another` became `D:<BEL>nother` in a test). Patch scripts are written
|
||||
with the Write tool and run by path; a scan for control characters before the gate catches the rest.
|
||||
|
||||
**Owner-only, added to the list below:** item 7.
|
||||
|
||||
@@ -0,0 +1,56 @@
|
||||
# HANDOFF history — 0.1.0-beta.11
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` on 2026-10-19 (beta.24, owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" point inside the original file.*
|
||||
|
||||
## 2026-10-03 — the beta.11 train: the exception's trial, the library, sessions across
|
||||
|
||||
*Status is `CHANGELOG.md` `[0.1.0-beta.11]`; this is what no other file carries. The approved plan was five PRs: PR-1 the
|
||||
CrackProof titles (rules `2026.10.1`), PR-2 the exception's trial (schema 0017, Disclaimer 2.9, EULA 1.4), PR-3 the
|
||||
library and the import, PR-4 delete sessions, the charts across sessions and the Settings clean-up, PR-5 the release.*
|
||||
|
||||
**Decisions (owner, 2026-10-03, asked before the plan — do not re-ask):**
|
||||
|
||||
- **D38 — the user-mode exception's evidence moved under the grant, as a trial.** The owner deleted their ledger and
|
||||
found GIRLS' FRONTLINE 2 "Not eligible: 0 successful hooked session(s), two are needed" for good: since beta.8 a game is
|
||||
blocked the moment it is added, a blocked game is never hooked without a grant, so D33's two sessions were unreachable
|
||||
for every game blocked from the start and lost with a reset ledger. Chosen: a grant needs no session; the first two
|
||||
hooked sessions under it are a trial; any end during the trial (every D33 end, or a stored hooked session with no frames
|
||||
or an abnormal exit) ends it for good (`games.ac_exception_trial_failed_at`). Every other condition is unchanged.
|
||||
Legal text: Disclaimer 2.9 (§2A) and EULA 1.4 — the EULA's "a game the Software has already measured successfully"
|
||||
would have become false (D36's rule).
|
||||
- **D39 — charts across a game's sessions: both** — *Sessions at a glance* on the Sessions tab, and *Also draw* on the
|
||||
Trend (two units at most, the second on the right axis).
|
||||
- **D40 — Delete all sessions: both places** — the game's page and Settings ▸ Data. The Agent deletes (the rows are its),
|
||||
never while a session it would delete under is being recorded.
|
||||
- **D41 — Refresh does all three**: reload the library, offer the games the stores installed since, mark the entries
|
||||
whose executable is gone (*Not installed*; nothing is removed).
|
||||
- **D42 — the library switches between a grid that fills the window and a list** (`ui.library_view`).
|
||||
- **CrackProof (owner's list, "a few, by Steam id")**: three titles whose own store pages say *"Uses Kernel Level
|
||||
Anti-Cheat"* and name CrackProof; ANOTHER EDEN, named only by a community list, is left out.
|
||||
|
||||
**Traps met on the way:**
|
||||
|
||||
- **A fresh git worktree cannot configure the native build**: CMake's MinHook FetchContent clone runs `git submodule`,
|
||||
which fails there ("'submodule' appears to be a git command, but we were not able to execute it"). Run the gate in the
|
||||
primary checkout, whose `build/native/x64-release/_deps` is cached; a worktree is for writing code and managed tests.
|
||||
- **A `DataGrid` laid out outside a window draws its star columns at their minimum** (no Loaded pass): a visual check
|
||||
renders a hosted, off-screen `Window` and pumps the dispatcher (`Dispatcher.PushFrame`), not Measure/Arrange on a page.
|
||||
- **`Native FPS` includes a measured-none session**, whose native rate is the presented one: beside Presented it is a
|
||||
second line on the same points, so the overview keeps Native and Displayed to sessions that generated frames.
|
||||
- **Both processes may change the library while the Games page is open**, and WPF UI 4.3.0 does nothing on a navigation
|
||||
to the page already on screen: the page reloads on `SessionCompleted` and on the App's own `LibraryChanges`.
|
||||
- **A grant's trial is counted from the sessions, not kept as a counter**: the lapse policy counts at each finalize
|
||||
(`CountSuccessfulUnderGrantAsync`: that family, started at or after the grant), and `ac_exception_sessions` is only
|
||||
the sweep's copy for the card. Deleting sessions can only lengthen a trial; the mark that ends one for good
|
||||
(`ac_exception_trial_failed_at`) is the only stored decision.
|
||||
- **A session summary is a window of its own, outside every page**: deleting sessions must close the ones open on a
|
||||
deleted session and let go of File ▸ Export's selection, asking the ledger whether the session is still there (both in
|
||||
`SessionDeletion`, so Settings ▸ Data does it too) — ids are reused once the newest is gone. The plan said so; PR-4's
|
||||
first version did neither, and a self-review caught it before the merge.
|
||||
- **Analyzers met:** `MA0048` (one type per file), `CA1003`/`MA0046` (an `EventArgs` type for an event), `IDE1006` (a `_`
|
||||
prefix on private consts), `CA1030` (no method named `Raise`), `MA0051` (60 lines), and `RevokeAntiCheatExceptionAsync`'s
|
||||
new `bool` before the token turned every `(path, reason, ct)` call into a compile error — pass `ct: ct`.
|
||||
- **The Bash tool's heredocs break on an odd number of apostrophes and halve backslashes**: patch scripts are files.
|
||||
|
||||
**Owner-only, added to the list below:** item 8.
|
||||
|
||||
@@ -0,0 +1,69 @@
|
||||
# HANDOFF history — 0.1.0-beta.12
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` on 2026-10-19 (beta.24, owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" point inside the original file.*
|
||||
|
||||
## ~~**START HERE**~~ — 2026-10-04, the beta.12 train: the game's own memory, rendered documents, a user guide, the legal split *(struck the same day: the head is §beta.13 below)*
|
||||
|
||||
*Status is `CHANGELOG.md` `[0.1.0-beta.12]`; this is what no other file carries. The approved plan was eight PRs: PR-0 the
|
||||
recorder test that went red on a loaded runner, PR-1 `NOTICE` and the licence header (D45), PR-2 the game's memory
|
||||
measured from outside the game (C++ `FrameLedger.ProcessStats.dll`, schema 0018, D43), PR-3 the App showing it, PR-4
|
||||
Markdown rendered and a tabbed About, PR-5 the user guide and the documents a user accepts, PR-6 the documentation sweep,
|
||||
PR-7 the release.*
|
||||
|
||||
**Decisions (owner, 2026-10-03, asked before the plan — do not re-ask):**
|
||||
|
||||
- **D43 — the game's memory is measured from OUTSIDE the game, in both tiers.** A new C++ library loaded by the Agent,
|
||||
never into a game: dedicated and shared GPU memory from the documented `GPU Process Memory` performance counters (no
|
||||
handle to the game), private working set / working set / commit from `GetProcessMemoryInfo` with
|
||||
`PROCESS_QUERY_LIMITED_INFORMATION` only — a hooked game through the handle the session holds, any other through a
|
||||
handle opened for the read and closed after it, the creation time checked, every process of the executable summed.
|
||||
Task Manager's figures are the definition; no budget (§M11 stays open); not `D3DKMTQueryStatistics` ("Reserved for
|
||||
system use"). Measured first: `spike-notes` §16.
|
||||
- **D44 — a user guide in English**, `guide/`, rendered in the App (Help ▸ User guide), linked from the README.
|
||||
- **D45 — the legal split.** `legal/TRADEMARKS.md`; `FORKING.md` and `CONTRIBUTING.md`; the GPL shown as information,
|
||||
not accepted (GPLv3 §9, FR-11 changed); GPLv3 §7(b)(c)(e) additional terms in `NOTICE` and named in every source file's
|
||||
header; the Appropriate Legal Notices in a tabbed About; the EULA's consumer-law carve-out and severability; the
|
||||
Privacy Policy's section on sharing exports and bug reports; `CODE_OF_CONDUCT.md`.
|
||||
- **D46 — documentation is corrected in place** (struck, dated) with an index, `docs/README.md`; history stays.
|
||||
|
||||
**Traps met on the way:**
|
||||
|
||||
- **A test whose session length came from a fake clock but whose end came from a real 150 ms timer** went red whenever a
|
||||
loaded runner fitted fewer than six drains into it (PR-0): make the fake drive both.
|
||||
- **Two LibreHardwareMonitor `Computer`s updating in one process** threw a NullReferenceException in `GenericCpu.Update`
|
||||
in the local gate (`LhmRealHardwareTests` beside `PrivilegeFootprintTests`); the Agent's own read was already behind a
|
||||
catch. The two test classes share a collection now.
|
||||
- **A test reading resource text outside the culture collection** races a class that flips `Strings.Culture`; a class
|
||||
that adds many flips (`GameMemoryTextTests`) makes it likelier. `GamesViewModelTests` moved in; the rest are a chip. *(Ended in beta.13: the
|
||||
collection runs alone.)*
|
||||
- **`ShmDrainIntegrationTests.AnUnhookRequestStops…` failed once on CI at the injection step** (≈1 s, `IsAllowed`
|
||||
false) and passed on the re-run; it passed on the PR before. A flake to watch, not yet a fix.
|
||||
- **Markdig follows the table spec strictly**: a line without cells between a table's rows ends the table, and GitHub
|
||||
still draws it. `MarkdownRendererTests` fails any embedded document whose table would show as `|---|` text.
|
||||
- **`AccentTextFillColorPrimaryBrush` is the dark accent until `ApplicationThemeManager.Apply(…, updateAccent: true)`
|
||||
runs** — a test host that skips it draws links #003E92 on #202020; the App (and the Legal Gate, via `WpfThemeApplier`)
|
||||
applies it.
|
||||
- **`tools/license-gather.ps1` took an override only for a URL-only package**; Markdig declares BSD-2-Clause and ships no
|
||||
file, so the expression branch takes an override too now.
|
||||
- **A file git sees as mixed line endings is `-text`**: no EOL conversion, so a CRLF rewrite shows as a whole-file change.
|
||||
Keep such a file's working copy LF (`docs/legal-drift-history.md`).
|
||||
- **Inserting a `### Changed` heading after an entry in the middle of `### Added`** moves every later Added entry under
|
||||
it — read the section's headings back before committing.
|
||||
- **The stacked-branch recipe carried four PRs** (PR-3 on PR-2, PR-4 on PR-3, PR-5 on PR-4): after each squash merge,
|
||||
`git rebase --onto origin/main <old parent>` replays only the PR's own commit, and resx / CHANGELOG additions stay
|
||||
clean because each PR appends after the previous one's.
|
||||
|
||||
- **A test can hide the defect it exists to catch**: `LogTailTests` fed App-form lines into the fake *Agent* log, so
|
||||
the Logs page's level filter matched no real Agent line (Serilog's default template, a date first) and nobody saw
|
||||
it for three weeks. A fixture for another process's file is a copy of a real line from that process.
|
||||
- **A setting with `AgentReads = true` that no Agent code reads is a switch that lies**: Settings' *Record games
|
||||
launched outside FrameLedger* wrote `capture.background` and nothing read it (removed in PR-6, the key reserved).
|
||||
Before trusting a registry row's flag, grep for a reader.
|
||||
- **The audits (PR-6) found code gaps the docs had been describing as built**, each left for its own PR and named
|
||||
here so it is not rediscovered: L1 telemetry is never pointed at the game's adapter (`SelectAdapter` has no caller,
|
||||
`18_GPU_VENDOR_APIS`); a machine-wide service refusal still says "detected in this game" (§S23-3, 🔴); no release
|
||||
has carried a Velopack delta (`release.yml` never fetches the previous release); there is no rules feed (§S20). *(Three of the four closed in
|
||||
beta.13 — §S23-3, the adapter, the delta; the rules feed stays.)*
|
||||
|
||||
**Owner-only, added to the list below:** item 9.
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
# HANDOFF history — 0.1.0-beta.13
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` on 2026-10-19 (beta.24, owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" point inside the original file.*
|
||||
|
||||
## ~~**START HERE**~~ — 2026-10-04, the beta.13 train: the four follow-ups the beta.12 audit left *(struck 2026-10-06: the head is §beta.14 below)*
|
||||
|
||||
*Status is `CHANGELOG.md` `[0.1.0-beta.13]`; this is what no other file carries. The owner asked (2026-10-04) for the
|
||||
four chips the beta.12 documentation audit had left — §S23-3's wording, the App tests' culture races, L1's adapter, the
|
||||
Velopack delta — then a release and the session closed. Two PRs: PR-1 the three code changes, PR-2 the release with the
|
||||
delta in `release.yml`.*
|
||||
|
||||
**No new owner decision.** The choices below follow rules already written: a figure from the wrong graphics card is worse
|
||||
than N/A (`FlShmHandshake.AdapterLuid`'s own comment), and a finding on the PC is not a finding in the game (§S23-3,
|
||||
2026-09-06).
|
||||
|
||||
**Traps met on the way:**
|
||||
|
||||
- **Pointing L1 at the game's adapter changes nothing visible on its own**: `CompositeTelemetrySource` merges L3 > L2 >
|
||||
L1 per field, and L2 (LibreHardwareMonitor's first GPU node) and L3 (NVAPI's first physical GPU) read their own card.
|
||||
Every layer has to agree on the card — L1 by LUID (`IGpuAdapterSelector`), the others by the adapter's vendor
|
||||
(`IGpuVendorFollower`), and L3 says nothing for an AMD or Intel adapter. Two GPUs of one vendor stay first-found.
|
||||
- **A `CaptureRefused`'s `reason` is the session's end reason** (`RefusedByGuard`), not the guard's: the App could not
|
||||
tell a service from a module until the events carried `guardReason`. A `RefusedAck`'s `Reason`, by contrast, IS the
|
||||
guard's — two "reason" fields one pipe apart that mean different things.
|
||||
- **A collection definition must be public** (xUnit1027), which CA1515 then flags in a test project that is an exe — the
|
||||
suppression carries the reason. `TestContext.Current.TestCollection.TestCollectionClassName` proves the definition
|
||||
bound, so a definition xUnit did not find fails a test instead of bringing the races back silently.
|
||||
- **`vpk download github --pre` puts the previous release's full package in `out/release`**: `vpk pack` needs it there to
|
||||
write a delta, and nothing else may ship it — `assets.win.json` names what this pack built, the rest moves to
|
||||
`out/previous`, and the feed and `RELEASES` are filtered to this build, as `vpk upload github` writes them.
|
||||
- **A 120 ms wall-clock ceiling races the second scan on a loaded runner**: the release rehearsal failed on
|
||||
`CaptureSessionTests.AGuardThatThrowsMidSessionKeepsTheRecordsItAlreadyDrained`, which ended as `Running` before the
|
||||
guard's second evaluation threw — the class beta.12's PR-0 fixed in the recorder tests. The four tests whose ending is a
|
||||
scan, a throw, the kill switch or an exit take `EndsOnItsOwn` (a 30 s safety net); a test that EXPECTS `Running` keeps
|
||||
the short ceiling, because that ceiling is its ending.
|
||||
- **The beta.12 traps about the culture race and the four code gaps are closed here** (the rules feed stays open, §S20).
|
||||
|
||||
**Owner-only, added to the list below:** item 10.
|
||||
|
||||
@@ -0,0 +1,67 @@
|
||||
# HANDOFF history — 0.1.0-beta.14
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` on 2026-10-19 (beta.24, owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" point inside the original file.*
|
||||
|
||||
## ~~**START HERE**~~ — 2026-10-06, the beta.14 train: contrast and the wheel, the update audit, crash reporters, assembly metadata, new measurements *(struck the same day: the head is §beta.15 below)*
|
||||
|
||||
*Status is `CHANGELOG.md` `[0.1.0-beta.14]`; this is what no other file carries. The owner's list (2026-10-05, with a
|
||||
screenshot of the import list in the dark theme): the contrast, a review of the update logic, games recorded as crashed
|
||||
by an engine's crash reporter (prevention; SILENT HILL 2 as the example), assembly metadata, new metrics and charts, and
|
||||
a wheel that scrolls with an option to hide the scroll bars. Nine stacked PRs — PR-1 contrast and the wheel, PR-2 the
|
||||
scroll-bar option, PR-3 the update audit, PR-4 the guard's retry, PR-5 crash classification, PR-6 assembly metadata,
|
||||
PR-7 the metrics' Agent half (schema 0019), PR-8 their App half, PR-9 the release — plus one test fix (#268).*
|
||||
|
||||
**Decisions (owner, 2026-10-05, asked before the plan — do not re-ask):**
|
||||
|
||||
- **D47 — the update channel follows the running copy.** `update.channel` gained `auto`, the default: a pre-release
|
||||
copy asks for pre-releases, a stable one for stable; an explicit *Stable* or *Beta* in Settings wins
|
||||
(`Update/UpdateChannelPolicy`). Until beta.14 the default was `stable` and every release is a pre-release, so an
|
||||
installed copy never found an update (the owner's own `velopack` log: "No releases found").
|
||||
- **D48 — the guard's narrow fix, both halves.** A scan-set member still loading (`ERROR_PARTIAL_COPY`) or already gone
|
||||
is read again once, ~250 ms later, before the guard refuses; still unreadable still refuses, and `ACCESS_DENIED` is
|
||||
never retried. A refused re-scan for a could-not-read reason (`ProcessUnreadable`, `ModuleScanFailed`,
|
||||
`ProcessTreeUnavailable` — never a finding) when the game itself had exited ends as the game's exit
|
||||
(`ExitScanRelabel`, the note `scan_at_exit=`). CLAUDE.md rule 2 is unchanged: a failure still refuses.
|
||||
- **D49 — all four metric groups.** The render scale over time; time below 30 / 60 / the refresh rate and frame to frame;
|
||||
the facts the row stored and nothing showed (VSync and tearing, ray tracing's share, focus, capture quality, the
|
||||
displayed 1 % low); the card's clocks, fan, memory temperature, limits, and frames per watt.
|
||||
- **D50 — the managed binaries' identity.** Company and Product "FrameLedger", the copyright the native `FL_COPYRIGHT`
|
||||
word for word; `versioninfo-check` reads both kinds and compares them.
|
||||
|
||||
**Traps met on the way:**
|
||||
|
||||
- **WPF UI 4.3.0 keys its DataGrid styles** (`DefaultDataGridRowStyle`) and defines no implicit row style: a `RowStyle`
|
||||
`BasedOn="{StaticResource {x:Type DataGridRow}}"` falls through to Aero2's row and `SystemColors.WindowBrush` — white
|
||||
under the dark theme's white text. Its `CheckBox` has `MinWidth` 120. Both in `16_WPFUI_SYNTAX` §Gotchas now.
|
||||
- **`NavigationViewContentPresenter` makes a `Page`'s `CanContentScroll` true and wraps it in its own scroller**; a page's
|
||||
own root `ScrollViewer` is then measured unbounded, has nothing to scroll, and still marks every wheel handled. ScottPlot
|
||||
never marks the wheel handled.
|
||||
- **`Keyboard.Modifiers` is the machine's real keyboard, from any thread** (a fresh background thread's `GetKeyState`
|
||||
reported the machine's NumLock): a local gate went red on the chart-wheel test while a Ctrl was held. A test that sends
|
||||
input sets the keys itself (`ChartWheel.CurrentModifiers`, #268).
|
||||
- **Velopack 1.2.0 applies a downloaded update at the next start by default** (`SetAutoApplyOnStartup`), before FR-12's
|
||||
check and with the Agent killed; `VelopackHooks` turns it off and a pending package is adopted instead.
|
||||
- **The plain "time below X" rule fabricates drops**: a game capped at 60 read 50.0 % "below 60" from present-timing
|
||||
jitter (measured on a copy of the owner's ledger); a rolling mean does not help. The margins of `FramePacing` and what
|
||||
they cost are in `03_METRICS` §Pacing.
|
||||
- **A WER 1001 is not a crash by its number**: `RADAR_PRE_LEAK_64` is Windows' memory-leak detector, and a substring match
|
||||
on the executable's name stored an ordinary The Witcher 3 session as crashed. `CrashEventMatcher` reads the event name
|
||||
and the typed process id.
|
||||
- **No chart palette colour was 60 apart from all six on the temperatures plot** — `Chart_Histogram` equals
|
||||
`Chart_Native` — so the seventh line got a key of its own (`Chart_SensorTertiary`); `ChartMathTests` caught it.
|
||||
- **Meziantou's MA0051 (60 lines, 40 statements) split** `FrameTimeSeries`'s two builders into one `Kept` accumulator,
|
||||
the summary's cards into three methods and Compare's rows into two; `dotnet format` wants one property per line in an
|
||||
object initializer, even in a test.
|
||||
- **The `fl_ring` anti-vacuity flake** (§Traps) fired on #264's CI and passed on the re-run, as written.
|
||||
- **`git describe` is 31 characters ten commits after a tag** (`v0.1.0-beta.13-10-g15ec7c1c5fd4`) — the most
|
||||
`FlShmHandshake.buildId` holds. `ShmHandshakeValidatorTests` appended `"x"` to the id for its mismatch case, the helper
|
||||
cut it back to 31, and the check read `Ok`: red from the tenth commit after every tag, locally and on CI (#273 uses
|
||||
another id of the same length).
|
||||
- **"The job was not acquired by Runner of type hosted even after multiple attempts"**: with seven CI runs in flight a
|
||||
queued Windows job was cancelled after ~15 minutes, twice, without a step having run. Nothing in the code; re-run the
|
||||
job when fewer runs are queued.
|
||||
- **The Privacy Policy 2.7 holds the merge of PR-5 and PR-7**: their wording (§4 the crash reports and the programs a
|
||||
game starts, §1 the card's sensor series) is the owner's to approve before they land, as the plan said.
|
||||
|
||||
**Owner-only, added to the list below:** item 11.
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
# HANDOFF history — 0.1.0-beta.15
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` on 2026-10-19 (beta.24, owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" point inside the original file.*
|
||||
|
||||
## ~~**START HERE**~~ — 2026-10-06, the beta.15 train: the five chips beta.14 left *(struck the same day: the head is §beta.16 below)*
|
||||
|
||||
*Status is `CHANGELOG.md` `[0.1.0-beta.15]`; this is what no other file carries. The owner's request (2026-10-06): "Xong
|
||||
beta14, tổng hợp 5 chip thành 1 bản beta15" — the five findings the beta.14 train spawned as tasks instead of fixing in
|
||||
its own scope. Six stacked PRs — PR-1 the choice lists follow the language, PR-2 launch mode's election, PR-3 a restart
|
||||
during finalize, PR-4 the scan set's creation times (D51), PR-5 the App's viewer (D52), PR-6 the release.*
|
||||
|
||||
**Decisions (owner, 2026-10-06, asked before the plan — do not re-ask):**
|
||||
|
||||
- **D51 — the scan set cuts a parent/child link only when it is proven wrong**: both creation times read and the child
|
||||
created before the process whose pid it names as its parent. An unread time keeps the link (rule 2, fail closed), equal
|
||||
times keep it, and each pid is walked once (`fl_guard_scanset.cpp`; `19_SAFETY` item 1 carries the rule and its one
|
||||
residual, a clock set backwards between a parent's start and its child's).
|
||||
- **D52 — the App's `--data-dir` is a viewer over a copy**: no Agent is started or contacted (its composition holds no
|
||||
pipe client, launcher, update check or Run-entry writer — `Services.MachineFacingServices`), every control that would
|
||||
ask the Agent or change the PC is disabled, and the profile's own folder is refused however it is spelled. D6 is
|
||||
unchanged; the full alternative (an Agent `--serve --data-dir`) would have changed D6, the pipe's per-user name and the
|
||||
hello.
|
||||
|
||||
**Traps met on the way:**
|
||||
|
||||
- **Launch mode's election had never run** (since #150): a refused launch returned its outcome without the launcher's
|
||||
pid, so the orchestrator stopped before its first `election:` line — and its tests hand-built an outcome that already
|
||||
carried a pid. A test of one half that hand-builds what the other half returns proves the half, not the pair
|
||||
(`CaptureSessionLaunchTests` now asserts what the session itself returns).
|
||||
- **The watcher reports a process once.** "One session per executable at a time" turned a restarted game away and nothing
|
||||
looked at it again; the orchestrator remembers the newest such process per executable and starts it when the running
|
||||
session ends, if it is then the executable's only process — a multi-process game's helper is not a restart.
|
||||
- **A pid in a snapshot names whoever holds it now.** Creation times are the evidence (`GetProcessTimes`, under the
|
||||
module scan's own read-only right), compared strictly: a parent and a child can share one tick of the clock.
|
||||
- **Static choice lists keep the language they were built in**; a list read once into a `static` field, the tray's
|
||||
menu built once and the pill's text written once all needed a way back (`ILanguageFollower`, called by the shell's
|
||||
rebuild).
|
||||
- **An Agent end-to-end test can lose to another project's harness**: `build.ps1` runs the test projects as parallel
|
||||
processes, and a `hook-harness.exe` another project was still starting made `TargetResolver` refuse with
|
||||
`TargetAmbiguous` (#269's first CI run; the re-run passed). The refusal is right and the test isolation is not — left
|
||||
as a task, not fixed in this train. *(Fixed in beta.16: the by-name suites consent to a run-unique copy of the
|
||||
harness — `14_TESTING` §hook-harness, test isolation.)*
|
||||
|
||||
**Owner-only, added to the list below:** item 12.
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
# HANDOFF history — 0.1.0-beta.16
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` on 2026-10-19 (beta.24, owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" point inside the original file.*
|
||||
|
||||
## ~~**START HERE**~~ — 2026-10-06, 0.1.0-beta.16: beta.15 verified, and the chip it left *(struck 2026-10-07: the head is §beta.17 below)*
|
||||
|
||||
*Status is `CHANGELOG.md` `[0.1.0-beta.16]`; this is what no other file carries. The owner, after beta.15's release
|
||||
(2026-10-06): owner-only item 12 passed on real hardware ("đã chạy và ok"), do the chip beta.15 left, release, and close
|
||||
the session. One PR carries the test isolation and the release. Nothing in the app changed, so no owner-only item is
|
||||
added.*
|
||||
|
||||
- **The chip:** a suite whose host resolves its target BY NAME (`TargetResolver`) — the Agent's end-to-end and
|
||||
partial-recovery suites, the capture host's — consents to a run-unique copy of the harness, as the pipe suite already
|
||||
did, so another project's `hook-harness.exe` starting at the same moment can no longer make the target ambiguous
|
||||
(`14_TESTING` §hook-harness). `AnotherHookHarnessRunningBesideTheSuiteDoesNotMakeTheTargetAmbiguous` runs a second
|
||||
harness beside the capture and was red against the shared name (`TargetAmbiguous`), measured before the fix.
|
||||
- **The beta.15 train's merges, for the record:** #274–#276 and #279 carry the PRs' own titles; #277 (PR-4, the scan
|
||||
set, D51) and #278 (PR-5, the viewer, D52) were opened by the owner from the pushed branches, so their squash commits
|
||||
are titled "Beta15/pr4 guard" and "Beta15/pr5 viewer" and list every commit of the branch. Their content is the gated
|
||||
stack's: main's tree matched it after each merge.
|
||||
|
||||
**Traps met on the way:**
|
||||
|
||||
- **A session restart restarts gpg-agent**, so the first signature after it asks for the passphrase again, whatever the
|
||||
cache said a minute before; pinentry-qt gives up in about half a minute with nobody at the desk (`git tag -s` failed
|
||||
with "signing failed: Timeout"). Ask the owner for `echo x | gpg --clearsign` right before a tag.
|
||||
- **main is strict and linear**: each PR of a stack must be rebased onto the squash of the one before and run CI again.
|
||||
`git rebase --update-refs --onto origin/main <merged branch> <tip>` moves every branch of the stack at once and drops
|
||||
a commit main already carries (it dropped PR-4 and PR-5 when the owner had merged them from the branches).
|
||||
- **The desktop app forbids polling CI** (no `gh` loop, Monitor or ScheduleWakeup): it wakes the session on a failure, a
|
||||
conflict or a review comment, never on green, so a green PR waits for the owner's word or the owner's auto-merge.
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
# HANDOFF history — 0.1.0-beta.17
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` on 2026-10-19 (beta.24, owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" point inside the original file.*
|
||||
|
||||
## ~~**START HERE**~~ — 2026-10-07, 0.1.0-beta.17: text that follows a theme switch, scroll bars hidden everywhere, a wiki *(struck 2026-10-07: the head is §beta.18 below)*
|
||||
|
||||
*Status is `CHANGELOG.md` `[0.1.0-beta.17]`; this is what no other file carries. The owner's report (2026-10-07, three
|
||||
screenshots of beta.16): Settings' descriptions kept the old theme's colour after a switch; the Dashboard kept its
|
||||
scroll bar with Hide scroll bars on; "a complete wiki, concise and easy, End-user and Dev". Five stacked PRs — #281 the
|
||||
theme text, #282 the scroll bars, #283 the guide's four new pages, #284 the wiki and its publishing, then the
|
||||
release.*
|
||||
|
||||
**Decisions (owner, 2026-10-07, asked before the plan — do not re-ask):**
|
||||
|
||||
- **D53 — the wiki's source is the repository.** `wiki/` (Home, the sidebar, the developer pages) and `guide/` with
|
||||
`LIMITATIONS.md` are assembled by `tools/wiki-build.ps1` and published to the Wiki tab by `.github/workflows/wiki.yml`
|
||||
after a successful Release run (and by hand); a page edited on the tab is overwritten at the next release. English.
|
||||
- **D54 — the wiki's End-user half is the user guide**, one source: it grows past D44's eight pages (the screens, every
|
||||
setting, troubleshooting, a glossary — twelve) and stays embedded in the App. Tests hold that every setting the
|
||||
Settings page shows and every page and menu item of the main window is named in it.
|
||||
|
||||
**Traps met on the way:**
|
||||
|
||||
- **`ui:TextBlock Appearance` pins a brush.** WPF UI 4.3.0 resolves it once (`TryFindResource`) and coerces Foreground
|
||||
to it, so a theme switch leaves the text in the old theme; 129 texts used it. Every contrast check before measured a
|
||||
theme as a surface was *made* under it — a switch needs the surface hosted in a `Window`, because only
|
||||
`Application.Windows` hear a dictionary change (`16_WPFUI_SYNTAX` §Gotchas, `14_TESTING`).
|
||||
- **A class handler on `Loaded` is not a load hook.** WPF raises Loaded only where a subtree listens for it with its own
|
||||
handler, style EventSetter or template trigger — WPF UI's toggle switches carry one, which is why Settings hid its
|
||||
bar and the Dashboard never did. A test that calls `RaiseEvent(Loaded)` proves the handler, never that WPF reaches it;
|
||||
`ScrollChanged` reaches every scroller from its first layout.
|
||||
- **The wiki's git branch is `master`, and the repository's default workflow token is read-only:** `wiki.yml` declares
|
||||
`contents: write`. A release made with `GITHUB_TOKEN` fires no `release` event for another workflow; `workflow_run`
|
||||
does, and runs `main`'s copy of the file — so it checks out the run's `head_sha` and links at its tag.
|
||||
- **A fresh worktree cannot run the full gate** (the native configure, `CONTRIBUTING`): the stack's tip was gated in the
|
||||
main checkout on a detached HEAD, and each PR's own CI ran on its branch.
|
||||
- **Found while writing the guide, not fixed** (a task each): two notices can print an internal name — *"The hook
|
||||
stopped (WriterSelfDisabled)…"*, and a refusal no anti-cheat names reads ~~*"The anti-cheat guard did not hook this
|
||||
game: reason RefusedKillSwitch."*~~ *"…: reason RefusedByGuard."* *(corrected 2026-10-07 by beta.18's tests, which
|
||||
build the Agent's own events: the kill switch's refusal carries the gate's label where a family goes, and read "kill
|
||||
switch was detected in this game (… (FR-2.4) …)"; a re-scan that could not look read "Access is denied. was detected")*; the kill switch's *Applied* strip says "at the next session start" (it applies
|
||||
within 30 s); *Turn off* failing says "Nothing was enabled."; in the viewer, the exception switch, the Recording numbers and the Channel stay enabled;
|
||||
`08_UI` lists a "PawnIO missing" banner that does not exist; and a release's Overlay build id reads `-dirty` (§0.1.0-beta.4,
|
||||
"Found and NOT fixed", still open). *(All but the build id fixed by beta.18 PR-2, 2026-10-07; the build id is PR-3's.)*
|
||||
|
||||
**Owner-only, added to the list below:** item 13.
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
# HANDOFF history — 0.1.0-beta.18
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` on 2026-10-19 (beta.24, owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" point inside the original file.*
|
||||
|
||||
## ~~**START HERE**~~ — 2026-10-07, 0.1.0-beta.18: page titles readable in the dark theme, notices in words, a clean build id *(struck 2026-10-12: the head is §beta.19 below)*
|
||||
|
||||
*Status is `CHANGELOG.md` `[0.1.0-beta.18]`; this is what no other file carries. The owner's report (2026-10-07, five
|
||||
screenshots of beta.17 in the dark theme): every page's title and section headings near-black on the dark window — and
|
||||
the two chips beta.17 left (§beta.17, "Found while writing the guide"). Three stacked PRs — #286 the page text, #287
|
||||
the notices and the rest of that list, #288 the release build id — then the release.*
|
||||
|
||||
**No new decisions.** The train is the owner's request of 2026-10-07 ("beta18 with the two chip tasks, and the text that
|
||||
blends into the background in dark mode").
|
||||
|
||||
**Traps met on the way:**
|
||||
|
||||
- **A page in the `NavigationView` inherits nothing.** `NavigationViewContentPresenter` is a `Frame`, and a Frame sets
|
||||
`InheritanceBehavior.SkipToAppNow`; WPF UI 4.3.0 makes the TextBlock default black. A page on screen during a theme
|
||||
switch takes the window's new colour through the switch and a page navigated to afterwards does not, so it came and
|
||||
went. Every check before hosted pages straight in a window and measured a page the App never draws — host a page in the
|
||||
presenter (`PagesLoadTests.Hosted`, `16_WPFUI_SYNTAX` §Gotchas).
|
||||
- **The accent is not in the theme dictionary.** WPF UI writes it into `Application.Resources` at every
|
||||
`ApplicationThemeManager.Apply(…, updateAccent: true)`; a test that swaps only the dictionary measures the other theme's
|
||||
accent (`Visuals.UnderTheme` derives it as the App does; `systemAccentColor: true` reads the machine's own palette).
|
||||
- **The gate's own refusals look like findings on the wire.** `HookedCaptureGate` puts a label ("kill switch", "previously
|
||||
blocked") where a family goes; whatever reads a family as "an anti-cheat was found" asks the end reason first. A test
|
||||
of what the user reads builds the event as the Agent does (`NoticesFromTheAgentTests`), never by hand — the
|
||||
hand-written events were why every notice test was green.
|
||||
- **`Safety_Consent_*` strings are versioned with the consent disclosure** (`SafetyDisclosure`): a message that is wrong
|
||||
on one path gets a key of its own rather than a changed meaning.
|
||||
- **A release's natives were `-dirty` by the release's own hand:** its date substitution edits `legal/*.md` before CMake
|
||||
reads describe. The id is read first, handed in, and read back out of the binaries (`tools/buildid-check.ps1`).
|
||||
- **Met again:** `CaptureHostEndToEndTests.WhenTheTargetExitsTheHostStopsAndSaysWhy` (`TargetNotRunning` on a slow
|
||||
runner) failed #286's first CI run; the job was re-run. **And a new one** failed #288's:
|
||||
`…LaunchModeOnAVulkanTargetAttachesToTheLayersRingAndInjectsNothing`. A hosted runner has the Vulkan loader and no
|
||||
device, so the harness exits 77 with a `[SKIP]` line — but the runner is elevated, the launch goes through
|
||||
`CreateProcessWithTokenW` (`UnelevatedProcess`), the child inherits no stdout, and the line never reaches the host's
|
||||
output; when the guard's scan hits the exiting harness (`ModuleScanFailed`) the test fails instead of skipping. Re-run;
|
||||
~~the deterministic fix is a task of its own~~ fixed the same day by beta.18 PR-5 (the test asks the harness itself,
|
||||
before the host runs), which also gave the `TargetNotRunning` case a 15 s hold (`13_CI_CD` §ci.yml).
|
||||
|
||||
**Owner-only, added to the list below:** item 14.
|
||||
|
||||
Loaded 100 of 733 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user