Update manual for version 0.5.1.0

Dn-Programming-Core-Management · Jan 6, 2025 · 60ef5c5 · 60ef5c5
1 parent 8412d66
commit 60ef5c5
Show file tree

Hide file tree

Showing 29 changed files with 377 additions and 273 deletions.
diff --git a/hlp/2a03.htm b/hlp/2a03.htm
@@ -211,15 +211,23 @@
         The &quot;<b>&lt;-</b>&quot;-button can also be used to assign samples, and &quot;<b>-&gt;</b>&quot;-button to remove assigned
         samples.</p>
 
+    <p class="bold"><a name="DPCMLoop">Loop</a></p>
+
     <p class="text">
         The loop setting will enable the DPCM loop mode, where the entire sample is
         looped from start to end.</p>
+
+    <p class="bold"><a name="DPCMDelta">Delta counter</a></p>
+
     <p class="text">
         The D-counter (delta counter) setting is used to force the delta counter to an initial value before the
         sample is played (equivalent to a Zxx-command in the pattern). Set it to Off to start playing the sample without resetting
         the delta counter.</p>
+
+    <p class="bold"><a name="DPCMSamplerate">Pitch</a></p>
+
     <p class="text">
-        The pitch setting translates to a frequency according to the
+        The pitch setting translates to a playback samplerate according to the
         following table (using the tracker's NTSC and PAL clock frequency of 1.789773 MHz and 1.662607 MHz respectively):</p>
 
     <table class="default" border="1" cellpadding="3px" style="width: 130px">
@@ -312,10 +320,6 @@
 
     <p class="text"><a href="https://www.nesdev.org/wiki/APU_DMC#Pitch_table">Reference.</a></p>
 
-    <p class="text">
-        This is equivalent to the quality setting when converting WAV files to DPCM
-        samples.</p>
-
     <table class="noteFrame" cellpadding="5px">
         <tr>
             <td>

diff --git a/hlp/Dn-FamiTracker.hhp b/hlp/Dn-FamiTracker.hhp
@@ -70,12 +70,16 @@ config_gui.htm
 config_emulation.htm
 menu_pattern.htm
 menu_song.htm
+groove_settings.htm
+detune_settings.htm
+bookmark_manager.htm
 
 [ALIAS]
 CHANGE_LOG						= changelog.htm
 DPCM_IMPORT						= dpcm_import.htm
 EFFECTS							= effect_list.htm
 HIDD_ABOUTBOX					= main_index.htm
+HIDD_BOOKMARKS=bookmark_manager.htm
 HIDD_COMMAND_LINE				= command_line.htm
 HIDD_COMMENTS					= comments.htm
 HIDD_CONFIG_APPEARANCE			= config_appearance.htm
@@ -88,7 +92,9 @@ HIDD_CONFIG_SHORTCUTS			= config_shortcuts.htm
 HIDD_CONFIG_SOUND				= config_sound.htm
 HIDD_CONFIG_VERSION=config_version.htm
 HIDD_CREATEWAV					= export_wave.htm
+HIDD_DETUNE=detune_settings.htm
 HIDD_EXPORT						= nsf_export.htm
+HIDD_GROOVE=groove_settings.htm
 HIDD_INSTRUMENT_DPCM			= 2a03.htm
 HIDD_INSTRUMENT_FDS				= fds.htm
 HIDD_INSTRUMENT_FDS_ENVELOPE	= fds.htm

diff --git a/hlp/comments.htm b/hlp/comments.htm
@@ -8,6 +8,9 @@
 
     <span class="topic">Module comments</span><hr />
 
+    <p class="text">
+        <img id="IMG1" style="FONT-SIZE: 10pt" src="img/module_comments.png" alt="Screenshot of module comments dialog"></p>
+
     <p class="text">
     This dialog is used to store a message in the module file.<br /><br />
 

diff --git a/hlp/config_general.htm b/hlp/config_general.htm
@@ -162,6 +162,12 @@
                 Use the extra keys on the keypad as hexadecimal digits in
                 the pattern editor.</td>
         </tr>
+        <tr>
+            <td>
+                Multi-frame selection</td>
+            <td>
+                Allow pattern selections to span across multiple frames.</td>
+        </tr>
         <tr>
             <td>
                 Check version on startup</td>
@@ -173,6 +179,25 @@
 
     <br />
 
+    <p class="heading">Edit settings</p>
+
+    <table border="1" cellpadding="3px" class="default">
+        <tr>
+            <td class="highlight" style="width: 200px">
+                <b>Setting</b></td>
+            <td class="highlight">
+                <b>Description</b></td>
+        </tr>
+        <tr>
+            <td>
+                Page Down jump</td>
+            <td>
+                Number of rows to jump when Page Up/Down is pressed.</td>
+        </tr>
+	</table>
+
+    <br />
+
     <p class="heading">Pattern edit style</p>
 
     <table border="1" cellpadding="3px" class="default">

diff --git a/hlp/config_mixer.htm b/hlp/config_mixer.htm
@@ -9,19 +9,30 @@
     <span class="topic">Mixer configuration</span><hr />
 
     <p class="text">
-        This allows you to confgure the mixing levels of the emulated audio hardware. This option is provided because
-        the mixing levels could vary on different types of hardware (such as different models of the Famicom or different versions
-        of game cartridges), it allows you to fine tune the audio emulation against a specific
-        set of hardware.</p>
+        This allows you to confgure the mixing levels of the emulated audio 
+        hardware. This option is provided because the mixing levels could vary 
+        on different types of hardware (such as different models of the Famicom 
+        or different versions of game cartridges), it allows you to fine tune 
+        the audio emulation against a specific set of hardware.</p>
 
     <p class="text">
-        Before changing these settings, please be aware that mixing levels are not yet stored in the NSF format and
-        that your song could be played back with any configuration of mixing levels!</p>
+        Before changing these settings, please be aware that mixing levels are 
+        stored in the NSF2/NSFe format via the
+        <a href="properties.htm#DeviceMixer">device mixer</a> in the module 
+        properties.</p>
+
+    <p class="text">
+        Regardless, your song could be played back with any 
+        configuration of mixing levels!</p>
 
     <p class="text">
         APU1 is the first audio out pin (pulse 1 & 2) and APU2 is the second audio out pin (triangle, noise & DPCM),
         the rest are the expansion chips. The sliders ranges from -12 dB to +12 dB, the default
-        value is 0 dB for all sliders.</p>
+        value is 0 dB for all sliders.
+    <ul class="text">
+        <li><b>Reset</b></b><br />
+            Sets all sliders to 0 dB.<br /><br /></li>
+    </ul></p>
 
     <hr />
     <span class="footer">Back to <a href="configuration.htm">configuration</a> &middot; <a href="interface.htm">interface</a> &middot; <a href="main_index.htm">main index</a></span>

diff --git a/hlp/config_version.htm b/hlp/config_version.htm
@@ -21,9 +21,7 @@
             <li><b>None</b><br />
                 Perform no validation at all while loading or saving modules.
                 The tracker might crash or enter an inconsistent state.<br /><br /></li>
-        </ul>
-
-        </p>
+        </ul></p>
 
     <hr />
     <span class="footer">Back to <a href="configuration.htm">configuration</a> &middot; <a href="interface.htm">interface</a> &middot; <a href="main_index.htm">main index</a></span>

diff --git a/hlp/detune_settings.htm b/hlp/detune_settings.htm
@@ -14,11 +14,6 @@
     <p class="text">
         <img id="IMG1" style="FONT-SIZE: 10pt" src="img/detune_settings.png" alt="Screenshot of detune settings dialog"></p>
 
-<h2 class="bold">Detune editor</h2>
-
-    <p class="text">
-        This allows the user to modify each individual note pitch offset, for all chips.</p>
-
     <p>
         <span class="gray">Reset</span><br />
         <span class="text">Resets the note table back to default values.</span></p>
@@ -33,11 +28,16 @@ <h2 class="bold">Detune editor</h2>
         <span class="text">Saves current note pitch offsets to a comma-separated
         value (.csv) file.</span></p>
 
+<h2 class="bold">Detune editor</h2>
+
+    <p class="text">
+        This allows the user to modify each individual note pitch offset, for any chip selected in the Table radio button list.</p>
+
 <h2 class="bold">Global tuning</h2>
 
     <p class="text">
         This allows the user to modify the global tuning and pitch offset. This
-        also affects all existing detune settings.</p>
+        affects the pitch in addition to all existing detune settings.</p>
 
     <hr />
     <span class="footer">Back to <a href="interface.htm">interface</a> &middot; <a href="main_index.htm">main index</a></span>

diff --git a/hlp/dpcm_import.htm b/hlp/dpcm_import.htm
@@ -1,19 +1,23 @@
 <HTML>
-	<HEAD>
-		<TITLE></TITLE>
-		<META NAME="GENERATOR" Content="Microsoft Visual Studio .NET 7.1">
+    <HEAD>
+        <TITLE></TITLE>
+        <META NAME="GENERATOR" Content="Microsoft Visual Studio .NET 7.1">
         <link href="style.css" rel="stylesheet" type="text/css" />
-	</HEAD>
-	<BODY>
+    </HEAD>
+    <BODY>
         <span class="topic">Importing DPCM samples</span>
-		<hr>
+        <hr>
 
         <p class="text">
             This feature is used to convert Microsoft wave files (.wav) to 1-bit DPCM samples, 
             as used by the NES hardware&#39;s sample channel. 
             The format of the wave files must be PCM, no compressed formats are supported.
             Sample rate, sample size and channel count doesn&#39;t matter, the file will be 
             resampled according to the quality setting.<br /></p>
+
+    <p class="text">
+        <img id="IMG1" style="FONT-SIZE: 10pt" src="img/pcm_import.png"
+        alt="Screenshot of PCM import dialog"></p>
 
         <p class="text">
             Choose import in 
@@ -23,9 +27,11 @@
 
         <ul class="text">
             <li><b>Quality</b><br />
-                Sets the sample rate for the converted sample, this is equivalent to the pitch setting in the instrument editor. Use the same setting to play the 
-                sample at original pitch. Quality of 15 gives 
-				best result but also shortest sample time.<br /><br />
+                Sets the <a href="2a03.htm#DPCMSamplerate">sample rate</a> for 
+                the converted sample, this is equivalent to the pitch setting 
+                in the instrument editor. Use the same setting to play the 
+                sample at original pitch. Quality of 15 gives the best result 
+                at the cost of shortest sample time.<br /><br />
             </li>
             <li><b>Gain</b><br />
                 Sets the conversion volume level. Range: -12dB to +12dB.
@@ -34,11 +40,13 @@
 
         <p class="text">
             Maximum supported size of one DPCM sample
-            is 4 kB, at quality 15 (33 kHz) it's a little 
-            less than one second and lowest quality (4 kHz) about eight seconds.</p>
+            is 4 kB (4081 bytes). At rate 15 (33.14394 kHz NTSC / 33.2521 kHz 
+            PAL), the play length is a little less than a second, while the 
+            lowest rate 0 (4.18171 kHz NTSC / 4.17740 kHz PAL) lasts about eight 
+            seconds.</p>
 
     <hr />
     <span class="footer">Back to <a href="interface.htm">interface</a> &middot; <a href="main_index.htm">main index</a></span>
 
-	</BODY>
+    </BODY>
 </HTML>
diff --git a/hlp/export_wave.htm b/hlp/export_wave.htm
@@ -7,11 +7,33 @@
 <BODY>
 
     <span class="topic">Export to wave</span><hr />
+
+    <p class="text">
+        <img id="IMG1" style="FONT-SIZE: 10pt" src="img/wave_export.png"
+        alt="Screenshot of wave export dialog"></p>
 
     <p class="text">
-    This feature allows FTM modules to be exported to wave files.
+    This feature allows modules to be exported as wave files. The samplerate, filtering and volume output follow the module's <a href="config_sound.htm">sound configuration</a>.
     </p>
-
+
+<h2 class="bold">Song length</h2>
+
+    <p class="text">The song can be exported either in loop counts or in a
+    specified length of time.</p>
+
+<h2 class="bold">Song</h2>
+
+    <p class="text">Selects the song to be exported.</p>
+
+<h2 class="bold">Channels</h2>
+
+    <p class="text">Selects the channels to be audible in export.</p>
+
+<h2 class="bold">Seperate channel export</h2>
+
+    <p class="text">If enabled, exports a single isolated wave file for each 
+    channel selected in the Channels list.</p>
+
     <hr />
     <span class="footer">Back to <a href="main_index.htm">main index</a></span>
 

diff --git a/hlp/fds.htm b/hlp/fds.htm
@@ -25,7 +25,7 @@
         modulator.</p>
 
     <hr />
-    <p class="heading">Instruments</p>
+    <p class="heading"><a name="Instruments">Instruments</a></p>
 
     <p>
         <IMG id="IMG1" style="FONT-SIZE: 10pt" src="img/inst_fds.PNG" alt=""></p>

diff --git a/hlp/hlp.vcxproj b/hlp/hlp.vcxproj
@@ -390,6 +390,9 @@ echo.</Command>
     <None Include="2a03.htm">
       <DeploymentContent>true</DeploymentContent>
     </None>
+    <None Include="bookmark_manager.htm">
+      <DeploymentContent>true</DeploymentContent>
+    </None>
     <None Include="changelog.htm">
       <DeploymentContent>true</DeploymentContent>
     </None>
@@ -432,6 +435,9 @@ echo.</Command>
     <None Include="control_panel.htm">
       <DeploymentContent>true</DeploymentContent>
     </None>
+    <None Include="detune_settings.htm">
+      <DeploymentContent>true</DeploymentContent>
+    </None>
     <None Include="Dn-FamiTracker.hhc" />
     <None Include="Dn-FamiTracker.hhk" />
     <None Include="dpcm_editor.htm">
@@ -452,6 +458,9 @@ echo.</Command>
     <None Include="fds.htm">
       <DeploymentContent>true</DeploymentContent>
     </None>
+    <None Include="groove_settings.htm">
+      <DeploymentContent>true</DeploymentContent>
+    </None>
     <None Include="instruments.htm">
       <DeploymentContent>true</DeploymentContent>
     </None>
@@ -539,22 +548,54 @@ echo.</Command>
     </None>
   </ItemGroup>
   <ItemGroup>
-    <Image Include="img\comments.png" />
-    <Image Include="img\dpcm_editor.PNG" />
+    <Image Include="img\bookmark_manager.png" />
+    <Image Include="img\chip_2A03.png" />
+    <Image Include="img\chip_FDS.png" />
+    <Image Include="img\chip_MMC5.PNG" />
+    <Image Include="img\chip_N163.png" />
+    <Image Include="img\chip_S5B.png" />
+    <Image Include="img\chip_VRC6.PNG" />
+    <Image Include="img\chip_VRC7.png" />
+    <Image Include="img\detune_settings.png" />
+    <Image Include="img\device_mix_offset.png" />
+    <Image Include="img\dpcm_editor.png" />
     <Image Include="img\dpcm_import.png" />
+    <Image Include="img\expansion_sound.png" />
     <Image Include="img\export_wav.png" />
     <Image Include="img\fds_fm_table.PNG" />
     <Image Include="img\frame_editor.png" />
+    <Image Include="img\groove_settings.png" />
     <Image Include="img\Icon.png" />
+    <Image Include="img\import_file.png" />
     <Image Include="img\inst_2a03.png" />
-    <Image Include="img\inst_dpcm.PNG" />
-    <Image Include="img\inst_fds.PNG" />
+    <Image Include="img\inst_dpcm.png" />
+    <Image Include="img\inst_fds.png" />
     <Image Include="img\inst_n163.png" />
-    <Image Include="img\inst_vrc7.PNG" />
+    <Image Include="img\inst_sun5.png" />
+    <Image Include="img\inst_sun5_nmode.png" />
+    <Image Include="img\inst_vrc7.png" />
+    <Image Include="img\module_comments.png" />
+    <Image Include="img\opll_settings.png" />
     <Image Include="img\pattern.png" />
-    <Image Include="img\properties.PNG" />
+    <Image Include="img\pcm_import.png" />
+    <Image Include="img\pitch_mode.png" />
+    <Image Include="img\properties.png" />
+    <Image Include="img\s5b_env_0-3,_9.png" />
+    <Image Include="img\s5b_env_4-7,_f.png" />
+    <Image Include="img\s5b_env_8.png" />
+    <Image Include="img\s5b_env_a.png" />
+    <Image Include="img\s5b_env_b.png" />
+    <Image Include="img\s5b_env_c.png" />
+    <Image Include="img\s5b_env_d.png" />
+    <Image Include="img\s5b_env_e.png" />
+    <Image Include="img\song_and_edit_settings.png" />
+    <Image Include="img\song_and_edit_settings_modified.png" />
+    <Image Include="img\song_editor.png" />
+    <Image Include="img\song_information_and_instrument_list.png" />
     <Image Include="img\toolbar1.png" />
     <Image Include="img\toolbar2.png" />
+    <Image Include="img\vibrato.png" />
+    <Image Include="img\wave_export.png" />
   </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
   <ImportGroup Label="ExtensionTargets">