1If you are having problems installing the software or want a step-by-
2step guide to building and using the Adonthell software, please look
3at the NEWBIE file. If you just want the quick-start version of the
4install process, here it is.
5
6Should you still have problems, please visit our tech support at
7http://savannah.gnu.org/support/?group_id=702 .
8
9
10Requirements:
11=============
12
13There are six libraries that Adonthell depends on:
14
151. Python, version 2.2.1 or later.
16
17   See http://www.python.org/
18
19
202. SDL, version 2.0 or later.
21
22   See http://www.libsdl.org/
23
24
253. SDL_mixer, version 2.0.0 or later.
26
27   See https://www.libsdl.org/projects/SDL_mixer/
28
29
304. SDL_ttf, version 2.0.12 or later.
31
32   See https://www.libsdl.org/projects/SDL_ttf/
33
34
355. Freetype, version 2.0 or later.
36
37   See http://www.freetype.org/
38
39
406. Ogg Vorbis, version 1.0rc3 or later
41
42   See http://www.xiph.org/downloads/
43
44
45Installing:
46===========
47
48From source:
49------------
50
51In the toplevel adonthell-0.3 directory type
52
53$> ./configure
54$> make
55
56and (as root)
57
58$> make install
59
60For more information, see the README file. Problems? Don't have
61the right libraries? Please look at the NEWBIE file or our website
62for answers:
63
64   http://adonthell.nongnu.org
65
66
67
68Advanced configure options:
69===========================
70
71There are a number of options to 'configure' that might be useful
72for you. For a complete list, run 'configure --help'.
73
74
75--enable-py-debug
76
77  This option turns on debugging output of the embedded python
78interpreter to locate bugs in our python scripts. If Adonthell
79behaves odd or hangs with no apparent error message, turning
80on Python debugging might reveal the source of error. On slower
81machines, you shouldn't enable this option unless you need it -
82it may considerably increase Adonthell's CPU usage.
83
84
85--enable-dlgedit
86
87  Use this to build the Adonthell dialogue editor. Note that
88this requires additional dependencies for compilation, namely
89Cairo 1.2.6 or higher and GTK+ 2.18 or higher.
90
91
92--disable-pyc
93
94  This option can be used to disable byte-compiling any included
95python scripts. Instead of compiled (.pyc) files, the raw (.py)
96source files get installed upon 'make install'.
97
98
99--enable-doc
100
101  Use this to build the Adonthell source code documentation. For
102this to work you will need two additional tools: doxygen and dot.
103
104   See http://www.doxygen.org
105
106for the first. Latter is a part of AT&T's graphviz toolkit which
107can be found at
108
109   http://www.research.att.com/sw/tools/graphviz/.
110
111  The documentation will end up in doc/<subdir>/html/ respectively
112doc/<subdir>/latex/, where subdir is one of devel or dlgedit.
113
114
115--enable-memleaks
116
117  This enables support for mtrace, a tool to find memory leaks.
118After compiling you have to set the $MALLOC_TRACE environment
119variable to any file. Running Adonthell will record debugging
120information in this file. Use 'mtrace adonthell $MALLOC_TRACE'
121to finally display any occurrence of memory leaks.
122
123  A much more convenient way to check for memory leaks is the
124'memprof' tool: http://people.redhat.com/~otaylor/memprof
125
126  Even better than memprof, but not as easy to use is valgrind:
127http://developer.kde.org/~sewardj/
128
129
130--disable-nls
131
132  Use this option to disable NLS completely. For more information
133regarding this and the previous option, read the ABOUT-NLS file in
134this directory.
135
136
137--disable-sdltest
138--disable-vorbistest
139--disable-freetypetest
140
141  If configure claims to not find the SDL library, Ogg Vorbis or
142Freetype, although they are there, or if you try to cross-compile,
143you can disable the respective test.
144
145Another way to workaround such a problem might be to recreate
146'configure' by running the 'autogen.sh' script.
147
148
149--with-<x>-prefix=PFX
150
151  This allows you to specify the path to various libraries. (replace
152the <x> with the name of the library.) This is useful if you have
153installed those libraries in unusual locations, although it might be
154better to set the $LD_LIBRARY_PATH environment variable, or to add
155those directories to /etc/ld.so.conf.
156
157
158--with-data-dir=DIR
159
160  Use this option to customise the location of the data directory.
161The default is /usr/local/share/adonthell. Once you have compiled
162Adonthell you can query the data directory with 'adonthell -d'.
163
164
165*********************************************************************
166* That's it! Enjoy the game engine and let us know what you think!! *
167*********************************************************************
168					- The Adonthell Team
169