Document new effects

This commit is contained in:
Natt Akuma 2022-03-15 03:59:52 +07:00
parent 54da047b5a
commit 7308114475

View file

@ -10,6 +10,8 @@ however, effects are continuous, which means you only need to type it once and t
- a note must be present for this effect to work. - 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. - maximum vibrato depth is ±1 semitone.
- `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 systems support this effect. - not all systems support this effect.
- `09xx`: set speed 1. - `09xx`: set speed 1.
@ -22,6 +24,9 @@ however, effects are continuous, which means you only need to type it once and t
- `0Dxx`: jump to next pattern. - `0Dxx`: jump to next pattern.
- `0Fxx`: set speed 2. - `0Fxx`: set speed 2.
- `9xxx`: set sample position to `xxx`\*0x100.
- not all systems support this effect.
- `Cxxx`: change song Hz. - `Cxxx`: change song Hz.
- `xxx` may be from `000` to `3ff`. - `xxx` may be from `000` to `3ff`.
@ -46,6 +51,14 @@ however, effects are continuous, which means you only need to type it once and t
- `EFxx`: add or subtract global pitch. - `EFxx`: add or subtract global pitch.
- this effect is rather weird. use with caution. - this effect is rather weird. use with caution.
- `80` is center. - `80` is center.
- `F0xx`: change song Hz by BPM value.
- `F1xx`: single tick slide up.
- `F2xx`: single tick slide down.
- `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 system has its own effects. [click here for more details](../7-systems/README.md). additionally each system has its own effects. [click here for more details](../7-systems/README.md).