Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jbaylies committed Jan 17, 2024
1 parent f167c6f commit 1a123a3
Show file tree
Hide file tree
Showing 63 changed files with 878 additions and 123 deletions.
Binary file modified SousaFX/.docs/.doctrees/content/EULA.doctree
Binary file not shown.
Binary file modified SousaFX/.docs/.doctrees/content/bindings.doctree
Binary file not shown.
Binary file modified SousaFX/.docs/.doctrees/content/hardreq.doctree
Binary file not shown.
Binary file modified SousaFX/.docs/.doctrees/content/install.doctree
Binary file not shown.
Binary file not shown.
Binary file modified SousaFX/.docs/.doctrees/content/purchase.doctree
Binary file not shown.
Binary file modified SousaFX/.docs/.doctrees/content/sousavfx.doctree
Binary file not shown.
Binary file modified SousaFX/.docs/.doctrees/content/sousavfxscreenshots.doctree
Binary file not shown.
Binary file modified SousaFX/.docs/.doctrees/content/startup.doctree
Binary file not shown.
Binary file added SousaFX/.docs/.doctrees/content/tickets.doctree
Binary file not shown.
Binary file modified SousaFX/.docs/.doctrees/environment.pickle
Binary file not shown.
Binary file modified SousaFX/.docs/.doctrees/index.doctree
Binary file not shown.
16 changes: 8 additions & 8 deletions SousaFX/.docs/_sources/content/EULA.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -348,17 +348,17 @@ distributed under the Apache 2.0 license.

For SousaFX to comply with the license I must inform you that I recolored the following icons:

- https://iconduck.com/icons/92336/weather-sunset-down
- `weather sunset down <https://iconduck.com/icons/92336/weather-sunset-down>`_

- https://iconduck.com/icons/91258/select-color
- `select colors <https://iconduck.com/icons/91258/select-color>`_

- https://iconduck.com/icons/91094/restart
- `restart <https://iconduck.com/icons/91094/restart>`_

- https://iconduck.com/icons/90226/midi
- `midi <https://iconduck.com/icons/90226/midi>`_

- https://iconduck.com/icons/90175/metronome
- `metronome <https://iconduck.com/icons/90175/metronome>`_

- https://iconduck.com/icons/86936/arrow-decision-auto-outline
- `arrow decision auto outline <https://iconduck.com/icons/86936/arrow-decision-auto-outline>`_


icofont/LICENSE
Expand All @@ -385,7 +385,7 @@ The IcoFont authority reserves the right to change or modify the above license t

.. important::

For SousaFX to comply with the license I must inform you that I recolored the following icon: https://iconduck.com/icons/249084/swirl
For SousaFX to comply with the license I must inform you that I recolored the following icon: `swirl <https://iconduck.com/icons/249084/swirl>`_


KDE/oxygen-icons
Expand All @@ -397,5 +397,5 @@ https://github.com/KDE/oxygen-icons

.. important::

For SousaFX to comply with the license I must inform you that I recolored the following icon: https://www.iconarchive.com/show/oxygen-icons-by-oxygen-icons.org/Actions-games-config-options-icon.html
For SousaFX to comply with the license I must inform you that I recolored the following icon: `action games config options <https://www.iconarchive.com/show/oxygen-icons-by-oxygen-icons.org/Actions-games-config-options-icon.html>`_

57 changes: 53 additions & 4 deletions SousaFX/.docs/_sources/content/bindings.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@ Controller Bindings
pcl.rst
deadzones.rst

The controller bindings window uses `max's crosspatch <https://docs.cycling74.com/max8/refpages/crosspatch object>`_ to connect gamepad inputs with effect parameters.
The controller bindings window uses Max's `crosspatch <https://docs.cycling74.com/max8/refpages/crosspatch>`_ object to connect gamepad inputs with effect parameters.

To create a binding, click one circle and drag the connection to a circle on the other side of crosspatch. To delete a binding, click the connection and press the delete key. To save bindings, click "save / overwrite".
To create a binding, click one circle and drag the connection to a circle on the other side of crosspatch. To delete a binding, click the connection and press the delete key. To save bindings, click "save / overwrite". The factory presets can not be overwritten.

The bindings are mapped to be ergonomic for having the controller on the side of a tuba. The right bumper, right trigger, and left trigger all change which bindings the X A B Y buttons are assigned to. The left trigger also changes the dpad and LB's bindings, to allow for a second bank of subdivisions.
There are two factory preset slots for the default preset and a blank preset. The five user preset slots are empty, so the factory presets may be copied to the user preset by selecting the factory preset first, then selecting the empty user preset and saving.

The bindings are mapped to be ergonomic for having the controller attached to the side of a tuba. The right bumper, right trigger, and left trigger all change which bindings the X A B Y buttons are assigned to. The left trigger also changes the dpad and LB's assignments, to allow for a second bank of subdivisions.

Click the parameter labels to open their :ref:`control logic settings <Parameter Control Logic>`.

Expand All @@ -20,4 +22,51 @@ Click to the right of the parameter labels to open the parameters window that th
.. image:: media/bindings.png
:width: 100%
:align: center
:alt: bindings window
:alt: bindings window

:Latch / Delay:

This determines how diagonals are triggered.

- Latch: after triggering a diagonal, ↑ → ↓ ← can not trigger without first releasing the dpad

- Delay: ↑ → ↓ ← can trigger after a diagonal without releasing the dpad

:pre-delay:

Before pressing a diagonal, this is the amount of time you have to hold ↑ → ↓ ← before they trigger.

:post-delay:

After releasing a diagonal, this is the amount of time you have to release ↑ → ↓ ← before they trigger. Only available in Delay mode.

:cycle / count:

This determines how the Controller Bindings Preset Selector functions. This is a global parameter that's auto-saved.

- Cycle: Single-click & double click will cycle forward & back through user presets.

- Count: # of button presses in 1 second sets user preset #.

Hold the button to load the default preset.

:top-right toggle:

Enable to have the crosspatch object highlight conections that are in-use. This is useful for debugging, but uses a lot of CPU, so disable it while performing.

:latch / trigger:

This determines how the dpad and LB react to their modifier key, LT.

- Hold: Toggling with LT doesn't trigger dpad or LB. This is useful for being able to lock open sends.

- Trigger: If dpad or LB is pressed, toggling with LT will trigger them. This is useful for switching between subdivisions.

This parameter is saved with the bindings' user presets.

:Presets 1 - 4:

These four bindings can select each of the first 16 :ref:`Main Presets <Main Window>`. Clicking them selects a preset, and holding them for more than 1 second sets the preset bank. Holding preset 1 sets preset bank 1 (presets 1 - 4), holding preset 2 sets preset bank 2 (presets 5 - 8), holding Preset 3 sets preset bank 3 (presets 9 - 12), and holding preset 4 sets preset bank 4 (presets 13 - 16).



7 changes: 5 additions & 2 deletions SousaFX/.docs/_sources/content/hardreq.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,13 @@ Benchmarks

SousaFX takes three minutes to start, and idles around 4.8 GB RAM, 9% CPU.

:windows 11, DDR4 2666, i7-9700K:
:windows 11, DDR4 2666, i7-9700K, 8 cores:

SousaFX takes five minutes to start, and idles around 4.5 GB RAM, 14% CPU.
Five minutes to start, idles around 4.5 GB RAM, 14% CPU.

:2012 macbook pro, DDR3 1600, 4 cores:

Ten minutes.

Examples
--------
Expand Down
2 changes: 1 addition & 1 deletion SousaFX/.docs/_sources/content/install.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ SousaFX
SousaPlayback
-------------

7. To open the SousaPlayback template project ``~/Documents/​Max 8/​Projects/​sousastep/​default/​SousaPlayback template Project/​SousaPlayback template.als``, `download Live Suite <https://www.ableton.com/en/trial/>`_ from Ableton.
7. To open the SousaPlayback Project, `download Live Suite <https://www.ableton.com/en/trial/>`_ from Ableton.

Go to Live's settings: ``Menubar > Live > Settings...``, and set the following:

Expand Down
5 changes: 5 additions & 0 deletions SousaFX/.docs/_sources/content/mailinglist.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Mailing List
============

.. raw:: html
:file: mailinglist.html
18 changes: 6 additions & 12 deletions SousaFX/.docs/_sources/content/purchase.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,19 @@ You may use the discounted license if:

Payment may be sent via any of the following platforms. Please be sure to include the email address that you would like the license key sent to.

.. button-link:: https://ko-fi.com/sousafx

.. button-link:: https://ko-fi.com/sousafx/shop
:color: primary
:outline:

ko-fi


.. button-link:: https://patreon.com/sousastep
.. button-link:: https://github.com/sponsors/jbaylies?frequency=one-time
:color: primary
:outline:

patreon
github


.. button-link:: https://venmo.com/sousastep
Expand All @@ -36,16 +37,9 @@ Payment may be sent via any of the following platforms. Please be sure to includ
venmo


.. button-link:: https://github.com/sponsors/jbaylies
:color: primary
:outline:

github


When you complete your purchase, a license key will be emailed to you ASAP (usually within 24 hours). License purchases are non-refundable. Be sure that email from sousastep@gmail.com is not going into your spam folder.
When you complete your purchase, send an email to sousastep@gmail.com and a license key will be emailed to you ASAP. License purchases are non-refundable. Be sure that email from sousastep@gmail.com is not going into your spam folder.

Classroom licenses and discounted-to-commercial license upgrades are also offered. For these and any other license needs, please email sousastep@gmail.com
Classroom licenses and discounted-to-commercial license upgrades are also offered. For these and any other license needs,git please email sousastep@gmail.com

.. image:: media/window-about-nolicense.png
:width: 70%
Expand Down
36 changes: 2 additions & 34 deletions SousaFX/.docs/_sources/content/sousavfx.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -51,37 +51,5 @@ Startup

Screenshots
-----------

.. figure:: media/vfx1.png
:align: center
:width: 100%
:alt: vfx1

dude837's primitive action shader

|
.. figure:: media/vfx2.png
:align: center
:width: 100%
:alt: vfx2

Supports scrolling text.

|
.. figure:: media/isfobject.png
:align: center
:width: 100%
:alt: international shafer format for jitter

ISF preset switcher.

|
.. figure:: media/serialobject.png
:align: center
:width: 100%
:alt: serial

Sending RGB data to a Teensy via ``serial``.

:ref:`More pictures of SousaVFX. <Screenshots>`
12 changes: 9 additions & 3 deletions SousaFX/.docs/_sources/content/sousavfxscreenshots.rst.txt
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
Screenshots
-----------
===========

.. figure:: media/vfx1.png
:align: center
:width: 100%
:alt: vfx1

SousaVFX screenshot #2
dude837's primitive action shader

|
.. figure:: media/vfx2.png
:align: center
:width: 100%
:alt: vfx2

SousaVFX screenshot #3
Supports scrolling text.

|
.. figure:: media/isfobject.png
:align: center
Expand All @@ -22,6 +26,8 @@ Screenshots

ISF preset switcher.

|
.. figure:: media/serialobject.png
:align: center
:width: 100%
Expand Down
5 changes: 1 addition & 4 deletions SousaFX/.docs/_sources/content/startup.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,7 @@ SousaPlayback

Steps 7 - 9 are only necessary the first time SousaPlayback starts.

6. Open ``~/Documents/​Max 8/​Projects/
​sousastep/​default/
​SousaPlayback template Project/
​SousaPlayback template.als``.
6. Open open ``~/Documents/​Max 8/​Projects/​sousastep/​SousaPlayback Project/​SousaPlayback.als``.

7. If the :ref:`Black Octopus Drum Loops are installed <blackoctopus>` then drum clips will be available in session view, but if they're missing then feel free to delete them and add your own.

Expand Down
59 changes: 59 additions & 0 deletions SousaFX/.docs/_sources/content/tickets.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
Tickets
=======

Feel free to submit bug reports or feature requests to `GitHub Issues <https://github.com/Sousastep/sousastep/issues>`_


Known Bugs
----------

- plugin selectors can only clear plugin slot by manually deleting json file in data folder.

- the About window shows "0 0" as install date on first boot.

- four rnbo filterdelays can't load at once, but three can. So if delay send 4 is bypassed, which it is by default, it will insta-feedback when opened, so no bindings are connected to it by default.

- implement max4cats delay fx as a choice for the delay sends. involves refactoring or making another version of plugin_selector

- :ref:`Param Control Logic's <Parameter Control Logic>` "This control is mapped to the joystick" message is only correct on load and won't update when switching presets. It will update when manually adding and removing connections. It also can't say when it's bound to a button.


Upcoming Features
-----------------

- allow any plugin parameter to bind to any joystick axis

- Make SousaFX detect time signatures other than 4/4

- detect and warn of unsaved changes instead of erring on the side of caution and always warning of unsaved changes

- Make m4l device that auto-enables live link on load

- make fx banks randomizer detect how many plugin slots are filled instead of being hardcoded to 4.

- take twitch bot out of vfx and make it into its own patch

- make floating windows aware of max patcher sizes instead of just being too big.

- rename phasor1n device to something more inviting and playful. dreamy, even.

- bring stutter accel to LFO. bringing stutter accel into gen would be difficult.

- when main input delay send enabled, after tuba stops playing, close send until control hits deadzone.

- in audio io status window, add links to channel labels

- Allow all Gamepad inputs to be duplicated as MIDI?

- add toggle to display latency compensation?

- allow all "max or plugin selectors" to also select external IO.

- make floating windows remember their location.

- Export the Phasor & midi tempo M4L devices as plugins that work in other DAWs
Bonus: port stutter / tremolo / filter amxd to rnbo

- improve loopers

- only use pleading emoji in menubar if unlicensed after 30 days have passed since installation
2 changes: 2 additions & 0 deletions SousaFX/.docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@ SousaFX may be :ref:`downloaded <Installation>` and evaluated for free, however
content/playback.rst
content/sousavfx.rst
content/purchase.rst
content/mailinglist.rst
content/attrib.rst
content/tickets.rst

.. image:: content/media/sousagamepad.png
:width: 60%
Expand Down
Loading

0 comments on commit 1a123a3

Please sign in to comment.