home *** CD-ROM | disk | FTP | other *** search
/ Dave Lowe: Latest Version…itors Megaman XInfo File / Lowe_LatestVersionsOfMusicEditors_MegamanXInfoFile.img / GEAR / GEAR30.DOC < prev    next >
Encoding:
Text File  |  1994-10-27  |  3.9 KB  |  121 lines
  1. -------------------------------------------------------------------------------
  2. GAMEGEAR MUSIC DRIVER - (c) Martin Walker 1993/1994
  3. -------------------------------------------------------------------------------
  4.  
  5. DEVELOPERS MANUAL - UPDATED:
  6.  
  7. 25/07/94 - Driver updated to version 3.0/ RAM usage 226 bytes
  8. 09/07/93 - Driver updated to version 1.7
  9.  
  10.  
  11.  
  12.  
  13. ------------------------------------------------------------------------------
  14. DEMOING THE MUSIC/ EFFECTS
  15. ------------------------------------------------------------------------------
  16.  
  17. To help test the music files, a file named 'GEARMUS.ROM' may be supplied.
  18. You can download this to the GAMEGEAR for a demo of the music and effects.
  19. The GAMEGEAR keys to use are as follows:
  20.  
  21. UP/DOWN           Increment/Decrement current call number.
  22. LEFT/RIGHT        Stop all sound/Re-Initialise sound driver
  23. 1                 Start music.
  24. 2                 Start effect.
  25.  
  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). They
  35. are assembled to any address specified by the customer. The driver and data
  36. will start at MUSTABLE, and the ram variables will start at MUSVARS. Each
  37. driver has a jumptable of calls at the beginning, as follows:
  38.  
  39.  
  40. START OF ROM (CARTRIDGE) DATA:
  41. INITSND        equ  MUSTABLE+0
  42. INTSND         equ  MUSTABLE+3
  43.  
  44.  
  45. START OF RAM (WORKSPACE) DATA: (CURRENT USAGE 224 BYTES)
  46. SFXNO          equ  MUSVARS+0
  47. TUNENO         equ  MUSVARS+1
  48. STATUS         equ  MUSVARS+2
  49. EFFECTVOL      equ  MUSVARS+3      ;default setting 0Fh (maximum)
  50. MUSICVOL       equ  MUSVARS+4      ;default setting 0Dh (to balance effects)
  51. FADEVOL        equ  MUSVARS+5
  52.  
  53.  
  54.  
  55.  
  56. INITIALISATION:
  57. ---------------
  58. The player needs to be initialised once only on starting the game. This sets
  59. up the sound chip and the initial values of all RAM variables. The music
  60. master volume defaults to 0Dh and the effect master volume defaults to maximum
  61. (0Fh) during this routine. It is done using:
  62.  
  63.                CALL INITSND             ;Initialise driver
  64.  
  65.  
  66.  
  67. The  music  player needs to be added to an  existing  interrupt routine, as
  68. follows:
  69.  
  70.                CALL INTSND              ;Sound Interrupt Routine every 60Hz
  71.  
  72.  
  73.  
  74.  
  75. MUSIC CALLS:
  76. ------------
  77. STRTUNE:       LD A,00h                 ;Desired value (see PROJECT.DOC)
  78.                LD (TUNENO),A
  79.  
  80. Values are:    000h-07Fh                ;Music tracks
  81.                080h                     ;Stop Music immediately
  82.                081h-0FEh                ;Fade Music (Typical speed 084h)
  83.  
  84.  
  85. During a fade,the value of STATUS will change from 0FFh (music active) to 00h
  86. (music stopped) at the instant the fade has finished.
  87.  
  88. CHKFADE:       LD A,(STATUS)
  89.                BIT 7,A
  90.                RET NZ                   ;Music still playing
  91.  
  92.  
  93. If desired, the master volume setting for the music can be changed from the
  94. default value set by INITSND (0Dh) to a different value if a different balance
  95. between sound effects and music is required. The default value is already
  96. optimised for most cases.
  97.  
  98. MUSVOL:        LD A,0Dh                 ;00h-0Fh
  99.                LD (MUSICVOL),A
  100.  
  101.  
  102.  
  103.  
  104. EFFECT CALLS:
  105. -------------
  106. STRTFX:        LD A,01h                 ;Desired value (see PROJECT.DOC)
  107.                LD (SFXNO),A
  108.  
  109.  
  110. If desired, the master volume setting for the effects can be changed from the
  111. default maximum value set by INITSND (0Fh) to a lower value.
  112.  
  113. FXVOL:         LD A,0Dh                 ;00h-0Fh
  114.                LD (EFFECTVOL),A
  115.  
  116.  
  117. The music fade is designed to affect the music only - if you require to fade
  118. sound effects simultaneously, simply copy the current FADEVOL to EFFECTVOL
  119. after each call to INTSND.
  120.  
  121.