home *** CD-ROM | disk | FTP | other *** search
/ Large Pack of OldSkool DOS MOD Trackers / beaversweeper_v101.zip / manualv1.0.txt < prev    next >
Text File  |  2005-10-24  |  7KB  |  216 lines
  1. Beaver Sweeper manual 1.0
  2. -----------------------------------------------
  3. Auth: gnilk
  4. Date: 2002-09-18
  5. Version: 1.0
  6.  
  7. Userinterface comments:        gnilk
  8. Synth and sound generation:    steffo
  9. Player and sound output:    zyrax
  10.  
  11. Contact us through appropriate channels...
  12.  
  13. Updates: 
  14. --------
  15.        Date    | who      | desc
  16.     -----------|----------|---------------------------------------------------
  17.     2005-10-23 | gnilk    | Added some stuff
  18.     2002-10-16 | gnilk    | negative transpose values now displayed correctly
  19.                             tiny information about sequencer/pattern columns
  20.  
  21.  
  22.  
  23. Bugs:
  24. -----
  25. - Does crash quite randomly, probably due to thread synchronization issues
  26.   The source is there, change if you want, we dont anymore..
  27.  
  28. Keyboard shortcuts in trackerview
  29. ---------------------------------------------------------------------------
  30.  
  31. General:
  32.  
  33. CTRL-UP        switch between pattern/sequencer editor
  34. CTRL-DOWN    switch between pattern/sequencer editor
  35. RSHIFT-TAB    switch between pattern/sequencer editor
  36.  
  37. F7        start play
  38. F8        stop play
  39.  
  40. In sequencer view:
  41. --------------------
  42.  
  43. HOME        move to top position of sequencer
  44. END            move to last position of sequencer
  45.  
  46. UP            move one position up
  47.  
  48. DOWN        move one position down
  49.  
  50. RIGHT        move one position right, within the column
  51. CTRL-RIGHT    move one column right
  52.  
  53. LEFT        move one position left, within the column
  54. CTRL-LEFT    move one column left
  55.  
  56. PAGE-UP        move 16 positions up
  57. PAGE-DOWN     move 16 positions down
  58.  
  59. TAB            forward one column
  60. LSHIFT-TAB    back one column
  61.  
  62. DELETE        delete data in current column
  63.  
  64. ----------------------------------------------------------
  65.  
  66. In patternview:
  67. -------------------------
  68. F1        octave 0
  69. F2        octave 1
  70. F3        octave 2
  71. F4        octave 3
  72. F5        octave 4
  73.  
  74.  
  75. HOME        move to top position of pattern
  76. END            move to last position of pattern
  77.  
  78. UP            move add-num up, default this is one position up
  79.  
  80. DOWN        move add-num down, default this is one position down
  81.  
  82. RIGHT        move one position right, within the column
  83. CTRL-RIGHT    move one column right
  84.  
  85. LEFT        move one position left, within the column
  86. CTRL-LEFT    move one column left
  87.  
  88. PAGE-UP        move 16 positions up
  89. PAGE-DOWN     move 16 positions down
  90.  
  91. TAB            forward one column
  92. LSHIFT-TAB    back one column
  93.  
  94. DELETE        delete note at position
  95. CTRL-DELETE    delete note and effect at column
  96.  
  97. CTRL-B        begin marking of block, use cursor movments to control block marking
  98. CTRL-C        copy block
  99. CTRL-V        paste block
  100. CTRL-K        truncate pattern
  101. CTRL-I        interpolate effect column at cursor in block, between blockstart fx value and blockend value
  102. CTRL-E        double length of pattern, use CTRL-K to fine tune pattern length
  103.             wont look nice if you extend above 255 (0xff) positions, the limit is set to 65536
  104.  
  105. note editing is classic tracking editor keyboard setting
  106.  
  107. normal notes:
  108.     ZSXDCVGBHNJM,L.Q2W3ER5T6Y7UI9O0P
  109. raised notes:
  110.     0123456789ABCDEF
  111. special
  112. \        note off
  113. --------------------------------------------------------------------
  114. Short notes for the sequencer
  115. -----------------------------
  116. There exists two types of speeds. The main speed is global for the sequencer
  117. each sequencer channel has a pattern. The pattern speed is induvidual for
  118. every sequencer channel.
  119. This might be confusing at first, but thats how it works. You set the
  120. speed for the sequencer then you set the speed in the patterns.
  121.  
  122. ------------------------------------------------------------------------------
  123. 00 |  nn  xx yy p1 p2 p3 00 00 00 | nn  xx yy p1 p2 p3 00 00 00 | nn  xx yy...
  124. 01 |  nn  xx yy p1 p2 p3 00 00 00 | nn  xx yy p1 p2 p3 00 00 00 | nn  xx yy...
  125.  
  126.  
  127.   nn - pattern number for to be player for this sequencer position
  128.   xx - Tranpose (00-7f  positive transpose,  80-ff  negative transpose)
  129.   yy - Effect
  130.   p1 - Parameter 1 for effect
  131.   p2 - Parameter 2 for effect
  132.   p3 - Parameter 3 for effect
  133.  
  134. The zeros are for further use, and should not be used... 
  135. The effects and their parameters are subject to documentation.
  136.  
  137. Short notes for the patterns
  138. -----------------------------------------------------------------------------
  139. 00|--- vv fx p1|--- vv fx p1|--- vv fx p1|--- vv fx p1|--- vv fx p1|...
  140. 01|--- vv fx p1|--- vv fx p1|--- vv fx p1|--- vv fx p1|--- vv fx p1|...
  141. 02|....
  142.  
  143.    --- : Insert note the normal "tracker" way
  144.    vv  : velocity
  145.    fx  : effect
  146.    p1  : parameter
  147.  
  148.  
  149. Known effects:
  150. --------------
  151.     - ff    - Set pattern tick speed
  152.  
  153. ===========================================================================
  154. !!!!!!!The effects and their parameters are subject to documentation!!!!!!!
  155. ===========================================================================
  156. -> This is only for the pattern information, the synth is serialized, more
  157.    or less...
  158. -------------------------------
  159. File format, if you want it for some reason...
  160.  
  161. version
  162.         0103    
  163.                 * pattern and sequencer length is 16 bit
  164.  
  165. file layout:
  166.  
  167.     0        GOAT
  168.     4        version (0x0103)
  169.     6        number of seq channels
  170.     7        number of patterns
  171.     8           number of instruments
  172.     9           song BPM
  173.  
  174.     10           sequence tick per row
  175.     11           default pattern tick per row
  176.     12..        seq channel 0 of N in packed form
  177.     X..        Pattern 0 of N in packed form...
  178.  
  179. seqchannel data is stored as:
  180.     0        id of channel (which channel is this),
  181.     1        channel length (number of positions in channel)
  182.     3..    position data in packed form
  183.  
  184.     seq pos data is stored as:
  185.         flag, indicating (bit flags)
  186.         0        no data is stored for this position
  187.         1        pattern number is stored
  188.         2        transpose values is stored
  189.         4        fx parameter is stored
  190.         8        param1 of fx is stored
  191.         0x10    param2 of fx is stored
  192.         0x20    param3 of fx is stored
  193.             0x40    param1 of fx is stored
  194.         0x80    param2 of fx is stored
  195.             0x100    param3 of fx is stored
  196.     
  197.     flag is stored as word..
  198.       number of bytes indicated by the flags (each type has one byte)
  199.         max is: 9 bytes in the order: <pattern><trans><instr><param1><param2><param3><param1><param2><param3>
  200.  
  201.  
  202. pattern data is stored as:
  203.  
  204.     0        id of pattern, important: the sequencer will point to this number
  205.     1        length of pattern positions
  206.     3        data in packed form...
  207.     
  208.     each row in a pattern is stored as:
  209.  
  210.     0        flag, indicating which of the 16 channels that are used...
  211.                         if bit=1 pos data is available, bit 0 = pos 0, bit 1 = pos 1, bit 2 = pos 2.. (bit 0 = 0x01)
  212.  
  213.     4        the position data itself is not packed...
  214.             if position data is available it is stored as:
  215.             <note><velocity><fx><param>
  216.