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