Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 1.59 KB

File metadata and controls

33 lines (24 loc) · 1.59 KB

Getting Started

Requirements

Unity 2022.3 LTS or newer. Arkhe is an Editor-only tool — see Installation for how it's added to a project, and FAQ for what that means for builds.

Installation

See Installation for the full walkthrough. In short: import the package, then open it from Tools > Arkhe in the Unity menu bar.

First Workflow

This is the fastest path from installing Arkhe to seeing it do something real.

  1. Open Tools > Arkhe. Arkhe opens as its own floating window — it doesn't dock alongside Scene, Game, or Inspector, and you can move, resize, or minimize it like any other Editor window. Unity remembers wherever you last placed it.
  2. Go to the Dashboard or Scanner page and click Run Scan. Arkhe scans your project's assets and dependencies in the background, without blocking the Editor.
  3. When the scan finishes, the Dashboard shows a Health Score and a project summary, and the Governance page lists any violations found. See Dashboard for what each part of that page means.
  4. Open the Governance page and select a finding from the list to see its details — each finding names the file involved and the rule it triggered.

If you'd rather see what a real violation looks like before scanning your own project, skip to Demo & Test Data instead — it adds a small, disposable sample project you can scan immediately.

Once you're oriented, Configuration covers the Settings page, and Features covers each capability in depth.