don't need no more
[btb/d2x.git] / README
1 ===========
2     D2X
3 ===========
4
5 http://icculus.org/d2x
6
7
8 Linux/Unix:
9 ===========
10
11 Required tools:
12 * GCC 2.95
13 * SDL 1.1.0 or higher
14 * NASM 0.98 (OPTIONAL but RECOMMENDED for x86)
15 * A thread safe X server.
16 * Make, sed, etc...
17
18 Build instructions:
19 Install all of the components above. Next, from the d2x directory:
20
21 ./configure
22         ./configure --help will show you the available options.
23         If you have a 3d graphics card, use --with-opengl
24
25 VPATH builds also work (i.e., you can put the source in one directory
26 and build in another.  Just execute the configure script from the
27 build directory like so:
28 mkdir d2x-build
29 cd d2x-build
30 ../d2x-source/configure
31
32 make
33 make install
34
35 see installation.txt for info on where to put your datafiles, etc.
36
37 Known bugs/issues:
38
39 * Serial support doesn't work. (UDP and IPX networking does (btb: it
40   does? UDP?!))
41
42
43 * Sound glitches (due to stuff I haven't implemented)
44 * The mouse support is at the same level as it was in d1x (as in, it
45   kind of works) (btb: works pretty good for me.)
46
47
48 Win32:
49 ======
50
51 Required tools:
52 * Cygwin
53   d2x doesn't use Cygwin, but it makes building it easier (to me).
54   You can probably build it with just MinGW, but I haven't tried yet.
55 * SDL 1.1.0 or higher
56 * NASM 0.98 (OPTIONAL but RECOMMENDED)
57
58 You will probably have to compile SDL from source.
59 Download the source code tarball from http://www.libsdl.org/
60
61 tar zxf SDL-x.x.x.tar.gz
62 cd SDL-x.x.x
63 ./configure
64 make
65 make install
66
67 Note that SDL.dll needs to be in your executable PATH, since that is
68 where windows looks for dlls.
69 I recommend copying or moving it to /usr/local/bin:
70 cp /usr/local/lib/SDL.dll /usr/local/bin
71
72 If you need to run autogen.sh (e.g. to rebuild the configure scripts,
73 or to build from cvs) sdl.m4 will have to be somewhere where aclocal
74 can find it.
75 You can fix this by setting the ACLOCAL_FLAGS variable like this:
76 export ACLOCAL_FLAGS=/usr/local/share/aclocal
77
78 You should also install NASM, for compiling assembler files.  Download
79 it from http://www.web-sites.co.uk/nasm/where.html and place nasmw.exe
80 somewhere in your path (e.g. /usr/local/bin):
81 unzip nasm-0.98-win32.zip
82 mv nasmw.exe /usr/local/bin
83
84 Now you can configure d2x as normal.  i.e.
85 ./configure
86 or
87 ./configure --with-opengl
88
89 automake/autoconf in cygwin has a problem with not always putting the
90 .exe extentions where they need to be.  So you may have to run make
91 twice, like so:
92 make && make d2x-sdl.exe
93 or
94 make && make d2x-gl.exe
95
96 Then just copy your executable and SDL.dll into the descent2 directory.
97
98
99 MS-DOS:
100 =======
101
102 Dos support isn't a high priority right now, so things may be a little
103 messed up.
104
105 Required tools:
106 * DJGPP v2
107 The following DJGPP packages are ALL REQUIRED (newer versions are ok)!
108 v2/
109 djdev203.zip
110 v2gnu/
111 bnu281b.zip gcc2952b.zip mak3781b.zip bsh1147b.zip sed302b.zip
112 m4-14b.zip acnf213b.zip gwk304b.zip txt20b.zip grep22b.zip dif272b.zip
113 So many packages are needed to support the autoconf build system that d2x
114 uses. (Sorry! =)
115 * NASM v0.98 or better is REQUIRED
116
117
118 Build instructions:
119 Install all of the djgpp packages above. Make sure that DJGPP is properly
120 configure (see the DJGPP docs for more information).
121 Make a copy of bash.exe in your djgpp bin/ directory. Call it "sh.exe". This
122 step is VERY IMPORTANT (otherwise all the scripts will fail).
123
124 Now, run the following from the d2x directory:
125 djgpp.bat
126 make
127
128 Hopefully things will work out and the package will build correctly for you.
129
130 Known bugs/issues:
131 * Serial and network support missing.
132 * Sound support missing.
133
134
135
136 Reporting bugs/feedback:
137 ========================
138
139 There are two ways to report bugs and give feedback:
140 1) Get on the descent-source mailing list by sending an email to
141 majordomo@warpcore.org with the body as: "subscribe descent-source
142 <your email address>". Discussions about the source code in general
143 are available here, and is the main list that d2x and d1x, a similar
144 project for descent 1 is discussed on. Patches and questions can be
145 posted there, as well.
146
147 2) Send feedback directly to me, bradleyb@u.washington.edu. I'll try
148 to get back to you ASAP, depending on real-life concerns =)
149
150 /* THE OLD README FOLLOWS */
151 Legal Stuff:
152
153 THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
154 SOFTWARE CORPORATION ("PARALLAX").  PARALLAX, IN DISTRIBUTING THE CODE TO
155 END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
156 ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
157 IN USING, DISPLAYING,  AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
158 SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
159 FREE PURPOSES.  IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
160 CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES.  THE END-USER UNDERSTANDS
161 AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.  
162 COPYRIGHT 1993-1999 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.
163
164 We make no warranties as to the usability or correctness of this code.
165
166 ============================================
167 Message from Matt Toschlog & Mike Kulas:
168
169 Descent fans:
170
171 Here, finally, is the source for Descent II.  We've been so busy with 
172 Descent 3, Mercenary, FreeSpace, FreeSpace 2, and several other 
173 projects that we haven't given much thought to this old code.  But we 
174 know that many of you are eager to get it, so here you go.
175
176 We were amazed and impressed at the cool things people did with 
177 the Descent source we released a few years ago.  It touches us 
178 deeply how devoted some people are to the Descent series, and we 
179 look forward to seeing what people can do with this Descent II 
180 source.
181
182 Matt Toschlog               Mike Kulas
183 Outrage Entertainment       Volition, Inc.
184
185 ============================================
186
187 About the Source Code:
188
189 Included is almost all the source code to Descent 2, ver. 1.2.  We removed
190 all code to which we did not own the copyright.  This mainly involved low-
191 level sound and modem code and the movie code.    
192
193 The Descent Network has agreed to provide a list of mirror locations where 
194 this code can be downloaded. The location is:
195
196 http://www.descent2.com/ddn/sources/descent2
197
198 The following tools were used in the development of Descent:
199 Watcom C/C++, version 9.5
200 Microsoft Macro Assembler, version 6.1x
201 Opus Make, version 6.01
202
203 Have fun with the code!
204 Parallax Software Corporation
205 12/14/1999
206
207
208 As Packaged the code currently will not compile. Some code had to be removed
209 to release it, therefore you will get some missing file errors when building.
210
211 Much of this code is very close to the Descent 1 source code. Many people have
212 put effort into porting that code, so if you are interested in porting D2, you
213 should be able to take advantage of some of that work.
214
215 A few good web sites to check out are:
216
217 The D1X Project:
218 http://d1x.warpcore.org
219
220 The Descent Network:
221 http://www.descent-network.com
222