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