
    Welcome to Dingux MSX

Original Author of fMSX

  fMSX-SDL port            by Vincent van Dam (2001).
  Original fMSX            by Marat Fayzullin (1994-2001).
  YM2413/PSG/SCC emulation by Mitsutaka Okazaki (2001).
  Y8950 emulation          by Tatsuyuki Satoh (1999/2000).

Author of the Dingoo/Dingux port version 

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


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

  fMSX emulates MSX, MSX2, and MSX2+ 8bit home computers. It runs MSX/MSX2/MSX2+
  software on many different platforms including Windows, MacOS, Unix, MSDOS, 
  AmigaOS, etc. See http://fms.komkon.org/fMSX/ for further informations.

  Dingux MSX is a port on Dingoo/Dingux of my previous GP2X-Wiz port version.

  The Dingux part of this package is under GPL Copyright, read COPYING file for more 
  information about it. Original fMSX code is under "Marat Fayzullin's license" 
  (see http://fms.komkon.org/fMSX/ for details).


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

  Unzip the zip file, and copy the content of the directory local to your
  SD card.

  Put your rom image files on "roms" sub-directory.

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

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

3.1 - Virtual keyboard

  In the 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 Dingux trigger keys.

  In the MSX emulator window 
  
  Normal mapping :
  
    Dingux        MSX 
      
    Y          Delete
    X          Return
    B          Space
    A          Fire1
    Up         Up
    Down       Down
    Left       Left
    Right      Right
  
  LTrigger   Toogle with L keyboard mapping
  RTrigger   Toggle with R keyboard mapping
  
  LTrigger mapping :
  
    Dingux        MSX 
      
    Y          Hotkey FPS
    X          Hotkey Load state
    B          Hotkey Save state
    A          Hotkey render
    Up         Up
    Down       Down
    Left       Left
    Right      Right
  
  RTrigger mapping :
  
    Dingux        MSX 
      
    Y          Escape
    X          Return
    B          Hotkey auto-fire
    A          Fire2
    Up         Up
    Down       Down
    Left       Left
    Right      Right
  
  Press Menu      to enter in emulator main menu.
  Press Select    open/close the virtual keyboard
  
  In the main menu
  
  RTrigger   Reset the emulator
  
  X          Go Up directory
  B          Valid
  A          Valid
  Y          Go Back to the emulator window
  
  The On-Screen Keyboard of "Danzel" and "Jeff Chen"
  
  Use digital pad to choose one of the 9 squares, and
  use X, Y, A, B to choose one of the 4 letters of the
  highlighted square.
  
  Use LTrigger and RTrigger to see other 9 squares
  figures.
  

4. LOADING MSX ROM FILES
   ------------

  If you want to load rom image in your emulator, you have to put your rom
  file (with .zip, .rom, .mx1 or .mx2 file extension) on your SD card
  in the 'roms' directory.

  Then, while inside DinguxMSX emulator, just press SELECT to enter in 
  the emulator main menu, and then using the file selector choose one 
  rom file to load in your emulator.

  Back to the emulator window, the rom should stard automatically.

  To eject a ROM choose "Eject Rom" inside the emulator menu.

  You can use the virtual keyboard in the file requester menu to choose the
  first letter of the game you search (it might be useful when you have tons of
  games in the same folder). 

  Entering several time the same letter let you choose sequentially files
  beginning with the given letter. You can use the Run key of the virtual
  keyboard to launch the rom.

  You may use the Trigger key to swap between the two virtual keyboard panels
  (numbers & letters)


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

  If you want to load disk image in the virtual drive A or B of your emulator,
  you have to put your disk file (with .dsk file extension, or gzipped disk file
  with .dsz file extension) on your SD card in the 'disk' directory. 

  Gzipped disk files are not writable.

  You proceed as previously described for ROM files, and your disk is then
  inserted in the drive 'A' of your emulator.

  To start your disk, you have to choose the "Reset MSX" option and back to 
  the emulator window, the MSX should reboot and stard your disk automatically.

  You must eject any present rom before starting a disk, or only the 
  ROM will start instead of your disk image.

6. COMMENTS
   ------------

You can write your own comments for games using the "Comment" menu.  The first
line of your comments would then be displayed in the file requester menu while
selecting the given file name (snapshot, disk, keyboard, settings).


7. LOADING KEY MAPPING FILES
   ------------

  For given games, the default keyboard mapping between Dingux Keys and
  MSX keys, is not suitable, and the game can't be played on DinguxMSX.

  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 rom filename (.zip etc ...)
  then when you load this rom, 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.

  If you have saved the state of a game, then a thumbnail image will
  be displayed in the file requester while selecting any file (rom, disk,
  keyboard, settings) with game name, to help you to recognize that game later.


8. CHEAT CODE (.CHT)
   ----------

  You can use cheat codes with Dingux-MSX You can add your own cheat codes in the
  cheat.txt file and then import them in the cheat menu.

  All cheat codes you have specified for a game can be save in a CHT file 
  in 'cht' folder.  Those cheat codes would then be automatically loaded
  when you start the game.

  The CHT file format is the following :
  #
  # Enable, Address, Value, Comment
  #
  1,36f,3,Cheat comment

  Using the Cheat menu you can search for modified bytes in RAM between
  current time and the last time you saved the RAM. It might be very usefull to
  find "poke" address by yourself, monitoring for example life numbers.

  To find a new "poke address" you can proceed as follow :

  Let's say you're playing "1942" and you want to find the memory
  address where "number lives" is stored.

  . Start a new game in 1942
  . Enter in the cheat menu. 
  . Choose Save Ram to save initial state of the memory. 
  . Specify the number of lives you want to find in
    "Scan Old Value" field.
    (for 1942 the initial lives number is 4)
  . Go back to the game and loose 1 life.
  . Enter in the cheat menu.
  . Specify the number of lives you want to find in
    "Scan New Value" field.
    (for 1942 the lives number is now 3)
  . In Add Cheat you have many matching Addresses
  . Then go back to the game and loose more lives
    let's say up to 0.
  . Enter in the cheat menu.
  . Specify the number of lives you want to find in
    "Scan New Value" field.
    (for 1942 the lives number is now 0)
  . In Add Cheat you have now only one matching Address
  . Specify the Poke value you want (for example 4) 
    and add the new cheat with this address / value.
  . Try this cheat while restarting a new game and see 
    if the life number is 4 or not. You will see that 
    the good address is 2D2F.

  The cheat is now activated in the cheat list 
  and you can save it using the "Save cheat" menu.

  Let's enjoy 1942 with infinite life !!

9. SETTINGS
   ------------

  You can modify several settings value in the settings menu of this emulator.
  The following parameters are available :

  Sound enable       : enable or disable the sound
  Music FM-PAC       : emulate specific FM-PAC hardware (slow)
  Music Module       : emulate specific music hardware (slow)
  Sound volume       : Boost sound volume
  Video Mode         : NTSC or PAL video standard
  Speed limiter      : limit the speed to a given fps value
  Skip frame         : to skip frame and increase emulator speed
  Display fps        : display real time fps value 
  MSX version        : MSX version 1, 2 or 2+
  MSX Ram size       : memory size of MSX
  Render mode        : many render modes are available with different 
                       geometry that should covered all games requirements
  V-Sync             : vertical synchronisation (slow down the emulator)
  Clock frequency    : Dingux clock frequency, by default the value is set to
                       200Mhz, and should be enough for most of all games.

10. JOYSTICK SETTINGS
   ------------

  You can modify several joystick settings value in the settings menu of this emulator.
  The following parameters are available :

  Swap Analog/Cursor : swap key mapping between Dingux analog pad and Dingux digital pad
  Auto fire period   : auto fire period
  Auto fire mode     : auto fire mode active or not


11. COMPILATION
   ------------

  It has been developped under Linux FC9 using gcc with DINGUX SDK. 
  All tests have been done using a Dingoo with Dingux installed
  To rebuild the homebrew run the Makefile in the src archive.

  Enjoy,

            Zx
