Skip to Content
Chameleon Docs

Concepts

The words the studio and the API share.

Manual

The library everything sits in: the PDF, its labels and image settings, the built assets, the cards, any pictures you uploaded, and the published deck. A manual made from your own pictures has no PDF.

Labels

Regions drawn on the PDF's pages, each with a kind and a name:

  • Step: one action and its picture. A step owns the regions inside it.
  • Object: a thing a step needs or makes, like a part, a tool or the finished result.
  • Text: words kept as words.

Steps can be combined into groups, like the steps of one bag or one stage.

Image settings

How each region's picture is finished: the page behind the art made transparent, the picture trimmed and sized. Settings apply to the whole manual, a page, or one region.

Asset

What a build makes of a region: a picture, or a text. An asset goes stale when its region or settings change, and is made again on the next build.

Card and deck

A card is one page on the glasses, holding pictures, text and boxes. The deck is the cards in order. Publishing writes the deck where the glasses read it: public on everyone's list, or private to you.

On this page