More refinements to settings.md

This commit is contained in:
Electric Keet 2023-07-06 15:45:43 -07:00 committed by tildearrow
parent ff40729b18
commit 20a6785f12

View file

@ -24,6 +24,9 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
- **Short**: shows silent title screen briefly. - **Short**: shows silent title screen briefly.
- **Full (short when loading song)**: shows animated musical intro unless started with a song (command line, double-clicking a .fur file, etc.) - **Full (short when loading song)**: shows animated musical intro unless started with a song (command line, double-clicking a .fur file, etc.)
- **Full (always)**: always shows animated musical intro. - **Full (always)**: always shows animated musical intro.
- **When creating new song**:
- **Display system preset selector**
- **Start with initial system**
- **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.
- **Toggle channel solo on:** select which interactions with a channel header will toggle solo for that channel. - **Toggle channel solo on:** select which interactions with a channel header will toggle solo for that channel.
@ -32,6 +35,7 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
- if on: with the cursor on the value `A5` and typing a "B" results in `5B`. - if on: with the cursor on the value `A5` and typing a "B" results in `5B`.
- **Move cursor up on backspace-delete** - **Move cursor up on backspace-delete**
- **Move cursor by edit step on delete** - **Move cursor by edit step on delete**
<!-- coming up in 0.6pre6! -->
<!-- <!--
- **Insert pushes entire channel row** - **Insert pushes entire channel row**
- **Pull delete affects entire channel row** - **Pull delete affects entire channel row**
@ -56,6 +60,7 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
- **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!
<!-- coming up in 0.6pre6! -->
<!-- <!--
- **Late render clear** - **Late render clear**
- calls `rend->clear()` after `rend->present()`. might reduce UI latency by one frame in some drivers. - calls `rend->clear()` after `rend->present()`. might reduce UI latency by one frame in some drivers.
@ -69,6 +74,7 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
- **Save unused patterns** - **Save unused patterns**
- **Compress when saving** - **Compress when saving**
- use zlib to compress saved songs. - use zlib to compress saved songs.
<!-- coming up in 0.6pre6! -->
<!-- <!--
- **Use new pattern format when saving** - **Use new pattern format when saving**
- use a packed format which saves space when saving songs. - use a packed format which saves space when saving songs.
@ -110,14 +116,12 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
# Audio/MIDI # Audio/MIDI
<!-- - **Backend**: select SDL or JACK for audio output.
- **Backend** {{document this}} - only appears on Linux, or MacOS compiled with JACK support
-->
- **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**: {{document this}} - 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.
- **Quality**: selects quality of resampling. low quality reduces CPU load. - **Quality**: selects quality of resampling. low quality reduces CPU load.
@ -125,13 +129,13 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
- **Low-latency mode (experimental!)**: reduces 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**
- **Software clipping**: clips output to nominal range (-1.0 to 1.0) before passing it to the sound 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.
- **want:** requested audio configuration. - **want:** displays requested audio configuration.
- **got:** actual audio configuration returned by audio backend. - **got:** displays actual audio configuration returned by audio backend.
- **MIDI input** - **MIDI input**
- **MIDI output** - **MIDI output**
- **MIDI input settings** - **MIDI input settings**
- **Note input** - **Note input**
- **Velocity input** - **Velocity input**
@ -211,6 +215,10 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
- **SID core** - **SID core**
- **reSID** - **reSID**
- **reSIDfp** - **reSIDfp**
<!-- uncomment upon 0.6pre6! -->
<!--
- **dSID**
-->
- **POKEY core** - **POKEY core**
- **Atari800 (mzpokeysnd)** - **Atari800 (mzpokeysnd)**
- **ASAP (C++ port)** - **ASAP (C++ port)**
@ -234,11 +242,12 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
# Appearance # Appearance
<!-- coming up in 0.6pre6! -->
<!-- <!--
- **Render backend**: {{document this}} - **Render backend**
--> -->
- **Render driver** - **Render driver** <!-- goes away in 0.6pre6! -->
- **Automatic UI scaling factor** - **Automatic UI scaling factor**: automatically match the OS's UI scaling.
- **UI scaling factor**: only if "Automatic UI scaling factor" is off. - **UI scaling factor**: only if "Automatic UI scaling factor" is off.
- **Main font**: if "Custom...", a file path selector will appear beneath. - **Main font**: if "Custom...", a file path selector will appear beneath.
- **Size** - **Size**
@ -249,7 +258,7 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
**Display Chinese (Simplified) characters**\ **Display Chinese (Simplified) characters**\
**Display Chinese (Traditional) characters**\ **Display Chinese (Traditional) characters**\
**Display Korean characters** **Display Korean characters**
- only toggle this option if you have enough graphics memory. - only toggle these options if you have enough graphics memory.
- these are a temporary solution until dynamic font atlas is implemented in Dear ImGui. - these are a temporary solution until dynamic font atlas is implemented in Dear ImGui.
- **Number of recent files** - **Number of recent files**
@ -310,6 +319,7 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
- **Grid** - **Grid**
- **Single (with list)** - **Single (with list)**
- **Single (combo box)** - **Single (combo box)**
<!-- coming up in 0.6pre6! -->
<!-- <!--
- **Chip memory usage unit:** - **Chip memory usage unit:**
- **Bytes** - **Bytes**
@ -360,9 +370,6 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
- **Single-digit effects for 00-0F** - **Single-digit effects for 00-0F**
- **Center pattern view**: centers pattern horizontally in view. - **Center pattern view**: centers pattern horizontally in view.
- **Unsigned FM detune values** - **Unsigned FM detune values**
<!--
- **Add separators between systems in Orders**
-->
- **Highlight channel at cursor in Orders** - **Highlight channel at cursor in Orders**
- **About screen party time** - **About screen party time**
- _warning:_ may cause epileptic seizures. - _warning:_ may cause epileptic seizures.
@ -405,4 +412,6 @@ settings are saved when clicking the **OK** button at the bottom of the dialog.
- **Import** - **Import**
- **Export** - **Export**
- **Reset defaults** - **Reset defaults**
- several categories... - several categories of keybinds...
- click on a keybind then enter a key or key combination to change it
- right-click to clear the keybind