From a2be33396cd96f6711e7578c1647827a674bd26c Mon Sep 17 00:00:00 2001 From: Electric Keet Date: Wed, 1 Nov 2023 15:23:49 -0700 Subject: [PATCH] Adjustments to channel status docs. --- doc/3-pattern/README.md | 19 +++++++++++-------- doc/7-systems/c64.md | 4 ++-- doc/7-systems/pce.md | 2 +- doc/7-systems/snes.md | 2 +- doc/7-systems/wonderswan.md | 2 +- 5 files changed, 16 insertions(+), 13 deletions(-) diff --git a/doc/3-pattern/README.md b/doc/3-pattern/README.md index 89e1f6e5d..d9dcb0121 100644 --- a/doc/3-pattern/README.md +++ b/doc/3-pattern/README.md @@ -38,16 +38,21 @@ 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 dialog to set view modes: -- **Effect columns/collapse**: as shown above. adds buttons: +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: - **-**: 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. - **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 beneath the names of channels that function together in some way. -- **Visualizer**: during playback, show visual effects depending on activity in each channel. - - also can be toggled by a right-click on the `++` button. -- **Channel status**: a bar with icons that indicate activity in the channel. +- **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. + - also can be toggled by right-clicking on the `++` button. +- **Channel status**: displays icons that indicate activity in the channel. see the "channel status" section below. + +to rename and/or hide channels, open [the Channels window](../8-advanced/channels.md) via the window menu. + +### channel status + - note status: - ![note off](status-note-off.png) note off - ![note on](status-note-on.png) note on @@ -66,8 +71,6 @@ clicking the `++` at the top left corner of the pattern view pops up a small dia - ![tremolo](status-volume-tremolo.png) tremolo - other icons depending on chip. -to rename and/or hide channels, open [the Channels window](../8-advanced/channels.md) via the window menu. - ## input diff --git a/doc/7-systems/c64.md b/doc/7-systems/c64.md index ba1d0fcf0..8df123e42 100644 --- a/doc/7-systems/c64.md +++ b/doc/7-systems/c64.md @@ -71,10 +71,10 @@ 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, why it is muted: +when enabled, channel status will show an additional icon representing whether currently playing note is audible, and if not, the reason it is muted: - ![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) text 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 diff --git a/doc/7-systems/pce.md b/doc/7-systems/pce.md index 9948f21e7..01e0f5978 100644 --- a/doc/7-systems/pce.md +++ b/doc/7-systems/pce.md @@ -27,6 +27,6 @@ this chip uses the [PC Engine](../4-instrument/pce.md) instrument editor. ## channel status -when enabled, channel status will show an additional icon representing the noise mode of the currently playing note: +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 diff --git a/doc/7-systems/snes.md b/doc/7-systems/snes.md index a8414f87f..2c45a4a05 100644 --- a/doc/7-systems/snes.md +++ b/doc/7-systems/snes.md @@ -67,7 +67,7 @@ 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 and envelope status of the currently playing note: +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 diff --git a/doc/7-systems/wonderswan.md b/doc/7-systems/wonderswan.md index 287ca7136..34984be22 100644 --- a/doc/7-systems/wonderswan.md +++ b/doc/7-systems/wonderswan.md @@ -27,7 +27,7 @@ this chip uses the [WonderSwan](../4-instrument/wonderswan.md) instrument editor ## channel status -when enabled, channel status will show an additional icon representing the mode of the currently playing note: +when enabled, channel status will show an additional icon representing channel mode: - ![PCM mode off](status-Swan-PCM-off.png) PCM mode off - ![PCM mode on](status-Swan-PCM-on.png) PCM mode on