add flag to disable debug mode
[rofl0r-df-libgraphics.git] / README.linux
blobb642374d69251cc6089bc299a94736ee215ad629
1 -------------------
2 System Requirements
3 -------------------
5 In addition to the hardware requirements (which will be the same as the other
6 platforms) your system will need these libraries installed:
8 * SDL 1.2+
9 * SDL_image
11 optional
12 * GTK+ 2+
14 And (optional) some kind of OpenGL implementation, so:
16 * libgl
17 * libglu
19 you need "scons" to build the source.
21 -------------------
22 Compiling
23 -------------------
24 it's not possible to compile the source with g++ 4.7.x due to
25 libstdc++ version incompatibilities with the one used by the
26 DF binary.
28 tested and known to work is g++ 4.4
29 on debian and ubuntu, you can install it via 
30 apt-get install g++-4.4
32 to compile the source, use: 
33 CXX=g++-4.4 scons [disable-gtk=1 disable-curses=1 disable-gl=1 disable-debug=1]
35 the options inside [] are optional.
36 if neither gtk nor curses are enabled, messageboxes displaying
37 information or asking questions such as "should the game run
38 fullscreen" ? are asked on the terminal window you started
39 df from, so be sure to keep an eye on it the first time
40 you start it.
42 -------------------
43 Commandline Options
44 -------------------
46 -sound_output : sets the sound system to use. Possible values:
47     ALSA - Use the Advanced Linux Sound Architecture. (default)
48     OSS  - Use the Open Sound System.
49     ESD  - Use the Enlightenment Sound Daemon.
50     
51 If you need to use one of the alternative systems and want to avoid 
52 having to run from a terminal everytime, add the switch and the sound
53 system required to the df script. 
57 -------------------
58   Known   Issues
59 -------------------
61 * If the mouse cursor is enabled, and you are running fullscreen
62   it reacts strangely around the leftmost and topmost edges of the screen.
63 * Recorded movies will flicker every few frames, with artifacts on
64   larger screen sizes.
65 * If the lock keys (caps lock, num lock, etc) do not work for you, open
66   the df file in a text editor and remove the line that reads
67   
68   export SDL_DISABLE_LOCK_KEYS=1
69   
70   it's a work around for a bug in the SDL package in Debian based distributions,
71   that reverses the behaviour of the above environmental variable.