Kr.seonghwan.reference NPM

Reference

About Reference

Reference is a dependency tracking plugin for UnityEditor that provides additional information such as the number of usage.

This plugin is based on pre-cached complementary guid map to trace which asset has dependencies to specific asset. The pain point that mainly considered with Unity is that when we delete an asset, we don't know which asset is using it.

Requirements

All assets must be serialized as force-text option in ProjectSetting/Editor
Indexed in 0.0.x version caches are not compatible with above 0.1.x.
You must generate indices again if you update plugin from 0.0.x to above 0.1.x.
From 0.1.x, plugin will update automatically in future.

Tested in

Unity 2019.4 LTS Windows
Unity 2020.3 LTS Windows
Unity 2021.1f Windows
Unity 2021.2b Windows
Unity 2022.1a Windows

Installation

Unity Package Manager

{
    "dependencies": {
        "kr.seonghwan.reference": "0.1.5"
    }
}

{
    "scopedRegistries": [
        {
            "name": "npm-seonghwan",
            "url": "https://registry.npmjs.org",
            "scopes": [
                "kr.seonghwan"
            ]
        }
    ]
}

FileSystem

Move to ProjectRoot\Packages
Run command in terminal.

git clone https://github.com/seonghwan-dev/Reference

QuickStart

Execute Tools/Reference/Index All Assets in MenuItem and wait until complete.
Configure Reference settings in Edit/Project Settings... in MenuItem.
Select an asset you want to know which asset references it and run Find References In Project context menu.

Fundamentals

Create a cache file per a asset file, see also RefData.cs
Detect asset changes from AssetPostprocessor, see also ReferenceAssetPostprocessor.cs
Detect an attempt to delete an asset from AssetModificationProcessor, see also ReferenceAssetModificationProcessor.cs

Features

Display asset usage count in inspector.
Find References In Project

Roadmap

Safer Asset Delete (#8)
Reference replacement wizard (#9)
Reference dependency map visualizer
Detect references indexed in Addressable

Contributes

Fork and clone at ProjectName\Packages
Add an Scripting Define Symbol DEBUG_REFERENCE at ProjectSettings/Player.
Run Tools/Reference_DEV/Add New Language to create a new localization profile.
Run Tools/Reference_DEV/Update Language profiles to add field after edit Localize class.
Create PR.