***************************
        AlexKidd2X
         v0.6.4u
***************************

  GP2X SMS/GG Emulator

***************************

Note: 'cfg' files from previous versions are not compatible with this version.
You must start afresh. The 'data' folder in the 'Alexkidd2x_0.6.4u' directory
should be empty on first run.

Running:
=========
'alexkidd2x.gpe' -> Use on GP2X-F100 running firmware v3.0 and below, and Open2x.
'alexkidd2x.fw4+.gpe' -> Use on GP2X-F100 running firmware v4.xx.
(F200 users can use either version)

Copy the 'Alexkidd2x_0.6.4u' folder to your SD card and place roms in the 'roms'
folder. Roms can be uncompressed (.sms and .gg extension) or compressed (.zip).
Roms can be placed in subfolders within the roms directory e.g.
'roms/Master System', 'roms/Game Gear', 'roms/Beta' etc.

Make sure 'Volume Limit' isn't switched on in 'System' if using pre fw4.xx.
If you use Gmenu2x or Open2x, enable the 'Tweak RAM Timings' option.

Note: There seems to be a minor bug relating to the volume when playing on fw4.1.0
and Open2x. After you have played a rom and exit back to the Rom List then start
another rom, the volume will be quite low. Pressing the 'Volume Up' button won't do
anything. To fix this, just press 'Volume Down', then 'Volume Up' to make the volume
control work again. 
Note2: If you running Open2x on an F100 and intend on using AlexKidd2X via TV-Out,
then use the 'alexkidd2x.fw4+.gpe' version otherwise you will get a constant flashing
onscreen battery level indicator and the low battery warning LED.

I have removed the battery level checking code in the 'fw4+' version. This is to
prevent the constant flashing onscreen battery level indicator and the low battery
warning LED on an F100 using fw4.xx.


Controls:
==========

Rom List:
----------
Up/Down -> Move cursor up/down.
L/R/Left/Right -> Move page up/down.
B -> Select highlighted rom.
Click+A+X / Vol Down+A+X -> Delete selected rom.
Click+Y / A+Y -> Save current roms folder as the default roms folder. The standard
                 default folder is 'roms' within the 'Alexkidd2x_0.6.4u' directory.
                 Note: Folder names in the path must not have spaces in them.
Start+Select -> Exit emulator.
Select+Y -> Rom Scan against CRC internal database (progress bar displayed at bottom
            of screen).

			
Rom Configuration Menu:
------------------------
Up/Down -> Move cursor up/down.
A/B -> Change menu option.
Click+Y / L+Y -> Save current rom configuration as default configuration for all roms.
Select -> Start game.
Start -> Go back.
Start+Select -> Exit emulator.


Marquee Selection Screen:
--------------------------
Up/Down -> Move cursor up/down.
Y -> Preview highlighted Marquee (hold button).
B -> Select highlighted Marquee.
Start -> Disable Marquee.


In-game default keys (Note: These can be remapped from the Rom Configuration Menu):
------------------------------------------------------------------------------------
Joystick -> Pad.
X -> Button 1.
B -> Button 2.
Start -> Pause.
A+Y+R -> Reset Master System/Game Gear. 
Click+Vol Up / Select+Vol Up -> Increase current save slot (0 to 9).
Click+Vol Down / Select+Vol Down -> Decrease current save slot.
Click+L / Select+L -> Save game in current slot.
Click+R / Select+R -> Restore game from current slot.
Select+Y -> Show/Hide FPS.
Select+A -> Show/Hide battery level (only on GP2X-F100 running FW v3.0 and below, and Open2x).
            Note: You cannot hide the icon if the battery level is critical.
Vol Up -> Increase volume.
Vol Down -> Decrease volume.
L+R -> Exit game back to the Rom List.


Options and Additional Info:
=============================

Per Rom settings:
------------------
Each game create its own config file after it has been run once, so will remember the options you
have set for each game. Game options only save when you load the game. So if you change options
for a particular game in the Rom configuration Menu, start the game (press 'Select') to save them.
If you press 'Click+Y' or 'L+Y' whilst in the Rom Configuration Menu, it will apply the current
options (including the Marquee and defined keys) for the selected rom to all roms that don't
currently have their own config file (i.e. haven't been run yet).


Rom CRC Scanning:
------------------
This will check your roms against the internal CRC database and then rename them accordingly. (Note:
It will not physically rename them on your memory card, but only within the emulator itself via the
file 'roms.crc' which the emulator refers to, and is written to the directory wherever you conduct
the scan. If you have previously done a Rom CRC Scan and you want to add additional roms, you must
do another CRC Scan (Select+Y) in the folder where you added the roms for them to appear in the Rom
List. Alternatively, you can just delete 'roms.crc' from folder where you conducted the scan, and the
emulator will display however the rom is named on your memory card, until you select the rom, then you
can see the CRC naming in the Rom Configuration Menu. If you have roms in multiple directories, that
will require multiple scans from within each directory. I recommend having Game Gear and Master System
roms in subfolders within the 'roms' directory, e.g. 'roms/Master System' and 'roms/Game Gear'.
Then do a CRC scan from within each of those folders. Note: Rom CRC scans can take up to 5 minutes
depending on the amount of roms you have in the particular folder you are scanning. Also, make sure
your rom names start with a capital letter otherwise they will be placed at the bottom of the Rom
List. Doing a Rom CRC scan is not a necessity for the functioning of the emulator. It is a feature of
convenience that will display your roms in a list that makes it possible to see the rom codes (e.g.
region, beta, translated etc.) regardless of filename length, so you can set settings accordingly in
the Rom Configuration menu.


CPU Speed:
-----------
The majority of Master System and Game Gear games will run at full speed at the default setting of
'144mhz'. You will need to increase this if you enable 'Yamaha FM Sound' (see details below).


Audio Sampling:
----------------
I recommend leaving the Audio Sampling Rate set to '22050' as '44100' tends to get a bit scratchy.


Yamaha FM Sound:
-----------------
If your game supports Yamaha FM sound, '(FM)' will be displayed at the top of the Rom Configuration
Menu in the title of your selected game. You can then enable 'Yamaha FM Sound' if you wish to.
Note: FM Sound emulation on compatible games requires a higher CPU clock setting to maintain frame
rate ('166mhz ~ 200mhz' for 'EMU2413', and at least '225mhz' for 'YM2413'). I recommend using
'EMU2413' as it is less CPU intensive and has a slightly higher volume level.
Since AlexKidd2X v0.6.4u you are not just restricted to Sega Mark III Japanese region for FM sound.
You can choose any region and FM sound will still work. The only exception to this is the game
'Wonder Boy III: The Dragon's Trap'. This game needed forcing to the Japanese Region for FM sound to
work. This causes the title screen to display 'Monster World II' on the Euro/US Version. This is the
only difference, the game still plays in English. FM sound works on the virtual console(VC) dump of
this game no matter what region setting you choose.
Note: If you have made save states whilst running a game with 'FM' sound enabled, don't then try and
load the state whilst playing the the game with 'FM' disabled, and vice versa, otherwise the sound
won't work correctly.

The following games are Yamaha FM sound compatible:

After Burner, Aleste, Alex Kidd BMX Trial, Alex Kidd - The Lost Stars, Alien Syndrome, Altered Beast,
Aztec Adventure - The Golden Road to Paradise, Blade Eagle 3-D, Bomber Raid, California Games,
Captain Silver, Casino Games, Chouon Senshi Borgman, Cloud Master, Cyborg Hunter,
Doki Doki Penguin Land - Uchuu-Daibouken, Double Dragon, Family Games,
Fantasy Zone 2 - Opa-Opa no Namida, Fantasy Zone 2 - The Tears of Opa-Opa, Fantasy Zone - The Maze,
Galactic Protector, Galaxy Force, Game Box Serie Esportes Radicais, Global Defense, Golfamania,
Golvellius - Valley of Doom, Great Golf, Haja no Fuuin, Hoshi wo Sagashite, Hwarang Ui Geom,
Kenseiden, Kujaku Ou, Lord of the Sword, Maou Golvellius, Maze Hunter 3-D, Maze Walker, Megumi Rescue,
Miracle Warriors - Seal of the Dark Lord, Monica no Castelo do Dragao, Nekkyuu Koushien, Opa Opa,
OutRun 3-D, OutRun, Parlour Games, Penguin Land, Phantasy Star, Poseidon Wars 3-D, Power Strike,
R-Type, Rampage, Rastan, Rescue Mission, S.D.I., Scramble Spirits, Shanghai, Shinobi,
Solomon no Kagi - Oujo  Rihita no Namida, Sonic The Hedgehog (FM Patched), Space Harrier 3-D,
SpellCaster, Summer Games (Prototype), Super Racing, Super Wonder Boy - Monster World, Tennis Ace,
Tensai Bakabon, Thunder Blade, Time Soldiers, Turma da Monica em O Resgate,
Ultima IV - Quest of the Avatar, Vigilante, Wonder Boy 3 - The Dragons Trap,
Wonder Boy in Monster Land, Ys, Ys - Vanished Omens (FM patched), Zaxxon 3-D,
Zillion 2 - The Tri Formation.


Master System Screen Size:
---------------------------
If the Screen Mode is set to '1:1', Master System games will display at their native resolutions of
256x192 or 256x224 (some Codemasters games). If the Screen Mode is set to 'FULL', this will stretch
256x192/256x224 to full screen without changing the resolution.


Game Gear Screen Size:
-----------------------
If the Screen Mode is set to '1:1' and Game Gear Size set to 'Orig', Game Gear games will display at
their native resolution of 160x144. Setting the Game Gear Size to 'SMS' will force Game Gear games to
the Master System resolution of 256x192. This will show hidden areas of the screen which will contain
graphical errors in most Game Gear games, but there are some that work well in 'SMS' mode
e.g. Robocop v Terminator. Game Gear Games that truly support SMS resolution (SMSGG games) are already
in the CRC internal database, and will automatically switch to a SMS screen resolution regardless of
Game Gear screen size settings. So this option has no impact on those games.
If the Screen Mode is set to 'FULL', this will stretch whatever the Game Gear Size setting is to full
screen without changing the resolution.
The 'Game Gear Expand' option, when enabled will scale 160x144 Game Gear games to a size halfway
between 1:1 and Full Screen Mode. Note: This option only works when the Screen Mode option is set to
'1:1' and Game Gear Size is set to 'Orig'. Setting the Screen Mode to 'FULL' or Game Gear Size to
'SMS' will override this option.


Marquees:
----------
Marquees are custom borders (png images) that cover the black areas of the screen around the play
area of Master System and Game Gear games when they are running at their native resolution. Marquees
only work when the Screen Mode is set to '1:1'. Game Gear Marquees have the prefix 'gg-', and Master
System Marquees have the prefix 'sms-'. There are 2 specialist Marquees. 'sms-codemasters' for
Codemasters 256x224 screen resolution games, and 'gg-expand' for when the 'Game Gear Expand' mode is
enabled. The 'universal' Marquee can be used on Master System (256x192) and Game Gear (160x144/256x192
+ Expand Mode) games. The Marquee List can be accessed via the Rom Configuration Menu.


Keymapping and USB Joypads:
----------------------------
Remapping keys is done via the 'Configure Input' option in the Rom Configuration Menu. When remapping
your keys, on most GP2X's you will need to press each key twice while remapping. You'll know if you
need to press the key again, as the screen won't move on to the next stage until you do. On a lesser
amount of GP2X's, you will only need to press each key once.

If you have been using a USB pad for player 1, you will need to remap your keys again if you go back
to using the GP2X controls.
The USB and GP2X pad names get mixed up for player 2 in the 'Configure Input' Menu if you have more
than one USB pad plugged in. To map player 2 to USB, select 'GP2X Joystick' for player 2, then select
'Remap Buttons', and use the second USB pad to map the buttons. After you have completed the mapping
for player 2, the correct name of the second USB pad will be displayed. This only applies if you are
using two USB pads.


No Sprite Limit:
-----------------
Enabling this disables the hardware sprite limit. It bypasses the 8 sprite per line limit of the
original hardware eliminating sprite flicker in most games. 'NO SPRITE LIMIT' is switched 'on' by
default which keeps most games flicker free, but if you prefer the sprite flicker/limits of the
original hardware, just switch the option to 'off'.
Note: Some games have special routines to negate the sprite limits and minimize flickering. The
'NO SPRITE LIMIT' option may have no effect on these games.


Z80 Speed:
-----------
This option enables you to overclock/underclock the Z80 speed. It can be useful for some games that
suffered slowdown on the original Master System hardware.


Region/Display:
----------------
There are four combinations of Region/Display settings.
'Usa/NTSC', 'Euro/PAL', 'Jap/NTSC' and 'Jap/PAL'.
'NTSC' will set the screen to a 60hz refresh rate, and 'PAL' will set it to a 50hz refresh rate.
Depending on the the 'Region' setting, some games will run in a different language, have altered
text, or display a different title screen.
Note: Some PAL only games will be forced to a 50hz refresh rate regardless of the 'Region/Display'
setting (see details below).


PAL 50hz games:
----------------
The following Euro/Brazilian games will be forced to run at 50hz regardless of the Region/Display
setting. This is because at 60hz they either don't work, display graphical errors, or run too fast.
You will know which games this applies to as '(50hz)' will be displayed at the top of the Rom
Configuration Menu in the title of your selected game:

Addams Family, Alien 3, Back to the Future Part 2, Back to the Future Part 3, Battlemaniacs (Brazil),
Bram Stokers Dracula, California Games 2, Cosmic Spacehead, Desert Strike, Dinobasher (Prototype),
Excellent Dizzy (Game Gear), Home Alone, James Bond 007 - The Duel, Jungle Book, Micro Machines,
NBA Jam (Prototype), New Zealand Story, OutRun Europa, Predator 2, Prince of Persia,
Quest for the Shaven Yak (Brazil), RoboCop 3, S.S.Lucifer - Man Overboard (Game Gear), Sensible Soccer
Shadow Dancer, Shadow of the Beast, Simpsons - Bart vs The Space Mutants, Sonic Blast (Brazil)
Sonic The Hedgehog 2, Sonic 2 (Hacked Versions), Space Harrier, Speedball (Image Works),
Speedball (Virgin), Street Fighter 2 (Brazil), Super Kick Off, Super Smash T.V., Taito Chase H.Q.,
Xenon 2 - Megablast (Image Works), Xenon 2 - Megablast (Virgin).

If a game feels like it's running too fast, try running it in 'Euro/PAL' to slow it down to 50hz. Many
games were PAL optimised, so were designed to run in 50hz. If you have made save states when running a
game in 'PAL', don't then try and load the state whilst playing the the game in 'NTSC', and vice versa
otherwise you will get frame rate issues.


TV-Out:
--------
TV-Out set to NTSC doesn't work for AlexKidd2X if set via GP2X Native Menu. PAL works fine.
Both PAL and NTSC TV-Out modes work fine in AlexKidd2X if set via Gmenu2x and Open2x(Use 'PAL
Overscan Fix' if using PAL).
Note: Disable Marquees when using TV-Out.


Known bugs (also present in previous versions):
------------------------------------------------
- After selecting your rom you may notice a brief 1 second stutter within the first minute of
  gameplay. The game will play fine after this.
- Emulator sometimes locks up/black screens when exiting back to the Rom List or starting a rom.
  So if a rom black screens when loading and the emulator has froze, it doesn't necessarily mean
  it doesn't work. Restart the emulator and try the game again.
- Occasionally, if you try and load a save state when there isn't one present, the emulator will
  lock-up.
- When playing on fw4.1.0 or Open2x, after you have played a rom and exit back to the Rom List then
  start another rom, the volume will be quite low. Pressing the 'Volume Up' button won't do anything.
  To fix this, just press 'Volume Down', then 'Volume Up' to make the volume control work again.


Changelog AlexKidd2X:
======================

v0.6.4u (unofficial build by Nightbird):
-----------------------------------------

- Integrated the 256x224 SMS2-VDP screen resolution for Codemasters SMS and SMSGG-Compatible games.
  This fixes the following games, so that the bottom of the screen is no longer cut off:
  Micro Machines, Cosmic Spacehead, Excellent Dizzy Collection (Game Gear version).
- Master System games now working: Shadow Dancer, Ace of Aces, Sangokushi 3, Dodgeball King,
  Jang Pung 2, Jang Pung 3.
- Game Gear games now working: Excellent Dizzy Collection (runs in 256x224), Ernie Els Golf, Dropzone,
  CJ Elephant Fugitive, Pete Sampras Tennis, Micro Machines 2, Jang Pung 2 (runs in 256x192).
- Street Hero (proto v2) now correctly switches to 'SMSGG' mode if your rom has '.gg' extension.
- Added an option in the Rom Configuration Menu to turn off the hardware sprite limit. This bypasses
  the 8 sprite per line limit of the original hardware. It eliminates sprite flicker on most games 
  (you can now play R-Type without flickering enemies). The new option 'NO SPRITE LIMIT' is switched
  'on' by default which keeps most games flicker free. But if you prefer the sprite flicker/limits of
  the original hardware, just switch the option to 'off'.
- Added the ability to reset the Master System/Game Gear, as it avoids having to exit the game and
  reload the rom if you want to start a new game. Just press A+Y+R whilst a game is running to reset
  the system.
- Made some CPU changes. Increased the default CPU Clock from 140mhz to 144mhz. Removed CPU clock
  settings below 120mhz as many games will suffer a drop in frame rate or have sound issues at these
  speeds. Added more CPU frequency increments to the Rom Configuration Menu.
- Updated Z80 core (this has fixed the pause bug in Robocop 3 and Dinobasher which previously caused
  these games to lock-up).
- Added an option in the Rom Configuration Menu called 'Game Gear Expand', which when enabled will
  scale 160x144 Game Gear games to a size halfway between 1:1 and Full Screen Mode. Note: This option
  only works when the 'Screen Mode' option is set to '1:1', and 'Game Gear Size' is set to 'Orig'.
  Setting the 'Screen Mode' to 'FULL' or 'Game Gear Size' to 'SMS' will override this option.
- Added three new Marquees. 'sms-codemasters' for Codemasters 256x224 screen resolution games,
  'gg-expand' for the new 'Game Gear Expand' mode, and 'universal' which can be used on both Master
  System and Game Gear (including 'Expand' mode) games. All are made from the 'sms-pedator2' Marquee.
- Added code to force 50hz refresh on games with known issues running at 60hz. See 'readme.txt' for
  more info and 50hz games list. These games will be forced to run at 50hz regardless of the
  Region/Display setting. You will know which games this applies to as '(50hz)' will be displayed at
  the top of the Rom Configuration Menu in the title of your selected game.
- Added information in the Rom Configuration Menu to indicate if a Game Gear game is a 'Master System
  Compatibility Mode' game. 'SMSGG' will be displayed at the top of the Rom Configuration Menu in the
  title of your selected game. These roms can have either the .gg or .sms extension and will still
  automatically switch to SMS resolution regardless of Game Gear screen size settings.
- Added information in the Rom Configuration Menu to indicate if a game supports Yamaha FM sound.
  '(FM)' will be displayed at the top of the Rom Configuration Menu in the title of your selected
  game. You can then enable 'Yamaha FM Sound' if you wish to. Note: FM Sound emulation on compatible
  games requires a higher CPU clock setting to maintain frame rate ('166mhz ~ 200mhz' for 'EMU2413',
  and at least '225mhz' for 'YM2413'). I recommend using 'EMU2413' as it is less CPU intensive and
  has a slightly higher volume level.
- Stopped the emulator forcing Sega Mark III Japanese region when enabling FM Sound on compatible
  games. It was causing some Euro/US games to display Japanese text (Time Soldiers was one).
- You now need to press 'Click+A+X' or 'Vol Down+A+X' to delete a rom, as it was too easy to
  accidentally delete one before.
- Completely rewritten and updated the Rom CRC internal database (now has 2800 entries, previous
  release had around 1100). Now after a CRC scan, for nearly all roms you will be able see the rom
  codes (e.g. region, beta, translated etc.) regardless of filename length, so you can set options
  accordingly in the Rom Configuration Menu. Or, if you prefer not to do a CRC scan, you can still
  see the internal database name in the Rom Configuration Menu after you select a rom.
- Save States should now be working in pretty much every Master System and Game Gear game.
- Fixed the system lock-up caused by simultaneously pressing 'Start' and 'Select' in the Rom
  Configuration Menu. If you press them together now it exits the emulator, same as it would in the
  Rom List.
- Removed the option of moving the stick left/right to change options in menu, as it can be
  over-sensitive and easy to alter options accidentally when scrolling up/down. I've defined the 'A'
  button to decrease options ('B' was previously already defined to increase), so you must now use 'A'
  and 'B'. Due to button 'A's new functionality, 'L+Y' is now used to save current rom configuration
  as default configuration for all roms.
- Made some changes to the default controls. Check 'readme.txt' for complete keymap.
- Reset the load/save slot to '0' when loading a rom. As each game has its own discrete 10 save slots,
  it is more practical to always reset to slot '0' when starting a new rom rather than your first save
  ending up in say slot '6'.
- Changed the way remapping your keys is executed to cover all GP2X hardware variations and retain
  compatibility with USB joypads. Now when you remap your keys, on most GP2X's you will need to press
  each key twice while remapping. You'll know if you need to press the key again, as the screen won't
  move on to the next stage until you do. On a lesser amount of GP2X's, you will only need to press
  each key once.
- Disabled the FPS meter on exit rom so it doesn't show for every rom you load thereafter.
- Fixed Marquee clashing with gaming area when forcing a Game Gear game to SMS resolution.
- Fixed buttons 1 and 2 being reversed when remapping keys to a USB joypad.
- Fixed osd messages relating to previous roms from appearing when you load a new rom.
- Fixed load/save messages and the FPS meter getting partially stuck on-screen when playing Game Gear
  games in Full Screen Mode.
- Fixed the sluggish osd screen update when changing between load/save slots.

Note: 'cfg' files from previous versions are not compatible with this version. You must start afresh.


v0.6.2u (unofficial build by Nightbird):
-----------------------------------------

- Gained about 20% to the maximum volume level (primarily done to correct the low volume in the
  previous release when running on an F100. Note: Make sure 'Volume Limit' isn't switched on in
  'System' if using pre v4.xx firmware).
- Rom CRC scan for the GoodSMS/GG database now requires you to press 'Select+Y' to scan instead of
  just 'Select'. This was done to prevent accidental CRC scans as it can take up to 5 minutes to
  CRC check a full romset.
- Some minor adjustments to the Rom CRC GoodSMS/GG internal database.
- Fixed the Remap Keys bug which would cause buttons 1 and 2 to be reversed.
- Removed Show/Hide FPS and Show/Hide Battery Level from 'Stick Click+Y' and 'Stick Click+X'
  respectively to avoid accidentally showing/hiding them during gameplay if you have remapped
  your keys. You can still Show/Hide them using 'Select+Y'(FPS) and 'Select+X'(Battery Level).
- You now need to press 'Start+Select' in the Rom List rather than just 'Start' to exit the emulator.
- Dinobasher (Codemasters-Prototype) now works (Note: Run this game in Euro/PAL(50hz) mode otherwise
  it will run too fast. Also, don't press pause during the game as it will freeze, requiring you
  to exit back to the Rom List).
- S.S. Lucifer - Man Overboard (Game Gear) now works (Note: Run this game in Euro/PAL(50hz) mode
  otherwise you will get a high level of screen flicker. Also, you can't see the rising sea level
  which makes it hard to judge how much time you have at the first attempt in some levels).
- Separate binary for GP2X-F100 running firmware 4.xx to prevent battery level indicator bug.
  
  
----------------------------------------------------------------
Thanks to Israel Lopez Fernandez (Puck2099) for this Emulator.
Charles MacDonald for SMSPlus, and Eke-eke for the Wii version.
