Skip to content

Commit

Permalink
try adding checkboxes to install steps
Browse files Browse the repository at this point in the history
  • Loading branch information
jbaylies committed Nov 14, 2024
1 parent 24b7e0c commit 85cbde2
Showing 1 changed file with 76 additions and 2 deletions.
78 changes: 76 additions & 2 deletions docs/content/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ Installation

1. Read SousaFX's :ref:`End User License Agreement<End User License Agreement For SousaFX>`.

.. raw:: html

<input type="checkbox">

|
2. `Download Max <https://cycling74.com/downloads>`_ from Cycling '74.
Expand All @@ -11,6 +15,10 @@ Installation

SousaFX & SousaVFX remain fully functional after Max's `30-day trial ends <https://support.cycling74.com/hc/en-us/articles/360049995834-Max-8-Max-7-Authorization#link-2>`_.

.. raw:: html

<input type="checkbox">

|
3. `Download Live Suite <https://www.ableton.com/en/download/>`_ from Ableton.
Expand All @@ -19,6 +27,10 @@ Installation

The SousaPlayback template project cannot be saved after Ableton Live's `30-day trial ends <https://www.ableton.com/en/trial/>`_. The template uses Max for live devices that require Ableton Live 11/12 Suite or Standard with the Max for Live addon.

.. raw:: html

<input type="checkbox">

|
4. Open Max, go to ``Menubar > Max > Preferences...``, and set the following preferences:
Expand All @@ -27,10 +39,18 @@ Installation

- Mixer > Enable Mixer Parallel Processing [check]

.. raw:: html

<input type="checkbox">

|
5. Open Max's `Audio Status Window <https://docs.cycling74.com/max8/vignettes/audio_status>`_ 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

<input type="checkbox">

|
6. Open Max's Package Manager: ``Menubar > File > Show Package Manager``, and install the following packages:
Expand All @@ -53,14 +73,28 @@ Installation

- `ISF <c74max://packagemanager/ISF>`_

.. note:: Open the ISF package and download the editor & files.
.. note:: Open the ISF package and download the editor & files.

.. raw:: html

<input type="checkbox">

7. Download `Pix Shaders <https://github.com/tmhglnd/gl-pix-shaders.git>`_ to your ``~/Documents/​Max 8/​Packages/``
|
7. Download `Pix Shaders <https://github.com/tmhglnd/gl-pix-shaders.git>`_ to your ``~/Documents/​Max 8/​Packages/`` folder.

.. raw:: html

<input type="checkbox">

|
8. `Download sousastep-0.10.1's Source code (zip) <https://github.com/Sousastep/sousastep/releases/latest>`_ to your ``~/Documents/​Max 8/​Projects/`` folder. It contains SousaFX, SousaVFX, and SousaPlayback.

.. raw:: html

<input type="checkbox">

|
9. Rename ``sousastep-0.10.1`` to ``sousastep``.
Expand All @@ -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

<input type="checkbox">

|
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

<input type="checkbox">

|
11. Open Live, open its settings ``Menubar > Live > Settings...``, and set the following:
Expand All @@ -101,12 +143,20 @@ Installation

f. Link Tempo MIDI > Show Link Toggle [show]

.. raw:: html

<input type="checkbox">

|
.. _blackoctopus:

12. Optionally, download Black Octopus Sound's `excellent free samples <https://blackoctopus-sound.com/product/free-1gb-of-black-octopus-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

<input type="checkbox">

|
.. _freeplugins:
Expand All @@ -129,6 +179,10 @@ Installation

f. `Melda Production <https://www.meldaproduction.com/MFreeFxBundle>`_ "The biggest and most powerful free plugins pack available."

.. raw:: html

<input type="checkbox">

|
.. _startupprefs:
Expand All @@ -141,6 +195,10 @@ Installation

.. image:: media/startup.webp

.. raw:: html

<input type="checkbox">

|
15. In SousaPlayback, ensure that the Main and Monitor :ref:`return tracks <Return Track List>` are routed to the audio interface's Main and Headphone/Aux outputs, respectively.
Expand All @@ -158,6 +216,10 @@ Installation
is recommended if your audio interface has an available
`loopback <https://www.sweetwater.com/insync/loopback-explained-what-is-audio-loopback/>`_ channel.

.. raw:: html

<input type="checkbox">

|
16. Once SousaFX is running, open the :ref:`Audio IO Status window <Audio IO Status>`.
Expand All @@ -173,11 +235,23 @@ Installation

c. If you're using a loudspeaker or amplifier, set the "Main L & R" outputs to your audio interface's main output.

.. raw:: html

<input type="checkbox">

|
17. Connect your game controller to your computer either wired or wirelessly.
Check that the start/select buttons don't trigger anything outside of SousaFX,
such as Steam or your operating system. For example on MacOS Ventura or later,
go to System Settings > Game Controller > Add New Profile > Share Gestures > Set "Double Press" to "Off" > Click "Done" > Scroll up to your controller and select it > Set "Use Profile" to the new profile > Click "Done". Also note the "Buddy Controller" setting that allows two controllers to be used as one.

.. raw:: html

<input type="checkbox">

|
Now, it's time for a :ref:`soundcheck <Soundcheck>`!

|

0 comments on commit 85cbde2

Please sign in to comment.