DiscoverNotes

DiscoverNotes is a Unity package for adding visual, structured documentation directly to GameObjects and production scenes. It keeps implementation context, review notes, warnings, links, and team annotations close to the content they describe.

Highlights

• Inspector-based note editing for GameObjects.
• Fixed and edit display modes.
• Categories, authors, and discipline tagging.
• Rich text, links, checklists, and inline image references.
• Hierarchy tooltip support for quick review.
• Structured Discover sections for production notes.
• VAT UV atlas tooling for visual reference workflows.
• Distributed as com.jaimecamachodev.discovernotes.

Installation

Scoped Registry

For team distribution through Unity Package Manager, add this scoped registry to Packages/manifest.json:

{
  "scopedRegistries": [
    {
      "name": "JaimeCamachoDev",
      "url": "https://registry.npmjs.org",
      "scopes": [
        "com.jaimecamacho"
      ]
    }
  ],
  "dependencies": {
    "com.jaimecamachodev.discovernotes": "1.2.4"
  }
}

Git URL

You can also install directly from GitHub:

{
  "dependencies": {
    "com.jaimecamachodev.discovernotes": "https://github.com/JaimeCamachoDev/DiscoverNotes.git?path=/Packages/com.jaimecamachodev.discovernotes"
  }
}

You can also use Window > Package Manager > Add package from git URL... and paste:

https://github.com/JaimeCamachoDev/DiscoverNotes.git?path=/Packages/com.jaimecamachodev.discovernotes

What It Solves

DiscoverNotes helps teams document decisions where they happen: inside the Unity Editor. Instead of scattering context across chats, tickets, and temporary comments, you can attach that information directly to the relevant GameObject.

Typical use cases:

• Explaining scene setup decisions.
• Marking warnings, blockers, and follow-up tasks.
• Linking to internal tools, docs, or external references.
• Leaving handoff notes for art, design, tech art, FX, audio, or gameplay.
• Building review-friendly notes for VAT and content validation workflows.

Main Features

GameObject Notes

The GameObjectNotes component lets you create one or more notes per object with:

• Title and summary fields.
• Category, discipline, and author metadata.
• Plain-text editing with formatted rendering in fixed mode.
• Support for links, checklist items, color tags, size tags, and inline references.

Discover Sections

Each note can include structured sections to split information into clearer blocks for reviews, pipelines, and handoff documentation.

Hierarchy Feedback

Notes can be surfaced in the Unity hierarchy through tooltip-style previews, which makes it easier to review important context without opening every object individually.

Visual VAT Support

The package includes VAT UV atlas support for generating visual reference textures directly from note data.

Quick Start

1. Import the package into your Unity project.
2. Add the GameObjectNotes component to any GameObject.
3. Create a note and assign its category, discipline, and author.
4. Write the note body and optional Discover sections.
5. Switch between edit mode and fixed mode to preview the final rendering.

Markup Examples

DiscoverNotes supports lightweight authoring patterns inside notes:

[tag](Carlos) escribe un [link externo](https://example.com/)

[check] Review collision boxes

[bold]Important[/bold]
[italics]Needs revision[/italics]

[color=red]High priority[/color]
[size=20]Large heading[/size]

Screenshots

The README is prepared to host component screenshots under Packages/com.jaimecamachodev.discovernotes/Documentation~/images/.

Suggested screenshot filenames:

• discovernotes-manifest.png
• discovernotes-editor.png
• discovernotes-preview.png

Suggested gallery block:

![Package manifest](Packages/com.jaimecamachodev.discovernotes/Documentation~/images/discovernotes-manifest.png)
![Component editor](Packages/com.jaimecamachodev.discovernotes/Documentation~/images/discovernotes-editor.png)
![Rendered note preview](Packages/com.jaimecamachodev.discovernotes/Documentation~/images/discovernotes-preview.png)

Repository

• Repository: JaimeCamachoDev/DiscoverNotes
• Git URL: https://github.com/JaimeCamachoDev/DiscoverNotes.git
• Author: Jaime Camacho
• License: MIT
• Changelog: CHANGELOG.md

Release Workflow

This package now uses a Unity 6.3 signed tarball workflow for npm releases.

Normal release

From PowerShell in the repository root:

cd E:\DiscoverNotes
.\Release-DiscoverNotes-ManualSign.bat -Version X.Y.Z

Example:

cd E:\DiscoverNotes
.\Release-DiscoverNotes-ManualSign.bat -Version 1.3.0

What it does:

1. Updates package.json to the requested version.
2. Syncs README.md, CHANGELOG.md, and LICENSE into the package.
3. Creates the changelog section if it does not exist yet.
4. Prompts for changelog notes if the new section still contains placeholder text.
5. Waits for a signed Unity export.
6. Publishes the signed .tgz to npm.

Manual Unity export step

When the script pauses, export the signed tarball from Unity Package Manager and save it here:

E:\DiscoverNotes\ReleaseArtifacts\com.jaimecamachodev.discovernotes-X.Y.Z.tgz

Then return to the console and press Enter.

Publish an already exported tarball

If the signed .tgz already exists, you can publish it directly:

cd E:\DiscoverNotes
.\Publish-SignedTarball.bat -Version X.Y.Z

Optional Git automation

You can ask the release script to create the release commit and tag too:

cd E:\DiscoverNotes
.\Release-DiscoverNotes-ManualSign.bat -Version X.Y.Z -CreateGitCommit -CreateGitTag -PushGitTag

Notes

• Run the commands from E:\DiscoverNotes.
• In PowerShell, use cd E:\DiscoverNotes, not cd /d E:\DiscoverNotes.
• The tarball must be Unity-signed. The publish script validates that before uploading.
• Full release notes are documented in RELEASING.md.

Unity Version

Current package metadata targets Unity 6000.0.0f1.