diff --git a/TODO.md b/TODO.md index 4af99b6fa..20c54eb9a 100644 --- a/TODO.md +++ b/TODO.md @@ -3,14 +3,10 @@ - tutorial? - ease-of-use improvements... ideas: - preset compat flags - - setting to toggle the Choose a System screen on new project - maybe reduced set of presets for the sake of simplicity - a more preferable highlight/drag system - some speed/intuitive workflow improvements that go a long way - - Had a hard time finding the docs on github and in Furnace's folder. - make .pdf manual out of doc/ - - you're going too slow; please run - break compatibility if it relieves complexity -- ins/wave/sample organization (folders and all) - multi-key binds - bug fixes diff --git a/android/app/build.gradle b/android/app/build.gradle index 483ea52c4..3f3fc8bd8 100644 --- a/android/app/build.gradle +++ b/android/app/build.gradle @@ -19,7 +19,7 @@ android { versionName "0.6pre5" externalNativeBuild { cmake { - arguments "-DANDROID_APP_PLATFORM=android-21", "-DANDROID_STL=c++_static" + arguments "-DANDROID_APP_PLATFORM=android-21", "-DANDROID_STL=c++_static", "-DWARNINGS_ARE_ERRORS=ON" // abiFilters 'armeabi-v7a', 'arm64-v8a', 'x86', 'x86_64' abiFilters 'arm64-v8a' } diff --git a/doc/2-interface/asset-add.png b/doc/2-interface/asset-add.png new file mode 100644 index 000000000..f6ef5b73b 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 000000000..d0eb8dd97 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 000000000..caa740fb1 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 000000000..8d693e0fe 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 44c3fefa5..936c4a32f 100644 --- a/doc/2-interface/asset-list.md +++ b/doc/2-interface/asset-list.md @@ -3,21 +3,21 @@  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. +- **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. ## folder view  In folder view, the "Move up" and "Move down buttons disappear and a new one appears: -- **New Folder:** Creates a new folder. +- **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 +34,5 @@ Everything from the instrument list applies here also, with one major difference  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. +- **Preview**: Plays the selected sample at its default note. +- **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 000000000..fdcbca6a9 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 000000000..01540abd9 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 000000000..eea985143 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 000000000..8636285c4 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 000000000..02fe6498e 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 000000000..19dd03e9a 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 35fce78c7..e3e2d177a 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 0c6672565..51822c0e4 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 a6eb5d01e..a11f0aab2 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 853cdcffe..fc2865902 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 feafe1681..c258b5fd8 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 c905e64ae..2a6a96add 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 fd6262da7..e2d86be34 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 f1fc9e4a7..e124c60d2 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 a8a093fa9..37295e0df 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 b0d1b0d40..7d9c7cca2 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 235ea2ce3..2b3fab407 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 98a89cc4e..6dfd57706 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 7a4eaa775..bc8eb1415 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 18e4ae630..a2fbb5ab2 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 33487de68..00102e543 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 ae9950139..1c2abf07d 100644 Binary files a/doc/2-interface/interface1.png and b/doc/2-interface/interface1.png differ diff --git a/doc/2-interface/play-edit-controls.md b/doc/2-interface/play-edit-controls.md index 0645f6d12..038c458eb 100644 --- a/doc/2-interface/play-edit-controls.md +++ b/doc/2-interface/play-edit-controls.md @@ -2,19 +2,19 @@ The "Play/Edit Controls" are used to control playback and change parameters of the pattern view. --  **Play:** Plays from cursor position. --  **Stop:** Stops all playback. --  **Play from the beginning of this pattern:** Plays from the start of current pattern. --  **Repeat from the beginning of this pattern:** Repeats current pattern from its start. --  **Step one row:** Plays only the row at cursor position and moves down one. --  **Edit:** Toggles edit mode. If off, nothing can be edited in the pattern window. (Great for playing around on the keyboard!) --  **Metronome:** Toggles the metronome, which only sounds during playback. --  **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). -- **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. -- **Follow orders:** If on, the selected order in the orders window will follow the song during playback. -- **Follow pattern:** If on, the cursor will follow playback and the song will scroll by as it plays. +-  **Play**: Plays from cursor position. +-  **Stop**: Stops all playback. +-  **Play from the beginning of this pattern**: Plays from the start of current pattern. +-  **Repeat from the beginning of this pattern**: Repeats current pattern from its start. +-  **Step one row**: Plays only the row at cursor position and moves down one. +-  **Edit**: Toggles edit mode. If off, nothing can be edited in the pattern window. (Great for playing around on the keyboard!) +-  **Metronome**: Toggles the metronome, which only sounds during playback. +-  **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). +- **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. +- **Follow orders**: If on, the selected order in the orders window will follow the song during playback. +- **Follow pattern**: If on, the cursor will follow playback and the song will scroll by as it plays. ## layouts diff --git a/doc/2-interface/samples.png b/doc/2-interface/samples.png index 816512fbb..2be62a9ba 100644 Binary files a/doc/2-interface/samples.png and b/doc/2-interface/samples.png differ diff --git a/doc/2-interface/song-info.md b/doc/2-interface/song-info.md index 1a4cd03eb..5ba682a21 100644 --- a/doc/2-interface/song-info.md +++ b/doc/2-interface/song-info.md @@ -1,49 +1,49 @@ # song info -- "Name" is for the track's title. -- "Author" is used to list the contributors to a song. If the song is a cover of someone else's track, it's customary to list their name first, followed by `[cv. YourName]`. -- "Album" can be used to store the associated album name, the name of the game the song is from, or whatever. -- "System" is for the game or computer the track is designed for. This is automatically set when creating a new tune, but it can be changed to anything one wants. The "Auto" button will provide a guess based on the chips in use. +- **Name**: The track's title. +- **Author**: List of contributors to a song. If the song is a cover of someone else's track, it's customary to list their name first, followed by `[cv. YourName]`. +- **Album**: The associated album name, the name of the game the song is from, or whatever. +- **System**: The game console or computer the track is designed for. This is automatically set when creating a new tune, but it can be changed to anything one wants. The **Auto** button will provide a guess based on the chips in use. All of this metadata will be included in a VGM export. This isn't the case for a WAV export, however. -"Tuning (A-4)" allows one to set tuning based on the note A-4, which should be 440 in most cases. Opening an Amiga MOD will set it to 436 for hardware compatibility. +**Tuning (A-4)**: Set tuning based on the note A-4, which should be 440 in most cases. Opening an Amiga MOD will set it to 436 for hardware compatibility. # subsongs This window allows one to create **subsongs** – multiple individual songs within a single file. Each song has its own order list and patterns, but all songs within a file share the same chips, samples, and so forth. - The drop-down box selects the current subsong. -- The `+` button adds a new subsong. -- The `−` button permanently deletes the current subsong (unless it's the only one). -- "Name" sets the title of the current subsong. +- The **`+`** button adds a new subsong. +- The **`−`** button permanently deletes the current subsong (unless it's the only one). +- **Name**: Title of the current subsong. - The box at the bottom can store any arbitrary text, like a separate "Comments" box for the current subsong. # speed There are multiple ways to set the tempo of a song. -**Tick Rate** sets the frequency of ticks per second, the rate at which notes and effects are processed. -- All values are allowed for all chips, but most chips have hardware limitations that mean they should stay at either 60 (approximately NTSC) or 50 (exactly PAL). +**Tick Rate**: The frequency of ticks per second, thus the rate at which notes and effects are processed. +- All values are allowed for all chips, though most chips have hardware limitations that mean they should stay at either 60 (approximately NTSC) or 50 (exactly PAL). - Clicking the Tick Rate button switches to a more traditional **Base Tempo** BPM setting. -**Speed** sets the number of ticks per row. +**Speed**: The number of ticks per row. - Clicking the "Speed" button changes to more complex modes covered in the [grooves] page. -**Virtual Tempo** simulates any arbitrary tempo without altering the tick rate. It does this by adding or skipping ticks to approximate the tempo. The two numbers represent a ratio applied to the actual tick rate. Example: +**Virtual Tempo**: Simulates any arbitrary tempo without altering the tick rate. It does this by adding or skipping ticks to approximate the tempo. The two numbers represent a ratio applied to the actual tick rate. Example: - Set tick rate to 150 BPM (60 Hz) and speed to 6. - Set the first virtual tempo number (numerator) to 200. - Set the second virtual tempo number (denominator) to 150. - The track will play at 200 BPM. - The ratio doesn't have to match BPM numbers. Set the numerator to 4 and the denominator to 5, and the virtual BPM becomes 150 × 4/5 = 120. -**Divider** changes the effective tick rate. A tick rate of 60Hz and a divisor of 6 will result in ticks lasting a tenth of a second each! +**Divider**: Changes the effective tick rate. A tick rate of 60Hz and a divisor of 6 will result in ticks lasting a tenth of a second each! -**Highlight** sets the pattern row highlights: +**Highlight**: Sets the pattern row highlights: - The first value represents the number of rows per beat. - The second value represents the number of rows per measure. - These don't have to line up with the music's actual beats and measures. Set them as preferred for tracking. _Note:_ These values are used for the metronome and calculating BPM. -**Pattern Length** is the length of each pattern in rows. This affects all patterns in the song, and every pattern must be the same length. (Individual patterns can be cut short by `0Bxx`, `0Dxx`, and `FFxx` commands.) +**Pattern Length**: The length of each pattern in rows. This affects all patterns in the song, and every pattern must be the same length. (Individual patterns can be cut short by `0Bxx`, `0Dxx`, and `FFxx` commands.) -**Song Length** shows how many orders are in the order list. Decreasing it will hide the orders at the bottom. Increasing it will restore those orders; increasing it further will add new orders of all `00` patterns. +**Song Length**: How many orders are in the order list. Decreasing it will hide the orders at the bottom. Increasing it will restore those orders; increasing it further will add new orders of all `00` patterns. diff --git a/doc/2-interface/tab1.png b/doc/2-interface/tab1.png index 2c63a7d91..156532c5b 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 645f55a54..18bc6b2d1 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 4ebc1077a..c59d973ea 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 ad7ea8808..4ac45f2c8 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 5d7b32f32..a812b7a89 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 61a62133f..6ef20cb43 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 6f9f04f23..ab4c985f2 100644 Binary files a/doc/3-pattern/channels.png and b/doc/3-pattern/channels.png differ diff --git a/doc/3-pattern/effects.md b/doc/3-pattern/effects.md index 54d180006..c7a54fd49 100644 --- a/doc/3-pattern/effects.md +++ b/doc/3-pattern/effects.md @@ -3,74 +3,74 @@ most of the effect numbers are from ProTracker/FastTracker 2. however, effects are continuous, which means you only need to type it once and then stop it with an effect value of `00`. -- `00xy`: arpeggio. after using this effect the channel will rapidly switch between `note`, `note+x` and `note+y`. -- `01xx`: slide up. -- `02xx`: slide down. -- `03xx`: note portamento. +- **`00xy`**: arpeggio. after using this effect the channel will rapidly switch between `note`, `note+x` and `note+y`. +- **`01xx`**: slide up. +- **`02xx`**: slide down. +- **`03xx`**: note portamento. - a note must be present for this effect to work. -- `04xy`: vibrato. `x` is the speed, while `y` is the depth. +- **`04xy`**: vibrato. `x` is the speed, while `y` is the depth. - maximum vibrato depth is ±1 semitone. -- `07xy`: tremolo. `x` is the speed, while `y` is the depth. +- **`07xy`**: tremolo. `x` is the speed, while `y` is the depth. - maximum tremolo depth is -60 volume steps. -- `08xy`: set panning. `x` is the left channel and `y` is the right one. +- **`08xy`**: set panning. `x` is the left channel and `y` is the right one. - not all chips support this effect. -- `80xx`: set panning (linear). this effect behaves more like other trackers: +- **`80xx`**: set panning (linear). this effect behaves more like other trackers: - `00` is left. - `80` is center. - `FF` is right. - not all chips support this effect. -- `81xx`: set volume of left channel (from `00` to `FF`). +- **`81xx`**: set volume of left channel (from `00` to `FF`). - not all chips support this effect. -- `82xx`: set volume of right channel (from `00` to `FF`). +- **`82xx`**: set volume of right channel (from `00` to `FF`). - not all chips support this effect. -- `09xx`: set speed 1. -- `0Axy`: volume slide. +- **`09xx`**: set speed 1. +- **`0Axy`**: volume slide. - if `x` is 0 then this is a slide down. - if `y` is 0 then this is a slide up. -- `0Bxx`: jump to pattern. -- `0Cxx`: retrigger note every `xx` ticks. +- **`0Bxx`**: jump to pattern. +- **`0Cxx`**: retrigger note every `xx` ticks. - this effect is not continuous. -- `0Dxx`: jump to next pattern. -- `0Fxx`: set speed 2. +- **`0Dxx`**: jump to next pattern. +- **`0Fxx`**: set speed 2. -- `9xxx`: set sample position to `xxx`\*0x100. +- **`9xxx`**: set sample position to `xxx`\*0x100. - not all chips support this effect. -- `Cxxx`: change song Hz. +- **`Cxxx`**: change song Hz. - `xxx` may be from `000` to `3ff`. -- `E0xx`: set arpeggio tick. +- **`E0xx`**: set arpeggio tick. - this sets the number of ticks between arpeggio values. -- `E1xy`: note slide up. `x` is the speed, while `y` is how many semitones to slide up. -- `E2xy`: note slide down. `x` is the speed, while `y` is how many semitones to slide down. -- `E3xx`: set vibrato direction. `xx` may be one of the following: +- **`E1xy`**: note slide up. `x` is the speed, while `y` is how many semitones to slide up. +- **`E2xy`**: note slide down. `x` is the speed, while `y` is how many semitones to slide down. +- **`E3xx`**: set vibrato direction. `xx` may be one of the following: - `00`: up and down. - `01`: up only. - `02`: down only. -- `E4xx`: set vibrato range in 1/16th of a semitone. -- `E5xx`: set pitch. `80` is 0 cents. +- **`E4xx`**: set vibrato range in 1/16th of a semitone. +- **`E5xx`**: set pitch. `80` is 0 cents. - range is ±1 semitone. -- `EAxx`: toggle legato. -- `EBxx`: set sample bank. +- **`EAxx`**: toggle legato. +- **`EBxx`**: set sample bank. - does not apply on Amiga. -- `ECxx`: note off after `xx` ticks. -- `EDxx`: delay note by `xx` ticks. -- `EExx`: send external command. +- **`ECxx`**: note off after `xx` ticks. +- **`EDxx`**: delay note by `xx` ticks. +- **`EExx`**: send external command. - this effect is currently incomplete. -- `F0xx`: change song Hz by BPM value. -- `F1xx`: single tick slide up. -- `F2xx`: single tick slide down. -- `F3xx`: fine volume slide up (64x slower than `0Axy`). -- `F4xx`: fine volume slide down (64x slower than `0Axy`). -- `F5xx`: disable macro. +- **`F0xx`**: change song Hz by BPM value. +- **`F1xx`**: single tick slide up. +- **`F2xx`**: single tick slide down. +- **`F3xx`**: fine volume slide up (64x slower than `0Axy`). +- **`F4xx`**: fine volume slide down (64x slower than `0Axy`). +- **`F5xx`**: disable macro. - see macro table at the end of this document for possible values. -- `F6xx`: enable macro. -- `F8xx`: single tick volume slide up. -- `F9xx`: single tick volume slide down. -- `FAxy`: fast volume slide (4x faster than `0Axy`). +- **`F6xx`**: enable macro. +- **`F8xx`**: single tick volume slide up. +- **`F9xx`**: single tick volume slide down. +- **`FAxy`**: fast volume slide (4x faster than `0Axy`). - if `x` is 0 then this is a slide down. - if `y` is 0 then this is a slide up. -- `FFxx`: end of song/stop playback. +- **`FFxx`**: end of song/stop playback. additionally each chip has its own effects. [click here for more details](../7-systems/README.md). diff --git a/doc/3-pattern/keyboard.png b/doc/3-pattern/keyboard.png index 67f0b78d8..7042af1c1 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 e6abde48d..ca059faa8 100644 Binary files a/doc/3-pattern/pattern.png and b/doc/3-pattern/pattern.png differ diff --git a/doc/4-instrument/8930.md b/doc/4-instrument/8930.md index 2d671f6d0..ecb1e8ed8 100644 --- a/doc/4-instrument/8930.md +++ b/doc/4-instrument/8930.md @@ -2,15 +2,15 @@ AY8930 instrument editor consists of these macros. -- [Volume] - volume sequence -- [Arpeggio]- pitch in half-steps -- [Noise Freq] - AY8930 noise generator frequency sequence -- [Waveform] - selector of sound type: pulse wave tone, noise or envelope generator -- [Pitch] - fine pitch -- [Phase Reset] - trigger restart of waveform -- [Duty] - duty cycle of a pulse wave sequence -- [Envelope] - allows shaping an envelope -- [AutoEnv Num] - sets the envelope to the channel's frequency multiplied by numerator -- [AutoEnv Den] - sets the envelope to the channel's frequency divided by denominator -- [Noise AND Mask] - alters the shape/frequency of the noise generator, allowing to produce various interesting sound effects and even PWM phasing -- [Noise OR Mask] - see above +- **Volume**: volume sequence +- **Arpeggio**: pitch in half-steps +- **Noise Freq**: AY8930 noise generator frequency sequence +- **Waveform**: selector of sound type: pulse wave tone, noise or envelope generator +- **Pitch**: fine pitch +- **Phase Reset**: trigger restart of waveform +- **Duty**: duty cycle of a pulse wave sequence +- **Envelope**: allows shaping an envelope +- **AutoEnv Num**: sets the envelope to the channel's frequency multiplied by numerator +- **AutoEnv Den**: sets the envelope to the channel's frequency divided by denominator +- **Noise AND Mask**: alters the shape/frequency of the noise generator, allowing to produce various interesting sound effects and even PWM phasing +- **Noise OR Mask**: see above diff --git a/doc/4-instrument/README.md b/doc/4-instrument/README.md index d359441ee..8857cf2ec 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  -- **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.  diff --git a/doc/4-instrument/amiga.md b/doc/4-instrument/amiga.md index 6b8d81cd9..fc76c8667 100644 --- a/doc/4-instrument/amiga.md +++ b/doc/4-instrument/amiga.md @@ -4,14 +4,14 @@ The PCM instrument editor consists of a sample selector and several macros: # Amiga/sample -- [Initial sample] - specifies which sample should be assigned to the instrument, or the first one in the sequence +- **Initial sample**: specifies which sample should be assigned to the instrument, or the first one in the sequence # Macros -- [Volume] - volume sequence WARNING: it works only on Amiga system, as of version 0.5.5!! -- [Arpeggio] - pitch sequence -- [Waveform] - sample sequence -- [Panning (left)] - output level for left channel -- [Panning (right)] - output level for right channel -- [Pitch] - fine pitch -- [Phase Reset] - trigger restart of waveform \ No newline at end of file +- **Volume**: volume sequence WARNING: it works only on Amiga system, as of version 0.5.5!! +- **Arpeggio**: pitch sequence +- **Waveform**: sample sequence +- **Panning (left)**: output level for left channel +- **Panning (right)**: output level for right channel +- **Pitch**: fine pitch +- **Phase Reset**: trigger restart of waveform \ No newline at end of file diff --git a/doc/4-instrument/ay8910.md b/doc/4-instrument/ay8910.md index c5ec5e98a..c4a0a8154 100644 --- a/doc/4-instrument/ay8910.md +++ b/doc/4-instrument/ay8910.md @@ -2,12 +2,12 @@ The AY-3-8910 instrument editor consists of these macros. -- [Volume] - volume levels sequence -- [Arpeggio]- pitch sequence -- [Noise Freq] - AY-3-8910 noise generator frequency sequence -- [Waveform] - selector of sound type - square wave tone, noise or envelope generator -- [Pitch] - fine pitch -- [Phase Reset] - trigger restart of waveform -- [Envelope] - allows shaping an envelope -- [AutoEnv Num] - sets the envelope to the channel's frequency multiplied by numerator -- [AutoEnv Den] - sets the envelope to the channel's frequency multiplied by denominator +- **Volume**: volume levels sequence +- **Arpeggio**: pitch sequence +- **Noise Freq**: AY-3-8910 noise generator frequency sequence +- **Waveform**: selector of sound type - square wave tone, noise or envelope generator +- **Pitch**: fine pitch +- **Phase Reset**: trigger restart of waveform +- **Envelope**: allows shaping an envelope +- **AutoEnv Num**: sets the envelope to the channel's frequency multiplied by numerator +- **AutoEnv Den**: sets the envelope to the channel's frequency multiplied by denominator diff --git a/doc/4-instrument/c64.md b/doc/4-instrument/c64.md index 2f3a97373..5dd20408a 100644 --- a/doc/4-instrument/c64.md +++ b/doc/4-instrument/c64.md @@ -4,32 +4,32 @@ The C64 instrument editor consists of two tabs: "C64" to control various paramet ## C64 -- [Waveform] - allows selecting a waveform. NOTE: more than one waveform can be selected at once, logical AND mix of waves will be produced, with an exception of a noise waveform, it can't be mixed. -- [Attack] - determines the rising time for the sound. The bigger the value, the slower the attack. (0-15 range) -- [Decay]- Determines the diminishing time for the sound. The higher the value, the longer the decay. It's the initial amplitude decay rate. (0-15 range) -- [Sustain] - Sets the volume level at which the sound stops decaying and holds steady. (0-15 range) -- [Release] - Determines the rate at which the sound disappears after KEY-OFF. The higher the value, the longer the release. (0-15 range) -- [Ring Modulation] - enables the ring modulation affecting the instrument. -- [Duty] - specifies the width of a pulse wave. (0-4095 range) -- [Oscillator Sync] - enables the oscillator hard sync. As one oscillator finishes a cycle, it resets the period of another oscillator, forcing the latter to have the same base frequency. This can produce a harmonically rich sound, the timbre of which can be altered by varying the synced oscillator's frequency. -- [Enable filter] - enables analogue filter affecting the instrument -- [Initialize filter] - initializes the filter with the specified parameters: -- [Cutoff] - defines the "intensity" of a filter, to put in in layman terms (0-2047 range) -- [Resonance] - defines an additional controlled amplification of that cutoff frequency, creating a secondary peak forms and colors the original pitch. (0-15 range) -- [Filter mode] - determined the filter mode NOTE: SID's filter is multi-mode, you can mix different modes together (like low and high-pass filters at once) CH3-OFF disables the channel 3, for no reason whatsoever lmao -- [Volume Macro is Cutoff Macro] - turns a volume macro in a macros tab into a filter cutoff macro. -- [Absolute Cutoff Macro] - changes the behaviour of a cutoff macro from the old-style, compatible to much more define-able. -- [Absolute Duty Macro] - changes the behaviour of a duty cycle macro from the old-style, compatible to much more definable. -- [Don't test/gate before new note] - Don't reset the envelope to zero when a new note starts. (Read "Test/Gate" below for more info.) +- **Waveform**: allows selecting a waveform. NOTE: more than one waveform can be selected at once, logical AND mix of waves will be produced, with an exception of a noise waveform, it can't be mixed. +- **Attack**: determines the rising time for the sound. The bigger the value, the slower the attack. (0-15 range) +- **Decay**: Determines the diminishing time for the sound. The higher the value, the longer the decay. It's the initial amplitude decay rate. (0-15 range) +- **Sustain**: Sets the volume level at which the sound stops decaying and holds steady. (0-15 range) +- **Release**: Determines the rate at which the sound disappears after KEY-OFF. The higher the value, the longer the release. (0-15 range) +- **Ring Modulation**: enables the ring modulation affecting the instrument. +- **Duty**: specifies the width of a pulse wave. (0-4095 range) +- **Oscillator Sync**: enables the oscillator hard sync. As one oscillator finishes a cycle, it resets the period of another oscillator, forcing the latter to have the same base frequency. This can produce a harmonically rich sound, the timbre of which can be altered by varying the synced oscillator's frequency. +- **Enable filter**: enables analogue filter affecting the instrument +- **Initialize filter**: initializes the filter with the specified parameters: +- **Cutoff**: defines the "intensity" of a filter, to put in in layman terms (0-2047 range) +- **Resonance**: defines an additional controlled amplification of that cutoff frequency, creating a secondary peak forms and colors the original pitch. (0-15 range) +- **Filter mode**: determined the filter mode NOTE: SID's filter is multi-mode, you can mix different modes together (like low and high-pass filters at once) CH3-OFF disables the channel 3, for no reason whatsoever lmao +- **Volume Macro is Cutoff Macro**: turns a volume macro in a macros tab into a filter cutoff macro. +- **Absolute Cutoff Macro**: changes the behaviour of a cutoff macro from the old-style, compatible to much more define-able. +- **Absolute Duty Macro**: changes the behaviour of a duty cycle macro from the old-style, compatible to much more definable. +- **Don't test/gate before new note**: Don't reset the envelope to zero when a new note starts. (Read "Test/Gate" below for more info.) ## Macros -- [Volume] - volume sequence (WARNING: Volume sequence is global for ALL three channels!!) -- [Arpeggio] - pitch sequence -- [Duty] - pulse duty cycle sequence -- [Waveform] - select the waveform used by instrument -- [Pitch] - fine pitch -- [Filter mode] - select the filter mode/sequence -- [Resonance] - filter resonance sequence -- [Special] - ring and oscillator sync selector -- [Test/Gate] - When on, the TEST bit resets and locks Oscillator 1 at zero until cleared. The GATE bit controls Oscillator 1's envelope: Gate on runs through the envelope's attack, delay, and sustain; Gate off is envelope release. \ No newline at end of file +- **Volume**: volume sequence (WARNING: Volume sequence is global for ALL three channels!!) +- **Arpeggio**: pitch sequence +- **Duty**: pulse duty cycle sequence +- **Waveform**: select the waveform used by instrument +- **Pitch**: fine pitch +- **Filter mode**: select the filter mode/sequence +- **Resonance**: filter resonance sequence +- **Special**: ring and oscillator sync selector +- **Test/Gate**: When on, the TEST bit resets and locks Oscillator 1 at zero until cleared. The GATE bit controls Oscillator 1's envelope: Gate on runs through the envelope's attack, delay, and sustain; Gate off is envelope release. \ No newline at end of file diff --git a/doc/4-instrument/fm.md b/doc/4-instrument/fm.md index 31de4de85..08542eb32 100644 --- a/doc/4-instrument/fm.md +++ b/doc/4-instrument/fm.md @@ -2,47 +2,46 @@ FM editor is divided into 7 tabs: -- [FM] - for controlling the basic parameters of FM sound source. -- [Macros (FM)]- for macros controlling algorithm, feedback and LFO -- [Macros (OP1)] - for macros controlling FM paramets of operator 1 -- [Macros (OP2)] - for macros controlling FM paramets of operator 2 -- [Macros (OP3)] - for macros controlling FM paramets of operator 3 -- [Macros (OP4)] - for macros controlling FM paramets of operator 4 -- [Macros] - for miscellaneous macros controlling volume, argeggio and YM2151 noise generator. +- **FM**: for controlling the basic parameters of FM sound source. +- **Macros (FM)**: for macros controlling algorithm, feedback and LFO +- **Macros (OP1)**: for macros controlling FM paramets of operator 1 +- **Macros (OP2)**: for macros controlling FM paramets of operator 2 +- **Macros (OP3)**: for macros controlling FM paramets of operator 3 +- **Macros (OP4)**: for macros controlling FM paramets of operator 4 +- **Macros**: for miscellaneous macros controlling volume, argeggio and YM2151 noise generator. ## FM FM synthesizers Furnace supports are four-operator, meaning it takes four oscillators to produce a single sound. Each operator is controlled by a dozen sliders: -- [Attack Rate (AR)] - determines the rising time for the sound. The bigger the value, the faster the attack. (0-31 range) -- [Decay Rate (DR)]- Determines the diminishing time for the sound. The higher the value, the shorter the decay. It's the initial amplitude decay rate. (0-31 range) -- [Secondary Decay Rate (DR2)/Sustain Rate (SR)] - Determines the diminishing time for the sound. The higher the value, the shorter the decay. This is the long "tail" of the sound that continues as long as the key is depressed. (0-31 range) -- [Release Rate (RR)] - Determines the rate at which the sound disappears after KEY-OFF. The higher the value, the shorter the release. (0-15 range) -- [Sustain Level(SL)] - Determines the point at which the sound ceases to decay and changes to a sound having a constant level. The sustain level is expressed as a fraction of the maximum level. (0-15 range) -- [Total Level (TL)] - Represents the envelope’s highest amplitude, with 0 being the largest and 127 (decimal) the smallest. A change of one unit is about 0.75 dB. -- [Envelope Scale (KSR)] - A parameter that determines the degree to which the envelope execution speed increases according to the pitch. (0-3 range) -- [Frequency Multiplier (MULT)] - Determines the operator frequency in relation to the pitch. (0-15 range) -- [Fine Detune (DT)] - Shifts the pitch a little (0-7 range) -- [Coarse Detune (DT2)] - Shifts the pitch by tens of cents (0-3 range) WARNING: this parameter affects only YM2151 sound source!!! -- [Hardware Envelope Generator (SSG-EG)] - Executes the built-in envelope, inherited from AY-3-8910 PSG. Speed of execution is controlled via Decay Rate. WARNING: this parameter affects only YM2610/YM2612 sound source!!! -- [Algorithm (AL)] - Determines how operators are connected to each other. (0-7 range) -- [Feedback (FB)] - Determines the amount of signal whick operator 1 returns to itself. (0-7 range) -- [Amplitude Modulation (AM)] - Makes the operator affected by LFO. -- [LFO Frequency Sensitivity] - Determines the amount of LFO frequency changes. (0-7 range) -- [LFO Amplitude Sensitivity (AM)] - Determines the amount of LFO frequency changes. (0-3 range) +- **Attack Rate (AR)**: determines the rising time for the sound. The bigger the value, the faster the attack. (0-31 range) +- **Decay Rate (DR)**: Determines the diminishing time for the sound. The higher the value, the shorter the decay. It's the initial amplitude decay rate. (0-31 range) +- **Secondary Decay Rate (DR2)/Sustain Rate (SR)**: Determines the diminishing time for the sound. The higher the value, the shorter the decay. This is the long "tail" of the sound that continues as long as the key is depressed. (0-31 range) +- **Release Rate (RR)**: Determines the rate at which the sound disappears after KEY-OFF. The higher the value, the shorter the release. (0-15 range) +- **Sustain Level(SL)**: Determines the point at which the sound ceases to decay and changes to a sound having a constant level. The sustain level is expressed as a fraction of the maximum level. (0-15 range) +- **Total Level (TL)**: Represents the envelope’s highest amplitude, with 0 being the largest and 127 (decimal) the smallest. A change of one unit is about 0.75 dB. +- **Envelope Scale (KSR)**: A parameter that determines the degree to which the envelope execution speed increases according to the pitch. (0-3 range) +- **Frequency Multiplier (MULT)**: Determines the operator frequency in relation to the pitch. (0-15 range) +- **Fine Detune (DT)**: Shifts the pitch a little (0-7 range) +- **Coarse Detune (DT2)**: Shifts the pitch by tens of cents (0-3 range) WARNING: this parameter affects only YM2151 sound source!!! +- **Hardware Envelope Generator (SSG-EG)**: Executes the built-in envelope, inherited from AY-3-8910 PSG. Speed of execution is controlled via Decay Rate. WARNING: this parameter affects only YM2610/YM2612 sound source!!! +- **Algorithm (AL)**: Determines how operators are connected to each other. (0-7 range) +- **Feedback (FB)**: Determines the amount of signal whick operator 1 returns to itself. (0-7 range) +- **Amplitude Modulation (AM)**: Makes the operator affected by LFO. +- **LFO Frequency Sensitivity**: Determines the amount of LFO frequency changes. (0-7 range) +- **LFO Amplitude Sensitivity (AM)**: Determines the amount of LFO frequency changes. (0-3 range) ## Macros Macros define the sequence of values passed to the given parameter. Via macro, aside previously mentioned parameters, the following can be controlled: -- LFO Frequency -- LFO waveform selection WARNING: this parameter affects only YM2151 sound source!!! -- Amplitude Modulation Depth WARNING: this parameter affects only YM2151 sound source!!! -- Frequency Modulation Depth WARNING: this parameter affects only YM2151 sound source!!! -- Arpeggio Macro: pitch change sequence in semitones. Two modes are available: -Absolute (default) - Executes the pitch with absolute change based on the pitch of the actual note. -Fixed - Executes at the pitch specified in the sequence regardless of the note pitch. -- Noise Frequency: specifies the noise frequency in noise mode of YM2151's Channel 8 Operator 4 special mode. +- **LFO Frequency** +- **LFO Waveform**: _WARNING:_ this parameter affects only YM2151 sound source! +- **Amplitude Modulation Depth**: _WARNING:_ this parameter affects only YM2151 sound source! +- **Frequency Modulation Depth**: _WARNING:_ this parameter affects only YM2151 sound source! +- **Arpeggio Macro**: Pitch change sequence in semitones. Two modes are available: + - **Absolute** (default): Executes the pitch with absolute change based on the pitch of the actual note. + - **Fixed**: Executes at the pitch specified in the sequence regardless of the note pitch. +- **Noise Frequency**: specifies the noise frequency in noise mode of YM2151's Channel 8 Operator 4 special mode. -Loop -You can loop the execution of part of a sequence. Left-click anywhere on the Loop line at the bottom of the editor to create a loop. You can move the start and end points of the loop by dragging both ends of the loop. +Looping: You can loop the execution of part of a sequence. Left-click anywhere on the Loop line at the bottom of the editor to create a loop. You can move the start and end points of the loop by dragging both ends of the loop. Rigkt-click to remove the loop. diff --git a/doc/4-instrument/game-boy.md b/doc/4-instrument/game-boy.md index d3da0776e..fd982615d 100644 --- a/doc/4-instrument/game-boy.md +++ b/doc/4-instrument/game-boy.md @@ -4,22 +4,22 @@ GB instrument editor consists of two tabs: one controlling envelope of sound cha ## Game Boy -- [Use software envelope] - switch to volume macro instead of envelope -- [Initialize envelope on every note] - forces a volume reset on each new note -- [Volume] - initial channel volume (range 0-15) -- [Length] - envelope decay/attack duration (range 0-7) -- [Sound Length] - cuts off sound after specified length, overriding the Length value +- **Use software envelope**: switch to volume macro instead of envelope +- **Initialize envelope on every note**: forces a volume reset on each new note +- **Volume**: initial channel volume (range 0-15) +- **Length**: envelope decay/attack duration (range 0-7) +- **Sound Length**: cuts off sound after specified length, overriding the Length value -- [Up and Down radio buttons] - Up makes the envelope an attack, down makes it decay. _Note:_ For envelope attack to have any effect, start at a lower volume! +- **Up and Down radio buttons**: Up makes the envelope an attack, down makes it decay. _Note:_ For envelope attack to have any effect, start at a lower volume! -- [Hardware Sequence] - (document this) +- **Hardware Sequence**: (document this) ## Macros -- [Volume] - volume sequence. _Note:_ This only appears if "Use software envelope" is checked. -- [Arpeggio] - pitch in half-steps -- [Duty/Noise] - pulse wave duty cycle or noise mode sequence -- [Waveform] - ch3 wavetable sequence -- [Panning] - output for left and right channels -- [Pitch] - fine pitch -- [Phase Reset] - trigger restart of waveform +- **Volume**: volume sequence. _Note:_ This only appears if "Use software envelope" is checked. +- **Arpeggio**: pitch in half-steps +- **Duty/Noise**: pulse wave duty cycle or noise mode sequence +- **Waveform**: ch3 wavetable sequence +- **Panning**: output for left and right channels +- **Pitch**: fine pitch +- **Phase Reset**: trigger restart of waveform diff --git a/doc/4-instrument/list.png b/doc/4-instrument/list.png index d85cea628..e8af84a83 100644 Binary files a/doc/4-instrument/list.png and b/doc/4-instrument/list.png differ diff --git a/doc/4-instrument/lynx.md b/doc/4-instrument/lynx.md index b181e8e28..43dc1734d 100644 --- a/doc/4-instrument/lynx.md +++ b/doc/4-instrument/lynx.md @@ -2,13 +2,13 @@ Atari Lynx instrument editor consists of these macros: -- [Volume] - volume sequence -- [Arpeggio] - pitch in half-steps -- [Duty/Int] - bit pattern for LFSR taps and integration -- [Panning (left)] - output level for left channel -- [Panning (right)] - output level for right channel -- [Pitch] - fine pitch -- [Phase Reset] - trigger restart of waveform +- **Volume**: volume sequence +- **Arpeggio**: pitch in half-steps +- **Duty/Int**: bit pattern for LFSR taps and integration +- **Panning (left)**: output level for left channel +- **Panning (right)**: output level for right channel +- **Pitch**: fine pitch +- **Phase Reset**: trigger restart of waveform ## Audio generation description diff --git a/doc/4-instrument/macro-ADSR.png b/doc/4-instrument/macro-ADSR.png index e514a85bb..f38d14329 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 4e3f409b2..2580426f4 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 c79bce9f1..90cb5c088 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 438dbd66c..6529a72ca 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 e02e94f93..8ad9c24b3 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 916153d5c..dd316c205 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 bd6cebe24..6ea2050b4 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 42a2a635e..4e03bad92 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 d2bd59718..faadedb2e 100644 Binary files a/doc/4-instrument/macroview.png and b/doc/4-instrument/macroview.png differ diff --git a/doc/4-instrument/n163.md b/doc/4-instrument/n163.md index 4cd122614..1ec459143 100644 --- a/doc/4-instrument/n163.md +++ b/doc/4-instrument/n163.md @@ -4,27 +4,27 @@ The Namco 163 instrument editor consists of two tabs: "Namco 163" for control of ## Namco 163 -- [Waveform] - Determines the initial waveform for playing. -- [Offset] - Determines the initial waveform position will be load to RAM. -- [Length] - Determines the initial waveform length will be load to RAM. -- [Load waveform before playback] - Determines the load initial waveform into RAM before playback. -- [Update waveforms into RAM when every waveform changes] - Determines the update every different waveform changes in playback. +- **Waveform**: Determines the initial waveform for playing. +- **Offset**: Determines the initial waveform position will be load to RAM. +- **Length**: Determines the initial waveform length will be load to RAM. +- **Load waveform before playback**: Determines the load initial waveform into RAM before playback. +- **Update waveforms into RAM when every waveform changes**: Determines the update every different waveform changes in playback. ## Macros -- [Volume] - volume levels sequence -- [Arpeggio]- pitch sequence -- [Waveform] - sets waveform source for playback immediately or update later -- [Panning] - output for left and right channels -- [Pitch] - fine pitch -- [Phase Reset] - trigger restart of waveform +- **Volume**: volume levels sequence +- **Arpeggio**: pitch sequence +- **Waveform**: sets waveform source for playback immediately or update later +- **Panning**: output for left and right channels +- **Pitch**: fine pitch +- **Phase Reset**: trigger restart of waveform \ No newline at end of file diff --git a/doc/4-instrument/pce.md b/doc/4-instrument/pce.md index 96a910af2..72c87470b 100644 --- a/doc/4-instrument/pce.md +++ b/doc/4-instrument/pce.md @@ -2,13 +2,13 @@ The PCE instrument editor consists of these macros: -- [Volume] - volume sequence -- [Arpeggio] - pitch in half-steps -- [Noise] - enable noise mode (ch5 and ch6 only) -- [Waveform] - wavetable sequence -- [Panning (left)] - output level for left channel -- [Panning (right)] - output level for right channel -- [Pitch] - fine pitch -- [Phase Reset] - trigger restart of waveform +- **Volume**: volume sequence +- **Arpeggio**: pitch in half-steps +- **Noise**: enable noise mode (ch5 and ch6 only) +- **Waveform**: wavetable sequence +- **Panning (left)**: output level for left channel +- **Panning (right)**: output level for right channel +- **Pitch**: fine pitch +- **Phase Reset**: trigger restart of waveform It also has wavetable synthesizer support, but unfortunately, it clicks a lot when in use on the HuC6280. diff --git a/doc/4-instrument/saa.md b/doc/4-instrument/saa.md index 4e6f76a7a..1611bd61c 100644 --- a/doc/4-instrument/saa.md +++ b/doc/4-instrument/saa.md @@ -2,11 +2,11 @@ The SAA1099 instrument editor consists of these macros: -- [Volume] - volume sequence -- [Arpeggio] - pitch sequence -- [Duty/Noise] - noise generator frequency -- [Waveform] - selector between tone and noise -- [Panning (left)] - output level for left channel -- [Panning (right)] - output level for right channel -- [Pitch] - fine pitch -- [Envelope] - envelope generator shape +- **Volume**: volume sequence +- **Arpeggio**: pitch sequence +- **Duty/Noise**: noise generator frequency +- **Waveform**: selector between tone and noise +- **Panning (left)**: output level for left channel +- **Panning (right)**: output level for right channel +- **Pitch**: fine pitch +- **Envelope**: envelope generator shape diff --git a/doc/4-instrument/scc.md b/doc/4-instrument/scc.md index 33d5f341d..fa9a9408b 100644 --- a/doc/4-instrument/scc.md +++ b/doc/4-instrument/scc.md @@ -2,7 +2,7 @@ The SCC/Bubble System WSG instrument editor consists of these macros: -- [Volume] - volume sequence -- [Arpeggio] - pitch sequence -- [Waveform] - spicifies wavetables sequence -- [Pitch] - fine pitch +- **Volume**: volume sequence +- **Arpeggio**: pitch sequence +- **Waveform**: spicifies wavetables sequence +- **Pitch**: fine pitch diff --git a/doc/4-instrument/standard.md b/doc/4-instrument/standard.md index 0cf7a7290..2da6e1601 100644 --- a/doc/4-instrument/standard.md +++ b/doc/4-instrument/standard.md @@ -2,9 +2,9 @@ The instrument editor for NES and PSG (SMS, MSX, and such) consists of these macros: -- [Volume] - volume -- [Arpeggio] - pitch in half-steps -- [Duty] - duty cycle and noise mode for NES channels. _Note:_ This has no effect on Sega Master System. -- [Panning] - output for left and right channels -- [Pitch] - fine pitch -- [Phase Reset] - trigger restart of waveform \ No newline at end of file +- **Volume**: volume +- **Arpeggio**: pitch in half-steps +- **Duty**: duty cycle and noise mode for NES channels. _Note:_ This has no effect on Sega Master System. +- **Panning**: output for left and right channels +- **Pitch**: fine pitch +- **Phase Reset**: trigger restart of waveform \ No newline at end of file diff --git a/doc/4-instrument/tia.md b/doc/4-instrument/tia.md index c80dc42a3..704d3aa21 100644 --- a/doc/4-instrument/tia.md +++ b/doc/4-instrument/tia.md @@ -2,7 +2,7 @@ The TIA instrument editor consists of these macros: -- [Volume] - volume sequence -- [Arpeggio] - pitch sequencr -- [Waveform] - 1-bit polynomial pattern type sequence -- [Pitch] - "fine" pitch +- **Volume**: volume sequence +- **Arpeggio**: pitch sequencr +- **Waveform**: 1-bit polynomial pattern type sequence +- **Pitch**: "fine" pitch diff --git a/doc/4-instrument/vera.md b/doc/4-instrument/vera.md index ed6cbbec2..ec76f6598 100644 --- a/doc/4-instrument/vera.md +++ b/doc/4-instrument/vera.md @@ -2,9 +2,9 @@ VERA instrument editor consists of these macros: -- [Volume] - volume sequence -- [Arpeggio] - pitch sequence -- [Duty] - pulse duty cycle sequence -- [Waveform] - select the waveform used by instrument -- [Panning] - output for left and right channels -- [Pitch] - fine pitch +- **Volume**: volume sequence +- **Arpeggio**: pitch sequence +- **Duty**: pulse duty cycle sequence +- **Waveform**: select the waveform used by instrument +- **Panning**: output for left and right channels +- **Pitch**: fine pitch diff --git a/doc/4-instrument/vrc6.md b/doc/4-instrument/vrc6.md index 4a8e86ae2..17588b219 100644 --- a/doc/4-instrument/vrc6.md +++ b/doc/4-instrument/vrc6.md @@ -2,10 +2,10 @@ The VRC6 (regular) instrument editor consists of these macros: -- [Volume] - volume sequence -- [Arpeggio] - pitch sequence -- [Duty] - specifies duty cycle for pulse wave channels -- [Pitch] - fine pitch +- **Volume**: volume sequence +- **Arpeggio**: pitch sequence +- **Duty**: specifies duty cycle for pulse wave channels +- **Pitch**: fine pitch ## VRC6 (saw) instrument editor diff --git a/doc/4-instrument/wonderswan.md b/doc/4-instrument/wonderswan.md index 6ad0e8c97..d43e154ec 100644 --- a/doc/4-instrument/wonderswan.md +++ b/doc/4-instrument/wonderswan.md @@ -2,7 +2,7 @@ WS instrument editor consists of only four macros, similar to PCE but with different volume and noise range: -- [Volume] - volume sequence -- [Arpeggio] - pitch sequencr -- [Noise] - noise LFSR tap sequence -- [Waveform] - spicifies wavetables sequence +- **Volume**: volume sequence +- **Arpeggio**: pitch sequencr +- **Noise**: noise LFSR tap sequence +- **Waveform**: spicifies wavetables sequence diff --git a/doc/4-instrument/x1_010.md b/doc/4-instrument/x1_010.md index c76cbcb54..2311f74d0 100644 --- a/doc/4-instrument/x1_010.md +++ b/doc/4-instrument/x1_010.md @@ -2,10 +2,10 @@ X1-010 instrument editor consists of 7 macros. -- [Volume] - volume levels sequence -- [Arpeggio]- pitch sequence -- [Waveform] - spicifies wavetables sequence -- [Envelope Mode] - allows shaping an envelope -- [Envelope] - spicifies envelope shape sequence, it's also wavetable. -- [Auto envelope numerator] - sets the envelope to the channel's frequency multiplied by numerator -- [Auto envelope denominator] - sets the envelope to the channel's frequency divided by denominator +- **Volume**: volume levels sequence +- **Arpeggio**: pitch sequence +- **Waveform**: spicifies wavetables sequence +- **Envelope Mode**: allows shaping an envelope +- **Envelope**: spicifies envelope shape sequence, it's also wavetable. +- **Auto envelope numerator**: sets the envelope to the channel's frequency multiplied by numerator +- **Auto envelope denominator**: sets the envelope to the channel's frequency divided by denominator diff --git a/doc/5-wave/README.md b/doc/5-wave/README.md index a42ffd815..cdf344f0c 100644 --- a/doc/5-wave/README.md +++ b/doc/5-wave/README.md @@ -6,13 +6,13 @@ Furnace's wavetable editor is rather simple, you can draw the waveform using mou Furnace's wavetable editor features multiple ways of creating desired waveform shape: -- Shape tab allows you to select a few predefined basic shapes and indirectly edit it via "Duty", "Exponent" and "XOR Point" sliders: - - `Duty` slider affects mainly pulse waves, determining its wisth, like on C64/VRC6 - - `Exponent` powers the waveform in the mathematical sense of the word (^2, ^3 and so on) - - `XOR Point` determines the point where the waveform gets negated. - - TODO: amplitude/phase part -- FM is for creating the waveform with frequency modulation synthesis principles: One can set carrier/modulation levels, frquency multiplier, connection between operators and FM waveforms of these operators. -- WaveTools allows user to fine-tune the waveform: scale said waveform in both X and Y axes, smoothen, amplify, normalize, convert to signed/unisgned, invert or even randomize the wavetable. +- **Shape** tab allows you to select a few predefined basic shapes and indirectly edit it via "Duty", "Exponent" and "XOR Point" sliders: + - **Duty**: Affects mainly pulse waves, determining its wisth, like on C64/VRC6 + - **Exponent**: Powers the waveform in the mathematical sense of the word (^2, ^3 and so on) + - **XOR Point**: Determines the point where the waveform gets negated. + - _TODO:_ amplitude/phase part +- **FM** For creating the waveform with frequency modulation synthesis principles: One can set carrier/modulation levels, frquency multiplier, connection between operators and FM waveforms of these operators. +- **WaveTools**: Allows user to fine-tune the waveform: scale said waveform in both X and Y axes, smoothen, amplify, normalize, convert to signed/unisgned, invert or even randomize the wavetable. ## wavetable synthesizer diff --git a/doc/7-systems/amiga.md b/doc/7-systems/amiga.md index 419114450..907b79fed 100644 --- a/doc/7-systems/amiga.md +++ b/doc/7-systems/amiga.md @@ -6,10 +6,10 @@ in this very computer music trackers were born... # effects -- `10xx`: toggle low-pass filter. `0` turns it off and `1` turns it on. -- `11xx`: toggle amplitude modulation with the next channel. +- **`10xx`**: toggle low-pass filter. `0` turns it off and `1` turns it on. +- **`11xx`**: toggle amplitude modulation with the next channel. - does not work on the last channel. -- `12xx`: toggle period (frequency) modulation with the next channel. +- **`12xx`**: toggle period (frequency) modulation with the next channel. - does not work on the last channel. -- `13xx`: change wave. +- **`13xx`**: change wave. - only works when "Mode" is set to "Wavetable" in the instrument. diff --git a/doc/7-systems/ay8910.md b/doc/7-systems/ay8910.md index 25eb77f7e..4b4724e72 100644 --- a/doc/7-systems/ay8910.md +++ b/doc/7-systems/ay8910.md @@ -8,7 +8,7 @@ the AY-3-8914 variant was used in Intellivision, which is pretty much an AY with # effects -- `20xx`: set channel mode. `xx` may be one of the following: +- **`20xx`**: set channel mode. `xx` may be one of the following: - `00`: square - `01`: noise - `02`: square and noise @@ -17,8 +17,8 @@ the AY-3-8914 variant was used in Intellivision, which is pretty much an AY with - `05`: envelope and noise - `06`: envelope and square and noise - `07`: nothing -- `21xx`: set noise frequency. `xx` is a value between 00 and 1F. -- `22xy`: set envelope mode. +- **`21xx`**: set noise frequency. `xx` is a value between 00 and 1F. +- **`22xy`**: set envelope mode. - `x` sets the envelope shape, which may be one of the following: - `0: \___` decay - `4: /___` attack once @@ -31,16 +31,16 @@ the AY-3-8914 variant was used in Intellivision, which is pretty much an AY with - `E: /\/\` obelisco - `F: /___` attack once - if `y` is 1 then the envelope will affect this channel. -- `23xx`: set envelope period low byte. -- `24xx`: set envelope period high byte. -- `25xx`: slide envelope period up. -- `26xx`: slide envelope period down. -- `29xy`: enable auto-envelope mode. +- **`23xx`**: set envelope period low byte. +- **`24xx`**: set envelope period high byte. +- **`25xx`**: slide envelope period up. +- **`26xx`**: slide envelope period down. +- **`29xy`**: enable auto-envelope mode. - in this mode the envelope period is set to the channel's notes, multiplied by a fraction. - `x` is the numerator. - `y` is the denominator. - if `x` or `y` are 0 this will disable auto-envelope mode. -- `2Exx`: write to I/O port A. +- **`2Exx`**: write to I/O port A. - this changes the port's mode to "write". make sure you have connected something to it. -- `2Fxx`: write to I/O port B. +- **`2Fxx`**: write to I/O port B. - this changes the port's mode to "write". make sure you have connected something to it. diff --git a/doc/7-systems/ay8930.md b/doc/7-systems/ay8930.md index 0d471bcaf..dda2e7584 100644 --- a/doc/7-systems/ay8930.md +++ b/doc/7-systems/ay8930.md @@ -9,7 +9,7 @@ emulation of this chip in Furnace is now complete thanks to community efforts an # effects -- `12xx`: set channel duty cycle. `xx` is a value between 00 and 08. +- **`12xx`**: set channel duty cycle. `xx` is a value between 00 and 08. - `00`: 3.125% - `01`: 6.25% - `02`: 12.5% @@ -19,7 +19,7 @@ emulation of this chip in Furnace is now complete thanks to community efforts an - `06`: 87.5% - `07`: 93.75% - `08`: 96.875% -- `20xx`: set channel mode. `xx` may be one of the following: +- **`20xx`**: set channel mode. `xx` may be one of the following: - `00`: square - `01`: noise - `02`: square and noise @@ -28,8 +28,8 @@ emulation of this chip in Furnace is now complete thanks to community efforts an - `05`: envelope and noise - `06`: envelope and square and noise - `07`: nothing -- `21xx`: set noise frequency. `xx` is a value between 00 and FF. -- `22xy`: set envelope mode. +- **`21xx`**: set noise frequency. `xx` is a value between 00 and FF. +- **`22xy`**: set envelope mode. - `x` sets the envelope shape, which may be one of the following: - `0: \___` decay - `4: /___` attack once @@ -42,13 +42,13 @@ emulation of this chip in Furnace is now complete thanks to community efforts an - `E: /\/\` obelisco - `F: /___` attack once - if `y` is 1 then the envelope will affect this channel. -- `23xx`: set envelope period low byte. -- `24xx`: set envelope period high byte. -- `25xx`: slide envelope period up. -- `26xx`: slide envelope period down. -- `27xx`: set noise AND mask. -- `28xx`: set noise OR mask. -- `29xy`: enable auto-envelope mode. +- **`23xx`**: set envelope period low byte. +- **`24xx`**: set envelope period high byte. +- **`25xx`**: slide envelope period up. +- **`26xx`**: slide envelope period down. +- **`27xx`**: set noise AND mask. +- **`28xx`**: set noise OR mask. +- **`29xy`**: enable auto-envelope mode. - in this mode the envelope period is set to the channel's notes, multiplied by a fraction. - `x` is the numerator. - `y` is the denominator. diff --git a/doc/7-systems/bubblesystem.md b/doc/7-systems/bubblesystem.md index b339b893e..1a904b9d8 100644 --- a/doc/7-systems/bubblesystem.md +++ b/doc/7-systems/bubblesystem.md @@ -10,4 +10,4 @@ Furnace emulates this configuration as a "chip" with 32x16 wavetables. # effects -- `10xx`: change wave. +- **`10xx`**: change wave. diff --git a/doc/7-systems/c64.md b/doc/7-systems/c64.md index 0f8054efa..4b0f26f12 100644 --- a/doc/7-systems/c64.md +++ b/doc/7-systems/c64.md @@ -8,7 +8,7 @@ two versions of aforementioned chip exist - 6581 (original chip) and 8580 (impro # effects -- `10xx`: change wave. the following values are accepted: +- **`10xx`**: change wave. the following values are accepted: - `00`: nothing - `01`: triangle - `02`: saw @@ -18,14 +18,14 @@ two versions of aforementioned chip exist - 6581 (original chip) and 8580 (impro - `06`: pulse and saw - `07`: pulse and triangle and saw - `08`: noise -- `11xx`: set coarse cutoff. `xx` may be a value between 00 to 64. +- **`11xx`**: set coarse cutoff. `xx` may be a value between 00 to 64. - **this effect only exists for compatibility reasons, and its use is discouraged.** - use effect `4xxx` instead. -- `12xx`: set coarse duty cycle. `xx` may be a value between 00 to 64. +- **`12xx`**: set coarse duty cycle. `xx` may be a value between 00 to 64. - **this effect only exists for compatibility reasons, and its use is discouraged.** - use effect `3xxx` instead. -- `13xx`: set resonance. `xx` may be a value between 00 and 0F. -- `14xx`: set filter mode. the following values are accepted: +- **`13xx`**: set resonance. `xx` may be a value between 00 and 0F. +- **`14xx`**: set filter mode. the following values are accepted: - `00`: filter off - `01`: low pass - `02`: band pass @@ -34,19 +34,19 @@ two versions of aforementioned chip exist - 6581 (original chip) and 8580 (impro - `05`: band reject/stop/notch - `06`: high+band pass - `07`: all pass -- `15xx`: set envelope reset time. +- **`15xx`**: set envelope reset time. - this is the amount of ticks the channel turns off before a note occurs in order to reset the envelope safely. - if `xx` is 0 or higher than the song speed, the envelope will not reset. -- `1Axx`: disable envelope reset for this channel. -- `1Bxy`: reset cutoff: +- **`1Axx`**: disable envelope reset for this channel. +- **`1Bxy`**: reset cutoff: - if `x` is not 0: on new note - if `y` is not 0: now - this effect is not necessary if the instrument's cutoff macro is absolute. -- `1Cxy`: reset duty cycle: +- **`1Cxy`**: reset duty cycle: - if `x` is not 0: on new note - if `y` is not 0: now - this effect is not necessary if the instrument's duty macro is absolute. -- `1Exy`: change additional parameters. +- **`1Exy`**: change additional parameters. - `x` may be one of the following: - `0`: attack (`y` from 0 to F) - `1`: decay (`y` from 0 to F) @@ -55,5 +55,5 @@ two versions of aforementioned chip exist - 6581 (original chip) and 8580 (impro - `4`: ring modulation (`y` is 0 or 1) - `5`: oscillator sync (`y` is 0 or 1) - `6`: disable channel 3 (`y` is 0 or 1) -- `3xxx`: set duty cycle. `xxx` range is 000-FFF -- `4xxx`: set cutoff. `xxx` range is 000-7FF. +- **`3xxx`**: set duty cycle. `xxx` range is 000-FFF +- **`4xxx`**: set cutoff. `xxx` range is 000-7FF. diff --git a/doc/7-systems/es5506.md b/doc/7-systems/es5506.md index acdcd0a43..759fdde50 100644 --- a/doc/7-systems/es5506.md +++ b/doc/7-systems/es5506.md @@ -12,30 +12,30 @@ it supports a whooping 32 channels of 16-bit PCM and: # effects -- `10xx`: set waveform. -- `11xx`: set filter mode (0-3) -- `120x`: set pause (bit 0). Pauses the sample until the bit is unset, where it will then resume where it left off. -- `14xx`: set filter coefficient K1 low byte. -- `15xx`: set filter coefficient K1 high byte. -- `16xx`: set filter coefficient K2 low byte. -- `17xx`: set filter coefficient K2 high byte. -- `18xx`: set filter coefficient K1 slide up. -- `19xx`: set filter coefficient K1 slide down. -- `1Axx`: set filter coefficient K2 slide up. -- `1Bxx`: set filter coefficient K2 slide down. -- `20xx`: set envelope count. -- `22xx`: set envelope left volume ramp. -- `23xx`: set envelope right volume ramp. -- `24xx`: set envelope filter coefficient K1 ramp. -- `25xx`: set envelope filter coefficient K1 ramp (slower). -- `26xx`: set envelope filter coefficient K2 ramp. -- `27xx`: set envelope filter coefficient K2 ramp (slower). -- `3xxx`: set coarse filter coefficient K1. -- `4xxx`: set coarse filter coefficient K2. -- `81xx`: set panning (left channel). -- `82xx`: set panning (right channel). -- `88xx`: set panning (rear channels). -- `89xx`: set panning (rear left channel). -- `8Axx`: set panning (rear right channel). -- `9xxx`: set sample offset (x256). -- `DFxx`: set sample playback direction. +- **`10xx`**: set waveform. +- **`11xx`**: set filter mode (0-3) +- **`120x`**: set pause (bit 0). Pauses the sample until the bit is unset, where it will then resume where it left off. +- **`14xx`**: set filter coefficient K1 low byte. +- **`15xx`**: set filter coefficient K1 high byte. +- **`16xx`**: set filter coefficient K2 low byte. +- **`17xx`**: set filter coefficient K2 high byte. +- **`18xx`**: set filter coefficient K1 slide up. +- **`19xx`**: set filter coefficient K1 slide down. +- **`1Axx`**: set filter coefficient K2 slide up. +- **`1Bxx`**: set filter coefficient K2 slide down. +- **`20xx`**: set envelope count. +- **`22xx`**: set envelope left volume ramp. +- **`23xx`**: set envelope right volume ramp. +- **`24xx`**: set envelope filter coefficient K1 ramp. +- **`25xx`**: set envelope filter coefficient K1 ramp (slower). +- **`26xx`**: set envelope filter coefficient K2 ramp. +- **`27xx`**: set envelope filter coefficient K2 ramp (slower). +- **`3xxx`**: set coarse filter coefficient K1. +- **`4xxx`**: set coarse filter coefficient K2. +- **`81xx`**: set panning (left channel). +- **`82xx`**: set panning (right channel). +- **`88xx`**: set panning (rear channels). +- **`89xx`**: set panning (rear left channel). +- **`8Axx`**: set panning (rear right channel). +- **`9xxx`**: set sample offset (x256). +- **`DFxx`**: set sample playback direction. diff --git a/doc/7-systems/fds.md b/doc/7-systems/fds.md index e7bede281..83e8538b2 100644 --- a/doc/7-systems/fds.md +++ b/doc/7-systems/fds.md @@ -7,14 +7,14 @@ it also offers an additional 6-bit, 64-byte wavetable sound channel with (somewh # effects -- `10xx`: change wave. -- `11xx`: set modulation depth. -- `12xy`: set modulation speed high byte and toggle on/off. +- **`10xx`**: change wave. +- **`11xx`**: set modulation depth. +- **`12xy`**: set modulation speed high byte and toggle on/off. - `x` is the toggle. a value of 1 turns on the modulator. - `y` is the speed. -- `13xx`: set modulation speed low byte. -- `14xx`: set modulator position. -- `15xx`: set modulator wave. +- **`13xx`**: set modulation speed low byte. +- **`14xx`**: set modulator position. +- **`15xx`**: set modulator wave. - `xx` points to a wavetable. it should (preferably) have a height of 7 with the values mapping to: - 0: +0 - 1: +1 diff --git a/doc/7-systems/game-boy.md b/doc/7-systems/game-boy.md index ffc357fb3..16b6c1496 100644 --- a/doc/7-systems/game-boy.md +++ b/doc/7-systems/game-boy.md @@ -6,13 +6,13 @@ with stereo sound, two pulse channels, a wave channel and a noise one it packed # effects -- `10xx`: change wave. -- `11xx`: set noise length. `xx` may be one of: +- **`10xx`**: change wave. +- **`11xx`**: set noise length. `xx` may be one of: - 0: long - 1: short -- `12xx`: set duty cycle (from 0 to 3). -- `13xy`: setup sweep (pulse channels only). +- **`12xx`**: set duty cycle (from 0 to 3). +- **`13xy`**: setup sweep (pulse channels only). - `x` is the time. - `y` is the shift. - set to 0 to disable it. -- `14xx`: set sweep direction. 0 is up and 1 is down. +- **`14xx`**: set sweep direction. 0 is up and 1 is down. diff --git a/doc/7-systems/genesis.md b/doc/7-systems/genesis.md index 335466d0a..fd7fc56df 100644 --- a/doc/7-systems/genesis.md +++ b/doc/7-systems/genesis.md @@ -6,29 +6,29 @@ this console is powered by two sound chips: the [Yamaha YM2612](ym2612.md) and [ # effects -- `10xy`: set LFO parameters. +- **`10xy`**: set LFO parameters. - `x` toggles the LFO. - `y` sets its speed. -- `11xx`: set feedback of channel. -- `12xx`: set operator 1 level. -- `13xx`: set operator 2 level. -- `14xx`: set operator 3 level. -- `15xx`: set operator 4 level. -- `16xy`: set multiplier of operator. +- **`11xx`**: set feedback of channel. +- **`12xx`**: set operator 1 level. +- **`13xx`**: set operator 2 level. +- **`14xx`**: set operator 3 level. +- **`15xx`**: set operator 4 level. +- **`16xy`**: set multiplier of operator. - `x` is the operator (1-4). - `y` is the multiplier. -- `17xx`: enable PCM channel. +- **`17xx`**: enable PCM channel. - this only works on channel 6. - **this effect is there for compatibility reasons** - it is otherwise recommended to use Sample type instruments (which automatically enable PCM mode when used). -- `18xx`: toggle extended channel 3 mode. +- **`18xx`**: toggle extended channel 3 mode. - 0 disables it and 1 enables it. - only in extended channel 3 chip. -- `19xx`: set attack of all operators. -- `1Axx`: set attack of operator 1. -- `1Bxx`: set attack of operator 2. -- `1Cxx`: set attack of operator 3. -- `1Dxx`: set attack of operator 4. -- `20xy`: set PSG noise mode. +- **`19xx`**: set attack of all operators. +- **`1Axx`**: set attack of operator 1. +- **`1Bxx`**: set attack of operator 2. +- **`1Cxx`**: set attack of operator 3. +- **`1Dxx`**: set attack of operator 4. +- **`20xy`**: set PSG noise mode. - `x` controls whether to inherit frequency from PSG channel 3. - 0: use one of 3 preset frequencies (C: A-2; C#: A-3; D: A-4). - 1: use frequency of PSG channel 3. diff --git a/doc/7-systems/lynx.md b/doc/7-systems/lynx.md index e7178a611..7c46ec445 100644 --- a/doc/7-systems/lynx.md +++ b/doc/7-systems/lynx.md @@ -15,6 +15,6 @@ the Atari Lynx has a 6502-based CPU with a sound part (this chip is known as MIK # effects -- `3xxx`: Load LFSR (0 to FFF). +- **`3xxx`**: Load LFSR (0 to FFF). - this is a bitmask. - for it to work, duty macro in instrument editor must be set to some value. without it LFSR will not be fed with any bits. diff --git a/doc/7-systems/mmc5.md b/doc/7-systems/mmc5.md index d483bd57c..ef3e31404 100644 --- a/doc/7-systems/mmc5.md +++ b/doc/7-systems/mmc5.md @@ -8,5 +8,5 @@ additionally, it offers an 8-bit DAC which can be used to play samples. only one # effects -- `12xx`: set duty cycle or noise mode of channel. +- **`12xx`**: set duty cycle or noise mode of channel. - may be 0-3 for the pulse channels. diff --git a/doc/7-systems/msm5232.md b/doc/7-systems/msm5232.md index b08875a3b..7c5ffa6be 100644 --- a/doc/7-systems/msm5232.md +++ b/doc/7-systems/msm5232.md @@ -16,11 +16,11 @@ Furnace implements this chip in a way that allows the following features: # effects -- `10xy`: set group control. +- **`10xy`**: set group control. - `x` sets sustain mode. - `y` is a 4-bit mask which toggles overtones. -- `11xx`: set noise mode. -- `12xx`: set group attack (0 to 5). +- **`11xx`**: set noise mode. +- **`12xx`**: set group attack (0 to 5). - only in internal (capacitor-based) envelope mode. -- `13xx`: set group decay (0 to 11). +- **`13xx`**: set group decay (0 to 11). - only in internal (capacitor-based) envelope mode. diff --git a/doc/7-systems/msm6295.md b/doc/7-systems/msm6295.md index 257669277..1faf15664 100644 --- a/doc/7-systems/msm6295.md +++ b/doc/7-systems/msm6295.md @@ -4,4 +4,4 @@ an upgrade from 6258 - it provides 4 ADPCM channels, at max 32 KHz (still no var # effects -- `20xx`: set chip output rate. +- **`20xx`**: set chip output rate. diff --git a/doc/7-systems/n163.md b/doc/7-systems/n163.md index 06f2d0b1f..50b2bbd11 100644 --- a/doc/7-systems/n163.md +++ b/doc/7-systems/n163.md @@ -17,16 +17,16 @@ both waveform playback and load command work independently per each channel colu # effects -- `10xx`: set waveform for playback. -- `11xx`: set waveform position in RAM for playback (single nibble unit). -- `12xx`: set waveform length in RAM for playback (04 to FC, 4 nibble unit). -- `130x`: set playback waveform update behavior (0: off, bit 0: update now, bit 1: update when every waveform is changed). -- `14xx`: set waveform for load to RAM. -- `15xx`: set waveform position for load to RAM (single nibble unit). -- `16xx`: set waveform length for load to RAM (04 to FC, 4 nibble unit). -- `170x`: set waveform load behavior (0: off, bit 0: load now, bit 1: load when every waveform is changed). -- `180x`: set channel limit (0 to 7, x + 1). -- `20xx`: (Global) set waveform for load to RAM. -- `21xx`: (Global) set waveform position for load to RAM (single nibble unit). -- `22xx`: (Global) set waveform length for load to RAM (04 to FC, 4 nibble unit). -- `230x`: (Global) set waveform load behavior (0: off, bit 0: load now, bit 1: load when every waveform is changed). +- **`10xx`**: set waveform for playback. +- **`11xx`**: set waveform position in RAM for playback (single nibble unit). +- **`12xx`**: set waveform length in RAM for playback (04 to FC, 4 nibble unit). +- **`130x`**: set playback waveform update behavior (0: off, bit 0: update now, bit 1: update when every waveform is changed). +- **`14xx`**: set waveform for load to RAM. +- **`15xx`**: set waveform position for load to RAM (single nibble unit). +- **`16xx`**: set waveform length for load to RAM (04 to FC, 4 nibble unit). +- **`170x`**: set waveform load behavior (0: off, bit 0: load now, bit 1: load when every waveform is changed). +- **`180x`**: set channel limit (0 to 7, x + 1). +- **`20xx`**: (Global) set waveform for load to RAM. +- **`21xx`**: (Global) set waveform position for load to RAM (single nibble unit). +- **`22xx`**: (Global) set waveform length for load to RAM (04 to FC, 4 nibble unit). +- **`230x`**: (Global) set waveform load behavior (0: off, bit 0: load now, bit 1: load when every waveform is changed). diff --git a/doc/7-systems/namco.md b/doc/7-systems/namco.md index 0a53d15d7..12d9ec9ef 100644 --- a/doc/7-systems/namco.md +++ b/doc/7-systems/namco.md @@ -6,5 +6,5 @@ everything starts with Namco WSG, which is a simple 3-channel wavetable with no # effects -- `10xx`: change waveform. -- `11xx`: toggle noise mode (WARNING: only on C30). +- **`10xx`**: change waveform. +- **`11xx`**: toggle noise mode (WARNING: only on C30). diff --git a/doc/7-systems/nes.md b/doc/7-systems/nes.md index 8367c5891..9292a1de5 100644 --- a/doc/7-systems/nes.md +++ b/doc/7-systems/nes.md @@ -6,30 +6,30 @@ also known as Famicom. it is a five-channel sound generator: first two channels # effects -- `11xx`: write to delta modulation counter. +- **`11xx`**: write to delta modulation counter. - this may be used to attenuate the triangle and noise channels. - will not work if a sample is playing. -- `12xx`: set duty cycle or noise mode of channel. +- **`12xx`**: set duty cycle or noise mode of channel. - may be 0-3 for the pulse channels and 0-1 for the noise channel. -- `13xy`: setup sweep up. +- **`13xy`**: setup sweep up. - `x` is the time. - `y` is the shift. - set to 0 to disable it. -- `14xy`: setup sweep down. +- **`14xy`**: setup sweep down. - `x` is the time. - `y` is the shift. - set to 0 to disable it. -- `15xx`: set envelope mode. +- **`15xx`**: set envelope mode. - `0`: envelope + length counter (volume represents envelope duration). - `1`: length counter (volume represents output volume). - `2`: looping envelope (volume represents envelope duration). - `3`: constant volume (default; volume represents output volume). - pulse and noise channels only. - you may need to apply a phase reset (using the macro) to make the envelope effective. -- `16xx`: set length counter. +- **`16xx`**: set length counter. - see table below for possible values. - this will trigger phase reset. -- `17xx`: set frame counter mode. +- **`17xx`**: set frame counter mode. - `0`: 4-step. - NTSC: 120Hz sweeps and lengths; 240Hz envelope. - PAL: 100Hz sweeps and lengths; 200Hz envelope. @@ -38,14 +38,14 @@ also known as Famicom. it is a five-channel sound generator: first two channels - NTSC: 96Hz sweeps and lengths; 192Hz envelope. - PAL: 80Hz sweeps and lengths; 160Hz envelope. - Dendy: 95.1Hz sweeps and lengths; 190.2Hz envelope. -- `18xx`: set PCM channel mode. +- **`18xx`**: set PCM channel mode. - `00`: PCM (software). - `01`: DPCM (hardware). - when in DPCM mode, samples will sound muffled (due to its nature), availables pitches are limited and loop point is ignored. -- `19xx`: set triangle linear counter. +- **`19xx`**: set triangle linear counter. - `00` to `7F` set the counter. - `80` and higher halt it. -- `20xx`: set DPCM frequency. +- **`20xx`**: set DPCM frequency. - only works in DPCM mode. - see table below for possible values. diff --git a/doc/7-systems/opl.md b/doc/7-systems/opl.md index 80c002997..3f9e9c0cf 100644 --- a/doc/7-systems/opl.md +++ b/doc/7-systems/opl.md @@ -20,61 +20,61 @@ afterwards everyone moved to Windows and software mixed PCM streaming... - 0: 1dB (shallow) - 1: 4.8dB (deep) - this effect applies to all channels. -- `11xx`: set feedback of channel. -- `12xx`: set operator 1 level. -- `13xx`: set operator 2 level. -- `14xx`: set operator 3 level. +- **`11xx`**: set feedback of channel. +- **`12xx`**: set operator 1 level. +- **`13xx`**: set operator 2 level. +- **`14xx`**: set operator 3 level. - only in 4-op mode (OPL3). -- `15xx`: set operator 4 level. +- **`15xx`**: set operator 4 level. - only in 4-op mode (OPL3). -- `16xy`: set multiplier of operator. +- **`16xy`**: set multiplier of operator. - `x` is the operator (1-4; last 2 operators only in 4-op mode). - `y` is the multiplier. - 17xx: set vibrato depth. the following values are accepted: - 0: normal - 1: double - this effect applies to all channels. -- `18xx`: toggle drums mode. +- **`18xx`**: toggle drums mode. - 0 disables it and 1 enables it. - only in drums chip. -- `19xx`: set attack of all operators. -- `1Axx`: set attack of operator 1. -- `1Bxx`: set attack of operator 2. -- `1Cxx`: set attack of operator 3. +- **`19xx`**: set attack of all operators. +- **`1Axx`**: set attack of operator 1. +- **`1Bxx`**: set attack of operator 2. +- **`1Cxx`**: set attack of operator 3. - only in 4-op mode (OPL3). -- `1Dxx`: set attack of operator 4. +- **`1Dxx`**: set attack of operator 4. - only in 4-op mode (OPL3). -- `2Axy`: set waveform of operator. +- **`2Axy`**: set waveform of operator. - `x` is the operator (1-4; last 2 operators only in 4-op mode). a value of 0 means "all operators". - `y` is the value. - only in OPL2 or higher. -- `30xx`: enable envelope hard reset. +- **`30xx`**: enable envelope hard reset. - this works by inserting a quick release and tiny delay before a new note. -- `50xy`: set AM of operator. +- **`50xy`**: set AM of operator. - `x` is the operator (1-4; last 2 operators only in 4-op mode). a value of 0 means "all operators". - `y` determines whether AM is on. -- `51xy` set SL of operator. +- **`51xy`**: set SL of operator. - `x` is the operator (1-4; last 2 operators only in 4-op mode). a value of 0 means "all operators". - `y` is the value. -- `52xy` set RR of operator. +- **`52xy`**: set RR of operator. - `x` is the operator (1-4; last 2 operators only in 4-op mode). a value of 0 means "all operators". - `y` is the value. -- `53xy`: set VIB of operator. +- **`53xy`**: set VIB of operator. - `x` is the operator (1-4; last 2 operators only in 4-op mode). a value of 0 means "all operators". - `y` determines whether VIB is on. -- `54xy` set KSL of operator. +- **`54xy`**: set KSL of operator. - `x` is the operator (1-4; last 2 operators only in 4-op mode). a value of 0 means "all operators". - `y` is the value. -- `55xy` set SUS of operator. +- **`55xy`**: set SUS of operator. - `x` is the operator (1-4; last 2 operators only in 4-op mode). a value of 0 means "all operators". - `y` determines whether SUS is on. -- `56xx`: set DR of all operators. -- `57xx`: set DR of operator 1. -- `58xx`: set DR of operator 2. -- `59xx`: set DR of operator 3. +- **`56xx`**: set DR of all operators. +- **`57xx`**: set DR of operator 1. +- **`58xx`**: set DR of operator 2. +- **`59xx`**: set DR of operator 3. - only in 4-op mode (OPL3). -- `5Axx`: set DR of operator 4. +- **`5Axx`**: set DR of operator 4. - only in 4-op mode (OPL3). -- `5Bxy`: set KSR of operator. +- **`5Bxy`**: set KSR of operator. - `x` is the operator (1-4; last 2 operators only in 4-op mode). a value of 0 means "all operators". - `y` determines whether KSR is on. diff --git a/doc/7-systems/opll.md b/doc/7-systems/opll.md index 115e4bd70..e4dc3ae37 100644 --- a/doc/7-systems/opll.md +++ b/doc/7-systems/opll.md @@ -29,39 +29,39 @@ the YM2413 is equipped with the following features: # effects -- `11xx`: set feedback of channel. -- `12xx`: set operator 1 level. -- `13xx`: set operator 2 level. -- `16xy`: set multiplier of operator. +- **`11xx`**: set feedback of channel. +- **`12xx`**: set operator 1 level. +- **`13xx`**: set operator 2 level. +- **`16xy`**: set multiplier of operator. - `x` is the operator (1 or 2). - `y` is the multiplier. -- `18xx`: toggle drums mode. +- **`18xx`**: toggle drums mode. - 0 disables it and 1 enables it. - only in drums chip. -- `19xx`: set attack of all operators. -- `1Axx`: set attack of operator 1. -- `1Bxx`: set attack of operator 2. -- `50xy`: set AM of operator. +- **`19xx`**: set attack of all operators. +- **`1Axx`**: set attack of operator 1. +- **`1Bxx`**: set attack of operator 2. +- **`50xy`**: set AM of operator. - `x` is the operator (1-2). a value of 0 means "all operators". - `y` determines whether AM is on. -- `51xy` set SL of operator. +- **`51xy`**: set SL of operator. - `x` is the operator (1-2). a value of 0 means "all operators". - `y` is the value. -- `52xy` set RR of operator. +- **`52xy`**: set RR of operator. - `x` is the operator (1-2). a value of 0 means "all operators". - `y` is the value. -- `53xy`: set VIB of operator. +- **`53xy`**: set VIB of operator. - `x` is the operator (1-2). a value of 0 means "all operators". - `y` determines whether VIB is on. -- `54xy` set KSL of operator. +- **`54xy`**: set KSL of operator. - `x` is the operator (1-2). a value of 0 means "all operators". - `y` is the value. -- `55xy` set EGT of operator. +- **`55xy`**: set EGT of operator. - `x` is the operator (1-2). a value of 0 means "all operators". - `y` determines whether EGT is on. -- `56xx`: set DR of all operators. -- `57xx`: set DR of operator 1. -- `58xx`: set DR of operator 2. -- `5Bxy`: set KSR of operator. +- **`56xx`**: set DR of all operators. +- **`57xx`**: set DR of operator 1. +- **`58xx`**: set DR of operator 2. +- **`5Bxy`**: set KSR of operator. - `x` is the operator (1-2). a value of 0 means "all operators". - `y` determines whether KSR is on. diff --git a/doc/7-systems/opz.md b/doc/7-systems/opz.md index 507e4ab1d..f5b79d4c6 100644 --- a/doc/7-systems/opz.md +++ b/doc/7-systems/opz.md @@ -25,68 +25,68 @@ no plans have been made for TX81Z MIDI passthrough, because: # effects -- `10xx`: set noise frequency of channel 8 operator 4. 00 disables noise while 01 to 20 enables it. -- `11xx`: set feedback of channel. -- `12xx`: set operator 1 level. -- `13xx`: set operator 2 level. -- `14xx`: set operator 3 level. -- `15xx`: set operator 4 level. -- `16xy`: set multiplier of operator. +- **`10xx`**: set noise frequency of channel 8 operator 4. 00 disables noise while 01 to 20 enables it. +- **`11xx`**: set feedback of channel. +- **`12xx`**: set operator 1 level. +- **`13xx`**: set operator 2 level. +- **`14xx`**: set operator 3 level. +- **`15xx`**: set operator 4 level. +- **`16xy`**: set multiplier of operator. - `x` is the operator (1-4). - `y` is the multiplier. -- `17xx`: set LFO speed. -- `18xx`: set LFO waveform. `xx` may be one of the following: +- **`17xx`**: set LFO speed. +- **`18xx`**: set LFO waveform. `xx` may be one of the following: - `00`: saw - `01`: square - `02`: triangle - `03`: noise -- `19xx`: set attack of all operators. -- `1Axx`: set attack of operator 1. -- `1Bxx`: set attack of operator 2. -- `1Cxx`: set attack of operator 3. -- `1Dxx`: set attack of operator 4. -- `1Exx`: set LFO AM depth. -- `1Fxx`: set LFO PM depth. -- `24xx`: set LFO 2 speed. -- `25xx`: set LFO 2 waveform. `xx` may be one of the following: +- **`19xx`**: set attack of all operators. +- **`1Axx`**: set attack of operator 1. +- **`1Bxx`**: set attack of operator 2. +- **`1Cxx`**: set attack of operator 3. +- **`1Dxx`**: set attack of operator 4. +- **`1Exx`**: set LFO AM depth. +- **`1Fxx`**: set LFO PM depth. +- **`24xx`**: set LFO 2 speed. +- **`25xx`**: set LFO 2 waveform. `xx` may be one of the following: - `00`: saw - `01`: square - `02`: triangle - `03`: noise -- `26xx`: set LFO 2 AM depth. -- `27xx`: set LFO 2 PM depth. -- `28xy`: set reverb of operator. +- **`26xx`**: set LFO 2 AM depth. +- **`27xx`**: set LFO 2 PM depth. +- **`28xy`**: set reverb of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `2Axy`: set waveform of operator. +- **`2Axy`**: set waveform of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `2Bxy`: set EG shift of operator. +- **`2Bxy`**: set EG shift of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `2Cxy` set fine multiplier of operator. +- **`2Cxy`**: set fine multiplier of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `2Fxx`: enable envelope hard reset. +- **`2Fxx`**: enable envelope hard reset. - this works by inserting a quick release and tiny delay before a new note. -- `3xyy`: set fixed frequency of operator 1/2. +- **`3xyy`**: set fixed frequency of operator 1/2. - `x` is the block (0-7 for operator 1; 8-F for operator 2). - `y` is the frequency. fixed frequency mode will be disabled if this is less than 8. - the actual frequency is: `y*(2^x)`. -- `4xyy`: set fixed frequency of operator 3/4. +- **`4xyy`**: set fixed frequency of operator 3/4. - `x` is the block (0-7 for operator 3; 8-F for operator 4). - `y` is the frequency. fixed frequency mode will be disabled if this is less than 8. - the actual frequency is: `y*(2^x)`. -- `50xy`: set AM of operator. +- **`50xy`**: set AM of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` determines whether AM is on. -- `51xy` set SL of operator. +- **`51xy`**: set SL of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `52xy` set RR of operator. +- **`52xy`**: set RR of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `53xy` set DT of operator. +- **`53xy`**: set DT of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value: - 0: +0 @@ -97,19 +97,19 @@ no plans have been made for TX81Z MIDI passthrough, because: - 5: -3 - 6: -2 - 7: -1 -- `54xy` set RS of operator. +- **`54xy`**: set RS of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `55xy` set DT2 of operator. +- **`55xy`**: set DT2 of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `56xx`: set DR of all operators. -- `57xx`: set DR of operator 1. -- `58xx`: set DR of operator 2. -- `59xx`: set DR of operator 3. -- `5Axx`: set DR of operator 4. -- `5Bxx`: set D2R/SR of all operators. -- `5Cxx`: set D2R/SR of operator 1. -- `5Dxx`: set D2R/SR of operator 2. -- `5Exx`: set D2R/SR of operator 3. -- `5Fxx`: set D2R/SR of operator 4. +- **`56xx`**: set DR of all operators. +- **`57xx`**: set DR of operator 1. +- **`58xx`**: set DR of operator 2. +- **`59xx`**: set DR of operator 3. +- **`5Axx`**: set DR of operator 4. +- **`5Bxx`**: set D2R/SR of all operators. +- **`5Cxx`**: set D2R/SR of operator 1. +- **`5Dxx`**: set D2R/SR of operator 2. +- **`5Exx`**: set D2R/SR of operator 3. +- **`5Fxx`**: set D2R/SR of operator 4. diff --git a/doc/7-systems/pce.md b/doc/7-systems/pce.md index 2405ac4f6..ea7b0a239 100644 --- a/doc/7-systems/pce.md +++ b/doc/7-systems/pce.md @@ -9,14 +9,14 @@ furthermore, it has some PCM and LFO! # effects -- `10xx`: change wave. -- `11xx`: toggle noise mode. only available in the last two channels. -- `12xx`: setup LFO. the following values are accepted: +- **`10xx`**: change wave. +- **`11xx`**: toggle noise mode. only available in the last two channels. +- **`12xx`**: setup LFO. the following values are accepted: - `00`: LFO disabled. - `01`: LFO enabled, shift 0. - `02`: LFO enabled, shift 4. - `03`: LFO enabled, shift 8. - when LFO is enabled, channel 2 is muted and its output is passed to channel 1's frequency. -- `13xx`: set LFO speed. -- `17xx`: toggle PCM mode. +- **`13xx`**: set LFO speed. +- **`17xx`**: toggle PCM mode. - **this effect is there for compatibility reasons** - it is otherwise recommended to use Sample type instruments (which automatically enable PCM mode when used). diff --git a/doc/7-systems/pet.md b/doc/7-systems/pet.md index f2c2c1c61..8d5406dbf 100644 --- a/doc/7-systems/pet.md +++ b/doc/7-systems/pet.md @@ -8,4 +8,4 @@ some of these didn't even have sound... # effects -- 10xx: set waveform. `xx` is a bitmask. +- **`10xx`**: set waveform. `xx` is a bitmask. diff --git a/doc/7-systems/pokey.md b/doc/7-systems/pokey.md index efebfcd34..cd94652f2 100644 --- a/doc/7-systems/pokey.md +++ b/doc/7-systems/pokey.md @@ -4,7 +4,7 @@ a sound and input chip developed by Atari for their 8-bit computers (Atari 400, # effects -- 10xx: set waveform. +- **`10xx`**: set waveform. - 0: harsh noise (poly5+17) - 1: square buzz (poly5) - 2: weird noise (poly4+5) @@ -13,7 +13,7 @@ a sound and input chip developed by Atari for their 8-bit computers (Atari 400, - 5: square - 6: bass (poly4) - 7: buzz (poly4) -- 11xx: set AUDCTL. `xx` is a bitmask. +- **`11xx`**: set AUDCTL. `xx` is a bitmask. - bit 7: 9-bit poly mode. shortens noise. - bit 6: high channel 1 clock (~1.79MHz on NTSC). - overrides 15KHz mode. @@ -32,6 +32,6 @@ a sound and input chip developed by Atari for their 8-bit computers (Atari 400, - filtered output on channel 2 (I suggest you to set channel 4 volume to 0). - use for PWM effects (not automatic!). - bit 0: 15KHz mode. -- 12xx: toggle two-tone mode. +- **`12xx`**: toggle two-tone mode. - when enabled, channel 2 modulates channel 1. I don't know how, but it does. - only on ASAP core. diff --git a/doc/7-systems/qsound.md b/doc/7-systems/qsound.md index 81bfe4b9c..95bd6124e 100644 --- a/doc/7-systems/qsound.md +++ b/doc/7-systems/qsound.md @@ -12,8 +12,8 @@ there are also 3 ADPCM channels. ADPCM samples are fixed to 8012 Hz. # effects -- `10xx`: set echo feedback level. +- **`10xx`**: set echo feedback level. - this effect will apply to all channels. -- `11xx`: set echo level. -- `12xx`: toggle QSound algorithm (on by default). -- `3xxx`: set the length of the echo delay buffer. +- **`11xx`**: set echo level. +- **`12xx`**: toggle QSound algorithm (on by default). +- **`3xxx`**: set the length of the echo delay buffer. diff --git a/doc/7-systems/saa1099.md b/doc/7-systems/saa1099.md index 8c58bbbb5..55073716f 100644 --- a/doc/7-systems/saa1099.md +++ b/doc/7-systems/saa1099.md @@ -6,13 +6,13 @@ this was used by the Game Blaster and SAM Coupé. it's pretty similar to the AY- # effects -- `10xy`: set channel mode. +- **`10xy`**: set channel mode. - `x` toggles noise. - `y` toggles square. - this effect affects either the first 3 or last 3 channels, depending on where it is placed. -- `11xx`: set noise frequency. +- **`11xx`**: set noise frequency. - this effect affects either the first 3 or last 3 channels, depending on where it is placed. -- `12xx`: setup envelope. this is a bitmask. +- **`12xx`**: setup envelope. this is a bitmask. - bit 7 toggles the envelope. - bit 5 toggles whether to use a fixed frequency or lock to the frequency of channel 2 or 5. - bit 4 sets the envelope resolution. diff --git a/doc/7-systems/scc.md b/doc/7-systems/scc.md index fb69a9cb8..413d240ff 100644 --- a/doc/7-systems/scc.md +++ b/doc/7-systems/scc.md @@ -8,4 +8,4 @@ the SCC+ fixes this issue though (while being compatible with SCC games). # effects -- `10xx`: change wave. +- **`10xx`**: change wave. diff --git a/doc/7-systems/segapcm.md b/doc/7-systems/segapcm.md index ba1a81186..b44ca2505 100644 --- a/doc/7-systems/segapcm.md +++ b/doc/7-systems/segapcm.md @@ -12,6 +12,6 @@ Furnace also has a five channel version of this chip, but it only exists for Def # effects -- `20xx`: set PCM frequency. +- **`20xx`**: set PCM frequency. - `xx` is a 256th fraction of 31250Hz. - this effect exists for mostly DefleMask compatibility - it is otherwise recommended to use Sample type instruments. diff --git a/doc/7-systems/sm8521.md b/doc/7-systems/sm8521.md index e68461987..563aa35cc 100644 --- a/doc/7-systems/sm8521.md +++ b/doc/7-systems/sm8521.md @@ -19,5 +19,5 @@ The sound-related features and quirks of the SM8521 are as follows: ## effect commands -- `10xx` Set waveform +- **`10xx`**: Set waveform - `xx` is a value between 0 and 255, that sets the waveform of the channel you place it on. diff --git a/doc/7-systems/sms.md b/doc/7-systems/sms.md index 37097ccdc..a17f8d229 100644 --- a/doc/7-systems/sms.md +++ b/doc/7-systems/sms.md @@ -8,7 +8,7 @@ on the other hand, the chip was clocked at a much higher speed on Master System # effects -- `20xy`: set noise mode. +- **`20xy`**: set noise mode. - `x` controls whether to inherit frequency from channel 3. - 0: use one of 3 preset frequencies (C: A-2; C#: A-3; D: A-4). - 1: use frequency of channel 3. diff --git a/doc/7-systems/snes.md b/doc/7-systems/snes.md index 61b30635d..a9a98b894 100644 --- a/doc/7-systems/snes.md +++ b/doc/7-systems/snes.md @@ -22,58 +22,58 @@ Furnace also allows the SNES to use wavetables (and the wavetable synthesizer) i # effects -- `10xx`: set waveform. -- `11xx`: toggle noise mode. -- `12xx`: toggle echo on this channel. -- `13xx`: toggle pitch modulation. -- `14xy`: toggle inverting the left or right channels (x: left, y: right). -- `15xx`: set envelope mode. +- **`10xx`**: set waveform. +- **`11xx`**: toggle noise mode. +- **`12xx`**: toggle echo on this channel. +- **`13xx`**: toggle pitch modulation. +- **`14xy`**: toggle inverting the left or right channels (x: left, y: right). +- **`15xx`**: set envelope mode. - 0: ADSR. - 1: gain (direct). - 2: linear decrement. - 3: exponential decrement. - 4: linear increment. - 5: bent line (inverse log) increment. -- `16xx`: set gain (00 to 7F if direct, 00 to 1F otherwise). -- `18xx`: enable echo buffer. -- `19xx`: set echo delay +- **`16xx`**: set gain (00 to 7F if direct, 00 to 1F otherwise). +- **`18xx`**: enable echo buffer. +- **`19xx`**: set echo delay - goes from 0 to F. -- `1Axx`: set left echo channel volume. +- **`1Axx`**: set left echo channel volume. - this is a signed number. - 00 to 7F for 0 to 127. - 80 to FF for -128 to -1. - setting this to -128 is not recommended as it may cause echo output to overflow and therefore click. -- `1Bxx`: set right echo channel volume. +- **`1Bxx`**: set right echo channel volume. - this is a signed number. - 00 to 7F for 0 to 127. - 80 to FF for -128 to -1. - setting this to -128 is not recommended as it may cause echo output to overflow and therefore click. -- `1Cxx`: set echo feedback. +- **`1Cxx`**: set echo feedback. - this is a signed number. - 00 to 7F for 0 to 127. - 80 to FF for -128 to -1. - setting this to -128 is not recommended as it may cause echo output to overflow and therefore click. -- `1Dxx`: set noise generator frequency (00 to 1F). -- `1Exx`: set left dry/global volume. +- **`1Dxx`**: set noise generator frequency (00 to 1F). +- **`1Exx`**: set left dry/global volume. - this does not affect echo. -- `1Fxx`: set right dry/global volume. +- **`1Fxx`**: set right dry/global volume. - this does not affect echo. -- `20xx`: set attack (0 to F). +- **`20xx`**: set attack (0 to F). - only in ADSR envelope mode. -- `21xx`: set decay (0 to 7). +- **`21xx`**: set decay (0 to 7). - only in ADSR envelope mode. -- `22xx`: set sustain (0 to 7). +- **`22xx`**: set sustain (0 to 7). - only in ADSR envelope mode. -- `23xx`: set release (00 to 1F). +- **`23xx`**: set release (00 to 1F). - only in ADSR envelope mode. -- `30xx`: set echo filter coefficient 0. -- `31xx`: set echo filter coefficient 1. -- `32xx`: set echo filter coefficient 2. -- `33xx`: set echo filter coefficient 3. -- `34xx`: set echo filter coefficient 4. -- `35xx`: set echo filter coefficient 5. -- `36xx`: set echo filter coefficient 6. -- `37xx`: set echo filter coefficient 7. +- **`30xx`**: set echo filter coefficient 0. +- **`31xx`**: set echo filter coefficient 1. +- **`32xx`**: set echo filter coefficient 2. +- **`33xx`**: set echo filter coefficient 3. +- **`34xx`**: set echo filter coefficient 4. +- **`35xx`**: set echo filter coefficient 5. +- **`36xx`**: set echo filter coefficient 6. +- **`37xx`**: set echo filter coefficient 7. - all of these are signed numbers. - 00 to 7F for 0 to 127. - 80 to FF for -128 to -1. diff --git a/doc/7-systems/soundunit.md b/doc/7-systems/soundunit.md index 4f1234619..6bc43d180 100644 --- a/doc/7-systems/soundunit.md +++ b/doc/7-systems/soundunit.md @@ -14,7 +14,7 @@ it has the following capabilities: # effects -- `10xx`: set waveform +- **`10xx`**: set waveform - 0: pulse wave - 1: sawtooth - 2: sine wave @@ -23,34 +23,34 @@ it has the following capabilities: - 5: periodic noise - 6: XOR sine - 7: XOR triangle -- `12xx`: set pulse width (0 to 7F) -- `13xx`: set resonance of filter (0 to FF) +- **`12xx`**: set pulse width (0 to 7F) +- **`13xx`**: set resonance of filter (0 to FF) - despite what the internal effects list says (0 to F), you can use a resonance value from 0 to FF (255) -- `14xx`: set filter mode and ringmod +- **`14xx`**: set filter mode and ringmod - bit 0: ring mod - bit 1: low pass - bit 2: high pass - bit 3: band pass -- `15xx`: set frequency sweep period low byte -- `16xx`: set frequency sweep period high byte -- `17xx`: set volume sweep period low byte -- `18xx`: set volume sweep period high byte -- `19xx`: set cutoff sweep period low byte -- `1Axx`: set cutoff sweep period high byte -- `1Bxx`: set frequency sweep boundary -- `1Cxx`: set volume sweep boundary -- `1Dxx`: set cutoff sweep boundary -- `1Exx`: set phase reset period low byte -- `1Fxx`: set phase reset period high byte -- `20xx`: toggle frequency sweep +- **`15xx`**: set frequency sweep period low byte +- **`16xx`**: set frequency sweep period high byte +- **`17xx`**: set volume sweep period low byte +- **`18xx`**: set volume sweep period high byte +- **`19xx`**: set cutoff sweep period low byte +- **`1Axx`**: set cutoff sweep period high byte +- **`1Bxx`**: set frequency sweep boundary +- **`1Cxx`**: set volume sweep boundary +- **`1Dxx`**: set cutoff sweep boundary +- **`1Exx`**: set phase reset period low byte +- **`1Fxx`**: set phase reset period high byte +- **`20xx`**: toggle frequency sweep - bit 0-6: speed - bit 7: up direction -- `21xx`: toggle volume sweep +- **`21xx`**: toggle volume sweep - bit 0-4: speed - bit 5: up direction - bit 6: loop - bit 7: alternate -- `22xx`: toggle cutoff sweep +- **`22xx`**: toggle cutoff sweep - bit 0-6: speed - bit 7: up direction -- `4xxx`: set cutoff (0 to FFF) +- **`4xxx`**: set cutoff (0 to FFF) diff --git a/doc/7-systems/t6w28.md b/doc/7-systems/t6w28.md index 9083cb7a2..346100f02 100644 --- a/doc/7-systems/t6w28.md +++ b/doc/7-systems/t6w28.md @@ -6,6 +6,6 @@ this chip was used in Neo Geo Pocket. # effects -- `20xx`: set noise mode. +- **`20xx`**: set noise mode. - 0: thin pulse. - 1: noise. diff --git a/doc/7-systems/tia.md b/doc/7-systems/tia.md index 3d9146afc..fbfd2edba 100644 --- a/doc/7-systems/tia.md +++ b/doc/7-systems/tia.md @@ -9,7 +9,7 @@ Furnace isn't complete without this one... # effects -- `10xx` select shape. `xx` may be one of: +- **`10xx`**: select shape. `xx` may be one of: - 0: nothing - 1: buzzy - 2: low buzzy diff --git a/doc/7-systems/vera.md b/doc/7-systems/vera.md index be610a809..8d630129b 100644 --- a/doc/7-systems/vera.md +++ b/doc/7-systems/vera.md @@ -7,9 +7,9 @@ currently Furnace does not support the PCM channel's stereo mode, though (except # effects -- `20xx`: set waveform. the following values are accepted: +- **`20xx`**: set waveform. the following values are accepted: - 0: pulse - 1: saw - 2: triangle - 3: noise -- `22xx`: set duty cycle. `xx` may go from 0 to 3F. +- **`22xx`**: set duty cycle. `xx` may go from 0 to 3F. diff --git a/doc/7-systems/vic20.md b/doc/7-systems/vic20.md index cf9a8a46e..4d445936d 100644 --- a/doc/7-systems/vic20.md +++ b/doc/7-systems/vic20.md @@ -15,4 +15,4 @@ these channels are not referred as "square" wave channels since a technique to p ## effect commands - - `10xx` Switch waveform (`xx` from `00` to `0F`) +- **`10xx`**: Switch waveform (`xx` from `00` to `0F`) diff --git a/doc/7-systems/virtual-boy.md b/doc/7-systems/virtual-boy.md index 94a2d0492..9079d1c7b 100644 --- a/doc/7-systems/virtual-boy.md +++ b/doc/7-systems/virtual-boy.md @@ -10,10 +10,10 @@ additionally, channel 5 offers a modulation/sweep unit. the former is similar to # effects -- `10xx`: set waveform. -- `11xx`: set noise length (0 to 7). +- **`10xx`**: set waveform. +- **`11xx`**: set noise length (0 to 7). - only in the noise channel. -- `12xy`: setup envelope. +- **`12xy`**: setup envelope. - `x` determines whether envelope is enabled or not. - 0: disabled - 1: enabled @@ -22,13 +22,13 @@ additionally, channel 5 offers a modulation/sweep unit. the former is similar to - `y` sets the speed and direction. - 0-7: down - 8-F: up -- `13xy`: setup sweep. +- **`13xy`**: setup sweep. - `x` sets the speed. - 0 and 8 are "speed 0" - sweep is ineffective. - `y` sets the shift (0 to 7). - 8 and higher will mute the channel. - only in channel 5. -- `14xy`: setup modulation. +- **`14xy`**: setup modulation. - `x` determines whether it's enabled or not. - 0: disabled - 1: enabled @@ -38,6 +38,6 @@ additionally, channel 5 offers a modulation/sweep unit. the former is similar to - 0 and 8 are "speed 0" - modulation is ineffective. - no, you can't really do Yamaha FM using this. - only in channel 5. -- `15xx`: set modulation wave. +- **`15xx`**: set modulation wave. - `xx` points to a wavetable. it should have a height of 255. - this is an alternative to setting the modulation wave through the instrument. diff --git a/doc/7-systems/vrc6.md b/doc/7-systems/vrc6.md index 0ec4c8b26..e761f90dc 100644 --- a/doc/7-systems/vrc6.md +++ b/doc/7-systems/vrc6.md @@ -14,5 +14,5 @@ Furnace supports this routine for PCM playback, but it consumes a lot of CPU tim these effects only are effective in the pulse channels. -- `12xx`: set duty cycle (0 to 7). -- `17xx`: toggle PCM mode. +- **`12xx`**: set duty cycle (0 to 7). +- **`17xx`**: toggle PCM mode. diff --git a/doc/7-systems/wonderswan.md b/doc/7-systems/wonderswan.md index 21a1a9261..eb3b47cde 100644 --- a/doc/7-systems/wonderswan.md +++ b/doc/7-systems/wonderswan.md @@ -10,12 +10,12 @@ it has 4 wavetable channels. some of them have additional capabilities: # effects -- `10xx`: change wave. -- `11xx`: setup noise mode (channel 4 only). +- **`10xx`**: change wave. +- **`11xx`**: setup noise mode (channel 4 only). - 0: disable. - 1-8: enable and set tap preset. -- `12xx`: setup sweep period (channel 3 only). +- **`12xx`**: setup sweep period (channel 3 only). - 0: disable. - 1-32: enable and set period. -- `13xx`: setup sweep amount (channel 3 only). -- `17xx`: toggle PCM mode (channel 2 only). +- **`13xx`**: setup sweep amount (channel 3 only). +- **`17xx`**: toggle PCM mode (channel 2 only). diff --git a/doc/7-systems/x1-010.md b/doc/7-systems/x1-010.md index 80b5b41a3..deae16e7b 100644 --- a/doc/7-systems/x1-010.md +++ b/doc/7-systems/x1-010.md @@ -25,20 +25,20 @@ In furnace, you can enable the envelope shape split mode. When it is set, its wa # effects -- `10xx`: change wave. -- `11xx`: change envelope shape (also wavetable). -- `17xx`: toggle PCM mode. -- `20xx`: set PCM frequency (1 to FF). -- `22xx`: set envelope mode. +- **`10xx`**: change wave. +- **`11xx`**: change envelope shape (also wavetable). +- **`17xx`**: toggle PCM mode. +- **`20xx`**: set PCM frequency (1 to FF). +- **`22xx`**: set envelope mode. - bit 0 sets whether envelope will affect this channel. - bit 1 toggles the envelope one-shot mode. when it is set, channel is halted after envelope cycle is finished. - bit 2 toggles the envelope shape split mode. when it is set, envelope shape will be split to left half and right half. - bit 3/5 sets whether the right/left shape will mirror the original one. - bit 4/6 sets whether the right/left output will mirror the original one. -- `23xx`: set envelope period. -- `25xx`: slide envelope period up. -- `26xx`: slide envelope period down. -- `29xy`: enable auto-envelope mode. +- **`23xx`**: set envelope period. +- **`25xx`**: slide envelope period up. +- **`26xx`**: slide envelope period down. +- **`29xy`**: enable auto-envelope mode. - in this mode the envelope period is set to the channel's notes, multiplied by a fraction. - `x` is the numerator. - `y` is the denominator. diff --git a/doc/7-systems/ym2151.md b/doc/7-systems/ym2151.md index cef663c8d..affb8c3a9 100644 --- a/doc/7-systems/ym2151.md +++ b/doc/7-systems/ym2151.md @@ -8,40 +8,40 @@ in most arcade boards the chip was used in combination with a PCM chip, like [Se # effects -- `10xx`: set noise frequency of channel 8 operator 4. 00 disables noise while 01 to 20 enables it. -- `11xx`: set feedback of channel. -- `12xx`: set operator 1 level. -- `13xx`: set operator 2 level. -- `14xx`: set operator 3 level. -- `15xx`: set operator 4 level. -- `16xy`: set multiplier of operator. +- **`10xx`**: set noise frequency of channel 8 operator 4. 00 disables noise while 01 to 20 enables it. +- **`11xx`**: set feedback of channel. +- **`12xx`**: set operator 1 level. +- **`13xx`**: set operator 2 level. +- **`14xx`**: set operator 3 level. +- **`15xx`**: set operator 4 level. +- **`16xy`**: set multiplier of operator. - `x` is the operator (1-4). - `y` is the multiplier. -- `17xx`: set LFO speed. -- `18xx`: set LFO waveform. `xx` may be one of the following: +- **`17xx`**: set LFO speed. +- **`18xx`**: set LFO waveform. `xx` may be one of the following: - `00`: saw - `01`: square - `02`: triangle - `03`: noise -- `19xx`: set attack of all operators. -- `1Axx`: set attack of operator 1. -- `1Bxx`: set attack of operator 2. -- `1Cxx`: set attack of operator 3. -- `1Dxx`: set attack of operator 4. -- `1Exx`: set LFO AM depth. -- `1Fxx`: set LFO PM depth. -- `30xx`: enable envelope hard reset. +- **`19xx`**: set attack of all operators. +- **`1Axx`**: set attack of operator 1. +- **`1Bxx`**: set attack of operator 2. +- **`1Cxx`**: set attack of operator 3. +- **`1Dxx`**: set attack of operator 4. +- **`1Exx`**: set LFO AM depth. +- **`1Fxx`**: set LFO PM depth. +- **`30xx`**: enable envelope hard reset. - this works by inserting a quick release and tiny delay before a new note. -- `50xy`: set AM of operator. +- **`50xy`**: set AM of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` determines whether AM is on. -- `51xy` set SL of operator. +- **`51xy`**: set SL of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `52xy` set RR of operator. +- **`52xy`**: set RR of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `53xy` set DT of operator. +- **`53xy`**: set DT of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value: - 0: +0 @@ -52,19 +52,19 @@ in most arcade boards the chip was used in combination with a PCM chip, like [Se - 5: -3 - 6: -2 - 7: -1 -- `54xy` set RS of operator. +- **`54xy`**: set RS of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `55xy` set DT2 of operator. +- **`55xy`**: set DT2 of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `56xx`: set DR of all operators. -- `57xx`: set DR of operator 1. -- `58xx`: set DR of operator 2. -- `59xx`: set DR of operator 3. -- `5Axx`: set DR of operator 4. -- `5Bxx`: set D2R/SR of all operators. -- `5Cxx`: set D2R/SR of operator 1. -- `5Dxx`: set D2R/SR of operator 2. -- `5Exx`: set D2R/SR of operator 3. -- `5Fxx`: set D2R/SR of operator 4. +- **`56xx`**: set DR of all operators. +- **`57xx`**: set DR of operator 1. +- **`58xx`**: set DR of operator 2. +- **`59xx`**: set DR of operator 3. +- **`5Axx`**: set DR of operator 4. +- **`5Bxx`**: set D2R/SR of all operators. +- **`5Cxx`**: set D2R/SR of operator 1. +- **`5Dxx`**: set D2R/SR of operator 2. +- **`5Exx`**: set D2R/SR of operator 3. +- **`5Fxx`**: set D2R/SR of operator 4. diff --git a/doc/7-systems/ym2203.md b/doc/7-systems/ym2203.md index b9f76b8ec..984d32f97 100644 --- a/doc/7-systems/ym2203.md +++ b/doc/7-systems/ym2203.md @@ -11,23 +11,23 @@ several variants of this chip were released as well, with more features. # effects -- `11xx`: set feedback of channel. -- `12xx`: set operator 1 level. -- `13xx`: set operator 2 level. -- `14xx`: set operator 3 level. -- `15xx`: set operator 4 level. -- `16xy`: set multiplier of operator. +- **`11xx`**: set feedback of channel. +- **`12xx`**: set operator 1 level. +- **`13xx`**: set operator 2 level. +- **`14xx`**: set operator 3 level. +- **`15xx`**: set operator 4 level. +- **`16xy`**: set multiplier of operator. - `x` is the operator (1-4). - `y` is the multiplier. -- `18xx`: toggle extended channel 3 mode. +- **`18xx`**: toggle extended channel 3 mode. - 0 disables it and 1 enables it. - only in extended channel 3 chip. -- `19xx`: set attack of all operators. -- `1Axx`: set attack of operator 1. -- `1Bxx`: set attack of operator 2. -- `1Cxx`: set attack of operator 3. -- `1Dxx`: set attack of operator 4. -- `20xx`: set SSG channel mode. `xx` may be one of the following: +- **`19xx`**: set attack of all operators. +- **`1Axx`**: set attack of operator 1. +- **`1Bxx`**: set attack of operator 2. +- **`1Cxx`**: set attack of operator 3. +- **`1Dxx`**: set attack of operator 4. +- **`20xx`**: set SSG channel mode. `xx` may be one of the following: - `00`: square - `01`: noise - `02`: square and noise @@ -36,8 +36,8 @@ several variants of this chip were released as well, with more features. - `05`: envelope and noise - `06`: envelope and square and noise - `07`: nothing -- `21xx`: set noise frequency. `xx` is a value between 00 and 1F. -- `22xy`: set envelope mode. +- **`21xx`**: set noise frequency. `xx` is a value between 00 and 1F. +- **`22xy`**: set envelope mode. - `x` sets the envelope shape, which may be one of the following: - `0: \___` decay - `4: /___` attack once @@ -50,27 +50,27 @@ several variants of this chip were released as well, with more features. - `E: /\/\` obelisco - `F: /___` attack once - if `y` is 1 then the envelope will affect this channel. -- `23xx`: set envelope period low byte. -- `24xx`: set envelope period high byte. -- `25xx`: slide envelope period up. -- `26xx`: slide envelope period down. -- `29xy`: enable SSG auto-envelope mode. +- **`23xx`**: set envelope period low byte. +- **`24xx`**: set envelope period high byte. +- **`25xx`**: slide envelope period up. +- **`26xx`**: slide envelope period down. +- **`29xy`**: enable SSG auto-envelope mode. - in this mode the envelope period is set to the channel's notes, multiplied by a fraction. - `x` is the numerator. - `y` is the denominator. - if `x` or `y` are 0 this will disable auto-envelope mode. -- `30xx`: enable envelope hard reset. +- **`30xx`**: enable envelope hard reset. - this works by inserting a quick release and tiny delay before a new note. -- `50xy`: set AM of operator. +- **`50xy`**: set AM of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` determines whether AM is on. -- `51xy` set SL of operator. +- **`51xy`**: set SL of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `52xy` set RR of operator. +- **`52xy`**: set RR of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `53xy` set DT of operator. +- **`53xy`**: set DT of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value: - 0: +0 @@ -81,21 +81,21 @@ several variants of this chip were released as well, with more features. - 5: -3 - 6: -2 - 7: -1 -- `54xy` set RS of operator. +- **`54xy`**: set RS of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `55xy` set SSG-EG of operator. +- **`55xy`**: set SSG-EG of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value (0-8). - values between 0 and 7 set SSG-EG. - value 8 disables it. -- `56xx`: set DR of all operators. -- `57xx`: set DR of operator 1. -- `58xx`: set DR of operator 2. -- `59xx`: set DR of operator 3. -- `5Axx`: set DR of operator 4. -- `5Bxx`: set D2R/SR of all operators. -- `5Cxx`: set D2R/SR of operator 1. -- `5Dxx`: set D2R/SR of operator 2. -- `5Exx`: set D2R/SR of operator 3. -- `5Fxx`: set D2R/SR of operator 4. +- **`56xx`**: set DR of all operators. +- **`57xx`**: set DR of operator 1. +- **`58xx`**: set DR of operator 2. +- **`59xx`**: set DR of operator 3. +- **`5Axx`**: set DR of operator 4. +- **`5Bxx`**: set D2R/SR of all operators. +- **`5Cxx`**: set D2R/SR of operator 1. +- **`5Dxx`**: set D2R/SR of operator 2. +- **`5Exx`**: set D2R/SR of operator 3. +- **`5Fxx`**: set D2R/SR of operator 4. diff --git a/doc/7-systems/ym2608.md b/doc/7-systems/ym2608.md index 5eda41c1e..5f57e5f6a 100644 --- a/doc/7-systems/ym2608.md +++ b/doc/7-systems/ym2608.md @@ -8,26 +8,26 @@ the YM2610 (OPNB) and YM2610B chips are very similar to this one, but the built- # effects -- `10xy`: set LFO parameters. +- **`10xy`**: set LFO parameters. - `x` toggles the LFO. - `y` sets its speed. -- `11xx`: set feedback of channel. -- `12xx`: set operator 1 level. -- `13xx`: set operator 2 level. -- `14xx`: set operator 3 level. -- `15xx`: set operator 4 level. -- `16xy`: set multiplier of operator. +- **`11xx`**: set feedback of channel. +- **`12xx`**: set operator 1 level. +- **`13xx`**: set operator 2 level. +- **`14xx`**: set operator 3 level. +- **`15xx`**: set operator 4 level. +- **`16xy`**: set multiplier of operator. - `x` is the operator (1-4). - `y` is the multiplier. -- `18xx`: toggle extended channel 3 mode. +- **`18xx`**: toggle extended channel 3 mode. - 0 disables it and 1 enables it. - only in extended channel 3 chip. -- `19xx`: set attack of all operators. -- `1Axx`: set attack of operator 1. -- `1Bxx`: set attack of operator 2. -- `1Cxx`: set attack of operator 3. -- `1Dxx`: set attack of operator 4. -- `20xx`: set SSG channel mode. `xx` may be one of the following: +- **`19xx`**: set attack of all operators. +- **`1Axx`**: set attack of operator 1. +- **`1Bxx`**: set attack of operator 2. +- **`1Cxx`**: set attack of operator 3. +- **`1Dxx`**: set attack of operator 4. +- **`20xx`**: set SSG channel mode. `xx` may be one of the following: - `00`: square - `01`: noise - `02`: square and noise @@ -36,8 +36,8 @@ the YM2610 (OPNB) and YM2610B chips are very similar to this one, but the built- - `05`: envelope and noise - `06`: envelope and square and noise - `07`: nothing -- `21xx`: set noise frequency. `xx` is a value between 00 and 1F. -- `22xy`: set envelope mode. +- **`21xx`**: set noise frequency. `xx` is a value between 00 and 1F. +- **`22xy`**: set envelope mode. - `x` sets the envelope shape, which may be one of the following: - `0: \___` decay - `4: /___` attack once @@ -50,27 +50,27 @@ the YM2610 (OPNB) and YM2610B chips are very similar to this one, but the built- - `E: /\/\` obelisco - `F: /___` attack once - if `y` is 1 then the envelope will affect this channel. -- `23xx`: set envelope period low byte. -- `24xx`: set envelope period high byte. -- `25xx`: slide envelope period up. -- `26xx`: slide envelope period down. -- `29xy`: enable SSG auto-envelope mode. +- **`23xx`**: set envelope period low byte. +- **`24xx`**: set envelope period high byte. +- **`25xx`**: slide envelope period up. +- **`26xx`**: slide envelope period down. +- **`29xy`**: enable SSG auto-envelope mode. - in this mode the envelope period is set to the channel's notes, multiplied by a fraction. - `x` is the numerator. - `y` is the denominator. - if `x` or `y` are 0 this will disable auto-envelope mode. -- `30xx`: enable envelope hard reset. +- **`30xx`**: enable envelope hard reset. - this works by inserting a quick release and tiny delay before a new note. -- `50xy`: set AM of operator. +- **`50xy`**: set AM of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` determines whether AM is on. -- `51xy` set SL of operator. +- **`51xy`**: set SL of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `52xy` set RR of operator. +- **`52xy`**: set RR of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `53xy` set DT of operator. +- **`53xy`**: set DT of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value: - 0: +0 @@ -81,21 +81,21 @@ the YM2610 (OPNB) and YM2610B chips are very similar to this one, but the built- - 5: -3 - 6: -2 - 7: -1 -- `54xy` set RS of operator. +- **`54xy`**: set RS of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `55xy` set SSG-EG of operator. +- **`55xy`**: set SSG-EG of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value (0-8). - values between 0 and 7 set SSG-EG. - value 8 disables it. -- `56xx`: set DR of all operators. -- `57xx`: set DR of operator 1. -- `58xx`: set DR of operator 2. -- `59xx`: set DR of operator 3. -- `5Axx`: set DR of operator 4. -- `5Bxx`: set D2R/SR of all operators. -- `5Cxx`: set D2R/SR of operator 1. -- `5Dxx`: set D2R/SR of operator 2. -- `5Exx`: set D2R/SR of operator 3. -- `5Fxx`: set D2R/SR of operator 4. +- **`56xx`**: set DR of all operators. +- **`57xx`**: set DR of operator 1. +- **`58xx`**: set DR of operator 2. +- **`59xx`**: set DR of operator 3. +- **`5Axx`**: set DR of operator 4. +- **`5Bxx`**: set D2R/SR of all operators. +- **`5Cxx`**: set D2R/SR of operator 1. +- **`5Dxx`**: set D2R/SR of operator 2. +- **`5Exx`**: set D2R/SR of operator 3. +- **`5Fxx`**: set D2R/SR of operator 4. diff --git a/doc/7-systems/ym2610.md b/doc/7-systems/ym2610.md index a18888e60..022b82e98 100644 --- a/doc/7-systems/ym2610.md +++ b/doc/7-systems/ym2610.md @@ -6,26 +6,26 @@ its soundchip is a 4-in-1: 4ch 4-op FM, YM2149 (AY-3-8910 clone) and 2 different # effects -- `10xy`: set LFO parameters. +- **`10xy`**: set LFO parameters. - `x` toggles the LFO. - `y` sets its speed. -- `11xx`: set feedback of channel. -- `12xx`: set operator 1 level. -- `13xx`: set operator 2 level. -- `14xx`: set operator 3 level. -- `15xx`: set operator 4 level. -- `16xy`: set multiplier of operator. +- **`11xx`**: set feedback of channel. +- **`12xx`**: set operator 1 level. +- **`13xx`**: set operator 2 level. +- **`14xx`**: set operator 3 level. +- **`15xx`**: set operator 4 level. +- **`16xy`**: set multiplier of operator. - `x` is the operator (1-4). - `y` is the multiplier. -- `18xx`: toggle extended channel 2 mode. +- **`18xx`**: toggle extended channel 2 mode. - 0 disables it and 1 enables it. - only in extended channel 2 chip. -- `19xx`: set attack of all operators. -- `1Axx`: set attack of operator 1. -- `1Bxx`: set attack of operator 2. -- `1Cxx`: set attack of operator 3. -- `1Dxx`: set attack of operator 4. -- `20xx`: set SSG channel mode. `xx` may be one of the following: +- **`19xx`**: set attack of all operators. +- **`1Axx`**: set attack of operator 1. +- **`1Bxx`**: set attack of operator 2. +- **`1Cxx`**: set attack of operator 3. +- **`1Dxx`**: set attack of operator 4. +- **`20xx`**: set SSG channel mode. `xx` may be one of the following: - `00`: square - `01`: noise - `02`: square and noise @@ -34,8 +34,8 @@ its soundchip is a 4-in-1: 4ch 4-op FM, YM2149 (AY-3-8910 clone) and 2 different - `05`: envelope and noise - `06`: envelope and square and noise - `07`: nothing -- `21xx`: set noise frequency. `xx` is a value between 00 and 1F. -- `22xy`: set envelope mode. +- **`21xx`**: set noise frequency. `xx` is a value between 00 and 1F. +- **`22xy`**: set envelope mode. - `x` sets the envelope shape, which may be one of the following: - `0: \___` decay - `4: /___` attack once @@ -48,27 +48,27 @@ its soundchip is a 4-in-1: 4ch 4-op FM, YM2149 (AY-3-8910 clone) and 2 different - `E: /\/\` obelisco - `F: /___` attack once - if `y` is 1 then the envelope will affect this channel. -- `23xx`: set envelope period low byte. -- `24xx`: set envelope period high byte. -- `25xx`: slide envelope period up. -- `26xx`: slide envelope period down. -- `29xy`: enable SSG auto-envelope mode. +- **`23xx`**: set envelope period low byte. +- **`24xx`**: set envelope period high byte. +- **`25xx`**: slide envelope period up. +- **`26xx`**: slide envelope period down. +- **`29xy`**: enable SSG auto-envelope mode. - in this mode the envelope period is set to the channel's notes, multiplied by a fraction. - `x` is the numerator. - `y` is the denominator. - if `x` or `y` are 0 this will disable auto-envelope mode. -- `30xx`: enable envelope hard reset. +- **`30xx`**: enable envelope hard reset. - this works by inserting a quick release and tiny delay before a new note. -- `50xy`: set AM of operator. +- **`50xy`**: set AM of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` determines whether AM is on. -- `51xy` set SL of operator. +- **`51xy`**: set SL of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `52xy` set RR of operator. +- **`52xy`**: set RR of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `53xy` set DT of operator. +- **`53xy`**: set DT of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value: - 0: +0 @@ -79,21 +79,21 @@ its soundchip is a 4-in-1: 4ch 4-op FM, YM2149 (AY-3-8910 clone) and 2 different - 5: -3 - 6: -2 - 7: -1 -- `54xy` set RS of operator. +- **`54xy`**: set RS of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `55xy` set SSG-EG of operator. +- **`55xy`**: set SSG-EG of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value (0-8). - values between 0 and 7 set SSG-EG. - value 8 disables it. -- `56xx`: set DR of all operators. -- `57xx`: set DR of operator 1. -- `58xx`: set DR of operator 2. -- `59xx`: set DR of operator 3. -- `5Axx`: set DR of operator 4. -- `5Bxx`: set D2R/SR of all operators. -- `5Cxx`: set D2R/SR of operator 1. -- `5Dxx`: set D2R/SR of operator 2. -- `5Exx`: set D2R/SR of operator 3. -- `5Fxx`: set D2R/SR of operator 4. +- **`56xx`**: set DR of all operators. +- **`57xx`**: set DR of operator 1. +- **`58xx`**: set DR of operator 2. +- **`59xx`**: set DR of operator 3. +- **`5Axx`**: set DR of operator 4. +- **`5Bxx`**: set D2R/SR of all operators. +- **`5Cxx`**: set D2R/SR of operator 1. +- **`5Dxx`**: set D2R/SR of operator 2. +- **`5Exx`**: set D2R/SR of operator 3. +- **`5Fxx`**: set D2R/SR of operator 4. diff --git a/doc/7-systems/ym2610b.md b/doc/7-systems/ym2610b.md index f20e82ed5..feeea9f18 100644 --- a/doc/7-systems/ym2610b.md +++ b/doc/7-systems/ym2610b.md @@ -5,26 +5,26 @@ it is backward compatible with the original chip. # effects -- `10xy`: set LFO parameters. +- **`10xy`**: set LFO parameters. - `x` toggles the LFO. - `y` sets its speed. -- `11xx`: set feedback of channel. -- `12xx`: set operator 1 level. -- `13xx`: set operator 2 level. -- `14xx`: set operator 3 level. -- `15xx`: set operator 4 level. -- `16xy`: set multiplier of operator. +- **`11xx`**: set feedback of channel. +- **`12xx`**: set operator 1 level. +- **`13xx`**: set operator 2 level. +- **`14xx`**: set operator 3 level. +- **`15xx`**: set operator 4 level. +- **`16xy`**: set multiplier of operator. - `x` is the operator (1-4). - `y` is the multiplier. -- `18xx`: toggle extended channel 3 mode. +- **`18xx`**: toggle extended channel 3 mode. - 0 disables it and 1 enables it. - only in extended channel 3 chip. -- `19xx`: set attack of all operators. -- `1Axx`: set attack of operator 1. -- `1Bxx`: set attack of operator 2. -- `1Cxx`: set attack of operator 3. -- `1Dxx`: set attack of operator 4. -- `20xx`: set SSG channel mode. `xx` may be one of the following: +- **`19xx`**: set attack of all operators. +- **`1Axx`**: set attack of operator 1. +- **`1Bxx`**: set attack of operator 2. +- **`1Cxx`**: set attack of operator 3. +- **`1Dxx`**: set attack of operator 4. +- **`20xx`**: set SSG channel mode. `xx` may be one of the following: - `00`: square - `01`: noise - `02`: square and noise @@ -33,8 +33,8 @@ it is backward compatible with the original chip. - `05`: envelope and noise - `06`: envelope and square and noise - `07`: nothing -- `21xx`: set noise frequency. `xx` is a value between 00 and 1F. -- `22xy`: set envelope mode. +- **`21xx`**: set noise frequency. `xx` is a value between 00 and 1F. +- **`22xy`**: set envelope mode. - `x` sets the envelope shape, which may be one of the following: - `0: \___` decay - `4: /___` attack once @@ -47,27 +47,27 @@ it is backward compatible with the original chip. - `E: /\/\` obelisco - `F: /___` attack once - if `y` is 1 then the envelope will affect this channel. -- `23xx`: set envelope period low byte. -- `24xx`: set envelope period high byte. -- `25xx`: slide envelope period up. -- `26xx`: slide envelope period down. -- `29xy`: enable SSG auto-envelope mode. +- **`23xx`**: set envelope period low byte. +- **`24xx`**: set envelope period high byte. +- **`25xx`**: slide envelope period up. +- **`26xx`**: slide envelope period down. +- **`29xy`**: enable SSG auto-envelope mode. - in this mode the envelope period is set to the channel's notes, multiplied by a fraction. - `x` is the numerator. - `y` is the denominator. - if `x` or `y` are 0 this will disable auto-envelope mode. -- `30xx`: enable envelope hard reset. +- **`30xx`**: enable envelope hard reset. - this works by inserting a quick release and tiny delay before a new note. -- `50xy`: set AM of operator. +- **`50xy`**: set AM of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` determines whether AM is on. -- `51xy` set SL of operator. +- **`51xy`**: set SL of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `52xy` set RR of operator. +- **`52xy`**: set RR of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `53xy` set DT of operator. +- **`53xy`**: set DT of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value: - 0: +0 @@ -78,21 +78,21 @@ it is backward compatible with the original chip. - 5: -3 - 6: -2 - 7: -1 -- `54xy` set RS of operator. +- **`54xy`**: set RS of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `55xy` set SSG-EG of operator. +- **`55xy`**: set SSG-EG of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value (0-8). - values between 0 and 7 set SSG-EG. - value 8 disables it. -- `56xx`: set DR of all operators. -- `57xx`: set DR of operator 1. -- `58xx`: set DR of operator 2. -- `59xx`: set DR of operator 3. -- `5Axx`: set DR of operator 4. -- `5Bxx`: set D2R/SR of all operators. -- `5Cxx`: set D2R/SR of operator 1. -- `5Dxx`: set D2R/SR of operator 2. -- `5Exx`: set D2R/SR of operator 3. -- `5Fxx`: set D2R/SR of operator 4. +- **`56xx`**: set DR of all operators. +- **`57xx`**: set DR of operator 1. +- **`58xx`**: set DR of operator 2. +- **`59xx`**: set DR of operator 3. +- **`5Axx`**: set DR of operator 4. +- **`5Bxx`**: set D2R/SR of all operators. +- **`5Cxx`**: set D2R/SR of operator 1. +- **`5Dxx`**: set D2R/SR of operator 2. +- **`5Exx`**: set D2R/SR of operator 3. +- **`5Fxx`**: set D2R/SR of operator 4. diff --git a/doc/7-systems/ym2612.md b/doc/7-systems/ym2612.md index dda452665..afdb98f36 100644 --- a/doc/7-systems/ym2612.md +++ b/doc/7-systems/ym2612.md @@ -4,39 +4,39 @@ one of two chips that powered the Sega Genesis. It is a six-channel, four-operat # effects -- `10xy`: set LFO parameters. +- **`10xy`**: set LFO parameters. - `x` toggles the LFO. - `y` sets its speed. -- `11xx`: set feedback of channel. -- `12xx`: set operator 1 level. -- `13xx`: set operator 2 level. -- `14xx`: set operator 3 level. -- `15xx`: set operator 4 level. -- `16xy`: set multiplier of operator. +- **`11xx`**: set feedback of channel. +- **`12xx`**: set operator 1 level. +- **`13xx`**: set operator 2 level. +- **`14xx`**: set operator 3 level. +- **`15xx`**: set operator 4 level. +- **`16xy`**: set multiplier of operator. - `x` is the operator (1-4). - `y` is the multiplier. -- `17xx`: enable PCM channel. +- **`17xx`**: enable PCM channel. - this only works on channel 6. -- `18xx`: toggle extended channel 3 mode. +- **`18xx`**: toggle extended channel 3 mode. - 0 disables it and 1 enables it. - only in extended channel 3 chip. -- `19xx`: set attack of all operators. -- `1Axx`: set attack of operator 1. -- `1Bxx`: set attack of operator 2. -- `1Cxx`: set attack of operator 3. -- `1Dxx`: set attack of operator 4. -- `30xx`: enable envelope hard reset. +- **`19xx`**: set attack of all operators. +- **`1Axx`**: set attack of operator 1. +- **`1Bxx`**: set attack of operator 2. +- **`1Cxx`**: set attack of operator 3. +- **`1Dxx`**: set attack of operator 4. +- **`30xx`**: enable envelope hard reset. - this works by inserting a quick release and tiny delay before a new note. -- `50xy`: set AM of operator. +- **`50xy`**: set AM of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` determines whether AM is on. -- `51xy` set SL of operator. +- **`51xy`**: set SL of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `52xy` set RR of operator. +- **`52xy`**: set RR of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `53xy` set DT of operator. +- **`53xy`**: set DT of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value: - 0: -3 @@ -47,21 +47,21 @@ one of two chips that powered the Sega Genesis. It is a six-channel, four-operat - 5: 2 - 6: 3 - 7: -0 -- `54xy` set RS of operator. +- **`54xy`**: set RS of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value. -- `55xy` set SSG-EG of operator. +- **`55xy`**: set SSG-EG of operator. - `x` is the operator (1-4). a value of 0 means "all operators". - `y` is the value (0-8). - values between 0 and 7 set SSG-EG. - value 8 disables it. -- `56xx`: set DR of all operators. -- `57xx`: set DR of operator 1. -- `58xx`: set DR of operator 2. -- `59xx`: set DR of operator 3. -- `5Axx`: set DR of operator 4. -- `5Bxx`: set D2R/SR of all operators. -- `5Cxx`: set D2R/SR of operator 1. -- `5Dxx`: set D2R/SR of operator 2. -- `5Exx`: set D2R/SR of operator 3. -- `5Fxx`: set D2R/SR of operator 4. +- **`56xx`**: set DR of all operators. +- **`57xx`**: set DR of operator 1. +- **`58xx`**: set DR of operator 2. +- **`59xx`**: set DR of operator 3. +- **`5Axx`**: set DR of operator 4. +- **`5Bxx`**: set D2R/SR of all operators. +- **`5Cxx`**: set D2R/SR of operator 1. +- **`5Dxx`**: set D2R/SR of operator 2. +- **`5Exx`**: set D2R/SR of operator 3. +- **`5Fxx`**: set D2R/SR of operator 4. diff --git a/doc/7-systems/zxbeep.md b/doc/7-systems/zxbeep.md index 6504ce98e..6381814a8 100644 --- a/doc/7-systems/zxbeep.md +++ b/doc/7-systems/zxbeep.md @@ -6,8 +6,8 @@ not really - very soon talented programmers found out ways to output much more t # effects -- `12xx`: set pulse width. -- `17xx`: trigger overlay drum. +- **`12xx`**: set pulse width. +- **`17xx`**: trigger overlay drum. - `xx` is the sample number. - overlay drums are 1-bit and always play at 55930Hz (NTSC) or 55420Hz (PAL). - the maximum length is 2048! diff --git a/doc/8-advanced/README.md b/doc/8-advanced/README.md index 3c001173c..b1772007a 100644 --- a/doc/8-advanced/README.md +++ b/doc/8-advanced/README.md @@ -1,3 +1,21 @@ # advanced -advanced Furnace features. +advanced Furnace features, as listed in the `Window` menu. + +- [mixer](mixer.md) +- [grooves](grooves.md) +- [channel manager](channels.md) +- [pattern manager](pat-manager.md) +- [chip manager](chip-manager.md) +- [compatibility flags](compat-flags.md) +- [song comments](comments.md) + +