* build: the main line on .NET 11 - SDK 11.0.100, net11.0, the three runtime-serviced packages at 11.0.0; Windows 10 stated as untested and unsupported (D94, D95) (beta.37 PR-1) The owner moved the main line to .NET 11 the day after it shipped (D94), setting aside condition (a) of 20_OPEN_QUESTIONS section G's table - two alphas on the released runtime. This is the alpha branch's switch applied to main at released versions, and what follows from it. - global.json 11.0.100 (allowPrerelease false), TFM net11.0-windows10.0.22621.0, Microsoft.Extensions.Hosting, Microsoft.Data.Sqlite and System.Diagnostics.EventLog 11.0.0; legal/licenses/nuget regenerated (78 packages -> 69). - Two CA1307 sites the released SDK raised in tests written after the last alpha was cut take the (char, StringComparison) overload. - IHost.RunAsync rethrows a failed BackgroundService on .NET 11: the Agent's --serve leaves through its crash report where it exited 0. Accepted, not wrapped; HostBackgroundFailureTests holds the runtime's behaviour, which nothing had observed. - release.yml installs a .NET 10 runtime for vpk 1.2.161; Qodana's container installs the .NET 11 SDK first (interim, until the Ultimate linter); Dependabot's and the workflows' comments follow. - Windows 10 22H2 is not blocked, and is stated as untested and unsupported (D95): NFR-8, LIMITATIONS, README, the guide, the wiki. A processor needs SSE4.2 and POPCNT. - docs: 12_BUILD (the main line's .NET; the alpha line rests after alpha.4, D98), 13_CI_CD, 20_OPEN_QUESTIONS row closed, 10_LOGGING, spike-notes section 28, CLAUDE.md, the decisions index (D94-D96, D98). Gate on the dev box: all passed in 338 s on SDK 11.0.100 (native 32/32, 2,561 tests, coverage floors held). Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * build: what this pull request's runs measured on .NET 11 - CodeQL reads net11.0 whole, the delta from beta.36, Qodana's one finding fixed - HostBackgroundFailureTests: the message is kept rather than the exception, so no `!` is needed - the one problem Qodana's interim run reported (run 42916491047, InspectCode 2026.2.3.1 on SDK 11.0.100). - 13_CI_CD: what analyze (csharp, none) read of net11.0 (CodeQL 2.27.4, "scanned 1220 out of 1220 C# files", 363 references resolved, none unresolved), and the rule for C# 15 constructs (D96); the interim's first run. - spike-notes section 28: the table of this pull request's runs - check, CodeQL, SonarCloud, Qodana, and the release rehearsal with the first delta across two runtime majors (72.6 MB, 372 of 443 files patched). Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com>
5.4 KiB
Contributing to FrameLedger
Thank you for looking. FrameLedger is a small project with strict rules, because it loads code into games and a mistake can cost a user their account. This page says how to build it, what a change has to bring with it, what will not be merged, and under what licence your contribution is accepted.
Before you start
- Read
CLAUDE.md's Non-negotiable rules anddocs/19_SAFETY_AND_ANTICHEAT.mdfirst. They constrain everything that touches a game. - Open an issue before anything larger than a fix, so the approach can be agreed before the work is done.
- A game with anti-cheat that FrameLedger fails to detect is a safety bug: use the Safety gap issue form.
- A vulnerability in FrameLedger itself goes the private route in
SECURITY.md, never a public issue. - Something that cannot be reached, read or seen — with the keyboard, a screen reader, a contrast theme — uses the
Accessibility problem form;
ACCESSIBILITY.mdsays what the App aims for. - Everyone who takes part follows the
CODE_OF_CONDUCT.md.
Building
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:
./build.ps1 check
That is the whole quality gate, and continuous integration runs the identical script: the native build and its tests,
clang-format, the managed build with warnings as errors, dotnet format, every test project, and the repository's own
checks (licences, the accuracy blocks, the licence headers, the changelog rules, …). docs/12_BUILD.md describes each
step and the build profiles. Run it in your main checkout: a fresh git worktree cannot configure the native build.
Documentation lives in three places: guide/ for players (shown in the app and on the wiki), wiki/ for the wiki's own
pages, and docs/ for developers. A change a player would notice updates guide/; a change to how the code is put
together updates docs/ — and the wiki/ page that summarises it, if that page now says something else.
./build.ps1 check builds the wiki and fails on a link that leads nowhere.
Never point a build of your own at the data FrameLedger records into (%LOCALAPPDATA%\FrameLedger): a newer build
migrates the database, and the released one cannot read it back. To look at real data, copy the folder and start
FrameLedger.exe --data-dir <copy> — a viewer that starts no Agent and changes nothing on the PC (docs/12_BUILD.md
§Debugging says how to copy it safely).
What a pull request brings with it
The definition of done is the one in CLAUDE.md:
- it builds without warnings (C# and C++), the tests are green, and
dotnet formatandclang-formatare clean; - a change to the hook path states its measured overhead in the PR (
docs/14_TESTING.md§Hook overhead); - a new hook is listed in
docs/17_HOOK_ENGINE.md§Hook inventory and justified against rule 4; - every new user-visible string exists in
en,viandja(docs/09_I18N.md); - a change to what the App shows keeps
ACCESSIBILITY.md§For contributors — a name for every control that shows no text, theme colours only, nothing shown by colour alone, everything reachable by keyboard — and says in the PR what was checked with the keyboard and Narrator; if it moves what works or what does not,ACCESSIBILITY.mdchanges with it; - a change that makes a document wrong updates that document in the same PR;
- a change under
src/adds an entry under## [Unreleased]inCHANGELOG.md; - every new source file carries the licence header —
./tools/notice-check.ps1 -Fixwrites it. A file you wrote yourself may name you in its second line instead, in the same form:Copyright (C) <year> <your name> - additional terms under GPLv3 section 7: see NOTICE.
The pull-request template lists the safety checks for changes to the capture layer, and the accessibility checks for changes to the user interface.
What will not be merged
Whatever its other merits, a change that
- adds any way to override, weaken or skip the anti-cheat guard (rule 2);
- makes FrameLedger harder to detect — manual mapping, header erasure, thread hiding, unlinking modules, obfuscation, renamed binaries (rules 3 and 9);
- reads or writes game memory outside the hooked calls (rule 4), or makes a hook able to crash a game (rule 5);
- adds telemetry, analytics or any network request beyond the ones
legal/PRIVACY_POLICY.mdlists (rule 8); - turns injection on for a game the user did not individually enable (rule 1).
Licensing of contributions
FrameLedger is licensed under the GNU GPL, version 3 only, with the additional terms in NOTICE. By opening a pull
request you confirm that you have the right to submit the change, and you license it under GPL-3.0-only, with the
additional terms in NOTICE (GPLv3 §7 (b), (c) and (e)) applying to it as they apply to the rest of FrameLedger's own
material. There is no contributor licence agreement and no copyright assignment: you keep the copyright in your
contribution. Code from elsewhere must come with a licence compatible with GPL-3.0-only and be listed in
legal/THIRD_PARTY_NOTICES.md.
Changes written with AI assistance are welcome on the same terms — you are responsible for what you submit, as for any other change.
Questions
Open an issue, or write to contact@poli0981.dev.