Skip to content

Commit 68f0feb

Browse files
committed
docs(step-recorder): update docs for various changes
Fixes #9
1 parent cd9f095 commit 68f0feb

1 file changed

Lines changed: 28 additions & 7 deletions

File tree

README.md

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Bitwig Studio Extensions
22

33
This project contains three Bitwig Studio controller extensions. Some of it was written with Cursor.
4-
Currently requires the latest API version. Copy the release files with `.bwextension` to
4+
Currently, requires the latest API version. Copy the release files with `.bwextension` to
55
`c:\Users\<your-user>\Documents\Bitwig Studio\Extensions` and add the extensions to your running
66
Bitwig in the settings -> controllers section
77

@@ -54,12 +54,12 @@ Create a Group Track named exactly **"Patterns"** containing:
5454
- **Number of Tracks per Group**:
5555
- Default 5
5656
- How many tracks are "seen" by this extension within the **Devices** and the **Patterns** group
57-
- the higher the more resources this may drain from your system
57+
- the higher, the more resources this may drain from your system
5858
- **Number of root Groups**: Default 2 (Patterns + Devices groups) - if the first two groups are the aforementioned groups, you don't need more than the value 2 here.
5959
- **Number of Slots per Track**:
6060
- Default is 5
6161
- How many slots in the clip launcher are "seen" by this extension within the **Devices** and the **Patterns** group
62-
- the higher the more resources this may drain from your system
62+
- the higher, the more resources this may drain from your system
6363
- **Stop Keyword**: Default `[stop]` (customize if you want to use a different word)
6464
- It is unknown if these settings could just be fixed to maximum values due to possible performance considerations.
6565
The extension needs to observe changes in your project and remap automatically.
@@ -72,16 +72,37 @@ Create a Group Track named exactly **"Patterns"** containing:
7272
Step recording with various step lengths
7373

7474
- **Toggle: Enable/disable**: arm or disarm this extension
75-
- **Disabled when switching to a different clip**: disables itself automatically when opening a different clip.
75+
- **Disabled when switching to a different clip**:
76+
disables itself automatically when opening a different clip.
77+
Depends on two settings that require to have a value bigger than 0:
78+
79+
- Scenes per track observed
80+
- Tracks observed
81+
82+
Everything beyond these observation scopes is ignored in terms of the
83+
functionality provided, i.e., the step recording is not disabled automatically
84+
and the internal step recording cursor is not reset to the start of the clip
85+
86+
When changing either observation settings, reload your project. The extension
87+
cannot update these values while running due to the limitations of the API
88+
available.
7689
- **Step Recording**: Play notes on your MIDI keyboard to add them to the currently selected clip in the clip launcher
77-
- **Musical Note Values**: Standard note values from 32/1 down to 1/64
90+
- **Navigate backward/forward**: Move cursor back and forth. This allows to fix
91+
mistakes or insert gaps. Can be combined with **Toggle: clear while moving
92+
cursor** to either delete while navigating or go back and add more
93+
- **Musical Note Lengths**: Standard note lengths from 32/1 down to 1/64
7894
- **Triplet Support**: Regular and triplet timing for all note values
95+
- **Note Velocity**: velocity of the midi input or a fixed value is used for all notes added to the selected clip. Two settings allow to change that:
96+
97+
- Fixed Velocity: set to ✓ for the Note Velocity Value setting to be used
98+
- Note Velocity: the fixed velocity value (0-127) to use
7999
- **Chord Detection**: 100ms threshold for chord recognition to enter chords at the current position
80100
- **MIDI Learn Navigation**: CC-based cursor movement controls
81101
- **Toggle: clear old notes**: New notes at the same position replace existing ones or don't depending on the toggle setting
82102
- **Toggle: clear while moving cursor**: delete notes when moving forward or backward, allows to insert gaps or delete mistakes
83103
- **Button. clear notes under cursor**: deletes notes at the current position
84-
- **Sleep when transport is playing**: is temporarily disabled when transport is playing
104+
- **Sleep when transport is playing**: is temporarily disabled when transport is
105+
playing, but remembers if it was enabled prior to starting transport
85106
- **MIDI learn for all features**: go to preferences of controller extension and click on
86107
"Learning..." button and send CC values. When learning was successful, neither "Learning..." nor
87108
"Not Mapped" appear clicked.
@@ -128,4 +149,4 @@ Extension
128149
- `sdk install maven`
129150
- `sdk install mvnd`
130151
- Copy .env.dist to .env and replace `<user>` with your real user.
131-
- run `./install.sh`
152+
- run `./install.sh`

0 commit comments

Comments
 (0)