Skip to content

Commit 2239616

Browse files
committed
Minor corrections to docs.
And a more accurate description for tick rate.
1 parent 232fc95 commit 2239616

4 files changed

Lines changed: 10 additions & 11 deletions

File tree

doc/2-interface/speed.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
## speed
22

33
there are multiple ways to set the tempo of a song.
4-
the effective BPM is displayed as well, taking all settings into account.
54

65
**Base Tempo**: tempo in beats per minute (BPM). this is affected by the Highlight settings below.
76
- clicking the Base Tempo button switches to the more technical Tick Rate.
87

9-
**Tick Rate**: the frequency of ticks per second, thus the rate at which notes and effects are processed.
10-
- 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).
8+
**Tick Rate**: the frequency of ticks per second, thus the rate at which notes and effects are processed. range is from 1 to 999.
9+
- all values are allowed for all chips. the default value is determined by the video frame rate of the system selected when the song was created, as this is usually the tick rate of a typical sound driver running on that system. this is almost always either 60 (approximately NTSC) or 50 (exactly PAL).
1110
- clicking the Tick Rate button switches to the more traditional Base Tempo BPM setting.
1211

1312
**Speed**: the number of ticks per row.
@@ -30,6 +29,6 @@ the effective BPM is displayed as well, taking all settings into account.
3029
- these don't have to line up with the track's actual beats and measures. set them as preferred for tracking.
3130
- these values are used for the metronome and calculating BPM.
3231

33-
**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.)
32+
**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` effects.
3433

3534
**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.

doc/4-instrument/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ the release mode parameter determines how macro release (`===` or `REL` in the p
183183

184184
note: ADSR envelopes operate differently in versions 0.6.8.3 and prior.
185185

186-
- **Bottom** and **Top** determine the macro's output range Bottom can be larger than Top to invert the envelope. all outputs will be between these two values.
186+
- **Bottom** and **Top** determine the macro's output range. Bottom can be larger than Top to invert the envelope. all outputs will be between these two values, inclusive.
187187
- the Attack, Decay, SusDecay, and Release portions of the envelope change value by the specified amount before each tick, including the first.
188188
- 0 equals no change; the value stays at Bottom.
189189
- 1 equals 1/256 of a step per tick, the slowest possible change.
@@ -208,13 +208,13 @@ note: ADSR envelopes operate differently in versions 0.6.8.3 and prior.
208208
note: LFO envelopes operate differently in versions 0.6.8.3 and prior.
209209

210210
- **Bottom** and **Top** determine the macro's output range. Bottom can be larger than Top to invert the waveform. all outputs will be between these two values.
211-
- **Speed** determines the LFO frequency, and depends on the LFO shape set further below.
211+
- **Speed** determines the LFO frequency, and depends on the LFO Shape set further below.
212212
- for triangle and saw, this is how much the output value changes per tick measured in 1/128 of a step.
213213
- 0 equals no change; the value stays frozen at its initial state determined by Phase.
214214
- 1 equals 1/128 of a step per tick, the slowest possible change.
215215
- the maximum value is the number of steps between Bottom and Top multiplied by 128 and minus 1.
216216
- this happens before the first tick plays; an Attack of 128 will start the note at one step from Bottom toward Top.
217-
- for Square, this is how much of a single cycle passes per tick, measured in 1/65536 of a cycle.
217+
- for square, this is how much of a single cycle passes per tick, measured in 1/65536 of a cycle.
218218
- 0 equals no change.
219219
- 1 equals 1/65535 of a cycle per tick, the slowest possible.
220220
- the maximum value is 32768 which makes output alternate between Bottom and Top in a two-tick cycle, the fastest possible.

doc/4-instrument/ay8910.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ note that using samples on AY is CPU expensive!
3838
- 0: off.
3939
- 1: **PWM**: amplitude modulation of the tone.
4040
- 2: **SyncBuzzer**: hard-sync of the envelope (resetting its position to start).
41-
- **TFX Offset**: difference between timer frequency and note pitch. notably affects the rate of PWM.
41+
- **TFX Offset**: difference between timer frequency and note pitch. affects the rate of PWM.
4242
- **Timer Num** and **Timer Den**: sets the timer frequency to automatically match note pitch multiplied by Num and divided by Den.
4343
- if either value is 0, this automatic matching is disabled.
44-
- **PWM Boundary**: sets the amount of modulation when in PWM mode.
44+
- **PWM Boundary**: sets the amount of amplitude modulation when in PWM mode.
4545

4646
_warning:_ timer effects require direct stream mode to be enabled during VGM export. note that timer effects might not be supported by VGM players, and are rather CPU expensive!

doc/7-systems/ay8910.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ this chip was used in many home computers (ZX Spectrum, MSX, Amstrad CPC, Atari
44

55
it is a 3-channel sound generator for which each channel can play a square wave, noise, or a combination of the two. the chip's powerful sound comes from a single hardware volume envelope which each channel can use, and can be set to loop at high speed for tonal effects.
66

7-
Furnace is capable of doing software sample playback on AY-3-8910, where all 3 channels can play 4-bit PCM samples (at the cost of a very high CPU usage) and utilize CPU timer effects, providing all kinds of modulation (PWM and envelope distortion) effects, again at the cost of a higher CPU usage. Songs utilizing timer effects may not sound as intended after VGM export.
7+
Furnace is capable of doing software sample playback on AY-3-8910, where all 3 channels can play 4-bit PCM samples (at the cost of a very high CPU usage) and use CPU timer effects, providing all kinds of modulation (PWM and envelope distortion) effects, again at the cost of a higher CPU usage. songs using timer effects may not sound as intended after VGM export.
88

99
## effects
1010

@@ -17,7 +17,7 @@ Furnace is capable of doing software sample playback on AY-3-8910, where all 3 c
1717
- `5`: envelope and noise
1818
- `6`: envelope and square and noise
1919
- `7`: nothing
20-
- `21xx`: **set noise frequency.** range is `0` to `1F`. `1E` and `1F` are the same volume.
20+
- `21xx`: **set noise frequency.** range is `0` to `1F`. `1E` and `1F` are the same.
2121
- `22xy`: **set envelope mode.**
2222
- `x` sets the envelope shape:
2323
- `0`: `\___` decay

0 commit comments

Comments
 (0)