Set up structures to document Opus Quad use.

Deep-Symmetry · Jun 2, 2024 · 01d252d · 01d252d
1 parent 6bbd72c
commit 01d252d
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 0 deletions.
diff --git a/doc/modules/ROOT/nav.adoc b/doc/modules/ROOT/nav.adoc
@@ -20,6 +20,7 @@
 ** xref:Shows_PhraseTriggers.adoc[Phrase Triggers]
 ** xref:Shows_RawTriggers.adoc[Raw Triggers]
 * xref:Link.adoc[Working with Ableton Link]
+* xref:OpusQuad.adoc[Working with the Opus Quad]
 * xref:ObsOverlay.adoc[OBS Streaming Overlays]
 * xref:Debugging.adoc[Debugging and Sharing]
 * xref:Integration.adoc[Integration Examples]

diff --git a/doc/modules/ROOT/pages/OpusQuad.adoc b/doc/modules/ROOT/pages/OpusQuad.adoc
@@ -0,0 +1,14 @@
+= Working with the Opus Quad
+include::partial$PagePreamble.adoc[]
+
+Even though the Opus Quad does not attempt to truly implement the Pro DJ Link protocol, it is now possible to use many Beat Link Trigger features with that hardware thanks to a lot of work by https://github.com/cprepos[@cprepos] and https://github.com/kyleawayan[Kyle Awayan].
+
+The key to getting useful results with the Opus Quad, since it is unable to send most of the metadata that BLT needs, is to create metadata archive files for any USBs that you want to use, and attach them to the appropriate USB slots in the <<Players.adoc#,Player Status window>>.
+
+## Creating Metadata Archives
+
+TODO: Explain
+
+## Attaching Metadata Archives
+
+TODO: Explain
diff --git a/doc/modules/ROOT/pages/Players.adoc b/doc/modules/ROOT/pages/Players.adoc
@@ -190,6 +190,8 @@ it, in which case you will be able to control those.
 
 The CDJ-3000 will let you load tracks, but it does not support Fader
 Start either, so you won't be able to start or stop them playing.
+
+The Opus Quad is even more limited, but when you working with one this menu is instead used to <<OpusQuad.adoc#attaching-metadata-archives,attach metadata archives>> so that BLT can work with that hardware despite its lack of support for the actual Pro DJ Link protocol.
 ====
 
 During pre-show and after-show situations, when there is no DJ on

diff --git a/doc/modules/ROOT/pages/README.adoc b/doc/modules/ROOT/pages/README.adoc
@@ -95,6 +95,8 @@ Triggers window opens, in the same configuration that you left it the
 last time you used the program, and any Show files you had open will
 be reopened as well.
 
+TIP: If you want to use Opus Quad hardware, even though it doesn’t really support the Pro DJ Link protocol, you can now use most BLT features with it as long as you create and attach metadata archives of any USBs you are using, as discussed <<OpusQuad.adoc#,here>>,
+
 [[command-line-arguments]]
 === Command-Line Arguments