Docs updates.

Several small features and such, including updated graphics as needed.
This commit is contained in:
Electric Keet 2025-03-06 13:12:57 -08:00 committed by tildearrow
parent 8ee01d15f7
commit 61d2108745
12 changed files with 12 additions and 7 deletions

View file

@ -313,7 +313,7 @@ cmake -G Xcode ..
once you've created the build directory with `mkdir`, you don't have to do that again. just `cd` to it when you want to build Furnace. once you've created the build directory with `mkdir`, you don't have to do that again. just `cd` to it when you want to build Furnace.
once you ran CMake successfully, you don't have to run it again every time you make a change. just run `make`, `ninja`, `xcodebuild` or `msbuild`. once you've run CMake successfully, you don't have to run it again every time you make a change. just run `make`, `ninja`, `xcodebuild` or `msbuild`.
## CMake options ## CMake options

View file

@ -24,6 +24,8 @@ buttons from left to right:
- **Move down**: same, but downward. - **Move down**: same, but downward.
- **Delete**: deletes the currently selected instrument. pattern data will be adjusted to use the next available instrument in the list. - **Delete**: deletes the currently selected instrument. pattern data will be adjusted to use the next available instrument in the list.
instruments may be dragged and dropped to reorder them. this will change instrument numbers throughout the module accordingly.
## folder view ## folder view
![instruments window in folder view](instruments-folder.png) ![instruments window in folder view](instruments-folder.png)
@ -39,7 +41,7 @@ right-clicking on a folder allows one to rename or delete it. deleting a folder
![wavetables window](wavetables.png) ![wavetables window](wavetables.png)
everything from the instrument list applies here also, with one major difference: moving waves around with the buttons will change their associated numbers in the list but **not** in pattern or instrument data. be careful! everything from the instrument list applies here also, with one major difference: moving waves around with the buttons or dragging them will change their associated numbers in the list but **not** in pattern or instrument data. be careful!
wavetables are saved as Furnace wavetable (.fuw) files. wavetables are saved as Furnace wavetable (.fuw) files.

View file

@ -64,6 +64,7 @@ the menu bar allows you to select from five menus: file, edit, settings, window
- **randomize**: replaces the selection with random values. - **randomize**: replaces the selection with random values.
- does not affect the note column. - does not affect the note column.
- **Nibble mode**: when enabled, the randomization will be per-nibble (0 to F) rather than per-value (00 to FF). - **Nibble mode**: when enabled, the randomization will be per-nibble (0 to F) rather than per-value (00 to FF).
- **Set effect:**: only appears when the selection includes an effect column. if enabled, an input box will appear. instead of being randomized, all effect types in the selection will be changed to the value entered.
- **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 two menu items. - **collapse/expand amount**: allows you to specify how much to collapse/expand in the next two menu items.

View file

@ -284,6 +284,7 @@ below all the binds, select a key from the dropdown list to add it. it will appe
- **Double-click time (seconds)**: maximum time between mouse clicks to recognize them as a double-click. - **Double-click time (seconds)**: maximum time between mouse clicks to recognize them as a double-click.
- **Don't raise pattern editor on click** - **Don't raise pattern editor on click**
- **Focus pattern editor when selecting instrument** - **Focus pattern editor when selecting instrument**
- **Draggable instruments/samples/waves:** allow dragging and dropping assets within their lists to reorder them.
- **Note preview behavior:** allows you to disable note preview when entering notes in the pattern. - **Note preview behavior:** allows you to disable note preview when entering notes in the pattern.
- **Never**: don't preview notes at all. - **Never**: don't preview notes at all.
- **When cursor is in Note column**: only when the cursor is in the Note column - **When cursor is in Note column**: only when the cursor is in the Note column

View file

@ -27,12 +27,13 @@ Amiga | ≤256 | 256 |
![wavetable editor](wave-editor.png) ![wavetable editor](wave-editor.png)
controls across the top line: controls across the top line:
- waveform number. the `-` and `+` buttons step through the list. - waveform number: the `-` and `+` buttons step through the list.
- open. opens a file selector to choose the file to open. - open: opens a file selector to choose the file to open.
- save. opens a file selector to choose the file to save to. - save: opens a file selector to choose the file to save to.
- right-clicking brings up a menu: - right-clicking brings up a menu:
- **save as .dmw...**: saves the selected wavetable in DefleMask format. - **save as .dmw...**: saves the selected wavetable in DefleMask format.
- **save raw...**: saves the selected wavetable as raw data. - **save raw...**: saves the selected wavetable as raw data.
- create sample from wavetable: copies wavetable to a new looped sample.
- **Steps**: view waveform as discrete blocks. - **Steps**: view waveform as discrete blocks.
- **Lines**: view waveform as a continuous line. - **Lines**: view waveform as a continuous line.
- **Width**: length of the waveform data. maximum is 256. - **Width**: length of the waveform data. maximum is 256.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 109 KiB

After

Width:  |  Height:  |  Size: 109 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 127 KiB

After

Width:  |  Height:  |  Size: 127 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 106 KiB

After

Width:  |  Height:  |  Size: 106 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 38 KiB

View file

@ -1,5 +1,5 @@
# statistics # statistics
the Statistics window shows audio load (CPU used by emulation/playback). the Statistics window shows current audio load (CPU used by emulation/playback) and a chart of audio load over the last two seconds.
![statistics window](stats.png) ![statistics window](stats.png)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.6 KiB

After

Width:  |  Height:  |  Size: 11 KiB

View file

@ -36,4 +36,4 @@ you may reproduce, modify and/or distribute this documentation provided this cop
this documentation is provided as-is and without warranty of any kind. this documentation is provided as-is and without warranty of any kind.
**note:** online documentation may include new features in development or other information that doesn't apply to the most current release. the PDF included with Furnace will be most accurate to that release.