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