README

   1  _____                        _
   2  | + _)_      ___      ______| |___
   3  |   /(_) ___| +_|____| - >- > | +_|
   4  /  | | ||   \  \  -  |_ |  |  |  \
   5 /___| |_||_|__\__\_____|_|__|__|\__\
   6
   7 ++o0-0o++o0-0o++o0-0o++o0-0o++o0-0o++o0-0o++o0-0o++o0-0o++o0-0o++o0-0o+o0-0o+
   8
   9 Most of this tracker was written by lft to run on an AVR. Here is his page for
  10 the project: http://www.linusakesson.net/hardware/chiptune.php
  11
  12 I hope he doesn't mind us using the code.. right now we are just trying to make
  13 it usable to the average vi-user :-)
  14
  15 If you are used to vi you will be quite comfortable. Beware that we have not
  16 implemented some features (like undo!) that may seem second nature to you,
  17 and living without them might be hard for a while. We also have a number of
  18 keys that aren't in vi but we have tried to make them vi-like enough to be
  19 included in pineapple tracker.
  20
  21 Look at our SPEC file for a command reference. Not everything is implemented,
  22 yet... it's just a specification!
  23
  24
  25
  26 below is the original README:
  27
  28 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  29
  30
  31 Hi!
  32
  33 This is the tracker I used in the hardware chiptune project
  34 (http://www.linusakesson.net/hardware/chiptune.php). It was never intended to
  35 be used by anyone other than me, so it's not exactly user friendly.
  36
  37 This is a quick documentation attempt.
  38
  39 You have to give the tracker a file name when you're starting it. So type
  40 "./tracker test2.song" to start working on the existing song, or type e.g.
  41 "./tracker my_song.song" to start from scratch. Although the GUI hints that you
  42 can later press ^F to change the file name, this was never implemented.
  43
  44 Once you've started the tracker, you'll see that the screen is divided into
  45 three sections: song, track and instrument. Use TAB to move between these
  46 sections. Alternatively, if you're in the song section and the cursor is on a
  47 track identifier, you can press ` (backquote) to start editing this track.
  48
  49 Use { and } to change the current track, and [ and ] to change the current
  50 instrument. Use enter to start playing the current track (in the track section)
  51 or the song (in the song section). Use space to stop playing or to enter edit
  52 mode.
  53
  54 Use < and > to change the current octave. The main part of the keyboard is used
  55 to enter notes. The keyboard layout is adapted for a US qwerty keymap. You can
  56 edit gui.c to change this to fit a Dvorak keymap instead.
  57
  58 Press ^E (control-E) to exit without saving. Press ^W ("write") to save. Press
  59 # to optimize the song (remove unused tracks, move tracks together) and % to
  60 export the song into a packed format. (% will always export to two files called
  61 "exported.s" and "exported.h" in the current working directory).
  62
  63 In the song and instrument editors, use capital A, I and D to add, insert and
  64 delete lines. In the track and instrument editors, use capital C and V for copy
  65 and paste.
  66
  67 A line in the instrument editor is either a command, a relative note or an
  68 absolute note. Relative notes are indicated by + in the command column,
  69 absolute notes by =. Commands in the instrument editor are the same as commands
  70 in the track editor.
  71
  72 The available commands are:
  73
  74         dxx Set duty cycle (pulse width) to xx.
  75         fxx Set volume fade speed to xx. So, fff is a slow fadeout, f01 is a slow fadein.
  76         ixx Set channel inertia. A high inertia causes automatic slides between notes. Default 0.
  77         @xx jump to instrument line xx. Used to create arpeggio loops.
  78                 Warning: The loop must contain a delay element (t command), otherwise you'll crash the software.
  79         sxx Set Slide. So, lff is a slow slide down, l01 is a slow slide up.
  80         mxx Set pulse width modulation rate to xx.
  81         txx Wait xx time units.
  82         vxx Set channel volume to xx.
  83         wxx Set waveform. 00 = triangle, 01 = saw, 02 = pulse, 03 = noise.
  84         ~xy Set vibrato. x = depth, y = rate.
  85
  86 Investigate test2.song, and play around, and you'll probably get the hang of
  87 things! Remember that the packed format only supports one command per track
  88 line (see homepage).
  89
  90 Good luck!
  91
  92 Linus (lft^kryo)