
          * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
          *  zBoy - a GameBoy emulator for Linux, Windows and DOS.  *
          *         Copyright (C) Mateusz Viste 2010, 2011          *
          * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

+----------------------------------------------------------------------------+
| Available keys:                                                            |
|                                                                            |
| Joypad actions | Keys mapping (on default keyboard mapping)                |
|  UP            | Up arrow                                                  |
|  DOWN          | Down arrow                                                |
|  LEFT          | Left arrow                                                |
|  RIGHT         | Right arrow                                               |
|  START         | Enter (return)                                            |
|  SELECT        | TAB                                                       |
|  CTRL          | Button A                                                  |
|  ALT           | Button B                                                  |
|                                                                            |
| Emulator's functions:                                                      |
|  F1  - enables/disables game's background                                  |
|  F2  - enables/disables game's sprites                                     |
|  F5  - saves the current state of the game on disk (a.k.a. "QuickSave")    |
|  F7  - loads the saved state of the game from disk (a.k.a. "QuickLoad")    |
|  F8  - enables/disables autoscreenshot (does a screenshot every 10 seconds)|
|  F9  - performs a PCX screenshot                                           |
|  F10 - resets the CPU (restarts the game)                                  |
|  ESC - quits the emulator                                                  |
+----------------------------------------------------------------------------+

+----------------------------------------------------------------------------+
| Command-line usage:                                                        |
|  zboy [--option1 --option2 --...] file.gb                                  |
|                                                                            |
| Available options:                                                         |
|  --scale x       Scales the video screen x times. Possible values are      |
|                  1..7 (defaults to 4 = 640x576).                           |
|  --fastscale x   Same as --scale, but two times faster (displays only half |
|                  of scanlines).                                            |
|  --skipframes y  Display only every y frame. Possible values are 1..10     |
|                  (defaults to 1 = display all frames).                     |
|  --fullscreen    Use fullscreen mode (fullscreen mode is always used in    |
|                  DOS anyway).                                              |
|  --bpp x         Use a x BPP graphic driver (if not specified, 32bpp is    |
|                  used in windowed mode, and 8bpp in fullscreen mode.       |
|                  Possible values are 4, 8, 16 and 32 BPP.                  |
|  --bootlogo      Boots over the Gameboy's internal ROM (which displays a   |
|                  Nintendo logo), before executing the cartridge ROM.       |
|  --palette file  Use the palette from "file" as the display palette (must  |
|                  be a 16 color JASC palette file). By default zBoy uses a  |
|                  display palette similar to the GameBoy Micro.             |
|  --input keys    Redefine keys used to emulate the GameBoy's joypad. Need  |
|                  to be followed by the list of scancodes in this exact     |
|                  order: Up Down Left Right Start Select A B TurboA TurboB  |
|                  See the list of available scancodes below.                |
|  --fnkeys keys   Redefine keys used for calling functions of the emulator. |
|                  Need to be followed by the list of scancodes in this exact|
|                  order: bgCtrl spriteCtrl Save Load Autoshot Screenshot    |
|                  Reset Quit                                                |
|                  See the list of available scancodes below.                |
|  --nospeedlimit  Runs zBoy at full (unlimited) speed. This is not a good   |
|                  idea if you want play games, but might be useful for some |
|                  benchmarking needs.                                       |
|  --showfps       Shows the FPS counter (frames per second) onscreen. The   |
|                  FPS is displayed in the window's titlebar if in windowed  |
|                  mode, or in the upper left corner of the screen when in   |
|                  fullscreen.                                               |
|  --noscreensaver Prohibits any screen saver to start while the emulator is |
|                  running (works only on Linux so far).                     |
|  --hiscoresmem   This option will tell zBoy to memorize HiScores in games  |
|                  that aren't able to do so by themselves (eg. Pipe Dream). |
|  --rominfos      Displays various informations about the ROM.              |
+----------------------------------------------------------------------------+

+----------------------------------------------------------------------------+
| List of available scancodes (useable with --input or --fnkeys)             |
|                                                                            |
| zBoy's scancode | Description                                              |
| ----------------+------------------------------                            |
|    kb.f1        | F1 key                                                   |
|    kb.f2        | F2 key                                                   |
|    kb.f3        | F3 key                                                   |
|    kb.f4        | F4 key                                                   |
|    kb.f5        | F5 key                                                   |
|    kb.f6        | F6 key                                                   |
|    kb.f7        | F7 key                                                   |
|    kb.f8        | F8 key                                                   |
|    kb.f9        | F9 key                                                   |
|    kb.f10       | F10 key                                                  |
|    kb.f11       | F11 key                                                  |
|    kb.f12       | F12 key                                                  |
|    kb.esc       | Escape key                                               |
|    kb.tab       | TAB                                                      |
|    kb.ctrl      | Control key                                              |
|    kb.alt       | ALT key                                                  |
|    kb.spc       | Space                                                    |
|    kb.ret       | Return (enter)                                           |
|    kb.bks       | Backspace                                                |
|    kb.left      | Left arrow                                               |
|    kb.right     | Right arrow                                              |
|    kb.up        | Up arrow                                                 |
|    kb.down      | Down arrow                                               |
|    kb.rshift    | Right shift key                                          |
|    kb.lshift    | Left shift key                                           |
|    kb.lwin      | Left "Windows" key                                       |
|    kb.rwin      | Right "Windows" key                                      |
|    kb.menu      | "Menu" key                                               |
|    kb.pgup      | Page up                                                  |
|    kb.pgdw      | Page down                                                |
|    kb.home      | Home key                                                 |
|    kb.end       | End key                                                  |
|    kb.ins       | Insert key                                               |
|    kb.del       | Delete key                                               |
|    kb.a         | Key "a"                                                  |
|    kb.b         | Key "b"                                                  |
|    kb.c         | Key "c"                                                  |
|    kb.d         | Key "d"                                                  |
|    kb.e         | Key "e"                                                  |
|    kb.f         | Key "f"                                                  |
|    kb.g         | Key "g"                                                  |
|    kb.h         | Key "h"                                                  |
|    kb.i         | Key "i"                                                  |
|    kb.j         | Key "j"                                                  |
|    kb.k         | Key "k"                                                  |
|    kb.l         | Key "l"                                                  |
|    kb.m         | Key "m"                                                  |
|    kb.n         | Key "n"                                                  |
|    kb.o         | Key "o"                                                  |
|    kb.p         | Key "p"                                                  |
|    kb.q         | Key "q"                                                  |
|    kb.r         | Key "r"                                                  |
|    kb.s         | Key "s"                                                  |
|    kb.t         | Key "t"                                                  |
|    kb.u         | Key "u"                                                  |
|    kb.v         | Key "v"                                                  |
|    kb.w         | Key "w"                                                  |
|    kb.x         | Key "x"                                                  |
|    kb.y         | Key "y"                                                  |
|    kb.z         | Key "z"                                                  |
|    kb.0         | Key "0"                                                  |
|    kb.1         | Key "1"                                                  |
|    kb.2         | Key "2"                                                  |
|    kb.3         | Key "3"                                                  |
|    kb.4         | Key "4"                                                  |
|    kb.5         | Key "5"                                                  |
|    kb.6         | Key "6"                                                  |
|    kb.7         | Key "7"                                                  |
|    kb.8         | Key "8"                                                  |
|    kb.9         | Key "9"                                                  |
|    joy1.a1pos   | Axis #1 on joypad #1 (positive value of the axis)        |
|    joy1.a1neg   | Axis #1 on joypad #1 (negative value of the axis)        |
|    joy1.a2pos   | Axis #2 on joypad #1 (positive value of the axis)        |
|    joy1.a2neg   | Axis #2 on joypad #1 (negative value of the axis)        |
|    joy1.a3pos   | Axis #3 on joypad #1 (positive value of the axis)        |
|    joy1.a3neg   | Axis #3 on joypad #1 (negative value of the axis)        |
|    joy1.a4pos   | Axis #4 on joypad #1 (positive value of the axis)        |
|    joy1.a4neg   | Axis #4 on joypad #1 (negative value of the axis)        |
|    joy1.b1      | Button #1 on joypad #1                                   |
|    joy1.b2      | Button #2 on joypad #1                                   |
|    joy1.b3      | Button #3 on joypad #1                                   |
|    joy1.b4      | Button #4 on joypad #1                                   |
|    joy1.b5      | Button #5 on joypad #1                                   |
|    joy1.b6      | Button #6 on joypad #1                                   |
|    joy1.b7      | Button #7 on joypad #1                                   |
|    joy1.b8      | Button #8 on joypad #1                                   |
|    joy1.b9      | Button #9 on joypad #1                                   |
|    joy1.b10     | Button #10 on joypad #1                                  |
|    joy1.b11     | Button #11 on joypad #1                                  |
|    joy1.b12     | Button #12 on joypad #1                                  |
|    joy1.b13     | Button #13 on joypad #1                                  |
|    joy1.b14     | Button #14 on joypad #1                                  |
|    joy1.b15     | Button #15 on joypad #1                                  |
|    joy1.b16     | Button #16 on joypad #1                                  |
|    joy2.a1pos   | Axis #1 on joypad #2 (positive value of the axis)        |
|    joy2.a1neg   | Axis #1 on joypad #2 (negative value of the axis)        |
|    joy2.a2pos   | Axis #2 on joypad #2 (positive value of the axis)        |
|    joy2.a2neg   | Axis #2 on joypad #2 (negative value of the axis)        |
|    joy2.a3pos   | Axis #3 on joypad #2 (positive value of the axis)        |
|    joy2.a3neg   | Axis #3 on joypad #2 (negative value of the axis)        |
|    joy2.a4pos   | Axis #4 on joypad #2 (positive value of the axis)        |
|    joy2.a4neg   | Axis #4 on joypad #2 (negative value of the axis)        |
|    joy2.b1      | Button #1 on joypad #2                                   |
|    joy2.b2      | Button #2 on joypad #2                                   |
|    joy2.b3      | Button #3 on joypad #2                                   |
|    joy2.b4      | Button #4 on joypad #2                                   |
|    joy2.b5      | Button #5 on joypad #2                                   |
|    joy2.b6      | Button #6 on joypad #2                                   |
|    joy2.b7      | Button #7 on joypad #2                                   |
|    joy2.b8      | Button #8 on joypad #2                                   |
|    joy2.b9      | Button #9 on joypad #2                                   |
|    joy2.b10     | Button #10 on joypad #2                                  |
|    joy2.b11     | Button #11 on joypad #2                                  |
|    joy2.b12     | Button #12 on joypad #2                                  |
|    joy2.b13     | Button #13 on joypad #2                                  |
|    joy2.b14     | Button #14 on joypad #2                                  |
|    joy2.b15     | Button #15 on joypad #2                                  |
|    joy2.b16     | Button #16 on joypad #2                                  |
|    none         | No key assigned (useful if we don't need some keys)      |
|                                                                            |
+----------------------------------------------------------------------------+
         homepage: http://www.viste-family.net/mateusz/software/zboy/
