fix linking bug, increment version number
[btb/d2x.git] / README
1 ===========
2     D2X
3 ===========
4
5 http://icculus.org/d2x
6
7
8 Useful Links:
9 =============
10 Nasm: http://nasm.sourceforge.net
11 SDL:  http://www.libsdl.org
12
13
14 Linux/Unix:
15 ===========
16
17 Required tools:
18 * GCC 2.95 or higher
19 * SDL 1.1.0 or higher
20 * NASM 0.98 (OPTIONAL but RECOMMENDED for x86)
21 * A thread safe X server.
22 * GNU make is probably required as well.
23
24 Build instructions:
25 Install all of the components above. Next, from the d2x directory:
26
27 ./configure
28         ./configure --help will show you the available options.
29         If you have a 3d graphics card, use --with-opengl
30
31 VPATH builds also work (i.e., you can put the source in one directory
32 and build in another.  Just execute the configure script from the
33 build directory like so:
34 mkdir d2x-build
35 cd d2x-build
36 ../d2x-source/configure
37
38 make
39 make install
40
41 on systems where `make' isn't GNU make, use `gmake' instead.
42
43 see installation.txt for info on where to put your datafiles, etc.
44
45 Known bugs/issues:
46
47 * Serial support doesn't work. (UDP and IPX networking does)
48 * Sound glitches (due to stuff I haven't implemented)
49 * The mouse support is at the same level as it was in d1x (as in, it
50   kind of works) (btb: works pretty good for me.)
51
52
53 Win32:
54 ======
55
56 Required tools:
57 * Cygwin
58   d2x doesn't use Cygwin, but it makes building it easier (to me).
59   You can probably build it with just MinGW, but I haven't tried yet.
60 * SDL 1.1.0 or higher
61 * NASM 0.98 (OPTIONAL but RECOMMENDED)
62
63 Note that SDL.dll needs to be in your executable PATH, since that is
64 where windows looks for dlls.
65 I recommend copying or moving it to /usr/local/bin:
66 cp /usr/local/lib/SDL.dll /usr/local/bin
67
68 If you need to run autogen.sh (e.g. to rebuild the configure scripts,
69 or to build from cvs) sdl.m4 will have to be somewhere where aclocal
70 can find it.
71 You can fix this by setting the ACLOCAL_FLAGS variable like this:
72 export ACLOCAL_FLAGS=/usr/local/share/aclocal
73
74 Now you can configure d2x as normal.  i.e.
75 ./configure
76 or
77 ./configure --with-opengl
78
79 automake/autoconf in cygwin has a problem with not always putting the
80 .exe extentions where they need to be.  So you may have to run make
81 twice, like so:
82 make && make d2x-sdl.exe
83 or
84 make && make d2x-gl.exe
85
86 Then just copy your executable and SDL.dll into the descent2 directory.
87
88
89 MS-DOS:
90 =======
91
92 Dos support isn't a high priority right now, so things may be a little
93 messed up.
94
95 Required tools:
96 * DJGPP v2
97 The following DJGPP packages are ALL REQUIRED (newer versions are ok)!
98 v2/
99 djdev203.zip
100 v2gnu/
101 bnu281b.zip gcc2952b.zip mak3781b.zip bsh1147b.zip sed302b.zip
102 m4-14b.zip acnf213b.zip gwk304b.zip txt20b.zip grep22b.zip dif272b.zip
103 So many packages are needed to support the autoconf build system that d2x
104 uses. (Sorry! =)
105 * NASM v0.98 or better is REQUIRED
106
107
108 Build instructions:
109 Install all of the djgpp packages above. Make sure that DJGPP is properly
110 configure (see the DJGPP docs for more information).
111 Make a copy of bash.exe in your djgpp bin/ directory. Call it "sh.exe". This
112 step is VERY IMPORTANT (otherwise all the scripts will fail).
113
114 Now, run the following from the d2x directory:
115 djgpp.bat
116 make
117
118 Hopefully things will work out and the package will build correctly for you.
119
120 Known bugs/issues:
121 * Serial and network support missing.
122 * Sound support missing.
123
124
125 MAC OS X
126 ========
127
128 Install the latest version of apple's developer tools.
129 Compile and install SDL from source: d2x doesn't use Project Builder.
130
131 configure and compile as with other unices.
132
133 Known bugs/issues:
134 * Serial and network support missing
135 * GL version very buggy
136
137
138 Bugs/feedback:
139 ==============
140
141 There are three places to report bugs and give feedback:
142
143 You can get on the descent-source mailing list by sending an email to
144 majordomo@warpcore.org with the body as: "subscribe descent-source
145 <your email address>". Discussions about the source code in general
146 are available here, and is the main list that d2x and d1x, a similar
147 project for descent 1, are discussed on. Patches and questions can be
148 posted there, as well.
149
150 Use Bugzilla. https://bugzilla.icculus.org/
151
152 Contact me directly, btb@icculus.org.  I'll try to get back to you
153 ASAP, depending on real-life concerns =)