etc/furnace
0
0
Fork 0
mirror of https://github.com/tildearrow/furnace.git synced 2024-12-01 16:57:27 +00:00
Code Issues Projects Releases Packages Wiki Activity

Docs: Macro right-click menu. (#1641)

Browse source 
* Fixing typos in docs.

* Small doc updates.

* Minor doc changes as requested.

* Docs: Macro right-click menu.

I only just discovered that this exists!

* Recommended wording.

* One more little edit.
This commit is contained in:
Electric Keet 2023-12-13 11:34:56 -08:00 committed by GitHub
parent ae8a185145
commit ef5ab90be5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
doc/4-instrument/README.md
View file

@ -126,14 +126,25 @@ finally, the sequence of values can be directly edited in the text box at the bo
- in arpeggio macros, a value starting with a `@` is a fixed value as described above. - in arpeggio macros, a value starting with a `@` is a fixed value as described above.
- in bitmask-style macros, the values are added up in binary and converted to decimal. see [the hexadecimal guide](../1-intro/hex.md) for more info. - in bitmask-style macros, the values are added up in binary and converted to decimal. see [the hexadecimal guide](../1-intro/hex.md) for more info.
in all cases except bitmask macros, right-clicking on the graph opens up an editing menu:
- **copy**: copies the macro.
- **paste**: pastes the macro in the clipboard.
- **clear**: clears the macro.
- **clear contents**: resets all values to 0.
- **offset**:
- **X**: slides the data "horizontally" within the macro, filling the gap with zeroes. data moved past the start or end is lost.
- **Y**: increases or decreases all values, clipping them if they would move past the allowed range.
- **scale**:
- **X**: stretches the macro.
- **Y**: multiplies all values by the scale factor, clipping them if they would exceed the allowed range.
- **randomize**: replaces all values with random values between **Min** and **Max**.
### ADSR ### ADSR
![ADSR macro editor](macro-ADSR.png) ![ADSR macro editor](macro-ADSR.png)
- **Bottom** and **Top** determine the range of outputs generated by the macro. (Bottom can be larger than Top to invert the envelope!) All outputs will be between these two values. - **Bottom** and **Top** determine the range of outputs generated by the macro. (Bottom can be larger than Top to invert the envelope!) All outputs will be between these two values.
- attack, Decay, Sustain, SusDecay, and Release accept inputs between 0 to 255. these are scaled to the distance between Bottom and Top. - Attack, Decay, Sustain, SusDecay, and Release accept inputs between 0 to 255. these are scaled to the distance between Bottom and Top.
- **Attack** is how much the value moves toward Top with each tick. - **Attack** is how much the value moves toward Top with each tick.
- **Hold** sets how many ticks to stay at Top before Decay. - **Hold** sets how many ticks to stay at Top before Decay.
- **Decay** is how much the value moves to the Sustain level. - **Decay** is how much the value moves to the Sustain level.