Subversion Repositories duke3d_hrp

Rev

Rev 715 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

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