2011-10-19 06:47:12 +00:00
FCEUX SDL 2.1.6 SDL README
2009-12-31 06:08:53 +00:00
By Lukas Sabota (punkrockguy318)
2011-03-19 22:04:34 +00:00
http://www.fceux.com
2011-10-19 06:47:12 +00:00
Last Modified: October 19, 2011
2009-12-31 06:08:53 +00:00
Table of Contents
1. Requirements
2. Installation
3. Compile-time options
4. GUI
2011-03-19 22:04:34 +00:00
5. FAQ
6. Contact
2009-12-31 06:08:53 +00:00
1. Requirements
* libsdl1.2 - It is strongly recommended that you upgrade to the latest
2011-03-19 22:04:34 +00:00
version of sdl (1.2.14).
2009-12-31 06:08:53 +00:00
* scons - Required to build fceux.
2011-03-19 22:04:34 +00:00
* libgtk2.0 (optional) - recomended that you install version >= 2.18
2011-10-19 06:47:12 +00:00
* libgtk3.0 (optional) - this compiles as of fceux 2.1.6. it has seemed stable in initial testing, but expect bugs as this is new.
2009-12-31 06:08:53 +00:00
2. Installation
Fceux is installed with the scons utility. To compile, run:
scons
2011-03-19 22:04:34 +00:00
After a sucessful compilation, the fceux binary will be generated to
./src/fceux . You can install it to your path with:
2009-12-31 06:08:53 +00:00
2011-03-19 22:04:34 +00:00
sudo install -m 755 src/fceux /usr/local/bin/fceux
2009-12-31 06:08:53 +00:00
2011-10-19 06:47:12 +00:00
or by running the install.sh script which executes the same function.
You can choose to install the lua scripts (located in output/luaScripts) to a directory of your choosing:
cp -R output/luaScripts /usr/local/some/directory/that/i/will/find/later
2009-12-31 06:08:53 +00:00
3. Compile-time options
You can enable and disable certain features of fceux at build time.
2011-10-19 06:47:12 +00:00
To edit these options, edit the "BoolOptions" following the "opts.AddVariables" method
at the head of the "SConstruct" file in this source directory. The
default options will be fine for most users, but power users may want to
tweak some of these options.
2009-12-31 06:08:53 +00:00
4. GUI
2011-03-19 22:04:34 +00:00
You can enable the GTK GUI by setting GTK to 1 in the SConstruct build file.
Gfceux is deprecatiated in favor of the new GTK GUI. You can disable it at
2011-10-08 21:52:43 +00:00
run-time by passing the --nogui option, or disable it build time by setting
2011-10-19 06:47:12 +00:00
GTK to 0 in the SConstruct file. If you prefer GTK3 to GTK2, you can set the
GTK3 BoolVariable to 1 in the SConstruct.
2009-12-31 06:08:53 +00:00
2011-03-19 22:04:34 +00:00
5. FAQ
2009-12-31 06:08:53 +00:00
Q. I'm having issues with my sound!
A. First of all, for the best sound quality be sure you are using SDL 1.2.14 or later. Versions 1.2.13 and earlier are known to have problems with fceux! Next, try different SDL audio drivers to see if this makes any difference. You can do this by using this command before running fceux:
2010-03-01 17:24:05 +00:00
export SDL_AUDIODRIVER=driver
2009-12-31 06:08:53 +00:00
2010-03-01 17:24:05 +00:00
where driver is either:
2011-04-21 03:30:32 +00:00
'pulse' for pulseaudio
'alsa' for ALSA
'dsp' for OSS
'esd' for ESD
2009-12-31 06:08:53 +00:00
There are sound options that you can tweak at runtime through command line switches:
-soundq x internal sound quality hack value (0 off)
-soundrate x sound rate (sane values: 28000 48000
-soundbuffersize x (in ms) sane values (30, 50, 100, 120)
2010-02-18 23:04:03 +00:00
2011-03-19 22:04:34 +00:00
* Running fceux through esddsp is known to fix some audio issues with pulseaudio on some older Ubuntu versions.
2009-12-31 06:08:53 +00:00
2011-03-19 22:04:34 +00:00
6. Contact
If you have an issue with fceux, report it in the sourceforge bug tracker (see fceux.com). If you would like to contact the author of this readme personally, e-mail LTsmooth42 <at> gmail <dot> com. You can also check us out at #fceu on irc.freenode.net.
