WebSVN – duke3d_hrp – Diff – /maphacks/MapHacks.txt


                   ==========================================
                   |              Duke Nukem 3D             |
                   |        Maphacks for the EDuke32        |
                   |       High Resolution Pack (HRP)       |
                   |                   or                   |
                   |               Voxel Pack               |
                   |                                        |
                   ==========================================
 
 
 
 
=======================
CONTENTS OF THIS README
=======================
 
1) About
2) Installation
3) Notes
4) Support for NightFright's Addon Compilation
5) License
6) Contact/Links
7) Credits
8) Changelog
 
 
1) ABOUT
========
 Maphacks are used to edit the positioning of objects and other parts of a level
in cases where the maps cannot be redistributed. These maphacks' goal is to
improve the compatibility of user created maps with the HRP or the Voxel Pack.
Since there is no central site for map downloads, patching the maps directly
would lead to quite some confusion among players about their respective
versions. By distributing separated maphacks the original map download archives
can be kept unchanged. The maphacks are now part of the HRP, but this pack is
updated more frequently.
 
 
2) INSTALLATION
===============
 Technically this is like an HRP update pack with maphack additions and 
updates only - therefore, if your current HRP's (or regular HRP update pack's) 
version number is greater than ours, don't use this pack.
 
Drop this pack into the autoload folder alongside your HRP (5.4 or later) and 
you should be done.
(Standalone invocation: eduke32 -g UserMapHacks.zip -mh maphacks/maphacks.def)
 
You need a recent EDuke32 executable which has the UserMapHacks functions 
implemented - at least r4886 (source r4884). (HRP 5.4 comes with r5267.)
 
Currently users are reporting various issues with recent EDuke32 builds. If you 
should encounter problems as well, try the r4495 version with backported 
UserMapHack functions from the "Other Stuff" link below.
 
Your eduke32.log should contain one or more lines similar to this after playing:
   Loaded map hack file "maphacks/usermaps/foobar.mhk"
 
 
3) NOTES
========
 The main goal is to get rid of the most annoying HRP-related problems of 
popular (highly rated by reviewers) and recently released user maps. 
Since the introduction of the Poymer renderer in 2009 and the big HRP model 
rotation in early 2012 (r5.1.295), even maps which were designed with the HRP 
in mind need some adjustments. 
Do not expect a maphack quality comparable to what has been done for the 
original game's levels, though. No Polymer lighting for example.
 
A few older maps make use of tricks which can't be reproduced (yet?) using the 
modern OpenGL renderers. Some recent maps' README files explicitly state that 
the respective map is meant to be played without fancy renderers, or the HRP.
Remember that these maphacks do not claim to make those maps look as intended 
if you are using the HRP anyway, but try to fix the obvious glitches as far as 
it is technically possible. Do not complain to mappers, do not ask them to 
'fix' their map if it looks bad when HRPlaying it.
 
Some other maps and episodes come with custom textures. Tiles014.art, 
tiles15.art, tiles20.art and up, will technically never interfere with the HRP, 
whereas extensive use of custom textures may look off when combined with 
the HRP. In case of conflicting ART I may have added a README and/or a ZIP file 
to explain or improve compatibility. But even if a maphack and further 
compatibility improvements exist, it's still your decision to HRPlay or not.
 
This Pack is suitable for the Voxel Pack as well, although only the 'angoff'
directive (model rotation) works currently on voxels (EDuke32 r5880). 
But that's the most commonly used correction anyway.
 
 
You can help:
 
 - If you find anything you consider worthy correcting in an already maphacked
level, don't hesitate to report it (DNCOORDS!), and which renderer/HRP version
you are using. Some models (like the 0603 hangbabe) might need different
maphacks and some floor/ceiling aligned sprites may show up different
(or not at all) in either Polymost or Polymer renderer/HRP.
 
 - You can contribute your own maphacks. Basic information is available at:
     http://wiki.eduke32.com/wiki/Maphack_Language
 
 - If you have a newer version of an already maphacked level, please let LeoD
   know. (But compare the checksums first.)
 
 
4) Support for NightFright's Addon Compilation 3.1
==================================================
A full set of maphacks is available for each of the following GRPs (244):
  adg.grp             (5)
  aqua.grp            (3)
  battlefield3.grp    (3)
  bobsp.grp           (5)
  bravenworld.grp     (5) - Check out HRP-BNW-compatibility.zip
  castlequest.grp     (7)
  chronic.grp         (5) - Check out HRP-TheChronic-compatibility.zip
  commbuild.grp       (8)
  crucialconflict.grp (3)
  daikarin.grp        (7) - Check out HRP-DaikariN-compatibility.zip
  darkplace.grp       (5)
  deathdrive.grp      (5)
  dn64revisited.grp   (3)
  dreamtrilogy_grp    (3)
  dukehard.grp       (17) - Check out HrpDukePlus-DukeHard-compatibility.zip
  duketen.grp         (3)
  fbsp.grp            (3)
  glavic.grp         (10) 
  kaiserland.grp      (3)
  lorch.grp           (3)
  losthighway.grp     (7)
  mathpak.grp         (5)
  metromayhem.grp    (15)
  milltown.grp        (2)
  mssp.grp            (8)
  opblitzkrieg.grp    (5)
  plugpray.grp        (7)
  prequel2time.grp    (4)
  red.grp             (7)
  redrum.grp          (1)
  roch.grp            (9)
  showdown.grp       (21) - Check out HRP-NuclearShowdown-compatibility.zip ???
  spcmissn.grp        (2)
  spiegul.grp         (3)
  stranger.grp        (6)
  sunburn.grp         (2)
  taivo.grp           (5)
  undertaker.grp      (5)
  v_series.grp        (4)
  verminclear.grp    (12)
  wgspace.grp         (8)
 
Maphacks for the following GRPs are not yet completed (128/209):
  c3po.grp       :  2/4
  escape.grp     :  2/5
  fm3x.grp       : 34/42 - FM1X-FM3X done
  jungletour.grp :  1/3
  kucera.grp     :  4/15
  pinxten.grp    ;  5/9
  pipeline.grp   ;  2/7
  quakis.grp     :  6/8
  space.grp      : 23/38
  urban.grp      : 49/78
 
Some GRPs' high resolution contents have been left out from the Addon Pack:
  infestation.grp : 39/39 : Check out IITTC-HRP-compatibility.zip
  moonbase.grp    :  9/9
  wgrealms.grp    :  6/6
They will probably get recompiled for HRP with the Addon's maps included (54).
They'll become available at the "Other Stuff" link below.
 
Most other GRPs included in the Addon Pack are probably not compatible with the
HRP, but they need to be actually checked out, though.
 
 
5) LICENSE
==========
 Maphacks for the original game's maps and official addon maps (Nuclear Winter, 
Duke in D.C., Caribbean/Vacation) are covered by the HRP Art License.
You are free to copy, alter, reproduce, and redistribute all other maphack files
as long as their original author[s] are credited in each *.mhk respectively.
 
 
6) CONTACT/LINKS
================
  You can check the related EDuke32 forum thread over at Duke4.net:
  https://forums.duke4.net/index.php?showtopic=6070
 
Contact:
--------
  https://forums.duke4.net/index.php?showuser=1299
 
Related Links:
--------------
  Duke4.net ................................... http://www.duke4.net
  Duke Nukem 3D High-Resolution Pack .......... http://hrp.duke4.net
  NightFright's Addon Pack .................... http://hrp.duke4.net
  EDuke32 port ................................ http://eduke32.com
  RHash checksum generator .................... http://rhash.anz.ru
  Maphacks in the HRP repository ... http://svn.eduke32.com/polymer_hrp/maphacks
 
Advertisement:
--------------
  Other Stuff by LeoD ........ https://forums.duke4.net/index.php?showtopic=3513
 
 
7) CREDITS
==========
  Anyone who has contributed to EDuke32, the HRP, or the user maps listed herein
 

Rev 694	Rev 695
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	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. The maphacks are now part of the HRP, but this pack is
36	updated more frequently.	36	updated more frequently.
37		37
38		38
39	2) INSTALLATION	39	2) INSTALLATION
40	===============	40	===============
41	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
42	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)
43	version number is greater than ours, don't use this pack.	43	version number is greater than ours, don't use this pack.
44		44
45	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
46	you should be done.	46	you should be done.
47	(Standalone invocation: eduke32 -g UserMapHacks.zip -mh maphacks/maphacks.def)	47	(Standalone invocation: eduke32 -g UserMapHacks.zip -mh maphacks/maphacks.def)
48		48
49	You need a recent EDuke32 executable which has the UserMapHacks functions	49	You need a recent EDuke32 executable which has the UserMapHacks functions
50	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.)
51		51
52	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
53	should encounter problems as well, try the r4495 version with backported	53	should encounter problems as well, try the r4495 version with backported
54	UserMapHack functions from the "Other Stuff" link below.	54	UserMapHack functions from the "Other Stuff" link below.
55		55
56	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:
57	Loaded map hack file "maphacks/usermaps/foobar.mhk"	57	Loaded map hack file "maphacks/usermaps/foobar.mhk"
58		58
59		59
60	3) NOTES	60	3) NOTES
61	========	61	========
62	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
63	popular (highly rated by reviewers) and recently released user maps.	63	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	64	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	65	rotation in early 2012 (r5.1.295), even maps which were designed with the HRP
66	in mind need some adjustments.	66	in mind need some adjustments.
67	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
68	original game's levels, though. No Polymer lighting for example.	68	original game's levels, though. No Polymer lighting for example.
69		69
70	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
71	modern OpenGL renderers. Some recent maps' README files explicitly state that	71	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.	72	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	73	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	74	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	75	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.	76	'fix' their map if it looks bad when HRPlaying it.
77		77
78	Some other maps and episodes come with custom textures. Tiles014.art,	78	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,	79	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	80	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	81	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	82	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.	83	compatibility improvements exist, it's still your decision to HRPlay or not.
84		84
85	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'
86	directive (model rotation) works currently on voxels (EDuke32 r5811).	86	directive (model rotation) works currently on voxels (EDuke32 r5880).
87	But that's the most commonly used correction anyway.	87	But that's the most commonly used correction anyway.
88		88
89		89
90	You can help:	90	You can help:
91		91
92	- 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
93	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
94	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
95	maphacks and some floor/ceiling aligned sprites may show up different	95	maphacks and some floor/ceiling aligned sprites may show up different
96	(or not at all) in either Polymost or Polymer renderer/HRP.	96	(or not at all) in either Polymost or Polymer renderer/HRP.
97		97
98	- You can contribute your own maphacks. Basic information is available at:	98	- You can contribute your own maphacks. Basic information is available at:
99	http://wiki.eduke32.com/wiki/Maphack_Language	99	http://wiki.eduke32.com/wiki/Maphack_Language
100		100
101	- 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
102	know. (But compare the checksums first.)	102	know. (But compare the checksums first.)
103		103
104		104
105	4) Support for NightFright's Addon Compilation 3.0	105	4) Support for NightFright's Addon Compilation 3.1
106	==================================================	106	==================================================
107	A full set of maphacks is available for each of the following GRPs (234):	107	A full set of maphacks is available for each of the following GRPs (244):
108	adg.grp (5)	108	adg.grp (5)
109	aqua.grp (3)	109	aqua.grp (3)
110	battlefield3.grp (3)	110	battlefield3.grp (3)
111	bobsp.grp (5)	111	bobsp.grp (5)
112	bravenworld.grp (5) - Check out HRP-BNW-compatibility.zip	112	bravenworld.grp (5) - Check out HRP-BNW-compatibility.zip
113	castlequest.grp (7)	113	castlequest.grp (7)
114	chronic.grp (5) - Check out HRP-TheChronic-compatibility.zip	114	chronic.grp (5) - Check out HRP-TheChronic-compatibility.zip
115	commbuild.grp (8)	115	commbuild.grp (8)
116	crucialconflict.grp (3)	116	crucialconflict.grp (3)
117	daikarin.grp (7) - Check out HRP-DaikariN-compatibility.zip	117	daikarin.grp (7) - Check out HRP-DaikariN-compatibility.zip
118	darkplace.grp (5)	118	darkplace.grp (5)
119	deathdrive.grp (5)	119	deathdrive.grp (5)
120	dn64revisited.grp (3)	120	dn64revisited.grp (3)
121	dreamtrilogy_grp (3)	121	dreamtrilogy_grp (3)
122	dukehard.grp (17) - Check out HrpDukePlus-DukeHard-compatibility.zip	122	dukehard.grp (17) - Check out HrpDukePlus-DukeHard-compatibility.zip
123	duketen.grp (3)	123	duketen.grp (3)
124	fbsp.grp (3)	124	fbsp.grp (3)
125	glavic.grp (10)	125	glavic.grp (10)
126	kaiserland.grp (3)	126	kaiserland.grp (3)
127	lorch.grp (3)	127	lorch.grp (3)
128	losthighway.grp (7)	128	losthighway.grp (7)
129	mathpak.grp (5)	129	mathpak.grp (5)
130	metromayhem.grp (15)	130	metromayhem.grp (15)
131	milltown.grp (2)	131	milltown.grp (2)
132	mssp.grp (8)	132	mssp.grp (8)
133	opblitzkrieg.grp (5)	133	opblitzkrieg.grp (5)
134	plugpray.grp (7)	134	plugpray.grp (7)
135	prequel2time.grp (4)	135	prequel2time.grp (4)
136	red.grp (7)	136	red.grp (7)
137	redrum.grp (1)	137	redrum.grp (1)
138	roch.grp (9)	138	roch.grp (9)
139	showdown.grp (21) - Check out HRP-NuclearShowdown-compatibility.zip ???	139	showdown.grp (21) - Check out HRP-NuclearShowdown-compatibility.zip ???
140	spcmissn.grp (2)	140	spcmissn.grp (2)
141	spiegul.grp (3)	141	spiegul.grp (3)
-		142	stranger.grp (6)
142	sunburn.grp (2)	143	sunburn.grp (2)
143	taivo.grp (5)	144	taivo.grp (5)
144	undertaker.grp (5)	145	undertaker.grp (5)
-		146	v_series.grp (4)
145	verminclear.grp (12)	147	verminclear.grp (12)
146	wgspace.grp (8)	148	wgspace.grp (8)
147		149
148	Maphacks for the following GRPs are not yet completed (124/198):	150	Maphacks for the following GRPs are not yet completed (128/209):
149	c3po.grp : 2/4	151	c3po.grp : 2/4
150	escape.grp : 2/5	152	escape.grp : 2/5
151	fm3x.grp : 34/42 - FM1X-FM3X done	153	fm3x.grp : 34/42 - FM1X-FM3X done
152	jungletour.grp : 1/3	154	jungletour.grp : 1/3
153	kucera.grp : 4/11	155	kucera.grp : 4/15
154	pinxten.grp ; 5/9	156	pinxten.grp ; 5/9
155	pipeline.grp ; 2/7	157	pipeline.grp ; 2/7
156	quakis.grp : 6/8	158	quakis.grp : 6/8
157	space.grp : 18/30	159	space.grp : 23/38
158	urban.grp : 50/79	160	urban.grp : 49/78
159		161
160	Some GRPs' high resolution contents have been left out from the Addon Pack:	162	Some GRPs' high resolution contents have been left out from the Addon Pack:
161	infestation.grp : 39/39 : Check out IITTC-HRP-compatibility.zip	163	infestation.grp : 39/39 : Check out IITTC-HRP-compatibility.zip
162	moonbase.grp : 9/9	164	moonbase.grp : 9/9
163	wgrealms.grp : 6/6	165	wgrealms.grp : 6/6
164	They will probably get recompiled for HRP with the Addon's maps included (54).	166	They will probably get recompiled for HRP with the Addon's maps included (54).
165	They'll become available at the "Other Stuff" link below.	167	They'll become available at the "Other Stuff" link below.
166		168
167	Most other GRPs included in the Addon Pack are probably not compatible with the	169	Most other GRPs included in the Addon Pack are probably not compatible with the
168	HRP, but they need to be actually checked out, though.	170	HRP, but they need to be actually checked out, though.
169		171
170		172
171	5) LICENSE	173	5) LICENSE
172	==========	174	==========
173	Maphacks for the original game's maps and official addon maps (Nuclear Winter,	175	Maphacks for the original game's maps and official addon maps (Nuclear Winter,
174	Duke in D.C., Caribbean/Vacation) are covered by the HRP Art License.	176	Duke in D.C., Caribbean/Vacation) are covered by the HRP Art License.
175	You are free to copy, alter, reproduce, and redistribute all other maphack files	177	You are free to copy, alter, reproduce, and redistribute all other maphack files
176	as long as their original author[s] are credited in each *.mhk respectively.	178	as long as their original author[s] are credited in each *.mhk respectively.
177		179
178		180
179	6) CONTACT/LINKS	181	6) CONTACT/LINKS
180	================	182	================
181	You can check the related EDuke32 forum thread over at Duke4.net:	183	You can check the related EDuke32 forum thread over at Duke4.net:
182	https://forums.duke4.net/index.php?showtopic=6070	184	https://forums.duke4.net/index.php?showtopic=6070
183		185
184	Contact:	186	Contact:
185	--------	187	--------
186	https://forums.duke4.net/index.php?showuser=1299	188	https://forums.duke4.net/index.php?showuser=1299
187		189
188	Related Links:	190	Related Links:
189	--------------	191	--------------
190	Duke4.net ................................... http://www.duke4.net	192	Duke4.net ................................... http://www.duke4.net
191	Duke Nukem 3D High-Resolution Pack .......... http://hrp.duke4.net	193	Duke Nukem 3D High-Resolution Pack .......... http://hrp.duke4.net
192	NightFright's Addon Pack .................... http://hrp.duke4.net	194	NightFright's Addon Pack .................... http://hrp.duke4.net
193	EDuke32 port ................................ http://eduke32.com	195	EDuke32 port ................................ http://eduke32.com
194	RHash checksum generator .................... http://rhash.anz.ru	196	RHash checksum generator .................... http://rhash.anz.ru
195	Maphacks in the HRP repository ... http://svn.eduke32.com/polymer_hrp/maphacks	197	Maphacks in the HRP repository ... http://svn.eduke32.com/polymer_hrp/maphacks
196		198
197	Advertisement:	199	Advertisement:
198	--------------	200	--------------
199	Other Stuff by LeoD ........ https://forums.duke4.net/index.php?showtopic=3513	201	Other Stuff by LeoD ........ https://forums.duke4.net/index.php?showtopic=3513
200		202
201		203
202	7) CREDITS	204	7) CREDITS
203	==========	205	==========
204	Anyone who has contributed to EDuke32, the HRP, or the user maps listed herein	206	Anyone who has contributed to EDuke32, the HRP, or the user maps listed herein
205		207

Subversion Repositories duke3d_hrp

(root)/maphacks/MapHacks.txt – Rev 694 → 695