Subversion Repositories duke3d_hrp

Rev

Rev 690 | Rev 695 | Go to most recent revision | Only display areas with differences | Regard whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 690 Rev 694
1
                   ==========================================
1
                   ==========================================
2
                   |              Duke Nukem 3D             |
2
                   |              Duke Nukem 3D             |
3
                   |        Maphacks for the EDuke32        |
3
                   |        Maphacks for the EDuke32        |
4
                   |       High Resolution Pack (HRP)       |
4
                   |       High Resolution Pack (HRP)       |
5
                   |                   or                   |
5
                   |                   or                   |
6
                   |               Voxel Pack               |
6
                   |               Voxel Pack               |
7
                   |                                        |
7
                   |                                        |
8
                   ==========================================
8
                   ==========================================
9
 
9
 
10
 
10
 
11
 
11
 
12
 
12
 
13
=======================
13
=======================
14
CONTENTS OF THIS README
14
CONTENTS OF THIS README
15
=======================
15
=======================
16
 
16
 
17
1) About
17
1) About
18
2) Installation
18
2) Installation
19
3) Notes
19
3) Notes
20
4) Support for NightFright's Addon Pack
20
4) Support for NightFright's Addon Compilation
21
5) License
21
5) License
22
6) Contact/Links
22
6) Contact/Links
23
7) Credits
23
7) Credits
24
8) Changelog
24
8) Changelog
25
 
25
 
26
 
26
 
27
1) ABOUT
27
1) ABOUT
28
========
28
========
29
 Maphacks are used to edit the positioning of objects and other parts of a level
29
 Maphacks are used to edit the positioning of objects and other parts of a level
30
in cases where the maps cannot be redistributed. These maphacks' goal is to
30
in cases where the maps cannot be redistributed. These maphacks' goal is to
31
improve the compatibility of user created maps with the HRP or the Voxel Pack.
31
improve the compatibility of user created maps with the HRP or the Voxel Pack.
32
Since there is no central site for map downloads, patching the maps directly
32
Since there is no central site for map downloads, patching the maps directly
33
would lead to quite some confusion among players about their respective
33
would lead to quite some confusion among players about their respective
34
versions. By distributing separated maphacks the original map download archives
34
versions. By distributing separated maphacks the original map download archives
-
 
35
can be kept unchanged. The maphacks are now part of the HRP, but this pack is
35
can be kept unchanged.
36
updated more frequently.
36
 
37
 
37
 
38
 
38
2) INSTALLATION
39
2) INSTALLATION
39
===============
40
===============
40
 Technically this is like an HRP update pack with maphack additions and 
41
 Technically this is like an HRP update pack with maphack additions and 
41
updates only - therefore, if your current HRP's (or regular HRP update pack's) 
42
updates only - therefore, if your current HRP's (or regular HRP update pack's) 
42
version number is greater than ours, don't use this pack.
43
version number is greater than ours, don't use this pack.
43
 
44
 
44
Drop this pack into the autoload folder alongside your HRP (5.4 or later) and 
45
Drop this pack into the autoload folder alongside your HRP (5.4 or later) and 
45
you should be done.
46
you should be done.
46
 
-
 
-
 
47
(Standalone invocation: eduke32 -g UserMapHacks.zip -mh maphacks/maphacks.def)
47
 
48
 
48
You need a recent EDuke32 executable which has the UserMapHacks functions 
49
You need a recent EDuke32 executable which has the UserMapHacks functions 
49
implemented - at least r4886 (source r4884). (HRP 5.4 comes with r5267.)
50
implemented - at least r4886 (source r4884). (HRP 5.4 comes with r5267.)
50
 
51
 
51
Currently users are reporting various issues with recent EDuke32 builds. If you 
52
Currently users are reporting various issues with recent EDuke32 builds. If you 
52
should encounter problems as well, try the r4495 version with backported 
53
should encounter problems as well, try the r4495 version with backported 
53
UserMapHack functions from the "Other Stuff" link below.
54
UserMapHack functions from the "Other Stuff" link below.
54
 
55
 
55
Your eduke32.log should contain one or more lines similar to this after playing:
56
Your eduke32.log should contain one or more lines similar to this after playing:
56
   Loaded map hack file "maphacks/usermaps/foobar.mhk"
57
   Loaded map hack file "maphacks/usermaps/foobar.mhk"
57
 
58
 
58
 
59
 
59
3) NOTES
60
3) NOTES
60
========
61
========
61
 The main goal is to get rid of the most annoying HRP-related problems of 
62
 The main goal is to get rid of the most annoying HRP-related problems of 
62
popular (highly rated by reviewers) and recently released user maps. 
63
popular (highly rated by reviewers) and recently released user maps. 
63
Since the Introduction of the Poymer renderer in 2009 and the big HRP model 
64
Since the Introduction of the Poymer renderer in 2009 and the big HRP model 
64
rotation in early 2012 (r5.1.295), even maps which were designed with the HRP 
65
rotation in early 2012 (r5.1.295), even maps which were designed with the HRP 
65
in mind need some adjustments. 
66
in mind need some adjustments. 
66
Do not expect a maphack quality comparable to what has been done for the 
67
Do not expect a maphack quality comparable to what has been done for the 
67
original game's levels, though. No Polymer lighting for example.
68
original game's levels, though. No Polymer lighting for example.
68
 
69
 
69
A few older maps make use of tricks which can't be reproduced (yet?) using the 
70
A few older maps make use of tricks which can't be reproduced (yet?) using the 
70
modern OpenGL renderers. Some recent maps' README files explicitly state that 
71
modern OpenGL renderers. Some recent maps' README files explicitly state that 
71
the respective map is meant to be played without fancy renderers or the HRP.
72
the respective map is meant to be played without fancy renderers or the HRP.
72
Remember that these maphacks do not claim to make those maps look as intended 
73
Remember that these maphacks do not claim to make those maps look as intended 
73
if you are using the HRP anyway, but try to fix the obvious glitches as far as 
74
if you are using the HRP anyway, but try to fix the obvious glitches as far as 
74
it is technically possible. Do not complain to mappers, do not ask them to 
75
it is technically possible. Do not complain to mappers, do not ask them to 
75
'fix' their map if it looks bad when HRPlaying it.
76
'fix' their map if it looks bad when HRPlaying it.
76
 
77
 
77
Some other maps and episodes come with custom textures. Tiles014.art, 
78
Some other maps and episodes come with custom textures. Tiles014.art, 
78
tiles15.art, tiles20.art and up, will technically never interfere with the HRP, 
79
tiles15.art, tiles20.art and up, will technically never interfere with the HRP, 
79
whereas extensive use of custom textures may look off when combined with 
80
whereas extensive use of custom textures may look off when combined with 
80
the HRP. In case of conflicting ART I may have added a README and/or a ZIP file 
81
the HRP. In case of conflicting ART I may have added a README and/or a ZIP file 
81
to explain or improve compatibility. But even if a maphack and further 
82
to explain or improve compatibility. But even if a maphack and further 
82
compatibility improvements exist, it's still your decision to HRPlay or not.
83
compatibility improvements exist, it's still your decision to HRPlay or not.
83
 
84
 
84
This Pack is suitable for the Voxel Pack as well, although only the 'angoff'
85
This Pack is suitable for the Voxel Pack as well, although only the 'angoff'
85
directive (model rotation) works currently on voxels (EDuke32 r5771). 
86
directive (model rotation) works currently on voxels (EDuke32 r5811). 
86
But that's the most commonly used correction anyway.
87
But that's the most commonly used correction anyway.
87
 
88
 
88
 
89
 
89
You can help:
90
You can help:
90
 
91
 
91
 - If you find anything you consider worthy correcting in an already maphacked
92
 - If you find anything you consider worthy correcting in an already maphacked
92
level, don't hesitate to report it (DNCOORDS!), and which renderer/HRP version
93
level, don't hesitate to report it (DNCOORDS!), and which renderer/HRP version
93
you are using. Some models (like the 0603 hangbabe) might need different
94
you are using. Some models (like the 0603 hangbabe) might need different
94
maphacks and some floor/ceiling aligned sprites may show up different
95
maphacks and some floor/ceiling aligned sprites may show up different
95
(or not at all) in either Polymost or Polymer renderer/HRP.
96
(or not at all) in either Polymost or Polymer renderer/HRP.
96
 
97
 
97
 - You can contribute your own maphacks. Basic information is available at:
98
 - You can contribute your own maphacks. Basic information is available at:
98
     http://wiki.eduke32.com/wiki/Maphack_Language
99
     http://wiki.eduke32.com/wiki/Maphack_Language
99
 
100
 
100
 - If you have a newer version of an already maphacked level, please let LeoD
101
 - If you have a newer version of an already maphacked level, please let LeoD
101
   know. (But compare the checksums first.)
102
   know. (But compare the checksums first.)
102
 
103
 
103
 
104
 
104
4) Support for NightFright's Addon Pack 2.0
105
4) Support for NightFright's Addon Compilation 3.0
105
===========================================
106
==================================================
106
A full set of maphacks is available for each of the following GRPs (208):
107
A full set of maphacks is available for each of the following GRPs (234):
107
  adg.grp       (5)
108
  adg.grp             (5)
108
  aqua_grp      (3)
109
  aqua.grp            (3)
109
  bf3.grp       (3)
110
  battlefield3.grp    (3)
110
  bobsp.grp     (5)
111
  bobsp.grp           (5)
-
 
112
  bravenworld.grp     (5) - Check out HRP-BNW-compatibility.zip
111
  cbp.grp       (8)
113
  castlequest.grp     (7)
112
  chronic.grp   (5) - Check out HRP-TheChronic-compatibility.zip
114
  chronic.grp         (5) - Check out HRP-TheChronic-compatibility.zip
-
 
115
  commbuild.grp       (8)
113
  conflict.grp  (3)
116
  crucialconflict.grp (3)
114
  daikarin.grp  (7) - Check out HRP-DaikariN-compatibility.zip
117
  daikarin.grp        (7) - Check out HRP-DaikariN-compatibility.zip
-
 
118
  darkplace.grp       (5)
115
  deadrive.grp  (5)
119
  deathdrive.grp      (5)
116
  dn64rev.grp   (3)
120
  dn64revisited.grp   (3)
117
  duke10.grp    (3)
121
  dreamtrilogy_grp    (3)
118
  dukehard.grp (17) - Check out HrpDukePlus-DukeHard-compatibility.zip
122
  dukehard.grp       (17) - Check out HrpDukePlus-DukeHard-compatibility.zip
-
 
123
  duketen.grp         (3)
-
 
124
  fbsp.grp            (3)
119
  glavic.grp   (10) 
125
  glavic.grp         (10) 
120
  kaiser.grp    (3)
126
  kaiserland.grp      (3)
-
 
127
  lorch.grp           (3)
121
  losthway.grp  (7)
128
  losthighway.grp     (7)
122
  math_pak.grp  (5)
129
  mathpak.grp         (5)
123
  metromay.grp (15)
130
  metromayhem.grp    (15)
124
  milltown.grp  (2)
131
  milltown.grp        (2)
125
  mssp3.grp     (8)
132
  mssp.grp            (8)
126
  opblitz.grp   (5)
133
  opblitzkrieg.grp    (5)
127
  plugpray.grp  (7)
134
  plugpray.grp        (7)
-
 
135
  prequel2time.grp    (4)
128
  red.grp       (7)
136
  red.grp             (7)
-
 
137
  redrum.grp          (1)
129
  roch.grp      (9)
138
  roch.grp            (9)
130
  showdown.grp (21) - Check out HRP-NuclearShowdown-compatibility.zip ???
139
  showdown.grp       (21) - Check out HRP-NuclearShowdown-compatibility.zip ???
131
  spcmissn.grp  (2)
140
  spcmissn.grp        (2)
132
  taivo.grp    (10)
141
  spiegul.grp         (3)
-
 
142
  sunburn.grp         (2)
133
  tbnw.grp      (5) - Check out HRP-BNW-compatibility.zip
143
  taivo.grp           (5)
134
  undertkr.grp  (5)
144
  undertaker.grp      (5)
135
  vermin.grp   (12)
145
  verminclear.grp    (12)
136
  wgspace.grp   (8)
146
  wgspace.grp         (8)
137
 
147
 
138
Maphacks for the following GRPs are not yet completed (121/194):
148
Maphacks for the following GRPs are not yet completed (124/198):
139
  c3po.grp     :  2/4
149
  c3po.grp       :  2/4
140
  escape.grp   :  2/5
150
  escape.grp     :  2/5
141
  fm3x.grp     : 34/42 - FM1X-FM3X
151
  fm3x.grp       : 34/42 - FM1X-FM3X done
142
  forklift.grp :  4/12 - PRETIME Episode
152
  jungletour.grp :  1/3
143
  kucera.grp   :  4/11
153
  kucera.grp     :  4/11
-
 
154
  pinxten.grp    ;  5/9
-
 
155
  pipeline.grp   ;  2/7
144
  quakis.grp   :  6/8
156
  quakis.grp     :  6/8
145
  space.grp    : 19/33
157
  space.grp      : 18/30
146
  urban.grp    : 50/79
158
  urban.grp      : 50/79
147
 
159
 
148
Some GRPs' high resolution contents have been left out from the Addon Pack:
160
Some GRPs' high resolution contents have been left out from the Addon Pack:
149
  inftime.grp  : 39/39 : Check out IITTC-HRP-compatibility.zip
161
  infestation.grp : 39/39 : Check out IITTC-HRP-compatibility.zip
150
  moonbase.grp :  9/9
162
  moonbase.grp    :  9/9
151
  wgrealms.grp :  6/6
163
  wgrealms.grp    :  6/6
152
They will probably get recompiled for HRP with the Addon's maps included (54).
164
They will probably get recompiled for HRP with the Addon's maps included (54).
153
They'll become available at the "Other Stuff" link below.
165
They'll become available at the "Other Stuff" link below.
154
 
166
 
155
Most other GRPs included in the Addon Pack are probably not compatible with the
167
Most other GRPs included in the Addon Pack are probably not compatible with the
156
HRP, but they need to be actually checked out, though.
168
HRP, but they need to be actually checked out, though.
157
 
169
 
158
 
170
 
159
5) LICENSE
171
5) LICENSE
160
==========
172
==========
161
 Maphacks for the original game's maps and official addon maps (Nuclear Winter, 
173
 Maphacks for the original game's maps and official addon maps (Nuclear Winter, 
162
Duke in D.C., Caribbean/Vacation) are covered by the HRP Art License.
174
Duke in D.C., Caribbean/Vacation) are covered by the HRP Art License.
163
You are free to copy, alter, reproduce, and redistribute all other maphack files
175
You are free to copy, alter, reproduce, and redistribute all other maphack files
164
as long as their original author[s] are credited in each *.mhk respectively.
176
as long as their original author[s] are credited in each *.mhk respectively.
165
 
177
 
166
 
178
 
167
6) CONTACT/LINKS
179
6) CONTACT/LINKS
168
================
180
================
169
  You can check the related EDuke32 forum thread over at Duke4.net:
181
  You can check the related EDuke32 forum thread over at Duke4.net:
170
  https://forums.duke4.net/index.php?showtopic=6070
182
  https://forums.duke4.net/index.php?showtopic=6070
171
 
183
 
172
Contact:
184
Contact:
173
--------
185
--------
174
  https://forums.duke4.net/index.php?showuser=1299
186
  https://forums.duke4.net/index.php?showuser=1299
175
 
187
 
176
Related Links:
188
Related Links:
177
--------------
189
--------------
178
  Duke4.net ................................... http://www.duke4.net
190
  Duke4.net ................................... http://www.duke4.net
179
  Duke Nukem 3D High-Resolution Pack .......... http://hrp.duke4.net
191
  Duke Nukem 3D High-Resolution Pack .......... http://hrp.duke4.net
180
  NightFright's Addon Pack .................... http://hrp.duke4.net
192
  NightFright's Addon Pack .................... http://hrp.duke4.net
181
  EDuke32 port ................................ http://eduke32.com
193
  EDuke32 port ................................ http://eduke32.com
182
  RHash checksum generator .................... http://rhash.anz.ru
194
  RHash checksum generator .................... http://rhash.anz.ru
183
  Maphacks in the HRP repository ... http://svn.eduke32.com/polymer_hrp/maphacks
195
  Maphacks in the HRP repository ... http://svn.eduke32.com/polymer_hrp/maphacks
184
 
196
 
185
Advertisement:
197
Advertisement:
186
--------------
198
--------------
187
  Other Stuff by LeoD ........ https://forums.duke4.net/index.php?showtopic=3513
199
  Other Stuff by LeoD ........ https://forums.duke4.net/index.php?showtopic=3513
188
 
200
 
189
 
201
 
190
7) CREDITS
202
7) CREDITS
191
==========
203
==========
192
  Anyone who has contributed to EDuke32, the HRP, or the user maps listed herein
204
  Anyone who has contributed to EDuke32, the HRP, or the user maps listed herein
193
 
205