API index
Every public export, generated from the TypeScript sources. If something is exported and not listed here, the extractor is wrong — not the documentation.
Components
| Export | Kind | Package | Description |
|---|---|---|---|
ActivityMark | component | @aora-bot/react | The "an agent is doing something" line in a conversation. |
ActivityTicker | component | @aora-bot/react | Single-line text that swaps rather than changes. |
AgentAvatar | component | @aora-bot/react | The avatar an application actually drops into a list. |
AgentCharacterPicker | component | @aora-bot/react | A `CharacterPicker` that holds its edits until they are confirmed. |
AgentHud | component | @aora-bot/react | The arbiter's current reading, as a character and a plate. |
AgentStateProvider | component | @aora-bot/react | Share one arbiter across a subtree. |
AppearanceProvider | component | @aora-bot/react | Set drawing defaults for every mark below. |
AvatarEditor | component | @aora-bot/react | The avatar dialog: pick a character, generate a picture, or upload one. |
AvatarSlot | component | @aora-bot/surfaces | The empty circle a character flies into at the end of a scene. |
AvatarStack | component | @aora-bot/react | Overlapping cluster of group members. |
AvatarStatusDot | component | @aora-bot/react | Corner presence indicator. |
AvatarTrigger | component | @aora-bot/react | The button that opens the avatar editor, showing what it would edit. |
BootLoop | component | @aora-bot/surfaces | Something is starting up and nobody knows how long it will take. |
CastMember | component | @aora-bot/surfaces | One character in a scripted scene, in two nested boxes. |
CastStage | component | @aora-bot/surfaces | — |
CharacterMark | component | @aora-bot/react | A single animated character. |
CharacterMarkMirror | component | @aora-bot/react | Draw an already-running character again, somewhere else. |
CharacterPicker | component | @aora-bot/react | Shape and colour chooser, with an optional face style and nose. |
CompactCharacterPicker | component | @aora-bot/react | The picker cut down to what fits beside a sign-up form. |
Composer | component | @aora-bot/surfaces | A message field with a character that pays attention to it. |
ConfettiLayer | component | @aora-bot/react | Confetti on its own, with no character attached. |
DemoDesktop | component | @aora-bot/surfaces | A window frame to put a demo inside. |
DeviceBezel | component | @aora-bot/surfaces | A device around a character: rounded shell, inset screen, status light. |
EditableAvatar | component | @aora-bot/react | An avatar that says it can be edited, and opens the editor when pressed. |
GroupActivityMark | component | @aora-bot/react | Group equivalent, rotating through the members. |
GroupAvatar | component | @aora-bot/react | Convenience wrapper that reads members off a group record. |
HandOff | component | @aora-bot/surfaces | One agent handing work to another. |
HudPlate | component | @aora-bot/react | The words around a dial. |
JobBubbles | component | @aora-bot/surfaces | Work in flight, as words around a character. |
LandingWait | component | @aora-bot/surfaces | The screen before anything has happened. |
LoadingMark | component | @aora-bot/surfaces | A placeholder in the shape of the character that is coming. |
LocaleProvider | component | @aora-bot/react | Language for the component layer. |
MarkStageProvider | component | @aora-bot/react | Hosts one hidden animation per distinct appearance, for mirrors to reuse. |
OccupancyList | component | @aora-bot/surfaces | Which agents are on which resource. |
OccupancyMark | component | @aora-bot/surfaces | One agent, small, in a list of who is using something. |
RestrictedScene | component | @aora-bot/surfaces | The page you land on when something says no. |
ShareCard | component | @aora-bot/surfaces | A template as something you can hand to someone: face, name, link. |
SpriteMark | component | @aora-bot/react | A raster character driven by the same states as the vector ones. |
StagedMark | component | @aora-bot/react | A character that shares its animation with every other character of the same |
SuggestionCards | component | @aora-bot/surfaces | Three starting points, each with a face. |
SurfaceLocaleProvider | component | @aora-bot/surfaces | Copy overrides for the surfaces. |
TemplateDialog | component | @aora-bot/surfaces | Create or edit an agent template. |
UnreadBadge | component | @aora-bot/react | Unread counter, capped so a runaway number cannot stretch the layout. |
VisibilityControls | component | @aora-bot/surfaces | Who can use a template, as two labelled choices rather than a switch. |
WorkingBadge | component | @aora-bot/react | Three dots, pulsing out of phase. |
Hooks
| Export | Kind | Package | Description |
|---|---|---|---|
useActivityPresence | hook | @aora-bot/react | Mount on show, play the exit animation, then unmount. |
useAgentHud | hook | @aora-bot/react | The HUD the arbiter is currently showing, if there is an arbiter at all. |
useAgentState | hook | @aora-bot/react | The nearest `AgentStateProvider`. Throws outside one, because there is no sensible default to fall back to. |
useAppearance | hook | @aora-bot/react | The defaults in effect here. An empty record outside any provider. |
useArbiter | hook | @aora-bot/react | Run an arbiter for the lifetime of a component. |
useCastScene | hook | @aora-bot/surfaces | Walk a scripted scene, one step at a time. |
useCycle | hook | @aora-bot/react | Shared rotation counter. |
useDeadline | hook | @aora-bot/react | A deadline that restarts whenever its dependencies change. |
useEventSourceChannel | hook | @aora-bot/react | Subscribe to a server-sent event stream of state messages. |
useHudSpec | hook | @aora-bot/react | Build a HUD spec from live numbers, or `null` if it does not hold up. |
useIdleSleep | hook | @aora-bot/react | A character that nods off when the visitor does. |
useLabel | hook | @aora-bot/react | The id-driven half of the locale, as functions. |
useLocale | hook | @aora-bot/react | Translate a key. Falls back to English outside a provider. |
useMarkCommand | hook | @aora-bot/react | Subscribe to one agent. |
useMarkCommands | hook | @aora-bot/react | Command side of the stage. Works with or without a provider above it. |
useMarkSettle | hook | @aora-bot/react | Hold a state until it has stopped changing. |
useMarkStage | hook | @aora-bot/react | — |
useOptionalAgentState | hook | @aora-bot/react | The nearest provider, or `null`. For components that work either way. |
usePokeCycle | hook | @aora-bot/react | Cycle a character through its three flourishes, one per call. |
usePublishMark | hook | @aora-bot/surfaces | Three states for the one moment a form is worth animating. |
useReducedMotion | hook | @aora-bot/react | Reduced motion, as a subscription so a mid-session change is picked up. |
useSpawnEntrance | hook | @aora-bot/react | Play an arrival the first time an agent shows up, and never again. |
useSpriteManifest | hook | @aora-bot/react | Load a manifest by URL. Resolves to `{ manifest: null, loading: false }` with no URL. |
useStateChannel | hook | @aora-bot/react | Accept `postMessage` state updates for as long as the component is mounted. |
useSurfaceLocale | hook | @aora-bot/surfaces | Translate a surface key in the language of the surrounding `LocaleProvider`; English outside one. |
Functions
| Export | Kind | Package | Description |
|---|---|---|---|
activityFromTool | function | @aora-bot/react | — |
activityLabelForState | function | @aora-bot/react | The label for a state, for hosts that already know the state and only need the words. |
agentColor | function | @aora-bot/react | — |
agentFace | function | @aora-bot/react | — |
agentNose | function | @aora-bot/react | The agent's nose, or `null` unless its face is the line face. |
agentShape | function | @aora-bot/react | Resolve an agent's appearance. |
allShapes | function | @aora-bot/engine | Every shape, derived. Only call this when you genuinely need all of them. |
autoColorForKey | function | @aora-bot/engine | Deterministic colour for an arbitrary key (an agent id, a username, anything). |
autoNoseForKey | function | @aora-bot/engine | Deterministic nose for an arbitrary key, for the line face. Salted so a |
autoPause | function | @aora-bot/engine | — |
autoShapeForKey | function | @aora-bot/engine | Deterministic body shape for an arbitrary key. |
bangGlyphPath | function | @aora-bot/engine | An exclamation mark: a tapered capsule over a round dot. |
behaviourFor | function | @aora-bot/engine | — |
beltBodyRing | function | @aora-bot/engine | The body outline while a belt takes over, as points. |
beltForState | function | @aora-bot/engine | — |
blendBeltFrames | function | @aora-bot/engine | Cross-fade two belt frames. |
castMember | function | @aora-bot/engine | Look up a cast member. Returns `null` for unknown ids rather than throwing, so a stored preference can go stale safely. |
characterStateForActivity | function | @aora-bot/react | — |
characterStateForAgent | function | @aora-bot/react | Resolve what an agent is doing to a state. |
characterStateForRoster | function | @aora-bot/engine | Resolve a roster row to a state. |
clamp | function | @aora-bot/engine | — |
clampPan | function | @aora-bot/react | Hold the crop window inside the image. |
clampZoom | function | @aora-bot/react | — |
computeEyePlacement | function | @aora-bot/engine | Work out where the two eyes go and how they are distorted by the pose. |
computeFaceGeometry | function | @aora-bot/engine | Place the whole face: eyes, and in line mode the nose and mouth too. |
computeFacePlacement | function | @aora-bot/engine | The same placement as SVG strings. A thin wrapper over `computeFaceGeometry` |
coverScale | function | @aora-bot/react | Pixels of stage per pixel of image. |
createArbiter | function | @aora-bot/engine | — |
createCharacter | function | @aora-bot/engine | Build and drive one character. |
createConfettiController | function | @aora-bot/engine | — |
createImpulseBehaviour | function | @aora-bot/engine | Behaviours that fire discrete impulses rather than tracking a continuous |
createMarkCommandRegistry | function | @aora-bot/react | The agent-keyed half of the stage. |
createParticleSystem | function | @aora-bot/engine | Confetti bursts and spin ribbons. |
createSimulation | function | @aora-bot/engine | Build the part of a character that is not drawing. |
cropToDataUrl | function | @aora-bot/react | Render the crop to a PNG data URL. |
cx | function | @aora-bot/react | Join class names, dropping the falsy ones. |
defineShape | function | @aora-bot/engine | Register a custom shape, or replace a built-in one. |
defineStyle | function | @aora-bot/engine | Register a style series, or replace one with the same id. |
easeInOutCubic | function | @aora-bot/engine | — |
easeOutCubic | function | @aora-bot/engine | — |
easeOutQuart | function | @aora-bot/engine | — |
emotionIdForState | function | @aora-bot/engine | The canonical id for a state — what a kit-side host should emit for it. |
emotionIdForTool | function | @aora-bot/engine | — |
emotionSegment | function | @aora-bot/engine | — |
evaluateBelt | function | @aora-bot/engine | Evaluate a belt at time `t` seconds. |
evaluateFx | function | @aora-bot/engine | The effect `kind` at time `t`, in seconds. |
evaluateHud | function | @aora-bot/engine | Evaluate a HUD at `tMs` milliseconds. |
evaluateHudPrimitives | function | @aora-bot/engine | `evaluateHud` without the SVG: polylines stay as points. |
exportPlacement | function | @aora-bot/react | Where the image lands on the export canvas. |
eyeOutline | function | @aora-bot/engine | Convert a spec into a closed outline. |
eyePairFor | function | @aora-bot/engine | The eye pair a name means on a given face. The cute face reads cute names |
faceTuneForState | function | @aora-bot/engine | — |
fitFace | function | @aora-bot/engine | Find the largest ellipse that fits comfortably inside a body outline. |
fitImage | function | @aora-bot/react | The size to decode a source image at. |
fnv1a32 | function | @aora-bot/engine | 32-bit FNV-1a. Stable across runs and platforms, which is the whole point. |
formatHud | function | @aora-bot/engine | Format a spec the way a status bar would print it. |
frameLerp | function | @aora-bot/engine | Frame-rate independent exponential approach. `rate` is the fraction covered |
gazeForState | function | @aora-bot/engine | — |
getAdapter | function | @aora-bot/engine | — |
getCuteMouth | function | @aora-bot/engine | — |
getEmotion | function | @aora-bot/engine | — |
getEyeScaleForShape | function | @aora-bot/engine | Counter-scale for eyes so they read the same size on every body. |
getInkColor | function | @aora-bot/engine | — |
getInkColorCss | function | @aora-bot/engine | Ink as a `light-dark()` pair. |
getInkGradient | function | @aora-bot/engine | — |
getInkGradientFor | function | @aora-bot/engine | Resolved (non-`light-dark`) gradient, for contexts that cannot use CSS colour functions. |
getInkVars | function | @aora-bot/engine | The CSS custom properties a host puts on a character for this colour. |
getLeafColor | function | @aora-bot/engine | — |
getMouth | function | @aora-bot/engine | — |
getShape | function | @aora-bot/engine | Shapes are derived on first use, not at import. Face fitting is a grid |
getShapeScale | function | @aora-bot/engine | — |
getStyle | function | @aora-bot/engine | Look a series up. Throws for an id nobody registered, naming the ones that exist. |
getSwatch | function | @aora-bot/engine | — |
getSwatchHex | function | @aora-bot/engine | — |
haloBackground | function | @aora-bot/engine | Soft multi-stop wash used behind avatars. |
hasPicture | function | @aora-bot/react | — |
hasStyle | function | @aora-bot/engine | — |
isCastId | function | @aora-bot/engine | — |
isCharacterState | function | @aora-bot/engine | — |
isGroup | function | @aora-bot/react | — |
isHudKind | function | @aora-bot/engine | — |
isHudSpec | function | @aora-bot/engine | Strict validation, used by the protocol parser. |
isKnownActivity | function | @aora-bot/react | Whether the catalogue recognises a verb, rather than falling back to work. |
isMouthId | function | @aora-bot/engine | — |
isNoseId | function | @aora-bot/engine | — |
isOneshotEmotion | function | @aora-bot/engine | — |
isSpriteManifest | function | @aora-bot/engine | Structural check for something fetched off the network. |
kaomoji | function | @aora-bot/engine | The character as one line of text: `(・ω・)`, `☁(^▽^) ♪`, `ฅ(・ω・)ฅ`. |
layoutAvatarStack | function | @aora-bot/react | Where the discs in a cluster go. |
lerp | function | @aora-bot/engine | — |
listStyles | function | @aora-bot/engine | Every registered series: the built-ins in the order of `STYLE_IDS`, then the |
loadImage | function | @aora-bot/react | Decode a data URL and bring it down to a workable size. |
loadSpriteManifest | function | @aora-bot/react | Fetch and validate a manifest. Cached per URL for the page's lifetime; a failure is forgotten so a retry can succeed. |
mapPointerToGaze | function | @aora-bot/engine | Map a point in viewport pixels to a gaze target. |
morphEye | function | @aora-bot/engine | Blend two eye specs. Every field is independent, so the result is always a valid eye. |
morphEyePair | function | @aora-bot/engine | — |
morphMouth | function | @aora-bot/engine | Blend two mouths. Every field is independent, so the result is always a valid mouth. |
mouthForState | function | @aora-bot/engine | — |
mouthOutline | function | @aora-bot/engine | Convert a mouth spec into a closed outline: the upper lip left to right, |
mouthSpecFor | function | @aora-bot/engine | The mouth a name means on a given face, or `undefined` when that face has no such mouth. |
mulberry32 | function | @aora-bot/engine | Mulberry32 PRNG. Small, fast, and good enough for scatter and jitter. |
normaliseId | function | @aora-bot/engine | Accept `3`, `'3'`, `'03'`, `' 03 '` as the same id. |
normalize | function | @aora-bot/engine | — |
normalizeLine | function | @aora-bot/engine | Parse and normalise one line of newline-delimited JSON. Blank lines are skipped, not errors. |
normalizeTemplateDraft | function | @aora-bot/surfaces | Clean a template up and say what is still wrong with it. |
nosePolyline | function | @aora-bot/engine | Nose polyline scaled to a radius and positioned at an anchor. |
onReducedMotionChange | function | @aora-bot/engine | Subscribe to reduced-motion changes. Returns an unsubscribe function. |
openMessageChannel | function | @aora-bot/engine | Listen for `{ type: 'aora:state', payload }` messages. Returns a closer. |
panLimit | function | @aora-bot/react | How far the centre may travel before an edge of the image enters the window. |
paramsForVariant | function | @aora-bot/engine | The parameters a variant actually reads, for a control panel that shows only those. |
parseAgentMessage | function | @aora-bot/engine | Parse the wire form of a message: `{ aoraBotId, tips?, hud? }`, |
participantsFromMembers | function | @aora-bot/react | Split a membership list into the faces to draw and a count for the rest. |
particleFrames | function | @aora-bot/engine | Paper as renderers see it: position, size and a ready-made opacity. |
particleOpacity | function | @aora-bot/engine | Opacity curve: quick fade in, long power fade out. |
particleSize | function | @aora-bot/engine | Confetti shrinks a little as it falls. |
pencilGlyphPath | function | @aora-bot/engine | A pencil, pointing down. |
polylinePath | function | @aora-bot/engine | Straight-segment SVG path through a list of points. |
polylinesPath | function | @aora-bot/engine | Several open polylines as one path, each its own subpath. |
poseMatrix | function | @aora-bot/engine | Combined pose and rest-pose matrix. |
prefersReducedMotion | function | @aora-bot/engine | Whether the visitor asked for reduced motion. Safe to call during SSR. |
projectOnSphere | function | @aora-bot/engine | Project a point on the character's notional sphere through the current pose. |
readImageFile | function | @aora-bot/react | Validate and read a dropped, pasted or chosen file. |
readLineStream | function | @aora-bot/engine | Consume newline-delimited JSON from any async source of text chunks. |
renderAvatarDataUrl | function | @aora-bot/engine | One-line deterministic avatar for an arbitrary key. |
renderStaticSvg | function | @aora-bot/engine | Render a character to an SVG string. |
renderStaticSvgDataUrl | function | @aora-bot/engine | Percent-encoded data URL. Smaller and more readable than base64 for SVG. |
resetSpawnEntrances | function | @aora-bot/react | Forget every introduction. Exists for tests and for host-side session resets. |
resolveEmotionId | function | @aora-bot/engine | Resolve either form of address to an id: a two-digit protocol id, or a |
resolveLineWeight | function | @aora-bot/engine | Resolve a per-character line weight from a multiplier. |
resolveSpriteFrames | function | @aora-bot/engine | Pick the frames for an id. |
resolveStyleOptions | function | @aora-bot/engine | Merge caller parameters over a series' defaults. |
ribbonColor | function | @aora-bot/engine | A ribbon's colour: soft and a little light, so it reads as a flourish and not as part of the body. |
ribbonRuns | function | @aora-bot/engine | The stretches of a ribbon on one side of the body, as `[first, last]` index |
roundTo | function | @aora-bot/engine | Round to a number of decimal places. |
settleForState | function | @aora-bot/engine | — |
settleSpring | function | @aora-bot/engine | Drop a spring onto its target instantly. Used for reduced-motion. |
shapeMaskImage | function | @aora-bot/engine | Silhouette-only SVG, for use as a CSS `mask-image`. |
shapeRingMaskImage | function | @aora-bot/engine | Hollow ring version of the silhouette, for selection indicators. |
smoothClosedPath | function | @aora-bot/engine | Closed Catmull-Rom spline through `points`, converted to cubic Béziers. |
smoothstep | function | @aora-bot/engine | — |
spring | function | @aora-bot/engine | — |
springPosition | function | @aora-bot/engine | Normalised spring position at time `t`, starting at 0 and settling at 1. |
springSettleTime | function | @aora-bot/engine | Time in seconds for a spring to visually settle. Used to derive CSS |
springToLinearEasing | function | @aora-bot/engine | Sample a spring into a CSS `linear()` easing function so a DOM transition |
spriteCoverage | function | @aora-bot/engine | Audit a manifest against a list of ids (normally `EMOTION_IDS`). |
stackMetrics | function | @aora-bot/react | — |
stackMetricsForPx | function | @aora-bot/react | The band an arbitrary pixel size falls in. |
stateForActivity | function | @aora-bot/engine | State for an activity verb; anything unrecognised is generic work. |
stateForAgentEvent | function | @aora-bot/engine | Translate a tool event through its adapter. `null` when either is unknown. |
stateForEmotion | function | @aora-bot/engine | Resolve an id to the state a character should adopt. |
stateForTool | function | @aora-bot/engine | State for a tool name; unknown tools are "working". |
stepSpring | function | @aora-bot/engine | Advance a spring by `dt` seconds using semi-implicit Euler at a fixed |
streamChunks | function | @aora-bot/engine | Turn a `ReadableStream` (as returned by `fetch`) into an async iterable of chunks. |
tangentTransform | function | @aora-bot/engine | — |
tangentTransformString | function | @aora-bot/engine | The same transform as an SVG attribute value, at four decimals. |
trailFrames | function | @aora-bot/engine | Ribbons as renderers see them; one too short or too thin to draw is left out. |
validateStyleOptions | function | @aora-bot/engine | Report what `resolveStyleOptions` would silently fix. |
wrapperFor | function | @aora-bot/engine | The wrapper a shape wears. |
Constants and data
| Export | Kind | Package | Description |
|---|---|---|---|
ACTIVITY_EXIT_MS | constant | @aora-bot/react | How long the row stays in the DOM after it has been told to go. |
ACTIVITY_LABELS | constant | @aora-bot/react | The verb to show for each state a tool can put the character in. |
ACTIVITY_MARK_PX | constant | @aora-bot/react | — |
ACTIVITY_VERB_IDS | constant | @aora-bot/engine | The verbs a product surface uses to say what an agent is doing. |
ACTIVITY_VERBS | constant | @aora-bot/engine | — |
AGENT_ADAPTERS | constant | @aora-bot/engine | — |
ANTIC_STATES | constant | @aora-bot/engine | States in which an unattended character may occasionally do something on |
ASSIGNABLE_COLOR_IDS | constant | @aora-bot/engine | Colours that deterministic assignment may pick. `black` is reserved for defaults. |
AUTO_SHAPE_POOL | constant | @aora-bot/engine | Shapes that deterministic assignment may pick — the eight that read well at 16px. |
AVATAR_PREVIEW_PX | constant | @aora-bot/react | Default size of the character preview. |
AVATAR_SIZES | constant | @aora-bot/react | — |
BELT_CORE_SIZE | constant | @aora-bot/engine | How far the body shrinks when this belt takes over. |
BELT_GLYPH_SIZE | constant | @aora-bot/engine | Height of a belt glyph in shape units, before the frame's own scale. |
BELT_KINDS | constant | @aora-bot/engine | — |
CAST | constant | @aora-bot/engine | The named characters, one per body, in catalogue order. |
CAST_IDS | constant | @aora-bot/engine | — |
CENTER | constant | @aora-bot/engine | Centre of shape space. All generators build around this point. |
CHARACTER_STATES | constant | @aora-bot/engine | — |
claudeCode | constant | @aora-bot/engine | Claude Code hook events. |
COLOR_IDS | constant | @aora-bot/engine | — |
COLOR_SWATCHES | constant | @aora-bot/engine | Three colour layers per hue. |
CONFETTI_COLORS | constant | @aora-bot/engine | — |
CROP_STAGE_PX | constant | @aora-bot/react | Side of the square crop window. |
cursor | constant | @aora-bot/engine | Cursor agent hook events. |
CUTE_EYE_IDS | constant | @aora-bot/engine | — |
CUTE_EYE_TOPOLOGIES | constant | @aora-bot/engine | — |
CUTE_MOUTH_IDS | constant | @aora-bot/engine | Named mouths for the cute face. Every state wears one; see `STATE_CUTE_MOUTH`. |
CUTE_MOUTHS | constant | @aora-bot/engine | — |
DEFAULT_ACTIVITY | constant | @aora-bot/react | — |
DEFAULT_FACE_TUNE | constant | @aora-bot/engine | — |
DEFAULT_POSE | constant | @aora-bot/engine | Live pose, layered on top of the rest pose. Neutral by default — animation |
DEFAULT_POSE_HOME | constant | @aora-bot/engine | Rest pose: the slight three-quarter turn the character holds when it is not |
DEFAULT_PRIORITY | constant | @aora-bot/engine | Default priorities. Errors and refusals beat everything because they need |
DEFAULT_STYLE_ID | constant | @aora-bot/engine | The series a character is drawn in when nothing names one. |
DEFAULT_TOOL_STATE | constant | @aora-bot/engine | — |
EMOTION_IDS | constant | @aora-bot/engine | — |
EMOTION_SEGMENTS | constant | @aora-bot/engine | — |
EMOTIONS | constant | @aora-bot/engine | — |
enUS | constant | @aora-bot/react | Source of truth for translatable strings. Every other locale mirrors these keys. |
EXPORT_PX | constant | @aora-bot/react | Side of the exported PNG. Four times the stage, so a retina avatar stays sharp. |
EYE_TOPOLOGIES | constant | @aora-bot/engine | — |
EYE_TOPOLOGY_IDS | constant | @aora-bot/engine | — |
FACE_STYLES | constant | @aora-bot/engine | How the face is drawn. |
FX_COLORS | constant | @aora-bot/engine | Colours the effects keep on every variant. Ink-coloured ones are `null`, so the renderer picks the ink. |
FX_KINDS | constant | @aora-bot/engine | The mood effects of the cute face: what a character throws off besides its expression. |
GROUP_CYCLE_MS | constant | @aora-bot/react | — |
GROUP_INK_MS | constant | @aora-bot/react | Ink crossfade when the group rotates. Slower, because the rotation itself is abrupt. |
GROUP_MARK_PX | constant | @aora-bot/react | — |
HUD_FONT | constant | @aora-bot/engine | Tabular face for the printed figure. |
HUD_KIND_LABELS | constant | @aora-bot/engine | — |
HUD_KINDS | constant | @aora-bot/engine | The HUD data contract. |
HUD_PRINT_MIN_PX | constant | @aora-bot/engine | Below this CSS size the ring keeps the track and drops the glyphs. |
IDLE_EMOTION_ID | constant | @aora-bot/engine | — |
IDLE_STATE | constant | @aora-bot/engine | — |
INK_GRADIENT_ANGLE | constant | @aora-bot/engine | — |
LEAF_COLOR | constant | @aora-bot/engine | The green of a leaf accessory (`ShapePart` tone `leaf`), and the lighter one |
LEAF_COLOR_ON_GREEN | constant | @aora-bot/engine | — |
LINE_FACE_TUNE | constant | @aora-bot/engine | Eye size multipliers applied in line mode. |
LINE_WEIGHT | constant | @aora-bot/engine | Stroke weight for nose, mouth and thin eye expressions, as a fraction of the |
LINE_WEIGHT_RANGE | constant | @aora-bot/engine | How far a character may stray from the shared line weight, either way. |
LOCALES | constant | @aora-bot/react | — |
MarkCommandContext | constant | @aora-bot/react | — |
MAX_SOURCE_PX | constant | @aora-bot/react | Longest edge kept after loading. A source photo is usually several times this. |
MAX_UPLOAD_BYTES | constant | @aora-bot/react | Refuse anything larger. Above this a data URL alone is enough to stall a tab. |
MESSAGE_TYPE | constant | @aora-bot/engine | Wire shape for the `postMessage` transport. |
MOUTH_DROP | constant | @aora-bot/engine | Where the mouth sits below the eye line, in eye radii. |
MOUTH_IDS | constant | @aora-bot/engine | Named mouths for the line face. Every state wears one; see `STATE_MOUTH`. |
MOUTHS | constant | @aora-bot/engine | The thirteen mouths. Together they cover every state; see `STATE_MOUTH`. |
NOSE_DROP | constant | @aora-bot/engine | Where the nose sits below the eye line, in eye radii. |
NOSE_IDS | constant | @aora-bot/engine | Nose shapes for the line face. A trait, not an expression: chosen once per |
NOSES | constant | @aora-bot/engine | Sixteen-point polylines in eye-radius units, centred on their bounding box. |
PART_TONES | constant | @aora-bot/engine | How a part of a figure is painted. |
PathBuilder | constant | @aora-bot/engine | — |
PICKER_MARK_PX | constant | @aora-bot/react | — |
POKE_COOLDOWN_MS | constant | @aora-bot/react | Ignore a second poke inside this window, so a rapid click cannot stack flourishes. |
SEGMENT_FALLBACK | constant | @aora-bot/engine | Fallback chain for unknown ids, by segment. |
SETTLE_MS | constant | @aora-bot/react | How long a state has to hold still before a roster believes it. |
SHAPE_FAMILIES | constant | @aora-bot/engine | The roster on its shelves. |
SHAPE_IDS | constant | @aora-bot/engine | The roster in catalogue order, `mochi` (the default shape) first. |
SHAPE_SPACE | constant | @aora-bot/engine | Shape space is a square of this size; every generated path is normalised into it. |
SHAPE_WRAPPERS | constant | @aora-bot/engine | Wrappers for the shapes that dress up (a few of the roster); every other shape is a plain pair of brackets. |
SPAWN_STATE | constant | @aora-bot/react | The state an agent wears on its way in. |
SPRITE_FALLBACK_HOPS | constant | @aora-bot/engine | The manifest's own chain is followed at most this many hops. |
STACK_MAX_VISIBLE | constant | @aora-bot/react | — |
STACK_OVERLAP | constant | @aora-bot/react | Default overlap, as a fraction of one disc. |
STAGE_SOURCE_PX | constant | @aora-bot/react | Source marks render at a real size rather than 1px. |
STATE_BELT | constant | @aora-bot/engine | Which states hand their body over to a belt overlay. |
STATE_BLINK_MS | constant | @aora-bot/engine | Blink interval range. `null` means the state does not blink — either the |
STATE_BLUSH | constant | @aora-bot/engine | How strongly the cheeks are flushed in each state, 0..1. Only happy, success |
STATE_CUTE_EYES | constant | @aora-bot/engine | The cute face's expression sequence per state: the same cycle as |
STATE_CUTE_MOUTH | constant | @aora-bot/engine | The cute face's mouth per state. Most states have none: a mouth is there |
STATE_ENTRY_EFFECTS | constant | @aora-bot/engine | — |
STATE_EYE_SWITCH_MS | constant | @aora-bot/engine | Random interval range, in milliseconds, before switching to the next expression. |
STATE_EYE_TOPOLOGIES | constant | @aora-bot/engine | Expression sequence per state. The first entry is adopted on entry; the rest |
STATE_FACE_TUNE | constant | @aora-bot/engine | Per-state face adjustments layered over DEFAULT_FACE_TUNE. |
STATE_FACES | constant | @aora-bot/engine | The face inside the wrapper, for every state. |
STATE_FX | constant | @aora-bot/engine | The effect a state throws off: a mood's mark, or for the sixteen belt |
STATE_GAZE | constant | @aora-bot/engine | Gaze drift: amplitude in shape units and the interval between new targets. |
STATE_GROUP_IDS | constant | @aora-bot/engine | — |
STATE_GROUPS | constant | @aora-bot/engine | — |
STATE_MOUTH | constant | @aora-bot/engine | The mouth each state wears in line mode. |
STATE_MOUTH_TALK | constant | @aora-bot/engine | States whose mouth pulses open and shut, as though speaking. The pulse is |
STATE_SETTLE_TO | constant | @aora-bot/engine | States that are moments rather than conditions, and what they become when |
STATE_TAILS | constant | @aora-bot/engine | What follows the closing wrapper: the mood's effect, as a mark. Empty when the state has none. |
STYLE_IDS | constant | @aora-bot/engine | The style series that ship with the engine, in display order. |
SURFACE_LOCALES | constant | @aora-bot/surfaces | — |
surfaceEnUS | constant | @aora-bot/surfaces | Source of truth for the surfaces' strings. zh-CN mirrors these keys. |
surfaceZhCN | constant | @aora-bot/surfaces | — |
TEMPLATE_ERROR_KEYS | constant | @aora-bot/surfaces | Copy for each failure, so a host does not have to write its own. |
TEMPLATE_LIMITS | constant | @aora-bot/surfaces | Ceilings on the two free-text fields. |
TEMPLATE_MARK_PX | constant | @aora-bot/surfaces | Default size of the template's character. |
ticker | constant | @aora-bot/engine | — |
TOOL_ACTIVITIES | constant | @aora-bot/react | — |
TOOL_STATES | constant | @aora-bot/engine | Generic tool names, for hosts that report which tool is running rather |
UNREAD_BADGE_CAP | constant | @aora-bot/react | — |
VIEWBOX | constant | @aora-bot/engine | — |
VIEWBOX_STR | constant | @aora-bot/engine | — |
zhCN | constant | @aora-bot/react | — |
ZOOM_MAX | constant | @aora-bot/react | — |
ZOOM_MIN | constant | @aora-bot/react | — |
ZOOM_STEP | constant | @aora-bot/react | Step for the plus and minus buttons — eight presses from end to end. |
Next
- Components — every surface in one table
- Getting started — install, first character, three props