1.0.4-pre backport: fixed a possible out-of-bounds access
[rofl0r-gnuboy.git] / docs / FAQ
blob479121dc85a081a5b7babd99129dbf2c34985041
2 GNUBOY FREQUENTLY ASKED QUESTIONS
5 Q: How do I configure gnuboy?
7 A: You can specify various options to gnuboy by means of "rcvars",
8 either on the command line or in your gnuboy.rc file. To set rcvars
9 from the command line, just use --varname=value, or --no-varname to
10 turn off yes/no options. If you wish to use a gnuboy.rc file, create
11 it with any text editor and save it in ~/.gnuboy (for *nix systems) or
12 the same directory as gnuboy.exe (for DOS/Windows systems). In this
13 file you can set rcvars with lines of the form "set varname value".
14 See the sample.rc file included for examples.
17 Q: Are you planning to add serial cable (gamelink) emulation?
19 A: Yes, read the wishlist in the README. At this time we don't have
20 all the technical information to emulate it 100% correctly, so if you
21 think you can help us find the info, get in touch.
24 Q: gnuboy is too slow. How can I make it run faster?
26 A: You can try turning the sampling rate for sound down (for example,
27 --samplerate=22050) or disabling sound entirely (--no-sound). Also,
28 running at 8bpp with --rgb565 enabled will result in the highest video
29 performance at the expense of some color quality. Of course, gnuboy is
30 very fast, and shouldn't need any performance tweaks as long as your
31 system is at least as fast as a Pentium/120.
34 Q: Why did the keybindings change in 1.0?
36 A: Even though lots of emulators do it, we figured it wasn't a very
37 good idea to use modifier keys for the controls, since some systems
38 may be configured to trap these for other uses. This especially became
39 a problem after adding support for Alt+Enter to toggle fullscreen. If
40 you want to go back to the old bindings and don't want to configure
41 them yourself, you can find all the old settings (including the old
42 default palette) in classic.rc. Just copy and paste to your gnuboy.rc.
45 Q: Will gnuboy ever support recording and playback?
47 A: We get this question fairly often, and I'm never sure how to answer
48 it. We are planning to support recording audio output before too
49 terribly long, but whether full demo recording and playback will ever
50 be supported is uncertain. We'll keep it in mind for the future,
51 though.
54 Q: Why doesn't gnuboy do anything when I run it?
56 A: You need to specify the name of the ROM to load on the command
57 line. One way to do this on Windows is to drag the ROM file onto
58 gnuboy.exe (or a shortcut to it). Associating *.gb and *.gbc with
59 gnuboy also works. Of course, you can also just use the run command on
60 the start menu, or open a dos prompt. Unix users of course are
61 expected to know how to run programs.
64 Q: gnuboy doesn't run on WinNT/2k!!
66 A: Set the following environment variables before running:
67     SDL_VIDEODRIVER=windib
68     SDL_AUDIODRIVER=waveout
69 Doing so should fix problems with other SDL programs too. If it still
70 doesn't work, let us know. Your milage may vary; some people have
71 reported that this doesn't help.
74 Q: Why is sound pitch off by about 1% in gnuboy?
76 A: You have a very good ear. It's a rounding issue that won't be
77 outright fixed for a while. If you want a workaround, set the sample
78 rate to a power of two (for example 32768 works well) on the command
79 line or in your gnuboy.rc.
82 Q: Why does sound have ugly static noise on Windows?
84 A: This is a bug in SDL's DirectSound support. Try setting the
85 environment variable:
86     SDL_AUDIODRIVER=waveout
87 before running gnuboy. Hopefully this won't cause any problems.