Compare commits

...
Author SHA1 Message Date
poli0981andClaude Opus 5.5 562f2ff767 release: 0.1.0-beta.12 - the CHANGELOG section, the accuracy block's release line, README's release lines, LIMITATIONS' version, HANDOFF's train section with the one START HERE and owner-only item 9
The [Unreleased] entries move under ## [0.1.0-beta.12] - 2026-10-04 with a
summary for a user and the update notes from beta.11 (schema 0018; the
Legal Gate shows EULA 1.5 / Disclaimer 2.10 / Privacy 2.6 once; the GPL is
no longer accepted). The date is the local one, as beta.9 and beta.10 did
when their runs fell on the previous UTC day.

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

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

VERSION stays 0.1.0: the tag's numeric core.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-04 01:29:57 +07:00
7 changed files with 111 additions and 13 deletions

No files matched your search

+29 -3
View File
@@ -28,6 +28,34 @@ numeric core and does not move; the heading is the full version — corrected 20
## [Unreleased]
## [0.1.0-beta.12] - 2026-10-04
**The twelfth pre-release: how much memory each game itself uses, documents you can read, and a user guide.** The same
unsigned installer: verify its hash against `SHA256SUMS.txt`, then *More info → Run anyway*. What changed for a user:
- **The game's own memory, in every session** — its video memory and its RAM, the figures Task Manager's Details tab
shows for the game's process, read once a second from outside the game, whether or not the game is hooked. The
session summary shows the median and the peak, the Sessions tab has two new columns, the Trend and Compare have the
memory metrics, the Sensors charts draw this game's memory beside the whole graphics card's and the whole PC's, and
the Dashboard shows it live.
- **Statistics per series**: every sensor's mean, median, minimum and peak, at the bottom of a session's summary.
- **Documents are rendered**, not shown as raw text: the first-start documents, Help ▸ Limitations, the update notes,
and a new **Help ▸ About** with the program's legal notices, the third-party licences and the legal documents.
- **A user guide** — eight short pages, under **Help ▸ User guide**.
- **The GPL is no longer something you accept**: it is your licence, shown for information. You accept the EULA (now
1.5), the Disclaimer (2.10) and the Privacy Policy (2.6), so the first-start window opens once after the update.
- Links to the project's documents open the version you run, not the newest one.
- **The Logs page's Warning and Error filters show the Agent's lines** too; they showed only the App's.
- **Settings no longer has "Record games launched outside FrameLedger"**: the switch never did anything.
**Updating from `0.1.0-beta.11`:**
- Quit the App (tray icon → Exit) and end `FrameLedger.Agent.exe` before running the installer.
- Schema 0018 adds the memory columns; the database opens in place, and an older version cannot open it again.
- Sessions recorded before this version have no memory figures and no per-series statistics: they read N/A, and the
summary says so.
- The new `FrameLedger.ProcessStats.dll` is installed beside the Agent; without it the memory figures read N/A.
### Added
- **The game's own memory, measured from outside the game, in every session** (owner decision D43, beta.12). A new
@@ -43,7 +71,7 @@ numeric core and does not move; the heading is the full version — corrected 20
(`game_vram_dedicated_*`, `game_ram_private_*`, …), the process count, the sources, and every sensor series'
n / mean / median / min / max in `sensor_stats_json`; carried live to the Dashboard (`SessionProgress`, `SessionHeld`)
and through the crash-recovery file (a new chunk type; beta.11's files still recover). The video-memory **budget** is
still not measured (`20_OPEN_QUESTIONS` §M11). The App shows all of it in the next change.
still not measured (`20_OPEN_QUESTIONS` §M11). The App shows all of it (below).
- **Sensor statistics have a median and a minimum** beside the mean and the maximum (`SeriesAggregates`).
- **The App shows the game's own memory everywhere a session is** (D43, beta.12), in Task Manager's units — MB below
1 GB, GB to two decimals, 1 GB = 1024 MB. The **session summary** has two new cards, *VRAM (this game)* and *RAM (this
@@ -71,7 +99,6 @@ numeric core and does not move; the heading is the full version — corrected 20
game, read your results, anti-cheat and safety, your data, questions and answers, and the terms in plain words — in
the app under **Help ▸ User guide** (the first item of the Help menu) and in the repository's `guide/` folder. The
README now opens with a pointer to it and keeps a separate section for developers and forks.
- **`NOTICE`, and the licence header in every source file** (owner decision D45, beta.12). FrameLedger's own material is
GPL-3.0-only with three additional terms of the kinds GPLv3 §7 permits: keep the copyright line and the attribution in
the program's legal notices (b), mark a modified version as different and do not call it "FrameLedger" alone (c), and
@@ -123,7 +150,6 @@ numeric core and does not move; the heading is the full version — corrected 20
rules file's own comment and the rules workflow's header made the feed claim too, and are corrected. `docs/README.md`
is a new index for developers. Code comments that said what is not so (a sparkline, a flyout, a layer flag "false by
construction", two self-test counts) are corrected with them.
- **The first start's summary said "there is no way to override that refusal"** although a per-game user-mode exception
has existed since beta.9, and **"Nothing is sent anywhere"** although the update check is a request to GitHub; it now
names the exception and the one request. The README's safety table still said an exception needed two earlier
+1 -1
View File
@@ -76,7 +76,7 @@ src/
FrameLedger.NvapiBridge/ # C++ DLL loaded by the Agent (never a game): NVAPI telemetry, NGX state (P2 PR-E2)
FrameLedger.ProcessStats/ # C++ DLL loaded by the Agent (never a game): the game process's memory (beta.12, D43)
tests/ tools/ third_party/ # ctest suites; probes, hook-harness, vendor stubs; vendored headers
# (these five lines added 2026-10-04 — the list stopped at Shm)
# (these three lines added 2026-10-04 — the list stopped at Shm)
FrameLedger.Domain/ # entities, metric calculators — zero dependencies
# (Metrics/ WRITTEN 2026-09-09, P2 PR-A: frame times,
# percentiles, lows, stutter, the FG window and its
+1 -1
View File
@@ -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.11.*
*Beta software: this page describes version 0.1.0-beta.12.*
## Games it will not measure
+4 -4
View File
@@ -9,8 +9,8 @@ anti-cheat, and look after your data, a page each. What FrameLedger cannot do is
[Limitations](LIMITATIONS.md). Both are in the app too (Help ▸ User guide, Help ▸ Limitations).
<!-- accuracy-block:begin -->
> ⚠ **What FrameLedger actually measures today — 2026-10-03.** The software is a beta; its latest
> **pre-release is `0.1.0-beta.11`** (2026-10-03), an unsigned installer built from that tag with its
> ⚠ **What FrameLedger actually measures today — 2026-10-04.** The software is a beta; its latest
> **pre-release is `0.1.0-beta.12`** (2026-10-04), an unsigned installer built from that tag with its
> checksums published beside it. The source holds the desktop app
> (library, store import, charts, settings) and the background Agent, which records a session when a
> game in the library runs (unless you switched its recording off), injects only into games you enabled
@@ -153,7 +153,7 @@ Elevation is **optional — for everything.** Hooked capture is the normal path
## Install
> **The latest pre-release is `v0.1.0-beta.11` (2026-10-03); before it `v0.1.0-beta.10` (2026-09-28), `v0.1.0-beta.9` (2026-09-26), `v0.1.0-beta.8` (2026-09-25), `v0.1.0-beta.7` (2026-09-23), `v0.1.0-beta.6` (2026-09-23), `v0.1.0-beta.5` (2026-09-22), `v0.1.0-beta.4` (2026-09-21), `v0.1.0-beta.3` (2026-09-21), `v0.1.0-beta.2` (2026-09-17) and `v0.1.0-beta.1` (2026-09-16).** They are pre-releases: read `CHANGELOG.md`'s section for the one you install — what it measures, what it does not yet, and how to update — before installing. A source build is `docs/12_BUILD.md`.
> **The latest pre-release is `v0.1.0-beta.12` (2026-10-04); before it `v0.1.0-beta.11` (2026-10-03), `v0.1.0-beta.10` (2026-09-28), `v0.1.0-beta.9` (2026-09-26), `v0.1.0-beta.8` (2026-09-25), `v0.1.0-beta.7` (2026-09-23), `v0.1.0-beta.6` (2026-09-23), `v0.1.0-beta.5` (2026-09-22), `v0.1.0-beta.4` (2026-09-21), `v0.1.0-beta.3` (2026-09-21), `v0.1.0-beta.2` (2026-09-17) and `v0.1.0-beta.1` (2026-09-16).** They are pre-releases: read `CHANGELOG.md`'s section for the one you install — what it measures, what it does not yet, and how to update — before installing. A source build is `docs/12_BUILD.md`.
1. Download the latest `FrameLedger.App-win-Setup.exe` from [Releases](https://github.com/poli0981/frameledger/releases). It installs into `%LOCALAPPDATA%\FrameLedger.App`; your data stays in `%LOCALAPPDATA%\FrameLedger`, and uninstalling asks before touching it.
2. SmartScreen may warn — releases are not code-signed (free, open-source project). Verify the SHA-256 checksum published with each release, then **More info → Run anyway**.
@@ -200,4 +200,4 @@ GPU telemetry is layered so the project never depends on a proprietary vendor li
---
**Status:** pre-release (beta). Eleven tagged pre-releases so far; see `CHANGELOG.md` for what each one changed and the accuracy block at the top of this file for what is and is not measured. It is not feature-complete, it certainly still has bugs, and `legal/DISCLAIMER.md` §0 says what that means for you.
**Status:** pre-release (beta). Twelve tagged pre-releases so far; see `CHANGELOG.md` for what each one changed and the accuracy block at the top of this file for what is and is not measured. It is not feature-complete, it certainly still has bugs, and `legal/DISCLAIMER.md` §0 says what that means for you.
+72
View File
@@ -1804,6 +1804,69 @@ library and the import, PR-4 delete sessions, the charts across sessions and the
**Owner-only, added to the list below:** item 8.
## **START HERE** — 2026-10-04, the beta.12 train: the game's own memory, rendered documents, a user guide, the legal split
*Status is `CHANGELOG.md` `[0.1.0-beta.12]`; this is what no other file carries. The approved plan was eight PRs: PR-0 the
recorder test that went red on a loaded runner, PR-1 `NOTICE` and the licence header (D45), PR-2 the game's memory
measured from outside the game (C++ `FrameLedger.ProcessStats.dll`, schema 0018, D43), PR-3 the App showing it, PR-4
Markdown rendered and a tabbed About, PR-5 the user guide and the documents a user accepts, PR-6 the documentation sweep,
PR-7 the release.*
**Decisions (owner, 2026-10-03, asked before the plan — do not re-ask):**
- **D43 — the game's memory is measured from OUTSIDE the game, in both tiers.** A new C++ library loaded by the Agent,
never into a game: dedicated and shared GPU memory from the documented `GPU Process Memory` performance counters (no
handle to the game), private working set / working set / commit from `GetProcessMemoryInfo` with
`PROCESS_QUERY_LIMITED_INFORMATION` only — a hooked game through the handle the session holds, any other through a
handle opened for the read and closed after it, the creation time checked, every process of the executable summed.
Task Manager's figures are the definition; no budget (§M11 stays open); not `D3DKMTQueryStatistics` ("Reserved for
system use"). Measured first: `spike-notes` §16.
- **D44 — a user guide in English**, `guide/`, rendered in the App (Help ▸ User guide), linked from the README.
- **D45 — the legal split.** `legal/TRADEMARKS.md`; `FORKING.md` and `CONTRIBUTING.md`; the GPL shown as information,
not accepted (GPLv3 §9, FR-11 changed); GPLv3 §7(b)(c)(e) additional terms in `NOTICE` and named in every source file's
header; the Appropriate Legal Notices in a tabbed About; the EULA's consumer-law carve-out and severability; the
Privacy Policy's section on sharing exports and bug reports; `CODE_OF_CONDUCT.md`.
- **D46 — documentation is corrected in place** (struck, dated) with an index, `docs/README.md`; history stays.
**Traps met on the way:**
- **A test whose session length came from a fake clock but whose end came from a real 150 ms timer** went red whenever a
loaded runner fitted fewer than six drains into it (PR-0): make the fake drive both.
- **Two LibreHardwareMonitor `Computer`s updating in one process** threw a NullReferenceException in `GenericCpu.Update`
in the local gate (`LhmRealHardwareTests` beside `PrivilegeFootprintTests`); the Agent's own read was already behind a
catch. The two test classes share a collection now.
- **A test reading resource text outside the culture collection** races a class that flips `Strings.Culture`; a class
that adds many flips (`GameMemoryTextTests`) makes it likelier. `GamesViewModelTests` moved in; the rest are a chip.
- **`ShmDrainIntegrationTests.AnUnhookRequestStops…` failed once on CI at the injection step** (≈1 s, `IsAllowed`
false) and passed on the re-run; it passed on the PR before. A flake to watch, not yet a fix.
- **Markdig follows the table spec strictly**: a line without cells between a table's rows ends the table, and GitHub
still draws it. `MarkdownRendererTests` fails any embedded document whose table would show as `|---|` text.
- **`AccentTextFillColorPrimaryBrush` is the dark accent until `ApplicationThemeManager.Apply(…, updateAccent: true)`
runs** — a test host that skips it draws links #003E92 on #202020; the App (and the Legal Gate, via `WpfThemeApplier`)
applies it.
- **`tools/license-gather.ps1` took an override only for a URL-only package**; Markdig declares BSD-2-Clause and ships no
file, so the expression branch takes an override too now.
- **A file git sees as mixed line endings is `-text`**: no EOL conversion, so a CRLF rewrite shows as a whole-file change.
Keep such a file's working copy LF (`docs/legal-drift-history.md`).
- **Inserting a `### Changed` heading after an entry in the middle of `### Added`** moves every later Added entry under
it — read the section's headings back before committing.
- **The stacked-branch recipe carried four PRs** (PR-3 on PR-2, PR-4 on PR-3, PR-5 on PR-4): after each squash merge,
`git rebase --onto origin/main <old parent>` replays only the PR's own commit, and resx / CHANGELOG additions stay
clean because each PR appends after the previous one's.
- **A test can hide the defect it exists to catch**: `LogTailTests` fed App-form lines into the fake *Agent* log, so
the Logs page's level filter matched no real Agent line (Serilog's default template, a date first) and nobody saw
it for three weeks. A fixture for another process's file is a copy of a real line from that process.
- **A setting with `AgentReads = true` that no Agent code reads is a switch that lies**: Settings' *Record games
launched outside FrameLedger* wrote `capture.background` and nothing read it (removed in PR-6, the key reserved).
Before trusting a registry row's flag, grep for a reader.
- **The audits (PR-6) found code gaps the docs had been describing as built**, each left for its own PR and named
here so it is not rediscovered: L1 telemetry is never pointed at the game's adapter (`SelectAdapter` has no caller,
`18_GPU_VENDOR_APIS`); a machine-wide service refusal still says "detected in this game" (§S23-3, 🔴); no release
has carried a Velopack delta (`release.yml` never fetches the previous release); there is no rules feed (§S20).
**Owner-only, added to the list below:** item 9.
## Owner-only — no PR can close these
1. **§S23-2 — branch protection.** `Rules / validate` is not a required status check on
@@ -1853,6 +1916,15 @@ library and the import, PR-4 delete sessions, the charts across sessions and the
on a game's page and in Settings ▸ Data. (d) *Sessions at a glance* and the Trend with a second unit. (e) The Legal
Gate shows the Disclaimer 2.9 and the EULA 1.4 once. (f) The `ja` text of `Safety_Exception_Trial` (English until
reviewed) and the App strings marked `review`.
9. **beta.12 on real hardware.** (a) **The game's memory:** one hooked game and one that is not (hooking off, or a
blocked game), each beside Task Manager's Details tab at the same moment — the summary's *VRAM (this game)* against
*Dedicated GPU memory*, *RAM (this game)* against *Memory (private working set)*; the Dashboard's live line; the
Sessions columns, the Trend's memory metrics and the Sensors charts. (b) **The Legal Gate** shows the EULA 1.5, the
Disclaimer 2.10 and the Privacy Policy 2.6 once, rendered, with the GPL as *your licence*, needing no acceptance.
(c) **Help ▸ User guide**, **Help ▸ About** (its three tabs; *Open the licences folder* in the installed copy), and
*View on GitHub* opening the `v0.1.0-beta.12` tag. (d) The `ja` strings marked `review` (the memory labels, the
About window, the first-start summary). (e) `docs/LIST_GAME_TESTED.md` is as of beta.10: refresh it from a copy of
the ledger, with the games' memory figures, and approve it before it is committed (D35).
**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
+2 -2
View File
@@ -11,8 +11,8 @@
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-10-03.** The software is a beta; its latest
> **pre-release is `0.1.0-beta.11`** (2026-10-03), an unsigned installer built from that tag with its
> ⚠ **What FrameLedger actually measures today — 2026-10-04.** The software is a beta; its latest
> **pre-release is `0.1.0-beta.12`** (2026-10-04), an unsigned installer built from that tag with its
> checksums published beside it. The source holds the desktop app
> (library, store import, charts, settings) and the background Agent, which records a session when a
> game in the library runs (unless you switched its recording off), injects only into games you enabled
+2 -2
View File
@@ -113,8 +113,8 @@ 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-10-03.** The software is a beta; its latest
> **pre-release is `0.1.0-beta.11`** (2026-10-03), an unsigned installer built from that tag with its
> ⚠ **What FrameLedger actually measures today — 2026-10-04.** The software is a beta; its latest
> **pre-release is `0.1.0-beta.12`** (2026-10-04), an unsigned installer built from that tag with its
> checksums published beside it. The source holds the desktop app
> (library, store import, charts, settings) and the background Agent, which records a session when a
> game in the library runs (unless you switched its recording off), injects only into games you enabled