Skip to content

Commit 8fccfce

Browse files
Gumball2415Gumball2415
committed
Add groove and detune settings
- Fixes #5. - Fixes #7. - Add bookmark manager - Expand module properties with images - Link groove, detune dialogs accordingly - Add heading for module settings
1 parent e2c1fd2 commit 8fccfce

20 files changed

+287
-15
lines changed

‎hlp/2a03.htm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
Produces pulse waves with four duty lengths (12.5%, 25%, 50% and 25% inverted).
4949
These channels have a hardware sweep unit that can be accessed by
5050
<a href="effect_list.htm#HardwareSweepUp">H and I effects</a>. These channels also have a
51-
hardware volume envelope, accesible with <a href="effect_list.htmeffect_list.htm#Volume2A03EnvelopeToggle">Exx effects.</a><br /><br />
51+
hardware volume envelope, accesible with <a href="effect_list.htm#Volume2A03LengthCounter">Exx effects.</a><br /><br />
5252
<i>Note:</i> There is a hardware quirk that resets the duty phase when the high
5353
byte of the freqency registers are written, this can be heard as a pop and might
5454
be noticable when using vibrato or pitch slides across those frequencies.<br /><br />

‎hlp/Dn-FamiTracker.hhc

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,27 @@
102102
<param name="Local" value="menu_help.htm">
103103
</OBJECT>
104104
</UL>
105+
<LI> <OBJECT type="text/sitemap">
106+
<param name="Name" value="Module settings">
107+
</OBJECT>
108+
<UL>
109+
<LI> <OBJECT type="text/sitemap">
110+
<param name="Name" value="Module properties">
111+
<param name="Local" value="properties.htm">
112+
</OBJECT>
113+
<LI> <OBJECT type="text/sitemap">
114+
<param name="Name" value="Detune settings">
115+
<param name="Local" value="detune_settings.htm">
116+
</OBJECT>
117+
<LI> <OBJECT type="text/sitemap">
118+
<param name="Name" value="Groove settings">
119+
<param name="Local" value="groove_settings.htm">
120+
</OBJECT>
121+
<LI> <OBJECT type="text/sitemap">
122+
<param name="Name" value="Bookmark Manager">
123+
<param name="Local" value="bookmark_manager.htm">
124+
</OBJECT>
125+
</UL>
105126
<LI> <OBJECT type="text/sitemap">
106127
<param name="Name" value="Pattern editor">
107128
<param name="Local" value="pattern_editor.htm">
@@ -118,10 +139,6 @@
118139
<param name="Name" value="Key commands">
119140
<param name="Local" value="shortcuts.htm">
120141
</OBJECT>
121-
<LI> <OBJECT type="text/sitemap">
122-
<param name="Name" value="Module properties">
123-
<param name="Local" value="properties.htm">
124-
</OBJECT>
125142
<LI> <OBJECT type="text/sitemap">
126143
<param name="Name" value="NSF exporting">
127144
<param name="Local" value="nsf_export.htm">

‎hlp/bookmark_manager.htm

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
<HTML>
2+
<HEAD>
3+
<META NAME="GENERATOR" Content="Microsoft Visual Studio 8.0">
4+
<TITLE></TITLE>
5+
<link href="style.css" rel="stylesheet" type="text/css" />
6+
</HEAD>
7+
<BODY>
8+
9+
<span class="topic">Bookmark manager</span><hr />
10+
11+
<p class="text">
12+
The bookmark manager is used to manage bookmarks.</p>
13+
14+
<p class="text">
15+
<img id="IMG1" style="FONT-SIZE: 10pt" src="img/bookmark_manager.png" alt="Screenshot of bookmark manager dialog"></p>
16+
17+
<h2 class="bold">Bookmark</h2>
18+
19+
<p class="text">
20+
A bookmark is a highlight in the pattern editor at a specified frame and row.
21+
It resets the row highlight pattern, and may define a new row highlight pattern.</p>
22+
23+
<p class="text">
24+
Each bookmark contains:
25+
26+
<ul class="text">
27+
<li>A name, which defaults to "Bookmark" and comes with an index if
28+
created from the pattern editor directly;</li>
29+
<li>A frame index and a row index, which indicate the position of
30+
the bookmark. Bookmarks reposition themselves upon performing frame
31+
actions such as inserting or removing frames;</li>
32+
<li>Highlight settings which override the previous value of the
33+
track if enabled. Using bookmarks, it is possible to change the row
34+
highlight intervals in the middle of a track. Disabling "Apply to
35+
all following frames" will keep the highlight distance to the
36+
current frame, so that the next frame will not use the settings of
37+
this bookmark.</li>
38+
</ul></p>
39+
40+
<h2 class="bold">Bookmark Editor</h2>
41+
42+
<p class="text">
43+
This allows the user to modify a bookmark.</p>
44+
45+
<h2 class="bold">Bookmark List</h2>
46+
47+
<p class="text">
48+
Lists the module's bookmark data.</p>
49+
50+
<p>
51+
<span class="gray">Move Up</span><br />
52+
<span class="text">Moves the selected bookmark up one index.</span></p>
53+
54+
<p>
55+
<span class="gray">Move Down</span><br />
56+
<span class="text">Moves the selected bookmark down one index.</span></p>
57+
58+
<p>
59+
<span class="gray">Remove</span><br />
60+
<span class="text">Deletes the selected bookmark.</span></p>
61+
62+
<p>
63+
<span class="gray">Clear all</span><br />
64+
<span class="text">Deletes all bookmark data.</span></p>
65+
66+
<p class="text">
67+
The bookmark list supports these keyboard shortcuts:
68+
69+
<ul class="text">
70+
<li>Ctrl + Up / Down for moving the currently selected bookmark;</li>
71+
<li>Insert for creating a new bookmark;</li>
72+
<li>Delete for removing the currently selected bookmark.</li>
73+
</ul></p>
74+
75+
<hr />
76+
<span class="footer">Back to <a href="interface.htm">interface</a> &middot; <a href="main_index.htm">main index</a></span>
77+
78+
</BODY>
79+
</HTML>

‎hlp/control_panel.htm

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<span class="topic">Control panel</span><hr />
1010

11-
<p class="text">The main window control panel</p>
11+
<p class="text">The main window control panel.</p>
1212

1313
<img id="img" src="img/toolbar2.png" alt="Screenshot of the control panel."><br />
1414

@@ -44,14 +44,15 @@
4444

4545
<h2 class="bold">Song settings &amp; edit settings</h2>
4646

47-
<img id="img" src="img/song_and_edit_settings.png" alt="Screenshot of song settings and edit settings."><br />
47+
<img id="img" src="img/song_and_edit_settings.png" alt="Screenshot of song settings and edit settings.">
48+
<img id="img" src="img/song_and_edit_settings_modified.png" alt="Screenshot of song settings and edit settings with speed and tempo modified."><br />
4849

4950
<p class="text">
5051
Song settings is default play speed &amp; tempo, number
5152
of rows and frames in the song. Double-click any box to enter a value manually.</p>
5253

5354
<p class="text">
54-
Click on the <b>Speed</b> button to toggle between Speed and Grooves.</p>
55+
Click on the <b>Speed</b> button to toggle between Speed and <a href="groove_settings.htm">Grooves</a>.</p>
5556

5657
<p class="text">
5758
Click on the <b>Tempo</b> button to toggle between Tempo and Fixed.

‎hlp/detune_settings.htm

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<HTML>
2+
<HEAD>
3+
<META NAME="GENERATOR" Content="Microsoft Visual Studio 8.0">
4+
<TITLE></TITLE>
5+
<link href="style.css" rel="stylesheet" type="text/css" />
6+
</HEAD>
7+
<BODY>
8+
9+
<span class="topic">Detune settings</span><hr />
10+
11+
<p class="text">
12+
The detune settings dialog is used to manage the module's note tuning.</p>
13+
14+
<p class="text">
15+
<img id="IMG1" style="FONT-SIZE: 10pt" src="img/detune_settings.png" alt="Screenshot of detune settings dialog"></p>
16+
17+
<h2 class="bold">Detune editor</h2>
18+
19+
<p class="text">
20+
This allows the user to modify each individual note pitch offset, for all chips.</p>
21+
22+
<p>
23+
<span class="gray">Reset</span><br />
24+
<span class="text">Resets the note table back to default values.</span></p>
25+
26+
<p>
27+
<span class="gray">Import</span><br />
28+
<span class="text">Loads a comma-separated value (.csv) file containing
29+
note pitch offsets.</span></p>
30+
31+
<p>
32+
<span class="gray">Import</span><br />
33+
<span class="text">Saves current note pitch offsets to a comma-separated
34+
value (.csv) file.</span></p>
35+
36+
<h2 class="bold">Global tuning</h2>
37+
38+
<p class="text">
39+
This allows the user to modify the global tuning and pitch offset. This
40+
also affects all existing detune settings.</p>
41+
42+
<hr />
43+
<span class="footer">Back to <a href="interface.htm">interface</a> &middot; <a href="main_index.htm">main index</a></span>
44+
45+
</BODY>
46+
</HTML>

‎hlp/effect_list.htm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@
197197
<br />
198198

199199
<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>
200+
<p class="text">If groove mode is enabled, sets the groove to index <b>xx</b> of the <a href="groove_settings.htm">groove list</a>.</p>
201201
<br />
202202

203203
<a name="FinePitch" class="boldText">Pxx - Fine pitch</a><br />

‎hlp/groove_settings.htm

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
<HTML>
2+
<HEAD>
3+
<META NAME="GENERATOR" Content="Microsoft Visual Studio 8.0">
4+
<TITLE></TITLE>
5+
<link href="style.css" rel="stylesheet" type="text/css" />
6+
</HEAD>
7+
<BODY>
8+
9+
<span class="topic">Groove Settings</span><hr />
10+
11+
<p class="text">
12+
The groove settings dialog is used to edit and manage the module's grooves.</p>
13+
14+
<p class="text">
15+
<img id="IMG1" style="FONT-SIZE: 10pt" src="img/groove_settings.png" alt="Screenshot of groove settings dialog"></p>
16+
17+
<h2 class="bold">Groove</h2>
18+
<p class="text">
19+
A groove is a sequence of speed commands that changes the speed every row.
20+
This can be used in place of long chains of
21+
<a href="effect_list.htm#Speed"><b>Fxx</b></a> commands to save pattern data.</p>
22+
<p class="text">
23+
Each module may store up to:
24+
<ul class="text">
25+
<li>32 grooves;</li>
26+
<li>255 groove bytes; (each non-empty groove uses 1 byte per entry plus 2 bytes)</li>
27+
<li>128 entries per groove.</li>
28+
</ul></p>
29+
30+
31+
<h2 class="bold">Groove list</h2>
32+
33+
<p class="text">
34+
Lists the module's groove data.</p>
35+
36+
<p>
37+
<span class="gray">Up</span><br />
38+
<span class="text">Moves the selected groove data up one index.</span></p>
39+
40+
<p>
41+
<span class="gray">Down</span><br />
42+
<span class="text">Moves the selected groove data down one index.</span></p>
43+
44+
<p>
45+
<span class="gray">Clear</span><br />
46+
<span class="text">Deletes the selected groove data.</span></p>
47+
48+
<p>
49+
<span class="gray">Clear all</span><br />
50+
<span class="text">Deletes all groove data.</span></p>
51+
52+
53+
<h2 class="bold">Groove editor</h2>
54+
55+
<p class="text">
56+
The groove editor allows the user to modify the groove pattern.</p>
57+
58+
<p>
59+
<span class="gray">Move up</span><br />
60+
<span class="text">Moves the selected speed command up.</span></p>
61+
62+
<p>
63+
<span class="gray">Move down</span><br />
64+
<span class="text">Moves the selected speed command down.</span></p>
65+
66+
<p>
67+
<span class="gray">Generate</span><br />
68+
<span class="text">Generates a speed sequence <b>x</b> / <b>y</b>, or
69+
<b>x</b> ticks in <b>y</b> rows. Inputs for <b>x</b> and <b>y</b> are provided in the
70+
textboxes next to the button. The sequence won't be generated if the resulting speed is less than one.</span></p>
71+
72+
<p>
73+
<span class="gray">Pad</span><br />
74+
<span class="text">Padding inserts the specified entry after each groove
75+
entry, so that the average speed is halved. All entries in the groove must
76+
be greater than the pad amount.</span></p>
77+
78+
<p>
79+
<span class="gray">Expand</span><br />
80+
<span class="text">Halves the groove's average speed and works only if
81+
all entries are greater than or equal to 2.</span></p>
82+
83+
<p>
84+
<span class="gray">Shrink</span><br />
85+
<span class="text">Doubles the average speed and works only when the
86+
groove length is a multiple of 2.</span></p>
87+
88+
<hr />
89+
<span class="footer">Back to <a href="interface.htm">interface</a> &middot; <a href="main_index.htm">main index</a></span>
90+
91+
</BODY>
92+
</HTML>

‎hlp/img/bookmark_manager.png

13.4 KB
Loading

‎hlp/img/detune_settings.png

21.6 KB
Loading

‎hlp/img/device_mix_offset.png

6.47 KB
Loading

0 commit comments

Comments
 (0)