home *** CD-ROM | disk | FTP | other *** search
/ Dave Lowe: Latest Version…itors Megaman XInfo File / Lowe_LatestVersionsOfMusicEditors_MegamanXInfoFile.img / GBOY / GBOY30.DOC < prev    next >
Encoding:
Text File  |  1994-08-31  |  3.1 KB  |  97 lines
  1. -------------------------------------------------------------------------------
  2. NINTENDO GAMEBOY MUSIC DRIVER - (c) Martin Walker 1992/1993/1994
  3. -------------------------------------------------------------------------------
  4.  
  5. DEVELOPERS MANUAL - UPDATED:
  6.  
  7. 25/07/94 - Driver updated to version 3.0/ RAM usage 226 bytes
  8. 27/05/93 - Driver updated to version 2.4
  9.  
  10.  
  11.  
  12.  
  13. ------------------------------------------------------------------------------
  14. DEMOING THE MUSIC/ EFFECTS
  15. ------------------------------------------------------------------------------
  16.  
  17. To help test the music files, a file named 'GBOYMUS.ROM' may be supplied.
  18. You can download this to the GAMEBOY at address 0000h for a demo of the music
  19. and effects. The GAMEBOY keys to use are as follows:
  20.  
  21. UP/DOWN           Increment/Decrement current call number.
  22. A                 Select Music call (default).
  23. B                 Select Effect call.
  24. SELECT            Stop music/effects.
  25. START             Start music/effect.
  26.  
  27.  
  28.  
  29. ------------------------------------------------------------------------------
  30. OVERVIEW & CONTENTS OF DRIVER FILE
  31. -------------------------------------------------------------------------------
  32.  
  33. The players and self contained music/effect data are in the  form of pure
  34. object code with no headers (for minimum size and maximum portability).
  35. They  are assembled to any address specified by the customer.
  36.  
  37.  
  38.  
  39. Each  driver  has its calls at the beginning,  as follows:
  40.  
  41. START OF ROM (CARTRIDGE) DATA:
  42. INITSND        equ  00
  43. INTSND         equ  03
  44. NEWLOAD        equ  06
  45.  
  46. START OF RAM (WORKSPACE) DATA: (CURRENT USAGE 226 BYTES)
  47. SFXNO          equ  00
  48. TUNENO         equ  01
  49. STATUS         equ  02
  50.  
  51.  
  52. ------------------------------------------------------------------------------
  53. INSTALLING THE DRIVER INTO THE GAME
  54. ------------------------------------------------------------------------------
  55.  
  56. 1. The player needs to be initialised once only on starting the game. This
  57. sets up the initial values of all RAM variables and the sound chip, and also
  58. initialises the data for LOAD0 (see below). It is done using:
  59.  
  60.                CALL JUMPTABLE+0         ;Initialise driver
  61.  
  62.  
  63.  
  64.  
  65. 2. The  music  player needs to be added to an  existing  64Hz interrupt
  66. routine, as follows:
  67.  
  68.                CALL JUMPTABLE+3         ;Sound Interrupt Routine every 64Hz
  69.  
  70.  
  71.  
  72.  
  73. 3. MUSIC CALLS:
  74.  
  75. STRTUNE:       LD A,00h                 ;Desired value
  76.                LD (TUNENO),A
  77.  
  78. Values are:    000h-07Fh                ;Music tracks
  79.                080h                     ;Stop Music immediately
  80.                081h-0FEh                ;Fade Music (Typical speed 084h)
  81.  
  82. During a fade,the value of STATUS will change from 0FFh (music active) to 00h
  83. (music stopped) at the instant the fade has finished. In normal usage, STATUS
  84. will have a value of 0FFh while music is playing, and return to 00h as soon as
  85. a tune has finished. Sound effects are entirely independant of the music.
  86.  
  87.  
  88.  
  89.  
  90. 4. EFFECT CALLS:
  91.  
  92. STRTFX:        LD A,00h
  93.                LD (SFXNO),A
  94.  
  95. Any Effect triggered after a fade has finished will restore the output volume
  96. to maximum automatically.
  97.