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

Subversion Repositories duke3d_hrp

(root)/maphacks/MapHacks.txt – Rev 689 → 690