WebSVN – duke3d_hrp – Blame – /autoload.txt

Rev	Author	Line No.	Line
736	leod	1
		2	=======================================
		3	\| The EDuke32 autoload Thingy \|
		4	\| by LeoD \|
		5	=======================================
		6	\| Version: 1.3 (2023-05-30) \|
		7	=======================================
		8
		9
		10	Copy mods, HRP, or Voxel Pack files into the autoload folder and they will be
		11	loaded automatically without additional parameters.
		12	(Check the according option in the startup window, or add the line
		13	"NoAutoLoad = 0" to the [Setup] section of your eduke32.cfg file.)
		14
		15	"autoload" is usually located in your Duke3D/Ion Fury installation directory,
		16	alongside the EDuke32/Fury executable and its *.cfg files.
		17	Other possible locations (not checked):
		18	- Windows: %USERPROFILE%\AppData\Roaming\EDuke32\autoload
		19	- Linux: ${HOME}/.eduke32/autoload
		20
		21	Put only the currently required ZIPs into autoload. (Accepted file extensions
		22	are: zip, grp, pk3, pk4.)
		23
		24	Packs which build upon other packs only need to have a file name "later" in the
		25	alphanumerical sort order to override or add to other ZIP contents if necessary.
		26
		27	A common misconception is that the packages are actually "loaded" by EDuke32.
		28	Better consider their contents a bunch of sheets laid over each other with,
		29	say, zzz-mypack.zip on top.
		30	EDuke32 will only 'see' the lower priority files where (all) the layers above
		31	have a hole ( = file not present in their ZIP/GRP/folder).
		32
		33
		34	Priority from bottom to top:
		35
		36	1. default GRP (shipped with your game, usually DUKE3D.GRP, fury.grp, etc.)
		37	2. -gamegrp GRP/ZIP
		38	3. autoload GRPs
		39	4. autoload ZIPs
		40	5. -g GRPs/ZIPs in parameter order
		41	6. -j [dir] files in parameter order
		42	7. files in the current working directory
		43
		44
		45	Many mods, especially the bigger ones like DukePlus, are not meant to be put
		46	into autoload in the first place, but some may still be able to use it the
		47	other way round. You could play a CON-only mod with the HRP for example.
		48	Always consult their accompanying documentation first.
		49
		50	Because some shitty operating system(s) won't differ between upper/lower case
		51	letters, which affects the sort order, it is recommended to use
		52	lower case letters only for filenames in autoload.
		53
		54	I recommend to not have plain game files in your autoload folder,
		55	only ZIP or GRP packages.
		56
		57	Do NOT set autoload as "Custom game content directory" in the startup window,
		58	that's very bad practice. The same goes for "-j autoload".
		59
		60	Do NOT name a folder containing game files "DUKE3D.GRP". That's even worse IMO.
		61
		62	The -noautoload command line option will temporarily override the current
		63	setting without altering the configuration file.
		64
		65	In order to turn a game contents folder into an autoload package, zip up what's
		66	inside it, NOT the folder itself.
		67
		68
		69	The behaviour of other Duke Nukem 3D ports (BuildGDX, Raze, etc.) and even
		70	other games based on EDuke32 (NBlood, VoidSW, etc.) may differ from EDuke32,
		71	concerning either autoload, command line parameters, or both.
		72
		73
		74	What I know about DukeGDX (BuildGDX):
		75
		76	AFAIK BuildGDX doesn't take any command line parameters.
		77
		78	Phredreeke added:
		79	For DukeGDX, ZIP files in the autoload folder are actually loaded separate
		80	and isolated from each other (a DEF file in a ZIP file can not define an
		81	image found in another ZIP file).
		82
		83	This means that you couldn't use the Z-Pack on top of the HRP, for example.
		84	(The current DukeGDX v1.15 (BuildGdx v20.081) can't deal with many of the
		85	HRPs DEF parameters anyway.)
		86
		87	From BuildGDX' 1.15 readme.txt:
		88	Autoload folder can be used to load mods at game startup. These can include
		89	custom music packs, voxels, maphacks, HRP etc.
		90	*You are not supposed to put custom campaigns into autoload folder*
		91	BGDX will automatically load all zipped files in the autoload folder and
		92	execute the following .def files:
		93	- unpacked .def files
		94	- .def files inside .zip archives that have the name of the port
		95	(dukegdx.def, bloodgdx.def, swgdx.def, rrgdx.def, psgdx.def,
		96	twgdx.def, lspgdx.def, or whgdx.def)
		97
		98
		99	LINKS:
		100	------
		101	Duke4.net ................................... https://duke4.net
		102	Duke Nukem 3D High-Resolution Pack .......... https://hrp.duke4.net
		103	DukePlus / Attrition ........................ https://fissile.duke4.net
		104	EDuke32 port ................................ https://eduke32.com
		105	EDukeWiki ................................... https://wiki.eduke32.com
		106
		107
		108	Advertisement:
		109	--------------
		110	Other stuff by LeoD ....... https://forums.duke4.net/index.php?showtopic=3513
		111
		112
		113	CHANGELOG:
		114	==========
		115
		116	1.3 (2023-05-30)
		117	----------------
		118	about autoload folder location
		119
		120
		121	1.2 (2021-11-09)
		122	----------------
		123	turn game folder into autoload package
		124
		125
		126	1.1 (2021-09-13)
		127	----------------
		128	clarifications
		129
		130
		131	1.0 (2021-08-23)
		132	----------------
		133	initial release

Subversion Repositories duke3d_hrp

(root)/autoload.txt – Rev 736