nmacadam / Notate

✏ A note component for your inspector

Notate

A note component for your inspector.

Use the Note component to add in-inspector comments or documentation. Edit the note contents by clicking and typing like any text field, and customize the icon by clicking on it. You can further customize the following by putting the inspector into Debug mode:

• Message alignment & anchoring
• Background color
• Icon (specify any built-in icon by name)

Note components are not included in build.

🪛 Installation

Install with OpenUPM via CLI or scoped registry (recommended)

 ✨ To add a package via openupm-cli, run the following command:

 openupm install com.nmacadam.notate

 🗃️ To add a package via scoped registry:

• Open Edit/Project Settings/Package Manager
• Add a new Scoped Registry:

  Name: OpenUPM
  URL:  https://package.openupm.com/
  Scope(s): com.nmacadam
  

• Open Window/Package Manager
• Click +
• Add from Git URL
• com.nmacadam.notate Add

Install with Git URL

• Open Window/Package Manager
• Click +
• Add from Git URL
• https://github.com/nmacadam/Notate.git#upm Add

 Note that you won't be able to receive updates through Package Manager this way, you'll have to update manually.

Install manually

• Download the upm branch of this repository as a .zip file and extract it
• Open Window/Package Manager
• Click +
• Add package from disk
• Select package.json in the extracted folder

 Note that you won't be able to receive updates through Package Manager this way, you'll have to update manually.