Compare commits
61
Commits
No files matched your search
+257
@@ -59,6 +59,102 @@ 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 and D100) ---
|
||||
# Qodana's linters run ReSharper's engine - Qodana for .NET since 2026-11-11, the Community linter before it - and the
|
||||
# engine 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. (What is NOT ReSharper's - a whole severity, the
|
||||
# IntelliJ platform's Markdown and XML inspections, JetBrains' security rules - has no key here and is in qodana.yaml.)
|
||||
[*.{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
|
||||
|
||||
[*.resx]
|
||||
# A vi or ja value that equals the English one is deliberate: product and technology names, units and format strings
|
||||
# are not translated, and a ja safety string is the English verbatim until a reviewer signs it (docs/09_I18N.md;
|
||||
# tools/resx-audit.ps1 holds that rule). 271 results on Qodana for .NET's first run.
|
||||
resharper_overridden_with_same_value_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 +168,164 @@ 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
|
||||
|
||||
# --- ReSharper C++ inspections: what Qodana's native report reads (docs/13_CI_CD.md §Qodana, D99 and D100) ---
|
||||
# The native report runs ReSharper's C++ engine, and with it the clang-tidy checks and clang diagnostics that engine
|
||||
# bundles (the keys that say clang_tidy). The native code is built by MSVC alone, with /W4 /WX; what clang says about
|
||||
# code it never compiles is read here as advice. An inspection is off only where it argues with a choice this project
|
||||
# made, and each line says which; everything else the report found was fixed.
|
||||
[src/native/**.{cpp,h,inl}]
|
||||
# Where the compiler pads a struct. Information, not a fault: the layouts that matter are asserted (static_assert on
|
||||
# sizes and offsets in fl_shm.h, and the mirror test against fl-layout-dump).
|
||||
resharper_cpp_clang_tidy_clang_diagnostic_padded_highlighting = none
|
||||
# MSVC's own keywords - __try/__except (rule 5's guard around every hook body), __declspec, __stdcall. This code is
|
||||
# built by MSVC and by nothing else.
|
||||
resharper_cpp_clang_tidy_clang_diagnostic_language_extension_token_highlighting = none
|
||||
# A function looked up by name - GetProcAddress, vkGetInstanceProcAddr, a vtable slot - comes back as a pointer to
|
||||
# another function type and is cast to its real one: that is the API. Through void* is how the cast says it is meant.
|
||||
resharper_cpp_clang_tidy_clang_diagnostic_cast_function_type_strict_highlighting = none
|
||||
resharper_cpp_clang_tidy_bugprone_casting_through_void_highlighting = none
|
||||
# Memory read as something else - a COM object as its vtable, a relay's bytes as an address - says reinterpret_cast,
|
||||
# also where static_cast from void* would compile.
|
||||
resharper_cpp_reinterpret_cast_from_void_ptr_highlighting = none
|
||||
# It proposes std::cmp_less for a comparison whose sides differ in sign. The comparisons it found cast one side
|
||||
# explicitly, and the compiler's own sign warnings (C4018, C4388, C4389) are errors in this build.
|
||||
resharper_cpp_clang_tidy_modernize_use_integer_sign_comparison_highlighting = none
|
||||
# A `default:` under a switch that names every enumerator is deliberate: a value outside the enumeration - a corrupt
|
||||
# one, a future one - takes the refusing arm instead of falling out of the switch.
|
||||
resharper_cpp_clang_tidy_clang_diagnostic_covered_switch_default_highlighting = none
|
||||
# "Not eliding copy on return": a verdict returned from a const local is copied. It is a few words wide.
|
||||
resharper_cpp_clang_tidy_clang_diagnostic_nrvo_highlighting = none
|
||||
# A type that owns a handle deletes its copies or declares none; the moves are then not generated either, which is
|
||||
# what is wanted. Four more `= delete` lines would say nothing the destructor did not.
|
||||
resharper_cpp_clang_tidy_cppcoreguidelines_special_member_functions_highlighting = none
|
||||
# An enumeration zero-initialised (`D3D_FEATURE_LEVEL got{}`) is an out parameter cleared before the call that fills it.
|
||||
resharper_cpp_clang_tidy_bugprone_invalid_enum_default_initialization_highlighting = none
|
||||
# An enumeration's width is part of a layout or of the atomic word it is stored in, not a size to be minimised.
|
||||
resharper_cpp_clang_tidy_performance_enum_size_highlighting = none
|
||||
# "Possibly unused #include": a file that calls std::memset includes <cstring>, also when <windows.h> already brought
|
||||
# it in. What it reported was of that kind, or a header named again inside a conditional block, but for two that
|
||||
# nothing used; those were removed.
|
||||
resharper_cpp_unused_include_directive_highlighting = none
|
||||
# A function another file calls by a declaration of its own (the harness's Hold* functions), an entry point the
|
||||
# loader calls by name (DllMain), a placeholder a target links: "can be made static" reads one file.
|
||||
resharper_cpp_use_internal_linkage_highlighting = none
|
||||
# "Can be made const": a parameter or a method through which the code acts on a device, a ring or a handle is not
|
||||
# const because the type system would allow it; and a local that is already const gains nothing from constexpr - for a
|
||||
# std::string it would hold only while the text fits the small-string buffer.
|
||||
resharper_cpp_parameter_may_be_const_ptr_or_ref_highlighting = none
|
||||
resharper_cpp_member_function_may_be_const_highlighting = none
|
||||
resharper_cpp_variable_can_be_made_constexpr_highlighting = none
|
||||
# THE ENGINE MISREADS THESE. (1) `std::atomic_ref<T>{x}.fetch_or(bit)` is reported as an expression without side
|
||||
# effects; the side effect is the call. (2) A Win32, D3D12 or ffx-api structure is zero-initialised and then filled
|
||||
# field by field - the reserved fields must stay zero - and is handed to the API by its address or its header's: the
|
||||
# engine reports the initialiser as always rewritten and the fields as assigned and never used. (3) A test of a
|
||||
# constexpr function (`Check(F(a) == b && G(a) == c, ...)`) has the engine evaluate it and call one side redundant.
|
||||
resharper_cpp_expression_without_side_effects_highlighting = none
|
||||
resharper_cpp_initialized_value_is_always_rewritten_highlighting = none
|
||||
resharper_cpp_assigned_value_is_never_used_highlighting = none
|
||||
resharper_cpp_redundant_boolean_expression_argument_highlighting = none
|
||||
# Proposals to restate working code in a newer idiom - a range-for, std::ranges, any_of, starts_with, std::min, a raw
|
||||
# string, an if with an initialiser, emplace_back. The native code is written to be read beside the hook path: an
|
||||
# index and a plain loop, the same in the guard, its tests and the probes.
|
||||
resharper_cpp_clang_tidy_modernize_loop_convert_highlighting = none
|
||||
resharper_cpp_clang_tidy_modernize_use_ranges_highlighting = none
|
||||
resharper_cpp_use_range_algorithm_highlighting = none
|
||||
resharper_cpp_clang_tidy_readability_use_anyofallof_highlighting = none
|
||||
resharper_cpp_clang_tidy_modernize_use_starts_ends_with_highlighting = none
|
||||
resharper_cpp_clang_tidy_readability_use_std_min_max_highlighting = none
|
||||
resharper_cpp_clang_tidy_modernize_raw_string_literal_highlighting = none
|
||||
resharper_cpp_clang_tidy_modernize_use_emplace_highlighting = none
|
||||
resharper_cpp_clang_tidy_modernize_return_braced_init_list_highlighting = none
|
||||
resharper_cpp_use_associative_contains_highlighting = none
|
||||
resharper_cpp_too_wide_scope_highlighting = none
|
||||
resharper_cpp_if_can_be_replaced_by_constexpr_if_highlighting = none
|
||||
|
||||
# A structure Windows defines and this SDK's headers do not give (RTL_PROCESS_MODULE_INFORMATION,
|
||||
# PROCESS_MEMORY_COUNTERS_EX2), and a test's stand-in for a Vulkan dispatchable object, are declared field for field:
|
||||
# the fields nothing names are what puts the others at their offsets.
|
||||
[src/native/{FrameLedger.Injector/src/fl_guard_sources.cpp,FrameLedger.ProcessStats/src/fl_process_stats.cpp,tools/fl-probe-guard/main.cpp,tests/vklayer_test.cpp}]
|
||||
resharper_cpp_declarator_never_used_highlighting = none
|
||||
|
||||
# fl::patch::Install takes its hook engine as a template parameter and calls Create / Enable / Disable on it. The
|
||||
# test's two stand-in engines are used that way and no other, which ReSharper's "never used" does not follow through a
|
||||
# dependent call: six reports, one per member (Qodana, 2026-11-12). The members are the test.
|
||||
[src/native/tests/unhook_inline_test.cpp]
|
||||
resharper_cpp_declarator_never_used_highlighting = none
|
||||
|
||||
# The linter's compiler, not the build's: NVAPI's header makes NvU32 `unsigned int` under clang and `unsigned long`
|
||||
# under MSVC, which is the compiler that builds this probe - and `%lu` is right for it.
|
||||
[src/native/tools/fl-probe-nvapi/main.cpp]
|
||||
resharper_cpp_clang_tidy_clang_diagnostic_format_highlighting = none
|
||||
|
||||
# --- the probes, the harness and the tests ---
|
||||
[src/native/{tools,tests}/**.{cpp,h}]
|
||||
# printf, fprintf, fputs, fclose: a probe prints what it found and a test prints why it failed; neither has anything
|
||||
# to do about a failed write to its own console.
|
||||
resharper_cpp_clang_tidy_cert_err33_c_highlighting = none
|
||||
# atoi on the harness's own arguments, which its tests write: a number that does not parse is 0, and the run that
|
||||
# asked for it fails on its own assertion.
|
||||
resharper_cpp_clang_tidy_bugprone_unchecked_string_to_number_conversion_highlighting = none
|
||||
# A printf-shaped helper (`Note(fmt, ...)`): the attribute clang proposes is not MSVC's, and a parameter pack would
|
||||
# be a second implementation of printf.
|
||||
resharper_cpp_clang_tidy_modernize_avoid_variadic_functions_highlighting = none
|
||||
resharper_cpp_clang_tidy_clang_diagnostic_missing_format_attribute_highlighting = none
|
||||
# `&pointer` handed to an API that takes `void*` (ReadProcessMemory, a memcpy of a vtable slot, a Streamline array of
|
||||
# constants): the conversion is the call's own.
|
||||
resharper_cpp_clang_tidy_bugprone_multi_level_implicit_pointer_conversion_highlighting = none
|
||||
# A test builds a handle or an address from a number, on purpose: a fake one, or one read from another process.
|
||||
resharper_cpp_clang_tidy_performance_no_int_to_ptr_highlighting = none
|
||||
# A macro that pastes its argument into a name (FL_DEV(vkGetDeviceQueue)) cannot put it in parentheses.
|
||||
resharper_cpp_clang_tidy_bugprone_macro_parentheses_highlighting = none
|
||||
# A test's fixture: a global with a std::string in it, a memcpy into a byte buffer that is not a string, two strings
|
||||
# added in an assertion's message.
|
||||
resharper_cpp_clang_tidy_bugprone_throwing_static_initialization_highlighting = none
|
||||
resharper_cpp_clang_tidy_bugprone_not_null_terminated_result_highlighting = none
|
||||
resharper_cpp_clang_tidy_performance_inefficient_string_concatenation_highlighting = none
|
||||
# layout_test checks facts the compiler already knows - a constant's length, a bit-field's range - at run time, so
|
||||
# that a failure prints which one: the branch that cannot be taken is the test passing.
|
||||
resharper_cpp_unreachable_code_highlighting = none
|
||||
resharper_cpp_clang_tidy_clang_diagnostic_unreachable_code_highlighting = none
|
||||
resharper_cpp_clang_tidy_clang_diagnostic_tautological_value_range_compare_highlighting = none
|
||||
|
||||
# --- CODE LOADED INTO A GAME: the Overlay, the Vulkan layer, the shared-memory headers ---
|
||||
# D100: here only a defect is fixed, in a pull request of its own with the hook's overhead measured (rule 5,
|
||||
# 14_TESTING §Hook overhead). The report found none. What it did say about these files, each kept as it is:
|
||||
[src/native/{FrameLedger.Overlay,FrameLedger.VkLayer,FrameLedger.Shm}/**.{cpp,h,inl}]
|
||||
# Arms with the same body are different cases, each with its own comment saying why it reads as it does.
|
||||
resharper_cpp_clang_tidy_bugprone_branch_clone_highlighting = none
|
||||
# MinHook's MH_ALL_HOOKS is NULL, by its header.
|
||||
resharper_cpp_zero_constant_can_be_replaced_with_nullptr_highlighting = none
|
||||
# Kept on purpose, each with its reason beside it in dllmain.cpp: a retired enumerator whose bit must not be reused;
|
||||
# slSetTag, deprecated by a header whose replacement no measured module exports.
|
||||
resharper_cpp_enumerator_never_used_highlighting = none
|
||||
resharper_cpp_clang_tidy_clang_diagnostic_deprecated_declarations_highlighting = none
|
||||
|
||||
# DEAD CODE, FOUND AND NOT REMOVED: nothing calls dllmain.cpp's LogNoteW. D100 changes code loaded into a game for
|
||||
# a defect only, so taking it out is the owner's to order (HANDOFF, the native report's section) and not this
|
||||
# report's to do. Until then this one file is not read for an unused function. Remove this section with it.
|
||||
[src/native/FrameLedger.Overlay/src/dllmain.cpp]
|
||||
resharper_cpp_declarator_never_used_highlighting = none
|
||||
resharper_cpp_clang_tidy_clang_diagnostic_unused_function_highlighting = none
|
||||
|
||||
# The guard's rule matcher, which the Overlay compiles too. ResolveTolerance clears its out parameter with memset, as
|
||||
# ResetRules does: a Tolerance is flags with default member initialisers, which is all "non-trivially default
|
||||
# constructible" means here, and zero is what those initialisers say.
|
||||
[src/native/FrameLedger.Injector/{src/fl_ac_rules.cpp,include/fl_ac_rules.h}]
|
||||
resharper_cpp_clang_tidy_bugprone_raw_memory_call_on_non_trivial_type_highlighting = none
|
||||
@@ -3,9 +3,9 @@
|
||||
#
|
||||
# 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 (10.0.100) with rollForward latestFeature, so every machine and the CI
|
||||
# runner already build with the newest 10.0 SDK they have; raising the floor is
|
||||
# a decision, not an update (docs/12_BUILD.md).
|
||||
# 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
|
||||
|
||||
@@ -20,8 +20,8 @@ name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
# `alpha` since 2026-10-31 (D73, docs/13_CI_CD.md §The alpha line): the same source on a prerelease .NET, whose
|
||||
# merges and syncs from main need the same gate under its own global.json.
|
||||
# `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:
|
||||
|
||||
@@ -16,6 +16,11 @@
|
||||
|
||||
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]
|
||||
@@ -23,6 +28,7 @@ on:
|
||||
branches: [main]
|
||||
schedule:
|
||||
- cron: '27 4 * * 1'
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
@@ -0,0 +1,178 @@
|
||||
# Qodana (owner decisions D93, 2026-11-10, and D99, 2026-11-11; 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 for .NET (Rider's engine) in NATIVE mode, on a Windows
|
||||
# runner: the projects target Windows, and the linter then builds and loads them
|
||||
# with the SDK this job installs from global.json - no container, and no
|
||||
# EnableWindowsTargeting. qodana.yaml names the linter and the mode; nothing is
|
||||
# passed as an action argument. (Until beta.37 this was the Community linter in a
|
||||
# Linux container, the one Linux job this repository had.)
|
||||
# - The action is pinned to a commit, 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, a
|
||||
# Qodana Cloud outage or a lapsed licence is a red job beside a green `check`,
|
||||
# never a blocked merge.
|
||||
# - Two jobs, two reports (D99): `managed` reads the solution - the C#, the XAML and
|
||||
# what Rider's plugins read around it - and reports to the Qodana Cloud project
|
||||
# `frameledger`; `native` reads the C++ of src/native through a Visual Studio
|
||||
# solution CMake generates for it, with settings of its own (qodana-native.yaml),
|
||||
# and reports to `frameledger-cpp`. Neither reads what the other does. The pull
|
||||
# request's comment and annotations are the managed job's alone.
|
||||
# - `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.
|
||||
|
||||
name: Qodana
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
pull_request:
|
||||
branches: [main]
|
||||
push:
|
||||
branches: [main]
|
||||
|
||||
permissions: {}
|
||||
|
||||
concurrency:
|
||||
group: qodana-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
managed:
|
||||
name: Qodana (managed)
|
||||
# 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: windows-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
|
||||
|
||||
# Native mode runs the linter in this job's environment, so the SDK it loads
|
||||
# the projects with is this one. No MSVC step here on purpose: it exports
|
||||
# Platform=x64, which MSBuild reads as a solution platform (build.ps1's
|
||||
# Clear-VcxprojPlatform).
|
||||
- name: Set up .NET
|
||||
uses: actions/setup-dotnet@v6
|
||||
with:
|
||||
global-json-file: global.json
|
||||
|
||||
# Restored only: `check` saves this cache, under the same key.
|
||||
- name: Restore the NuGet cache
|
||||
uses: actions/cache/restore@v6
|
||||
with:
|
||||
path: ~/.nuget/packages
|
||||
key: nuget-${{ runner.os }}-${{ hashFiles('**/Directory.Packages.props', 'global.json') }}
|
||||
restore-keys: nuget-${{ runner.os }}-
|
||||
|
||||
# Built before it is inspected: a build that fails is then one red step with
|
||||
# the compiler's own message, not a report of thousands of unresolved symbols.
|
||||
# The native DLLs are absent here, so the .targets that copy them warn and the
|
||||
# build goes on, as on a fresh clone.
|
||||
- name: Build what the linter loads
|
||||
shell: pwsh
|
||||
run: |
|
||||
dotnet build FrameLedger.slnx -c Release
|
||||
if ($LASTEXITCODE -ne 0) { throw 'the build failed' }
|
||||
|
||||
# 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), under keys of
|
||||
# this job's own: 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
|
||||
artifact-name: qodana-report
|
||||
cache-default-branch-only: true
|
||||
primary-cache-key: qodana-managed-${{ github.ref_name }}-${{ github.sha }}
|
||||
additional-cache-key: qodana-managed-main
|
||||
env:
|
||||
QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}
|
||||
QODANA_ENDPOINT: 'https://qodana.cloud'
|
||||
|
||||
native:
|
||||
name: Qodana (native)
|
||||
# The same condition as `managed`, for the same reason: QODANA_TOKEN_NATIVE
|
||||
# reaches neither a fork's pull request nor Dependabot's.
|
||||
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: windows-latest
|
||||
timeout-minutes: 60
|
||||
# No annotations and no comment from this job (below), so it writes nothing.
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
ref: ${{ github.event.pull_request.head.sha }}
|
||||
fetch-depth: 0
|
||||
|
||||
# global.json sits above the solution, and the linter resolves it.
|
||||
- name: Set up .NET
|
||||
uses: actions/setup-dotnet@v6
|
||||
with:
|
||||
global-json-file: global.json
|
||||
|
||||
# The Visual Studio generator finds the toolset itself: no MSVC step. Configure
|
||||
# fetches MinHook, Catch2 and jsmn into the build tree, as the gate's does.
|
||||
- name: Generate the solution and the one generated header
|
||||
shell: pwsh
|
||||
working-directory: src/native
|
||||
run: |
|
||||
cmake --version
|
||||
cmake --preset x64-vs-analysis
|
||||
if ($LASTEXITCODE -ne 0) { throw 'cmake configure failed' }
|
||||
cmake --build --preset x64-vs-analysis --target fl_ac_floor_gen
|
||||
if ($LASTEXITCODE -ne 0) { throw 'generating the blocklist floor failed' }
|
||||
if (-not (Test-Path ../../build/native/x64-vs-analysis/FrameLedgerNative.slnx)) {
|
||||
Get-ChildItem ../../build/native/x64-vs-analysis -Filter 'FrameLedgerNative.*' | ForEach-Object { Write-Host $_.Name }
|
||||
throw 'CMake did not write FrameLedgerNative.slnx (qodana-native.yaml names it)'
|
||||
}
|
||||
|
||||
# A report of its own: its own settings file, results folder, artifact, cache
|
||||
# keys and Qodana Cloud project. The pull request's comment and annotations are
|
||||
# the managed job's; a second job of the same linter would overwrite them.
|
||||
- name: Qodana Scan
|
||||
uses: JetBrains/qodana-action@3e8d76ff0e0241618abd808682f426afe84bab3f # v2026.2.2
|
||||
with:
|
||||
args: --config qodana-native.yaml
|
||||
results-dir: ${{ runner.temp }}/qodana-native/results
|
||||
cache-dir: ${{ runner.temp }}/qodana-native/caches
|
||||
pr-mode: false
|
||||
upload-result: true
|
||||
artifact-name: qodana-report-native
|
||||
cache-default-branch-only: true
|
||||
primary-cache-key: qodana-native-${{ github.ref_name }}-${{ github.sha }}
|
||||
additional-cache-key: qodana-native-main
|
||||
post-pr-comment: false
|
||||
use-annotations: false
|
||||
env:
|
||||
QODANA_TOKEN: ${{ secrets.QODANA_TOKEN_NATIVE }}
|
||||
QODANA_ENDPOINT: 'https://qodana.cloud'
|
||||
@@ -24,7 +24,7 @@
|
||||
#
|
||||
# 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 a prerelease .NET. Its tags are `vX.Y.Z-alpha.N` and nothing else, no other
|
||||
# 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.
|
||||
@@ -67,10 +67,15 @@ 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@0b201ec74fa43914dc39ae48a89fd1d8cb592756 # v1.13.0
|
||||
|
||||
+8
-5
@@ -9,7 +9,7 @@ barrier. It is written for the person who has just met one; the details for deve
|
||||
FrameLedger is a desktop program: its own window, its dialogs, its document windows, the icon by the clock and the
|
||||
notices Windows shows for it. It draws nothing inside a game, so it cannot make a game itself any easier to use.
|
||||
|
||||
*Beta software: this page describes version 0.1.0-beta.35. In the app: Help ▸ Accessibility.*
|
||||
*Beta software: this page describes version 0.1.0-beta.45. In the app: Help ▸ Accessibility.*
|
||||
|
||||
## What FrameLedger aims for
|
||||
|
||||
@@ -29,7 +29,7 @@ notices Windows shows for it. It draws nothing inside a game, so it cannot make
|
||||
|
||||
| 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. |
|
||||
| **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. **Ctrl+6** opens Advanced the same way while Advanced metrics is switched on, and does nothing while it is off. |
|
||||
| **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. |
|
||||
@@ -95,9 +95,9 @@ from the same translations. The documents — the user guide, this page, the leg
|
||||
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.
|
||||
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, and **Ctrl+6** the Advanced page only while its option is on; 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
|
||||
@@ -107,6 +107,9 @@ from the same translations. The documents — the user guide, this page, the leg
|
||||
|
||||
Each one with what to do instead. A barrier that is not on this list is worth reporting.
|
||||
|
||||
- **The Advanced page's "This PC" does not announce its readings as they change.** They change every second; a
|
||||
screen reader reads the table when you move through it, and each row says its reading, its value and the time it
|
||||
was read at.
|
||||
- **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**.
|
||||
|
||||
+26
-74
@@ -35,82 +35,22 @@ numeric core and does not move; the heading is the full version — corrected 20
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
### 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.
|
||||
- **Hooks go into a game together, and come out together** (owner decision D134). Putting a hook in or taking it
|
||||
out stops every thread of the game for a moment, and until now that happened once for every hook: the thirteen
|
||||
Streamline hooks took 0.7 to 2.8 seconds of a game's start in real sessions (2026-11-13), and stopping a session
|
||||
took about a sixth of a second for each hook — two to three seconds, sometimes on the thread that draws. The
|
||||
hooks a moment finds are now put in under **one** stop of the threads, and a stop takes all of them out under
|
||||
one. On FrameLedger's own test program: nine hooks in 78–90 ms where they took 0.6–0.7 s; eighteen out in
|
||||
76–90 ms where they took 1.4–1.6 s. What a hook reads and when it is installed are unchanged, and no hook's own
|
||||
code changed. The log of the part inside the game has a new line for each such moment (`PATCH_BATCH`, with the
|
||||
time it took and the number of hooks). **Not run in a real game yet.**
|
||||
|
||||
- **The limitations, the accuracy statement and the user guide say what the first real sessions on 0.1.0-beta.45
|
||||
showed** (2026-11-13, six games): five of its six new readings were read in real games — every Streamline game
|
||||
asked whether its features are supported — and no game allocated a feature's resources after FrameLedger was in
|
||||
it, so that row has not been seen. No code changes.
|
||||
|
||||
## Releases
|
||||
|
||||
@@ -118,6 +58,18 @@ Newest first. Each file holds that release's section exactly as it stood here.
|
||||
|
||||
| Version | Date | Notes |
|
||||
|---|---|---|
|
||||
| `0.1.0-beta.45` | 2026-11-12 | [`docs/changelog/0.1.0-beta.45.md`](docs/changelog/0.1.0-beta.45.md) |
|
||||
| `0.1.0-beta.44` | 2026-11-12 | [`docs/changelog/0.1.0-beta.44.md`](docs/changelog/0.1.0-beta.44.md) |
|
||||
| `0.1.0-beta.43` | 2026-11-12 | [`docs/changelog/0.1.0-beta.43.md`](docs/changelog/0.1.0-beta.43.md) |
|
||||
| `0.1.0-beta.42` | 2026-11-12 | [`docs/changelog/0.1.0-beta.42.md`](docs/changelog/0.1.0-beta.42.md) |
|
||||
| `0.1.0-beta.41` | 2026-11-12 | [`docs/changelog/0.1.0-beta.41.md`](docs/changelog/0.1.0-beta.41.md) |
|
||||
| `0.1.0-beta.40` | 2026-11-12 | [`docs/changelog/0.1.0-beta.40.md`](docs/changelog/0.1.0-beta.40.md) |
|
||||
| `0.1.0-beta.39` | 2026-11-11 | [`docs/changelog/0.1.0-beta.39.md`](docs/changelog/0.1.0-beta.39.md) |
|
||||
| `0.1.0-beta.38` | 2026-11-11 | [`docs/changelog/0.1.0-beta.38.md`](docs/changelog/0.1.0-beta.38.md) |
|
||||
| `0.1.0-alpha.4` | 2026-11-11 | [`docs/changelog/0.1.0-alpha.4.md`](docs/changelog/0.1.0-alpha.4.md) |
|
||||
| `0.1.0-beta.37` | 2026-11-11 | [`docs/changelog/0.1.0-beta.37.md`](docs/changelog/0.1.0-beta.37.md) |
|
||||
| `0.1.0-beta.36` | 2026-11-10 | [`docs/changelog/0.1.0-beta.36.md`](docs/changelog/0.1.0-beta.36.md) |
|
||||
| `0.1.0-beta.35` | 2026-11-09 | [`docs/changelog/0.1.0-beta.35.md`](docs/changelog/0.1.0-beta.35.md) |
|
||||
| `0.1.0-alpha.3` | 2026-11-06 | [`docs/changelog/0.1.0-alpha.3.md`](docs/changelog/0.1.0-alpha.3.md) |
|
||||
| `0.1.0-beta.34` | 2026-11-06 | [`docs/changelog/0.1.0-beta.34.md`](docs/changelog/0.1.0-beta.34.md) |
|
||||
| `0.1.0-alpha.2` | 2026-11-03 | [`docs/changelog/0.1.0-alpha.2.md`](docs/changelog/0.1.0-alpha.2.md) |
|
||||
|
||||
@@ -20,6 +20,8 @@ A C++ DLL (`FrameLedger.Overlay.dll`) is injected into games the user explicitly
|
||||
> **Amended 2026-10-03 (owner decision D38): the evidence moved from before the grant to its trial.** "≥ 2 successful Tier-1 sessions" above could never be met by a game blocked at add time — since beta.8 that is every blocked game — nor after a ledger reset. Asked with that, the owner chose: a grant needs no session; the first two hooked sessions under it are a trial, and any end during the trial (a crash, a safety unhook, a floor stop, a new finding, or a stored hooked session with no frames or an abnormal exit) ends the exception **for good** (`games.ac_exception_trial_failed_at`, schema 0017, never cleared). Every other condition above is unchanged, and so is the last sentence.
|
||||
3. **Never implement evasion.** No manual mapping, no PE header erasure, no thread hiding, no signature obfuscation, no unlinking from the PEB module list. Injection uses documented `LoadLibraryW`. The DLL keeps its real name, real exports, and version info. A performance tool must be *visible* to anti-cheat, not hidden from it. Any PR that makes FrameLedger harder to detect is rejected on principle.
|
||||
4. **Never read or write game memory outside our own hooks.** We read arguments passed to APIs we hooked and COM/handle objects we legitimately own. No pattern scanning for game internals, no reading player/entity state, no writing to game memory. Ever.
|
||||
|
||||
> **Amended 2026-11-13 (owner decision D132): a driver's read-only getter, with the device of the swap chain we hook.** Asked with this rule quoted, the owner ruled that calling NVIDIA's two latency getters (`NvAPI_D3D_GetLatency`, `NvAPI_D3D_GetSleepStatus`) with the device behind a swap chain the Overlay hooks is inside this rule: it reads the driver's report, not game memory, and writes nothing. **Nothing shipped does it yet**: a spike on `hook-harness` and a stub comes first (`spike-notes` §31), and a release that carries it needs the owner's go on that result. Getters only, never a setter, a marker or a sleep, and never a call that loads `nvapi64.dll` into a game.
|
||||
5. **The hook must never crash the game.** Every hook body: SEH-guarded, allocation-free, lock-free, no logging, no exceptions crossing the boundary. On repeated faults, self-disable (`17_HOOK_ENGINE` §Fault policy).
|
||||
6. **FPS display rule (product requirement):** wherever FPS is shown and Frame Generation is active, show *Native FPS*, *Displayed FPS*, and the FG factor together (`62 → 118 FPS (×1.9 FG)`). Never a single inflated number. See `docs/03_METRICS.md`.
|
||||
|
||||
@@ -42,7 +44,7 @@ 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`. **The `alpha` branch** (D73–D76, 2026-10-31) builds the same source on a prerelease .NET — .NET 11 RC3, C# 15 — and differs from main only where `docs/12_BUILD.md` §The alpha line lists; code on main must keep compiling as C# 14 on .NET 10, so no C# 15 syntax |
|
||||
| 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 |
|
||||
@@ -73,6 +75,12 @@ RELEASE_LINE # `main`, or `alpha` on the alpha branch (D73, 20
|
||||
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-native.yaml # the same for the native job: the C++ of src/native, through the Visual Studio solution
|
||||
# CMake writes for it (preset x64-vs-analysis), a report of its own (D99)
|
||||
qodana.yaml # Qodana's settings for the managed job of .github/workflows/qodana.yml (D93; Qodana for
|
||||
# .NET on the Ultimate licence since 2026-11-11, D99): the linter, the solution, a gate
|
||||
# of zero problems, and what is switched off that .editorconfig has no key for —
|
||||
# ReSharper's inspections are .editorconfig's resharper_* keys (D100) — 13_CI_CD §Qodana
|
||||
src/
|
||||
native/
|
||||
FrameLedger.Overlay/ # C++20 DLL injected into the game (hooks + ring writer + optional overlay)
|
||||
@@ -97,7 +105,36 @@ src/
|
||||
# composes it from, SessionEndReason, the census/NGX/marker facts;
|
||||
# and Recording/ since 2026-09-10 (PR-D): SessionRecorder,
|
||||
# SessionAggregator + FgLadder, SessionFinalizer, the .partial
|
||||
# writer and PartialRecovery, ExitStatusMapper, the crash policy
|
||||
# writer and PartialRecovery, ExitStatusMapper, the crash policy;
|
||||
# and Advanced/ since 2026-11-11 (D101): AdvancedMetricCatalog, the one
|
||||
# list "Advanced metrics" reads - what is read, and what is not with the
|
||||
# reason (18_GPU_VENDOR_APIS §Advanced metrics) - and the value model
|
||||
# (AdvancedValue / AdvancedFact / AdvancedReading / AdvancedSnapshot) and
|
||||
# the port IAdvancedHardware. Infrastructure implements it: AdvancedHardwareHub
|
||||
# (one reader for the Agent, on its own thread, only while held - D107) over
|
||||
# NvapiAdvancedReader (the bridge's ABI 3) and LhmAdvancedReader (LhmGroups:
|
||||
# the card; as administrator with PawnIO the processor, memory and board -
|
||||
# never storage, D103). The Agent composes it since the switch, `telemetry.advanced`
|
||||
# (PR-5, 2026-11-11: off by default; on, a session holds the hub), and
|
||||
# Ipc/AdvancedMachineResponder answers GetAdvancedMachine from the hub's last
|
||||
# snapshot - each request is the page's hold on it (PR-6, D107). Recording/
|
||||
# AdvancedSessionBuilder stores what a session's samples carried (schema 0023:
|
||||
# machine_profiles + session_advanced, adv.* series with NaN for a gap, D102).
|
||||
# Train B (0.1.0-beta.40, D111): Capture/InGameAdvancedSampler turns the shared
|
||||
# memory's region 5 - what a hooked game told DLSS and FSR, read by the Overlay
|
||||
# only while the session asks (ICaptureObserver.WantsInGameAdvanced) - into session
|
||||
# facts and two adv.* series; reach `Game` in the catalog; no schema change.
|
||||
# Since 0.1.0-beta.43 also what the game tells Streamline each frame and how it
|
||||
# configures FSR frame generation, from two calls hooked only once Advanced has been
|
||||
# asked for; AdvancedInGameCall says of each: read, never called, or not hooked.
|
||||
# Since 0.1.0-beta.44 also what Streamline answers when the game asks about a
|
||||
# feature (its version, what it requires), from two more calls hooked the same
|
||||
# way; ~~a game asks while it starts, so "never called" is the usual answer there~~
|
||||
# (the games run since ask again later, and are read).
|
||||
# Since 0.1.0-beta.45 also whether Streamline says a feature is supported and
|
||||
# loaded, the game switching it, its resources allocated and freed and Streamline
|
||||
# shut down, from six more calls hooked the same way (D130); slInit is not hooked
|
||||
# and its entry says why (AdvancedReach.BeforeAttach, D129).
|
||||
FrameLedger.Infrastructure/ # SQLite, shm reader, vendor APIs, injector interop, parsers,
|
||||
# and Capture/ (PR-C): ShmRingAttacher/ShmCaptureSink over the
|
||||
# reader, HeldProcessLivenessSource, TargetResolver (path only,
|
||||
@@ -120,7 +157,9 @@ src/
|
||||
# is built as of 2026-09-14 (PR-5 Games/Dashboard, PR-6 summary +
|
||||
# charts, PR-7 trend/compare, PR-8a Settings/safety notices/Logs/
|
||||
# --diag, PR-8b tray + the Agent's maintenance flags, PR-9 first run
|
||||
# + Legal Gate FR-11); Strings.resx en/vi/ja. `--data-dir <copy>`
|
||||
# + Legal Gate FR-11); Strings.resx en/vi/ja. The Advanced page
|
||||
# (2026-11-11, D101/D105: Pages/AdvancedPage, there and on Ctrl+6 only
|
||||
# while `telemetry.advanced` is on - 08_UI §Advanced). `--data-dir <copy>`
|
||||
# (beta.15, D52) = a VIEWER: no Agent started or contacted,
|
||||
# nothing on the PC changed, the profile's own folder refused
|
||||
FrameLedger.CaptureHost/ # UNSHIPPED, and since P2 PR-C (2026-09-09) a THIN SHELL: verbs,
|
||||
@@ -148,7 +187,14 @@ tools/ # accuracy-check, changelog-check, chokepoint-che
|
||||
# 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),
|
||||
# docs-split-check (beta.24, D66: CHANGELOG/HANDOFF and their parts agree)
|
||||
# docs-split-check (beta.24, D66: CHANGELOG/HANDOFF and their parts agree),
|
||||
# agent-cost (D110, 2026-11-11: a developer tool, not a gate - what the shipped
|
||||
# Agent costs per second of session, Advanced metrics off and on),
|
||||
# nvapi-readonly-check (D108, 2026-11-11: every NVAPI call of the bridge is on
|
||||
# nvapi-allowed-calls.txt, and none there writes or identifies),
|
||||
# overlay-fields-check (D116, 2026-11-12: every member of a vendor's struct the
|
||||
# Overlay reads for Advanced metrics is in fl_adv_fields.h and on
|
||||
# overlay-allowed-fields.txt; a camera's position, axes and matrices nowhere)
|
||||
# (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
|
||||
@@ -175,13 +221,13 @@ 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 reads the C# and the XAML in an advisory workflow of its own, with a gate of zero problems *(since 2026-11-10, D93; Qodana for .NET on the Ultimate licence since 2026-11-11, D99 — `13_CI_CD` §Qodana)*: fix what it reports, or switch the inspection off with the reason on the line above, **in the place the engine that raised it reads** *(D100)* — one of ReSharper's (C#, XAML, `.resx`, the C++) in `.editorconfig`; what has no key there (the hints as a severity, the Markdown and XML inspections, the files JetBrains' security rules were read in) in `qodana.yaml` — never anywhere else, never without a reason. A new file that starts a process fails `ProcessStartSitesTests`, and Qodana's security rule reports it: read what it starts and where the path and the arguments come from, then list it in the test, in `qodana.yaml` and in `13_CI_CD` §Qodana. 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)*. 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)*.
|
||||
**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)*. Qodana reads it as well, in a report of its own *(since 2026-11-11, D99: ReSharper's C++ inspections and the clang-tidy checks they run, advisory, a gate of zero — `13_CI_CD` §Qodana)*: fix what it reports, or switch the inspection off in `.editorconfig` with the reason above it; **in code loaded into a game only a defect is fixed**, in a pull request of its own with the overhead measured *(D100)*.
|
||||
|
||||
**Licence header —** every first-party source file (`.cs .cpp .h .inl .ps1 .xaml`) opens with two comment lines, `SPDX-License-Identifier: GPL-3.0-only` and `Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE` (beta.12, owner decision D45). GPLv3 §7 requires additional terms to be named in the source files, and `NOTICE` holds them — (b) preserve the notices, (c) mark modified versions, (e) no trademark rights in the name. `tools/notice-check.ps1` is a `build.ps1` gate; `-Fix` writes a missing header. `src/native/third_party/` is excluded.
|
||||
|
||||
**Struct mirroring —** ~~`FlFrameRecord`, `FlShmHandshake`, `FlWriterState` and `FlControlBlock`~~ `FlShmHandshake`, `FlWriterState`, `FlControlBlock`, `FlDisplayState` (layout 4, beta.10), `FlFrameRecord` and `FlTolerance` (D33, beta.9) each exist twice *(corrected 2026-10-04)*: `src/native/FrameLedger.Shm/include/fl_shm.h` / `fl_tolerance.h` (**normative**) and `src/FrameLedger.Shared/ShmLayout.cs` as `[StructLayout(LayoutKind.Sequential)]`. `ShmLayoutMirrorTests` asserts size and every field offset on both sides **against JSON emitted by ~~`tools/fl-layout-dump`~~ `src/native/tools/fl-layout-dump`**, never a transcribed table, and walks the field list in both directions so a field added on either side alone fails.
|
||||
**Struct mirroring —** ~~`FlFrameRecord`, `FlShmHandshake`, `FlWriterState` and `FlControlBlock`~~ `FlShmHandshake`, `FlWriterState`, `FlControlBlock`, `FlDisplayState` (layout 4, beta.10), `FlAdvancedState` (layout 5, 2026-11-11, Advanced metrics train B), `FlFrameRecord` and `FlTolerance` (D33, beta.9) each exist twice *(corrected 2026-10-04)*: `src/native/FrameLedger.Shm/include/fl_shm.h` / `fl_tolerance.h` (**normative**) and `src/FrameLedger.Shared/ShmLayout.cs` as `[StructLayout(LayoutKind.Sequential)]`. `ShmLayoutMirrorTests` asserts size and every field offset on both sides **against JSON emitted by ~~`tools/fl-layout-dump`~~ `src/native/tools/fl-layout-dump`**, never a transcribed table, and walks the field list in both directions so a field added on either side alone fails.
|
||||
|
||||
It also asserts **blittability** (`RuntimeHelpers.IsReferenceOrContainsReferences`), because offsets cannot see it: measured 2026-08-05, swapping the `fixed byte BuildId[32]` for this repo's own `[MarshalAs(ByValTStr)] string` idiom keeps `Marshal.SizeOf` at 64 and every offset correct while `Unsafe.SizeOf` collapses to **40** — a mirror that passes the obvious checks and cannot be read out of a memory-mapped view.
|
||||
|
||||
|
||||
+3
-2
@@ -17,8 +17,9 @@ merged, and under what licence your contribution is accepted.
|
||||
|
||||
## 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
|
||||
|
||||
+23
-9
@@ -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
|
||||
@@ -69,17 +73,27 @@
|
||||
<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 on a prerelease .NET from the long-lived `alpha`
|
||||
branch, where this file and global.json are two of the few lines that differ (docs/12_BUILD.md §The alpha line).
|
||||
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'">
|
||||
@@ -87,7 +101,7 @@
|
||||
</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 are the
|
||||
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). -->
|
||||
|
||||
@@ -6,7 +6,8 @@
|
||||
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.
|
||||
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>
|
||||
@@ -38,7 +39,9 @@
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup Label="Hosting and logging">
|
||||
<PackageVersion Include="Microsoft.Extensions.Hosting" Version="10.0.14" />
|
||||
<!-- 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" />
|
||||
@@ -47,7 +50,7 @@
|
||||
|
||||
<ItemGroup Label="Storage">
|
||||
<!-- No EF: Dapper over Microsoft.Data.Sqlite (CLAUDE.md pinned stack). -->
|
||||
<PackageVersion Include="Microsoft.Data.Sqlite" Version="10.0.14" />
|
||||
<PackageVersion Include="Microsoft.Data.Sqlite" Version="11.0.0" />
|
||||
<PackageVersion Include="Dapper" Version="2.1.89" />
|
||||
<!--
|
||||
No transitive pin on SQLitePCLRaw since beta.30 (2026-10-26). From the scaffold (2026-08-02) to beta.29 this held
|
||||
@@ -57,6 +60,9 @@
|
||||
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.
|
||||
-->
|
||||
</ItemGroup>
|
||||
|
||||
@@ -69,7 +75,7 @@
|
||||
<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.14" />
|
||||
<PackageVersion Include="System.Diagnostics.EventLog" Version="11.0.0" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup Label="Analyzers (build-time only)">
|
||||
|
||||
+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.34.*
|
||||
*Beta software: this page describes version 0.1.0-beta.45.*
|
||||
|
||||
## Games it will not measure
|
||||
|
||||
@@ -51,6 +51,11 @@ shown is recorded too, from outside the game. ([Capture](docs/04_CAPTURE.md))
|
||||
game). Unity's crash handler and Chromium's `crashpad_handler` start with every game that has them, so their presence
|
||||
says nothing. Sessions recorded before 0.1.0-beta.14 keep how they were stored — a few of them may read *crashed*
|
||||
because Windows logged a memory report about the game. ([details](docs/04_CAPTURE.md))
|
||||
- **A game that faults while it is closing can read *ended normally* in a session measured from inside the game.**
|
||||
FrameLedger looks for Windows' crash report when it saves the session, and for such a session that is before
|
||||
Windows has written it; the same fault in a session that was not measured from inside reads *crashed*. Seen on one
|
||||
game whose graphics-driver library faults at every exit, measured or not (2026-11-12), and on a second whose
|
||||
Steam crash handler faults at every measured exit. Not changed yet.
|
||||
|
||||
## Frame rate and frame generation
|
||||
|
||||
@@ -90,7 +95,9 @@ shown is recorded too, from outside the game. ([Capture](docs/04_CAPTURE.md))
|
||||
same games as *Render → output resolution* in the accuracy statement; elsewhere it says it was not measured.
|
||||
- The upscaler is read from the game's calls: DLSS and NIS through NVIDIA Streamline, and FSR through AMD's
|
||||
FidelityFX libraries. **Intel XeSS is not read** (its licence forbids it), FSR 2 and upscalers built into the
|
||||
game are not identified, and Vulkan and OpenGL games read N/A. Where no hook saw DLSS but the NVIDIA driver
|
||||
game are not identified — Cyberpunk 2077's FSR 2.1 is one: its sessions say "unknown" beside a measured render
|
||||
size — and Vulkan and OpenGL games read N/A. A game that sends FSR upscaling through two unrelated libraries in
|
||||
one run is counted from the first alone (none is known). Where no hook saw DLSS but the NVIDIA driver
|
||||
reports it, the page says it is the driver's report.
|
||||
- **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
|
||||
@@ -173,6 +180,84 @@ shown is recorded too, from outside the game. ([Capture](docs/04_CAPTURE.md))
|
||||
- **CPU temperature** needs *Run the agent as administrator* and the separately installed PawnIO driver, and
|
||||
has not been verified on real hardware yet. CPU load is the time the processor was busy — not Task
|
||||
Manager's "utility" figure, which can exceed 100%. ([Telemetry](docs/18_GPU_VENDOR_APIS.md))
|
||||
- **Advanced metrics** (since 0.1.0-beta.39; Settings ▸ Recording, off by default) stores more of what the graphics
|
||||
driver and the sensors report with each session. Its limits:
|
||||
- **A session recorded while it was off is not filled in later**, and switching it on applies from the next session.
|
||||
- **What a game tells DLSS and FSR** (since 0.1.0-beta.40) is kept only for a game FrameLedger measures from
|
||||
inside, and only where the game hands it over in a call FrameLedger intercepts. **Most games set their DLSS
|
||||
options through a call it cannot see and show nothing**; the FSR rows need FSR 3.1 or later through AMD's own
|
||||
library. The session says which it was — nothing seen, or not measured inside the game — and neither means the
|
||||
game uses no upscaler. They are the game's words, not a check of what the upscaler did; the field of view is a
|
||||
lowest and highest value, never a line over time; FSR's memory is a point where the game asked, so most sessions
|
||||
have none. FSR's upscaling values have been read from real games; **the DLSS options have not been confirmed on
|
||||
one yet.**
|
||||
- **What a game tells Streamline each frame, and how it configures FSR frame generation** (since 0.1.0-beta.43)
|
||||
are read from two calls FrameLedger hooks **only once a session with Advanced metrics on has started in that
|
||||
game** — a session recorded with the option off puts neither hook in. Streamline's values are those of **the
|
||||
first viewport that called**: a game with several (split screen, a picture-in-picture view) shows one, and the
|
||||
count of calls covers all. The frame-generation rows are **what the game asked for** — a game that asks for
|
||||
generation and gets none still reads "on", and the session's summary is where what was generated is measured. A
|
||||
setting the game changed during the session reads "on and off". The session's line says, for each of the two,
|
||||
whether it was read, hooked and never called by the game, or not hooked (the game did not load the library).
|
||||
Streamline 1.x is not read. Streamline's values have been read from three real games and the frame-generation
|
||||
configuration from one (2026-11-12); **a configuration that reaches FSR through AMD's 2.3 loader has not been
|
||||
read from a real game yet.** **A game may give a value in a unit of its own**: Cyberpunk 2077 gives Streamline
|
||||
its field of view in degrees where NVIDIA's header says radians. A field of view too large to be radians is
|
||||
shown as the game gave it, with a line saying so, and is never converted (since 0.1.0-beta.44; a session
|
||||
recorded before keeps the line it was stored with, which labels the degrees as radians). The count of resets is
|
||||
the number of calls in which the game said so — menus and loading screens raise it.
|
||||
- **Which version each Streamline feature is, and what it requires** (since 0.1.0-beta.44) are Streamline's
|
||||
answers to two questions a game asks while it starts — and, in the games run so far, again later. FrameLedger
|
||||
hooks the two calls only once a session with Advanced metrics on has started in that game. **A game that asks
|
||||
only at its start shows nothing here**, and the session's line then says the call was hooked and the game did
|
||||
not ask again; the four Unreal Engine games run on 2026-11-12 asked again and were read, and Cyberpunk 2077
|
||||
asked again for the requirements and not for the versions. A second session of a game that kept running keeps
|
||||
what the first one read. The rows are Streamline's answer as the game received it — the versions
|
||||
of Windows and of the driver are the ones Streamline found — not FrameLedger's own check of the PC. Twelve
|
||||
features are kept; a thirteenth is not. The lists the answer points to (the buffers, the Vulkan extensions) are
|
||||
never read, so the rows give how many buffers a feature needs and not which. **The version Streamline gives for
|
||||
a feature can differ from the file in the game's folder** — three games answered 2.14.16 for DLSS frame
|
||||
generation while shipping an older plugin; which file that newer one is was not looked into. The games run so
|
||||
far do not ask Streamline about DLSS upscaling unless they upscale through it, so a game can list frame
|
||||
generation here and no upscaler.
|
||||
- **Whether each Streamline feature is supported and loaded, and what the game did with it** (since
|
||||
0.1.0-beta.45) come from six more calls, hooked the same way — only once a session with Advanced metrics on has
|
||||
started in that game. **What the game did before that is not seen**: a feature it switched on while it started
|
||||
has no "switched" row, and resources it allocated then are not counted. The counts are **calls the game made**,
|
||||
not resources, and each stops at fifteen (shown as `≥ 15`); they and the switching start again with each
|
||||
session, while the two answers are kept from an earlier session of a game that kept running. "Supported" is
|
||||
Streamline's answer for the graphics card the game asked about; which card that was is never read, so on a PC
|
||||
with two cards the row does not say. A refusal is shown by NVIDIA's own name for it
|
||||
(`eErrorFeatureNotSupported`), and it is the game that was refused, not FrameLedger. None of this says a
|
||||
feature ran or drew anything. **Read on five games on 2026-11-13**: each asked whether its features are
|
||||
supported, three asked whether they are loaded, two switched features off and on, one freed a feature's
|
||||
resources once and one shut Streamline down once. **None allocated a feature's resources after FrameLedger was
|
||||
in it**, so that row has not been seen in a real game.
|
||||
- **What a game started Streamline with is not read, and will not be**: the game makes that call once, before
|
||||
FrameLedger can be inside it — also when FrameLedger starts the game itself. The Advanced page lists the entry
|
||||
with that reason.
|
||||
- **The driver's own figures** — the card's firmware and architecture, its memory in detail, what a display can do
|
||||
with HDR and variable refresh, the driver's settings for the game — exist on **NVIDIA** cards only. On other cards
|
||||
they read N/A; the card's sensors (fans, voltages, loads) are read on every brand, and none has been tested on an
|
||||
AMD or Intel card.
|
||||
- **The sensors are read every five seconds**, NVIDIA's figures every second; between two readings a sensor has no
|
||||
value, and its last one is not repeated.
|
||||
- **The processor's, the memory's and the motherboard's sensors** need *Run the agent as administrator* and the
|
||||
separately installed PawnIO driver, and **have never been read on real hardware**. Without them they read N/A
|
||||
with the reason.
|
||||
- **A drive's temperature is not read at all**: the sensor library cannot list drives without touching removable
|
||||
ones. Power supplies, fan controllers and batteries are not read either.
|
||||
- **No serial number and no display identification data (EDID) is read**, so two PCs with the same parts look the
|
||||
same.
|
||||
- **None of these readings has been checked against another tool**, and they are **not in an export or a bug
|
||||
report**.
|
||||
- **The Advanced page's "This PC" is read only while that page is open** (or a game is being recorded), is not
|
||||
stored, and keeps five minutes of each reading in memory. A reading with more than eight parts — every
|
||||
processor core — is drawn as its lowest, average and highest; the table lists each part.
|
||||
- **A session's chart needs its per-second series**, which are kept for the newest sessions of each game only
|
||||
(Settings ▸ Recording); an older session keeps its statistics.
|
||||
|
||||
([Telemetry](docs/18_GPU_VENDOR_APIS.md#advanced-metrics-owner-decisions-d101d108-2026-11-11))
|
||||
- **Whether the graphics card was held back by its power limit or by heat** (since 0.1.0-beta.14) is known only on
|
||||
NVIDIA cards, and only as it was at each once-a-second reading. On other cards it reads N/A.
|
||||
- **Frames per watt** (since 0.1.0-beta.14) counts the game's own frames — never generated ones — against the graphics
|
||||
@@ -183,7 +268,8 @@ shown is recorded too, from outside the game. ([Capture](docs/04_CAPTURE.md))
|
||||
|
||||
Off by default. When on, **Windows asks every time the agent starts** and names an unknown publisher, because
|
||||
FrameLedger is not signed. It lets FrameLedger open games that run as administrator and read the CPU
|
||||
temperature; it does not bypass anti-cheat, does not open protected processes, and does not make games you
|
||||
temperature — with Advanced metrics on, also the processor's, the memory's and the motherboard's sensors — where
|
||||
PawnIO is installed; it does not bypass anti-cheat, does not open protected processes, and does not make games you
|
||||
start from FrameLedger run as administrator. **The risk:** FrameLedger is installed in your user folder, so a
|
||||
program running under your account could replace its files and would then run as administrator the next time
|
||||
you accept the prompt. Turn it on only if you trust everything that runs under your account.
|
||||
@@ -191,7 +277,13 @@ 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.
|
||||
@@ -222,7 +314,9 @@ a barrier is on its own page: [Accessibility](ACCESSIBILITY.md) (in the app: Hel
|
||||
- **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
|
||||
measured session early, which the crash safety counts: two turn hooking off for the game — and since
|
||||
0.1.0-beta.44 the count starts again each time you switch hooking back on (before, one more such end was enough
|
||||
once a game had been switched off). 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))
|
||||
|
||||
@@ -283,13 +377,13 @@ releases unless you choose *Beta* in Settings ▸ Updates, and apply a downloade
|
||||
*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 runs on a .NET that Microsoft has not finished** — .NET 11's release candidate first — 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
|
||||
- **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)).
|
||||
- **Windows 10 22H2 Home and Pro are not supported** by Microsoft for .NET 11; an alpha may run there, but nobody
|
||||
supports it. It does not start at all on a processor without SSE4.2 and POPCNT.
|
||||
- **A failure in the capture agent's own background work ends the agent with a crash report** on an alpha, where a
|
||||
beta's agent stops and exits quietly: .NET 11 reports it that way.
|
||||
- **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
|
||||
|
||||
@@ -12,9 +12,9 @@ app too (Help ▸ User guide, Help ▸ Limitations, Help ▸ Accessibility), and
|
||||
[wiki](https://github.com/poli0981/frameledger/wiki) with the developer pages.
|
||||
|
||||
<!-- accuracy-block:begin -->
|
||||
> ⚠ **What FrameLedger actually measures today — 2026-11-06.** The software is a beta; its latest
|
||||
> **beta is `0.1.0-beta.34`** (2026-11-06), an unsigned installer built from that tag with its
|
||||
> checksums published beside it (alphas — experimental builds on a prerelease .NET — are published apart). The source holds the desktop app
|
||||
> ⚠ **What FrameLedger actually measures today — 2026-11-11.** The software is a beta; its latest
|
||||
> **beta is `0.1.0-beta.45`** (2026-11-12), 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
|
||||
@@ -102,6 +102,33 @@ app too (Help ▸ User guide, Help ▸ Limitations, Help ▸ Accessibility), and
|
||||
> Windows once a second and charted. Processor temperature is read only when the Agent runs as
|
||||
> administrator — an option, off by default, for which Windows asks at every start of the Agent — with
|
||||
> PawnIO installed, and that reading has not yet been checked on real hardware; everywhere else it is `N/A`.
|
||||
> - **Advanced metrics (since beta.39; off unless you switch it on in Settings):** with it on, a session also stores
|
||||
> what the graphics driver and the sensor library report about the hardware — the graphics card's memory, load,
|
||||
> clocks, fans, voltages and power in detail, what a display can do, the driver's settings for the game — as they
|
||||
> report it: NVIDIA's figures once a second, the sensor library's every five seconds. None of these readings has
|
||||
> been checked against another tool. The processor's, the memory's and the motherboard's need the Agent as
|
||||
> administrator with PawnIO and have never been read on real hardware; a drive's temperature is not read. The
|
||||
> Advanced page shows them as they were stored, and what the PC reads at the moment only while that page is open.
|
||||
> - **What a game tells its upscaler (since beta.40; only with Advanced metrics on, only for a game measured from
|
||||
> inside):** the output size, presets and exposure a game hands DLSS, and the sharpening, jitter, exposure, depth
|
||||
> range, field-of-view range, flags and frame time it hands FSR, are read from the arguments of the calls
|
||||
> FrameLedger intercepts and shown as the game stated them — not checked against what the upscaler did. Most games
|
||||
> set their DLSS options through a call that cannot be intercepted and show none; the FSR values need FSR 3.1 or
|
||||
> later through AMD's own library. Since beta.43 also what a game tells NVIDIA Streamline about each frame (jitter,
|
||||
> motion-vector scale, depth range, field-of-view range, how often it reset the upscaler's history — for the first
|
||||
> viewport that called, where a game has several) and how it configures FSR frame generation (the settings it asked
|
||||
> for, not whether frames were generated). Since beta.44 also what Streamline answers when a game asks about a
|
||||
> feature — its version, and what it requires (graphics APIs, V-Sync, GPU scheduling, Windows and driver versions):
|
||||
> Streamline's answer as the game received it, not a check of the PC. A game that asks only while it starts has
|
||||
> none and the session says so; the Unreal Engine games run so far ask again later, and were read. Since beta.45
|
||||
> also whether Streamline says each feature is supported and whether it is loaded, and what the game did with it
|
||||
> after FrameLedger attached — switched it on or off, allocated and freed its resources (counted to fifteen), shut
|
||||
> Streamline down: calls the game made, not a statement that a feature ran or produced anything. FSR's upscaling
|
||||
> values, Streamline's constants (seven games), its answers about a feature (seven games), the
|
||||
> frame-generation configuration (one game) and five of beta.45's six calls (five games) have been read from
|
||||
> real games; no game run so far allocated a feature's resources after FrameLedger attached, and the DLSS
|
||||
> options have not been confirmed on one yet. A game may give a value in a unit of its own: one gives
|
||||
> Streamline its field of view in degrees, and it is shown as given.
|
||||
> - **Safety:** every pre-injection check runs before injection, including the signed-by-a-known-vendor
|
||||
> half of the suspicious-module rule. During every capture the Agent re-runs the checks every 30 s and
|
||||
> stops capturing on a refusal: a Direct3D or OpenGL game's hooks are removed, and the Vulkan layer
|
||||
@@ -169,7 +196,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
|
||||
|
||||
@@ -177,7 +205,7 @@ Elevation is **optional — for everything.** Hooked capture is the normal path
|
||||
|
||||
## Install
|
||||
|
||||
> **The latest beta is `v0.1.0-beta.34` (2026-11-06); before it `v0.1.0-beta.33` (2026-11-03), `v0.1.0-beta.32` (2026-10-31), `v0.1.0-beta.31` (2026-10-26), `v0.1.0-beta.30` (2026-10-26), `v0.1.0-beta.29` (2026-10-25), `v0.1.0-beta.28` (2026-10-20), `v0.1.0-beta.27` (2026-10-20), `v0.1.0-beta.26` (2026-10-19), `v0.1.0-beta.25` (2026-10-19), `v0.1.0-beta.24` (2026-10-19), `v0.1.0-beta.23` (2026-10-14), `v0.1.0-beta.22` (2026-10-13), `v0.1.0-beta.21` (2026-10-13), `v0.1.0-beta.20` (2026-10-12), `v0.1.0-beta.19` (2026-10-12), `v0.1.0-beta.18` (2026-10-07), `v0.1.0-beta.17` (2026-10-07), `v0.1.0-beta.16` (2026-10-06), `v0.1.0-beta.15` (2026-10-06), `v0.1.0-beta.14` (2026-10-06), `v0.1.0-beta.13` (2026-10-04), `v0.1.0-beta.12` (2026-10-04), `v0.1.0-beta.11` (2026-10-03), `v0.1.0-beta.10` (2026-09-28), `v0.1.0-beta.9` (2026-09-26), `v0.1.0-beta.8` (2026-09-25), `v0.1.0-beta.7` (2026-09-23), `v0.1.0-beta.6` (2026-09-23), `v0.1.0-beta.5` (2026-09-22), `v0.1.0-beta.4` (2026-09-21), `v0.1.0-beta.3` (2026-09-21), `v0.1.0-beta.2` (2026-09-17) and `v0.1.0-beta.1` (2026-09-16).** They are pre-releases: read the notes of the one you install — `CHANGELOG.md` links each release's own file under `docs/changelog/` — for what it measures, what it does not yet, and how to update, before installing. A source build is `docs/12_BUILD.md`.
|
||||
> **The latest beta is `v0.1.0-beta.45` (2026-11-12); before it `v0.1.0-beta.44` (2026-11-12), `v0.1.0-beta.43` (2026-11-12), `v0.1.0-beta.42` (2026-11-12), `v0.1.0-beta.41` (2026-11-12), `v0.1.0-beta.40` (2026-11-12), `v0.1.0-beta.39` (2026-11-11), `v0.1.0-beta.38` (2026-11-11), `v0.1.0-beta.37` (2026-11-11), `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**.
|
||||
|
||||
@@ -25,8 +25,14 @@
|
||||
-->
|
||||
<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>
|
||||
<!--
|
||||
Tests repeat their arrange steps on purpose; duplication there is not a defect.
|
||||
HookFamilies.cs is the Domain's mirror of FlHookFamily (ShmLayout.cs): Domain references nothing, so the enum is
|
||||
written twice by design and MetricEnumMirrorTests fails when the two differ. Six members added at once
|
||||
(0.1.0-beta.45) were 39 duplicated lines of 1,063 new ones, 3.7 % against the gate's 3 %, and failed it on the
|
||||
release's commit with no issue open. The mirror is left out of the detection; FlHookFamily itself is not.
|
||||
-->
|
||||
<Property Name="sonar.cpd.exclusions">tests/**,src/native/tests/**,src/FrameLedger.Domain/Metrics/HookFamilies.cs</Property>
|
||||
|
||||
<Property Name="sonar.sourceEncoding">UTF-8</Property>
|
||||
|
||||
|
||||
@@ -479,6 +479,26 @@ function Invoke-ProjectGates {
|
||||
# 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.
|
||||
# 2026-11-11 (D108): "the bridge never calls a setter" was a sentence in docs/18 a reviewer checked by reading one
|
||||
# file. With Advanced metrics the bridge calls forty-four NVAPI entry points, and the header declares a setter beside
|
||||
# almost every getter: each call is held to tools/nvapi-allowed-calls.txt, in both directions, and a writer or a
|
||||
# reader of an identifier (D104) is red even when the list names it. Text only - it runs with or without the native
|
||||
# build.
|
||||
Write-Step 'nvapi-readonly-check'
|
||||
$nvapiTool = Join-Path $repo 'tools/nvapi-readonly-check.ps1'
|
||||
Invoke-Checked 'nvapi-readonly-check (self-test)' { & $nvapiTool -SelfTest }
|
||||
Invoke-Checked 'nvapi-readonly-check' { & $nvapiTool -RepoRoot $repo }
|
||||
|
||||
# 2026-11-12 (D116): the same for the code loaded into a game. Advanced metrics, train B, reads more members of
|
||||
# the vendors' structs than the frame record ever needed, and the same structs hold where the player's camera is.
|
||||
# Every such read is in one header, each member on tools/overlay-allowed-fields.txt in both directions; a camera's
|
||||
# position, axes and matrices are named nowhere in the Overlay or the Vulkan layer, whatever the list says. Text
|
||||
# only.
|
||||
Write-Step 'overlay-fields-check'
|
||||
$fieldsTool = Join-Path $repo 'tools/overlay-fields-check.ps1'
|
||||
Invoke-Checked 'overlay-fields-check (self-test)' { & $fieldsTool -SelfTest }
|
||||
Invoke-Checked 'overlay-fields-check' { & $fieldsTool -RepoRoot $repo }
|
||||
|
||||
Write-Step 'docs-split-check'
|
||||
$splitTool = Join-Path $repo 'tools/docs-split-check.ps1'
|
||||
Invoke-Checked 'docs-split-check (self-test)' { & $splitTool -SelfTest }
|
||||
|
||||
@@ -162,7 +162,7 @@ The profile's own folder is refused there.)*
|
||||
- **ADR-8:** **No evasion, ever** (`19_SAFETY` §What we will never build). This is an architectural constraint, not a preference — it defines what "correct" means for this codebase.
|
||||
- **ADR-9:** Elevation demoted from required to optional; the Agent runs as a standard user by default.
|
||||
**Chosen, not inherited, since beta.10 (owner decision D34, 2026-09-27):** Settings ▸ Capture agent ▸ *Run the agent as
|
||||
administrator* (`capture.run_elevated`, off by default, a versioned disclosure — `agent-admin-dialog/1` — before it turns
|
||||
administrator* (`capture.run_elevated`, off by default, a versioned disclosure — `agent-admin-dialog/2` *(`/1` until 2026-11-11, when Advanced metrics widened what the option adds — D101)* — before it turns
|
||||
on). With it on, **Windows is asked every time the Agent starts** — a UAC prompt owned by the App's window when the App
|
||||
starts it, flashing on the taskbar when the logon task does — and there is no silent path: no "highest privileges" task,
|
||||
no service. The elevated Agent is started for one user (`--serve --for-user <SID>`) and refuses to run as another
|
||||
|
||||
+8
-2
@@ -53,6 +53,7 @@ Requirement IDs (`FR-x`, `NFR-x`) are referenced by other docs, commits, and tes
|
||||
- FR-5.3 Charts handle ≥ 500k points via min/max decimation; zoom/pan; PNG export.
|
||||
- FR-5.4 Native/Displayed toggle wherever FG data exists.
|
||||
- FR-5.5 Stutter markers annotated with cause when known (`PSO compile`, `VRAM budget exceeded`).
|
||||
- FR-5.6 *(owner decision D101, 2026-11-11)* **Advanced metrics**: an option, off by default, and a page of its own that shows what the vendor interfaces make available — NVAPI, LibreHardwareMonitor through PawnIO, and in later releases Streamline and FidelityFX inside the game — each value under what it belongs to, the PC or one session, and each value that is not read listed with the reason. Off means nothing more is read or stored. `18_GPU_VENDOR_APIS` §Advanced metrics is the design and the inventory. *(Not built: the catalog exists, nothing reads it yet.)*
|
||||
|
||||
### 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.
|
||||
@@ -104,7 +105,7 @@ Draw live FPS/frametime/upscaler info inside the game. Only for games already ho
|
||||
## Non-functional requirements
|
||||
|
||||
- **NFR-1 Game-side overhead:** ≤ 1 µs per present, ≤ 8 MB resident, measured game FPS impact ≤ 0.5% vs uninstrumented.
|
||||
- **NFR-2 Agent overhead:** ≤ 1% of one core during capture, ≤ 150 MB working set, ~0% idle.
|
||||
- **NFR-2 Agent overhead:** ~~≤ 1% of one core during capture~~ **≤ 2.5 % of one core during capture** *(owner decision D117, 2026-11-11: the 1 % had never been measured; measured in a real Agent it is 1.93 % with Advanced metrics off and 2.04 % with it on — `20_OPEN_QUESTIONS` §M16, `tools/agent-cost.ps1` — nearly all of it the once-a-second read of the graphics card's sensors, which stays)*, ≤ 150 MB working set *(measured: 113 MiB off, 119 MiB on)*, ~0% idle. *(D101, 2026-11-11: the limits hold with Advanced metrics on — FR-5.6. Its reads run on a thread of their own, the slow ones seldom, and with no game running only while its page is open (D107), so "~0% idle" is not spent on it. Measured on the development PC in a session that is not hooked; a hooked session, an elevated Agent with PawnIO's groups and a real game are the owner's run, `HANDOFF` §Owner-only.)*
|
||||
- **NFR-3 Stability:** faults **originating in our own hook bodies** are contained by `FL_HOOK_GUARD`, counted, and self-disable the Overlay after 3 occurrences; the safety-unhook path completes within one frame. The Overlay adds no allocation, lock, syscall or logging to the present path.
|
||||
|
||||
> This deliberately does **not** say "must never crash a game" (`20_OPEN_QUESTIONS` §H8). SEH containment cannot reliably catch stack overflow, cannot intercept `__fastfail` — and `-D_HAS_EXCEPTIONS=0` converts a would-be STL throw into exactly that (`spike-notes.md` §H3) — and does not help when the game installs a vectored exception handler that runs first. An absolute promise the mechanism cannot support does not belong in a requirement, and must stay out of user-facing text: the Disclaimer already says injection carries risk, and that wording is the honest one.
|
||||
@@ -112,7 +113,12 @@ 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-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.
|
||||
|
||||
@@ -687,6 +687,18 @@ From the upscaler hooks we get, per frame:
|
||||
> 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).
|
||||
- **One technology's name, quality and size** *(2026-11-12, owner decision D120)*. A session's — and a segment's —
|
||||
upscaler is **the technology named on the most samples of the dominant stream** (a tie goes to the lower value, as
|
||||
the quality byte's does), not the first one any record names. While a session names one technology, its quality
|
||||
and render size are read from the whole stream as before: under frame generation the name sits on one present in
|
||||
N. When it names **more than one**, the quality and the size are read **only from the samples that name the
|
||||
chosen one**, a quality byte of the other family is withheld (`UpscalerChoice.QualityFor`), and the session is
|
||||
marked "settings changed during session". The session this was found on (Dying Light: The Beast, 81 seconds:
|
||||
DLSS evaluated for most of it, an FSR dispatch for a few seconds) had been stored as "DLSS" with FSR's Balanced
|
||||
byte and FSR's render size — three true readings of two technologies under one name. What the chosen technology
|
||||
did not say stays N/A (rule 7). `Domain.Metrics.UpscalerChoice`; the live card still names the first technology
|
||||
the session saw (`FgLadder.UpscalerIdentity`), which for a session in progress is a different question and was
|
||||
not changed.
|
||||
- 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
|
||||
|
||||
+6
-2
@@ -26,6 +26,9 @@ public interface IFrameSource : IAsyncDisposable
|
||||
> DrainResult Drain(Span<FlFrameRecord> into, IList<ulong> gapIndices);
|
||||
> void PublishGuardResult(uint completedEvaluations, bool unhookRequested);
|
||||
> void SetPaused(bool paused); void RequestLogFlush();
|
||||
> FlAdvancedState? AdvancedState { get; } void SetAdvancedRequested(bool requested); // region 5, train B (2026-11-12): the
|
||||
> // word is written either way as the ring is attached, before the first guard result; the region is read only by
|
||||
> // a session whose observer WantsInGameAdvanced, and carried on CaptureProgress.InGameAdvanced
|
||||
> }
|
||||
> public sealed class CaptureSession(...) // the loop: gate → inject → attach → drain, until something ends it
|
||||
> {
|
||||
@@ -428,7 +431,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
|
||||
@@ -536,7 +540,7 @@ Crash-within-60s-of-injection happening twice for the same game ⇒ **hooking au
|
||||
|---|---|
|
||||
| Game process, per present | ≤ 1 µs; no syscall, no allocation, no lock, no logging (`17_HOOK_ENGINE`) |
|
||||
| Game process, resident | ≤ 8 MB (DLL + ring) |
|
||||
| Agent, during capture | ≤ 1% of one core average, ≤ 150 MB working set |
|
||||
| Agent, during capture | ~~≤ 1%~~ ≤ 2.5 % of one core average *(NFR-2 as D117 amended it, 2026-11-11: measured 1.93 %, `20_OPEN_QUESTIONS` §M16)*, ≤ 150 MB working set |
|
||||
| Agent, idle | ~0% (1 Hz process poll only) |
|
||||
| Measured game FPS impact | ≤ 0.5% vs uninstrumented, verified per release (`14_TESTING` §Hook overhead) |
|
||||
|
||||
|
||||
+64
-1
@@ -2,7 +2,7 @@
|
||||
|
||||
`%LOCALAPPDATA%\FrameLedger\ledger.db`. Pragmas: `journal_mode=WAL`, `synchronous=NORMAL`, `foreign_keys=ON`, `busy_timeout=5000`. `Microsoft.Data.Sqlite` + Dapper; all writes in explicit transactions.
|
||||
|
||||
**Writer ownership:** Agent writes `sessions`, `session_segments`, `frame_blobs`, `sensor_blobs`, `hardware_snapshots`, the hook-state columns on `games`, **and since P4 PR-1 (2026-09-14) the *detected* columns on `games`** — `engine`, `engine_version`, `platform` under the per-field provenance rule (`05_DETECTION` §Caching: a `user` field is never touched), `capability_flags` whole, and the cache key `detection_rules_version` / `detection_exe_size_bytes` / `detection_exe_mtime_ms`, and since schema 0011 (2026-09-25) the executable's own facts `exe_machine` / `exe_file_version` / `exe_product_version` / `library_versions`, written whole like the flags — through `IGameRepository.ApplyDetectionAsync` only. The UI and the Agent were both already writers of `games`; this adds columns to the Agent's half, not a third writer (HANDOFF §P4). **And since P4 PR-4 the UI's library import writes `platform`, `store_id` and `game_version` through `ApplyStoreMetadataAsync`** — the same per-field provenance rule, badged `detected` (a store's record is not the user's typing), on columns the UI already owned. **And since 2026-09-23 the Agent's relocator merges two entries for one executable under two drive letters** (`IGameMerge`, HANDOFF D26, `19_SAFETY` §A moved drive is the same executable): in one transaction it re-parents the dropped entry's `sessions` to the survivor (before the delete — `sessions.game_id` cascades), carries a block or a crash auto-disable still in force to the survivor (`hook_enabled` only ever to 0; `hook_blocked_reason` is copied, never originated or cleared), adds the crash counts, deletes the dropped `games` row, and then moves the survivor to the file's path (after the delete — `exe_path` is UNIQUE). It was the one Agent write that deletes a `games` row until beta.19; it never touches a consent column. **And since beta.19 (2026-10-12, D55) the Agent removes an entry whose game is no longer installed** (`IGamePrune`, `SqliteGamePrune`, asked by the detection sweep through `UninstalledEntryPrune`): one `DELETE` that holds every stored condition in the same statement — the same row at the same path, `removed_at` NULL, no session stored (`NOT EXISTS` on `sessions` — nothing cascades), no `hook_blocked_reason`, `hook_prescan_state` not `blocked`, no `ac_exception_at` and no `ac_exception_trial_failed_at` — behind `retention.remove_uninstalled_games`; a block, a grant and D38's mark are never removed with their entry (`19_SAFETY` §What a finding does to the game, *What clears it*). **And since 2026-09-23 the UI writes `record_sessions`** (schema 0009, FR-1.6): the entry's recording switch, which the Agent only reads — off, the watcher does not watch for the program. The script's one data change switches it off for entries an old import made for Steam's own tools (`SteamLibrarySource.KnownTools`, the ids as of the script); a twin merge keeps it off when either twin had it off. **And since 2026-09-25 the Agent's pre-scan of the library (`19_SAFETY` §What a finding does to the game) writes the hook-state columns of every entry, not only of those the user asked to hook** — `hook_prescan_state`, and on a finding `hook_enabled = 0` and `hook_blocked_reason` — and its own key, `hook_prescan_rules_version` / `hook_prescan_exe_size_bytes` / `hook_prescan_exe_mtime_ms` (schema 0010), through `IGameConsentStore.RecordPreScanAsync` only: columns that were already the Agent's, never over a block, never a new row. **And since 2026-09-26 (schema 0014, D33) the Agent writes the user-mode exception's columns** — `ac_exception_*` on `games` through `IGameConsentStore` only (eligibility from the sweep, a grant from the `SetAntiCheatException` command, every end), and `sessions.ac_exception_family` with the session — the grant only after the user accepted its disclosure in the UI, which asks and never writes. **And since 2026-10-03 (beta.11, D40) the Agent deletes sessions on request** — every session of one game or of every game, `DeleteSessions` over the pipe, through `ISessionRepository.DeleteSessionsAsync` in one transaction (segments, blobs and annotations cascade), never while one is being recorded; the UI asks and never deletes a session row itself *(for Delete all sessions; FR-1.4's removal is the App's own cascade, above — corrected 2026-10-04)*. **Maintenance (P4 PR-7) adds no writer:** the retention sweep on demand is the Agent's, asked over the pipe; the UI's `VACUUM` rewrites pages with the same contents and changes no row (§Retention built note). UI writes `games` (user-editable fields — since P3 PR-3 that is the FR-1.3 metadata, the `*_default` tri-states, and `removed_at`; ~~never a `hook_*` column~~ **and two downgrades** *(corrected 2026-10-04)*: *Change executable* (2026-09-21, `GameLibrary.ChangeExecutableAsync`) turns hooking off, clears the consent and pre-scan columns and ends an exception grant — it never writes a block or a grant — and *Remove game ▸ DeLine truncated
|
||||
**Writer ownership:** Agent writes `sessions`, `session_segments`, `frame_blobs`, `sensor_blobs`, `hardware_snapshots`, *(since schema 0023, 2026-11-11)* `machine_profiles` and `session_advanced`, the hook-state columns on `games`, **and since P4 PR-1 (2026-09-14) the *detected* columns on `games`** — `engine`, `engine_version`, `platform` under the per-field provenance rule (`05_DETECTION` §Caching: a `user` field is never touched), `capability_flags` whole, and the cache key `detection_rules_version` / `detection_exe_size_bytes` / `detection_exe_mtime_ms`, and since schema 0011 (2026-09-25) the executable's own facts `exe_machine` / `exe_file_version` / `exe_product_version` / `library_versions`, written whole like the flags — through `IGameRepository.ApplyDetectionAsync` only. The UI and the Agent were both already writers of `games`; this adds columns to the Agent's half, not a third writer (HANDOFF §P4). **And since P4 PR-4 the UI's library import writes `platform`, `store_id` and `game_version` through `ApplyStoreMetadataAsync`** — the same per-field provenance rule, badged `detected` (a store's record is not the user's typing), on columns the UI already owned. **And since 2026-09-23 the Agent's relocator merges two entries for one executable under two drive letters** (`IGameMerge`, HANDOFF D26, `19_SAFETY` §A moved drive is the same executable): in one transaction it re-parents the dropped entry's `sessions` to the survivor (before the delete — `sessions.game_id` cascades), carries a block or a crash auto-disable still in force to the survivor (`hook_enabled` only ever to 0; `hook_blocked_reason` is copied, never originated or cleared), adds the crash counts, deletes the dropped `games` row, and then moves the survivor to the file's path (after the delete — `exe_path` is UNIQUE). It was the one Agent write that deletes a `games` row until beta.19; it never touches a consent column. **And since beta.19 (2026-10-12, D55) the Agent removes an entry whose game is no longer installed** (`IGamePrune`, `SqliteGamePrune`, asked by the detection sweep through `UninstalledEntryPrune`): one `DELETE` that holds every stored condition in the same statement — the same row at the same path, `removed_at` NULL, no session stored (`NOT EXISTS` on `sessions` — nothing cascades), no `hook_blocked_reason`, `hook_prescan_state` not `blocked`, no `ac_exception_at` and no `ac_exception_trial_failed_at` — behind `retention.remove_uninstalled_games`; a block, a grant and D38's mark are never removed with their entry (`19_SAFETY` §What a finding does to the game, *What clears it*). **And since 2026-09-23 the UI writes `record_sessions`** (schema 0009, FR-1.6): the entry's recording switch, which the Agent only reads — off, the watcher does not watch for the program. The script's one data change switches it off for entries an old import made for Steam's own tools (`SteamLibrarySource.KnownTools`, the ids as of the script); a twin merge keeps it off when either twin had it off. **And since 2026-09-25 the Agent's pre-scan of the library (`19_SAFETY` §What a finding does to the game) writes the hook-state columns of every entry, not only of those the user asked to hook** — `hook_prescan_state`, and on a finding `hook_enabled = 0` and `hook_blocked_reason` — and its own key, `hook_prescan_rules_version` / `hook_prescan_exe_size_bytes` / `hook_prescan_exe_mtime_ms` (schema 0010), through `IGameConsentStore.RecordPreScanAsync` only: columns that were already the Agent's, never over a block, never a new row. **And since 2026-09-26 (schema 0014, D33) the Agent writes the user-mode exception's columns** — `ac_exception_*` on `games` through `IGameConsentStore` only (eligibility from the sweep, a grant from the `SetAntiCheatException` command, every end), and `sessions.ac_exception_family` with the session — the grant only after the user accepted its disclosure in the UI, which asks and never writes. **And since 2026-10-03 (beta.11, D40) the Agent deletes sessions on request** — every session of one game or of every game, `DeleteSessions` over the pipe, through `ISessionRepository.DeleteSessionsAsync` in one transaction (segments, blobs and annotations cascade), never while one is being recorded; the UI asks and never deletes a session row itself *(for Delete all sessions; FR-1.4's removal is the App's own cascade, above — corrected 2026-10-04)*. **Maintenance (P4 PR-7) adds no writer:** the retention sweep on demand is the Agent's, asked over the pipe; the UI's `VACUUM` rewrites pages with the same contents and changes no row (§Retention built note). UI writes `games` (user-editable fields — since P3 PR-3 that is the FR-1.3 metadata, the `*_default` tri-states, and `removed_at`; ~~never a `hook_*` column~~ **and two downgrades** *(corrected 2026-10-04)*: *Change executable* (2026-09-21, `GameLibrary.ChangeExecutableAsync`) turns hooking off, clears the consent and pre-scan columns and ends an excepLine truncated
|
||||
|
||||
## Schema (v2 — hook architecture)
|
||||
|
||||
@@ -399,6 +399,9 @@ CREATE TABLE sensor_blobs (
|
||||
-- beta.14 (D49) also gpu_core_clock|gpu_mem_clock (MHz), gpu_fan (RPM), gpu_mem_temp (°C)
|
||||
-- and gpu_power_limit|gpu_thermal_limit (100 or 0 per tick, NVIDIA only) — a series name
|
||||
-- needs no migration
|
||||
-- since schema 0023 (2026-11-11, D102) also the ADVANCED series, every one under a name
|
||||
-- that starts with `adv.` (Application.Advanced.AdvancedMetricCatalog): NaN, not -1,
|
||||
-- for a tick with no reading, and read by FindAdvancedSensorsAsync only
|
||||
-- cpu_load / ram_mb / cpu_temp and sessions.avg_cpu_load, avg_cpu_temp, max_cpu_temp,
|
||||
-- avg_ram_mb were in schema 0001 with NO producer until 2026-09-21 (Telemetry.SystemTelemetrySource
|
||||
-- on the poller's tick). Rows before that date hold NULL, which is what they measured; no migration.
|
||||
@@ -464,6 +467,7 @@ switch's rule); integers are invariant-culture within an inclusive range; choice
|
||||
| `capture.run_elevated` | bool | `0` | | The App when it starts the Agent, and an Agent the logon task started — both BEFORE the Agent exists, through `Infrastructure.Startup.RunElevatedSetting` (one row, `PRAGMA query_only`, no version gate, anything but `1` is off) (D34, beta.10): on, Windows is asked for administrator rights at every Agent start (`01_ARCHITECTURE` ADR-9) |
|
||||
| `capture.min_session_s` | int | `30` | 5–600 | Agent, per session (FR-3.6) |
|
||||
| `telemetry.interval_ms` | int | `1000` | 500–2000 | Agent, per session (FR-3.5) |
|
||||
| `telemetry.advanced` | bool | `0` | | Agent, per session (FR-5.6, owner decision D101, 2026-11-11): **Advanced metrics**. On, a session holds the Agent's shared reader and stores its `adv.*` series and its `session_advanced` row (schema 0023); off — and any row that is not exactly `1` — nothing more is read or stored, and a session recorded while off has no row. Settings ▸ Recording (`18_GPU_VENDOR_APIS` §The switch) |
|
||||
| `retention.raw_sessions_per_game` | int | `20` | 0–10000; **0 = unlimited** | Agent, per session (§Retention) |
|
||||
| `retention.remove_uninstalled_games` | bool | `1` | | Agent, at every detection sweep (beta.19, D55, FR-1.8): on, an entry whose executable has been gone for ten minutes — its drive connected, the folder it was installed in still there — and that has no session and no anti-cheat block or exception is removed; off, it stays and reads *Not installed* (D41's behaviour) |
|
||||
| `update.channel` | choice | ~~`stable`~~ `auto` (beta.14, D47) | `auto` · `stable` · `beta` | UI (P4 PR-5 reads it: `beta` = GitHub pre-releases too; `auto` follows the running copy, a pre-release asking for pre-releases — `11_UPDATER` §The update audit) |
|
||||
@@ -491,6 +495,18 @@ Because Tier-1 and Tier-2 sessions carry different fields, every query that comp
|
||||
> axis (a gap's interval is stored as 0), so a series still drifts ahead of its sensors past each gap.
|
||||
> Sensor series are aligned to `t_ms` (milliseconds from `qpc_epoch`) and a tick with no reading is stored as
|
||||
> **−1** — never 0, which would be a reading — because temperatures, loads, power and memory are never negative.
|
||||
>
|
||||
> **The advanced series are the exception, and say so by their name (schema 0023, owner decision D102).** A series
|
||||
> whose name starts with `adv.` stores **NaN** for a tick with no reading: a motherboard's −12 V rail is negative, so
|
||||
> −1 cannot mark a gap, and most of its ticks are gaps — the sensor library is read every fifth. They go through a
|
||||
> second encoder, `ISeriesCodec.EncodeSparseFloat32`, which allows NaN and still refuses an infinity; **the rule
|
||||
> above is not relaxed**: `EncodeFloat32` throws on a NaN as before, because a frame time has no gaps. Both decode
|
||||
> with `DecodeFloat32`. `ISessionRepository.FindSensorsAsync` — what every summary, chart and export reads — leaves
|
||||
> the `adv.` rows out (`series NOT LIKE 'adv.%'`), since those readers drop every negative value as "no reading";
|
||||
> `FindAdvancedSensorsAsync` returns them with `t_ms` first. One session stores at most 256 of them
|
||||
> (`AdvancedSessionBuilder.MaxSeries`); what is beyond is counted in its directory, not stored.
|
||||
> **Size, measured 2026-11-11** on values shaped like the dev box's reader (17 series with a reading every tick, 41
|
||||
> with one every fifth): one hour is 816 KiB raw and **189 KiB stored** — well inside NFR-5's 3 MB an hour.
|
||||
|
||||
## The `.partial` file
|
||||
|
||||
@@ -513,6 +529,16 @@ Because Tier-1 and Tier-2 sessions carry different fields, every query that comp
|
||||
> | 6 `Note` | wall clock + UTF-8 text: a state transition | each transition |
|
||||
> | 7 `Touches` | N × `i64` QPC at which the host touched the target | each flush |
|
||||
> | 8 `SensorsWide` | the same samples under a 32-bit presence mask that carries the game process's memory (D43) | each flush, since beta.12 *(row added 2026-10-04)* |
|
||||
> | 9 `SensorsAdvanced` | the advanced readings of the samples of the type-8 chunk before it (D101): `u16` names, then per name `u16` bytes and UTF-8; `u32` samples, then per sample `i64` QPC, `u16` readings and per reading `u16` name, `f64` value. Each chunk carries its own names, so it reads without any earlier chunk | each flush **in which a sample carries any** — with Advanced metrics off, never; the file is then byte for byte what it was (2026-11-11) |
|
||||
> | 10 `AdvancedContext` | UTF-8 JSON (`AdvancedJson.OfContext`): the PC's facts, the session's, its series' directory, each source's state; the last one wins | the first flush after the recorder set it, and again only when it changed (2026-11-11) |
|
||||
>
|
||||
> **A chunk of a type the reader does not know is skipped, not the end of the file (owner decision D106,
|
||||
> 2026-11-11).** Its length and checksum have been verified by then, so it is a whole chunk a newer build wrote.
|
||||
> Until that day `_ => false` ended the read there, and a build one release older lost everything after the first
|
||||
> new chunk — the price types 9 and 10 would have charged a beta.38 reading a beta.39 file. A chunk of a KNOWN type
|
||||
> that does not parse still ends the read: that is a torn or a wrong file, not a newer one.
|
||||
> (`PartialSessionFileAdvancedTests`: an unknown type between two known ones; the same with its checksum broken;
|
||||
> a kill at every byte offset of a file that holds both new types.)
|
||||
>
|
||||
> Recovery (`PartialRecovery`): a file whose guid is already a row is deleted (the finalize had landed);
|
||||
> one under the minimum session length is discarded; one with no readable header is dropped; the rest
|
||||
@@ -718,6 +744,43 @@ Sequential embedded SQL (`Migrations/0001_init.sql`, `0002_*.sql`, …), applied
|
||||
> from its crash file (which carries no module list). `LatestVersion` is 21;
|
||||
> `LedgerDatabaseTests.ScriptTwentyOneAddsTheModuleSourcesColumnAndAnEarlierSessionHasNone`, the repository round trip.
|
||||
|
||||
> **`0023_advanced_metrics.sql` (2026-11-11, owner decisions D101 and D102) — what Advanced metrics stores.** Two
|
||||
> tables and **no column on `sessions`** — the first `CREATE TABLE` since 0001. Every read of a `sessions` row, the
|
||||
> JSON export and the bug bundle carry the whole row, and a driver profile does not belong in a bug bundle.
|
||||
> `machine_profiles(id, hash UNIQUE, facts_json, captured_at)` holds the facts of the PC, one row per distinct set
|
||||
> (`hash` = SHA-256 of `facts_json`); it stands beside `hardware_snapshots`, not in it, because that table's hash
|
||||
> feeds the trend's hardware-change markers and a set of facts that exists only while an option is on would raise a
|
||||
> marker each time the option is switched. `session_advanced(session_id PRIMARY KEY → sessions ON DELETE CASCADE,
|
||||
> machine_profile_id → machine_profiles, facts_json, stats_json, series_json)` holds one row per session **recorded
|
||||
> with the option on**: its facts and each source's state, the statistics of its advanced series (the form of
|
||||
> `sensor_stats_json`), and the directory of the series that are members of a family. **A session recorded with the
|
||||
> option off has no row** — that absence is how the App says "the option was off when this was recorded" rather than
|
||||
> "nothing answered" — and is never given one. The JSON is `Application.Advanced.AdvancedJson`'s (camel case, nulls
|
||||
> left out, a status by its name); writing is strict, reading is tolerant, and **only a fact whose catalog entry is
|
||||
> read may be written** (`AdvancedJson.Storable`), so no identifier reaches either table (D104). **Since
|
||||
> 0.1.0-beta.40 (train B) the same row holds what the game told its upscaler** — the session facts of the entries
|
||||
> whose reach is `Game`, after the driver's, and `sources.inGame` (`Reading`, `NothingSeen`, `NotHooked`; absent in
|
||||
> a row beta.39 wrote, which reads as "not said") — and its two series are `adv.ffx.upscale.frame_time_delta` and
|
||||
> `adv.ffx.memory_usage` in `sensor_blobs`. **Since 0.1.0-beta.43** `sources` may also hold `streamlineConstants`
|
||||
> and `fsrFrameGeneration` (`Read`, `NeverCalled`, `NotHooked`; `Application.Advanced.AdvancedInGameCall`) — what
|
||||
> became, in that session, of the two calls hooked only for Advanced metrics; both absent in a row written before,
|
||||
> and in a session not measured inside the game. **Since 0.1.0-beta.44** also `streamlineFeatureVersion` and
|
||||
> `streamlineFeatureRequirements`, the same three values for the two questions a game asks Streamline about a
|
||||
> feature — where `NeverCalled` is the usual one, a game asking while it starts — and the facts
|
||||
> `sl.feature.versions` and `sl.feature.requirements`, rows named `<feature> · <member>` in the vendor's words.
|
||||
> **Since 0.1.0-beta.45** six more keys, the same three values each — `streamlineFeatureSupported`,
|
||||
> `streamlineFeatureLoaded`, `streamlineSetFeatureLoaded`, `streamlineAllocateResources`, `streamlineFreeResources`,
|
||||
> `streamlineShutdown`, absent in every row written before — and the facts `sl.feature.support` and
|
||||
> `sl.feature.lifecycle`, rows named `<feature> · <call>` (`slShutdown` alone for the shutdowns); a count that
|
||||
> reached its ceiling is the text `≥ 15`. No column and no script: schema 23 as it was. A session deleted
|
||||
> takes its row with it; a profile no session points to is left, as a hardware snapshot is; the retention sweep
|
||||
> removes a session's `adv.` series with its other raw series and keeps its row. Written by the Agent only, in the
|
||||
> session's own transaction (`SqliteSessionRepository.InsertAdvancedAsync`). `LatestVersion` is 23;
|
||||
> `LedgerDatabaseTests.ScriptTwentyThreeCreatesTheTwoAdvancedTablesAndAnEarlierSessionHasNoRow` (whose helper now
|
||||
> undoes a script's `CREATE TABLE` and `CREATE INDEX` as well as its `ADD COLUMN`), the repository's four cases.
|
||||
> **Nothing produces a row yet**: the option that switches the reader on is the next pull request's.
|
||||
> **A beta.38 cannot open a ledger a later build migrated.**
|
||||
|
||||
> **`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
|
||||
|
||||
+78
-5
@@ -14,15 +14,17 @@ in beta.9 without a row here)*:
|
||||
|
||||
Created by the Overlay on init, opened by the Agent. Name is deliberately plain and identifiable (`19_SAFETY` — no obfuscated object names).
|
||||
|
||||
Layout — **~~four~~ five regions, each exactly one 64-byte cache line before the ring** (layout 4 since
|
||||
2026-09-27, beta.10: region 4 is new and the ring moved from `0xC0` to `0x100`):
|
||||
Layout — **~~four~~ ~~five~~ six regions** (layout 4 since 2026-09-27, beta.10: region 4 is new and the ring moved
|
||||
from `0xC0` to `0x100`; **layout 5 since 2026-11-11**, Advanced metrics train B: region 5 is new — twenty-three cache
|
||||
lines, where the four before it are one each — and the ring moved from `0x100` to `0x6C0`):
|
||||
|
||||
```
|
||||
[0x0000] FlShmHandshake 64 B write-once by the Overlay at init
|
||||
[0x0040] FlWriterState 64 B Overlay-written (writeIndex touched every present)
|
||||
[0x0080] FlControlBlock 64 B Agent-written
|
||||
[0x00C0] FlDisplayState 64 B Overlay-written, at most every 500 ms per chain (layout 4)
|
||||
[0x0100] FlFrameRecord[capacity] (64 B each, power-of-two capacity)
|
||||
[0x0100] FlAdvancedState 1472 B Overlay-written by its watchdog, once a second, only while the Agent asks (layout 5)
|
||||
[0x06C0] FlFrameRecord[capacity] (64 B each, power-of-two capacity)
|
||||
```
|
||||
|
||||
The header is split in two on purpose. The immutable handshake and the
|
||||
@@ -72,7 +74,8 @@ struct alignas(64) FlControlBlock { // Agent-written
|
||||
uint32_t overlayEnabled; // @8 in-game overlay draw toggle (v1.1)
|
||||
uint32_t guardTicks; // @12 completed guard evaluations, NOT a timer
|
||||
uint32_t logFlushRequested; // @16 a COUNTER: bumped by the Agent at session end; the watchdog flushes the native log on a change (17_HOOK_ENGINE §Native logging, 2026-09-06)
|
||||
uint32_t reserved[11]; // @20..63 must be zero
|
||||
uint32_t advancedRequested; // @20 0, or this session's request for Advanced metrics (D111): non-zero, new to this ring; written at attach, either way
|
||||
uint32_t reserved[10]; // @24..63 must be zero
|
||||
};
|
||||
|
||||
struct alignas(64) FlDisplayState { // Overlay-written (layout 4, 2026-09-27, beta.10)
|
||||
@@ -93,9 +96,78 @@ static_assert(sizeof(FlShmHandshake) == 64);
|
||||
static_assert(sizeof(FlWriterState) == 64);
|
||||
static_assert(sizeof(FlControlBlock) == 64);
|
||||
static_assert(sizeof(FlDisplayState) == 64);
|
||||
static_assert(FL_SHM_DISPLAY_OFFSET == 0xC0 && FL_SHM_RING_OFFSET == 0x100 && FL_SHM_RING_OFFSET % 64 == 0);
|
||||
static_assert(sizeof(FlAdvancedState) == 1472); // region 5: fl_shm.h is its declaration, member by member
|
||||
static_assert(FL_SHM_DISPLAY_OFFSET == 0xC0 && FL_SHM_ADVANCED_OFFSET == 0x100 && FL_SHM_RING_OFFSET == 0x6C0 && FL_SHM_RING_OFFSET % 64 == 0);
|
||||
```
|
||||
|
||||
**Region 5 — what a hooked game told its upscaler (layout 5, 2026-11-11; Advanced metrics train B, owner decisions
|
||||
D111 and D113; written by the Overlay's watchdog since 0.1.0-beta.40).** `18_GPU_VENDOR_APIS` §Train B is the design.
|
||||
What the region is, as a contract between the two sides:
|
||||
|
||||
- **Off means nothing is read and nothing is written.** `FlControlBlock.advancedRequested` is the Agent's word that
|
||||
this session records Advanced metrics — written at attach, either way, because the control block outlives a session
|
||||
(`ShmRingReader.SetAdvancedRequested`). While it is 0 the Overlay reads no field and installs no hook beyond what
|
||||
it did before, and writes nothing here: a ring nobody ever asked is zero from end to end (`fl_guard` checks every
|
||||
byte, with a target that sends everything), and `validMask == 0` means "nothing was read", never "the game used
|
||||
none of it".
|
||||
- **"On" is a request, not a 1** *(2026-11-12)*. A game outlives a session, and so do the summaries the Overlay keeps
|
||||
inside it — a range, a count, a mask of what was ever seen. So the word is a value no session of this ring used
|
||||
before (above the word as it stands and above the request the region last answered; never 0), the watchdog starts
|
||||
its summaries afresh at a value it has not seen, and every publication names the request it answers
|
||||
(`FlAdvancedState.request`, the word that was `reserved0`). The reader returns only a publication that names the
|
||||
value it wrote: what a second session of the same game finds in the region before the first tick is the first
|
||||
session's, and is not read. After an "off" the region keeps its last publication, untouched.
|
||||
- **One writer, once a second.** The detours keep process-local accumulators; the watchdog copies them here at its
|
||||
tick. No game thread writes the region, so the seqlock has a single writer: `seq` odd, the fields, `seq` even.
|
||||
- **The reader keeps its last consistent copy** (`ShmRingReader.AdvancedState`): null until something was published
|
||||
for its request;
|
||||
the same copy while `seq` has not moved, without copying 1472 bytes again; and that copy still when the writer is
|
||||
inside on every attempt — a watchdog killed with its process leaves `seq` odd for good, and what it published
|
||||
before is still what the game said.
|
||||
- **Zero is "not read", never a value.** A Streamline `Boolean` and a DLSS preset are stored as the vendor's value
|
||||
plus one; a float as its bits, with `FL_ADV_FLOAT_NONE` for "none seen" — and, in `ffxNearBits` / `ffxFarBits` alone, `FL_ADV_FLOAT_INFINITE` (`0x7F800000`, +infinity's own bits) for a plane at infinity *(0.1.0-beta.42, owner decision D119: an engine with an infinite depth hands FSR `FLT_MAX` or +infinity for one plane; for Streamline `FLT_MAX` is "not set" and stays refused)* — the vendors' own sentinels are refused in
|
||||
the detour and never reach the region; a size of 0 is "not given".
|
||||
- **A per-frame value is summarised where it is seen**: a flag is an "ever seen" mask, a jitter the largest magnitude,
|
||||
a field of view its lowest and highest (D114), the reported frame time a count and a sum the watchdog drains.
|
||||
- **Sized once for the train's three releases.** The members ~~0.1.0-beta.41 and beta.42~~ ~~0.1.0-beta.42 and
|
||||
beta.43~~ 0.1.0-beta.43 and beta.44 fill *(renumbered twice on 2026-11-12 — D118: a fix release took beta.41;
|
||||
D122: the second step became two releases, and beta.42 fills none of them. The comments in `fl_shm.h` and
|
||||
`ShmLayout.cs` carry the new numbers since beta.42)* (`ffxFg*`,
|
||||
`sl*`, `features`) are declared now and stay zero until then, so those releases bump no layout. **The `sl*` group
|
||||
is filled since 0.1.0-beta.43** by the `slSetConstants` hook (`17_HOOK_ENGINE` §Hook inventory), under
|
||||
`FL_ADV_VALID_SL_CONSTANTS`: the call count of every viewport, and for the first viewport seen the resets, the
|
||||
jitter's largest magnitude, the motion-vector scale, the two depth planes, the field of view's range, the aspect
|
||||
ratio, and one bit per `Boolean` in each of two words — seen true, seen false. `FlHookFamily` gains
|
||||
`FL_HOOK_SL_CONSTANTS` (bit 13): the hook is in, which it is only in a process that was asked at least once.
|
||||
**The `ffxFg*` group is filled since the same release** by the `ffxConfigure` hook, under
|
||||
`FL_ADV_VALID_FFX_FG_CONFIG`: the frame-generation configures of the one module counted, three switches as "seen
|
||||
off / seen on" bit pairs (enabled, asynchronous, generated frames only), every flag any configure carried, and
|
||||
the last generation rectangle as left, top, width, height — **four `-1` for a rectangle with a negative side or
|
||||
one past 32,767**, never a clipped one. `FL_HOOK_FFX_CONFIGURE` (bit 14) is published when every ffx-api module
|
||||
the process loaded has its `ffxConfigure` patched.
|
||||
- **The feature slots are written since 0.1.0-beta.44**: `features` is twelve slots of twenty-four words — word 0
|
||||
the `sl::Feature` id plus one (0 is an empty slot), word 1 which of the two questions has an answer (bit 0 the
|
||||
version, bit 1 the requirements), then the two versions, the flags, three counts and four more versions, as
|
||||
`fl_shm.h` lays them out. Slots fill from 0 in the order the game first asked about each feature; **a new request
|
||||
does not empty them** — the one group that is a fact about the process and not about a session — and
|
||||
`FL_ADV_VALID_SL_FEATURES` stays set with them. `FL_HOOK_SL_FEATURE_VERSION` (bit 15) and
|
||||
`FL_HOOK_SL_FEATURE_REQUIREMENTS` (bit 16) are published with their patches, in a process that was asked.
|
||||
- **Word 1 of a slot carries more since 0.1.0-beta.45** (no layout change): bit 2 `slIsFeatureSupported` answered,
|
||||
with the `sl::Result` it gave in bits 8..15 (0 is `eOk`; a refusal is kept, it is the answer; `0xFF` a code a byte
|
||||
cannot carry); bit 3 `slIsFeatureLoaded` answered and bit 4 what it said; bit 5 the game switched the feature off
|
||||
through `slSetFeatureLoaded`, bit 6 on. **Bits 5 and 6 are a session's and a new request clears them**; every
|
||||
other bit of the word is a fact about the process and stays, as the slot does. A feature Streamline refused has
|
||||
a slot with only that word in it. `FL_HOOK_SL_FEATURE_SUPPORTED` (bit 17), `FL_HOOK_SL_FEATURE_LOADED` (18) and
|
||||
`FL_HOOK_SL_SET_FEATURE_LOADED` (19) are published with their patches.
|
||||
- **And two counts** (the same release): bits 16..19 of word 1 are how many times the game allocated the feature's
|
||||
resources (`slAllocateResources`), bits 20..23 how many times it freed them (`slFreeResources`) — each stops at
|
||||
15 — and `slShutdowns` (@308, taken from the three reserved words that ended the `sl::Constants` line; two remain)
|
||||
counts `slShutdown` calls, with `FL_ADV_VALID_SL_SHUTDOWN` (bit 6 of the mask) set once one was seen. All three
|
||||
are a session's and a new request clears them. `FL_HOOK_SL_ALLOCATE_RESOURCES` (bit 20),
|
||||
`FL_HOOK_SL_FREE_RESOURCES` (21) and `FL_HOOK_SL_SHUTDOWN` (22) are published with their patches.
|
||||
- The Vulkan layer never writes it. `ShmLayoutMirrorTests.TheAdvancedStateMirrorMatches` checks every member's
|
||||
offset against `fl-layout-dump`; `ShmRingReaderTests` the three reads and that the request is stored either way.
|
||||
|
||||
**Region 4 — the presenting swap chain's display facts (layout 4, 2026-09-27, beta.10).** The owner asked for the game's
|
||||
window size and display mode (exclusive fullscreen / borderless / windowed) and the share of a session each took. The two
|
||||
facts only the process knows — whether the chain is in exclusive fullscreen, and which window it presents to — are
|
||||
@@ -402,6 +474,7 @@ Unchanged in spirit from v1, bumped to `v2` for the new message set.
|
||||
| `Shutdown` | UI→A | graceful stop → `ShutdownAck`, then the host stops (sessions finalize inside its grace window). *(Built 2026-09-13, PR-1b: `IAgentLifetime`, the host's under `--serve`, a logged no-op under `--console`.)* |
|
||||
| `DeleteSessions` | UI→A | **Added 2026-10-03 (beta.11, D40).** `{ gameId? }` — every session of that game, or of every game when it is null, with their segments, frame and sensor series and annotations (they cascade) → `DeleteSessionsAck { gameId?, games, sessions }`. `Error SessionRunning` and nothing deleted while a session of that game — of any game, for all — is being recorded (`CaptureOrchestrator.IsRecording` / `IsRecordingAny`). The client names no rows beyond the game: they are the Agent's (§Writer ownership). Additive: an older Agent answers `Error UnknownType`, which the App says as "restart the agent". Carries no safety fact. |
|
||||
| `SweepRetention` | UI→A | **no payload** — a trigger, like `UpdateRules`: the Agent applies `06_DATA_MODEL` §Retention to every game with the `retention.raw_sessions_per_game` it reads itself → `SweepRetentionAck { keep, games, sessions }` (`keep` 0 = unlimited, and then nothing was swept). *(Built 2026-09-15, P4 PR-7, for Tools ▸ Database maintenance: `Application.Recording.RetentionSweep` over `ISessionRepository.SweepRetentionAllAsync`, composed into `AgentCommandHandler` under `--serve`. The client names no number because the rows are the Agent's (§Writer ownership). Additive: an older Agent answers `Error UnknownType`, which the dialog reads as "restart the Agent". Carries no safety fact.)* |
|
||||
| `GetAdvancedMachine` | UI→A | **Added 2026-11-11 (Advanced PR-6, owner decisions D101/D107).** `{ factsHash? }` → `AdvancedMachineAck { ready, takenAtUnixMs, factsHash?, factsJson?, readings[{ series, value }], series[{ series, metricId, label }], nvapi, nvapiCode?, sensors, elevatedSensors }` — what the Agent's shared advanced reader last read about this PC (`18_GPU_VENDOR_APIS` §The page's feed). **The handler reads no sensor**: the answer is the reader's last snapshot, one reference, because the pipe's read loop awaits its handler and a driver call there would hold up `Ping` and `StopSession`; the one thing it awaits is the option, a `settings` row asked for at most every two seconds. **A request is the page's hold on the reader**: the first acquires it and each renews a five-second lease, so the App asks once a second while the page is open and nothing has to say that it closed (`Application.Ipc.AdvancedMachineResponder`). `ready: false` — held, not yet read — carries nothing else. `readings` are that tick's only: a slow source is read every few ticks and the client keeps the last value it saw; a value that is not a number is left out. `factsJson` is the PC's facts as the ledger stores them (`AdvancedJson.OfFacts`), left out when the request's `factsHash` is the Agent's own. The three states are `AdvancedSourceStatus` names; a name a client does not know reads as unknown. `Error AdvancedOff` while `telemetry.advanced` is off — nothing is read, and a hold a previous request took is let go at once. Additive, protocol 2: an older Agent answers `Error UnknownType`, which the page shows as such. Carries no safety fact and changes nothing. |
|
||||
| `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). **`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 |
|
||||
|
||||
+74
-4
@@ -38,7 +38,7 @@ Compare showed the icon alone)*. Light/Dark/System themes via `ApplicationThemeM
|
||||
> a refusal is a message box and exit 2. The viewer's folder is its own single-instance key, so it runs beside the
|
||||
> profile's App. D6 is unchanged: the Agent's `--data-dir` stays under `--console`.
|
||||
|
||||
**NavigationView items:** Dashboard · Games · Compare · Logs — `Settings` lives in `FooterMenuItems`. Icons from `SymbolIcon` (Fluent System Icons; pick from the `SymbolRegular` enum — see 16 §Icons).
|
||||
**NavigationView items:** Dashboard · Games · Compare · Logs · *Advanced* (since 2026-11-11, D105: last in `MenuItems`, `Visibility` bound to `Services.AdvancedOption.IsOn` — there only while `telemetry.advanced` is on, §Advanced) — `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 / Xbox *— since beta.33*) · Export ▸ (Session CSV / Session JSON / Chart PNG) · Exit
|
||||
@@ -850,7 +850,77 @@ Tail view of `ui-*.log` / `agent-*.log` (toggle), level filter, search (`ui:Auto
|
||||
> The status line says shown / total / file. Tests: `LogTailTests`, `LogsViewModelTests`, and the page renders in
|
||||
> `PagesLoadTests`.
|
||||
|
||||
### Advanced
|
||||
> **Built 2026-11-11 (Advanced PR-7; owner decisions D101, D105, D107).** `Pages/AdvancedPage` over
|
||||
> `ViewModels/AdvancedViewModel`, a `TabControl` of three tabs by what a value belongs to:
|
||||
>
|
||||
> - **This PC** — `Services.AdvancedMachineFeed`, watched between `Loaded` and `Unloaded` and while the page is visible
|
||||
> (a window hidden to the tray lets go too), which is what makes the Agent read with no game running and stop when the
|
||||
> page closes (D107). A status line says what the last request came to (`Advanced_State_*`: read at a time, waiting,
|
||||
> off, no agent, an older agent, a viewer); *About this PC* is the facts under the catalog's groups; *Right now* is a
|
||||
> `DataGrid` of every series with **the time it was read at** — a sensor read every fifth tick is never shown as new;
|
||||
> *Over time* is one catalog entry's last five minutes (`Charts/AdvancedSeriesChart`, a date axis).
|
||||
> - **Session** — a selector of the newest fifty sessions that have a `session_advanced` row
|
||||
> (`ISessionRepository.ListAdvancedAsync`), then the PC's facts as they were and the session's own, the stored
|
||||
> statistics, and the entry's series over the session (`SessionSeriesLoader.LoadAdvancedAsync`: `t_ms` is the clock,
|
||||
> NaN is left out, a negative reading is kept). A session whose raw series retention removed keeps its statistics
|
||||
> and says the series are gone. A session's summary has **Advanced metrics…** where the session has a row
|
||||
> (`SessionSummaryViewModel.HasAdvanced`); it asks for that session through `Services.AdvancedSelection` and
|
||||
> navigates, and a page already on screen takes the request at once.
|
||||
> - **Sources** — every entry of `AdvancedMetricCatalog`: its label, what it belongs to, its source, and *Read*, or
|
||||
> the reason it is not (`AdvReach_*`), or — live — why its source is silent (`AdvSource_*`). An entry read inside
|
||||
> the game (reach `Game`, 0.1.0-beta.40) says *Read inside a game FrameLedger measures, when the game makes the
|
||||
> call* (`Advanced_Status_InGame`): it is not a state of the PC. What became of those entries in one session is in
|
||||
> that session's sources line on the Session tab (`Advanced_InGameLine` with `AdvInGame_*`): read, the game made none
|
||||
> of the calls, or the session was not measured inside the game; a session stored before beta.40 has no such
|
||||
> sentence. **Since 0.1.0-beta.43** a session measured inside the game has one more
|
||||
> (`Advanced_InGameCallsLine` with `AdvInGameCall_*`): for what the game tells Streamline each frame and for how it
|
||||
> configures FSR frame generation, each *read*, *hooked - the game did not make the call*, or *not hooked - the
|
||||
> game did not load the library that has the call*. "Nothing here" then says which of the two it is.
|
||||
> **Since 0.1.0-beta.44** one more (`Advanced_InGameFeatureCallsLine`): for which version each Streamline feature
|
||||
> is and for what each requires, the same three — except that hooked and not seen reads *hooked - the game asks
|
||||
> this while it starts, and did not ask again after FrameLedger attached* (`AdvInGameCall_NotAskedAgain`,
|
||||
> `AdvancedLabels.InGameStartupCall`): the usual case, and not a finding about the game.
|
||||
> **Since 0.1.0-beta.45** one more, and one only for six calls (`Advanced_InGameMoreCallsLine`,
|
||||
> `AdvancedPresenter.MoreCalls`): *Streamline's other calls - read: …; hooked, the game did not make the call: …;
|
||||
> not hooked: …*, each call under its own name (`slIsFeatureSupported`, a function's name and so not translated)
|
||||
> in the group that is true of it, and the word for "none" where a group is empty. A session stored before has
|
||||
> none of the six and no such sentence. The catalog's `sl.init.preferences` carries a reason of its own
|
||||
> (`AdvReach_BeforeAttach`): *Not read: the game makes this call once, before FrameLedger is inside it*.
|
||||
>
|
||||
> **Words.** Every catalog entry, group, reason, source state and driver token is a `Strings.resx` key made from its own
|
||||
> name (`Adv_<id>`, `AdvGroup_*`, `AdvReach_*`, `AdvSource_*`, `AdvToken_*`) in `en`, `vi`, `ja`; the English label of
|
||||
> an entry **is** its summary in the catalog, and a test holds the two equal. A key that is not there — a token a
|
||||
> newer build stored — reads as the stored text, never as nothing (`ViewModels/AdvancedLabels`).
|
||||
> `ViewModels/AdvancedPresenter` is the pure mapping, each rule with a test.
|
||||
>
|
||||
> **Charts.** A family with more than eight members is drawn as its lowest, average and highest
|
||||
> (`AdvancedPresenter.MaxLines`), and the page says so; the table beside it lists every member. Lines differ by
|
||||
> pattern as well as colour (`ChartPatterns`).
|
||||
>
|
||||
> **A viewer** (`--data-dir`) has no Agent: *This PC* says so, the page opens on *Session*, and nothing is asked. The
|
||||
> navigation item is there when the copy's option is on **or the copy holds an advanced session** (`App.RunAsync`).
|
||||
>
|
||||
> **Accessibility** (`ACCESSIBILITY.md` §For contributors): one first-level heading, a level on every section; the two
|
||||
> templates are implicit by type, so no page-local resource key is named; every row type overrides `ToString` so an
|
||||
> item is read by its text; no `LiveSetting` — the readings change every second and are not announced; each chart has
|
||||
> its name and says its numbers are in the table beside it. Tests: `AdvancedPresenterTests`, `AdvancedViewModelTests`,
|
||||
> `PagesLoadTests` (the page among every surface, both themes, the contrast themes), `AccessibilityTests`
|
||||
> (`CtrlOneToFive…`), `GuideDocumentsTests`.
|
||||
|
||||
### Settings
|
||||
> **Advanced metrics (2026-11-11, owner decision D101; Advanced PR-5).** The Recording section has **Advanced metrics**
|
||||
> (`telemetry.advanced`, off by default, off in a viewer like every setting the Agent reads): one `ui:CardControl` with a
|
||||
> `ToggleSwitch`, under *Raw series kept per game*. Its text says what is read, that off reads and stores nothing more,
|
||||
> that it applies from the next session and that an earlier session is not filled in. The Agent reads it at each
|
||||
> session's start, so the row gets the usual "Applied. The capture agent reads it at the next session" strip. The
|
||||
> switch also sets `AdvancedOption.IsOn` at once, so the navigation item and Ctrl+6 follow it without a restart
|
||||
> (§Advanced, PR-7). With it, three texts that said what
|
||||
> an Agent running as administrator adds with PawnIO now name the processor's, the memory's and the motherboard's
|
||||
> sensors beside the CPU temperature: the Agent section's elevation line, the first run's Agent step, and the admin
|
||||
> mode's disclosure (`agent-admin-dialog/2`). Tests: `SettingsViewModelTests.AdvancedMetricsIsOffByDefaultAndItsToggleIsPersisted`,
|
||||
> `ViewerModeTests.EverySettingTheAgentReadsIsOffInAViewer`, `GuideDocumentsTests.TheSettingsPageOfTheGuideNamesEverySetting`.
|
||||
>
|
||||
> **beta.23 (owner decisions D60/D61).** The Games section has, under the Play button, **Show game artwork**
|
||||
> (`ui.game_art`, on) and **Colour the game page from its artwork** (`ui.game_art_tint`, on; disabled while the first is
|
||||
> off) — the game page's artwork and its band's colour (§Games › Game detail, *The header's cover*). Neither downloads
|
||||
@@ -891,7 +961,7 @@ Agent section: elevation state with a plain explanation of what elevation *optio
|
||||
|
||||
> **The admin mode, beta.10 (owner decision D34; `01_ARCHITECTURE` ADR-9).** The Agent section has a switch, *Run the agent
|
||||
> as administrator* (`capture.run_elevated`, off by default). Turning it on opens a `ContentDialog`
|
||||
> (`Services.AgentAdminPrompt`, text `FrameLedger.Shared`'s `Safety_AdminMode_*`, version `agent-admin-dialog/1` in its
|
||||
> (`Services.AgentAdminPrompt`, text `FrameLedger.Shared`'s `Safety_AdminMode_*`, version `agent-admin-dialog/2` *(`/1` until 2026-11-11, when Advanced metrics widened what the option adds — D101)* in its
|
||||
> corner) whose primary button is enabled only by ticking "I understand…" and whose default button keeps standard rights;
|
||||
> declined, nothing is written. Either way the row is written and the Agent restarts — asked to stop over the pipe, its
|
||||
> instance lock waited out, the connection's next round starting it the new way — **except under a running session**,
|
||||
@@ -924,7 +994,7 @@ 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; About's version line names the runtime on every line, and `--diag` prints `release_line:` and the runtime's description.
|
||||
> **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
|
||||
@@ -1030,7 +1100,7 @@ the requirement was one bullet under §UX rules, and nothing checked it.
|
||||
|
||||
| Keys | Does | Where |
|
||||
|---|---|---|
|
||||
| **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`) |
|
||||
| **Ctrl+1 … Ctrl+5** (and the numeric keypad's 1–5); **Ctrl+6** since 2026-11-11 (D105) — the Advanced page, only while `AdvancedOption.IsOn`: `ShellShortcuts` refuses it otherwise, so the number stays free | 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 |
|
||||
|
||||
@@ -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
|
||||
@@ -83,7 +93,7 @@ Tails the active files (shared read), level filter, text search, pause autoscrol
|
||||
2. **Bundle builder** creates `FrameLedger-bugreport-YYYYMMDD-HHmm.zip` in a user-chosen location:
|
||||
- `logs/` (last 7 days, redacted copies)
|
||||
- `sysinfo.json` (app + agent + **overlay build id**, OS build, CPU/GPU name, driver version, telemetry source, Vulkan layer state, PawnIO present?, elevation state, locale)
|
||||
- `overlay-<pid>-*.log` for the last hooked sessions, plus hook fault details and the ring's dropped/fault counters — these are what make injection bugs diagnosable at all. *(The file exists since 2026-09-06 — `17_HOOK_ENGINE` §Native logging: written at init, on the Agent's request at session end, and on the stop; `FAULT` lines carry the exception code and the hook's name, `UNHOOK_*` lines say per patch whether it was restored or left to a later hooker.)*
|
||||
- `overlay-<pid>-*.log` for the last hooked sessions, plus hook fault details and the ring's dropped/fault counters — these are what make injection bugs diagnosable at all. *(The file exists since 2026-09-06 — `17_HOOK_ENGINE` §Native logging: written at init, on the Agent's request at session end, and on the stop — and since 0.1.0-beta.42 by the Overlay's watchdog whenever something new was logged, so it is whole after a game that simply exits, with each install named by module and symbol and each descriptor type an ffx module was handed; `FAULT` lines carry the exception code and the hook's name, `UNHOOK_*` lines say per patch whether it was restored or left to a later hooker.)*
|
||||
- `settings.json` (sanitized — no paths)
|
||||
- optional checkbox: last session metadata + aggregates JSON (never raw blobs by default)
|
||||
- crash dumps included only when the user ticks the checkbox (size warning shown)
|
||||
|
||||
+1
-1
@@ -98,7 +98,7 @@ flow, and the tests run the flow over a fake client because nothing here may tou
|
||||
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). Moving between the lines
|
||||
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):
|
||||
|
||||
+84
-31
@@ -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.
|
||||
@@ -19,6 +20,11 @@ cmake --preset x64-release
|
||||
cmake --build --preset x64-release
|
||||
```
|
||||
|
||||
A third preset, **`x64-vs-analysis`** *(2026-11-11)*, builds nothing that ships: it has CMake write a Visual Studio
|
||||
solution (`build/native/x64-vs-analysis/FrameLedgerNative.slnx`, generator "Visual Studio 18 2026", tests and tools
|
||||
on) for Qodana's native report, which reads C++ through a solution (`13_CI_CD` §Qodana). It needs Visual Studio 18;
|
||||
the gate and the release never use it.
|
||||
|
||||
Targets:
|
||||
- `FrameLedger.Overlay` → `FrameLedger.Overlay.dll`
|
||||
- `FrameLedger.VkLayer` → `FrameLedger.VkLayer.dll` + `VkLayer_FRAMELEDGER_overlay.json`
|
||||
@@ -48,9 +54,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. *(On the `alpha` branch it pins the prerelease SDK instead, on purpose — §The alpha line, 2026-10-31.)*
|
||||
- **`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,44 +168,89 @@ 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 alpha line (owner decisions D73–D76, 2026-10-31)
|
||||
## 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 on a
|
||||
prerelease .NET — .NET 11 RC3 first (SDK `11.0.100-rc.3.26522.148`, runtime and Windows Desktop
|
||||
`11.0.0-rc.3.26522.148`) — 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).
|
||||
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.
|
||||
|
||||
- **What differs from main, and nothing else** — `git diff main...alpha` is the whole difference: `RELEASE_LINE`
|
||||
(`alpha`); `global.json` (the prerelease SDK, `allowPrerelease: true`); the TFM in `Directory.Build.props`
|
||||
(`net11.0-windows10.0.22621.0` — `SupportedOSPlatformVersion` stays `10.0.19045.0`, so CA1416 still holds the code to
|
||||
Windows 10 22H2 although Microsoft does not support .NET 11 on its Home and Pro editions); the three Microsoft packages
|
||||
in `Directory.Packages.props` that are serviced with the runtime (`Microsoft.Extensions.Hosting`,
|
||||
`System.Diagnostics.EventLog`, `Microsoft.Data.Sqlite`, each `11.0.0-rc.3.26522.148` — the last declares SQLitePCLRaw
|
||||
3.0.5, SQLite 3.53.4, where main's 10.0.14 declares 2.1.13, SQLite 3.53.3); `legal/licenses/nuget/` regenerated for
|
||||
that package set; and a fix only .NET 11 can take, if one is ever forced. C# is what `LangVersion latest` gives the
|
||||
SDK — C# 15 on the 11 SDK — and the source uses none of its syntax: **main must keep building on .NET 10** (D76: retarget
|
||||
only, no preview feature, no runtime-async).
|
||||
- **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 .NET 10 can also take lands on main.
|
||||
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.** 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
|
||||
`legal/licenses/nuget/` is resolved 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.
|
||||
- **Building it locally:** check out `alpha` with the prerelease SDK installed — `global.json` selects it — and run
|
||||
`./build.ps1 check` as on main.
|
||||
- **The next .NET build** (an RC, the GA on 2026-11-10, a servicing release) is one line of `global.json` and three
|
||||
package versions on `alpha`; RC3's support ends at the GA.
|
||||
- **Whether the main line follows** is not decided here: `20_OPEN_QUESTIONS` §G, *The main line's .NET*.
|
||||
- **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
|
||||
|
||||
@@ -358,6 +409,8 @@ Seven self-test cases, both directions; `./tools/notice-check.ps1 -Fix` writes a
|
||||
13d. **`tools/wiki-build.ps1 -SelfTest`, then `-Check`** (beta.17, owner decisions D53/D54, 2026-10-07) — assembles the GitHub Wiki from `wiki/`, `guide/`, `LIMITATIONS.md` and (beta.35) `ACCESSIBILITY.md` into a temporary folder, as `wiki.yml` does at a release (`13_CI_CD` §wiki.yml), and fails on a link to a file, folder or section that does not exist, two sources for one page, a page that neither Home nor the sidebar leads to, a sidebar that lists the guide in another order than `guide/README.md`, a backticked repository path in a `wiki/` page that names nothing, and a version number written into a `wiki/` page (the footer says which release the wiki shows). ~~Nine~~ Ten self-test cases since beta.35 (the statement's page, D88), both directions
|
||||
14. `tools/changelog-check.ps1 -SelfTest` — nine cases, five expected RED. The live half needs a pull request's changed-file list and is supplied by `ci.yml`
|
||||
14b. `tools/release-notes.ps1 -SelfTest` — five cases over a fixture changelog (a dated and an undated section, a missing one, a prefix that must not match, an empty one), and since beta.24 three over a temporary tree: a version with its own `docs/changelog/<version>.md` is read from it, one without from `CHANGELOG.md`, a prefix of a file name is not that file. The live half needs a tag's version and runs in `release.yml`, where a missing or empty section is a red release (P4 PR-5)
|
||||
14e. **`tools/nvapi-readonly-check.ps1 -SelfTest`, then live** (owner decision D108, 2026-11-11) — every `NvAPI_*` call in `src/native/FrameLedger.NvapiBridge/src/fl_nvapi_bridge.cpp`, the one translation unit that links `nvapi64.lib` into a shipped binary, is on `tools/nvapi-allowed-calls.txt` and every name there is called; a name that sets, saves, restores, deletes, registers, resets, enables, disables or controls something is red **even when the list names it**, and so is one that returns an identifier (D104) — three reads the verb rule would refuse are exempt by name, each with its reason. Comments and string literals are taken out first, so a setter named in the comment that says it is never called is not a call. Seventeen self-test cases, both directions. Text only: it runs with or without the native build. `18_GPU_VENDOR_APIS` §Runtime policy's "never call a setter", which was a sentence until the bridge went from fourteen calls to forty-four
|
||||
14f. **`tools/overlay-fields-check.ps1 -SelfTest`, then live** (owner decision D116, 2026-11-12) — the same for the code loaded into a game: every member of a vendor's struct the Overlay reads for Advanced metrics is read in ONE header, `src/native/FrameLedger.Overlay/include/fl_adv_fields.h`, through parameters with fixed names, and is on `tools/overlay-allowed-fields.txt`; every name there is read; the parameters are not aliased and `->` reaches nothing but `desc` and the Overlay's own `region`; no other Overlay or Vulkan-layer source reads a listed member; **a camera's position, axes and matrices** (`cameraPos`, `cameraUp`, `cameraRight`, `cameraFwd`, the five matrices, `cameraPinholeOffset`, `cameraPosition`, `cameraForward`) **are named nowhere in those sources and not on the list, whatever the list says**; and neither `sl::Constants` nor `ffxDispatchDescFrameGenerationPrepareV2` is copied by value or measured with `sizeof`. Comments and string literals are taken out first. Nineteen self-test cases, both directions. Text only. It reads names, not types — which struct version carries a member is `17_HOOK_ENGINE` §Which struct version carries which field and ctest `fl_adv_fields`
|
||||
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)
|
||||
|
||||
+392
-20
@@ -95,7 +95,7 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
|
||||
- **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)*. *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
|
||||
@@ -105,6 +105,36 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
|
||||
- **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); Qodana for .NET since 2026-11-11 (D99)**
|
||||
- ~~One job, `qodana`, on `ubuntu-latest` — the only Linux job in this repository, because the linter is a Linux
|
||||
container~~ Two jobs, on `windows-latest`, each a report of its own: **`native`** (*Qodana (native)*) has CMake
|
||||
write a Visual Studio solution and reads the C++ of `src/native` with `qodana-native.yaml`'s settings; and
|
||||
`managed` (*Qodana (managed)*): `JetBrains/qodana-action` (pinned to
|
||||
`v2026.2.2`'s commit; Dependabot moves the pin) runs **Qodana for .NET** in native mode over `FrameLedger.slnx`
|
||||
with `qodana.yaml`'s settings, after a `dotnet build`. No job here runs on Linux any more. §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)**
|
||||
|
||||
@@ -235,17 +265,19 @@ 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.
|
||||
|
||||
## The alpha line — the `alpha` branch (owner decisions D73–D76, 2026-10-31)
|
||||
## The alpha line — the `alpha` branch (owner decisions D73–D76, 2026-10-31; resting since D98, 2026-11-11)
|
||||
|
||||
What it is and what differs on the branch: `12_BUILD` §The alpha line. What CI and the release do with it:
|
||||
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 prerelease SDK it names whatever the `rollForward`. 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`** stays on main: the source is main's, and CodeQL's extractor reads C# 14 (CodeQL 2.25.6, June 2026)
|
||||
while the alpha's compiler is C# 15.
|
||||
— `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
|
||||
@@ -254,9 +286,10 @@ What it is and what differs on the branch: `12_BUILD` §The alpha line. What CI
|
||||
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:** 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).
|
||||
- **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)
|
||||
|
||||
@@ -324,7 +357,10 @@ from CI.
|
||||
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;
|
||||
duplication exclusions *(and, since 2026-11-12, `src/FrameLedger.Domain/Metrics/HookFamilies.cs`: the Domain's
|
||||
mirror of `FlHookFamily`, the same enum twice by design and held together by `MetricEnumMirrorTests`. The six
|
||||
members 0.1.0-beta.45 added to both were 3.7 % duplication on new code against the gate's 3 %, and failed the gate
|
||||
on the release's commit with no issue open)*; 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`
|
||||
@@ -414,7 +450,7 @@ the comment below; the rest are fixed in the same train (beta.24 PR-2).
|
||||
| `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`). |
|
||||
| `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`). **Raised again 2026-11-12:** #398 moved that call into `TryWriteOnce` (the dump is now tried three times), and SonarCloud tracks an issue by where it is — the accepted one closed and a new one opened on the same expression, as a blocker on new code. Nothing about the call changed; it is to be accepted again (HANDOFF owner-only item 38 (j)). |
|
||||
| `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):
|
||||
@@ -457,6 +493,341 @@ on `src/FrameLedger.Infrastructure/**/*` and `src/FrameLedger.Shared/**/*`, so n
|
||||
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 decisions D93, 2026-11-10; D99 and D100, 2026-11-11)
|
||||
|
||||
**Since 2026-11-11 the linter is Qodana for .NET, on the Ultimate licence (D99).** The owner took an Ultimate licence for
|
||||
the Qodana Cloud organisation and asked for Qodana over every language. So the linter is **Qodana for .NET**
|
||||
(`qodana-dotnet`: Rider's engine) where it was the Community one, in **native mode** on a Windows runner: no container,
|
||||
the projects built and loaded with the SDK the job installs from `global.json`, and no `EnableWindowsTargeting`.
|
||||
`qodana.yaml` names the linter and the mode (`withinDocker: false`); nothing is an action argument, so `qodana scan` on
|
||||
a developer's PC reads the same file. The job is `managed` — *Qodana (managed)* in a pull request's checks: checkout,
|
||||
`setup-dotnet`, the NuGet cache restored, `dotnet build -c Release` first — so that a build that fails is one red step
|
||||
with the compiler's own message, not a report of unresolved symbols — then the action, pinned by commit. No MSVC step,
|
||||
on purpose: it exports `Platform=x64`, which MSBuild reads as a solution platform. The linter's log says what the token
|
||||
bought: "Qodana license plan: Ultimate", and the Qodana Cloud project it is linked to (`frameledger`). Still advisory,
|
||||
still a gate of zero, still `main` and its pull requests alone. From here down to *As it was built* is the job as it
|
||||
is; below that is D93's own account, which is now history.
|
||||
|
||||
**Two reports (D99).** Asked how to gather the C# and the C++, the owner chose two reports from the start, and made a
|
||||
second Qodana Cloud project (`frameledger-cpp`, the `QODANA_TOKEN_NATIVE` secret). The managed report leaves
|
||||
`src/native` out; the native one (*The native report*, below) reads nothing else, so every file is in exactly one.
|
||||
|
||||
**What is read, and by what.**
|
||||
|
||||
| What | Read by | |
|
||||
|---|---|---|
|
||||
| The C#, XAML and `.resx` of the thirteen projects | `managed` | ReSharper's engine, as under D93 |
|
||||
| Markdown and XML around the solution | `managed` | the IntelliJ platform's own inspections — 23 and 10 results on the first run |
|
||||
| JetBrains' security rules over the C# — pattern rules for a process start, an SQL text and the like | `managed` | new with this linter (its OpenGrep plugin) — 36 results on the first run, every one read; the files they were read in are listed in `qodana.yaml`, so a new one is reported |
|
||||
| The C++ of `src/native` | `native` | ReSharper's C++ engine and the clang-tidy checks it bundles, over a Visual Studio solution CMake writes for it |
|
||||
| JSON and YAML, the workflows among them | nothing reported | whether the profile inspects them and found nothing, or does not inspect them, was not established; CodeQL's `actions` language reads the workflows |
|
||||
| PowerShell (`build.ps1`, `tools/`), CMake files, the HLSL shader | no linter of JetBrains' reads them here | SonarCloud reads the PowerShell |
|
||||
|
||||
**The first runs on this linter, and what was done (2026-11-11).** Run 42923079119 — the job with no settings beyond the
|
||||
solution: **3,953 problems** in 92 inspections, and 3,607 of them **hints**: the lowest level an IDE has, which the
|
||||
editor offers without underlining anything (this linter files them as `TYPO`, Qodana as *Low*). Meziantou's "name the
|
||||
parameter" 1,084 times, a trailing comma 979, a XAML binding whose `DataContext` the engine cannot know 414, the MVVM
|
||||
Toolkit's partial-property proposal 224, "invert `if`" 114 — and every other Roslyn analyzer message below the level
|
||||
this build makes an error. **Hints are off as a severity**, one group in `qodana.yaml` (`severity:TYPO`): the Community
|
||||
linter never reported them, and D93's rule is about warnings and suggestions. With that, run 42928814104: **347**.
|
||||
|
||||
| What | n | Done |
|
||||
|---|---|---|
|
||||
| `OverriddenWithSameValue` — a vi or ja value equal to the English one | 271 | off in `.editorconfig` (`[*.resx]`): product and technology names, units and format strings are not translated, and a ja safety string is the English verbatim until a reviewer signs it |
|
||||
| `csharp_injection_rule-CommandInjection` — a process started with something that is not a literal | 35 | **read, one by one** (below): 11 places in `src`, 24 in tests; one place was hardened. The rule stays on, and the files read are left out of the plugin's inspection by path in `qodana.yaml` (*How the security rules are scoped*, below), so a new file that starts a process is reported |
|
||||
| `MarkdownIncorrectTableFormatting` | 20 | off in `qodana.yaml`: Rider wants columns padded to one width; these tables are written to be diffed |
|
||||
| `XmlHighlighting` in `src/FrameLedger.App/app.manifest` | 10 | that file ignored for that inspection: the linter has no schema for a Windows application manifest |
|
||||
| `UnusedVariable.Compiler` and `RedundantUsingDirective` in `PrimaryDisplay.cs` | 6 | **the linter's own fault**, and the file is left as it is: resolving `PInvoke.EnumDisplaySettings(null, …)` — the `null`-to-`PCWSTR` conversion — the engine of this linter's build (QDNET-262.12299) fails an internal assertion (`IsStandardImplicitConversionFromExpression(conversion.Kind)`, in its `backend.log`), loses the method, and reports its three locals and the file's three usings as unused. The compiler builds the file with warnings as errors, and InspectCode 2026.2.3.1 and 2026.3.0 report nothing in it. Those two inspections are excluded for that one file in `qodana.yaml`, to be removed when a linter build reads it |
|
||||
| `MarkdownUnresolvedHeaderReference` | 3 | off in `qodana.yaml`: all three resolve on GitHub, whose anchor rule the linter does not follow (`#display-mode--both-tiers-beta10`) |
|
||||
| `csharp_injection_rule-SQLInjection` | 1 | the same: the one place assigns a constant command text and binds every value as a parameter, as every statement in this repository does; its file is listed with the others |
|
||||
| `RedundantBoolCompare`, in a test | 1 | fixed — the expression also carried a clause its first half implied |
|
||||
|
||||
With those settled, run 42940926340 (2026-11-11, this pull request's branch, the whole solution): **no problem
|
||||
reported** — the gate's zero, on this linter.
|
||||
|
||||
**How the security rules are scoped — by the plugin's one inspection, not by a rule.** Every result of the
|
||||
OpenGrep plugin's several hundred rules is produced by one inspection, `OpenGrepInspection`; a rule's own id
|
||||
(`csharp_injection_rule-CommandInjection`) is in the report and is honoured nowhere. Three runs measured it — a
|
||||
profile entry's `ignore` (42932842462), an `exclude` path under the rule's id (42935752891), `enabled: false`
|
||||
on the rule (42938295264): all 36 results stood each time, and the linter's log shows why — the plugin hands its
|
||||
server every rule file whatever the profile says. What the plugin's inspection does honour is a path: an
|
||||
`exclude` entry named `OpenGrepInspection` (its scopes are in the report's `log/effective.profile.xml`). So the
|
||||
eleven files of `src` the results were read in, and `tests`, are listed there — and in the run above the
|
||||
inspection was performed on 943 files, where it had been 1,308, and reported nothing: it is on, and it reads
|
||||
what is not listed. The price is stated in `qodana.yaml`: a listed file is left out of **all** of the plugin's
|
||||
rules, not only the one that fired. The plugin is also most of the job's time — about six of its fifteen
|
||||
minutes.
|
||||
|
||||
**A second tripwire, in the gate: `ProcessStartSitesTests`.** Qodana is advisory, and its rule is a pattern for
|
||||
`Process.Start`. The test sweeps `src` for every way a process is started here — `Process.Start`, a
|
||||
`ProcessStartInfo`, `CreateProcessWithTokenW` through CsWin32, and the registration of the logon task — and fails
|
||||
on a file that is not in its list, until that file has been read and listed. `Startup/UnelevatedProcess`, which
|
||||
the rule never saw, is in it.
|
||||
|
||||
**Every place that starts a process, as read on 2026-11-11.** The rule is a pattern, not a data flow: it reports any
|
||||
`Process.Start` whose argument is not a literal. What matters at each is what is started and where its path and
|
||||
arguments come from.
|
||||
|
||||
| Place | What it starts | Where the path and the arguments come from |
|
||||
|---|---|---|
|
||||
| `App/Services/AgentLauncher` | `FrameLedger.Agent.exe` | the file beside the App (`AppContext.BaseDirectory`); arguments the App builds (`--serve`, the data folder) |
|
||||
| `App/Services/AgentTool` | the same Agent, with one maintenance flag | a constant at each of its two callers (`--install-task`, the Settings page's flags) |
|
||||
| `Infrastructure/Startup/AgentElevation` | the Agent, elevated (`runas`) | the Agent's own path; `--serve --for-user <this user's SID>` |
|
||||
| `Infrastructure/Startup/LogonTask` | nothing itself — it registers the logon task, whose action Windows starts at sign-in | the Agent's path and constant arguments (`--serve`), into a Task Scheduler definition for this user, at the lowest privileges |
|
||||
| `Infrastructure/Diagnostics/CrashDumpWriter` | this process's own executable, as the dumper | `Environment.ProcessPath`; an `ArgumentList`, no shell |
|
||||
| `Infrastructure/Capture/ProcessLauncher` | the game | the executable the user added and enabled hooking for, and the launch arguments the user wrote for it; no shell |
|
||||
| `App/Services/ShellStarter` | a game, directly or through its store (`steam://…`, `explorer.exe shell:AppsFolder\<AUMID>`) | the launch `GamePlayer` resolves from the record of a game the user added (D59, D80) |
|
||||
| `App/Services/Explorer` | `explorer.exe` on a folder or a file | a quoted path of FrameLedger's own: the data folder, the logs, a bug report's zip, the licences folder |
|
||||
| `App/Services/ShellUrlOpener` | the browser or the mail client | the project's own pages, or a Markdown link `MarkdownLinks` has already held to `http`, `https` and `mailto`. **Hardened here**: the opener now refuses any other scheme itself (`ShellUrlOpenerTests`) — the shell runs whatever it is handed, and a `file:` address is a program |
|
||||
| `App/ViewModels/SettingsViewModel` | the browser | one constant address |
|
||||
| `Infrastructure/Startup/UnelevatedProcess` | the Agent or a game with the shell's token, from an elevated process (`CreateProcessWithTokenW`) | its two callers above, `AgentLauncher` and `ProcessLauncher` — not a `Process.Start`, so the rule did not see it; the sweep does |
|
||||
|
||||
None takes a value from outside the PC or from a file FrameLedger did not write, except the game's own path and
|
||||
arguments — which starting the game the user chose is.
|
||||
|
||||
**The native report — `qodana-native.yaml`, the job `native` (D99, 2026-11-11).** The C++ of `src/native`, read by
|
||||
the same linter — Qodana for .NET, whose C++ is ReSharper C++ — in native mode on a Windows runner. It is the only
|
||||
linter of JetBrains' that can: the native layer is MSVC-only, and the two C/C++ linters (`qodana-cpp`,
|
||||
`qodana-clang`) are Linux images. It reads C++ through a Visual Studio solution, and `src/native` is a CMake tree, so
|
||||
the job has CMake write one first: the preset **`x64-vs-analysis`** (generator "Visual Studio 18 2026", tests and
|
||||
tools on) puts `FrameLedgerNative.slnx` under `build/native/x64-vs-analysis`, and the job builds from it the one
|
||||
target whose output is a header (`fl_ac_floor_gen`, the blocklist floor). Nothing else is compiled, and nothing from
|
||||
that tree ships. Then the action, with `--config qodana-native.yaml`: the solution, `RelWithDebInfo` and `x64` — the
|
||||
flags the shipped binaries are built with — and, left out by path, what is not FrameLedger's code (the build tree,
|
||||
`third_party`, the vendor stubs, a compiled shader as a byte array). Its own results folder, cache keys and artifact
|
||||
(`qodana-report-native`), and the Qodana Cloud project `frameledger-cpp` through `QODANA_TOKEN_NATIVE`. It posts no
|
||||
comment and no annotations — a second job of the same linter would overwrite the managed job's — so its result is the
|
||||
job's own status and its report. Advisory, and a gate of zero, like the other.
|
||||
|
||||
**What it runs** is ReSharper's C++ inspections and, through them, the clang-tidy checks and clang diagnostics that
|
||||
engine bundles. clang never builds this code — MSVC does, with `/W4 /WX` — so what clang says is read as advice. Every
|
||||
one of them has a key in `.editorconfig` (`resharper_cpp_…_highlighting`; a clang-tidy check's is
|
||||
`resharper_cpp_clang_tidy_<check>_highlighting`), so D100's rule holds without a second file: no `.clang-tidy`.
|
||||
|
||||
**Its first runs, and what was done.** Run 42923079119: **4,695 problems**, 4,040 of them hints, which are off as on
|
||||
the managed side. Run 42928814104: **655** — **494 distinct**, because a source file compiled into three targets is
|
||||
reported three times.
|
||||
|
||||
| What | distinct | Done |
|
||||
|---|---|---|
|
||||
| A choice this code made, off for the native tree: where the compiler pads a struct (46); MSVC's own keywords, `__try` among them (54); a function pointer got by name cast to its real type, through `void*` (55); `reinterpret_cast` where memory is read as something else (5); `std::cmp_less` proposed for comparisons that already cast (20); a `default:` under a full enum switch (3); a copied verdict (4); the moves of a type that owns a handle (11); a zeroed out-parameter enum (8); an enum's width (5); "can be made const / constexpr / static" (52); "possibly unused `#include`" (15) | 278 | off in `.editorconfig`, each with its reason. Of the fifteen includes two were unused and were removed; the others are a file including what it uses although another header already brings it |
|
||||
| A newer idiom proposed for working code — a range-for, `std::ranges`, `any_of`, `starts_with`, a raw string, an `if` with an initialiser | 53 | off: the native code is written to be read beside the hook path, an index and a plain loop |
|
||||
| **The engine misreading**: `std::atomic_ref<T>::fetch_or` as an expression without side effects (7); a Win32, D3D12 or ffx-api structure zero-initialised and then filled field by field as "always rewritten" and "assigned, never used" (15); a test of a `constexpr` function as a redundant argument (3) | 25 | off, with what the engine gets wrong written beside the keys |
|
||||
| Fields nothing names, in a structure Windows defines and the SDK's headers do not give (`RTL_PROCESS_MODULE_INFORMATION`, `PROCESS_MEMORY_COUNTERS_EX2`) and in a test's stand-in for a Vulkan object | 25 | off for those four files: the fields are what puts the others at their offsets |
|
||||
| `%lu` with an `NvU32`, in `fl-probe-nvapi` | 19 | off for that file: NVAPI's header makes `NvU32` an `unsigned int` under clang and an `unsigned long` under MSVC — the linter's compiler, not the build's |
|
||||
| The probes, the harness and the tests: an unchecked `printf` (35), `atoi` on the harness's own arguments (20), a `&pointer` handed to a `void*` parameter (7), a printf-shaped helper (4), a fake handle built from a number (4), a test's fixtures (4), `layout_test`'s run-time checks of compile-time facts (3), a macro that pastes a name (1) | 78 | off for `tools` and `tests` |
|
||||
| Code loaded into a game (below) | 7 | kept as it is, off for those files; one of them is dead code, recorded for the owner |
|
||||
| **Fixed**: `sizeof(a) / sizeof(a[0])` → `std::size(a)` (4); a multiplication done in a narrower type than the one it is stored in or compared with (2: a constant in the guard's sources, a test); a member function, and a type alias, nothing used (3) | 9 | in the code; none changes what a shipped binary does |
|
||||
|
||||
With those settled, run 42942068024 — the first with these settings — reported **one** problem: `LogNoteW`, now by
|
||||
ReSharper's own inspection where clang's had said it before (below). And run 42943094415 (2026-11-11, this pull
|
||||
request's branch): **no problem reported** — the gate's zero, in the native report too.
|
||||
|
||||
**Code loaded into a game — the Overlay, the Vulkan layer, the shared-memory headers, the guard's rule matcher.**
|
||||
D100: there only a defect is fixed, in a pull request of its own with the hook's overhead measured (rule 5,
|
||||
`14_TESTING` §Hook overhead), and a proposal about style is not acted on. About a quarter of the 655 results were in
|
||||
those files; nearly all of them are the tree-wide kinds above. **The report found no defect there.** What is
|
||||
particular to them, read and kept: two `if` chains whose arms have the same body and are different cases, each with
|
||||
its comment (`dllmain.cpp`); MinHook's `MH_ALL_HOOKS`, which is `NULL` by its header; a retired enumerator kept so
|
||||
that its bit is not reused; `slSetTag`, deprecated by a header whose replacement no measured module exports;
|
||||
`ResolveTolerance` clearing its out-parameter with `memset`, as `ResetRules` does — a `Tolerance` is flags whose
|
||||
default initialisers are zero. And one thing that is not as it should be: **`LogNoteW` in `dllmain.cpp`, which nothing
|
||||
calls** — dead code. It is not a defect, so D100 leaves its removal to the owner (HANDOFF); until then that one file
|
||||
is not read for an unused function (`.editorconfig` says so, in a section to be removed with it).
|
||||
|
||||
**"Zero" has to mean "analysed".** A report with no problem cannot tell a clean tree from one the linter did not
|
||||
read. So the settings were proved on a branch that puts back three of the things fixed here — the unused alias, the
|
||||
unused member function, the narrow multiplication. Run 42942390715 reported exactly those three, each by the
|
||||
inspection that had found it the first time (`CppTypeAliasNeverUsed` in `tools/fl-probe-interposer/main.cpp`;
|
||||
`clang-diagnostic-unused-member-function` and `bugprone-implicit-widening-of-multiplication-result` in
|
||||
`tests/ring_test.cpp`), and `LogNoteW`, and nothing else. The branch was deleted. Do the same before trusting a
|
||||
zero after a change to the preset, the settings or the linter's version.
|
||||
|
||||
**What it does not read.** CMake files and PowerShell have no inspection in this linter (SonarCloud reads the
|
||||
PowerShell); the HLSL shader and the `.def` file are not C++. CodeQL (`analyze (cpp, manual)`, a required check) and
|
||||
SonarCloud go on reading the C++ as before: this is a third reader, and the only one of the three that is ReSharper's.
|
||||
|
||||
**Where an inspection is switched off: by the engine that raised it (D100, amending D93's "never in `qodana.yaml`").**
|
||||
What Qodana reports is fixed, unless the inspection argues with a choice this project made; then it is off, with the
|
||||
reason on the line above — in the place the engine that raised it reads:
|
||||
|
||||
- **ReSharper's** — the C#, the XAML, the `.resx`, and the C++ of the native report with the clang-tidy checks it
|
||||
runs — in **`.editorconfig`** (`resharper_*_highlighting`), where Rider and ReSharper in the editor read it too:
|
||||
sixty-four keys for the managed code, fifty-four lines for the C++, some of them for a folder or a file alone.
|
||||
- **What has no key there** — in **`qodana.yaml`**: a whole severity (the hints) and the IntelliJ platform's Markdown
|
||||
and XML inspections under `profile.inspections`; under `exclude`, by inspection and path, the files JetBrains'
|
||||
security rules were read in and a file the linter itself fails on.
|
||||
- **What is not FrameLedger's code** is left out by path (`exclude`): `SonarQube.Analysis.xml`'s list, for its reasons.
|
||||
|
||||
**What it does not use, and what happens if the licence lapses.** Quick-fixes (the linter would push commits — the job
|
||||
has no `contents: write`, and a change nobody read is not wanted), code coverage in Qodana (the gate's coverage and
|
||||
SonarCloud's already read the same reports) and FlexInspect are Ultimate features this job leaves alone. Without a
|
||||
valid licence the linter does not start, so the job is red — advisory, never a blocked merge; the way back is
|
||||
`linter: qodana-cdnet` with the job on `ubuntu-latest`, as it ran until beta.37.
|
||||
|
||||
**Running it on a developer's PC.** `qodana scan` in the repository root reads `qodana.yaml`, downloads the linter and
|
||||
needs the project's token in `QODANA_TOKEN` — the Ultimate linter checks the licence. Without a token, InspectCode
|
||||
still gives ReSharper's part (*As it was built*, below), with `--toolset-path` at the 11.0 SDK's `MSBuild.dll`; the
|
||||
Markdown, XML and security results are the Rider linter's alone.
|
||||
|
||||
**As it was built — the Community linter, 2026-11-10 to beta.37 (D93).** Kept as written; where it says *is*, read *was*.
|
||||
|
||||
**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
|
||||
@@ -481,9 +852,10 @@ Central package management makes Dependabot PRs single-file diffs.
|
||||
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 (10.0.100) with `rollForward: latestFeature`, so a
|
||||
developer's machine and the runner already build with the newest 10.0 SDK they have (the runner installed 10.0.402
|
||||
on 2026-10-20). Raising the floor is a decision about what a contributor must install, not an update.
|
||||
- **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
|
||||
@@ -520,8 +892,8 @@ Central package management makes Dependabot PRs single-file diffs.
|
||||
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, stated so that a later SDK's
|
||||
defaults cannot move them. With `TreatWarningsAsErrors` a vulnerable package is NU1901–NU1904 and the restore, so
|
||||
(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
|
||||
@@ -544,7 +916,7 @@ 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] 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)
|
||||
|
||||
+10
-3
@@ -28,7 +28,7 @@ The anti-cheat guard is the one component where a bug can cost someone an accoun
|
||||
- **Ring buffer:** SPSC correctness under a hammering writer thread; seqlock torn-read detection; wrap and overwrite-oldest semantics; power-of-two capacity assumptions. Include the **one-full-lap case**: a reader stalled exactly `capacity` records must not validate a different frame as unchanged (this is what the never-reset `seq` counter defends, `07_IPC` §Protocol rules).
|
||||
- **Drop accounting:** the reader-side computation (`writeIndex - readIndex > capacity`) reports the right count and resumes at the right index. The writer has no drop counter to test — by design.
|
||||
- **Torn records produce gap markers,** not silently shortened streams; a golden test asserts the gap does not appear as a stutter.
|
||||
- **Record and header layout:** `static_assert(sizeof(...) == 64)` and `offsetof` assertions for `FlFrameRecord` **and all ~~three~~ four header structs** (`FlShmHandshake`, `FlWriterState`, `FlControlBlock`, and `FlDisplayState` since layout 4, beta.10) — plus D33's `FlTolerance`, mirrored the same way *(corrected 2026-10-04)* — the Agent reads across the process boundary in every one of them. Both halves exist as of 2026-08-05: the native side is `layout_test.cpp` plus the `static_assert`s (ctest `fl_shm_layout`), and the runtime offset dump from `tools/fl-layout-dump` is consumed by `ShmLayoutMirrorTests`, which walks the field list in **both directions** and additionally asserts blittability — `Marshal.SizeOf` and every offset stay correct for a mirror that uses `[MarshalAs(ByValTStr)] string`, while `Unsafe.SizeOf` drops from 64 to 40 and the struct can no longer be read from a mapped view.
|
||||
- **Record and header layout:** `static_assert(sizeof(...) == 64)` and `offsetof` assertions for `FlFrameRecord` **and all ~~three~~ ~~four~~ five header structs** *(five since layout 5, 2026-11-11: `FlAdvancedState`, 1472 bytes; what reads and writes it is tested at four levels since 0.1.0-beta.40 — `fl_adv_fields` the Overlay's header alone, `fl_guard` `[advanced]` the injected Overlay with the word off and on, `InGameAdvancedSamplerTests` / `CaptureSessionTests` / `SessionRecorderTests` what the Agent makes of a publication, and `AgentEndToEndTests.WhatTheGameTellsFsrIsStoredOnlyByASessionThatRecordsAdvancedMetrics` the shipped Agent, the real Overlay and the harness: two sessions of one target, the first storing nothing of it)* (`FlShmHandshake`, `FlWriterState`, `FlControlBlock`, and `FlDisplayState` since layout 4, beta.10) — plus D33's `FlTolerance`, mirrored the same way *(corrected 2026-10-04)* — the Agent reads across the process boundary in every one of them. Both halves exist as of 2026-08-05: the native side is `layout_test.cpp` plus the `static_assert`s (ctest `fl_shm_layout`), and the runtime offset dump from `tools/fl-layout-dump` is consumed by `ShmLayoutMirrorTests`, which walks the field list in **both directions** and additionally asserts blittability — `Marshal.SizeOf` and every offset stay correct for a mirror that uses `[MarshalAs(ByValTStr)] string`, while `Unsafe.SizeOf` drops from 64 to 40 and the struct can no longer be read from a mapped view.
|
||||
- **Fault policy:** injected SEH faults in a fake hook body → counter increments, original still called, self-disable at 3.
|
||||
- **Hook index verification, by behaviour.** A vtable slot carries no identity, so "check that slot 8 *is* `Present`" is not a question the runtime can answer — the earlier wording here required something unimplementable. What is answerable: patch the slot, call the method, see whether the detour ran (`17_HOOK_ENGINE` §Getting vtable addresses; proved for slots 8, 13 and 22 in `spike-notes.md` §H4). Runs headless on CI via WARP and `CreateSwapChainForComposition`. A deliberate mismatch aborts installation instead of patching.
|
||||
- **Every probe must be shown to fail.** A probe that ends in an unconditional assertion is green by construction and its ctest is decorative — `fl_proxy_swapchain` shipped in exactly that state. Before a probe counts as a regression net, break the thing it watches and watch it go red.
|
||||
@@ -145,7 +145,7 @@ own work item on the STA thread and puts back — and with the keys a parameter,
|
||||
## Hook overhead measurement (NFR-1, per release)
|
||||
|
||||
1. `hook-harness` in a fixed workload, present-rate uncapped: 3 runs hooked vs 3 unhooked → mean present-call cost delta must be ≤ 1 µs (measured with QPC around the call site in an instrumented harness build).
|
||||
2. Real game, fixed 10-minute scene, capture ON vs OFF, 3 runs each: **game's own Avg FPS delta ≤ 0.5%**, Agent CPU ≤ 1% of a core, Agent RSS ≤ 150 MB, Overlay resident ≤ 8 MB.
|
||||
2. Real game, fixed 10-minute scene, capture ON vs OFF, 3 runs each: **game's own Avg FPS delta ≤ 0.5%**, Agent CPU ~~≤ 1%~~ ≤ 2.5 % of a core *(NFR-2 as D117 amended it, 2026-11-11; `tools/agent-cost.ps1` measures the unhooked half without a game)*, Agent RSS ≤ 150 MB, Overlay resident ≤ 8 MB.
|
||||
|
||||
> **NOT MEASURED. The runbook exists as of 2026-09-10 (P2 PR-G); the run is the owner's.**
|
||||
> `tools/fps-impact-runbook.ps1` sequences the six launches, holds consent granted for the ON leg and
|
||||
@@ -158,6 +158,13 @@ own work item on the STA thread and puts back — and with the keys a parameter,
|
||||
> Until the run happens, the honest state of this line is *unmeasured*, not *passing*.
|
||||
3. Results recorded in the release notes ("measured overhead this release: …").
|
||||
|
||||
**What a patch costs when it goes in and comes out (since 0.1.0-beta.46) is not the per-present number above**, and
|
||||
is measured where it happens: `fl_guard`'s Streamline `[advanced]` case prints the microseconds of each install
|
||||
batch and of the stop's one restore (the Overlay's `PATCH_BATCH` lines), and the time from the unhook request to
|
||||
`UNHOOKED`; it asserts that every lazily installed patch is under a batch line, that the stop is one, and that the
|
||||
restore stays under a second — the bound the one-patch-at-a-time stop did not meet on the development PC. In a real
|
||||
game the same lines are in `logs\overlay-<pid>-….log`.
|
||||
|
||||
## Tier cross-validation (accuracy regression net) — **GONE, 2026-08-28, and this is the entry to read before planning P5**
|
||||
|
||||
~~Run the same game session with Tier 1 and Tier 2 simultaneously where possible (ETW does not conflict with hooking) and compare frametime distributions: Avg/1% Low must agree within **1%**. Divergence beyond that means one of the two paths is wrong and blocks the release. This is also the check that would have caught the original detection-accuracy problem.~~
|
||||
@@ -201,7 +208,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 |
|
||||
|
||||
@@ -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) |
|
||||
|
||||
+215
-12
@@ -194,12 +194,17 @@ 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`; 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: `slEvaluateFeature` · ~~⏳ `slInit`~~ *(not hooked, and not to be: owner decision D129, 2026-11-12 — its row below says why)*, ~~`slSetFeatureLoaded`~~ *(its own row below since beta.45)*, ~~`slSetConstants`~~ *(its own row below since beta.43)*, ~~`slGetFeatureRequirements`~~ *(its own row below since beta.44, with `slGetFeatureVersion`)* | 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. **Since 0.1.0-beta.40 (Advanced metrics train B, D111), and only while the Agent asks** (`FlControlBlock.advancedRequested`): the `sl::DLSSOptions` a title chains into `inputs` — the struct the quality mode is read from — is read further: `outputWidth`/`outputHeight`, `preExposure`, `exposureScale`, `colorBuffersHDR`, the five presets of version 1, and where the struct's own `structVersion` proves them present `ultraQualityPreset` and `useAutoExposure` (≥ 2) and `alphaUpscalingEnabled` (≥ 3) — §Which struct version carries which field. Rule 4: more members of the same argument of the same call; `fl_adv_fields.h` is the one place, `tools/overlay-fields-check.ps1` holds it. No new patch site. **Measured** (the header's own functions, `/O2 /guard:cf /Qspectre /MT`, 20 M calls × 3): +9.5–11.7 ns per evaluation that chains the options while asked; with the word at 0, one relaxed load and a branch not taken — below what the bench resolves. Most titles set these through `slDLSSSetOptions`, which is not an export, and read N/A (train D) |
|
||||
| ✅ Streamline: `slSetConstants` (0.1.0-beta.43, Advanced metrics train B; owner decisions D111–D116, D122) | **What the game tells Streamline about a frame**, once per frame and viewport, read from the `sl::Constants` it passes — rule 4: an argument of the call hooked, and of it only the members named here. **Read:** `jitterOffset`, `mvecScale`, `cameraNear`, `cameraFar`, `cameraFOV`, `cameraAspectRatio` and the seven `Boolean`s (`depthInverted`, `cameraMotionIncluded`, `motionVectors3D`, `reset`, `orthographicProjection`, `motionVectorsDilated`, `motionVectorsJittered`). **Never read:** the five matrices (bytes 32..351 of the struct), `cameraPinholeOffset`, and the camera's position and three axes (bytes 368..423) — `tools/overlay-fields-check.ps1` refuses their names anywhere in code loaded into a game, and ctest `fl_adv_fields` publishes two structs that differ in every one of those bytes and gets the same bytes out. **The one row that is not installed unless asked for** (D111): `InstallByFamily` returns before it resolves the symbol in a process the Agent has never asked for Advanced metrics — resolving takes a reference on the module — so with the option off the export's first bytes are the file's (`fl_guard` `[advanced]` reads them from the target). Once asked, the patch goes in on that watchdog tick and stays for the life of the process; the detour forwards without looking while the request is off, and after a stop (`MayObserve`). **Every call** checks the struct's GUID and a `structVersion` of at least 1 before any member is read, and the viewport handle's the same way; every member read is one version 1 carries, so a version-1 struct laid against unreadable memory is read whole without a fault (the same ctest). **Summaries are the first viewport's**: a title with two viewports sets constants for each every frame, and "the last value" across them would flip twice a frame; the call count is of every viewport. `FLT_MAX` is Streamline's "not set" here and is kept nowhere (D119's plane at infinity is FidelityFX's). Family `FL_HOOK_SL_CONSTANTS` (bit 13), published with the patch: it entitles no field of a frame record, and tells "hooked, never called" from "not hooked". **Measured overhead** (the detour's body on the headers, the Overlay's flags, 20 million calls a run, three runs): not asked **+0.57 / +0.60 / +0.58 ns**; asked, the summarised viewport **+19.61 / +19.54 / +19.79 ns**; asked, another viewport +5.83 / +6.01 / +5.62 ns. |
|
||||
| ✅ Streamline: `slGetFeatureVersion` and `slGetFeatureRequirements` (0.1.0-beta.44, Advanced metrics train B's third step; owner decisions D111–D116, D122) | **What Streamline answers when the game asks about a feature** — which version it is, and what it requires. Two rows, two patches, two detours of one shape: **the original runs first, exactly once, on every path, with both arguments forwarded untouched**, and the struct the game passed is read only when the original said `eOk` — a refusal leaves the struct as the game made it, which is not an answer. Rule 4: an argument of the call hooked, read after the call, and of it only the members named here. **Read from `sl::FeatureVersion`:** `versionSL`, `versionNGX`. **Read from `sl::FeatureRequirements`:** `flags`, `maxNumCPUThreads`, `maxNumViewports`, `numRequiredTags`, `osVersionDetected`, `osVersionRequired`, `driverVersionDetected`, `driverVersionRequired`. **Never read:** `requiredTags` — the pointer the count belongs to — and everything after `driverVersionRequired`: the Vulkan queue counts and the pointers to the names of extensions and features. **No pointer of the game's is followed** (`tools/overlay-fields-check.ps1`, parameters `fv` and `fr`; ctest `fl_adv_fields`: two answers that differ only in those bytes publish the same region, and an answer cut off where the Vulkan members begin, laid against unreadable memory, is read without a fault; the injected `fl_guard` case's stub hands back wild pointers and no fault is counted). **Installed only where asked for** (D111), as `slSetConstants` is: `InstallByFamily` returns before it resolves either symbol in a process the Agent has never asked for Advanced metrics; once in, a patch stays for the life of the process and its detour forwards without looking while the request is off. **They are the first two rows of the table**: a game asks these while it starts, the watchdog patches rows in the table's order, and each patch stops the game's threads for a moment (0.1–0.25 s apart in the owner's logs of 2026-11-12, where `slSetConstants` was the fifth Streamline patch in, 1.9–7.8 s after the attach). *(Since 0.1.0-beta.46 the rows a tick finds go in together, under one stop of the threads — §Unhooking, Batches — so the order no longer decides which row waits behind which; it is still the order of their log lines.)* In a process never asked they are passed over and the order changes nothing. ~~**Most sessions will still have missed the calls** — an attach after the game's start-up is the usual case — and the session then says the call was hooked and the game did not ask again.~~ *(Measured 2026-11-12, the owner's eight sessions on beta.44: both calls were read in six of six Streamline sessions on five games — Unreal's Streamline plugin asks again after the attach, Cyberpunk 2077 asks again for requirements and not for versions. A game that asks only while starting still reads "hooked, not asked again".)* Three conditions before a read, as for `slSetConstants`: the Agent is asking, observing has not stopped, and the struct carries its own GUID and a version of at least 1 on this call (a struct with another GUID is not kept: the injected case sends one). Every member read is version 1's (§Which struct version carries which field). **Twelve slots** in region 5 (`FlAdvancedState.features`, layout 5 as it was), one per feature in the order first asked about; the last answer about a feature is the one kept; a thirteenth feature is not kept. **A new request does not empty them**: what version a feature is and what it requires are facts about the process, and a second session of a game that kept running would otherwise have nothing where the first had the answer — the one group `Reset` leaves, with its bit of the mask. Streamline 1.x is refused before anything is resolved (`SpeaksStreamline2`). Families `FL_HOOK_SL_FEATURE_VERSION` (bit 15) and `FL_HOOK_SL_FEATURE_REQUIREMENTS` (bit 16), each published with its patch; neither entitles a field of a frame record. **Measured overhead** (the detours' bodies on the headers, the Overlay's flags, 20 million calls a run, three runs, eight features asked about in turn): the version — not asked **+0.58 / +0.61 / +0.58 ns**, asked **+14.82 / +14.54 / +14.47 ns**; the requirements — not asked **+0.58 / +0.63 / +0.61 ns**, asked **+20.88 / +21.01 / +20.96 ns**. A game makes these calls a handful of times. |
|
||||
| ✅ Streamline: `slIsFeatureSupported`, `slIsFeatureLoaded`, `slSetFeatureLoaded` (0.1.0-beta.45; owner decisions D129–D131) | **Whether a feature is supported, whether it is loaded, and the game switching it on and off.** Three rows, three patches. Rule 4: bare arguments and results of the calls hooked, and no vendor struct at all — the feature's id; the `sl::Result` `slIsFeatureSupported` returned, **every result**, since a refusal is the answer to that question (the original runs first, both arguments forwarded untouched); the `bool` `slIsFeatureLoaded` wrote, read only when it returned `eOk`; the `bool` the game passed to `slSetFeatureLoaded`, noted before the call. **The adapter `slIsFeatureSupported` is asked about is never read** (D131): `sl::AdapterInfo` holds the adapter's LUID or a Vulkan physical device; the detour forwards the reference and `tools/overlay-fields-check.ps1` refuses the names of its members (`deviceLUID`, `deviceLUIDSizeInBytes`, `vkPhysicalDevice`) anywhere in the Overlay and the Vulkan layer — the fixture's adapter carries a wild pointer. **Installed only where asked for** (D111), as the four rows before them. `slIsFeatureSupported` and `slIsFeatureLoaded` follow the two rows of beta.44 at the head of the table; `slSetFeatureLoaded` follows `slSetConstants`. **Kept in word 1 of the feature's slot** (region 5, layout 5 as it was): bit 2 and the result in bits 8..15, bits 3 and 4, bits 5 and 6 — the last two a session's, cleared by a new request; the rest the process's, kept (`fl_adv_fields.h` `kFeatureSessionBits`). A refused feature therefore has a slot now, with nothing in it but that word. The declarations of the three functions are the same from Streamline v2.0.0 to v2.14.16, and `sl::Result` is the same forty codes in the same order at all sixteen tags (`include/sl_result.h`, `05a3c7e3889c` … `8a844b68ff55`), so a code means the same whatever interposer answered. Families `FL_HOOK_SL_FEATURE_SUPPORTED` (bit 17), `FL_HOOK_SL_FEATURE_LOADED` (18), `FL_HOOK_SL_SET_FEATURE_LOADED` (19), each published with its patch. **Measured overhead** (the detours' bodies on the headers, the Overlay's flags, 20 million calls a run, three runs, eight features in turn): `slIsFeatureSupported` — not asked **+1.50 / +1.48 / +1.50 ns**, asked **+11.97 / +11.98 / +12.08 ns**; `slIsFeatureLoaded` — **+1.79 / +1.77 / +1.89 ns**, **+12.35 / +12.31 / +12.33 ns**; `slSetFeatureLoaded` — **+1.44 / +1.47 / +1.80 ns**, **+11.28 / +11.54 / +11.45 ns**. **`slInit` is not a row and will not be** (D129): a game calls it once, before the Overlay is in the process or before a patch can land — launch mode waits for the presentation runtime before it injects, nothing is ever patched on a game's thread (§H2), and a row that exists only for Advanced metrics waits for the Agent's request. **A stop takes about 160 ms for every patch it restores** (measured on the fixture, 0.1.0-beta.45: each `MH_DisableHook` snapshots the system's threads): twelve patches took 1.9 s, fifteen 2.4 s, and the watchdog's wait for the stop's log lines, 2 s until then, is now a quarter of a second for every patch the registry can hold. **Since 0.1.0-beta.46 (D134) a stop restores its patches under one stop of the threads**: eighteen in 76–90 ms on the fixture, where one by one they took 1.37–1.56 s (§Unhooking, Batches). |
|
||||
| ✅ Streamline: `slAllocateResources`, `slFreeResources`, `slShutdown` (0.1.0-beta.45; owner decision D130) | **The game allocating and freeing a feature's resources, and shutting Streamline down — counted, and nothing else.** Three rows, three patches. Rule 4: the feature's id is the only argument looked at; the command buffer and the viewport of the two resource calls are forwarded and never read (the fixture's command buffer is a wild pointer), and `slShutdown` has no argument. **`slFreeResources` and `slShutdown` are on a game's way out**: each detour notes the call first and then calls the original, exactly once, and runs nothing of ours after it returns; the fixture goes on calling the stub after `slShutdown`, through every detour. **Installed only where asked for** (D111); the last three Streamline rows of the table. **Kept** in word 1 of the feature's slot as two four-bit counts — allocations in bits 16..19, frees in 20..23, each stopping at 15 and never carrying into its neighbour — and, for `slShutdown`, in `FlAdvancedState.slShutdowns` (@308, the first of three reserved words; layout 5 as it was) with `FL_ADV_VALID_SL_SHUTDOWN` (bit 6 of the mask). All three are a session's: a new request clears them. Families `FL_HOOK_SL_ALLOCATE_RESOURCES` (bit 20), `FL_HOOK_SL_FREE_RESOURCES` (21), `FL_HOOK_SL_SHUTDOWN` (22). The three declarations are the same from Streamline v2.0.0 to v2.14.16. **Measured overhead** (the detours' bodies on the headers, the Overlay's flags, 20 million calls a run, three runs): `slAllocateResources` — not asked **+0.70 / +0.72 / +0.80 ns**, asked **+10.43 / +10.53 / +10.74 ns**; `slFreeResources` — **+0.61 / +0.84 / +0.58 ns**, **+10.33 / +10.57 / +10.44 ns**; `slShutdown` — not asked within the bench's noise (+0.06 / −0.12 / +0.04 ns), asked **+3.39 / +3.37 / +3.52 ns**. Inventory 23 → 26 rows; a Streamline title with Advanced metrics asked for now carries thirteen patches on the interposer, and a stop restores each in about 160 ms (the row above). **In real games (2026-11-13: six sessions, five games)** `slAllocateResources` was not called once after the attach, `slFreeResources` once in one game (Phantom Blade Zero, frame generation's) and `slShutdown` once in one (Dying Light: The Beast); no session counted a fault, and the two games that fault while closing did so at the offsets they had before these hooks. Installing the thirteen interposer patches took 0.7 s to 2.8 s of a game's start, 57 to 215 ms a patch. The owner's word on both (2026-11-13): `slAllocateResources` keeps its patch and is looked at again with more sessions (D135); installs and restores are to be batched, one stop of the threads for a batch (D134, 0.1.0-beta.46). |
|
||||
| ✅ 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 — *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". |
|
||||
| ✅ **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 *(since 0.1.0-beta.43, owner decision D125: **counted at the first source that saw an UPSCALE and at no other** — `g_ffxUpscaleOwner`, `fl::adv::Owns`. Cyberpunk 2077's loader 2.3.0 hands a dispatch on to the leaf's export — its frame-generation dispatch types are logged on the loader and on the leaf — so an UPSCALE through such a loader reaches two hooked modules, and one count per module read K = 1 as 2.0 on the fixture bound that way (`--ffx-topology 2x-export`: 60 presents, 120 counted). No title run so far upscales through one; it is a precaution. Measured on the header with the Overlay's flags: +0.02 to +0.03 ns on the module that is counted, about 4 ns less on the forwarded copy)*; **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. **Since 0.1.0-beta.40 (Advanced metrics train B, D111), and only while the Agent asks:** the UPSCALE arm reads the rest of `ffxDispatchDescUpscale` — `enableSharpening`, `sharpness`, `jitterOffset`, `preExposure`, `cameraNear`, `cameraFar`, `cameraFovAngleVertical`, `flags`, `reset`, `frameTimeDelta` — into process-local summaries (an "ever seen" mask, a largest magnitude, a lowest and highest, a count and a sum; one module's dispatches are counted, so a dispatch that reaches the loader and a leaf is one). Never on the FSR 3.0 host's legacy descriptor, which is vouched Line truncated
|
||||
| ✅ **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". **Since 0.1.0-beta.40 (Advanced metrics train B, D111), and only while the Agent asks:** when the query the vendor answered OK is the upscaler's memory — `FFX_API_QUERY_DESC_TYPE_UPSCALE_GPU_MEMORY_USAGE` (`0x00010008`, ffx-api 1.1.2) or `…_V2` (`0x00010009`, 2.0) — the `FfxApiEffectMemoryUsage` it wrote through the title's own out-pointer is kept (total and aliasable bytes), one module's queries counted. Only a title that asks is answered: FrameLedger never calls `ffxQuery` itself. The frame-generation memory queries (`0x00020007`, `0x0002000b`) are not read. +4.3–6.1 ns per such query while asked. Harness: `--ffx-memory-query v1|v2`; `fl_guard` "region 5 stays empty until the Agent asks". |
|
||||
| ~~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~~ |
|
||||
| ✅ **FidelityFX ffx-api: `ffxConfigure` on the same four modules** (0.1.0-beta.43, Advanced metrics train B; owner decisions D111–D116, D122) | **How the game configures FSR frame generation** — a title calls `ffxConfigure` with a frame-generation descriptor, usually every frame. Rule 4: an argument of the call hooked, and of it only what is named here. **Read**, and only when the header's type is `FFX_API_CONFIGURE_DESC_TYPE_FRAMEGENERATION` (`0x20002`): `frameGenerationEnabled`, `allowAsyncWorkloads`, `flags`, `onlyPresentGenerated`, `generationRect`. **Never read:** `swapChain`, the two callbacks and their contexts, `HUDLessColor`, `frameID`; and of every other configure type — key-value pairs, the distortion field, the camera info — nothing but the header's type. ctest `fl_adv_fields` publishes two descriptors that differ in all of those and gets the same bytes out, and hands the detour a key-value descriptor, which is shorter, without a read past it. **Installed only where asked for** (D111), as `slSetConstants` is: `InstallByFamily` returns before it resolves anything in a process never asked for Advanced metrics, so with the option off the export's first bytes in the target are the file's (`fl_guard` `[advanced]`). Published when every ffx-api module the process loaded is patched (`FL_HOOK_FFX_CONFIGURE`, bit 14), as the dispatch and query families are. **Counted at the first module that saw a frame-generation configure** — an owner slot of its own: the fixture's loader has always handed `ffxConfigure` on to the leaf's export, and Cyberpunk 2077's loader does the same with dispatches, so one call reaches two hooked modules (the injected case reads one configure a frame through the loader, not two). The rectangle is stored in one word, sixteen bits a side, so a publication never carries half of one rectangle beside half of the next; a side that is negative or past fifteen bits makes it four `-1`. The descriptor's type is kept for the log whatever it is (`FFX_CONFIGURE`, §Native logging). The detour consults `MayObserve()` first. **Measured overhead** (the detour's body on the headers, the Overlay's flags, 20 million calls a run, three runs): not asked **+1.72 / +1.68 / +1.78 ns** (the type kept for the log); asked, the counted module **+15.02 / +15.55 / +15.11 ns**; asked, the forwarded copy +2.70 / +2.81 / +2.65 ns; asked, another configure type +2.43 / +2.55 / +2.47 ns. |
|
||||
| ✅ **Application frames per present** (`fgEvaluations`) — **`sl.interposer.dll!slGetNewFrameToken` since 2026-09-03** | Native vs Displayed frame counts at Tier 1 — see `03_METRICS` §Frame Generation. **The producer is the frame-token export**: Streamline hands a title one token per application frame and the title must ask; the detour counts distinct tokens between two presents (pointer changes, nothing dereferenced), `FL_HOOK_FG_EVALUATIONS` is its family, and it installs on every Streamline 2 title including the ones that evaluate nothing through `slEvaluateFeature`. Rule 4: the out-parameter of an API we hooked. Premise and its gate in `03_METRICS`; pre-committed table in `20_OPEN_QUESTIONS` §S31. *The row as it stood before:* ~~NGX/SL/FFX/XeSS FG feature evaluations per present. **Built 2026-08-15 for Streamline, and MEASURED TO YIELD NOTHING ON THAT ROUTE**~~ — `slEvaluateFeature(kFeatureDLSS_G)` is never called by Cyberpunk 2077 (0 across ~14,000 batches, four FG settings), so this row installs, is honest, and counts zero; see `docs/HANDOFF.md` item 3. Built on the detour that was already there: `kFeatureDLSS_G` contributes to a saturating COUNT in the same word the feature bits live in (`fl_sl_seen.h`) rather than to a bit, because a bit collapses several evaluations between two presents into one — and under multi-frame generation that is the common case, not the edge. The row's family is therefore compound (`FL_HOOK_UPSCALER_IDENTITY \| FL_HOOK_FG_EVALUATIONS`), pinned by a `static_assert` because `hookinventory-check` reads that column as an opaque identifier. **Counts EVALUATIONS, not generated frames** — the 2026-08-14 owner ruling; the multiplier lives in `sl::DLSSGOptions`, which is only reachable by the route §2b refused. ~~Non-NVIDIA FG vendors are **deferred with a written rationale**: `amd_fidelityfx_framegeneration_dx12.dll` 3.1.5 exports only the five generic `ffx*` entry points, identical to five sibling modules, so identity is in the arguments and we have no headers~~ — **AMD has a producer since 2026-09-04** (the FidelityFX row above: the PREPARE dispatch's `frameID`, or the UPSCALE count on a title that never prepares, feeds `fgEvaluations` when Streamline has never issued a token); Intel stays at the census (`20_OPEN_QUESTIONS` §Scope decisions, by licence); the FSR 3.0 host DLL's UPSCALE (`ffxFsr3ContextDispatchUpscale`, since 2026-09-05) counts like an ffx-api UPSCALE when neither Streamline nor a PREPARE has spoken |
|
||||
|
||||
> `GetFrameStatistics().PresentCount` is **not** in this inventory and must not be
|
||||
@@ -300,6 +305,72 @@ So:
|
||||
> **`third_party/streamline/README.md` asserted this pass existed for five days
|
||||
> before it did**, which is why it is described here rather than only there.
|
||||
|
||||
### Which struct version carries which field (owner decision D115, 2026-11-11)
|
||||
|
||||
**A field of a vendor struct is read only where it is proven to be there.** A game hands a hook a struct of the
|
||||
version it was built against; a member a later version added lies past the end of what an older game allocated, and
|
||||
reading it is reading game memory outside the argument (rule 4) — not merely a wrong value. So every read of a tail
|
||||
member is gated on the struct's own version, and the gate comes from this table, not from the one header in the tree
|
||||
— which declares only the newest shape, and for `sl::DLSSOptions` says nothing about which version added what.
|
||||
|
||||
Established 2026-11-11 from the upstream tags, through GitHub's API: each tag's header was fetched by blob and the
|
||||
struct's declarations — type, name and order — compared across tags. The members' own types were checked at the
|
||||
oldest and the newest tag (`enum Boolean : char`, `enum class DLSSMode : uint32_t`, `enum class DLSSPreset :
|
||||
uint32_t`, `float2`/`float3`/`float4x4`; no `#pragma pack` in either).
|
||||
|
||||
**Streamline** (`NVIDIA-RTX/Streamline`; tags v2.0.0, v2.1.0, v2.2.0, v2.4.0, v2.4.15, v2.7.2, v2.7.30, v2.7.32,
|
||||
v2.8.0, v2.9.0, v2.10.0, v2.10.3, v2.11.1, v2.12.0, v2.14.1, v2.14.16):
|
||||
|
||||
| Struct | `structVersion` | First tag (blob of the header) | Members that version adds, in order |
|
||||
|---|---|---|---|
|
||||
| `sl::DLSSOptions` (`include/sl_dlss.h`) | 1 | v2.0.0 (`7de7411e507d`) | `mode`, `outputWidth`, `outputHeight`, `sharpness`, `preExposure`, `exposureScale`, `colorBuffersHDR`, `indicatorInvertAxisX`, `indicatorInvertAxisY`, `dlaaPreset`, `qualityPreset`, `balancedPreset`, `performancePreset`, `ultraPerformancePreset` |
|
||||
| | 2 | v2.1.0 (`60882f60e6f4`) | `ultraQualityPreset`, `useAutoExposure` |
|
||||
| | 3 | v2.4.0 (`27d352db364f`) | `alphaUpscalingEnabled` |
|
||||
| `sl::Constants` (`include/sl_consts.h`) | 1 | v2.0.0 (`db6f37adcf66`) | every member through `motionVectorsJittered` — the matrices, `jitterOffset`, `mvecScale`, `cameraPinholeOffset`, the camera's position and axes, `cameraNear`, `cameraFar`, `cameraFOV`, `cameraAspectRatio`, `motionVectorsInvalidValue`, the seven `Boolean`s |
|
||||
| | 2 | v2.4.0 (`bba15338a623`) | `minRelativeLinearDepthObjectSeparation` |
|
||||
| `sl::FeatureVersion` (`include/sl.h`; `include/sl_core_types.h` from v2.7.2) | 1 | v2.0.0 (`fc2d6ee39fea`) | `versionSL`, `versionNGX` |
|
||||
| `sl::FeatureRequirements` (the same headers) | 1 | v2.0.0 (`fc2d6ee39fea`) | `flags`, `maxNumCPUThreads`, `maxNumViewports`, `numRequiredTags`, `requiredTags`, `osVersionDetected`, `osVersionRequired`, `driverVersionDetected`, `driverVersionRequired`, then ten Vulkan members from `vkNumComputeQueuesRequired` to `vkFeatures13` |
|
||||
| | 2 | v2.1.0 (`79037e0974d2`) | `vkNumOpticalFlowQueuesRequired` |
|
||||
|
||||
`sl::DLSSOptions` keeps those seventeen declarations, same types and order, through v2.14.16 (`9a875bd4f843`); v2.8.0
|
||||
only re-spelled the deprecated `sharpness`. `sl::Constants` is unchanged from v2.4.0 through v2.14.16
|
||||
(`15589e577df9`). Streamline 1.x is refused before any read (`SpeaksStreamline2`). **Since 0.1.0-beta.43 the
|
||||
Overlay reads `sl::Constants`, and only members of version 1** — nothing of version 2 — so no version test beyond
|
||||
"at least 1" is needed, and the read ends before `minRelativeLinearDepthObjectSeparation`, the member version 2
|
||||
added.
|
||||
|
||||
**The two answers about a feature** (established 2026-11-12, the same way, over the same sixteen tags):
|
||||
`sl::FeatureVersion` is two members at every tag, and `sl::FeatureRequirements` is the nineteen of v2.0.0 plus the
|
||||
one v2.1.0 added, unchanged through v2.14.16 (`a255f5c5e99a`). `sl::Version` is three `uint32_t` — `major`, `minor`,
|
||||
`build` — in `include/sl_version.h` from v2.0.0 (`deec7cd04363`) to v2.14.16 (`dc3041ae8b44`), and the two functions'
|
||||
declarations are the same at both ends: `sl::Result slGetFeatureVersion(sl::Feature, sl::FeatureVersion&)` and
|
||||
`sl::Result slGetFeatureRequirements(sl::Feature, sl::FeatureRequirements&)`. **Since 0.1.0-beta.44 the Overlay reads
|
||||
both, and only members of version 1**: the read of the requirements ends at `driverVersionRequired`, before the first
|
||||
Vulkan member, so no version test beyond "at least 1" is needed.
|
||||
|
||||
**FidelityFX** (`GPUOpen-LibrariesAndSDKs/FidelityFX-SDK`; tags v1.1.0 — FSR 3.1.0, the first ffx-api — v1.1.1,
|
||||
v1.1.2, v1.1.3, v1.1.4, v2.0.0, v2.1.0, v2.2.0, v2.3.0, v2.4.0). The descriptor header carries a `type` and no size
|
||||
or version, so the question is whether the declaration ever changed:
|
||||
|
||||
| Struct | Tags | Result |
|
||||
|---|---|---|
|
||||
| `ffxDispatchDescUpscale` | v1.1.0 (`68860479bb94`) … v2.4.0 (`9d4a3e5f6c60`) | **one declaration in all ten**: twenty-three members, `flags` the last |
|
||||
| `ffxConfigureDescFrameGeneration` | v1.1.0 (`0ecdd4b4e59b`) … v2.4.0 (`823a3b4720f1`) | **one declaration in all ten**: thirteen members |
|
||||
| `FfxApiResource`, `FfxApiResourceDescription`, `FfxApiFloatCoords2D`, `FfxApiDimensions2D`, `FfxApiRect2D` | v1.1.0 … v2.4.0 | one declaration each in all ten |
|
||||
| `ffxQueryDescUpscaleGetGPUMemoryUsage` (`0x00010008`), `FfxApiEffectMemoryUsage` | from v1.1.2 | one declaration since; a game that sends the type knows the struct |
|
||||
| `ffxQueryDescUpscaleGetGPUMemoryUsageV2` (`0x00010009`) | from v2.0.0 | one declaration since |
|
||||
|
||||
**What follows for a hook** (Advanced metrics, train B):
|
||||
|
||||
- `sl::DLSSOptions`: a member is read at `structVersion >=` the row that adds it — never "at least 1" for the tail.
|
||||
- `sl::Constants`: everything this project may read is version 1's. The camera's position, axes and matrices are
|
||||
never read at any version (rule 4; the catalog's `PlayerState`).
|
||||
- `ffxDispatchDescUpscale`, `ffxConfigureDescFrameGeneration`: every member may be read on the ffx-api route, since
|
||||
no ffx-api release has a shorter one. `ffxDispatchDescFrameGenerationPrepareV2`'s camera arrays are never read.
|
||||
- **Not established, so nothing more is read there**: the FSR 3.0 host's legacy descriptors (`fsr3-v3.0.x`) beyond
|
||||
the `renderSize` the existing hook pins; any struct of a Streamline or FidelityFX release newer than the last tag
|
||||
above — a re-vendoring re-runs this comparison (`third_party/*/README.md` §Checklist).
|
||||
|
||||
### Ray tracing
|
||||
| Hook | Yields |
|
||||
|---|---|
|
||||
@@ -334,7 +405,7 @@ So:
|
||||
| Hook / call | Yields |
|
||||
|---|---|
|
||||
| ~~`IDXGIAdapter3::QueryVideoMemoryInfo` (we **call** it, not hook it, once per second from our own thread)~~ | ~~**Per-process VRAM** `CurrentUsage` + `Budget` — previously impossible; now exact~~ **Never built; superseded 2026-10-03 (D43):** the game's memory is read from OUTSIDE the game by the Agent (`18_GPU_VENDOR_APIS` §The game process's memory), so nothing in the Overlay calls it. Only the budget would need it, and that stays open (`20_OPEN_QUESTIONS` §M11) |
|
||||
| NVAPI Reflex: hook `NvAPI_D3D_SetSleepMode`, `NvAPI_D3D_SetLatencyMarker`; call `NvAPI_D3D_GetLatency` | Reflex on/off + PC latency breakdown. Declarations come from the vendored MIT NVAPI headers (`18_GPU_VENDOR_APIS` §L3); the Overlay links them like any other header. NVIDIA-only — the whole block compiles out to a no-op capability flag elsewhere |
|
||||
| NVAPI Reflex: ~~hook `NvAPI_D3D_SetSleepMode`, `NvAPI_D3D_SetLatencyMarker`~~; call `NvAPI_D3D_GetLatency` *(**never built.** The two hooks cannot be: neither function is an export — `20_OPEN_QUESTIONS` §M14. What a call-only route would take is read through in `spike-notes` §30, 2026-11-12, and waits for the owner's go or no)* | Reflex on/off + PC latency breakdown. Declarations come from the vendored MIT NVAPI headers (`18_GPU_VENDOR_APIS` §L3); the Overlay links them like any other header. NVIDIA-only — the whole block compiles out to a no-op capability flag elsewhere |
|
||||
|
||||
### Explicitly not hooked
|
||||
Input APIs, file I/O, network, memory allocators, window messages beyond what the overlay needs, anything game-specific. Rule 4 in CLAUDE.md.
|
||||
@@ -571,7 +642,7 @@ Field notes — each of these was a defect in an earlier revision:
|
||||
- **SPSC lock-free ring**, capacity a power of two (default 8192 records = 512 KB), overwrite-oldest.
|
||||
- Writer/reader seqlock protocol, including the rule that the payload write must
|
||||
**exclude** the `seq` field and that `seq` is never reset: `07_IPC` §Protocol rules.
|
||||
- Header: ~~three~~ **four** separate 64-byte lines before the ring *(corrected 2026-10-04: since layout 4, 2026-09-27,
|
||||
- Header: ~~three~~ **four** separate 64-byte lines before the ring — and, since layout 5 (2026-11-11), region 5's twenty-three, which the watchdog alone writes and only while the Agent asks (`07_IPC` §Region 5) — *(corrected 2026-10-04: since layout 4, 2026-09-27,
|
||||
beta.10, `FlDisplayState` at 0xC0 — Overlay-written at most every 500 ms; the ring starts at 0x100)* — `FlShmHandshake` (write-once),
|
||||
`FlWriterState` (Overlay-written: `writeIndex`, `status`, `apiMask`, `faultCount`),
|
||||
and `FlControlBlock` (**Agent**-written: `pauseRequested`, `unhookRequested`,
|
||||
@@ -643,7 +714,7 @@ Every hook body is wrapped:
|
||||
```
|
||||
|
||||
- Any SEH exception inside our code ⇒ increment `faultCount`, record which hook, **return control to the original function** so the game continues.
|
||||
- 3 faults total ⇒ set `status = self_disabled`, ~~uninstall all hooks (`MH_DisableHook(MH_ALL_HOOKS)`)~~ restore each patch's prologue only while its bytes are still our jump (compare-and-restore per patch through `StopObserving`, §Unhooking, §H7 — `MH_ALL_HOOKS` would have removed an overlay chained after us; corrected 2026-09-27), stop writing, stay dormant. The Agent sees the flag and finalizes the session as `degraded`.
|
||||
- 3 faults total ⇒ set `status = self_disabled`, ~~uninstall all hooks (`MH_DisableHook(MH_ALL_HOOKS)`)~~ restore each patch's prologue only while its bytes are still our jump (compare-and-restore per patch through `StopObserving`, §Unhooking, §H7 — `MH_ALL_HOOKS` would have removed an overlay chained after us; corrected 2026-09-27; since 0.1.0-beta.46 the patches that are still ours come out together, under one stop of the threads — §Unhooking, Batches), stop writing, stay dormant. The Agent sees the flag and finalizes the session as `degraded`.
|
||||
- Never `__try` around the call to the original function — only around *our* code, so we never mask a game bug as ours or vice versa.
|
||||
- The trampoline call to the original is always executed exactly once, on every path, including error paths.
|
||||
|
||||
@@ -663,6 +734,82 @@ Every hook body is wrapped:
|
||||
> foreign one in ctest `fl_unhook_inline` (the vtable form stays in `fl_unhook_preserves_foreign`), and
|
||||
> against the injected Overlay in ctest `fl_guard` `[log]`, where every patch reads `UNHOOK_RESTORED`
|
||||
> because the harness is alone in its process.
|
||||
>
|
||||
> **The registry refuses what it cannot hold, and a patch is registered before it can run (0.1.0-beta.42,
|
||||
> `fl_patch_registry.h`).** The registry was an array and a counter, and two things were wrong with it — found by
|
||||
> reading the code for the plan of the next two hooks, not by a failure. **Full meant silent:** `RegisterPatch`
|
||||
> wrote its entry only while it fitted, after `PatchTarget` had already enabled the hook, so a 49th patch would
|
||||
> have been live and unknown to the stop, with no line anywhere. (Twenty patch sites exist; the rule no longer
|
||||
> depends on that count being right, and a `static_assert` now checks the capacity against the inventory's own row
|
||||
> count plus the seven sites that are not rows.) **Enabled before registered:** `PatchTarget` enabled the hook,
|
||||
> re-read `g_observing`, and registered last; a stop between the re-read and the registration walked a table
|
||||
> that did not hold the patch yet, and the patch stayed in after "stopped". The DXGI three and the loader detour
|
||||
> registered after enabling too, with no re-read at all.
|
||||
>
|
||||
> One sequence now, `fl::patch::Install`: **take a slot — no slot, no patch, nothing created — create, enable,
|
||||
> commit the slot, then re-read the flag.** The stop clears the flag and then walks the committed slots. Each side
|
||||
> writes and then reads what the other wrote, sequentially consistent, so at least one sees the other: the walk
|
||||
> restores the patch, or the installer finds the flag clear and takes its own patch out (and retires the slot,
|
||||
> so the walk does not report it as somebody else's). A slot whose patch failed is free again; one that was ever
|
||||
> live is never reused — the walk reads it without a lock. Nothing is created once observing is off. A patch
|
||||
> that did not go in is logged once per target and reason, `PATCH_FAILED a=<reason>` (`2` stopped, `3` registry
|
||||
> full, `4` create failed, `5` enable failed, `6` the stop arrived meanwhile); until now every such failure was
|
||||
> silent. The three DXGI patches are still enabled together and keep the same rules by hand; when any step of
|
||||
> theirs fails, whatever a partial enable left in is taken out — it used to stay, unregistered, with init
|
||||
> reporting failure. And two stores that could overwrite a stop's reason no longer do: `READY` is written only
|
||||
> over `INIT`, and init's failure path stores nothing. No hook body changed. ctest `fl_unhook_inline` drives
|
||||
> the shipped sequence against real MinHook patches: a full registry leaves the target's bytes untouched and
|
||||
> MinHook unasked; a stop arranged between the enable and the re-read ends with the function unpatched; a failed
|
||||
> patch gives its slot back; a slot is invisible to the walk until committed.
|
||||
>
|
||||
> **Batches, 0.1.0-beta.46 (owner decision D134): one stop of the game's threads for a group of patches.** MinHook
|
||||
> writes a jump with every other thread of the process stopped — a snapshot of the system's threads, then a
|
||||
> suspend, a context read and a resume for each of the process's — and `MH_EnableHook` / `MH_DisableHook` for one
|
||||
> target do all of that for one jump. The owner's logs of 2026-11-13 put a number on it: the thirteen Streamline
|
||||
> patches took 0.74 s to 2.8 s of a game's start, 57 to 215 ms each, and a stop restored its patches the same way.
|
||||
> MinHook 1.3.4 can queue — `MH_QueueEnableHook` / `MH_QueueDisableHook` mark a hook, `MH_ApplyQueued` executes
|
||||
> every mark under one stop — and `fl_patch_registry.h` now has the two sequences that use it:
|
||||
> `fl::patch::Batch` (`Add`: slot and create, nothing marked; `Commit`: enable them all) and
|
||||
> `fl::patch::RestoreAll`, which is the stop's walk. `InstallUpscalerHooks` queues every row a tick finds
|
||||
> something for and commits once, before the families that are published "when whole"; `InstallRtHooks` batches
|
||||
> its two; `StopObserving` calls `RestoreAll`. A patch's `HOOK_INSTALLED` line, family bit and latch still come in
|
||||
> that order and only once it is in. The loader detour, OpenGL and the three DXGI patches of init are as they were.
|
||||
>
|
||||
> **What the queue makes dangerous, and what the code therefore never does** (the plan was reviewed against
|
||||
> `hook.c` before a line was written, and its first form was refused). `MH_ApplyQueued` applies **every** hook
|
||||
> whose mark differs from its state — the process has one table, not one per caller. So (1) **no mark is ever left
|
||||
> standing**: a hook that failed to enable has its mark removed, or the next apply — the stop's own — would enable
|
||||
> it; (2) **only a patch that is still ours is ever marked for a restore** (`StillOurs`, as before; §H7), and
|
||||
> nothing is marked "all" — the refused draft marked everything and then un-marked what it must not restore, and
|
||||
> un-marking a hook that is already out marks it for *enabling*: the stop would have put a patch back in after the
|
||||
> stop; (3) **mark, apply and commit happen inside a gate** (`MinHookEngine::BeginQueue`, a slim lock taken
|
||||
> exclusively) so the watchdog's apply cannot execute the stop's marks nor the stop's the watchdog's. The gate is
|
||||
> held for one apply and never across a symbol lookup, which takes the loader's lock. It is the one lock in the
|
||||
> Overlay, and it is on no hook body's path: the only way from a hook to it is the stop itself, which already
|
||||
> waited for MinHook's own lock and a stop of the threads for every patch. Its owner re-enters it without
|
||||
> waiting. **The verdict on an install is the engine's, not the bytes'**: a foreign overlay patching over us a
|
||||
> moment after the apply would read as "not in", and treating that as a failure would mark a restore nobody had
|
||||
> compared. `MH_ApplyQueued` stops at the first hook that fails and says only that one did; the ones after it
|
||||
> are then enabled — or, in the stop, restored — one at a time, so one bad patch still costs one patch.
|
||||
> The write-then-read pair is unchanged: the stop clears the flag and then walks; `Commit` commits its slots and
|
||||
> then re-reads the flag, and takes out — compared first — what it put in when the flag is clear. A stop that
|
||||
> lands before the commit enables nothing.
|
||||
>
|
||||
> **Measured** on `hook-harness`'s Streamline target, the development PC, three runs before and after (`fl_guard`
|
||||
> `[advanced]` prints them): the nine Advanced-only patches went in one by one over 0.60 s / 0.70 s / 0.60 s
|
||||
> from the first log line to the ninth, 76–88 ms each; as one batch they take **81 / 90 / 78 ms**. The stop restored
|
||||
> eighteen patches in 1.37 s / 1.56 s / 1.37 s; under one apply, **77 / 90 / 76 ms** — and from the Agent's request
|
||||
> to `UNHOOKED`, 1.27–1.48 s became 94–110 ms. One stop of the threads costs what it cost for one patch, whether it
|
||||
> covers four, nine or eighteen. A new log line says so in the field: `PATCH_BATCH install` / `restore`, `a` the
|
||||
> microseconds, `b` the patches. **Not measured:** a real game — how long one stop of the threads is with a few
|
||||
> hundred of them, and whether any title minds patches arriving together (owner-only item 44). One more thing the
|
||||
> queue changes for the better: MinHook's single-target disable does not move a thread that is suspended inside
|
||||
> the patched bytes (`hook.c` passes the enable action to its thread fix-up in both directions); the queued apply
|
||||
> does. ctest `fl_unhook_inline` drives `Batch` and `RestoreAll` against real MinHook (three in under one apply,
|
||||
> a duplicate target refused without holding the others up, a foreign patch left byte for byte) and against a
|
||||
> model of MinHook's table for what real MinHook cannot be made to do on demand: an apply that fails halfway or
|
||||
> not at all, a stop inside the apply, a committed patch that is already out — the refused draft's failure — and
|
||||
> that no mark is ever standing or made outside the gate.
|
||||
|
||||
~~`FlRequestUnhook()` (or the control flag) ⇒ `MH_DisableHook(MH_ALL_HOOKS)`, restore vtable entries **only where they are still ours**, flush the ring, set status.~~ *(Corrected 2026-10-04: both reach `StopObserving` — compare-and-restore per patch as the note above says, then the status; there is no `MH_ALL_HOOKS`, no vtable entry and no ring flush. The watchdog flushes the native log on its way out.)* **The DLL is not `FreeLibrary`'d from the live process** — a thread could still be inside a trampoline. It goes dormant and unloads with the process. This is deliberate and documented.
|
||||
|
||||
@@ -691,6 +838,12 @@ before it. And when the slot has changed, going dormant costs nothing: we stay
|
||||
loaded anyway, and our detour remains in someone else's chain doing nothing
|
||||
harmful.
|
||||
|
||||
> **Said plainly, 2026-11-13: for the inline patches that re-check has never been made.** MinHook owns the write
|
||||
> window — it stops the threads, changes the protection and writes — and `StillOurs` is asked before it is called,
|
||||
> not inside. Between the two a foreign overlay could patch over us, on a thread MinHook has not stopped yet. The
|
||||
> batches of 0.1.0-beta.46 neither close that window nor widen it: the comparison and the write are apart by one
|
||||
> stop of the threads, as they were for each patch, once instead of once a patch.
|
||||
|
||||
Verified by `hook-harness --probe-unhook` (ctest `fl_unhook_preserves_foreign`),
|
||||
which simulates the foreign hooker rather than depending on RTSS being
|
||||
installed, so it is deterministic and runs on CI. Both halves are asserted: we
|
||||
@@ -702,13 +855,19 @@ compare-and-restore that never restores is not a fix.
|
||||
No logging in hook bodies. A small fixed-size in-memory ring of structured events (hook installed, symbol missing, fault, unhook) is flushed to `logs\overlay-<pid>-*.log` by the init thread at session end, on unhook, or on Agent request — never mid-frame.
|
||||
|
||||
> **Built 2026-09-06 (P1 item 4), as specified, with the details a bug report needs.** A ring of 256 ×
|
||||
> 64-byte events (`qpc`, code, two operands, a 40-char name) appended with one `fetch_add` from init and
|
||||
> ~~64-byte events (`qpc`, code, two operands, a 40-char name)~~ 96-byte events (`qpc`, code, two operands, a
|
||||
> 72-char name — 64 bytes and 40 characters until beta.42) appended with one `fetch_add` from init and
|
||||
> watchdog paths and from a hook's **SEH handler** — `NoteFault` records the exception code and the hook's
|
||||
> `__func__` — never from a hook body. Codes: `RING_CREATED`, `PRESENT_HOOKS`, `HOOK_INSTALLED` (one per
|
||||
> patch, with the target address), `SYMBOL_MISSING` (once per pair, and only when the module IS mapped),
|
||||
> `FAULT`, `STOP` (the reason), `UNHOOK_RESTORED` / `UNHOOK_DECLINED` (one per patch), `LOADER_DETOUR`,
|
||||
> `SUPERVISION_LOST`, 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
|
||||
> `SUPERVISION_LOST`, since beta.24 `STOP_FLUSHED` (the last line after a stop: `a=1` when the stop had finished
|
||||
> writing), and since beta.42 `PATCH_FAILED` (a patch that did not go in, once per target and reason — §Unhooking)
|
||||
> and `FFX_DISPATCH`, `FFX_QUERY`, `UPSCALE_ROUTE`, `RUNTIME_CENSUS` (the note at the end of this section), and
|
||||
> since beta.43 `FFX_CONFIGURE` — each configure type a hooked ffx module was handed, in a process where
|
||||
> `ffxConfigure` is hooked at all (one asked for Advanced metrics) — and since beta.46 `PATCH_BATCH`: one line an
|
||||
> apply, `install` or `restore`, `a` the microseconds it took and `b` the patches it covered (§Unhooking, Batches).
|
||||
> **Three flush points — four since beta.42, the same note —, 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
|
||||
@@ -719,15 +878,59 @@ No logging in hook bodies. A small fixed-size in-memory ring of structured event
|
||||
> 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
|
||||
> wakes the watchdog; the final flush waits for that, bounded at 2 s *(a quarter of a second for every patch the registry can hold since beta.45; the stop is one apply since beta.46 and the bound is for its fallback)*, 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
|
||||
> `UNHOOK_*` / `SYMBOL_MISSING` / `PATCH_FAILED` / `SUPERVISION_LOST` lines at the end of every session
|
||||
> (`Consume/OverlayLog.cs`).
|
||||
>
|
||||
> **The log outlives the game, and says what each ffx module was handed (0.1.0-beta.42, owner decision D121).**
|
||||
> Cyberpunk 2077, set to FSR upscaling with FSR frame generation, was recorded with frame generation measured and
|
||||
> the upscaler "unknown": PREPARE and FRAMEGENERATION dispatches arrived and no UPSCALE ever did. The log could
|
||||
> not say why. **It ended half a second into the session** — written at the end of init, then only when the Agent
|
||||
> asked or a stop ran, and a game that exits does neither: the watchdog dies with the process. And **it could not
|
||||
> have said much**: the two one-target rows logged their symbol and every other row the word `hook`, so four ffx
|
||||
> modules were one indistinguishable line each. Four changes, none of them a new patch site:
|
||||
>
|
||||
> 1. **A fourth flush point: the watchdog, on any tick that finds something new in the ring** (`FlushLogIfNew`:
|
||||
> one load on an uneventful tick, no file opened). Events are few and bounded — installs, first sights, three
|
||||
> faults at most — so this is a handful of appends a session. The init thread's flush moved to **before** the
|
||||
> watchdog is created: `FlushLog`'s state belongs to one thread at a time, and with the watchdog flushing on its
|
||||
> first tick the old order could run two at once.
|
||||
> 2. **Every install line names its module and its symbol** — `amd_fidelityfx_dx12.dll!ffxDispatch` — built at
|
||||
> compile time from the inventory row's own two spellings (`fl::inventory::NameOfRow`), so no second list of
|
||||
> names exists. The same name is on the `UNHOOK_*` and `PATCH_FAILED` lines. The event's text grew from 40 to
|
||||
> 72 characters for it (an event is 96 bytes; the ring 24 KiB, static), and `PatchTarget` lost its default
|
||||
> name, so a new call site cannot log `hook`.
|
||||
> 3. **`FFX_DISPATCH` / `FFX_QUERY`: each descriptor type a hooked ffx-api module was handed, once**
|
||||
> (`fl_ffx_types.h`). Text = the module, `b` = the type (`0x10001` UPSCALE, `0x20004` / `0x2000c` PREPARE,
|
||||
> `0x20003` FRAMEGENERATION, …); `a` ≠ 0 with `b=0` says what did not fit (`1` a ninth distinct type, `2` a
|
||||
> type of zero). The detour keeps the value of `type` — the member it reads already to choose an arm — in the
|
||||
> first free of eight slots per module and entry point; the watchdog writes it. A query's type is kept whatever
|
||||
> the vendor answered. `UPSCALE_ROUTE` names each source an UPSCALE came from, once (the FSR 3.0 host has no
|
||||
> descriptor type, so this is the only line that says its export was called), and `RUNTIME_CENSUS` repeats the
|
||||
> census word (`b`) whenever it gains a bit — both from words the detours kept before, at no cost to a hook.
|
||||
> 4. **`PATCH_FAILED`** (§Unhooking) is the fourth: a patch that did not go in used to leave no line at all.
|
||||
>
|
||||
> **This is a diagnostic, not a measurement, and it is not behind the Advanced-metrics switch** — like
|
||||
> `HOOK_INSTALLED`, it reaches the log file and nothing else: no record, no region of the shared memory, no session.
|
||||
> Rule 4: the only thing read is `type`, of a descriptor handed to a hooked call. Rule 5: no allocation, no lock,
|
||||
> no logging in the body; a type already kept costs loads and no write.
|
||||
>
|
||||
> **Measured overhead** (on `fl_ffx_types.h` itself with the Overlay's compile flags — `/O2 /GS /guard:cf
|
||||
> /Qspectre`, 50 million calls a run, three runs, i7-14700KF): a frame's three dispatch types in turn, **+3.8 ns a
|
||||
> dispatch** (3.79 / 3.87 / 3.81); a type in the first slot +0.9 to +1.0 ns; in the eighth, the worst steady
|
||||
> state, +8.1 to +8.4 ns. A new type costs one compare-exchange, once per type and module.
|
||||
>
|
||||
> ctest `fl_ffx_types` (the header, including eight threads meeting the same six types at once: each kept exactly
|
||||
> once) and `fl_guard` `[log]`: a harness on the 1.1.x monolith, generating frames and asking a ratio query, is
|
||||
> supervised and told **nothing else** — no flush request, no stop — and its log holds the two install lines by
|
||||
> module and symbol, the three dispatch types and the query type once each, the route and the census; the process
|
||||
> is then killed and the file is as it was, one header, no `STOP`.
|
||||
|
||||
> **Tests and the real logs folder (2026-09-15).** The injection tests use the shipped Overlay, so their harness
|
||||
> logs land in the user's real `logs\` too: measured that day, 2506 overlay logs, **2492 of them hook-harness's**,
|
||||
@@ -753,7 +956,7 @@ verification a dev-machine-only affair before:
|
||||
- **WARP** (`D3D_DRIVER_TYPE_WARP`) — a software rasteriser, so no adapter is required.
|
||||
- **`CreateSwapChainForComposition`** — no `HWND`, so no dependency on a window station or an interactive session.
|
||||
|
||||
Current modes: `--probe-vtable` (§H4, ctest `fl_vtable_indices`), `--probe-proxy` (§H5, ctest `fl_proxy_swapchain`), `--probe-unhook` (§H7, ctest `fl_unhook_preserves_foreign`), `--probe-cost` (NFR-1, measurement only), **`--probe-frames`** (ctest `fl_frame_identity` — what counts as a frame, against `GetLastPresentCount`), **`--probe-d3d12`** (ctest `fl_d3d12_acquisition` — device → command queue → swapchain), `--present N`, `--hold N`, **`--real`** and **`--plus-ui K``**, **`--vulkan --hold-presenting N`** (P1 item 3, real loader, exit 77 = cannot run here) and **`--opengl --hold-presenting N`** (P1 item 4, gdi32 `SwapBuffers` on a hidden window, Microsoft's generic renderer — runs on CI). *(Added 2026-10-04, each with its own ctest: `--probe-d3d12-vtable`, `--probe-dxr`, `--probe-dxr-inputs`, `--probe-upscaler-resolve`, `--probe-sl-abi`, `--probe-ffx-resolve`, `--probe-sl-inputs`, `--probe-sl-seen`, `--probe-dxgi-count`; and the `--hold-presenting-*` injection fixtures with `--load` / `--load-after-ms`.)*
|
||||
Current modes: `--probe-vtable` (§H4, ctest `fl_vtable_indices`), `--probe-proxy` (§H5, ctest `fl_proxy_swapchain`), `--probe-unhook` (§H7, ctest `fl_unhook_preserves_foreign`), `--probe-cost` (NFR-1, measurement only), **`--probe-frames`** (ctest `fl_frame_identity` — what counts as a frame, against `GetLastPresentCount`), **`--probe-d3d12`** (ctest `fl_d3d12_acquisition` — device → command queue → swapchain), `--present N`, `--hold N`, **`--real`** and **`--plus-ui K``**, **`--vulkan --hold-presenting N`** (P1 item 3, real loader, exit 77 = cannot run here) and **`--opengl --hold-presenting N`** (P1 item 4, gdi32 `SwapBuffers` on a hidden window, Microsoft's generic renderer — runs on CI). *(Added 2026-10-04, each with its own ctest: `--probe-d3d12-vtable`, `--probe-dxr`, `--probe-dxr-inputs`, `--probe-upscaler-resolve`, `--probe-sl-abi`, `--probe-ffx-resolve`, `--probe-sl-inputs`, `--probe-sl-seen`, `--probe-dxgi-count`; and the `--hold-presenting-*` injection fixtures with `--load` / `--load-after-ms`.)* *(Added 2026-11-12, Advanced metrics train B: `--probe-adv-fields`, ctest `fl_adv_fields` — `fl_adv_fields.h` alone: a struct of a lower version is not read past its end, the vendors' sentinels never leave as values, the summaries, the publication, a new request starting afresh; and `--advanced` / `--ffx-memory-query v1|v2`, which make the `--hold-presenting-upscaled` and `--hold-presenting-ffx` fixtures send what Advanced metrics reads.)*
|
||||
|
||||
> **Every present here used to carry `DXGI_PRESENT_TEST`, which submits nothing.** Measured: 500 of them leave `GetLastPresentCount` at 0 while 37 real presents move it by 37. "N presents → N records" was therefore satisfiable only by a writer counting non-frames. `--real` issues real presents; the test-present path is kept as a named mode because it is what an alt-tabbed title actually runs.
|
||||
|
||||
|
||||
+610
-2
@@ -145,7 +145,7 @@ L1 gives no temperatures on its own (unless the D3DKMT probe pans out). That is
|
||||
|
||||
`LibreHardwareMonitorLib` ≥ 0.9.6, consumed as an **unmodified NuGet package**. It already implements per-vendor GPU sensor access internally — which means the vendor-interop licensing problem is one LHM has solved upstream, under a licence that works for us. That is the entire reason this layer exists.
|
||||
|
||||
- `Computer` opened with `IsGpuEnabled` always; ~~`IsCpuEnabled` + `IsMemoryEnabled` only when the Agent is elevated and PawnIO is available~~ nothing else, ever — the CPU temperature uses a separate `Computer` (below) (corrected 2026-10-04).
|
||||
- `Computer` opened with `IsGpuEnabled` always; ~~`IsCpuEnabled` + `IsMemoryEnabled` only when the Agent is elevated and PawnIO is available~~ nothing else, ever — the CPU temperature uses a separate `Computer` (below) (corrected 2026-10-04). *(2026-11-11: still true of THIS layer's `Computer`. Advanced metrics opens a third one, of its own — the graphics card, and as administrator with PawnIO the processor, memory and motherboard groups; D103, §Advanced metrics. Storage, the power supply, controllers, the battery and the network are opened by nothing.)*
|
||||
- Poll on a dedicated thread: `computer.Accept(updateVisitor)` then read mapped sensors. Never faster than 500 ms; default 1000 ms.
|
||||
- Sensor mapping by `SensorType` + name heuristics per vendor (`GPU Core`, `GPU Hot Spot`, `GPU Memory`, `GPU Package Power`, …), kept in `SensorMap.cs` with unit tests against captured sensor-tree fixtures.
|
||||
- **P0 verification items:** (a) which fields LHM actually returns per vendor on real hardware — fill the capability matrix below — **NVIDIA filled 2026-09-03, AMD/Intel deferred (§R5/§R6)**; (b) ~~whether GPU-only usage works **without** elevation and without PawnIO (expected yes, since GPU sensors go through user-mode vendor paths, but confirm — it determines whether the default unelevated Agent has temperatures at all)~~ — **confirmed 2026-09-03, §M5 row R1**: eight fields unelevated, the same eight elevated, PawnIO never opened; (c) ~~confirm LHM's sources are not marked with MPL-2.0 Exhibit B~~ — **done, 2026-08-02: clear.** No source file applies the notice; the only repository hit is the `LICENSE` template itself, and every file we depend on carries the permissive Exhibit A. Method and evidence in `docs/spike-notes.md` §0. Re-check on every version bump, and check *source headers*, never the LICENSE file — MPL-2.0's own text contains Exhibit B as a template, so grepping the licence finds it in every MPL project ever published.
|
||||
@@ -204,6 +204,8 @@ Still resolve **entry points defensively at runtime**: `nvapi64.dll` may be abse
|
||||
> **Not in this build, stated so nobody infers it from the table below:** VRAM (`FlNvSample.vram` is
|
||||
> reserved and its bit is never set — see the Memory row), power, hotspot temperature, per-domain
|
||||
> utilisation beyond the GPU domain, and anything Reflex (§M8: a hook fact, not a poller field).
|
||||
> *(2026-11-11: still true of `FlNvSample`, the 1 Hz telemetry layer's struct. The memory figures and the other
|
||||
> three utilisation domains are read since ABI 3 — below — into structs of their own, for Advanced metrics only.)*
|
||||
>
|
||||
> **ABI 2 (2026-09-25, beta.8): the driver profile, read-only.** The owner asked whether the NVIDIA App overrides a
|
||||
> game's DLSS (frame generation, ray reconstruction, the model preset). The NVIDIA App writes those overrides into the
|
||||
@@ -222,6 +224,39 @@ Still resolve **entry points defensively at runtime**: `nvapi64.dll` may be abse
|
||||
> ctest `fl_nvapi_bridge` (argument refusals, DEGRADED before init, the global profile of the test's own executable on
|
||||
> a GPU machine) and `NvapiBridgeMirrorTests` (`FlNvDriverProfileSize`, ABI 2).
|
||||
>
|
||||
> **ABI 3 (2026-11-11, owner decision D101): what "Advanced metrics" reads.** Five reads, each a struct with its
|
||||
> size first and a `present` mask, and each call behind it a query: `FlNvReadFacts` (what is true of the card whatever
|
||||
> is running — its type, bus, PCI ids, VBIOS version, architecture, core counts, the base and boost clocks, the
|
||||
> sensor's range, `NvAPI_GPU_GetMemoryInfoEx`'s four sizes, the frame-buffer sizes, the driver's package and base
|
||||
> branch, NVAPI's interface version, the chipset), `FlNvReadLive` (the same memory call's free figure with evictions
|
||||
> and promotions, the frame-buffer, video and bus utilisation, the video clock, the P-state, the board and
|
||||
> power-supply temperatures where the card has them, the throttle word, the encoder's session count and averages),
|
||||
> `FlNvReadDisplays` (per connected display: HDR formats and luminances, variable-refresh support, the adaptive-sync
|
||||
> flags), `FlNvSessionDisplay` (the display a GDI device name names: its variable-refresh state and the colour space
|
||||
> the driver reports for one process) and `FlNvProfileSettings` (every setting of the global profile, or only what a
|
||||
> game's own profile sets — a game no profile names is answered `GLOBAL` with nothing listed, never with the PC's
|
||||
> settings). No struct of ABI 2 changed size; `FL_NV_FIELD_VRAM` stays clear.
|
||||
>
|
||||
> **No identifier has an entry point** (D104): not `NvAPI_GPU_GetBoardInfo`, `NvAPI_GPU_GetUUID`, an EDID read, or
|
||||
> `NvAPI_GPU_GetEncoderSessionsInfo`, which lists WHICH programs encode. A display is passed on by its place in the
|
||||
> driver's list; NVAPI's display id is a handle of this boot and is neither stored nor shown.
|
||||
>
|
||||
> **Read-only is now a gate** (D108): `tools/nvapi-readonly-check.ps1` holds every `NvAPI_*` call of the bridge's
|
||||
> source to `tools/nvapi-allowed-calls.txt` in both directions — forty-four names — and refuses a name that sets,
|
||||
> saves, restores, registers or controls something, or that returns an identifier, **even when the list names it**.
|
||||
> Managed: `INvapiAdvancedBridge` (a port of its own beside `INvapiBridge`; `NativeNvapiBridge` implements both, and a
|
||||
> DLL that predates ABI 3 answers `Unavailable` rather than throwing) and `NvapiAdvancedReader`, which turns the five
|
||||
> structs into the catalog's facts and readings — every `nvapi.` entry whose reach is `Agent`, and no other, held by
|
||||
> `NvapiAdvancedReaderTests` in both directions. **Nothing composes the reader yet**: no Agent code calls it.
|
||||
>
|
||||
> **Measured on the dev box the day it was written** (RTX 5080, a driver of base branch `R620`, ctest `fl_nvapi_bridge`'s
|
||||
> AVAILABLE branch — `20_OPEN_QUESTIONS` §M12): all twenty facts answer (`present = 0xFFFFF`: discrete, desktop, PCI
|
||||
> Express, 84 ray-tracing and 336 tensor cores, base 2295 / boost 2670 MHz, 16,303 MiB dedicated, a DCH Game Ready
|
||||
> driver); eight of the ten live groups answer (`0x33F`) — **the board and power-supply temperatures do not exist on
|
||||
> this card**, as the memory temperature does not, and read N/A; the one display answers all four groups; the global
|
||||
> profile lists 24 settings. One thing the header had wrong: it misspells `NV_ENCODER_STATISTICS_VER` as
|
||||
> `NNV_ENCODER_STATISTICS_VER`, so the bridge names `NV_ENCODER_STATISTICS_VER1`.
|
||||
>
|
||||
> **The ctest could not fail on a GPU machine until the same day.** `fl_nvapi_bridge` was registered with
|
||||
> `PASS_REGULAR_EXPRESSION` alone, which makes ctest ignore the exit code: the AVAILABLE branch's reference-counting
|
||||
> check (two references, two releases, then a read expected to work) failed on every machine with an NVIDIA GPU while
|
||||
@@ -234,7 +269,7 @@ Still resolve **entry points defensively at runtime**: `nvapi64.dll` may be abse
|
||||
| Temperatures | `NvAPI_GPU_GetThermalSettings` (+ extended thermal query for hotspot/memory where available). **Bridge (2026-09-10):** the public enumeration only — core is the `GPU` target; memory is the `MEMORY` target when the driver lists one, and on the RTX 5080 it does not (bit clear → `null`); hotspot is not read |
|
||||
| Utilisation | `NvAPI_GPU_GetDynamicPstatesInfoEx` (GPU / FB / VID / BUS domains). **Bridge (2026-09-10):** the GPU domain only, as `loadPct` |
|
||||
| Clocks | `NvAPI_GPU_GetAllClockFrequencies` — **bridge (2026-09-10):** current graphics and memory clocks |
|
||||
| Memory | `NvAPI_GPU_GetMemoryInfoEx` — **not `NvAPI_GPU_GetMemoryInfo`**, which this table named until 2026-08-05. The vendored headers mark it `__nvapi_deprecated_function` ("deprecated in release 520"), so under `/W4 /WX` a call to it fails the native build. **Neither is called (2026-09-10):** the vendored `nvapi.h` (`cd6918f6`) does not declare `GetMemoryInfoEx` at all — the deprecation message names a function the same header set does not ship — so the bridge's `vram` field is **reserved**, its bit is never set, and VRAM stays L1's PDH adapter counter. Taking a newer header set is the way to change that, not a call to the deprecated one |
|
||||
| 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~~ **Corrected 2026-11-11: the vendored set does declare it** — `nvapi_lite_common.h:600`, which `nvapi.h` includes, with `NV_GPU_MEMORY_INFO_EX_V1` above it and its id in `nvapi_interface.h`; the search that found nothing looked in `nvapi.h` alone. It was not called because of that sentence, from 2026-09-10 until now. The bridge calls it from ABI 3 for the advanced memory rows (§Advanced metrics); `FlNvSample.vram` stays reserved, so which layer fills the base `vram_adapter` series does not change |
|
||||
| **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) — 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.)* |
|
||||
@@ -493,3 +528,576 @@ alone could never catch.
|
||||
> (`NvapiTelemetrySource` over `FrameLedger.NvapiBridge.dll`, §L3). §M5 in particular (do LHM GPU
|
||||
> sensors work unelevated, without PawnIO?) decided whether the default unelevated
|
||||
> Agent has temperatures at all — **it does, on NVIDIA; row R1 above.**
|
||||
|
||||
## Advanced metrics (owner decisions D101–D108, 2026-11-11)
|
||||
|
||||
The owner asked for a setting, *"Thông số nâng cao"* (Advanced metrics), with a navigation item of its own, that shows
|
||||
as much as the Streamline and NVAPI headers and PawnIO make available — numbers, tables, charts — **with each value
|
||||
assigned to what it belongs to: one game session, or the PC**. Asked while planning, the owner chose: everything
|
||||
that can be reached inside a game as well, in stages, the route refused on 2026-08-09 re-examined; stored in full with
|
||||
the session; off by default, and off means nothing more is read; and the page never asks for administrator rights
|
||||
itself. This section is the design those answers gave, the decisions taken with it, and the inventory.
|
||||
|
||||
**Nothing here is built by the pull request that wrote it** except the catalog
|
||||
(`FrameLedger.Application.Advanced.AdvancedMetricCatalog`) and this section. Each later pull request of the train
|
||||
states here what it built.
|
||||
|
||||
### The decisions
|
||||
|
||||
- **D101 — the option.** `telemetry.advanced`, off by default, read by the Agent at each session's start. **Off means
|
||||
not read**: no additional call to NVAPI or LibreHardwareMonitor, nothing more stored, and the navigation item is
|
||||
hidden. A session recorded while it was off shows N/A for everything here — it is not filled in afterwards.
|
||||
- **D102 — where it is stored.** In two tables of their own (schema 0023), not in new columns of `sessions`: every
|
||||
read of a `sessions` row, the JSON export and the bug bundle carry the whole row, and a driver profile does not
|
||||
belong in a bug bundle. `machine_profiles` holds the facts of the PC, one row per distinct set, and a session points
|
||||
to the row that was true when it ran — the trend's hardware-change markers and `hardware_snapshots` are untouched.
|
||||
`session_advanced` holds one session's facts, its series' statistics and their directory. The series themselves go
|
||||
to `sensor_blobs` under names that start with `adv.`, **with NaN for a tick that has no reading**: the fixed series
|
||||
store −1 there and their readers drop every negative value, which would silently eat a −12 V rail.
|
||||
- **D103 — LibreHardwareMonitor's other groups.** CPU, memory and motherboard (its sensor chip and embedded
|
||||
controller) are opened **only when the Agent already runs as administrator and PawnIO is installed** — the existing
|
||||
admin mode (D34); the page says what is missing and links to that setting. **Refused**: the power-supply and
|
||||
fan-controller groups, which make the library search every USB HID device. **Deferred**: the battery group — and
|
||||
**storage**. The plan had storage in, temperature only and internal drives only, with one outcome written down
|
||||
before any run: *if the group cannot be opened without touching removable drives, it stays closed*. It cannot: the
|
||||
library's `StorageGroup` (0.9.6, read 2026-11-11) lists every drive through DiskInfoToolkit's `ReloadStorages` with
|
||||
no filter by bus, and subscribes to drives being plugged in afterwards. So `lhm.storage.*` is `Deferred`, a drive's
|
||||
temperature reads N/A, and `LhmGroups` — the only way this code can name a group to open — has no member for it
|
||||
(`20_OPEN_QUESTIONS` §M13). This amends §L2's "nothing else, ever" from the pull request that opened the three.
|
||||
- **D104 — identifiers are never read.** The card's board serial number and unique id, a display's EDID, and the list
|
||||
of programs that are encoding. They are named in the inventory so the page can say so; a test holds that no stored
|
||||
JSON has their keys. This is the only part of "everything" left out on purpose.
|
||||
- **D105 — the navigation item** is the last of the pane's items; Ctrl+1 to Ctrl+5 keep their pages and **Ctrl+6**
|
||||
opens it only while the option is on.
|
||||
- **D106 — the `.partial` file skips what it does not know.** A chunk of an unknown type whose checksum is right is
|
||||
passed over; until now it ended the read, so a build one release older lost everything after the first new chunk.
|
||||
- **D107 — with no game running**, the Agent reads sensors only while the page is open, through one reader shared
|
||||
with the sessions, closed again some seconds after the last use. A PC idling with FrameLedger in the tray reads
|
||||
nothing (NFR-2's "~0% idle").
|
||||
- **D108 — read-only, by a gate.** §Runtime policy's "never call a setter" becomes a build check: every `NvAPI_*`
|
||||
call in the bridge's source is compared with a committed list, in both directions, and a name that changes
|
||||
something or returns an identifier is refused whatever the list says. An entry point that both reads and writes by
|
||||
a command argument — the colour and info-frame controls — is refused like a writer: the check reads names, not
|
||||
arguments, and nothing on the list is one. *(Built with ABI 3: `tools/nvapi-readonly-check.ps1`.)*
|
||||
|
||||
### The reader (built 2026-11-11; composed by the Agent since the switch)
|
||||
|
||||
`Application.Advanced.IAdvancedHardware` is the port: `Acquire()` keeps the reader running until the handle is let
|
||||
go, `Latest` is the last tick without waiting, `ReadSessionFacts` reads one session's facts on the caller's thread.
|
||||
`Infrastructure.Telemetry.AdvancedHardwareHub` implements it — **one reader for the whole Agent, on a thread of its
|
||||
own (`fl-advanced`), running only while somebody holds it** and for a linger after, so that two sessions in a row,
|
||||
or a session ending as the page opens, do not close and reopen the sensors (D107). The Agent records several
|
||||
sessions at once, each with a poller; a reader per session would open the motherboard's sensor chip as many times.
|
||||
|
||||
What runs on that thread is `AdvancedHardwareReader`: NVAPI through `NvapiAdvancedReader`, and
|
||||
`LhmAdvancedReader` over a `Computer` of its own, opened with `LhmAdvancedReader.GroupsFor(elevated, pawnIo)` —
|
||||
`LhmGroups`, an enum that has a member for the four groups this project may open and for no other. Each sensor is a
|
||||
member of a catalog family by the device at the top of its tree and its type (`LhmAdvancedMap.FamilyOf`); its series
|
||||
is named from the library's own identifier (`/lpc/nct6798d/0/voltage/3` → `adv.lhm.board.voltage.lpc_nct6798d_0_3`)
|
||||
and labelled with the hardware's words. A sensor with no family is not read.
|
||||
|
||||
- **A source that is not there is a state** (`AdvancedSources`): no NVIDIA driver, not administrator, PawnIO
|
||||
missing. Never an exception, and never a value in its place.
|
||||
- **A device that throws twice is left alone** until the reader opens again; the others go on. The library's own
|
||||
traversal stops at the first exception, so each top-level device is refreshed in a guard of its own.
|
||||
- **NVAPI answering with no field, twice running, after it had answered**: released and initialised again, once
|
||||
(`20_OPEN_QUESTIONS` §M12).
|
||||
- **The cadence was set by a measurement, before anything composed the reader.** `FrameLedger.CaptureHost
|
||||
probe-advanced` runs this reader on the caller's own rights and prints what it read and what it cost. On the dev
|
||||
box (RTX 5080, unelevated, 2026-11-11): 35 facts and 58 readings a tick — 17 from NVAPI, 41 from the card's sensors;
|
||||
**one NVAPI live read costs 0.4 ms of processor time; one refresh of LibreHardwareMonitor's graphics-card group
|
||||
costs 14 ms (62 ms elapsed)**. Once a second that refresh alone is 1.4% of one core, above NFR-2's 1% for the
|
||||
whole Agent. So NVAPI is read every tick and **the sensor library every fifth** (0.28%), and on the ticks between a
|
||||
sensor has no reading — its last value is not repeated. The same refresh is what the L2 telemetry layer does once
|
||||
a second in every session: that cost is not this feature's, and is `20_OPEN_QUESTIONS` §M16 — measured in a real
|
||||
Agent on 2026-11-11 (1.93 % of one core off, 2.04 % on) and answered by amending NFR-2 to 2.5 % (D117).
|
||||
|
||||
### From the reader to the ledger (built 2026-11-11; fed since the switch)
|
||||
|
||||
- **The poller attaches, it does not read.** `TelemetryPoller` takes an optional `IAdvancedHardware`, holds it from
|
||||
`Start` to `Dispose`, and at each poll takes `Latest` — a read of one reference. A snapshot it has not taken yet
|
||||
rides on that poll's `TelemetrySample.Advanced`; one it has already taken is not attached again, because a
|
||||
reading is of one tick. Null — the option off — composes nothing, and a sample is what it always was.
|
||||
- **The `.partial`** carries those readings in a chunk of their own after the sensor chunk (type 9) and the
|
||||
session's context in another (type 10), so a recovered session keeps both; with the option off neither is
|
||||
written. An unknown chunk type is now skipped rather than the end of the file (D106). `06_DATA_MODEL` §The
|
||||
`.partial` file.
|
||||
- **The finalizer** (`AdvancedSessionBuilder`, both tiers) turns the samples' readings into one series each,
|
||||
aligned to `t_ms` with NaN for a tick with none, and builds the session's row: facts, sources, statistics,
|
||||
directory. Schema 0023 and the rule for NaN are `06_DATA_MODEL` §Blob encoding and §Migrations.
|
||||
|
||||
### The switch (built 2026-11-11, Advanced PR-5)
|
||||
|
||||
`telemetry.advanced` (`SettingsRegistry.TelemetryAdvanced`, Boolean, default `0`, read by the Agent) becomes
|
||||
`RecorderOptions.AdvancedMetrics` through `SettingsRecorderPolicy`, at each session's start like the other recording
|
||||
settings; exactly `1` is on. From there:
|
||||
|
||||
- **The process has one sensor library** *(2026-11-12)*. One *reader* was never the whole of it: a session's L2
|
||||
source and its CPU-temperature reader each open a LibreHardwareMonitor `Computer` of their own beside the
|
||||
Advanced reader's, and the library keeps part of its state — the driver it reads the processor through, its bus
|
||||
mutexes — per process. `Computer.Close()` lets go of that part whoever else is still reading. The first sessions
|
||||
recorded as administrator with PawnIO showed it (`20_OPEN_QUESTIONS` §M13): a processor device that faulted out
|
||||
some seconds after each session's sources closed, and one session whose reader could not open at all. Every
|
||||
`Computer` is now opened and closed through `Infrastructure.Telemetry.LhmLibrary` (`LhmComputerAdapter` is its
|
||||
user): opens and closes never run at once, and a `Computer` closed while another is in use is **parked** — left
|
||||
open, read by nobody, handed to the next user of the same groups — until the last user lets go, when all are
|
||||
closed. The reads are not serialised: the readers keep their own threads, so a sensor that hangs in one still
|
||||
holds up neither the other nor the pipe.
|
||||
- **The Agent has one reader** — `AgentServices` registers `AdvancedHardwareHub` as `IAdvancedHardware`, a tick a
|
||||
second and a linger of ten — and nothing starts it but a holder. `SessionRecorder` holds it for a session's length
|
||||
**only when the option is on**, and `AgentRecording` gives the session's `TelemetryPoller` the reader on the same
|
||||
condition. Off: not held, not asked, no chunk 9 or 10, no row (`SessionRecorderTests.WithAdvancedMetricsOff…`).
|
||||
- **A session's facts are read once, off the capture loop.** Fifteen seconds after the game's process is known — by
|
||||
then it has a window — or at the session's end if that comes first, `IAdvancedHardware.ReadSessionFacts` runs on a
|
||||
pool thread: asking the driver for a profile takes some hundred milliseconds. The finalize waits at most five
|
||||
seconds for a read still in flight and stores the session without its facts rather than hold it. A read that
|
||||
throws costs the facts, never the session.
|
||||
- **Which display is the game's** comes from Windows, not from the game: `WindowGeometryProbe.MonitorDeviceOf` — the
|
||||
monitor the process's largest visible window is on, as its GDI device name — which the reader hands to
|
||||
`FlNvSessionDisplay`. No window, or a display another adapter drives: the session's display facts are absent.
|
||||
- **The context reaches the crash file as it changes** (chunk 10), from `IAdvancedHardware.Latest` — a read of one
|
||||
reference on the capture loop's task — so a recovered session keeps its machine facts, its sources and its
|
||||
directory of series.
|
||||
- **A session recorded with the option on always stores a row**, if only one that says every source is `Unknown`:
|
||||
no row means "the option was off when this was recorded", which the page (PR-7) shows as such.
|
||||
|
||||
What elevation adds changed with this: an Agent running as administrator with PawnIO reads the processor, memory
|
||||
and motherboard groups in a session with the option on. The texts that state what the admin mode adds say so —
|
||||
Disclaimer 2.15 §5 and §5A (the owner's answer of 2026-11-11), the admin mode's disclosure (`agent-admin-dialog/2`),
|
||||
Settings, the first run, the guide and `LIMITATIONS.md` — and Privacy Policy 2.15 names what is read and stored.
|
||||
|
||||
### The page's feed (built 2026-11-11, Advanced PR-6; shown by the page since PR-7)
|
||||
|
||||
With no game running the Agent reads sensors **only while the page is open** (D107), and nothing tells the Agent
|
||||
that a page opened or closed:
|
||||
|
||||
- **`GetAdvancedMachine`** (`07_IPC` §Messages) is answered by `Application.Ipc.AdvancedMachineResponder` from
|
||||
`IAdvancedHardware.Latest` alone. The first request acquires the shared reader and each one renews a five-second
|
||||
lease; a lease after the last request the hold is let go, and the reader closes its sources ten seconds later
|
||||
unless a session holds it. A page that closes, an App that exits and a pipe that drops all look the same: no
|
||||
request. With the option off the answer is `Error AdvancedOff`, and nothing is held.
|
||||
- **`App.Services.AdvancedMachineFeed`** asks once a second while a page holds `Watch()`, and keeps the facts (asked
|
||||
for once, by their hash), **the last value of every series with the tick it was read on** — a sensor read every
|
||||
fifth tick is "1400, as of then", never shown as new — five minutes of each series for the live charts, and the
|
||||
sources' states. It stores nothing. Its states are the page's own words for why there is nothing to show: waiting
|
||||
for the first read, off, no agent (a viewer never has one), an older agent.
|
||||
|
||||
### The page (built 2026-11-11, Advanced PR-7)
|
||||
|
||||
`08_UI` §Advanced is the screen. What this document's model becomes there:
|
||||
|
||||
- **A machine fact** is under *This PC* ▸ *About this PC* while the Agent answers, and under *Session* as it was
|
||||
when that session was recorded (`machine_profiles`, one row per distinct set).
|
||||
- **A session fact** is under *Session* only.
|
||||
- **A series** is a row of *Right now* and a line of *Over time* while live — never stored then — and a row of the
|
||||
session's statistics and a line of its chart once a session stored it.
|
||||
- **An entry that is not read** is on *Sources* with its reason, in the same words as §Left out, by name.
|
||||
|
||||
`ISessionRepository.ListAdvancedAsync` lists the sessions that have a row; `SessionSeriesLoader.LoadAdvancedAsync`
|
||||
decodes their series against `t_ms`, leaving a NaN tick out and keeping a negative reading.
|
||||
|
||||
### What belongs to what
|
||||
|
||||
| Scope | What it is | Stored | Shown |
|
||||
|---|---|---|---|
|
||||
| `MachineFact` | true of the PC whatever is running: the card's firmware and architecture, the driver's package, what a display can do | `machine_profiles`, once per distinct set; a session points to its row | This PC |
|
||||
| `SessionFact` | true of one session: the game's display state, the settings the driver's profile for that game sets | `session_advanced.facts_json` | Session |
|
||||
| `Series`, during a session | a sensor of the PC sampled while the game ran | `sensor_blobs` (`adv.*`), statistics in `session_advanced.stats_json` | Session |
|
||||
| `Series`, with no session | the same sensor, read because the page is open | nowhere | This PC |
|
||||
|
||||
A third tab, **Sources**, lists every row of the inventory with its state on this PC — read, or N/A with the reason:
|
||||
not an NVIDIA card, the Agent is not administrator, PawnIO is not installed, the option was off when the session was
|
||||
recorded, the hook is not built, the route is refused, a vendor's licence. A PC without an NVIDIA card shows N/A for
|
||||
every `nvapi.` row; nothing is estimated in its place (FR-4.9).
|
||||
|
||||
### The trains
|
||||
|
||||
| Train | Release | What | Its gate |
|
||||
|---|---|---|---|
|
||||
| A | 0.1.0-beta.39 | read by the Agent only — NVAPI and LibreHardwareMonitor — storage, the page. **Nothing changes in code loaded into a game** | this section |
|
||||
| B | 0.1.0-beta.40, ~~.41, .42~~ ~~.42, .43~~ .42, .43, .44 *(three releases since D113, 2026-11-11; one was planned. Renumbered 2026-11-12, D118: 0.1.0-beta.41 is a fix release for the sensor library, not part of the train. **Four since D122, the same day**: the second step is beta.42 — no new patch site — and beta.43, the two new hooks; the third step is beta.44)* | inside the game: more fields of the Streamline and FidelityFX calls already hooked, and new hooks on functions `sl.interposer.dll` **exports** (`17_HOOK_ENGINE` §Hook inventory's ⏳ rows); shared-memory layout 5 — §Train B below | a plan of its own; overhead measured; each release after the first waits for the owner's run of the one before |
|
||||
| B, a fourth step | 0.1.0-beta.45 *(D130, 2026-11-12)* | six more of Streamline's core calls — is a feature supported, is it loaded, the game switching it, its resources allocated and freed, Streamline shut down | hooks installed only where asked for, as in the second and third steps; `slInit` is not among them (D129) |
|
||||
| C | ~~0.1.0-beta.41~~ ~~0.1.0-beta.43~~ ~~0.1.0-beta.44~~ ~~0.1.0-beta.45~~ after 0.1.0-beta.45 *(D118, D122, D130)* | Reflex latency per frame | a spike — written beside beta.45, a document only — then the owner's go or no |
|
||||
| D | ~~0.1.0-beta.42~~ ~~0.1.0-beta.44~~ ~~0.1.0-beta.45~~ ~~0.1.0-beta.46~~ after train C *(D118, D122, D130)* | the Streamline feature state behind `slGetFeatureFunction` — DLSS frame generation's, DLSS's, Reflex's | a spike, then the owner's go or no |
|
||||
|
||||
Rules 4 and 5, the hook inventory, the measured overhead and the anti-cheat guard bind B, C and D exactly as they bind
|
||||
every hook. `sl::Constants` is read without its camera position, axes and matrices: where the camera is, is where the
|
||||
player is (rule 4). NGX stays closed by its licence (`17_HOOK_ENGINE` §NGX).
|
||||
|
||||
**Train D re-examines a refusal; it does not lift it.** `handoff/history/p0-queue-1-6.md` refused, on five grounds,
|
||||
hooking `slGetFeatureFunction` and patching the function it returns. The route to try is a different one:
|
||||
`slGetFeatureFunction` is itself an export (`vendor-exports.json`), so its hook is an ordinary inventory row, and
|
||||
what it hands back could be a wrapper for a fixed list of names instead of a patch at an address learned at run time
|
||||
— which would answer grounds 1 to 4, and turn ground 5 into "measured only when injected at launch". Two things it
|
||||
raises are the owner's: replacing the pointer the game receives is a **write**, which rule 4 forbids as written; and
|
||||
a wrapper must outlive the Overlay's own unhook. If the spike cannot answer all of it, the route stays refused and
|
||||
the page says so.
|
||||
|
||||
### Train B (planned 2026-11-11, owner decisions D110–D116)
|
||||
|
||||
What the catalog marks `HookedCall` and `NewHook`. Planned the day train A shipped, the owner's decisions asked while
|
||||
planning, the design reviewed against the code before it was approved.
|
||||
|
||||
- **D111 — off means off inside the game too.** The Agent writes one word of the control block
|
||||
(`advancedRequested`, ~~0 or 1~~ 0 or that session's request, unconditionally at attach) when the session records Advanced metrics. The Overlay
|
||||
reads a new field, and installs a new hook, only while it is set; with the option off it hooks and reads exactly
|
||||
what 0.1.0-beta.39's does.
|
||||
**Built 2026-11-12 (0.1.0-beta.40, PR-3), with one thing the plan did not have:** "on" is not a 1 but a
|
||||
*request* — a value no session of that ring used before. A game outlives a session, and the Overlay's summaries
|
||||
with it; a second session of a game that kept running would have read the first one's field of view and counts.
|
||||
The watchdog starts its summaries afresh at a request it has not seen and names the request in every publication;
|
||||
the Agent reads only what answers its own (`07_IPC` §Region 5). The detours consult one process-local flag, the
|
||||
watchdog is the region's one writer, and `fl_guard` shows the off half on a target that sends everything: every
|
||||
byte of the region zero until asked, untouched after an "off", a count that starts again at the next request.
|
||||
**The Agent and the App, 2026-11-12 (PR-4).** A session that records Advanced metrics says so through
|
||||
`ICaptureObserver.WantsInGameAdvanced`; `CaptureSession` writes the word either way as the ring is attached, before
|
||||
its first guard result, and from then on carries each publication of region 5 on `CaptureProgress.InGameAdvanced`
|
||||
— one instance a publication, the same one on the ten ticks between two. `Application.Capture.InGameAdvancedSampler`
|
||||
turns a publication into what a session stores: the session facts of the thirteen `Game` entries below (nineteen since 0.1.0-beta.43, twenty-one since 0.1.0-beta.44, twenty-three since 0.1.0-beta.45), in the
|
||||
vendor's own words (a preset is its letter, a member its name), and two series —
|
||||
`adv.ffx.upscale.frame_time_delta`, the mean of one second's dispatches, and `adv.ffx.memory_usage`, a point for
|
||||
each second the game asked. The facts are one list until a field they are made of moves, so the recorder's context
|
||||
is rewritten when a range widens and not once a second; the readings ride the newest telemetry sample of the tick.
|
||||
**No schema change**: the facts go into `session_advanced.facts_json` beside the driver's, the series into
|
||||
`sensor_blobs` under their `adv.` names, the `.partial`'s chunks 9 and 10 carry both. `AdvancedSources.InGame`
|
||||
(optional; absent in every row 0.1.0-beta.39 wrote) says what became of those entries in the session: `Reading`,
|
||||
`NothingSeen` — measured inside the game, and the game made none of the calls where they can be seen — or
|
||||
`NotHooked`. The page says it in the session's sources line and, on Sources, that such an entry is read inside a
|
||||
game FrameLedger measures when the game makes the call. The aliasable part of FSR's memory is published and not
|
||||
shown: the catalog has one memory entry.
|
||||
**The second step, 2026-11-12 (0.1.0-beta.43, PR-4).** Six more entries have reach `Game`: `sl.constants.jitter`,
|
||||
`.motion_vectors`, `.depth`, `.projection`, `.resets` and `ffx.framegen.config`, from the two calls hooked only
|
||||
for Advanced metrics (`17_HOOK_ENGINE` §Hook inventory, `slSetConstants` and `ffxConfigure`). The sampler makes
|
||||
them from members region 5 already had (layout 5 as it was; schema 23 as it was): a switch is `on`, `off` or
|
||||
`on_and_off` from the two words of what was seen, the flags are AMD's own names, the rectangle is the last one
|
||||
the game gave and is left out where the capture side could not state it, the field of view is a range (D114).
|
||||
**A field of view over π is said as given (owner decision D128, 0.1.0-beta.44).** Both vendors' headers say
|
||||
radians; Cyberpunk 2077 gives Streamline 51–90, and the row read `51.0055 – 90 rad (2922.4° – 5156.6°)`. Such a
|
||||
value is now the number alone, with a second row (`cameraFOV unit`, token `not_radians`) that says what it is
|
||||
not; it is never converted, which would store this project's guess at the unit as the game's word. A
|
||||
frame-generation configure that set no flag has a `flags` row of `none`, as an upscale does.
|
||||
**A count is not part of what makes the facts new** — `sl.constants.resets` grows all session, and a context
|
||||
rewritten on each would be one a second — so `InGameAdvancedSampler.Conclude` brings it up to the last
|
||||
publication once, when the session ends. `AdvancedSources.StreamlineConstants` and `.FsrFrameGeneration`
|
||||
(`AdvancedInGameCall`; null in every row written before, and in a session not measured inside the game) say for
|
||||
each call which of three things happened: `Read`; `NeverCalled` — the capture side published the hook's family
|
||||
(`FlHookFamily.SlConstants`, `.FfxConfigure` in the writer state's mask) and no publication carried the group; or
|
||||
`NotHooked` — the family was never published, which is a game that did not load the library, a Streamline 1.x
|
||||
interposer, or a patch that was refused. The page says it in one more sentence of the session's sources line.
|
||||
**The third step, 2026-11-12 (0.1.0-beta.44).** Two more entries have reach `Game`: `sl.feature.versions` and
|
||||
`sl.feature.requirements`, from what Streamline answers `slGetFeatureVersion` and `slGetFeatureRequirements`
|
||||
(`17_HOOK_ENGINE` §Hook inventory). The sampler makes them from region 5's twelve feature slots (layout 5 and
|
||||
schema 23 as they were): rows named `<feature> · <member>`, the feature by NVIDIA's constant (`kFeatureDLSS_G`;
|
||||
`feature 4242` for an id this build has no name for), a version as `major.minor.build`, the requirement flags by
|
||||
their enumerators. A version of all zeros is the vendor's "none" and has no row — a feature with no NGX model, a
|
||||
requirement nobody stated — except `versionSL`; a count of 0 is a count. One bit of the mask covers both
|
||||
questions, so which was answered is told by the slots (`InGameAdvancedSampler.FeatureCall`), and
|
||||
`AdvancedSources.StreamlineFeatureVersion` and `.StreamlineFeatureRequirements` say for each: `Read`;
|
||||
`NeverCalled` — hooked, and the game did not ask after that, ~~**the usual case, because a game asks while it
|
||||
starts**~~ *(not the usual case: measured 2026-11-12, six of six Streamline sessions on five games read both, bar
|
||||
Cyberpunk 2077's version question)*, and the page words it as "did not ask again"; or `NotHooked`. The slots are not emptied by a new request, so a second
|
||||
session of a game that kept running stores what the first one read. `sl.init.preferences` stays unread (D112).
|
||||
**The fourth step, 2026-11-12 (0.1.0-beta.45).** Two more entries have reach `Game`, from six calls
|
||||
(`17_HOOK_ENGINE` §Hook inventory): `sl.feature.support` — `<feature> · slIsFeatureSupported`, the `sl::Result`
|
||||
by NVIDIA's enumerator (`eOk`, `eErrorFeatureNotSupported`; `result 40` for a number past the forty this build
|
||||
names, `result 255` for a code a byte could not carry), and `<feature> · slIsFeatureLoaded`, `on` or `off` — and
|
||||
`sl.feature.lifecycle` — `<feature> · slSetFeatureLoaded` (`on`, `off`, `on_and_off`: what the game asked for
|
||||
during the session, not the state it left), `· slAllocateResources` and `· slFreeResources` (a count; `≥ 15`
|
||||
where the four bits stopped), and a row `slShutdown` with the number of shutdowns. All of it is word 1 of the
|
||||
twelve feature slots and one word that was reserved (layout 5 and schema 23 as they were). A feature with nothing
|
||||
to say has no row and a fact with no row is not stored. `AdvancedSources` has one member a call
|
||||
(`StreamlineFeatureSupported`, `…Loaded`, `StreamlineSetFeatureLoaded`, `StreamlineAllocateResources`,
|
||||
`StreamlineFreeResources`, `StreamlineShutdown`), `Read` / `NeverCalled` / `NotHooked` as before and null in a
|
||||
row written before; the page says the six in one sentence. The switching and the counts are a session's — the
|
||||
capture side clears them at a new request — so, unlike the answers, a second session does not inherit them.
|
||||
`sl.init.preferences` now has reach `BeforeAttach` (D129): not a later release, never.
|
||||
**Measured 2026-11-13** (six Streamline sessions on five games; `HANDOFF` item 43): `slIsFeatureSupported` was
|
||||
read in every one — refusals among the answers, `eErrorFeatureMissing` for ImGUI, NIS and DeepDVC —
|
||||
`slIsFeatureLoaded` in three games, `slSetFeatureLoaded` in two (every feature off and on), `slFreeResources`
|
||||
and `slShutdown` once in one game each, and `slAllocateResources` in none.
|
||||
- **D113 — three releases, because a new patch site cannot be proven in CI.** A crash in a game under the user-mode
|
||||
anti-cheat exception's trial ends that exception for good (D38), and every release already means restarting the
|
||||
game. **beta.40**: more fields of calls *already* hooked — `sl::DLSSOptions` where the game chains it into
|
||||
`slEvaluateFeature`, the FSR upscale dispatch, the FSR memory query — shared-memory layout 5, the Agent and the
|
||||
page; **no new patch site**. **~~beta.41~~ beta.42**: `slSetConstants` and `ffxConfigure`. **~~beta.42~~
|
||||
beta.43**: `slGetFeatureVersion` and `slGetFeatureRequirements` — the owner's words: a release of their own, still
|
||||
hooked. Each starts when the owner says the one before passed its owner-only item.
|
||||
- **D122 — the second step is two releases** (owner decision 2026-11-12, after the owner's sessions on beta.40
|
||||
and beta.41 and a review of the draft against the code). **0.1.0-beta.42 adds no patch site**: the session's
|
||||
upscaler label (D120, `03_METRICS` §Upscaling), a patch registry that refuses what it cannot register, a native
|
||||
log that survives the game's exit and says which descriptor types each ffx module saw — because Cyberpunk 2077,
|
||||
set to FSR upscaling, was named "unknown" and nothing in the field could say why (D121) — and FSR's infinite depth
|
||||
plane (D119). **0.1.0-beta.43 is `slSetConstants` and `ffxConfigure`**, begun only when that log was read. The
|
||||
third step (`slGetFeatureVersion`, `slGetFeatureRequirements`) is beta.44, train C beta.45, train D beta.46.
|
||||
- **D118 — 0.1.0-beta.41 is a fix release, and the train's numbers move by one** (owner decision 2026-11-12). The
|
||||
owner's first evening with beta.40 showed the sensor library being closed under its other users (the paragraph on
|
||||
`LhmLibrary` below; `20_OPEN_QUESTIONS` §M13); told that the fix would take the number D113 had given the train's
|
||||
second release, the owner chose to release it at once. So: second release beta.42, third beta.43, train C
|
||||
beta.44, train D beta.45. Text written before that day says beta.41 and beta.42 for the second and third — in
|
||||
the released changelogs and the moved HANDOFF sections, which are not edited, and in the comments of `fl_shm.h`
|
||||
and `ShmLayout.cs`, which the release that fills each member rewrites (they were left so that the code loaded
|
||||
into a game stayed 0.1.0-beta.40's, line for line, in a release that fixes something else).
|
||||
- **D112 — `slInit` is not hooked in train B.** A game calls it before FrameLedger attaches, so its preferences
|
||||
would almost never be seen. If it is ever hooked: `applicationId`, `projectId` and the paths are never read.
|
||||
- **D129 — `slInit` is not hooked at all** (owner decision 2026-11-12, asked to reopen D112 and shown what was
|
||||
found). No mode of the shipped product is in the game in time: *Play ▸ Start directly* does not create the game
|
||||
suspended — it waits for the presentation runtime, runs the guard, then injects; nothing is ever patched on a
|
||||
game's thread, so a hook lands some hundred milliseconds after its module appears (`17_HOOK_ENGINE`, the loader
|
||||
lock); and a hook that exists only for Advanced metrics waits for the Agent's request, which comes after the
|
||||
attach. A hook on it would be a patch that reads nothing. `sl.init.preferences` says so in the catalog. Most of
|
||||
what it would have told is read another way: which features are loaded (`slIsFeatureLoaded`), and whether a
|
||||
newer plugin than the game's own is in use (the versions of 0.1.0-beta.44).
|
||||
- **D130 — six more core calls in one release, 0.1.0-beta.45**: `slIsFeatureSupported`, `slIsFeatureLoaded`,
|
||||
`slSetFeatureLoaded`, `slAllocateResources`, `slFreeResources`, `slShutdown`. Trains C and D come after it; train
|
||||
C's spike is written beside it, as a document.
|
||||
- **D131 — the adapter a game asks `slIsFeatureSupported` about is never read**: `sl::AdapterInfo` holds its LUID
|
||||
or a Vulkan physical device. The feature's id and the result are all that is kept, and a build check refuses the
|
||||
names of the struct's members in the code loaded into a game.
|
||||
- **D114 — the field of view is a session's range**, lowest to highest, never a series: a series would say when the
|
||||
player aimed.
|
||||
- **D115 — a tail member is read only where it is proven to be there** (`17_HOOK_ENGINE` §Which struct version
|
||||
carries which field): the table from the upstream tags, not the one header in the tree.
|
||||
- **D116 — "never the camera" is a build check**, as "never a setter" is (D108): `tools/overlay-fields-check.ps1` —
|
||||
every read of a vendor struct in one header, each allowed member named and used, the camera's names refused
|
||||
anywhere in the Overlay and the Vulkan layer, no copy of `sl::Constants` by value. *(Built 2026-11-12:
|
||||
twenty-eight members on `tools/overlay-allowed-fields.txt`; `12_BUILD` gate 14f. Fifty-six since 0.1.0-beta.44,
|
||||
with the two answers about a feature.)*
|
||||
- **What will read N/A, and says why.** Many titles set their DLSS options through `slDLSSSetOptions`, which is not
|
||||
an export (train D), so `sl.dlss.*` is filled only for a title that passes its options with the evaluate call.
|
||||
`slGetFeatureVersion` and `slGetFeatureRequirements` are calls a game makes while starting.
|
||||
- **Privacy Policy 2.19** at beta.45 (approved with that release's plan): 2.18 named two of Streamline's answers
|
||||
about a feature; whether it is supported and loaded, the game switching it, allocating and freeing its resources
|
||||
and shutting Streamline down are in neither list, so they are named — with two more things never read: what
|
||||
identifies the graphics card a game hands over with its question, and the content of a graphics resource.
|
||||
- **Privacy Policy 2.18** at beta.44 (approved with that release's plan): 2.17 named two further calls and what
|
||||
they give; Streamline's answers about a feature are in neither list, so they are named, with what of the answer
|
||||
is never read — the lists it points to.
|
||||
- **Privacy Policy 2.17** at beta.43 (approved with that release's plan): 2.16 listed DLSS's and FSR's upscaling
|
||||
parameters by name, and Streamline's per-frame constants and the frame-generation configuration are in neither
|
||||
list, so they are named — and §4 says the two calls are intercepted only once a session with the option on has
|
||||
started in the game.
|
||||
- **Privacy Policy 2.16** at beta.40, once for the three releases: with Advanced metrics on, for a game FrameLedger
|
||||
injects into, the parameters the game gives its upscaler and frame generation through the intercepted calls are
|
||||
*stored* — sizes, presets, exposure, sharpening, the jitter's, the depth's and the field of view's ranges, flags,
|
||||
versions — and never the camera's position, axes or matrices.
|
||||
|
||||
### Left out, by name
|
||||
|
||||
Present in the vendored `nvapi.h`, readable from the Agent, and not in the inventory — each is either not a
|
||||
measurement of how a game runs or exists on professional cards only: ECC status and errors, NVLINK, illumination
|
||||
(the card's lighting zones), licensable features, virtualization and GSP information, Quadro status, VR-ready data,
|
||||
the IRQ and bus slot numbers, logical GPUs and SLI state, HDCP support, scan-out configuration, the colour and
|
||||
info-frame controls. `NvAPI_DISP_GetTiming` calculates a timing from an input and reads nothing.
|
||||
`NV_GET_ADAPTIVE_SYNC_DATA`'s last-flip count and timestamp mean nothing sampled once a second.
|
||||
`NvAPI_GPU_ClientRegisterForUtilizationSampleUpdates` registers a callback, which is not a read.
|
||||
|
||||
### The inventory
|
||||
|
||||
One row per entry of `AdvancedMetricCatalog`, in its order; `AdvancedMetricCatalogTests` fails when this table and
|
||||
the catalog differ in either direction. **Reach** is where a value can be read from, or why it is not read: `Agent`
|
||||
(the Agent's own process), `AgentElevated` (the same, as administrator with PawnIO), `Game` (read inside a game
|
||||
FrameLedger measures, from the arguments of a call the Overlay hooks, while the session records Advanced metrics —
|
||||
since 0.1.0-beta.40), `HookedCall` (an argument of a call the Overlay already hooks, not read yet), `NewHook` (a hook
|
||||
that is not built — Train B; no entry carries it since 0.1.0-beta.45), `BeforeAttach` (a call the game makes once,
|
||||
before FrameLedger is inside it, so no hook could read it — D129), `Spike` (Trains C and D), `Refused`, `Deferred`, `Identifier` (D104), `PlayerState`
|
||||
(rule 4), `Licence`, `NotInHeaders`. ~~Only the first two are read by a build of Train A.~~ The first three are read
|
||||
(`AdvancedMetric.IsRead`).
|
||||
|
||||
**NVAPI, the graphics card: facts**
|
||||
|
||||
| Id | What it is | Scope | Source | Reach | Unit |
|
||||
|---|---|---|---|---|---|
|
||||
| `nvapi.gpu.type` | Integrated or discrete graphics | MachineFact | Nvapi | Agent | Text |
|
||||
| `nvapi.gpu.system_type` | Laptop or desktop, as the driver sees the PC | MachineFact | Nvapi | Agent | Text |
|
||||
| `nvapi.gpu.external` | The card is an external one | MachineFact | Nvapi | Agent | Flag |
|
||||
| `nvapi.gpu.bus_type` | The bus the card sits on | MachineFact | Nvapi | Agent | Text |
|
||||
| `nvapi.gpu.pci_ids` | PCI device, subsystem and revision ids - the model, not the unit | MachineFact | Nvapi | Agent | Text |
|
||||
| `nvapi.gpu.vbios_version` | Video BIOS version | MachineFact | Nvapi | Agent | Text |
|
||||
| `nvapi.gpu.architecture` | Chip architecture, implementation and revision | MachineFact | Nvapi | Agent | Text |
|
||||
| `nvapi.gpu.core_count` | Graphics cores | MachineFact | Nvapi | Agent | Count |
|
||||
| `nvapi.gpu.rt_cores` | Ray-tracing cores | MachineFact | Nvapi | Agent | Count |
|
||||
| `nvapi.gpu.tensor_cores` | Tensor cores | MachineFact | Nvapi | Agent | Count |
|
||||
| `nvapi.gpu.ram_bus_width` | Width of the card's memory bus | MachineFact | Nvapi | Agent | Bits |
|
||||
| `nvapi.gpu.clock_base_core` | Base core clock | MachineFact | Nvapi | Agent | Megahertz |
|
||||
| `nvapi.gpu.clock_base_memory` | Base memory clock | MachineFact | Nvapi | Agent | Megahertz |
|
||||
| `nvapi.gpu.clock_boost_core` | Boost core clock | MachineFact | Nvapi | Agent | Megahertz |
|
||||
| `nvapi.gpu.clock_boost_memory` | Boost memory clock | MachineFact | Nvapi | Agent | Megahertz |
|
||||
| `nvapi.gpu.temp_default_max` | The core sensor's default maximum temperature | MachineFact | Nvapi | Agent | Celsius |
|
||||
|
||||
**NVAPI, the card's memory**
|
||||
|
||||
| Id | What it is | Scope | Source | Reach | Unit |
|
||||
|---|---|---|---|---|---|
|
||||
| `nvapi.vram.dedicated` | Dedicated video memory on the card | MachineFact | Nvapi | Agent | Mebibytes |
|
||||
| `nvapi.vram.dedicated_available` | Dedicated video memory available for surfaces | MachineFact | Nvapi | Agent | Mebibytes |
|
||||
| `nvapi.vram.system` | System memory the driver reserved at load | MachineFact | Nvapi | Agent | Mebibytes |
|
||||
| `nvapi.vram.shared` | Shared system memory the driver may commit | MachineFact | Nvapi | Agent | Mebibytes |
|
||||
| `nvapi.vram.framebuffer_physical` | Physical frame buffer size | MachineFact | Nvapi | Agent | Mebibytes |
|
||||
| `nvapi.vram.framebuffer_virtual` | Virtual frame buffer size | MachineFact | Nvapi | Agent | Mebibytes |
|
||||
| `nvapi.vram.available` | Dedicated video memory available now, all programs | Series | Nvapi | Agent | Mebibytes |
|
||||
| `nvapi.vram.in_use` | Dedicated video memory in use now, all programs: available for surfaces less available now | Series | Nvapi | Agent | Mebibytes |
|
||||
| `nvapi.vram.evictions_size` | Memory released by evictions since the driver loaded | Series | Nvapi | Agent | Mebibytes |
|
||||
| `nvapi.vram.eviction_count` | Evictions from dedicated video memory since the driver loaded | Series | Nvapi | Agent | Count |
|
||||
| `nvapi.vram.promotions_size` | Memory moved in by promotions since the driver loaded | Series | Nvapi | Agent | Mebibytes |
|
||||
| `nvapi.vram.promotion_count` | Promotions into dedicated video memory since the driver loaded | Series | Nvapi | Agent | Count |
|
||||
|
||||
**NVAPI, the card over time**
|
||||
|
||||
| Id | What it is | Scope | Source | Reach | Unit |
|
||||
|---|---|---|---|---|---|
|
||||
| `nvapi.load.framebuffer` | Frame-buffer (memory controller) utilisation | Series | Nvapi | Agent | Percent |
|
||||
| `nvapi.load.video` | Video-engine utilisation | Series | Nvapi | Agent | Percent |
|
||||
| `nvapi.load.bus` | Bus-interface utilisation | Series | Nvapi | Agent | Percent |
|
||||
| `nvapi.clock.video` | Video clock | Series | Nvapi | Agent | Megahertz |
|
||||
| `nvapi.pstate` | The card's current performance state (P-state id) | Series | Nvapi | Agent | Count |
|
||||
| `nvapi.temp.board` | Board ambient temperature, where the card has the sensor | Series | Nvapi | Agent | Celsius |
|
||||
| `nvapi.temp.power_supply` | The card's power-supply temperature, where it has the sensor | Series | Nvapi | Agent | Celsius |
|
||||
| `nvapi.limit.ac_battery` | Held back by a switch to battery on the tick: 100 or 0 | Series | Nvapi | Agent | Percent |
|
||||
| `nvapi.limit.api` | Held back at a program's request on the tick: 100 or 0 | Series | Nvapi | Agent | Percent |
|
||||
| `nvapi.limit.insufficient_power` | Held back by a missing power connector on the tick: 100 or 0 | Series | Nvapi | Agent | Percent |
|
||||
| `nvapi.encoder.sessions` | Active hardware-encoder sessions, all programs | Series | Nvapi | Agent | Count |
|
||||
| `nvapi.encoder.fps` | Average encoding rate of the active sessions | Series | Nvapi | Agent | FramesPerSecond |
|
||||
| `nvapi.encoder.latency` | Average encoding latency | Series | Nvapi | Agent | Microseconds |
|
||||
|
||||
**NVAPI, the driver**
|
||||
|
||||
| Id | What it is | Scope | Source | Reach | Unit |
|
||||
|---|---|---|---|---|---|
|
||||
| `nvapi.driver.package` | Game Ready, Studio or an RTX enterprise branch | MachineFact | Nvapi | Agent | Text |
|
||||
| `nvapi.driver.dch` | The driver is a DCH package | MachineFact | Nvapi | Agent | Flag |
|
||||
| `nvapi.driver.base_branch` | The driver's base branch | MachineFact | Nvapi | Agent | Text |
|
||||
| `nvapi.driver.interface_version` | NVAPI's own interface version | MachineFact | Nvapi | Agent | Text |
|
||||
| `nvapi.driver.chipset` | Chipset vendor and name, as the driver reports them | MachineFact | Nvapi | Agent | Text |
|
||||
| `nvapi.driver.global_profile` | Every setting of the driver's global profile, read-only | MachineFact | Nvapi | Agent | Table |
|
||||
| `nvapi.session.driver_profile` | The settings the driver's profile for this game sets itself, read-only | SessionFact | Nvapi | Agent | Table |
|
||||
|
||||
**NVAPI, displays**
|
||||
|
||||
| Id | What it is | Scope | Source | Reach | Unit |
|
||||
|---|---|---|---|---|---|
|
||||
| `nvapi.display.hdr_formats` | HDR formats a display accepts: HDR10, HDR10+, HDR10+ Gaming, Dolby Vision, EDR | MachineFact, one per device | Nvapi | Agent | Text |
|
||||
| `nvapi.display.luminance_max` | A display's maximum luminance for HDR content | MachineFact, one per device | Nvapi | Agent | Nits |
|
||||
| `nvapi.display.luminance_min` | Its minimum luminance | MachineFact, one per device | Nvapi | Agent | Nits |
|
||||
| `nvapi.display.luminance_max_frame_average` | Its maximum frame-average light level | MachineFact, one per device | Nvapi | Agent | Nits |
|
||||
| `nvapi.display.vrr_support` | Variable refresh: supported, G-SYNC module or adaptive sync, ULMB, usable at the current mode | MachineFact, one per device | Nvapi | Agent | Text |
|
||||
| `nvapi.display.adaptive_sync_off` | Adaptive sync is switched off on the display | MachineFact, one per device | Nvapi | Agent | Flag |
|
||||
| `nvapi.display.max_frame_interval` | The longest frame interval adaptive sync is set to hold | MachineFact, one per device | Nvapi | Agent | Microseconds |
|
||||
| `nvapi.session.vrr_enabled` | Variable refresh was active on the game's display | SessionFact | Nvapi | Agent | Flag |
|
||||
| `nvapi.session.vrr_requested` | Variable refresh was requested for it | SessionFact | Nvapi | Agent | Flag |
|
||||
| `nvapi.session.vrr_possible` | Variable refresh was possible on it | SessionFact | Nvapi | Agent | Flag |
|
||||
| `nvapi.session.vrr_display_mode` | The display itself was in variable-refresh mode | SessionFact | Nvapi | Agent | Flag |
|
||||
| `nvapi.session.source_colorspace` | The colour space the game presented in, as the driver reports it for the process | SessionFact | Nvapi | Agent | Text |
|
||||
|
||||
**LibreHardwareMonitor, the graphics card (every vendor, unelevated)**
|
||||
|
||||
| Id | What it is | Scope | Source | Reach | Unit |
|
||||
|---|---|---|---|---|---|
|
||||
| `lhm.gpu.temperature` | Every temperature sensor of the card | Series, one per device | Lhm | Agent | Celsius |
|
||||
| `lhm.gpu.load` | Every load of the card: its engines, its bus, its memory controller | Series, one per device | Lhm | Agent | Percent |
|
||||
| `lhm.gpu.memory` | The card's memory counters: total, free, used, Direct3D dedicated and shared | Series, one per device | Lhm | Agent | Mebibytes |
|
||||
| `lhm.gpu.clock` | Every clock of the card | Series, one per device | Lhm | Agent | Megahertz |
|
||||
| `lhm.gpu.power` | Every power reading of the card | Series, one per device | Lhm | Agent | Watts |
|
||||
| `lhm.gpu.fan` | Every fan of the card | Series, one per device | Lhm | Agent | Rpm |
|
||||
| `lhm.gpu.fan_control` | Each fan's duty | Series, one per device | Lhm | Agent | Percent |
|
||||
| `lhm.gpu.voltage` | Every voltage of the card | Series, one per device | Lhm | Agent | Volts |
|
||||
| `lhm.gpu.current` | Every current of the card | Series, one per device | Lhm | Agent | Amperes |
|
||||
| `lhm.gpu.throughput` | PCI Express traffic to and from the card | Series, one per device | Lhm | Agent | BytesPerSecond |
|
||||
|
||||
**LibreHardwareMonitor through PawnIO (the Agent as administrator, D103)**
|
||||
|
||||
| Id | What it is | Scope | Source | Reach | Unit |
|
||||
|---|---|---|---|---|---|
|
||||
| `lhm.cpu.temperature` | Processor temperatures: the package and each core | Series, one per device | Lhm | AgentElevated | Celsius |
|
||||
| `lhm.cpu.load` | Processor load: the total and each core | Series, one per device | Lhm | AgentElevated | Percent |
|
||||
| `lhm.cpu.clock` | Each core's clock, and the bus clock | Series, one per device | Lhm | AgentElevated | Megahertz |
|
||||
| `lhm.cpu.power` | Processor power: the package, the cores | Series, one per device | Lhm | AgentElevated | Watts |
|
||||
| `lhm.cpu.voltage` | Processor voltages | Series, one per device | Lhm | AgentElevated | Volts |
|
||||
| `lhm.board.model` | The motherboard's maker and model | MachineFact | Lhm | AgentElevated | Text |
|
||||
| `lhm.board.sensor_chip` | The board's sensor chip | MachineFact | Lhm | AgentElevated | Text |
|
||||
| `lhm.board.temperature` | The board's temperature sensors | Series, one per device | Lhm | AgentElevated | Celsius |
|
||||
| `lhm.board.fan` | Each fan header's speed | Series, one per device | Lhm | AgentElevated | Rpm |
|
||||
| `lhm.board.fan_control` | Each fan header's duty | Series, one per device | Lhm | AgentElevated | Percent |
|
||||
| `lhm.board.voltage` | The board's voltage rails | Series, one per device | Lhm | AgentElevated | Volts |
|
||||
| `lhm.memory.modules` | The memory modules: size, speed, maker's part name - never a serial number | MachineFact | Lhm | AgentElevated | Table |
|
||||
| `lhm.memory.load` | Memory in use: physical and virtual | Series, one per device | Lhm | AgentElevated | Percent |
|
||||
| `lhm.memory.temperature` | Each memory module's temperature, where it has a sensor | Series, one per device | Lhm | AgentElevated | Celsius |
|
||||
|
||||
**What the Agent could reach and does not**
|
||||
|
||||
| Id | What it is | Scope | Source | Reach | Unit |
|
||||
|---|---|---|---|---|---|
|
||||
| `lhm.psu` | Power-supply sensors: reading them makes the library search every USB device | MachineFact | Lhm | Refused | Table |
|
||||
| `lhm.controller` | Fan-controller sensors: the same search of USB devices | MachineFact | Lhm | Refused | Table |
|
||||
| `lhm.battery` | Battery sensors | MachineFact | Lhm | Deferred | Table |
|
||||
| `lhm.storage.models` | The drives' model names: the library cannot list drives without touching removable ones | MachineFact | Lhm | Deferred | Table |
|
||||
| `lhm.storage.temperature` | Each drive's temperature: the same, so the storage group is not opened | Series, one per device | Lhm | Deferred | Celsius |
|
||||
| `nvapi.gpu.board_serial` | The card's board serial number | MachineFact | Nvapi | Identifier | Text |
|
||||
| `nvapi.gpu.uuid` | The card's unique id | MachineFact | Nvapi | Identifier | Text |
|
||||
| `nvapi.display.edid` | A display's EDID block, which carries its serial number | MachineFact, one per device | Nvapi | Identifier | Text |
|
||||
| `nvapi.encoder.session_processes` | Which programs are encoding | Series | Nvapi | Identifier | Table |
|
||||
| `nvapi.gpu.power` | Card power through NVAPI (LibreHardwareMonitor reads it) | Series | Nvapi | NotInHeaders | Watts |
|
||||
| `nvapi.gpu.fan_duty` | Fan duty through NVAPI (LibreHardwareMonitor reads it) | Series | Nvapi | NotInHeaders | Percent |
|
||||
| `nvapi.gpu.voltage` | Card voltage through NVAPI (LibreHardwareMonitor reads it) | Series | Nvapi | NotInHeaders | Volts |
|
||||
| `nvapi.gpu.ram_type` | The card's memory type | MachineFact | Nvapi | NotInHeaders | Text |
|
||||
|
||||
**Inside the game: calls the Overlay already hooks**
|
||||
|
||||
| Id | What it is | Scope | Source | Reach | Unit |
|
||||
|---|---|---|---|---|---|
|
||||
| `sl.dlss.output_size` | The output size the game gave DLSS | SessionFact | Streamline | Game | Text |
|
||||
| `sl.dlss.presets` | The DLSS model preset per quality mode | SessionFact | Streamline | Game | Table |
|
||||
| `sl.dlss.hdr_input` | The game told DLSS its colour buffers are HDR | SessionFact | Streamline | Game | Flag |
|
||||
| `sl.dlss.auto_exposure` | DLSS auto-exposure | SessionFact | Streamline | Game | Flag |
|
||||
| `sl.dlss.alpha_upscaling` | DLSS upscales the alpha channel | SessionFact | Streamline | Game | Flag |
|
||||
| `sl.dlss.exposure` | Pre-exposure and exposure scale given to DLSS | SessionFact | Streamline | Game | Table |
|
||||
| `ffx.upscale.sharpening` | FSR sharpening: on or off, and its strength | SessionFact | FidelityFx | Game | Table |
|
||||
| `ffx.upscale.jitter` | The largest jitter offset the game gave FSR | SessionFact | FidelityFx | Game | Table |
|
||||
| `ffx.upscale.exposure` | Pre-exposure given to FSR | SessionFact | FidelityFx | Game | Text |
|
||||
| `ffx.upscale.depth` | Near and far planes and the range of the field of view given to FSR | SessionFact | FidelityFx | Game | Table |
|
||||
| `ffx.upscale.flags` | The flags of the game's FSR dispatch | SessionFact | FidelityFx | Game | Text |
|
||||
| `ffx.upscale.frame_time_delta` | The frame time the game reported to FSR | Series | FidelityFx | Game | Milliseconds |
|
||||
| `ffx.memory_usage` | FSR's own video memory, when the game asks it | Series | FidelityFx | Game | Mebibytes |
|
||||
|
||||
**Inside the game: hooks that are not built**
|
||||
|
||||
| Id | What it is | Scope | Source | Reach | Unit |
|
||||
|---|---|---|---|---|---|
|
||||
| `sl.constants.jitter` | The jitter offsets the game gave Streamline | SessionFact | Streamline | Game | Table |
|
||||
| `sl.constants.motion_vectors` | Motion-vector scale, and whether they are 3D, dilated, jittered | SessionFact | Streamline | Game | Table |
|
||||
| `sl.constants.depth` | Near and far planes, and whether depth is inverted | SessionFact | Streamline | Game | Table |
|
||||
| `sl.constants.projection` | Field of view, aspect ratio, orthographic or not | SessionFact | Streamline | Game | Table |
|
||||
| `sl.constants.resets` | How often the game reset the upscaler's history | SessionFact | Streamline | Game | Count |
|
||||
| `ffx.framegen.config` | The game's FSR frame-generation configuration | SessionFact | FidelityFx | Game | Table |
|
||||
| `sl.feature.versions` | Each Streamline feature's version and its NGX model version | SessionFact | Streamline | Game | Table |
|
||||
| `sl.feature.requirements` | What each Streamline feature requires: operating system, driver, buffers | SessionFact | Streamline | Game | Table |
|
||||
| `sl.feature.support` | Whether Streamline says each feature is supported, and loaded | SessionFact | Streamline | Game | Table |
|
||||
| `sl.feature.lifecycle` | Each feature switched on or off, its resources allocated and freed, Streamline shut down | SessionFact | Streamline | Game | Table |
|
||||
| `sl.init.preferences` | The preferences the game started Streamline with | SessionFact | Streamline | BeforeAttach | Text |
|
||||
| `sl.constants.camera` | Camera position, axes and matrices | SessionFact | Streamline | PlayerState | Text |
|
||||
|
||||
**Inside the game: routes a spike decides**
|
||||
|
||||
| Id | What it is | Scope | Source | Reach | Unit |
|
||||
|---|---|---|---|---|---|
|
||||
| `nvapi.reflex.mode` | Reflex: low-latency mode, boost, the frame-rate limit | SessionFact | Nvapi | Spike | Text |
|
||||
| `nvapi.reflex.sleep_status` | What the driver's low-latency state is | SessionFact | Nvapi | Spike | Text |
|
||||
| `nvapi.reflex.frame_report` | Latency per frame: simulation, render submit, present, driver, OS queue, GPU render | Series, one per device | Nvapi | Spike | Microseconds |
|
||||
| `sl.dlss.optimal_settings` | The render size and sharpness DLSS recommends | SessionFact | Streamline | Spike | Text |
|
||||
| `sl.dlss.vram_estimate` | DLSS's own estimate of its video memory | Series | Streamline | Spike | Mebibytes |
|
||||
| `sl.dlssg.options` | DLSS frame generation: mode, frames to generate | SessionFact | Streamline | Spike | Text |
|
||||
| `sl.dlssg.state` | DLSS frame generation: status, the most frames it can generate | SessionFact | Streamline | Spike | Text |
|
||||
| `sl.dlssg.frames_presented` | Frames DLSS frame generation presented, by its own count | Series | Streamline | Spike | Count |
|
||||
| `sl.dlssg.vram_estimate` | DLSS frame generation's estimate of its video memory | Series | Streamline | Spike | Mebibytes |
|
||||
| `sl.dlssd.options` | Ray reconstruction's options | SessionFact | Streamline | Spike | Text |
|
||||
| `sl.nis.options` | NVIDIA Image Scaling's options | SessionFact | Streamline | Spike | Text |
|
||||
| `sl.deepdvc.options` | RTX Dynamic Vibrance's options | SessionFact | Streamline | Spike | Text |
|
||||
| `sl.reflex.state` | Reflex through Streamline: availability and its frame reports | SessionFact | Streamline | Spike | Table |
|
||||
| `sl.pcl.markers` | PC-latency markers the game sets | Series | Streamline | Spike | Count |
|
||||
|
||||
**Closed by a licence**
|
||||
|
||||
| Id | What it is | Scope | Source | Reach | Unit |
|
||||
|---|---|---|---|---|---|
|
||||
| `ngx.parameters` | NGX parameters: the quality value, the DLSS hints | SessionFact | Ngx | Licence | Table |
|
||||
| `xess.options` | XeSS's options | SessionFact | Xess | Licence | Table |
|
||||
| `sl.nvperf` | Streamline's performance counters (NSight Perf SDK licence) | Series | Streamline | Licence | Table |
|
||||
@@ -60,10 +60,30 @@ Implemented in `FrameLedger.Injector` and reached from managed code through a th
|
||||
> at once), waits `kScanRetryPauseMs` (250 ms), takes a **fresh** scan set and scans it whole. A member still unreadable
|
||||
> then refuses `kProcessUnreadable`, as before; one that has gone is not in the new set; a target that has gone leaves
|
||||
> no set, which refuses `kProcessTreeUnavailable`. **`ERROR_ACCESS_DENIED` — a protected process — is never retried**,
|
||||
> and no other answer of any source is. The sentence above stands: every failure still means REFUSE; what changed is
|
||||
> and no other answer of any source is *(one more since D123, below)*. The sentence above stands: every failure still means REFUSE; what changed is
|
||||
> how many times "still loading" is asked before it counts as one. ctest `fl_guard` `[D48]` holds both directions,
|
||||
> against fakes and against the real source (a process created suspended, a pid with no process).
|
||||
>
|
||||
> **Amended 2026-11-12 (owner decision D123): a module list that changed while it was read is read again, at most
|
||||
> three times — never a pass.** The module check lists a process's modules and then asks each one's name. A game at
|
||||
> its launch loads and unloads modules for seconds, and a module that was in the list and could not be named a
|
||||
> moment later made the whole answer "incomplete": a refusal before injection, or — 0.5 s after it, at the first
|
||||
> supervision scan — a safety unhook with no frame recorded, the game then running on unrecorded. **Five such ends
|
||||
> in one PC's Agent logs in a week** (Phantom Blade Zero three times on 2026-11-05, Crown & Coin on 11-10,
|
||||
> Cyberpunk 2077 on 11-12), and twice in this repository's own gate. Asked with that, the owner chose: read it
|
||||
> again. Such a list is now `Collected::kUnsettled`; the pass finishes — **a blocklisted module among those that
|
||||
> were read still refuses at once** — waits `kScanRetryPauseMs`, takes a fresh scan set and reads it whole, up to
|
||||
> `kMaxUnsettledRereads` (3) times: four reads and 750 ms of pauses at most. A list still unsettled on the last
|
||||
> read refuses `kModuleScanFailed` ("a module list kept changing while it was read"). **What did not change:** a
|
||||
> list too long for the guard's buffer is still `kIncomplete` and refuses at once (a second read would be as
|
||||
> long); a protected process still refuses at once; D48's re-read is still one for the whole check; every read is
|
||||
> of the whole scan set, and the read that allows is one in which every member was read whole and none held a
|
||||
> finding. A failure to read is still never a pass — what changed is how many times a list that is moving is
|
||||
> asked before it counts as unreadable. The launch poll's presentation-runtime probe treats an unsettled list as
|
||||
> "ask again" rather than deciding on half of one. ctest `fl_guard` `[D123]`: against fakes, every direction
|
||||
> above; against the real source, a process that loads and frees a module in a loop — read some 3,600 times in
|
||||
> three seconds, about one read in four is unsettled and none is anything else.
|
||||
>
|
||||
> **Launch mode (2026-09-06, P1 item 2) does not weaken this.** `FlGuardedInjectWhenReady` polls
|
||||
> the same enumeration to learn *when* the launched target has mapped a presentation runtime, and a
|
||||
> failing enumeration there means "not yet" — the poll continues. That is not a pass: the poll
|
||||
@@ -1027,7 +1047,7 @@ injected or layered**.
|
||||
If `OpenProcess` with the needed rights fails (protected process, higher integrity), do **not** escalate creatively. Report "cannot attach" and offer Tier-2. Never attempt to acquire privileges beyond running the Agent elevated at the user's explicit request.
|
||||
|
||||
> **The explicit request exists since beta.10 (owner decision D34, 2026-09-27): the admin mode.** An option off by default,
|
||||
> turned on through a versioned disclosure (`Safety_AdminMode_*`, `agent-admin-dialog/1`) that states what it adds, what it
|
||||
> turned on through a versioned disclosure (`Safety_AdminMode_*`, `agent-admin-dialog/2` *(`/1` until 2026-11-11, when Advanced metrics widened what the option adds — D101)*) that states what it adds, what it
|
||||
> does not change, how Windows asks and the risk of a per-user install; then **Windows asks at every start of the Agent**
|
||||
> (`01_ARCHITECTURE` ADR-9). What it does NOT do, each held by code rather than by this paragraph:
|
||||
>
|
||||
@@ -1214,6 +1234,20 @@ outlives a rules change, a game update and *Change executable*; §What a finding
|
||||
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.
|
||||
- **The count starts again when the user switches hooking on (owner decision D126, 0.1.0-beta.44).** Until then
|
||||
`hook_crash_count` only ever grew: Lies of P had two such ends on 2026-10-19/20 (the hand-off above), its user
|
||||
switched hooking on again, and on 2026-11-12 one more early end — the game's own crash, by the owner, after a shader
|
||||
failed to compile — switched it off at once, under a reason that says *twice*. The consent grant, the only
|
||||
statement that turns hooking on, now sets the count to 0 (`SqliteGameConsentStore`). The policy still only
|
||||
disables, a block is still never cleared, and the user-mode exception's trial (D38) keeps its own record, which
|
||||
nothing sets back.
|
||||
- **A fault while the game is closing is not seen by a hooked session (owner decision D127: written down, not
|
||||
changed in 0.1.0-beta.44).** Hogwarts Legacy faults in the driver's `_nvngx.dll` at exit — six times in Windows'
|
||||
application log since 2026-11-06, hooked or not. The one unhooked session reads `crashed`; the five hooked ones
|
||||
read `normal` with exit code 0: the witness is looked for when the session is saved, which for a hooked session
|
||||
is before Windows has written the event. Looking again later would make every session of such a game `crashed`,
|
||||
and under a user-mode exception that ends the exception for good for a fault no hook caused — so it is a decision
|
||||
of its own, not a fix to slip in beside two new hooks.
|
||||
- **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,
|
||||
|
||||
@@ -1549,6 +1549,13 @@ probe never showed a deadlock.
|
||||
> real-game leg — a title that pulls Streamline or D3D12 in lazily, hooked through the wake — which the
|
||||
> `loader detour:` report line will show as a non-zero wake count with the family present from the first
|
||||
> bucket.
|
||||
>
|
||||
> **0.1.0-beta.46 (owner decision D134): one suspension for a batch, and the rule is as it was.** The rows a
|
||||
> watchdog tick finds are enabled under one `MH_ApplyQueued` — one stop of the threads where there was one a row
|
||||
> (`17_HOOK_ENGINE` §Unhooking, Batches). Still only on the watchdog, never from the detour and never on a game's
|
||||
> thread; the gate around the queue is not held across a symbol lookup, so it is never held with the loader's lock
|
||||
> wanted. What a stop of the threads costs in a real game was read from the owner's logs of 2026-11-13: 57 to
|
||||
> 215 ms, thirteen times over for a Streamline title until this release.
|
||||
|
||||
### H11 ◐ · XeFG and FSR3-FG identity — **AMD built 2026-09-04 through the ffx-api leaves, complete 2026-09-06; Intel closed by licence; FSR 3.0 host route built 2026-09-05**
|
||||
|
||||
@@ -1860,6 +1867,11 @@ Moved verbatim, in this order.
|
||||
| M9 ✅ | **Closed 2026-08-02 by a decision.** The old file/module detection does not exist in this repository and the owner confirmed there is no copy elsewhere, so **"build a minimal static-hint detector as the measurement baseline" is now P0 item 3** (`15_ROADMAP`). It needs no guard and no injection. Until it exists, ADR-7's headline claim stays out of the README rather than being asserted unmeasured |
|
||||
| M10 ❓ | **§CPU — is the CPU temperature this build reads the right sensor, and does it read at all on the owner's machine?** `LhmCpuTemperatureReader` (2026-09-21) opens a CPU-only LibreHardwareMonitor `Computer` when the Agent is elevated AND `PawnIo.IsInstalled`, takes the package sensor (`CPU Package` / `Core (Tctl/Tdie)`) and falls back to the hottest core. It was written against LHM's sensor names and a fake `ILhmComputer`; **no elevated run with PawnIO has been taken.** | **The measurement is one session:** Agent elevated, PawnIO installed, a five-minute capture with HWiNFO or Ryzen Master open beside it. Pre-committed: `max_cpu_temp` within 3 °C of the reference's package peak → keep; a core sensor picked where a package sensor exists, or a reading tens of degrees off (a distance-to-TjMax sensor mistaken for a temperature) → fix `Pick` and re-run; nothing read at all → `cpu_temp` stays N/A and `legal/ACCURACY.md` says processor temperature is not measured. CPU **load** and memory are not in question: `TheRealCountersAnswerOnThisMachine` reads them on every gate run. |
|
||||
| M11 🅓 | **The game's VRAM budget and `budget_exceeded_pct` (FR-4.5's second half), 2026-10-03.** D43 reads the game's usage from outside (the `GPU Process Memory` counters); the budget the OS grants the process is what DXGI's `QueryVideoMemoryInfo` returns to the *calling* process (§M7), so only an in-process call — the Overlay's background thread, which today only checks for a stop — or `D3DKMTQueryStatistics`' `PROCESS_SEGMENT_GROUP` query (documented "Reserved for system use") could read it. **Deferred by decision:** neither is built; `vram_budget_exceeded_pct` stays NULL and the budget N/A, and the in-process route would change what the Disclaimer says the Overlay's thread does. Reopening it needs that decision, not a measurement. | — |
|
||||
| M12 ❓ | **Advanced metrics — which NVAPI rows answer on real hardware (D101, 2026-11-11).** `18_GPU_VENDOR_APIS` §The inventory lists sixty `nvapi.` rows whose reach is `Agent`. They are declared in the vendored headers; **none has been called on a GPU**, and CI has no driver, so it never takes that branch. Unknown per row: whether the RTX 5080 on the current driver answers or returns `NVAPI_NOT_SUPPORTED` (the memory-temperature target already does not exist on that card). | **The measurement is the bridge's probe on the owner's PC**, then the page itself (the release's owner-only item). Pre-committed: a call that does not answer → that row is N/A with NVAPI's own status as the reason, and nothing is put in its place; a call that hangs or faults twice → the row is off for the session (§Runtime policy); a value that contradicts the vendor's own tool → the row is withheld until it is explained. **Half answered the same day, by the bridge's own test on the dev box** (ctest `fl_nvapi_bridge`, AVAILABLE branch; RTX 5080): every fact answers (`present = 0xFFFFF`), eight of ten live groups answer (`0x33F` — no board and no power-supply temperature sensor on this card: N/A, by the first pre-committed outcome), the display answers its four groups, the global profile lists 24 settings; figures in `18_GPU_VENDOR_APIS` §L3. **Still open**: the same values on the page beside the vendor's own tool, and the session rows (`nvapi.session.*`), which need a game. **And one thing seen once and not explained**: in one test run of about a dozen that day, `FlNvReadLive` came back with no field at all although `FlNvReadFacts`, a moment earlier in the same process, had answered everything; nine further runs did not show it. A handle the driver invalidated is the usual cause of that shape, and nothing here re-enumerates after `FlNvInit`. Pre-committed for the reader that owns the thread: two readings in a row with no field → release and initialise the bridge again, once, and say so in the log; if that does not bring the fields back the layer is off for the session, as any layer that fails twice is. |
|
||||
| M13 ❓ | **Advanced metrics — LibreHardwareMonitor's CPU, memory, motherboard and storage groups, elevated, with PawnIO (D103, 2026-11-11).** Never opened by any build: §M10's elevated run has not been taken either, and this is a larger surface — a sensor chip on the LPC bus, the embedded controller, SPD over SMBus, SMART. Unknown: whether each group opens on the owner's board, what a refresh costs, whether opening the storage group touches removable drives (this PC once had a failing USB drive), and whether any group enables a privilege (`PrivilegeFootprintTests`). | **One elevated run with the probe verb, before the option exists.** Pre-committed: the storage group cannot be opened without touching removable drives → `lhm.storage.*` stays N/A in beta.39 and its reach reads `Deferred`; a node that throws twice → skipped for the session; the Agent above 1% of one core or 150 MB with the option on (NFR-2) → the slow groups are read less often or dropped before the release; a privilege enabled by a group → that group is not opened, and the owner is asked. **Two of the four answered 2026-11-11, before the option exists.** (1) **Storage: not opened, by the first outcome.** LibreHardwareMonitor 0.9.6's `StorageGroup` lists every drive through DiskInfoToolkit's `ReloadStorages` with no filter by bus and follows drives plugged in later — it cannot be opened without touching removable drives. `lhm.storage.*` reads `Deferred`, and `LhmGroups` has no member for it. (2) **Cost, unelevated, measured with `probe-advanced`** on the dev box: one refresh of the graphics-card group alone is 14 ms of processor time (62 ms elapsed) — 1.4% of one core at one a second, above NFR-2 — and one NVAPI read 0.4 ms. By the third outcome the sensor library is read every fifth tick (0.28%). **Still open, and the owner's**: the same probe as administrator with PawnIO — whether the processor, memory and motherboard groups open on this board, what they cost, and `PrivilegeFootprintTests`' new case on a token that holds the privileges (CI's does; the dev box's unelevated run passes by construction). **The first run was taken on 2026-11-12, by the owner, in ordinary use** (0.1.0-beta.40, the Agent as administrator with PawnIO, an i7-14700KF on a board with an IT8689E chip, an RTX 5080), and read here from a copy of the ledger and the Agent's log, not from a probe. **The groups open and read**: nine of ten sessions stored 119 processor series (a clock and a load per thread, temperatures, powers, voltages), 14 memory series and 21 motherboard series (six fans, six temperatures, nine voltages) beside the card's 41 — 195 from the sensor library in all. **No value was compared with another tool**; that is still the owner's. **Two faults, one cause** (`Infrastructure.Telemetry.LhmLibrary`): the Agent held up to three `Computer`s at once, and the library keeps the driver it reads the processor through and its bus mutexes per process — closing one `Computer` let go of them under the others. After seven sessions the Advanced reader's processor device threw `NullReferenceException` twice and was left alone (the page lost the processor until the reader reopened); once a session's start met another instance's close, the reader's `Open` threw `ObjectDisposedException`, and that session stored 17 series instead of 212. **Fixed 2026-11-12**: opens and closes are serialised and a `Computer` is parked, not closed, while another is in use. The cause is read from the log's timing and was not reproduced — it needs this elevation — so **whether the faults are gone is the owner's next sessions to show**: no `advanced: a device is left alone` and no `did not open` in the Agent's log. **First evidence, 2026-11-12, 0.1.0-beta.41, the same PC:** seven sessions between 06:38 and 07:01 with no `advanced:` line at all, each with the option on storing 212 or 213 series; on beta.40 that morning the processor device faulted out after each of six sessions (04:34–05:07) — thirteen of sixteen over the night. The reader failing to open was seen once in sixteen, so this is not yet enough to call that one gone. Still open: any value beside another tool. |
|
||||
| M16 ✅ | **The L2 telemetry layer's cost — the first number, and it is above NFR-2 (found 2026-11-11, measuring something else).** `LhmTelemetrySource` refreshes LibreHardwareMonitor's graphics-card group once a second in every recorded session. `probe-advanced` measured that refresh, through the same library and the same group, at **14 ms of processor time** on the dev box (RTX 5080, 41 mapped sensors, about twenty of them the Direct3D engine nodes the library enumerates per card) — 1.4% of one core, where NFR-2 allows the whole Agent 1% during capture and `14_TESTING` §Hook overhead's Agent figure has never been measured. This is a measurement of the call, not yet of a session: L2's own poller was not instrumented. | **Measure L2 in a session** (the Agent's processor time over a ten-minute capture, telemetry at 1000 ms and at 2000 ms). Pre-committed: at or under 1% → this row closes with the number; above → the owner chooses between a slower default for `telemetry.interval_ms`, reading the sensors the layer keeps from NVAPI on NVIDIA cards (L3 already has most, at 0.4 ms), or amending NFR-2 to what is measured. Not decided here, and nothing about L2 changes in the Advanced-metrics train. **Measured in a real Agent, 2026-11-11 (owner decision D110), and answered (D117).** `tools/agent-cost.ps1` runs the shipped `FrameLedger.Agent.exe --console capture` against a copy of hook-harness in a scratch data folder — a session that is not hooked, so the telemetry poller runs as in every session and nothing drains frames — and reads the Agent process's own processor time at exit; the cost per second is the slope between a 45 s and a 165 s session, two runs of each. Dev box (RTX 5080, not elevated, layers `l1+lhm+nvapi`): **19.3 ms of processor time per second of session = 1.93 % of one core with Advanced metrics off** (2,312 and 2,312 ms over 45 s; 4,594 and 4,656 ms over 165 s), **20.4 ms = 2.04 % with it on** (2,984 and 3,000; 5,547 and 5,344); peak working set 113 MiB and 119 MiB. A first pass with 30 s and 90 s sessions gave 1.56 % and 2.21 % — its two short runs differed by 670 ms, which is why the lengths were raised. So the probe's number holds in a session: the Agent's steady cost is about twice NFR-2's 1 %, nearly all of it the layer every session has always used, and the new option adds about a tenth of a percent. **The owner's answer: NFR-2 is amended to ≤ 2.5 % of one core** — the limit had never been measured, the sensors keep their one reading a second, and nothing in the code changes. Not measured: a hooked session (the drain's cost on top), a session with the Agent elevated and PawnIO's groups open, another PC. |
|
||||
| M14 ❓ | **Reflex latency per frame — is there a route within rules 4 and 5? (Train C, 2026-11-11.)** `17_HOOK_ENGINE` §Memory / latency names hooks on `NvAPI_D3D_SetSleepMode` / `SetLatencyMarker` and a call to `NvAPI_D3D_GetLatency`. NVAPI resolves all three through `nvapi_QueryInterface` by id — they are not exports, so a hook on them is a patch at an address learned at run time, the class refused on 2026-08-09. The route to try first needs no hook: the Overlay's own background thread **calls** `GetLatency` with the device of the swap chain it already hooks, once a second (the call returns the last 64 frames' reports). Unknown: whether calling into the driver from that thread is safe on every device kind, what it costs, what it returns when the game never enabled Reflex, and what it means for the Disclaimer's sentence about that thread. | **A spike on `hook-harness` and a stub first, then one real title.** Pre-committed: no route without a patch at a run-time address or a loader-lock call on the game's thread → Reflex stays N/A and the page says why; overhead above NFR-1 → the same. The owner says go or no on the spike's result. **2026-11-12 — the reading that comes before that spike is `spike-notes` §30** (owner decision D130: a document first, beside 0.1.0-beta.45; nothing was run). It finds: a hook on NVAPI's latency functions is the refused class, and a hook on Streamline's Reflex and PCL functions is train D's wrapper (§M15) — and would miss a game that fetched them before the attach, as `slInit` is missed (D129); the Overlay calling `slReflexGetState` itself breaks the thread contract the vendor's header states; **what remains is the route named in this row**, the Overlay calling two driver getters with the game's device, and a no-injection ETW route that gives the game-side markers only and makes the game post messages to its own window. Corrected there: `nvapi64.dll` exports **two** functions on the dev box (`nvapi_Direct_GetMethod` beside `nvapi_QueryInterface`), not one. The go or no is the owner's, and a go needs the owner's ruling that calling a driver getter with the game's device is inside rule 4. **2026-11-13 — the owner answered (D132, D133).** Route D goes to the spike this row names, on `hook-harness` and a stub `nvapi64.dll`, with the ruling: a driver's read-only getter called with the device of the swap chain the Overlay hooks is inside rule 4 (`CLAUDE.md`, the rule's note of that day). No real game before the owner has seen the result, and nothing shipped changes for the spike (`spike-notes` §31, written after 0.1.0-beta.46). Route C is **refused**; the ETW route **stays closed**, and §G is not reopened. |
|
||||
| M15 ❓ | **The Streamline state behind `slGetFeatureFunction` — re-examined, not reopened (Train D, 2026-11-11).** The owner asked for the refusal in `handoff/history/p0-queue-1-6.md` to be looked at again. `18_GPU_VENDOR_APIS` §The trains states the route to try (hook the export, hand back a wrapper for a fixed list of names) and what it raises: the wrapper is a write to what the game receives, which rule 4 forbids as written; a wrapper must outlive the Overlay's unhook; a game that fetched its functions before the hook existed is never seen. | **A written design against each of the five grounds, then a spike.** Pre-committed: any ground unanswered → the route stays refused, and `sl.dlssg.*`, `sl.reflex.*` and the rest of that block read N/A with "refused" as the reason. Proceeding needs the owner's amendment of rule 4, asked with the rule quoted. |
|
||||
| M10 ✅ | ~~PDH `\GPU Engine(*)\Utilization Percentage` summed across engines does not reproduce the Task Manager figure the doc invokes. Decide what we actually report and label it accordingly~~ **Decided 2026-09-09 (PR-E1): L1 does not read the engine counters at all.** `LoadPct` is L2's vendor-reported `GPU Core` load (measured ✓ on NVIDIA, §M5 row R1) and is labelled *GPU load (vendor)* wherever it is shown; on a machine without L2 the field is N/A, never a sum that is not the number the user expects. What L1 does read from PDH is one counter, `\GPU Adapter Memory(luid_…_phys_0)\Dedicated Usage`, bound by LUID — the figure Task Manager labels "Dedicated GPU memory", measured 1301 MB at an idle desktop on the RTX 5080. Reopening this needs a measurement of `max(engine)` against Task Manager's own number, not a decision |
|
||||
|
||||
#### §M5 — the decision table, pre-committed 2026-09-03 BEFORE the first run
|
||||
@@ -1916,7 +1928,8 @@ Each of these is referenced by an existing doc but specified nowhere.
|
||||
| ~~**Accessibility / DPI**~~ | ~~NFR-9 states requirements; no design anywhere~~ **Answered 2026-09-15 (P4 PR-8): `08_UI` §Accessibility** — what each clause of NFR-9 means here and the check that holds it; this row was not struck then. Since 2026-11-09 (beta.35, D88) the users' half is `ACCESSIBILITY.md`, and NFR-9 names screen readers and contrast themes too. **Row closed** | NFR-9, `08_UI` |
|
||||
| **Uninstall / data deletion** | One Velopack clause. No in-app "delete all my data", despite the privacy position | `12_BUILD`, `legal/PRIVACY_POLICY.md` |
|
||||
| ~~**Cover art**~~ | ~~Appears in the schema, the data directory and the UI; nothing says where it comes from or the licence position on downloaded store art~~ **Answered 2026-10-14 (beta.23, owner decisions D60/D61):** from the user's own image (a copy in `covers\`) or what the Steam and GOG GALAXY apps already keep on this PC — nothing is downloaded, so no store art is redistributed or fetched; the art stays its owners' (`legal/TRADEMARKS.md`), the Privacy Policy 2.11 names the files read. `08_UI` §Games › Game detail. **Row closed** | `06_DATA_MODEL`, `05_DETECTION` |
|
||||
| **The main line's .NET** *(added 2026-10-31, D73–D76)* | **When does the main line — the betas and the first release — leave .NET 10 LTS, and for what?** The alpha line (`12_BUILD` §The alpha line) builds the same source on .NET 11 to gather the evidence; it decides nothing by existing. What is known: .NET 11 is STS, supported 24 months to about 2028-11, no later than .NET 10 LTS (2028-11-14), so moving buys no support time; Microsoft's supported-OS list for .NET 11 has Windows 10 only in its LTSC and IoT editions, against NFR-8's Windows 10 22H2 floor; C# 15's unions and closed hierarchies would suit the tri-states and refusal reasons, but only once the main line compiles C# 15. **Decision table, written before the evidence:** move to .NET 11 only if (a) at least two alphas on the GA runtime pass the gate and an owner's run of a hooked title with no runtime-specific defect, (b) the owner accepts dropping NFR-8's floor to Windows 11 or ships knowingly unsupported on Windows 10, and (c) something .NET 11 brings is wanted — a measured gain or a language feature; otherwise stay on .NET 10 and take .NET 12 LTS (expected 2027-11) the same way, through the alpha line first | `12_BUILD`, `13_CI_CD`, `02_SPEC` NFR-8, CLAUDE.md pinned stack |
|
||||
| ~~**The main line's .NET**~~ *(added 2026-10-31, D73–D76; decided 2026-11-11)* | **When does the main line — the betas and the first release — leave .NET 10 LTS, and for what?** The alpha line (`12_BUILD` §The alpha line) builds the same source on .NET 11 to gather the evidence; it decides nothing by existing. What is known: .NET 11 is STS, supported 24 months to about 2028-11, no later than .NET 10 LTS (2028-11-14), so moving buys no support time; Microsoft's supported-OS list for .NET 11 has Windows 10 only in its LTSC and IoT editions, against NFR-8's Windows 10 22H2 floor; C# 15's unions and closed hierarchies would suit the tri-states and refusal reasons, but only once the main line compiles C# 15. **Decision table, written before the evidence:** move to .NET 11 only if (a) at least two alphas on the GA runtime pass the gate and an owner's run of a hooked title with no runtime-specific defect, (b) the owner accepts dropping NFR-8's floor to Windows 11 or ships knowingly unsupported on Windows 10, and (c) something .NET 11 brings is wanted — a measured gain or a language feature; otherwise stay on .NET 10 and take .NET 12 LTS (expected 2027-11) the same way, through the alpha line first. **Decided 2026-11-11 (owner decisions D94–D96), the day after .NET 11 shipped: the main line moves with 0.1.0-beta.37.** Of the table: (a) was **set aside by the owner, not met** — no alpha had run on the released runtime; alpha.1 to alpha.3 ran on Release Candidate 3 with the gate green each time, and no owner's run of a hooked title on an alpha is recorded in this repository; (b) Windows 10 22H2 is not blocked and is stated as untested and unsupported (D95, NFR-8 amended); (c) C# 15 is used from the same release (D96). What stood in for (a): the whole gate on SDK 11.0.100 (`spike-notes` §28) and owner-only item 34. .NET 12 is taken the way this row described — through the alpha line first — and whether the main line follows is asked again then. **Row closed** | `12_BUILD`, `13_CI_CD`, `02_SPEC` NFR-8, CLAUDE.md pinned stack |
|
||||
| **C# 15 on the main line** *(added 2026-11-11, beta.37, D96)* | **When can the main line use C# 15's constructs?** It compiles them since beta.37 and uses none: ReSharper's engine — InspectCode 2026.2.3.1, which Qodana 2026.2 runs, and 2026.3.0 — parses neither `closed` nor `union` and calls collection expression arguments and labeled jumps preview features, so each file that used one would be an error on Qodana's gate of zero; a union also draws CA1815 from the SDK's own rules; and what CodeQL (documented up to C# 14) extracts of them is not established, a pull request's analysis being an overlay. **Answered by:** the canary of `spike-notes` §29 run again on the engine the Qodana linter then carries, and a `workflow_dispatch` of `codeql.yml` on its branch. The survey of where each construct would go is in that note | `13_CI_CD` §C# 15 and the analyses, CLAUDE.md pinned stack |
|
||||
| **Xbox app / Microsoft Store titles** *(added 2026-11-03, beta.33, D77–D82)* | GDK titles are imported, played and measured since beta.33 (`spike-notes` §25: full trust, the user's token, the session's object namespace, the image path the `Content` folder's); what is NOT answered: **(1) title lists know Steam ids only (D81).** `blockedStoreIds` has no `store` value for a Microsoft Store product id or a package family name, and the guard has no reader for one, so an Xbox copy of a game listed there by its Steam id is matched by its executables, modules, files, drivers and services but not by that entry. Keying one would take a schema value (`additionalProperties: false` there is a safety control) and a reader under D31's rule — listed refuses, none is not applicable, unreadable refuses — fed by `MicrosoftGame.config`'s `StoreId`, which the import already reads. The owner chose not to, for now. **(2) A Vulkan GDK title is not measured:** the layer is enabled by `FRAMELEDGER_ENABLE_VK_LAYER=1`, which only a launch FrameLedger makes can set, and a package is started by Windows. **(3) A package that keeps write virtualization on** (all 11 measured turn it off) would put the Overlay's log in its `LocalCache`, out of the bug report's reach; capture itself never reads the log. **(4) Unmeasured:** a start from inside the Xbox app (GameLaunchHelper's parent there — the scan set's next process), any GDK title with anti-cheat, the ring from a packaged process (the owner's first hooked session) | `02_SPEC` §Out of scope, `05_DETECTION`, `19_SAFETY` check 3, `LIMITATIONS.md` |
|
||||
| **Tier-2 mechanism** *(was: PresentMon distribution)* | **By what mechanism does a shipped build reach a no-injection MEASUREMENT?** Nothing names one. Since 2026-08-28 the ladder is two rungs and Tier 2 is explicitly not a measurement — duration, sensors and the reason — so this row is no longer about degraded fidelity but about whether that capability returns at all. **It now owns TWO casualties, not one:** the frame-generation oracle §S31 spent four attempts looking for, and `14_TESTING`'s Tier-1 accuracy cross-check, struck the same day because it required a second instrument measuring the same frames. **One mechanism would restore both**, which is the strongest argument for costing it. Constraints on any answer: `README`'s capture-tier table and its **safety** row *"always a way out"*, `legal/DISCLAIMER.md` §73 and `legal/EULA.md` §33; ETW needs elevation whatever the tool; and `15_ROADMAP` has no v2 fallback either | `README`, `legal/DISCLAIMER.md`, `legal/EULA.md`, `04_CAPTURE`, `14_TESTING`, `15_ROADMAP` |
|
||||
|
||||
|
||||
+445
-77
@@ -73,104 +73,199 @@ owner-only items stay below; the history of every train, the passed owner-only i
|
||||
| `§beta.31` | [`handoff/history/0.1.0-beta.31.md`](handoff/history/0.1.0-beta.31.md) |
|
||||
| `§beta.32` | [`handoff/history/0.1.0-beta.32.md`](handoff/history/0.1.0-beta.32.md) |
|
||||
| `§beta.33` | [`handoff/history/0.1.0-beta.33.md`](handoff/history/0.1.0-beta.33.md) |
|
||||
| `§beta.34` | [`handoff/history/0.1.0-beta.34.md`](handoff/history/0.1.0-beta.34.md) |
|
||||
| `§beta.35` | [`handoff/history/0.1.0-beta.35.md`](handoff/history/0.1.0-beta.35.md) |
|
||||
| `§beta.36` | [`handoff/history/0.1.0-beta.36.md`](handoff/history/0.1.0-beta.36.md) |
|
||||
| `§beta.37` | [`handoff/history/0.1.0-beta.37.md`](handoff/history/0.1.0-beta.37.md) |
|
||||
| `§beta.38`, `§NEXT` (the owner's request of 2026-11-11, the four trains) | [`handoff/history/0.1.0-beta.38.md`](handoff/history/0.1.0-beta.38.md) |
|
||||
| `§beta.39`, train B's plan as approved (its `§NEXT`) | [`handoff/history/0.1.0-beta.39.md`](handoff/history/0.1.0-beta.39.md) |
|
||||
| `§beta.40`, what the owner's first sessions with it showed, train B's traps | [`handoff/history/0.1.0-beta.40.md`](handoff/history/0.1.0-beta.40.md) |
|
||||
| `§beta.41`, what the owner's sessions on beta.40 and beta.41 showed, the plan of 2026-11-12 (D119–D122) | [`handoff/history/0.1.0-beta.41.md`](handoff/history/0.1.0-beta.41.md) |
|
||||
| `§beta.42`, what the owner's seven sessions on beta.42 showed (D121 answered, the guard's lost launches), beta.43's design as planned | [`handoff/history/0.1.0-beta.42.md`](handoff/history/0.1.0-beta.42.md) |
|
||||
| `§beta.43`, what the owner's nine sessions on beta.43 showed, session by session (item 41), the traps of that train | [`handoff/history/0.1.0-beta.43.md`](handoff/history/0.1.0-beta.43.md) |
|
||||
| `§beta.44`, what the owner's eight sessions on beta.44 showed, session by session (item 42), this release's facts, the traps of that train | [`handoff/history/0.1.0-beta.44.md`](handoff/history/0.1.0-beta.44.md) |
|
||||
| `§Owner-only`, an open item | [§Owner-only](#owner-only--no-pr-can-close-these) below |
|
||||
| `§Owner-only`, a passed item (3, 12, 14–19) | [`handoff/owner-only-passed.md`](handoff/owner-only-passed.md) |
|
||||
| `§Owner-only`, a passed item (3, 12, 14–19, 38, 39) | [`handoff/owner-only-passed.md`](handoff/owner-only-passed.md) |
|
||||
| `§Traps`, `§Two corrections carried forward` | [`handoff/traps.md`](handoff/traps.md) |
|
||||
| `Dnn` | [§Decisions index](#decisions-index) below |
|
||||
|
||||
---
|
||||
|
||||
## **START HERE** — 2026-11-06, 0.1.0-beta.34: DLSS 5 and DLSS 4.5 from what the game and the driver did; filters; Games at once
|
||||
## **START HERE** — 2026-11-12, 0.1.0-beta.45: six more of Streamline's calls, hooked only where asked; `slInit` stays out; the Reflex spike as a document
|
||||
|
||||
*Status is `docs/changelog/0.1.0-beta.34.md`; this is what no other file carries.* The owner asked for seven things, the
|
||||
usual train: (1) how DLSS 5 Neural Rendering is detected on Hogwarts Legacy (Neural Rendering on in the game), and its
|
||||
version; (2) under the NVIDIA App's *Dynamic* multi frame generation the label read DLSS 4, though Dynamic and ×6 exist
|
||||
only in DLSS 4.5 (Phantom Blade Zero); (3) filters on Games and Compare; (4) the Compare page's layout, from a
|
||||
screenshot; (5) the documents and the tested-games list, from the database; (6) switching to Games stalled 0.5–1.5 s;
|
||||
(7) a language change landed on the last content page instead of Settings. And while planning: "Bạn check Streamline các
|
||||
bản gần đây có gì thay đổi và sửa luôn nếu thật sự cần nhé." — check what changed in recent Streamline versions and fix it
|
||||
if really needed. #356 (two fixes from a self-review of #351 and #352), #357 (D83), #358 (D84, Streamline `v2.14.16`),
|
||||
#359 (items 6 and 7), #360 (items 3 and 4, D85, D86), #361 (item 5) and this release; `0.1.0-alpha.3` follows (D87) —
|
||||
the owner's screenshot is of an alpha, so the alpha is how these reach the owner's PC.
|
||||
*Status is `docs/changelog/0.1.0-beta.45.md`; this is what no other file carries.* The owner ran eight sessions on
|
||||
beta.44 the evening it was released and said: add the three new ones, update, go on. They were read from a copy of
|
||||
the ledger and the logs (#426); asked to reopen D112, the owner was shown why `slInit` cannot be seen and chose to
|
||||
leave it out (D129), chose six other calls for one release (D130), and approved the plan with Privacy Policy 2.19's
|
||||
wording. Four pull requests and this one: #427 (`slIsFeatureSupported`, `slIsFeatureLoaded`, `slSetFeatureLoaded`
|
||||
in the Overlay; D129–D131), #428 (`slAllocateResources`, `slFreeResources`, `slShutdown`), #429 (the Agent, the
|
||||
App, Privacy Policy 2.19), #430 (train C's spike, a document: `spike-notes` §30). **What the eight sessions on
|
||||
beta.44 showed, session by session, is [`handoff/history/0.1.0-beta.44.md`](handoff/history/0.1.0-beta.44.md)**;
|
||||
what each pull request built is [`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Hook inventory (the two rows of the six
|
||||
calls, with their measured cost) and [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Train B (the fourth step).
|
||||
|
||||
**Decisions (asked while planning, do not re-ask):**
|
||||
### What this release decided, beyond D129–D131
|
||||
|
||||
- **D83 — Dynamic frame generation is DLSS 4.5's**: the owner's rule, "Dynamic and ×6 exist only in DLSS 4.5". The
|
||||
evidence is the game's driver profile setting Dynamic (`NGX_DLSSG_MODE` = 4) **and** the driver reporting its
|
||||
frame-generation override applied in the game's process (`FG_MODE` in its FG word), in a session where DLSS
|
||||
Frame Generation was identified (`fg_mode = dlssg`; its factor need not have been counted); a state measured at ×5 or more still ranks first, and a *Fixed* multiplier names nothing by itself
|
||||
(amends D64). The driver's `frameGenerationMode` — 3 under Dynamic and 1 under Fixed in every session read, and unnamed
|
||||
by NVIDIA — is recorded in `spike-notes` §26, not keyed on.
|
||||
- **D84 — DLSS 5 is the session's generation where its neural rendering was measured running**: the Overlay decodes
|
||||
`kFeatureDLSS_NR` in its `slEvaluateFeature` detour and the Agent keeps its share of the Streamline batches
|
||||
(`sessions.dlss_nr_pct`, schema 0022) — *DLSS 5 (neural rendering on N % of rendered frames)*; loaded and seen not
|
||||
running, *runtime loaded, not seen running*; where nothing could tell, *runtime loaded*, as before (amends D64).
|
||||
- **D85 — the filters**: Games — store, engine, state, installed, played; Compare — game, tier, frame generation, no
|
||||
period; Compare lists every session (it listed the newest 200).
|
||||
- **D86 — the left pane's selected item keeps its label**: our copy of WPF UI 4.3.0's LeftFluent item template, whose
|
||||
`IsActive` trigger animated it away.
|
||||
- **D87 — alpha.3 right after beta.34**, on RC3: the train reaches it before .NET 11's release on 2026-11-10.
|
||||
- **Everything the six calls give is word 1 of a feature's slot, and one reserved word.** Bits 2–4 the two answers
|
||||
(supported, with the `sl::Result` in bits 8..15; loaded and its value), bits 5–6 the game switching the feature
|
||||
off and on, bits 16..19 and 20..23 two counts that stop at fifteen and never carry; `slShutdowns` took the first
|
||||
of three reserved words (@308). Layout 5 and schema 23 as they were. **The answers are the process's and a new
|
||||
request keeps them; the switching, the counts and the shutdowns are a session's and a new request clears them.**
|
||||
- **A refusal is the answer.** `slIsFeatureSupported`'s detour calls the original first and keeps whatever it
|
||||
returned; the page names it by NVIDIA's enumerator (forty codes, the same order at sixteen upstream tags from
|
||||
v2.0.0 to v2.14.16), `result <n>` past the list, 255 for a code a byte could not carry.
|
||||
- **The two calls on a game's way out note the call, then call the original, and run nothing after it** —
|
||||
`slFreeResources` and `slShutdown`. The fixture shuts Streamline down and goes on using the stub through every
|
||||
detour.
|
||||
- **The adapter is never read** (D131), and the build refuses the names of `sl::AdapterInfo`'s members in the code
|
||||
loaded into a game (`overlay-fields-check`); the fixture hands a wild LUID pointer.
|
||||
- **A stop restores its patches one after another, about 160 ms each.** MinHook stops every thread of the process
|
||||
for each `MH_DisableHook`. With six more patches the stop's last log lines were cut at the two seconds the
|
||||
Overlay waited for them; the wait is now sized to the patch table (`250 ms × kMaxPatches`). The patches were
|
||||
always restored; `UNHOOKED` is written after the last. **Not changed, and proposed**: queueing the restores (and
|
||||
the installs) so the threads are stopped once — a change to the hook engine's order of operations, which wants
|
||||
its own pull request, its own measurement and the owner's word. Until then a stop in a Streamline game with
|
||||
Advanced metrics on takes two to three seconds on the thread that stops.
|
||||
- **Six calls are one sentence on the page**, each by its function's name under which of three things became of
|
||||
it; a row stored before this release has none of the six and no such sentence.
|
||||
- **`AdvancedReach.BeforeAttach` is a reason of its own** for `sl.init.preferences`: not "a later release". No
|
||||
catalog entry carries `NewHook` any more; the value stays, for rows a later train may add.
|
||||
- **Where the rows sit in the table** (rows are patched in its order): the two questions after beta.44's two, at
|
||||
the head; `slSetFeatureLoaded` after `slSetConstants`; the three counted calls last of the Streamline block.
|
||||
- **Train C's spike is a reading** (`spike-notes` §30): hooking NVAPI's or Streamline's latency functions is
|
||||
refused or is train D's wrapper; the Overlay calling `slReflexGetState` breaks the vendor's thread contract;
|
||||
what remains is the Overlay calling two driver getters with the game's device, and a no-injection ETW route
|
||||
that gives half the number. It ends in three questions that are the owner's.
|
||||
|
||||
Streamline was re-vendored at `v2.14.16` on the owner's instruction above, not as a decision of its own. The wording of
|
||||
the Disclaimer 2.13 and the Privacy Policy 2.14, and the tested-games list (D35), were approved with the plan (D36).
|
||||
### Traps this train left
|
||||
|
||||
**Choices made here:**
|
||||
- **The catalog table of `18_GPU_VENDOR_APIS` is compared with the catalog row for row by a test**: a catalog
|
||||
entry and its row go in the same commit, or the Application tests are red.
|
||||
- **Qodana's native report again found an index into the feature slots computed as a 32-bit product** (#427, the
|
||||
harness's probe): write `size_t{2} * FL_ADV_FEATURE_WORDS`. It is advisory and auto-merge does not wait for it;
|
||||
both reports were read before each merge.
|
||||
- **A second `region` inside the probe's block is C4456**, and warnings are errors: name the inner one otherwise.
|
||||
- **A test method over sixty lines is MA0051** in the test projects too; split the assertions by what they cover.
|
||||
- **The injected test waits for the stop**: with eighteen patches a stop takes about three seconds, so its wait is
|
||||
200 iterations.
|
||||
- **The shell tool refuses `sleep N; command`**: wait in a background `until` loop.
|
||||
- **After a lower pull request is squashed**, `git diff <old tip> origin/main` empty proves the squash is the
|
||||
branch; then `git rebase --onto origin/main <old tip> <next branch>` and a forced push with lease.
|
||||
|
||||
- **Neural rendering's share is over the Streamline batches**, not every present: a generated frame evaluates nothing,
|
||||
and a title that never drains a batch reads *nothing could tell* (null), never 0 %.
|
||||
- **A writer older than beta.34 is told apart by its family bit**, `FL_HOOK_SL_NEURAL_RENDERING` (bit 12), published with
|
||||
the detour — an old Overlay's silence leaves `dlss_nr_pct` null instead of a measured 0 %; no layout change.
|
||||
- **The Games page is the window's**, kept by our own page provider (`WindowPageCache`), not `NavigationCacheMode`: WPF UI
|
||||
4.3.0 reads that only when neither a service provider nor a page provider is set, and `SetNavigationControl` sets one
|
||||
(`16_WPFUI_SYNTAX` §Navigation). One per window, so a language change's window builds its own.
|
||||
- **The cards come before the executable checks** — 39 of the owner's 41 Steam games are on a USB drive that sleeps — and
|
||||
each card gets its *Not installed* pill when its check answers.
|
||||
- **The pane's item template is a copy changed in one place**, reading WPF UI's own `NavigationViewConstants.xaml`: before
|
||||
the WPF UI pin moves, the upstream template is read again.
|
||||
### What the owner's seven sessions on beta.45 showed (2026-11-13)
|
||||
|
||||
**Measured on the way:** the owner's DLSS sessions of 2026-11-01 → 11-06, the driver's frame-generation numbering and
|
||||
Streamline's `v2.12.0` → `v2.14.16` changes are `spike-notes` §26 (the ledger read read-only; the vendored copy was
|
||||
`v2.12.0` byte for byte); the Games page before and after is §27 (first cards 822–830 ms → 10–15 ms with the first
|
||||
executable check held 800 ms; a revisit 181–215 ms → 15–16 ms). The neural-rendering decode costs nothing measurable in
|
||||
the detour and 0.14–0.19 ns on the present's feature byte (#358's body; NFR-1's budget is 1 µs per present).
|
||||
The owner ran seven sessions on six games the day after the release and said: check the logs and go on. Read from
|
||||
a copy of the ledger (sessions 190–196), the seven overlay logs, the Agent's log and Windows' application log —
|
||||
no FrameLedger binary was run against the owner's data. **Every session is hooked, `normal`, with no fault
|
||||
counted, no dropped record and no `PATCH_FAILED`; the count of early ends is 0 on all six games.** The update
|
||||
showed the terms once: Privacy Policy 2.19 was accepted at 07:23:36.
|
||||
|
||||
**Traps met on the way:**
|
||||
| Game (session, length) | Interposer | `slIsFeatureSupported` | `slIsFeatureLoaded` | `slSetFeatureLoaded` | allocate | free | shutdown |
|
||||
|---|---|---|---|---|---|---|---|
|
||||
| Phantom Blade Zero (190, 2 h 48 min; 191, 1 h 32 min) | 2.14.1 | **read** — Reflex, DLSS frame generation, PCL `eOk`; ImGUI and DeepDVC `eErrorFeatureMissing` | **read** — Reflex, frame generation *on* | not called | not called | **read** — frame generation, 1 | not called |
|
||||
| Cyberpunk 2077 (193, 7 min) | 2.14.1 | **read** — frame generation, DLSS, ray reconstruction, Reflex `eOk`; NIS `eErrorFeatureMissing` | **read** — the four *on* | **read** — the four, *on and off* | not called | not called | not called |
|
||||
| Dying Light: The Beast (194, 4 min) | 2.8.0 | **read** — DLSS, frame generation, PCL, Reflex, NIS `eOk` | not called | **read** — all five, *on and off* | not called | not called | **read** — 1 |
|
||||
| Hogwarts Legacy (195, 4 min) | 2.14.16 | **read** — frame generation, Reflex, DeepDVC, DLSS 5's `kFeatureDLSS_NR`, PCL `eOk`; ImGUI `eErrorFeatureMissing` | **read** — the first four *on* | not called | not called | not called | not called |
|
||||
| Black Myth: Wukong (196, 3 min) | 2.7.4 | **read** — frame generation, Reflex, PCL `eOk` | not called | not called | not called | not called | not called |
|
||||
| Kingdom Come: Deliverance II (192, 4 min) | none | not hooked | not hooked | not hooked | not hooked | not hooked | not hooked |
|
||||
|
||||
- **`notice-check` reads the tracked tree**: a file deleted from the working tree but not from the index fails it with
|
||||
*Could not find file* — after every build and test had passed (#360's first local gate). Stage the change
|
||||
(`git add -A`) before the gate.
|
||||
- **A new hook family bit belongs in the native token test's exact mask** (`guard_test.cpp`), and a new Streamline fact
|
||||
in the 0xF00D case's list of facts it must not light — #358's first gate (`0x100f` against `15`).
|
||||
- **WPF UI 4.3.0**: `NavigationCacheMode` is ignored once a page provider is set; `INavigationService.SetNavigationControl`
|
||||
hands the NavigationView the container's provider, so ours is set after it; LeftFluent's item template collapses the
|
||||
selected item's label.
|
||||
- **Microsoft.Data.Sqlite's async methods run synchronously**: a read awaited on the UI thread blocks it — `Task.Run` it.
|
||||
- **`slIsFeatureSupported` was read in every Streamline session, and `slAllocateResources` in none.** Item 43
|
||||
wrote the meaning of that before the run: a call no game makes after the attach gives nothing in attach mode, and
|
||||
whether it keeps its patch is the owner's to say. `slFreeResources` and `slShutdown` were each read once, in one
|
||||
game each; `slIsFeatureLoaded` in three games, `slSetFeatureLoaded` in two.
|
||||
- **A refusal reads as one.** Phantom Blade Zero and Hogwarts Legacy ask about `kFeatureImGUI`, Streamline's
|
||||
debug overlay, and are told it is missing; Cyberpunk 2077 is told the same of NIS, which Dying Light is told is
|
||||
supported. Phantom Blade Zero is told DeepDVC is missing although Streamline answered its requirements.
|
||||
- **The count says how often, not when.** Dying Light's one shutdown and Phantom Blade Zero's one freeing of frame
|
||||
generation's resources may each be the game closing; nothing in a session says. Dying Light switched all five
|
||||
features off and on.
|
||||
- **The way out is as it was.** Hogwarts Legacy faulted at its exit in `_nvngx.dll`, `0xc0000005` at offset
|
||||
`0x6aa85` — the offset of its six before, since 2026-11-06, hooked or not — and Black Myth: Wukong in
|
||||
Steam's `crashhandler64.dll`, `0xc0000409` at `0x39b49`, the offset of its three before (Steam's file is now
|
||||
11.23.65.88). Windows' log has no fault for the other four games; the two hooks on a game's way out were in all
|
||||
five Streamline games.
|
||||
- **Rates are where they were**, for what a comparison without the same scene is worth: Phantom Blade Zero ×4 at
|
||||
64 → 255 (beta.44: 63 → 251), Wukong 85 → 341 (90 → 361), Cyberpunk 2077 164 → 327 (137 → 275), Dying Light ×4
|
||||
at 48 → 194 (beta.42: 54 → 216), Kingdom Come 58.8 presented (59.3).
|
||||
- **An install stops the game's threads once a patch, as a restore does.** The thirteen interposer patches took
|
||||
0.74 s on Phantom Blade Zero, 1.2 s on Cyberpunk 2077, 1.7 s on Dying Light and Wukong (twelve there) and
|
||||
**2.8 s on Hogwarts Legacy** — 57 to 215 ms a patch, while the game starts. That is the cost the proposal to
|
||||
queue patches (§What this release decided) would cut, measured on real games.
|
||||
- **No stop was exercised.** Every session ended with the game closing, so no log has an `UNHOOK_RESTORED` line.
|
||||
Item 43 (g) said a log "ends with an `UNHOOK_RESTORED` line for each patch": that is true only of a session
|
||||
stopped while its game runs, and the item was worded wrongly.
|
||||
- **Not exercised: off means off** — Advanced metrics was on in every session. **Not visible in the data**: (c), whether *loaded* agrees with the game's own menu, and (h), the
|
||||
catalog's wording on the page — both are what the owner sees.
|
||||
- **For train C's spike**: Streamline says Reflex is supported in all five games and loaded in the three that
|
||||
ask; Cyberpunk 2077 and Dying Light switch it off and on (`spike-notes` §30 has the note).
|
||||
|
||||
**Owner-only:** item 30 — beta.34 on real hardware.
|
||||
### NEXT
|
||||
|
||||
### 0.1.0-alpha.3 — the third alpha, the same day (D87)
|
||||
1. ~~**The owner runs item 43**~~ **Run and read 2026-11-13** (§What the owner's seven sessions on beta.45
|
||||
showed): five of the six calls read in real games, nothing different on the way out, no fault. *Off means off*
|
||||
was not exercised, and `slAllocateResources` was called by no game.
|
||||
2. ~~**The owner reads `spike-notes` §30 and answers its three questions.**~~ **Answered 2026-11-13 (D132,
|
||||
D133)**: route D goes to a spike on `hook-harness` and a stub — the owner ruled that a driver's read-only getter
|
||||
called with the device of the hooked swap chain is inside rule 4 — and no real game is touched before the owner
|
||||
has seen its result (`spike-notes` §31, to be written after 0.1.0-beta.46 is tagged); route C is refused; the
|
||||
ETW route stays closed. No shipped code changes for the spike.
|
||||
3. ~~**The stop's cost** (above): whether to batch the restores is the owner's to say.~~ **Decided 2026-11-13
|
||||
(D134): batch them, installs too** — a pull request of its own, measured on the harness, released alone as
|
||||
**0.1.0-beta.46**. The plan was reviewed against MinHook's source before it was approved: `MH_ApplyQueued`
|
||||
applies every entry whose queued state differs, not only the caller's, so the queue-to-apply sequence is
|
||||
serialised, only targets that are still ours are ever queued for a restore, and nothing is queued "for all".
|
||||
4. **`slAllocateResources` keeps its patch** (D135); looked at again with more sessions.
|
||||
5. **Train D** after train C, the same way: a spike first.
|
||||
|
||||
`alpha` takes main at this pull request — `v0.1.0-beta.34` and these notes, no other change — by a merge commit, as
|
||||
`13_CI_CD` §The alpha line says. One file the switch holds moved on main — `legal/THIRD_PARTY_NOTICES.md`, its
|
||||
Streamline row (#358) — on a line the switch does not touch (the switch changes the *Transitive* row), so the merge
|
||||
takes both without a conflict (`git merge-tree` before the pull request); main's package set did not move, and the
|
||||
switch stays the first alpha's (SDK `11.0.100-rc.3.26522.148`, the three packages at `11.0.0-rc.3.26522.148`, the same
|
||||
NuGet licence texts) — the train reached it before .NET 11's release. Its gate on the 11 SDK must pass before the pull
|
||||
request into `alpha` is merged by
|
||||
hand (the branch has no auto-merge); the release runs from the signed tag `v0.1.0-alpha.3` on `alpha`, with its delta
|
||||
from alpha.2. Its notes are `docs/changelog/0.1.0-alpha.3.md`, which open with the experimental-build warning. It is
|
||||
the first alpha whose ledger moves (schema 22): the copy it makes first is the database as alpha.2 left it, and going
|
||||
back is to the newest beta, which opens schema 22.
|
||||
### Left open by this session
|
||||
|
||||
- **The next alpha moves to .NET 11's release**: from 2026-11-10 the switch is SDK `11.0.100` and the packages `11.0.0`,
|
||||
and RC3 is out of support — move the alpha even if no beta comes.
|
||||
|
||||
**Owner-only:** item 31 — the third alpha on real hardware.
|
||||
- ~~**This release's own facts** — the tag's run, the digests, the delta — are not in any file yet: the release is cut
|
||||
after this text. Record them in the next pull request, with what SonarCloud and Qodana said.~~ **Recorded
|
||||
2026-11-12: 0.1.0-beta.45 was released 2026-11-12T16:40:42Z** (23:40 in the owner's time zone) from the signed
|
||||
tag on `550d830` (#431), by run 43257803723 — green at the first attempt, one run for the one tag push. Eight
|
||||
assets; the seven digests of `SHA256SUMS.txt` equal the ones GitHub computed; the four shipped natives carry
|
||||
`FL_BUILD_ID v0.1.0-beta.45`. The delta from beta.44 is 1,762,465 bytes beside a full package of 110,767,499 —
|
||||
"Delta processed 0452 files. 0024 patched, 0428 unchanged". The wiki was published by run 43261335359. The
|
||||
rehearsal on the release branch (run 43253780609, at `f4e3fe2`, the released tree) had made a delta of 1,779,418
|
||||
bytes with the same file counts. **Qodana's two reports are green on `550d830`.** On the way Qodana's native
|
||||
report found two index products in the harness's probe (#427), fixed before that pull request merged; every
|
||||
later report was clean, and each was read before its merge. No required check failed on this train.
|
||||
**SonarCloud's quality gate failed on `550d830`, on one condition: duplicated lines on new code, 3.7 % where the
|
||||
gate allows 3 %.** No issue is open and coverage on new code is 98.6 %. The 39 lines are the six new members of
|
||||
`FlHookFamily` (`ShmLayout.cs`) and of its Domain mirror `HookFamilies` — two enums that are the same on purpose
|
||||
(Domain references nothing, and `MetricEnumMirrorTests` fails when they differ), which six members at once took
|
||||
over a threshold that two at a time had stayed under. The job is advisory and the release was already cut. The
|
||||
pull request that records this leaves the Domain's mirror out of duplication detection, with the reason in
|
||||
`SonarQube.Analysis.xml` and in `13_CI_CD` §SonarCloud; **whether the gate is green again is for the analysis of
|
||||
that commit on `main` to say**, and it is not in this text. *(It said so the same night: green on `d3e8dd3`,
|
||||
duplicated lines on new code 0.0 %, no issue open.)* One more thing the train showed: main's branch
|
||||
protection wants a pull request up to date, so of two that were green at once the second (#430) had to be
|
||||
rebased after the first merged, and ran its checks again.
|
||||
- ~~**No real game was run on this build.** Six new patch sites, tested with the harness and the stub; their cost
|
||||
measured on the headers.~~ **Seven sessions on six games, 2026-11-13** (§What the owner's seven sessions on
|
||||
beta.45 showed). The published release notes say the six calls "have not been run in a real game"; a released
|
||||
file is not edited.
|
||||
- **`slAllocateResources` has a patch no game has used**: not called after the attach in any of six sessions on
|
||||
five games. ~~Whether it stays is the owner's.~~ It stays for now (D135, 2026-11-13).
|
||||
- **Off means off (item 42 (f)) has never been exercised on a real game**; it is item 43 (f) now, for all ten.
|
||||
- **Valor Mortis's crash at 51 s** (twice, beta.40 and beta.44) **and Black Myth: Wukong's fault in Steam's crash
|
||||
handler at every exit** are not explained. One session of each with hooking off is the comparison that is missing.
|
||||
- **What item 41 left unexercised**: a configure through the FidelityFX 2.3 loader (Cyberpunk 2077 with FSR frame
|
||||
generation), a game with neither library.
|
||||
- **A fault while a game is closing is not seen by a hooked session** (D127: written down, not changed).
|
||||
- **`docs/LIST_GAME_TESTED.md` is as of 2026-11-06**: refreshing it is a new copy of the ledger and the owner's review.
|
||||
- **Item 40 (d)** was not exercised and the owner has not said item 40 passed. **Items 36 (d) and 37 are still open.**
|
||||
- **What an empty process snapshot does to the watcher's tick in a real session** was not looked into (seen once in
|
||||
a test on 2026-11-12).
|
||||
- **`LIMITATIONS.md` and the accuracy statement still say the processor's, the memory's and the motherboard's
|
||||
sensors "have never been read on real hardware"** — the owner's to reword. The alpha line still rests (D98).
|
||||
|
||||
**Owner-only:** item 43; the three questions of `spike-notes` §30; one session each of Valor Mortis and Black
|
||||
Myth: Wukong with hooking off; what item 41 left unexercised; item 40 (d).
|
||||
|
||||
## Owner-only — no PR can close these
|
||||
|
||||
*The items that passed — 3, 12, 14–19 — moved verbatim to [`handoff/owner-only-passed.md`](handoff/owner-only-passed.md) on 2026-10-19 (D66); the numbers are kept, and a number is never reused.*
|
||||
*The items that passed — 3, 12, 14–19, and 38 and 39 on 2026-11-12 — moved verbatim to [`handoff/owner-only-passed.md`](handoff/owner-only-passed.md) (the first eight on 2026-10-19, D66); the numbers are kept, and a number is never reused.*
|
||||
|
||||
1. **§S23-2 — branch protection.** `Rules / validate` is not a required status check on
|
||||
`main`, so the gate that makes the anti-cheat blocklist un-removable is advisory.
|
||||
@@ -396,6 +491,231 @@ back is to the newest beta, which opens schema 22.
|
||||
window shows the Disclaimer 2.13, the Privacy Policy 2.14 and the Alpha notice with its box again, and Accept waits for
|
||||
the tick. (c) `%LOCALAPPDATA%\FrameLedger\backups\ledger-before-0.1.0-alpha.3.db` exists beside alpha.2's, and opens;
|
||||
the ledger it left is at schema 22. (d) Item 30's checks, on the alpha.
|
||||
32. **beta.35 on real hardware** (D88–D91). (a) **The update from beta.34** (or alpha.3's): no terms window, the ledger
|
||||
unchanged. (b) **Narrator**: a safety notice is read as it appears; the agent's banner going and coming; Tools ▸
|
||||
Database maintenance ▸ Check reads its result; a short message at the bottom is read; **H** moves between each page's
|
||||
title and its sections; Settings ▸ Theme's options read their words; the Sessions table's cells read their values;
|
||||
Tab to a chart says its name and where its numbers are, and its arrows, Ctrl+arrows and A move it without scrolling
|
||||
the page; a double-click shows all of it. (c) **Contrast themes**: Aquatic and Desert, and one with an edited colour
|
||||
(Windows 10 if at hand) — every page, a dialog, the title bar's agent pill, a short message, a chart; turned on and
|
||||
off with FrameLedger open, it follows at once; Settings ▸ Theme shows its line. (d) **Ctrl+1 … Ctrl+5** put the
|
||||
keyboard in the page and Narrator says its title. (e) **Animation effects off** (Settings ▸ Accessibility ▸ Visual
|
||||
effects): no page slides in. (f) **Remove** on a game's page: the box opens over the window, its Cancel puts the focus
|
||||
back on Remove; the light theme's agent pill and a *done* message read clearly. (g) Help ▸ Accessibility shows the
|
||||
statement. (h) The 35 `ja` strings this release adds, all marked `review`: `Menu_Help_Accessibility`,
|
||||
`Accessibility_Title`, `Settings_Theme_ContrastOn` and 32 `A11y_*` (the names, the chart names and keys, the
|
||||
announcements).
|
||||
33. **Qodana, and beta.36 on real hardware** (D93). (a) **The update from beta.35**: no terms window, the ledger
|
||||
unchanged. (b) **The re-pointed bindings, by hand** — the tests pin their text, not a click: on Games, a card opens
|
||||
its game and both Play buttons (card and list) start it, greyed in a viewer; on the Dashboard a recent session
|
||||
opens; on a game's page a session row's *Open* opens its summary; in a session's summary a Yes/No/N/A chip opens the
|
||||
override dialog; a safety notice's button dismisses it; Settings lists the hooked games with *Revoke*, the
|
||||
exception rows with *Grant*/*Withdraw*, and the system information lines. (c) **Qodana Cloud**: the trial's end
|
||||
changes nothing in CI (the Community linter needs no licence; the token names the project the report goes to). If
|
||||
an Ultimate licence is wanted — JetBrains has a programme for open-source projects — `13_CI_CD` §Qodana says what
|
||||
moves. (d) **`qodana` as a required check, or not**: advisory today, like `sonarcloud`. (e) **The members nothing
|
||||
uses** (`13_CI_CD` §Qodana, 34 and 49 getters): say which are dead, and a pull request removes them.
|
||||
34. **beta.37 on real hardware — the first build on .NET 11's release** (D94–D98). (a) **The update from beta.36**:
|
||||
Help ▸ Check for updates offers beta.37 and *Restart to update* installs it — a download of about 70 MB, not a few;
|
||||
the terms window shows the **EULA 1.7 and the Disclaimer 2.14** once and nothing else; the ledger stays at schema 22.
|
||||
(b) **A hooked session on .NET 11.0.0**: one title you measure often, Tier 1 — frame times, the upscaler and frame
|
||||
generation as before; the Agent's log opens with `release line main, .NET 11.0.0`, and Help ▸ About reads *Runs on
|
||||
.NET 11.0.0*. This is the run `20_OPEN_QUESTIONS` §G's table asked for before the move and did not get (D94).
|
||||
(c) **The Agent in admin mode and the logon task** still start it — the publish is self-contained on a new runtime.
|
||||
(d) **Windows 10 22H2, if a PC or a VM with it is at hand**: does it install and start? No version has ever been run
|
||||
there; D95 states it as untested, and one run would be the first evidence either way. (e) **The Japanese** of the
|
||||
three alpha strings that changed or are new (`Alpha_Banner_Body_Format`, `Alpha_Banner_Body_Resting_Format`,
|
||||
`About_Runtime_Alpha_Format`) and of the first-run summary's first line. (f) **Going back** — only if something is
|
||||
wrong: install beta.36 over it; the ledger opens.
|
||||
35. **alpha.4 on real hardware — the last alpha for now** (D98). (a) **The update from alpha.3**: Help ▸ Check for
|
||||
updates offers alpha.4 and *Restart to update* installs it — a large download, the runtime moving from the release
|
||||
candidate to 11.0.0. (b) 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; `…\backups\ledger-before-0.1.0-alpha.4.db` exists beside the older copies, and opens;
|
||||
the ledger stays at schema 22. (c) **The banner says the alpha line is paused** and to install the beta — not the
|
||||
experimental-build warning — and Help ▸ About reads *Alpha build — runs on .NET 11.0.0*, with no "prerelease".
|
||||
(d) **Then install beta.37 over it**: the installer asks to replace it; the beta opens the ledger, shows no Alpha
|
||||
notice, and its update channel is no longer locked.
|
||||
36. **beta.38, and the two Qodana reports** (D99, D100). (a) **The update from beta.37**: Help ▸ Check for updates
|
||||
offers beta.38 — a small download — and *Restart to update* installs it; no terms window. (b) **Links still open**:
|
||||
the documentation from the Help menu, a document's page on GitHub from its window, a link inside the user guide
|
||||
and inside the update notes, and the source link in Help ▸ About each open in the browser, as before. (c) **Qodana Cloud**: the projects `frameledger` and
|
||||
`frameledger-cpp` each show a report from `main` with no problem. A job's log says *Qodana license plan: Ultimate*
|
||||
and the day the subscription is active until; when it lapses both jobs go red — advisory, never a blocked merge —
|
||||
and `qodana.yaml` says the way back. (d) **`LogNoteW`**: the Overlay has one function nothing calls
|
||||
(`src/native/FrameLedger.Overlay/src/dllmain.cpp`). Say whether it is removed — a pull request of its own, eleven
|
||||
lines — or kept; either way the `.editorconfig` section that names it is then removed or reworded.
|
||||
37. **beta.39, Advanced metrics on real hardware** (D101–D109). (a) **The update from beta.38**: the terms window
|
||||
shows the **Privacy Policy 2.15** and the **Disclaimer 2.15** once; the ledger moves to schema 23 and every
|
||||
earlier session opens as before. (b) **The switch**: Settings ▸ Recording ▸ *Advanced metrics* on — **Advanced**
|
||||
appears as the last item on the left at once, **Ctrl+6** opens it; off — it goes, and Ctrl+6 does nothing.
|
||||
(c) **This PC, on the RTX 5080**: the facts (firmware, cores, memory sizes, the display's HDR and variable
|
||||
refresh), the *Right now* table beside the NVIDIA app or HWiNFO — the first comparison of any of these values
|
||||
with another tool — and the chart moving; a fan's *Read at* a few seconds behind the memory's. Leave the page: the
|
||||
Agent's log says the reader closes some fifteen seconds later, and opens again when the page does. (d) **A
|
||||
session with a real game, the option on**: it is on *Session* with its statistics and its chart; its summary has
|
||||
**Advanced metrics…** and the button opens it there; *variable refresh was active* and the colour space against
|
||||
what the game and the display really did; the driver's settings for the game against the NVIDIA app. A session
|
||||
recorded with the option off is not on the list. (e) **As administrator, with PawnIO installed** — the first run
|
||||
there has ever been (`20_OPEN_QUESTIONS` §M10, §M13): the processor per core, the memory and the motherboard's
|
||||
sensors appear on *This PC* and *Sources* says *Read*; watch for a pause or a hang when the page first opens,
|
||||
and compare a few values with HWiNFO. Without it, *Sources* gives the reason in words. (f) **What it costs**: the
|
||||
Agent's processor time and memory during a session with the option on and with it off (NFR-2: ~~1 %~~ 2.5 % of one
|
||||
core since D117, 150 MB) — ~~and with that in hand, the answer to §M16~~ §M16 was measured without a game and
|
||||
answered on 2026-11-11; what is left for a real game is the hooked session and the elevated one. (g) **The words**: the `vi` strings read as a Vietnamese
|
||||
speaker would write them; the `ja` strings marked `review`. (h) **A copy of the ledger** (`--data-dir`) that holds
|
||||
such a session: the page is there, opens on *Session*, and *This PC* says it is a copy.
|
||||
40. **beta.42 — the log that answers D121, the label, the plane at infinity** (D119–D122). (a) **The update from
|
||||
beta.41**: Help ▸ Check for updates, *Restart to update* with no game running; no terms window. (b) **Cyberpunk
|
||||
2077 with FSR upscaling** (FSR 3 or 4, with or without FSR frame generation — as it was when the upscaler read
|
||||
"unknown"): one session of a few minutes of play, then **quit the game from its own menu**. Nothing else is
|
||||
needed: `%LOCALAPPDATA%\FrameLedger\logs\overlay-<pid>-….log` of that session is what is read. If the session
|
||||
now names FSR, say so — nothing in this release should have changed that. (c) **A game that gave one depth
|
||||
plane** — Lies of P, Clair Obscur or Dying Light: The Beast, FSR upscaling, **Advanced metrics on**: the
|
||||
session's Advanced page shows both planes, one of them "∞". If it still shows one, the missing plane is not
|
||||
`FLT_MAX` and the log of (b)'s kind says nothing about it — say so. (d) **A session that changes upscaler** —
|
||||
Dying Light: The Beast as it was (DLSS evaluated, then FSR), or any game switched between DLSS and FSR in its
|
||||
menu during one session: the summary names the one that ran longest, with that one's quality and render size,
|
||||
and says *settings changed during session*. (e) **Any hooked game, ended by quitting it**: its overlay log has
|
||||
lines after the first second — `HOOK_INSTALLED` with a module and a function, `RUNTIME_CENSUS` — and no
|
||||
`PATCH_FAILED`; if there is one, its `a=` number is the reason.
|
||||
**Four sessions were run on 2026-11-12 and read the same morning** (START HERE §What the owner's first four
|
||||
sessions on beta.42 showed): (a) happened — the sessions carry the beta.42 build; (b) read, and D121 answered:
|
||||
the session upscaled with FSR 2.1, built into the game; (c) Lies of P and Dying Light show `cameraNear = ∞`;
|
||||
(e) all four logs are whole and none has a `PATCH_FAILED`. **(d) was not exercised**, and the owner has not
|
||||
said the item passed.
|
||||
41. **beta.43 — the first real games with the two new hooks, and the guard's re-read** (D123–D125). **Not first on
|
||||
a game under the user-mode exception's trial** (D38): a crash there ends the exception for good. (a) **The
|
||||
update from beta.42**: Help ▸ Check for updates, *Restart to update* with no game running; **the terms window
|
||||
shows once, with Privacy Policy 2.17**. (b) **The guard**: over the games played, the Agent's log
|
||||
(`logs\agent-<date>.log`) has no session that ended at a game's launch with `guard=ModuleScanFailed`. If one
|
||||
does, its signal now says which kind — *kept changing while it was read* (four reads were not enough) or *came
|
||||
back incomplete* — say which. (c) **A Streamline game with Advanced metrics on** (Dying Light: The Beast, or
|
||||
Cyberpunk 2077 with DLSS): a session of a few minutes, quit from the game's menu. Its Advanced page shows the
|
||||
Streamline rows — jitter, motion vectors, depth, projection, resets — and the line under the session says
|
||||
*read*. **Read them for sense**: a field of view between about 0.3 and 2.5 rad, an aspect ratio near the
|
||||
screen's, a jitter under 1, planes that are not both zero. Values that make no sense mean the game's struct is
|
||||
not laid out as the one FrameLedger was built against: say so, with the numbers, and do not run further games.
|
||||
(d) **FSR frame generation on** (Cyberpunk 2077 or Lies of P), Advanced metrics on: the page shows the
|
||||
frame-generation rows — on, asynchronous or not, the flags, the rectangle — and the line says *read*. (e) **The
|
||||
three answers of the line**: a game with neither library says *not hooked* for both; a game where it says
|
||||
*hooked — the game did not make the call* for a library the game plainly uses is a finding, not a pass — say
|
||||
which game. (f) **Off means off**: with Advanced metrics off, **start a game afresh** and record a session; it
|
||||
has no Advanced button, and its `logs\overlay-<pid>-….log` has no `HOOK_INSTALLED` line naming `slSetConstants`
|
||||
or `ffxConfigure`. (A game that was already running when a session with the option on was recorded keeps the
|
||||
two patches until it exits — that is by design, and its log will have the lines.) (g) **Nothing else moved**:
|
||||
no crash, no `PATCH_FAILED` in any overlay log, frame rates and the frame-generation factor as on beta.42 for
|
||||
the same game and settings.
|
||||
**What each outcome means, written before the run.** (c) or (d) empty with *not hooked*: the log of that
|
||||
session says why — no `HOOK_INSTALLED` for the function (the library is a 1.x interposer or lacks the export)
|
||||
or a `PATCH_FAILED` (its `a=` number is the reason). Empty with *hooked — the game did not make the call*: the
|
||||
game reaches Streamline or FSR by a way that does not pass the export — beta.44's plan needs to know. A crash,
|
||||
or a game that will not start: say so at once; *Disable all hooking* (Settings ▸ Capture) and switching Advanced
|
||||
metrics off are the two ways to run without the hooks, and which of them cured it says which hook it was.
|
||||
**Nine sessions were run on 2026-11-12 and read the same afternoon** ([`handoff/history/0.1.0-beta.43.md`](handoff/history/0.1.0-beta.43.md) §What the owner's nine
|
||||
sessions on beta.43 showed): (a) happened — Privacy Policy 2.17 accepted once, at the update; (b) held — no
|
||||
`guard=ModuleScanFailed` since the update; (c) read on Phantom Blade Zero, Cyberpunk 2077 and Hogwarts Legacy,
|
||||
every value sane but one: **Cyberpunk 2077 gives its field of view in degrees** (51–90), and the page labels it
|
||||
radians — the struct is laid out as expected, the label is wrong; (d) read on Lies of P, **not exercised through
|
||||
the FidelityFX 2.3 loader**; (e) the three answers were each seen and none is a finding, **a game with neither
|
||||
library was not run**; (f) held on Lies of P started afresh; (g) no `PATCH_FAILED`, no fault, frame rates as
|
||||
before — Lies of P's 35 s end with exit code 3 is, by the owner, the game's own crash after a shader failed to
|
||||
compile, and Hogwarts Legacy's fault at exit is in Windows' log six times since 2026-11-06, hooked or not.
|
||||
**Judged passed 2026-11-12, on the owner's word to go on if it did**; the two parts in bold stay open.
|
||||
42. **beta.44 — the two questions about a feature in real games, and what the nine sessions found, fixed**
|
||||
(D126–D128). **Not first on a game under the user-mode exception's trial** (D38): a crash there ends the
|
||||
exception for good. (a) **The update from beta.43**: Help ▸ Check for updates, *Restart to update* with no game
|
||||
running; **the terms window shows once, with Privacy Policy 2.18**. (b) **Cyberpunk 2077 with Advanced metrics
|
||||
on**, a session of a minute or two: its Advanced page shows the field of view as the game gives it —
|
||||
`51.0055 – 90`, or whatever the game's setting makes it — with a line under it that says *Not radians*, and no
|
||||
"rad" beside the number. The two sessions of 2026-11-12 keep `51.0055 – 90 rad (2922.4° – 5156.6°)`: they were
|
||||
stored that way. (c) **Any Streamline game with Advanced metrics on** (Phantom Blade Zero, Hogwarts Legacy,
|
||||
Cyberpunk 2077): the line under the session has one more sentence — *Which version each Streamline feature is:
|
||||
…. What each requires: ….* — and for each it says *read*, or *hooked - the game asks this while it starts, and
|
||||
did not ask again after FrameLedger attached*. **The second is the expected answer** for a game that was already
|
||||
past its start-up when FrameLedger attached; it is not a failure. If it says *read*: the page lists features by
|
||||
NVIDIA's names (`kFeatureDLSS`, `kFeatureDLSS_G`) with versions and requirements — check that the driver version
|
||||
it shows as *detected* is the installed driver's, and that Streamline's version is the game's `sl.*.dll` file
|
||||
version. (d) **Which games, if any, say *read***: nothing to set up — FrameLedger attaches as soon as it sees the
|
||||
game — but say, for each Streamline game run, which of the two answers each call got. Hogwarts Legacy loaded its
|
||||
Streamline library some six seconds after FrameLedger attached on 2026-11-12, so it is the likeliest to say
|
||||
*read*; Phantom Blade Zero and Cyberpunk 2077 had it loaded already. (e) **A game with no Streamline** (Lies of P, Kingdom Come:
|
||||
Deliverance II): both say *not hooked*. (f) **Off means off**: with Advanced metrics off, **start a game
|
||||
afresh** and record a session; its `logs\overlay-<pid>-….log` has no `HOOK_INSTALLED` line naming
|
||||
`slGetFeatureVersion`, `slGetFeatureRequirements`, `slSetConstants` or `ffxConfigure`. (g) **Nothing else
|
||||
moved**: no crash, no `PATCH_FAILED` in any overlay log, frame rates and the frame-generation factor as on
|
||||
beta.43 for the same game and settings. With Advanced metrics on, a Streamline game's log has
|
||||
`slGetFeatureVersion` and `slGetFeatureRequirements` as its **first two** Streamline `HOOK_INSTALLED` lines.
|
||||
(h) **The count of early ends** (D126) is not something to provoke: if a game whose hooking you switched back
|
||||
on ends once within a minute of starting, hooking stays on; a second such end switches it off, as before.
|
||||
**What each outcome means, written before the run.** (c) *not hooked* on a Streamline game: the log says why —
|
||||
no `HOOK_INSTALLED` for the function (a 1.x interposer, or the export is missing) or a `PATCH_FAILED`. (c) and
|
||||
(d) both *did not ask again* on every game: the calls are made before any attach can be in — then these two
|
||||
hooks give nothing in attach mode, and whether they are worth their two patches is the owner's to say before
|
||||
train C. *Read* with numbers that make no sense (a driver version that is not the installed one, a feature
|
||||
named `feature <number>`): say so with the numbers — an id with no name only means NVIDIA added a feature this
|
||||
build does not know. A crash, or a game that will not start: say so at once; *Disable all hooking*
|
||||
(Settings ▸ Capture) and switching Advanced metrics off are the two ways to run without the hooks, and which
|
||||
of them cured it says which hook it was.
|
||||
**Eight sessions were run on 2026-11-12 and read the same evening** ([`handoff/history/0.1.0-beta.44.md`](handoff/history/0.1.0-beta.44.md) §What the owner's
|
||||
eight sessions on beta.44 showed): (a) happened — Privacy Policy 2.18 accepted once; (b) held — Cyberpunk 2077 reads
|
||||
`51.0055 – 90` and *not radians*; (c), (d) **both questions read on five games, six sessions of six** — the
|
||||
expected answer was the other one — with the driver, Windows and NGX versions agreeing with the PC, and one
|
||||
reading no file could give: frame generation's Streamline plugin is 2.14.16 on three games that ship an older
|
||||
one; Cyberpunk's version question was *not asked again*; (e) held on Kingdom Come: Deliverance II; (g) no
|
||||
`PATCH_FAILED`, no fault, the two rows first; (h) seen for real — Valor Mortis's second early end switched
|
||||
hooking off, the owner switched it on, the count is 0. **(f) was not exercised.** Valor Mortis crashed 51 s
|
||||
into a hooked session exactly as on beta.40, and Black Myth: Wukong faults in Steam's crash handler at every
|
||||
exit: neither is explained, and neither began with this release. **Taken as passed on the owner's "update and
|
||||
go on", 2026-11-12**; (f) and the two comparisons stay open.
|
||||
43. **beta.45 — six more Streamline calls in real games** (D129–D131). **Not first on a game under the user-mode
|
||||
exception's trial** (D38): a crash there ends the exception for good. (a) **The update from beta.44**: Help ▸
|
||||
Check for updates, *Restart to update* with no game running; **the terms window shows once, with Privacy Policy
|
||||
2.19**. (b) **Any Streamline game with Advanced metrics on** (Phantom Blade Zero, Clair Obscur, Valor Mortis,
|
||||
Black Myth: Wukong, Cyberpunk 2077), a session of a few minutes that includes **changing a graphics setting
|
||||
that touches frame generation or DLSS** if the game lets you: its Advanced page has two more tables —
|
||||
*Whether Streamline says each feature is supported, and loaded* (`kFeatureDLSS_G · slIsFeatureSupported` =
|
||||
`eOk`, `· slIsFeatureLoaded` = *On* or *Off*) and *Each feature switched on or off, its resources allocated and
|
||||
freed, Streamline shut down* — and the line under the session ends with one more sentence: *Streamline's other
|
||||
calls - read: …; hooked, the game did not make the call: …; not hooked: ….* Say, for each game, which calls
|
||||
are in which group. (c) **Check one number you can know**: a feature the game has switched off in its own menu
|
||||
and that reads *On* under `slIsFeatureLoaded`, or the reverse, is worth saying — "loaded" is Streamline's word
|
||||
for the plugin being in, not for the feature being in use, and what a real game does here is not known.
|
||||
(d) **A game with no Streamline** (Lies of P, Kingdom Come: Deliverance II): all six are in *not hooked*.
|
||||
(e) **The way out**: close each game the way you usually do. **Black Myth: Wukong and Hogwarts Legacy already
|
||||
fault while closing** (Steam's `crashhandler64.dll`, `_nvngx.dll`); what matters is whether anything is
|
||||
*different* — a new fault in Windows' application log (Event Viewer ▸ Windows Logs ▸ Application, *Application
|
||||
Error*) naming another module, a game that hangs on exit, a game that used to close cleanly and does not.
|
||||
(f) **Off means off**: with Advanced metrics off, **start a game afresh** and record a session; its
|
||||
`logs\overlay-<pid>-….log` has no `HOOK_INSTALLED` line naming any of the ten: `slSetConstants`, `ffxConfigure`,
|
||||
`slGetFeatureVersion`, `slGetFeatureRequirements`, `slIsFeatureSupported`, `slIsFeatureLoaded`,
|
||||
`slSetFeatureLoaded`, `slAllocateResources`, `slFreeResources`, `slShutdown`. (This is item 42 (f), which was
|
||||
not run.) (g) **Nothing else moved**: no crash, no `PATCH_FAILED` in any overlay log, frame rates and the
|
||||
frame-generation factor as on beta.44 for the same game and settings; with Advanced metrics on the log ends
|
||||
with an `UNHOOK_RESTORED` line for each patch and no "the stop was still writing". (h) **The Advanced page's
|
||||
catalog**: *The preferences the game started Streamline with* reads *Not read: the game makes this call once,
|
||||
before FrameLedger is inside it*.
|
||||
**What each outcome means, written before the run.** A call in *hooked, the game did not make the call* in
|
||||
every game: the game does that before FrameLedger is in, or never — then that hook gives nothing in attach
|
||||
mode, and whether it keeps its patch is the owner's to say. `slIsFeatureSupported` with a result that is not
|
||||
`eOk` for a feature the game then uses: say which — the row is Streamline's answer to the game, and the game
|
||||
may have asked about another graphics card. A count of `≥ 15`: the game allocates or frees every few frames;
|
||||
the number stopped, nothing is wrong. *Not hooked* on a Streamline game: the log says why — no `HOOK_INSTALLED`
|
||||
for the function (a 1.x interposer, or the export is missing) or a `PATCH_FAILED`. **A new fault on the way
|
||||
out, a hang on exit, or a crash in play**: say so at once, with the game; switching Advanced metrics off and
|
||||
starting the game afresh runs it without any of the ten hooks, and if that cures it the hook is one of the
|
||||
six new ones or the four before — the overlay log's last `HOOK_INSTALLED` lines and Windows' fault entry say
|
||||
which is nearer. A game that will not start at all: *Disable all hooking* (Settings ▸ Capture).
|
||||
**Seven sessions were run on 2026-11-13 and read the same day** (START HERE §What the owner's seven sessions on
|
||||
beta.45 showed): (a) happened — Privacy Policy 2.19 accepted once; (b) five Streamline games, six sessions —
|
||||
`slIsFeatureSupported` read in all, `slIsFeatureLoaded` in three games, `slSetFeatureLoaded` in two,
|
||||
`slFreeResources` and `slShutdown` once in one game each, **`slAllocateResources` in none**; (d) held on Kingdom
|
||||
Come: Deliverance II; (e) **nothing different**: Hogwarts Legacy and Black Myth: Wukong fault while closing in
|
||||
the same module at the same offset as before, the other four games leave no fault; (g) no `PATCH_FAILED`, no
|
||||
fault counted, rates as before — and no session was stopped while its game ran, so the part about
|
||||
`UNHOOK_RESTORED` lines was not exercised and was worded wrongly. **(f) was not exercised; (c) and (h) are the
|
||||
owner's to say.** Taken as passed on the owner's "check the logs and go on", 2026-11-13; (f) stays open.
|
||||
`slAllocateResources` keeps its patch (D135, the same day).
|
||||
|
||||
**Answered 2026-08-05, do not re-ask:** remove `gameguard` and keep `guard` (approved
|
||||
over a red `Rules` gate, with the reasoning recorded in the merge commit); vendor NVAPI
|
||||
headers **and** `amd64/nvapi64.lib`; Windows 11 is the **measurement scope** only —
|
||||
@@ -491,12 +811,60 @@ Where each owner decision is recorded — the file and its section, and a label
|
||||
| D79 | [`05_DETECTION.md`](05_DETECTION.md) §Platform signatures & metadata | the platform is "Xbox" (`xbox`), in full: import, artwork, Play, capture, detection, docs and legal |
|
||||
| D80 | [`08_UI.md`](08_UI.md) §Games | Play on an Xbox game always activates its package, in both modes; the Agent answers `PackagedGame` and records it in attach mode |
|
||||
| D81 | [`20_OPEN_QUESTIONS.md`](20_OPEN_QUESTIONS.md) §G | title lists stay keyed by Steam id; an Xbox copy is matched by everything but that entry |
|
||||
| D82 | [`HANDOFF.md`](HANDOFF.md) §START HERE | alpha.2 right after beta.33; on RC3 unless the train reaches it after .NET 11 ships (then SDK 11.0.100, packages 11.0.0) |
|
||||
| D82 | [`handoff/history/0.1.0-beta.33.md`](handoff/history/0.1.0-beta.33.md) | alpha.2 right after beta.33; on RC3 unless the train reaches it after .NET 11 ships (then SDK 11.0.100, packages 11.0.0) |
|
||||
| D83 | [`05_DETECTION.md`](05_DETECTION.md) §DLSS generation | the NVIDIA App's Dynamic frame generation, reported applied by the driver in a session where DLSS Frame Generation was identified, is DLSS 4.5 (amends D64) |
|
||||
| D84 | [`05_DETECTION.md`](05_DETECTION.md) §DLSS generation | DLSS 5 heads the DLSS line where its neural rendering was measured running (`kFeatureDLSS_NR`, `dlss_nr_pct`); loaded only reads "runtime loaded" (amends D64) |
|
||||
| D85 | [`08_UI.md`](08_UI.md) §Games, §Compare | filters: Games — store, engine, state, installed, played; Compare — game, tier, frame generation (no period); Compare lists every session |
|
||||
| D86 | [`08_UI.md`](08_UI.md) (the shell) | the left pane's selected item keeps its label: our copy of WPF UI 4.3.0's LeftFluent item template |
|
||||
| D87 | [`HANDOFF.md`](HANDOFF.md) §START HERE | alpha.3 right after beta.34, on RC3 (before .NET 11's release, 2026-11-10) |
|
||||
| D87 | [`handoff/history/0.1.0-beta.34.md`](handoff/history/0.1.0-beta.34.md) | alpha.3 right after beta.34, on RC3 (before .NET 11's release, 2026-11-10) |
|
||||
| D88 | [`../ACCESSIBILITY.md`](../ACCESSIBILITY.md) | the accessibility statement at the root, under Help ▸ Accessibility and on the wiki: WCAG 2.2 AA through WCAG2ICT is a goal, never a claim; reports by severity, no promised times |
|
||||
| D89 | [`08_UI.md`](08_UI.md) §Screen readers | what appears is said to a screen reader — notices, the agent's and the update's banners, the snackbars, a game page's notice, Database maintenance's results — while FrameLedger's window is active |
|
||||
| D90 | [`08_UI.md`](08_UI.md) §Screen readers | page titles heading 1, section titles heading 2; every chart named with where its numbers are; no series told apart by colour alone |
|
||||
| D91 | [`08_UI.md`](08_UI.md) §Contrast | Windows contrast themes are followed, whatever Settings ▸ Theme says |
|
||||
| D92 | [`handoff/history/0.1.0-beta.35.md`](handoff/history/0.1.0-beta.35.md) | beta.35 in this train, no alpha; alpha.4 is the move to .NET 11's release (SDK 11.0.100, packages 11.0.0), a task of its own after 2026-11-10 |
|
||||
| D93 | [`13_CI_CD.md`](13_CI_CD.md) §Qodana | Qodana Community for .NET from a workflow of its own (the organisation's licence is a 30-day trial, so not the Rider linter): a gate of zero problems, advisory; an inspection is switched off only in `.editorconfig`, with its reason |
|
||||
| D94 | [`12_BUILD.md`](12_BUILD.md) §The main line's .NET | the main line moves to .NET 11 with 0.1.0-beta.37, the day after it shipped; condition (a) of `20_OPEN_QUESTIONS` §G's table — two alphas on the released runtime — set aside by the owner, not met |
|
||||
| D95 | [`02_SPEC.md`](02_SPEC.md) NFR-8 | Windows 10 22H2 is not blocked, and is stated as untested and unsupported (Microsoft supports .NET 11 on Windows 11); a processor needs SSE4.2 and POPCNT |
|
||||
| D96 | [`13_CI_CD.md`](13_CI_CD.md) §C# 15 and the analyses | C# 15 on the main line from beta.37, a construct only where the build, CodeQL and Qodana read it — none of the four yet (Qodana's engine reads none, 2026-11-11), so beta.37 takes .NET 11's API and no syntax; no preview feature |
|
||||
| D97 | [`../legal/ALPHA_NOTICE.md`](../legal/ALPHA_NOTICE.md) | an alpha is "a beta's source built to try a newer version of .NET, at times a prerelease one": EULA 1.7, Disclaimer 2.14 (with a paragraph on Windows and the processor), Alpha notice 1.1, approved with the plan; the App says "a prerelease .NET" only where the runtime is one |
|
||||
| D98 | [`12_BUILD.md`](12_BUILD.md) §The alpha line | alpha.4 is beta.37's source on .NET 11.0.0, and then the alpha line rests until a newer .NET has a preview; a resting alpha tells its user to install the beta |
|
||||
| D99 | [`13_CI_CD.md`](13_CI_CD.md) §Qodana | Qodana for .NET on the Ultimate licence, in two reports from the start: the managed code to the Qodana Cloud project `frameledger`, the C++ to `frameledger-cpp` |
|
||||
| D100 | [`13_CI_CD.md`](13_CI_CD.md) §Qodana | an inspection is switched off where the engine that raised it reads — ReSharper's in `.editorconfig`, the rest in `qodana.yaml` (amends D93); hints are off as a severity; in code loaded into a game only defects are fixed |
|
||||
| D101 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Advanced metrics | "Thông số nâng cao" — Advanced metrics: the option `telemetry.advanced`, off by default, and off means nothing more is read or stored and the navigation item is hidden; everything reachable inside a game follows in stages, four trains A–D |
|
||||
| D102 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Advanced metrics | stored in full with the session, in tables of their own (`machine_profiles`, `session_advanced`, schema 0023) and not in columns of `sessions`; series under `adv.` names with NaN, not −1, for a tick with no reading |
|
||||
| D103 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Advanced metrics | LibreHardwareMonitor's CPU, memory, motherboard and storage groups only when the Agent already runs as administrator with PawnIO — the page links to that setting and never asks; power-supply and fan-controller groups refused, battery deferred |
|
||||
| D104 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Advanced metrics | identifiers are never read: the card's serial number and unique id, a display's EDID, the list of programs that are encoding |
|
||||
| D105 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Advanced metrics | the navigation item is the pane's last; Ctrl+1–5 keep their pages and Ctrl+6 opens it only while the option is on |
|
||||
| D106 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Advanced metrics | a `.partial` chunk of an unknown type with a right checksum is skipped, where it ended the read |
|
||||
| D107 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Advanced metrics | with no game running the Agent reads sensors only while the page is open |
|
||||
| D108 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Advanced metrics | "never call a setter" is a build gate: every `NvAPI_*` call of the bridge is held to a committed list |
|
||||
| D110 | [`20_OPEN_QUESTIONS.md`](20_OPEN_QUESTIONS.md) §M16 | the L2 telemetry layer's cost is measured in a real Agent before anything is changed (`tools/agent-cost.ps1`); what to do about the number is asked after |
|
||||
| D117 | [`02_SPEC.md`](02_SPEC.md) NFR-2 | asked with the measurement in hand (1.93 % off, 2.04 % on): NFR-2 is amended to ≤ 2.5 % of one core during capture; the sensors keep one reading a second and no code changes |
|
||||
| D111 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Train B | inside the game too, off means nothing more is read: the Overlay reads new fields and installs new hooks only while the Agent's control word says the session records Advanced metrics |
|
||||
| D112 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Train B | `slInit` is not hooked in train B; if ever, never `applicationId`, `projectId` or the paths |
|
||||
| D113 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Train B | train B is three releases: beta.40 fields of calls already hooked (no new patch site), beta.41 `slSetConstants` + `ffxConfigure`, beta.42 `slGetFeatureVersion` + `slGetFeatureRequirements`; each waits for the owner's run of the one before; C is beta.43, D beta.44 |
|
||||
| D114 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Train B | the field of view is stored as a session's range, never as a series |
|
||||
| D115 | [`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Which struct version carries which field | a tail member of a vendor struct is read only where the upstream tags prove it is there |
|
||||
| D116 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Train B | "never the camera" is a build gate: `tools/overlay-fields-check.ps1` |
|
||||
| D118 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Train B | told that the sensor-library fix would take the number D113 gave train B's second release, the owner chose to release it at once as 0.1.0-beta.41: the train's second and third releases are beta.42 and beta.43, train C beta.44, train D beta.45 |
|
||||
| D119 | [`07_IPC.md`](07_IPC.md) §Region 5 | `FLT_MAX` (or +infinity) in an FSR depth plane is stored and shown as "infinite" — three engines pass it for the plane at infinity; for FSR only: for Streamline `FLT_MAX` is the "not set" sentinel and stays absent |
|
||||
| D120 | [`03_METRICS.md`](03_METRICS.md) §Upscaling | a session's upscaler is the technology named on the most samples, and its quality and render size are read from that technology's samples — not the first one named, with the others' values beside it |
|
||||
| D121 | [`HANDOFF.md`](HANDOFF.md) §NEXT | Cyberpunk 2077 was set to FSR upscaling and FrameLedger named none: a detection gap, to be investigated — which first needs a native log that survives the game's exit |
|
||||
| D122 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Train B | train B's second step is split: **beta.42** has no new patch site (D119–D121 and the patch registry's hardening); **beta.43** is the two new hooks, begun only after the owner has run Cyberpunk on beta.42 and its log was read. The third release is beta.44, train C beta.45, train D beta.46 |
|
||||
| D123 | [`19_SAFETY_AND_ANTICHEAT.md`](19_SAFETY_AND_ANTICHEAT.md) §Pre-injection checks, check 1 | a module list that changed while the guard read it is read again, at most three times, before it refuses — five real sessions on one PC in a week had ended as a safety unhook with no frame recorded; a list that never settles still refuses, and nothing else about what refuses changed |
|
||||
| D124 | [`HANDOFF.md`](HANDOFF.md) §NEXT | the guard's re-read (D123) ships with 0.1.0-beta.43 and not as a release of its own — the train's numbers do not move a third time; until then a launch can still be lost that way on beta.42 |
|
||||
| D125 | [`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Hook inventory | an FSR UPSCALE is counted at the first source that saw one and at no other — a precaution for a loader that hands a dispatch on to the leaf's export (Cyberpunk 2077's 2.3.0 does, for frame generation); no title run so far upscales through one |
|
||||
| D126 | [`19_SAFETY_AND_ANTICHEAT.md`](19_SAFETY_AND_ANTICHEAT.md) §Crash & stability safety | the count of early abnormal ends starts again when the user switches hooking on (the consent grant sets it to 0) — it was never set back, so a game once switched off was switched off again by every single such end, under a reason that says "twice" (Lies of P, 2026-11-12) |
|
||||
| D127 | [`19_SAFETY_AND_ANTICHEAT.md`](19_SAFETY_AND_ANTICHEAT.md) §Crash & stability safety | a fault while a game is closing, which a hooked session does not see (Hogwarts Legacy, the driver's `_nvngx.dll`, hooked or not), is written down and not changed in 0.1.0-beta.44 — seeing it would end a user-mode exception for a fault no hook caused; a decision of its own |
|
||||
| D128 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Train B | a field of view over π is shown as the game gave it, with a row that says it is not radians, and is never converted — Cyberpunk 2077 gives Streamline degrees; converting would store a guess at the unit as the game's word |
|
||||
| D129 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Train B | `slInit` is not hooked at all — asked to reopen D112 and shown that no shipped mode is in the game in time (launch mode waits for the presentation runtime, no patch is ever made on a game's thread, an Advanced-only hook waits for the Agent's request), the owner kept it out; a hook there would be a patch that reads nothing |
|
||||
| D130 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Train B | six more Streamline core calls are hooked in one release, 0.1.0-beta.45 — `slIsFeatureSupported`, `slIsFeatureLoaded`, `slSetFeatureLoaded`, `slAllocateResources`, `slFreeResources`, `slShutdown`; trains C and D come after it, and train C's spike is written beside it as a document |
|
||||
| D131 | [`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Hook inventory | the adapter a game asks `slIsFeatureSupported` about (`sl::AdapterInfo`: a LUID, or a Vulkan physical device) is never read — the feature's id and the result only; a build check refuses the struct's member names in code loaded into a game |
|
||||
| D132 | [`20_OPEN_QUESTIONS.md`](20_OPEN_QUESTIONS.md) §M14, `CLAUDE.md` rule 4's note of 2026-11-13 | Reflex route D goes to a spike on `hook-harness` and a stub first — and the ruling a go needed: calling a driver's read-only getter with the device of the swap chain the Overlay hooks is inside rule 4. No real game before the owner has seen the result |
|
||||
| D133 | [`20_OPEN_QUESTIONS.md`](20_OPEN_QUESTIONS.md) §M14, [`spike-notes/30-reflex-latency.md`](spike-notes/30-reflex-latency.md) | Reflex route C (the Overlay calling `slReflexGetState`) is refused; the no-injection ETW route stays closed, and §G with it |
|
||||
| D134 | `HANDOFF` START HERE §NEXT | installs and restores are batched through MinHook's queue — one stop of the game's threads for a batch, not one a patch — in a pull request of its own, measured, released alone (0.1.0-beta.46) |
|
||||
| D135 | [`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Hook inventory | `slAllocateResources` keeps its patch although no game called it in the first six sessions; looked at again when there are more |
|
||||
| D109 | [`../legal/DISCLAIMER.md`](../legal/DISCLAIMER.md) §5, §5A | asked on 2026-11-11 with both sentences quoted: the Disclaimer goes to 2.15 with the Privacy Policy — PawnIO and the admin mode are no longer "for the CPU temperature" alone; with Advanced metrics on they also read the processor's, the memory's and the motherboard's sensors. The admin mode's disclosure follows (`agent-admin-dialog/2`) |
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -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,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,69 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.38 was cut, 2026-11-11 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.38] - 2026-11-11
|
||||
|
||||
**The thirty-eighth pre-release: the App opens web and mail links only.** One small hardening, and nothing else you
|
||||
see, record or measure changes. The one place in the App that hands a link to Windows now refuses any address that is
|
||||
not `http`, `https` or `mailto`, where it trusted each caller to have checked — Windows runs whatever it is handed, and
|
||||
a `file:` address is a program. Every link the App shows already was one of those three, so no link you could click
|
||||
before stops working. The rest of this release is for developers: Qodana — JetBrains' code analysis — now reads the C#
|
||||
with its Rider-based linter and, as a second report, the C++. The same unsigned installer: verify its hash against
|
||||
`SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**Updating from `0.1.0-beta.37`:** 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: the code FrameLedger loads into a game is
|
||||
0.1.0-beta.37's, line for line.
|
||||
|
||||
**No alpha follows this release**: the alpha line rests (`guide/11-alpha-builds.md`).
|
||||
|
||||
### Changed
|
||||
|
||||
- **Every place that starts a process was read, and the App now opens web and mail links only.** JetBrains' rule for
|
||||
"a process started with something that is not a literal" reported 35 places — 11 in the product, 24 in tests. Each
|
||||
was read: what it starts, and where the path and the arguments come from (the table in `docs/13_CI_CD.md` §Qodana).
|
||||
None takes a value from outside the PC or from a file FrameLedger did not write, except the path and arguments of
|
||||
the game the user added. One was hardened: `ShellUrlOpener` — what opens a link in the browser or the mail client —
|
||||
now refuses any address that is not `http`, `https` or `mailto` itself, where it trusted each caller to have
|
||||
checked; the shell runs whatever it is handed, and a `file:` address is a program. Every caller already passed one
|
||||
of the project's own pages or a link held to those schemes, so no link you could click before stops working. The
|
||||
rule stays on: the files its results were read in are listed in `qodana.yaml`, so a new file that starts a
|
||||
process is reported — by path on the plugin's one inspection, since a rule's own id is honoured nowhere (three
|
||||
runs measured it). And a test of the repository's own, `ProcessStartSitesTests`, in the gate, fails on a new file
|
||||
that starts a process, or registers a scheduled task, until it has been read and listed.
|
||||
- **Qodana for .NET, on the Ultimate licence, reads the managed code** (developers only; owner decisions D99 and D100).
|
||||
The owner took an Ultimate licence for the Qodana Cloud organisation and asked for Qodana over every language. The
|
||||
job — `managed`, *Qodana (managed)* in a pull request's checks — now runs Qodana for .NET (Rider's engine) in native
|
||||
mode on a Windows runner, after a `dotnet build`, where the Community linter ran in a Linux container. Besides the
|
||||
C#, the XAML and the `.resx` it reads the Markdown and XML around the solution, and JetBrains' security rules read
|
||||
the C#. Its first run reported 3,953 problems, 3,607 of them **hints** — the level an editor offers without
|
||||
underlining anything, which the Community linter never reported; hints are off as a severity. Of the 347 left: a vi
|
||||
or ja string equal to the English one (271) is off in `.editorconfig` for `.resx` files — names, units and format
|
||||
strings are not translated; two Markdown inspections (table padding, and anchors computed otherwise than GitHub
|
||||
does) and the application manifest's XML are off in `qodana.yaml`; six results in `PrimaryDisplay.cs` are the
|
||||
linter's own fault (an internal assertion, in its log) and are excluded for that file; one test expression was
|
||||
simplified. The gate stays zero problems and the job stays advisory. An inspection is now switched off **where the
|
||||
engine that raised it reads** — one of ReSharper's in `.editorconfig`, what has no key there in `qodana.yaml` — which
|
||||
amends D93's "never in `qodana.yaml`" (`docs/13_CI_CD.md` §Qodana). The C++ goes to a second report, the next pull
|
||||
request's.
|
||||
- **Qodana reads the C++ too, as a second report** (developers only; owner decision D99). The job `native` has CMake
|
||||
write a Visual Studio solution for `src/native` (the preset `x64-vs-analysis`; nothing ships from it) and runs
|
||||
Qodana for .NET over it — ReSharper's C++ inspections and the clang-tidy checks they bundle — with settings of its
|
||||
own (`qodana-native.yaml`), reporting to a Qodana Cloud project of its own. Its first run reported 4,695 problems,
|
||||
4,040 of them hints; of the 655 left, 494 are distinct (a file compiled into three targets is reported three
|
||||
times). Nearly all of them are not faults, and `.editorconfig` now says why in fifty-four lines, each with its
|
||||
reason: clang's opinion of code that only MSVC builds (`__try`, a function pointer got by name, struct padding);
|
||||
the engine misreading `std::atomic_ref`, zero-initialised API structures and tests of `constexpr` functions;
|
||||
proposals to restate working code in a newer idiom; and what a probe or a test does on purpose. Eleven things
|
||||
were fixed, none changing what a shipped binary does: `std::size` for four hand-written array lengths, two
|
||||
multiplications done in a narrower type than their result, two unused member functions, an unused type alias, two
|
||||
unused includes. **In code loaded into a game nothing was changed**: the report found no defect there, and what it
|
||||
did say about those files is listed in `docs/13_CI_CD.md` §Qodana — among it one function in the Overlay that
|
||||
nothing calls (`LogNoteW`), which is recorded for the owner and not removed (D100). The gate is zero problems and the job is advisory, like the other.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **A test that failed on a busy machine** (developers only). `ShmDrainIntegrationTests`' drain under supervision
|
||||
ended after one guard evaluation whenever the first scan was slow enough for fifty presents to be waiting, and
|
||||
then failed its own "supervised more than once"; the loop now supervises at least twice whatever the first
|
||||
drain holds.
|
||||
@@ -0,0 +1,125 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.39 was cut, 2026-11-11 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.39] - 2026-11-11
|
||||
|
||||
**The thirty-ninth pre-release: Advanced metrics.** A new setting, **off unless you switch it on** — Settings ▸
|
||||
Recording ▸ *Advanced metrics* — and a page of its own. With it on, the capture agent reads more from the graphics
|
||||
driver and the hardware sensors during a session and keeps it with the session: the graphics card's memory, load,
|
||||
clocks, fans, voltages and power in detail; what each display can do with HDR and variable refresh, and what the
|
||||
game's display did; the driver's settings, global and for the game; and — when the agent runs as administrator with
|
||||
PawnIO installed — the processor per core, the memory and the motherboard's sensors. The **Advanced** page (the last
|
||||
item on the left, **Ctrl+6**) shows it under what it belongs to: **This PC**, read only while the page is open and
|
||||
never stored; **Session**, what one session kept, in tables and a chart; **Sources**, every reading FrameLedger knows
|
||||
of and, for each one it does not read, why. With the setting off, nothing more is read or stored and the page is not
|
||||
there. The same unsigned installer: verify its hash against `SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**What it is not, yet.** None of these readings has been checked against another tool. The processor's, the memory's
|
||||
and the motherboard's sensors have never been read on real hardware — the first run as administrator with PawnIO is
|
||||
still to come. The driver's own figures exist on NVIDIA cards only, and no AMD or Intel card was tested. A drive's
|
||||
temperature is not read. Nothing is read inside the game by this release: the readings that need a hook come with
|
||||
later ones. `LIMITATIONS.md` §Sensors lists every limit.
|
||||
|
||||
**Updating from `0.1.0-beta.38`:** Help ▸ Check for updates, then *Restart to update* with no game running. The terms
|
||||
window shows the **Privacy Policy 2.15** and the **Disclaimer 2.15** once — they name what Advanced metrics reads and
|
||||
stores, only while it is on, and that PawnIO and the administrator mode then read more than the CPU temperature. The
|
||||
ledger moves to **schema 23** (two tables are added; nothing that was there changes), so a 0.1.0-beta.38 cannot open
|
||||
it afterwards. The detection rules stay at `2026.11.2`. With the setting off, nothing about capture or measurement
|
||||
changes: the code FrameLedger loads into a game — the overlay, the Vulkan layer, the shared-memory layout, the
|
||||
injector — is 0.1.0-beta.38's, line for line.
|
||||
|
||||
*The entries below are in the order the seven pull requests landed. One that says "not yet" describes that pull
|
||||
request; a later entry is what followed.*
|
||||
|
||||
### Added
|
||||
|
||||
- **"Advanced metrics" is planned, and its inventory is written — nothing reads it yet.** The owner asked for a
|
||||
setting, *Thông số nâng cao*, with a navigation item of its own that shows as much as the NVAPI and Streamline
|
||||
headers and PawnIO make available, each value under what it belongs to: one game session, or the PC. This pull
|
||||
request is the first of that train and changes nothing you can see or record. It adds the list everything else in
|
||||
the train reads — `AdvancedMetricCatalog`, 137 entries: what the Agent will read from NVAPI and
|
||||
LibreHardwareMonitor (the card's firmware, architecture and cores; its memory with evictions and promotions; its
|
||||
utilisation by domain; what a display can do with HDR and variable refresh; the driver's profile; and, as
|
||||
administrator with PawnIO, the processor per core, the motherboard, the memory modules and the drives'
|
||||
temperatures), what can only be read inside a game and waits for a later release, **and what is never read with the
|
||||
reason** — a serial number, a display's EDID, the list of programs that are encoding, the camera's position, what
|
||||
a vendor's licence closes. `docs/18_GPU_VENDOR_APIS.md` §Advanced metrics holds the design, the owner's decisions
|
||||
D101–D108 and the same list as a table; a test fails when the table and the catalog differ in either direction.
|
||||
|
||||
- **The NVIDIA bridge can read what Advanced metrics will show — and nothing calls it yet.**
|
||||
`FrameLedger.NvapiBridge.dll`, the library the Agent loads into its own process and never into a game, gains five
|
||||
reads (its ABI 3): the card's facts — firmware version, architecture, ray-tracing and tensor core counts, base and
|
||||
boost clocks, its memory sizes, the driver's package; what it says now — free and used video memory with evictions
|
||||
and promotions, the frame-buffer, video and bus utilisation, the performance state, the encoder's load; what each
|
||||
connected display can do with HDR and variable refresh; the state of the display a game presents on; and every
|
||||
setting of a driver profile. On the development PC's RTX 5080 all twenty facts and eight of the ten live groups
|
||||
answer — the card has no board or power-supply temperature sensor, so those two will read N/A.
|
||||
**It reads no identifier**: no serial number, no unique id, no display EDID, and not which programs are encoding.
|
||||
- **"The bridge never calls a setter" is now a build check.** A new gate, `tools/nvapi-readonly-check.ps1`, compares
|
||||
every NVAPI call in the bridge's source with a committed list of forty-four reads, in both directions, and refuses a
|
||||
name that sets, saves, restores, registers or controls something — or returns an identifier — even when someone
|
||||
adds it to the list.
|
||||
|
||||
- **The reader behind Advanced metrics exists, was measured on a real PC, and is still not switched on.** One
|
||||
reader for the whole Agent, on a thread of its own, that runs only while a session or the page needs it: NVIDIA's
|
||||
figures every second, and every sensor LibreHardwareMonitor has for the graphics card — each fan and its duty, the
|
||||
core voltage, PCI Express traffic, the load of every engine. When the Agent runs as administrator with PawnIO
|
||||
installed it will also read the processor per core, the memory and the motherboard's sensor chip.
|
||||
**A drive's temperature is not read**: the library cannot list drives without touching removable ones, so that
|
||||
group is never opened and the value will read N/A with that reason.
|
||||
- **`FrameLedger.CaptureHost probe-advanced`** (a developer tool, not shipped): runs that reader for a few seconds
|
||||
on your own rights and prints everything it read and what it cost. On the development PC it read 35 facts and 58
|
||||
values a second — and showed that one refresh of the sensor library takes 14 ms of processor time, so the reader
|
||||
refreshes it every five seconds, where NVIDIA's own figures (0.4 ms) stay at one a second.
|
||||
|
||||
- **The ledger can hold Advanced metrics — and holds none yet.** Schema 23 adds two tables: one for the facts of
|
||||
the PC, stored once per distinct set, and one for what a session recorded with the option on knows — its own
|
||||
facts, which sources answered and why the others did not, and the statistics of its extra series. Nothing is
|
||||
added to the session row itself, so what the JSON export and a bug bundle carry does not grow. The extra series
|
||||
are stored beside the others under names of their own, with a real "no reading" for a second in which a sensor
|
||||
was not read. One hour of them is about 0.2 MB. **A session recorded with the option off stores nothing of this**,
|
||||
and the option does not exist yet. *A 0.1.0-beta.38 cannot open a ledger a later build has migrated.*
|
||||
|
||||
- **Settings ▸ Recording ▸ Advanced metrics — the switch exists, off by default.** On, the capture agent reads more
|
||||
from the graphics driver and the hardware sensors during a session and stores it with the session: the graphics
|
||||
card's memory, load, clocks, fans, voltages and power in detail, what each display can do with HDR and variable
|
||||
refresh and what the game's display did, the driver's settings for the game — and, when the agent runs as
|
||||
administrator with PawnIO installed, the processor per core, the memory and the motherboard's sensors. **Off,
|
||||
nothing more is read or stored**, and the shared reader is not even started. It applies from the next session, and
|
||||
a session recorded while it was off is not filled in later. NVIDIA's figures are read once a second, the sensors
|
||||
every five. **No page shows what is stored yet** — that is the next pull requests' — and none of it is in an
|
||||
export or a bug report.
|
||||
- **The App can ask the agent what this PC reads right now — and no page asks yet.** A new request,
|
||||
`GetAdvancedMachine`, answers what the agent's shared reader last read: the PC's facts, the newest value of every
|
||||
series, and which sources answer or why they do not. It never touches a sensor itself, so it cannot hold up the
|
||||
pipe. Each request also keeps the reader running for five seconds, which is how "with no game running, sensors are
|
||||
read only while the page is open" works without anything telling the agent that a page closed. With Advanced
|
||||
metrics off it answers that it is off, and nothing is read. On the App's side `AdvancedMachineFeed` asks once a
|
||||
second while a page watches it and keeps each value with the moment it was read.
|
||||
- **The Advanced page.** While Advanced metrics is on, **Advanced** is the last item in the list on the left, and
|
||||
**Ctrl+6** opens it. **This PC** shows what the graphics driver and the sensors say right now — the card's
|
||||
firmware, cores and memory, what each display can do, the driver's settings, and every reading with the time it
|
||||
was read at and a chart of its last five minutes. It is read only while the page is open, and is not stored.
|
||||
**Session** shows what a session recorded with the option on kept: the PC as it was, what belonged to that session,
|
||||
the lowest, average and highest of each reading, and a chart over the session. **Sources** lists every reading
|
||||
FrameLedger knows of and, for each one it does not read, why — the agent is not an administrator, PawnIO is not
|
||||
installed, it comes with a later release, or it is never read. A session's summary has an **Advanced metrics…**
|
||||
button that opens that session there. In `en`, `vi` and `ja`; the user guide has a page for it.
|
||||
- **The terms window shows the Privacy Policy 2.15 and the Disclaimer 2.15 once.** The Privacy Policy names what
|
||||
Advanced metrics reads and stores, only while it is on, and what it never reads: a serial number, a display's
|
||||
identification data, a list of other programs. The Disclaimer's two sentences about PawnIO and about running the
|
||||
agent as administrator said "the CPU temperature"; they now also name the processor's, the memory's and the
|
||||
motherboard's sensors, read with Advanced metrics on. The same sentence changed in Settings, the first run, the
|
||||
administrator dialog, the guide and `LIMITATIONS.md`.
|
||||
|
||||
### Changed
|
||||
|
||||
- **A crash file from a newer build no longer loses its tail in an older one.** The file a session writes as it goes
|
||||
(so that a crash keeps what was recorded) is made of chunks; a reader that met a chunk of a kind it did not know
|
||||
stopped there. It now passes over a whole chunk it does not know and reads on.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **A sentence in the documents that kept a function from being called.** `docs/18_GPU_VENDOR_APIS.md` said the
|
||||
vendored NVAPI headers do not declare `NvAPI_GPU_GetMemoryInfoEx`. They do — in `nvapi_lite_common.h`, which
|
||||
`nvapi.h` includes; the search that found nothing had looked in `nvapi.h` alone. The row is corrected, and the
|
||||
bridge will call it for the advanced memory rows. Nothing about the memory figures FrameLedger shows today changes.
|
||||
@@ -0,0 +1,99 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.40 was cut, 2026-11-12 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.40] - 2026-11-12
|
||||
|
||||
**The fortieth pre-release: Advanced metrics, inside the game.** With **Advanced metrics** on (Settings ▸ Recording;
|
||||
off unless you switch it on), a session of a game FrameLedger measures from inside now also keeps **what the game
|
||||
itself tells its upscaler**: for DLSS the output size, the model preset for each quality mode, whether the game said
|
||||
its colour buffers are HDR, auto-exposure, alpha upscaling and the exposure values; for FSR the sharpening, the
|
||||
largest jitter offset, the exposure, the near and far planes, the **range** of the field of view, the flags, the
|
||||
frame time the game reported and FSR's own video memory when the game asked for it. The **Advanced** page shows them
|
||||
under the session, in the vendor's own notation, and the session says in a sentence what became of them. With the
|
||||
setting off nothing more is read inside a game: the component in the game runs the same reads as before, and a test
|
||||
that injects into a window sending all of it finds the new memory region empty to the last byte. The same unsigned
|
||||
installer: verify its hash against `SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**What it is not, yet.** **None of this has been read from a real game** — only from the project's own test window.
|
||||
**Many games will show nothing**: most set their DLSS options through a call FrameLedger cannot intercept, and the
|
||||
FSR rows need FSR 3.1 or later through AMD's own library (a game that upscales through the older FSR 3.0 interface
|
||||
shows none). The session then says *the game made none of the calls these are read from* — which never means the
|
||||
game uses no upscaler; its summary names the upscaler as before. These are the game's words to the upscaler, not a
|
||||
check of what the upscaler did. **Never read:** where the camera is, which way it looks, its matrices — a build
|
||||
check refuses those names anywhere in the code loaded into a game. No new hook is installed by this release; two
|
||||
further steps of this train add hooks, each after this one has been run on real games. `LIMITATIONS.md` §Sensors
|
||||
lists every limit.
|
||||
|
||||
**Updating from `0.1.0-beta.39`:** Help ▸ Check for updates, then *Restart to update* with no game running. The terms
|
||||
window shows the **Privacy Policy 2.16** once — it names what is stored of the game's upscaler parameters, only with
|
||||
Advanced metrics on and only for a game FrameLedger injects into, and what is never read. The Disclaimer stays 2.15.
|
||||
**A game that is running when you update must be restarted before FrameLedger measures it again**: the shared memory
|
||||
between the game and the agent has a new layout (version 5), and the component inside the game is new. The ledger
|
||||
stays at schema 23 and the detection rules at `2026.11.2`.
|
||||
|
||||
*The entries below are in the order the four pull requests landed. One that says "not yet" describes that pull
|
||||
request; a later entry is what followed.*
|
||||
|
||||
### Added
|
||||
|
||||
- **Advanced metrics inside the game is planned — three releases, and nothing reads it yet.** The readings that
|
||||
exist only inside a game — the options a game gives DLSS and FSR, FSR's own memory, later the constants a game
|
||||
gives Streamline and its frame-generation configuration — come in three steps (owner decisions D110–D116):
|
||||
first more fields of calls FrameLedger already intercepts, with no new hook; then two new hooks; then two more.
|
||||
Each step waits for the one before to be run on real games. With Advanced metrics off, nothing more is read
|
||||
inside a game either. This pull request changes nothing you can see or record: it records the decisions, and
|
||||
**which version of each vendor struct carries which field**, compared across every upstream release of Streamline
|
||||
2.x and of the FidelityFX API — a field is read only where it is proven to be there.
|
||||
- **`tools/agent-cost.ps1`** (a developer tool): what the shipped capture agent costs while it records, measured on
|
||||
the real program against the project's own test window, with Advanced metrics off and on.
|
||||
|
||||
- **The shared memory between a game and the agent has room for what a game tells its upscaler — and nothing
|
||||
writes it yet.** Its layout is version 5: one new region, sized once for the three releases of this train, and
|
||||
one new word by which the agent says "this session records Advanced metrics". With that word at zero — every
|
||||
session, until the next pull request, and afterwards every session with the option off — the region stays empty and
|
||||
the component inside the game does exactly what it did before. **A game that is running when you update must be
|
||||
restarted before FrameLedger measures it again**, as after every update.
|
||||
|
||||
- **The component inside a game can read what the game tells its upscaler — and only when asked.** For a game
|
||||
FrameLedger injects into, and only while the agent asks for it (nothing asks yet: that is the next pull request,
|
||||
and then only with Advanced metrics on), the calls FrameLedger already intercepts are read a little further: the
|
||||
options a game hands DLSS with each evaluation (output size, presets, exposure, three switches), what it hands
|
||||
FSR with each upscale (sharpening, the jitter's size, exposure, the depth range, the field of view as a range,
|
||||
flags, the frame time it reports), and FSR's own memory when the game itself asks for it. **No new hook**, and
|
||||
with the request off the same code as before runs: a test injects into a window that sends all of it and finds
|
||||
the new memory region empty to the last byte. **Never the camera's position, its axes or its matrices** — a
|
||||
build check now refuses those names anywhere in the code loaded into a game (`tools/overlay-fields-check.ps1`).
|
||||
Many games set their DLSS options through a call that cannot be intercepted, and will show nothing here.
|
||||
Measured cost while asked: 22–23 billionths of a second per frame for FSR, 10–12 for DLSS; not measurable when
|
||||
not asked.
|
||||
- **A second session of a game that kept running starts its summaries afresh.** The ranges and counts kept inside the
|
||||
game belong to the session that asked for them: each session asks with a request of its own, and the agent reads
|
||||
only what answers it.
|
||||
|
||||
- **Advanced metrics: what the game tells DLSS and FSR, kept with the session.** With Advanced metrics on, a session
|
||||
of a game FrameLedger measures from inside now also keeps what the game itself handed to its upscaler: for DLSS the
|
||||
output size, the model preset for each quality mode, whether the game said its colour buffers are HDR,
|
||||
auto-exposure, alpha upscaling and the exposure values; for FSR the sharpening, the largest jitter offset, the
|
||||
exposure, the near and far planes, the **range** of the field of view, the flags, the frame time the game reported
|
||||
(as a chart) and FSR's own video memory at the moments the game asked. The Advanced page shows them under the
|
||||
session, in the vendor's own notation. **Many games will show nothing**, and the session says why — most games
|
||||
set their DLSS options through a call FrameLedger cannot see, and the FSR rows need FSR 3.1 or later through AMD's
|
||||
library; it never means the game uses no upscaler. **Never read:** where the camera is, which way it looks, its
|
||||
matrices. With the option off nothing more is read inside a game, exactly as before. Not yet read from a real game.
|
||||
- **Privacy Policy 2.16** names the above: what is stored, only with the option on and only for a game FrameLedger
|
||||
injects into, and what is never read. You are shown it once after updating.
|
||||
|
||||
### Changed
|
||||
|
||||
- **The agent's processor budget says what was measured.** The specification promised that the capture agent uses
|
||||
at most 1 % of one processor core while recording; nobody had measured it. Measured on the development PC it is
|
||||
1.93 % — 2.04 % with Advanced metrics on — nearly all of it the once-a-second read of the graphics card's sensors
|
||||
that every session has always made, and its memory is 113 MiB (119 with the option on) against a limit of 150.
|
||||
The owner chose to keep the readings and amend the limit: **NFR-2 is now ≤ 2.5 % of one core** (D117). Nothing the
|
||||
agent does changes.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **A crash dump is tried up to three times.** When FrameLedger or its agent stops on an error it never expected, a
|
||||
small helper writes a dump of the program for a bug report - while the program's other threads are still
|
||||
running. Windows can fail that once when the program changes under it, and one failure used to mean no dump at
|
||||
all. It is now tried again, twice, a moment apart.
|
||||
@@ -0,0 +1,41 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.41 was cut, 2026-11-12 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.41] - 2026-11-12
|
||||
|
||||
**The forty-first pre-release: one fix, for Advanced metrics with the agent as administrator.** If you run the
|
||||
capture agent as administrator with PawnIO installed and have **Advanced metrics** on, 0.1.0-beta.40 and
|
||||
0.1.0-beta.39, which has the same code and where it was not looked for, could lose sensors: after most sessions the Advanced page stopped showing the processor's readings
|
||||
until it was reopened, and now and then a whole session was stored with the graphics driver's seventeen readings
|
||||
and none of the two hundred from the sensor library. The agent was closing the sensor library in one place while
|
||||
another place was still reading it. It now opens and closes it in one place only, and never while something is
|
||||
reading. If you do not use that combination, nothing changes for you. The same unsigned installer: verify its hash
|
||||
against `SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**What it is not, yet.** The fix was made from the agent's log of ten real sessions; the fault needs an
|
||||
administrator's agent with PawnIO to show, and has not been seen to be gone on such a PC yet. After a few sessions
|
||||
the agent's log (Logs page) should no longer say *a device is left alone* or *the sensor library did not open*.
|
||||
Everything 0.1.0-beta.40's notes say is not yet done still stands.
|
||||
|
||||
**Updating from `0.1.0-beta.40`:** Help ▸ Check for updates, then *Restart to update* with no game running. No
|
||||
terms to read again, no change to the ledger (schema 23), the detection rules stay at `2026.11.2`. **The code
|
||||
FrameLedger loads into a game — the overlay, the Vulkan layer, the shared-memory layout, the injector — is
|
||||
0.1.0-beta.40's, line for line**; as after every update, a game that was running across it must be restarted
|
||||
before it is measured again.
|
||||
|
||||
**A note on numbers.** The plan for Advanced metrics had named 0.1.0-beta.41 for its next step inside the game (two
|
||||
new hooks). This fix took the number; that step is now 0.1.0-beta.42, and the ones after it move by one as well.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **Advanced metrics: the processor's sensors no longer drop out after a session, and a session no longer loses its
|
||||
sensors at the start.** With the agent running as administrator and PawnIO installed, the sensor library was being
|
||||
closed by one part of the agent while another part was still reading it. After most sessions the Advanced page
|
||||
lost the processor's readings until it was reopened, and one session in ten stored only the graphics driver's
|
||||
seventeen series instead of two hundred and twelve. The agent now opens and closes the sensor library in one
|
||||
place, and does not close it while anything is still reading. Found in the first sessions recorded that way; the
|
||||
cause was read from the log and could not be reproduced without that setup, so the next sessions will show
|
||||
whether it is gone — the agent's log should no longer say *a device is left alone* or *the sensor library did not
|
||||
open*. Nothing changes in the code loaded into a game.
|
||||
- **Two comparisons in the Advanced-metrics code say what they mean.** Whether a game gave FSR one field of view or
|
||||
a range of them was decided by comparing two decimal numbers for equality; it is now decided by comparing the two
|
||||
stored values bit for bit. Nothing you see changes. (Found by SonarCloud after 0.1.0-beta.40 was merged.)
|
||||
@@ -0,0 +1,62 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.42 was cut, 2026-11-12 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.42] - 2026-11-12
|
||||
|
||||
**The forty-second pre-release: groundwork, and a log that can answer a question.** Four changes, none of which
|
||||
adds a hook to a game. A session that saw two upscalers is now named after the one it ran — one real session had
|
||||
been stored as "DLSS" with FSR's quality mode and FSR's render size. The part of FrameLedger inside the game can no
|
||||
longer leave a hook in after it has stopped. Its log is now written during the session rather than only at the
|
||||
start and the end, so it is whole after a game that simply exits, and it says which module each hook went into and
|
||||
what kinds of call each AMD FidelityFX module received. And with **Advanced metrics** on, an FSR depth plane at
|
||||
infinity is shown as "∞" where it used to be missing. The same unsigned installer: verify its hash against
|
||||
`SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**What it is not, yet.** It does not fix a game whose upscaler reads "unknown" — Cyberpunk 2077 set to FSR is the
|
||||
one known — it makes the next session of such a game say why, in `logs\overlay-<pid>-….log`. The two new readings
|
||||
planned for Advanced metrics (the frame-generation settings a game gives FSR, and what a game tells Streamline
|
||||
about each frame) are the next pre-release, after that log has been read. No real game has been run on this
|
||||
build: the changes inside the game were tested with FrameLedger's own test program, and their cost was measured
|
||||
on the code itself (about 4 billionths of a second per FidelityFX call for the log's new lines; nothing measurable
|
||||
for the rest). Everything 0.1.0-beta.41's notes say is not yet done still stands.
|
||||
|
||||
**Updating from `0.1.0-beta.41`:** Help ▸ Check for updates, then *Restart to update* with no game running. No
|
||||
terms to read again, no change to the ledger (schema 23), the detection rules stay at `2026.11.2`. **The code
|
||||
loaded into a game changed in this release** — the first time since 0.1.0-beta.40 — so a game that was running
|
||||
during the update keeps the old part until it is started again. Sessions already stored are not rewritten: one
|
||||
that was named after the wrong upscaler keeps that name.
|
||||
|
||||
### Added
|
||||
|
||||
- **Advanced metrics: FSR's depth plane at infinity is shown as "∞".** Engines with an infinite depth range tell
|
||||
FSR that one of the two camera planes is at infinity, and FrameLedger took that value for "not set" — so a
|
||||
session's depth range showed one plane where the game had given two. The plane at infinity is now stored and
|
||||
shown as such. Only for FSR, and only while Advanced metrics is on; nothing else about what is read changed.
|
||||
|
||||
### Changed
|
||||
|
||||
- **The Overlay's log is whole after a game exits, and says more.** The log FrameLedger's part inside the game
|
||||
writes (`logs\overlay-<pid>-….log`) used to hold only the first half second of a session unless the session
|
||||
ended while the game was still running: a game that exits takes the thread that writes the log with it. It is
|
||||
now written during the session, whenever something new was noted. Each hook that went in is named by its module
|
||||
and function (four AMD modules used to be four identical lines), a hook that could not go in says why, and the
|
||||
log lists which kinds of call each AMD FidelityFX module received and which upscaling and frame-generation
|
||||
modules the game loaded, and when. This is for finding out why a game's upscaler reads "unknown" — nothing in
|
||||
it is a measurement, and nothing from it is stored in a session. Measured cost: about 4 billionths of a second
|
||||
per FidelityFX call.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **The part inside the game can no longer leave a hook in after it has stopped.** Two gaps in how the Overlay keeps
|
||||
track of its own patches, found by reading the code and not by a failure: a patch made while the table of patches
|
||||
was full would have been made anyway and never taken out, and a stop that arrived at the exact moment a hook was
|
||||
going in could miss it. A patch now takes its place in the table before it is made — no place, no patch — and is
|
||||
recorded before it can run, so the stop either removes it or the installer does. A patch that could not be made
|
||||
is written to the Overlay's log with the reason, where it used to be silent. No hook's own code changed.
|
||||
|
||||
- **A session that saw two upscalers is named after the one it ran, with that one's quality and render size.** The
|
||||
session's upscaler used to be the first one FrameLedger saw named, while the quality mode and the render size
|
||||
came from whichever frames carried them. A game that evaluated DLSS briefly and then ran FSR was stored as "DLSS"
|
||||
with FSR's quality and FSR's render size. The name is now the technology named on the most frames, the quality
|
||||
and the size are read from that technology's frames only, and such a session is marked "settings changed during
|
||||
session". What that technology did not say reads N/A rather than borrowing the other's value. Sessions already
|
||||
stored are not rewritten.
|
||||
@@ -0,0 +1,86 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.43 was cut, 2026-11-12 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.43] - 2026-11-12
|
||||
|
||||
**The forty-third pre-release: a game that was still loading is no longer lost, and two more readings inside the
|
||||
game.** Two fixes first. A game that FrameLedger looked at while it was still loading its modules could be left
|
||||
unrecorded — the session ended as a safety stop with nothing in it; FrameLedger now reads the list again before it
|
||||
gives up, and what stops a session has not changed. And an FSR upscale is counted once per frame whichever way the
|
||||
game's FidelityFX loader passes it on. Then, with **Advanced metrics** on, a session of a game measured from inside
|
||||
also keeps what the game tells NVIDIA Streamline about each frame and how it configures FSR frame generation —
|
||||
from two calls FrameLedger hooks only once Advanced metrics has been asked for in that game. The same unsigned
|
||||
installer: verify its hash against `SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**What it is not, yet.** The two new readings have been tested with FrameLedger's own test program and **have not
|
||||
been run in a real game**: this release is the first time either hook is put into one. They are what the game
|
||||
asked for, not a check of what happened, and Streamline's values are those of the first view a game draws.
|
||||
Streamline 1.x is not read. Where the game's camera is, which way it looks and its matrices are never read — they
|
||||
sit in the same data, and a check in the build refuses code that names them. The cost was measured on the code
|
||||
itself: about 20 billionths of a second per frame for Streamline's call and 15 per call for FSR's while the option
|
||||
is on, under 2 while it is off; nothing measurable for the two fixes. A game whose FSR is built in (Cyberpunk 2077's
|
||||
FSR 2.1) still reads "unknown" as its upscaler. Everything 0.1.0-beta.42's notes say is not yet done still stands.
|
||||
|
||||
**Updating from `0.1.0-beta.42`:** Help ▸ Check for updates, then *Restart to update* with no game running. **The
|
||||
terms are shown once: Privacy Policy 2.17**, which names the two new readings. No change to the ledger (schema 23),
|
||||
the detection rules stay at `2026.11.2`. **The code loaded into a game changed in this release**, so a game that
|
||||
was running during the update keeps the old part until it is started again.
|
||||
|
||||
### Added
|
||||
|
||||
- **Advanced metrics: a session now shows what the game told Streamline each frame and how it configured FSR frame
|
||||
generation.** For a game FrameLedger measures from inside, a session recorded with **Advanced metrics** on keeps
|
||||
— beside what the game told DLSS and FSR — the largest jitter offset, the motion-vector scale and how motion
|
||||
vectors are stored, the near and far planes and whether depth is inverted, the range of the field of view, the
|
||||
aspect ratio, whether the projection is orthographic and how often the game reset the upscaler's history
|
||||
(Streamline); and whether FSR frame generation was configured on, whether it may run asynchronously, its flags,
|
||||
whether only generated frames are presented, and the part of the picture it generates in. A setting the game
|
||||
changed during the session reads *on and off*. The line under the session now also says, for each of the two,
|
||||
whether it was read, hooked and never called by the game, or not hooked because the game did not load the
|
||||
library — so an empty page says which it is. These are what the game asked for, not a check of what happened;
|
||||
neither has been confirmed on a real game yet. Never read: where the camera is, which way it looks, its
|
||||
matrices.
|
||||
|
||||
- **The terms are shown once after this update: Privacy Policy 2.17.** It names the two new readings above and says
|
||||
that the two calls they come from are intercepted in a game only once a session with Advanced metrics on has
|
||||
started there. Nothing is sent anywhere, as before.
|
||||
|
||||
- **Advanced metrics, inside the game: how the game configures FSR frame generation** (the part inside the game;
|
||||
what a session shows of it comes with the same release). With **Advanced metrics** on, FrameLedger now also
|
||||
reads, from the call a game makes to configure AMD's frame generation, whether generation is on, whether it may
|
||||
run asynchronously, its flags, whether only generated frames are presented, and the part of the picture it
|
||||
generates in. Nothing else of that call is read. Like the Streamline hook, this one is put into a game only once
|
||||
Advanced metrics has been asked for. Measured cost: about 15 billionths of a second per call while the option is
|
||||
on, under 2 while it is off.
|
||||
|
||||
- **Advanced metrics, inside the game: what the game tells NVIDIA Streamline about each frame** (the part inside the
|
||||
game; what a session shows of it comes with the same release). With **Advanced metrics** on, FrameLedger now also
|
||||
reads, from a call a Streamline game makes every frame, the size of the jitter, the motion-vector scale, the depth
|
||||
range, the range of the field of view, the aspect ratio and seven on/off settings (inverted depth, how motion
|
||||
vectors are stored, whether the upscaler's history was reset). It never reads where the game's camera is, which
|
||||
way it looks, or its matrices, which sit in the same data — a check in the build refuses any code that names
|
||||
them. This is the first reading that needs a hook of its own, and that hook is put into a game only once
|
||||
Advanced metrics has been asked for: with the option off, nothing in the game is touched for it. Measured cost:
|
||||
about 20 billionths of a second per frame while the option is on, under one billionth while it is off.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **FSR upscaling is counted once per frame whichever way the game's FidelityFX loader passes it on.** Newer
|
||||
FidelityFX loaders hand a call on to the library behind them in a way that brought the same upscale to
|
||||
FrameLedger twice; with frame generation off, the count of frames the game rendered would have doubled — Native
|
||||
FPS twice too high. Seen in how Cyberpunk 2077's loader passes on its frame-generation calls; no game tested so
|
||||
far upscales through such a loader, so this is a precaution. The upscale is now counted where the game calls it,
|
||||
and nowhere else. (Owner decision D125. Measured cost: none that can be told from noise.)
|
||||
|
||||
- **A game is no longer left unrecorded because it was still loading when FrameLedger looked at it.** Before it
|
||||
hooks a game, and again right after, FrameLedger lists the modules the game has loaded and checks them against
|
||||
the anti-cheat list. A game that is starting loads and unloads modules for several seconds, and when the list
|
||||
changed in the middle of being read FrameLedger treated it as unreadable and stopped: the session ended as a
|
||||
safety stop with nothing recorded, and the game ran on unmeasured until it was restarted. It now reads the list
|
||||
again — up to three more times, a quarter of a second apart — and only stops if the list never holds still. What
|
||||
stops a session has not changed: an anti-cheat module found in any read stops it at once, a protected process
|
||||
still stops it at once, and a list that cannot be read in the end is still a stop, never a pass. (Owner decision
|
||||
D123; seen five times in one PC's logs in a week.)
|
||||
|
||||
- **A test of the Overlay's log reads its lines without `strlen`.** The helper that looks for a line in the log
|
||||
took its text as C strings and measured one with `strlen`; it takes strings now. Test code only: nothing in the
|
||||
installed software changes. (Found by SonarCloud after 0.1.0-beta.42 was merged.)
|
||||
@@ -0,0 +1,83 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.44 was cut, 2026-11-12 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.44] - 2026-11-12
|
||||
|
||||
**The forty-fourth pre-release: what the first real games on 0.1.0-beta.43 showed, fixed — and two more readings
|
||||
inside the game.** Nine sessions on five games were read the day 0.1.0-beta.43 came out. Its two new readings
|
||||
worked on four of them; three things did not read right, and are fixed first. Cyberpunk 2077 tells NVIDIA
|
||||
Streamline its field of view in degrees, and FrameLedger labelled the number as radians: a value too large to be
|
||||
radians is now shown as the game gave it, and says so. A game whose hooking had once been switched off after two
|
||||
early ends was switched off again by every single one after that: the count now starts again each time you switch
|
||||
hooking back on. And an FSR frame-generation configuration with no flag set now says *None*. Then, with
|
||||
**Advanced metrics** on, a session of a game measured from inside can also keep what Streamline answers when the
|
||||
game asks **which version a feature is and what it requires** — from two more calls FrameLedger hooks only once
|
||||
Advanced metrics has been asked for in that game. The same unsigned installer: verify its hash against
|
||||
`SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**What it is not, yet.** **Most sessions will show nothing of the two new readings.** A game asks Streamline about
|
||||
its features while it starts, and FrameLedger is usually not in the game yet; the session then says the call was
|
||||
hooked and the game did not ask again — which is the expected answer, not a fault. They have been tested with
|
||||
FrameLedger's own test program and **have not been run in a real game**: this release is the first time either
|
||||
hook is put into one. What they give is Streamline's answer as the game received it — not FrameLedger's own check
|
||||
of the PC — and never the lists that answer points to (which buffers, which Vulkan extensions). A game that faults
|
||||
while it is closing can still read *ended normally* in a session measured from inside; that is written down, not
|
||||
changed. The two Cyberpunk 2077 sessions recorded on 0.1.0-beta.43 keep the line they were stored with. The cost
|
||||
was measured on the code itself: 15 and 21 billionths of a second per call while the option is on, under 1 while
|
||||
it is off, for calls a game makes a handful of times. Everything 0.1.0-beta.43's notes say is not yet done still
|
||||
stands.
|
||||
|
||||
**Updating from `0.1.0-beta.43`:** Help ▸ Check for updates, then *Restart to update* with no game running. **The
|
||||
terms are shown once: Privacy Policy 2.18**, which names the two new readings. No change to the ledger (schema 23),
|
||||
the detection rules stay at `2026.11.2`. **The code loaded into a game changed in this release**, so a game that
|
||||
was running during the update keeps the old part until it is started again.
|
||||
|
||||
### Added
|
||||
|
||||
- **Two more calls are hooked inside a game, only where Advanced metrics was asked for** (Advanced metrics train B,
|
||||
the third step): `slGetFeatureVersion` and `slGetFeatureRequirements` of `sl.interposer.dll` — what Streamline
|
||||
answers when a game asks which version a feature is and what it requires. The original call runs first and its
|
||||
answer is read only when it succeeded: the feature's Streamline and NGX versions; the graphics APIs it supports,
|
||||
whether V-Sync must be off and hardware-accelerated GPU scheduling on, how many threads, viewports and buffers,
|
||||
and the Windows and driver versions found beside the ones required. **The lists the answer points to — the
|
||||
buffer tags, the names of Vulkan extensions and features — are never followed.** As with `slSetConstants`,
|
||||
neither patch is made in a game no session has asked, and each stays for the life of the process once made. A
|
||||
game asks these while it starts, so the two rows are the first the Overlay patches — and most sessions, attached
|
||||
later, will still not see the calls. Nothing is shown of them yet: the Agent and the App read them in the next
|
||||
pull request. No layout change (5), no schema change (23).
|
||||
|
||||
- **A session shows which version each Streamline feature is, and what it requires** (Advanced metrics). Two
|
||||
catalog entries are now read inside the game: `sl.feature.versions` and `sl.feature.requirements` — Streamline's
|
||||
answers to the two questions a game asks about a feature, in NVIDIA's own names (`kFeatureDLSS_G · versionNGX`,
|
||||
`kFeatureDLSS · driverVersionRequired`). The line under the session says for each of the two calls whether it was
|
||||
read, not hooked, or — the usual case — *hooked — the game asks this while it starts, and did not ask again after
|
||||
FrameLedger attached*. **Most sessions will show nothing here**: a game asks before FrameLedger is in it. A game
|
||||
that asks later is read then, and a second session of a game that kept running keeps what the first read. The
|
||||
Agent's end-to-end tests now run a Streamline target as well as an FSR one.
|
||||
|
||||
### Changed
|
||||
|
||||
- **Privacy Policy 2.18**: it names what Streamline answers about a feature — the features asked about, their
|
||||
versions, what each requires — and what of that answer is never read (the lists it points to: the buffers' names,
|
||||
the names of Vulkan extensions and features); "two further calls" is four. The terms window shows once after the
|
||||
update. The Disclaimer stays 2.15.
|
||||
- **Switching hooking back on starts the count of early abnormal ends again** (owner decision D126). The count was
|
||||
never set back, so a game that had once been switched off — after two ends within 60 seconds of injection — was
|
||||
switched off again by every single such end after its user switched it on, under a reason that still said
|
||||
"twice". Seen on 2026-11-12: Lies of P, two ends in October, one crash of its own that day. Two are needed again
|
||||
each time. Nothing else about the rule moves: it only switches off, an anti-cheat block is never cleared, and the
|
||||
user-mode exception's trial keeps its own record.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **A field of view a game gives in degrees is no longer labelled radians** (Advanced metrics; owner decision
|
||||
D128). Cyberpunk 2077 gives NVIDIA Streamline 51–90 where the library expects radians, and the session read
|
||||
`51.0055 – 90 rad (2922.4° – 5156.6°)`. A value too large to be radians is now shown as the game gave it, with a
|
||||
line that says it is not radians, and is not converted. Sessions recorded on 0.1.0-beta.43 keep the line they
|
||||
were stored with.
|
||||
- **An FSR frame-generation configuration with no flag set says "None"** (Advanced metrics). The row was missing,
|
||||
where an upscale with no flag has always said so.
|
||||
- **The accuracy statement and the limitations no longer say that what a game tells Streamline, and how it
|
||||
configures FSR frame generation, have not been read from a real game**: they were, on 2026-11-12 — three games
|
||||
and one. What is still unconfirmed is named: the DLSS options, and a configuration that reaches FSR through
|
||||
AMD's 2.3 loader. A fault while a game is closing, which a session measured from inside the game does not see,
|
||||
is written down as a limit (owner decision D127: not changed in this release).
|
||||
@@ -0,0 +1,80 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.45 was cut, 2026-11-12 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.45] - 2026-11-12
|
||||
|
||||
**The forty-fifth pre-release: what a game does with NVIDIA Streamline's features.** With **Advanced metrics** on,
|
||||
a session of a game measured from inside can now also keep, for each Streamline feature the game asks about or
|
||||
controls: whether Streamline says it is **supported** — in NVIDIA's own word, a refusal included — whether it is
|
||||
**loaded**, whether the game **switched it on or off** while it ran, how many times the game **allocated and
|
||||
freed** what the feature needs, and how many times it **shut Streamline down**. They come from six more calls,
|
||||
which FrameLedger hooks only once Advanced metrics has been asked for in that game. The pages that said most
|
||||
sessions would show nothing of 0.1.0-beta.44's two readings are corrected: the first real sessions read both in
|
||||
every Streamline game. The same unsigned installer: verify its hash against `SHA256SUMS.txt`, then *More info →
|
||||
Run anyway*.
|
||||
|
||||
**What it is not, yet.** The six new calls have been tested with FrameLedger's own test program and **have not
|
||||
been run in a real game**: this release is the first time any of them is patched in one, and it is six at once.
|
||||
Two of them sit on a game's way out — freeing a feature's resources, shutting Streamline down — and two of the
|
||||
games run so far already fault while closing without them; whether anything changes there is for the first real
|
||||
sessions to say. What is shown are **calls the game made after FrameLedger was in it**, counted to fifteen: not
|
||||
what the game did while it started, and not a statement that a feature ran or drew anything. **What a game
|
||||
started Streamline with is not read and will not be**: the game makes that call once, before FrameLedger can be
|
||||
inside it, and the Advanced page now says so instead of "a later release". Which graphics card a game asks about
|
||||
is never read. The cost was measured on the code itself: at most 13 billionths of a second per call while the
|
||||
option is on, under 2 while it is off, for calls a game makes a few times a second at most. A stop restores every
|
||||
patch, each taking about a sixth of a second, and a Streamline game with Advanced metrics on now has six more of
|
||||
them; the Overlay's log waits for them.
|
||||
Everything 0.1.0-beta.44's notes say is not yet done still stands.
|
||||
|
||||
**Updating from `0.1.0-beta.44`:** Help ▸ Check for updates, then *Restart to update* with no game running. **The
|
||||
terms are shown once: Privacy Policy 2.19**, which names the new readings and two things that are never read. No
|
||||
change to the ledger (schema 23), the detection rules stay at `2026.11.2`. **The code loaded into a game changed
|
||||
in this release**, so a game that was running during the update keeps the old part until it is started again.
|
||||
|
||||
### Added
|
||||
|
||||
- **Three more of Streamline's calls are hooked inside a game, only where Advanced metrics was asked for** (owner
|
||||
decisions D129–D131): `slIsFeatureSupported`, `slIsFeatureLoaded` and `slSetFeatureLoaded` — whether Streamline
|
||||
says a feature is supported (its answer, a refusal included), whether it is loaded, and the game switching a
|
||||
feature off and on while it runs. No vendor struct is read for these: the feature's id, a result code, a yes or
|
||||
no. **The adapter a game names when it asks whether a feature is supported is never read**, and the build now
|
||||
refuses code that names what identifies it. As with the four hooks before them, none of the three patches is made
|
||||
in a game no session has asked. Nothing is shown of them yet: the Agent and the App read them in a later pull
|
||||
request. No layout change (5), no schema change (23).
|
||||
- **And three more, counted only**: `slAllocateResources`, `slFreeResources` and `slShutdown` — how many times a
|
||||
game allocated and freed a feature's resources (up to fifteen each) and how many times it shut Streamline down.
|
||||
The feature's id is the only argument looked at; the two that sit on a game's way out note the call and then
|
||||
call the original, and run nothing after it. Six new calls in all in this release, each patched only where a
|
||||
session asked.
|
||||
- **`slInit` is not hooked, and will not be** (D129). A game starts Streamline once, before FrameLedger can be in
|
||||
it — also when FrameLedger starts the game itself — so a hook there would be a patch that reads nothing. The
|
||||
Advanced page's entry for what a game started Streamline with now gives that reason instead of "a later release".
|
||||
- **A session shows whether each Streamline feature is supported and loaded, and what the game did with it**
|
||||
(Advanced metrics). Two catalog entries are read from the six calls above: `sl.feature.support` — Streamline's
|
||||
answer by NVIDIA's own name (`kFeatureDLSS_G · slIsFeatureSupported` = `eOk`; a refusal is named, and it is an
|
||||
answer) and whether the feature is loaded — and `sl.feature.lifecycle` — the game switching a feature on, off or
|
||||
both, how many times it allocated and freed the feature's resources (`≥ 15` past fifteen), and how many times it
|
||||
shut Streamline down. The line under the session names the six calls in one sentence: read; hooked, the game did
|
||||
not make the call; not hooked. They begin when FrameLedger is in the game — what a game did while it started is
|
||||
not there — and they are calls the game made, not a statement that a feature ran. Not confirmed on a real game.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **A stop that restores many patches no longer leaves its last lines out of the Overlay's log.** Restoring a patch
|
||||
takes about 160 ms, and the wait for the stop's log lines was two seconds whatever the number of patches: with
|
||||
fifteen the log ended "the stop was still writing". The patches were restored; the log did not say so. The wait
|
||||
is now sized to the number of patches a game can hold.
|
||||
|
||||
### Changed
|
||||
|
||||
- **Privacy Policy 2.19**: it names, for each Streamline feature a game asks about or controls, whether Streamline
|
||||
says it is supported and loaded, the game switching it on or off, and how many times its resources were allocated
|
||||
and freed, and how many times the game shut Streamline down — and two more things that are never read: what
|
||||
identifies the graphics card a game hands over with its question, and the content of a graphics resource. "Four
|
||||
further calls" is ten. The terms window shows once after the update. The Disclaimer stays 2.15.
|
||||
- **The limitations, the accuracy statement and the user guide no longer say that most sessions will show nothing
|
||||
of what Streamline answers about a feature.** 0.1.0-beta.44's notes expected that, because a game asks while it
|
||||
starts. The first real sessions (2026-11-12, five games) read both answers in every Streamline session: the
|
||||
Unreal Engine games ask again later. The pages now say what was seen — and two things the readings showed: the
|
||||
version Streamline gives for a feature can be newer than the file in the game's folder, and a game that does not
|
||||
upscale through Streamline lists frame generation there and no upscaler. No code changes.
|
||||
@@ -0,0 +1,90 @@
|
||||
# HANDOFF history — 0.1.0-beta.34
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` when 0.1.0-beta.35 was cut, 2026-11-09 (owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" mean HANDOFF.md as it stood.*
|
||||
|
||||
## **START HERE** — 2026-11-06, 0.1.0-beta.34: DLSS 5 and DLSS 4.5 from what the game and the driver did; filters; Games at once
|
||||
|
||||
*Status is `docs/changelog/0.1.0-beta.34.md`; this is what no other file carries.* The owner asked for seven things, the
|
||||
usual train: (1) how DLSS 5 Neural Rendering is detected on Hogwarts Legacy (Neural Rendering on in the game), and its
|
||||
version; (2) under the NVIDIA App's *Dynamic* multi frame generation the label read DLSS 4, though Dynamic and ×6 exist
|
||||
only in DLSS 4.5 (Phantom Blade Zero); (3) filters on Games and Compare; (4) the Compare page's layout, from a
|
||||
screenshot; (5) the documents and the tested-games list, from the database; (6) switching to Games stalled 0.5–1.5 s;
|
||||
(7) a language change landed on the last content page instead of Settings. And while planning: "Bạn check Streamline các
|
||||
bản gần đây có gì thay đổi và sửa luôn nếu thật sự cần nhé." — check what changed in recent Streamline versions and fix it
|
||||
if really needed. #356 (two fixes from a self-review of #351 and #352), #357 (D83), #358 (D84, Streamline `v2.14.16`),
|
||||
#359 (items 6 and 7), #360 (items 3 and 4, D85, D86), #361 (item 5) and this release; `0.1.0-alpha.3` follows (D87) —
|
||||
the owner's screenshot is of an alpha, so the alpha is how these reach the owner's PC.
|
||||
|
||||
**Decisions (asked while planning, do not re-ask):**
|
||||
|
||||
- **D83 — Dynamic frame generation is DLSS 4.5's**: the owner's rule, "Dynamic and ×6 exist only in DLSS 4.5". The
|
||||
evidence is the game's driver profile setting Dynamic (`NGX_DLSSG_MODE` = 4) **and** the driver reporting its
|
||||
frame-generation override applied in the game's process (`FG_MODE` in its FG word), in a session where DLSS
|
||||
Frame Generation was identified (`fg_mode = dlssg`; its factor need not have been counted); a state measured at ×5 or more still ranks first, and a *Fixed* multiplier names nothing by itself
|
||||
(amends D64). The driver's `frameGenerationMode` — 3 under Dynamic and 1 under Fixed in every session read, and unnamed
|
||||
by NVIDIA — is recorded in `spike-notes` §26, not keyed on.
|
||||
- **D84 — DLSS 5 is the session's generation where its neural rendering was measured running**: the Overlay decodes
|
||||
`kFeatureDLSS_NR` in its `slEvaluateFeature` detour and the Agent keeps its share of the Streamline batches
|
||||
(`sessions.dlss_nr_pct`, schema 0022) — *DLSS 5 (neural rendering on N % of rendered frames)*; loaded and seen not
|
||||
running, *runtime loaded, not seen running*; where nothing could tell, *runtime loaded*, as before (amends D64).
|
||||
- **D85 — the filters**: Games — store, engine, state, installed, played; Compare — game, tier, frame generation, no
|
||||
period; Compare lists every session (it listed the newest 200).
|
||||
- **D86 — the left pane's selected item keeps its label**: our copy of WPF UI 4.3.0's LeftFluent item template, whose
|
||||
`IsActive` trigger animated it away.
|
||||
- **D87 — alpha.3 right after beta.34**, on RC3: the train reaches it before .NET 11's release on 2026-11-10.
|
||||
|
||||
Streamline was re-vendored at `v2.14.16` on the owner's instruction above, not as a decision of its own. The wording of
|
||||
the Disclaimer 2.13 and the Privacy Policy 2.14, and the tested-games list (D35), were approved with the plan (D36).
|
||||
|
||||
**Choices made here:**
|
||||
|
||||
- **Neural rendering's share is over the Streamline batches**, not every present: a generated frame evaluates nothing,
|
||||
and a title that never drains a batch reads *nothing could tell* (null), never 0 %.
|
||||
- **A writer older than beta.34 is told apart by its family bit**, `FL_HOOK_SL_NEURAL_RENDERING` (bit 12), published with
|
||||
the detour — an old Overlay's silence leaves `dlss_nr_pct` null instead of a measured 0 %; no layout change.
|
||||
- **The Games page is the window's**, kept by our own page provider (`WindowPageCache`), not `NavigationCacheMode`: WPF UI
|
||||
4.3.0 reads that only when neither a service provider nor a page provider is set, and `SetNavigationControl` sets one
|
||||
(`16_WPFUI_SYNTAX` §Navigation). One per window, so a language change's window builds its own.
|
||||
- **The cards come before the executable checks** — 39 of the owner's 41 Steam games are on a USB drive that sleeps — and
|
||||
each card gets its *Not installed* pill when its check answers.
|
||||
- **The pane's item template is a copy changed in one place**, reading WPF UI's own `NavigationViewConstants.xaml`: before
|
||||
the WPF UI pin moves, the upstream template is read again.
|
||||
|
||||
**Measured on the way:** the owner's DLSS sessions of 2026-11-01 → 11-06, the driver's frame-generation numbering and
|
||||
Streamline's `v2.12.0` → `v2.14.16` changes are `spike-notes` §26 (the ledger read read-only; the vendored copy was
|
||||
`v2.12.0` byte for byte); the Games page before and after is §27 (first cards 822–830 ms → 10–15 ms with the first
|
||||
executable check held 800 ms; a revisit 181–215 ms → 15–16 ms). The neural-rendering decode costs nothing measurable in
|
||||
the detour and 0.14–0.19 ns on the present's feature byte (#358's body; NFR-1's budget is 1 µs per present).
|
||||
|
||||
**Traps met on the way:**
|
||||
|
||||
- **`notice-check` reads the tracked tree**: a file deleted from the working tree but not from the index fails it with
|
||||
*Could not find file* — after every build and test had passed (#360's first local gate). Stage the change
|
||||
(`git add -A`) before the gate.
|
||||
- **A new hook family bit belongs in the native token test's exact mask** (`guard_test.cpp`), and a new Streamline fact
|
||||
in the 0xF00D case's list of facts it must not light — #358's first gate (`0x100f` against `15`).
|
||||
- **WPF UI 4.3.0**: `NavigationCacheMode` is ignored once a page provider is set; `INavigationService.SetNavigationControl`
|
||||
hands the NavigationView the container's provider, so ours is set after it; LeftFluent's item template collapses the
|
||||
selected item's label.
|
||||
- **Microsoft.Data.Sqlite's async methods run synchronously**: a read awaited on the UI thread blocks it — `Task.Run` it.
|
||||
|
||||
**Owner-only:** item 30 — beta.34 on real hardware.
|
||||
|
||||
### 0.1.0-alpha.3 — the third alpha, the same day (D87)
|
||||
|
||||
`alpha` takes main at this pull request — `v0.1.0-beta.34` and these notes, no other change — by a merge commit, as
|
||||
`13_CI_CD` §The alpha line says. One file the switch holds moved on main — `legal/THIRD_PARTY_NOTICES.md`, its
|
||||
Streamline row (#358) — on a line the switch does not touch (the switch changes the *Transitive* row), so the merge
|
||||
takes both without a conflict (`git merge-tree` before the pull request); main's package set did not move, and the
|
||||
switch stays the first alpha's (SDK `11.0.100-rc.3.26522.148`, the three packages at `11.0.0-rc.3.26522.148`, the same
|
||||
NuGet licence texts) — the train reached it before .NET 11's release. Its gate on the 11 SDK must pass before the pull
|
||||
request into `alpha` is merged by
|
||||
hand (the branch has no auto-merge); the release runs from the signed tag `v0.1.0-alpha.3` on `alpha`, with its delta
|
||||
from alpha.2. Its notes are `docs/changelog/0.1.0-alpha.3.md`, which open with the experimental-build warning. It is
|
||||
the first alpha whose ledger moves (schema 22): the copy it makes first is the database as alpha.2 left it, and going
|
||||
back is to the newest beta, which opens schema 22.
|
||||
|
||||
- **The next alpha moves to .NET 11's release**: from 2026-11-10 the switch is SDK `11.0.100` and the packages `11.0.0`,
|
||||
and RC3 is out of support — move the alpha even if no beta comes.
|
||||
|
||||
**Owner-only:** item 31 — the third alpha on real hardware.
|
||||
@@ -0,0 +1,74 @@
|
||||
# HANDOFF history — 0.1.0-beta.35
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` when 0.1.0-beta.36 was cut, 2026-11-10 (owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" mean HANDOFF.md as it stood then.*
|
||||
|
||||
## **START HERE** — 2026-11-09, 0.1.0-beta.35: accessibility — a statement, what a screen reader is given and told, headings and charts, contrast themes, focus
|
||||
|
||||
*Status is `docs/changelog/0.1.0-beta.35.md`; this is what no other file carries.* The owner: "Bạn lên plan và thêm
|
||||
phiên bản mới (nếu thực sự cần) cho mục accessibility: 1. đọc docs, check, sync và sửa, cập nhật thêm file
|
||||
ACCESSIBILITY.md vào đúng vị trí. 2. Check các Accessibility đã có, đề xuất thêm accessibility nếu cần. 3. Đã dùng: bàn
|
||||
phím only (tắt chuột) và narrators, không lỗi." — plan accessibility, with a new version if it is really needed: read,
|
||||
check, sync and fix the documents and add `ACCESSIBILITY.md` where it belongs; check what exists and propose more; the
|
||||
owner had used the keyboard alone, mouse disconnected, and Narrator, with no fault. With opensource.guide's
|
||||
accessibility practices and the open-source-accessibility toolkit's `ACCESSIBILITY.md` template (MIT: its structure,
|
||||
not its text). #366 (the statement, D88), #367 (names and peers), #368 (announcements, D89), #369 (headings and charts,
|
||||
D90), #370 (contrast themes, D91, and three contrast holes outside them), #371 (focus and motion) and this release; no alpha (D92).
|
||||
|
||||
**Decisions (asked while planning, do not re-ask):**
|
||||
|
||||
- **D88 — the accessibility statement**: `ACCESSIBILITY.md` at the repository's root, in the App under Help ▸
|
||||
Accessibility and on the wiki. WCAG 2.2 at level AA, as W3C's WCAG2ICT applies it to desktop software, is a goal and
|
||||
never a claim; a report is handled by severity, with no promised times; 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 — is its first evidence by hand.
|
||||
- **D89 — what appears is said to a screen reader**: UI Automation notifications for a safety notice, the agent's and
|
||||
the update's banners, every snackbar, a game page's notice and Database maintenance's results, only while
|
||||
FrameLedger's window is the active one.
|
||||
- **D90 — headings and charts**: a page's title is a heading of level 1, a section's title level 2; every chart is
|
||||
named with where its numbers are written; no chart tells two series apart by colour alone.
|
||||
- **D91 — Windows contrast themes are followed**, whatever Settings ▸ Theme says.
|
||||
- **D92 — beta.35 in this train and no alpha**; alpha.4 is the move to .NET 11's release (SDK `11.0.100`, packages
|
||||
`11.0.0`), a task of its own after 2026-11-10.
|
||||
|
||||
**Choices made here:**
|
||||
|
||||
- **A contrast theme is the user's colours by role**, not WPF UI's high-contrast files (84 red placeholders among 97
|
||||
colours, 17 brushes that throw, Windows 11's defaults) and not a hand list of keys: every key of the four files takes
|
||||
the colour of the role it has in all of them, opaque colours only (`ContrastRoles`), over the light or the dark Fluent
|
||||
theme as the contrast theme is; the text on the accent is the highlight's text, the App's choice.
|
||||
- **What must change while it is shown binds `ContrastTheme.IsOn`**, a static property WPF hears through
|
||||
`StaticPropertyChanged`: the implicit button style, the Settings line. The charts, the badges and the artwork band read
|
||||
`ContrastTheme.Active` when they draw.
|
||||
- **The snackbars lost their green and orange** (white on fixed colours, 2.16–2.78:1 in both themes): every message is
|
||||
Secondary, its icon saying the kind. **The agent's pill is a `Pill` on the theme's fills**, no longer a badge.
|
||||
- **A content dialog's focus is WPF UI's**: its host stores and restores the focused element; a test pins it. Message
|
||||
boxes get the App's active window as owner (`MessageBoxes`), which WPF UI's leaves null.
|
||||
- **A page shortcut focuses the page's first control and says its first level-1 heading** (`PageFocus`); a click in the
|
||||
pane leaves the focus where WPF UI puts it.
|
||||
- **Left as limitations, with what to do instead** (`ACCESSIBILITY.md` §Known limitations): a chart's points one by
|
||||
one, headings inside the documents the App shows (a FlowDocument paragraph has no peer), the snackbars' four seconds,
|
||||
Windows' text size, pausing only from the tray.
|
||||
|
||||
**Measured on the way:** the UI Automation tree WPF builds, on .NET 10.0.14 — items named by `ToString()`, peerless
|
||||
focusable controls, a template's text hidden from the control view, template cells read as *Item: …* (`16_WPFUI_SYNTAX`
|
||||
§Gotchas); WPF UI 4.3.0's high-contrast files, its Button, Badge and Snackbar appearances (fixed colours, the ratios
|
||||
above), its message box's missing owner and its content dialog host's focus restore; ScottPlot 5.1.59's keys (focusable,
|
||||
none marked handled) and its double-click benchmark.
|
||||
|
||||
**Traps met on the way:**
|
||||
|
||||
- **A `ContentDialog` test needs the dispatcher's context.** `ContentDialog.ShowAsync` takes the dialog out of its host
|
||||
in a `finally` after an await; on a test thread with no `DispatcherSynchronizationContext` that never resumes on the UI
|
||||
thread, the dialog stays in its host and the focus on its button — a first measurement concluded WPF UI kept the focus
|
||||
there; it does not.
|
||||
- **A test that listens to a static event hears every test's**: subscribe inside the one STA work item.
|
||||
- **Inside the App, a brush that throws when WPF UI's file is read alone falls back to the application's resources**, the
|
||||
Fluent theme's translucent fills: `MenuBarItemBackgroundPressed` read as the window text's white. Count only opaque
|
||||
colours as evidence.
|
||||
- **WPF calls a resource reference's callback when a merged dictionary changes, even for an equal value** (Aquatic's
|
||||
window is the dark theme's `#202020`): no second signal was needed, measured and pinned.
|
||||
- **A forward `StaticResource` in a style dictionary fails only when that resource is first used** — `AgentPill`
|
||||
`BasedOn` `Pill`, placed above it: the dictionary loaded, the style threw when found.
|
||||
- **Python's `"\b"` in a non-raw string is a backspace** — it went into a C# regex twice; write regexes raw.
|
||||
- **`RenderTargetBitmap.Render(child)` draws the child at its offset**: sample a child's pixel through its parent.
|
||||
|
||||
**Owner-only:** item 32 — beta.35 on real hardware.
|
||||
@@ -0,0 +1,79 @@
|
||||
# HANDOFF history — 0.1.0-beta.36
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` when 0.1.0-beta.37 was cut, 2026-11-11 (owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" mean HANDOFF.md as it stood then.*
|
||||
|
||||
## **START HERE** — 2026-11-10, 0.1.0-beta.36: Qodana in CI, and what its first run reported settled
|
||||
|
||||
*Status is `docs/changelog/0.1.0-beta.36.md`; this is what no other file carries.* The owner: "Bạn có thể thêm vào,
|
||||
trigger Qodana vào CI/CD và sửa lỗi, release (nếu có) với mẫu mà jetbrains cung cấp, có thể tuỳ biến (nếu cần)" — add
|
||||
Qodana to CI from the workflow JetBrains gives (the Qodana Scan action on `ubuntu-latest`, `pr-mode: false`,
|
||||
`QODANA_TOKEN`), changed where needed, fix what it reports, release if there is something to release; the usual train.
|
||||
The owner had made the project on Qodana Cloud and set the `QODANA_TOKEN` secret the same day. #373 (the workflow, the
|
||||
settings, the fixes and the documents, D93) and this release; no alpha (D92 stands: alpha.4 is the move to .NET 11's
|
||||
release).
|
||||
|
||||
**Decisions (asked while planning, do not re-ask):**
|
||||
|
||||
- **D93 — Qodana Community for .NET, from a workflow of its own.** Asked which licence the Qodana Cloud organisation
|
||||
holds — it decides the linter — the owner answered "Dùng thử 30 ngày", a 30-day trial. So not the Rider-based linter
|
||||
(Ultimate; the job would turn red when the trial ends) but the Community one, which runs under every licence. A gate
|
||||
of zero problems, advisory; `docs/13_CI_CD.md` §Qodana.
|
||||
|
||||
**Choices made here:**
|
||||
|
||||
- **An inspection is switched off in `.editorconfig`, never in `qodana.yaml`**: InspectCode reads its severities there
|
||||
and so does Rider, so the job and the editor show one list, and a change to it is tested on a developer's PC without
|
||||
CI. Sixty-three keys, each with its reason; the rule is CLAUDE.md §Coding conventions'.
|
||||
- **What Qodana reports is fixed unless the inspection argues with a choice the project made.** The suggestions
|
||||
(ReSharper's lowest reported level) that propose another style are off as a group: the style is `.editorconfig`,
|
||||
`dotnet format` and the analyzers.
|
||||
- **The members nothing in the solution uses were listed, not removed** (`13_CI_CD` §Qodana): whether each is
|
||||
vocabulary, a piece not wired yet, or dead is the owner's to say (owner-only item 33).
|
||||
- **One pull request, the gate shown red first**: the settings and the gate were pushed before the fixes, so the run
|
||||
between them (42847369329) is the gate failing on the 409 problems the settings did not cover.
|
||||
- **A release although nothing a user sees changes**: the fixes are in the shipped assemblies, so the version says
|
||||
which code is installed; the changelog says in its first line that nothing visible moved.
|
||||
- **The XAML bindings were re-pointed, not only annotated**: `{Binding DataContext.ViewModel.X, RelativeSource
|
||||
AncestorType=Page}` became `{Binding ViewModel.X, RelativeSource AncestorType={x:Type pages:GamesPage}}` — the same
|
||||
object, since each page and window sets `DataContext = this` (read in the five code-behinds) — because the inspection
|
||||
resolves a typed ancestor and not `DataContext`.
|
||||
|
||||
**Measured on the way:** the Community linter's container builds and loads all thirteen `net10.0-windows` projects on
|
||||
Linux once `EnableWindowsTargeting` is set, though JetBrains' page sends such projects to the Ultimate linter's native
|
||||
mode; a clean worktree with no native DLLs builds with 15 warnings and no error; InspectCode 2026.2.3.1 on Windows and
|
||||
in the container agree to within a handful of findings; `.editorconfig`'s `resharper_*` keys are read in the container.
|
||||
|
||||
**Traps met on the way:**
|
||||
|
||||
- **InspectCode on the owner's PC picks Visual Studio 18 Insiders' MSBuild and dies** ("No files to inspect were
|
||||
found"): pass `--toolset-path` to the .NET SDK's `MSBuild.dll` and `--dotnetcore`. And **a `--caches-home` a failed
|
||||
run wrote leaves a project unloaded** on the next run — 2,875 false compile errors in `Infrastructure.Tests`, and
|
||||
hundreds of false "never used" — use a fresh folder.
|
||||
- **A fix scripted from the report's positions needs the build as its judge**: a redundant tuple name's region stops
|
||||
before its colon; two casts in one lambda (`SqliteGameMerge`) are each redundant alone and not together; a suggested
|
||||
`m[^1]` sat in an expression tree (CS8790); `public bool On => false` on a bound row is CA1822.
|
||||
- **`dotnet format style --diagnostics IDE0008 IDE0022 --severity info`** applies `.editorconfig`'s suggestion-level
|
||||
style, which the gate's `--verify-no-changes` (warnings and up) never asks for.
|
||||
- **`CrashDumpHelperTests.TheWriterHasTheAgentDumpThisProcessFromOutside` failed once on the hosted runner** (#373's
|
||||
first run, two YAML files changed): "the dumper did not finish within 30 s". Green on the next runs; not looked into.
|
||||
- **SonarCloud's gate failed on #373, on one condition: coverage on new code, 77 %** — 19 of the 87 changed lines it
|
||||
counts were old lines no test ever ran (the update prompts, `App.xaml.cs`, chart code-behind), and a line a fix
|
||||
touches is new code. No issue, no hotspot; the job is advisory and #373 merged on its required checks. `main`'s new
|
||||
code is "since the previous version", so its gate reads the same until the first analysis after the tag — which
|
||||
was the release commit's own (its `sonarcloud` job started after the tag was pushed, read version 0.1.0-beta.36 and
|
||||
passed); had the tag come later, a `workflow_dispatch` of `ci.yml` on `main` would have been that analysis.
|
||||
- **A release's delta says what the notes forgot**: read "Delta processed … patched" in the tag's log before
|
||||
calling a release verified — 343 patched files was the runtime, which no line of the notes named.
|
||||
- **A shell `cd` in a tool call stays** for the next one: use absolute paths.
|
||||
|
||||
**The release (the tag, 2026-11-10):** `v0.1.0-beta.36` on `deaa8f3`, a rehearsal of `release.yml` first (run
|
||||
42853812423, on the release branch), the tag's run 42856948658 green; the seven digests of `SHA256SUMS.txt` are
|
||||
GitHub's; the wiki published. **The package carries the .NET runtime 10.0.15, not beta.35's 10.0.14**: the hosted
|
||||
runner installed SDK 10.0.404 that day, 10.0.403 the day before (`global.json` rolls forward within 10.0), so the delta patched 343
|
||||
of 456 files (5,756,432 bytes) where a release with these changes alone would have patched a few dozen. The notes at
|
||||
the tag did not say so; the changelog file and the release's text were corrected the same day, marked. Still open
|
||||
from it: the 10.0.15 servicing packages (`Microsoft.Extensions.Hosting`, `Microsoft.Data.Sqlite`,
|
||||
`System.Diagnostics.EventLog` are at 10.0.14) — Dependabot's cooldown holds them a week. `main` after the tag: `check`
|
||||
green, Qodana 0 problems, SonarCloud's gate OK again (its first analysis with version 0.1.0-beta.36).
|
||||
|
||||
**Owner-only:** item 33 — Qodana's settings on the owner's side, the never-used list, and beta.36 on real hardware.
|
||||
@@ -0,0 +1,205 @@
|
||||
# HANDOFF history — 0.1.0-beta.37
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` when 0.1.0-beta.38 was cut, 2026-11-11 (owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" mean HANDOFF.md as it stood then.*
|
||||
|
||||
## **START HERE** — 2026-11-11, 0.1.0-beta.37: the main line on .NET 11, what an alpha is now, and why no C# 15 yet
|
||||
|
||||
*Status is `docs/changelog/0.1.0-beta.37.md`; this is what no other file carries.* The owner, with two screenshots — a
|
||||
Qodana Ultimate licence in the JetBrains console, and the Qodana Cloud project's setup page: "Bạn có thể bắt đầu với phiên
|
||||
cải tiến cho .net 11 và set up cho qodana cho tất cả ngôn ngữ (gói ultimate) nhé." The session D92 had left for after
|
||||
.NET 11's release (2026-11-10), and Qodana for every language on the Ultimate licence. One plan, approved whole, in
|
||||
three parts: **beta.37** (#376 the move, #379 what an alpha is, #380 .NET 11's API and the C# 15 finding, and this
|
||||
release) → **alpha.4** → **Qodana Ultimate in two reports**. This section is the first part; the other two follow it on
|
||||
`main` the same way.
|
||||
|
||||
**Decisions (asked while planning, do not re-ask):**
|
||||
|
||||
- **D94 — the main line moves to .NET 11 now.** Asked whether the betas move or only alpha.4 — with
|
||||
`20_OPEN_QUESTIONS` §G's table quoted: two alphas on the released runtime and an owner's run of a hooked title first —
|
||||
the owner chose "Chuyển main sang .NET 11 ngay". Condition (a) of that table was **set aside, not met**;
|
||||
`12_BUILD` §The main line's .NET says what stood in for it, and owner-only item 34 is the run it asked for.
|
||||
- **D95 — Windows 10 22H2 is not blocked, and is stated as untested and unsupported** ("Vẫn chạy, ghi rõ không được hỗ
|
||||
trợ"). NFR-8 is amended; a processor needs SSE4.2 and POPCNT.
|
||||
- **D96 — C# 15 in the same release** ("Áp dụng cả C# 15 ngay trong beta.37"). The plan narrowed it in writing, and was
|
||||
approved with that: a construct only where the build, CodeQL and Qodana all read it.
|
||||
- **D97 — all three legal texts reworded** ("Sửa cả ba văn bản"): EULA 1.7, Disclaimer 2.14, Alpha notice 1.1. Their
|
||||
text was in the plan and approved with it.
|
||||
- **D98 — alpha.4, then the alpha line rests** until a newer .NET has a preview ("alpha.4 rồi nghỉ tới .NET 12
|
||||
Preview").
|
||||
- **The order**: beta.37 → alpha.4 first, Qodana after; and Qodana in **two reports from the start** (the third part's
|
||||
decision, D99).
|
||||
|
||||
**Choices made here:**
|
||||
|
||||
- **No C# 15 construct is used, although the owner asked for them.** The rule decided it, not a preference:
|
||||
ReSharper's engine, which Qodana runs, reads none of the four (`13_CI_CD` §C# 15 and the analyses, `spike-notes`
|
||||
§29). Unions would not have been the form in any case — the SDK's own CA1815 asks every union to hand-write its
|
||||
equality, and the shapes that wanted one are closed record hierarchies. What the release takes is API.
|
||||
- **.NET 11's `IHost.RunAsync` is accepted, not wrapped**: a failed background service now ends the Agent through its
|
||||
crash report. A catch there would hide a fault, and could not reproduce .NET 10's exit exactly either.
|
||||
- **A resting alpha says so in the build, not only in its notes**: the anti-cheat list reaches a user only inside a
|
||||
release, so an alpha nobody updates carries an ageing one. `FlAlphaLineRests` is stamped on both lines; the `alpha`
|
||||
branch sets it to false when it next tries a .NET.
|
||||
- **"A prerelease .NET" is said only by a build that runs on one**, read from the runtime's own description — the next
|
||||
preview alpha says it again with no change to the code.
|
||||
- **`release.yml` names the .NET 10 runtime `vpk` needs**, rather than relying on the hosted image carrying one.
|
||||
- **The Community Qodana job was kept alive across the move** by installing the SDK into its container — an interim;
|
||||
the Ultimate linter replaces the job in the third part.
|
||||
- **The 2026-10-31 forms stay where they read as well** (`json.AsSpan().TrimStart().StartsWith('[')` avoids a string):
|
||||
.NET 11's `char` overloads replaced a span only where the span was there for .NET 10's sake.
|
||||
|
||||
**Measured on the way** (`spike-notes` §28 and §29): the gate on SDK 11.0.100 — two analyzer sites beyond RC3's
|
||||
twenty-one, both in tests written after the last alpha; `IHost.RunAsync` rethrowing, observed for the first time; the
|
||||
first delta across two runtime majors (372 of 443 files patched, 72.6 MB on the rehearsal); `main`'s first full CodeQL
|
||||
C# analysis on `net11.0` (1,221 of 1,221 files, the same 23 unresolved `Windows.Win32` types as on .NET 10); the
|
||||
SonarScanner 12.0.0 on the 11.0 runtime; InspectCode 2026.2.3.1 and 2026.3.0 against each C# 15 construct.
|
||||
|
||||
**Traps met on the way:**
|
||||
|
||||
- **A pull request's CodeQL C# run is an overlay analysis**: it extracts the changed files on top of `main`'s cached
|
||||
database, and its "scanned N out of N" is `main`'s baseline. #376 wrote "CodeQL reads `net11.0` whole" from one and
|
||||
was corrected, dated, two pull requests later with `main`'s own run. For anything the extractor has not met, dispatch
|
||||
`codeql.yml` on the branch (it takes `workflow_dispatch` since #380).
|
||||
- **`ShmDrainIntegrationTests.TheGuardInjectsTheOverlayAndTheReaderDrainsRealFrames` failed once on the dev box** —
|
||||
"our own harness must not start matching the blocklist mid-run": the guard's re-scan refused the harness in one gate
|
||||
run of five. The class passed three times in a row straight after and no guard code had changed; not looked into.
|
||||
- **A wiki page names no version** (`wiki-check`): "since 0.1.0-alpha.4" in `wiki/Releasing.md` was red. The guide's
|
||||
pages may.
|
||||
- **The runner queue**: with three workflows per pull request and a probe's pull request open beside the train,
|
||||
`check` waited about 25 minutes for a runner. Cancel a probe's runs once it has told what it can.
|
||||
- **A Bash heredoc halves the backslashes** of an inline Python regex — write the script with the Write tool.
|
||||
- **`x.Should().NotBeNull(); x!.Member`**: ReSharper reads the `!` as redundant (Qodana's one finding on #376) and the
|
||||
compiler wants it. Keep the value the assertion needs, not the object.
|
||||
- **CA2025** on a lambda that captures a `using` variable in a test: await inside a `try`, assert after.
|
||||
- **A local gate reseeds `%LOCALAPPDATA%\FrameLedger\rules`** while the owner's installed copy runs beside it: the
|
||||
files were hashed before and after every gate (identical each time — the repository's rules were the installed ones).
|
||||
|
||||
**The release (the tag, 2026-11-11).** Rehearsed first (`release.yml` dispatched on the release branch, run
|
||||
42926539241), then the signed tag `v0.1.0-beta.37` on `1a7fbf3`: run 42930394186, published 2026-11-11T00:36:54Z.
|
||||
Eight assets, the seven listed in `SHA256SUMS.txt` equal to the digests GitHub computed; `FL_BUILD_ID v0.1.0-beta.37`
|
||||
in the shipped natives. The delta across two major runtimes exists — the stop condition the plan had named: "Delta
|
||||
processed 0443 files. 0373 patched, 0070 unchanged, 0009 new, 0017 removed", 72,681,960 bytes beside a full package of
|
||||
110,325,368. The wiki was published by its own run (42932792575).
|
||||
|
||||
**Owner-only:** item 34 — beta.37 on real hardware, a hooked session on .NET 11.0.0, and Windows 10 if a PC with it is
|
||||
at hand.
|
||||
|
||||
### 0.1.0-alpha.4 — the fourth alpha, the same day, and the last for now (D98)
|
||||
|
||||
`alpha` takes main at this pull request — `v0.1.0-beta.37` and these notes, no other change — by a merge commit. **This
|
||||
sync is not like the three before it**: main now holds what the switch held (`global.json`, the TFM, the three
|
||||
packages, `legal/licenses/nuget/`, the *Transitive* row), so every switch file conflicts, and each is resolved by
|
||||
taking main's — the branch's RC3 lines go, `RELEASE_LINE` stays `alpha`, and `git diff --name-only origin/main` on the
|
||||
merged tree must print that one name. Its gate must pass on `alpha` before the pull request is merged by hand (the
|
||||
branch has no auto-merge); the release runs from the signed tag `v0.1.0-alpha.4` on `alpha`, with its delta from
|
||||
alpha.3. Its notes are `docs/changelog/0.1.0-alpha.4.md`: the warning, and that it is the last alpha for now.
|
||||
|
||||
- **After it the line rests** (`12_BUILD` §The alpha line): no sync follows a beta and no alpha is cut until a newer
|
||||
.NET has a preview. `FlAlphaLineRests` in `Directory.Build.props` says so to the build; the next trial sets it to
|
||||
`false` on `alpha` with the rest of the switch.
|
||||
- **What a resting alpha costs its user** is in its notes, the guide and its banner: no update, the anti-cheat list
|
||||
included; and once ten betas have followed it, a copy of alpha.3 or older no longer finds alpha.4 (Velopack reads
|
||||
the newest ten releases).
|
||||
|
||||
**The sync and the release (2026-11-11).** #382 put the notes on main (`428b723`); #383 merged main into `alpha` by
|
||||
hand (`134115b`): twenty-seven conflicts, every one resolved to main's side, and `git diff --name-only origin/main
|
||||
origin/alpha` prints `RELEASE_LINE` alone. Rehearsed on `alpha` (run 42933603983: channel `alpha`, a delta from
|
||||
alpha.3), then the signed tag `v0.1.0-alpha.4`: run 42935876535, published 2026-11-11T01:16:22Z as *FrameLedger
|
||||
0.1.0-alpha.4 (experimental alpha)*, a pre-release. Eight assets, seven of seven digests equal; "Delta processed 0448
|
||||
files. 0369 patched, 0079 unchanged, 0004 new, 0005 removed", 18,207,557 bytes; `FrameLedger.App-alpha-Setup.exe`,
|
||||
`releases.alpha.json`; the wiki run skipped, as it does for an alpha.
|
||||
|
||||
- **One tag push started two release runs** (42935876535 and 42935878584, both `push`, created in the same second;
|
||||
the tag was pushed once). `release.yml`'s concurrency group made the second wait for the first, and it then began
|
||||
the whole build again. It was cancelled once the first had published: it could only have ended red, at
|
||||
`gh release create` on a release that existed. If a tag ever shows two runs, let the first finish, verify the
|
||||
release, then cancel the other.
|
||||
|
||||
**Owner-only:** item 35 — the fourth alpha on real hardware, and the beta installed over it.
|
||||
|
||||
|
||||
### Qodana for .NET on the Ultimate licence — the managed report (D99, D100)
|
||||
|
||||
*Status is `docs/13_CI_CD.md` §Qodana and `CHANGELOG.md`; this is what no other file carries.* The third part of the
|
||||
plan, in two pull requests: this one moves the existing job to Qodana for .NET (Rider's engine, native on a Windows
|
||||
runner) and settles what it reports over the managed code; the next adds the C++ as a second report.
|
||||
|
||||
**Decisions:**
|
||||
|
||||
- **D99 — two reports from the start** ("Hai báo cáo ngay từ đầu"). The owner made a second Qodana Cloud project,
|
||||
`frameledger-cpp`, and the secret `QODANA_TOKEN_NATIVE`; the managed report goes to `frameledger` with
|
||||
`QODANA_TOKEN`. Both secrets are the owner's; no token was ever read or handled here.
|
||||
- **D100 — where an inspection is switched off** (the plan's design, approved with it; it amends D93's "never in
|
||||
`qodana.yaml`"): in the place the engine that raised it reads — one of ReSharper's in `.editorconfig`; what has no
|
||||
key there in `qodana.yaml`. Hints are off as a severity. In code loaded into a game only defects are fixed.
|
||||
|
||||
**Choices made here:**
|
||||
|
||||
- **JetBrains' security rules stay on, scoped by path — which took four runs to find.** Every result was read first
|
||||
(the table in `13_CI_CD` §Qodana), and one place hardened (`ShellUrlOpener` refuses anything but `http`, `https`
|
||||
and `mailto`). Then the files read had to be told to the linter, and a rule's own id is honoured nowhere:
|
||||
`ignore`, an `exclude` path and `enabled: false` each left all 36 results standing. The report's own
|
||||
`log/effective.profile.xml` and `qodana_inspections_summary.csv` gave the answer — one inspection,
|
||||
`OpenGrepInspection`, produces every rule's results, and it does take a path. Between the third run and the
|
||||
fourth the rules were written as off, with a test in their place; the test stayed (`ProcessStartSitesTests`, in
|
||||
the gate, and wider than the rule), the rules came back on.
|
||||
- **`PrimaryDisplay.cs` was not changed to please the linter.** Its six results come from an internal assertion in
|
||||
this linter's build (in the job's `backend.log`), not from the file; the first guess — that the engine misreads an
|
||||
`unsafe` tuple — was wrong, and a rewrite made on it was reverted. Two inspections are excluded for that one file,
|
||||
to be removed when a linter build reads it.
|
||||
- **What the Ultimate licence offers and this job does not use**: quick-fixes (the job cannot push, on purpose), code
|
||||
coverage in Qodana, FlexInspect. If the licence lapses the job is red and advisory; the way back is in `qodana.yaml`.
|
||||
|
||||
**Traps:**
|
||||
|
||||
- **A security rule's id is not an inspection.** The OpenGrep plugin's rules all report through
|
||||
`OpenGrepInspection`; only that name works in `qodana.yaml`, and only by path. Read
|
||||
`log/qodana_inspections_summary.csv` in the report artifact to see which inspection produced a result before
|
||||
spending a run on a guess.
|
||||
- **A report artifact is a zip inside the download, with backslash paths**: `unzip` extracts it and exits non-zero
|
||||
on the warnings, so do not chain on its exit code.
|
||||
- **A linter result can be the linter's fault**: read the job's log directory (the report artifact carries it) for an
|
||||
`AssertionException` before changing the code it points at.
|
||||
- **A Qodana run of the managed job takes fifteen to seventeen minutes**, most of it the scan; a pull request's own run
|
||||
reads the whole solution (`pr-mode: false`), so there is no quick partial run to iterate on.
|
||||
|
||||
**Then:** the native report, in the pull request after it — the next section.
|
||||
|
||||
|
||||
### Qodana — the native report: the C++ through a solution CMake writes (D99, D100)
|
||||
|
||||
*Status is `docs/13_CI_CD.md` §Qodana and `CHANGELOG.md`; this is what no other file carries.* The second pull request
|
||||
of the third part: the job `native`, `qodana-native.yaml`, the preset `x64-vs-analysis`, fifty-four `.editorconfig`
|
||||
lines for the C++ and eleven small fixes outside code loaded into a game.
|
||||
|
||||
**Choices made here:**
|
||||
|
||||
- **One linter for both reports.** Qodana for .NET is the only linter of JetBrains' that reads this C++ (MSVC-only;
|
||||
`qodana-cpp` and `qodana-clang` are Linux images), and it wants a Visual Studio solution — so CMake writes one. The
|
||||
generated solution is never built from, beyond the one header a build generates.
|
||||
- **No `.clang-tidy` file.** The plan had expected one. Every clang-tidy check and clang diagnostic the engine runs
|
||||
has an `.editorconfig` key of ReSharper's, so D100's "where the engine reads" is one file for all of the C++, and
|
||||
the repository gains no clang-tidy configuration that a developer's editor would start obeying.
|
||||
- **Most of what it reported is not a fault, and the settings say why, line by line**: clang's opinion of code only
|
||||
MSVC builds; the engine misreading `atomic_ref`, zero-initialised API structures and constexpr tests; proposals of
|
||||
a newer idiom. Eleven things were fixed. **In code loaded into a game nothing was changed**: no defect was found
|
||||
there.
|
||||
- **`LogNoteW` (`FrameLedger.Overlay/src/dllmain.cpp`) is dead code, and it is still there — the owner's call.**
|
||||
Nothing calls it. D100 changes code loaded into a game for a defect only, and an unused function is not one, so
|
||||
it was not removed on a linter's word; `.editorconfig` leaves that one file unread for an unused function, in a
|
||||
section that says to remove it with the function. Removing it is eleven lines with no caller: a pull request of
|
||||
its own, whose overhead statement is that the function was never reached.
|
||||
- **"Possibly unused `#include`" is off, not obeyed.** Ten of the twelve reported outside the game are a file
|
||||
including what it uses (`<cstring>` for `std::memset`) although `<windows.h>` already brought it; removing them
|
||||
would have made the files depend on an accident.
|
||||
|
||||
**Traps:**
|
||||
|
||||
- **InspectCode cannot load the native solution on the owner's PC** (Visual Studio 18 Insiders' MSBuild crashes it,
|
||||
2026.2.3.1 and 2026.3.0 alike), so C++ results are read from CI: dispatch `qodana.yml` on the branch, download
|
||||
`qodana-report-native`, unzip the inner `qodana-report.zip`.
|
||||
- **A file compiled into three targets is reported three times**: count distinct results (rule, file, line), not rows.
|
||||
- **A shortened line is a clang-format change two lines away**: the gate's clang-format step failed on an alignment
|
||||
that the edit above it had made possible. Run clang-format on every native file touched before the gate.
|
||||
- **Do not switch branches while a gate runs** — a probe branch was made during a local native build, which changed
|
||||
and restored two sources under it. Nothing came of it; the next gate was run on a still tree.
|
||||
@@ -0,0 +1,104 @@
|
||||
# HANDOFF history — 0.1.0-beta.38
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` when 0.1.0-beta.39 was cut, 2026-11-11 (owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" mean HANDOFF.md as it stood then, and a path it writes is relative to `docs/`.*
|
||||
|
||||
## **START HERE** — 2026-11-11, 0.1.0-beta.38: Qodana Ultimate in two reports — and the next work is the owner's "Thông số nâng cao"
|
||||
|
||||
*Status is `docs/changelog/0.1.0-beta.38.md`; this is what no other file carries.* This release closes the plan of
|
||||
2026-11-11 — **beta.37** → **alpha.4** → **Qodana Ultimate in two reports**. The plan was one session's, and its START
|
||||
HERE was moved whole: all three parts, the decisions D94–D100, the choices and the traps are
|
||||
[`handoff/history/0.1.0-beta.37.md`](handoff/history/0.1.0-beta.37.md) — the two Qodana sections are its last two.
|
||||
#384 moved the managed job to Qodana for .NET and settled what it reports; #385 added the C++ as a second report; this
|
||||
release ships the one change to shipped code that came of it: the App's link opener refuses anything but a web or a
|
||||
mail address.
|
||||
|
||||
### NEXT — the owner's request of 2026-11-11, for the session(s) after this one
|
||||
|
||||
Sent while this session was still running, and recorded here as it was written:
|
||||
|
||||
> "Xong phiên này, bạn cập nhật (những) phiên tiếp theo với các phiên bản về Setting "Thông số nâng cao" hoặc tương tự
|
||||
> và hiển thị tại 1 navigation riêng, khai thác số liệu, dữ liệu, biểu đồ mức tối đa, toản bộ mà các header `.h` của
|
||||
> Streamline và NVAPI hoặc pawnIO có thể sử dụng và hiển thị nhé."
|
||||
|
||||
That is: once this session is done, the following session or sessions — and their versions — are about a setting
|
||||
called *"Thông số nâng cao"* (advanced metrics) or similar, shown in **a navigation item of its own**, that exploits
|
||||
to the maximum the numbers, the data and the charts that the `.h` headers of **Streamline** and **NVAPI**, or
|
||||
**PawnIO**, make available.
|
||||
|
||||
**Nothing of it was designed or begun here.** It is a new task, and it starts the way every train does — a plan, with
|
||||
the owner's decisions asked while planning. What follows is this session's reading, not the owner's words:
|
||||
|
||||
- **An inventory comes first, from the headers in the tree**: `src/native/third_party/streamline`, `nvapi`,
|
||||
`fidelityfx`; and what LibreHardwareMonitorLib reads through PawnIO (CPU and board sensors — optional, elevated
|
||||
only). For each item: what it is, and **where it can be read from** — the Agent's own process (NVAPI through
|
||||
`FrameLedger.NvapiBridge`, LibreHardwareMonitor) or only inside the game, through a hook (Streamline).
|
||||
- **Anything read inside a game is a hook**, and the rules that govern hooks are not this feature's to bend: rules 4
|
||||
and 5, `17_HOOK_ENGINE` §Hook inventory, the overhead stated, the open S-series of `20_OPEN_QUESTIONS`; the
|
||||
anti-cheat guard and rule 2 untouched. Rule 6 governs any frame rate it shows beside frame generation, rule 7 any
|
||||
Yes/No it shows, and rule 8 says it calls nothing on the network.
|
||||
- **Questions that are the owner's**: on or off by default; what is stored in the ledger (a schema change, the size
|
||||
of a session) and what is shown live only; what a PC without an NVIDIA card shows (N/A, never a guess); whether
|
||||
the page asks for the elevation PawnIO needs; how many releases, and in what order.
|
||||
- **What a new page owes**: strings in `en`, `vi`, `ja`; `ACCESSIBILITY.md` §For contributors for the page and each
|
||||
chart; `LIMITATIONS.md` and the guide; `08_UI`.
|
||||
|
||||
#### Planned 2026-11-11, and approved by the owner — four trains, the first begun
|
||||
|
||||
The plan was made the same day, the owner's decisions asked while planning. **The design, the decisions D101–D108 and
|
||||
the inventory are [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Advanced metrics**; what follows is only what that
|
||||
section does not carry — the order, and what was asked.
|
||||
|
||||
- **The owner's four answers.** (1) Inside the game: **everything, in stages — and the refusal of 2026-08-09 is
|
||||
re-examined**, not taken as final. (2) **Stored in full with the session.** (3) **Off by default, and off means
|
||||
nothing more is read or stored**; the navigation item is hidden. (4) PawnIO: **the page says what is missing and
|
||||
links to the admin mode's setting** (D34); it never asks for the rights itself.
|
||||
- **Four trains, one release each, in this order**: **A** (0.1.0-beta.39) what the Agent can read — NVAPI,
|
||||
LibreHardwareMonitor — with storage and the page, **and nothing changed in code loaded into a game**; **B**
|
||||
(beta.40) inside the game, on calls already hooked and on functions Streamline exports, shared-memory layout 5;
|
||||
**C** (beta.41) Reflex latency, after a spike; **D** (beta.42) the Streamline state behind `slGetFeatureFunction`,
|
||||
after a spike. **Why this order**: A needs no hook, so it ships the page, the storage and the option first and
|
||||
every later train only fills rows; B is hooks of a kind already built; C and D are routes nobody has proven safe,
|
||||
and each ends in the owner's go or no.
|
||||
- **The approval covers train A whole** — its eight pull requests through the release. **B, C and D each begin with a
|
||||
plan of their own**, their decisions asked then. For D the owner will be asked one thing nothing else has needed:
|
||||
handing the game a wrapper in place of the function it asked for is a write, and rule 4 as written forbids it.
|
||||
- **Train A's pull requests**: (1) decisions, inventory, the catalog; (2) the NVAPI bridge's ABI 3 and the read-only
|
||||
gate; (3) LibreHardwareMonitor's groups and the shared reader, not yet composed; (4) the `.partial` chunks and
|
||||
schema 0023, produced by nobody yet; (5) the option goes live, with Privacy 2.15; (6) the pipe request and the
|
||||
App's feed; (7) the page, the navigation item, Ctrl+6; (8) the release. A setting and its guide text, a navigation
|
||||
item and its guide text, a schema script and its writer each land in ONE pull request — the guide tests, the
|
||||
viewer-mode test and the registry test are red otherwise.
|
||||
- **What the owner will be asked to run** (the release's owner-only item): the NVAPI rows on the RTX 5080 — CI has no
|
||||
driver and never takes that branch; one run as administrator with PawnIO, which is also the first there has ever
|
||||
been (`20_OPEN_QUESTIONS` §M10); the Agent's processor time and memory with the option on and off (NFR-2).
|
||||
- **A trap already paid for**: LibreHardwareMonitor's storage group may touch every drive when it opens, and this
|
||||
PC once had a failing USB drive. If the group cannot be opened without touching removable drives, storage stays
|
||||
N/A in beta.39 — decided before the first run, not after it. **It cannot (read in the library's source,
|
||||
2026-11-11), so it is not opened**: a drive's temperature reads N/A in beta.39, and the reason is on the page.
|
||||
- **Measure before composing.** `FrameLedger.CaptureHost probe-advanced` ran the reader on this PC before any Agent
|
||||
code used it, and found the sensor library's refresh at 14 ms of processor time — so the reader reads it every
|
||||
fifth tick. The same number says the telemetry layer every session already uses costs more than NFR-2 allows
|
||||
(`20_OPEN_QUESTIONS` §M16): **not this train's to fix, and the owner's to decide** — ask it when this train is out.
|
||||
|
||||
### Left open by this session
|
||||
|
||||
- **`LogNoteW`** (`src/native/FrameLedger.Overlay/src/dllmain.cpp`): a function nothing calls, found by the native
|
||||
report and **not removed** — D100 changes code loaded into a game for a defect only, and dead code is not one. The
|
||||
owner says whether it goes (owner-only item 36 (d)); `.editorconfig` has a section, naming it, that goes with it.
|
||||
- ~~**This release's own facts** — the tag's run, the digests, the delta — are not in any file yet: the release is cut
|
||||
after this text. Record them in the next pull request, as beta.37's and alpha.4's were in #384.~~ **Recorded
|
||||
2026-11-11, in the first pull request of the Advanced-metrics train: 0.1.0-beta.38 was released
|
||||
2026-11-11T02:56:51Z** from the signed tag on `b7d6550`, by run 42947853293 — one run for the one tag push, where
|
||||
alpha.4's push had started two. Eight assets; the seven digests of `SHA256SUMS.txt` equal the ones GitHub computed;
|
||||
the shipped natives carry `FL_BUILD_ID v0.1.0-beta.38`. The delta from beta.37 is 699,201 bytes beside a full
|
||||
package of 110,325,438 — "Delta processed 0452 files. 0022 patched, 0430 unchanged". The wiki was published by run
|
||||
42949461191. The rehearsal on the release branch (run 42944533749) had made a delta of 727,036 bytes with the same
|
||||
file counts.
|
||||
- **The Qodana licence** is read from the job's log (*Qodana license plan: Ultimate*, and the day the subscription is
|
||||
active until). When it lapses both jobs are red and advisory; `qodana.yaml`'s first comment is the way back.
|
||||
- **C# 15's constructs** wait for a ReSharper engine that reads them (`20_OPEN_QUESTIONS` §G, the row added with
|
||||
beta.37): the linter is now Qodana for .NET, whose engine is the same one — re-run the canary (`spike-notes` §29)
|
||||
when the action's pin moves.
|
||||
- **The alpha line rests** (D98). No sync and no alpha follow this release.
|
||||
|
||||
**Owner-only:** item 36 — beta.38 on real hardware, the links, the two Qodana Cloud projects, and `LogNoteW`.
|
||||
@@ -0,0 +1,111 @@
|
||||
# HANDOFF history — 0.1.0-beta.39
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` when 0.1.0-beta.40 was cut, 2026-11-12 (owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" mean HANDOFF.md as it stood then, and a path it writes is relative to `docs/`.*
|
||||
|
||||
## **START HERE** — 2026-11-11, 0.1.0-beta.39: Advanced metrics, train A — and train B begins with a plan of its own
|
||||
|
||||
*Status is `docs/changelog/0.1.0-beta.39.md`; this is what no other file carries.* The owner's request of 2026-11-11
|
||||
— a setting, *Thông số nâng cao*, with a navigation item of its own — was planned the same day, approved, and its
|
||||
**first train of four is this release**: what the Agent can read (NVAPI, LibreHardwareMonitor), stored with the
|
||||
session, shown on a page, and **nothing changed in code loaded into a game**. Seven pull requests and this one:
|
||||
#387 (decisions, inventory, the catalog), #388 (the NVAPI bridge's ABI 3, the read-only gate), #389 (the shared
|
||||
reader, measured before composed), #390 (schema 0023, the `.partial` chunks), #391 (the switch, Privacy 2.15,
|
||||
Disclaimer 2.15), #392 (the pipe request, the App's feed), #393 (the page, the navigation item, Ctrl+6). **The
|
||||
design, the decisions D101–D108 and the inventory are [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Advanced
|
||||
metrics; the screen is `08_UI` §Advanced.** The request as the owner wrote it, the four answers and the order of the
|
||||
four trains are [`handoff/history/0.1.0-beta.38.md`](handoff/history/0.1.0-beta.38.md) §NEXT.
|
||||
|
||||
### What this train decided that the plan had not
|
||||
|
||||
- **D109 — the Disclaimer goes to 2.15 with the Privacy Policy.** The plan approved the Privacy Policy's content only.
|
||||
Writing #391 found two sentences of the Disclaimer (§5, §5A) that said PawnIO and the admin mode were for the CPU
|
||||
temperature alone, which the option makes false; the owner was asked with both quoted and chose to amend them. The
|
||||
admin mode's own disclosure followed (`agent-admin-dialog/2`).
|
||||
- **Storage is not read at all** (D103's outcome, decided before the first run): LibreHardwareMonitor cannot list
|
||||
drives without touching removable ones, so the group is never opened and a drive's temperature is N/A with that
|
||||
reason. Power supplies and fan controllers are refused for the same kind of reason (a search of every USB device).
|
||||
- **The sensors are read every fifth second**, NVIDIA's figures every second — set by a measurement
|
||||
(`CaptureHost probe-advanced`: 14 ms of processor time per refresh of the sensor library), not by taste.
|
||||
- **The page's hold on the reader is the request itself**: nothing tells the Agent that a page opened or closed
|
||||
(`07_IPC` `GetAdvancedMachine`). A design with an "open" and a "close" message was not written, because a pipe
|
||||
that drops would leave the reader running.
|
||||
|
||||
### NEXT
|
||||
|
||||
1. ~~**Ask the owner `20_OPEN_QUESTIONS` §M16 before anything else.**~~ **Asked 2026-11-11 — D110: measure it in a
|
||||
real Agent first.** `tools/agent-cost.ps1` does, and §M16 holds the numbers: 1.93 % of one core with Advanced
|
||||
metrics off, 2.04 % on. **D117: NFR-2 is amended to ≤ 2.5 %**; nothing in the code changes.
|
||||
2. ~~**Train B (0.1.0-beta.40) starts with a plan of its own**~~ **Train B was planned and approved the same day**
|
||||
(D111–D116): [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Train B is the design. What that section does not
|
||||
carry:
|
||||
- **The approval covers 0.1.0-beta.40 whole** — five pull requests: (1) the decisions, the struct-version table,
|
||||
§M16 measured; (2) shared-memory layout 5, written by nobody yet; (3) the Overlay reads the extra fields of the
|
||||
calls it already hooks, behind the control word, with `overlay-fields-check` and the overhead measured; (4) the
|
||||
Agent's sampler, the catalog's new reach, the page's words, Privacy 2.16; (5) the release, owner-only item 38.
|
||||
- **beta.41 and beta.42 are designed and not begun.** Each starts only when the owner says the release before it
|
||||
passed its owner-only item on real games — that wait is what the split is for.
|
||||
- **The design was reviewed against the code before approval, and the review changed it**: the split itself; the
|
||||
struct-version table (the tree holds one version of each header); storing a vendor `Boolean` or preset as its
|
||||
value plus one and refusing the vendors' sentinels (`INVALID_FLOAT` is FLT_MAX); flags as "ever seen" masks and
|
||||
the frame time as a sum the watchdog drains, since a value sampled once a second aliases a per-frame one; the
|
||||
new region written by the watchdog alone and only while requested; `AdvancedSources`' new member optional, so a
|
||||
beta.39 row still parses; `kMaxPatches = 48` to be checked before a patch is added.
|
||||
3. **Trains C and D** (Reflex latency; the Streamline state behind `slGetFeatureFunction`) each begin with a spike
|
||||
and end in the owner's go or no. D needs an amendment of rule 4 if it goes ahead — handing the game a wrapper is
|
||||
a write — and that question is put to the owner then, not assumed.
|
||||
|
||||
### Left open by this session
|
||||
|
||||
- ~~**This release's own facts** — the tag's run, the digests, the delta — are not in any file yet: the release is cut
|
||||
after this text. Record them in the next pull request, as beta.38's were in #387.~~ **Recorded 2026-11-11, in the
|
||||
first pull request of train B: 0.1.0-beta.39 was released 2026-11-11T13:52:07Z** from the signed tag on `e63cd49`
|
||||
(#394), by run 43031168146 — green at the first attempt, one run for the one tag push. Eight assets; the seven
|
||||
digests of `SHA256SUMS.txt` equal the ones GitHub computed; the shipped natives carry `FL_BUILD_ID v0.1.0-beta.39`.
|
||||
The delta from beta.38 is 3,144,205 bytes beside a full package of 110,678,706 — "Delta processed 0452 files. 0026
|
||||
patched, 0426 unchanged". The wiki was published by run 43033077805. The rehearsal on the release branch (run
|
||||
43026873256) had made a delta of 3,159,090 bytes with the same file counts.
|
||||
- **Nothing here was seen in the running App.** The page was rendered to images from a test over fixture data and
|
||||
looked at; a chart does not render into such an image. No real Agent answered a real App, no session was recorded
|
||||
with the option on, and no value was compared with another tool. All of that is owner-only item 37.
|
||||
- **The first run as administrator with PawnIO is still to come** (`20_OPEN_QUESTIONS` §M10, §M13): the processor,
|
||||
memory and motherboard groups have been opened on no PC. The reader leaves a device alone after two faults, and
|
||||
runs on a thread of its own, so a sensor that hangs holds up neither a session's samples nor the pipe — that is
|
||||
the design, and it has not been tried.
|
||||
- **The `vi` strings were written by the assistant and the `ja` ones are marked `review`** — 245 keys each, every
|
||||
catalog entry among them.
|
||||
- **`LogNoteW`** is still there (owner-only item 36 (d)), and the alpha line still rests (D98): no alpha follows this
|
||||
release.
|
||||
|
||||
### Traps this train paid for
|
||||
|
||||
- **A pull request whose workflows never start.** #390 was opened and GitHub started none of its three workflows —
|
||||
`gh pr checks` said "no checks reported" ten minutes later, with nothing queued. Closing and reopening the pull
|
||||
request starts them (`pull_request: reopened`); **closing drops auto-merge, so enable it again.** After every
|
||||
`gh pr create`, ask the API for the runs of the head commit before walking away.
|
||||
- **`ShmDrainIntegrationTests.TheGuardInjectsTheOverlayAndTheReaderDrainsRealFrames` was red once** in a local gate
|
||||
(#392's first run): the guard's re-scan refused the harness mid-run, under the gate's load. It passed alone and in
|
||||
the rerun; nothing in that pull request is on its path; it was not diagnosed. ~~If it shows again, read the verdict's
|
||||
reason first — the assertion prints only that it was a refusal.~~ **It showed again the same day** (train B's first
|
||||
local gate), on another line: the Overlay's status was still `Init` with fifty records already drained. That one
|
||||
is a race in the test and is fixed — the Overlay publishes `Ready` after its last hook, later than its first
|
||||
record, so the test now waits `Init` out, bounded. The refusal was not reproduced; the assertion now prints the
|
||||
verdict, so the next one says why.
|
||||
- **`PagesLoadTests.EveryTextFollowsAThemeSwitch` was red once on a hosted runner** (#393's first run, green three
|
||||
times locally): *Settings: "Processor" shows in a fresh one only*. Every build of the Settings page in that fixture
|
||||
made a `SystemInfoViewModel` of its own, whose lines arrive from the thread pool, so two pages built a moment apart
|
||||
could differ by a row. The fixture now loads one and awaits it (`Surfaces.SystemInfo`) — fixed in the release's
|
||||
pull request, test code only. A surface whose view model loads by itself is loaded once, awaited, then shared.
|
||||
- **SonarCloud's coverage of new code** (advisory, 80 % asked) was 75.3 % on #391: the uncovered part was Win32
|
||||
(`WindowGeometryProbe.MonitorDeviceOf`). A lookup that takes a named window, as `Observe` does, can be tested
|
||||
against the harness's window; one that only searches for a visible window cannot, on a hosted runner.
|
||||
- **The App's own accessibility tests will refuse a page** that sets `AutomationProperties.LiveSetting` in XAML, that
|
||||
names a page-local resource key, whose item types have no `ToString`, or whose grid has an unnamed filler column —
|
||||
and a navigation item or a guide page that the guide's contents do not name. All of it is one test run away:
|
||||
run `FrameLedger.App.Tests` whole before the gate.
|
||||
- **An image of a page from a test** (`RenderTargetBitmap` over the hosted frame) shows the layout and the text, and
|
||||
costs a temporary test; ScottPlot draws nothing into it.
|
||||
- **`sed -i` on a file the Write tool made** is harmless only because both are LF until the normalising step; on a
|
||||
CRLF file it is the trap `handoff/traps.md` already names.
|
||||
|
||||
**Owner-only:** item 37 — beta.39 on real hardware: the update and its two terms, the switch and the page, a session
|
||||
with a real game, the first run as administrator with PawnIO, and what the Agent costs with the option on and off.
|
||||
@@ -0,0 +1,148 @@
|
||||
# HANDOFF history — 0.1.0-beta.40
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` when 0.1.0-beta.41 was cut, 2026-11-12 (owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" mean HANDOFF.md as it stood then, and a path it writes is relative to `docs/`. **Its release numbers are those of the day it was written**: what it calls beta.41 and beta.42 are train B's second and third releases, now beta.42 and beta.43 (D118).*
|
||||
|
||||
## **START HERE** — 2026-11-12, 0.1.0-beta.40: Advanced metrics inside the game, the first of train B's three releases
|
||||
|
||||
*Status is `docs/changelog/0.1.0-beta.40.md`; this is what no other file carries.* Train B of the owner's
|
||||
"Thông số nâng cao" was planned and approved on 2026-11-11 (D110–D117) as **three releases**, and this is the first:
|
||||
what a hooked game tells its upscaler, read from **calls the Overlay already hooked — no new patch site** — only
|
||||
while the session records Advanced metrics. Four pull requests and this one: #395 (the decisions, the struct-version
|
||||
table, §M16 measured, NFR-2 amended), #396 (shared-memory layout 5, region 5), #397 (the Overlay's reads, the
|
||||
`overlay-fields-check` gate, the overhead measured), #398 (the Agent's sampler, the catalog's reach `Game`, the
|
||||
page's words, Privacy Policy 2.16). **The design is [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Train B; the
|
||||
contract of the new region is [`07_IPC.md`](07_IPC.md) §Region 5; what each hooked call reads is
|
||||
[`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Hook inventory.** The plan as approved, the review that changed it and the
|
||||
order of the trains are [`handoff/history/0.1.0-beta.39.md`](handoff/history/0.1.0-beta.39.md) §NEXT.
|
||||
|
||||
### What this train decided that the plan had not
|
||||
|
||||
None of these is an owner decision; each was found while building, and is written where it binds.
|
||||
|
||||
- **"On" is a request of the session's own, not a 1** (#397, `07_IPC` §Region 5). The plan had the control word as
|
||||
0 or 1. A game outlives a session, and the Overlay's summaries with it — a second session of a game that kept
|
||||
running would have read the first one's field-of-view range and counts. The Agent now writes a value no session of
|
||||
that ring used, the watchdog starts its summaries afresh at a value it has not seen and names it in every
|
||||
publication, and the reader keeps only a publication that names its own. Found while writing the injected test,
|
||||
before anything shipped; layout 5 was changed in place (`reserved0` became `request`), which was possible only
|
||||
because no release had carried it.
|
||||
- **One module's calls are counted**, for the memory query as for the dispatch: a loader that passes a call on to a
|
||||
leaf's export is seen at two hooks.
|
||||
- **Five of the thirteen entries are tables**, not text (`sl.dlss.presets`, `sl.dlss.exposure`,
|
||||
`ffx.upscale.sharpening`, `.jitter`, `.depth`): a row's name is the vendor's own member name, so nothing but a
|
||||
switch's on/off and a flag's name needs translating. The catalog's unit and two summaries changed; no id did.
|
||||
- **What became of the in-game entries is stored with the session** (`AdvancedSources.InGame`): read, nothing seen,
|
||||
not hooked. Without it a session whose game set its DLSS options through `slDLSSSetOptions` would look like a
|
||||
game with no upscaler.
|
||||
- **The Disclaimer stays 2.15.** The accuracy statement gained an item, as in beta.19, beta.20 and beta.25, none of
|
||||
which moved it; the Privacy Policy went to 2.16 with the content the plan approved.
|
||||
- **A crash dump is tried three times** (#398). Not this train's subject: `CrashDumpHelperTests` failed under the
|
||||
full gate for the third time in two days, and the cause — `MiniDumpWriteDump` of a running process that changes
|
||||
under it — costs a real crash its only dump in exactly the same way.
|
||||
|
||||
### NEXT
|
||||
|
||||
1. **The owner runs item 38** — this release on real games. **Nothing of train B is begun before that**: the wait
|
||||
is what the split into three releases is for (D113).
|
||||
2. **0.1.0-beta.41, when the owner says item 38 passed**: two new hooks, `slSetConstants` and `ffxConfigure`. The
|
||||
design is in `18` §Train B and the plan in [`handoff/history/0.1.0-beta.39.md`](handoff/history/0.1.0-beta.39.md)
|
||||
§NEXT; region 5 already has their members (`sl*`, `ffxFg*`), so no layout changes. What to settle first, in a
|
||||
plan of its own: `kMaxPatches = 48` against the patch count with the new rows; the window of `sl::Constants` that
|
||||
is read, pinned by `static_assert` so that the camera members stay outside it; the overhead of a call made every
|
||||
frame for every viewport, measured before the merge; `overlay-fields-check`'s list and its parameters for the two
|
||||
new structs.
|
||||
3. **0.1.0-beta.42, when the owner says the one before passed**: `slGetFeatureVersion` and
|
||||
`slGetFeatureRequirements` — calls a game makes while starting, so most sessions will say the game did not make
|
||||
them after FrameLedger attached. The release notes and the page say so.
|
||||
4. **Trains C and D** (Reflex latency → beta.43; the Streamline state behind `slGetFeatureFunction` → beta.44) each
|
||||
begin with a spike and end in the owner's go or no. D needs an amendment of rule 4 if it goes ahead.
|
||||
|
||||
### Left open by this session
|
||||
|
||||
- ~~**This release's own facts** — the tag's run, the digests, the delta — are not in any file yet: the release is cut
|
||||
after this text. Record them in the next pull request, as beta.39's were in #395.~~ **Recorded 2026-11-12, in the
|
||||
pull request after the release: 0.1.0-beta.40 was released 2026-11-11T19:30:13Z** (02:30 on the 12th in the
|
||||
owner's time zone, which is the date the changelog carries; the legal documents' *Effective* date is the UTC one,
|
||||
2026-11-11 — the fifth release to straddle midnight that way, after beta.9, .10, .12 and .14) from the signed tag
|
||||
on `5268332` (#399), by run 43085044822 — green at the first attempt, one run for the one tag push. Eight assets;
|
||||
the seven digests of `SHA256SUMS.txt` equal the ones GitHub computed; the shipped natives carry `FL_BUILD_ID
|
||||
v0.1.0-beta.40`. The delta from beta.39 is 2,413,166 bytes beside a full package of 110,707,319 — "Delta processed
|
||||
0452 files. 0025 patched, 0427 unchanged". The wiki was published by run 43087844607. The rehearsal on the release
|
||||
branch (run 43082208739) had made a delta of 2,426,184 bytes with the same file counts.
|
||||
- **Nothing here was read from a real game, and nothing was seen in the running App.** The values come from
|
||||
`hook-harness --advanced` and the FidelityFX stub; the page's new rows were loaded by its tests and looked at by
|
||||
nobody. All of it is owner-only item 38.
|
||||
- **Whether any shipping title chains `sl::DLSSOptions` into `slEvaluateFeature`** is not known. If none of the
|
||||
owner's games does, the six `sl.dlss.*` entries read N/A everywhere until train D, and the page already says why.
|
||||
- **The aliasable part of FSR's memory** is read and published and not shown: the catalog has one memory entry.
|
||||
- **What the owner's first evening with it showed** (2026-11-12, read from a copy of the ledger and the Agent's log;
|
||||
ten hooked sessions on eight games, no fault in any, the Overlay `Ready` at every end):
|
||||
- **Read from a real game for the first time: Lies of P** (FSR 3 through `amd_fidelityfx_dx12.dll` 1.0.1, the
|
||||
SDK 1.1.x monolith) — sharpening on at 0.5, jitter up to 0.48 / 0.49 of a pixel, pre-exposure 0.25–1, a vertical
|
||||
field of view from 21.6° to 73.7°, no flag, and a reported frame time whose median is 16.67 ms beside a native
|
||||
rate of 55.6 FPS. The series starts 83 seconds in and has no gap after. Whether these match the game's own
|
||||
settings is still the owner's to say (item 38 (c)).
|
||||
- **`cameraNear` is absent there and `cameraFar` is 10.** Most likely the game runs an inverted, infinite depth
|
||||
and passes `FLT_MAX` for the plane at infinity, which the Overlay refuses as a value nobody set. "Infinite" would
|
||||
be the true answer. It is a change in code loaded into a game: decide it in beta.41's plan, not before.
|
||||
- **Every other game said *the game made none of the calls***, as expected: all ran DLSS. Dying Light: The Beast
|
||||
evaluates DLSS through Streamline and chains no `DLSSOptions` — the first evidence on that open question, and
|
||||
it is a no. Valor Mortis, Phantom Blade Zero, Clair Obscur and Kingdom Come: Deliverance II ship AMD's FSR 3.1+
|
||||
libraries and did not upscale through them in these sessions, so **no FSR 3.1+ title has been read yet**.
|
||||
- **The option off stored nothing** (Black Myth: Wukong, one session each way), and **a game under the user-mode
|
||||
anti-cheat exception ran with it on** (Girls' Frontline 2, trial 1 of 2).
|
||||
- **Valor Mortis ended with an access violation 51 seconds after injection, once**; the next launch ran fourteen
|
||||
minutes on the same build. The Overlay counted no fault and Windows logged no application error. Not attributed
|
||||
and not ruled out; its crash count stands at 1, and a second such end switches its hooking off.
|
||||
- **The sensor library was closed under its other users** — a defect of train A that only an elevated Agent with
|
||||
PawnIO can show. `20_OPEN_QUESTIONS` §M13 has what was seen; `LhmLibrary` is the fix; the owner's next sessions
|
||||
say whether it holds.
|
||||
- **`LIMITATIONS.md` and the accuracy statement still say the processor's, the memory's and the motherboard's
|
||||
sensors "have never been read on real hardware".** They have now been read on one PC and compared with nothing.
|
||||
The sentence is the owner's to reword.
|
||||
- ~~**SonarCloud on #398** had not answered when this was written; #397's three findings are fixed in #398.~~
|
||||
**It answered after the merge, with three findings on new code**, handled in the pull request after the release:
|
||||
two `csharpsquid:S1244` in `InGameAdvancedSampler` — a lowest and a highest float compared with `==` to tell one
|
||||
value from a range; they are now told apart by their bits, which is what was meant — and one
|
||||
`csharpsquid:S3869`, a blocker, on `ParentDump`'s `DangerousGetHandle`. That one is **not new and not fixed**: the
|
||||
owner accepted it in beta.24 (`13_CI_CD` §SonarCloud), #398 moved the same expression into a new method, and
|
||||
SonarCloud tracks an issue by its place. It needs the owner's *Accept* again — item 38 (j).
|
||||
- **The `vi` strings were written by the assistant and the `ja` ones are marked `review`** — fourteen more keys and
|
||||
the reworded Settings text.
|
||||
- **`LogNoteW`** is still there (owner-only item 36 (d)), item 37 is still unrun, and the alpha line still rests
|
||||
(D98): no alpha follows this release.
|
||||
|
||||
### Traps this train paid for
|
||||
|
||||
- **A library that is "one object per user" may still be one per process underneath.** Three `Computer`s of
|
||||
LibreHardwareMonitor shared a driver handle and mutexes; each was tested alone, unelevated, where the shared part
|
||||
is never opened. Before composing a second instance of anything that talks to a driver, ask what its `Close`
|
||||
closes. And `first ??= TryClose(x)` in a loop stops closing at the first throw — the test for "all are closed
|
||||
even when one throws" caught it in the fix itself.
|
||||
- **A heredoc in the tool's shell breaks on an odd number of apostrophes** — a script with `game's` in it fails with
|
||||
"unexpected EOF while looking for matching `'`" before Python ever runs. Write the script to a file and run the
|
||||
file.
|
||||
- **A region that outlives its reader needs to say whose data it holds.** Region 4 never had the problem — it is
|
||||
the swap chain's state, the same for any session. Region 5 holds summaries, and a summary has a beginning. Ask of
|
||||
any new shared state: what does the second session of the same process read in its first second?
|
||||
- **SonarCloud's engine does not see a Catch2 `REQUIRE` end a path**: `REQUIRE(OpenRingFor(pid, r))` followed by
|
||||
`r.st->…` is a null dereference to it (`cpp:S2259`, a failed gate on new code). An explicit `return` after the
|
||||
`REQUIRE` is what it follows. And a `LARGE_INTEGER` read through `QuadPart` is initialised through `QuadPart`
|
||||
(`cpp:S6232`) — `13_CI_CD` §SonarCloud has had the rule since #336; new code still forgot it.
|
||||
- **SonarCloud fails after the merge.** Its job is advisory and slower than the required checks, so auto-merge lands
|
||||
the pull request first. Read its result on the merged pull request before building on it.
|
||||
- **`MA0051` counts sixty lines, comments included**, and `CaptureSession.SuperviseAsync` was at fifty-nine: one
|
||||
line more is a build error. What a session asks once belongs where the session's state is made, not in the loop.
|
||||
- **`RCS1242` refuses `in` for a struct that is not `readonly`** — the mirror structs are not. Pass the object that
|
||||
holds the struct and take `ref readonly` inside.
|
||||
- **`/W4 /WX` refuses `alignas` on a struct it then has to pad** (C4324): align the variable, not the type.
|
||||
- **The `.resx` files hold a literal apostrophe**, not `'`: an edit script that searches for the entity finds
|
||||
nothing and stops half-way through.
|
||||
- **`ISessionRepository.FindAdvancedSensorsAsync` returns `t_ms` too**: "no advanced series" is "no series under
|
||||
`adv.`", not an empty list.
|
||||
- **PowerShell reads a backtick in a double-quoted string as an escape** (`` `r `` is a carriage return) and
|
||||
`"$name: text"` as a scoped variable: in a gate's messages, quote names with apostrophes and write `${name}:`.
|
||||
|
||||
**Owner-only:** item 38 — beta.40 on real games: the update and the Privacy Policy 2.16, a game that was running
|
||||
across the update, an FSR 3.1+ title and a DLSS title with the option on, the same with it off, a second session of
|
||||
a game that kept running, a game under the user-mode anti-cheat exception, and what the Agent costs.
|
||||
@@ -0,0 +1,131 @@
|
||||
# HANDOFF history — 0.1.0-beta.41
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` when 0.1.0-beta.42 was cut, 2026-11-12 (owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" mean HANDOFF.md as it stood then, and a path it writes is relative to `docs/`. **Its release numbers are those of the hour it was written**: its item 3 calls train B's third step beta.43 and its item 4 calls trains C and D beta.44 and beta.45 — since D122, later the same day, they are beta.44, beta.45 and beta.46, and beta.43 is the two new hooks.*
|
||||
|
||||
## **START HERE** — 2026-11-12, 0.1.0-beta.41: one fix — the sensor library is no longer closed under its other users
|
||||
|
||||
*Status is `docs/changelog/0.1.0-beta.41.md`; this is what no other file carries.* 0.1.0-beta.40 was released in the
|
||||
small hours of 2026-11-12 and the owner ran it that same night on eight games, as administrator with PawnIO — the
|
||||
first elevated run there has been. A copy of the ledger and the Agent's log showed the in-game readings working
|
||||
(Lies of P, the first real game read) and **a defect of train A that only that elevation can show**: three
|
||||
LibreHardwareMonitor `Computer`s in one Agent, and the library's per-process state closed by one under the others.
|
||||
This release is that fix and nothing else: #400 (0.1.0-beta.40's release facts; two comparisons SonarCloud flagged),
|
||||
#401 (`LhmLibrary`), and this one. **Everything about train B — what was built, what the owner's sessions showed,
|
||||
the traps — is [`handoff/history/0.1.0-beta.40.md`](handoff/history/0.1.0-beta.40.md)**; the fix is
|
||||
[`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Advanced metrics and [`20_OPEN_QUESTIONS.md`](20_OPEN_QUESTIONS.md)
|
||||
§M13.
|
||||
|
||||
### What this release decided
|
||||
|
||||
- **D118 — the fix is released at once as 0.1.0-beta.41, and train B's numbers move by one.** D113 had named
|
||||
beta.41 for the train's second release. Told so, the owner chose to release the fix now. The train's second
|
||||
release is **beta.42**, its third **beta.43**, train C **beta.44**, train D **beta.45**. Released changelogs and
|
||||
moved HANDOFF sections keep the numbers of their day; so do the comments in `fl_shm.h` and `ShmLayout.cs` (the
|
||||
members "0.1.0-beta.41" and "beta.42" fill), **deliberately**: touching them would have changed source that is
|
||||
loaded into a game in a release that says the game-side code is beta.40's line for line. The release that fills
|
||||
a member rewrites its comment.
|
||||
- **The reads of the sensor library are not put under one lock**, only its opens and closes. A lock around every
|
||||
read would have put a session's once-a-second poll behind the Advanced reader's, undoing the separate threads
|
||||
that keep a hanging sensor from holding up the other reader.
|
||||
|
||||
### NEXT
|
||||
|
||||
1. ~~**The owner runs item 39** (this fix, on the PC that showed the fault) **and the rest of item 38** (an FSR 3.1+
|
||||
title; two sessions of one running game; the cost; the values of Lies of P against the game's own settings).~~
|
||||
**Both passed on 2026-11-12, on the owner's word** ("Bạn có thể đánh dấu là pass và tiếp tục") after the thirteen
|
||||
sessions below; [`handoff/owner-only-passed.md`](handoff/owner-only-passed.md) says what those sessions covered and
|
||||
what they did not.
|
||||
2. **Planned and approved 2026-11-12 (D119–D122): the second step is two releases.** **0.1.0-beta.42 has no new
|
||||
patch site** — five pull requests: (1) the session's upscaler label (D120); (2) the Overlay's patch registry
|
||||
refuses a patch it cannot register, and registers before it enables; (3) the native log is flushed whenever
|
||||
something new was logged, every inventory row's install line names its module and symbol, a failed patch says
|
||||
why, and the first sight of each ffx descriptor type on each module is logged — so that one Cyberpunk session on
|
||||
beta.42 says where its upscale goes (D121); (4) FSR's infinite depth plane (D119); (5) the release, owner-only
|
||||
item 40. **0.1.0-beta.43 is the two new hooks** and begins only when that log was read; its design — reviewed
|
||||
against the code, which changed it — is in the plan of that day and below. What the review found that the first
|
||||
draft had wrong: there is no "dominant segment" (segments split on output size only), so the label is the modal
|
||||
name over the dominant stream; the patch table drops a patch silently when full; the init thread's flush runs
|
||||
after the watchdog starts; a second NaN pattern for "infinite" would have been dropped by the Agent — real
|
||||
+infinity is stored instead; the new rows must be gated before `ResolveScoped`, which takes a module reference a
|
||||
call; `slSetConstants` needs the struct's GUID checked on every call; `ffxConfigure` needs an owner slot of its
|
||||
own; summaries across viewports must come from the first viewport seen.
|
||||
~~**0.1.0-beta.42 — train B's second release — when the owner says item 38 passed begins now, with its plan**~~: `slSetConstants` and
|
||||
`ffxConfigure`. A plan of its own first. What it must settle, beside what
|
||||
[`handoff/history/0.1.0-beta.40.md`](handoff/history/0.1.0-beta.40.md) §NEXT lists (`kMaxPatches = 48`, the window
|
||||
of `sl::Constants` pinned outside the camera members, the per-call overhead, the gate's list for the two new
|
||||
structs):
|
||||
- ~~**`FLT_MAX` in an FSR depth plane.** Lies of P gave `cameraFar = 10` and no `cameraNear`; most likely the
|
||||
plane at infinity is `FLT_MAX`, which the Overlay refuses as "nobody set this". Decide whether it is stored as
|
||||
"infinite" — an Overlay change, with its overhead stated.~~ *(Decided, D119, and built in beta.42:
|
||||
`FL_ADV_FLOAT_INFINITE`, shown "∞". Whether Lies of P's missing plane IS `FLT_MAX` is still the hypothesis it
|
||||
was — item 40 reads it.)*
|
||||
- ~~**Valor Mortis.** One exit by access violation 51 seconds after injection under beta.40, none under an earlier
|
||||
build, not attributed. Its crash count is 1; a second such end switches its hooking off. Before adding a hook
|
||||
to that game's process, ask the owner whether it happened again.~~ **Answered by the owner, 2026-11-12: it was
|
||||
the game's own — a shader-compilation error on entering the game, shown in the game's own crash dialog.** Not
|
||||
FrameLedger's. It ran normally under beta.41 afterwards. Its crash count still stands at 1, because the crash
|
||||
policy counts an abnormal end within 60 seconds of injection whoever caused it: a second one, from any cause,
|
||||
switches its hooking off, and the owner then switches it on again from the game's page.
|
||||
- **The release numbers in the comments** of `fl_shm.h`, `ShmLayout.cs`, `hook-harness` and `guard_test.cpp` for
|
||||
the members that release fills (D118).
|
||||
3. **0.1.0-beta.43 — the third — when the owner says the one before passed**: `slGetFeatureVersion` and
|
||||
`slGetFeatureRequirements`.
|
||||
4. **Trains C and D** (beta.44, beta.45) each begin with a spike and end in the owner's go or no.
|
||||
|
||||
### Left open by this session
|
||||
|
||||
- ~~**This release's own facts** — the tag's run, the digests, the delta — are not in any file yet: the release is cut
|
||||
after this text. Record them in the next pull request.~~ **Recorded 2026-11-12: 0.1.0-beta.41 was released
|
||||
2026-11-11T22:38:39Z** (05:38 on the 12th in the owner's time zone) from the signed tag on `a6b95e8` (#402), by
|
||||
run 43111028661 — green at the first attempt, one run for the one tag push. Eight assets; the seven digests of
|
||||
`SHA256SUMS.txt` equal the ones GitHub computed; the shipped natives carry `FL_BUILD_ID v0.1.0-beta.41`. The delta
|
||||
from beta.40 is 807,692 bytes beside a full package of 110,708,416 — "Delta processed 0452 files. 0022 patched,
|
||||
0430 unchanged". The wiki was published by run 43113525941. The rehearsal on the release branch (run 43108189693)
|
||||
had made a delta of 841,038 bytes with the same file counts.
|
||||
- ~~**The fix has not been seen to work.** It was written from the log's timing; the fault needs an elevated Agent with
|
||||
PawnIO. Item 39 is the check, and `20_OPEN_QUESTIONS` §M13 stays open until then.~~ **The owner's first seven
|
||||
sessions on beta.41 show no fault** (2026-11-12, 06:38–07:01, read from the Agent's log and a copy of the ledger):
|
||||
not one `advanced:` line, and every session with the option on stored its 212 or 213 series, the processor's 119
|
||||
among them. On beta.40 the same morning the processor device faulted out after **each** of the six sessions
|
||||
recorded between 04:34 and 05:07. The rarer fault — the reader failing to open — was one session in sixteen, so
|
||||
seven clean ones do not yet say it is gone. ~~Whether item 39 has passed is the owner's to say.~~ The owner
|
||||
marked it passed the same day.
|
||||
- **What those sessions say of train B's first release** (the same log and ledger; the owner named which games are
|
||||
first-person — Kingdom Come: Deliverance II, Cyberpunk 2077, Dying Light: The Beast, Valor Mortis — the rest
|
||||
third-person, and Psycho-Sleuth 2D):
|
||||
- **The first FSR 3.1 title read: Kingdom Come: Deliverance II** (FSR 3.1 chosen in the game;
|
||||
`amd_fidelityfx_upscaler_dx12.dll` 4.0.2 behind the loader). Performance mode, 1280×720 to 2560×1440;
|
||||
sharpening on at 0.5; `cameraNear` 0.05 and `cameraFar` 8000 — **both planes, the only title that gives both**;
|
||||
one vertical field of view for the whole session, 63.1°; a reported frame time of 16.67 ms. A 41-second session
|
||||
of the same game that never left its menu read nothing and says so.
|
||||
- **Dying Light: The Beast** upscaling with FSR: sharpening off, 75.4°–78° vertical, 7.5 ms. **Clair Obscur**:
|
||||
sharpening off, 5.7°–90.7° over four minutes. So far the two first-person titles hold a narrow range and the
|
||||
two third-person ones a wide one (Lies of P 21.6°–73.7°) — what one would expect of cutscene and aiming
|
||||
cameras, and no more than that: four titles.
|
||||
- **Three engines give `cameraFar` alone, as a small number** — 10 (Lies of P), 1 (Clair Obscur), 0.1 (Dying
|
||||
Light) — which is the near plane of an inverted, infinite depth with the other plane at `FLT_MAX`. That is the
|
||||
case beta.42's plan has to decide.
|
||||
- **Clair Obscur reports a frame time of 0.001 ms in some seconds.** It is what the game hands FSR, stored as it
|
||||
was said; the lowest value of that series is not a frame time anyone saw.
|
||||
- **Cyberpunk 2077 read nothing**, with FSR frame generation running and the render size known: its upscaling did
|
||||
not come through an ffx-api upscale dispatch in those sessions. Which upscaler it was set to is the owner's to
|
||||
say; `ffxConfigure` (beta.42) is where its frame generation would be read.
|
||||
- **One session of Dying Light names DLSS as its upscaler and carries FSR's quality byte and render size** (81
|
||||
seconds, both an FSR dispatch and a DLSS evaluation seen, "settings changed" not set). Not this train's code —
|
||||
the session summary's choice between two upscalers seen in one session — and not looked into. **The owner,
|
||||
2026-11-12: Dying Light and Expedition 33 were set, in the game, to FSR upscaling with DLSS frame generation.**
|
||||
So "FSR beside DLSS frame generation" in their other sessions is the setting, not a misreading; in this one the
|
||||
summary picked the wrong one of the two for its upscaler line, which is still to be looked at.
|
||||
- **A session without consent says so**: two Cyberpunk sessions before its consent dialog was accepted are
|
||||
Tier 2, and their Advanced row says *not measured inside the game*. **The option off stored nothing** again,
|
||||
this time on a title that upscales with FSR 3.1 (Dying Light, beta.41).
|
||||
- **`LIMITATIONS.md` and the accuracy statement still say the processor's, the memory's and the motherboard's
|
||||
sensors "have never been read on real hardware".** They have been read on one PC and compared with nothing. The
|
||||
owner's to reword.
|
||||
- **SonarCloud's `csharpsquid:S3869` on `ParentDump.cs`** is open on `main` until the owner accepts it again (it was item
|
||||
38 (j), the one part of that item not done; the owner said on 2026-11-12 that they will). Until then `main`'s `sonarcloud` job is red on that one line.
|
||||
- **Items 36 (d) (`LogNoteW`) and 37 are still open**; the ledger shows part of 37 (e) happened — the elevated
|
||||
groups opened and read — and nothing of it was compared with another tool. The alpha line still rests (D98).
|
||||
|
||||
**Owner-only:** ~~item 39~~ passed 2026-11-12, with item 38. Nothing new is open from this release; items 36 (d)
|
||||
and 37 still are.
|
||||
@@ -0,0 +1,204 @@
|
||||
# HANDOFF history — 0.1.0-beta.42
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` when 0.1.0-beta.43 was cut, 2026-11-12 (owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" mean HANDOFF.md as it stood then, and a path it writes is relative to `docs/`. **Its §NEXT item 2 says 0.1.0-beta.43 is "under way"**: it was released the same day, and what it built and decided is HANDOFF.md's section for it.*
|
||||
|
||||
## **START HERE** — 2026-11-12, 0.1.0-beta.42: no new patch site — the label, the registry, a log that outlives the game, the plane at infinity
|
||||
|
||||
*Status is `docs/changelog/0.1.0-beta.42.md`; this is what no other file carries.* The owner marked items 38 and 39
|
||||
passed on 2026-11-12 and train B's second step was planned the same morning. A review of the draft against the code
|
||||
changed it, and the owner split it (D122): **this release adds no patch site**, and the two new hooks are
|
||||
0.1.0-beta.43. Four pull requests and this one: #406 (the session's upscaler label, D120; the decisions D119–D122),
|
||||
#407 (the patch registry), #408 (the native log and the descriptor-type census, D121), #409 (FSR's plane at
|
||||
infinity, D119; Qodana's native report). **What the owner's sessions on beta.40 and beta.41 showed, and the plan as
|
||||
approved, are [`handoff/history/0.1.0-beta.41.md`](handoff/history/0.1.0-beta.41.md)**; what each pull request built
|
||||
is [`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Unhooking and §Native logging, [`03_METRICS.md`](03_METRICS.md)
|
||||
§Upscaling and [`07_IPC.md`](07_IPC.md) §Region 5.
|
||||
|
||||
### What this release decided, beyond D119–D122
|
||||
|
||||
- **The descriptor-type census is not behind the Advanced-metrics switch.** It is a diagnostic that reaches the log
|
||||
file and nothing else — no record, no shared memory, no session — like `HOOK_INSTALLED`. Behind the switch it
|
||||
could not answer D121 for a session recorded with the switch off, which is most of them. Its cost was measured
|
||||
and stated instead (+3.8 ns a dispatch).
|
||||
- **The log's text grew to 72 characters; nothing else about the ring did.** 256 events, static, 24 KiB.
|
||||
- **A slot of the patch registry that was ever live is never reused**, and a failed create or enable leaves the
|
||||
hook created in MinHook as it always did. Both are the smaller change: the first keeps the stop's walk lock-free
|
||||
without a second word per slot, the second changes no failure path that has never been seen to run.
|
||||
- **The live card still names the first upscaler a session saw** (`FgLadder.UpscalerIdentity`). The stored
|
||||
session's name is the modal one (D120); for a session in progress the question is a different one.
|
||||
- **Qodana's "never used" on the registry test's stand-in engines is switched off for that file**, not answered by
|
||||
turning the template into function pointers: the header is loaded into a game, and D100 changes such code only
|
||||
for a defect.
|
||||
|
||||
### What the owner's first four sessions on beta.42 showed (2026-11-12, 09:40–09:53)
|
||||
|
||||
Dying Light: The Beast, Kingdom Come: Deliverance II, Cyberpunk 2077 and Lies of P, each quit from its own menu;
|
||||
read from the four `overlay-<pid>-….log` files, a copy of the ledger, and — for Cyberpunk — the game's own settings
|
||||
file and executable on disk. All four hooked, no fault, no `PATCH_FAILED`, the Agent's log without an `advanced:`
|
||||
line.
|
||||
|
||||
- **D121 is answered, and it is not a detection gap: in that session Cyberpunk 2077 upscaled with FSR 2.1, which is
|
||||
compiled into the game.** Its `UserSettings.json`, written when the session ended, has `ResolutionScaling = FSR2`,
|
||||
`FSR2 = Quality`, `FrameGeneration = FSR3`, `FSR3_FrameGeneration = true` — FSR **2** for the upscale, FSR **3**
|
||||
for frame generation only. Quality is a ratio of 1.5, and the session's render size is 1707×960 at 2560×1440.
|
||||
`Cyberpunk2077.exe` carries FSR 2's own function names (`ffxFsr2GetJitterPhaseCount`,
|
||||
`ffxFsr2GetUpscaleRatioFromQualityMode`) and names one FidelityFX module, the loader; its folder has no FSR 2
|
||||
DLL. **The log says the same from the other side**: the loader (2.3.0), the upscaler leaf (4.1.1) and the
|
||||
frame-generation leaf (4.0.1) were all patched; the loader and the frame-generation leaf were handed `0x20004`
|
||||
(PREPARE) and `0x20003` (FRAMEGENERATION); the loader and the upscaler leaf were asked `0x10002` (the ratio of a
|
||||
quality mode) once at start; **no module was ever handed `0x10001`**, and there is no `UPSCALE_ROUTE` line. The
|
||||
NVIDIA driver's words for the session say DLSS was not running. So the upscale goes through no export at all —
|
||||
the case `LIMITATIONS.md` already names ("FSR 2 and upscalers built into the game are not identified"), and
|
||||
"unknown" beside a measured render size is the true reading. ~~**The owner had said FSR 3 or 4; that the setting is
|
||||
FSR 2.1 is read from the file, and is the owner's to confirm.**~~ **Confirmed by the owner the same morning with
|
||||
a screenshot of the game's Graphics menu: Resolution Scaling reads "AMD FidelityFX Super Resolution 2.1"** (the
|
||||
file's `FSR2`), with its own quality and sharpening rows under it. Nothing to fix for it in beta.43.
|
||||
- **The loader of SDK 2.3 passes a dispatch on to the leaf's export — the older loader does not — and that is a
|
||||
double count waiting for the first title that upscales through it.** In Cyberpunk each frame-generation dispatch
|
||||
type is logged on the loader AND on the frame-generation leaf: the game calls the loader, the loader calls the
|
||||
leaf's exported `ffxDispatch`. In Kingdom Come and Dying Light (loader 1.0.2) the UPSCALE is logged on the loader
|
||||
alone, which is what `fl_hook_inventory.h` measured in September and what the fixture's loader stub copies.
|
||||
Frame generation is unharmed — PREPARE is counted by its frame number, FRAMEGENERATION is a bit, and the
|
||||
session's factor is ×2.0001. **An UPSCALE is counted once per hooked module that sees it**
|
||||
(`g_ffxSeen`'s count): through a 2.3 loader that would be two a frame, and with frame generation off — no
|
||||
PREPARE, so the count falls back to UPSCALE dispatches — the application-frame count would double. Not
|
||||
observed: no UPSCALE was dispatched. **One session answers it: Cyberpunk with Resolution Scaling set to FSR 3
|
||||
and frame generation off** — the log shows whether `0x10001` is on both modules, and the session's frame
|
||||
counts show whether it was counted twice. If so, the fix is beta.43's: count at the first module seen, as
|
||||
`fl::adv::Owns` already does for the Advanced reads.
|
||||
- **The plane at infinity is measured, not a hypothesis any more (D119).** Lies of P: `cameraNear = ∞`,
|
||||
`cameraFar = 10`. Dying Light: `cameraNear = ∞`, `cameraFar = 0.1`. Both gave one plane on beta.41. Kingdom
|
||||
Come still gives both as numbers (0.05 and 8000). Clair Obscur was not run.
|
||||
- **The logs are whole.** Each has its installs by module and symbol, the census as it grew, and lines long after
|
||||
the first second — Dying Light's first UPSCALE at 71.6 s, Kingdom Come's at 37.5 s, when play began. One line
|
||||
looks odd and was not looked into: Cyberpunk's frame-generation leaf's `ffxDispatch` is at `0x241cde7ba10`, far
|
||||
from where the other modules sit (`0x7ff…`); the patch went in and was called.
|
||||
- **Dying Light was named FSR, Quality, with DLSS frame generation ×3.99** — its settings as the owner gave them.
|
||||
No session changed upscaler part-way, so D120's case was not exercised.
|
||||
|
||||
### And three more starts of Cyberpunk 2077, 10:05–10:15 the same morning
|
||||
|
||||
Asked for as "Resolution Scaling = FSR 3, frame generation off". Read the same way.
|
||||
|
||||
- **The game was still on FSR 2.** After the last of them `UserSettings.json` has `ResolutionScaling = FSR2`,
|
||||
`FSR2 = Performance` (it was `Quality` at 09:50), `FSR3 = Auto` untouched, `FrameGeneration = Off`. So the quality
|
||||
and the frame generation were changed and the upscaler was not: **the owner's screenshot of the menu, taken after
|
||||
them, shows Resolution Scaling = "AMD FidelityFX Super Resolution 2.1", Performance, Frame Generation Off** —
|
||||
the file's `FSR2` is the menu's FSR 2.1. Both
|
||||
stored sessions (215 s and 158 s, attached to a game already running) agree with FSR 2.1 built in and frame
|
||||
generation off: every hook in, **not one ffx dispatch or query of any type**, no Streamline evaluation, no render
|
||||
size, upscaler "unknown", factor 1.0 from Streamline's frame tokens, ~290 FPS. **So the 2.3 loader's double count
|
||||
is still unobserved either way**: what answers it is a session in which `UserSettings.json` says
|
||||
`ResolutionScaling = FSR3` afterwards.
|
||||
- **The first start was lost to the transient this file recorded an hour earlier — in a real session this time.**
|
||||
10:05:20 the game appeared; the Overlay went in at 10:05:23; 0.47 s later it was told to stop, and the Agent's
|
||||
log says why: `SafetyUnhook; Discarded (tier 1, exit=UnhookedSafety, frames=0); guard=ModuleScanFailed/a module
|
||||
list came back incomplete`. The Overlay's log shows the four patches restored within 0.75 s. The game ran on
|
||||
unrecorded for two minutes until the owner restarted it. **It is not new and not rare**: the Agent's logs kept on
|
||||
this PC (2026-11-05 onwards) hold five such ends — Phantom Blade Zero three times on 2026-11-05 (two safety
|
||||
unhooks and one refusal before injection), Crown & Coin on 2026-11-10, Cyberpunk today — beside the two test
|
||||
runs. Each is a module list read while the target was still loading modules, at a launch. **The question for the
|
||||
owner is no longer hypothetical**: a list that cannot be read is not a finding, and rule 2 treats it as a refusal
|
||||
so that an unreadable game is never hooked; reading it again a bounded number of times before refusing would
|
||||
keep that — a list that stays unreadable still refuses — and stop losing sessions to a moment of loading. It
|
||||
changes what the guard does on a check, so it is the owner's decision, and it is not made here. *(Made the same
|
||||
day: D123, §NEXT item 1b.)*
|
||||
|
||||
### NEXT
|
||||
|
||||
1. ~~**The owner runs item 40** — above all **one session of Cyberpunk 2077 with FSR upscaling** on beta.42, then
|
||||
quits the game the ordinary way. Its `logs\overlay-<pid>-….log` is what beta.43 waits for.~~ **Run 2026-11-12;
|
||||
the section above is what it showed.** What is left of item 40 is (d), a session that changes upscaler, and
|
||||
the owner's word on the rest.
|
||||
1a. ~~**Before beta.43's plan: one session of Cyberpunk 2077 with Resolution Scaling = FSR 3, frame generation
|
||||
off** (the second bullet above), and a second with it on. It says whether FrameLedger names FSR 3 there —
|
||||
the route through the loader that D121 was first taken to be about — and whether the 2.3 loader counts an
|
||||
UPSCALE twice. *(Tried 2026-11-12 10:08 and 10:12: the game was still on FSR 2 — the section above. The check
|
||||
that the right thing ran is the file: `ResolutionScaling = FSR3`.)*~~
|
||||
**It cannot be run, the owner said the same day: Cyberpunk 2077 has FSR 2.1 as its only FSR upscaler and
|
||||
FSR 3.1 as frame generation only — two separate settings, not a pair; there is no FSR 3 under Resolution
|
||||
Scaling.** So D121 is closed for good — every Cyberpunk session upscaling with FSR reads "unknown", by the
|
||||
limit `LIMITATIONS.md` states — and **no title run so far upscales through a 2.3 loader**. The double
|
||||
count stays unobserved. What IS measured is that this loader hands a frame-generation dispatch to the leaf's
|
||||
export; an UPSCALE through the same `ffxDispatch` would take the same path. beta.43's plan therefore counts
|
||||
an UPSCALE at the first hooked module that sees it (as `fl::adv::Owns` does) as a precaution, with a fixture
|
||||
whose loader forwards to the leaf's export — rather than wait for a session that cannot be had.
|
||||
1b. ~~**The owner's decision on the guard's module-list read** (the section above): refuse at the first incomplete
|
||||
list, as now, or read again a bounded number of times first. If the second, it is a pull request of its own
|
||||
in the guard (`FrameLedger.Injector`), with `19_SAFETY` amended in it, before or with beta.43.~~ **Decided
|
||||
2026-11-12 — read again (D123) — and built the same day**: `Collected::kUnsettled`, up to three re-reads,
|
||||
`19_SAFETY` amended. Not released: it ships with the next pre-release, and until then a launch can still be
|
||||
lost this way on beta.42. What the owner then checks is the Agent's log: no `guard=ModuleScanFailed` end at a
|
||||
game's launch, and if one comes its signal now says which kind — *kept changing while it was read* (four reads
|
||||
were not enough) or *came back incomplete* (more modules than the guard's buffer holds).
|
||||
2. **0.1.0-beta.43 — planned and approved 2026-11-12 (D123–D125), and under way.** The guard's re-read (D123,
|
||||
#413) ships with it and not on its own (D124). Five pull requests after it: (1) an UPSCALE is counted at the
|
||||
first source that saw one (D125) — the fixture's loader bound through the leaves' exports read K = 1 as 2.0
|
||||
before it; (2) `slSetConstants`; (3) `ffxConfigure` on the four ffx modules; (4) the Agent, the App and the
|
||||
Privacy Policy 2.17, whose wording the plan carried and the owner approved with it; (5) the release, owner-only
|
||||
item 41. The design is the one below, as the review of 2026-11-12's first plan left it; nothing in the logs
|
||||
changed it except D125.
|
||||
~~**Read that log, then plan 0.1.0-beta.43**~~ — `slSetConstants` and `ffxConfigure`, and the fix for D121 if the
|
||||
log shows the route. What to look for: which `HOOK_INSTALLED` lines there are (which of the four ffx modules and
|
||||
the FSR 3.0 host were patched); the `FFX_DISPATCH` lines — is `b=0x10001` (UPSCALE) on any module, or only
|
||||
`0x20004` / `0x2000c` / `0x20003`; an `UPSCALE_ROUTE` line; `PATCH_FAILED`; the last `RUNTIME_CENSUS` word.
|
||||
**No UPSCALE type anywhere and no route line means the upscale does not come through any export the Overlay
|
||||
patches** — statically linked, or a module the inventory does not name — and then the fix is not a new arm in
|
||||
a detour. The design for the two hooks, as the review left it, is the plan of 2026-11-12 (moved with the
|
||||
section above) and these points: the new rows are gated at the top of `InstallByFamily`, **before**
|
||||
`ResolveScoped`, and installed only once the process was ever asked; hook families 13 and 14 with latches of
|
||||
their own; `slSetConstants` checks the struct's GUID and `structVersion ≥ 1` on every call and reads only
|
||||
`jitterOffset`, `mvecScale`, `cameraNear` … `cameraAspectRatio` and the seven Booleans — never bytes 368..423,
|
||||
pinned by `offsetof` of the allowed members; summaries from the first viewport seen; `ffxConfigure` has an
|
||||
owner slot of its own and reads `frameGenerationEnabled`, `allowAsyncWorkloads`, `flags`,
|
||||
`onlyPresentGenerated`, `generationRect` and nothing else; the detours also consult `MayObserve()`;
|
||||
`overlay-fields-check` gains three parameter names, `structType` among the shared members and an `offsetof` per
|
||||
listed `sl::Constants` member. The registry holds 48 and the worst case becomes 25
|
||||
(`kPatchSitesOutsideTheInventory` stays 7; the inventory's row count goes from 13 to 18 and its
|
||||
`static_assert` says so).
|
||||
3. **0.1.0-beta.44** — `slGetFeatureVersion` and `slGetFeatureRequirements` — when the owner says beta.43 passed.
|
||||
4. **Trains C and D** (beta.45, beta.46) each begin with a spike and end in the owner's go or no.
|
||||
|
||||
### Left open by this session
|
||||
|
||||
- ~~**This release's own facts** — the tag's run, the digests, the delta — are not in any file yet: the release is cut
|
||||
after this text. Record them in the next pull request.~~ **Recorded 2026-11-12: 0.1.0-beta.42 was released
|
||||
2026-11-12T02:31:07Z** (09:31 in the owner's time zone) from the signed tag on `a708ae8` (#410), by run
|
||||
43139775713 — green at the first attempt, one run for the one tag push. Eight assets; the seven digests of
|
||||
`SHA256SUMS.txt` equal the ones GitHub computed; the four shipped natives carry `FL_BUILD_ID v0.1.0-beta.42`. The
|
||||
delta from beta.41 is 710,943 bytes beside a full package of 110,716,228 — "Delta processed 0452 files. 0023
|
||||
patched, 0429 unchanged". The wiki was published by run 43142009098. The rehearsal on the release branch (run
|
||||
43137520796) had made a delta of 735,485 bytes with the same file counts.
|
||||
- **No real game was run on this build.** The four changes were tested with the harness and the cost measured on
|
||||
the headers. Item 40 is the first real session.
|
||||
- **Whether the missing plane of Lies of P, Clair Obscur and Dying Light is `FLT_MAX`** is still the reading their
|
||||
small `cameraFar` values point to, not a measurement. Item 40 (c).
|
||||
- **A flake with a cause now, and a question in it for the owner.**
|
||||
`ShmDrainIntegrationTests.TheGuardInjectsTheOverlayAndTheReaderDrainsRealFrames` was red once in this release's
|
||||
local gate (and once on 2026-11-11, when the assertion did not yet print the verdict): the supervisor's first
|
||||
re-scan, 0.8 s after the injection, came back `ModuleScanFailed` — *a module list came back incomplete* — while
|
||||
the harness was still loading modules. The same gate was green on the same code before and after. In the test
|
||||
it is a re-run. **In a real session the same answer is a safety unhook**: a re-scan that cannot read the module
|
||||
list of a game that is still running stops the session (`19_SAFETY` §During a session; D48 covers only a game
|
||||
that has exited). Whether the guard should read the list a second time before refusing is a change to rule 2's
|
||||
checks and is the owner's to decide; nothing was changed. **A second one within the hour, in the gate of the pull
|
||||
request that records the release's facts:**
|
||||
`ToolhelpProcessSnapshotSourceTests.ThisProcessIsInTheSnapshotWithItsNormalisedImagePathAndACreationTime` got an
|
||||
empty snapshot — `ToolhelpProcessSnapshotSource.Take` returns an empty list when the snapshot cannot be taken or
|
||||
walked, and says nothing. Green on the run after. Both are Windows refusing, for a moment, to enumerate something
|
||||
on a PC that was building, testing and running FrameLedger itself at once; what an empty snapshot does to the
|
||||
watcher's tick in a real session was not looked into.
|
||||
- ~~**SonarCloud has not answered for #406–#409**: `main`'s `sonarcloud` job was cancelled by the next merge each
|
||||
time. It runs to its end on this release's commit; read it then.~~ **It answered on `a708ae8`: the quality gate
|
||||
passed, and one issue was open on `main`** — `cpp:S5813`, a `strlen` in the helper the new log case of
|
||||
`guard_test.cpp` reads lines with (#408). Fixed in the pull request that records these facts: the helper takes
|
||||
strings. **`csharpsquid:S3869` on `ParentDump.cs` is no longer open** — SonarCloud shows it accepted at
|
||||
2026-11-11T21:13Z (04:13 on the 12th, the owner's time), which is before the texts that still called it open
|
||||
were written; they were not checked against SonarCloud then. **Qodana's two reports are green on the release's
|
||||
commit**; the native one was red from #407 to #408 on seven problems in test code, answered in #409.
|
||||
- **`LIMITATIONS.md` and the accuracy statement still say the processor's, the memory's and the motherboard's
|
||||
sensors "have never been read on real hardware"** — the owner's to reword. ~~**SonarCloud's `csharpsquid:S3869` on
|
||||
`ParentDump.cs`** is the owner's to accept.~~ *(Done — the line above.)* **Items 36 (d) and 37 are still open.** The alpha line still rests
|
||||
(D98).
|
||||
|
||||
**Owner-only:** item 40.
|
||||
@@ -0,0 +1,154 @@
|
||||
# HANDOFF history — 0.1.0-beta.43
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` when 0.1.0-beta.44 was cut, 2026-11-12 (owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" mean HANDOFF.md as it stood then, and a path it writes is relative to `docs/`. **Its §NEXT item 2 says 0.1.0-beta.44 is planned**: it was released the same day, and what it built and decided is HANDOFF.md's section for it.*
|
||||
|
||||
## **START HERE** — 2026-11-12, 0.1.0-beta.43: two hooks installed only where asked for, the guard reads a moving list again, an UPSCALE counted once
|
||||
|
||||
*Status is `docs/changelog/0.1.0-beta.43.md`; this is what no other file carries.* The owner ran beta.42 the morning
|
||||
it was released; seven sessions, a copy of the ledger and the logs answered D121 (Cyberpunk 2077's FSR is 2.1, built
|
||||
into the game), showed the guard losing launches to a module list that moved while it was read, and showed the
|
||||
FidelityFX 2.3 loader handing a call on to the leaf's export. The owner decided D123–D125 and approved the plan the
|
||||
same morning, Privacy Policy 2.17's wording with it. Five pull requests and this one: #413 (the guard reads again,
|
||||
D123), #414 (an UPSCALE is counted at the first source that saw one, D125; D124), #415 (`slSetConstants`), #416
|
||||
(`ffxConfigure` on the four ffx-api modules), #417 (the Agent, the App, Privacy Policy 2.17). **What the owner's
|
||||
sessions on beta.42 showed, and the design as planned, are
|
||||
[`handoff/history/0.1.0-beta.42.md`](handoff/history/0.1.0-beta.42.md)**; what each pull request built is
|
||||
[`19_SAFETY_AND_ANTICHEAT.md`](19_SAFETY_AND_ANTICHEAT.md) §Pre-injection checks,
|
||||
[`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Hook inventory (the two rows, with their measured cost) and
|
||||
[`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Train B.
|
||||
|
||||
### What this release decided, beyond D123–D125
|
||||
|
||||
- **A hook that exists only for Advanced metrics is not put into a game that was never asked.** The two rows are
|
||||
gated at the top of `InstallByFamily`, before the symbol is resolved (resolving holds the module). Once a
|
||||
session with the option on has started in a process, the patch goes in on that watchdog tick and **stays for the
|
||||
life of the process**: a later session with the option off finds the detour there, forwarding without looking.
|
||||
Removing a patch between sessions would be a second patch event in a running game for nothing gained. So "off
|
||||
means off" (D111) is, for these two: nothing read, nothing published — and, in a game no session ever asked,
|
||||
nothing patched. Privacy Policy 2.17 §4 says it that way.
|
||||
- **Privacy Policy 2.17, not 2.16 stretched.** beta.40's plan had 2.16 stand "once for the three releases"; its
|
||||
text then listed DLSS's and FSR's parameters by name, and neither list holds Streamline's constants or the
|
||||
frame-generation configuration. The plan of beta.43 carried the new sentences and the owner approved them with it.
|
||||
**beta.44 reads feature versions and requirements — check 2.17's lists the same way before assuming it covers
|
||||
them.**
|
||||
- **For each of the two calls a session says which of three things happened** (`AdvancedInGameCall`): read; hooked
|
||||
and the game never called; not hooked. "Not hooked" is three causes the session does not tell apart — the game
|
||||
did not load the library, a Streamline 1.x interposer (refused), a patch the registry refused — and the Overlay's
|
||||
log does: a `HOOK_INSTALLED` line naming the function, or a `PATCH_FAILED`.
|
||||
- **A count is not part of what makes a session's facts new.** `sl.constants.resets` grows all session; the
|
||||
recorder's context would be rewritten each second. `InGameAdvancedSampler.Conclude` brings it up to date once, at
|
||||
the end. A session recovered after a crash holds the count as of the last time some other field moved — a lower
|
||||
bound.
|
||||
- **Streamline's summaries are the first viewport's**, and the configure count has an owner slot of its own (the
|
||||
2.3 loader would otherwise bring one configure to two modules, as D125's dispatch).
|
||||
- **The accuracy statement no longer says nothing of what a game tells its upscaler was read from a real game.**
|
||||
FSR's upscaling values were (beta.41, beta.42: Lies of P, Dying Light: The Beast, Kingdom Come: Deliverance II).
|
||||
The DLSS options, Streamline's constants and the frame-generation configuration are still unconfirmed, and the
|
||||
three copies say so.
|
||||
|
||||
### Traps this train left
|
||||
|
||||
- **An unpatched export may already begin with a jump.** The loader stub's `ffxConfigure` starts with `E9` in the
|
||||
file: "the first byte is not a jump" is not a test of "not patched". `ReadTargetExportBytes` compares the target's
|
||||
bytes with the file's own (`inFile`).
|
||||
- **A branch stacked on a pull request that is then squashed**: `git rebase --onto origin/main <the old tip>`, and
|
||||
`git diff <old tip> <squash>` empty says the gate that ran still stands.
|
||||
- **`mcp__ccd_pr__set_auto_merge` says "not bound" for a pull request opened from a script**: `gh pr merge <n>
|
||||
--auto --squash`. A run's artifacts while it is still in progress: `gh api
|
||||
repos/…/actions/artifacts/<id>/zip`.
|
||||
- **clang-format re-wraps what an edit script wrote**, so a second script's anchors must be read from the formatted
|
||||
file; a multi-file script that fails part-way has already written the earlier files.
|
||||
- **One local gate printed 871 App tests where every other printed 872**, green. Not looked into.
|
||||
|
||||
### What the owner's nine sessions on beta.43 showed (2026-11-12)
|
||||
|
||||
Run 15:42–16:21 in the owner's time zone, read the same afternoon from a copy of the ledger (sessions 171–179), the
|
||||
Agent's log, the nine overlay logs and Windows' application log. Advanced metrics was on for the first eight and off
|
||||
for the last.
|
||||
|
||||
| # | Game | What it showed |
|
||||
|---|---|---|
|
||||
| 171 | Phantom Blade Zero, 649 s, DLSS frame generation ×3.0 | Streamline 2.14.1: **read** — jitter ≤ 0.47, motion-vector scale 0.0009 / 0.0016, near 0.01 and far 75,000 with depth inverted, field of view 0.6545–1.3612 rad, aspect 1.7767, 1 reset. FSR frame generation: hooked on the loader and both leaves, the game never called |
|
||||
| 172 | Lies of P, 35 s, exit code 3 | 542 frames, nothing evaluated. **The owner: the game crashed after a shader failed to compile.** The crash policy counted it and turned the game's hooking off (below) |
|
||||
| 173 | Lies of P, 130 s | Tier 2 — hooking was off; the owner switched it on again at 16:02 |
|
||||
| 174 | Lies of P, 94 s, FSR 3 + FSR frame generation ×2.0 | **`ffxConfigure` read** on the one-module `amd_fidelityfx_dx12.dll`: frame generation on and off, not asynchronous, generated frames not presented alone, 2560 × 1440 at 0, 0; the log has `FFX_CONFIGURE` types `0x10007` and `0x20002`. Streamline: not hooked (the game has none) |
|
||||
| 175 | Cyberpunk 2077, 72 s, no upscaler named, no frame generation | Streamline 2.14.1: **read** — jitter ≤ 0.5, motion-vector scale 1 / 1, near 0.02 and far 16,000 inverted, aspect 1.7778, **field of view 51.0055–90**, 2,575 resets |
|
||||
| 176 | Cyberpunk 2077, 145 s, DLSS + DLSS frame generation ×2.0 | the same values; 1,821 resets. FSR frame generation: hooked on the loader and both leaves, never called |
|
||||
| 177 | Kingdom Come: Deliverance II, 135 s, FSR | Streamline: not hooked. `ffxConfigure` hooked on the loader and the upscaler, never called — the game ships no frame generation |
|
||||
| 178 | Hogwarts Legacy, 158 s, DLSS frame generation ×4.0 | Streamline 2.14.16: **read** — jitter ≤ 0.47, field of view 0.8872–2.0071 rad, aspect 1.7763, near 0.01 and far 75,000 inverted, 11 resets. `ffxConfigure` hooked on `amd_fidelityfx_dx12.dll`, never called |
|
||||
| 179 | Lies of P, 129 s, **Advanced metrics off**, a new Agent, the game started afresh | no Advanced row; bits 13 and 14 clear in `hooks_installed_mask`; the log has `ffxDispatch` and `ffxQuery` and **no `ffxConfigure` line** |
|
||||
|
||||
- **The two hooks did what they were built to do on four real games**, three Streamline builds apart (2.14.1 twice,
|
||||
2.14.16) and one FSR library. No `PATCH_FAILED`, no fault counted, in nine logs. `legal_acceptance` holds Privacy
|
||||
Policy 2.17 accepted once, four seconds after the update; no session since the update ended with
|
||||
`guard=ModuleScanFailed` (the day's one is beta.42's, at 10:05).
|
||||
- **Cyberpunk 2077 gives Streamline its field of view in degrees.** The vendor's header says radians; the game
|
||||
passes 51–90. Every other field of the same struct is sane (the aspect ratio beside it is 1.7778), so the layout
|
||||
is not in question — the game's unit is. The page prints `51.0055 – 90 rad (2922.4° – 5156.6°)`: **a defect of
|
||||
the label, not of the reading**, and beta.44's first pull request. The two stored sessions keep the string they
|
||||
were stored with.
|
||||
- **A resets count has no denominator.** 2,575 in a 72 s session that was mostly menus and 1,821 in 145 s on
|
||||
Cyberpunk, beside 1 and 11 on the two Unreal games. It is what the game said (`reset == eTrue`, the first
|
||||
viewport's calls); the page does not say out of how many calls.
|
||||
- **A frame-generation configuration with no flag set has no flags row**, where an upscale with none says `none`.
|
||||
- **Lies of P's 35 s end turned its hooking off, and one such end is now enough.** `hook_crash_count` is never set
|
||||
back: the game's two ends of 2026-10-19/20 (`19_SAFETY` §Crash & stability safety, the hand-off to Steam) had
|
||||
brought it to 2, the owner had switched hooking on again, and today's single early end made 3 — at or over
|
||||
`CrashesToDisable`, so hooking went off at once, under a reason that says *twice*. Whether switching hooking back
|
||||
on starts the count again is the owner's decision; it is asked with beta.44's plan.
|
||||
- **Hogwarts Legacy faults in the driver's `_nvngx.dll` as it exits, hooked or not.** Windows' application log has
|
||||
the same fault (0xc0000005 at +0x6aa85, `_nvngx.dll` 32.0.16.2114) six times since 2026-11-06, each at the end
|
||||
of one of the game's seven recorded sessions — the first of them session 131, which nothing was injected into.
|
||||
That one reads `crashed`; the five hooked ones, today's 178 among them, read `normal` with exit code 0, the
|
||||
fault logged in the second the session was saved. **Why a hooked session does not see the crash event that an
|
||||
unhooked one does was not looked into.**
|
||||
- **Frame rates as before**, where the settings were: Lies of P 59 → 118 (beta.42: 58.9 → 118.0), Kingdom Come 59.3
|
||||
(59.4), Hogwarts Legacy 58.8 → 235.8 at ×4 (alpha.3: 56.1 → 225.1). Phantom Blade Zero's factor moves between
|
||||
sessions under the driver's dynamic mode (×2.9 to ×4.1 since 2026-11-05) and Cyberpunk was run with other settings.
|
||||
- **Not exercised**: a configure through the FidelityFX 2.3 loader (Cyberpunk 2077 with FSR frame generation) — the
|
||||
configure count's owner slot has not met a real game; a game with neither library; Dying Light: The Beast.
|
||||
Phantom Blade Zero and Hogwarts Legacy name no upscaler beside DLSS frame generation, as on every release before.
|
||||
|
||||
### NEXT
|
||||
|
||||
1. ~~**The owner runs item 41**~~ **Run and read 2026-11-12** (§What the owner's nine sessions on beta.43 showed).
|
||||
The owner's word was to go on if it passed, and it is judged passed: both hooks read real games, nothing
|
||||
failed to patch, off meant off. What was not exercised is listed there and stays open.
|
||||
2. **0.1.0-beta.44** — first the field of view a game gives in degrees (and what else the nine sessions found),
|
||||
then `slGetFeatureVersion` and `slGetFeatureRequirements`. Both are calls a game makes while starting, so most
|
||||
sessions will have missed them: plan what "not seen" says. ~~**Planned with the owner before any code.**~~ **The
|
||||
plan was approved 2026-11-12 with three decisions, D126–D128** (the count of early abnormal ends starts again
|
||||
at a grant; the fault at exit is written down only; a field of view over π is shown as given), and with Privacy
|
||||
Policy 2.18's wording. Four pull requests: the fixes; the two hooks in the Overlay; the Agent, the App and the
|
||||
policy; the release.
|
||||
3. **Trains C and D** (beta.45, beta.46) each begin with a spike and end in the owner's go or no.
|
||||
|
||||
### Left open by this session
|
||||
|
||||
- ~~**This release's own facts** — the tag's run, the digests, the delta — are not in any file yet: the release is cut
|
||||
after this text. Record them in the next pull request, with what SonarCloud and Qodana said of #413–#417 (the
|
||||
`sonarcloud` job on `main` is cancelled by the next merge, so it answers on the release's commit).~~ **Recorded
|
||||
2026-11-12: 0.1.0-beta.43 was released 2026-11-12T06:57:57Z** (13:57 in the owner's time zone) from the signed
|
||||
tag on `6c7ba74` (#418), by run 43169675460 — green at the first attempt, one run for the one tag push. Eight
|
||||
assets; the seven digests of `SHA256SUMS.txt` equal the ones GitHub computed; the four shipped natives carry
|
||||
`FL_BUILD_ID v0.1.0-beta.43`. The delta from beta.42 is 1,934,264 bytes beside a full package of 110,736,398 —
|
||||
"Delta processed 0452 files. 0025 patched, 0427 unchanged". The wiki was published by run 43171842051. The
|
||||
rehearsal on the release branch (run 43167388933, the same tree before it was rebased onto #417's squash) had
|
||||
made a delta of 1,944,086 bytes with the same file counts. **SonarCloud answered on `6c7ba74`: the quality gate
|
||||
passed and no issue is open on `main`. Qodana's two reports are green on that commit**, and were on #417's.
|
||||
- ~~**No real game was run on this build.** Two new patch sites, tested with the harness and the stubs; their cost
|
||||
measured on the headers. Whether a real `sl.interposer.dll` 2.x lays `sl::Constants` out as the vendored header
|
||||
does is checked on every call by the struct's GUID and version, not by a real game yet.~~ **Nine sessions on five
|
||||
games, 2026-11-12** (§What the owner's nine sessions on beta.43 showed): interposers 2.14.1 and 2.14.16 lay the
|
||||
struct out as the header does. **The accuracy statement's three copies and `LIMITATIONS.md` still say Streamline's
|
||||
constants and the frame-generation configuration "have not been confirmed" on a real game** — reworded with
|
||||
beta.44's first pull request. **`docs/LIST_GAME_TESTED.md` is as of 2026-11-06**: refreshing it is a new copy and
|
||||
the owner's review.
|
||||
- **Item 40 (d)** — a session that changes upscaler — was not exercised, and the owner has not said item 40 passed.
|
||||
**Items 36 (d) and 37 are still open.**
|
||||
- **What an empty process snapshot does to the watcher's tick in a real session** was not looked into
|
||||
(`ToolhelpProcessSnapshotSource.Take` returns an empty list and says nothing; seen once in a test on 2026-11-12).
|
||||
- **`LIMITATIONS.md` and the accuracy statement still say the processor's, the memory's and the motherboard's
|
||||
sensors "have never been read on real hardware"** — the owner's to reword. The alpha line still rests (D98).
|
||||
|
||||
**Owner-only:** what item 41 left unexercised — (d) through the FidelityFX 2.3 loader, (e) a game with neither library; item 40 (d).
|
||||
@@ -0,0 +1,182 @@
|
||||
# HANDOFF history — 0.1.0-beta.44
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` when 0.1.0-beta.45 was cut, 2026-11-12 (owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" mean HANDOFF.md as it stood then, and a path it writes is relative to `docs/`. **Its §NEXT says 0.1.0-beta.45 is planned**: it was released the same day, and what it built and decided is HANDOFF.md's section for it.*
|
||||
|
||||
## **START HERE** — 2026-11-12, 0.1.0-beta.44: what the first real games on beta.43 found, fixed; Streamline's answers about a feature, hooked only where asked
|
||||
|
||||
*Status is `docs/changelog/0.1.0-beta.44.md`; this is what no other file carries.* The owner ran nine sessions on
|
||||
beta.43 the afternoon it was released and said: read them, write down the result, go on if it passes. They were read
|
||||
from a copy of the ledger, the Agent's log, nine overlay logs and Windows' application log (#420); item 41 was judged
|
||||
passed, and the owner decided D126–D128 and approved the plan the same afternoon, Privacy Policy 2.18's wording with
|
||||
it. Four pull requests and this one: #421 (the fixes: a field of view in degrees, the count of early abnormal ends,
|
||||
`flags` of `none`; D126–D128), #422 (`slGetFeatureVersion` and `slGetFeatureRequirements` in the Overlay), #423
|
||||
(the Agent, the App, Privacy Policy 2.18). **What the nine sessions showed, session by session, is
|
||||
[`handoff/history/0.1.0-beta.43.md`](handoff/history/0.1.0-beta.43.md)**; what each pull request built is
|
||||
[`19_SAFETY_AND_ANTICHEAT.md`](19_SAFETY_AND_ANTICHEAT.md) §Crash & stability safety,
|
||||
[`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Hook inventory (the row of the two calls, with their measured cost) and
|
||||
[`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Train B.
|
||||
|
||||
### What this release decided, beyond D126–D128
|
||||
|
||||
- **What is read of these two calls is the answer, and only a good one.** The detours call the original first and
|
||||
read the struct the game passed when it returned `eOk`; a refusal leaves the struct as the game made it, and the
|
||||
fixture's stub leaves 99s in it to prove nothing of a refused answer is kept. The pointers the answer carries —
|
||||
the list of required buffer tags, the names of Vulkan extensions and features — are never followed; the stub's
|
||||
are wild, and no fault is counted.
|
||||
- **The feature slots are the one group of region 5 a new request does not empty.** Every other group is a
|
||||
session's — ranges, counts, switches seen. Which version a feature is and what it requires are facts about the
|
||||
process, and a game asks once: a second session of a game that kept running would have nothing where the first
|
||||
had the answer. `Reset` keeps the slots and their bit of the mask. They were read only while a session asked.
|
||||
- **The two rows are the first of the table, because rows are patched in the table's order.** Nothing in the
|
||||
Overlay paces the installs: the 0.1–0.25 s between `HOOK_INSTALLED` lines in the owner's logs is MinHook stopping
|
||||
every thread of the game for each patch. In a process that was asked, the two calls a game makes while starting
|
||||
are the ones that cannot wait behind five others; in a process never asked, the two rows are passed over before
|
||||
anything is resolved.
|
||||
- **"Hooked, and the game did not call" has words of its own for a call made while starting**
|
||||
(`AdvInGameCall_NotAskedAgain`). For a call made every frame it is a finding about the game; for these two it is
|
||||
what every late attach will say. One bit of the mask covers both questions, so which was answered is told by the
|
||||
slots (`InGameAdvancedSampler.FeatureCall`).
|
||||
- **Privacy Policy 2.18, not 2.17 stretched**: 2.17 says "two further calls" and lists what they give. 2.18 also
|
||||
says what of the answer is never read.
|
||||
- **The rows are the vendor's words**: `kFeatureDLSS_G · versionNGX`, the requirement flags by their enumerators,
|
||||
an id this build has no name for as `feature <number>`. A version of all zeros has no row, except `versionSL`.
|
||||
- **The Agent's end-to-end tests run a Streamline target now** (until this release only an FSR one): the constants
|
||||
and the two answers, through the shipped Agent and the real Overlay.
|
||||
- **A field of view over π is two rows** (D128): the number, and `cameraFOV unit` with the token `not_radians` —
|
||||
a token replaces a row's value in the App, so a note beside a number is a row of its own.
|
||||
- **The count of early abnormal ends is set back by the consent grant and by nothing else** (D126) — the one
|
||||
statement that turns hooking on. `hook_autodisabled_reason` and `_at` stay as the row's history; the App shows
|
||||
them only while hooking is off.
|
||||
|
||||
### Traps this train left
|
||||
|
||||
- **`vswhere -latest` names SQL Server Management Studio on this PC.** Ask for the C++ tools as `build.ps1` does
|
||||
(`-requires Microsoft.VisualStudio.Component.VC.Tools.x86.x64`). The `x64-release` preset writes no
|
||||
`compile_commands.json`: `ninja -C build/native/x64-release -t commands FrameLedger.Overlay` gives the Overlay's
|
||||
flags for a bench.
|
||||
- **Run clang-format on the native files an edit script wrote before the gate** — the format check comes after the
|
||||
native build and tests, and a miss costs the whole run.
|
||||
- **`tools/resx-gen.ps1` needs `-Resx src/FrameLedger.App/Strings.resx`**; started without it from a shell that
|
||||
has no console it waits for the missing parameter until it is stopped.
|
||||
- **A Python script passed to a shell as a here-document loses its backslashes** before Python sees them: write
|
||||
the script to a file.
|
||||
- **`gh pr checks --watch` returns at once when no check has started yet**; wait a moment before starting it.
|
||||
- **Qodana's native report is advisory, and auto-merge does not wait for it.** On #422 it reported three
|
||||
`bugprone-implicit-widening-of-multiplication-result` in the test and the harness (an index into the feature
|
||||
slots computed as a product of two 32-bit values: compute it in `size_t`) while the required checks were still
|
||||
running; auto-merge was switched off until the fix was pushed. A finished job's log while its run is still going:
|
||||
`gh api repos/…/actions/jobs/<id>/logs --allow-escape-sequences`; the report's SARIF is a zip inside the
|
||||
artifact's zip.
|
||||
- **GPG's pinentry timed out once** (the cache had expired); the second attempt went through when the owner was
|
||||
at the keyboard.
|
||||
|
||||
### What the owner's eight sessions on beta.44 showed (2026-11-12)
|
||||
|
||||
Run 19:52–20:46 in the owner's time zone, read the same evening from a copy of the ledger (sessions 181–188), the
|
||||
Agent's log, eight overlay logs and Windows' application log. Advanced metrics was on throughout.
|
||||
|
||||
| # | Game | What it showed |
|
||||
|---|---|---|
|
||||
| 181 | Phantom Blade Zero, 796 s, DLSS frame generation ×4.0 | Streamline 2.14.1. **Both questions read**: versions of `kFeatureReflex`, `kFeatureDLSS_G`, `kFeaturePCL`; requirements of those and `kFeatureDeepDVC`. The constants as on beta.43 |
|
||||
| 182 | Clair Obscur: Expedition 33, 107 s, FSR + DLSS frame generation ×3.0 | Streamline 2.7.30. **Both read** (`kFeatureDLSS_G`, `kFeatureReflex`, `kFeaturePCL`); the constants and FSR's upscale values read beside them |
|
||||
| 183 | Valor Mortis (Microsoft Store), 51 s, **crashed** — exit code `0xC0000005` | Streamline 2.14.1. Both read before it ended. The game's second early abnormal end, so hooking went off (below) |
|
||||
| 184 | Valor Mortis, 935 s, ×6.0 | hooking switched on again at 20:11; both read; ended normally |
|
||||
| 185 | Black Myth: Wukong, 167 s, ×4.0 | Streamline 2.7.4. Both read |
|
||||
| 186 | Cyberpunk 2077, 257 s, DLSS + DLSS frame generation ×2.0 | **The field of view reads `51.0055 – 90` with a row `cameraFOV unit` = *not radians*** (D128). Requirements **read** for `kFeatureDLSS`, `kFeatureDLSS_RR`, `kFeatureDLSS_G`, `kFeatureReflex`, `kFeatureNIS`; the version question *hooked, not asked again* |
|
||||
| 187, 188 | Kingdom Come: Deliverance II, 39 s and 289 s | no Streamline: the constants and both questions *not hooked*; `ffxConfigure` hooked and never called. Neither session reached an FSR dispatch (the upscaler's first query came 11 s before the second one ended) |
|
||||
|
||||
- **The two questions were read in six of six Streamline sessions, on five games** — the plan, the release notes
|
||||
and four documents said most sessions would show nothing, because a game asks while it starts. Unreal's
|
||||
Streamline plugin (four of the five games) asks again after the attach, and Cyberpunk 2077 asks for requirements
|
||||
again; only Cyberpunk's version question was *not asked again*. The three answers of the line were each seen.
|
||||
The documents are corrected in the same pull request as this text.
|
||||
- **What was read agrees with the PC.** `driverVersionDetected` 621.14.0 is the snapshot's driver
|
||||
(`32.0.16.2114`), `osVersionDetected` 10.0.29648 its Windows build, `versionNGX` of `kFeatureDLSS_G` the file
|
||||
version of the game's `nvngx_dlssg.dll` (310.9.1, 310.6.0), `versionSL` of Reflex and PCL the interposer's.
|
||||
- **`kFeatureDLSS_G`'s `versionSL` is 2.14.16 on three games that ship 2.14.1 or 2.7.30** (Phantom Blade Zero,
|
||||
Valor Mortis, Clair Obscur): Streamline answers for a newer frame-generation plugin than the game's own folder
|
||||
holds. Which file that is was not looked into — an updated plugin delivered by NVIDIA's app is the likely one.
|
||||
It is the first value of this kind that a file's version could not have given.
|
||||
- **No Unreal game asked about `kFeatureDLSS`.** Their DLSS upscaling does not go through Streamline (Cyberpunk's
|
||||
does: it is asked about, and the session names DLSS). That is the likely reason Phantom Blade Zero, Hogwarts
|
||||
Legacy, Valor Mortis and Black Myth: Wukong name no upscaler beside DLSS frame generation — the question left
|
||||
open since beta.43. Naming it would take a hook on NGX, which this project does not have.
|
||||
- **Valor Mortis crashed 51 s into a hooked session, as it did on beta.40.** Session 141 (2026-11-12 02:44,
|
||||
beta.40: `0xC0000005` after 51 s, 498 frames) and session 183 (20:09, beta.44: the same code after 51 s, 8,077
|
||||
frames); the session after each ran normally under the same build. So it is not this release's hooks. Whether
|
||||
FrameLedger has any part in it is not known: Windows logged no event for either (a Store package), and there is
|
||||
no unhooked start to compare. **The crash policy did what D126 says**: today's was the game's second early end, so
|
||||
hooking went off at 20:09:52; the owner switched it on at 20:11:03 and the count is 0.
|
||||
- **Black Myth: Wukong faults in Steam's `crashhandler64.dll` as it exits** (0xc0000409 at +0x39b49) — at each of
|
||||
its three recorded exits, all hooked (beta.40 twice, beta.44 once); each session reads `normal`, the shape D127
|
||||
wrote down for Hogwarts Legacy. **There is no unhooked exit to compare**: one session of it with hooking off
|
||||
would say whether FrameLedger has a part.
|
||||
- **No `PATCH_FAILED`, no fault counted, in eight logs**; Privacy Policy 2.18 was accepted once, eight seconds
|
||||
after the update. The two new rows are the first Streamline `HOOK_INSTALLED` lines of every log. Frame rates as
|
||||
before where the settings were: Clair Obscur 106 → 323 (beta.41: 106 → 318), Valor Mortis 39.6 → 237 (37.7 →
|
||||
228). Wukong's native rate was 90 where beta.40's two sessions had 124; nothing says whether the scene and
|
||||
settings were the same.
|
||||
- **Not exercised: off means off** — every session had Advanced metrics on. And, from item 41: a configure through
|
||||
the FidelityFX 2.3 loader.
|
||||
|
||||
### NEXT
|
||||
|
||||
1. ~~**The owner runs item 42**~~ **Run and read 2026-11-12** (§What the owner's eight sessions on beta.44
|
||||
showed): both hooks read real games — far more often than planned for — the degrees fix reads right on
|
||||
Cyberpunk 2077, a game with no Streamline says *not hooked*. *Off means off* was not exercised.
|
||||
2. **The next version, by the owner's word of 2026-11-12: `slInit`, `slIsFeatureSupported` "and some other parts"**
|
||||
— said the evening beta.44 came out, to be done if beta.44 passed, and then "update and go on" once these
|
||||
sessions were in. It reopens D112 (`slInit` is not hooked in train B; if ever: never `applicationId`,
|
||||
`projectId`, the paths), and `slIsFeatureSupported` is handed an `sl::AdapterInfo` whose `deviceLUID` and
|
||||
`vkPhysicalDevice` are not to be read (D104). ~~**Planned with the owner before any code**: which other parts,
|
||||
what of each is read, the Privacy Policy's wording, and where train C goes.~~ **Planned and approved 2026-11-12
|
||||
(D129–D131)**: `slInit` stays out — shown why it cannot be seen, the owner chose so; six calls go in, in one
|
||||
release, **0.1.0-beta.45** — `slIsFeatureSupported`, `slIsFeatureLoaded`, `slSetFeatureLoaded`,
|
||||
`slAllocateResources`, `slFreeResources`, `slShutdown`; Privacy Policy 2.19's wording approved with the plan.
|
||||
Pull requests: three hooks, three hooks, the Agent and the App with the policy, the release.
|
||||
3. **Train C (Reflex latency per frame)**: its spike is written beside beta.45, a document only; code waits for the
|
||||
owner's go after reading it. **Train D** after that, the same way.
|
||||
|
||||
### Left open by this session
|
||||
|
||||
- ~~**This release's own facts** — the tag's run, the digests, the delta — are not in any file yet: the release is cut
|
||||
after this text. Record them in the next pull request, with what SonarCloud and Qodana said.~~ **Recorded
|
||||
2026-11-12: 0.1.0-beta.44 was released 2026-11-12T12:24:26Z** (19:24 in the owner's time zone) from the signed
|
||||
tag on `f9e9fdb` (#424), by run 43214789700 — green at the first attempt, one run for the one tag push. Eight
|
||||
assets; the seven digests of `SHA256SUMS.txt` equal the ones GitHub computed; the four shipped natives carry
|
||||
`FL_BUILD_ID v0.1.0-beta.44`. The delta from beta.43 is 1,866,183 bytes beside a full package of 110,750,960 —
|
||||
"Delta processed 0452 files. 0025 patched, 0427 unchanged". The wiki was published by run 43217647799. The
|
||||
rehearsal on the release branch (run 43204362797, at `56b1157` — the released tree but for two namespace
|
||||
qualifiers #423 dropped afterwards) had made a delta of 1,878,774 bytes with the same file counts. **SonarCloud
|
||||
answered on `f9e9fdb`: the quality gate passed and no issue is open on `main`. Qodana's two reports are green on
|
||||
that commit.** Qodana found two things on the way, each fixed before its pull request merged: three index
|
||||
products in the injected test and the harness (#422, native), and two namespace qualifiers a new `using` made
|
||||
redundant (#423, managed) — #423's auto-merge was held until that report was in. **`check` failed once on
|
||||
#424**, a pull request that changes no code: the CaptureHost's launch-mode end-to-end test
|
||||
(`LaunchModeStartsTheHarnessItselfAndReportsWhatRanUnhooked`) read 19.8 presented frames a second from the
|
||||
harness on a slow runner where it asks for more than 30; the job was run again and passed. A rate asserted
|
||||
against a wall clock on a shared runner — the one flake of this train, not looked into further.
|
||||
- ~~**No real game was run on this build.** Two new patch sites, tested with the harness and the stub; their cost
|
||||
measured on the headers.~~ **Eight sessions on six games, 2026-11-12** (§What the owner's eight sessions on
|
||||
beta.44 showed). **The release notes on GitHub still say "most sessions will show nothing of the two new
|
||||
readings"** — a prediction the sessions did not bear out; `docs/changelog/0.1.0-beta.44.md` is a released file
|
||||
and is not edited, and the published notes were left as they are.
|
||||
- **Valor Mortis's crash at 51 s** (twice, beta.40 and beta.44) **and Black Myth: Wukong's fault in Steam's crash
|
||||
handler at every exit** are not explained. One session of each with hooking off is the comparison that is missing.
|
||||
- **What item 41 left unexercised**: a configure through the FidelityFX 2.3 loader (Cyberpunk 2077 with FSR frame
|
||||
generation), a game with neither library.
|
||||
- **A fault while a game is closing is not seen by a hooked session** (D127: written down, not changed). Looking
|
||||
again later would make every session of Hogwarts Legacy `crashed`, and under a user-mode exception would end the
|
||||
exception for a fault no hook caused; the decision is the owner's, and is not taken.
|
||||
- ~~**Phantom Blade Zero and Hogwarts Legacy name no upscaler beside DLSS frame generation**, as on every release
|
||||
before; not looked into.~~ **Likely answered 2026-11-12**: no Unreal game asks Streamline about `kFeatureDLSS`, so
|
||||
their DLSS upscaling does not pass through the calls this project hooks.
|
||||
- **`docs/LIST_GAME_TESTED.md` is as of 2026-11-06**: refreshing it is a new copy of the ledger and the owner's review.
|
||||
- **Item 40 (d)** was not exercised and the owner has not said item 40 passed. **Items 36 (d) and 37 are still open.**
|
||||
- **What an empty process snapshot does to the watcher's tick in a real session** was not looked into (seen once in
|
||||
a test on 2026-11-12).
|
||||
- **`LIMITATIONS.md` and the accuracy statement still say the processor's, the memory's and the motherboard's
|
||||
sensors "have never been read on real hardware"** — the owner's to reword. The alpha line still rests (D98).
|
||||
|
||||
**Owner-only:** item 42 (f), and one session each of Valor Mortis and Black Myth: Wukong with hooking off; what
|
||||
item 41 left unexercised; item 40 (d).
|
||||
@@ -1,6 +1,6 @@
|
||||
# Owner-only items that passed
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` §Owner-only on 2026-10-19 (beta.24, owner decision D66): the items the owner reported passed or took, numbers kept — a number is never reused. The open ones stay in `docs/HANDOFF.md`.*
|
||||
*Moved verbatim from `docs/HANDOFF.md` §Owner-only on 2026-10-19 (beta.24, owner decision D66): the items the owner reported passed or took, numbers kept — a number is never reused. The open ones stay in `docs/HANDOFF.md`. Items that passed later are added below as they pass (38 and 39 on 2026-11-12).*
|
||||
|
||||
3. ~~**Which titles** go in `blockedExecutables` — a product decision with false-refusal
|
||||
consequences. The list ships empty until it is taken.~~ **Taken 2026-09-25 (D30):** per-title
|
||||
@@ -66,4 +66,40 @@
|
||||
page and choose its longest session, switch the page's tabs; visit the Dashboard a few times, then end a session —
|
||||
one "Session saved". (e) The Privacy Policy 2.11 is shown once after the update. (f) The `ja` strings marked
|
||||
`review`.
|
||||
|
||||
38. ~~**beta.40, Advanced metrics inside a real game**~~ **Passed 2026-11-12** — the owner ran it on ten games over one night (beta.40, then beta.41), was shown what a copy of the ledger and the Agent's log said of those sessions, and answered: "Bạn có thể đánh dấu là pass và tiếp tục." What the sessions covered: (b) the option off storing nothing, on a DLSS title and on an FSR 3.1 one; (c) three titles upscaling through FSR 3.1 — Kingdom Come: Deliverance II (chosen in the game), Dying Light: The Beast and Clair Obscur: Expedition 33, the last two with **FSR upscaling beside DLSS frame generation, which is how the owner had set them in the game** — and Lies of P through FSR 3; (d) every DLSS title saying *the game made none of the calls*, none chaining its options into the evaluation; (e) the sentence under the session in each of its three forms; (g) Girls' Frontline 2 under the user-mode exception. **Not exercised, and passed on the owner's word**: (f) two sessions of one game that kept running; (h) the cost; (i) the words. **(j) is not done**: the SonarCloud acceptance is still the owner's to click, and stands in HANDOFF §Left open. Valor Mortis's one crash was the game's own (a shader-compilation error, its own crash dialog — the owner). *(The item as written:)* (D111–D116; train B's first release — beta.41 is not begun
|
||||
until this passes). (a) **The update from beta.39**: the terms window shows the **Privacy Policy 2.16** once, and
|
||||
not the Disclaimer; a game that was **running across the update** is refused until it is restarted, with the
|
||||
reason, and measured normally after. (b) **The option off, a hooked game that uses DLSS or FSR**: the game runs
|
||||
and is measured as in beta.39; the session is not on the Advanced page's list; nothing in the Agent's or the
|
||||
Overlay's log mentions the upscaler's options. (c) **The option on, a title that upscales through FSR 3.1 or
|
||||
later** (AMD's `amd_fidelityfx_*.dll` in its folder; a title on the older FSR 3.0 interface, such as one that
|
||||
ships `ffx_fsr3_x64.dll` alone, is expected to show none): on *Session*, under Upscaling, sharpening on or off
|
||||
and its strength against the game's own setting; the field of view as a range, against the game's slider (it is
|
||||
the **vertical** angle, in radians with degrees beside it) — and wider after zooming or aiming; the near and far
|
||||
planes; the flags; the chart of the frame time the game reported beside the session's own frame time; FSR's
|
||||
memory only if the game asks for it. (d) **The option on, a DLSS title**: most are expected to say *the game made
|
||||
none of the calls these are read from*. If one shows rows, this is the first sight of them anywhere: the output
|
||||
size against the display resolution, the preset letters against the NVIDIA app's override or the DLSS
|
||||
indicator, HDR input against the game's HDR setting. Write down which title did. (e) **The sentence under the
|
||||
session** says which of the three it was, and the session's summary still names the upscaler and its quality as
|
||||
before. (f) **Two sessions of one game that kept running**, both with the option on: the second one's field-of-
|
||||
view range and counts are its own, not the first one's carried over. (g) **A game under the user-mode anti-cheat
|
||||
exception**, the option on: it runs, the session is hooked, and its trial is not ended by anything new. (h) **What
|
||||
it costs**: the game's own frame rate with the option on and off, and the Agent's processor time in a hooked
|
||||
session (NFR-2: 2.5 % of one core). (i) **The words**: the fourteen new `vi` strings and the Settings text; the
|
||||
`ja` ones are marked `review`. (j) **SonarCloud**: accept `csharpsquid:S3869` on
|
||||
`src/FrameLedger.Infrastructure/Diagnostics/ParentDump.cs` again — the same call the acceptance of beta.24 covers,
|
||||
raised anew because #398 moved it (`13_CI_CD` §SonarCloud says why it is safe); until then `main`'s reliability
|
||||
rating on new code shows E for that one line.
|
||||
39. ~~**beta.41, the sensor library on the PC that showed the fault**~~ **Passed 2026-11-12** — the same answer. Seven sessions on beta.41 as administrator with PawnIO, no `advanced:` line in the Agent's log, 212 or 213 series in each session with the option on; on beta.40 the same morning the processor device faulted out after each of six sessions. **Not exercised**: (c) the page after a session was not looked at by anyone but the owner; (d) the unelevated run; (e) no value beside HWiNFO — that stays item 37 (e). The rarer fault, the reader failing to open, was one session in sixteen; `20_OPEN_QUESTIONS` §M13 keeps the count. *(The item as written:)* (D118; `20_OPEN_QUESTIONS` §M13). (a) **The
|
||||
update from beta.40**: no terms window, the ledger opens as before; a game running across the update is refused
|
||||
until restarted, as after every update. (b) **As administrator with PawnIO, Advanced metrics on**: five or more
|
||||
sessions of different games, some with the Advanced page left open on *This PC* throughout, some with it closed,
|
||||
one started within a few seconds of another ending. **Afterwards the Agent's log (Logs page, or
|
||||
`agent-<date>.log`) holds no `advanced: a device is left alone` and no `advanced: the sensor library did not
|
||||
open`**, and every one of those sessions has its processor, memory and motherboard readings on *Session* (about
|
||||
two hundred series; a session with seventeen is the fault). (c) **The page after a session ends**: the
|
||||
processor's rows on *This PC* are still there and still moving, without reopening the page. (d) **Not as
|
||||
administrator**: nothing differs from beta.40 — the card's sensors and the driver's figures, and *Sources* says
|
||||
why the rest is not read. (e) While there, the part of item 37 (e) nobody has done: a few of the processor's and
|
||||
the motherboard's values beside HWiNFO.
|
||||
@@ -63,6 +63,89 @@ are kept because they record what each version changed and why (owner decision D
|
||||
>
|
||||
> Version 2.5 (2026-09-27, 0.1.0-beta.10) adds how a tracked game's window is shown — read from Windows — and the engine build name read from an Unreal Engine game's executable. It is also the first version to say two things the software already did: it reads the **content** of a library game's executable (markers in its first 8 MB and its import table, since the detection of engines and features; and, when a session starts, the graphics-library markers in the whole file), and it reads the processor load and the memory in use (since 0.1.0-beta.3). Nothing here leaves your device, as before.
|
||||
|
||||
### What version 2.19 of the Privacy Policy changed (0.1.0-beta.45)
|
||||
|
||||
**Six more calls read inside the game, only while Advanced metrics is on** (train B's fourth step, owner decisions
|
||||
D129–D131; the wording approved with the plan of 0.1.0-beta.45). Version 2.18 named Streamline's answers to two
|
||||
questions about a feature — its version, what it requires — and "four further calls". This release reads two more
|
||||
answers and four things the game does, none of which is in that list, so the version moves. §1's item on Advanced
|
||||
metrics gains, **for each Streamline feature the game asks about or controls: whether Streamline answers that it is
|
||||
supported, whether it is loaded, whether the game switched it on or off while it ran, and how many times its
|
||||
resources were allocated and freed; and whether the game shut Streamline down, and how many times**. It also says
|
||||
two more things that are never read: **what identifies the graphics card that the game hands over with its
|
||||
question** — `slIsFeatureSupported` takes an `sl::AdapterInfo`, the adapter's LUID or a Vulkan physical device,
|
||||
which D131 forbids and a check in the build refuses by name — and **the content of a graphics resource**: the two
|
||||
resource calls take a command buffer and a viewport, forwarded and never looked at. §4's "four further calls" is
|
||||
ten, its "two questions" are four, and its list of what is stored names the new facts and repeats that what
|
||||
identifies the card is not among them. What the game started Streamline with (`slInit`) is not in the policy
|
||||
because it is not read, and will not be (D129). The accuracy block's item says what the new rows are — calls the
|
||||
game made, counted to fifteen, not a statement that a feature ran. The Disclaimer stays 2.15. §2 is unchanged:
|
||||
nothing is sent.
|
||||
|
||||
### What version 2.18 of the Privacy Policy changed (0.1.0-beta.44)
|
||||
|
||||
**Two more calls read inside the game, only while Advanced metrics is on** (train B's third step, owner decisions
|
||||
D126–D128 beside it; the wording approved with the plan of 0.1.0-beta.44). Version 2.17 named Streamline's per-frame
|
||||
constants and the frame-generation configuration, and "two further calls"; this release reads what Streamline
|
||||
**answers** when the game asks about a feature, which is in neither list, so the version moves. §1's item on
|
||||
Advanced metrics gains **which features the game asked about, the version of each and of its NGX model, and what
|
||||
each requires** — the graphics APIs it supports, whether V-Sync must be off and hardware-accelerated GPU scheduling
|
||||
on, how many processor threads, viewports and buffers, and the versions of Windows and of the graphics driver that
|
||||
Streamline found beside the ones the feature needs. It also says what of that answer is never read: **the lists it
|
||||
points to** — the buffers' names, the names of Vulkan extensions and features — which a check in the build holds
|
||||
(the count of required buffers is read; its list is not). §4's "two further calls" is four, and its list of what is
|
||||
stored names the versions and requirements. The versions of Windows and of the driver are the ones Streamline
|
||||
reports to the game; FrameLedger already stores the driver's version with a session's hardware. The accuracy
|
||||
block's item says what these are — Streamline's answers, not a check of the PC — and that a game asks while it
|
||||
starts, so most sessions have none. The Disclaimer stays 2.15. §2 is unchanged: nothing is sent.
|
||||
|
||||
### What version 2.17 of the Privacy Policy changed (0.1.0-beta.43)
|
||||
|
||||
**Two more calls read inside the game, only while Advanced metrics is on** (train B's second step, owner decisions
|
||||
D122–D125; the wording approved with the plan of 0.1.0-beta.43). Version 2.16 named what a session stores of DLSS and
|
||||
of FSR's upscaling item by item, and neither list holds what this release reads, so the version moves rather than
|
||||
the words being stretched. §1's item on Advanced metrics gains **what the game told NVIDIA Streamline about each
|
||||
frame** — the size of the jitter, the motion-vector scale, the depth range and whether depth is inverted, the lowest
|
||||
and highest field of view, the aspect ratio, whether the projection is orthographic, how its motion vectors are
|
||||
stored and how often it reset the upscaler's history — and **how it configured FSR frame generation** — on or off,
|
||||
whether it may run asynchronously, its flags, whether only generated frames are presented, and the rectangle it
|
||||
generates in. The sentence on what is never read (where the camera is, which way it looks, its matrices) stands as
|
||||
it was: those sit in the same data as Streamline's constants, and a check in the build refuses code that names them.
|
||||
§4 says what is new about *how*: until now every parameter read was of a call FrameLedger intercepted anyway; these
|
||||
two calls are intercepted in a game **only once a session with the option on has started there**, and with the
|
||||
option off nothing in the game is touched for them. The accuracy block's item on what a game tells its upscaler
|
||||
names the two, and no longer says none of it was read from a real game — FSR's upscaling values were, on
|
||||
0.1.0-beta.41 and beta.42. The Disclaimer stays 2.15, as before. §2 is unchanged: nothing is sent.
|
||||
|
||||
### What version 2.16 of the Privacy Policy changed (0.1.0-beta.40)
|
||||
|
||||
**Advanced metrics inside the game** (train B, owner decisions D111–D116; the content approved with the plan, once
|
||||
for the train's three releases). §1's item on Advanced metrics gains what a session stores **for a game FrameLedger
|
||||
injects into, only while the option is on**: what the game passed to its upscaler in the calls FrameLedger
|
||||
intercepts — the output size, presets and exposure values it gave DLSS, whether it said its colour buffers are HDR,
|
||||
auto-exposure and alpha upscaling; the sharpening, the jitter's size, the exposure, the depth range, the lowest and
|
||||
highest field of view and the flags it gave FSR, the frame time it reported, FSR's own memory when the game asked —
|
||||
and what is never read: where the camera is, which way it looks, its matrices. It also says that switching the option
|
||||
off stops the reading inside a game as well. §4 had always named "the parameters your games pass to the graphics APIs
|
||||
it intercepts"; it now says that with the option on more of the upscaling calls' parameters are read **and stored**,
|
||||
which is what is new. The accuracy block gains an item: these are the game's words to the upscaler, not a check of
|
||||
what the upscaler did, and many games show none. The Disclaimer stays 2.15, as the accuracy statement's additions
|
||||
have not moved it before (beta.19, beta.20, beta.25). §2 is unchanged: nothing is sent.
|
||||
|
||||
### What version 2.15 of the Privacy Policy and of the Disclaimer changed (0.1.0-beta.39)
|
||||
|
||||
**Advanced metrics** (owner decisions D101–D108; the Privacy Policy's content approved with the plan, the Disclaimer's
|
||||
two sentences by the owner's answer of 2026-11-11). Privacy Policy §1 gains one item — what a session stores **only
|
||||
while the option is on**: more sensor series of the graphics card, and of the processor, the memory and the motherboard
|
||||
when the Agent runs as administrator with PawnIO; a description of the hardware; what each display can do and what the
|
||||
game's display did; the graphics driver's settings, global and for the game — and what is never read: a serial
|
||||
number, a display's EDID, a list of other programs. §3A says an export and a bug report do not carry it. §4 names the
|
||||
same as things the software can observe, only while the option is on. The Disclaimer's §5 and §5A said PawnIO and the
|
||||
admin mode were for the CPU temperature alone; both now name the processor's, the memory's and the motherboard's
|
||||
sensors with the option on. The accuracy block gains an item that says none of these readings has been checked
|
||||
against another tool. §2 is unchanged: nothing is sent, as before. (Versions 2.12 to 2.14 of the Privacy Policy and
|
||||
2.12 to 2.14 of the Disclaimer are recorded in the changelog of the release that carried each.)
|
||||
|
||||
### What version 2.11 of the Privacy Policy changed (0.1.0-beta.23)
|
||||
|
||||
A game's page shows its artwork (beta.23 PR-3, owner decisions D60/D61; the wording approved with the plan). §1 adds the
|
||||
|
||||
@@ -51,3 +51,6 @@ Each section below lives in its own file under `docs/spike-notes/`, moved verbat
|
||||
| §25 | Xbox app / Microsoft Store (GDK) titles — the layout, the launch chain, the image paths (2026-11-03, beta.33, D77–D82) | [`spike-notes/25-xbox-gdk.md`](spike-notes/25-xbox-gdk.md) |
|
||||
| §26 | DLSS 5 on Hogwarts Legacy, Dynamic frame generation on Phantom Blade Zero, and Streamline 2.12 → 2.14.16 (2026-11-06, beta.34, D83, D84) | [`spike-notes/26-dlss5-dynamic-streamline.md`](spike-notes/26-dlss5-dynamic-streamline.md) |
|
||||
| §27 | Switching to Games, and a language change that lands elsewhere (2026-11-06, beta.34) | [`spike-notes/27-games-page-2026-11-06.md`](spike-notes/27-games-page-2026-11-06.md) |
|
||||
| §28 | The main line on .NET 11's release — the whole gate, and what the analyses read (2026-11-11, beta.37, D94–D96) | [`spike-notes/28-dotnet11-main.md`](spike-notes/28-dotnet11-main.md) |
|
||||
| §29 | C# 15 against the checks — the canary, and where its constructs would go (2026-11-11, beta.37, D96) | [`spike-notes/29-csharp15-canary.md`](spike-notes/29-csharp15-canary.md) |
|
||||
| §30 | Reflex latency per frame — the routes there are, and what each would cost; a reading, nothing run (2026-11-12, beside beta.45, D130; §M14) | [`spike-notes/30-reflex-latency.md`](spike-notes/30-reflex-latency.md) |
|
||||
@@ -99,7 +99,7 @@ The last thing P1 owes (§R4 moved it here because it needs P2's drain and recor
|
||||
| 2 | OFF | | | |
|
||||
| 3 | OFF | | | |
|
||||
|
||||
Gates: FPS delta ≤ 0.5 %, Agent CPU ≤ 1 % of a core, Agent RSS ≤ 150 MB. **Overlay resident ≤ 8 MB is
|
||||
Gates: FPS delta ≤ 0.5 %, Agent CPU ≤ 1 % of a core *(≤ 2.5 % since 2026-11-11, D117)*, Agent RSS ≤ 150 MB. **Overlay resident ≤ 8 MB is
|
||||
not measured by the runbook** and is left blank rather than guessed: it is a module inside the game
|
||||
process, and reading the target's memory is what CLAUDE.md rule 4 forbids — an external tool that
|
||||
inspects module sizes is the way to fill it.
|
||||
|
||||
@@ -0,0 +1,46 @@
|
||||
## 28 · The main line on .NET 11's release — the whole gate, and what the analyses read *(2026-11-11, beta.37, owner decisions D94–D96)*
|
||||
|
||||
**Why this was measured.** The owner moved the main line to .NET 11 the day after it shipped (D94), setting aside the
|
||||
condition `20_OPEN_QUESTIONS` §G had written for it — two alphas on the released runtime. §24 measured Release Candidate
|
||||
3 on a throwaway branch; nothing had measured the release, and three things had never met .NET 11 at all: CodeQL's C#
|
||||
analysis (a required check, main-only), SonarCloud's scanner, and a Velopack delta across two runtime majors. This note
|
||||
is what stood in for the condition that was set aside.
|
||||
|
||||
**Where.** The dev box of §Environment (Windows 11 Pro build 29648, i7-14700KF, RTX 5080). SDK `11.0.100`, runtime and
|
||||
Windows Desktop `11.0.0` (released 2026-11-10), installed beside the 10.0 SDKs. The hosted runner: image
|
||||
`windows-2025-vs2026`, Visual Studio 18 Enterprise, MSVC 14.51.
|
||||
|
||||
**The switch, on main this time** (branch `beta37/pr1-net11`): `global.json` → `11.0.100`, `allowPrerelease` false;
|
||||
`Directory.Build.props` → `net11.0-windows10.0.22621.0`; `Microsoft.Extensions.Hosting`, `Microsoft.Data.Sqlite`,
|
||||
`System.Diagnostics.EventLog` → `11.0.0`; `legal/licenses/nuget/` regenerated (78 packages → 69, the alpha's set at
|
||||
released versions). Nothing else in the build.
|
||||
|
||||
**What the release asked of the source that RC3 had not.** Two sites, both in tests written after the last alpha was
|
||||
cut (beta.35's `ContrastThemeTests.Drawn.cs`): CA1307 on `string.StartsWith(char)` and `string.EndsWith(char)`, which
|
||||
.NET 11 gives a `StringComparison` overload. They take that overload now — the main line compiles against .NET 11, so
|
||||
§24's rule (a form .NET 10 also compiles) no longer binds. The 21 sites §24 fixed stayed quiet.
|
||||
|
||||
**`IHost.RunAsync`, observed for the first time.** §24 read Microsoft's note that a failed `BackgroundService` now fails
|
||||
`RunAsync` and recorded that no test pinned it. `HostBackgroundFailureTests` does: a host with one service that throws
|
||||
fails `RunAsync` with that exception on 11.0.0. The Agent's `--serve` therefore leaves through its crash report
|
||||
(`10_LOGGING` §Crash handling) where it exited 0 on .NET 10; it was accepted, not wrapped.
|
||||
|
||||
**The gate, on the dev box (`./build.ps1 check`, 338 s, all gates passed).** Native: 32 of 32 suites. Managed: the build
|
||||
with warnings as errors, 0 warnings; `dotnet format` clean; 2,561 tests passed and 2 skipped in the six projects (Domain
|
||||
429, Infrastructure 578 and the 2 skipped, Application 568, CaptureHost 137 with its end-to-end cases, App 816, Agent
|
||||
33), every one on `net11.0`; the coverage floors held (12 reports); `license-check` green on the regenerated texts. No
|
||||
test changed its answer between .NET 10 and .NET 11.
|
||||
|
||||
**The pull request's own runs (#376, 2026-11-11), which were the first of each on .NET 11:**
|
||||
|
||||
| Run | What it showed |
|
||||
|---|---|
|
||||
| `check` (42916490997) | green in 12 min 22 s on the hosted runner, SDK 11.0.100 installed by `setup-dotnet` from `global.json` |
|
||||
| `analyze (csharp, none)` (42916491104, CodeQL 2.27.4) | green in 4 min 5 s. Build mode `none` used the runner's 11.0.100 SDK for references (on .NET 10 it downloaded 10.0.100 itself): 1,221 source files found, 363 references resolved and none unresolved, 9 types unresolved (main's last run on .NET 10: 23 in three `Windows.Win32` namespaces), and "CodeQL scanned 1220 out of 1220 C# files" — the same line as main's last run. CodeQL's documentation lists C# up to 14 and .NET up to 10; *(Corrected the same day: this was an **overlay** analysis — the changed files, on top of `main`'s cached database — and its "1220 out of 1220" was `main`'s baseline. The whole source was read by `main`'s run after the merge, 42921492229: "Overlay mode not enabled", 1,221 files found and "CodeQL scanned 1221 out of 1221 C# files", 363 references resolved, none unresolved, 23 types unresolved as on .NET 10, 4 min 45 s.)* `net11.0` with source that uses no C# 15 construct is read whole |
|
||||
| `analyze (cpp, manual)` | green, 7 min 7 s — the native layer did not change |
|
||||
| `sonarcloud` | green, the gate passed: the SonarScanner for .NET 12.0.0 (a `netcoreapp3.1` tool that rolls forward to the newest major) ran on the 11.0 runtime |
|
||||
| Qodana (42916491047), the Community linter with the interim | the `bootstrap` line installed SDK 11.0.100 into the container, InspectCode 2026.2.3.1 loaded all thirteen `net11.0-windows` projects, and it reported **1 problem**: a redundant `!` in the new test, fixed in the same pull request |
|
||||
| `release.yml` rehearsal on the branch (42916488083, `0.1.0-beta.37`) | green. `setup-dotnet` installed SDK 11.0.100 and, for `vpk` 1.2.161, the .NET 10 line (SDK 10.0.404, runtime 10.0.15). **The first delta across two runtime majors**: "Delta processed 0443 files. 0372 patched, 0071 unchanged, 0009 new, 0017 removed" — 72,604,898 bytes, against a full package of 110,314,263 (beta.36's: 107,902,117) and a `Setup.exe` of 117,828,375 |
|
||||
|
||||
**Not measured here.** An installed build on real hardware and a hooked title on .NET 11.0.0 (owner-only item 34);
|
||||
Windows 10 22H2, which no version of FrameLedger has been run on; a processor without x86-64-v2.
|
||||
@@ -0,0 +1,61 @@
|
||||
## 29 · C# 15 against the checks — the canary, and where its constructs would go *(2026-11-11, beta.37, owner decision D96)*
|
||||
|
||||
**Why this was measured.** The owner asked for C# 15 on the main line in the same release that moved it to .NET 11 (D96).
|
||||
The plan's rule, approved with it: a construct is used only where (1) the build, its analyzers and `dotnet format` take
|
||||
it without an analyzer being switched off, (2) CodeQL extracts its file without an error, and (3) Qodana does not report
|
||||
errors that are only its engine not knowing the syntax. So each construct was written once, in a file of its own, and
|
||||
shown to each tool before any product code used it.
|
||||
|
||||
**The canary** (branch `probe/csharp15-canary`, draft pull request #377, closed unmerged): four files under
|
||||
`tests/FrameLedger.Domain.Tests/Canary/`, one construct each, each with a test that runs —
|
||||
|
||||
```csharp
|
||||
HashSet<string> set = [with(StringComparer.OrdinalIgnoreCase), "a", "A"]; // collection expression arguments
|
||||
private closed record State; private sealed record Idle : State; // a closed hierarchy, switched over
|
||||
private union Pet(Cat, Dog); // a union, switched over
|
||||
outer: foreach (int[] row in rows) { foreach (int cell in row) { if (cell < 0) { continue outer; } } } // a labeled jump
|
||||
```
|
||||
|
||||
**What each tool made of them.**
|
||||
|
||||
| Construct | SDK 11.0.100's compiler, its analyzers (`latest-all`), Roslynator 5.0.1, Meziantou 3.0.319, VS Threading 18.12.1 | `dotnet format` | ReSharper's engine: InspectCode 2026.2.3.1 (what Qodana 2026.2 runs) | InspectCode 2026.3.0 (the newest released) |
|
||||
|---|---|---|---|---|
|
||||
| Collection expression arguments, `[with(…), …]` | builds, 0 warnings | clean | **error** — "Feature 'collection expression arguments' is not available. Please use language version 'preview'." | the same error |
|
||||
| Closed hierarchy, `closed record` | builds, 0 warnings; the switch needs no default arm | clean | **not parsed** — "Cannot resolve symbol 'closed'", "Unexpected token", then CS8509 on the switch it reads as open | the same |
|
||||
| Union, `union Pet(Cat, Dog)` | builds **only with CA1815 silenced**: the SDK's own rule asks every union — a struct — to override `Equals` and the equality operators | clean | **not parsed** — "Cannot resolve symbol 'union'", "Identifier expected" | the same |
|
||||
| Labeled `continue` / `break` | builds, 0 warnings | **moves the label one indent to the left** (`csharp_indent_labels`), the statement staying on its line | **not parsed** — "; expected", "Cannot resolve symbol 'outer'", and the loop's tail read as unreachable | **error** — "Feature 'labeled break and continue' is not available. Please use language version 'preview'." |
|
||||
|
||||
The four tests passed. No analyzer threw on a syntax node it did not know (an `AD0001` would have been an error here).
|
||||
InspectCode was run on the dev box with `--toolset-path` at SDK 11.0.100's `MSBuild.dll`, a fresh caches folder each
|
||||
time; 2026.2.3.1 reported 29 results in the four files, 2026.3.0 24.
|
||||
|
||||
**CodeQL (2.27.4): not established, and why a pull request cannot establish it.** `analyze (csharp, none)` was green on
|
||||
the canary's pull request in 3 min 10 s, and its log says "Reading overlay changes": on a pull request the C# analysis is
|
||||
an **overlay** — it extracts the files the pull request changed on top of the database cached from `main` — and its log
|
||||
prints no per-file extraction result. "CodeQL scanned 1220 out of 1220 C# files" is `main`'s baseline figure, printed
|
||||
unchanged on a pull request that had added eight files. The SARIF the code-scanning API returns carries no extraction
|
||||
notification. CodeQL's documentation lists C# up to 14. So this run neither shows that CodeQL reads these constructs nor
|
||||
that it does not; a full analysis needs a run that is not a pull request's (`codeql.yml` takes `workflow_dispatch`
|
||||
since this pull request, for that).
|
||||
|
||||
**The conclusion, by the rule.** No C# 15 construct is used on the main line in 0.1.0-beta.37: every one of the four
|
||||
fails condition (3) — Qodana's engine would report errors in each file that used one, on a gate of zero — and the union
|
||||
fails (1) as well. What the main line takes from .NET 11 in this release is **API, not syntax**: the
|
||||
`string.StartsWith` / `EndsWith` / `LastIndexOf(char, StringComparison)` overloads (sixteen call sites that §24's rule had
|
||||
written as spans, or that §28 fixed), and `Process.TryGetProcessById` in place of a caught `ArgumentException`.
|
||||
|
||||
**What unblocks each, and where it would go** — the survey of 2026-11-11 over the thirteen projects, kept so the next
|
||||
attempt starts from it:
|
||||
|
||||
| Construct | Waits for | Where it would go |
|
||||
|---|---|---|
|
||||
| `[with(comparer), …]` | a ReSharper engine that reads C# 15 as released, in the Qodana linter | the seven sites §24 wrote with explicit `StringComparer.Ordinal` constructors for MA0002, and about fifteen more local `HashSet`/`SortedSet` constructions (`GameFileProbe`, `CaptureOrchestrator`, `LibraryImporter`, `GameTitleGuess`, …). Not the `IReadOnlySet`-typed statics (not a collection-expression target) nor `ConcurrentDictionary` |
|
||||
| `closed` | the same; and CodeQL's reading, measured by a dispatched run | `Application/Watch/WatchEvent` (the one abstract record in `src/`); and, as closed record hierarchies rather than unions, the hand-written "one of" shapes: `Domain/Detection/EngineMatch` (with `RuleEvaluator.MatchPlatform`), `Application/Recording/FgVerdict` with the identity and the withheld reason it travels with, `Application/Telemetry/GameProcess`, the Agent's private `ElevationDecision` |
|
||||
| `union` | the same, **and** CA1815 settled — a union that must hand-write its equality is not shorter than what it replaces | only a value that is one of several *existing* types: `IRingAttacher.TryAttach`'s `(ICaptureSink?, ShmAttachRefusal)` |
|
||||
| Labeled `continue` | the same | one site: `Infrastructure/Detection/InstallRoot.cs`, the `hit` flag |
|
||||
| Extension indexers | — | nowhere: the six extension methods in `src/` are not index-like |
|
||||
|
||||
**Left as they are, whatever the tools read:** the enums whose names are stored or cross a wire
|
||||
(`SessionEndReason`, `AntiCheatRefusalReason`, `ShmAttachRefusal`, `Tri`), and `AntiCheatVerdict` (it mirrors a native
|
||||
result, and "zeroed means not evaluated" is a rule of the guard). And the two preview features — runtime-async and the
|
||||
updated memory-safety rules — which D76's "no preview feature" still excludes.
|
||||
@@ -0,0 +1,176 @@
|
||||
## 30 · Reflex latency per frame — the routes there are, and what each would cost *(2026-11-12, written beside 0.1.0-beta.45, owner decision D130; `20_OPEN_QUESTIONS` §M14)*
|
||||
|
||||
**Why this was written.** Train C of Advanced metrics is "Reflex latency per frame" (`18_GPU_VENDOR_APIS` §The
|
||||
trains). §M14 asks whether any route to it stays inside rules 4 and 5, and pre-commits the answer for the case
|
||||
that none does. The owner decided on 2026-11-12 (D130) that this spike is written beside 0.1.0-beta.45 **as a
|
||||
document**, and that no code of train C is written until the owner has read it and said go or no.
|
||||
|
||||
**What this is, and what it is not.** A reading — of the vendored NVAPI headers
|
||||
(`src/native/third_party/nvapi/nvapi.h`, `nvapi_interface.h`), of Streamline's public headers and plugin source
|
||||
at tag `v2.14.16` (`include/sl_reflex.h`, `include/sl_pcl.h`, `source/plugins/sl.reflex/reflexEntry.cpp`,
|
||||
`source/plugins/sl.pcl/pclstats.h`, `pclImpl.h`; fetched through GitHub's API, not vendored), of this
|
||||
repository's own hook engine, and of a copy of the owner's ledger; one file on the dev box was looked at, the
|
||||
export table of the installed `nvapi64.dll`. **Nothing was run in a game and no shipped code changed.** Every
|
||||
"unknown" below is unknown, not assumed either way.
|
||||
|
||||
### What Reflex's numbers are, and who holds each
|
||||
|
||||
| What | Where it lives | The catalog entry that wants it |
|
||||
|---|---|---|
|
||||
| **The per-frame report**: for each of the last 64 frames, the times of input sample, simulation start/end, render submit start/end, present start/end, driver start/end, OS render queue start/end, GPU render start/end, and two durations (`gpuActiveRenderTimeUs`, `gpuFrameTimeUs`) | The **driver**. A program gets it by calling `NvAPI_D3D_GetLatency(pDev, NV_LATENCY_RESULT_PARAMS*)` with the game's own device; Streamline's `slReflexGetState` makes that call and hands the same 64 reports back as `sl::ReflexState::frameReport` | `nvapi.reflex.frame_report`, `sl.reflex.state` |
|
||||
| **The driver's low-latency state**: low-latency mode on, the last sleep interval, whether the game calls the sleep, the frame-generation multiplier last used | The driver: `NvAPI_D3D_GetSleepStatus(pDev, …)` | `nvapi.reflex.sleep_status` |
|
||||
| **What the game asked for**: low latency or low latency with boost, the frame-rate limit, whether markers may steer the driver | Only the **arguments** of `NvAPI_D3D_SetSleepMode` or of Streamline's `slReflexSetOptions` — no getter returns boost or the limit | `nvapi.reflex.mode` |
|
||||
| **The markers the game sets** each frame (simulation start … present end, the latency ping, the flash trigger) | The arguments of `NvAPI_D3D_SetLatencyMarker` / `slPCLSetMarker`; the PCL plugin also writes each as an ETW event | `sl.pcl.markers` |
|
||||
|
||||
`FlFrameRecord.reflexLatencyUs` (@48, "0 = unavailable") has waited for this since the record was designed, and
|
||||
`03_METRICS` lists *PC latency* as "mean/p95 of `reflexLatencyUs` when Reflex reports it". **A report cannot go
|
||||
into its own frame's record**: the driver completes a frame's report after that frame's GPU work ends, several
|
||||
presents after the record was written, and a ring record is never rewritten. Whatever route is taken, latency
|
||||
arrives as a series beside the frames, not as a column of them.
|
||||
|
||||
### What the owner's sessions already say
|
||||
|
||||
From 0.1.0-beta.44's `sl.feature.versions` / `sl.feature.requirements` (sessions 181–186 of the ledger's copy;
|
||||
`docs/HANDOFF.md`, item 42):
|
||||
|
||||
| Game (session) | Interposer | Asked Streamline about `kFeatureReflex` | about `kFeaturePCL` |
|
||||
|---|---|---|---|
|
||||
| Phantom Blade Zero (181) | 2.14.1 | version and requirements | version and requirements |
|
||||
| Clair Obscur: Expedition 33 (182) | 2.7.30 | version and requirements | version and requirements |
|
||||
| Valor Mortis (183, 184) | 2.14.1 | version and requirements | version and requirements |
|
||||
| Black Myth: Wukong (185) | 2.7.4 | version and requirements | version and requirements |
|
||||
| Cyberpunk 2077 (186) | 2.14.1 | requirements only | not asked |
|
||||
|
||||
So **every Streamline game run asks about Reflex**, and the four Unreal Engine games about PCL as well. That a
|
||||
game asks about a feature is not that it uses it; 0.1.0-beta.45's `slIsFeatureLoaded` and `slSetFeatureLoaded`
|
||||
rows will say whether Reflex and PCL are loaded and switched, on the owner's next sessions. No session says
|
||||
anything about a game that uses Reflex without Streamline: none of the hooks sees NVAPI.
|
||||
|
||||
**Added 2026-11-13, from the first sessions on 0.1.0-beta.45** (190–196): Streamline answers `eOk` for
|
||||
`kFeatureReflex` in all five Streamline games run, and `slIsFeatureLoaded` says it is loaded in the three that ask
|
||||
(Phantom Blade Zero, Cyberpunk 2077, Hogwarts Legacy); Cyberpunk 2077 and Dying Light: The Beast switch it off and
|
||||
on through `slSetFeatureLoaded`. `kFeaturePCL` is supported in the four games that ask about it. Loaded is still
|
||||
not in use: whether a game sets markers is what no hook sees.
|
||||
|
||||
### The routes
|
||||
|
||||
**A — hook NVAPI's own functions** (`SetLatencyMarker`, `SetSleepMode`; what `17_HOOK_ENGINE` §Memory / latency
|
||||
still names). The `nvapi64.dll` on the dev box (driver 32.0.16.2114, its export table dumped for this note)
|
||||
exports two functions, `nvapi_QueryInterface` and `nvapi_Direct_GetMethod` — §M14 said one — and no latency
|
||||
function: each of those is an address `nvapi_QueryInterface` returns for an id (`nvapi_interface.h`:
|
||||
`NvAPI_D3D_GetLatency` is `0x1a587f9c`). A hook on one is a patch at an address
|
||||
learned at run time — the class refused on 2026-08-09 — or a wrapper returned from a hooked
|
||||
`nvapi_QueryInterface`, which is a write to what the game receives (rule 4). **Refused, as §M14 pre-committed.**
|
||||
|
||||
**B — hook Streamline's Reflex and PCL functions** (`slReflexSetOptions`, `slPCLSetMarker`, `slReflexGetState`).
|
||||
None is an export of `sl.interposer.dll`. The game gets each through the exported `slGetFeatureFunction(feature,
|
||||
name, &fn)`, and Streamline's own header does that **once**: `SL_FEATURE_FUN_IMPORT_STATIC` keeps the pointer in
|
||||
a function-local static after the first call. Two consequences. A hook on `slGetFeatureFunction` could only see
|
||||
the game's calls by handing back a wrapper — train D's question (§M15), which needs rule 4 amended. And a hook
|
||||
that exists only for Advanced metrics is installed after the attach (D111), by which time a game that has
|
||||
presented a frame has fetched its functions: **the same reason `slInit` is not hooked (D129) applies to the
|
||||
fetch.** Not a route for train C; it stays train D's, and this finding weakens train D as well.
|
||||
|
||||
**C — the Overlay calls `slReflexGetState` itself**, having asked the interposer's exported, documented-thread-safe
|
||||
`slGetFeatureFunction` for it. No patch, no wrapper, and Streamline uses the device it already holds. But the
|
||||
header says of `slReflexGetState`: *"This method is NOT thread safe"*, and the source shows why — the function
|
||||
**writes** two fields of the plugin's context (`lowLatencyAvailable`, `latencyReportAvailable`) from the result
|
||||
of the two driver calls it makes, with no lock, and then calls into the PCL plugin. The game calls the same
|
||||
function from a thread FrameLedger cannot know (the call is not hooked), so the Overlay cannot keep its call
|
||||
from overlapping the game's. It would be FrameLedger breaking the vendor's stated contract inside the game, and
|
||||
writing plugin state the game reads back. **Recommended refused**, on the header's own words.
|
||||
|
||||
**D — the Overlay calls the driver's two getters itself**: `NvAPI_D3D_GetLatency` and `NvAPI_D3D_GetSleepStatus`,
|
||||
resolved through `nvapi_QueryInterface` of an `nvapi64.dll` **the game already loaded** (never loaded by
|
||||
FrameLedger), with the device of the swap chain the Overlay already hooks. This is §M14's "route to try first".
|
||||
What it would be:
|
||||
|
||||
- **No patch and no new hook.** Two calls, both getters; `tools/nvapi-readonly-check.ps1`'s list (D108) would
|
||||
gain them, and the check would have to cover the Overlay as well as the bridge. The Overlay would not link
|
||||
`nvapi64.lib`: it needs the two ids and the two structs from the vendored MIT headers.
|
||||
- **It works without Streamline** — any Direct3D game that uses Reflex — and not on Vulkan (the Vulkan layer has
|
||||
no NVAPI device; Reflex there is a Vulkan extension, a different study).
|
||||
- **It gives** the report (`nvapi.reflex.frame_report`) and the sleep status (`nvapi.reflex.sleep_status`), and
|
||||
through them most of `sl.reflex.state`. **It does not give** what the game asked for (boost, the limit:
|
||||
`nvapi.reflex.mode` stays N/A, with the reason) or a count of markers.
|
||||
- **First of its kind in two ways**, and both are the owner's to rule on. The Overlay would call a *vendor's
|
||||
driver interface on its own initiative* inside the game — today it only forwards the game's calls and reads
|
||||
their arguments. And it would use *the game's device object* for a call the game did not make: rule 4 allows
|
||||
"COM/handle objects we legitimately own", and the device is the game's. The nearest precedent is the read of
|
||||
`IDXGISwapChain::GetLastPresentCount` on the hooked chain (rule 6, 2026-09-06), a getter on the game's swap
|
||||
chain inside the present detour.
|
||||
- **Unknown, and what the spike would have to measure**: which object NVAPI wants for a Direct3D 12 game (the
|
||||
device behind the queue the swap chain was made on — not verified); whether the getters are safe on a thread
|
||||
that is not the game's — the header is silent; Streamline's own plugin calls them on whatever thread the game
|
||||
asks for its state while the render thread sets markers, which suggests the driver tolerates it, and is an
|
||||
inference; what a call costs, on the presenting thread or on the Overlay's own; what it returns in a game that
|
||||
never set a marker (the header: valid only after markers with rising frame ids); whether a call that blocks
|
||||
in the driver can be bounded — an SEH guard does not bound a wait.
|
||||
- **How often**: one call returns 64 frames. At 240 presents a second that is four calls a second to lose none;
|
||||
once a second keeps the newest 64 and says how many it skipped.
|
||||
- **What else moves**: a series through region 5 (a layout change, or the reserved words), the Agent's sampler,
|
||||
the page; the Disclaimer's sentence about what the Overlay's own thread does (a version of its own, the
|
||||
owner's wording); the Privacy Policy (what is stored: times, no content).
|
||||
|
||||
**E — from outside the game: the PCL statistics ETW provider.** Streamline's PCL plugin (and the Reflex SDK's
|
||||
`pclstats.h` in a game without Streamline) registers `PCLStatsTraceLoggingProvider`
|
||||
(`{0d216f06-82a6-4d49-bc4f-8f38ae56efab}`) and writes an event for every marker (`PCLStatsEvent`: `Marker`,
|
||||
`FrameID`), which is what NVIDIA's own overlay listens to. No injection, so it would also be the only route for
|
||||
a game the guard refuses. What it costs:
|
||||
|
||||
- **It gives the game-side markers only** — simulation, render submit, present, the ping. The driver, OS queue
|
||||
and GPU times are not in these events; NVIDIA's overlay has them from the driver.
|
||||
- **A trace session needs administrator rights** (or membership of *Performance Log Users*); the Agent is
|
||||
unelevated by default (D34).
|
||||
- **Listening changes what the game does.** Enabling the provider sets the game's `g_PCLStatsEnable`, and its own
|
||||
ping thread then posts a registered window message — or, where the game chose a key, `F13`–`F15` key messages
|
||||
— to the game's window every 100–300 ms. It is the game's code and the vendor's design, and it is what any
|
||||
listener causes; FrameLedger would still be the cause, in a game it is not even injected into.
|
||||
- **It reopens a closed decision**: ETW left the product on 2026-08-27/28 (Tier 2 is not a measurement;
|
||||
`20_OPEN_QUESTIONS` §G keeps the question of a no-injection measurement).
|
||||
|
||||
**F — NVAPI from the Agent.** `NvAPI_D3D_GetLatency` takes the game's device. Another process has none. Not a
|
||||
route.
|
||||
|
||||
### What each catalog entry would become
|
||||
|
||||
| Entry | Route A, B | C | D | E |
|
||||
|---|---|---|---|---|
|
||||
| `nvapi.reflex.frame_report` | refused | (refused) | **read**, Direct3D | game-side times only |
|
||||
| `nvapi.reflex.sleep_status` | refused | part | **read**, Direct3D | — |
|
||||
| `nvapi.reflex.mode` | refused | — | N/A: no getter returns it | — |
|
||||
| `sl.reflex.state` | refused | (refused) | the same numbers, under the NVAPI entries | — |
|
||||
| `sl.pcl.markers` | refused | — | — | counted |
|
||||
|
||||
### What this reading settles, and what it leaves to the owner
|
||||
|
||||
- **Settled by reading**: A and B are the refused classes; C breaks the vendor's own contract; F does not exist.
|
||||
§M14's pre-committed "no route without a patch at a run-time address" does **not** fire — D has no patch and E
|
||||
has no injection — so the entries do not go to N/A on this document alone.
|
||||
- **The owner's**, because each crosses a line the rules draw today:
|
||||
1. **Route D — go to a spike, or no?** A go means: `hook-harness` and a stub `nvapi64.dll` first (the call
|
||||
made, the report read, the overhead measured against NFR-1, a blocked call and a missing module shown to be
|
||||
harmless), then one real title of the owner's choice, never first in a game inside the anti-cheat
|
||||
exception's trial (D38). Pre-committed for that spike: a fault or a hang attributable to the call, an
|
||||
overhead above NFR-1, or a Direct3D 12 device that cannot be obtained without reading what rule 4 forbids
|
||||
→ Reflex latency stays N/A and the page says why. A go also needs the owner's ruling that calling a
|
||||
driver getter with the game's device is inside rule 4, asked with the rule quoted, as §M15 asks for its
|
||||
own amendment.
|
||||
2. **Route C — recorded as refused?** (Recommended: yes.)
|
||||
3. **Route E — leave §G closed, or reopen it for latency markers?** (Recommended: leave it; the route gives
|
||||
the smaller half of the number and makes a game post messages to itself.)
|
||||
- **Not looked into**: Reflex on Vulkan; AMD Anti-Lag 2 and Intel XeLL, which have their own interfaces; what
|
||||
`nvapi_Direct_GetMethod` is (the vendored headers do not declare it; the vendored import library names it; nothing here
|
||||
would use it); what a
|
||||
real game's interposer and its Reflex and PCL plugins export (the above is the headers' and the source's word,
|
||||
not a dump of a game's files).
|
||||
|
||||
### The owner's answers (2026-11-13, D132 and D133)
|
||||
|
||||
1. **Route D: go — to the spike on `hook-harness` and a stub first.** With it the ruling a go needed: calling a
|
||||
driver's read-only getter with the device of the swap chain the Overlay hooks is inside rule 4 (`CLAUDE.md`
|
||||
carries the note). No real game until the owner has seen the spike's result; no shipped code changes for it.
|
||||
2. **Route C: refused.**
|
||||
3. **Route E: left closed**; §G is not reopened.
|
||||
|
||||
The spike is `spike-notes` §31, written after 0.1.0-beta.46 is tagged.
|
||||
+2
-2
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"$comment": "Pins the SDK band. Without this, dotnet picks the newest installed SDK — on a machine with a .NET 11 preview present that silently changes analyzer behaviour under TreatWarningsAsErrors and makes local and CI disagree for reasons invisible in a diff. See docs/12_BUILD.md.",
|
||||
"$comment": "Pins the SDK band: .NET 11 since 0.1.0-beta.37 (owner decision D94, 2026-11-11). Without this, dotnet picks the newest installed SDK — on a machine with a .NET 12 preview present that silently changes analyzer behaviour under TreatWarningsAsErrors and makes local and CI disagree for reasons invisible in a diff. The alpha branch carries this same file while its line rests. See docs/12_BUILD.md.",
|
||||
"sdk": {
|
||||
"version": "10.0.100",
|
||||
"version": "11.0.100",
|
||||
"rollForward": "latestFeature",
|
||||
"allowPrerelease": false
|
||||
}
|
||||
|
||||
+4
-1
@@ -2,7 +2,10 @@
|
||||
|
||||
## What you need
|
||||
|
||||
- **Windows 10 (22H2) or Windows 11, 64-bit.**
|
||||
- **Windows 11, 64-bit.** FrameLedger may also run on Windows 10 (22H2), but it has not been tested there and nobody
|
||||
supports it: it is built on .NET 11, which Microsoft supports on Windows 11.
|
||||
- **A processor Windows 11 accepts.** On an older one, without the SSE4.2 and POPCNT instructions, FrameLedger does
|
||||
not start.
|
||||
- Games FrameLedger can measure: **64-bit DirectX 11, DirectX 12 and OpenGL games.** Other games — 32-bit games,
|
||||
DirectX 9 games, and Vulkan games you start yourself — are still recorded (how long you played, your PC's sensors,
|
||||
the game's memory use), but not measured. [Limitations](../LIMITATIONS.md) has the full list.
|
||||
|
||||
+11
-2
@@ -20,7 +20,7 @@ What each part of FrameLedger shows and what each button does. What the numbers
|
||||
update** (it waits while a game is being recorded); and the safety notices — a game's hooking refused, measurement
|
||||
stopped, hooking turned off — each with one button that only says you have read it.
|
||||
|
||||
**The pages** are on the left: **Dashboard**, **Games**, **Compare**, **Logs**, and **Settings** at the bottom.
|
||||
**The pages** are on the left: **Dashboard**, **Games**, **Compare**, **Logs**, and **Settings** at the bottom. **Advanced** joins them, after Logs, while Advanced metrics is switched on.
|
||||
|
||||
## The menus
|
||||
|
||||
@@ -107,6 +107,7 @@ It opens from a session row, from the Dashboard, and from the notice when a sess
|
||||
- **Frame generation in this session** — a bar and a table of every frame-generation state the session held, when it
|
||||
held more than one, with how frame generation was set.
|
||||
- **Tags and notes** with **Save**, and **Export CSV**, **Export JSON**, **Export PNG**.
|
||||
- **Advanced metrics…**, for a session recorded with Advanced metrics on: it opens that session on the Advanced page.
|
||||
|
||||
## Compare
|
||||
|
||||
@@ -120,6 +121,13 @@ not) and **frame generation** — a session you ticked stays in the list. **Clea
|
||||
What FrameLedger and its agent wrote down. Choose **App** or **Agent**, a level, and search; **Pause** stops the view from
|
||||
following new lines. **Open logs folder**, and **Export bug bundle**, which does the same as Help ▸ Report a bug….
|
||||
|
||||
## Advanced
|
||||
|
||||
There only while Settings ▸ Recording ▸ **Advanced metrics** is on. Three tabs: **This PC** — what the graphics
|
||||
driver and the sensors say right now, read only while the page is open; **Session** — what a session recorded with
|
||||
the option on kept, in a table and a chart; **Sources** — every reading FrameLedger knows of, and for each one it
|
||||
does not read, why. [Advanced metrics](12-advanced-metrics.md) describes each.
|
||||
|
||||
## Settings
|
||||
|
||||
Every switch and box is described in [Every setting](08-settings.md).
|
||||
@@ -133,7 +141,8 @@ is ready.
|
||||
|
||||
## Keyboard and mouse
|
||||
|
||||
- **Ctrl+1** … **Ctrl+5** open Dashboard, Games, Compare, Logs and Settings, and put the keyboard in that page.
|
||||
- **Ctrl+1** … **Ctrl+5** open Dashboard, Games, Compare, Logs and Settings, and put the keyboard in that page;
|
||||
**Ctrl+6** opens Advanced while Advanced metrics is on.
|
||||
- **Alt** or **F10** moves to the menus; **Alt** with a menu's underlined letter opens it (**Alt+F**, **Alt+T** and
|
||||
**Alt+H** for File, Tools and Help in English).
|
||||
- **Esc** closes a dialog the way its Close or Cancel button does.
|
||||
|
||||
@@ -22,6 +22,7 @@ The link under them, *Read what the hook does and does not do*, opens the safety
|
||||
| **Minimum session length (s)** | A shorter session is not kept. 5 to 600 seconds. *Agent.* | 30 |
|
||||
| **Sensor interval (ms)** | How often the PC's sensors are read during a session. 500 to 2000 ms. *Agent.* | 1000 |
|
||||
| **Raw series kept per game** | How many of each game's newest sessions keep their per-frame data; older ones keep their statistics. 0 keeps everything. *Agent.* | 20 |
|
||||
| **Advanced metrics** | Reads more from the graphics driver and the hardware sensors during a session — the graphics card's memory and load in detail, each fan and voltage, what your display can do, the driver's settings for the game — and stores it with the session. Off: nothing more is read or stored. It applies from the next session; a session recorded while it was off is not filled in later. While it is on, the **Advanced** page is in the list on the left ([Advanced metrics](12-advanced-metrics.md)). *Agent.* | Off |
|
||||
|
||||
## Data
|
||||
|
||||
@@ -34,7 +35,7 @@ The link under them, *Read what the hook does and does not do*, opens the safety
|
||||
|
||||
| Setting | What it does | Default |
|
||||
|---|---|---|
|
||||
| **Run the agent as administrator** | Lets FrameLedger measure games that run as administrator, and read CPU temperature with PawnIO installed. Windows asks every time the agent starts, at logon too. A warning explains the risk first; read [Limitations](../LIMITATIONS.md#running-the-agent-as-administrator). The agent restarts to apply it, or at its next start if a game is being recorded. | Off |
|
||||
| **Run the agent as administrator** | Lets FrameLedger measure games that run as administrator, and — with PawnIO installed — read CPU temperature and, when *Advanced metrics* is on, the processor's, the memory's and the motherboard's sensors. Windows asks every time the agent starts, at logon too. A warning explains the risk first; read [Limitations](../LIMITATIONS.md#running-the-agent-as-administrator). The agent restarts to apply it, or at its next start if a game is being recorded. | Off |
|
||||
| **Start the agent at logon** | **Register**, **Repair** or **Remove** a task that starts the agent when you log on, for your user only and without administrator rights. Without it, FrameLedger starts the agent when you open it. | Not installed |
|
||||
|
||||
## Appearance
|
||||
|
||||
@@ -32,7 +32,7 @@ While the game runs, a notice may say *hooking refused*.
|
||||
| The game runs in an app container, or Windows protects it in a way the component can neither load into nor hook. | Nothing: an older Microsoft Store app (UWP), or a game under code protection, is recorded, not measured ([Limitations](../LIMITATIONS.md#xbox-app-and-microsoft-store-games)). |
|
||||
| **Disable all hooking** is on. | Switch it off in Settings ▸ Capture. |
|
||||
| The game was already running when FrameLedger was updated. | Close the game and start it again. |
|
||||
| Hooking was switched off after the game crashed twice soon after it started. | Switch it on again in the game's page if the cause may be gone — after a driver update, for example. |
|
||||
| Hooking was switched off after the game crashed twice soon after it started. | Switch it on again in the game's page if the cause may be gone — after a driver update, for example. The count starts again when you do (since 0.1.0-beta.44). |
|
||||
| Hooking was switched off after **Play** started the game directly twice, and each time the game handed itself to Steam or closed at once. | Switch it on again, and set Settings ▸ Games ▸ **Play button** to *Through the store*: some Steam games will not start any other way. |
|
||||
| The game's file is gone. | If only its drive letter changed, FrameLedger follows it within about 15 seconds; otherwise **Change executable…** on the game's page. |
|
||||
| The component could not be loaded into the game. | [Report a problem](#report-a-problem). |
|
||||
|
||||
+23
-11
@@ -2,14 +2,25 @@
|
||||
|
||||
## What an alpha is
|
||||
|
||||
Besides the betas, FrameLedger publishes **alphas**: the same program as a beta, built on a version of .NET that
|
||||
Microsoft has not finished yet — .NET 11's release candidate first. They exist so that a new .NET can be tried before the
|
||||
betas move to it. An alpha's version ends in `-alpha.N` (`0.1.0-alpha.1`), its page on GitHub says *experimental alpha*,
|
||||
and its installer is `FrameLedger.App-alpha-Setup.exe`.
|
||||
Besides the betas, FrameLedger publishes **alphas**: the same program as a beta, built to try a newer version of .NET —
|
||||
sometimes one Microsoft has not finished yet. They exist so that a new .NET can be tried before the betas rely on it. An
|
||||
alpha's version ends in `-alpha.N` (`0.1.0-alpha.1`), its page on GitHub says *experimental alpha*, and its installer is
|
||||
`FrameLedger.App-alpha-Setup.exe`.
|
||||
|
||||
**If you want results you can rely on, use the beta.** An alpha can crash, record wrongly or fail to update in ways no
|
||||
beta has. The part of FrameLedger that goes into a game is the beta's own and does not use .NET; everything that starts
|
||||
it, reads it and stores what it measured runs on the new .NET.
|
||||
it, reads it and stores what it measured runs on the alpha's .NET.
|
||||
|
||||
## Right now: the alphas are paused
|
||||
|
||||
The alphas tried .NET 11. Since 0.1.0-beta.37 the betas run on .NET 11 too, so **0.1.0-alpha.4 is the last alpha for
|
||||
now**: it brings an installed alpha onto the finished .NET 11, and after it no alpha is published until there is a newer
|
||||
.NET to try.
|
||||
|
||||
A paused alpha gets **no updates** — no fixes, and not the list of anti-cheat software FrameLedger refuses to touch, which
|
||||
only arrives inside an update. Its banner tells you so. **Install the latest beta over it** (below); your data stays.
|
||||
One more thing: once ten betas have been published after 0.1.0-alpha.4, an older alpha can no longer find it as an
|
||||
update, and installing the beta by hand is the only way forward.
|
||||
|
||||
## Before it runs
|
||||
|
||||
@@ -18,7 +29,8 @@ tick: *I understand that this is an experimental build and I use it at my own ri
|
||||
Until you accept, the alpha's capture agent does not run at all. The notice is shown again whenever its text changes.
|
||||
|
||||
While an alpha runs, the title bar carries an **ALPHA** badge (hover it to see the .NET version), and a yellow banner
|
||||
above every page says what it is each time it starts; you can close the banner for that run. **Help ▸ About** names the
|
||||
above every page says what it is each time it starts — while the alphas are paused, that they are, and to install the
|
||||
beta; you can close the banner for that run. **Help ▸ About** names the
|
||||
.NET it runs on.
|
||||
|
||||
## Your data
|
||||
@@ -45,9 +57,9 @@ alpha.
|
||||
|
||||
## Windows and your PC
|
||||
|
||||
Microsoft supports .NET 11 on Windows 11 24H2 and later; on Windows 10 only in its LTSC and IoT editions. An alpha may
|
||||
work on Windows 10 22H2 Home or Pro, but nobody supports it there. .NET 11 also needs a processor with SSE4.2 and POPCNT,
|
||||
which every processor Windows 11 accepts has; on an older one the alpha does not start at all.
|
||||
An alpha needs what a beta needs since 0.1.0-beta.37 ([Install](01-install.md)): Microsoft supports .NET 11 on
|
||||
Windows 11; on Windows 10 (22H2) FrameLedger may run, but it is not tested there and nobody supports it; and on a
|
||||
processor without SSE4.2 and POPCNT it does not start at all.
|
||||
|
||||
A release candidate stops being supported by Microsoft when the final version ships — for .NET 11's, 10 November 2026 —
|
||||
and the next alpha moves to the final version.
|
||||
When an alpha runs on a .NET Microsoft has not finished, Microsoft stops supporting that version when the finished one
|
||||
ships, and the next alpha moves to the finished one.
|
||||
@@ -0,0 +1,126 @@
|
||||
# Advanced metrics
|
||||
|
||||
A session's summary shows the figures most people want. **Advanced metrics** is for looking closer: everything the
|
||||
graphics driver and the hardware sensors will say about your PC, kept with each session and shown on a page of its
|
||||
own.
|
||||
|
||||
It is **off unless you switch it on**, and while it is off nothing more is read or stored.
|
||||
|
||||
## Switch it on
|
||||
|
||||
Settings ▸ Recording ▸ **Advanced metrics**. A new item, **Advanced**, appears at the end of the list on the left
|
||||
(**Ctrl+6**). Sessions you record from then on keep the extra readings; a session recorded while it was off is not
|
||||
filled in later.
|
||||
|
||||
## This PC
|
||||
|
||||
What your PC says right now.
|
||||
|
||||
- **About this PC** — the graphics card's firmware, architecture and cores, its memory sizes, the driver's package,
|
||||
what each display can do with HDR and variable refresh, and the driver's global settings. A row with a number in
|
||||
brackets unfolds into a list.
|
||||
- **Right now** — every reading with the time it was read at. NVIDIA's own figures are read every second; the
|
||||
sensors (fans, voltages, loads) every five seconds, so a sensor's value can be a few seconds old, and its time
|
||||
says so.
|
||||
- **Over time** — choose a reading and see its last five minutes. More than eight lines at once cannot be told
|
||||
apart, so a reading with many parts (every processor core, say) is drawn as its lowest, average and highest.
|
||||
|
||||
These readings are taken **only while this page is open or a game is being recorded**, and what the page shows is
|
||||
not stored.
|
||||
|
||||
## Session
|
||||
|
||||
Choose a session recorded with Advanced metrics on. You see the PC as it was then, what belonged to that session
|
||||
alone — whether variable refresh was in use on the display the game ran on, the colour space the game presented in,
|
||||
the driver's settings for that game — the lowest, average and highest of every reading, and a chart over the
|
||||
session's length.
|
||||
|
||||
### What the game told its upscaler
|
||||
|
||||
For a game FrameLedger measures **from inside** (hooking is on for it), a session recorded with Advanced metrics on
|
||||
also keeps what the game itself handed to DLSS and FSR:
|
||||
|
||||
- **DLSS** — the output size, the model preset for each quality mode, whether the game said its colour buffers are
|
||||
HDR, auto-exposure, alpha upscaling, and the exposure values.
|
||||
- **FSR** — sharpening (on or off, and how strong), the largest jitter offset, the exposure, the near and far planes,
|
||||
the **range** of the field of view over the session, the flags of the call, the frame time the game reported, and
|
||||
FSR's own video memory at the moments the game asked for it.
|
||||
- **Streamline** (NVIDIA's library that games use for DLSS; since 0.1.0-beta.43) — what the game tells it about
|
||||
each frame: the largest jitter offset, the motion-vector scale and how the motion vectors are stored, the near and
|
||||
far planes and whether depth is inverted, the **range** of the field of view, the aspect ratio, whether the
|
||||
projection is orthographic, and how many times the game reset the upscaler's history (a camera cut, a loading
|
||||
screen). Where a game draws several views, these are the first view's.
|
||||
- **FSR frame generation** (since 0.1.0-beta.43) — how the game configured it: on or off, whether it may run
|
||||
asynchronously, its flags, whether only generated frames are presented, and the part of the picture it generates
|
||||
in. A setting the game changed during the session reads *on and off*. This is what the game **asked for**; how
|
||||
many frames were generated is in the session's summary, as before.
|
||||
|
||||
- **Streamline's features** (since 0.1.0-beta.44) — what Streamline answered when the game asked about a feature:
|
||||
which version it is (Streamline's own, and the DLSS model's), and what it requires — the graphics APIs it works
|
||||
with, whether V-Sync must be off, whether hardware-accelerated GPU scheduling must be on, how many threads,
|
||||
viewports and buffers, and the Windows and driver versions Streamline found beside the ones the feature needs.
|
||||
The features carry NVIDIA's own names: `kFeatureDLSS` is DLSS, `kFeatureDLSS_G` DLSS frame generation,
|
||||
`kFeatureDLSS_RR` ray reconstruction, `kFeatureReflex` Reflex. A game asks these while it starts; many ask
|
||||
again later, and then they are read. Where a game asks only at its start, the line under the session says
|
||||
*hooked — the game asks this while it starts, and did not ask again*. The version shown is the one Streamline
|
||||
reports, which can be newer than the file in the game's folder.
|
||||
- **Whether a feature is supported and loaded, and what the game did with it** (since 0.1.0-beta.45) — two more
|
||||
tables, one row for each feature and call. `kFeatureDLSS_G · slIsFeatureSupported` is Streamline's answer in
|
||||
NVIDIA's own word: `eOk` is yes, and a refusal is named (`eErrorFeatureNotSupported`, `eErrorFeatureMissing`).
|
||||
`· slIsFeatureLoaded` is *on* or *off*. `· slSetFeatureLoaded` says whether the game switched the feature *on*,
|
||||
*off* or *on and off* during the session; `· slAllocateResources` and `· slFreeResources` count how many times it
|
||||
set up and released what the feature needs (up to 15, then `≥ 15`); `slShutdown` counts how many times it shut
|
||||
Streamline down. These begin when FrameLedger is in the game: what the game did while it started is not there.
|
||||
In the games run so far every one asks whether its features are supported; the other rows appear in some games
|
||||
and not in others, and no game has shown an allocation.
|
||||
|
||||
These are the game's own words to the upscaler, shown in the vendor's notation (`preExposure`, preset `K`).
|
||||
FrameLedger does not check what the upscaler did with them.
|
||||
|
||||
The last four are read from calls FrameLedger hooks **only for Advanced metrics** — ten calls in all: in a game
|
||||
where no session has been recorded with the option on since it started, those hooks are not there. The line under
|
||||
the session says, for each call, whether it was *read*, *hooked — the game did not make the call*, or *not hooked —
|
||||
the game did not load the library that has the call*; the six calls of 0.1.0-beta.45 are named in one sentence,
|
||||
under which of the three happened to each.
|
||||
|
||||
**Many games will show nothing here**, and the line under the session says why: *the game made none of the calls
|
||||
these are read from* — most games set their DLSS options through a call FrameLedger cannot see, and only games that
|
||||
use FSR 3.1 or later through AMD's own library show the FSR rows — or *the session was not measured inside the game*.
|
||||
It never means the game uses no upscaler; the session's summary still names the upscaler as before.
|
||||
|
||||
**Where the camera is, which way it looks and its matrices are never read.** The field of view is kept as a lowest
|
||||
and a highest value, never as a line over time.
|
||||
|
||||
**A game may use a unit of its own.** NVIDIA's and AMD's libraries expect the field of view in radians, and
|
||||
FrameLedger shows it that way with the degrees beside it. Some games give degrees instead (Cyberpunk 2077 does, to
|
||||
Streamline): a value too large to be radians is shown as the game gave it, with a line that says *Not radians*, and
|
||||
is not converted — FrameLedger shows what the game said, not what it may have meant. The number of **resets** is
|
||||
the number of calls in which the game told the upscaler to drop its history; menus and loading screens raise it. A
|
||||
frame-generation configuration with no flag set says *None*.
|
||||
|
||||
A session's summary has an **Advanced metrics…** button that opens that session here.
|
||||
|
||||
## Sources
|
||||
|
||||
Every reading FrameLedger knows of, with what it belongs to (this PC, a session, or a session over time), where it
|
||||
comes from, and whether it is read. Where it is not, the reason is written out:
|
||||
|
||||
- **the capture agent is not running as administrator**, or **PawnIO is not installed** — the processor's, the
|
||||
memory's and the motherboard's sensors need both ([Every setting](08-settings.md), *Run the agent as
|
||||
administrator*);
|
||||
- **not present on this PC** — the driver's own figures exist on NVIDIA cards only;
|
||||
- **read inside a game FrameLedger measures, when the game makes the call** — what the game tells DLSS and FSR
|
||||
(above). Some further readings inside the game **come with a later release**;
|
||||
- **the game makes this call once, before FrameLedger is inside it** — what the game started Streamline with. It is
|
||||
not read, and no later release will read it;
|
||||
- **never read** — a serial number, a display's identification data, which other programs are encoding, the camera's
|
||||
position in the game. FrameLedger does not read these at all.
|
||||
|
||||
## Good to know
|
||||
|
||||
- A reading that could not be taken is **N/A**, never a guess and never a zero.
|
||||
- **A drive's temperature is not read**: the sensor library cannot list drives without touching removable ones.
|
||||
- None of these readings has been checked against another tool yet.
|
||||
- They are not part of an exported session or a bug report.
|
||||
|
||||
More limits are on the [Limitations](../LIMITATIONS.md) page, under *Sensors*.
|
||||
+3
-2
@@ -4,7 +4,7 @@ FrameLedger records how your games run on this PC — frame rate, frame times, t
|
||||
with, temperatures, and how much memory the game uses — and keeps every session so you can compare them later.
|
||||
Everything stays on your PC.
|
||||
|
||||
Each page below takes a minute or two to read. The first six are the guide; the next five are there to look things up.
|
||||
Each page below takes a minute or two to read. The first six are the guide; the next six are there to look things up.
|
||||
|
||||
1. [Install and first start](01-install.md)
|
||||
2. [Record a game](02-record-a-game.md)
|
||||
@@ -17,7 +17,8 @@ Each page below takes a minute or two to read. The first six are the guide; the
|
||||
9. [When something goes wrong](09-troubleshooting.md)
|
||||
10. [Words FrameLedger uses](10-glossary.md)
|
||||
11. [Alpha builds](11-alpha-builds.md) — the experimental builds on a new .NET, and how to go back
|
||||
12. [The terms, in plain words](terms-in-plain-words.md)
|
||||
12. [Advanced metrics](12-advanced-metrics.md) — everything the driver and the sensors say, if you switch it on
|
||||
13. [The terms, in plain words](terms-in-plain-words.md)
|
||||
|
||||
What FrameLedger cannot do is listed on its own page: [Limitations](../LIMITATIONS.md) (in the app: Help ▸
|
||||
Limitations). How it works with the keyboard alone, a screen reader or a contrast theme, and how to report a problem:
|
||||
|
||||
+30
-3
@@ -11,9 +11,9 @@
|
||||
that changes what FrameLedger.Overlay or the capture host does; date the change.
|
||||
HTML comments are not part of the block.
|
||||
-->
|
||||
> ⚠ **What FrameLedger actually measures today — 2026-11-06.** The software is a beta; its latest
|
||||
> **beta is `0.1.0-beta.34`** (2026-11-06), an unsigned installer built from that tag with its
|
||||
> checksums published beside it (alphas — experimental builds on a prerelease .NET — are published apart). The source holds the desktop app
|
||||
> ⚠ **What FrameLedger actually measures today — 2026-11-11.** The software is a beta; its latest
|
||||
> **beta is `0.1.0-beta.45`** (2026-11-12), 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
|
||||
@@ -101,6 +101,33 @@
|
||||
> Windows once a second and charted. Processor temperature is read only when the Agent runs as
|
||||
> administrator — an option, off by default, for which Windows asks at every start of the Agent — with
|
||||
> PawnIO installed, and that reading has not yet been checked on real hardware; everywhere else it is `N/A`.
|
||||
> - **Advanced metrics (since beta.39; off unless you switch it on in Settings):** with it on, a session also stores
|
||||
> what the graphics driver and the sensor library report about the hardware — the graphics card's memory, load,
|
||||
> clocks, fans, voltages and power in detail, what a display can do, the driver's settings for the game — as they
|
||||
> report it: NVIDIA's figures once a second, the sensor library's every five seconds. None of these readings has
|
||||
> been checked against another tool. The processor's, the memory's and the motherboard's need the Agent as
|
||||
> administrator with PawnIO and have never been read on real hardware; a drive's temperature is not read. The
|
||||
> Advanced page shows them as they were stored, and what the PC reads at the moment only while that page is open.
|
||||
> - **What a game tells its upscaler (since beta.40; only with Advanced metrics on, only for a game measured from
|
||||
> inside):** the output size, presets and exposure a game hands DLSS, and the sharpening, jitter, exposure, depth
|
||||
> range, field-of-view range, flags and frame time it hands FSR, are read from the arguments of the calls
|
||||
> FrameLedger intercepts and shown as the game stated them — not checked against what the upscaler did. Most games
|
||||
> set their DLSS options through a call that cannot be intercepted and show none; the FSR values need FSR 3.1 or
|
||||
> later through AMD's own library. Since beta.43 also what a game tells NVIDIA Streamline about each frame (jitter,
|
||||
> motion-vector scale, depth range, field-of-view range, how often it reset the upscaler's history — for the first
|
||||
> viewport that called, where a game has several) and how it configures FSR frame generation (the settings it asked
|
||||
> for, not whether frames were generated). Since beta.44 also what Streamline answers when a game asks about a
|
||||
> feature — its version, and what it requires (graphics APIs, V-Sync, GPU scheduling, Windows and driver versions):
|
||||
> Streamline's answer as the game received it, not a check of the PC. A game that asks only while it starts has
|
||||
> none and the session says so; the Unreal Engine games run so far ask again later, and were read. Since beta.45
|
||||
> also whether Streamline says each feature is supported and whether it is loaded, and what the game did with it
|
||||
> after FrameLedger attached — switched it on or off, allocated and freed its resources (counted to fifteen), shut
|
||||
> Streamline down: calls the game made, not a statement that a feature ran or produced anything. FSR's upscaling
|
||||
> values, Streamline's constants (seven games), its answers about a feature (seven games), the
|
||||
> frame-generation configuration (one game) and five of beta.45's six calls (five games) have been read from
|
||||
> real games; no game run so far allocated a feature's resources after FrameLedger attached, and the DLSS
|
||||
> options have not been confirmed on one yet. A game may give a value in a unit of its own: one gives
|
||||
> Streamline its field of view in degrees, and it is shown as given.
|
||||
> - **Safety:** every pre-injection check runs before injection, including the signed-by-a-known-vendor
|
||||
> half of the suspicious-module rule. During every capture the Agent re-runs the checks every 30 s and
|
||||
> stops capturing on a refusal: a Direct3D or OpenGL game's hooks are removed, and the Vulkan layer
|
||||
|
||||
+22
-16
@@ -1,10 +1,11 @@
|
||||
# FrameLedger — Alpha notice
|
||||
|
||||
**Version:** 1.0 · **Effective:** {{RELEASE_DATE}}
|
||||
**Version:** 1.1 · **Effective:** {{RELEASE_DATE}}
|
||||
|
||||
<!-- Owner decisions D73-D76 (2026-10-31): the text below was approved with the plan. Shared.AlphaNotice.Version must
|
||||
equal the version above (AlphaNoticeTests); an alpha build's Legal Gate shows this document with its own tick box,
|
||||
and an alpha's Agent does not serve until it is accepted at this version. -->
|
||||
<!-- Owner decisions D73-D76 (2026-10-31): the text was approved with the plan. Version 1.1 (owner decisions D97 and D98,
|
||||
2026-11-11: what an alpha is once .NET 11 has shipped, and the line's pause) was approved with that day's plan.
|
||||
Shared.AlphaNotice.Version must equal the version above (LegalDocumentsTests); an alpha build's Legal Gate shows this
|
||||
document with its own tick box, and an alpha's Agent does not serve until it is accepted at this version. -->
|
||||
|
||||
This notice applies only to **alpha** builds of FrameLedger (versions named `x.y.z-alpha.N`). An alpha build shows it, and
|
||||
it must be accepted, before the build runs. It adds to the EULA, the Disclaimer and the Privacy Policy and takes nothing
|
||||
@@ -12,16 +13,18 @@ away from them; nothing in it limits your rights under the GPL-3.0.
|
||||
|
||||
## 1. What an alpha build is
|
||||
|
||||
An alpha build is the source of a published beta, built for and run on a **prerelease version of .NET** — when this
|
||||
notice was written, .NET 11 Release Candidate 3 — with the matching C# compiler. It exists so that a new .NET can be tried
|
||||
before FrameLedger's regular builds move to it. The runtime, its libraries and its compiler are prerelease software from
|
||||
Microsoft, and FrameLedger has not been tested on them the way a beta is.
|
||||
An alpha build is the source of a published beta, built to try a newer version of .NET — at times a **prerelease
|
||||
version** — with the matching C# compiler. When this notice was written the alpha ran on .NET 11.0.0, Microsoft's final
|
||||
release of .NET 11, which the betas moved to in 0.1.0-beta.37; the alphas before it ran on its Release Candidate 3, and a
|
||||
later alpha may run on a prerelease of the next .NET. It exists so that a new .NET can be tried before FrameLedger's
|
||||
regular builds rely on it. When the runtime is a prerelease, it, its libraries and its compiler are prerelease software
|
||||
from Microsoft, and the build says so. In either case FrameLedger has not been tested on an alpha the way a beta is.
|
||||
|
||||
## 2. What can go wrong
|
||||
|
||||
Everything the Disclaimer says about pre-release builds (§0), and more: an alpha may crash, hang, fail to record, record
|
||||
wrongly or fail to update in ways no beta has shown. The component loaded into a game is the same native code as the
|
||||
beta's and does not use .NET; everything that starts it, reads it, computes from it and stores it runs on the prerelease
|
||||
beta's and does not use .NET; everything that starts it, reads it, computes from it and stores it runs on the alpha's
|
||||
runtime.
|
||||
|
||||
## 3. Your data
|
||||
@@ -32,9 +35,9 @@ open the ledger if that copy cannot be made. Sessions an alpha records stay in t
|
||||
|
||||
## 4. Windows and hardware
|
||||
|
||||
Microsoft supports .NET 11 on Windows 11 24H2 and later, and on Windows 10 only in its LTSC and IoT editions. An alpha may
|
||||
run on Windows 10 22H2 Home or Pro, but nobody supports it there. .NET 11 needs a processor with SSE4.2 and POPCNT
|
||||
(x86-64-v2) and does not start without them.
|
||||
Microsoft supports .NET 11 on Windows 11, and on Windows 10 only in its LTSC and IoT editions. An alpha — as a beta does
|
||||
from 0.1.0-beta.37 — may run on Windows 10 22H2 Home or Pro, but it is untested there and nobody supports it. .NET 11
|
||||
needs a processor with SSE4.2 and POPCNT (x86-64-v2) and does not start without them.
|
||||
|
||||
## 5. Your responsibility
|
||||
|
||||
@@ -42,9 +45,12 @@ You install and run an alpha build **entirely at your own risk**. It comes with
|
||||
the developer is not responsible for any incident, loss or damage that results from using it (EULA §6, Disclaimer §0). If
|
||||
you need dependable results, use the beta.
|
||||
|
||||
## 6. Updates, and going back
|
||||
## 6. Updates, the pause, and going back
|
||||
|
||||
An alpha updates only to newer alphas, and a beta only to newer betas; neither becomes the other by itself. To go back,
|
||||
install the latest beta from the project's GitHub Releases over the alpha; your ledger stays where it is. A release
|
||||
candidate stops being supported by Microsoft when the final release ships (for .NET 11 RC3, 10 November 2026); the next
|
||||
alpha moves to it.
|
||||
install the latest beta from the project's GitHub Releases over the alpha; your ledger stays where it is.
|
||||
|
||||
A prerelease .NET stops being supported by Microsoft when its final release ships; the next alpha moves to it. **When the
|
||||
betas run on the same .NET as the newest alpha, the alpha line pauses**: no further alpha is published until a newer .NET
|
||||
is tried, and a paused alpha receives no updates — its list of anti-cheat software included, which reaches FrameLedger
|
||||
only inside an update. A paused alpha says so when it starts. Install the latest beta over it.
|
||||
+41
-8
@@ -1,18 +1,23 @@
|
||||
# FrameLedger — Disclaimer
|
||||
|
||||
**Version:** 2.13 · **Effective:** {{RELEASE_DATE}}
|
||||
**Version:** 2.15 · **Effective:** {{RELEASE_DATE}}
|
||||
|
||||
## 0. This is pre-release software
|
||||
|
||||
**FrameLedger is pre-release software.** Every build published so far is a pre-release: a beta, or an alpha — a beta's
|
||||
source built on a prerelease version of .NET, with the further risks set out in the Alpha notice
|
||||
(`legal/ALPHA_NOTICE.md`, shown before an alpha build runs). It has been tested on a small number of
|
||||
source built to try a newer version of .NET, at times a prerelease one, with the further risks set out in the Alpha
|
||||
notice (`legal/ALPHA_NOTICE.md`, shown before an alpha build runs). It has been tested on a small number of
|
||||
machines and games — the games are listed in `docs/LIST_GAME_TESTED.md` in the project's repository, and what the software
|
||||
cannot do is listed in `LIMITATIONS.md` there and in the app under Help ▸ Limitations — and **it certainly still contains
|
||||
bugs — some of them not yet known to anyone.** Features can
|
||||
change or disappear between builds, recorded data can turn out to be wrong, and an update can require your data to be
|
||||
migrated.
|
||||
|
||||
**Windows and your processor.** From 0.1.0-beta.37 FrameLedger is built on .NET 11. Microsoft supports .NET 11 on
|
||||
Windows 11, and on Windows 10 only in its LTSC and IoT editions. FrameLedger has been run on Windows 11 only: on
|
||||
Windows 10 22H2 Home or Pro it may run, but it is untested there and nobody supports it. It does not start on a
|
||||
processor without SSE4.2 and POPCNT.
|
||||
|
||||
By installing or running a pre-release build you accept that:
|
||||
|
||||
- it may crash, hang, fail to record, or record wrongly, and may cause the game you are measuring to do the same;
|
||||
@@ -115,9 +120,9 @@ Software running inside another process can, in principle, destabilize it. Frame
|
||||
Frame timing is derived from high-resolution timestamps taken at the moment the game presents each frame; upscaling, frame-generation and ray-tracing state are read from the parameters the game passes to those APIs. This is substantially more accurate than inferring settings from files on disk, but **no measurement is guaranteed to be exact**:
|
||||
|
||||
<!-- accuracy-block:begin -->
|
||||
> ⚠ **What FrameLedger actually measures today — 2026-11-06.** The software is a beta; its latest
|
||||
> **beta is `0.1.0-beta.34`** (2026-11-06), an unsigned installer built from that tag with its
|
||||
> checksums published beside it (alphas — experimental builds on a prerelease .NET — are published apart). The source holds the desktop app
|
||||
> ⚠ **What FrameLedger actually measures today — 2026-11-11.** The software is a beta; its latest
|
||||
> **beta is `0.1.0-beta.45`** (2026-11-12), 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
|
||||
@@ -205,6 +210,33 @@ Frame timing is derived from high-resolution timestamps taken at the moment the
|
||||
> Windows once a second and charted. Processor temperature is read only when the Agent runs as
|
||||
> administrator — an option, off by default, for which Windows asks at every start of the Agent — with
|
||||
> PawnIO installed, and that reading has not yet been checked on real hardware; everywhere else it is `N/A`.
|
||||
> - **Advanced metrics (since beta.39; off unless you switch it on in Settings):** with it on, a session also stores
|
||||
> what the graphics driver and the sensor library report about the hardware — the graphics card's memory, load,
|
||||
> clocks, fans, voltages and power in detail, what a display can do, the driver's settings for the game — as they
|
||||
> report it: NVIDIA's figures once a second, the sensor library's every five seconds. None of these readings has
|
||||
> been checked against another tool. The processor's, the memory's and the motherboard's need the Agent as
|
||||
> administrator with PawnIO and have never been read on real hardware; a drive's temperature is not read. The
|
||||
> Advanced page shows them as they were stored, and what the PC reads at the moment only while that page is open.
|
||||
> - **What a game tells its upscaler (since beta.40; only with Advanced metrics on, only for a game measured from
|
||||
> inside):** the output size, presets and exposure a game hands DLSS, and the sharpening, jitter, exposure, depth
|
||||
> range, field-of-view range, flags and frame time it hands FSR, are read from the arguments of the calls
|
||||
> FrameLedger intercepts and shown as the game stated them — not checked against what the upscaler did. Most games
|
||||
> set their DLSS options through a call that cannot be intercepted and show none; the FSR values need FSR 3.1 or
|
||||
> later through AMD's own library. Since beta.43 also what a game tells NVIDIA Streamline about each frame (jitter,
|
||||
> motion-vector scale, depth range, field-of-view range, how often it reset the upscaler's history — for the first
|
||||
> viewport that called, where a game has several) and how it configures FSR frame generation (the settings it asked
|
||||
> for, not whether frames were generated). Since beta.44 also what Streamline answers when a game asks about a
|
||||
> feature — its version, and what it requires (graphics APIs, V-Sync, GPU scheduling, Windows and driver versions):
|
||||
> Streamline's answer as the game received it, not a check of the PC. A game that asks only while it starts has
|
||||
> none and the session says so; the Unreal Engine games run so far ask again later, and were read. Since beta.45
|
||||
> also whether Streamline says each feature is supported and whether it is loaded, and what the game did with it
|
||||
> after FrameLedger attached — switched it on or off, allocated and freed its resources (counted to fifteen), shut
|
||||
> Streamline down: calls the game made, not a statement that a feature ran or produced anything. FSR's upscaling
|
||||
> values, Streamline's constants (seven games), its answers about a feature (seven games), the
|
||||
> frame-generation configuration (one game) and five of beta.45's six calls (five games) have been read from
|
||||
> real games; no game run so far allocated a feature's resources after FrameLedger attached, and the DLSS
|
||||
> options have not been confirmed on one yet. A game may give a value in a unit of its own: one gives
|
||||
> Streamline its field of view in degrees, and it is shown as given.
|
||||
> - **Safety:** every pre-injection check runs before injection, including the signed-by-a-known-vendor
|
||||
> half of the suspicious-module rule. During every capture the Agent re-runs the checks every 30 s and
|
||||
> stops capturing on a refusal: a Direct3D or OpenGL game's hooks are removed, and the Vulkan layer
|
||||
@@ -246,14 +278,15 @@ be the difference between a game that runs and one that does not. Turn hooking o
|
||||
|
||||
## 5. Hardware and drivers
|
||||
|
||||
FrameLedger reads GPU telemetry through vendor libraries that ship with your graphics driver. It **only reads** — it never changes clocks, fan curves, power limits, or any other hardware setting. Optional CPU-temperature support relies on the separate third-party **PawnIO** driver, which you install at your own discretion under its own license; some anti-cheat systems object to third-party kernel drivers regardless of what they are used for.
|
||||
FrameLedger reads GPU telemetry through vendor libraries that ship with your graphics driver. It **only reads** — it never changes clocks, fan curves, power limits, or any other hardware setting. Optional CPU-temperature support — and, with Advanced metrics on, reading the processor's, the memory's and the motherboard's sensors — relies on the separate third-party **PawnIO** driver, which you install at your own discretion under its own license; some anti-cheat systems object to third-party kernel drivers regardless of what they are used for.
|
||||
|
||||
## 5A. Running the capture agent as administrator — optional, and your decision
|
||||
|
||||
Since 0.1.0-beta.10 a Settings option, off unless you turn it on, starts FrameLedger's capture agent as administrator.
|
||||
**Windows asks you every time the agent starts** — also when you sign in — and the prompt names an unknown publisher,
|
||||
because FrameLedger is not code-signed. It lets FrameLedger open and measure a game that itself runs as administrator,
|
||||
and read the CPU temperature where PawnIO is installed. It changes nothing in the anti-cheat guard (§2, §2A), opens no
|
||||
and read the CPU temperature — and, with Advanced metrics on, the processor's, the memory's and the motherboard's
|
||||
sensors — where PawnIO is installed. It changes nothing in the anti-cheat guard (§2, §2A), opens no
|
||||
process that Windows or an anti-cheat driver protects, and never starts a game as administrator: games you start from
|
||||
FrameLedger run with your standard rights.
|
||||
|
||||
|
||||
+3
-3
@@ -1,6 +1,6 @@
|
||||
# FrameLedger — End User License Agreement (EULA)
|
||||
|
||||
**Version:** 1.6 · **Effective:** {{RELEASE_DATE}}
|
||||
**Version:** 1.7 · **Effective:** {{RELEASE_DATE}}
|
||||
|
||||
This End User License Agreement ("Agreement") applies to **FrameLedger** ("the Software"), developed and published by **poli0981** ("the Developer"), contactable at <contact@poli0981.dev> — see <https://poli0981.dev/> for other contact channels.
|
||||
|
||||
@@ -33,8 +33,8 @@ The Software records without injecting unless you enable injection for a specifi
|
||||
## 2B. Pre-release software, and your PC
|
||||
|
||||
The Software is currently distributed only as **pre-release builds** — **betas**, and **alphas**: a beta's source built
|
||||
on a prerelease version of .NET, with the further risks the Alpha notice describes (`legal/ALPHA_NOTICE.md`) — which
|
||||
certainly still contain defects (Disclaimer §0). You use a pre-release build at your own risk, and the Developer is not
|
||||
to try a newer version of .NET, at times a prerelease one, with the further risks the Alpha notice describes
|
||||
(`legal/ALPHA_NOTICE.md`) — which certainly still contain defects (Disclaimer §0). You use a pre-release build at your own risk, and the Developer is not
|
||||
responsible for any incident that results.
|
||||
|
||||
You are responsible for making sure your PC meets at least the minimum system requirements published by the developer
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# FrameLedger — Privacy Policy
|
||||
|
||||
**Version:** 2.14 · **Effective:** {{RELEASE_DATE}}
|
||||
**Version:** 2.19 · **Effective:** {{RELEASE_DATE}}
|
||||
|
||||
**Short version: everything stays on your PC. FrameLedger has no accounts, no telemetry, no analytics, and never uploads your data anywhere.**
|
||||
|
||||
@@ -11,6 +11,7 @@ Stored in `%LOCALAPPDATA%\FrameLedger` on your device:
|
||||
- Your game library entries (names, executable paths, metadata you or the app filled in, and whether each one is recorded).
|
||||
- Images you choose for a game (Edit…), copied into the `covers` folder; choosing the store's image again, or removing the game together with its sessions, deletes the copy. Artwork a store's app keeps on your PC, or a game ships in its own folder, is shown from where it is and not copied.
|
||||
- Performance sessions: frame timing series, computed statistics, hardware sensor series (temperatures, load, power, memory usage, and the graphics card's clock speeds, fan speed, memory temperature and whether its power limit or heat held it back), the game's own memory use (its dedicated and shared video memory, private working set, working set and commit, once a second), session duration, crash flags, the graphics driver's settings the game ran under (NVIDIA only), how the game's window was shown (full-screen, borderless or windowed, for how long, its size and the monitor's), tags and notes you write.
|
||||
- **Only while Settings ▸ Advanced metrics is on** (it is off unless you switch it on), with each session: more hardware sensor series — the graphics card's memory use in detail, its load by part, its clocks, voltages, currents, power, each fan and its video encoder's use; and, when the capture agent runs as administrator with PawnIO installed, the processor's temperatures, load, clocks, power and voltages by core, the memory in use and its modules' temperatures, and the motherboard's temperatures, fans and voltages — and a description of the hardware: the graphics card's firmware version, architecture, bus and memory sizes, the graphics driver's package and the chipset it names, the motherboard's and the memory modules' model names, what each connected display can do (the HDR formats it accepts, its brightness range, variable refresh), whether variable refresh was in use on the display the game ran on and the colour space the game presented in, and the graphics driver's settings — its global ones and the ones it holds for the game (NVIDIA only). For a game FrameLedger injects into, a session then also stores what the game itself passed to its upscaler in the calls FrameLedger intercepts: the output size, the model presets and the exposure values it gave DLSS, whether it said its colour buffers are HDR, auto-exposure and alpha upscaling; and the sharpening, the size of the jitter, the exposure, the depth range, the lowest and highest field of view and the flags it gave FSR, the frame time it reported to FSR, and FSR's own video memory when the game asked for it; what the game told NVIDIA Streamline about each frame — the size of the jitter, the motion-vector scale, the depth range and whether depth is inverted, the lowest and highest field of view, the aspect ratio, whether the projection is orthographic, how its motion vectors are stored and how often it reset the upscaler's history; and how it configured FSR frame generation — on or off, whether it may run asynchronously, its flags, whether only generated frames are presented, and the rectangle it generates in; and what NVIDIA Streamline answered when the game asked it about a feature — which features the game asked about, the version of each and of its NGX model, and what each requires: the graphics APIs it supports, whether V-Sync must be off and hardware-accelerated GPU scheduling on, how many processor threads, viewports and buffers, and the versions of Windows and of the graphics driver that Streamline found beside the ones the feature needs ; and, for each Streamline feature the game asks about or controls: whether Streamline answers that it is supported, whether it is loaded, whether the game switched it on or off while it ran, and how many times its resources were allocated and freed; and whether the game shut Streamline down, and how many times — never the lists Streamline's answer points to (the buffers' names, the names of Vulkan extensions and features), never what identifies the graphics card that the game hands over with its question, never the content of a graphics resource, and never where the game's camera is, which way it looks, or its matrices. No serial number, no display identification data (EDID) and no list of other programs is read or stored. Switching the option off stops the reading, inside a game as well; what earlier sessions stored stays with them until you delete those sessions.
|
||||
- A hardware snapshot per session (CPU/GPU model, driver version, RAM size, OS build, display mode) used for the "what changed between sessions" feature.
|
||||
- App settings, logs (rotated daily — the app keeps 7 days, the capture agent 14 — including the logs written by the component loaded into games), and, after a crash of the app itself, crash dump files.
|
||||
- Which games you enabled code injection for, and when you consented.
|
||||
@@ -38,11 +39,11 @@ The "Report a bug" feature builds a zip file **on your device**, shows you exact
|
||||
|
||||
## 3A. Sharing an export or a bug report
|
||||
|
||||
An exported session (CSV or JSON) and a bug report can contain your games' names and **the paths to their files** — which include your **Windows user name** when a game is installed under your user folder — your hardware model, graphics driver and Windows build, the times you played, and your tags and notes. A bug report removes user directory paths from its logs; an export is written as it is. Look at a file before you share it. Once you share it, it is outside FrameLedger: whoever receives it, and the site you post it to, can read it under their own terms.
|
||||
An exported session (CSV or JSON) and a bug report can contain your games' names and **the paths to their files** — which include your **Windows user name** when a game is installed under your user folder — your hardware model, graphics driver and Windows build, the times you played, and your tags and notes. What a session stores only while Advanced metrics is on (§1) is in neither: an export and a bug report carry what they carried before. A bug report removes user directory paths from its logs; an export is written as it is. Look at a file before you share it. Once you share it, it is outside FrameLedger: whoever receives it, and the site you post it to, can read it under their own terms.
|
||||
|
||||
## 4. What the app can technically observe
|
||||
|
||||
To do its job, FrameLedger observes: which of *your tracked* executables — the entries in your library whose recording is on — are running, and their process trees; whether a game you enabled hooking for runs in an app container, and which of Windows' code-protection settings it runs under (for example, accepting only Microsoft-signed code), read from Windows before any injection; the parameters your games pass to the graphics APIs it intercepts (presentation, upscaling, ray tracing, pipeline creation); the memory use of a tracked game's process — its dedicated and shared video memory, from Windows' GPU performance counters, and its working sets and commit, from Windows' process-memory information, for which a game it does not inject into is opened with the least access Windows offers and closed again (never its memory's content); loaded module names of a game being captured, the version information of its upscaling, frame-generation and neural-rendering libraries, and whether each was loaded from the game's folder or from the graphics driver's own copy (for detection and for the anti-cheat safety check); the names of the files in each library game's install folder, the version information of its executable and of the upscaling and neural-rendering libraries it ships, the content of its executable file (the markers of the engine and of the graphics libraries it carries, the libraries it imports, and the engine build name an Unreal Engine game carries), the version marks an engine keeps in its own files (Unity's player library and the header of its data file, the header of a Godot data pack, an RPG Maker game's title, core script and Game.ini, the library Game.ini names, and the version file of a Ren'Py game's engine), and the store files that name it (Steam's and GOG's, on your disk) and, for a game the Xbox app or the Microsoft Store installed, the package files in its install folder that describe it (`MicrosoftGame.config` and `appxmanifest.xml`) — to detect its engine, its engine version and its features and to check it for anti-cheat before any injection is possible; the lists of installed games that the Steam, GOG GALAXY, Epic Games and itch apps keep on your disk, and where GOG GALAXY is installed, the folders the Xbox app installs games into on each drive (named by the `.GamingRoot` file at the drive's root) with each game's package files, and Windows' answer to whether that game's package is installed for you — read when you import your library and when you press Play, to find the store that installed a game and hand the game to that store's app — Steam's and GOG GALAXY's also when you open a game's page, to find the artwork their apps keep for it; the cover and banner images that the Steam and GOG GALAXY apps keep on your disk for a game in your library and the logo and splash-screen images a game from the Xbox app ships in its own folder — read to show them on its page, never copied or sent anywhere; the size, position and state of a tracked game's window and the monitor it is on, read from Windows and not from the game, and — for a game FrameLedger injects into — whether the game asked for exclusive full-screen; the NVIDIA driver's settings for your tracked executables (read only: the DLSS and frame-generation overrides the NVIDIA App set); hardware sensor values from your graphics driver's own libraries; how busy the processor is and how much memory is in use, from Windows' own counters; the crash reports Windows keeps in its Application log about a tracked game's executable while it ran (to tell a crash from an ordinary exit — the reports are read, never sent anywhere); and the names of the programs a tracked game starts, so that a game's own crash reporter is recognised.
|
||||
To do its job, FrameLedger observes: which of *your tracked* executables — the entries in your library whose recording is on — are running, and their process trees; whether a game you enabled hooking for runs in an app container, and which of Windows' code-protection settings it runs under (for example, accepting only Microsoft-signed code), read from Windows before any injection; the parameters your games pass to the graphics APIs it intercepts (presentation, upscaling, ray tracing, pipeline creation) — and, only while Advanced metrics is on, more of the parameters of the upscaling calls, and the parameters of ten further calls it begins to intercept in a game only once a session with that option on has started there (the constants the game gives NVIDIA Streamline for each frame, the game's configuration of FSR frame generation, Streamline's answers to the game's four questions about a feature — which version it is, what it requires, whether it is supported and whether it is loaded — and the game switching a feature on or off, allocating and freeing its resources, and shutting Streamline down), which are then stored with the session (sizes, presets, exposure, sharpening, the jitter's size, the motion-vector scale, the depth range, the range of the field of view, flags, the reported frame time, the upscaler's own memory, how frame generation is configured, the versions and requirements of Streamline's features, whether each is supported and loaded, and how often the game switched it, allocated and freed its resources and shut Streamline down), never the camera's position, direction or matrices, and never what identifies the graphics card; the memory use of a tracked game's process — its dedicated and shared video memory, from Windows' GPU performance counters, and its working sets and commit, from Windows' process-memory information, for which a game it does not inject into is opened with the least access Windows offers and closed again (never its memory's content); loaded module names of a game being captured, the version information of its upscaling, frame-generation and neural-rendering libraries, and whether each was loaded from the game's folder or from the graphics driver's own copy (for detection and for the anti-cheat safety check); the names of the files in each library game's install folder, the version information of its executable and of the upscaling and neural-rendering libraries it ships, the content of its executable file (the markers of the engine and of the graphics libraries it carries, the libraries it imports, and the engine build name an Unreal Engine game carries), the version marks an engine keeps in its own files (Unity's player library and the header of its data file, the header of a Godot data pack, an RPG Maker game's title, core script and Game.ini, the library Game.ini names, and the version file of a Ren'Py game's engine), and the store files that name it (Steam's and GOG's, on your disk) and, for a game the Xbox app or the Microsoft Store installed, the package files in its install folder that describe it (`MicrosoftGame.config` and `appxmanifest.xml`) — to detect its engine, its engine version and its features and to check it for anti-cheat before any injection is possible; the lists of installed games that the Steam, GOG GALAXY, Epic Games and itch apps keep on your disk, and where GOG GALAXY is installed, the folders the Xbox app installs games into on each drive (named by the `.GamingRoot` file at the drive's root) with each game's package files, and Windows' answer to whether that game's package is installed for you — read when you import your library and when you press Play, to find the store that installed a game and hand the game to that store's app — Steam's and GOG GALAXY's also when you open a game's page, to find the artwork their apps keep for it; the cover and banner images that the Steam and GOG GALAXY apps keep on your disk for a game in your library and the logo and splash-screen images a game from the Xbox app ships in its own folder — read to show them on its page, never copied or sent anywhere; the size, position and state of a tracked game's window and the monitor it is on, read from Windows and not from the game, and — for a game FrameLedger injects into — whether the game asked for exclusive full-screen; the NVIDIA driver's settings for your tracked executables (read only: the DLSS and frame-generation overrides the NVIDIA App set); hardware sensor values from your graphics driver's own libraries; and — only while Advanced metrics is on — that driver's description of the graphics card and of each connected display, what it reports about the display a tracked game's window is on, its settings for a tracked game and its global ones (read only), and, when the capture agent runs as administrator with PawnIO installed, the sensors and model names of the processor, the memory and the motherboard (never a drive's), all of which areLine truncated
|
||||
|
||||
It does **not** read game memory outside those API parameters, and does not read game saves, chat, input content, network traffic, or anything unrelated to performance measurement. It records only for programs you added to your library and did not switch recording off for — a program whose recording is off is not watched at all — and injects only into games you individually enabled.
|
||||
|
||||
|
||||
@@ -46,7 +46,7 @@ FrameLedger is licensed under **GPL-3.0-only**. It includes or depends on the th
|
||||
| **Transitive, under LibreHardwareMonitorLib** — BlackSharp.Core, DiskInfoToolkit, RAMSPDToolkit-NDD | Hardware access helpers LHM 0.9.6 depends on | MPL-2.0 | Not named by this table until 2026-09-15. **Exhibit B clear:** authenticated code search of each upstream repository (Blacktempel/BlackSharp, /DiskInfoToolkit, /RAMSPDToolkit) finds the sentence once, in `LICENSE` — the template — and no source file carries an MPL notice at all, so the repository licence governs and §3.3 Secondary Licenses applies. Default branch as searched; the nuspecs pin commits `c70b735c`, `25319eae`, `3b47b960`. Source Code Form links are in each package's text |
|
||||
| **Transitive, under LibreHardwareMonitorLib** — HidSharp; Mono.Posix.NETStandard; System.IO.Ports, System.Management, System.CodeDom, System.IO.FileSystem.AccessControl | USB HID, POSIX helpers, serial ports, WMI | Apache-2.0 (HidSharp's LICENSE.txt); MIT (Mono's LICENSE, reviewed override); MIT (Microsoft) | Mono.Posix.NETStandard declares only a URL; its text is the Mono LICENSE file that URL resolves to, fetched 2026-09-15 and committed as `tools/license-overrides/Mono.Posix.NETStandard.txt` |
|
||||
| **Transitive, under ScottPlot.WPF** — SkiaSharp, HarfBuzzSharp and their Win32 native assets; OpenTK 4.x; OpenTK.GLWpfControl; OpenTK.redist.glfw | 2-D rendering, text shaping, OpenGL host | MIT; GLFW is zlib (its COPYING.md) | The native Skia and HarfBuzz builds carry their own third-party notices, shipped once each in `legal/licenses/nuget/notices-*.txt`. OpenTK.GLWpfControl declares only a URL (reviewed override, like Mono.Posix) |
|
||||
| **Transitive** — Microsoft.Extensions.* (Hosting, DependencyInjection, Logging, Configuration, Options, …), Serilog.Extensions.*, Serilog.Sinks.Console, SQLitePCLRaw.* — its `lib.e_sqlite3` is the SQLite engine *(since beta.30; SourceGear's own `SQLite` package before, under a pin the release dropped)* | Host, DI, logging plumbing; the SQLite engine | MIT; Apache-2.0; SQLite is public domain | The complete, versioned list is `legal/licenses/nuget/INDEX.md` — 77 packages on 2026-09-15, 78 on 2026-10-26 |
|
||||
| **Transitive** — Microsoft.Extensions.* (Hosting, DependencyInjection, Logging, Configuration, Options, …), Serilog.Extensions.*, Serilog.Sinks.Console, SQLitePCLRaw.* — the SQLite engine is SourceGear's `SQLite` package *(since beta.37, 2026-11-11, D94: SQLitePCLRaw 3.0.5, declared by `Microsoft.Data.Sqlite` 11; from beta.30 to beta.36 it was SQLitePCLRaw's own `lib.e_sqlite3`, and SourceGear's package before that under a pin beta.30 dropped; the alphas shipped this graph from 2026-10-31)*. Nine `Microsoft.Extensions.*` libraries are part of the .NET 11 runtime rather than packages beside it | Host, DI, logging plumbing; the SQLite engine | MIT; Apache-2.0; SQLite is public domain | The complete, versioned list is `legal/licenses/nuget/INDEX.md` — 77 packages on 2026-09-15, 78 on 2026-10-26, 69 since beta.37 (2026-11-11) |
|
||||
| Roslynator, Meziantou.Analyzer, VS Threading Analyzers (build-time) | Static analysis | Apache-2.0 / MIT | Build-time only |
|
||||
| **Test-time only, never shipped** — xUnit.net v3 4.x (`xunit.v3.mtp-off`, `xunit.runner.visualstudio`), Microsoft.NET.Test.Sdk, coverlet.collector, FluentAssertions 7.x, NSubstitute; Catch2 (native) | Unit and integration tests, coverage | Apache-2.0 (xUnit.net, <https://github.com/xunit/xunit>; FluentAssertions **7.x only**) · MIT (Test.Sdk, coverlet) · BSD-3-Clause (NSubstitute) · BSL-1.0 (Catch2) | Not named by this table until 2026-09-21. None of them is in a published package: `12_BUILD` publishes App and Agent only, `tools/package-closure-check.ps1` keeps the test projects out of that closure, and `legal/licenses/nuget/` therefore lists none of them. xUnit.net moved 3.2.2 → 4.0.1 on 2026-09-21, same licence. **FluentAssertions is pinned to `[7.2.2]` on purpose**: 8.x is Xceed's Community Licence, not an OSI licence (`Directory.Packages.props`, `20_OPEN_QUESTIONS` §G). Catch2's text is `legal/licenses/catch2-BSL-1.0.txt` |
|
||||
|
||||
|
||||
@@ -19,34 +19,26 @@ from the runtime packs the publish used.
|
||||
| HidSharp | 2.6.4 | the file LICENSE.txt in the package | Agent, App | [HidSharp.txt](HidSharp.txt) |
|
||||
| LibreHardwareMonitorLib | 0.9.6 | MPL-2.0 | Agent, App | [LibreHardwareMonitorLib.txt](LibreHardwareMonitorLib.txt) |
|
||||
| Markdig | 1.5.0 | BSD-2-Clause | App | [Markdig.txt](Markdig.txt) |
|
||||
| Microsoft.Data.Sqlite.Core | 10.0.14 | MIT | Agent, App | [Microsoft.Data.Sqlite.Core.txt](Microsoft.Data.Sqlite.Core.txt) |
|
||||
| Microsoft.Extensions.Configuration | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Configuration.txt](Microsoft.Extensions.Configuration.txt) |
|
||||
| Microsoft.Extensions.Configuration.Abstractions | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Configuration.Abstractions.txt](Microsoft.Extensions.Configuration.Abstractions.txt) |
|
||||
| Microsoft.Extensions.Configuration.Binder | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Configuration.Binder.txt](Microsoft.Extensions.Configuration.Binder.txt) |
|
||||
| Microsoft.Extensions.Configuration.CommandLine | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Configuration.CommandLine.txt](Microsoft.Extensions.Configuration.CommandLine.txt) |
|
||||
| Microsoft.Extensions.Configuration.EnvironmentVariables | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Configuration.EnvironmentVariables.txt](Microsoft.Extensions.Configuration.EnvironmentVariables.txt) |
|
||||
| Microsoft.Extensions.Configuration.FileExtensions | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Configuration.FileExtensions.txt](Microsoft.Extensions.Configuration.FileExtensions.txt) |
|
||||
| Microsoft.Extensions.Configuration.Json | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Configuration.Json.txt](Microsoft.Extensions.Configuration.Json.txt) |
|
||||
| Microsoft.Extensions.Configuration.UserSecrets | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Configuration.UserSecrets.txt](Microsoft.Extensions.Configuration.UserSecrets.txt) |
|
||||
| Microsoft.Extensions.DependencyInjection | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.DependencyInjection.txt](Microsoft.Extensions.DependencyInjection.txt) |
|
||||
| Microsoft.Extensions.DependencyInjection.Abstractions | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.DependencyInjection.Abstractions.txt](Microsoft.Extensions.DependencyInjection.Abstractions.txt) |
|
||||
| Microsoft.Extensions.Diagnostics | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Diagnostics.txt](Microsoft.Extensions.Diagnostics.txt) |
|
||||
| Microsoft.Extensions.Diagnostics.Abstractions | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Diagnostics.Abstractions.txt](Microsoft.Extensions.Diagnostics.Abstractions.txt) |
|
||||
| Microsoft.Extensions.FileProviders.Abstractions | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.FileProviders.Abstractions.txt](Microsoft.Extensions.FileProviders.Abstractions.txt) |
|
||||
| Microsoft.Extensions.FileProviders.Physical | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.FileProviders.Physical.txt](Microsoft.Extensions.FileProviders.Physical.txt) |
|
||||
| Microsoft.Extensions.FileSystemGlobbing | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.FileSystemGlobbing.txt](Microsoft.Extensions.FileSystemGlobbing.txt) |
|
||||
| Microsoft.Extensions.Hosting | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Hosting.txt](Microsoft.Extensions.Hosting.txt) |
|
||||
| Microsoft.Extensions.Hosting.Abstractions | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Hosting.Abstractions.txt](Microsoft.Extensions.Hosting.Abstractions.txt) |
|
||||
| Microsoft.Extensions.Logging | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Logging.txt](Microsoft.Extensions.Logging.txt) |
|
||||
| Microsoft.Extensions.Logging.Abstractions | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Logging.Abstractions.txt](Microsoft.Extensions.Logging.Abstractions.txt) |
|
||||
| Microsoft.Extensions.Logging.Configuration | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Logging.Configuration.txt](Microsoft.Extensions.Logging.Configuration.txt) |
|
||||
| Microsoft.Extensions.Logging.Console | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Logging.Console.txt](Microsoft.Extensions.Logging.Console.txt) |
|
||||
| Microsoft.Extensions.Logging.Debug | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Logging.Debug.txt](Microsoft.Extensions.Logging.Debug.txt) |
|
||||
| Microsoft.Extensions.Logging.EventLog | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Logging.EventLog.txt](Microsoft.Extensions.Logging.EventLog.txt) |
|
||||
| Microsoft.Extensions.Logging.EventSource | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Logging.EventSource.txt](Microsoft.Extensions.Logging.EventSource.txt) |
|
||||
| Microsoft.Extensions.Options | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Options.txt](Microsoft.Extensions.Options.txt) |
|
||||
| Microsoft.Extensions.Options.ConfigurationExtensions | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Options.ConfigurationExtensions.txt](Microsoft.Extensions.Options.ConfigurationExtensions.txt) |
|
||||
| Microsoft.Extensions.Primitives | 10.0.14 | MIT | Agent, App | [Microsoft.Extensions.Primitives.txt](Microsoft.Extensions.Primitives.txt) |
|
||||
| Microsoft.Data.Sqlite.Core | 11.0.0 | MIT | Agent, App | [Microsoft.Data.Sqlite.Core.txt](Microsoft.Data.Sqlite.Core.txt) |
|
||||
| Microsoft.Extensions.Configuration | 11.0.0 | MIT | Agent, App | [Microsoft.Extensions.Configuration.txt](Microsoft.Extensions.Configuration.txt) |
|
||||
| Microsoft.Extensions.Configuration.Binder | 11.0.0 | MIT | Agent, App | [Microsoft.Extensions.Configuration.Binder.txt](Microsoft.Extensions.Configuration.Binder.txt) |
|
||||
| Microsoft.Extensions.Configuration.CommandLine | 11.0.0 | MIT | Agent, App | [Microsoft.Extensions.Configuration.CommandLine.txt](Microsoft.Extensions.Configuration.CommandLine.txt) |
|
||||
| Microsoft.Extensions.Configuration.EnvironmentVariables | 11.0.0 | MIT | Agent, App | [Microsoft.Extensions.Configuration.EnvironmentVariables.txt](Microsoft.Extensions.Configuration.EnvironmentVariables.txt) |
|
||||
| Microsoft.Extensions.Configuration.FileExtensions | 11.0.0 | MIT | Agent, App | [Microsoft.Extensions.Configuration.FileExtensions.txt](Microsoft.Extensions.Configuration.FileExtensions.txt) |
|
||||
| Microsoft.Extensions.Configuration.Json | 11.0.0 | MIT | Agent, App | [Microsoft.Extensions.Configuration.Json.txt](Microsoft.Extensions.Configuration.Json.txt) |
|
||||
| Microsoft.Extensions.Configuration.UserSecrets | 11.0.0 | MIT | Agent, App | [Microsoft.Extensions.Configuration.UserSecrets.txt](Microsoft.Extensions.Configuration.UserSecrets.txt) |
|
||||
| Microsoft.Extensions.DependencyInjection | 11.0.0 | MIT | Agent, App | [Microsoft.Extensions.DependencyInjection.txt](Microsoft.Extensions.DependencyInjection.txt) |
|
||||
| Microsoft.Extensions.Diagnostics | 11.0.0 | MIT | Agent, App | [Microsoft.Extensions.Diagnostics.txt](Microsoft.Extensions.Diagnostics.txt) |
|
||||
| Microsoft.Extensions.FileProviders.Physical | 11.0.0 | MIT | Agent, App | [Microsoft.Extensions.FileProviders.Physical.txt](Microsoft.Extensions.FileProviders.Physical.txt) |
|
||||
| Microsoft.Extensions.FileSystemGlobbing | 11.0.0 | MIT | Agent, App | [Microsoft.Extensions.FileSystemGlobbing.txt](Microsoft.Extensions.FileSystemGlobbing.txt) |
|
||||
| Microsoft.Extensions.Hosting | 11.0.0 | MIT | Agent, App | [Microsoft.Extensions.Hosting.txt](Microsoft.Extensions.Hosting.txt) |
|
||||
| Microsoft.Extensions.Logging | 11.0.0 | MIT | Agent, App | [Microsoft.Extensions.Logging.txt](Microsoft.Extensions.Logging.txt) |
|
||||
| Microsoft.Extensions.Logging.Configuration | 11.0.0 | MIT | Agent, App | [Microsoft.Extensions.Logging.Configuration.txt](Microsoft.Extensions.Logging.Configuration.txt) |
|
||||
| Microsoft.Extensions.Logging.Console | 11.0.0 | MIT | Agent, App | [Microsoft.Extensions.Logging.Console.txt](Microsoft.Extensions.Logging.Console.txt) |
|
||||
| Microsoft.Extensions.Logging.Debug | 11.0.0 | MIT | Agent, App | [Microsoft.Extensions.Logging.Debug.txt](Microsoft.Extensions.Logging.Debug.txt) |
|
||||
| Microsoft.Extensions.Logging.EventLog | 11.0.0 | MIT | Agent, App | [Microsoft.Extensions.Logging.EventLog.txt](Microsoft.Extensions.Logging.EventLog.txt) |
|
||||
| Microsoft.Extensions.Logging.EventSource | 11.0.0 | MIT | Agent, App | [Microsoft.Extensions.Logging.EventSource.txt](Microsoft.Extensions.Logging.EventSource.txt) |
|
||||
| Microsoft.Extensions.Options.ConfigurationExtensions | 11.0.0 | MIT | Agent, App | [Microsoft.Extensions.Options.ConfigurationExtensions.txt](Microsoft.Extensions.Options.ConfigurationExtensions.txt) |
|
||||
| Mono.Posix.NETStandard | 1.0.0 | a URL only: https://go.microsoft.com/fwlink/?linkid=869050 | Agent, App | [Mono.Posix.NETStandard.txt](Mono.Posix.NETStandard.txt) |
|
||||
| OpenTK.Audio.OpenAL | 4.9.4 | MIT | App | [OpenTK.Audio.OpenAL.txt](OpenTK.Audio.OpenAL.txt) |
|
||||
| OpenTK.Compute | 4.9.4 | MIT | App | [OpenTK.Compute.txt](OpenTK.Compute.txt) |
|
||||
@@ -72,13 +64,12 @@ from the runtime packs the publish used.
|
||||
| SkiaSharp.NativeAssets.Win32 | 3.119.0 | MIT | App | [SkiaSharp.NativeAssets.Win32.txt](SkiaSharp.NativeAssets.Win32.txt) |
|
||||
| SkiaSharp.Views.Desktop.Common | 3.119.0 | MIT | App | [SkiaSharp.Views.Desktop.Common.txt](SkiaSharp.Views.Desktop.Common.txt) |
|
||||
| SkiaSharp.Views.WPF | 3.119.0 | MIT | App | [SkiaSharp.Views.WPF.txt](SkiaSharp.Views.WPF.txt) |
|
||||
| SQLitePCLRaw.bundle_e_sqlite3 | 2.1.13 | Apache-2.0 | Agent, App | [SQLitePCLRaw.bundle_e_sqlite3.txt](SQLitePCLRaw.bundle_e_sqlite3.txt) |
|
||||
| SQLitePCLRaw.core | 2.1.13 | Apache-2.0 | Agent, App | [SQLitePCLRaw.core.txt](SQLitePCLRaw.core.txt) |
|
||||
| SQLitePCLRaw.lib.e_sqlite3 | 2.1.13 | Apache-2.0 | Agent, App | [SQLitePCLRaw.lib.e_sqlite3.txt](SQLitePCLRaw.lib.e_sqlite3.txt) |
|
||||
| SQLitePCLRaw.provider.e_sqlite3 | 2.1.13 | Apache-2.0 | Agent, App | [SQLitePCLRaw.provider.e_sqlite3.txt](SQLitePCLRaw.provider.e_sqlite3.txt) |
|
||||
| SQLite | 3.53.4 | the file LICENSE.txt in the package | Agent, App | [SQLite.txt](SQLite.txt) |
|
||||
| SQLitePCLRaw.config.e_sqlite3 | 3.0.5 | Apache-2.0 | Agent, App | [SQLitePCLRaw.config.e_sqlite3.txt](SQLitePCLRaw.config.e_sqlite3.txt) |
|
||||
| SQLitePCLRaw.core | 3.0.5 | Apache-2.0 | Agent, App | [SQLitePCLRaw.core.txt](SQLitePCLRaw.core.txt) |
|
||||
| SQLitePCLRaw.provider.e_sqlite3 | 3.0.5 | Apache-2.0 | Agent, App | [SQLitePCLRaw.provider.e_sqlite3.txt](SQLitePCLRaw.provider.e_sqlite3.txt) |
|
||||
| System.CodeDom | 10.0.2 | MIT | Agent | [System.CodeDom.txt](System.CodeDom.txt) |
|
||||
| System.Diagnostics.EventLog | 10.0.14 | MIT | Agent | [System.Diagnostics.EventLog.txt](System.Diagnostics.EventLog.txt) |
|
||||
| System.IO.FileSystem.AccessControl | 5.0.0 | MIT | Agent, App | [System.IO.FileSystem.AccessControl.txt](System.IO.FileSystem.AccessControl.txt) |
|
||||
| System.Diagnostics.EventLog | 11.0.0 | MIT | Agent | [System.Diagnostics.EventLog.txt](System.Diagnostics.EventLog.txt) |
|
||||
| System.IO.Ports | 10.0.3 | MIT | Agent, App | [System.IO.Ports.txt](System.IO.Ports.txt) |
|
||||
| System.Management | 10.0.2 | MIT | Agent, App | [System.Management.txt](System.Management.txt) |
|
||||
| Velopack | 1.2.161 | MIT | App | [Velopack.txt](Velopack.txt) |
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
Microsoft.Data.Sqlite.Core 10.0.14
|
||||
Microsoft.Data.Sqlite.Core 11.0.0
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
|
||||
@@ -1,33 +0,0 @@
|
||||
Microsoft.Extensions.Configuration.Abstractions 10.0.14
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -1,4 +1,4 @@
|
||||
Microsoft.Extensions.Configuration.Binder 10.0.14
|
||||
Microsoft.Extensions.Configuration.Binder 11.0.0
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
@@ -6,7 +6,7 @@ Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
Third-party notices: notices-a9a59db1b6a6.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
Microsoft.Extensions.Configuration.CommandLine 10.0.14
|
||||
Microsoft.Extensions.Configuration.CommandLine 11.0.0
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
@@ -6,7 +6,7 @@ Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
Third-party notices: notices-a9a59db1b6a6.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
Microsoft.Extensions.Configuration.EnvironmentVariables 10.0.14
|
||||
Microsoft.Extensions.Configuration.EnvironmentVariables 11.0.0
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
@@ -6,7 +6,7 @@ Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
Third-party notices: notices-a9a59db1b6a6.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
Microsoft.Extensions.Configuration.FileExtensions 10.0.14
|
||||
Microsoft.Extensions.Configuration.FileExtensions 11.0.0
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
@@ -6,7 +6,7 @@ Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
Third-party notices: notices-a9a59db1b6a6.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
Microsoft.Extensions.Configuration.Json 10.0.14
|
||||
Microsoft.Extensions.Configuration.Json 11.0.0
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
@@ -6,7 +6,7 @@ Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
Third-party notices: notices-a9a59db1b6a6.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
Microsoft.Extensions.Configuration.UserSecrets 10.0.14
|
||||
Microsoft.Extensions.Configuration.UserSecrets 11.0.0
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
@@ -6,7 +6,7 @@ Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
Third-party notices: notices-a9a59db1b6a6.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
Microsoft.Extensions.Configuration 10.0.14
|
||||
Microsoft.Extensions.Configuration 11.0.0
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
@@ -6,7 +6,7 @@ Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
Third-party notices: notices-a9a59db1b6a6.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
|
||||
@@ -1,33 +0,0 @@
|
||||
Microsoft.Extensions.DependencyInjection.Abstractions 10.0.14
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -1,4 +1,4 @@
|
||||
Microsoft.Extensions.DependencyInjection 10.0.14
|
||||
Microsoft.Extensions.DependencyInjection 11.0.0
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
@@ -6,7 +6,7 @@ Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
Third-party notices: notices-a9a59db1b6a6.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
|
||||
@@ -1,33 +0,0 @@
|
||||
Microsoft.Extensions.Diagnostics.Abstractions 10.0.14
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -1,4 +1,4 @@
|
||||
Microsoft.Extensions.Diagnostics 10.0.14
|
||||
Microsoft.Extensions.Diagnostics 11.0.0
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
@@ -6,7 +6,7 @@ Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
Third-party notices: notices-a9a59db1b6a6.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
|
||||
@@ -1,33 +0,0 @@
|
||||
Microsoft.Extensions.FileProviders.Abstractions 10.0.14
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -1,4 +1,4 @@
|
||||
Microsoft.Extensions.FileProviders.Physical 10.0.14
|
||||
Microsoft.Extensions.FileProviders.Physical 11.0.0
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
@@ -6,7 +6,7 @@ Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
Third-party notices: notices-a9a59db1b6a6.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
Microsoft.Extensions.FileSystemGlobbing 10.0.14
|
||||
Microsoft.Extensions.FileSystemGlobbing 11.0.0
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
@@ -6,7 +6,7 @@ Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
Third-party notices: notices-a9a59db1b6a6.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
|
||||
@@ -1,33 +0,0 @@
|
||||
Microsoft.Extensions.Hosting.Abstractions 10.0.14
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -1,4 +1,4 @@
|
||||
Microsoft.Extensions.Hosting 10.0.14
|
||||
Microsoft.Extensions.Hosting 11.0.0
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
@@ -6,7 +6,7 @@ Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
Third-party notices: notices-a9a59db1b6a6.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
|
||||
@@ -1,33 +0,0 @@
|
||||
Microsoft.Extensions.Logging.Abstractions 10.0.14
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright: © Microsoft Corporation. All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -1,4 +1,4 @@
|
||||
Microsoft.Extensions.Logging.Configuration 10.0.14
|
||||
Microsoft.Extensions.Logging.Configuration 11.0.0
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
@@ -6,7 +6,7 @@ Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
Third-party notices: notices-a9a59db1b6a6.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
Microsoft.Extensions.Logging.Console 10.0.14
|
||||
Microsoft.Extensions.Logging.Console 11.0.0
|
||||
|
||||
Licence declared: MIT
|
||||
Text below: the standard MIT text; the package ships no licence file
|
||||
@@ -6,7 +6,7 @@ Copyright: © Microsoft Corporation. All rights reserved.
|
||||
Authors: Microsoft
|
||||
Project: https://dot.net/
|
||||
Ships in: Agent, App
|
||||
Third-party notices: notices-b7d456965950.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
Third-party notices: notices-a9a59db1b6a6.txt (THIRD-PARTY-NOTICES.TXT)
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
|
||||
Loaded 100 of 513 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user