Argus

Quickstart

Five minutes from a fresh Argus account to a profiling capture appearing on your dashboard. Assumes you have a Unity project already (any version 2022 or newer).

1. Sign up + create a project

  1. Sign up at /signup. A personal organisation gets created automatically — you can rename it later from /[orgSlug]/settings.
  2. On the dashboard, the Get started checklist shows three steps. Click Create project and give it a name (e.g. your game's name) plus a URL slug (e.g. my-game).

2. Generate an API key

From the project page, open the API keys tab → New API key. Give it a name (development is fine for now), pick the sessions:write permission. The key is shown once on the next screen — copy it now (format: argus_ followed by 32 hex characters).

Lost the key? Generate a new one and revoke the old. Never recover the original — keys are stored hashed, the cleartext is unrecoverable.

3. Install the Unity package

Two options, pick whichever fits your workflow.

Option A — Local UPM package (fastest)

  1. Download the .unitypackage from Tools → Argus Control → 📦 Export in any project that already has Argus, OR clone the repo and copy Assets/Argus/ somewhere outside your target project (e.g. D:/Packages/com.argus.profiler/).
  2. In your target project's Packages/manifest.json:
    {
  "dependencies": {
    "com.argus.profiler": "file:../../Packages/com.argus.profiler",
    "com.unity.editorcoroutines": "1.0.0"
  }
}
  3. Reload Unity. Tools → Argus Control appears in the menu bar.

Option B — Git URL (recommended for teams)

"com.argus.profiler": "https://github.com/argus-profiler/argus-unity.git"

4. Configure + connect

  1. Create the config asset: Assets → Create → Argus → Configuration. Place it in any Resources/ folder, named exactly ArgusConfig.
  2. Open Tools → Argus Control. In the Connection card:
    • Set Server to https://argus-api-1579.onrender.com (or your custom dashboard host).
    • Paste your API key into the API Key field.
    • Click Connect. The status pill flips to ● CONNECTED if everything's right.

5. Send your first capture

Two paths — pick whichever exercises real game code.

Manual capture (no code change)

In Argus Control's Capture card, click ▶ Start Capture (or ▶ Quick (5s) for a fixed-duration capture). Hit Play in Unity. Move around for a few seconds. Click ⏹ End Capture. The capture uploads to the dashboard within a couple of seconds.

Code-triggered capture

Add this anywhere in your runtime code:

using Argus;

void OnPlayerJump() {
    Argus.TriggerProfilerEvent("Player.Jump", 3);  // 3-second capture
}

Trigger the action in-game. The capture fires automatically.

6. View the result

On the dashboard:

  • Project page — recent captures across all test sessions.
  • Test sessions tab — captures grouped by their wrapper label (auto-named {ProductName}_{Date} unless you set one in Argus Control).
  • Click a capture — full metric grid, top frame-time spikes with code attribution, raw frameData JSON.

Where to next

  • Unity SDK setup — the full configuration reference, all ArgusConfig fields, every Argus Control panel, and the event semantics that prevent dashboard noise.
  • How Argus works — the mental model: test sessions vs captures, dedup, sampling pipeline.
  • Webhooks & Slack — push every capture to a Slack channel.