Skip to content

Commit

Permalink
Update effects list
Browse files Browse the repository at this point in the history 
- Move S5B effect list to main effect list page
- Add VRC7 effects
- Add Oxx and Nxy
  • Loading branch information
@Gumball2415
Gumball2415 committed May 10, 2023
1 parent 48fbfa0 commit 4358656
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 53 deletions.
74 changes: 71 additions & 3 deletions hlp/effect_list.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
<li><a href="#Harmonic">Kxx - Frequency multiplier</a></li>
<li><a href="#DelayedRelease">Lxx - Delayed note release</a></li>
<li><a href="#DelayedVolume">Mxy - Delayed note volume</a></li>
<li><a href="#TargetVolumeSlide">Nxy - Target volume slide</a></li>
<li><a href="#Groove">Oxx - Groove index</a></li>
<li><a href="#FinePitch">Pxx - Fine pitch</a></li>
<li><a href="#NoteSlideUp">Qxy - Note slide up</a></li>
<li><a href="#NoteSlideDown">Rxy - Note slide down</a></li>
Expand All @@ -47,6 +49,12 @@
<li><a href="#DpcmDelta">Zxx - Delta counter</a></li>
</ul>

<p class="boldText">VRC7 effects</p>
<ul class="text">
<li><a href="#VRC7Port">Hxx - Custom patch byte port</a></li>
<li><a href="#VRC7Write">Ixx - Custom patch byte write</a></li>
</ul>

<p class="boldText">FDS modulation effects</p>
<ul class="text">
<li><a href="#ModulationDepth">Hxx - Modulation depth</a></li>
Expand Down Expand Up @@ -77,6 +85,15 @@
<li><a href="#WaveRamPositionRestore">Z7F - Wave RAM position restore</a></li>
</ul>

<p class="boldText">S5B effects</p>
<ul class="text">
<li><a href="#S5BEnvelopeType">H0y - Envelope type</a></li>
<li><a href="#S5BEnvelopePitch">Hxy - Envelope automatic pitch</a></li>
<li><a href="#S5BEnvelopePitchHi">Ixx - Envelope manual pitch, high</a></li>
<li><a href="#S5BEnvelopePitchLo">Jxx - Envelope manual pitch, low</a></li>
<li><a href="#S5BNoisePitch">Wxx - Noise pitch</a></li>
</ul>

<hr />

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

<a name="TargetVolumeSlide" class="boldText">Nxy - Target volume slide</a><br />
<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>
<br />

<a name="Groove" class="boldText">Oxx - Groove index</a><br />
<p class="text">If groove mode is enabled, sets the groove to index <b>xx</b> of the groove list.</p>
<br />

<a name="FinePitch" class="boldText">Pxx - Fine pitch</a><br />
<p class="text">Sets the fine pitch in <b>xx</b> pitch units.<br />
The default value is <b>80</b>.<br />
Expand All @@ -198,15 +223,19 @@
<br />

<a name="Timbre" class="boldText">Vxx - Timbre control</a><br />
<p class="text">This effect controls the duty period of the pulse channels and noise mode of the noise channel.
On N163 it can be used to select the wave index.<br />
<p class="text">This effect controls the duty period of the pulse channels and noise mode of the noise channel.<br />
On N163, it can be used to select the wave index.<br />
On VRC7, it can be used to select the patch index.<br />
On S5B, it can be used to select the channel mode bitmask.<br />
Valid values are:
</p>
<ul class="text">
<li>2A03/MMC5 pulse channels: <b>00 - 03</b></li>
<li>Noise channel: <b>00 - 01</b></li>
<li>2A03 Noise channel: <b>00 - 01</b></li>
<li>VRC6 pulse channels: <b>00 - 07</b></li>
<li>VRC7 channels: <b>00 - 0F</b></li>
<li>N163 channels: <b>00 - 3F</b></li>
<li>S5B channels: <b>00 - 07</b></li>
</ul>
<br />

Expand Down Expand Up @@ -235,6 +264,19 @@

<hr />

<p class="heading">VRC7 effects</p>

<a name="VRC7Port" class="boldText">Hxx - Custom patch byte port</a><br />
<p class="text">Select port address <b>xx</b> of custom patch to be written. To be used with <b>Ixx</b>.<br />
Valid range: <b>00 - 07</b>.</p>
<br />

<a name="VRC7Write" class="boldText">Ixx - Custom patch byte write</a><br />
<p class="text">Byte <b>xx</b> to be written at the address port specified. To be used with <b>Hxx</b>.<br />
<br />

<hr />

<p class="heading">FDS modulation effects</p>

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

<hr />

<p class="heading">S5B effects</p>

<a name="S5BEnvelopeType" class="boldText">H0y - Envelope type</a><br />
<p class="text">Sets <a href="sunsoft.htm#5BEnvelopes">envelope type</a> <b>y</b>.<br /></p>
<br />

<a name="S5BEnvelopePitch" class="boldText">Hxy - Envelope automatic pitch</a><br />
<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 />
Approximate envelope frequency is note frequency * (2^|<b>x</b> - 8|) / 32.</p>
<br />

<a name="S5BEnvelopePitchHi" class="boldText">Ixx - Envelope manual pitch, high</a><br />
<p class="text">Sets the highest 8 bits of the 16-bit envelope period.</p>
<br />

<a name="S5BEnvelopePitchLo" class="boldText">jxx - Envelope manual pitch, low</a><br />
<p class="text">Sets the lowest 8 bits of the 16-bit envelope period.</p>
<br />

<a name="S5BNoisePitch" class="boldText">Wxx - Noise pitch</a><br />
<p class="text">Sets the noise pitch.<br />
Valid range: <b>00 - 1F</b>.</p>
<br />

<hr />
<span class="footer">Back to <a href="interface.htm">interface</a> &middot; <a href="main_index.htm">main index</a></span>

Expand Down
53 changes: 3 additions & 50 deletions hlp/sunsoft.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,12 @@
Noise, and the Yellow bar is for Envelope.
</p>
<hr>
<p class="heading">5B Envelopes</p>
<a name="5BEnvelopes"><p class="heading">5B Envelopes</p></a>
<p class="text">The Sunsoft 5B has a configurable envelope generator, able to
play back 16 preset envelope sets. The table below shows each envelope and
its functions.
</p>
<p class="footer"><i>Note: These are intended to be used with the Hxy command.</i></p>
<p class="footer"><i>Note: These are intended to be used with the H0y/Hxy command.</i></p>
<table border="1" size=50% class="text">
<thead>
<tr>
Expand Down Expand Up @@ -117,54 +117,7 @@
</tr>
</tbody>
</table>
<hr>
<p class="heading">Effects</p>
<p class="text">
The Sunsoft 5B comes with it's own unique set of effects for the features
it has. The table describes all the effects and their syntax, as well as
what they do.
</p>
<table border="1" style="table-layout: fixed; width: 448px" class="text">
<colgroup>
<col style="width: 101px">
<col style="width: 171px">
<col style="width: 176px">
</colgroup>
<thead>
<tr>
<th>Effect Name</th>
<th>Effect Syntax</th>
<th>Effect Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Envelope</td>
<td>H0y<br><br>Y = Envelope Shape</td>
<td>Defines an envelope type to use. Set pitch with Ixx and Jxx.</td>
</tr>
<tr>
<td>Auto Envelope</td>
<td>Hxy<br>X = Pitch Shift<br>Y = Envelope Shape</td>
<td>Define an envelope type to use, and tie it to the note placed down in the pattern.</td>
</tr>
<tr>
<td>Envelope Pitch</td>
<td>Ixx, Jxx</td>
<td>These two effects control the 5B's pitch and </td>
</tr>
<tr>
<td>Noise Pitch</td>
<td>Wxx</td>
<td>Manually control the pitch at which the 5B's Noise Generator is playing.</td>
</tr>
<tr>
<td>Noise/Mode Toggle</td>
<td>Vxx</td>
<td>Manually Toggle Tone/Noise/Envelope, <br>overriding the instrument's macro if it has ended.</td>
</tr>
</tbody>
</table>

<hr>
<span class="footer">
Back to <a href="sound_overview.htm">sound hardware</a> &middot;
Expand Down

0 comments on commit 4358656

Please sign in to comment.