Skip to content

getting-started.md

Latest commit

 

History

History
45 lines (30 loc) · 2.13 KB

getting-started.md

File metadata and controls

45 lines (30 loc) · 2.13 KB
Raw

Getting Started

This page assumes Runtime Atlas is already installed — see Installation if it isn't yet.

First Run

  1. Confirm 18 tabs appear across two rows. No console errors indicates a clean install.
  2. Enter Play mode. The status indicator in the header changes from EDIT MODE to LIVE.
  3. Open the Camera tab — FOV, clip planes, and position for every active camera appear.
  4. Open the Alerts tab — the stats bar counter reflects real-time issues.

Try It Against the Sample Scene

A pre-built sample scene ships at Assets/RuntimeAtlas/Samples/Scene/RA.unity. Open it, enter Play mode, and open Runtime Atlas — every tab populates immediately against the sample scene's cameras and audio sources. This is the fastest way to see the tool working before pointing it at your own project.

Monitoring a Session

  1. Enter Play mode. The Timeline Recorder starts automatically if Auto-Start on Play is enabled.
  2. Navigate tabs while running. Data polls at the configured refresh interval — see Configuration.
  3. Open the Profiler tab to see frame time, FPS, and GC allocation history.
  4. Open Alerts to review any flagged conditions.

Generating a Report

  1. Navigate to the Report tab.
  2. Click Generate Preview to snapshot the current session.
  3. Select an export format (HTML, JSON, Markdown, CSV, or DOCX).
  4. Click Export. The file is written to a location you choose.

See Session Reports for what each export format contains.

Running a Script Scan

  1. Open the Scanner tab.
  2. Click Run Full Scan. The scanner analyzes all scripts outside excluded folders.
  3. Open the Optimizer tab for actionable suggestions derived from the scan.

See Scanner & Optimizer for details on what the scanner looks for.

Where to Go Next

  • Configuration for refresh intervals, auto-start behavior, and other settings
  • Features for a full reference of every tab
  • API Reference if you're implementing IAlertSource from your own code
  • FAQ for common questions