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