Merge pull request #1566 from tildearrow/doc-general

Small documentation updates.

doc/1-intro/README.md

@@ -26,4 +26,6 @@ once familiar with the tracker, look to [9-guides](../9-guides/README.md) for us
 
 ## tutorial?
 
+[How to Learn Chiptune Trackers](https://www.youtube.com/watch?v=Q37XuOLz0jw): video tutorial created by Button Masher. covers the basic mechanics of chiptune tracking using Furnace for demonstration.
+
 [Furnace Tutorials](https://youtube.com/playlist?list=PLCELB6AsTZUnwv0PC5AAGHjvg47F44YQ1): video tutorials created by Spinning Square Waves. be noted that these may not apply to the current version.

doc/2-interface/asset-list.md

@@ -55,5 +55,12 @@ everything from the wavetables list applies here also, with the addition of one
 
 samples are saved as standard wave (.wav) files.
 
-- right-clicking the Save button brings up a menu with the following options:
-  - **save raw sample...**: saves the selected sample as raw data.
+right-clicking the Save button brings up a menu with the following options:
+- **save raw sample...**: saves the selected sample as raw data.
+
+right-clicking a sample in the list brings up a menu:
+- **make instrument**: creates a new instrument which is set to use the selected sample.
+- **duplicate**: makes a copy of the selected sample.
+- **replace...**: opens a file dialog to choose a replacement sample.
+- **save**: opens a file dialog to choose where to save the sample.
+- **delete**: removes the sample.

doc/2-interface/settings.md

@@ -47,6 +47,7 @@ settings are saved when clicking the **OK** or **Apply** buttons at the bottom o
 - **When creating new song**:
   - **Display system preset selector**
   - **Start with initial system**
+  - **Default author name**
 
 ### Start-up
 
@@ -92,7 +93,7 @@ settings are saved when clicking the **OK** or **Apply** buttons at the bottom o
   - setting this to a high value increases latency.
 - **Exclusive mode**: enables Exclusive Mode, which may offer latency improvements.
   - only available on WASAPI devices in the PortAudio backend!
-- **Low-latency mode (experimental!)**: reduces latency by running the engine faster than the tick rate. useful for live playback/jam mode.
+- **Low-latency mode**: reduces latency by running the engine faster than the tick rate. useful for live playback/jam mode.
   - only enable if your buffer size is small (10ms or less).
 - **Force mono audio**: use if you're unable to hear stereo audio (e.g. single speaker or hearing loss in one ear).
 - **want:** displays requested audio configuration.
@@ -104,6 +105,7 @@ settings are saved when clicking the **OK** or **Apply** buttons at the bottom o
 - **Software clipping**: clips output to nominal range (-1.0 to 1.0) before passing it to the audio device.
   - this avoids activating Windows' built-in limiter.
   - this option shall be enabled when using PortAudio backend with a DirectSound device.
+- **DC offset correction**: apply a filter to remove DC bias, where the output is overall above or below zero. default is on.
 
 ### Metronome
 
@@ -299,6 +301,9 @@ below all the binds, select a key from the dropdown list to add it. it will appe
   - applies when playback is stopped.
 - **Don't scroll when moving cursor**
 - **Move cursor with scroll wheel**
+  - **No**
+  - **Yes**
+  - **Inverted**
 
 ## Appearance
 

doc/4-instrument/README.md

@@ -96,24 +96,37 @@ every macro can be defined though one of three methods, selectable with the left
 - ![ADSR](macro-button-ADSR.png) **ADSR:** this is a traditional ADSR envelope, defined by the rate of increase and decrease of value over time.
 - ![LFO](macro-button-LFO.png) **LFO:** the Low Frequency Oscillator generates a repeating wave of values.
 
-some macros are "bitmap" style. they represent a number of "bits" that can be toggled individually, and the values listed represent the sum of which bits are turned on.
-
 ### sequence
 
 ![sequence macro editor](macro-seq.png)
 
+![clipped sequence macro editor](macro-seq-clip.png)
+
+![bitmask sequence macro editor](macro-seq-bitmask.png)
+
 the number between the macro type label and the macro type button is the macro length in steps. the `-` and `+` buttons change the length of the macro. start out by adding at least a few steps.
 
 the values of the macro can be drawn in the "bar graph" box.
+- arpeggio and pitch macros may have values above or below the visible area; small chevrons will be shown until they are scrolled into view.
+- bitmask-style macros show labels for each of their bits, and these are edited as toggles.
 
-just beneath the box is a shorter bar that controls looping.
+arpeggio macros have a short bar for setting whether to interpret the values as being "relative" or "fixed".
+- by default, values are offsets **relative** to the note.
+- if clicked on, a value becomes **fixed** and will be played at its corresponding note without regard to the note entered into the pattern.
+  - values are counted from `C-0`. for example, a fixed value of 48 produces a `C-4` note.
+  - fixed values are especially useful for noise instruments with preset periods.
+
+below this is a short bar that controls macro loop and release.
 - click to set the start point of a loop; the end point is the last value or release point. it appears as half-height bars. right-click to remove the loop.
 - shift-click to set the release point. when played, the macro will hold here until the note is released. it appears as a full-height bar. right-click to remove the release point.
 
 finally, the sequence of values can be directly edited in the text box at the bottom.
 - the loop start is entered as a `|`.
 - the release point is entered as a `/`.
-- in arpeggio macros, a value starting with a `@` is an absolute note (instead of a relative shift). no matter the note entered in the pattern, `@` values will be played at that exact note. this is especially useful for noise instruments with preset periods.
+- in arpeggio macros, a value starting with a `@` is a fixed value as described above.
+- in bitmask-style macros, the values are added up in binary and converted to decimal. see [the hexadecimal guide](../1-intro/hex.md) for more info.
+
+
 
 ### ADSR
 

doc/6-sample/README.md

@@ -159,3 +159,14 @@ in there, you can modify certain data pertaining to your sample, such as the:
 - **Create instrument from sample**: creates a new instrument with its sample set to the current sample.
 - **Zoom**: shows and sets sample view zoom level.
 - **Zoom mode**: switches between "Auto" (entire sample fits in window) and "100%" (each horizontal pixel represents one sample point).
+
+in the sample viewer:
+- left-click and drag to select a region of the sample.
+- right-click to display a menu:
+  - **cut**: puts the selection in the sample clipboard and deletes it from the sample.
+  - **copy**: copies the selection into the sample clipboard.
+  - **paste**: inserts the sample clipboard at the start of the selection.
+  - **paste (replace)**: replaces the selection with the sample clipboard.
+  - **paste (mix)**: mixes the sample clipboard into the existing sample, beginning at the start of the selection.
+  - **set loop to selection**: changes loop region to match selection.
+  - **create wavetable from selection**: copies the selection into a new wavetable entry.

doc/8-advanced/chip-manager.md

@@ -8,7 +8,7 @@ the **chip manager** window does exactly what it says.
 
 to move a chip around, click and drag the ![crossed-arrows](chip-manager-move.png) button to its left.
 
-to replace a chip with a different one, click the ![down-angle](chip-manager-change.png) and select the replacement.
+to replace a chip with a different one, click the **Change** button and select the replacement.
 
 to remove a chip entirely, click the ![X](chip-manager-remove.png) button.