Getting Started

Installation

Unity Asset Store

1. Add Azkar Screen Stats to your Unity Asset Store assets.
2. Open your Unity project.
3. Go to Window > Package Manager.
4. Select My Assets.
5. Find Azkar Screen Stats.
6. Download and import or install it from Package Manager.

Local Package Development

The package uses Unity Package Manager layout:

Packages/com.azkarindustries.azkarscreenstats

To install it into another local project:

1. Open Window > Package Manager.
2. Select the + menu.
3. Choose Add package from disk....
4. Select:

Packages/com.azkarindustries.azkarscreenstats/package.json

You can also embed the package by copying the folder into the consuming project's Packages directory.

Quick Start

Option 1: Add The Component

1. Create an empty GameObject in your scene.
2. Name it Azkar Screen Stats.
3. Add the component:

Azkar.ScreenStats.ScreenStatsOverlay

4. Enter Play Mode.

By default, the overlay appears on the active game camera.

Option 2: Use The Menu Item

In the Unity editor, create the overlay from:

GameObject > Azkar > Screen Stats Overlay

This creates a GameObject with ScreenStatsOverlay already attached.

Option 3: Use The Sample Bootstrap

Import the Package Manager sample named:

Basic Screen Stats Bootstrap

Add ScreenStatsBootstrap to a scene object. When the scene starts, it creates one ScreenStatsOverlay if one does not already exist. The sample can also keep the overlay alive across scene loads.

First Useful Pass

1. Enter Play Mode and confirm the overlay appears on the intended camera.
2. Watch FPS and smoothed frame time while reproducing the behavior you care about.
3. Keep the graph enabled to spot spikes, stutter, slow ramps, and timing stability.
4. Disable sections you do not need if the overlay is too tall for the target display.
5. Assign Target Camera directly in projects with split-screen, minimaps, camera stacks, or runtime-created cameras.