Subversion Repositories duke3d_hrp

Rev

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

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