diff --git a/doc/8-advanced/channels.md b/doc/8-advanced/channels.md index 7bf4fbf72..a57698559 100644 --- a/doc/8-advanced/channels.md +++ b/doc/8-advanced/channels.md @@ -1,11 +1,12 @@ # channels -The "Channels" dialog allows manipulation of the song's channels. +the "Channels" dialog allows manipulation of the song's channels. ![channels dialog](channels.png) -Each channel has the following options: -- **Visible**: uncheck the box to hide the channel from view. Pattern data will be kept. -- Crossed-arrows button: Click and drag to rearrange pattern data throughout the song. _Note:_ This does _not_ move channels around within a chip! It only affects pattern data. +each channel has the following options: +- **Visible**: uncheck the box to hide the channel from view. pattern data will be kept. +- crossed-arrows button: click and drag to rearrange pattern data throughout the song. + - note: this does _not_ move channels around within a chip! it only affects pattern data. - **Name** is the name displayed at the top of each channel in the tracker view. -- To the right of that is the abbreviation used above each channel in the order view. \ No newline at end of file +- to the right of that is the abbreviation used above each channel in the order view. diff --git a/doc/8-advanced/chanosc.md b/doc/8-advanced/chanosc.md index f58ae2960..631fa5d09 100644 --- a/doc/8-advanced/chanosc.md +++ b/doc/8-advanced/chanosc.md @@ -35,7 +35,7 @@ right-clicking within the view will change it to the configuration view shown ab - `%V`: volume (percentage) - `%b`: volume (hex) - `%%`: percent sign -- The OK button returns from options view to the oscilloscopes. +- the OK button returns from options view to the oscilloscopes. ## gradient diff --git a/doc/8-advanced/chip-manager.md b/doc/8-advanced/chip-manager.md index 722f3a973..d0cb89943 100644 --- a/doc/8-advanced/chip-manager.md +++ b/doc/8-advanced/chip-manager.md @@ -1,15 +1,15 @@ # chip manager -The **chip manager** window does exactly what it says. +the **chip manager** window does exactly what it says. ![chip manager](chip-manager.png) -**Preserve channel order**: Make existing pattern data stay in place even when chips are rearranged. If turned off, pattern data will rearrange to match (the default, and usually the desired behavior). +**Preserve channel order**: make existing pattern data stay in place even when chips are rearranged. if turned off, pattern data will rearrange to match (the default, and usually the desired behavior). -To move a chip around, click and drag the ![crossed-arrows](chip-manager-move.png) button to its left. +to move a chip around, click and drag the ![crossed-arrows](chip-manager-move.png) button to its left. -To replace a chip with a different one, click the ![down-angle](chip-manager-change.png) and select the replacement. +to replace a chip with a different one, click the ![down-angle](chip-manager-change.png) and select the replacement. -To remove a chip entirely, click the ![X](chip-manager-remove.png) button. +to remove a chip entirely, click the ![X](chip-manager-remove.png) button. -Click a chip's name to open its options, where one can set clock rate, chip variant, and other specifics. \ No newline at end of file +click a chip's name to open its options, where one can set clock rate, chip variant, and other specifics. \ No newline at end of file diff --git a/doc/8-advanced/clock.md b/doc/8-advanced/clock.md index 8c2bcc7cd..e9a512d28 100644 --- a/doc/8-advanced/clock.md +++ b/doc/8-advanced/clock.md @@ -2,7 +2,7 @@ ![clock dialog](clock.png) -The clock shows the current playback position relative to the start of the song: +the clock shows the current playback position relative to the start of the song: - order : row - measure : beat (as defined by row highlight settings) diff --git a/doc/8-advanced/comments.md b/doc/8-advanced/comments.md index 3fc14d590..2c53bf7c1 100644 --- a/doc/8-advanced/comments.md +++ b/doc/8-advanced/comments.md @@ -2,7 +2,7 @@ ![comments dialog](comments.png) -Comments, credits, or any arbitrary text may be entered here.\ -It has no effect on the song. +comments, credits, or any arbitrary text may be entered here.\ +it has no effect on the song. -There is no word wrap; long lines must be broken manually with the Enter key. \ No newline at end of file +there is no word wrap; long lines must be broken manually with the Enter key. \ No newline at end of file diff --git a/doc/8-advanced/grooves.md b/doc/8-advanced/grooves.md index 200681ee6..60762c561 100644 --- a/doc/8-advanced/grooves.md +++ b/doc/8-advanced/grooves.md @@ -1,26 +1,26 @@ # grooves -Grooves are macros for speed. +grooves are macros for speed. -A **groove** is the equivalent of repeating `0Fxx` commands on each row to get a cycle of speeds. For example, a groove of "6 4 5 3" makes the first row 6 ticks long, the next row 4 ticks, then 5, 3, 6, 4, 5, 3... +a **groove** is the equivalent of repeating `0Fxx` commands on each row to get a cycle of speeds. for example, a groove of "6 4 5 3" makes the first row 6 ticks long, the next row 4 ticks, then 5, 3, 6, 4, 5, 3... ![groove](groove.png) -To set the song's groove: -- Open the "Speed" window. -- Click the "Speed" button so it becomes "Speeds" (effectively a groove of two speeds). -- Click again so it becomes "Groove". -- Enter a sequence of up to 16 speeds. +to set the song's groove: +- open the "Speed" window. +- click the "Speed" button so it becomes "Speeds" (effectively a groove of two speeds). +- click again so it becomes "Groove". +- enter a sequence of up to 16 speeds. ![groove patterns](grooves.png) -The "Grooves" window is for entering preset groove patterns. -- The **`+`** button adds a new groove pattern; click in the pattern to edit it. -- The **`×`** buttons remove them. +the "Grooves" window is for entering preset groove patterns. +- the **`+`** button adds a new groove pattern; click in the pattern to edit it. +- the **`×`** buttons remove them. -A single `09xx` command will switch to the matching numbered groove pattern. +a single `09xx` command will switch to the matching numbered groove pattern. ## BPM @@ -28,7 +28,7 @@ this is a non-exhaustive list of grooves and their equivalent BPM. _note:_ this table assumes a song's tick rate setting is left at its default value for the chosen engine speed: 60 for NTSC, or 50 for PAL. -BPM NTSC | BPM PAL | groove | | BPM NTSC | BPM PAL | groove +bPM NTSC | BPM PAL | groove | | BPM NTSC | BPM PAL | groove --------:|--------:|:-----------------------|-|---------:|--------:|:---------------------- 100.00 | 83.33 | 9 | | 168.75 | 140.63 | 6, 5, 5 102.86 | 85.71 | 9, 9, 9, 8 | | 171.43 | 142.86 | 6, 5, 5, 5 diff --git a/doc/8-advanced/log-viewer.md b/doc/8-advanced/log-viewer.md index 4f1e1e4b6..275cc1c92 100644 --- a/doc/8-advanced/log-viewer.md +++ b/doc/8-advanced/log-viewer.md @@ -1,12 +1,12 @@ # log viewer -The log viewer provides a look at Furnace's internal messages. This can be useful for chasing down problems. +the log viewer provides a look at Furnace's internal messages. this can be useful for chasing down problems. ![log viewer dialog](log-viewer.png) -If the **Follow** checkbox is enabled, the log will snap to the bottom and continually scroll to show the newest messages. If disabled, it will stay put on what's currently shown. +if the **Follow** checkbox is enabled, the log will snap to the bottom and continually scroll to show the newest messages. if disabled, it will stay put on what's currently shown. -The **Level** dropdown determines the minimum importance of the messages displayed. +the **Level** dropdown determines the minimum importance of the messages displayed. | level | message shown | |---|---| diff --git a/doc/8-advanced/mixer.md b/doc/8-advanced/mixer.md index bafa0fe8d..55beca2a1 100644 --- a/doc/8-advanced/mixer.md +++ b/doc/8-advanced/mixer.md @@ -1,6 +1,6 @@ # mixer -The "Mixer" dialog provides options for overall sound mixing. +the "Mixer" dialog provides options for overall sound mixing. ## "Mixer" tab @@ -8,18 +8,18 @@ The "Mixer" dialog provides options for overall sound mixing. "Master Volume" controls the overall mix. -Each chip has several options: -- **Invert**: Flips the output wave. -- **Volume**: Controls the chip's volume relative to other chips. -- **Panning**: Left-right sound control. -- **Front/Rear**: Front-read sound control. Only useful for setups with four or more speakers. +each chip has several options: +- **Invert**: flips the output wave. +- **Volume**: controls the chip's volume relative to other chips. +- **Panning**: left-right sound control. +- **Front/Rear**: front-read sound control. only useful for setups with four or more speakers. ## "Patchbay" tab ![mixer dialog on patchbay tab](mixer-patchbay.png) -- **Automatic patchbay**: Make appropriate connections when adding, removing, or changing chips and chip settings. -- **Display hidden ports**: Shows all available connection ports. The "System" unit actually has 16 ports; 1 maps to the left channel, and 2 maps to the right. +- **Automatic patchbay**: make appropriate connections when adding, removing, or changing chips and chip settings. +- **Display hidden ports**: shows all available connection ports. the "System" unit actually has 16 ports; 1 maps to the left channel, and 2 maps to the right. - **Display internal**: hows two additional units, one for sample previews and one for the metronome sound. -The graph shows each existing unit along with their outputs, inputs, and the "patch cables" connecting them. Connections can be made by dragging between an output and an input. Right-clicking on a unit gives the option to disconnect all patches from that unit. +the graph shows each existing unit along with their outputs, inputs, and the "patch cables" connecting them. connections can be made by dragging between an output and an input. right-clicking on a unit gives the option to disconnect all patches from that unit. diff --git a/doc/8-advanced/osc.md b/doc/8-advanced/osc.md index fe90e3971..db625e71c 100644 --- a/doc/8-advanced/osc.md +++ b/doc/8-advanced/osc.md @@ -1,9 +1,9 @@ # oscilloscope -The Oscilloscope shows the waveform of the mix of all currently playing sounds. +the Oscilloscope shows the waveform of the mix of all currently playing sounds. ![oscilloscope view](osc.png) -Right-clicking on the oscilloscope toggles the adjustment sliders: +right-clicking on the oscilloscope toggles the adjustment sliders: - waveform height zoom - width of viewed audio (window size) in milliseconds. diff --git a/doc/8-advanced/pat-manager.md b/doc/8-advanced/pat-manager.md index ea058e667..79b854a48 100644 --- a/doc/8-advanced/pat-manager.md +++ b/doc/8-advanced/pat-manager.md @@ -1,6 +1,6 @@ # pattern manager -The pattern manager is useful for cleaning up stray patterns and as an overview of pattern usage. +the pattern manager is useful for cleaning up stray patterns and as an overview of pattern usage. ![pattern manager dialog](pattern-manager.png) @@ -8,7 +8,7 @@ The pattern manager is useful for cleaning up stray patterns and as an overview **Re-arrange patterns** renumbers patterns to be in sequence, along with changing all references in the order list to match. -The pattern grid shows each channel and all its patterns. These are color-coded to show how much they're used in the song; these colors can be changed in Settings. +the pattern grid shows each channel and all its patterns. these are color-coded to show how much they're used in the song; these colors can be changed in Settings. | default color | name in Settings | meaning | | --- | --- | --- | @@ -19,4 +19,4 @@ The pattern grid shows each channel and all its patterns. These are color-coded | orange | Really overused | used in half or more orders | | magenta | Combo Breaker | the only used pattern in this channel! | -Right-clicking a pattern will permanently delete it. +right-clicking a pattern will permanently delete it. diff --git a/doc/8-advanced/piano.md b/doc/8-advanced/piano.md index 4218ef083..b437a9820 100644 --- a/doc/8-advanced/piano.md +++ b/doc/8-advanced/piano.md @@ -1,33 +1,33 @@ # piano / input pad -The piano serves as a non-keyboard interface to input notes. +the piano serves as a non-keyboard interface to input notes. ![piano chart](piano.png) -The buttons at the left do the following: +the buttons at the left do the following: | | | | | :---: | :---: | :---: | | move one octave down | move one octave up | open options | | fewer visible octaves | more visible octaves | swap buttons | -When swapped, the bottons do the following: +when swapped, the bottons do the following: | | | | | :---: | :---: | :---: | | input note off | input note release | open options | | input macro release | delete | swap buttons | -Every C key is labelled with its octave. +every C key is labelled with its octave. -Right-clicking on the piano keys will make the buttons disappear; right-clicking again brings them back. +right-clicking on the piano keys will make the buttons disappear; right-clicking again brings them back. ## options -Key layout: +key layout: - **Automatic** -- **Standard**: Black keys are 2/3 length. -- **Continuous**: Black keys are full length. +- **Standard**: black keys are 2/3 length. +- **Continuous**: black keys are full length. -**Share play/edit offset/range**: If disabled, the piano will keep different octave and range values for playback and non-playback states. -**Read-only (can't input notes): Prevents note entry. \ No newline at end of file +**Share play/edit offset/range**: if disabled, the piano will keep different octave and range values for playback and non-playback states. +**Read-only (can't input notes): prevents note entry. \ No newline at end of file diff --git a/doc/8-advanced/regview.md b/doc/8-advanced/regview.md index 57f526fb3..e9d92c972 100644 --- a/doc/8-advanced/regview.md +++ b/doc/8-advanced/regview.md @@ -1,5 +1,5 @@ # register view -During playback, "Register View" shows the hex data involved with each chip's operation. +during playback, "Register View" shows the hex data involved with each chip's operation. ![register view dialog](register.png) diff --git a/doc/8-advanced/stats.md b/doc/8-advanced/stats.md index 9f3c5f490..01bc78775 100644 --- a/doc/8-advanced/stats.md +++ b/doc/8-advanced/stats.md @@ -1,5 +1,5 @@ # statistics -The Statistics dialog shows running stats such as overall audio processing load and per-chip sample memory. +the Statistics dialog shows running stats such as overall audio processing load and per-chip sample memory. ![statistics dialog](stats.png)