INDEX.yml

# Routing index for agents and humans.
# Keep volatile coverage counts in docs/Official VDJScript Coverage Audit.md,
# not here.

# Cross-corpus entry point: `just topic <term>` aggregates verbs, effects, XML
# elements, real example files, docs, and quirks for one topic. Start here for
# "how do I do X"; the per-topic sections below are for drilling in.
topic_search:
  primary:
    - tools/topic.py
  commands:
    - just topic sampler
    - just topic colorfx [--format=json --limit=N]

# Evidence policy governs all claims. Read before recording any finding.
evidence:
  primary:
    - docs/Evidence Standards.md
  note: >-
    Three tiers: PROOF = direct observation of the running app (network protocol, HTTP
    interface, live pad tests, agent driving the window). LEADS = staff forums, unbacked
    binary analysis, official example files. Everything else is not recorded. Existence,
    kind, and behavior are separate claims; the binary can DISPROVE a name but cannot
    prove behavior.

tasks:
  queue: TODO.md
  roadmap: docs/Completeness Roadmap.md
  commands:
    - just next-task
    - just status

vdjscript:
  primary:
    - docs/VirtualDJ Reference.md
    - docs/VDJScript Verbs.md
  grammar:
    - docs/VDJScript Grammar.md          # read the summary before writing VDJScript
    - docs/VDJScript Syntax Evidence.md  # raw parser/binary evidence behind it
    - tests/Pads/Reference - Grammar Battery Test.xml
  status:
    - docs/Official VDJScript Coverage Audit.md
    - docs/VDJScript Local Test Tracker.md
  candidates:
    - docs/Undocumented VDJScript Candidates.md
  machine_index:
    - docs/vdjscript-verb-index.json
  record_store:
    - docs/vdjscript-verbs.json
  commands:
    - just get-verb NAME
    - just find-verbs TERM [--surface=X --section=X --status=X --format=json]
    - just put-verb NAME field=value ...
    - just next-incomplete-verb
    - just verb-stats
    - just grep-verb-docs NAME
    - just needs-test
    - just verb-index

live_probe:
  primary:
    - docs/HTTP Control Interface.md
  commands:
    - just vdj-up
    - just vdj-query 'SCRIPT'
    - just vdj-execute 'SCRIPT'
    - just verb-probe NAME          # does this name exist, and what kind is it?
    - just binary-verb NAME         # structured binary evidence for one name
    - just sweep-verb-existence     # refresh tests/verb-existence-sweep.json

remote_protocol:
  primary:
    - docs/Remote Protocol.md
  note: >-
    VirtualDJ Remote companion-app wire protocol (Bonjour _vdjremote8._tcp, port 4243,
    8JDV framing, VDJScript query subscriptions). Separate from the HTTP interface.
  commands:
    - python3 tools/vdjremote_dial.py DEVICE_IP
    - python3 tools/vdjremote_dial.py --decode tests/vdjremote-opener.bin
    - python3 tools/vdjremote_subscribe.py tests/vdjremote-opener.bin 'left:get_title' 'get_clock'

fx:
  primary:
    - docs/Effects Usage.md
    - docs/Effects Engines.md
    - docs/Native Effects.md
  catalog_data:
    - tests/fx-introspection-dump.json
  commands:
    - just get-fx EFFECT
    - just find-fx [--has-button=X --min-sliders=N --format=json]
    - just fx-stats
  fixtures:
    - tests/Pads/Reference - FX Introspection Test.xml
    - tests/Pads/Reference - FX Bank Test.xml
    - tests/Pads/Reference - Release FX Test.xml
    - tests/Pads/Reference - BeatGrid Command Test.xml
    - tests/Pads/Reference - Mix FX Query Test.xml
  status:
    - docs/VDJScript Local Test Tracker.md

pads:
  primary:
    - examples/Pads/README.md
    - docs/Pad Page XML.md
    - docs/Example Pad XML Pages.md
  examples:
    - examples/Pads/Reference - Slot FX.xml
    - examples/Pads/Reference - ColorFX.xml
    - examples/Pads/SAMPLER READ ONLY.xml
    - examples/Pads/Quarantine/Reference - Page Aware Sampler.xml  # personal/superseded, see examples/Pads/README.md
  built_in:
    - examples/Pads/Built-In/README.md
  tests:
    - tests/README.md
    - tests/Pads/README.md

sampler:
  primary:
    - docs/Example Pad XML Pages.md
    - examples/Pads/README.md
  examples:
    - examples/Pads/SAMPLER READ ONLY.xml
    - examples/Pads/Quarantine/Reference - Page Aware Sampler.xml  # personal/superseded, see examples/Pads/README.md
  fixtures:
    - tests/Pads/Reference - Sampler Loaded Test.xml

skin_runtime:
  primary:
    - docs/Skin Runtime Findings.md
    - docs/Skin SDK.md
  fixtures:
    - tests/Skins/PlaceholderConditionTest/README.md
    - tests/Skins/PlaceholderConditionTest/skin.xml

plugin_sdk:
  primary:
    - docs/Plugin SDK.md
  note: >-
    C++ native-code extension point, and the boundary where VDJScript results are
    still typed: GetInfo -> double, GetStringInfo -> text, SendCommand -> execute.
    Also the VDJPARAM_* model and the [autoparams] manifest used by all 173
    built-in plugins. Headers are third-party and NOT vendored (no license grant);
    fetch to vendor/, which is gitignored.
  related:
    - docs/HTTP Control Interface.md
    - docs/Undocumented VDJScript Candidates.md

skin_sdk:
  primary:
    - docs/Skin SDK.md
    - docs/Skin Waveforms.md
    - docs/Example Skin XML Objects.md
  status:
    - docs/skin-xml-inventory.json
  examples:
    - examples/Skins/ModularSkeleton/README.md
    - examples/Skins/GraveRaver/README.md
  built_in:
    - examples/Skins/Built-In/README.md
  commands:
    - just get-xml-element NAME
    - just find-xml-elements [--family=X --undocumented --has-attr=X]
    - just xml-stats
    - just inventory
    - just lint-skins

application_internals:
  primary:
    - docs/Application Internals.md
  related:
    - docs/Resources.md

stems:
  primary:
    - docs/Stem File Format.md
    - docs/Application Internals.md
  related:
    - docs/Lyrics AI and Skins.md

mappers:
  primary:
    - docs/Mapper XML.md
  examples:
    - examples/Mappers/README.md
  related:
    - examples/Pads/README.md
  commands:
    - just lint-mappers

samplerbanks:
  primary:
    - examples/Samplerbanks/Built-In/README.md
    - docs/Pad Page XML.md

video_skins:
  primary:
    - examples/VideoSkins/Built-In/README.md
  related:
    - docs/Skin SDK.md

tests:
  primary:
    - tests/README.md
    - tests/Pads/README.md
    - tests/Skins/README.md
  commands:
    - just check
    - just lint-skins
    - just lint-mappers

tools:
  primary:
    - tools/README.md