Relinking and new stuff.

This commit is contained in:
Electric Keet 2023-07-16 11:00:20 -07:00
parent 49dbea2d88
commit 7dd36c3d5b
8 changed files with 77 additions and 33 deletions

View file

@ -9,6 +9,7 @@ the default layout of Furnace is depicted below.
primary topics: primary topics:
- [menu bar](menu-bar.md) - [menu bar](menu-bar.md)
- [order list](order-list.md)
- [play/edit controls](play-edit-controls.md) - [play/edit controls](play-edit-controls.md)
- [instrument/wavetable/sample list](asset-list.md) - [instrument/wavetable/sample list](asset-list.md)
- [song information](song-info.md) - [song information](song-info.md)

View file

@ -154,8 +154,8 @@ it's not really useful, unless you're a developer and want to use a command stre
- if a column is already selected, it will select the entire channel. - if a column is already selected, it will select the entire channel.
- if a channel is already selected, it will select the entire pattern. - if a channel is already selected, it will select the entire pattern.
- **operation mask**: this is an advanced feature. see [this page](../3-pattern/opmask.md) for more information. - **operation mask**: toggles which columns will be affected by the listed commands. [more information here.](../8-advanced/opmask.md)
- **input latch**: this is an advanced feature. see [this page](../3-pattern/inputlatch.md) for more information. - **input latch**: determines which data are placed along with a note. [more information here.](../8-advanced/inputlatch.md)
- **note/octave up/down**: transposes notes in the current selection. - **note/octave up/down**: transposes notes in the current selection.
@ -176,7 +176,7 @@ it's not really useful, unless you're a developer and want to use a command stre
- **invert values**: `00` becomes `FF`, `01` becomes `FE`, `02` becomes `FD` and so on. - **invert values**: `00` becomes `FF`, `01` becomes `FE`, `02` becomes `FD` and so on.
- **flip selection**: flips the selection so it is backwards. - **flip selection**: flips the selection so it is backwards.
- **collapse/expand amount**: allows you to specify how much to collapse/expand in the next options. - **collapse/expand amount**: allows you to specify how much to collapse/expand in the next commands.
- **collapse**: shrinks the selected contents. - **collapse**: shrinks the selected contents.
- **expand**: expands the selected contents. - **expand**: expands the selected contents.
@ -188,7 +188,7 @@ it's not really useful, unless you're a developer and want to use a command stre
- **expand song**: same as expand, but affects the entire song. - **expand song**: same as expand, but affects the entire song.
- it also changes speeds and pattern length to compensate. - it also changes speeds and pattern length to compensate.
- **find/replace**: opens the Find/Replace window. see [this page](../3-pattern/find-replace.md) for more information. - **find/replace**: shows [the Find/Replace window](../8-advanced/find-replace.md).
- **clear**: allows you to mass-delete things like songs, instruments and the like. - **clear**: allows you to mass-delete things like songs, instruments and the like.
@ -199,46 +199,42 @@ it's not really useful, unless you're a developer and want to use a command stre
- **basic mode**: toggles [Basic Mode](basic-mode.md). - **basic mode**: toggles [Basic Mode](basic-mode.md).
- **visualizer**: toggles pattern view particle effects when the song plays. - **visualizer**: toggles pattern view particle effects when the song plays.
- **reset layout**: resets the workspace to its defaults. - **reset layout**: resets the workspace to its defaults.
- **settings...**: opens the Settings window. these are detailed in [settings.md]. - **settings...**: shows the Settings window. these are detailed in [settings.md].
# window # window
- **song information**: shows/hides the Song Information window. all these commands show or hide their associated windows.
- **subsongs**: shows/hides the Subsongs window.
- **speed**: shows/hides the Speed window.
- **instruments**: shows/hides the instrument list.
- **wavetables**: shows/hides the wavetable list.
- **samples**: shows/hides the sample list.
- **orders**: shows/hides the Orders window.
- **pattern**: shows/hides the pattern view.
- **mixer**: shows/hides the Mixer window.
- **grooves**: shows/hides the Grooves window.
- **channels**: shows/hides the Channels window.
- **pattern manager**: shows/hides the Pattern Manager window.
- **chip manager**: shows/hides the Chip Manager window.
- **compatibility flags**: shows/hides the Compatibility Flags window.
- **song comments**: shows/hides the Song Comments window.
- **instrument editor**: shows/hides the Instrument Editor - [song information](song-info.md)
- **wavetable editor**: shows/hides the Wavetable Editor. - [subsongs](song-info.md)
- **sample editor**: shows/hides the Sample Editor. - [speed](song-info.md)
- [instruments](../4-instrument/README.md)
- [wavetables](../5-wave/README.md)
- [samples](../6-sample/README.md)
- [orders](order-list.md)
- [pattern](../3-pattern/README.md)
- [mixer](mixer.md)
- [grooves](grooves.md)
- [channels](channels.md)
- [pattern manager](pat-manager.md)
- [chip manager](chip-manager.md)
- [compatibility flags](compat-flags.md)
- [song comments](comments.md)
- **play/edit controls**: shows/hides the Play/Edit Controls. - [piano](piano.md)
- **piano/input pad**: shows/hides the Piano/Input Pad window. - [oscilloscope](osc.md)
- **oscilloscope (master)**: shows/hides the oscilloscope. - [oscilloscopes (per-channel)](chanosc.md)
- **oscilloscope (per-channel)**: shows/hides the per-channel oscilloscope. - [clock](clock.md)
- **volume meter**: shows/hides the volume meter. - [register view](regview.md)
- **clock**: shows/hides the clock. - [log viewer](log-viewer.md)
- **register view**: shows/hides the Register View window. - [stats](stats.md)
- **log viewer**: shows/hides the log Viewer.
- **statistics**: shows/hides the Statistics window.
# help # help
- **effect list**: displays the effect list. - **effect list**: displays the effect list.
- **debug menu**: this menu contains various debug utilities. - **debug menu**: this menu contains various debug utilities.
- unless you are working with the Furnace codebase, it's not useful. - unless you are working with the Furnace codebase, it's not useful.
- **inspector**: this options opens the Dear ImGui Metrics/Debugger window. - **inspector**: this option shows the Dear ImGui Metrics/Debugger window.
- unless you are working with the Furnace codebase, it's not useful. - unless you are working with the Furnace codebase, it's not useful.
- **panic**: this resets all chips while the song is playing, effectively silencing everything. - **panic**: this resets all chips while the song is playing, effectively silencing everything.
- **about...**: displays the About screen. - **about...**: displays the About screen.

View file

@ -0,0 +1,29 @@
# order list
the order list is a playlist for patterns.
![order list](order-list.png)
along the top are the available channels. their abbreviations can be set in the [channels window](../8-advanced/channels.md). the highlighted channel follows the channel the pattern view cursor is in.
along the left are the order numbers. these are referenced with the `0Bxx` command. the highlighted row follows the order the pattern view cursor is in.
each entry in the table is the pattern that will play during that order. these can be changed according to the order edit mode.
hovering over a pattern number will pop up a tooltip showing the name of that pattern, if it has one.
The buttons are as follows:
- **Add new order**.
- **Remove order**.
- **Duplicate order**: adds a new order with patterns matching the selected one directly below it. right-click to "deep clone"; this copies all patterns involved to new ones.
- **Move order up**: swaps the selected order with the one above it.
- **Move order down**: swaps the selected order with the one below it.
- **Duplicate order at end of song**: same as "Duplicate order" except the new order is added at the bottom of the list.
- **Order change mode**: selects how much of the order will change with an edit. only applies if "Order edit mode" is set to "Click to change".
- **one**: only current channel's pattern will change.
- **entire row**: all patterns in the order will change.
- **Order edit mode**: selects the method of changing orders.
- **Click to change**: a click will add one to the pattern number. a right-click will subtract one.
- **Select and type (don't scroll)**: select a pattern and type.
- **Select and type (scroll horizontally)**: as above, but after entering two digits, the cursor moves to the next channel.
- **Select and type (scroll vertically)**: as above, but after entering two digits, the cursor moves to the next order.

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

View file

@ -0,0 +1,11 @@
# input latch
![input latch menu item](inputlatch.png)
input latch determines which data are placed along with a note. as in the pattern view, the columns are note (not changeable), instrument, volume, effect type, and effect value.
- `&&` fills in the currently selected instrument.
- `..` ignores the column.
- all columns (except note) can be reset with a right-click.
- **Set**: sets latch according to the data found at the cursor.
- **Reset**: resets all columns to default (selected instrument, ignore others).
- only the first effect type and effect value may be latched.

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.8 KiB

7
doc/8-advanced/opmask.md Normal file
View file

@ -0,0 +1,7 @@
# operation mask
![operation mask popup](opmask.png)
the operation mask toggles which columns will be affected by the listed commands. as in the pattern view, the columns are note, instrument, volume, effect types, and effect values. the effect toggles apply to all effect columns.
click any area to toggle it. a `---` or `--` means the listed command will ignore any data in that column.

BIN
doc/8-advanced/opmask.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB