Repository navigation
Expand file tree
/
Copy pathINDEX.yml
More file actions
328 lines (304 loc) · 13.6 KB
/
Copy pathINDEX.yml
File metadata and controls
328 lines (304 loc) · 13.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# 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 # verb and skin syntax recovery
history: HISTORY.md # completed tasks; never selected from
retired: RETIRED.md # the queue TODO.md replaced (2026-10-01); never selected from
roadmap: docs/Completeness Roadmap.md
frozen_plans: # design references, not active state
- docs/VDJScript Reference Consolidation Plan.md
review_records:
- docs/Skin Manifest Recovery Tasks.md # requested implementation proposal; execution state stays in TODO.md
- docs/Repository Assessment and Prioritized Tasks.md
commands:
- just next-task
- just status
vdjscript:
primary:
- docs/VirtualDJ Reference.md
- docs/VDJScript Verbs.md
grammar:
- docs/Verb Tail and Linter Tasks.md # dated proposal; execution state stays in TODO.md
- docs/Skin Expansion.md # define/class/placeholders/conditions on 9246, with native fixtures
- docs/Skin Tag Dispatch.md # which tags 9246 recognizes where, and their roles (just skin-dispatch)
- docs/Offline Skin Host.md # native composition trees, class/coordinate resolution, offscreen Metal rendering
- docs/Native Skin Child Relationships.md # contextual native relationships, named slots, wrappers, partial manifest
- docs/Offline XML Parser.md # copied XML reader and skin-construction call traces
- docs/Offline Parser Host.md # copied-image fixed parser suite; saved live-baseline parity
- docs/VDJScript Grammar.md # read the summary before writing VDJScript
- docs/VDJScript Syntax Evidence.md # raw parser/binary evidence behind it
- docs/Runtime Argument Grammar Tests.md # H4 (closed with named limits): the common argument parser as executable predictions
- 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
button_editor: # category metadata, not behaviour evidence
- docs/Button Editor Catalog Audit.md
- docs/Button Editor Taxonomy.md
machine_index:
- docs/vdjscript-verb-index.json
record_store:
- docs/vdjscript-verbs.json
arguments: # what a verb's TAIL accepts — four sources
- tests/action-catalog.json # vendor prose: what a parameter MEANS (816 descriptions)
- tests/verb-arg-forms.json # probed: token vs nonsense control, per fixture
- tests/attested-tails.json # tails AND argument shapes (arity, token types, return evidence) from shipped scripts
- tests/binary-vocabularies.json # shared enumerations as binary structures (tables, switches)
- tests/verb-execute-forms.json # execute-position tails, two-baseline signatures
structural: # how the binary-derived tail evidence is bounded
- docs/Verb Tail Structural Discovery.md
- tests/action-contracts.json # per-verb class, capability, helper literal leads
- tests/action-contracts-debug.json # the call-graph addresses behind those leads
- tests/action-tail-leads.json # ranked Tier-2 tail queue, verb-store joined at query time
corpus:
- tests/vdjscript-corpus.json # vendor-written snippets, with provenance (factory mappings, Built-In XML, catalog, wiki, binary)
- tests/corpus-parse-results.json # every snippet through /query, outcomes classified
commands:
- just verb NAME # everything known about one verb, one screen
- just get-verb NAME
- just verb-arg-forms NAME # probed tail tokens for one verb
- just action-catalog --get NAME # the vendor's own description and parameters
- just action-catalog --cross-check # catalog vs probe vs corpus, three ways
- just attested-tails --verb NAME # tails used in shipped scripts
- just binary-vocab --get GROUP # a shared enumeration and its hidden members
- just binary-vocab --verb NAME # which enumerations a verb draws from
- just action-tail-leads --queue # ranked Tier-2 tail probe queue, settled tails removed
- just action-tail-leads --get NAME # one verb's literal leads, helper fan-out labelled
- just verb-contract NAME # class, capability, arg demands, helper candidates
- just verb-traces NAME # the call-graph addresses behind those candidates
- just script-corpus --verb NAME # vendor examples mentioning a verb
- just list-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
- just runtime-grammar # H4 argument-grammar captures; --audit joins them to branch families
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
- just fixtures # named states a probe can establish (10)
- just probe-arg-forms [--from-catalog|--from-corpus|--lexicon]
- just probe-execute-forms # WRITES: allowlisted settings verbs, restored and verified
- just corpus-parses # send every vendor snippet through /query
agent_integration:
primary:
- docs/MCP Server.md
note: >-
Serves the verb store, FX catalog, XML inventory, grammar, linters and the live
HTTP probe channel to any MCP client over stdio. Zero dependencies.
commands:
- just mcp-serve # serve the query layer to an MCP client over stdio
- just mcp-check # smoke-test every tool without a client
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 list-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/Quarantine/Reference - Slot FX.xml # personal, see examples/Pads/README.md
- examples/Pads/Quarantine/Reference - ColorFX.xml # personal, see examples/Pads/README.md
- examples/Pads/Quarantine/SAMPLER READ ONLY.xml # personal, see examples/Pads/README.md
- examples/Pads/Quarantine/Reference - Page Aware Sampler.xml # personal/superseded, see examples/Pads/README.md
built_in:
- examples/Pads/Built-In/README.md
- examples/Pads/Official-Addons/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/Quarantine/SAMPLER READ ONLY.xml # personal, see examples/Pads/README.md
- examples/Pads/Quarantine/Reference - Page Aware Sampler.xml # personal/superseded, see examples/Pads/README.md
fixtures:
- tests/Pads/Reference - Sampler Loaded Test.xml
- tests/sampler-contracts-9598.json
- tests/sampler-playback-9598.json
skin_runtime:
primary:
- docs/Skin Runtime Findings.md
- docs/Skin SDK.md
fixtures:
- tests/Skins/PlaceholderConditionTest/README.md
- tests/Skins/PlaceholderConditionTest/skin.xml
ghidra:
primary:
- docs/Runtime Memory Probe.md
note: >-
Persistent analyzed build-9246 project and raw evidence are in the sibling
/Users/nom/src/virtualdj-api-reference-resources/ghidra/ cache; read its README.md.
Project directory vdj_proj_9246, project name vdj_proj, program VirtualDJ-9246.arm64.
Reuse with -readOnly -noanalysis instead of importing and analyzing again.
plugin_sdk:
primary:
- docs/Plugin SDK.md
- docs/Runtime Memory Probe.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
findings:
- docs/Published Skin Findings.md # idioms from public skins, before they are folded in
- docs/Sysicon Binary Resolver.md # b9598 tested keys, unnamed atlas cells, internal selectors
- docs/Skin Schema Recovery.md # build-scoped button node ownership pilot; open gaps
- docs/Historical Installer Excavation.md # build-stamped compatibility history from older installers
status:
- docs/skin-xml-inventory.json
topic_tags:
- docs/topic-tags.json # hand-maintained input to `just topic`
examples:
- examples/Skins/ModularSkeleton/README.md
- examples/Skins/GraveRaver/README.md
built_in:
- examples/Skins/Built-In/README.md
- examples/Skins/Official-Addons/README.md
commands:
- just sysicon-atlas --cell H6 # one atlas cell, evidence tiers kept separate
- just sysicon-atlas --unnamed # wiki N/A cells, recovered keys and unresolved gaps
- just get-xml-element NAME
- just skin-schema button # outer/shared/child reads, unresolved paths; Tier 2
- just list-skin-elements [--family=X --undocumented --has-attr=X]
- just xml-stats
- just inventory
- just lint-skins
application_internals:
lyrics:
command: just lyrics-cache --evidence
inspect: just lyrics-cache --summary --db OFFLINE_EXTRA_DB
evidence: tests/lyrics-cache-9246.json
note: AudioSig and 18-byte LID, Chromaprint reduction, timestamped payload grammar; Tier 2.
linked_tracks:
list: just list-linked-tracks [--json] [--db PATH]
command: just linked-sid --evidence
calculator: just linked-sid --prepared --artist ARTIST --title TITLE --remix REMIX
evidence: tests/linked-sid-9246.json
note: Metadata FNV-1 SID; prepared-input calculator does not port tag cleanup.
primary:
- docs/Application Internals.md
related:
- docs/Resources.md
serato_tags:
primary:
- docs/Application Internals.md # "Serato tags in FLAC": which Serato Vorbis comments import (cues, loops, key) and which do not (grid, BPM); Scan/@Bpm is a period
related:
- docs/Configuration Options.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
- docs/Compiled Controller Definitions.md # controllers.dat: decode per build, diff from manifests
examples:
- examples/Mappers/README.md
- examples/Mappers/Official-Addons/README.md
related:
- examples/Pads/README.md
commands:
- just lint-mappers
- just controllers-vendor # decode the installed build into vendor/controllers/
- just controllers-archives
- just controllers-diff
settings:
primary:
- docs/Configuration Options.md
browser_filters:
primary:
- docs/Filter Syntax.md
samplerbanks:
primary:
- examples/Samplerbanks/Built-In/README.md
- examples/Samplerbanks/Official-Addons/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