From aa9f55d2b5c9228563a6251a613172292ca18e89 Mon Sep 17 00:00:00 2001 From: jbaylies Date: Sun, 7 Jan 2024 23:08:10 -0500 Subject: [PATCH] add moar --- docs/content/attrib.rst | 4 ++- docs/content/install.rst | 16 +++++------ docs/content/menubar.rst | 30 +++++++++++++++++++++ docs/content/metro.rst | 58 +++++++++++++++++++++++++++++++++++++++- docs/content/startup.rst | 2 +- 5 files changed, 99 insertions(+), 11 deletions(-) create mode 100644 docs/content/menubar.rst diff --git a/docs/content/attrib.rst b/docs/content/attrib.rst index 1f2b4a00..73e89dbe 100644 --- a/docs/content/attrib.rst +++ b/docs/content/attrib.rst @@ -30,7 +30,9 @@ SousaFX Max Patches - `Rusty Allred `_, `Trond Lossius `_, `Timothy Place `_, `J Curtis `_ // 4th-order `Linkwitz Riley `_ Crossover Filter -- `nik gaffney `_ // `do it home `_ & `Prompts for Programmers `_ +- `zzkt `_ // `do it home `_ & `Prompts for Programmers `_ + +- Christopher Dobrian // `taptempo max patch `_ SousaVFX Max Patches diff --git a/docs/content/install.rst b/docs/content/install.rst index 11b08e3a..c47e573e 100644 --- a/docs/content/install.rst +++ b/docs/content/install.rst @@ -6,13 +6,13 @@ Required 1. `Download Max `_ from Cycling '74. -2. Open Max, click "Menubar > Max > Preferences...", and set the following preferences: +2. Open Max, click ``Menubar > Max > Preferences...``, and set the following preferences: - Interface > Restore Windows on Launch [uncheck] - Mixer > Enable Mixer Parallel Processing [check] -3. Click "Menubar > File > Show Package Manager", and install the following packages: +3. Click ``Menubar > File > Show Package Manager``, and install the following packages: - ease @@ -24,7 +24,7 @@ Required 4. There will probably be a bunch of operating system security settings that you have to enable for Max as well. -5. `Download sousastep `_ to your `~/Documents/Max 8/Projects/` folder. `sousastep` contains SousaFX, SousaVFX, and SousaPlayback. +5. `Download sousastep `_ to your ``~/Documents/Max 8/Projects/`` folder. ``sousastep`` contains SousaFX, SousaVFX, and SousaPlayback. .. note:: @@ -33,9 +33,9 @@ Required Optional -------- -6. To open the SousaPlayback template project "~/Documents/Max 8/Projects/sousastep/default/SousaPlayback template Project/SousaPlayback template.als", `download Live Suite `_ from Ableton. +6. To open the SousaPlayback template project ``~/Documents/Max 8/Projects/sousastep/default/SousaPlayback template Project/SousaPlayback template.als``, `download Live Suite `_ from Ableton. - Open Live, click "Menubar > Live > Settings...", and set the following preferences: + Open Live, click ``Menubar > Live > Settings...``, and set the following preferences: - Audio > Audio Device [set preferred interface] @@ -53,7 +53,7 @@ Optional The SousaPlayback template project will not work after Ableton Live's `free trial `_ ends. The template uses a few Max for live devices that require Ableton Live 11/12 `Suite or Standard with the Max for Live addon `_. -7. Download Black Octopus Sound's `excellent free samples `_ and place `Black Octopus Sound - Free Samples Bundle` into "~/Documents/Max 8/Projects/sousastep/SousaFX/default/SousaPlayback template Project/Clips/" +7. Download Black Octopus Sound's `excellent free samples `_ and place `Black Octopus Sound - Free Samples Bundle` into ``~/Documents/Max 8/Projects/sousastep/SousaFX/default/SousaPlayback template Project/Clips/`` Updating -------- @@ -61,8 +61,8 @@ Updating .. important:: When updating to new versions of SousaFX, - copy all files from "~/Documents/Max 8/Projects/sousastep/SousaFX/data/" - to the new version's "sousastep/SousaFX/data/" folder + copy all files from ``~/Documents/Max 8/Projects/sousastep/SousaFX/data/`` + to the new version's ``sousastep/SousaFX/data/`` folder to ensure that your presets are carried over. Recommended Free Plugins diff --git a/docs/content/menubar.rst b/docs/content/menubar.rst new file mode 100644 index 00000000..73478cf1 --- /dev/null +++ b/docs/content/menubar.rst @@ -0,0 +1,30 @@ +Menubar +======= + + - About SousaFX… + + - 🔊 SousaFX + - 🌊 Modulation + - 🦅 Attack + - 🪴 Sustain + - ⚔️ Envelope Crossfade + - 📬 Post-Crossfade + - ⏳ Delay & Reverb Sends + - ♻️ Loopers + - 🥾 Kick Ducker + - 🎧 Monitor Mix + - ⚙️ Settings + - 🎮 Controller Bindings/B + - ☠️ Deadzones + + - 🥁 Tempo/T + + - 🎛 MIDI IO/{ + - 🎙 Audio IO/} + - 🔈 Audio Status.../| + - 🛟 Support + + - 📙 Documentation + - 🐞 Report a Bug; + - 👾 Join the Discord; + - 🥺 Donate; diff --git a/docs/content/metro.rst b/docs/content/metro.rst index d953d00f..bb73249a 100644 --- a/docs/content/metro.rst +++ b/docs/content/metro.rst @@ -4,4 +4,60 @@ Metronome .. image:: media/metro.png :width: 60% :align: center - :alt: metro \ No newline at end of file + :alt: metro + +Tempo Source +------------ + +- Tap Tempo: Tempo set by tapping. Metronome resets when unmuted, so be sure to unmute on the downbeat. LFO retriggered by "transient detection", and by unmuting the metronome + + This is best when playing freely, without a click. + +- Ableton's Tempo: Tempo, LFO, and Metronome all locked to Ableton Live. + + This is best when playing along with clips in Live. + +- Metronome's Tempo When On: When the metronome's muted, the LFO is retriggered by transient detection. When metronome is active, the LFO is locked to the metronome. The metronome resets when unmuted, so be sure to unmute on the downbeat. + + This is best when playing with folks who can monitor a click. + For example: The drummer can improvise a groove at any tempo, + and you can tap tempo along. Then you can unmute the metronome + on the downbeat, the LFO will lock to the metronome, + and the drummer can listen to the click. + +- Metronome's tempo always: The metronome is free-running and isn't reset when unmuted. The LFO is locked to the metronome while muted and unmuted. + + tbh i never use this one + +Audio Input or Live Link +------------------------ + +When the Tempo Source is Ableton's Tempo, this setting picks wether Ableton's sync signal comes from the "phasor1n" Max For Live device, or Live Link. + +Live Link is simple to set up, but gets offbeat if the tempo changes suddenly. + +The "phasor1n" Max For Live device sends a 1-bar-long phasor audio signal out of Live and into Max. It's always in time, but you have to set up the audio route from Live to Max yourself, and you have to be sure to never route this signal to a speaker, or else you'll hear a pop once per bar. + +Which Beats +----------- + +Pick which beats the metronome should emit a click on. + +- click on 1 & 3 + +- click on 1 2 3 & 4 + +Continuous Accelerando +---------------------- + +The continuous accelerando affects the Metronome, Modulation, Loopers, and Drum Clips. + +"Bars Per Accel Loop" sets how long it takes for a continuous accelerando to reach its original tempo + +When Continuous Accelerando is toggled off, the number of seconds remaining in the accel loop is displayed, and the accel ceases once the original tempo is reached. + +My two favorite examples of continuous accelerandos: + + - `Autechre Fold4 Wrap5 `_ + + - `Vijay Iyer Historicity `_ diff --git a/docs/content/startup.rst b/docs/content/startup.rst index 8afe670f..0fe0cbe4 100644 --- a/docs/content/startup.rst +++ b/docs/content/startup.rst @@ -8,7 +8,7 @@ :align: center :alt: startup -Select your preferred audio interface, then uncheck the pause button. :ref:`SousaFX will appear momentarily `. It takes a couple minutes to boot, but while it does, you may ponder a randomly selected prompt from :ref:`"Do It (Home)", or "Prompts for Programmers" `. +Select your preferred audio interface, then uncheck the pause button. :ref:`SousaFX will appear momentarily `. It takes a couple minutes to boot, but while it does, you may ponder a randomly selected prompt from :ref:`"Do It (Home)", or "Prompts for Programmers" `. .. note::