otomatalabs/furnace
8
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Revisions to doc updates.

Browse source
This commit is contained in:
Electric Keet 2025-11-16 21:09:03 -08:00 • committed by tildearrow
parent f8872b9386
commit ba84c60034
9 changed files with 29 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/2-interface/effect-list-window.md
View file

@ -7,7 +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.
- filter bar: search for 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.
- **None**: don't show any effects.

36
doc/2-interface/export.md
View file

@ -4,42 +4,44 @@ Furnace allows you to export your song in several formats. this section deals wi
## audio
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.
this option allows you to export your song to another audio format.
- **Export type**:
- **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.
- **multiple files (one per chip)**: exports the output of each chip to separate files.
- **multiple files (one per channel)**: exports the output of each channel to separate files.
- 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.
- **File Format**: select the output file 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.
- integer formats should be supported by all players, but are clipped to -1.0/+1.0 range.
- float formats are supported by most software players and have infinite range, but take more space.
- **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.
- **Channels in file**: default is 2 (stereo). set to 1 for mono.
- **Opus**: modern lossy compressed .ogg format. better audio quality than MP3 or Vorbis. not supported by all players, especially Apple devices.
- **Channels in file**: default is 2 (stereo). set to 1 for mono.
- **Bit rate**: higher numbers result in better quality sound at the cost of 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.
- **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
- **Vorbis**: lossy compressed .ogg format. better quality sound than MP3 with smaller file size. fairly common support except for Apple devices.
- **Sample rate**: affects the quality of the output file. see above.
- **Channels in file**: default is 2 (stereo). Set to 1 for mono.
- **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.
- **MP3**: lossy compressed .mp3 format. an old standard for compressed audio; it enjoys widespread support but has poor quality.
- **Sample rate**: affects the quality of the output file. see above.
- **Channels in file**: default is 2 (stereo). Set to 1 for mono.
- **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.
- **Bit rate**: higher numbers result in better quality sound at the cost of larger file size. default is 128000.
- **Variable**: bit rate adapts to the content. generates smaller files for the same quality. not all players support this mode.
- **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.
- **Average**: a compromise; the steady bit rate of "constant" with higher quality, but less efficiently compressed than "variable". not all players support this mode.
- **Bit rate**: higher numbers result in better quality sound at the cost of 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.

2
doc/2-interface/play-edit-controls.md
View file

@ -14,7 +14,7 @@ the "Play/Edit Controls" are used to control playback and change parameters of t
- 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.
- **Chord**: chord input. same 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.

4
doc/2-interface/settings.md
View file

@ -95,7 +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.
- **Load sample fine tuning when importing a sample**: if the file has note tuning information, it will be loaded. may result in glitches with some samples.
## Audio
@ -105,7 +105,7 @@ 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.
- ASIO: Audio Stream Input/Output. 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.