DOCS Back to framegain.dev
Getting started

Your first scan

Pick a target, choose a scope, run the read-only scan, and understand the ledger it returns.

After installation, open the project and open Framegain from the editor’s Window menu.

#Pick a target preset

A target preset tells Framegain which platform assumptions to use when it weighs a finding. Pick the target closest to what you are shipping.

#Choose a scope

Start with the whole project, or narrow the scan to a level or path pattern when you are investigating one area. A narrower scope runs the same checks only where you asked.

#Press Scan project

Scanning reads project assets and settings. It is read-only, so the first scan does not need an undo step.

#Read the ledger

The result is a ledger with one row per finding. Each row names a category and asset or setting, then reports the available estimated cost. Read an issue for the meaning of each field.

Important

A scan does not measure the game while it runs. Use the Pro PIE benchmark when you need before-and-after runtime evidence.

FRAMEGAIN DOCS

Search documentation

Type to search across 16 pages.