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

more doc updates and fixes

Browse source
This commit is contained in:
tildearrow 2023-09-10 04:41:15 -05:00
parent 4baefa569b
commit c6c692836b
6 changed files with 32 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
doc/2-interface/menu-bar.md
View file

@ -212,21 +212,21 @@ all these menu items show or hide their associated windows.
- [samples](../6-sample/README.md) - [samples](../6-sample/README.md)
- [orders](order-list.md) - [orders](order-list.md)
- [pattern](../3-pattern/README.md) - [pattern](../3-pattern/README.md)
- _[mixer](mixer.md)_ - _[mixer](../8-advanced/mixer.md)_
- _[grooves](grooves.md)_ - _[grooves](../8-advanced/grooves.md)_
- _[channels](channels.md)_ - _[channels](../8-advanced/channels.md)_
- _[pattern manager](pat-manager.md)_ - _[pattern manager](../8-advanced/pat-manager.md)_
- _[chip manager](chip-manager.md)_ - _[chip manager](../8-advanced/chip-manager.md)_
- _[compatibility flags](compat-flags.md)_ - _[compatibility flags](../8-advanced/compat-flags.md)_
- [song comments](comments.md) - [song comments](../8-advanced/comments.md)
- [piano](piano.md) - [piano](../8-advanced/piano.md)
- [oscilloscope](osc.md) - [oscilloscope](../8-advanced/osc.md)
- [oscilloscopes (per-channel)](chanosc.md) - [oscilloscopes (per-channel)](../8-advanced/chanosc.md)
- [clock](clock.md) - [clock](../8-advanced/clock.md)
- [register view](regview.md) - [register view](../8-advanced/regview.md)
- [log viewer](log-viewer.md) - [log viewer](../8-advanced/log-viewer.md)
- [stats](stats.md) - [stats](../8-advanced/stats.md)
# help # help

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

@ -2,14 +2,14 @@
the "Play/Edit Controls" are used to control playback and change parameters of the pattern view. the "Play/Edit Controls" are used to control playback and change parameters of the pattern view.
- ![](control-play.png) **Play**: plays from cursor position. - ![play](control-play.png) **Play**: plays from cursor position.
- ![](control-stop.png) **Stop**: stops all playback. - ![stop](control-stop.png) **Stop**: stops all playback.
- ![](control-play-pattern.png) **Play from the beginning of this pattern**: plays from the start of current pattern. - ![play pattern](control-play-pattern.png) **Play from the beginning of this pattern**: plays from the start of current pattern.
- ![](control-play-repeat.png) **Repeat from the beginning of this pattern**: repeats current pattern from its start. - ![play repeat](control-play-repeat.png) **Repeat from the beginning of this pattern**: repeats current pattern from its start.
- ![](control-step.png) **Step one row**: plays only the row at cursor position and moves down one. - ![step](control-step.png) **Step one row**: plays only the row at cursor position and moves down one.
- ![](control-edit.png) **Edit**: toggles edit mode. when turned off, you won't be able to enter notes. - ![edit](control-edit.png) **Edit**: toggles edit mode. when turned off, you won't be able to enter notes.
- ![](control-metronome.png) **Metronome**: toggles the metronome, which only works during playback. - ![metronome](control-metronome.png) **Metronome**: toggles the metronome, which only works during playback.
- ![](control-repeat.png) **Repeat pattern**: toggles pattern repeat. during playback while this is on, the current pattern will play over and over instead of following the order list. - ![repeat](control-repeat.png) **Repeat pattern**: toggles pattern repeat. during playback while this is on, the current pattern will play over and over instead of following the order list.
- **Poly**: turns on polyphony for previewing notes. toggles to **Mono** for monophony (one note at a time only). - **Poly**: turns on polyphony for previewing notes. toggles to **Mono** for monophony (one note at a time only).
- **Octave**: sets current input octave. - **Octave**: sets current input octave.
- **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. - **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.

8
doc/4-instrument/README.md
View file

@ -20,7 +20,7 @@ the following instrument types are available:
- [FM (OPN)](fm-opn.md) - for use with YM2612, YM2203, YM2608, YM2610 and YM2610B. - [FM (OPN)](fm-opn.md) - for use with YM2612, YM2203, YM2608, YM2610 and YM2610B.
- [Game Boy](game-boy.md) - for use with Game Boy APU. - [Game Boy](game-boy.md) - for use with Game Boy APU.
- [C64](c64.md) - for use with Commodore 64 SID. - [C64](c64.md) - for use with Commodore 64 SID.
- [Generic Sample](amiga.md) for controlling Amiga and other sample channels/chips like YM2612's Channel 6 PCM mode, NES channel 5, Sega PCM, X1-010 and PC Engine's sample playback mode. - [Generic Sample](sample.md) for controlling Amiga and other sample channels/chips like YM2612's Channel 6 PCM mode, NES channel 5, Sega PCM, X1-010 and PC Engine's sample playback mode.
- [PC Engine](pce.md) - for use with PC Engine's wavetable synthesizer. - [PC Engine](pce.md) - for use with PC Engine's wavetable synthesizer.
- [AY-3-8910/SSG](ay8910.md) - for use with AY-3-8910 PSG sound source and SSG portion in YM2610. - [AY-3-8910/SSG](ay8910.md) - for use with AY-3-8910 PSG sound source and SSG portion in YM2610.
- [AY8930](ay8930.md) - for use with Microchip AY8930 E-PSG sound source. - [AY8930](ay8930.md) - for use with Microchip AY8930 E-PSG sound source.
@ -89,9 +89,9 @@ Each macro has two buttons on the left.
Every macro can be defined though one of three methods, selectable with the leftmost button under the macro type label: Every macro can be defined though one of three methods, selectable with the leftmost button under the macro type label:
- ![](macro-button-seq.png) **Sequence:** displayed as a bar graph, this is a sequence of numeric values. - ![sequence](macro-button-seq.png) **Sequence:** displayed as a bar graph, this is a sequence of numeric values.
- ![](macro-button-ADSR.png) **ADSR:** this is a traditional ADSR envelope, defined by the rate of increase and decrease of value over time. - ![ADSR](macro-button-ADSR.png) **ADSR:** this is a traditional ADSR envelope, defined by the rate of increase and decrease of value over time.
- ![](macro-button-LFO.png) **LFO:** the Low Frequency Oscillator generates a repeating wave of values. - ![LFO](macro-button-LFO.png) **LFO:** the Low Frequency Oscillator generates a repeating wave of values.
Some macros are "bitmap" style. They represent a number of "bits" that can be toggled individually, and the values listed represent the sum of which bits are turned on. Some macros are "bitmap" style. They represent a number of "bits" that can be toggled individually, and the values listed represent the sum of which bits are turned on.

8
doc/7-systems/README.md
View file

@ -31,9 +31,9 @@ some systems have alternate chips, such as the Sega Genesis having a YM2612 or Y
<!-- --> <!-- -->
- **Amiga**: [Amiga](amiga.md) - **Amiga**: [Amiga](amiga.md)
<!-- --> <!-- -->
- **Arcade (YM2151 and SegaPCM)**: [YM2151](ym2152.md), [SegaPCM](segapcm.md) - **Arcade (YM2151 and SegaPCM)**: [YM2151](ym2151.md), [SegaPCM](segapcm.md)
<!-- --> <!-- -->
- **Capcom CPS-1**: [YM2151](ym2152.md), [MSM6295](msm6295.md) - **Capcom CPS-1**: [YM2151](ym2151.md), [MSM6295](msm6295.md)
- **Capcom CPS-2 (QSound)**: [QSound](qsound.md) - **Capcom CPS-2 (QSound)**: [QSound](qsound.md)
<!-- --> <!-- -->
- **Neo Geo CD**: [YM2610](ym2610.md) - **Neo Geo CD**: [YM2610](ym2610.md)
@ -46,7 +46,7 @@ some systems have alternate chips, such as the Sega Genesis having a YM2612 or Y
<!-- --> <!-- -->
- **Konami Bubble System**: [AY-3-8910](ay8910.md) × 2, [Konami WSG](bubblesystem.md) - **Konami Bubble System**: [AY-3-8910](ay8910.md) × 2, [Konami WSG](bubblesystem.md)
<!-- --> <!-- -->
- **Sharp X68000**: [YM2151](ym2152.md), [MSM6258](msm6258.md) - **Sharp X68000**: [YM2151](ym2151.md), [MSM6258](msm6258.md)
<!-- --> <!-- -->
- **PC + Sound Blaster Pro**: [YM3812](opl.md) × 2, [DAC](dac.md), [PC Speaker](pcspkr.md) - **PC + Sound Blaster Pro**: [YM3812](opl.md) × 2, [DAC](dac.md), [PC Speaker](pcspkr.md)
<!-- --> <!-- -->
@ -111,7 +111,7 @@ this is the full list of chips that Furnace supports.
- [VRC7, Y8950, YM3526, YM3812 and YMF262 (OPL)](opl.md) - [VRC7, Y8950, YM3526, YM3812 and YMF262 (OPL)](opl.md)
- [YM2413 (OPLL)](opll.md) - [YM2413 (OPLL)](opll.md)
- [YM2414 (OPZ)](opz.md) - [YM2414 (OPZ)](opz.md)
- [YM2151 (OPM)](ym2152.md) - [YM2151 (OPM)](ym2151.md)
- [YM2203 (OPN)](ym2203.md) - [YM2203 (OPN)](ym2203.md)
- [YM2608 (OPNA)](ym2608.md) - [YM2608 (OPNA)](ym2608.md)
- [YM2610 (OPNB)](ym2610.md) - [YM2610 (OPNB)](ym2610.md)

2
doc/7-systems/ym2151.md
View file

@ -4,7 +4,7 @@ the sound chip powering several arcade boards, synthesizers and the Sharp X1/X68
it also was present on several pinball machines and synthesizers of the era, and later surpassed by the YM2414 (OPZ) present in the world-famous TX81Z. it also was present on several pinball machines and synthesizers of the era, and later surpassed by the YM2414 (OPZ) present in the world-famous TX81Z.
in most arcade boards the chip was used in combination with a PCM chip, like [SegaPCM](segapcm.md) or [OKI's line of ADPCM chips](oki6295.md). in most arcade boards the chip was used in combination with a PCM chip, like [SegaPCM](segapcm.md) or [OKI's line of ADPCM chips](msm6295.md).
# effects # effects

2
doc/README.md
View file

@ -14,7 +14,7 @@ the index follows.
8. [advanced topics](8-advanced/README.md) 8. [advanced topics](8-advanced/README.md)
9. [guides](9-guides/README.md) 9. [guides](9-guides/README.md)
# authors ## authors
- cam900 - cam900
- DeMOSic - DeMOSic