Scream Tracker 3 Module - Revision history

RepellantMold: Add in instrument format, and how SAx works

2025-06-20T14:34:38Z

Add in instrument format, and how SAx works

@@ Line 14: / Line 14: @@
 *28 bytes: module name, NUL-terminated, NUL-padded.
 *Byte: 0x1A.
-*Byte: 16 (0x10) to indicate this is a Scream Tracker 3 module.
+*Byte: 16 (0x10) to indicate this is a Scream Tracker 3 module, 17 is (supposedly) song but it gives "ST3S not yet supported".
 *2 reserved bytes, should be set to 0x00.
 *6 words, denoting the following:
@@ Line 66: / Line 66: @@
 **Bits 0-3: Specified panning value if default not used.
-''TODO: ST3.21's TECH.DOC should cover instruments.''
+===Instrument format===
 ==Playback Notes==
@@ Line 261: / Line 298: @@
 ====SAx====
-Old stereo control. This appears in PANIC.S3M, but may have been removed since Scream Tracker 3.01 BETA. libmodplug, and in turn SchismTracker, convert these to S8x effects.
+Old stereo control. This appears in PANIC.S3M, but may have been removed since Scream Tracker 3.01 BETA. libmodplug, Schism Tracker, and OpenMPT, convert these to S8x effects.
-''TODO: work out how SAx converts to S8x effects.''
+*This effect only works on Sound Blaster.
 ====SBx====

RepellantMold: Fix some inconsistencies with how song flags were laid out

2025-01-18T19:12:01Z

Fix some inconsistencies with how song flags were laid out

Malvineous: /* File Format */ Mention how wide parapointers are

2013-03-03T02:13:53Z

File Format: Mention how wide parapointers are

← Older revision		Revision as of 19:13, 2 March 2013
Line 8:		Line 8:
	==File Format==		==File Format==

	The format is little-endian (least significant byte first). A "byte" is 8 bits, a "word" is 16 bits, and a "dword" (double word) is 32 bits. Hex values will be denoted with "0x". A parapointer points to pp*16 in the file due to the DOS nature of the format.		The format is little-endian (least significant byte first). A "byte" is 8 bits, a "word" is 16 bits, and a "dword" (double word) is 32 bits. Hex values will be denoted with "0x". A parapointer is 16 bits wide, and points to pp*16 in the file due to the DOS nature of the format.

	Note that if some parts of the format are inconsistent, it's usually best to let it slip, as ST3 itself will allegedly for instance load instruments which don't have the "SCRS" / "SCRI" mark.		Note that if some parts of the format are inconsistent, it's usually best to let it slip, as ST3 itself will allegedly for instance load instruments which don't have the "SCRS" / "SCRI" mark.

Nickysn: /* Ixy (%) */ documented tremor

2012-03-26T14:23:51Z

Ixy (%): documented tremor

← Older revision		Revision as of 07:23, 26 March 2012
Line 152:		Line 152:

	===Ixy (%)===		===Ixy (%)===
	Tremor. ~~''TODO: this effect is weird.''~~		Tremor.

	(~~Looking through what's released~~ of the ~~ST3 playback source code~~, ~~tremor~~ is ~~not retriggered~~ if there~~'s a Dxy~~ effect, or ~~something like that, but~~ this ~~needs to be clarified~~.)		* "On" time is '''x + 1''' ticks, "off" time is '''y + 1''' ticks
			* This effect is updated on '''every tick'''.
			* Implemented with two decrementing counters per channel - the "on" counter and the "off" counter.
			* On each tick, if the "on" counter is greater than zero, it is decremented and if it reaches zero, the current volume is set to 0 and the "off" counter is set to the "off" time (y + 1). If the "on" counter was zero in the beginning of the update procedure, then the "off" counter is decremented and if it reached zero (or became less than zero), '''the current volume is set to the stored volume''' and the "on" counter is set to the "on" time (x + 1).
			* '''The "on" and "off" counters are never reset''', except in the tremor update procedure described above. Scream Tracker doesn't even reset them on playback start. Only on tracker startup are they reset.
			* If the current volume was 0 at the end of the effect and there is no tremor effect on the next row, '''the current volume stays 0'''. It isn't reset back to the stored volume or its previous value from before the tremor effect.
			* '''The stored volume isn't modified by this effect.'''

	===Jxy (%)===		===Jxy (%)===

Nickysn: /* Qxy (%) */

2012-01-01T23:29:38Z

Qxy (%)

← Older revision		Revision as of 16:29, 1 January 2012
Line 175:		Line 175:

	===Qxy (%)===		===Qxy (%)===
	Retrigger note every y ticks with volume modifier x.		Retrigger note every y ticks with volume modifier x. '''If the retrig value 'y' is 0, the effect is ignored.'''

	This effect uses a counter, that is increased on each tick. When the counter reaches the retrig value 'y' (or becomes greater, which could happen if the retrig value is decreased), the sample is retriggered, the note volume is modified according to the volume modifier 'x' and the counter is reset back to 0. The counter is reset ('''without retriggering the sample''') also in the following cases:		This effect uses a counter, that is increased on each tick. When the counter reaches the retrig value 'y' (or becomes greater, which could happen if the retrig value is decreased), the sample is retriggered, the note volume is modified according to the volume modifier 'x' and the counter is reset back to 0. The counter is reset ('''without retriggering the sample''') also in the following cases:

Nickysn: /* Qxy (%) */

2012-01-01T23:26:50Z

Qxy (%)

← Older revision		Revision as of 16:26, 1 January 2012
Line 191:		Line 191:
	6: 2/3		6: 2/3
	7: 1/2		7: 1/2
	*8: ?		*8: 0 (documentation says "?")
	*9: 1		*9: 1
	*A: 2		*A: 2

Nickysn: /* Qxy (%) */

2011-12-28T22:11:45Z

Qxy (%)

← Older revision		Revision as of 15:11, 28 December 2011
Line 176:		Line 176:
	===Qxy (%)===		===Qxy (%)===
	Retrigger note every y ticks with volume modifier x.		Retrigger note every y ticks with volume modifier x.

			This effect uses a counter, that is increased on each tick. When the counter reaches the retrig value 'y' (or becomes greater, which could happen if the retrig value is decreased), the sample is retriggered, the note volume is modified according to the volume modifier 'x' and the counter is reset back to 0. The counter is reset ('''without retriggering the sample''') also in the following cases:
			* before the start of playing the song
			* when a row without the Qxx effect is encountered in the channel
			However, the counter is '''not reset in any other cases''', for example '''playing a new note with the Qxy effect does not reset the counter'''. Also, this effect '''is processed on every tick, including tick 0 and is entirely independent of the song speed.''' A retrig of the sample '''can also happen on tick 0, even when playing a new note''' in which case the note volume modification occurs '''immediately after the new note is played'''.

	Values for x:		Values for x:

Nickysn: /* S0x */ - documented a ST3.21 S00 note delay quirk/bug

2011-12-13T14:11:21Z

S0x: - documented a ST3.21 S00 note delay quirk/bug

← Older revision		Revision as of 07:11, 13 December 2011
Line 220:		Line 220:

	* '''S00''' performs an Sxy effect with '''the latest nonzero effect parameter to show up''' (note the '%').		* '''S00''' performs an Sxy effect with '''the latest nonzero effect parameter to show up''' (note the '%').
			* '''When S00 is repeating a note delay (SDx), the note is triggered twice: once on tick 0 (as if there's no note delay) and again on tick x (as with a normal note delay)'''

	====S1x====		====S1x====

Nickysn: /* S0x */

2011-12-13T14:07:38Z

S0x

← Older revision		Revision as of 07:07, 13 December 2011
Line 219:		Line 219:
	Set filter. Not implemented in Scream Tracker 3.		Set filter. Not implemented in Scream Tracker 3.

	* S00 performs an Sxy effect with '''the latest nonzero effect parameter to show up''' (note the '%').		* '''S00''' performs an Sxy effect with '''the latest nonzero effect parameter to show up''' (note the '%').

	====S1x====		====S1x====

Nickysn: /* Sxy (%) */ S00 uses the latest nonzero effect parameter to show up

2011-12-12T00:24:25Z

Sxy (%): S00 uses the latest nonzero effect parameter to show up

← Older revision		Revision as of 17:24, 11 December 2011
Line 215:		Line 215:
	===Sxy (%)===		===Sxy (%)===
	Miscellaneous effects.		Miscellaneous effects.

	~~''TODO: check what value xy is taken for Sxy''~~

	====S0x====		====S0x====
	Set filter. Not implemented in Scream Tracker 3.		Set filter. Not implemented in Scream Tracker 3.

			* S00 performs an Sxy effect with '''the latest nonzero effect parameter to show up''' (note the '%').

	====S1x====		====S1x====

← Older revision		Revision as of 12:12, 18 January 2025
Line 21:		Line 21:
	**Pattern count		**Pattern count
	**Flags		**Flags
	***Bit 0 (pre-3.01 ONLY): ST2 vibrato ''(effect unknown)''.		***Bit 0: (pre-3.01 ONLY): ST2 vibrato ''(effect unknown)''.
	***Bit 1 (pre-3.01 ONLY): ST2 tempo ''(effect unknown)''.		***Bit 1: (pre-3.01 ONLY): ST2 tempo ''(effect unknown)''.
	***Bit 3 (pre-3.01 ONLY): Amiga slides ''(effect unknown)''.		***Bit 2: (pre-3.01 ONLY): Amiga slides ''(effect unknown)''.
	***Bit 4: 0-vol optimisations - turn off looping notes which have a zero volume for more than(?) 2 rows.		***Bit 3: 0-vol optimisations - turn off looping notes which have a zero volume for more than(?) 2 rows.
	***Bit 5: Amiga limits (limit periods to confine to 113 <= x <= 856).		***Bit 4: Amiga limits (limit periods to confine to 113 <= x <= 856).
	***Bit 6 (pre-3.01 ONLY): Enable filter / sfx with SB ''(effect unknown)''.		***Bit 5: (pre-3.01 ONLY): Enable filter / sfx with SB ''(effect unknown)''.
	***Bit 7: ST3.00 volume slides ('''automatically enabled if tracker version is <= 0x1300''') - if enabled, ''all'' volume slides occur ''every'' tick.		***Bit 6: ST3.00 volume slides ('''automatically enabled if tracker version is == 0x1300''') - if enabled, ''all'' volume slides occur ''every'' tick.
	***Bit 8: Special custom data in file (uses "Special" field)		***Bit 7: Special custom data in file (uses "Special" field)
	**Tracker version		**Tracker version
	***0x1xyy == Scream Tracker x.yy		***0x1xyy == Scream Tracker x.yy
Line 89:		Line 89:
	'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.		'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.

	However, on '''~~adlib~~ channels''', if the default volume is 64, it will use 64. Any further operations on the volume will clip it to within the 0-63 range.		However, on '''Adlib channels''', if the default volume is 64, it will use 64. Any further operations on the volume will clip it to within the 0-63 range.

	Many effects use the '''latest nonzero effect parameter encountered''', as noted a bit further below.		Many effects use the '''latest nonzero effect parameter encountered''', as noted a bit further below.
Line 222:		Line 222:
	'''On tick 1''' (the '''second''' tick of the row) set the active volume to '''the stored volume plus''' (depth value) / (max_amplitude * 2) (Rxy peaks at 32 in each direction), and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''		'''On tick 1''' (the '''second''' tick of the row) set the active volume to '''the stored volume plus''' (depth value) / (max_amplitude * 2) (Rxy peaks at 32 in each direction), and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''
	*'''If the song speed (not tremolo speed, but song speed - ticks per row) is 1, the active volume is also untouched. It is not set to the stored volume!'''		*'''If the song speed (not tremolo speed, but song speed - ticks per row) is 1, the active volume is also untouched. It is not set to the stored volume!'''
	*'''Tremolo will not work if the stored volume is 0 (or 64 - ~~adlib~~ only).'''		*'''Tremolo will not work if the stored volume is 0 (or 64 - Adlib only).'''

	===Sxy (%)===		===Sxy (%)===