Documentation updates.
My, an awful lot has changed!
This commit is contained in:
Electric Keet
tildearrow
parent
0d396d4416
commit
ad38e7cdfe
27 changed files with 144 additions and 65 deletions
|
|
@ -7,4 +7,7 @@ this window provides a list of the effects that are available.
|
|||
for more details about these effects, see [the effects page](../3-pattern/effects.md).
|
||||
|
||||
- **Chip at cursor**: the currently selected chip. the list only shows available effects for this chip.
|
||||
- filter bar: type to filter the list to show only matching effects.
|
||||
- menu button: opens a small list of effect categories. toggle each to change whether effects belonging to such categories will be shown in the list.
|
||||
- **All**: show all effects.
|
||||
- **None**: show no effects.
|
||||
|
|
|
|||
|
|
@ -7,16 +7,39 @@ Furnace allows you to export your song in several formats. this section deals wi
|
|||
this option allows you to export your song in .wav format. I know I know, no .mp3 or .ogg export yet, but you can use a converter.
|
||||
|
||||
- **Export type**:
|
||||
- **one file**: exports your song to one .wav file.
|
||||
- **multiple files (one per chip)**: exports the output of each chip to .wav files.
|
||||
- **multiple files (one per channel)**: exports the output of each channel to .wav files.
|
||||
- useful for usage with a channel visualizer such as corrscope.
|
||||
- **Bit depth**: default is 16-bit integer.
|
||||
- **Sample rate**: affects the quality of the output file.
|
||||
- default is 44100, "CD quality".
|
||||
- lower sample rates lose fidelity as upper frequencies disappear.
|
||||
- higher sample rates gain frequencies that can't be heard at the cost of file size and rendering time.
|
||||
- **Channels in file**: default is 2 (stereo). Set to 1 for mono.
|
||||
- **one file**: exports your song to a single file.
|
||||
- **multiple files (one per chip)**: exports the output of each chip to its own file.
|
||||
- **multiple files (one per channel)**: exports the output of each channel to its own file.
|
||||
- ideal for use with a channel visualizer such as [corrscope](https://github.com/corrscope/corrscope).
|
||||
- **File Format**: select the output format. each format has its own options.
|
||||
- **Wave**: lossless uncompressed .wav format. largest file size but perfect quality. most useful for files that will need further editing.
|
||||
- **Bit depth**: default is 16-bit integer.
|
||||
- **Sample rate**: affects the quality of the output file.
|
||||
- default is 44100, "CD quality".
|
||||
- lower sample rates lose fidelity as upper frequencies disappear.
|
||||
- higher sample rates gain frequencies that can't be heard at the cost of file size and rendering time.
|
||||
- **Channels in file**: default is 2 (stereo). Set to 1 for mono.
|
||||
- **Opus**: lossy compressed .opus format. smaller size than either MP3 or Vorbis for better quality sound, but less common support than other formats.
|
||||
- **Channels in file**: default is 2 (stereo). Set to 1 for mono.
|
||||
- **Bit rate**: higher numbers generate better quality sound and larger file size. default is 128000.
|
||||
- **FLAC (Free Lossless Audio Codec)**: lossless compressed .flac format. good for archival or editing, as it preserves original sound data.
|
||||
- **Sample rate**: affects the quality of the output file. see above.
|
||||
- **Channels in file**: default is 2 (stereo). Set to 1 for mono.
|
||||
- **Compression level**: higher levels take slightly longer to pack but yield much better compression. default is 6.0.
|
||||
- **Vorbis**: lossy compressed .ogg format. better quality sound than MP3 with smaller file size. fairly common support
|
||||
- **Sample rate**: affects the quality of the output file. see above.
|
||||
- **Channels in file**: default is 2 (stereo). Set to 1 for mono.
|
||||
- **Quality**: compression rate. higher numbers produce larger files of higher fidelity. default is 8.0.
|
||||
- **MP3**: lossy compressed .mp3 format. it's the old standard; worst quality for the file size, but it sees the most widespread support and use.
|
||||
- **Sample rate**: affects the quality of the output file. see above.
|
||||
- **Channels in file**: default is 2 (stereo). Set to 1 for mono.
|
||||
- **Bit rate mode**:
|
||||
- **Constant**: fixed bit rate regardless of content. default.
|
||||
- **Bit rate**: higher numbers generate better quality sound and larger file size. default is 128000.
|
||||
- **Variable**: bit rate adapts to the content. generates smaller files for the same quality.
|
||||
- **Quality**: higher numbers produce larger files of higher fidelity. default is 6.0.
|
||||
- **Average**: a compromise; the steady bit rate of "constant" with higher quality, but less efficiently compressed than "variable".
|
||||
- **Bit rate**: higher numbers generate better quality sound and larger file size. default is 128000.
|
||||
- **Loops**: sets the number of times the song will loop.
|
||||
- does not have effect if the song ends with `FFxx` effect.
|
||||
- **Fade out (seconds)**: sets the fade out time when the song is over.
|
||||
|
|
|
|||
|
|
@ -33,6 +33,7 @@ the keys in the "Global hotkeys" section can be used in any window, although not
|
|||
| Decrease edit step | `Ctrl-Keypad /` |
|
||||
| Toggle edit mode | `Space` |
|
||||
| Metronome | `Ctrl-M` |
|
||||
| Toggle order lock | — |
|
||||
| Toggle repeat pattern | — |
|
||||
| Follow orders | — |
|
||||
| Follow pattern | — |
|
||||
|
|
@ -75,6 +76,9 @@ the keys in the "Global hotkeys" section can be used in any window, although not
|
|||
| Effect List | — |
|
||||
| Debug Menu | `Ctrl-Shift-D` |
|
||||
| Command Stream Player | — |
|
||||
| Reference Music Player | — |
|
||||
| Tuner | — |
|
||||
| Spectrum | — |
|
||||
| About | — |
|
||||
| Collapse/expand current window | — |
|
||||
| Close current window | `Shift-Escape` |
|
||||
|
|
|
|||
|
|
@ -115,6 +115,8 @@ all these menu items show or hide their associated windows.
|
|||
- **[oscilloscope (per-channel)](../8-advanced/chanosc.md)**
|
||||
- **[oscilloscope (X-Y)](../8-advanced/xyosc.md)**
|
||||
- volume meter
|
||||
- **[tuner](../8-advanced/tuner.md)**
|
||||
- **[spectrum](../8-advanced/spectrum.md)**
|
||||
- tempo
|
||||
- **[clock](../8-advanced/clock.md)**
|
||||
- **[grooves](../8-advanced/grooves.md)**
|
||||
|
|
@ -127,6 +129,8 @@ all these menu items show or hide their associated windows.
|
|||
- **[effect list](../3-pattern/effects.md)**
|
||||
- **[play/edit controls](play-edit-controls.md)**
|
||||
- **[piano/input pad](../8-advanced/piano.md)**
|
||||
- **[reference music player](../8-advanced/refPlayer.md)**
|
||||
- **[multi-ins setup](../8-advanced/multi-ins.md)**
|
||||
|
||||
## help
|
||||
|
||||
|
|
|
|||
|
|
@ -8,10 +8,14 @@ the "Play/Edit Controls" are used to control playback and change parameters of t
|
|||
-  **Repeat from the beginning of this pattern**: repeats current pattern from its start.
|
||||
-  **Step one row**: plays only the row at cursor position and moves down one.
|
||||
-  **Edit**: toggles edit mode. when turned off, you won't be able to enter notes.
|
||||
-  **Lock**: toggles the cursor lock, which keeps the cursor in the currently selected order.
|
||||
-  **Lock**: toggles the order lock, which keeps the cursor in the currently selected order.
|
||||
-  **Metronome**: toggles the metronome, which only works during playback.
|
||||
-  **Repeat pattern**: toggles pattern repeat. during playback while this is on, the current pattern will play over and over instead of following the order list.
|
||||
- **Poly**: turns on polyphony for previewing notes. toggles to **Mono** for monophony (one note at a time only).
|
||||
- polyphony toggle: cycles through the following options.
|
||||
- **Mono**: monophony. preview one note at a time only.
|
||||
- **Poly**: polyphony. preview multiple notes at once, using other channels of the same type on the same chip. default.
|
||||
- **Chord**: chord input. as polyphony, with the added feature that while keys are held, notes past the first are entered on the same row in adjacent channels.
|
||||
- some keyboards have limits on the number of keys that can be held at the same time. this is not a Furnace issue.
|
||||
- **Octave**: sets current input octave.
|
||||
- **Edit Step**: sets edit step. if this is 1, entering a note or effect will move to the next row. if this is a larger number, rows will be skipped. if this is 0, the cursor will stay in place.
|
||||
- if clicked, Step becomes **Coarse**, which sets the number of rows moved with `PgUp`, `PgDn`, and related movement shortcuts. clicking again will revert it to Step.
|
||||
|
|
|
|||
|
|
@ -87,6 +87,7 @@ settings are saved when clicking the **OK** or **Apply** buttons at the bottom o
|
|||
- **New instruments are blank**: when enabled, adding FM instruments will make them blank (rather than loading the default one).
|
||||
|
||||
### Configuration
|
||||
|
||||
- **Import**: select an exported `.ini` config file to overwrite current settings.
|
||||
- **Export**: select an `.ini` file to save current settings.
|
||||
- **Factory Reset**: resets all settings to default and purges settings backups.
|
||||
|
|
@ -94,6 +95,7 @@ settings are saved when clicking the **OK** or **Apply** buttons at the bottom o
|
|||
### Import
|
||||
|
||||
- **Use OPL3 instead of OPL2 for S3M import**: changes which system is used for the import of S3M files that contain FM channels.
|
||||
- **Load sample fine tuning when importing a sample**: as it says. may result in glitches with some samples.
|
||||
|
||||
## Audio
|
||||
|
||||
|
|
@ -103,6 +105,8 @@ settings are saved when clicking the **OK** or **Apply** buttons at the bottom o
|
|||
- SDL: the default one.
|
||||
- JACK: the JACK Audio Connection Kit (low-latency audio server). only appears on Linux, or MacOS compiled with JACK support.
|
||||
- PortAudio: this may or may not perform better than the SDL backend.
|
||||
- ASIO: Audio Stream Input/Output. extremely low latency, if your system has a driver for it. after selecting it, click "Apply" to see available devices.
|
||||
- **Control Panel**: opens the ASIO driver's control panel. you must first select a device and click "Apply".
|
||||
- **Driver**: select a different audio driver if you're having problems with the default one.
|
||||
- only appears when Backend is SDL.
|
||||
- **Device**: audio device for playback.
|
||||
|
|
@ -576,6 +580,16 @@ below all the binds, select a key from the dropdown list to add it. it will appe
|
|||
|
||||
- **Show channel indicators**: chooses whether to show the row "LED" channel indicators in the chip manager.
|
||||
|
||||
### Mixer
|
||||
|
||||
- **Mixer layout:**
|
||||
- **Horizontal**: a horizontal arrangement of tall mixer sliders.
|
||||
- **Vertical**: a vertical stack of wide mixer sliders. default.
|
||||
- **Mixer style:**
|
||||
- **No volume meters**
|
||||
- **Volume meters separate**: default.
|
||||
- **Volume meters in volume sliders**
|
||||
|
||||
### Windows
|
||||
|
||||
- **Rounded window corners**
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue