Giter Club home page Giter Club logo

project-curator's Introduction

Project Curator

A convenient tool to cleanup and maintain your Unity projects !
Project Curator is an Unity Editor window that, based on the currently selected Asset, displays the following information :

  • Each asset it depends on (called dependencies)

  • Each asset that depends on it (called referencers)
    Very useful to know if an Asset is can be safely deleted or not

  • Whether the asset is included in the build or not, depending on the nature of the Asset and its referencers (checked recursively)
    Check statuses section for more information

Screenshot

How to use ?

  • Install package
    • Using Git : In Unity, click Window > Package Manager > + > Add package from git URL... and add https://github.com/ogxd/project-curator.git
    • Manually : Download the .zip, unzip and in Unity click Window > Package Manager > + > Add package from disk... and select the downloaded package.json
    • With Unitypackage : Download the .unitypackage in the release tab. Not available anymore since version 1.2
  • When installed in Unity, click Window > Project Curator (and dock the window somewhere maybe)
  • Select an asset to visualize dependencies and referencers.

You will need to Rebuild the database on the first run. There should be a button for it in the window (or do a right click on the window tab). The database should update automatically afterwards, even when assets are created, moved or deleted. Feel free to rebuild the database again if there is an issue.

Statuses

Statuses can be :

  • Unknown
  • Not Included in Build
    • Not Includable
      This asset can't be in the build.
      Example : Editor scripts
    • Not Included
      This asset is not included in the build.
      Example : None of its referencers are included in the build
  • Included in Build
    • Scene In Build
      The asset is a scene and is set to build
    • Runtime Script
      The asset is a runtime script
    • Resource Asset
      The asset is in a Resources folder and will end in the final build
      It does not mean that the asset is actually useful. Check referencers manually and Resources.Load calls to find out
    • Referenced
      The asset is referenced by at least one other asset that is included in the build
      Example : A prefab that is in a built Scene

The overlay icon in the project folder can be disabled. To do so, right click on the Project Curator window tab, and click "Project Overlay"

project-curator's People

Contributors

ogxd avatar rhys-vdw avatar joaoborks avatar curiouspers avatar

project-curator's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.