A little more instrument docs cleanup.

This commit is contained in:
Electric Keet 2023-06-10 23:14:45 -07:00 committed by GitHub
parent 7012cd36ab
commit b6f37efe55
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 18 additions and 18 deletions

View file

@ -2,10 +2,10 @@
AY8930 instrument editor consists of these macros.
- [Volume] - volume levels sequence
- [Arpeggio]- pitch sequence
- [Volume] - volume sequence
- [Arpeggio]- pitch in half-steps
- [Noise Freq] - AY8930 noise generator frequency sequence
- [Waveform] - selector of sound type - pulse wave tone, noise or envelope generator
- [Waveform] - selector of sound type: pulse wave tone, noise or envelope generator
- [Pitch] - fine pitch
- [Phase Reset] - trigger restart of waveform
- [Duty] - duty cycle of a pulse wave sequence

View file

@ -34,7 +34,7 @@ depending on the instrument type, there are currently 13 different types of an i
# macros
Macros are incredibly versatile tools for automating instrument effects.
Macros are incredibly versatile tools for automating instrument parameters.
After creating an instrument, open the Instrument Editor and select the "Macros" tab. There may be multiple macro tabs to control individual FM operators and such.
@ -50,7 +50,7 @@ Each macro has two buttons on the left.
## macro types
Every macro can be defined though one of three methods, selectable by the leftmost button under the macro type label:
Every macro can be defined though one of three methods, selectable with the leftmost button under the macro type label:
- ![](macro-button-seq.png) **Sequence:** Displayed as a bar graph, this is a sequence of numeric values.
- ![](macro-button-ADSR.png) **ADSR:** This is a traditional ADSR envelope, defined by the rate of increase and decrease of value over time.
@ -65,8 +65,8 @@ Some macros are "bitmap" style. They represent a number of "bits" that can be to
The number between the macro type label and the macro type button is the macro length in steps. The `-` and `+` buttons change the length of the macro. Start out by adding at least a few steps.
The values of the macro can be drawn in the "bar graph box". Just beneath the box is shorter bar graph.
- Click to set the start point of a loop; the end point is the last value unless a release point is set.
- Shift-click to set the release point. When played, the macro will hold here until the note is released.
- Click to set the start point of a loop; the end point is the last value or release point. Right-click to remove the loop.
- Shift-click to set the release point. When played, the macro will hold here until the note is released. Right-click to remove the release point.
Finally, the sequence of values can be directly edited in the text box at the bottom.
- The loop start is entered as a `|`.
@ -77,8 +77,6 @@ Finally, the sequence of values can be directly edited in the text box at the bo
![ADSR macro editor](macro-ADSR.png)
![macro ADSR chart](macro-ADSRchart.png)
- **Bottom** and **Top** determine the range of values generated by the macro. (Bottom can be larger than Top to invert the envelope!) All generated values will fall between these two points.
- **Attack** is how quickly the value goes from Bottom to Top. A 0 means nothing will change; a 255 instantly jumps to the Top value.
- **Hold** sets how many ticks the note will wait at Top before decay.
@ -86,7 +84,9 @@ Finally, the sequence of values can be directly edited in the text box at the bo
- **Sustain** is the where the value will stay while the note is held until SusTime has passed.
- **SusTime** is how many ticks until SusDecay.
- **SusDecay** is the rate at which the value moves toward Bottom while the note is held.
- **Release** is the rate at which the note changes once the note is released.
- **Release** is the rate at which the value moves toward Bottom after the note is released.
![macro ADSR chart](macro-ADSRchart.png)
### LFO

View file

@ -1,6 +1,6 @@
# Amiga/PCM sound sourceinstrument editor
PCM instrument editor consists of a sample selector and several macros:
The PCM instrument editor consists of a sample selector and several macros:
# Amiga/sample

View file

@ -1,6 +1,6 @@
# AY-3-8910 instrument editor
AY-3-8910 instrument editor consists of these macros.
The AY-3-8910 instrument editor consists of these macros.
- [Volume] - volume levels sequence
- [Arpeggio]- pitch sequence

View file

@ -10,7 +10,7 @@ GB instrument editor consists of two tabs: one controlling envelope of sound cha
- [Length] - envelope decay/attack duration (range 0-7)
- [Sound Length] - cuts off sound after specified length, overriding the Length value
- [Up and Down radio buttons] - Up makes the envelope an attack, down makes it decay. _Note:_ For envelope attack to have any effect, volume should start at a lower value!
- [Up and Down radio buttons] - Up makes the envelope an attack, down makes it decay. _Note:_ For envelope attack to have any effect, start at a lower volume!
- [Hardware Sequence] - (document this)

View file

@ -1,6 +1,6 @@
# Namco 163 instrument editor
Namco 163 instrument editor consists of two tabs: one controlling various parameters for waveform initialize and macro tab containing 10 macros.
The Namco 163 instrument editor consists of two tabs: "Namco 163" for control of various waveform parameters, and "Macro" containing seveeral macros.
## Namco 163

View file

@ -1,6 +1,6 @@
# NEC PC Engine instrument editor
PCE instrument editor consists of these macros:
The PCE instrument editor consists of these macros:
- [Volume] - volume sequence
- [Arpeggio] - pitch in half-steps

View file

@ -1,6 +1,6 @@
# Philips SAA1099 instrument editor
SAA1099 instrument editor consists of these macros:
The SAA1099 instrument editor consists of these macros:
- [Volume] - volume sequence
- [Arpeggio] - pitch sequence

View file

@ -1,6 +1,6 @@
# Konami SCC/Bubble System WSG instrument editor
SCC/Bubble System WSG instrument editor consists of these macros:
The SCC/Bubble System WSG instrument editor consists of these macros:
- [Volume] - volume sequence
- [Arpeggio] - pitch sequence

View file

@ -1,6 +1,6 @@
# Atari TIA instrument editor
TIA instrument editor consists of these macros:
The TIA instrument editor consists of these macros:
- [Volume] - volume sequence
- [Arpeggio] - pitch sequencr