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

Switching to non-imperative tone.

Browse source
This commit is contained in:
Electric Keet 2023-08-07 18:04:01 -07:00
parent 7c53d330e6
commit 8db16af621
1 changed files with 27 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -11,19 +11,19 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
- **Render backend** - **Render backend**
- changing this may help with performace issues. - changing this may help with performace issues.
- **Late render clear** - **Late render clear**
- **Power-saving mode**: save power by lowering the frame rate to 2fps when idle. - **Power-saving mode**: saves power by lowering the frame rate to 2fps when idle.
- may cause issues under Mesa drivers! - may cause issues under Mesa drivers!
- **Disable threaded input (restart after changing!)**: process key presses for note preview on a separate thread (on supported platforms), which reduces latency. - **Disable threaded input (restart after changing!)**: processes key presses for note preview on a separate thread (on supported platforms), which reduces latency.
- however, crashes have been reported when threaded input is on. enable this option if that is the case. - however, crashes have been reported when threaded input is on. enable this option if that is the case.
- **Enable event delay** - **Enable event delay**
- may cause issues with high-polling-rate mice when previewing notes. - may cause issues with high-polling-rate mice when previewing notes.
### File ### File
- **Use system file picker**: use native OS file dialog instead of Furnace's. - **Use system file picker**: uses native OS file dialog instead of Furnace's.
- **Number of recent files**: number of files to show in the _open recent..._ menu. - **Number of recent files**: number of files to show in the _open recent..._ menu.
- **Compress when saving** - **Compress when saving**
- use zlib to compress saved songs. - uses zlib to compress saved songs.
- **Save unused patterns** - **Save unused patterns**
- **Use new pattern format when saving** - **Use new pattern format when saving**
- **Don't apply compatibility flags when loading .dmf** - **Don't apply compatibility flags when loading .dmf**
@ -36,10 +36,10 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
### Chip ### Chip
- **Initial system**: the system of chips loaded on starting Furnace. - **Initial system**: the system of chips loaded on starting Furnace.
- **Current system**: set current chips as default. - **Current system**: sets current chips as default.
- **Randomize**: set default to a random system. - **Randomize**: sets default to a random system.
- this will not choose a random system at each start. - this will not choose a random system at each start.
- **Reset to defaults**: set default to "Sega Genesis/Mega Drive". - **Reset to defaults**: sets default to "Sega Genesis/Mega Drive".
- **Name**: name for the default system. may be set to any text. - **Name**: name for the default system. may be set to any text.
- **Configure:**: same as in the [chip manager](../8-advanced/chip-manager.md) and [mixer](../8-advanced/mixer.md). - **Configure:**: same as in the [chip manager](../8-advanced/chip-manager.md) and [mixer](../8-advanced/mixer.md).
- **When creating new song**: - **When creating new song**:
@ -68,16 +68,16 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
### Output ### Output
- **Backend**: select SDL or JACK for audio output. - **Backend**: selects SDL or JACK for audio output.
- only appears on Linux, or MacOS compiled with JACK support - only appears on Linux, or MacOS compiled with JACK support
- **Driver** - **Driver**
- **Device**: audio device for playback. - **Device**: audio device for playback.
- **Sample rate** - **Sample rate**
- **Outputs**: select number of audio outputs created, up to 16. - **Outputs**: number of audio outputs created, up to 16.
- only appears when Backend is JACK. - only appears when Backend is JACK.
- **Channels**: number of output channels to use. - **Channels**: number of output channels to use.
- **Buffer size**: size of buffer in both samples and milliseconds. - **Buffer size**: size of buffer in both samples and milliseconds.
- **Low-latency mode (experimental!)**: reduce latency by running the engine faster than the tick rate. useful for live playback/jam mode. - **Low-latency mode (experimental!)**: reduces latency by running the engine faster than the tick rate. useful for live playback/jam mode.
- _warning:_ experimental! may produce glitches. only enable if your buffer size is small (10ms or less). - _warning:_ experimental! may produce glitches. only enable if your buffer size is small (10ms or less).
- **Force mono audio** - **Force mono audio**
- **want:** displays requested audio configuration. - **want:** displays requested audio configuration.
@ -85,8 +85,8 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
### Mixing ### Mixing
- **Quality**: select quality of resampling. low quality reduces CPU load. - **Quality**: selects quality of resampling. low quality reduces CPU load.
- **Software clipping**: clip output to nominal range (-1.0 to 1.0) before passing it to the audio device. - **Software clipping**: clips output to nominal range (-1.0 to 1.0) before passing it to the audio device.
- this avoids activating Windows' built-in limiter. - this avoids activating Windows' built-in limiter.
### Metronome ### Metronome
@ -134,7 +134,7 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
- **Control** - **Control**
- **Volume curve** - **Volume curve**
- **Actions:** - **Actions:**
- **`+`** button: add a new action. - **`+`** button: adds a new action.
- window-with-arrow button: new action with learning! press a button or move a slider/knob/something on your device. - window-with-arrow button: new action with learning! press a button or move a slider/knob/something on your device.
- each action has the following: - each action has the following:
- **Type** - **Type**
@ -207,7 +207,7 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
- **Export**: writes current layout to a .ini file. - **Export**: writes current layout to a .ini file.
- **Reset**: resets layout to default. - **Reset**: resets layout to default.
- **Allow docking editors** - **Allow docking editors**
- **Remember window position**: remember the window's last position on start-up. - **Remember window position**: remembers the window's last position on start-up.
- **Only allow window movement when clicking on title bar** - **Only allow window movement when clicking on title bar**
- **Play/edit controls layout:** - **Play/edit controls layout:**
- **Classic** - **Classic**
@ -233,7 +233,7 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
- **No** - **No**
- **Yes** - **Yes**
- **Yes (while holding Ctrl only)** - **Yes (while holding Ctrl only)**
- **Toggle channel solo on:** select which interactions with a channel header will toggle solo for that channel. - **Toggle channel solo on:** selects which interactions with a channel header will toggle solo for that channel.
- Right-click or double click - Right-click or double click
- Right-click - Right-click
- Double-click - Double-click
@ -292,7 +292,7 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
### Scaling ### Scaling
- **Automatic UI scaling factor**: automatically match the OS's UI scaling. - **Automatic UI scaling factor**: automatically matches the OS's UI scaling.
- **UI scaling factor**: only appears if "Automatic UI scaling factor" is off. - **UI scaling factor**: only appears if "Automatic UI scaling factor" is off.
- **Icon size** - **Icon size**
@ -334,7 +334,7 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
### Pattern ### Pattern
- **Center pattern view**: center pattern horizontally in view. - **Center pattern view**: centers pattern horizontally in view.
- **Overflow pattern highlights** - **Overflow pattern highlights**
- **Display previous/next pattern** - **Display previous/next pattern**
- **Pattern row number format:** - **Pattern row number format:**
@ -358,7 +358,7 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
### Channel ### Channel
- **Channel style:** set the appearance of channel headers in pattern view. - **Channel style:** sets the appearance of channel headers in pattern view.
- **Classic** - **Classic**
- **Line** - **Line**
- **Round** - **Round**
@ -428,7 +428,7 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
- **Between Decay and Sustain Rate** - **Between Decay and Sustain Rate**
- **After Release Rate** - **After Release Rate**
- **Use separate colors for carriers/modulators in FM editor** - **Use separate colors for carriers/modulators in FM editor**
- **Unsigned FM detune values**: use internal representation of detune values, such that detune amounts of -1, -2, and -3 are shown as 5, 6, and 7. - **Unsigned FM detune values**: uses the internal representation of detune values, such that detune amounts of -1, -2, and -3 are shown as 5, 6, and 7.
### Statistics ### Statistics
@ -440,19 +440,20 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
- **Rounded corners** - **Rounded corners**
- **Border** - **Border**
- **Mono**: display a single monaural waveform of all sound mixed together. - **Mono**: displays a single monaural waveform of all sound mixed together.
- if turned off, waves will be drawn on top of each other for each output channel. their colors are configurable via _Settings > Color > Color scheme > Oscilloscope > Wave (non-mono)._ - if turned off, waves will be drawn on top of each other for each output channel.
- **Anti-aliased**: smooth the lines of the waveform. - all colors are configurable via _Settings > Color > Color scheme > Oscilloscope > Wave (non-mono)._
- **Anti-aliased**: smoothes the lines of the waveform.
- slight performance cost and slightly buggy. - slight performance cost and slightly buggy.
- **Fill entire window**: remove the gap between the waveform and the edge of the window. - **Fill entire window**: removes the gap between the waveform and the edge of the window.
- **Waveform goes out of bounds**: allow the waveform to draw past the top and bottom of the oscilloscope. - **Waveform goes out of bounds**: allows the waveform to draw past the top and bottom of the oscilloscope.
### Windows ### Windows
- **Rounded window corners** - **Rounded window corners**
- **Rounded buttons** - **Rounded buttons**
- **Rounded menu corners** - **Rounded menu corners**
- **Borders around widgets**: draw thin borders on buttons, checkboxes, text widgets, and the like. - **Borders around widgets**: draws thin borders on buttons, checkboxes, text widgets, and the like.
@ -467,5 +468,5 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
- **Color scheme type:** - **Color scheme type:**
- **Dark** - **Dark**
- **Light** - **Light**
- **Frame shading**: apply a gradient effect to buttons and input boxes. - **Frame shading**: applies a gradient effect to buttons and input boxes.
- several more categories... - several more categories...