fix the doc

This commit is contained in:
tildearrow 2023-11-01 18:37:28 -05:00
parent 14b9ba1a56
commit 18a2e628ea
5 changed files with 53 additions and 45 deletions

View file

@ -39,10 +39,10 @@ clicking on a channel name mutes that channel.
double-clicking or right-clicking it enables solo mode, in which only that channel will be audible.
clicking the `++` at the top left corner of the pattern view pops up a small menu to set view modes:
- **Effect columns/collapse**: as shown above. adds the following buttons beneath the channel name:
- **Effect columns/collapse**: displays extra options for collapsing channels and adding/removing effect columns:
- **-**: collapse visible columns. changes to **+** when columns are hidden; click to expand them.
- **<**: disables the last effect column and hides it. effects are not deleted...
- **>**: adds an effects column. if one previously existed, its contents will be preserved.
- **>**: adds an effect column. if one previously existed, its contents will be preserved.
- **Pattern names**: displays pattern names (per channel). pattern names are also visible when hovering over a pattern in the order list.
- **Channel group hints**: display indicators when channels are paired in some way (e.g. OPL3 4-op mode).
- **Visualizer**: during playback, show visual effects in the pattern view.
@ -53,23 +53,23 @@ to rename and/or hide channels, open [the Channels window](../8-advanced/channel
### channel status
- note status:
- ![note off](status-note-off.png) note off
- ![note on](status-note-on.png) note on
- ![note on, macro released](status-note-on-rel.png) note on, macro released
- ![note released](status-note-off-rel.png) note released
- pitch effect:
- ![no effect](status-pitch-none.png) no effect
- ![pitch up](status-pitch-up.png) pitch up
- ![pitch down](status-pitch-down.png) pitch down
- ![portamento](status-pitch-porta.png) portamento
- ![arpeggio](status-pitch-arpeg.png) arpeggio
- volume effect:
- ![no effect](status-volume-none.png) no effect
- ![volume up](status-volume-up.png) volume up
- ![volume down](status-volume-down.png) volume down
- ![tremolo](status-volume-tremolo.png) tremolo
- other icons depending on chip.
- note status:
- ![note off](status-note-off.png) note off
- ![note on](status-note-on.png) note on
- ![macro released](status-note-on-rel.png) note on but macro released (`REL`)
- ![note released](status-note-off-rel.png) note released (`===`)
- pitch alteration:
- ![no effect](status-pitch-none.png) nothing
- ![pitch up](status-pitch-up.png) pitch slide up
- ![pitch down](status-pitch-down.png) pitch slide down
- ![portamento](status-pitch-porta.png) portamento
- ![arpeggio](status-pitch-arpeg.png) arpeggio
- volume alteration:
- ![no effect](status-volume-none.png) nothing
- ![volume up](status-volume-up.png) volume slide up
- ![volume down](status-volume-down.png) volume slide down
- ![tremolo](status-volume-tremolo.png) tremolo
- other icons may be present depending on the used chips.
## input

View file

@ -71,10 +71,11 @@ this chip uses the [C64](../4-instrument/c64.md) instrument editor.
## channel status
when enabled, channel status will show an additional icon representing whether currently playing note is audible, and if not, the reason it is muted:
the following icons are displayed when channel status is enabled in the pattern view:
- ![not muted](status-C64-none.png) not muted
- ![gate bit disabled](status-C64-gate-off.png) gate bit disabled
- ![gate bit disabled and test bit enabled](status-C64-gate-off-test-on.png) gate bit disabled and test bit enabled
- ![text bit enabled](status-C64-test-on.png) test bit enabled
- ![ch3off enabled in filter mode](status-C64-ch3off.png) ch3off enabled in filter mode
- channel is silent:
- ![not muted](status-C64-none.png) it's not
- ![gate bit disabled](status-C64-gate-off.png) gate bit disabled
- ![gate bit disabled and test bit enabled](status-C64-gate-off-test-on.png) gate bit disabled and test bit enabled
- ![text bit enabled](status-C64-test-on.png) test bit enabled
- ![ch3off enabled in filter mode](status-C64-ch3off.png) ch3off enabled in filter mode

View file

@ -27,6 +27,8 @@ this chip uses the [PC Engine](../4-instrument/pce.md) instrument editor.
## channel status
when enabled, channel status will show an additional icon representing whether noise mode is enabled:
- ![noise mode off](status-PCE-noise-off.png) noise mode off
- ![noise mode on](status-PCE-noise-on.png) noise mode on
the following icons are displayed when channel status is enabled in the pattern view:
- noise mode (channels 5 and 6 only):
- ![noise mode off](status-PCE-noise-off.png) off
- ![noise mode on](status-PCE-noise-on.png) on

View file

@ -67,16 +67,18 @@ this chip uses the [SNES](../4-instrument/snes.md) instrument editor.
## channel status
when enabled, channel status will show an additional icon representing the gain mode or envelope status of the currently playing note:
- ![direct gain, envelope off](status-SNES-gain-direct.png) direct gain, envelope off
- ![linear gain decrease](status-SNES-gain-dec-lin.png) linear gain decrease
- ![logarithmic gain decrease](status-SNES-gain-dec-log.png) logarithmic gain decrease
- ![linear gain increase](status-SNES-gain-inc-lin.png) linear gain increase
- ![bent-line gain increase](status-SNES-gain-inc-bent.png) bent-line gain increase
- ![envelope attack](status-SNES-env-A.png) envelope attack
- ![envelope decay](status-SNES-env-D.png) envelope decay
- ![envelope sustain](status-SNES-env-S.png) envelope sustain
- ![envelope release](status-SNES-env-R.png) envelope release
the following icons are displayed when channel status is enabled in the pattern view:
- envelope/gain status:
- ![direct gain, envelope off](status-SNES-gain-direct.png) direct gain
- ![linear gain decrease](status-SNES-gain-dec-lin.png) linear gain decrease
- ![logarithmic gain decrease](status-SNES-gain-dec-log.png) logarithmic gain decrease
- ![linear gain increase](status-SNES-gain-inc-lin.png) linear gain increase
- ![bent-line gain increase](status-SNES-gain-inc-bent.png) bent-line gain increase
- ![envelope attack](status-SNES-env-A.png) envelope attack
- ![envelope decay](status-SNES-env-D.png) envelope decay
- ![envelope sustain](status-SNES-env-S.png) envelope sustain
- ![envelope release](status-SNES-env-R.png) envelope release
## ADSR

View file

@ -27,11 +27,14 @@ this chip uses the [WonderSwan](../4-instrument/wonderswan.md) instrument editor
## channel status
when enabled, channel status will show an additional icon representing channel mode:
the following icons are displayed when channel status is enabled in the pattern view:
- ![PCM mode off](status-Swan-PCM-off.png) PCM mode off
- ![PCM mode on](status-Swan-PCM-on.png) PCM mode on
- ![sweep mode off](status-Swan-sweep-off.png) sweep mode off
- ![sweep mode on](status-Swan-sweep-on.png) sweep mode on
- ![noise mode off](status-Swan-noise-off.png) noise mode off
- ![noise mode on](status-Swan-noise-on.png) noise mode on
- PCM mode (channel 2):
- ![PCM mode off](status-Swan-PCM-off.png) off
- ![PCM mode on](status-Swan-PCM-on.png) on
- sweep (channel 3):
- ![sweep mode off](status-Swan-sweep-off.png) disabled
- ![sweep mode on](status-Swan-sweep-on.png) enabled
- noise mode (channel 4):
- ![noise mode off](status-Swan-noise-off.png) off
- ![noise mode on](status-Swan-noise-on.png) on