Unity notes

Create notes in Unity, e.g. for documentation.

• The closer documentation lives to the asset, the more likely it’ll be read.
• Showing docs in the editor improves discovery.
• And making it easy to write docs lowers the barrier for writing docs.

Current solutions¶

These cover everything. Assets & gameobjects.

• Unity note editor
• Unity inspector notes for folders & assets
  • notes on assets
  • support urls & links to assets
  • richtext
• Unity - add notes to gameobjects
  • it’d be cool if we can support urls too here.

Ideas¶

• crazy idea: Unity asset chat idea
• instead of Unity comments,can we focus on comments for any file in a git repo?

alternatives¶

• https://github.com/plyoung/EdNotes
  • Add notes to gameobjects in scene.
    • GameObject notes are kept in a hidden object tagged as EditorOnly
  • add notes to assets
    • Asset Notes are kept in an asset next to the this tool’s scripts.
  • Matches Unity’s UI
  • supports color tags & icons
  • a recent fork adds inspector support
• https://github.com/rstecca/UNotes ugly colors
• https://github.com/sverdegd/NotepadToolUnity not notes for assets or gameobj, instead this is just sticky note assets?
• https://github.com/wataru-ito/AssetMessenger custom popup, feels clunky, add notes to assets.

features¶

MVP

• write notes on folders & assets
  • V1 Unity inspector notes for folders & assets
  • V2 Unity note editor
• support URLs
• support rich text
• support private / local / user notes vs project notes

bonus

• optional support wikilinks
• support embedded images
• support instanced notes, e.g. a bunch of assets have the same note.

dev¶

Assets and gameobjects have different approaches of attaching notes.

• some assets (e.g. prefabs) can have components, just like gameobjects.
• most assets can’t have components, so we need a different approach.

Backlinks¶

• My Unity
  • i want to use this more
    Unity notes