SConscript: do not ignore PKG_CONFIG env vars needed for crosscompiles
[rofl0r-df-libgraphics.git] / README.linux
blobf1fc223f0ca573868ac64d65503f86427a6d70e3
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 and g++ 4.5
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 CXXFLAGS="-O3 fomit-frame-pointer" LDFLAGS=-s \
34   scons [disable-gtk=1 disable-curses=1 disable-gl=1 disable-debug=1]
36 the options inside [] , as well as the environment variables
37 CXX, CXXFLAGS, LDFLAGS are optional.
39 if neither gtk nor curses are enabled, messageboxes displaying
40 information or asking questions such as "should the game run
41 fullscreen" ? are asked on the terminal window you started
42 df from, so be sure to keep an eye on it the first time
43 you start it.
45 -------------------
46 Commandline Options
47 -------------------
49 -sound_output : sets the sound system to use. Possible values:
50     ALSA - Use the Advanced Linux Sound Architecture. (default)
51     OSS  - Use the Open Sound System.
52     ESD  - Use the Enlightenment Sound Daemon.
53     
54 If you need to use one of the alternative systems and want to avoid 
55 having to run from a terminal everytime, add the switch and the sound
56 system required to the df script. 
60 -------------------
61   Known   Issues
62 -------------------
64 * If the mouse cursor is enabled, and you are running fullscreen
65   it reacts strangely around the leftmost and topmost edges of the screen.
66 * Recorded movies will flicker every few frames, with artifacts on
67   larger screen sizes.
68 * If the lock keys (caps lock, num lock, etc) do not work for you, open
69   the df file in a text editor and remove the line that reads
70   
71   export SDL_DISABLE_LOCK_KEYS=1
72   
73   it's a work around for a bug in the SDL package in Debian based distributions,
74   that reverses the behaviour of the above environmental variable.