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.2
  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 or MinGW + MSys
  58 * SDL 1.2
  59 * NASM 0.98 (OPTIONAL but RECOMMENDED)
  60
  61 Note that SDL.dll needs to be in your executable PATH, since that is
  62 where windows looks for dlls.
  63 I recommend copying or moving it to /usr/local/bin:
  64 cp /usr/local/lib/SDL.dll /usr/local/bin
  65
  66 If you need to run autogen.sh (e.g. to rebuild the configure scripts,
  67 or to build from cvs) sdl.m4 will have to be somewhere where aclocal
  68 can find it.
  69 You can fix this by setting the ACLOCAL_FLAGS variable like this:
  70 export ACLOCAL_FLAGS=/usr/local/share/aclocal
  71
  72 Now you can configure d2x as normal.  i.e.
  73 ./configure
  74 or
  75 ./configure --with-opengl
  76
  77 Then just copy your executable and SDL.dll into the descent2 directory.
  78
  79
  80 MS-DOS:
  81 =======
  82
  83 Dos support isn't a high priority right now, so things may be a little
  84 messed up.
  85
  86 Required tools:
  87 * DJGPP v2
  88 The following DJGPP packages are ALL REQUIRED (newer versions are ok)!
  89 v2/
  90 djdev203.zip
  91 v2gnu/
  92 bnu281b.zip gcc2952b.zip mak3781b.zip bsh1147b.zip sed302b.zip
  93 m4-14b.zip acnf213b.zip gwk304b.zip txt20b.zip grep22b.zip dif272b.zip
  94 So many packages are needed to support the autoconf build system that d2x
  95 uses. (Sorry! =)
  96 * NASM v0.98 or better is REQUIRED
  97
  98
  99 Build instructions:
 100 Install all of the djgpp packages above. Make sure that DJGPP is properly
 101 configure (see the DJGPP docs for more information).
 102 Make a copy of bash.exe in your djgpp bin/ directory. Call it "sh.exe". This
 103 step is VERY IMPORTANT (otherwise all the scripts will fail).
 104
 105 Now, run the following from the d2x directory:
 106 djgpp.bat
 107 make
 108
 109 Hopefully things will work out and the package will build correctly for you.
 110
 111 Known bugs/issues:
 112 * Serial and network support missing.
 113 * Sound support missing.
 114
 115
 116 MAC OS X
 117 ========
 118
 119 Install the latest version of apple's developer tools.
 120 Compile and install SDL from source: d2x doesn't use Project Builder.
 121
 122 configure and compile as with other unices.
 123
 124
 125 Bugs/feedback:
 126 ==============
 127
 128 There are three places to report bugs and give feedback:
 129
 130 You can get on the descent-source mailing list by sending an email to
 131 majordomo@warpcore.org with the body as: "subscribe descent-source
 132 <your email address>". Discussions about the source code in general
 133 are available here, and is the main list that d2x and d1x, a similar
 134 project for descent 1, are discussed on. Patches and questions can be
 135 posted there, as well.
 136
 137 Use Bugzilla. https://bugzilla.icculus.org/
 138 This is the most reliable way to make sure your issue gets attention!
 139
 140 Contact me directly, btb@icculus.org.  I'll try to get back to you
 141 ASAP, depending on real-life concerns =)