home *** CD-ROM | disk | FTP | other *** search
/ Dave Lowe: Latest Version…itors Megaman XInfo File / Lowe_LatestVersionsOfMusicEditors_MegamanXInfoFile.img / GBOY / MANUALGB.DOC < prev   
Encoding:
Text File  |  1994-10-31  |  19.6 KB  |  581 lines

  1. ******************************************************************************
  2.                   NINTENDO GAMEBOY EDITOR Version 3.1
  3. ******************************************************************************
  4.  
  5. NEW FEATURES IN THIS VERSION
  6.  
  7. 3.1  Release date 31/10/94
  8. --------------------------
  9. 1. Bug in track plot cured.
  10.  
  11. 2. Bug causing clock to start after ALT L cured.
  12.  
  13. 3. 'ALT X' added to convert GAMEBOY format .SND file to GAMEGEAR format.
  14. Procedure is:a) Alt L to load in GAMEBOY file b) Alt X to convert c)Alt S to
  15. Save (use NEW filename to avoid writing over GAMEBOY file).
  16.  
  17. 4. Auto parallel port detection of comms. board (allows you to use any of LPT1
  18. 2 or 3). If comms. board is found the port number is displayed on screen.
  19.  
  20. 5. Bug causing editor screen to appear blank if entered from Windows in
  21. windowed mode cured.
  22.  
  23.  
  24.  
  25.  
  26. 3.0  Release date 22/08/94
  27. --------------------------
  28. 1. New command 'I' (Info toggle) toggles between note names and note values.
  29.  
  30. 2. New pan/note length display.
  31.  
  32. 3. Keyboard repeat speed forced to maximum for quick movement while editing.
  33.  
  34. 4. 'END', 'CTRL HOME' and 'CTRL END' added to move to start/end of current
  35. column data.
  36.  
  37. 5. New tiny format adopted - new commands are ALT A (Add column), ALT E
  38. (expand column). ALT C (Compress file) can now be used at any time.
  39.  
  40. 6. New max limits:
  41. 256 effects ($00-$FF)
  42. 256 tables  ($00-$FF)
  43. 256 voices  ($00-$FF)
  44. 256 subs    ($00-$FF)
  45. 128 tracks  ($00-$7F)
  46.  
  47. 7. Info box added, showing: current file size, Comms board & Download status.
  48.  
  49. 8. ALT V toggles verify of download (this takes more time, but is useful if
  50. you think there may be problems with your ESYS unit)
  51.  
  52. 9. Drumbend voice special added ($40). Note1 value gives amount & direction.
  53.  
  54. 10. ALT F/ ALT N Find & find Next added.
  55.  
  56. 11. All downloads to console now verified. Single byte edits are still sent to
  57. the console immediately, but any block edits (C/R/A/ALT A/ALT C/ALT E) are
  58. only updated on the PC. When the next 'Play' command is sent, the console is
  59. updated and the new data verified. This ensures:
  60. a) On-screen editing is always as quick as possible.
  61. b) The data is only sent and verified when next needed. If your ESYS has any
  62. problems downloading you will know straight away (normally you can just try
  63. downloading straight away unless a hardware problem has occurred).
  64.  
  65.  
  66.  
  67.  
  68. 2.3 Release date ??/05/93
  69. -------------------------
  70. 1. General updates for file management and screen layout.
  71. 2. Global Offset added for key changes.
  72. 3. 'Instant' screen updates bypassing BIOS.
  73.  
  74.  
  75.  
  76.  
  77. 2.2 Internal Release Only
  78. -------------------------
  79. 1. Spidersoft bugs removed in ESYS routines after bug report on 11/12/92.
  80.  
  81.  
  82.  
  83.  
  84. 2.1 Release date 30/11/92
  85. -------------------------
  86. 1. Directory re-shown after saves.
  87. 2. Effect & Fxtable limits both increased to 80.
  88. 3. Bug removed when compressing subroutines grester than 60h.
  89. 4. Master limit increased to 24.
  90. 5. Improved override of effects over music.
  91. 6. Voice atklvl special added.
  92. 7. Bug ignoring subroutines over 80h cured.
  93. 8. Complex Lo effect special added.
  94. 9. Automatic file limits calculated for each load/compression.
  95. 10.Voice limit increased to 64.
  96. 11.Arpeggio voice special added.
  97.  
  98.  
  99.  
  100.  
  101. 2.0 Release date 25/09/1992
  102. ----------------------------
  103. 1. Default tempo not reset to 125bpm on playing a new master.
  104. 2. Swap nibbles effect special added.
  105. 3. Waver effect special improved.
  106. 4. Mask input for directory.
  107. 5. Directory allows multiple columns to display up to 100 filenames.
  108. 6. Sub-directories filtered out from directory listing.
  109. 7. Music file compression added.
  110. 8. Sound effect table call with priority settings.
  111. 9. New editor layout to include table column and effect readout.
  112. 10.New format music files to accommodate effect table (old files no longer
  113. work).
  114.  
  115.  
  116.  
  117.  
  118. 1.4 Internal release only
  119. -------------------------
  120. Gate reset to FF at the start of each new subroutine.
  121. Stereo display on editor screen.
  122. Offset parameter added to music voices for instant transpose.
  123. Stereo effects/stereo noise added.
  124. Lowest Gameboy note (24h=C1=65Hz) limit now plotted correctly.
  125. Error beeps rationalised (on error or any unknown key)
  126. Shadow on directory listing.
  127.  
  128.  
  129.  
  130.  
  131. 1.3 Release date 03/09/1992
  132. ---------------------------
  133. Gate subroutine parameter added to allow staccato phrasing.
  134. Tied note subroutine parameter added for legato phrasing.
  135. Directory shown on load/save.
  136. More accurate realtime clock.
  137. Stereo placement (left/centre/right) for each music voice.
  138. New notetable - MIDI notes from 24h (C1 65Hz) to 7Fh (F#8 11839Hz).
  139. New noise frequency table - smoother sweeps.
  140.  
  141.  
  142.  
  143.  
  144. 1.2 Internal release only
  145. -------------------------
  146. Selectable pulse width waves in all 3 channels.
  147. Uses 'No' option from ESC to re-initialise and show version number.
  148. Current filename remembered correctly after re-initialisation.
  149. Limits properly enabled in Gameboy driver for up to 64 effects/ 32 voices.
  150. Bug causing crash when copying track cured.
  151. All ESYS error crashes trapped.
  152.  
  153.  
  154. 1.1 Release date 18/08/1992
  155. ---------------------------
  156. Version number on top right of PC screen.
  157. ESYS crashes greatly reduced.
  158. Garbage error on PC screen cured.
  159. Tempo values calculated on PC top line display when music is running.
  160. With no tempo commands, music now defaults to 125bpm.
  161.  
  162.  
  163.  
  164.  
  165. 1.0 Release date 15/08/1992
  166. ---------------------------
  167. Initial release with ESYS bugs.
  168.  
  169.  
  170.  
  171.  
  172. ------------------------------------------------------------------------------
  173. FUNCTIONS
  174.  
  175. ESC              Escape from editor ('no' option re-initialises ESYS)
  176. Alt A            Add a column at the cursor position
  177. Alt C            Compress a music file
  178. Alt D            Download current music file
  179. Alt E            Expand a compressed column to full size
  180. Alt F            Find 1 or 2 hex bytes
  181. Alt L            Load a music file
  182. Alt N            find Next matching hex byte
  183. Alt O            download On/Off
  184. Alt S            Save a music file
  185. Alt T            Time signature (e.g. 0006/0008 for 6/8)
  186. Alt X            convert GameBoy to GameGear .SND format
  187. Return/Enter     Play current music track
  188. Spacebar         Stop all music/effects
  189. F                Fade music (uses value 84h)
  190. I                Info switch (toggle between note name/ note value display
  191. K                Keymode (toggle between sharps and flats)
  192. S                Play current SFX effect (use when editing a single sound)
  193. T                play current TAB effect (for channel allocated sounds)
  194.  
  195.  
  196. MOVEMENT
  197.  
  198. Home             Move cursor to top of column
  199. Ctrl Home        Move cursor to beginning of column data
  200. End              Move cursor to bottom of column
  201. Ctrl End         Move cursor to end of column data
  202. Right & Left     Change edit column
  203. Up & Page Up     Move cursor up
  204. Down & Page Down Move cursor down
  205.  
  206. + & Shift +      Channel up
  207. - & Shift -      Channel down
  208.  
  209. [ & ]            Play up/down
  210. P                Play (using setting above)
  211.  
  212.  
  213. EDITING
  214.  
  215. < & >            Up/Down current parameter
  216. Keypad *         Zero current parameter
  217.  
  218. D                Down 1 octave for current parameter
  219. U                Up 1 octave for current parameter
  220. 1/2/4/8          Bitflip current parameter
  221.  
  222. Insert           Insert a byte at current cursor position
  223. Delete           Delete a byte at current cursor position
  224.  
  225.  
  226. BLOCK
  227.  
  228. C                Copy current column into buffer
  229. R                Replace current column with buffer
  230. A                Append buffer to current column
  231.  
  232.  
  233.  
  234.  
  235. GAMEBOY FUNCTIONS
  236.  
  237. To help test the music files, several keys have been set up on the Gameboy,
  238. as follows:
  239.  
  240. UP/DOWN          Increment/Decrement current call number.
  241. A                Select Music call.
  242. B                Select Effect call.
  243. SELECT           Stop music/effects.
  244. START            Start music/effect.
  245.  
  246.  
  247.  
  248.  
  249. SOUND EFFECT PARAMETERS (SFX)
  250.  
  251. atkdec           Attack 00-0F/ Decay 00-0F
  252.  
  253. susrel           Sustain 00-0F/ Release 00-0F
  254.  
  255. atkcnt           length of atkdec portion
  256.  
  257. endcnt           length of susrel portion (FF=continuous)
  258.  
  259. wve ad           A/D wave (see waveform table)
  260.  
  261. wve sr           S/R wave (see waveform table)
  262.  
  263. freqhi           High byte of start frequency (00-FF only 00-07 used)
  264.  
  265. freqlo           Low byte of start frequency (00-FF)
  266.  
  267. bend             Bend type 00-09 (see below)
  268.  
  269. bendhi           High byte of bend
  270.  
  271. bendlo           Low byte of bend
  272.  
  273. stereo           Stereo placement (10=left/11=centre/01=right)
  274.  
  275. specls           Specials (see below)
  276.  
  277. newcnt           Extra counter used by specials (see below)
  278.  
  279. newfhi           Extra freqhi used by specials (see below)
  280.  
  281. newflo           Extra freqlo used by specials (see below)
  282.  
  283.  
  284. EFFECT SPECIALS
  285.  
  286. 01               Swap bytes (freqhi/freqlo swapped every frame)
  287.  
  288. 02               Complex Hi (freqhi - bendhi/ eor with newfhi)
  289.  
  290. 04               Waver      (adds small random to freqlo every frame)
  291.  
  292. 08               Reload     (freqhi reloaded with newfhi after each newcnt)
  293.  
  294. 10               Swap nibbles (freqlo nibbles swapped every frame)
  295.  
  296. 20               Complex Lo (freqlo - bendlo/ eor with newflo)
  297.  
  298.  
  299.  
  300. EFFECT BEND TABLE
  301.  
  302. 00               No bend
  303. 01               Up
  304. 02               Down
  305. 03               Up start              (only during atkcnt)
  306. 04               Down start
  307. 05               Up/down               (up during atkcnt/down during endcnt)
  308. 06               Down/up
  309. 07               Up release            (only during endcnt)
  310. 08               Down release
  311. 09               Up/down cycle         (changes direction every newcnt)
  312.  
  313. EFFECT TABLE PARAMETERS (TAB)
  314.  
  315. prior             priority 0 (highest) to FF (lowest)
  316.  
  317. chan0             sfx to be called in channel 0 (FF=unused)
  318.  
  319. chan1             sfx to be called in channel 1 (FF=unused)
  320.  
  321. chan2             sfx to be called in channel 2 (FF=unused)
  322.  
  323.  
  324. MUSIC VOICE PARAMETERS (VCE)
  325.  
  326. atkdec            Attack time 00-0F/ Decay time 00-0F
  327.  
  328. susrel            Sustain level 00-0F/ Release time 00-0F
  329.  
  330. wvefrm            Waveform (see waveform table)
  331.  
  332. specls            Specials (see waveform table)
  333.  
  334. stereo            Stereo placement (10=left/11=centre/01=right)
  335.  
  336. offset            signed Offset to note (e.g. 0C=up 1 octave/FF=down 1 note)
  337.  
  338. atklvl            Attack peak level 00-0F (can be used to set overall volume)
  339.  
  340. atkcnt            Attack count 00-03
  341.  
  342. atkwve            Attack wave (see waveform table)
  343.  
  344. note 1/2/3/4      Used by chord/atkwave/atknote specials
  345.  
  346. trills            Used by trill special
  347.  
  348. vibrto            Vibrato presets 00-12h (0=off)
  349.  
  350. vdelay            Vibrato delay 00-FF (in frames)
  351.  
  352.  
  353. VOICE SPECIALS
  354.  
  355. 01                Arpeggio   (uses Note 1/2/3/4 values at half chord speed)
  356.  
  357. 02                Trill note (alternating with normal note)
  358.                   24-7F/80-FF Normally used with drum sounds.
  359.  
  360. 04                Drum       (wave alternates with voice/freq bend down)
  361.  
  362. 08                Chord      (uses Note 1/2/3/4 values)
  363.  
  364. 10                Atk wave   (Used instead of Wavfrm during Atkcnt)
  365.                   Normally used with 81h value for noise 'chiff' attack.
  366.  
  367. 20                Atk note   (used instead of normal note during Atkcnt)
  368.  
  369. 40                DrumBend (note1 sets amount & direction)
  370.  
  371. 80                Fixed      (unaffected by global offsets e.g. for drums)
  372.  
  373.  
  374. NOTE 1/2/3/4 VALUES
  375.  
  376. 24-7F fixed notes    (e.g. 3C = C3 = middle C)
  377. 80-BF offsets higher (e.g. 8C = 12 up = 1 octave higher)
  378. C0-FF offsets lower  (e.g. C7 = 7 down = perfect 5th lower)
  379.  
  380.  
  381. WAVEFORM TABLE
  382.  
  383. 01                gate on
  384. 40                pulse width 12.5%
  385. 50                pulse width 25%
  386. 60                pulse width 50% (square)
  387. 70                pulse width 75% (sounds identical to 25%)
  388. 80                noise
  389.  
  390. N.B. Noise & pulse waves may be used simultaneously.
  391.  
  392.  
  393. SUBROUTINE PARAMETERS
  394.  
  395. BYTE 1            BYTE 2                DETAILS
  396.  
  397. 24-7F NOTE        00-7F duration        normal note pair
  398.  
  399.  
  400. 80    VOICE       00-1F voice number    change to new voice
  401.  
  402.  
  403. 81    REST        00-7F duration        ADSR is set to release
  404.  
  405.  
  406. 82    BEND        00-7F bend up         reset to 0 with next note
  407.                   80-FF bend down       (use '8' to set up/down)
  408.  
  409. 83    TEMPO       01-FF value           global tempo (default is 6C = 125bpm)
  410.  
  411.  
  412. 84    TIED        0     (dummy)         the following note pair is legato
  413.  
  414.  
  415. 85    GATE        00-FF length          notes gated off (released) at length
  416.  
  417.  
  418. 86    GLBOF       00-FF signed offset   global key change
  419.  
  420.  
  421. FF    END         -                     End of subroutine
  422.  
  423.  
  424. N.B. When using frequency effects in combination, please note that the Trill
  425. and Chord specials override all vibrato and bend settings. For minimum Gameboy
  426. processor usage set Vibrto=0/ Vdelay=FF when using these specials.
  427.  
  428.  
  429. MASTER PARAMETERS
  430.  
  431. BYTE 1              BYTE 2              DETAILS
  432.  
  433. 00-3F no. of times  00-BF sequence no.  normal subroutine pair
  434.  
  435.  
  436. 40    loop end      -                   use only after loop start
  437.  
  438.  
  439. 41-7F loop start    -                   e.g. 46 = loop 6 times
  440.  
  441.  
  442. FD    fade          00-FF time          start fade in all channels
  443.  
  444.  
  445. FE    end           00    (dummy)       end in all channels
  446.  
  447.  
  448. FF    loop channel  00-5F loop point    loop channel to any step
  449.                                         e.g. FF/02=loop to step 02
  450.  
  451.  
  452.  
  453.  
  454. APPENDIX A - NOTE VALUES
  455.  
  456. NAME           NORMAL         DOTTED         DOUBLE DOT     TRIPLET
  457.  
  458. Semibreve      30h            48h            54h            20h
  459.  
  460. Minim          18h            24h            2Ah            10h
  461.  
  462. Crotchet       0Ch            12h            15h            08h
  463.  
  464. Quaver         06h            09h            -              04h
  465.  
  466. Semiquaver     03h            -              -              02h
  467.  
  468. Demisemiquaver 2/2/1/1        -              -              01h
  469.  
  470.  
  471.  
  472. APPENDIX B - FILE COMPRESSION/ TESTING
  473.  
  474. 1. Compressing music files is a simple matter of a keypress, but to get the
  475. most efficient compression the following should be noted:
  476.  
  477.  a) Effects, Table and Voices are each scanned from the highest to the lowest
  478.  for the first non-zero entry.
  479.  
  480.  b) Subroutines are each scanned from the lowest to the highest existing for
  481.  any non-zero bytes.
  482.  
  483.  c) Masters are scanned from 00 to the current highest, stopping at the first
  484.  non-zero step 00 in channel 0. You can use this fact to allow temporary edit
  485.  masters used for perfecting later sections of music - either leave a blank
  486.  master before your  temporary ones, or temporarily insert a 00 byte at step
  487.  00/ channel 00 of the first undesired master before  compressing the file.
  488.  
  489.  
  490.  
  491.  
  492. APPENDIX C - HINTS AND TIPS
  493.  
  494. 1. The easiest way to set up a project is to add the path of the Gameboy
  495. Editor to your AUTOEXEC.BAT file. You can then create a directory for each
  496. new project. Move to this directory and then use the 'M' command. The driver
  497. and editor will then be loaded, but only the project files will show when
  498. using Load and Save, making it far easier to manage filenames.
  499.  
  500. 2. Always leave SFX 00 as silence, and leave TAB 00 as 00/00/00/00. This will
  501. ensure that effect call 00 = kill all sound effects. Similarly, leave priority
  502. 00 for this call only, and give the highest priority effect a value of 01.
  503.  
  504. 3. Always make subroutine 00 a bar's rest - the quickest way to declare this
  505. is 81 30 FF for a 4/4 time signature. Empty masters will then be read as
  506. silence, which lets you hear individual channels. In the same way, by
  507. temporarily inserting two 00 bytes at the start of a master channel you can
  508. mute that channel (useful when tracking down rogue notes).
  509.  
  510. 4. Use higher unused masters for writing a later section of music. Once
  511. perfected, use COPY and APPEND with each channel in turn to add the completed
  512. section to the main piece.
  513.  
  514. 5. To abort a Load or Save, press Return with a blank filename. This is also
  515. useful for viewing the directory only.
  516.  
  517. 6. To transfer a single voice, subroutine or master from another music file,
  518. save your current file, load in the other file and use 'C' (copy) in the
  519. desired place. Then re-load your current file and use 'R' (replace) to
  520. transfer.
  521.  
  522. 7. Often, improvements to percussion sounds involve changing the note value.
  523. By setting all percussion notes to 3C (middle C) the actual pitch of each
  524. sound can be universally set using offset, making global changes to the sound
  525. far easier.
  526.  
  527. 8. Alt D (Download) is a useful command if you ever get a stray ESYS error.
  528. Assuming this is a single misread, and no further errors occur, by downloading
  529. the complete music file again it ensures that the Gameboy holds exactly the
  530. same information as the PC music file.
  531.  
  532. 9. The default tempo is set to 125bpm when the Gameboy is first initialised.
  533. This is a global setting, and any music played will use the current value
  534. (shown on the top line of the editor). Using a tempo command changes the
  535. global setting permanently until another tempo command is found. This is
  536. useful when working with many sections from one piece of music - as long as
  537. the main piece sets the tempo initially, every test master will use this
  538. global setting, removing the need to add extraneous tempo bytes just to try
  539. out all the sections at the correct tempo.
  540.  
  541. 10. Do ensure that each finished tune has its own tempo command as the first
  542. command in one of the channels. Don't rely on the first piece setting it for
  543. any others - it may not be the first piece to be played!
  544.  
  545. 11. Chord specials - By setting the 80 offset bit of each note you can produce
  546. a chord 'shape' which can then be used universally e.g. set 80 84 87 8C for a
  547. root position major chord. Then in a subroutine , a C3 plays C major, a D3
  548. plays D major etc. By doing this, you should find that you need far less
  549. chord voices. By setting both the 80 and 40 bits an offset down is set. This
  550. is  useful for retaining the correct subroutine note value when inversions are
  551. used e.g. C5 80 83 87 plays G/C/E/G or C minor, 2nd inversion. The advantage
  552. of this is that the correct subroutine note is retained, so that in a
  553. subroutine a 'C' will always indicate some sort of 'C' chord.
  554.  
  555. 12. The battery backup supply in the ESYS unit will retain the driver and
  556. latest music data for years if left undisturbed. It is quite unnecessary to
  557. download the driver every time you want to use the editor. However, one
  558. precaution needs to be taken. The PC will initialise its parallel port
  559. whenever you switch it on - this unfortunately corrupts the ESYS data if the
  560. Gameboy is not switched on at the time. However, if you switch on the Gameboy
  561. before the PC, it will safely retain its data. When actively working on a
  562. project, it is far easier just to load the editor each time.
  563.  
  564. 13. The Arpeggio voice special is a half speed version of the Chord special.
  565. Since the chord 'note speed' is a high 64Hz, it can sound distorted,
  566. particularly with low notes - the Arpeggio will often improve the overall
  567. sound.
  568.  
  569. 14. If you accidentally set the tempo to 000, the notes will never get updated,
  570. and resetting the tempo to a higher value will now work. To recover from this
  571. condition press 'B' on the gameboy to Re-Initialise the sound driver (this will
  572. reset the global tempo to 125bpm.
  573.  
  574. 15. Echo effects in music can be achieved by the following method. Play the
  575. first note using the desired voice, and then copy this voice to a vacant slot.
  576. Give the new voice an envelope like 0C/0C, and change the wvefrm setting from
  577. gate on to gate off e.g. from 61h to 60h. The following notes using this new
  578. voice will contine this envelope as it fades away. The same effect can also be
  579. achieved by using the existing voice but making all subsequent notes tied, but
  580. this often produces much longer subroutines and degrades readability.
  581.