Skip to content

Unity inspector notes for folders & assets

I wrote a tool to add notes to folders & assets in the Unity inspector.
https://github.com/hannesdelbeke/unity-folder-notes

The notes live in the folder’s metadata.
This seems like a clean solution, but it will clash with any tools using Unity userdata
I’m not sure how common that is.

todo

  • support Unity search.  
    e.g. for a class Comments you can search t:comments
  • support URL, wikilink, Markdown HTML
    Rich text support could be interesting.
    Maybe even support embedded images.
  • support private / local / user notes vs project notes.
    • a dict with {GUIDs: private notes} in a gitignored folder.
    • ideally the GUIDs would not be textdata but unity metadata so they can auto update if GUID changes somehow.
    • this could be a separate tool

alternatives

  • Put a README textfile containing your notes in each folder.
    • But you can’t edit the notes in unity without a custom inspector/tool.
    • It adds an extra file, files could get outdated/out of sync.
  • this can also be achieved with a gameobject in each folder, and Unity - add notes to gameobjects
    • But this also adds an extra file

Unity tool
my code projects