Every setting - poli0981/frameledger GitHub Wiki

Settings is the last item on the left. Its sections follow, in the order it shows them. Settings marked agent are read by the capture agent; unless the row says otherwise, a change applies from the next session.

Capture

Setting	What it does	Default
Disable all hooking	Nothing is loaded into any game, whatever each game's own switch says. A game being measured stops being measured at the next safety check, within 30 seconds. Sessions are still recorded. Agent.	Off
Games with hooking on	Shown while any game has hooking on: one Turn off per game.	—
Hide hooking on anti-cheat games	On, the page of a game where anti-cheat was found shows only what was found; off, it also shows the Hooking switch, greyed out. Such a game is never hooked either way.	On
Allow hooking in games whose only anti-cheat runs in user mode	Turns on the one narrow exception (Anti-cheat and safety). The games that qualify are listed under it, each with Make exception… (after a warning) or Withdraw. Agent.	Off
Vulkan layer	The component that measures Vulkan games — but only a game FrameLedger starts itself: Play set to Start directly (Games, below) does; a Vulkan game started any other way is recorded, not measured. The agent registers and removes it by itself; Register and Unregister repair that, for your Windows user only.	—

The link under them, Read what the hook does and does not do, opens the safety document on GitHub.

Recording

Setting	What it does	Default
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

Data

Setting	What it does	Default
Remove uninstalled games	A game whose .exe has been gone for ten minutes is removed from your library — only when it has no sessions, its drive is connected and the folder it was installed in is still there (an unplugged drive never counts), and never a game where anti-cheat was found. Off, it stays and reads Not installed. Agent, within 15 seconds.	On
Delete all sessions	Deletes every session of every game, with its data and notes, after asking. Your library, your settings and each game's hooking choice stay. It cannot be undone, and it is refused while a game is being recorded.	—

Capture agent

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. 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

Setting	What it does	Default
Theme	Follow system, Light or Dark. Applies at once.	Follow system
Language	English, Tiếng Việt or 日本語. The window is rebuilt in the new language at once.	English

Games

Setting	What it does	Default
Show game artwork	A game's page shows a picture of the game: the image you chose for it (Edit…), or else the cover and banner the Steam or GOG GALAXY app already keeps on your PC. Nothing is downloaded; a game from another store shows a picture only once you choose one.	On
Colour the game page from its artwork	The band at the top of a game's page takes the picture's main colour — never so strongly that a text on it gets hard to read. Off, the band keeps the plain card colour.	On
Play button	What Play does, on a game's page and on each game in the library. Through the store: Steam or the Epic Games Launcher starts the game, GOG GALAXY runs it, and the itch app asks which copy to launch — each store's app does what it does when you start a game from it. A game no store installed, and a GOG game without GOG GALAXY, is started by FrameLedger instead; so is every game while FrameLedger itself runs as administrator, so that the game does not. Start directly: FrameLedger's agent starts the game, recorded from its first frame, with your standard rights; it does not start a game whose recording is off, or one that asks to run as administrator.	Through the store

Window

Setting	What it does	Default
Start FrameLedger with Windows	Opens FrameLedger when you log on, for your user only.	Off
Minimize to tray on close	Closing the window keeps FrameLedger running by the clock; quit with Exit in the tray's menu or the File menu.	Off
Show FPS with two decimals	Every frame rate with two decimals (62.40) instead of a whole number (62). Pages show it when they next open.	Off
Hide scroll bars	No scroll bars are drawn anywhere; the wheel, the keyboard and touch still scroll. Applies at once.	Off

Updates

Setting	What it does	Default
Channel	Automatic follows your copy: a test version (a pre-release) looks for test versions, a release for releases. Or choose Stable, or Beta (releases and pre-releases).	Automatic
Check for updates at startup	One question to GitHub a few seconds after FrameLedger starts. A new version downloads in the background and installs only when you restart.	On

Logging

Setting	What it does	Default
Debug logging	FrameLedger writes far more detail into its log, for a bug report. The agent keeps its own level.	Off

System

This PC as FrameLedger records it with every session: processor, graphics card and driver, memory, Windows build and the main display. Nothing is sent anywhere. Copy puts the lines on the clipboard, for a bug report.

Legal

Reopen the legal documents shows the documents you accepted, and the GPL, again. Nothing is accepted again.