diff --git a/doc/8-advanced/channels.md b/doc/8-advanced/channels.md index e69de29bb..b2686960a 100644 --- a/doc/8-advanced/channels.md +++ b/doc/8-advanced/channels.md @@ -0,0 +1,11 @@ +# 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. +- "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 diff --git a/doc/8-advanced/channels.png b/doc/8-advanced/channels.png new file mode 100644 index 000000000..69fa2e995 Binary files /dev/null and b/doc/8-advanced/channels.png differ diff --git a/doc/8-advanced/chanosc.md b/doc/8-advanced/chanosc.md index e69de29bb..acc8a4fc4 100644 --- a/doc/8-advanced/chanosc.md +++ b/doc/8-advanced/chanosc.md @@ -0,0 +1,16 @@ +# oscilloscope (per channel) + +The "Oscilloscope (per channel)" dialog shows an individual oscilloscope for each channel during playback. + +![oscilloscope per-channel configuration view](chanosc.png) + +Right-clicking within the view will change it to the configuration view shown above: +- "Columns" sets the number of columns the view will be split into. +- "Size (ms)" sets what length of audio is visible in each oscilloscope. +- "Center waveform" does its best to latch to the channel's note frequency and centers the display. +- "Gradient" is presently unimplemented. +- The color selector allows setting the waveform color. Right-clicking on it pops up an option dialog: + - Select between the square selector and the color wheel selector. + - "Alpha bar" adds a transparency selector. +- The boxes below that are for selecting colors numerically by red-green-blue-alpha, hue-saturation-value-alpha, and HTML-style RGBA in hex. +- The OK button returns from options view to regular. diff --git a/doc/8-advanced/chanosc.png b/doc/8-advanced/chanosc.png new file mode 100644 index 000000000..f7a75ae91 Binary files /dev/null and b/doc/8-advanced/chanosc.png differ diff --git a/doc/8-advanced/chip-manager-change.png b/doc/8-advanced/chip-manager-change.png new file mode 100644 index 000000000..dc1561155 Binary files /dev/null and b/doc/8-advanced/chip-manager-change.png differ diff --git a/doc/8-advanced/chip-manager-move.png b/doc/8-advanced/chip-manager-move.png new file mode 100644 index 000000000..6d59cbf43 Binary files /dev/null and b/doc/8-advanced/chip-manager-move.png differ diff --git a/doc/8-advanced/chip-manager-remove.png b/doc/8-advanced/chip-manager-remove.png new file mode 100644 index 000000000..6ea5c5f04 Binary files /dev/null and b/doc/8-advanced/chip-manager-remove.png differ diff --git a/doc/8-advanced/chip-manager.md b/doc/8-advanced/chip-manager.md index e69de29bb..4b08e49f5 100644 --- a/doc/8-advanced/chip-manager.md +++ b/doc/8-advanced/chip-manager.md @@ -0,0 +1,15 @@ +# chip manager + +The **chip manager** window does exactly what it says. + +![chip manager](chip-manager.png) + +"Preserve channel order" will 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 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. + +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/chip-manager.png b/doc/8-advanced/chip-manager.png new file mode 100644 index 000000000..3f86f3a67 Binary files /dev/null and b/doc/8-advanced/chip-manager.png differ diff --git a/doc/8-advanced/clock.md b/doc/8-advanced/clock.md index e69de29bb..8c2bcc7cd 100644 --- a/doc/8-advanced/clock.md +++ b/doc/8-advanced/clock.md @@ -0,0 +1,10 @@ +# clock + +![clock dialog](clock.png) + +The clock shows the current playback position relative to the start of the song: + +- order : row +- measure : beat (as defined by row highlight settings) +- beat +- elapsed time in minutes:seconds.hundredths diff --git a/doc/8-advanced/clock.png b/doc/8-advanced/clock.png new file mode 100644 index 000000000..834eacaa0 Binary files /dev/null and b/doc/8-advanced/clock.png differ diff --git a/doc/8-advanced/comments.md b/doc/8-advanced/comments.md index e69de29bb..b36d65ab8 100644 --- a/doc/8-advanced/comments.md +++ b/doc/8-advanced/comments.md @@ -0,0 +1,8 @@ +# comments + +![comments dialog](comments.png) + +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 diff --git a/doc/8-advanced/comments.png b/doc/8-advanced/comments.png new file mode 100644 index 000000000..0559c6ba4 Binary files /dev/null and b/doc/8-advanced/comments.png differ diff --git a/doc/8-advanced/compat-flags.md b/doc/8-advanced/compat-flags.md index e69de29bb..6f2380dd3 100644 --- a/doc/8-advanced/compat-flags.md +++ b/doc/8-advanced/compat-flags.md @@ -0,0 +1,5 @@ +# compatibility flags + +The "Compatibility Flags" window contains several tabs full of settings that change aspects of tracking and playback. A new Furnace file will leave them all at their defaults (off), while opening a DefleMask, Amiga MOD, or earlier Furnace file will automatically set the appropriate options. + +Hovering over most options will bring up additional info about them. It's not recommended to change any of these without clear reason. _There be dragons here._ diff --git a/doc/8-advanced/log-viewer.md b/doc/8-advanced/log-viewer.md index e69de29bb..07d7960ed 100644 --- a/doc/8-advanced/log-viewer.md +++ b/doc/8-advanced/log-viewer.md @@ -0,0 +1,17 @@ +# log viewer + +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. + +The "Level" dropdown determines the minimum importance of the messages displayed. + +| level | message shown | +|---|---| +| ERROR | serious problem | +| warning | may or may not be a problem | +| info | significant information | +| debug | general info about what Furnace is doing | +| trace | detailed info useful only to developers | diff --git a/doc/8-advanced/log-viewer.png b/doc/8-advanced/log-viewer.png new file mode 100644 index 000000000..711205704 Binary files /dev/null and b/doc/8-advanced/log-viewer.png differ diff --git a/doc/8-advanced/mixer-mixer.png b/doc/8-advanced/mixer-mixer.png new file mode 100644 index 000000000..27574804c Binary files /dev/null and b/doc/8-advanced/mixer-mixer.png differ diff --git a/doc/8-advanced/mixer-patchbay.png b/doc/8-advanced/mixer-patchbay.png new file mode 100644 index 000000000..bd73cd832 Binary files /dev/null and b/doc/8-advanced/mixer-patchbay.png differ diff --git a/doc/8-advanced/mixer.md b/doc/8-advanced/mixer.md index e69de29bb..e0c68a8d6 100644 --- a/doc/8-advanced/mixer.md +++ b/doc/8-advanced/mixer.md @@ -0,0 +1,25 @@ +# mixer + +The "Mixer" dialog provides options for overall sound mixing. + +## "Mixer" tab + +![mixer dialog on mixer tab](mixer-mixer.png) + +"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" is for left-right control. +- "Front/Rear" does as it says, is only useful for setups with four or more speakers. + +## "Patchbay" tab + +![mixer dialog on patchbay tab](mixer-patchbay.png) + +- "Automatic patchbay" will 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" shows 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. diff --git a/doc/8-advanced/osc.md b/doc/8-advanced/osc.md index e69de29bb..fe90e3971 100644 --- a/doc/8-advanced/osc.md +++ b/doc/8-advanced/osc.md @@ -0,0 +1,9 @@ +# oscilloscope + +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: +- waveform height zoom +- width of viewed audio (window size) in milliseconds. diff --git a/doc/8-advanced/osc.png b/doc/8-advanced/osc.png new file mode 100644 index 000000000..dbf485075 Binary files /dev/null and b/doc/8-advanced/osc.png differ diff --git a/doc/8-advanced/pat-manager.md b/doc/8-advanced/pat-manager.md index e69de29bb..c9304d43b 100644 --- a/doc/8-advanced/pat-manager.md +++ b/doc/8-advanced/pat-manager.md @@ -0,0 +1,22 @@ +# pattern manager + +The pattern manager is useful for cleaning up stray patterns and as an overview of pattern usage. + +![pattern manager dialog](pattern-manager.png) + +"De-duplicate patterns" looks for matching patterns, eliminates all but the first instance, and changes all references in the order list to match. + +"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. + +| default color | name in Settings | meaning | +| --- | --- | --- | +| grey | Unallocated | pattern doesn't exist yet | +| red | Unused | exists but isn't in order list | +| green | Used | used only once in order list | +| yellow | Overused | used multiple times | +| 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. diff --git a/doc/8-advanced/pattern-manager.png b/doc/8-advanced/pattern-manager.png new file mode 100644 index 000000000..4df068111 Binary files /dev/null and b/doc/8-advanced/pattern-manager.png differ diff --git a/doc/8-advanced/piano.md b/doc/8-advanced/piano.md index e69de29bb..bb75ca3d5 100644 --- a/doc/8-advanced/piano.md +++ b/doc/8-advanced/piano.md @@ -0,0 +1,38 @@ +# piano / input pad + +The piano serves as a non-keyboard interface to input notes. + +![piano chart](piano.png) + +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: + +| | | | +| :---: | :---: | :---: | +| input note off | input note release | open options | +| input macro release | delete | swap buttons | + +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. + +## options + +Key layout: +- [Automatic] +- [Standard]: Black keys are 2/3 length. +- [Continuous]: Black keys are full length. + +Value input pad: (document this) +- [Disabled] +- [Replace piano] +- [Split (automatic)] +- [Split (always visible)] + +[Share play/edit offset/range]: (document this) diff --git a/doc/8-advanced/piano.png b/doc/8-advanced/piano.png new file mode 100644 index 000000000..d905dd74b Binary files /dev/null and b/doc/8-advanced/piano.png differ diff --git a/doc/8-advanced/register.png b/doc/8-advanced/register.png new file mode 100644 index 000000000..df68b667e Binary files /dev/null and b/doc/8-advanced/register.png differ diff --git a/doc/8-advanced/regview.md b/doc/8-advanced/regview.md index e69de29bb..57f526fb3 100644 --- a/doc/8-advanced/regview.md +++ b/doc/8-advanced/regview.md @@ -0,0 +1,5 @@ +# register view + +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 e69de29bb..9f3c5f490 100644 --- a/doc/8-advanced/stats.md +++ b/doc/8-advanced/stats.md @@ -0,0 +1,5 @@ +# statistics + +The Statistics dialog shows running stats such as overall audio processing load and per-chip sample memory. + +![statistics dialog](stats.png) diff --git a/doc/8-advanced/stats.png b/doc/8-advanced/stats.png new file mode 100644 index 000000000..9c11db264 Binary files /dev/null and b/doc/8-advanced/stats.png differ