
    Welcome to GP2X-CAP32

Original Author of Caprice32

  Ulrich Doewich

Author of the PSP and GP2X port versions

  Ludovic.Jacomme also known as Zx-81 (zx81.zx81@gmail.com)

  -> to Loic Daneels for his keyboard files, feedback and suggestions.
  -> to David Llort for all his comments, feedback and requests.
  -> to Shadow for his beautiful icons and background !
  -> to Goebish for his help on ram size / Symb-OS issue
  -> to KaosOverride for the hints on VDU stuff


1. INTRODUCTION
   ------------

  Caprice32 is one of the best emulator of the Amstrad CPC home computer series
  running on Windows and Unix.  The emulator faithfully imitates the CPC464,
  CPC664, and CPC6128 models (see http://sourceforge.net/projects/caprice32)

  GP2X-CAP32 is a port on GP2X of the version 4.2.0 of Caprice32, that i had
  previously ported to PSP.

  Special thanks to Danzel and Jeff Chen for their virtual keyboard,
  and to all GP2X-SDK developpers.

  This package is under GPL Copyright, read COPYING file for
  more information about it.


2. INSTALLATION
   ------------

  Unzip the zip file, and copy the content of the directory fw2.x or fw1.5
  (depending of the version of your firmware) on the psp/game directory.

  Put your snapshot files generated using the Windows version of Caprice32
  on "snap" sub-directory, or disk image on "disk" sub-directory.

  Unzip the zip file, and copy the content of the directory game to your
  SD memory.

  For any comments or questions on this version, please visit 
  http://zx81.zx81.free.fr or http://www.gp32x.com/


3. CONTROL
   ------------

  In the CPC emulator window, there are three different mapping 
  (standard, left trigger, and right Trigger mappings). 
  You can toggle between while playing inside the emulator using 
  the two GP2X trigger keys.

    -------------------------------------
    GP2X        CPC             (standard)
  
    A          Backspace
    Y          ENTER
    X          Joystick Fire 1
    B          Joystick Fire 2
    Up         Up
    Down       Down
    Left       Left 
    Right      Right
  
    -------------------------------------
    GP2X        CPC      (left and right trigger)
  
    A          Backspace
    Y          ENTER
    B          Escape
    X          Space
    Up         Up
    Down       Down
    Left       Left 
    Right      Right

    Joystick   Joystick
    
    Press Select  to enter in emulator main menu.
    Press Start   open/close the On-Screen keyboard

  In the main menu

    RTrigger   Reset the CPC

    Y   Go Up directory
    X   Valid
    B   Valid
    A   Go Back to the emulator window

  The On-Screen Keyboard of "Danzel" and "Jeff Chen"

    Use the stick to choose one of the 9 squares, and
    use A, B, X, Y to choose one of the 4 letters 
    of the highlighted square.

    Use LTrigger and RTrigger to see other 9 squares 
    figures.
    

4. LOADING CPC SNAPSHOT FILES
   ------------

  Using the Linux or Windows version of Caprice32 on your PC, you can save 
  any snapshot files of your CPC games or applications.

  You can then save those snapshot files (with .zip, .sna or .snz file extension)
  on your GP2X memory stick in the 'snap' directory. Then, while inside CPC
  emulator, just press SELECT to enter in the emulator main menu, and 
  then using the file selector choose one snapshot file to load in the
  RAM of your emulator.

  (NOTE) Save state files are now saved using gzip compression, with SNZ as
  file extention). It's much faster to save or load states. You can use 
  gzip or 7-zip to convert old SNA to SNZ. 
  SNA file format is still supported for loading, so you convert your 
  previous saved files (or original Caprice32 files), inside the emulator.


5. LOADING CPC DISK FILES
   ------------

  If you want to load disk image in the virtual drive A of your emulator,
  you have to put your disk file (with .zip or .dsk file extension) on your GP2X
  SD memory in the 'disk' directory. You proceed as previously described
  for snapshot files, and your disk is then inserted in the drive 'A' of your
  emulator.  

  The first method to launch a game after loading a disk file, is to set the
  "Disk startup" option to "full" and to set the "Reset on startup"
  option to true.

  When you insert a disk using the "Load disk" menu then game will start
  automatically.

  If you want to can set the "Disk startup" option to "manual", and browser
  yourself the content of the disk using the "Explore disk" menu.

  If you want to do all this manually, set the "Disk startup" option to
  "manual" and proceed as explained in the following paragraphs.

  To display the content of your drive, you have to use the virtual keyboard
  (press START key) and type the CPC command 'CAT' followed by ENTER (Y).
  For example if you have loaded the disk file of the game "Green Beret" :

       CAT

  You should see something like this :

       Drive A: user    0
       
       GBERET    .     * 15K

       140K free

  (NOTE) You can also use directly the shortcut in the emulator menu (Command CAT option)
   
  Then if you want to run a program GBERET that is on your drive 'A', you have to
  use the CPC command 'RUN' as follow :

       RUN"GBERET

  (NOTE-1) If the filename of the .dsk (here gberet.dsk) is also the name of the 
  program you want to run (here gberet) then you can use directly the Command RUN" 
  in the emulator menu. 


  (NOTE-2) If the command to run is different from the filename then you can specify 
  the proper command to RUN in the file run.txt, for example :

    mygame=DISC

  Then, while using the Command RUM/CPM menu, the emulator will type RUN"DISC
  instead of RUN"mygame. Have a look the file run.txt for details about the syntax.

  (NOTE-3) You can specify CPM games in the run.txt file using the following syntax:

     mygame=|CPM

  Then, when using the Command RUM/CPM menu, the emulator will use the |CPM
  command (instead of RUN"mygame).
  

6. LOADING KEY MAPPING FILES
   ------------

  For given games, the default keyboard mapping between GP2X Keys and CPC keys,
  is not suitable, and the game can't be played on GP2X-CAP32.

  To overcome the issue, you can write your own mapping file. Using notepad for
  example you can edit a file with the .kbd extension and put it in the kbd 
  directory.

  For the exact syntax of those mapping files, have a look on sample files already
  presents in the kbd directory (default.kbd etc ...).

  After writting such keyboard mapping file, you can load them using the main menu
  inside the emulator.

  If the keyboard filename is the same as the snapshot (.sna) or disk
  filename (.dsk) then when you load this snapshot file or this disk, the 
  corresponding keyboard file is automatically loaded !

  You can now use the Keyboard menu and edit, load and save your
  keyboard mapping files inside the emulator. The Save option save the .kbd
  file in the kbd directory using the "Game Name" as filename. The game name
  is displayed on the right corner in the emulator menu.
  

7. COMPILATION
   ------------

  It has been developped under Linux using gcc with GP2XSDK. 
  To rebuild the homebrew run the Makefile in the src archive.
