Merge pull request #1329 from tildearrow/doc-settings

Settings doc updates.
This commit is contained in:
tildearrow 2023-08-09 00:05:14 -05:00 committed by GitHub
commit fb4bb3e2d4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -11,21 +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** - **Power-saving mode**: saves power by lowering the frame rate to 2fps when idle.
- 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!)** - **Disable threaded input (restart after changing!)**: processes key presses for note preview on a separate thread (on supported platforms), which reduces latency.
- threaded input 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 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**
@ -39,11 +37,11 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
- **Initial system**: the system of chips loaded on starting Furnace. - **Initial system**: the system of chips loaded on starting Furnace.
- **Current system**: sets 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**: sets 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.
- system configuration: 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**:
- **Display system preset selector** - **Display system preset selector**
- **Start with initial system** - **Start with initial system**
@ -70,12 +68,12 @@ 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.
@ -209,8 +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 window position**: remembers the window's last position on start-up.
- 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**
@ -236,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
@ -248,13 +245,15 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
- **Pull delete affects entire channel row** - **Pull delete affects entire channel row**
- **Push value when overwriting instead of clearing it**: in the order list and pattern editors, typing into an already-filled value will shift digits instead of starting fresh. - **Push value when overwriting instead of clearing it**: in the order list and pattern editors, typing into an already-filled value will shift digits instead of starting fresh.
- if off: moving the cursor onto the value `A5` and typing a "B" results in `0B`. - if off: moving the cursor onto the value `A5` and typing a "B" results in `0B`.
- if on: with the cursor on the value `A5` and typing a "B" results in `5B`. - if on: moving the cursor onto the value `A5` and typing a "B" results in `5B`.
- **Effect input behavior:** - **Effect input behavior:**
- **Move down** - **Move down**
- **Move to effect value (otherwise move down)** - **Move to effect value (otherwise move down)**
- **Move to effect value/next effect and wrap around** - **Move to effect value/next effect and wrap around**
- **Delete effect value when deleting effect** - **Delete effect value when deleting effect**
- **Change current instrument when changing instrument column (absorb)** - **Change current instrument when changing instrument column (absorb)**
- **Remove instrument value when inserting note off/release**
- **Remove volume value when inserting note off/release**
### Cursor movement ### Cursor movement
@ -293,16 +292,17 @@ 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 if "Automatic UI scaling factor" is off. - **UI scaling factor**: only appears if "Automatic UI scaling factor" is off.
- **Icon size** - **Icon size**
### Text ### Text
- **Main font**: if "Custom...", a file path selector will appear beneath. - **Main font**: overall interface font.\
- **Size** **Header font**: font for section headers.\
- **Pattern font**: if "Custom...", a file path selector will appear beneath. **Pattern font** font for the pattern view, the order list, and related.
- **Size** - if "Custom...", a file path selector will appear.
- **Size**: font size.
- **Display Japanese characters**\ - **Display Japanese characters**\
**Display Chinese (Simplified) characters**\ **Display Chinese (Simplified) characters**\
**Display Chinese (Traditional) characters**\ **Display Chinese (Traditional) characters**\
@ -358,7 +358,7 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
### Channel ### Channel
- **Channel style:** - **Channel style:** sets the appearance of channel headers in pattern view.
- **Classic** - **Classic**
- **Line** - **Line**
- **Round** - **Round**
@ -428,11 +428,11 @@ 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** - **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
- **Chip memory usage unit:** - **Chip memory usage unit:** unit for displaying memory usage in the Statistics window.
- **Bytes** - **Bytes**
- **Kilobytes** - **Kilobytes**
@ -440,15 +440,20 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
- **Rounded corners** - **Rounded corners**
- **Border** - **Border**
- **Fill entire window** - **Mono**: displays a single monaural waveform of all sound mixed together.
- **Waveform goes out of bounds** - if turned off, waves will be drawn on top of each other for each output channel.
- 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.
- **Fill entire window**: removes the gap between the waveform and the edge of the window.
- **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** - **Borders around widgets**: draws thin borders on buttons, checkboxes, text widgets, and the like.