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