diff --git a/docs/content/install.rst b/docs/content/install.rst index 8fc6c6ec..f2ff9430 100644 --- a/docs/content/install.rst +++ b/docs/content/install.rst @@ -3,6 +3,10 @@ Installation 1. Read SousaFX's :ref:`End User License Agreement`. +.. raw:: html + + + | 2. `Download Max `_ from Cycling '74. @@ -11,6 +15,10 @@ Installation SousaFX & SousaVFX remain fully functional after Max's `30-day trial ends `_. +.. raw:: html + + + | 3. `Download Live Suite `_ from Ableton. @@ -19,6 +27,10 @@ Installation The SousaPlayback template project cannot be saved after Ableton Live's `30-day trial ends `_. The template uses Max for live devices that require Ableton Live 11/12 Suite or Standard with the Max for Live addon. +.. raw:: html + + + | 4. Open Max, go to ``Menubar > Max > Preferences...``, and set the following preferences: @@ -27,10 +39,18 @@ Installation - Mixer > Enable Mixer Parallel Processing [check] +.. raw:: html + + + | 5. Open Max's `Audio Status Window `_ by clicking on ``menubar > Settings > Audio Status...`` and set your preferred driver, sample rate, and vector size. A sample rate of 48 kHz and a vector size of 256 is recommended. If the audio crackles during use then restart Max and try a vector size of 512. +.. raw:: html + + + | 6. Open Max's Package Manager: ``Menubar > File > Show Package Manager``, and install the following packages: @@ -53,14 +73,28 @@ Installation - `ISF `_ - .. note:: Open the ISF package and download the editor & files. + .. note:: Open the ISF package and download the editor & files. + +.. raw:: html + + -7. Download `Pix Shaders `_ to your ``~/Documents/​Max 8/​Packages/`` +| + +7. Download `Pix Shaders `_ to your ``~/Documents/​Max 8/​Packages/`` folder. + +.. raw:: html + + | 8. `Download sousastep-0.10.1's Source code (zip) `_ to your ``~/Documents/​Max 8/​Projects/`` folder. It contains SousaFX, SousaVFX, and SousaPlayback. +.. raw:: html + + + | 9. Rename ``sousastep-0.10.1`` to ``sousastep``. @@ -77,10 +111,18 @@ Installation ``sousastep/​SousaFX/​data/`` folder, and repeat with ``/SousaVFX/``, to ensure that user presets are carried over. This isn't necessary if you clone the repo with git because the data folders are gitignored. +.. raw:: html + + + | 10. Add ``/sousastep/`` to Max's global search path. Go to Max's menubar > ``Options... > File Preferences...``, "Add Path" +, "choose", and select ``~/Documents/​Max 8/​Project/​sousastep``. +.. raw:: html + + + | 11. Open Live, open its settings ``Menubar > Live > Settings...``, and set the following: @@ -101,12 +143,20 @@ Installation f. Link Tempo MIDI > Show Link Toggle [show] +.. raw:: html + + + | .. _blackoctopus: 12. Optionally, 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/``, or skip this step and use your own drum samples. +.. raw:: html + + + | .. _freeplugins: @@ -129,6 +179,10 @@ Installation f. `Melda Production `_ "The biggest and most powerful free plugins pack available." +.. raw:: html + + + | .. _startupprefs: @@ -141,6 +195,10 @@ Installation .. image:: media/startup.webp +.. raw:: html + + + | 15. In SousaPlayback, ensure that the Main and Monitor :ref:`return tracks ` are routed to the audio interface's Main and Headphone/Aux outputs, respectively. @@ -158,6 +216,10 @@ Installation is recommended if your audio interface has an available `loopback `_ channel. +.. raw:: html + + + | 16. Once SousaFX is running, open the :ref:`Audio IO Status window