1GNGEO : A NeoGeo emulator for linux (and maybe some other unix) 2 3Licence: 4 Gngeo is build arround many different block with various licence. 5 The original code is released under the GPLV2 with this special exeption: 6 7 As a special exception, You have 8 the permission to link the code of this program with 9 independent modules,regardless of the license terms of these 10 independent modules, and to copy and distribute the resulting 11 executable under terms of your choice, provided that you also 12 meet, for each linked independent module, the terms and conditions 13 of the license of that module. An independent module is a module 14 which is not derived from or based on Gngeo. If you modify 15 this library, you may extend this exception to your version of the 16 library, but you are not obligated to do so. If you do not wish 17 to do so, delete this exception statement from your version. 18 19 Gngeo could not exist without the Mame project, and some code come 20 directly from it (the ym2610 for example). As you may know, the Mame 21 licence forbid commercial use, and as a conscequence, commercial use 22 of gngeo (as a whole) is also forbided. This is the same with Cyclone, 23 Drz80, Raze and Starscream. 24 25REQUIREMENT : 26 SDL-1.2.x and the libz 27 optional: nasm 0.98 for i386 asm optimisation 28 You will also need a neogeo BIOS 29 30INSTALLATION : 31 ./configure && make 32 then 'make install' as root 33 34 The configure script will detect the presence of nasm, and 35 choose the different CPU core in consequence. You can force 36 the use of one cpu core with the following configure switch: 37 --with-m68kcore=[cyclone|starscream|gen68k] 38 --with-z80core=[drz80|raze|mamez80] 39 40 cyclone is written in arm assembler (default on arm target) 41 starscream is written in x86 assembler (default on x86 target if nasm is found) 42 gen68k is written in portable C (default in every other case) 43 44 drz80 is written in arm assembler (default on arm target) 45 raze is written in x86 assembler (default on x86 target if nasm is found) 46 mamez80 is written in portable C (default in every other case) 47 48 To disable completly i386 assembler on x86 49 --disable-i386 50 51CROSSCOMPILATION : 52 To build gngeo in a crosscompilation environement, use the folowing 53 ./configure --build=i686-pc-linux-gnu --host=[HOST] --with-sdl-prefix=[Path to your corsscompiled SDL] CFLAGS=-I[PATH to the default include dir of your crosscompil env] 54 55USAGE : 56 You can start a game with the folowing command: 57 # gngeo game 58 where game is the mame name of the rom, for example mslug for Metal Slug 59 60Usage: gngeo [OPTION]... ROMSET 61Emulate the NeoGeo rom designed by ROMSET 62 63 --68kclock=x Overclock the 68k by x% (-x% for underclk) 64 --autoframeskip Enable auto frameskip 65 --bench Draw x frames, then quit and show average fps 66 -B, --biospath=PATH Tell gngeo where your neogeo bios is 67 -b, --blitter=Blitter Use the specified blitter (help for a list) 68 --country=... Set the contry to japan, asia, usa or europe 69 -D, --debug Start with inline debuger 70 -e, --effect=Effetc Use the specified effect (help for a list) 71 --forcepc Force the PC to a correct value at startup 72 -f, --fullscreen Start gngeo in fullscreen 73 -d, --gngeo.dat=PATH Tell gngeo where his ressource file is 74 -h, --help Print this help and exit 75 -H, --hwsurface Use hardware surface for the screen 76 -I, --interpolation Merge the last frame and the current 77 --joystick Enable joystick support 78 -l, --listgame Show all the game available in the romrc 79 --libglpath=PATH Path to your libGL.so 80 -P, --pal Use PAL timing (buggy) 81 --p1control=... Player1 control configutation 82 --p2control=... Player2 control configutation 83 --p1hotkey0=... Player1 Hotkey 0 configuration 84 --p1hotkey1=... Player1 Hotkey 1 configuration 85 --p1hotkey2=... Player1 Hotkey 2 configuration 86 --p1hotkey3=... Player1 Hotkey 3 configuration 87 --p2hotkey0=... Player2 Hotkey 0 configuration 88 --p2hotkey1=... Player2 Hotkey 1 configuration 89 --p2hotkey2=... Player2 Hotkey 2 configuration 90 --p2hotkey3=... Player2 Hotkey 3 configuration 91 -r, --raster Enable the raster interrupt 92 -i, --rompath=PATH Tell gngeo where your roms are 93 --sound Enable sound 94 --showfps Show FPS at startup 95 --sleepidle Sleep when idle 96 --screen320 Use 320x224 output screen (instead 304x224) 97 --system=... Set the system to home, arcade or unibios 98 --scale=X Scale the resolution by X 99 --samplerate=RATE Set the sample rate to RATE 100 -t, --transpack=Transpack Use the specified transparency pack 101 -v, --version Show version and exit 102 --z80clock=x Overclock the Z80 by x% (-x% for underclk) 103 104All boolean options can be disabled with --no-OPTION 105(Ex: --no-sound turn sound off) 106 107 108CONFIGURATION : 109 All configuration can be done in $HOME/.gngeo/gngeorc 110 a sample file is provide : sample_gngeorc 111 Every option are also accessible on the command line. 112 Per game configuration is also possible in $HOME/.gngeo/game.rc 113 114 By default, gngeo search bios and games in 115 $prefix/share/gngeo/ (the game must be in a zip file, the bios not) 116 117FRONTEND : 118 GGF: The first frontend available for gngeo. It's written in Java, support 119 game preview, very detailled game description and support many gngeo options. 120 - License: GPL 121 - Homepage: 122 123 XGngeo: Written in python with GTK2. Support internationalization, game preview, 124 and many configuration possibility, including a key configurator. 125 - License: GPL 126 - Homepage: http://choplair.tuxfamily.org/ 127 128 gngeogui: A new frontend written in Perl with libgtk-perl. Support game preview, and 129 nearly all the gngeo options. 130 - License: GPL 131 - Homepage: 132 133 134 135 136 137 138 139