| 1 |
<html> |
| 2 |
<head> |
| 3 |
<title>HivelyTracker Documentation</title> |
| 4 |
</head> |
| 5 |
<body> |
| 6 |
<h1>HivelyTracker v1.0 from IRIS & Up Rough!</h1> |
| 7 |
<h1>Getting Started</h1> |
| 8 |
<p> |
| 9 |
When you first start HivelyTracker, you should be presented with an interface like |
| 10 |
this: |
| 11 |
</p> |
| 12 |
<center> |
| 13 |
<a href="images/overviewbig.png" target="_blank"><img src="images/overview.png" width="400" height="300" alt="Main GUI" /></a> |
| 14 |
</center> |
| 15 |
<p> |
| 16 |
REMEMBER: Almost every input area in the GUI works with the mousewheel. Often this is the fastest and easiest method! |
| 17 |
</p> |
| 18 |
Along the top row next to the logo is the button panel. The following table lists |
| 19 |
the button functions: |
| 20 |
<table border="1" cellpadding="1" cellspacing="0"> |
| 21 |
<tr><td><b>Button</b></td><td><b>Left click</b></td><td><b>Right click</b></td></tr> |
| 22 |
<tr><td>New Tab</td><td>Opens a new tab. Right click to create a clone of the current tab.</td><td> </td></tr> |
| 23 |
<tr><td>Load Mod</td><td>Loads an AHX or HVL song into the current tab</td><td> </td></tr> |
| 24 |
<tr><td>Save AHX</td><td>Saves the current song as AHX format</td><td> </td></tr> |
| 25 |
<tr><td>Save HVL</td><td>Saves the current song as HVL format</td><td> </td></tr> |
| 26 |
<tr><td>Load Ins</td><td>Loads an AHX or HVL instrument</td><td> </td></tr> |
| 27 |
<tr><td>Save Ins</td><td>Saves an AHX or HVL instrument</td><td> </td></tr> |
| 28 |
<tr><td>Prefs</td><td>Opens the preferences window</td><td> </td></tr> |
| 29 |
<tr><td>Autogain</td><td>Calculates optimal mix gain for the current song (see <a href="mixingnotes.html">mixing notes</a>)</td><td> </td></tr> |
| 30 |
<tr><td>Undo</td><td>Undoes the last thing you changed. Right click to redo changes.</td></tr> |
| 31 |
<tr><td>About</td><td>Opens the about window</td><td> </td></tr> |
| 32 |
<tr><td>Play Song</td><td>Plays the song from the top of the current position</td><td>Continues the song from the current position</td></tr> |
| 33 |
<tr><td>Play Pos</td><td>Plays the current position from the top</td><td>Continues the current position</td></tr> |
| 34 |
<tr><td>Stop</td><td>Stops the song and any audio</td><td>Stops the song and any audio</td></tr> |
| 35 |
</table> |
| 36 |
<p> |
| 37 |
To the right of the button panel are the stereo scopes. |
| 38 |
</p> |
| 39 |
<p> |
| 40 |
Underneath that first row are the tabs. You can have multiple songs loaded into |
| 41 |
HivelyTracker, and each one will have a tab here. You simple click on the relevant |
| 42 |
tab to select the desired song. |
| 43 |
</p> |
| 44 |
<p> |
| 45 |
Beneath the tabs is the tracker panel. Here is where you edit the songs. The |
| 46 |
fundamental building blocks of AHX and HVL tunes are "tracks". A track is a |
| 47 |
list of notes and commands that are parsed from top to bottom. Several of these |
| 48 |
tracks are parsed in parallel (4 for AHX songs, up to 16 for HVL songs). A song |
| 49 |
can contain up to 256 of these tracks, and they can be played in any order. |
| 50 |
</p> |
| 51 |
<p> |
| 52 |
The "position editor" defines the order in which the tracks are played. A song |
| 53 |
can have up to 1000 positions, and each position records which track should be |
| 54 |
played, and a transpose value for each channel. The position editor shows |
| 55 |
the track number and transpose value for each channel as a 3 digit decimal number |
| 56 |
and 2 digit hexadecimal number respectively. The track number is simply 0 - 255 |
| 57 |
for the track number. The transpose value is 00 - 7F to transpose up "n" |
| 58 |
semitones, and 80-FF to transpose down "n" semitones (where FF is -1, FE is -2 |
| 59 |
etc. etc.) |
| 60 |
</p> |
| 61 |
<p> |
| 62 |
To the left of the position editor are two columns of numberboxes. They are: |
| 63 |
</p> |
| 64 |
<p> |
| 65 |
<table border="1" cellpadding="1" cellspacing="0"> |
| 66 |
<tr><td><b>Name</b></td><td><b>Function</b></td></tr> |
| 67 |
<tr><td valign="top">Position</td><td>This is the current position in the song. Changing this numberbox will update the position editor and the track editor</td></tr> |
| 68 |
<tr><td valign="top">Length</td><td>This is the length of the song in positions. Once the end of position "Length - 1" is reached, the song jumps to the position in the restart box</td></tr> |
| 69 |
<tr><td valign="top">Restart</td><td>This is the position number to jump to once the end of the song is reached</td></tr> |
| 70 |
<tr><td valign="top">Track Len</td><td>This is the length of the tracks from 1 to 64</td></tr> |
| 71 |
<tr><td valign="top">Subsongs</td><td>This is the number of "subsongs". An AHX or HVL song file can contain a number of extra songs after the main one. This is the number of extra subsongs to include, not including the main one</tr></tr> |
| 72 |
<tr><td valign="top">S.S. Num</td><td>This is the number of the subsong that you are currently editing. When you change this numberbox, the position editor is set to the starting position of this subsong</td></tr> |
| 73 |
<tr><td valign="top">S.S. Pos</td><td>This is the starting position of the current subsong. For example, the main song might be 24 positions long (0 to 23), and subsong 1 could start at 24</td></tr> |
| 74 |
<tr><td valign="top">Channels</td><td>This is the number of channels in the song. AHX songs can only have 4 channels</td></tr> |
| 75 |
<tr><td valign="top">Mix Gain</td><td>This sets the mix gain (see <a href="mixingnotes.html">mixing notes</a>)</td></tr> |
| 76 |
</table> |
| 77 |
</p> |
| 78 |
<p> |
| 79 |
Below the position editor is the track editor. Unlike AHX, the track editor is |
| 80 |
ALWAYS synced to the current position in the song. So, if a 4 channel song had |
| 81 |
tracks "1", "20", "0" and "0" at the current position, the track editor will show |
| 82 |
tracks 1, 20, 0 and 0 in the four columns. You can change the track number at a given |
| 83 |
position by going to the position editor (press ENTER if the track editor is active, |
| 84 |
or click in it), using the cursor keys to get to the track number you wish to change |
| 85 |
and typing in a new track number on the keyboard. Alternatively, you can just use |
| 86 |
the mousewheel in the "track number" box to the right of the mute button for the |
| 87 |
given channel. The track editor has to be in edit mode before you can put notes or |
| 88 |
commands into a track. Space toggles edit mode. |
| 89 |
</p> |
| 90 |
<p> |
| 91 |
Each track in the track editor is split into 3 columns; the note column and two |
| 92 |
command columns. In edit mode, you use the keyboard like a piano keyboard to write |
| 93 |
notes into the track. The bottom row starting from the bottom left alphabet key |
| 94 |
(Z on english and us keyboards) is the low octave keyboard (on GB keyboard, Z = C, |
| 95 |
S = C#, X = D and so on). The top alphabetical row and the numerical row act as |
| 96 |
the high octave keyboard (on GB keyboard, Q = C, 2 = C#, W = D etc.). AHX and HVL |
| 97 |
has 5 octaves. Pressing F1 sets the low octave keys as octave 1, and the high octave |
| 98 |
keys as octave 2. F2 sets octaves 2&3, F3 sets 3&4, F4 sets 4&5 and F5 sets 5. |
| 99 |
</p> |
| 100 |
<p> |
| 101 |
Using the cursor keys, you can move the cursor over to the command rows to insert |
| 102 |
commands. Commands are 3-digit hexadecimal numbers, where the first digit is the |
| 103 |
command type, and the second two are the effect parameter. See the <a href="commandref.html">command reference</a> |
| 104 |
for more information. |
| 105 |
</p> |
| 106 |
<p> |
| 107 |
HivelyTracker won't make any noise without instruments. Songs can have up to 63 |
| 108 |
different instruments. Instruments can be loaded in from disk. The "Load Ins" |
| 109 |
button loads an instrument file into the current instrument slot. You can change |
| 110 |
the currently active instrument slot with the numerical keypad (see <a href="keyref.html">keyboard reference</a>), |
| 111 |
or by simply rolling the mousewheel over the instrument list to the right of the |
| 112 |
position editor. |
| 113 |
</p> |
| 114 |
<p> |
| 115 |
When you insert notes into tracks, usually it will have an instrument number |
| 116 |
next to it. For example, "C#1 01" means play C#1 on instrument one. There is |
| 117 |
an "empty" instrument, which is instrument 0. This shows up as "C#1" with no |
| 118 |
number next to it. This changes the note of any currently playing sound in the |
| 119 |
channel without starting any new instrument noises. |
| 120 |
</p> |
| 121 |
<p> |
| 122 |
Pressing "Ins Ed" takes you into the instrument editor: |
| 123 |
</p> |
| 124 |
<center> |
| 125 |
<a href="images/insedbig.png" target="_blank"><img src="images/insed.png" width="400" height="300" alt="Instrument Editor" /></a> |
| 126 |
</center> |
| 127 |
<p> |
| 128 |
The instrument editor allows you to create or modify instruments. At the top is |
| 129 |
the slot number and name of the current instrument. Down the left hand side |
| 130 |
are a number of parameters you can change: |
| 131 |
</p> |
| 132 |
<p> |
| 133 |
<table border="1" cellpadding="1" cellspacing="0"> |
| 134 |
<tr><td><b>Name</b></td><td><b>Function</b></td></tr> |
| 135 |
<tr><td>Volume</td><td>This is the master volume for this instrument</td></tr> |
| 136 |
<tr><td>Wavelen</td><td>This is the wavelength of the oscillators for this instrument. The higher the value, the lower the pitch of the instrument</td></tr> |
| 137 |
<tr><td><b>Envelope</b></td><td></td></tr> |
| 138 |
<tr><td>Attack</td><td>All instruments start with a volume of 0, and build to the attack volume. The lower this value is, the faster it gets to the attack volume. A value of one means that it instantly reaches this volume</td></tr> |
| 139 |
<tr><td>Volume</td><td>This is the volume to reach after the attack period</td></tr> |
| 140 |
<tr><td>Decay</td><td>After the attack volume is reach it fades to the decay volume. The larger the decay value, the longer this takes</td></tr> |
| 141 |
<tr><td>Volume</td><td>This is the volume to reach after the decay period</td></tr> |
| 142 |
<tr><td>Sustain</td><td>This is how long to hold the decay volume level for</td></tr> |
| 143 |
<tr><td>Release</td><td>After the sustain period, the volume fades to the release volume level. This sets how long that takes</td></tr> |
| 144 |
<tr><td>Volume</td><td>This is the volume to reach after the relase period</td></tr> |
| 145 |
<tr><td><b>Vibrato</b></td><td></td></tr> |
| 146 |
<tr><td>Delay</td><td>This is the amount of time to wait before activating the vibrato effect, if any</td></tr> |
| 147 |
<tr><td>Depth</td><td>This is how much the vibrato modifies the frequency of the note (0 = no vibrato)</td></tr> |
| 148 |
<tr><td>Speed</td><td>This is how fast the vibrato effect is. The smaller the number, the faste it goes</td></tr> |
| 149 |
<tr><td><b>Square</b></td><td></td></tr> |
| 150 |
<tr><td>Lower L.</td><td>Sets the lower limit for square relation modulation.</td></tr> |
| 151 |
<tr><td>Upper L.</td><td>Sets the upper limit for square relation modulation</td></tr> |
| 152 |
<tr><td>Speed</td><td>Sets the speed for square relation modulation</td></tr> |
| 153 |
<tr><td><b>Filter</b></td><td></td></tr> |
| 154 |
<tr><td>Lower L.</td><td>Sets the lower limit for filter modulation</td></tr> |
| 155 |
<tr><td>Upper L.</td><td>Sets the upper limit for filter modulation</td></tr> |
| 156 |
<tr><td>Speed</td><td>Sets the speed for filter modulation</td></tr> |
| 157 |
<tr><td><b>-</b></td><td></td></tr> |
| 158 |
<tr><td>Speed</td><td>Sets the speed at which the performance list is parsed</td></tr> |
| 159 |
<tr><td>Length</td><td>Sets the length of the performance list</td></tr> |
| 160 |
<tr><td>Hard Cut</td><td>Sets a cut-off time before a new note is played for a previous one to stop</td></tr> |
| 161 |
<tr><td>Rel. Cut</td><td>Toggles release cut</td></tr> |
| 162 |
</table> |
| 163 |
</p> |
| 164 |
<p> |
| 165 |
To the right of these parameters is the "performance list". This defines the waveforms |
| 166 |
and notes that make up the instrument. Like the tracks, it is made up of a list |
| 167 |
of notes and commands. The commands are similar, but slightly different to |
| 168 |
the track commands (see <a href="commandref.html">command reference</a>). |
| 169 |
</p> |
| 170 |
<p> |
| 171 |
Like in the track editor, Space toggles between "free play" and "edit" mode. In |
| 172 |
edit mode, you can insert notes into the performance list using the keyboard as |
| 173 |
a piano-style keyboard. You can toggle the "fixed" parameter next to any note |
| 174 |
by hitting enter while in edit mode. Fixed notes have an asterisk (*) next to them. |
| 175 |
Fixed notes always play at the frequency of the note in the performance list (so, |
| 176 |
if the performance list has "C#1*", that will always play the note C#1, no matter |
| 177 |
what note is in the main track. Unfixed notes are added to the main track note, |
| 178 |
for example, if an instrument has "C#1" at the first position of the performance |
| 179 |
list, and the track has "C-1 n", where n is the instrument number, the instrument |
| 180 |
will actually play "C#1". If the track had "D-3 n", the instrument would play |
| 181 |
"D#3", because C#1 is one semitone higher than C-1, so the final note is one |
| 182 |
semitone higher than the track note. |
| 183 |
</p> |
| 184 |
<br /> |
| 185 |
<a href="index.html">Back to index</a> |
| 186 |
</body> |
| 187 |
</html> |