This commit was generated by cvs2svn to compensate for changes in r2,
[btb/d2x.git] / README
1 Ok folks, this is the d2x port of descent 2.\r
2 At this stage most of descent 2 works under linux:\r
3 \r
4 Known bugs/unintentional features/missing stuff:\r
5 * Serial support doesn't work. (UDP and IPX networking does)\r
6 * Movies (unlikely ever to be supported)\r
7 * Sound glitches (due to stuff I haven't implemented)\r
8 * The mouse support is at the same level as it was in d1x (as in, it kind of works)\r
9 * Something went screwy with the control config system, it kinda got "d1xed"...\r
10 * 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 =)\r
11 \r
12 Basically, to compile this under linux:\r
13 You need the SDL 1.0 or greater, and a thread-safe X server.\r
14 Do a ./autogen.sh then a make. Cross your fingers and pray, it worked on my machine.\r
15 \r
16 For OpenGL support, try building with --with-opengl. Your mileage may vary (but basically, you need an accelerated Mesa sitting somewhere where I can see it)... The OpenGL support isn't perfect, but it works...\r
17 \r
18 There are two ways to report bugs and give feedback:\r
19 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.\r
20 \r
21 2) Send feedback directly to me, peterhawkins@ozemail.com.au. I'll try to get back to you ASAP, depending on real-life concerns =)\r
22 \r
23 \r
24 /* THE OLD README FOLLOWS */\r
25 Legal Stuff:\r
26 \r
27 THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX\r
28 SOFTWARE CORPORATION ("PARALLAX").  PARALLAX, IN DISTRIBUTING THE CODE TO\r
29 END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A\r
30 ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS\r
31 IN USING, DISPLAYING,  AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS\r
32 SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE\r
33 FREE PURPOSES.  IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE\r
34 CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES.  THE END-USER UNDERSTANDS\r
35 AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.  \r
36 COPYRIGHT 1993-1999 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.\r
37 \r
38 We make no warranties as to the usability or correctness of this code.\r
39 \r
40 ============================================\r
41 Message from Matt Toschlog & Mike Kulas:\r
42 \r
43 Descent fans:\r
44 \r
45 Here, finally, is the source for Descent II.  We've been so busy with \r
46 Descent 3, Mercenary, FreeSpace, FreeSpace 2, and several other \r
47 projects that we haven't given much thought to this old code.  But we \r
48 know that many of you are eager to get it, so here you go.\r
49 \r
50 We were amazed and impressed at the cool things people did with \r
51 the Descent source we released a few years ago.  It touches us \r
52 deeply how devoted some people are to the Descent series, and we \r
53 look forward to seeing what people can do with this Descent II \r
54 source.\r
55 \r
56 Matt Toschlog               Mike Kulas\r
57 Outrage Entertainment       Volition, Inc.\r
58 \r
59 ============================================\r
60 \r
61 About the Source Code:\r
62 \r
63 Included is almost all the source code to Descent 2, ver. 1.2.  We removed\r
64 all code to which we did not own the copyright.  This mainly involved low-\r
65 level sound and modem code and the movie code.    \r
66 \r
67 The Descent Network has agreed to provide a list of mirror locations where \r
68 this code can be downloaded. The location is:\r
69 \r
70 http://www.descent2.com/ddn/sources/descent2\r
71 \r
72 The following tools were used in the development of Descent:\r
73 Watcom C/C++, version 9.5\r
74 Microsoft Macro Assembler, version 6.1x\r
75 Opus Make, version 6.01\r
76 \r
77 Have fun with the code!\r
78 Parallax Software Corporation\r
79 12/14/1999\r
80 \r
81 \r
82 As Packaged the code currently will not compile. Some code had to be removed\r
83 to release it, therefore you will get some missing file errors when building.\r
84 \r
85 Much of this code is very close to the Descent 1 source code. Many people have\r
86 put effort into porting that code, so if you are interested in porting D2, you\r
87 should be able to take advantage of some of that work.\r
88 \r
89 A few good web sites to check out are:\r
90 \r
91 The D1X Project:\r
92 http://d1x.warpcore.org\r
93 \r
94 The Descent Network:\r
95 http://www.descent-network.com\r
96 \r