must_free_canvas isn't used when AUTOMAP_DIRECT_RENDER is defined (whoops)
[btb/d2x.git] / installation.txt
1 Installing d2x on Windows
2 -------------------------
3
4 Unzip the binary release (d2x-x.x.x_mingw.zip), placing the files in
5 your descent2 directory (C:\GAMES\DESCENT2 by default)
6
7 You will also need the SDL and SDL_image runtime libraries.
8 Get SDL-1.2.x-win32.zip from here:
9 http://www.libsdl.org/download-1.2.php
10 And get SDL_image-1.2.x-win32.zip from here:
11 http://www.libsdl.org/projects/SDL_image/
12
13 Unzip these files and place the DLLs in your descent2 directory, or
14 you can place them in your system directory if you want to use them
15 with programs other than d2x.
16 See below for data installation.
17
18
19 Installing d2x on MacOS X
20 -------------------------
21
22 I guess we need to figure out the binary distribution first, eh?
23
24
25 Base Data Installation
26 ----------------------
27
28 In addition to d2x, you need some data files to play.
29 In Windows or DOS, they go in the same directory as the d2x binary
30 (C:\GAMES\DESCENT2 by default).  Similarly for Mac OS 9.
31 This can be overridden (see below).
32
33 On unix, these files usually go into a shared data directory
34 (/usr/local/share/games/d2x by default).
35 They can also go in $HOME/.d2x.
36
37 Files created by D2X (eg. saved games) can go in an arbitrary user
38 directory, set with the -userdir option on the command line or in a
39 settings file (d2x.ini by default).  Data files are searched for in this
40 directory first.  For Unix, the user directory defaults to $HOME/.d2x.
41
42 The settings file goes in the same directory as the binary, but an
43 additional one with more options can go in the user directory.  An
44 additional settings file cannot override settings in the first, however
45 this settings file only complements the original Descent preferences file.
46
47 Data files can go in an arbitrary directory specified with the -hogdir
48 option.
49
50 The base install depends on which version of the datafiles you have.
51 d2x currently supports just about any version of Descent II, and can
52 use almost any version of Descent I as an add-on.
53
54 Place these files into your shared data dir:
55
56 Full Version (PC or Mac):
57 descent2.ham
58 descent2.hog
59 descent2.s11
60 descent2.s22
61 alien1.pig
62 alien2.pig
63 fire.pig
64 groupa.pig
65 ice.pig
66 water.pig
67
68 If you want movies, place the .mvl files in your shared data dir:
69 intro-h.mvl and/or intro-l.mvl
70 other-h.mvl and/or other-l.mvl
71 robots-h.mvl and/or robots-l.mvl
72 The mvl files from the Mac version will not work.  They are in a
73 different format!
74
75 OEM Version (Destination: Quartzon):
76 descent2.ham
77 descent2.hog
78 descent2.s11
79 descent2.s22
80 fire.pig
81 groupa.pig
82 ice.pig
83 water.pig
84
85 If you want movies, place the .mvl files in your shared data dir:
86 intro-l.mvl
87 other-l.mvl
88 robots-h.mvl and/or robots-l.mvl
89
90 PC Shareware:
91 d2demo.ham
92 d2demo.hog
93 d2demo.pig
94
95 Mac Shareware:
96 d2demo.ham
97 d2demo.hog
98 d2demo.pig
99 descent2.s11
100 exit.ham
101 d2.mn2
102
103
104 Add-on Mission Installation
105 ---------------------------
106
107 d2x should be able to play any missions for Descent I or Descent II,
108 including the original Descent I mission (Descent: First Strike)
109
110 In order to play any add-on missions, you need to have a full set of
111 textures.  That is, your base installation above must be the "Full
112 Version", the "OEM Version", or the "Mac Shareware" version.
113
114 To install an additional mission, just place the .hog and the .msn or
115 .mn2 file into your missions directory.  d2x will search recursively for
116 missions (i.e. there can be folders within folders, containing missions).
117 The missions directory can be inside the system-wide data dir, or your user 
118 dir.  d2x will look in both places.
119
120 To install the original Descent I mission:
121 Place descent.hog into your data dir.
122
123 d2x tries to make Descent I levels look as close to the original as
124 possible, using just Descent II textures. However, if d2x finds
125 a .pig file from Descent I (except PC shareware and 1.0 versions)
126 installed in the data dir, it is able to improve the originality
127 by reading textures from there (except for animated textures).
128
129
130 Vertigo Installation
131 --------------------
132
133 Vertigo consists of both netgame enhancements (codenamed HOARD) and an
134 additional mission.  To install HOARD, place hoard.ham in your data
135 dir.  To play the vertigo mission, place d2x.hog and d2x.mn2 in your
136 mission dir.
137 If you want the movies that go with the vertigo mission, place
138 d2x-h.mvl and/or d2x-l.mvl in your data dir.
139
140
141 Notes
142 -----
143
144 In unix, all filenames must be in _lower case_. It's important.
145
146 It is not necessary to run the D2 setup program to extract the files
147 you need, just use unarj to extract the files from descent2.sow on the
148 cd.
149
150 If you use the mac demo data files, and they are not auto-detected
151 (colors come out wrong), use the -macdata switch.
152
153 If your computer has performance problems playing the movies, you can
154 tell it to play the low resolution versions by setting MovieHires=0 in
155 your descent.cfg file.
156 You can also override this setting by passing the -lowresmovies switch
157 or by deleting all *-h.mvl files.