Getting started

Installation

Requirements

RefSafe Pro is developed and tested against Unity 2022.3 LTS. The definitive supported version range is listed on the Asset Store page — check there if you’re on an older or newer editor.

The package is editor-only. Nothing it ships compiles into a player build, and it adds no runtime overhead to your game.

Importing the package

  1. Open your project in Unity.
  2. Open Window → Package Manager, switch to My Assets, find RefSafe Pro, and click Download, then Import.
  3. Leave all files selected in the import dialog and click Import.

After importing, confirm this folder exists:

Assets/RefSafe/Pro/
├── Core/          RefSafe.Pro.Core assembly — data models, enums, utilities
├── Editor/        RefSafe.Pro.Editor assembly — scanning, UI, integrations
├── Samples/       Custom rule, fixer, and exporter examples
└── Tests/         EditMode tests

RefSafe Pro ships as two assembly definitions:

  • RefSafe.Pro.Core — data models and enums, no Unity Editor dependency
  • RefSafe.Pro.Editor — everything else, editor-only

If you want to write custom rules, fixers, or exporters, your assembly references these. See extending RefSafe Pro.

Opening the window

Go to Tools → RefSafe → Pro.

On first launch you’ll get a short onboarding tour across the four tabs. You can dismiss it and re-run it later from the Settings panel.

Where RefSafe Pro stores data

PathContentsVersion control
Assets/RefSafe/Pro/Editor/Settings/Settings.assetProject-wide settings — rule config, health weights, build hookCommit this. Shared across the team.
Library/RefSafePro/UserSettings.jsonYour personal state — ignored issues, filter presets, density, pinned issues, tour stateNot committed. Library/ is git-ignored by Unity convention.
Library/RefSafePro/LastScan.jsonCached previous scan, used for diffingNot committed.
Library/RefSafePro/History.jsonScan history behind the Trends tabNot committed.

The split is deliberate: rule configuration is a team decision and belongs in version control, while “I’ve snoozed this issue” is personal and would otherwise cause merge noise on every commit.

All writes to Library/RefSafePro/*.json are atomic and schema-versioned, so an interrupted write or a version upgrade won’t corrupt your history.

Uninstalling

Delete the Assets/RefSafe/ folder. To also remove cached scan data, delete Library/RefSafePro/.