*****************************************************************************
* NEOGem ver. 0.022                                                        *                     
*                                                                           *
* URL: http://www.emuspain.com/neogem                                       *
* E-mail: arkaikos@hotmail.com                                              *
*                                                                           *
* y KRY & HN                                                             *
*****************************************************************************


WE DO NOT ACCEPT RESPONSIBILITY FOR ANY EFFECTS THAT THIS CODE MAY HAVE ON
YOUR COMPUTER OR ANYTHING YOU HAVE, USE IT AT YOUR OWN RISK.

YOUR ARE NOT LEGALLY ENTITLED TO USE ROM IMAGES IF YOU DON'T HAVE THE
ORIGINAL GAME BOARDS, OR CARTRIDGES.

PLEASE DON'T DISTRIBUTE NEOGem WITH ROM IMAGES.

NEOGEO AND ALL GAMES HERE MENTIONED THERE ARE REGISTERED TRADEMARK OF SNK
AND OF THEIR RESPECTIVE COMPANIES.

Changes
-------
 * ver 0.001
        -First Release Version

 * ver 0.005
        -More games run now ,included KOF '97, Fatal Fury RealBout 2, ...
        -Puzzle de Pon fixed (thanks Allard and MAME NEOGEO team).
        -Nam 1975,Neo bomberman and Magical Drop 3 graphics fixed.
        -Console and Arcade mode added to neogem.ini
        -Freeplay in Arcade mode added to neogem.ini
        -Country selection updated, now you can choice from JAPAN,USA or EUROPE.
        -Background animations speed fixed.
        -Z80 emulation and comunication with the Motorola added, lacks the
         YM2610 emulator to add the sound.

 * ver 0.022
        -Speedup a bit.
        -Added YM2610 emulation (by HAN).
        -Z80 bank system added.
        -Load support for ROMS on ZIP compressed format.
        -Frame skip auto, option added.
        -Language selection of the neogem.ini and the emulator.
        -Added support for PAD/Joystick 2,4,6 buttons.
        -New function for save and load state.
        -Option to save the Hiscores.
        -More games run, King of Monsters II, Kizuna Encounter...
        -Fixed graphic error in Metal Slug.
        -Background speed animation fixed (again...)
        -Sound and Music selectable.
        -more...

Contents
--------
1.Introduction
2.Requeriments
3.NEOGem usage
  3.1 Editing NEOGEM.INI
  3.2 Command line options
  3.3 NEOGem keys while running
4.Games tested with NEOGem
5.What it lacks
6.Troubles
7.Credits
8.Thanks
9.Contact with us


1. Introduction:
----------------

This is a NEOGEO Emulator for Console and Arcade systems, CD format is not
supported right now.
This program was make to run in pure DOS, not in Windows 95/98, so if you
experience crashes in Windows ,try it in DOS and if it continues crashing
then write us.
Virtual Memory is not posible under Windows 95/98.

2. Requeriments:
----------------

Minimun requeriments :
PENTIUM 133 MHZ
16 MB OF RAM
A VIDEO THAT SUPPORTS 16 bit color mode.(If can be, 320x240)
NEOGem can run in a slower computers but I not recommended it.

Recomended requeriments :
PENTIUM 233 MHZ or PENTIUM II
64 MB OF RAM or more.
VIDEO CARD with support for 320x240 in 16 bit color mode.

3. NEOGem usage:
----------------

To execute a NEOGEO ROM image you will pass in the parameter the name of
the directory where the ROM is.
For example suppose that you want to execute SOCCER BRAWL that is located
in the directory "c:\neogeo\roms\SBRAWL", then to run the game you would write
something like this:

NEOGEM c:\neogeo\roms\SBRAWL

The ROMS in this directory can be compressed in ZIP format.

NEOGem have configuration file, named "neogem.ini".
Also you can pass the options for the command line, this a description
of the options:


3.1 (NEOGEM.INI OPTIONS) (english)
------------------------

-NEOGem_Language (CASTELLANO or ENGLISH) : This selects the language in wich
        NEOGem will work.

-vsync (YES or NO) : This actives the vertical sincronization.
     
-country (JAPAN, USA or EUROPE) : With this you can select the country that
NEOGem will use to execute the game.

-fskip number : This is the number of frames that NEOGem will skip. The
default number is 1.

-Sound (YES or NO) : This activates the sound emulation.

-Music (YES or NO) : This actives the FM Music emulation. I recomend you, to
                     not activate this, because is in very alpha state.

-Save_HighScores (YES or NO) : If you select this, then the emulator will save
                               your hiscores of a game.

-NEOGEO_mode (CONSOLE or ARCADE) : Mode in which NEOGem will execute the
games. !!!IMPORTANT!!!, if you see the piracy screen in arcade mode then
put the console mode and the game will work fine.

-FREEPLAY (YES or NO) : This mode is only usefull in arcade mode. If you put
freeplay in arcade mode then your credits will be infinite.

-Player1_Control (Keyboard Joy2b Joy4b Joy6b Fspro Wingex)
-Player2_Control (Keyboard Joy2b Joy4b Joy6b Fspro Wingex)
        Keyboard : Keyboard control with the keys defined down.
        Joy2b  : Standard Joystick/PAD of 2 buttons.
        Joy4b  : 4 buttons Joystick/PAD.
        Joy6b  : 6 buttons Joystick/PAD.
        Fspro  : Flight Simulator pro.
        Wingex : Wingman extreme.

Note : If you select two pads, one for player1 and other for player2, then
the max number of buttons for each pad will be 2.

-Coin1 & -Coin2 : There you can define the scancodes that you want for
Coin1 and Coin2.
(default is key '1' for Coin1 and key '2' for Coin2)

-player1 & -player2 : There you can define the keys you want to play the
games.A file named SCANCODE.TXT is included , where there are all the keys
and his respectively scancode.
The default keys assigned for player 1:
        ARROW UP : UP
        ARROW DOWN : DOWN
        ARROW LEFT : LEFT
        ARROW RIGHT : RIGHT
        'Z' : BUTTON A
        'X' : BUTTON B
        'C' : BUTTON C
        'V' : BUTTON D
        'A' : START BUTTON
        'S' : START BUTTON

player2 is not active by default.


3.2 (COMMAND LINE OPTIONS)
----------------------------

-res x y : Where x and y are the X resolution and Y resolution respectively,
if you put some resolution different of 320x240 you will active also the
vertical sincronization.

-v : This actives the vertical sincronization.

-f number : This is the number of frames that NEOGem will skip. 

-j : Put the game in JAPAN mode.

-u : Put the game in USA mode.

-e : Put the game in EUROPE mode.

-a : Put the game in Arcade mode.

-c : Put the game in Console mode.

Note : Japanese mode will avoid the games censure automatically.


3.3 NEOGem KEYS WHILE RUNNING
------------------------------

'ESC'   Exits from NEOGem
'F5'    Console Reset.
'F6'    Joystick/PAD recalibration.
'F7'    Load State.
'F8'    Save State.
'F9'    Take and screen shot from the display and saves it in TGA format.
'F11'   Show frames/second in the upper right corner.
'F12'   Quit the frames/second display.
'SPACE' Pause.

4. Games tested with NEOGem:
----------------------------

3 COUNT BOUT : OK!
8MAN : OK!
2020 BASEBALL : Some sprite problems but playable.
AGRESSOR OF THE DARK KOMBAT : OK!
ANDRO DUNOS : OK!
ART OF FIGHTING I : OK!
ART OF FIGHTING III : OK!
ALPHA MISSION II : OK!
BASEBALL STARS II : OK!
BLAZING STARS : OK!
BLUE's JOURNEY : OK!
BURNING FIGHT : OK!
CYBER LIP : OK!
CROSSED SWORDS : OK!
FATAL FURY I : OK!
FATAL FURY II SPECIAL : OK!
FATAL FURY III : OK!
FATAL FURY REAL BOUT SPECIAL : OK!
FATAL FURY REAL BOUT II : OK!
FREEZE FOOTBALL : OK!
GHOST PILOTS : Some problems while playing.
GURURIN : Scaling problems.
JOY JOY KID : OK!
KABUKI KLASH : OK!
KARNOV'S REVENGE : OK!
KING OF THE MONSTERS I : OK!
KING OF THE MONSTERS II : OK!
KIZUNA ENCOUNTER : OK!
LAST RESORT : OK!
LAST BLADE : OK!
LEAGUE BOWLING : OK!
LEGEND OF SUCCESS JOE : OK! 
MAGICIAN LORD : OK!
MAGICAL DROP 3 : OK!
MAHJONG : OK!
METAL SLUG : OK!
MUTATION NATION : OK!
NAM 1975 : OK!
NEO BOMBER MAN : OK!
NEO DRIFT OUT : OK!
NEO MR. DO : OK!
NINJA COMMANDO : OK!
NINJA COMBAT : OK!
NINJA MASTER'S : OK!
PULSTAR : Not run.
PUZZLE DE PON : OK!
QUEST OF JONGMASTER : OK!
ROBO ARMY : OK!
SAMURAI SHODOWN I : OK!
SAMURAI SHODOWN II : OK!
SAMURAI SHODOWN III : Crashes in the first round. :-( (3c0006 problem)
SAMURAI SHODOWN IV : OK!  
SAVAGE REIGN : OK!
SENGOKU I : OK!
SENGOKU II : OK!
SOCCER BRAWL : OK!
STAKES WINNER : OK!
SUPER SIDEKICKS : Crashes because the copy protection.
TECMO SOCCER '96 : Zoom problems.
THE KING OF FIGHTERS '95 : OK!
THE KING OF FIGHTERS '97 : OK!
THE KING OF FIGHTERS '98 : OK!
TOP PLAYERS GOLF : OK!
TRASH RALLY : OK!
TURF MASTERS : OK!
TWINKLE STAR SPRITES : OK!
VIEW POINT : OK!
WIND JAMMERS : OK!
WORLD HEROES I : OK!
WORLD HEROES II : OK!
WORLD HEROES II JET : OK!
ZED BLADE : OK!

*Games tested : 72
*Games OK : 65

If you test NEOGem with other games, tell us if it run well, and if not
what happens.

5. What it lacks:
-----------------

-A speedup is needed.
-Some zoom problems.
-Some games there are not supported yet.
-A GUI.
-Better YM2610 emulation.
-Time to make more things.

6. Troubles
-----------

 6.1 NEOGem says "Resolution not supported : x y in 16-bit mode" :

     -Problem:    
        Your video card can display the graphics in this resolution.

     -Solutions:
        Get a modern graphics driver (ex: UNIVBE).
        Put NEOGem in other resolution editing the "neogem.ini".


 6.2 NEOGem says "Resolution not supported
                   Lower resolution supported is 320x240" :

     -Problem:
        NEOGem didn't support the specified resolution.

     -Solution:
        Edit "neogem.ini" and specify another resolution.


 6.3 NEOGem says "Error cargando ROMs de xxxxxx" :

     -Problem:
        NEOGem can't find the needed ROMs in the directory specified in
        the command line.

     -Solution:
        Test that the path is correct and that the ROMs of a game is
        located there.

 6.4 NEOGem says "No se ha podido cargar bios" :

        -Problem:
          NEOGem can't find the bios needed to run the games.

        -Solution:
          The file neo-geo.rom will be in the same directory where is
          located the emulator.

 6.5 NEOGem says "No se ha podido cargar bios ng-sfix.rom" :

        -Problem:
          NEOGem can't find the file ng-sfix.rom.

        -Solution:
          The file ng-sfix.rom will be in the same directory where is
          located the emulator.

 6.6 NEOGem says "No hay memoria suficiente" :

        -Problem:
          NEOGem can't allocate the needed memory for load and execute
          the desired game.

        -Solution:
          Execute the emulator in pure DOS , not in DOS window.
          Make sure that you have space in your hard disk to make
          virtual memory.


7. Credits:
-----------
Cristobal Aguilera (KRAY)
Luis Miguel Dominguez (HAN)

Special Thanks to "RIKIN Cadenas" the fan number one of NEOGEM. ;-)

8.Thanks
--------
Thanks to Luis Mendana (LiM) for give us space in EMUSPAIN and for make
the best emulation page "http://www.emuspain.com" .
Thanks to Neill Corlett for his StarScream emu.
Thanks to Neil Bradley for the Multi-Z80 CPU emulator (neil@synthcom.com)
Thanks to Hisham Elfangary for the graphics and animations.
Thanks to araCORN and all ROMLIST team.
Thanks to all people that make dumps of NEOGEO games and ROMS in general.
Thanks to Shin Seiki for his Technical Notes and Info.
Thanks to Allard Van der Bass (neogeo info).
Thanks to DJ Delorie for the free DJGPP compiler.
Thanks to Shawn Hargreaves for the ALLEGRO library.

Thanks to all our friends and all the guys of the IRC HISPANO:
(BraiNiack,ChandlerB,CBeard,Seia,Azote,Rikin,markos,etc..).
See you in #emuroms #emuladores and #emu channels.

9. Contact with us:
-------------------

NEOGem HOMEPAGE:
http://www.emuspain.com/neogem

E-MAIL:
arkaikos@hotmail.com

-----------------------------------------------------------------------------

Enjoy it.
