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

update documentation

Browse source
This commit is contained in:
tildearrow 2022-01-16 01:10:43 -05:00
parent c09ce1892b
commit ed5279f96c
25 changed files with 541 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

15
papers/doc/3-pattern/README.md Normal file
View file

@ -0,0 +1,15 @@
# patterns
a pattern consists of columns ("channels") and rows.
each column has several subcolumns in this order:
1. note
2. instrument
3. volume
4. effect and effect value (several)
clicking on the top left corner of the pattern view allows you to increase or decrease the number of effect columns a channel has (max 4 per channel).
all columns are represented in hexadecimal, except for the note column.
for a list of effects [click here](effects.md).

50
papers/doc/3-pattern/effects.md Normal file
View file

@ -0,0 +1,50 @@
# effect list
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.
- a note must be present for this effect to work.
- `04xy`: vibrato. `x` is the speed, while `y` is the depth.
- maximum vibrato depth is ±1 semitone.
- `08xy`: set panning. `x` is the left channel and `y` is the right one.
- not all platforms support this effect.
- `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.
- this effect is not continuous.
- `0Dxx`: jump to next pattern.
- `0Fxx`: set speed 2.
- `Cxxx`: change song Hz.
- `xxx` may be from `000` to `3ff`.
- `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:
- `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.
- range is ±1 semitone.
- `EAxx`: toggle legato.
- `EBxx`: set sample bank.
- does not apply on Amiga platform.
- `ECxx`: note off after `xx` ticks.
- `EDxx`: delay note by `xx` ticks.
- `EExx`: send external command.
- currently not used, but this eventually will allow you to do special things after I add VGM export.
- `EFxx`: add or subtract global pitch.
- this effect is rather weird. use with caution.
- `80` is center.
additionally each system/platform has its own effects. more details in another section of the manual.