From 80e932b07aa1912743a1c063494e0655eedb8d96 Mon Sep 17 00:00:00 2001 From: Kevin Montag Date: Sun, 12 May 2024 20:23:53 +0200 Subject: [PATCH] Update README --- README.md | 135 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 75 insertions(+), 60 deletions(-) diff --git a/README.md b/README.md index 19f1a28..781de25 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,8 @@ It lets you control transport, device parameters, clips, mixer controls, and more. It provides realtime feedback via the SoftStep's LEDs and display. -The interface is [highly](#python-configuration) -[configurable](#track-controls), so you can arrange things in a way -that makes sense for you. +The interface is [highly configurable](#python-configuration), so you +can arrange things in a way that makes sense for you. You can also [switch back and forth](#standalone-presets) between modeStep and your own SoftStep standalone presets. @@ -19,15 +18,20 @@ modeStep and your own SoftStep standalone presets. ### Live - Clone or download this repo and place it in your Live User Library - under the `Remote Scripts/` directory. -- (Re)start Live, and go to `Link / Tempo / MIDI` in Preferences. -- Choose `modeStep` as one of your control surfaces, and select `SSCOM -(Port 1)` for the Input and Output. + under the `Remote Scripts/` directory. If you download it directly, + make sure to change the folder name from `modeStep-main` to + `modeStep` (or anything without a hyphen). +- (Re)start Live, and go to `Link, Tempo & MIDI` in Preferences. +- Choose `modeStep` as one of your control surfaces, and select the + main SoftStep port (generally `SoftStep (Control Surface)` or + `SoftStep`) for the Input and Output. +- Ensure the `Remote` checkbox for the selected MIDI port is enabled + under the `Input Ports` and `Output Ports` sections. ### SoftStep 2 -No presets or special configuration are required on the SoftStep. The -controller will be placed into hosted mode. +No presets or special configuration are required on the SoftStep. +Make sure your device firmware is up to date (v2.0.3 or greater). ## Intro @@ -35,8 +39,8 @@ controller will be placed into hosted mode. indicated by `Trns` on the SoftStep's screen. Try pressing key 3 to play/stop the transport. -From any mode, you can press key 0 to open the Mode Select screen, and -choose where you want to go: +From any mode, you can press key 0 to open +the Mode Select screen, and choose where you want to go: ![mode select diagram](img/mode-select.svg) @@ -118,55 +122,15 @@ assigned to session record. You can customize the track controls modes using `override_track_controls` in your -[configuration](#python-configuration). You can also edit them -(ephemerally) directly from the SoftStep as described below. +[configuration](#python-configuration), or [edit them +directly](#editing-track-controls) if you need a different layout +in the moment. -#### Editing Track Controls +## Advanced Usage -To edit a track controls mode, long-press one of keys 1-5 on the Mode -Select screen. You'll be prompted to choose the control for the top -row of pedals: +
-![configure preset diagram](img/edit-track-control.svg) - -_See below for notes on action customization via key 5._ - -After selecting a control for the top row, you'll be prompted to -choose the control for the bottom row in the same way. - -If you choose different controls for the top and bottom rows, you'll -have access to both controls across 4 tracks. The display will show -the first two letters from each control. For example, if you choose -**Solo** and **Arm**: - -![solo/arm mode diagram](img/solo-arm-mode.svg) - -If you choose the same control twice, you'll have access to 8 -tracks. For example, if you choose **Mute** twice: - -![mute mode diagram](img/mute-mode.svg) - -#### Selecting the Key 5 Action - -Key 5 is normally mapped to session record in track controls modes, -but this can be configured. Press key 5 from the top or bottom edit -screen to assign a different action. `1Act` (or similar) will appear on -the display, and you can press keys 1-9 to select an action. The -layout mirrors the [Transport Mode](#transport-mode) layout - so if -you want to map `Play/Stop`, for example, touch key 3. - -Long-pressing does the same thing, but with actions from the [Utility -Mode](#utility-mode) layout. - -#### Disabling Track Controls Modes - -If you want to remove clutter from your Mode Select screen, press and -hold key 0 while editing a track controls mode to disable it. This -disables the corresponding LED on the mode select screen. You can -still reconfigure the mode by long-pressing the corresponding key on -the mode select screen. - -## Configuration +

Configuration

 You can customize modeStep by creating a file called `user.py` in this directory. @@ -192,8 +156,7 @@ configuration = Configuration( ) ``` - -### Set-specific configuration +#### Set-specific configuration You can configure modeStep on a set-by-set basis by creating a clip anywhere in the session view with a name like: @@ -218,8 +181,59 @@ fields. Configuration is only loaded when a set is opened, so you'll need to save and re-open the set after creating this clip. Triggering or otherwise interacting with the clip doesn't do anything special. +
+ +
+

Live-Editing Track Controls

 + +You can modify track controls for the current session directly from +the SoftStep (for persistent changes, use the +[configuration file](#python-configuration)). To do this, long-press +one of keys 1-5 on the Mode Select screen. You'll be prompted to +choose the control for the top row of pedals: + +![configure preset diagram](img/edit-track-control.svg) + +_See below for notes on action customization via key 5._ + +After selecting a control for the top row, you'll be prompted to +choose the control for the bottom row in the same way. + +If you choose different controls for the top and bottom rows, you'll +have access to both controls across 4 tracks. The display will show +the first two letters from each control. For example, if you choose +**Solo** and **Arm**: + +![solo/arm mode diagram](img/solo-arm-mode.svg) + +If you choose the same control twice, you'll have access to 8 +tracks. For example, if you choose **Mute** twice: + +![mute mode diagram](img/mute-mode.svg) + +#### Selecting the Key 5 Action + +Key 5 is normally mapped to session record in track controls modes, +but this can be configured. Press key 5 from the top or bottom edit +screen to assign a different action. `1Act` (or similar) will appear on +the display, and you can press keys 1-9 to select an action. The +layout mirrors the [Transport Mode](#transport-mode) layout - so if +you want to map `Play/Stop`, for example, touch key 3. + +Long-pressing does the same thing, but with actions from the [Utility +Mode](#utility-mode) layout. + +#### Disabling Track Controls Modes + +If you want to remove clutter from your Mode Select screen, press and +hold key 0 while editing a track controls mode to disable it. This +disables the corresponding LED on the mode select screen. You can +still reconfigure the mode by long-pressing the corresponding key on +the mode select screen. +
-## Standalone Presets +
+

Standalone Presets

 modeStep can put the SoftStep into standalone mode and load any presets in your setlist. @@ -262,3 +276,4 @@ CCs in your MIDI mappings: _Note: if you're having issues with LED states being overwritten when switching in and out of standalone mode, make sure to set a `background_program` in your configuration._ +