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