Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

AURA — Keyword Reference

Single-page lookup for every keyword, sigil, domain, enumerated value, standard key, and toolchain command in the AURA language. For full explanations, see flux.md, structure.md, and chages.md.


Sigils

Every sigil in AURA has exactly one meaning. No context-dependent overloading.

SigilNamePurpose
::Scope OpenerOpens a namespace block or declares a node block
->Value ArrowAssigns a literal value to a key
@ReferenceReferences a named entity anywhere in a document
##AnnotationQueryable comment — compiled into HAMI, not a code comment
--DividerVisual separator — no compile output
|Union PipeOne or more values across different domains or literals
?Optional MarkThis field may be absent
!Required MarkThis field must be present or compile fails
~Duration MarkSeparates start and duration in a time triple
[ ]List BracketTime triple [start, end, duration] or multi-ID list
>>Inherits FromExtend a template or base schema
*WildcardMatch all nodes in a namespace query
::Leap OperatorCross-boundary reference when combined with a file ID
%Custom MarkSuppresses unknown key linting for domain-specific fields

Boolean Literals

AURA uses media-native boolean values instead of true and false. true and false are accepted as synonyms for toolchain interoperability.

LiteralValueReads asAnalogy
live1true / onBroadcast: “going live” = active
dark0false / offStage: “going dark” = inactive
explicit  -> dark      ## not explicit
cleared   -> live      ## rights confirmed
featured  -> live      ## currently featured
published -> dark      ## still a draft

Reference Domains

All domains use the @domain/id or @domain/[id1, id2] pattern. Singular domain = one entity. Plural domain = multiple entities (compiles to array).

People

DomainFormResolves via
@person/idsingularinfo/people.aura or global cloud
@people/[a, b]pluralinfo/people.aura or global cloud
@author/idsingularalias for @person/id
@authors/[a, b]pluralalias for @people/[a, b]
@annotator/idsingularinfo/annotators.aura or global cloud
@annotators/[a,b]pluralinfo/annotators.aura or global cloud

Vocabulary

DomainFormResolves via
@genre/slugsingularmeta/genres.aura or global vocab
@genres/[a, b]pluralmeta/genres.aura or global vocab
@role/slugsingularmeta/roles.aura or global vocab
@roles/[a, b]pluralmeta/roles.aura or global vocab
@mood/slugsingularmeta/moods.aura or global vocab
@moods/[a, b]pluralmeta/moods.aura or global vocab

Content Files

DomainFormResolves via
@track/idsingulartracks/ folder by generated ID
@tracks/[a, b]pluraltracks/ folder by generated IDs
@episode/idsingularepisodes/ folder by generated ID
@episodes/[a, b]pluralepisodes/ folder
@scene/idsingularscenes/ folder by generated ID
@scenes/[a, b]pluralscenes/ folder
@variant/idsingularvariants/ folder by generated ID
@collection/idsingularcollection manifest file by ID
@season/idsingularseason manifest by ID
@member/idsingularanother member in the same collection
@member/id::node/pathsingularspecific node within another member

Time, Sync, and Tempo

DomainFormMeaning
@time/valuesingulara temporal point anchor in the current file
@tempo/idsingulara tempo node in the current file
@anchor/idsingulara hard sync anchor node

Music Attribution

DomainFormMeaning
@sample/idsingulara sample attribution node
@samples/[a, b]pluralmultiple sample nodes
@interpolation/idsingulara musical interpolation node
@interpolations/[a, b]pluralmultiple interpolation nodes

Annotation and Context

DomainFormMeaning
@explainer/idsingularan explanation node for any content node
@explainers/[a, b]pluralmultiple explainer nodes
@instruction/idsingulara processing instruction node
@instructions/[a, b]pluralmultiple instruction nodes

Events

DomainFormMeaning
@event/idsingulara condition-triggered signal node
@events/[a, b]pluralmultiple event nodes

Access

DomainMeaning
@access/openPublic — unrestricted, no authentication required
@access/lockedPrivate — authentication required, owner-only
@access/gatedConditional — subscription, payment, or role required
@access/embargoedTime-locked — transitions to open after embargo date
@access/archivedAccessible but retired — marked for historical access
@access/restrictedGeo- or rights-restricted — named territories only

Access cascade (least → most restrictive):

open < archived < restricted < gated < embargoed < locked

History

DomainMeaning
@history/currentThe latest take in this file’s ledger
@history/originThe first take ever recorded for this file
@history/tx3ab7kA specific take by generated ID (tx prefix)
@history/v1.0A named mark on the ledger
@history/~1One take before current (relative)
@history/~nn takes before current
@history/stream/nameThe head of a named development stream
@history/mainThe head of the main development stream
@history/take-id::pathA specific node’s state at a given take

Info and Meta Files

DomainMeaning
@info/peopleThe info/people.aura file for this project
@info/annotatorsThe info/annotators.aura file for this project
@info/metadataThe info/metadata.aura file for this project
@meta/genresThe meta/genres.aura file for this project
@meta/rolesThe meta/roles.aura file for this project
@meta/moodsThe meta/moods.aura file for this project

Media Assets

DomainFormMeaning
@art/idsingularA static image art asset (cover, poster, show banner)
@arts/[a, b]pluralMultiple art assets
@motion/idsingularAn animated motion cover or looping video asset
@motions/[a, b]pluralMultiple motion assets
@trailer/idsingularA promotional trailer or preview clip
@trailers/[a, b]pluralMultiple trailers

Industry Entities

DomainFormResolves via
@studio/idsingularinfo/studios.aura or global cloud studio registry
@studios/[a, b]pluralinfo/studios.aura or global cloud
@label/idsingularinfo/labels.aura or global cloud label registry
@labels/[a, b]pluralinfo/labels.aura or global cloud

Content Availability

DomainFormMeaning
@watch/idsingularStreaming platform availability entry
@watch/[a, b]pluralMultiple streaming platforms
@buy/idsingularPurchase availability entry with pricing
@buy/[a, b]pluralMultiple purchase options
@rent/idsingularRental availability entry with pricing and window
@rent/[a, b]pluralMultiple rental options
@download/idsingularDownload availability entry
@download/[a, b]pluralMultiple download options

Cloud

DomainMeaning
@aduki.org/Global cloud URI — all domains available via path

Reserved (Future)

DomainMeaning
@thread/idFuture — parallel thread support (not yet implemented)
@parallel/idFuture — parallel execution node (not yet implemented)

Namespace Blocks

Namespace blocks open with :: and contain key-value pairs or sub-nodes.

Core Namespaces

KeywordPurpose
schema::Document-level metadata: root, kind, lang, annotator
manifest::Content identity: name, creator, released, access, etc.
directives::Compiler / engine directives for this file
meta::Descriptive metadata block (genre, tags, etc.)
collection::Collection root block inside a manifest file
members::Member list inside a collection block
seasons::Season list inside a series manifest
related::Relational links to other works
links::External URL block inside a person or manifest node
info::Inline info reference block
namespace::Project or folder namespace descriptor (in namespace.aura)
exports::Re-exports of sub-namespaces in root namespace.aura
availability::Content platform availability block in a manifest

People and Annotators

KeywordPurpose
people::Person definitions block (canonical namespace)
persons::Alias for people:: — identical compile output
authors::Alias for people:: — identical compile output
annotators::Annotator definitions block in info/annotators.aura

Vocabulary - meta/ and info/ files

KeywordPurpose
genres::Genre vocabulary block in meta/genres.aura
roles::Role vocabulary block in meta/roles.aura
moods::Mood vocabulary block in meta/moods.aura

Media Assets and Industry Entities

KeywordPurpose
arts::Art asset block in info/arts.aura
motions::Motion cover block in info/arts.aura
trailers::Trailer and preview block in info/arts.aura
studios::Studio entity block in info/studios.aura
labels::Label entity block in info/labels.aura
watch::Streaming availability block in info/availability.aura
buy::Purchase availability block in info/availability.aura
rent::Rental availability block in info/availability.aura
download::Download availability block in info/availability.aura

Configs (Non-Compiled)

KeywordPurpose
llm::LLM provider definitions in configs/llm.aura
stores::Remote store origins in configs/stores.aura
accounts::Cloud identity credentials in configs/account.aura
ignore::History exclusion list in configs/ignore.aura

Support Node Namespaces

Declared inside support:: blocks within content files.

KeywordPurpose
support::Container for all support nodes in a file
segments::Musical/structural section markers
instruments::Instrument activity windows
chapters::Navigable chapter divisions
credits::Time-windowed contributor credit windows
translations::Language overlay nodes for content nodes
moods::Mood and emotional annotation windows
rights::Licensing and territorial boundary nodes
slots::Advertising insertion point nodes
anchors::Hard synchronization recovery point nodes
tempo::Tempo windows affecting lyric sync
samples::Audio sample attribution nodes
explainers::Explanation and gloss nodes
interpolations::Re-recorded composition element attribution nodes
instructions::Processing directive nodes
events::Condition-triggered signal nodes

Content Node Types

Content nodes carry renderable text payloads.

TypeGranularity LevelUsed In
actMacroFilm, stage, long-form video
sceneMacroFilm, music video, animation, documentary
shotMacroFilm, music video — camera unit
verseMacroSong lyrics
chorusMacroSong lyrics
bridgeMacroSong lyrics
introMacroSong, podcast, speech
outroMacroSong, podcast, speech
hookMacroSong lyrics
dropMacroElectronic music
interludeMacroSong, album
breakdownMacroSong
pre-chorusMacroSong lyrics
post-chorusMacroSong lyrics
chapterMacroAudiobook, podcast, documentary
segmentMacroSpeech, lecture, panel
sectionMacroAny long-form
lineMesoAll content types
dialogueMesoFilm, series, podcast — speaker-attributed
wordMicroAll content types
tokenMicroTranscription systems
syllableNanoSong, speech
phonemeNanoSpeech, accessibility
letterPicoAnimation, 60fps rendering
characterPicoNon-Latin scripts

Support Node Types

Support nodes carry metadata without a renderable text payload.

TypeATOM ClassPurpose
segment0x02Musical/structural section marker
instrument0x03Instrument activity window
chapter0x04Navigable division (audiobook, podcast, film)
credit0x05Time-windowed contributor credit
translation0x06Language overlay for a content node
mood0x07Emotional or tonal annotation window
rights0x08Licensing or territorial boundary
slot0x09Advertising insertion point
anchor0x0AHard synchronization recovery point
annotator0x0BAnnotator attribution node
vocab0x0CGenre, role, or mood vocabulary node
event0x0DCondition-triggered signal node
tempo0x0EBPM and time-signature window; affects lyric sync
sample0x0FAudio sample attribution (source, kind, clearance)
explainer0x10Explanation or gloss for any node
interpolation0x11Re-recorded composition element attribution
instruction0x12Processing directive to engine or player
access0x13Content visibility and permission level
history0x14Versioned take and delta chain provenance
art0x15Static cover art or image asset (manifest-level)
motion0x16Animated motion cover or looping video (manifest-level)
trailer0x17Promotional trailer or preview clip (manifest-level)
studio0x18Production studio entity with ownership hierarchy
label0x19Record label or publishing imprint with hierarchy
watch0x1AStreaming platform availability entry
buy0x1BPurchase availability entry with pricing
rent0x1CRental availability entry with pricing and window
download0x1DDownload availability entry

Standard Keys

KeyMeaning
nameHuman-readable title of this node (legacy person field; prefer first+last)
firstGiven name of a person node
middleMiddle name(s) of a person node — optional
lastFamily name of a person node — optional for mononyms
screenShort on-screen identifier for captions, dialogue, mini-player
kindType or category within this node’s class (also person kind)
timeTemporal interval of this node
durationTotal length as a standalone declared value
textText payload of a content node
localeIETF BCP 47 language tag
scriptExplicit script code (Latn, Arab, Cyrl, etc.)
labelShort human-readable tag or marker
genreGenre descriptor — may be a union list
releasedISO 8601 release date
territoryGeographic scope
versionSemantic version string
creatorPrimary creator reference
speakerActive speaker reference at this node
speakersMultiple speaker references at this node
castCast list for a scene or act
hostPodcast or show host reference
guestGuest speaker reference
languagePrimary language of this document
countryCountry of origin
cityCity of origin
bornDate of birth for a person node
bioBiography or description text
noteAnnotation or editorial note
sourceOrigin indicator
storeSource data store URI
hashContent hash for integrity verification
indexOrdinal position within a collection
countQuantity field
mainPrimary entry in a credits block
vocalsVocalist reference in a credits block
producerProducer reference in a credits block
writerWriter reference in a credits block
mixerMixing engineer reference
masterMastering engineer reference
directorDirector reference
editorEditor reference
narratorNarrator reference
energyNormalized intensity float 0.0 — 1.0
bpmBeats per minute
gridTime signature (4/4, 3/4, 6/8, etc.)
keyMusical key
isrcInternational Standard Recording Code
iswcInternational Standard Musical Work Code
licenseLicense identifier
expiresExpiry date for a rights or license field
showParent show name for episodic content
seasonSeason index or identifier
episodeEpisode index or identifier
synopsisLong-form description
tagsFree-form tag list
linksExternal link block
rolesRole list for a person node
familyInstrument family classification
activeList of active time windows (instrument nodes)
stemReference to a discrete audio stem file
thumbnailRemoved — use cover -> @art/id for chapter and episode art
artworkRemoved — use cover -> @art/id in manifest
confidenceFloat confidence value for inferred annotations
formatFile format or encoding
codecAudio or video codec identifier
ratingContent rating (explicit, clean, etc.)
legalLegal name of a person
marksSerialized OCPN marking vector snapshot
auraAURA source file reference for a collection member
atomCompiled .atom file reference for a member
hamiCompiled .hami file reference for a member
atlasCompiled .atlas file reference for a variant mapping
accessContent access level — @access/ domain value
embargoDate when @access/embargoed transitions to @access/open
liveBoolean true literal — “going live”
darkBoolean false literal — “going dark”
publishedBoolean publish flag (live = published, dark = draft)
featuredBoolean editorial featuring flag
explicitBoolean explicit content flag
clearedBoolean rights clearance flag (sample, interpolation)
authored@history/take-id — the take when this node was first recorded
revised@history/take-id or mark — the take when last changed
annotatorSingle annotator reference for this file or node
annotatorsMultiple annotator references for this file (requires plural domain)
contactContact address for a person or annotator node
used-atTime point in this work where a sampled element appears
triggerCondition expression that fires an event node
signalSignal path emitted when an event fires
targetReference to the node this instruction or explainer applies to
conditionOptional @event/id that activates an instruction
elementMusical element type for an interpolation node
writersPeople who wrote the interpolated element
langLanguage of an explainer or translation node
viaAnnotator or person responsible for an annotation
blockedTerritory or boolean blocking indicator for a rights node
holderRights holder — person or legal entity
scopeRights coverage scope (document, window, etc.)
maxMaximum duration for an ad slot
performerPerformer reference for an instrument node
parentParent entity reference for studio/label inheritance hierarchy
foundedISO 8601 founding date for a studio or label entity
logo@art/id reference to a studio or label logo
websiteExternal URL for a studio, label, or entity
urlCloud or platform URL — art/motion/trailer asset URLs and platform availability
ratioAspect ratio of an art or motion asset (square, 16:9, etc.)
loopBoolean — live = loops, dark = plays once (motion/trailer)
platformPlatform name for availability nodes (Netflix, Spotify, etc.)
pricePrice string with currency (e.g., “9.99 USD”) for buy/rent
currencyISO 4217 currency code for buy/rent pricing
windowRental access period (e.g., “30d”, “48h”) for rent nodes
drmDRM status — live = DRM protected, dark = DRM free
qualityPlayback quality (4k, hd, sd, lossless, audio-only)
providerLLM provider name in configs/llm.aura
modelLLM model identifier in configs/llm.aura
endpointLocal LLM endpoint URL for ollama or self-hosted providers
auth@account/id reference for credential lookup
envEnvironment variable name(s) for credential resolution
cover@art/id reference to primary cover art
motion@motion/id reference to motion cover asset
trailer@trailer/id reference to primary trailer
studio@studio/id reference to production studio
label@label/id reference to record label

Approved Hyphenated Keys

Hyphens are permitted only when no single word cleanly carries the full meaning.

KeyReason
pre-chorusRecognized song section with no single-word equivalent
post-chorusSame as above
lead-vocalDistinguishes from backing, harmony, and ad-lib roles
co-writerThe co- prefix is the only way to express co-authorship
voice-overAn established compound industry term
rights-holderHolder alone is ambiguous; rights context is required
fill-policyPolicy alone is ambiguous; fill-policy is the ad term
mood-vocabularyDirective key for a vocabulary declaration block
aura-refAURA source file reference within a collection member block
persons-refPeople index reference within a collection manifest

Media Kinds

Every AURA document declares its kind in the schema:: block.

Audio

ValueMeaning
audio::musicAlbum, EP, single, or musical work
audio::podcastPodcast episode or show
audio::audiobookSpoken word with chapters
audio::liveLive recording

Video

ValueMeaning
video::movieFeature or short film
video::seriesEpisodic series
video::podcastVideo podcast episode
video::documentaryDocumentary work
video::musicMusic video
video::liveLive performance or concert
video::shortShort-form content under 10 minutes

Mixed

ValueMeaning
mixed::albumVisual album — audio and video tied
mixed::interactiveInteractive or branching media

Enumerated Values

Segment Kinds

Used in segments:: support nodes under the kind key.

intro | verse | pre-chorus | chorus | post-chorus | bridge |
drop | breakdown | outro | interlude | instrumental | transition |
ad-lib | hook | custom

Sample Kinds

Used in samples:: support nodes under the kind key.

loop | stab | chop | vocal | melodic | rhythmic | atmospheric | custom

Interpolation Elements

Used in interpolations:: support nodes under the element key.

melody | chord-progression | lyric | rhythm | hook | bassline | custom

Explainer Kinds

Used in explainers:: support nodes under the kind key.

cultural | lyrical | historical | technical | translation | annotation | custom

Tempo Types

Used in tempo:: support nodes under the type key.

steady | increasing | decreasing | variable | free

Instruction Kinds

Used in instructions:: support nodes under the kind key.

loop | skip | jump | repeat | fade | crossfade | trim | mute | custom

Instruction Fade Types

Used under type in fade instructions.

linear | exponential | logarithmic

Event Kinds

Used in events:: support nodes under the kind key.

ambient | reactive | interactive | editorial | broadcast | custom

Event Trigger at Values

When within a trigger’s interval the event fires.

onset | offset | peak | @time/value

Anchor Kinds

Used in anchors:: support nodes under the kind key.

hard | verified | soft

Rights Scope

Used in rights:: support nodes under the scope key.

document | window

Ad Slot Fill Policy

Used in slots:: support nodes under the fill-policy key.

optional | required | house

Ad Slot Kinds

Used in slots:: support nodes under the kind key.

pre-roll | mid-roll | post-roll

Inference Source

Used in moods:: support nodes under the source key.

authored | hybrid | inferred

History Vocabulary

AURA-native versioning terms. Git verbs (commit, branch, tag, push, etc.) are not used.

AURA termMeaningAnalogy
takeAn immutable snapshot of the current document stateStudio take (“take one”)
markA human-readable name attached to a specific takeCue mark, chapter mark
streamA named parallel line of developmentAudio recording stream
mainThe primary line of development within a projectMain recording session
deltaThe set of changes between any two takesSignal differential
rewindRestore the draft to a previous take (non-destructive)Tape rewind
mixCombine two streams into oneAudio mixing
ledgerThe full ordered and permanent history of all takesProduction ledger
holdPark the current draft without recording a take“Put on hold”
recallLoad a specific take as the working sessionSession recall
releasePublish the current take to cloud distributionReleasing a record
syncPull the latest released state from cloudSyncing from master archive
dubCreate an independent full-history copy of the projectDubbing a tape
draftThe current uncommitted working stateWorking draft before a take
originThe first take ever recorded for a fileThe first session
currentThe latest take in the ledgerNow playing

ID Prefix Reference

Every AURA ID begins with a type prefix. Prefixes are one or two characters.

PrefixClassNotes
ttrackAn audio music track
ccollectionAlbum, EP, single, or compilation manifest
ppersonA contributor, creator, or any named individual
vvariantAn alternate version of any content file
epepisodeA single episode in a series or podcast
snseasonA season within a series or podcast
sseason-itemA season file within a series folder
tvseriesA TV, podcast, or episodic series root manifest
ffilmA feature or short film
dcdocumentaryA documentary work
pcpodcastA podcast series root manifest
ananimationAn animated or anime series root manifest
spspeechA speech, lecture, talk, or commencement address
bbookAn audiobook
mvmusic videoA music video
sgsingleA single release
cyinterviewA discrete interview file
rrightsA rights or licensing declaration file
iinfoAn info document (metadata, credits, labels)
txtakeA history take (immutable version snapshot)
ststudioA production studio or broadcast network entity
lblabelA record label or publishing imprint
arartA static image art asset (cover art, poster)
momotionAn animated motion cover or looping video asset
trtrailerA promotional trailer or preview clip

ID format: {prefix}{6 alphanumeric chars} using charset a-z0-9.

t7xab3c    <- track
p4xt9k2    <- person
ep7xb3n    <- episode
c8xab3d    <- collection
tx3ab7k    <- take

ATOM Node Class Reference

The node_class byte in ATOM’s interval tree entry allows stabbing queries to filter by node type at SIMD evaluation time.

ClassTypeDescription
0x01contentMacro, Meso, Micro, Nano, Pico content nodes
0x02segmentMusical/structural section marker
0x03instrumentInstrument activity window
0x04chapterNavigable chapter division
0x05creditTime-windowed contributor credit window
0x06translationLanguage overlay for a content node
0x07moodEmotional or tonal annotation window
0x08rightsLicensing or territorial boundary
0x09slotAdvertising insertion point
0x0AanchorHard synchronization recovery point
0x0BannotatorFirst-class annotator attribution node
0x0CvocabGenre, role, or mood vocabulary node
0x0DeventCondition-triggered signal node
0x0EtempoBPM and time-signature window
0x0FsampleAudio sample attribution node
0x10explainerExplanation or gloss node
0x11interpolationRe-recorded composition element node
0x12instructionProcessing directive node
0x13accessContent visibility and permission node
0x14historyVersioned take and delta chain node
0x15artStatic cover art or image asset node
0x16motionAnimated motion cover or looping video node
0x17trailerPromotional trailer or preview clip node
0x18studioProduction studio entity node
0x19labelRecord label or publishing imprint entity node
0x1AwatchStreaming platform availability node
0x1BbuyPurchase availability node
0x1CrentRental availability node
0x1DdownloadDownload availability node

Toolchain Commands

All commands are issued via the aura CLI.

ID Generation

CommandOutputDescription
aura generate trackt7xab3cGenerate a new track ID
aura generate personp4xt9k2Generate a new person ID
aura generate episodeep7xb3nGenerate a new episode ID
aura generate collectionc8xab3dGenerate a new collection ID
aura generate annotatorp9xb3mnGenerate a new annotator ID
aura generate seasonsn2kr9lGenerate a new season ID
aura generate variantv3qr7stGenerate a new variant ID

History(.history)

CommandDescription
aura takeRecord current draft as a new immutable take
aura take "message"Record a take with a descriptive message
aura mark nameAttach a human-readable name to the current take
aura rewind take-idRestore draft to a specific take by ID
aura rewind mark-nameRestore draft to a named mark
aura rewind ~nRestore draft n takes before current
aura stream open nameOpen a new named development stream
aura stream close nameClose and archive a named stream
aura stream listList all open streams
aura mix stream-nameMix a stream into the current stream
aura delta take-a take-bShow all changed nodes between two takes
aura delta mark-name currentShow changes between a mark and the current state
aura ledgerShow the full take history for this file
aura ledger node/pathShow the take history for a specific node
aura holdPark the current working draft without taking
aura hold restoreRestore a previously parked draft
aura releasePublish the current take to @aduki.org distribution
aura syncPull the latest released state from @aduki.org
aura dubCreate an independent full-history copy of the project

Compilation

CommandDescription
aura compileCompile .aura source files to .atom and .hami artifacts
aura validateValidate syntax and reference resolution without compiling
aura lintCheck for style violations and best practice warnings

Info and Meta Files : (Base)

info/ Folder — Project-Specific Data

FileNamespaceRequired
info/people.aurapeople::Always
info/annotators.auraannotators::Always
info/metadata.auraschema:: + manifest::Always
info/credits.auracredits::Albums, films
info/rights.aurarights::When applicable
info/labels.auralabels::Music projects with label info
info/studios.aurastudios::Film, TV, animation
info/arts.auraarts:: + motions:: + trailers::When media assets declared
info/availability.aurawatch:: + buy:: + rent:: + download::When availability declared
info/releases.auravariesWhen applicable

namespace.aura Files — Project and Folder Manifests

FilePurpose
namespace.aura (root)Project entry point: declares namespace, exports sub-namespaces
info/namespace.auraLists all files contained in the info/ folder
meta/namespace.auraLists all files contained in the meta/ folder
tracks/namespace.auraLists all tracks with their names
episodes/namespace.auraLists all episodes
scenes/namespace.auraLists all scene files

configs/ Folder — Non-Compiled Toolchain Config

Never compiled to .atom / .hami. Never tracked by .history/.

FileNamespacePurpose
configs/llm.aurallm::LLM provider definitions for editor integration
configs/stores.aurastores::Remote store origins and authentication references
configs/account.auraaccounts::Cloud identity — reads from .env or env variables
configs/ignore.auraignore::Paths excluded from .history/ tracking

meta/ Folder — Vocabulary Definitions

Vocabulary nodes use slug IDs (e.g. electronic, main-artist), not generated hex IDs.

FileNamespaceRequired
meta/genres.auragenres::When vocab used
meta/roles.auraroles::When vocab used
meta/moods.auramoods::When vocab used

Vocabulary Resolution Cascade

When the engine encounters a @genre/, @role/, or @mood/ reference:

  1. Local meta/ folder for this project
  2. Parent catalog’s meta/ folder (if inside a catalog)
  3. Global platform vocabulary at @aduki.org/genre/, @aduki.org/role/, @aduki.org/mood/
  4. Not found → stored as string literal, compile warning in strict mode

Signal Path Convention

Used in event:: nodes under the signal key. Multiple signals separated by |.

lights::dim(0.1)               <- dim lights to 10%
lights::colour(#0a1628)        <- set light colour
lights::strobe                 <- strobe
lights::fade(white, 30s)       <- fade to white over 30 seconds
haptic::pulse(80ms)            <- haptic motor burst
ar::overlay(frost)             <- AR frost overlay
display::credits               <- show credits display
player::insert-ad              <- trigger ad insertion
player::pause                  <- pause playback
player::skip                   <- skip current segment
iot::gpio(17, HIGH)            <- raw GPIO for custom hardware

Format: subsystem::action(params) where params are optional.


Time Notation Quick Reference

## Full triple — explicit
time -> [22s, 1m10s, 48s]

## Range — start ~ end (engine derives duration)
time -> 22s~1m10s

## Duration offset — start + duration (engine derives end)
time -> 2m30s+28s

## Point anchor (no duration)
sync-point -> @time/1m32s

## Cross-file time reference
sampled -> @track/t9vkx7q @time/2m44s

Time units: s (seconds), m (minutes), h (hours), ms (milliseconds). Full timestamps for film/video: HH:MM:SS, HH:MM:SS.mmm.


@history Reference Quick Reference

@history/current                  <- latest take
@history/origin                   <- first take ever
@history/premiere                 <- named mark
@history/v1.0                     <- another named mark
@history/~1                       <- one take back
@history/~3                       <- three takes back
@history/tx3ab7k                  <- specific take by ID
@history/stream/translation-fr    <- head of a stream
@history/main                     <- head of main stream

## Node state at a specific take
@history/v1.0::verse/one
@history/~3::chorus/one/line/two
@history/premiere::credits

## Global cloud form
@aduki.org/track/t7xab3c/history/premiere
@aduki.org/track/t7xab3c/history/~1::verse/one

AURA Keyword Reference — Engine Documentation See flux.md for syntax, structure.md for structure, changes.md for engine internals.