==============================================================================

        GRAOUMF TRACKER 2
        Beta version 0.0019 (2012/05/20)

        (c) 1994-2008 Laurent de SORAS

        SHORT DOCUMENTATION

==============================================================================



GRAOUMF TRACKER
===============

Graoumf Tracker is a soundtracker. It contains a sequencer, sound synthetizer,
multi-effect processor and sample editor in the same program.



LEGAL
=====

This beta version of Graoumf Tracker 2 is FREEWARE. You can use it and
distribute it as you want.
But it is time limited. After the date displayed in the software, you won't be
allowed to save your work with this version. Try to get another beta version
on the Graoumf Tracker web site, or buy the final product.

Please send remarks, suggestions and bug report to:

laurent.de.soras@free.fr

Laurent de Soras
4 Avenue Alsace-Lorraine
92500 Rueil-Malmaison
France

Web:
http://ldesoras.free.fr
http://www.sourceforge.net/graoumftracker2



FEATURES
========

- 16 bits / 44.1 KHz / Stereo output
- 32-bit mixing engine (24 bit precision, plus 8 bit headroom).
- Up to 99 tracks.
- 4 types of tracks: Samples (classical), Effects (DSP), Audio In and MIDI.
- Mono / Stereo, 8 / 16 bits and memory / direct-2-disk samples
- Optional auto-panning for each sample
- Volume, tone, panning and filter envelopes, including 2 loops, a LFO and a
fadeout.
- Resonant filter for each instrument, with optional velocity control.
- Mixing parameters controled by both interface and score, can be stored
in presets
- Up to 255 instruments and 255 samples.
- 256 patterns, up to 256 lines in a pattern.
- Sequence can contain up to 999 pattern numbers.
- Possibility of linear interpolation on each track separately.
- 10 octaves and a half.
- Speed range from 1 to 255 ticks/line.
- Tempo range from 32 to 999 BPM, with a high accuracy (error < 1/1000 BPM),
allowing a very good synchro with external sound sources.
- About 80 commands of 4 digits, including standard FastTracker commands.
- Separate velocity column, with effects.
- Makes a soundfile from a module, using a reconstruction filter for
resampling (far better than linear interpolation)
- Real time powerful DSP effects with graphical control interface, including
a delay and a resonant filter.
- Sample formats: reads and saves WAV, AVR, AU and raw data.
- Module formats: reads GT2 (native), MOD, XM and DTM. Saves in GT2 format.
- Multiple backup files.
- Protracker-like GUI
- Skin support
- Customizable keyboard
- 500 levels Undo/Redo
- System friendly program (I hope so...)
- And more...



INSTALLATION
============

What do you need ?
- A PC or compatible
- Windows 2000, XP, Vista or 7
- Direct X 8.0 or later

Note: Theoretically, Graoumf Tracker 2 could run on Windows 95 or NT and
uses only Direct X 3 functionalities, but at the moment I can only compile
for Direct X 8 and above because of DirectInput. Requirements will be
lowered again as soon as I get rid of DI.

Graoumf Tracker need at least a resolution of 800x600 in 256 colors. Your
monitor should support it.
Final (or future beta) release will allow you to configure these parameters.

You must have at least the following files and directories:
- gfx/
- manual/
- changes.txt
- file_id.diz
- gt.exe
- pref.inf
- rsc01.rsc
- very_short_doc.txt



KNOWN BUGS
==========

This is a beta-version, so some bugs are still there:

- Keyboard errors: some keys are mapped incorrectly.
- There is other small bugs (mainly due to some missing code and unfinished
functions).

In your bug report, please give me:

- Your hardware configuration
- The softs running in background
- What you did before the bug, and what happened
- the "gt.log" file. This file is generated each time GT starts, and
information it contains can be very helpful.



TRACK TYPES
===========

There are 4 kinds of tracks:
- Samples: the classic ones. Each Sample track can play one mono or stereo
sample at a time, and this sample can be located in memory or on disk (Direct
To Disk).
- Effects: With them you can apply a digital sound effect on a group of
tracks, of any type you want (it allows you to cascade FX). The commands
allow you to control all the parameters of each effect (automation).
- Audio In (not implemented): Get the sound on your input device.
Combined with effect tracks, it allows you to turn your computer into a
powerful programmable real time effect processor.
- MIDI (not implemented): This is a special type of track for MIDI support.



COMMAND LIST
============

There are few ones... Every values are hexa-decimal. I do know that this is
not very easy-to-use, but it allows you to use ALL the possibilities of the
soundtracker, keeping a good compatibility with other formats.
Use these commands on Sample tracks, Effect tracks and Audio In tracks. Pitch
changes are ignored on the two last types of tracks.

01xx    Portamento up
02xx    Portamento down
03xx    Tone portamento
04xy    Vibrato
05xx    Tone portamento + Vibrato
06xy    Vibrato + Tone portamento
07xy    Tremolo
08xy    Detune
09xx    Note delay
0Axx    Cut note/Key off
0Bxx    Jump to position
0C0x    Set vibrato waveform
0Dxx    Break pattern
0E0x    Set tremolo waveform
0Fxx    Set global speed/Tempo
10xy    Arpeggio
11xx    Fine portamento up
12xx    Fine portamento down
13xy    Roll + Volume slide
14xx    Linear volume slide up
15xx    Linear volume slide down
16xx    Logarithmic volume slide up
17xx    Logarithmic volume slide down
18xx    Linear volume slide up + Tone portamento
19xx    Linear volume slide down + Tone portamento
1Axx    Logarithmic volume slide up + Tone portamento
1Bxx    Logarithmic volume slide down + Tone portamento
1Cxx    Linear volume slide up + Vibrato
1Dxx    Linear volume slide down + Vibrato
1Exx    Logarithmic volume slide up + Vibrato
1Fxx    Logarithmic volume slide down + Vibrato
2xxx    Set linear volume
3xxx    Set logarithmic volume
4xxx    Set balance
5xxx    Set linear master volume
6xxx    Set logarithmic master volume
7xyy    Roll
8zxy    Roll + Volume slide + Set balance
9xxx    Sample Offset
A0xx    Linear master volume slide up
A1xx    Linear master volume slide down
A4xx    Fine linear volume slide up
A5xx    Fine linear volume slide down
A6xx    Fine linear master volume slide up
A7xx    Fine linear master volume slide down
A8xx    Set number of ticks
A9xx    Set fine speed
AAxx    Pattern delay
ABxx    Extra fine tone portamento
ACxx    Extra fine portamento up
ADxx    Extra fine portamento down
AExx    Left balance move
AFxx    Right balance move
B0xy    Tremor
B1xx    Pattern loop
B2xx    Set flags
B3xx    Set Volume Envelope
B4xx    Set Tone Envelope
B5xx    Set Panning Envelope
B6xx    Set Cut-off Envelope
B7xx    Set Reso Envelope
B9xx    Demo Synchro
BAxx    Fine Sample Offset
BBxx    Very Fine Sample Offset
BCxx    Increment Sample Position
BDxx    Decrement Sample Position
BExx    Auto Tempo
BFxx    Auto Period
C1xx    Set mixing preset
C2xx    Set linear track volume
C3xx    Set Logarithmic track volume
C4xx    Linear track volume slide up
C5xx    Linear track volume slide down
C6xx    Logarithmic track volume slide up
C7xx    Logarithmic track volume slide down
C8xx    Fine Logarithmic track volume slide up
C9xx    Fine Logarithmic track volume slide down
CAxx    Set mixing preset on input tracks
CBxx    Add mixing preset to input tracks
CCxx    Change input track volume
CDxx    Change input track panning



EFFECT TRACK COMMAND LIST
=========================

These commands are for the Effects tracks. The list is not complete. To see
the full set of commands, right-click on the command column in a pattern.

General
-------

C100 xxyy   Add track yy of type xx to the effect. Types are:
            0 = samples, 1 = Audio in (not used), 2 = Effects
C200 xxyy   Remove track yy of type xx from the effect
C300 xxxx	Set effect preset xxxx
C400        Remove FX from track (to save CPU time when an effect is not in
            use).
C500        Mute input of FX, by settings the input volume of each track to 0.
C600 xxxx   Set effect stereo (for effect supporting both stereo and mono
            mode). The parameter is 0001 for stereo, 0002 for mono.

Mono delay
----------

0101        Delay On

0110 xxx.xx Set period (ms)
0111 xxx.xx Period increase (ms)
0112 xxx.xx Period decrease (ms)
0113 xxx.xx Fine period increase (ms)
0114 xxx.xx Fine period decrease (ms)
011D xxx.yy Set period corresponding to a MIDI note (xxx = note, yy = finetune)
011D 0xx.0y Set period corresponding to a note (xx = note (0 - 11), y = octave)
011F xxx.yy Set period to xxx/yy beats.

0120 xxx.xx Set Feedback (%)
0121 xxx.xx Feedback increase (%)
0122 xxx.xx Feedback decrease (%)
0123 xxx.xx Fine feedback increase (%)
0124 xxx.xx Fine feedback decrease (%)

(*** To be updated ***)



Mono/Stereo resonant filter
---------------------------

(*** To be updated ***)



Mono/Stereo distortion
----------------------

(*** To be updated ***)



KEYBOARD SHORTCUTS
==================

Movement in pattern
-------------------

Arrows: Move the cursor in the pattern
Tab: Next track
Shift + Tab: Previous track
Shift + Up arrow: previous bar
Page up: previous bar
Shift + Down arrow: next bar
Page down: next bar
F9-F12: jump to bar n
Home: jump to first pattern line
End: jump to last pattern line
Alt + Q, W, ... P: jump to column 1, 2, ... 10
Alt + A, S, ... ': jump to column 11, 12, ... 20
Same keys + Shift: column + 20
Same keys + Ctrl: column + 40

Shift + Left arrow: previous position
Shift + Right arrow: next position
Ctrl + Left arrow: previous preset
Ctrl + Right arrow: next preset

Editing
-------

Space: stop / edit

Alt + Left arrow: previous instrument
Alt + Rigth arrow: next instrument
Point on numpad: closest instrument on the cursor's track
Alt + Shift + Left arrow: previous sample
Alt + Shift + Right arrow: next sample

Esc: Next octave
Shift + Esc: Previous octave
Ctrl + G: increment step
Ctrl + Shift + G: decrement step

F1: Set block start
F2: Set block end

Ctrl + C: Copy selection
Ctrl + V: Paste selection
Ctrl + L: Select track under cursor. Pressing it twice selects the entire
pattern.
Ctrl + B: Mark top left of selection
Ctrl + E: Mark bottom right of selection

Backspace: delete note
Shift + Backspace: delete command
Alt + Backspace: delete velocity
Ctrl + Backspace: delete whole note

Ctrl + Z: Undo
Ctrl + Y: Redo

Numeric pad
-----------

F5: changes the numeric pad functionning mode, toggles between instrument
selection and drumpad.

Numeric pad keys except 0 and point: depending on the mode,
- selects an instrument,
- enters a drumpad note into the score or associate the note under the cursor
to the pressed key.
Same keys + Shift: same function, number + 15
Same keys + Ctrl: same function, number + 30
Same keys + Alt: in drumpad mode only, associates the note under the cursor
to the pressed key (possibily with + Shift and/or + Ctrl)

Misc
----

Numpad 0: play song
Shift + Numpad 0: play pattern
Ctrl + Numpad 0: continue song
Ctrl + Shift + Numpad 0: continue pattern
Return: Play the line at cursor position
Shift + Return: Play pattern context (all the first notes from cursor postion
up in the pattern)

Ctrl + D: change pattern display
Ctrl + I: activate/deactivate interpolation on the current track
Shift + Ctrl + I: activate/deactivate interpolation on all the sample tracks
Ctrl + 1 ... 8: Menu activation
Ctrl + S: Quick module save
Ctrl + Shift + S: Quick song save
Ctrl + O: Open module
Ctrl + Shift + O: Open song
Cltr + N: New module from scratch



HOW TO WORK WITH THE DIGITAL EFFECTS ?
======================================

First, add an Effect track (\Tools\Tracks menu).

Go to the Mix menu, select the Effect track: click on the left box in the
upper single line, which normally shows "AudioOut". Select "Effects,
wet part", and change the track number if it's necessary.
Add the tracks on which you want to apply the effect by moving the cursor
on them and click "Insert trk". The new tracks appears now in the lower
window. You can add all tracks you want (except MIDI tracks). Remove the
unwanted by right-clicking on them in the Type column.

Then go in the FX menu. Select the effect you want to apply. Do the settings
(check the "real time" box to hear your modifications in... real time).

In the track patterns, you can modify the settings with the commands (see
above). You can recall recorded presets with the C300 xxxx command. You can
also recall a mix preset with the C1xx command (right column, with dots).
