Skip to content
ArcBrush ArcBrush Docs

Tag

Tag
Utility

Renames an image or a whole batch from a template or a find-and-replace, attaches your own key/value tags to each frame, and overrides either on individual frames, without touching a pixel.

Tag changes the name a frame carries into Export Batch’s {name} token, the Text node, and the Preview’s frame strip, and attaches any metadata you want to ride along. The pixels pass through byte-identical at either bit depth, so re-tagging a large batch costs nothing to recompute. Its one input takes a single image or a whole batch, and the output matches.

Naming rule

Section titled “Naming rule”

The Rule section offers two methods:

  • Build from Template writes each frame’s name from literal text and tokens: on a Palette Remap of hero.png, the rule {source}_{name} names the frames hero_red, hero_teal, hero_gold. A token picker inserts the tokens, and a live table shows the resolved name for every frame. Node tokens such as {this.label} do not work here, because a tag travels with the image. See the Tag recipe and, for every token a rule reads, the Token Reference.
  • Replace Text finds part of the existing name and replaces it. Find and Replace with take the same tokens, resolved per frame before matching, so a Find of {name} matches each frame’s whole name, and a Replace with of v{index} can swap a version suffix for the frame number. Matching is Unicode-aware, so accented characters match correctly and a match never splits a character.

A name that cannot be built (an undefined token, for example) is reported as a warning; turn on Strict to make it fail the node instead.

Tags

Section titled “Tags”

The Tags section is an ordered list of key/value pairs for metadata that is not a name: variant = night, artist = ako, sheet = 3. Anything downstream that reads a name reads a tag as {tag:key}, so an Export Batch template of {name}_{tag:variant} or a Text caption of {tag:artist} works like any built-in token.

Tag values are literal text with limits on count and length. The tag: prefix means your keys can never shadow a built-in token, and tag text in a file name stays inside the export destination, just as {name} does.

Per-frame overrides

Section titled “Per-frame overrides”

On a batch, the frame table overrides the rule for individual frames:

  • Name Override replaces that frame’s computed name.
  • Tag Override adds or replaces tags for that frame.
  • Tag Overrides Mode layers a frame’s override over the node’s Tags (merge) or makes it the frame’s whole tag set (replace).

Overrides follow the frame’s stable identity, not its position, so reordering, filtering, or re-cooking upstream keeps each override on its frame. An override whose frame no longer exists shows as an orphan instead of attaching to a different frame.

Swatch

Section titled “Swatch”

Set Swatch gives every passing frame the same swatch, the color chip shown beside the frame in batch lists and in Inspect. Per-frame swatch overrides sit in the same frame table.

Seeing the result

Section titled “Seeing the result”

The Inspect node shows a read-only Presentation section above its Source section: the name an upstream Tag authored, every tag as a key and value row, and the frame’s swatch. A name that could not be built is flagged with the reason. On a batch it follows the selected frame, so per-frame overrides show where they apply.

Parameters

Section titled “Parameters”

Pins

InputPixels
InputOptional
OutputPixels
Output

General

RuleData

How each frame is renamed.

  • Build from Template: builds the name from text and tokens: {name}, {source}, {label}, {index}, {count}, {width}, {height}, {color}, {graph} and {tag:key}. Add a transform such as {name|snake} or a fallback such as {label|or:name}.
  • Replace Text: replaces matching text in the incoming name. Find and Replace with accept the same tokens.
TagsData

Tags attached to every passing frame, as key and value pairs. A downstream template reads one as {tag:key}

Name OverridesData

Names set for individual frames, which replace the rule's result for those frames

Tag OverridesData

Tags set for individual frames. By default they are layered over the node's Tags

Tag Overrides ModeText
Default: merge

merge layers a frame's tag override over the node's Tags; replace makes it the frame's whole tag set

StrictToggle
Default: false

Treat naming warnings, such as an undefined token or a machine-scoped variable, as errors that fail the node

Set SwatchToggle
Default: false

Set every passing frame's swatch, the small color chip shown beside the frame in batch lists and Inspect. Off keeps each frame's incoming swatch

SwatchColor (RGB)
Default: rgb(255, 255, 255)
Set Swatch = on

Swatch color

Swatch OverridesData

Swatch colors set for individual frames, which replace Set Swatch's color for those frames

Usage Tips

Section titled “Usage Tips”
  • Put a Tag right after Collect or Image Folder to give a batch clean names before it fans out through Palette Remap; the palette variant’s {color} still appends downstream.
  • Use Replace Text with Find _final and an empty Replace with to strip a suffix from every frame at once.
  • Use a per-frame override for the exception. If most frames need the same change, change the template.
  • ArcBrush 1.6 cannot open a document saved by the current version, whether or not it has a Tag node. See File Management.
  • To reshape a name at export time ({name|snake}, {label|or:name}), use the transforms and fallbacks in the export file name.
Section titled “Related Nodes”