1-- This File is outdated and need a major rewrite --
2
3-- General question --
41. What is Gngeo?
5	Gngeo is a neogeo emulator for Linux.
6
72. What are the requirement?
8	Gngeo depend on the folowing libs:
9	 . libSDL (1.2.x) from http://www.libsdl.org
10	 . zlib   from http://www.zlib.org
11	Also, if you're under a Pentium class processor, I recommend you to
12	install nasm (0.98), so you can profit of i386asm and mmx optimisation.
13	If you want opengl blitter, you need opengl dev header.
14	Of course, you need a NeoGeo bios. A neogeo bios consist of the folowing
15	files: neo-geo.rom, ng-sfix.rom and ng-lo.rom
16
173. Which platform are supported?
18	The principal devellopement platform is linux for i386. But gngeo
19	is portable, and it should compile on different architecture and OS.
20	Actually, Gngeo is regulary tested on UltraSPARC (linux and solaris).
21
224. Which features does Gngeo have?
23	. Relatively fast emulation (PII 300 in enougth in most case)
24	. Emulate arcade and home system
25	. Raster effect (use in super side kick 2,3,4 and some other game)
26	. Nebula/Kawaks transparency pack support
27	. Interpolation between frame (smoother animation)
28	. Soft, Opengl and YUV blitters
29	. Many different effects (scanline, scale2x etc.)
30	. Save state
31	. Free as in free speech
32
33-- Installation/configuration --
34
355. How do I install gngeo?
36	First, you have to install the folowing lib: libsdl and zlib.
37	This lib are available in nearly every distribution (you may have
38	to install a separate devel package ). If it's not the case, you can
39	grab the source at http://www.libsdl.org and http://www.zlib.org
40	If you are under an i386 compatible platform, then install nasm
41	(http://www.web-sites.co.uk/nasm) for asm optimisation.
42	Now you can compile gngeo with the folowing command (do not type the $ ):
43	$ ./configure
44	$ make
45
46	Then, as a super user:
47	# make install
48
49	Next step is the installation of the neogeo bios. The default place is
50	$prefix/share/gngeo, but you can install it every where, if you tell
51	gngeo where to search. To install the bios, just copy the 3 rom
52	(neo-geo.rom, ng-sfix.rom and ng-lo.rom) to the desired location.
53	Ex: You have your bios in /home/plop/neorom and you want to start
54		viewpoint (also in /home/plop/neorom)
55
56	$ gngeo -i /home/plop/neorom /home/plop/neorom/viewpoin.zip
57
58	The option -i tell to Gngeo to search roms in /home/plop/neorom
59
60	For mame lovers, you can also use the folowing command line :
61	$ gngeo -i /home/plop/neorom viewpoin
62	Gngeo will search the rom in /home/plop/neorom
63
646. How do I configure it?
65	All the configuration of Gngeo is done in one file: $HOME/.gngeo/gngeorc
66	A sample file is provide in the source distribution: sample_gngeorc
67	To configure Gngeo copy this file to $HOME/.gngeo/gngeorc and edit it.
68	Every option are also accessible on the command line (please refer to
69	man page).
70	Generaly, the option you may first look at is rompath : this define the
71	path where gngeo search the neogeo bios (-i on the command line).
72
73	Keyboard configuration:
74	The easiest way to configure your keyboard is with the folowing method:
75	- start gngeo with a game (no matter wich one)
76	- press the F4 key.
77	- Now, every time you press a key, its scancode is print one the screen.
78	- So, you just have to press successively the press you want to use, and
79	  note the associated scancode somewhere.
80	- Now edit your gngeorc file at the line p1key (or p2key), and modify
81	  the default scancode with yours
82
83	You can do exactly the same with joystick configuration (p1joy & p2joy).
84	p1joy corespond to /dev/js0 and p2joy to /dev/js1 (you can invert this
85	order with the option --invertjoy)
86
87-- Troublshooting --
88
899. Some game does nothing. I got only a blank screen...
90	Some game doesn't have a valid initial PC. Try to start gngeo with th
91	--forcepc option, it should correct your problem. If it's not the case,
92	please make a bug report.
93
94-- Misc --
95
9610. What is a transparency pack, and how I use it?
97	Transparency pack have been introduced with Nebula and Kawaks.
98	This is basicly a file that define which sprite should be draw with
99	transparency. For example, explosion in Blazing Star or special effect
100	move in King Of Fighters.
101	You can find some pack in the nebula distribution (they	have .bld extension)
102	It's pretty simple to use it with Gngeo, you just have to use the -t
103	option (ex: gngeo -t /mnt/dos/nebula/config/kof96DS.bld kof96)
104
10511. What is raster effect?
106	It's a special effect often use to simulate perspective
107	(for ex. in SuperSideKick  II,III and IV) or wave effect (Samy logo in
108	Viewpoint or The fire stage in LastBlade2). Such effect need the
109	emulation of HBlank interrupt, and thus, need a little more CPU power.
110	Since this effect is use only by some game, raster effect are not
111	enable by default. You can enable it with the -r command line, or by
112	setting the raster option to true in your gngeorc.
113
11412. What interpolation is for?
115	Since NeoGeo hardware lack transparency support, programmers generally
116	use blinking sprite to simulate it. By interpolating the current frame
117	with the last one, sprite doesn't blink anymore and become transparent.
118
11913. How can I get further help
120	A Mailing list for Gngeo is available. This mailing list can be use to
121	ask help to other people (including me). Please read the archive to
122	verify that your question has not been already answered before you post.
123	To subscribe to the list, send a mail to gngeo-request@ml.free.fr with
124	subscribe in the subject.
125	Tha mailing list archive is available at http://www.mail-archive.com/....
126
127
128