Merge pull request #1443 from tildearrow/doc-general

Small documentation fixes and improvements.
This commit is contained in:
tildearrow 2023-08-31 00:20:18 -05:00 committed by GitHub
commit 5140acd51f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 11 additions and 16 deletions

View File

@ -39,14 +39,8 @@ items in _italics_ don't appear in basic mode and are only available in advanced
- only available when there's a YM2151 and/or VERA. - only available when there's a YM2151 and/or VERA.
- **export command stream...**: export song data to a command stream file. see next section for more details. - **export command stream...**: export song data to a command stream file. see next section for more details.
- this option is for developers. - this option is for developers.
- _**add chip...**:_ add a chip to the current song. - **manage chips**: opens the [Chip Manager](../8-advanced/chip-manager.md) dialog.
- _**configure chip...**:_ set a chip's parameters.
- for a list of parameters, see [7-systems](../7-systems/README.md).
- _**change chip...**:_ change a chip to another.
- **Preserve channel positions**: enable this option to make sure Furnace does not auto-arrange/delete channels to compensate for differing channel counts. this can be useful for doing ports, e.g. from Genesis to PC-98.
- _**remove chip...**_: remove a chip.
- **Preserve channel positions**: same thing as above.
- **restore backup**: restores a previously saved backup. - **restore backup**: restores a previously saved backup.
- Furnace keeps up to 5 backups of a song. - Furnace keeps up to 5 backups of a song.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 72 KiB

After

Width:  |  Height:  |  Size: 80 KiB

View File

@ -193,7 +193,7 @@ settings are saved when clicking the **OK** or **Apply** buttons at the bottom o
- **Import** - **Import**
- **Export** - **Export**
- **Reset defaults** - **Reset defaults**
- several categories of keybinds... - [grouped list of keybinds...](keyboard.md)
- click on a keybind then enter a key or key combination to change it - click on a keybind then enter a key or key combination to change it
- right-click to clear the keybind - right-click to clear the keybind
@ -327,6 +327,7 @@ settings are saved when clicking the **OK** or **Apply** buttons at the bottom o
- **Cursor details or file path** - **Cursor details or file path**
- **Nothing** - **Nothing**
- **Capitalize menu bar** - **Capitalize menu bar**
- **Display add/configure/change/remove chip menus in File menu**: if enabled, the "manage chips" item in the file menu is split into the four listed items for quick access.
### Orders ### Orders

View File

@ -50,8 +50,9 @@ The very first numeric entry sets the visible width of the bars in sequence-type
Each macro has two buttons on the left. Each macro has two buttons on the left.
- Macro type (explained below). - Macro type (explained below).
- Timing editor, which pops up a small dialog: - Timing editor, which pops up a small dialog:
- Step Length (ticks): Determines how many ticks pass before each change of value. - Step Length (ticks): Determines how many ticks pass before each change of value. Default is 1.
- Delay: Delays the start of the macro until this many ticks have passed. - Delay: Delays the start of the macro until this many ticks have passed. Default is 0.
- The button is highlighted if either of these is set differently from default.
## macro types ## macro types

View File

@ -22,11 +22,10 @@ These apply to the instrument as a whole:
- Right-click returns to algorithm view. - Right-click returns to algorithm view.
- **DC (half-sine carrier)**: Sets the waveform produced by carrier operator to half-sine - **DC (half-sine carrier)**: Sets the waveform produced by carrier operator to half-sine
- **DM (half-sine modulator)**: Sets the waveform produced by modulator operator to half-sine - **DM (half-sine modulator)**: Sets the waveform produced by modulator operator to half-sine
- preset dropdown: select OPLL preset instrument. - preset dropdown: selects OPLL preset instrument.
These apply to each operator: These apply to each operator:
- The crossed-arrows button can be dragged to rearrange operators. - The crossed-arrows button can be dragged to rearrange operators.
- The **OP1** and **OP2** buttons enable or disable those operators.
- **Amplitude Modulation (AM)**: Makes the operator affected by LFO tremolo. - **Amplitude Modulation (AM)**: Makes the operator affected by LFO tremolo.
- **Envelope generator sustain flag (EGS)**: When enabled, value of Sustain Level is in effect. - **Envelope generator sustain flag (EGS)**: When enabled, value of Sustain Level is in effect.
- **Attack Rate (AR)**: determines the rising time for the sound. The bigger the value, the faster the attack. (0-15 range) - **Attack Rate (AR)**: determines the rising time for the sound. The bigger the value, the faster the attack. (0-15 range)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 31 KiB

View File

@ -20,7 +20,7 @@ these tabs are unique to the editor for SNES instruments.
- **Delayed (write R on release)**: after release, waits until A and D have completed before starting exponential decrease. - **Delayed (write R on release)**: after release, waits until A and D have completed before starting exponential decrease.
if envelope is off: if envelope is off:
- **Gain Mode**: select gain mode. - **Gain Mode**: selects gain mode.
- **Direct**: direct gain from 0 to 127 - **Direct**: direct gain from 0 to 127
- **Decrease (linear)**: linear gain from -0 to -31 - **Decrease (linear)**: linear gain from -0 to -31
- **Decrease (logarithmic)**: exponential gain from -0 to -31 - **Decrease (logarithmic)**: exponential gain from -0 to -31

View File

@ -111,7 +111,7 @@ input waveforms should match the size of the wavetable or unexpected results may
- synthesizer type: selects the synthesis algorithm. - synthesizer type: selects the synthesis algorithm.
- waveform displays. - waveform displays.
- **Wave 1**: selects input waveform. - **Wave 1**: selects input waveform.
- this will turn yellow to indicate that a Waveform macro is set; remove the macro to work with the synthesizer. - this will turn yellow to indicate that a Waveform macro is set.
- **Wave 2**: selects second input waveform. only appears when a dual-waveform synthesizer is selected. - **Wave 2**: selects second input waveform. only appears when a dual-waveform synthesizer is selected.
- **Pause preview**: toggles live waveform preview. - **Pause preview**: toggles live waveform preview.
- **Restart preview**: restarts preview from initial state. - **Restart preview**: restarts preview from initial state.

View File

@ -184,7 +184,7 @@ this chip uses the [TIA](../4-instrument/tia.md) instrument editor.
| 30 | 32.7 | C-1 | 0.0 | 32.5 | C-1 | -11 | 30 | 32.7 | C-1 | 0.0 | 32.5 | C-1 | -11
| 31 | 31.7 | B-0 | +44 | 31.5 | B-0 | +33 | 31 | 31.7 | B-0 | +44 | 31.5 | B-0 | +33
## shapes 8 ## shape 8
| pitch | NTSC | note | cent | PAL | note | cent | pitch | NTSC | note | cent | PAL | note | cent
|------:|--------:|:----:|-----:|--------:|:----:|-----: |------:|--------:|:----:|-----:|--------:|:----:|-----: