Skip to content

Commit 4358656

Browse files
committed
Update effects list
- Move S5B effect list to main effect list page - Add VRC7 effects - Add Oxx and Nxy
1 parent 48fbfa0 commit 4358656

File tree

2 files changed

+74
-53
lines changed

2 files changed

+74
-53
lines changed

hlp/effect_list.htm

Lines changed: 71 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@
3131
<li><a href="#Harmonic">Kxx - Frequency multiplier</a></li>
3232
<li><a href="#DelayedRelease">Lxx - Delayed note release</a></li>
3333
<li><a href="#DelayedVolume">Mxy - Delayed note volume</a></li>
34+
<li><a href="#TargetVolumeSlide">Nxy - Target volume slide</a></li>
35+
<li><a href="#Groove">Oxx - Groove index</a></li>
3436
<li><a href="#FinePitch">Pxx - Fine pitch</a></li>
3537
<li><a href="#NoteSlideUp">Qxy - Note slide up</a></li>
3638
<li><a href="#NoteSlideDown">Rxy - Note slide down</a></li>
@@ -47,6 +49,12 @@
4749
<li><a href="#DpcmDelta">Zxx - Delta counter</a></li>
4850
</ul>
4951

52+
<p class="boldText">VRC7 effects</p>
53+
<ul class="text">
54+
<li><a href="#VRC7Port">Hxx - Custom patch byte port</a></li>
55+
<li><a href="#VRC7Write">Ixx - Custom patch byte write</a></li>
56+
</ul>
57+
5058
<p class="boldText">FDS modulation effects</p>
5159
<ul class="text">
5260
<li><a href="#ModulationDepth">Hxx - Modulation depth</a></li>
@@ -77,6 +85,15 @@
7785
<li><a href="#WaveRamPositionRestore">Z7F - Wave RAM position restore</a></li>
7886
</ul>
7987

88+
<p class="boldText">S5B effects</p>
89+
<ul class="text">
90+
<li><a href="#S5BEnvelopeType">H0y - Envelope type</a></li>
91+
<li><a href="#S5BEnvelopePitch">Hxy - Envelope automatic pitch</a></li>
92+
<li><a href="#S5BEnvelopePitchHi">Ixx - Envelope manual pitch, high</a></li>
93+
<li><a href="#S5BEnvelopePitchLo">Jxx - Envelope manual pitch, low</a></li>
94+
<li><a href="#S5BNoisePitch">Wxx - Noise pitch</a></li>
95+
</ul>
96+
8097
<hr />
8198

8299
<p class="heading">General effects</p>
@@ -175,6 +192,14 @@
175192
<p class="text">Sets the channel volume to <b>y</b> after <b>x</b> number of ticks.</p>
176193
<br />
177194

195+
<a name="TargetVolumeSlide" class="boldText">Nxy - Target volume slide</a><br />
196+
<p class="text">Slides the channel volume to <b>y</b> at a speed of <b>x</b>, similar to <a href="#VolumeSlide">Axy</a>.</p>
197+
<br />
198+
199+
<a name="Groove" class="boldText">Oxx - Groove index</a><br />
200+
<p class="text">If groove mode is enabled, sets the groove to index <b>xx</b> of the groove list.</p>
201+
<br />
202+
178203
<a name="FinePitch" class="boldText">Pxx - Fine pitch</a><br />
179204
<p class="text">Sets the fine pitch in <b>xx</b> pitch units.<br />
180205
The default value is <b>80</b>.<br />
@@ -198,15 +223,19 @@
198223
<br />
199224

200225
<a name="Timbre" class="boldText">Vxx - Timbre control</a><br />
201-
<p class="text">This effect controls the duty period of the pulse channels and noise mode of the noise channel.
202-
On N163 it can be used to select the wave index.<br />
226+
<p class="text">This effect controls the duty period of the pulse channels and noise mode of the noise channel.<br />
227+
On N163, it can be used to select the wave index.<br />
228+
On VRC7, it can be used to select the patch index.<br />
229+
On S5B, it can be used to select the channel mode bitmask.<br />
203230
Valid values are:
204231
</p>
205232
<ul class="text">
206233
<li>2A03/MMC5 pulse channels: <b>00 - 03</b></li>
207-
<li>Noise channel: <b>00 - 01</b></li>
234+
<li>2A03 Noise channel: <b>00 - 01</b></li>
208235
<li>VRC6 pulse channels: <b>00 - 07</b></li>
236+
<li>VRC7 channels: <b>00 - 0F</b></li>
209237
<li>N163 channels: <b>00 - 3F</b></li>
238+
<li>S5B channels: <b>00 - 07</b></li>
210239
</ul>
211240
<br />
212241

@@ -235,6 +264,19 @@
235264

236265
<hr />
237266

267+
<p class="heading">VRC7 effects</p>
268+
269+
<a name="VRC7Port" class="boldText">Hxx - Custom patch byte port</a><br />
270+
<p class="text">Select port address <b>xx</b> of custom patch to be written. To be used with <b>Ixx</b>.<br />
271+
Valid range: <b>00 - 07</b>.</p>
272+
<br />
273+
274+
<a name="VRC7Write" class="boldText">Ixx - Custom patch byte write</a><br />
275+
<p class="text">Byte <b>xx</b> to be written at the address port specified. To be used with <b>Hxx</b>.<br />
276+
<br />
277+
278+
<hr />
279+
238280
<p class="heading">FDS modulation effects</p>
239281

240282
<a name="ModulationDepth" class="boldText">Hxx - Modulation depth</a><br />
@@ -390,6 +432,32 @@
390432
<p class="text">Restores the wave RAM position control to all the instruments in a given N163 channel.<br /></p>
391433
<br />
392434

435+
<hr />
436+
437+
<p class="heading">S5B effects</p>
438+
439+
<a name="S5BEnvelopeType" class="boldText">H0y - Envelope type</a><br />
440+
<p class="text">Sets <a href="sunsoft.htm#5BEnvelopes">envelope type</a> <b>y</b>.<br /></p>
441+
<br />
442+
443+
<a name="S5BEnvelopePitch" class="boldText">Hxy - Envelope automatic pitch</a><br />
444+
<p class="text">Sets envelope period to the note period shifted by <b>x</b> and <a href="sunsoft.htm#5BEnvelopes">envelope type</a> <b>y</b>.<br />
445+
Approximate envelope frequency is note frequency * (2^|<b>x</b> - 8|) / 32.</p>
446+
<br />
447+
448+
<a name="S5BEnvelopePitchHi" class="boldText">Ixx - Envelope manual pitch, high</a><br />
449+
<p class="text">Sets the highest 8 bits of the 16-bit envelope period.</p>
450+
<br />
451+
452+
<a name="S5BEnvelopePitchLo" class="boldText">jxx - Envelope manual pitch, low</a><br />
453+
<p class="text">Sets the lowest 8 bits of the 16-bit envelope period.</p>
454+
<br />
455+
456+
<a name="S5BNoisePitch" class="boldText">Wxx - Noise pitch</a><br />
457+
<p class="text">Sets the noise pitch.<br />
458+
Valid range: <b>00 - 1F</b>.</p>
459+
<br />
460+
393461
<hr />
394462
<span class="footer">Back to <a href="interface.htm">interface</a> &middot; <a href="main_index.htm">main index</a></span>
395463

hlp/sunsoft.htm

Lines changed: 3 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,12 @@
5050
Noise, and the Yellow bar is for Envelope.
5151
</p>
5252
<hr>
53-
<p class="heading">5B Envelopes</p>
53+
<a name="5BEnvelopes"><p class="heading">5B Envelopes</p></a>
5454
<p class="text">The Sunsoft 5B has a configurable envelope generator, able to
5555
play back 16 preset envelope sets. The table below shows each envelope and
5656
its functions.
5757
</p>
58-
<p class="footer"><i>Note: These are intended to be used with the Hxy command.</i></p>
58+
<p class="footer"><i>Note: These are intended to be used with the H0y/Hxy command.</i></p>
5959
<table border="1" size=50% class="text">
6060
<thead>
6161
<tr>
@@ -117,54 +117,7 @@
117117
</tr>
118118
</tbody>
119119
</table>
120-
<hr>
121-
<p class="heading">Effects</p>
122-
<p class="text">
123-
The Sunsoft 5B comes with it's own unique set of effects for the features
124-
it has. The table describes all the effects and their syntax, as well as
125-
what they do.
126-
</p>
127-
<table border="1" style="table-layout: fixed; width: 448px" class="text">
128-
<colgroup>
129-
<col style="width: 101px">
130-
<col style="width: 171px">
131-
<col style="width: 176px">
132-
</colgroup>
133-
<thead>
134-
<tr>
135-
<th>Effect Name</th>
136-
<th>Effect Syntax</th>
137-
<th>Effect Description</th>
138-
</tr>
139-
</thead>
140-
<tbody>
141-
<tr>
142-
<td>Envelope</td>
143-
<td>H0y<br><br>Y = Envelope Shape</td>
144-
<td>Defines an envelope type to use. Set pitch with Ixx and Jxx.</td>
145-
</tr>
146-
<tr>
147-
<td>Auto Envelope</td>
148-
<td>Hxy<br>X = Pitch Shift<br>Y = Envelope Shape</td>
149-
<td>Define an envelope type to use, and tie it to the note placed down in the pattern.</td>
150-
</tr>
151-
<tr>
152-
<td>Envelope Pitch</td>
153-
<td>Ixx, Jxx</td>
154-
<td>These two effects control the 5B's pitch and </td>
155-
</tr>
156-
<tr>
157-
<td>Noise Pitch</td>
158-
<td>Wxx</td>
159-
<td>Manually control the pitch at which the 5B's Noise Generator is playing.</td>
160-
</tr>
161-
<tr>
162-
<td>Noise/Mode Toggle</td>
163-
<td>Vxx</td>
164-
<td>Manually Toggle Tone/Noise/Envelope, <br>overriding the instrument's macro if it has ended.</td>
165-
</tr>
166-
</tbody>
167-
</table>
120+
168121
<hr>
169122
<span class="footer">
170123
Back to <a href="sound_overview.htm">sound hardware</a> &middot;

0 commit comments

Comments
 (0)