diff --git a/doc/2-interface/asset-add.png b/doc/2-interface/asset-add.png new file mode 100644 index 00000000..f6ef5b73 Binary files /dev/null and b/doc/2-interface/asset-add.png differ diff --git a/doc/2-interface/asset-delete.png b/doc/2-interface/asset-delete.png new file mode 100644 index 00000000..d0eb8dd9 Binary files /dev/null and b/doc/2-interface/asset-delete.png differ diff --git a/doc/2-interface/asset-duplicate.png b/doc/2-interface/asset-duplicate.png new file mode 100644 index 00000000..caa740fb Binary files /dev/null and b/doc/2-interface/asset-duplicate.png differ diff --git a/doc/2-interface/asset-folderview.png b/doc/2-interface/asset-folderview.png new file mode 100644 index 00000000..8d693e0f Binary files /dev/null and b/doc/2-interface/asset-folderview.png differ diff --git a/doc/2-interface/asset-list.md b/doc/2-interface/asset-list.md index 44c3fefa..3b4d9e6f 100644 --- a/doc/2-interface/asset-list.md +++ b/doc/2-interface/asset-list.md @@ -3,21 +3,20 @@ ![instruments window](instruments.png) Buttons from left to right: -- **Add:** Creates a new, default instrument. -- **Duplicate:** Duplicates the currently selected instrument. -- **Open:** Brings up a file dialog to load a file as a new instrument at the end of the list. -- **Save:** Brings up a file dialog to save the currently selected instrument. -- **Toggle folders/standard view:** Enables (and disables) folder view, explained below. -- **Move up:** Moves the currently selected instrument up in the list. Pattern data will automatically be adjusted to match. -- **Move down:** Same, but downward. -- **Delete:** Deletes the currently selected instrument. Pattern data will be adjusted to use the next available instrument in the list. +- ![](asset-add.png) **Add:** Creates a new, default instrument. +- ![](asset-duplicate.png) **Duplicate:** Duplicates the currently selected instrument. +- ![](asset-open.png) **Open:** Brings up a file dialog to load a file as a new instrument at the end of the list. +- ![](asset-save.png) **Save:** Brings up a file dialog to save the currently selected instrument. +- ![](asset-folderview.png) **Toggle folders/standard view:** Enables (and disables) folder view, explained below. +- ![](asset-move.png) **Move up** and **Move down:** Moves the currently selected instrument in the list. Pattern data will automatically be adjusted to match. +- ![](asset-delete.png) **Delete:** Deletes the currently selected instrument. Pattern data will be adjusted to use the next available instrument in the list. ## folder view ![instruments window in folder view](instruments-folder.png) -In folder view, the "Move up" and "Move down buttons disappear and a new one appears: -- **New Folder:** Creates a new folder. +In folder view, the "Move up" and "Move down" buttons disappear and a new one appears: +- ![](asset-newfolder.png) **New Folder:** Creates a new folder. Instruments may be dragged from folder to folder and even rearranged within folders without changing their associated numbers. @@ -34,5 +33,5 @@ Everything from the instrument list applies here also, with one major difference ![samples window](samples.png) Everything from the wavetables list applies here also, with the addition of two buttons: -- **Preview:** Plays the selected sample at its default note. -- **Stop preview:** Stops the sample playback. +- ![](asset-preview.png) **Preview:** Plays the selected sample at its default note. +- ![](asset-previewstop.png) **Stop preview:** Stops the sample playback. diff --git a/doc/2-interface/asset-move.png b/doc/2-interface/asset-move.png new file mode 100644 index 00000000..fdcbca6a Binary files /dev/null and b/doc/2-interface/asset-move.png differ diff --git a/doc/2-interface/asset-newfolder.png b/doc/2-interface/asset-newfolder.png new file mode 100644 index 00000000..01540abd Binary files /dev/null and b/doc/2-interface/asset-newfolder.png differ diff --git a/doc/2-interface/asset-open.png b/doc/2-interface/asset-open.png new file mode 100644 index 00000000..eea98514 Binary files /dev/null and b/doc/2-interface/asset-open.png differ diff --git a/doc/2-interface/asset-preview.png b/doc/2-interface/asset-preview.png new file mode 100644 index 00000000..8636285c Binary files /dev/null and b/doc/2-interface/asset-preview.png differ diff --git a/doc/2-interface/asset-previewstop.png b/doc/2-interface/asset-previewstop.png new file mode 100644 index 00000000..02fe6498 Binary files /dev/null and b/doc/2-interface/asset-previewstop.png differ diff --git a/doc/2-interface/asset-save.png b/doc/2-interface/asset-save.png new file mode 100644 index 00000000..19dd03e9 Binary files /dev/null and b/doc/2-interface/asset-save.png differ diff --git a/doc/2-interface/control-edit.png b/doc/2-interface/control-edit.png index 35fce78c..e3e2d177 100644 Binary files a/doc/2-interface/control-edit.png and b/doc/2-interface/control-edit.png differ diff --git a/doc/2-interface/control-metronome.png b/doc/2-interface/control-metronome.png index 0c667256..51822c0e 100644 Binary files a/doc/2-interface/control-metronome.png and b/doc/2-interface/control-metronome.png differ diff --git a/doc/2-interface/control-play-pattern.png b/doc/2-interface/control-play-pattern.png index a6eb5d01..a11f0aab 100644 Binary files a/doc/2-interface/control-play-pattern.png and b/doc/2-interface/control-play-pattern.png differ diff --git a/doc/2-interface/control-play-repeat.png b/doc/2-interface/control-play-repeat.png index 853cdcff..fc286590 100644 Binary files a/doc/2-interface/control-play-repeat.png and b/doc/2-interface/control-play-repeat.png differ diff --git a/doc/2-interface/control-play.png b/doc/2-interface/control-play.png index feafe168..c258b5fd 100644 Binary files a/doc/2-interface/control-play.png and b/doc/2-interface/control-play.png differ diff --git a/doc/2-interface/control-repeat.png b/doc/2-interface/control-repeat.png index c905e64a..2a6a96ad 100644 Binary files a/doc/2-interface/control-repeat.png and b/doc/2-interface/control-repeat.png differ diff --git a/doc/2-interface/control-step.png b/doc/2-interface/control-step.png index fd6262da..e2d86be3 100644 Binary files a/doc/2-interface/control-step.png and b/doc/2-interface/control-step.png differ diff --git a/doc/2-interface/control-stop.png b/doc/2-interface/control-stop.png index f1fc9e4a..e124c60d 100644 Binary files a/doc/2-interface/control-stop.png and b/doc/2-interface/control-stop.png differ diff --git a/doc/2-interface/controls-classic.png b/doc/2-interface/controls-classic.png index a8a093fa..37295e0d 100644 Binary files a/doc/2-interface/controls-classic.png and b/doc/2-interface/controls-classic.png differ diff --git a/doc/2-interface/controls-compact.png b/doc/2-interface/controls-compact.png index b0d1b0d4..7d9c7cca 100644 Binary files a/doc/2-interface/controls-compact.png and b/doc/2-interface/controls-compact.png differ diff --git a/doc/2-interface/controls-split.png b/doc/2-interface/controls-split.png index 235ea2ce..2b3fab40 100644 Binary files a/doc/2-interface/controls-split.png and b/doc/2-interface/controls-split.png differ diff --git a/doc/2-interface/controls-vertical.png b/doc/2-interface/controls-vertical.png index 98a89cc4..6dfd5770 100644 Binary files a/doc/2-interface/controls-vertical.png and b/doc/2-interface/controls-vertical.png differ diff --git a/doc/2-interface/docking.png b/doc/2-interface/docking.png index 7a4eaa77..bc8eb141 100644 Binary files a/doc/2-interface/docking.png and b/doc/2-interface/docking.png differ diff --git a/doc/2-interface/instruments-folder.png b/doc/2-interface/instruments-folder.png index 18e4ae63..a2fbb5ab 100644 Binary files a/doc/2-interface/instruments-folder.png and b/doc/2-interface/instruments-folder.png differ diff --git a/doc/2-interface/instruments.png b/doc/2-interface/instruments.png index 33487de6..00102e54 100644 Binary files a/doc/2-interface/instruments.png and b/doc/2-interface/instruments.png differ diff --git a/doc/2-interface/interface1.png b/doc/2-interface/interface1.png index ae995013..1c2abf07 100644 Binary files a/doc/2-interface/interface1.png and b/doc/2-interface/interface1.png differ diff --git a/doc/2-interface/samples.png b/doc/2-interface/samples.png index 816512fb..2be62a9b 100644 Binary files a/doc/2-interface/samples.png and b/doc/2-interface/samples.png differ diff --git a/doc/2-interface/tab1.png b/doc/2-interface/tab1.png index 2c63a7d9..156532c5 100644 Binary files a/doc/2-interface/tab1.png and b/doc/2-interface/tab1.png differ diff --git a/doc/2-interface/tab2.png b/doc/2-interface/tab2.png index 645f55a5..18bc6b2d 100644 Binary files a/doc/2-interface/tab2.png and b/doc/2-interface/tab2.png differ diff --git a/doc/2-interface/tab3.png b/doc/2-interface/tab3.png index 4ebc1077..c59d973e 100644 Binary files a/doc/2-interface/tab3.png and b/doc/2-interface/tab3.png differ diff --git a/doc/2-interface/wavetables.png b/doc/2-interface/wavetables.png index ad7ea880..4ac45f2c 100644 Binary files a/doc/2-interface/wavetables.png and b/doc/2-interface/wavetables.png differ diff --git a/doc/2-interface/window.png b/doc/2-interface/window.png index 5d7b32f3..a812b7a8 100644 Binary files a/doc/2-interface/window.png and b/doc/2-interface/window.png differ diff --git a/doc/3-pattern/channelbar.png b/doc/3-pattern/channelbar.png index 61a62133..6ef20cb4 100644 Binary files a/doc/3-pattern/channelbar.png and b/doc/3-pattern/channelbar.png differ diff --git a/doc/3-pattern/channels.png b/doc/3-pattern/channels.png index 6f9f04f2..ab4c985f 100644 Binary files a/doc/3-pattern/channels.png and b/doc/3-pattern/channels.png differ diff --git a/doc/3-pattern/keyboard.png b/doc/3-pattern/keyboard.png index 67f0b78d..7042af1c 100644 Binary files a/doc/3-pattern/keyboard.png and b/doc/3-pattern/keyboard.png differ diff --git a/doc/3-pattern/pattern.png b/doc/3-pattern/pattern.png index e6abde48..ca059faa 100644 Binary files a/doc/3-pattern/pattern.png and b/doc/3-pattern/pattern.png differ diff --git a/doc/4-instrument/README.md b/doc/4-instrument/README.md index d359441e..8857cf2e 100644 --- a/doc/4-instrument/README.md +++ b/doc/4-instrument/README.md @@ -15,18 +15,18 @@ depending on the instrument type, there are currently 13 different types of an i - [FM synthesis](fm.md) - for use with YM2612, YM2151 and FM block portion of YM2610. - [Standard](standard.md) - for use with NES and Sega Master System's PSG sound source and its derivatives. - [Game Boy](game-boy.md) - for use with Game Boy APU. -- [PC Engine/TurboGrafx-16](pce.md) - for use with PC Engine's wavetable synthesizer. +- [PC Engine / TurboGrafx-16](pce.md) - for use with PC Engine's wavetable synthesizer. - [WonderSwan](wonderswan.md) - for use with WonderSwan's wavetable synthesizer. - [AY8930](8930.md) - for use with Microchip AY8930 E-PSG sound source. - [Commodore 64](c64.md) - for use with Commodore 64 SID. - [SAA1099](saa.md) - for use with Philips SAA1099 PSG sound source. - [TIA](tia.md) - for use with Atari 2600 chip. - [AY-3-8910](ay8910.md) - for use with AY-3-8910 PSG sound source and SSG portion in YM2610. -- [Amiga/sample](amiga.md) for controlling Amiga and other sample based synthsizers like YM2612's Channel 6 PCM mode, NES channel 5, Sega PCM, X1-010 and PC Engine's sample playback mode. +- [Amiga / sample](amiga.md) for controlling Amiga and other sample based synthsizers like YM2612's Channel 6 PCM mode, NES channel 5, Sega PCM, X1-010 and PC Engine's sample playback mode. - [Atari Lynx](lynx.md) - for use with Atari Lynx handheld console. - [VERA](vera.md) - for use with Commander X16 VERA. - [Seta/Allumer X1-010](x1_010.md) - for use with Wavetable portion in Seta/Allumer X1-010. -- [Konami SCC/Bubble System WSG](scc.md) - for use with Konami SCC and Wavetable portion in Bubble System's sound hardware. +- [Konami SCC / Bubble System WSG](scc.md) - for use with Konami SCC and Wavetable portion in Bubble System's sound hardware. - [Namco 163](n163.md) - for use with Namco 163. - [Konami VRC6](vrc6.md) - for use with VRC6's PSG sound source. @@ -77,14 +77,15 @@ Finally, the sequence of values can be directly edited in the text box at the bo ![ADSR macro editor](macro-ADSR.png) -- **Bottom** and **Top** determine the range of values generated by the macro. (Bottom can be larger than Top to invert the envelope!) All generated values will fall between these two points. -- **Attack** is how quickly the value goes from Bottom to Top. A 0 means nothing will change; a 255 instantly jumps to the Top value. -- **Hold** sets how many ticks the note will wait at Top before decay. -- **Decay** is how quickly the value moves to the Sustain level. -- **Sustain** is the where the value will stay while the note is held until SusTime has passed. -- **SusTime** is how many ticks until SusDecay. -- **SusDecay** is the rate at which the value moves toward Bottom while the note is held. -- **Release** is the rate at which the value moves toward Bottom after the note is released. +- **Bottom** and **Top** determine the range of outputs generated by the macro. (Bottom can be larger than Top to invert the envelope!) All outputs will be between these two values. +- Attack, Decay, Sustain, SusDecay, and Release accept inputs between 0 to 255. These are scaled to the distance between Bottom and Top. +- **Attack** is how much the value moves toward Top with each tick. +- **Hold** sets how many ticks to stay at Top before Decay. +- **Decay** is how much the value moves to the Sustain level. +- **Sustain** is how far from Bottom the value stays while the note is held. +- **SusTime** is how many ticks to stay at Sustain until SusDecay. +- **SusDecay** is how much the value moves toward Bottom with each tick while the note is held. +- **Release** is how much the value moves toward Bottom with each tick after the note is released. ![macro ADSR chart](macro-ADSRchart.png) diff --git a/doc/4-instrument/list.png b/doc/4-instrument/list.png index d85cea62..e8af84a8 100644 Binary files a/doc/4-instrument/list.png and b/doc/4-instrument/list.png differ diff --git a/doc/4-instrument/macro-ADSR.png b/doc/4-instrument/macro-ADSR.png index e514a85b..f38d1432 100644 Binary files a/doc/4-instrument/macro-ADSR.png and b/doc/4-instrument/macro-ADSR.png differ diff --git a/doc/4-instrument/macro-ADSRchart.png b/doc/4-instrument/macro-ADSRchart.png index 4e3f409b..2580426f 100644 Binary files a/doc/4-instrument/macro-ADSRchart.png and b/doc/4-instrument/macro-ADSRchart.png differ diff --git a/doc/4-instrument/macro-LFO.png b/doc/4-instrument/macro-LFO.png index c79bce9f..90cb5c08 100644 Binary files a/doc/4-instrument/macro-LFO.png and b/doc/4-instrument/macro-LFO.png differ diff --git a/doc/4-instrument/macro-button-ADSR.png b/doc/4-instrument/macro-button-ADSR.png index 438dbd66..6529a72c 100644 Binary files a/doc/4-instrument/macro-button-ADSR.png and b/doc/4-instrument/macro-button-ADSR.png differ diff --git a/doc/4-instrument/macro-button-LFO.png b/doc/4-instrument/macro-button-LFO.png index e02e94f9..8ad9c24b 100644 Binary files a/doc/4-instrument/macro-button-LFO.png and b/doc/4-instrument/macro-button-LFO.png differ diff --git a/doc/4-instrument/macro-button-seq.png b/doc/4-instrument/macro-button-seq.png index 916153d5..dd316c20 100644 Binary files a/doc/4-instrument/macro-button-seq.png and b/doc/4-instrument/macro-button-seq.png differ diff --git a/doc/4-instrument/macro-seq.png b/doc/4-instrument/macro-seq.png index bd6cebe2..6ea2050b 100644 Binary files a/doc/4-instrument/macro-seq.png and b/doc/4-instrument/macro-seq.png differ diff --git a/doc/4-instrument/macro.png b/doc/4-instrument/macro.png index 42a2a635..4e03bad9 100644 Binary files a/doc/4-instrument/macro.png and b/doc/4-instrument/macro.png differ diff --git a/doc/4-instrument/macroview.png b/doc/4-instrument/macroview.png index d2bd5971..faadedb2 100644 Binary files a/doc/4-instrument/macroview.png and b/doc/4-instrument/macroview.png differ diff --git a/doc/8-advanced/channels.png b/doc/8-advanced/channels.png index 69fa2e99..e51815eb 100644 Binary files a/doc/8-advanced/channels.png and b/doc/8-advanced/channels.png differ diff --git a/doc/8-advanced/chanosc.png b/doc/8-advanced/chanosc.png index f7a75ae9..42c6be29 100644 Binary files a/doc/8-advanced/chanosc.png and b/doc/8-advanced/chanosc.png differ diff --git a/doc/8-advanced/chip-manager-change.png b/doc/8-advanced/chip-manager-change.png index dc156115..0def9180 100644 Binary files a/doc/8-advanced/chip-manager-change.png and b/doc/8-advanced/chip-manager-change.png differ diff --git a/doc/8-advanced/chip-manager-move.png b/doc/8-advanced/chip-manager-move.png index 6d59cbf4..022eae23 100644 Binary files a/doc/8-advanced/chip-manager-move.png and b/doc/8-advanced/chip-manager-move.png differ diff --git a/doc/8-advanced/chip-manager-remove.png b/doc/8-advanced/chip-manager-remove.png index 6ea5c5f0..aea34d9c 100644 Binary files a/doc/8-advanced/chip-manager-remove.png and b/doc/8-advanced/chip-manager-remove.png differ diff --git a/doc/8-advanced/chip-manager.png b/doc/8-advanced/chip-manager.png index 3f86f3a6..69077779 100644 Binary files a/doc/8-advanced/chip-manager.png and b/doc/8-advanced/chip-manager.png differ diff --git a/doc/8-advanced/clock.png b/doc/8-advanced/clock.png index 834eacaa..c051c5fd 100644 Binary files a/doc/8-advanced/clock.png and b/doc/8-advanced/clock.png differ diff --git a/doc/8-advanced/comments.png b/doc/8-advanced/comments.png index 0559c6ba..dec7c26a 100644 Binary files a/doc/8-advanced/comments.png and b/doc/8-advanced/comments.png differ diff --git a/doc/8-advanced/groove.png b/doc/8-advanced/groove.png index bc4031b0..ee0877c6 100644 Binary files a/doc/8-advanced/groove.png and b/doc/8-advanced/groove.png differ diff --git a/doc/8-advanced/grooves.png b/doc/8-advanced/grooves.png index 4b8489a7..2130dad3 100644 Binary files a/doc/8-advanced/grooves.png and b/doc/8-advanced/grooves.png differ diff --git a/doc/8-advanced/log-viewer.png b/doc/8-advanced/log-viewer.png index 71120570..aa007650 100644 Binary files a/doc/8-advanced/log-viewer.png and b/doc/8-advanced/log-viewer.png differ diff --git a/doc/8-advanced/mixer-mixer.png b/doc/8-advanced/mixer-mixer.png index 27574804..249c6fbe 100644 Binary files a/doc/8-advanced/mixer-mixer.png and b/doc/8-advanced/mixer-mixer.png differ diff --git a/doc/8-advanced/mixer-patchbay.png b/doc/8-advanced/mixer-patchbay.png index bd73cd83..52ca7ab3 100644 Binary files a/doc/8-advanced/mixer-patchbay.png and b/doc/8-advanced/mixer-patchbay.png differ diff --git a/doc/8-advanced/osc.png b/doc/8-advanced/osc.png index dbf48507..4a9b728c 100644 Binary files a/doc/8-advanced/osc.png and b/doc/8-advanced/osc.png differ diff --git a/doc/8-advanced/pattern-manager.png b/doc/8-advanced/pattern-manager.png index 4df06811..b64b9d29 100644 Binary files a/doc/8-advanced/pattern-manager.png and b/doc/8-advanced/pattern-manager.png differ diff --git a/doc/8-advanced/piano.png b/doc/8-advanced/piano.png index d905dd74..9bf53cf6 100644 Binary files a/doc/8-advanced/piano.png and b/doc/8-advanced/piano.png differ diff --git a/doc/8-advanced/register.png b/doc/8-advanced/register.png index df68b667..76ec9894 100644 Binary files a/doc/8-advanced/register.png and b/doc/8-advanced/register.png differ diff --git a/doc/8-advanced/stats.png b/doc/8-advanced/stats.png index 9c11db26..920654e6 100644 Binary files a/doc/8-advanced/stats.png and b/doc/8-advanced/stats.png differ