-------------------------------------------------------------------------
                            NMOD Player by NEiM0D/QTX!
                            --------------------------

  The fastest, baddest, smallest GBA protracker modplayer in the world."
                                                                         
--------------------------------------------------------------------------
1) COPYRIGHT NOTICE

All libraries and source files inside this SDK are copyright (C) 2002 by
 NEiM0D.

My permission is required if you want to use this module player in your
game/demo/tool/other project. Just send me an email with the request.
Also you are requested to add my name and email address to the project credits
list.

YOU CANNOT USE THIS PLAYER IN COMMERCIAL/SHAREWARE PROJECT.
PLEASE CONTACT ME (neimod@hotmail.com) BEFORE ADDING THIS PLAYER IN SUCH A PROJECT.
I THINK WE WILL FIND A GOOD SOLUTION FOR BOTH SIDES.

2) FEATURES

-Stereo (channels 0,3 left;channels 1,2 right).
-4 channels playback.
-16000Hz samplerate.
-All protracker effects are supported.
-Small size (6k!)
-Plays straight from the MOD format, no need to convert it.
-Fast! With a 125bpm song, the average stable cpu usage is 6%.
-ARM SDT and GCC supported!
-Ability to syncronize your demos with the volume/note/instrument/row/pattern
  and much more!

3) HOWTO

UNZIPPING:
 Unzip with original folders.

ARM SDT:
Simply compile nmod.s and insert the generated object file in your project.
NOTE! Do not forget to initialise the Mastervolumes to 64 (max. volume) for each
sound channel (0-3). If you do not set them, you will hear nothing.
Call the function NMOD_Play((u32)(&module)) to start playing and NMOD_Stop() to stop playing.
Look at nmod.h for a more advanced usage of the player's functions.
---
If you wish to use a different start.s, make sure you link the Timer1 IRQ handler's address
to 0x03002b04 (address may change in next release).

GCC:
Simply type make to start compiling.
NOTE! Do not forget to initialise the Mastervolumes to 64 (max. volume) for each
sound channel (0-3). If you do not set them, you will hear nothing.
NOTE! Also do not forget to set the iTimer1Intr=NMOD_Timer1iRQ; else it will 
not work.
Call the function NMOD_Play((u32)(&module)) to start playing and NMOD_Stop() to stop playing.
Look at nmod.h for a more advanced usage of the player's functions.
---
I've left the iwram code handling, variables etc. to the GCC compiler, so 
it should work perfectly.

4) WARNINGS
This only applies to ARM SDT users, GCC users are free of this:
-Do not overwrite the data in 0x03000000-0x03002bcf, that is where the modplayer itself is
 plus the buffers are located.
-If you use iwram as rw-base, then do not forget to put the rw-base to 
 0x03002bd0, else you will overwrite it for sure.
GCC and ARM SDT:
-Timers 0 and 1 are used for playing the music, don't use them!

5) CONTACT

If you have any opinions about this player, have something to contribute, or 
just want to send me some money over paypal, send an email to: 
 neimod@hotmail.com

6) THANKS

Greets to exoticorn and sgstair!

7) TO DO

-Fix all bugs
-Add sound effects support


Signed,

       NEiM0D

------------------------------------------------------------------------------
            If you don't like this player, then eat SHIT lamah!
------------------------------------------------------------------------------