Updated IAMCCS-annotate with version 2.0.0
This commit is contained in:
IAMCCS
+59
-9
@@ -1,8 +1,6 @@
|
||||
# IAMCCS Annotate — User Guide
|
||||
|
||||
Version: 1.0.0
|
||||
|
||||
Coming soon: 2.0.0
|
||||
Version: 2.0.0
|
||||
|
||||
A fast, reliable annotation layer for ComfyUI. Draw, erase, organize in layers, and save notes inside your workflow.
|
||||
|
||||
@@ -13,6 +11,9 @@ A fast, reliable annotation layer for ComfyUI. Draw, erase, organize in layers,
|
||||
- Layers with visibility/lock/rename/delete
|
||||
- Per-mode brush sizes (draw vs eraser), opacity, dashed lines, constant width
|
||||
- HiDPI ×2 toggle for higher-quality rendering
|
||||
- Select / Transform / Rotate tools (drag-to-select, then act on corners)
|
||||
- Screenshot Post-its (drag to capture, then move from edges; can be moved even when Annotate is OFF)
|
||||
- Pin/unpin mode for Post-its (lock a screenshot so it can't be moved/resized/rotated)
|
||||
- Hide/show all annotations quickly
|
||||
- Export/import your entire workflow + annotations
|
||||
- Undo/redo and copy/paste for layers
|
||||
@@ -31,8 +32,21 @@ A fast, reliable annotation layer for ComfyUI. Draw, erase, organize in layers,
|
||||
- Alt+A — Toggle annotation mode
|
||||
- Alt+D — Toggle eraser/draw
|
||||
- Alt+S — Hide/show all annotations
|
||||
- Alt+F — Export workflow + notes (JSON)
|
||||
- Alt+1 — Tool: Draw
|
||||
- Alt+2 — Tool: Select
|
||||
- Alt+3 — Tool: Transform
|
||||
- Alt+4 — Tool: Rotate
|
||||
- Alt+5 — Tool: Screenshot
|
||||
- Alt+P — Toggle Pin/unpin mode (click a post-it to pin/unpin)
|
||||
- Ctrl+I — Import workflow + notes (JSON)
|
||||
- Ctrl+C — Copy selection (Select tool)
|
||||
- Ctrl+X — Cut selection (Select tool)
|
||||
- Ctrl+V — Paste selection (Select tool)
|
||||
- Delete / Backspace — Delete current selection (any tool)
|
||||
- Esc — Cancel current stroke / clear current selection
|
||||
|
||||
Notes:
|
||||
- Tool shortcuts (Alt+1..5) and Alt+P are active when Annotate is ON.
|
||||
|
||||
Note: On macOS, Alt refers to Option.
|
||||
|
||||
@@ -46,6 +60,37 @@ Note: On macOS, Alt refers to Option.
|
||||
- HiDPI ×2: supersamples annotation rendering for crisper lines (uses more memory)
|
||||
- Draw above nodes: when enabled, notes appear in the foreground; disable to push them behind nodes
|
||||
|
||||
## Tools
|
||||
|
||||
### Select
|
||||
- Drag to create a selection (rectangle or lasso)
|
||||
- The big selection frame is shown only while dragging; after release, selected items are highlighted
|
||||
- Drag inside a selected group to move it
|
||||
|
||||
### Transform
|
||||
- Drag a corner handle to scale the selected items
|
||||
- Corners have a larger hit-area and visible handles for easier grabbing
|
||||
|
||||
### Rotate
|
||||
- Drag a corner handle to rotate the selected items
|
||||
|
||||
### Screenshot (Post-it)
|
||||
- Drag a rectangle to capture a screenshot of the visible canvas
|
||||
- Move a post-it by dragging any edge
|
||||
- Move still works even when Annotate is OFF
|
||||
|
||||
### Text (+Text)
|
||||
- Click **+ Text** (next to **+ Layer**) to enter Text mode
|
||||
- Drag a rectangle on the workflow to set the text box size, then start typing
|
||||
- A font dropdown + size input appear next to **+ Text** in the menu
|
||||
- Double-click a text box to edit it later
|
||||
- Text boxes behave like a single object for Select / Transform / Rotate
|
||||
|
||||
### Pin/unpin (Post-it lock)
|
||||
- Enable Pin/unpin mode (Alt+P or the checkbox)
|
||||
- Click a post-it to toggle a red pin icon
|
||||
- Pinned post-its cannot be moved/resized/rotated (even if selected)
|
||||
|
||||
## Layers
|
||||
|
||||
- + Layer: adds a new layer and selects it
|
||||
@@ -55,22 +100,27 @@ Note: On macOS, Alt refers to Option.
|
||||
- Lock icon: prevent edits on the layer
|
||||
- X: delete layer (at least one layer is always kept)
|
||||
|
||||
### Layer color preview
|
||||
|
||||
- Each layer stores its own drawing color. When you select a layer, the color picker preview updates immediately to that layer’s saved color.
|
||||
|
||||
## Saving and persistence
|
||||
|
||||
- Saves to workflow.extra.iamccs_annotations
|
||||
- Local autosave keeps deletes/edits immediately (survives refresh).
|
||||
- If **Save into WF** is enabled, annotations are also embedded into `workflow.extra.iamccs_annotations` (so they travel with the workflow JSON).
|
||||
- Automatically saves when you:
|
||||
- complete a stroke
|
||||
- paste
|
||||
- clear
|
||||
- import
|
||||
- change key settings
|
||||
- When you load a workflow, its annotations load automatically
|
||||
- Each workflow keeps its own annotations
|
||||
- When you load a workflow, embedded annotations load automatically
|
||||
- Each workflow/subgraph keeps its own annotations
|
||||
|
||||
## Export / Import
|
||||
|
||||
- Export (Alt+F): downloads a JSON of the full workflow with annotations embedded in `extra.iamccs_annotations`
|
||||
- Import (ctrl+I): loads the full workflow if present; otherwise imports annotations only
|
||||
- Export (menu): use **Export Workflow+Notes** to download a JSON of the full workflow with annotations embedded in `extra.iamccs_annotations`
|
||||
- Import (Ctrl+I): loads the full workflow if present; otherwise imports annotations only
|
||||
- Import JSON (menu): imports annotations into the current layer
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
@@ -2,11 +2,11 @@
|
||||
|
||||
<img src="icon.png" width="150" height="150">
|
||||
|
||||
Version: 1.0.0 — Coming soon: 2.0.0 (many new features!)
|
||||
Version: 2.0.0
|
||||
|
||||
A powerful drawing and annotation tool for ComfyUI that lets you add notes, sketches, and annotations directly on your workflow canvas with full layer support.
|
||||
#A powerful drawing and annotation tool for ComfyUI that lets you add notes, sketches, and annotations directly on your workflow canvas with full layer support.
|
||||
|
||||
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
@@ -19,6 +19,7 @@ A powerful drawing and annotation tool for ComfyUI that lets you add notes, sket
|
||||
- Constant width option (maintains width at any zoom level)
|
||||
- HiDPI ×2 rendering toggle for crisper strokes
|
||||
- pen-only mode (4 tablet use)
|
||||
- Pin/unpin mode for screenshot post-its
|
||||
|
||||
🎨 **Layer System**
|
||||
- Create unlimited layers for organized annotations
|
||||
@@ -28,14 +29,44 @@ A powerful drawing and annotation tool for ComfyUI that lets you add notes, sket
|
||||
- Delete layers (minimum 1 layer always kept)
|
||||
- Auto-selects new layer as active
|
||||
|
||||
🧩 **Subgraph-aware Annotations (NEW in 2.0.0)**
|
||||
- Separate drawings per graph/subgraph: entering a subgraph shows its own annotations only
|
||||
- Returning to the main workflow restores the main workflow annotations
|
||||
|
||||
🧰 **Selection Tools (NEW in 2.0.0)**
|
||||
- Select tool with modes: Rectangle, Free-form, Lasso (drag required; no click-to-rect)
|
||||
- Copy / Cut / Paste for selected annotations
|
||||
- Selected items are highlighted after selection; the big selection frame only appears while dragging
|
||||
- Delete selected items with **Delete** or **Backspace** (any tool)
|
||||
|
||||
🧭 **Transform / Rotate (NEW in 2.0.0)**
|
||||
- Transform: scale selected items by dragging a corner handle
|
||||
- Rotate: rotate selected items by dragging a corner handle
|
||||
- Corner hit-area is enlarged and handles are visible for easier grabbing
|
||||
|
||||
📝 **Text Layers (NEW in 2.0.0)**
|
||||
- Create resizable text boxes directly on the workflow (drag to size, then type)
|
||||
- Choose font family and font size from the context menu controls
|
||||
- Double-click a text box to edit it later
|
||||
- Text boxes behave like a single object for Select / Transform / Rotate (whole box, not individual letters)
|
||||
|
||||
📸 **Screenshot Post-it (NEW in 2.0.0)**
|
||||
- Screenshot tool: drag a rectangle to capture any visible area (nodes/images/annotations)
|
||||
- The capture becomes a movable “post-it” you can place anywhere
|
||||
- Post-it appearance controls: configurable frame color, padding, border width, and optional shadow
|
||||
- Move post-its by dragging any edge (works even when Annotate is OFF)
|
||||
- Pin a post-it to lock it in place
|
||||
|
||||
📌 **State Management**
|
||||
- Save annotations with workflow (automatic)
|
||||
- Local autosave (survives refresh even if you don’t save the workflow)
|
||||
- Optional “Save into Workflow” (embeds notes into the workflow JSON)
|
||||
- Load annotations when reopening workflows
|
||||
- Quick toggle to hide/show all annotations
|
||||
- Persistent layer structure across sessions
|
||||
|
||||
🖱️ **User Interface**
|
||||
- Floating button with context menu (right-click)
|
||||
- Tools and Post-it settings are also available in the sidebar panel when present; otherwise a draggable dock panel appears near the canvas
|
||||
|
||||
|
||||
|
||||
@@ -52,8 +83,22 @@ A powerful drawing and annotation tool for ComfyUI that lets you add notes, sket
|
||||
| **Alt+A** | Toggle annotation mode ON/OFF |
|
||||
| **Alt+D** | Toggle eraser / draw mode |
|
||||
| **Alt+S** | Toggle hide/show annotations |
|
||||
| **Alt+1** | Tool: Draw |
|
||||
| **Alt+2** | Tool: Select |
|
||||
| **Alt+3** | Tool: Transform |
|
||||
| **Alt+4** | Tool: Rotate |
|
||||
| **Alt+5** | Tool: Screenshot |
|
||||
| **Alt+P** | Toggle Pin/unpin mode |
|
||||
| **Ctrl+I** | Import workflow + notes (JSON) |
|
||||
| **Ctrl+C** | Copy selection (Select tool) |
|
||||
| **Ctrl+X** | Cut selection (Select tool) |
|
||||
| **Ctrl+V** | Paste selection (Select tool) |
|
||||
| **Delete / Backspace** | Delete current selection (any tool) |
|
||||
| **Esc** | Cancel current stroke |
|
||||
|
||||
Notes:
|
||||
- Tool shortcuts (**Alt+1..5**) and **Alt+P** are active when Annotate is ON.
|
||||
|
||||
## Installation
|
||||
|
||||
1. Download or clone this extension into your ComfyUI custom_nodes folder:
|
||||
@@ -93,14 +138,25 @@ git clone https://github.com/IAMCCS/IAMCCS_annotate.git
|
||||
5. Use **lock icon** to prevent editing
|
||||
6. Use **X button** to delete layer
|
||||
|
||||
Layer color preview:
|
||||
- Each layer stores its own color. When you select a layer, the color picker preview updates immediately to that layer’s saved color.
|
||||
|
||||
### Adding Text
|
||||
1. In the context menu, click **"+ Text"** (next to **"+ Layer"**)
|
||||
2. Drag a rectangle on the workflow to set the text box size
|
||||
3. Type your text (Enter confirms, Shift+Enter adds a new line)
|
||||
4. Double-click a text box to edit it later
|
||||
5. Use **Select / Transform / Rotate** to move/scale/rotate the entire text box
|
||||
|
||||
### Hiding Annotations
|
||||
- Press **Alt+S** to quickly toggle visibility of all annotations
|
||||
- Useful for viewing your workflow without the annotations
|
||||
|
||||
### Workflow Integration
|
||||
- Annotations are **automatically saved** when you save your workflow
|
||||
- When you open a workflow that has annotations, they load automatically
|
||||
- Each workflow has its own separate annotations
|
||||
- The plugin keeps your changes immediately via **local autosave** (so deletes/edits survive a refresh).
|
||||
- If you want notes to travel with the workflow file, enable **Save into Workflow** and then save the workflow.
|
||||
- When you open a workflow that has embedded annotations, they load automatically.
|
||||
- Each workflow/subgraph keeps its own separate annotations.
|
||||
|
||||
## Context Menu Options
|
||||
|
||||
@@ -115,6 +171,18 @@ Right-click the floating button to access:
|
||||
- Dashed lines option
|
||||
- Hide notes option
|
||||
- **Layer Management** - Create, rename, manage layers
|
||||
- **Text** - Create resizable text boxes (+ Text) with font + size controls
|
||||
- **Tools (NEW)**
|
||||
- ✏️ Draw
|
||||
- 🔲 Select (Rectangle / Free-form / Lasso)
|
||||
- 📸 Shot (Screenshot Post-it)
|
||||
- Copy / Cut / Paste
|
||||
- 🔎 Macro
|
||||
- **Screenshot Post-it settings (NEW)**
|
||||
- Frame color
|
||||
- Padding
|
||||
- Border width
|
||||
- Shadow toggle
|
||||
- **Export/Import** - Save/load annotations separately
|
||||
- **Save into Workflow** - Toggle auto-save feature
|
||||
|
||||
@@ -147,8 +215,9 @@ Right-click the floating button to access:
|
||||
- Verify extension is in `custom_nodes/IAMCCS_annotate`
|
||||
|
||||
**Annotations not saving?**
|
||||
- Check "Save into workflow" toggle in menu
|
||||
- Ensure workflow is saved to disk
|
||||
- If you only need persistence after refresh: local autosave should handle it automatically.
|
||||
- If you need annotations embedded into the workflow JSON (for sharing/export): enable **Save into Workflow** and save the workflow.
|
||||
- Ensure the workflow is saved to disk after enabling the toggle.
|
||||
- Check browser console for errors
|
||||
|
||||
**Eraser not working?**
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 1.9 MiB |
Binary file not shown.
|
After Width: | Height: | Size: 2.2 MiB |
+6022
-82
File diff suppressed because it is too large
Load Diff
+1
-1
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "IAMCCS-Annotate"
|
||||
version = "1.0.0"
|
||||
version = "2.0.0"
|
||||
description = "Drawing and annotation tool for ComfyUI with layer support"
|
||||
readme = "README.md"
|
||||
license = {text = "MIT"}
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "iamccs-annotate",
|
||||
"version": "1.0.0",
|
||||
"version": "2.0.0",
|
||||
"author": "Carmine Cristallo Scalzi (IAMCCS)",
|
||||
"description": "drawing and annotation tool for ComfyUI."
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user