How to pack your Mission - Revision history

Nbohr1more: /* Creating your PK4 */

2024-12-05T00:57:42Z

Creating your PK4

← Older revision		Revision as of 00:57, 5 December 2024
Line 66:		Line 66:

	Make sure that you do not accidentily pack backup files like "mymap.bak", "mymap_autosave.map" or other random files into the PK4. They just increase the file size, but are not neccessary for playing the mission at all.		Make sure that you do not accidentily pack backup files like "mymap.bak", "mymap_autosave.map" or other random files into the PK4. They just increase the file size, but are not neccessary for playing the mission at all.

			=== Illegal Filenames ===

			The new SVN mission database does not handle files with spaces or special characters ( % & ! etc) in their names.
			<br>Please use underscores "some_file_name.dds" or camelcase "someFileName.dds" instead of spaces.

	=== The _i18n.pk4 file ===		=== The _i18n.pk4 file ===

Frost Salamander: change ordering of darkmod.txt in example to conform with expectations

2023-04-15T14:39:56Z

change ordering of darkmod.txt in example to conform with expectations

← Older revision		Revision as of 14:39, 15 April 2023
Line 38:		Line 38:
	Starting with release TDM 1.01 it will be possible for missions to specify a "required version", so that missions which are built upon undead (for example) can specify in their darkmod.txt that it needs TDM 1.01 and upwards to run. If the mission installer encounters a version mismatch, a notification appears and TDM will refuse to install it.		Starting with release TDM 1.01 it will be possible for missions to specify a "required version", so that missions which are built upon undead (for example) can specify in their darkmod.txt that it needs TDM 1.01 and upwards to run. If the mission installer encounters a version mismatch, a notification appears and TDM will refuse to install it.

	You can specify another line after ''~~Author~~:''		You can specify another line after ''Version:''
	Title: The Outpost		Title: The Outpost
	Description: Break into a builder outpost to retrieve a gold ingot.		Description: Break into a builder outpost to retrieve a gold ingot.
			Version: 1
	Author: angua & greebo		Author: angua & greebo
	~~Version: 1~~
	Required TDM Version: 1.01		Required TDM Version: 1.01
	The "Required TDM Version" string is optional, so existing missions still work of course.		The "Required TDM Version" string is optional, so existing missions still work of course.
Line 50:		Line 50:

	VERSION: The internal downloader can only handle integers. So, don't update from v 1 to v 1.1, go from 1 to 2.		VERSION: The internal downloader can only handle integers. So, don't update from v 1 to v 1.1, go from 1 to 2.


	=== startingmap.txt ===		=== startingmap.txt ===

Geep: /* Internationalisation (I18N) */ Add comment suggesting this is optional and why

2021-11-20T23:08:27Z

Internationalisation (I18N): Add comment suggesting this is optional and why

← Older revision		Revision as of 23:08, 20 November 2021
Line 17:		Line 17:

	=== Internationalisation (I18N) ===		=== Internationalisation (I18N) ===
			''Comment from Geep, 2021: When the i18n string table was introduced, it was to allow quick translations, with the map and other assets unaltered. Nowadays, higher-quality translations usually require changes to the map and/or assets. Given that, the benefit of the string table to translators is modest. For mappers, it has non-trivial costs, in terms of effort, but particularly complexity and opacity when working in DR. So this section might be considered Optional.''

	To make it easier to translate your mission into different languages, you need to prepare it for this. The most important steps are:		To make it easier to translate your mission into different languages, you need to prepare it for this. The most important steps are:

Geep: /* FM Notes (optional) */ Move suggestion about credits to here from Distribution section

2020-03-11T20:42:19Z

FM Notes (optional): Move suggestion about credits to here from Distribution section

← Older revision		Revision as of 20:42, 11 March 2020
Line 96:		Line 96:

	== FM Notes (optional) ==		== FM Notes (optional) ==
	It's possible to display a couple of lines as FM notes. Just add a file called '''readme.txt''' in the PK4. When this file is available, an additional button "Notes" will be displayed next to the "Install Mission" button.		It's possible to display a couple of lines as FM notes. Just add a file called '''readme.txt''' in the PK4. When this file is available, an additional button "Notes" will be displayed next to the "Install Mission" button. This is a good place to put acknowledgements and credits.

	== Distributing your Mission ==		== Distributing your Mission ==

Geep: /* Distributing your Mission */

2020-03-11T20:39:39Z

Distributing your Mission

← Older revision		Revision as of 20:39, 11 March 2020
Line 100:		Line 100:
	== Distributing your Mission ==		== Distributing your Mission ==

	Now that you have your distributable PK4 file, others can play your fan mission. For the next steps, see [Your_Mission_-_From_Beta_Testing_to_Release_and_Beyond]		Now that you have your distributable PK4 file, others can play your fan mission. For the next steps, see [[Your_Mission_-_From_Beta_Testing_to_Release_and_Beyond\|Your Mission - From Beta Testing to Release and Beyond]].

	== See also ==		== See also ==

Geep: /* Distributing your Mission */ Link to 'Your Mission - From Beta Testing to Release and Beyond'

2020-03-11T20:37:10Z

Distributing your Mission: Link to 'Your Mission - From Beta Testing to Release and Beyond'

← Older revision		Revision as of 20:37, 11 March 2020
Line 100:		Line 100:
	== Distributing your Mission ==		== Distributing your Mission ==

	~~You need only distribute~~ your PK4 ~~files for~~ others to play your fan mission. ~~They must~~, ~~of course, have the Dark Mod resources.~~		Now that you have your distributable PK4 file, others can play your fan mission. For the next steps, see [Your_Mission_-_From_Beta_Testing_to_Release_and_Beyond]

	~~You can include a readme.txt or similar in the pk4 for any extra info including credits etc.~~

	~~There will be at least one website available that accepts Dark Mod fan mission PK4s for downloading.~~

	== See also ==		== See also ==

Dragofer: Update method not yet verified.

2016-12-08T15:35:30Z

Update method not yet verified.

← Older revision		Revision as of 15:35, 8 December 2016
Line 105:		Line 105:

	There will be at least one website available that accepts Dark Mod fan mission PK4s for downloading.		There will be at least one website available that accepts Dark Mod fan mission PK4s for downloading.

	~~== Updating Missions ==~~

	~~When preparing an update for a mission, open darkmod.txt and increase the mission's version number by one. Only integers will work.~~


	== See also ==		== See also ==

Dragofer at 16:58, 3 November 2016

2016-11-03T16:58:49Z

← Older revision		Revision as of 16:58, 3 November 2016
Line 105:		Line 105:

	There will be at least one website available that accepts Dark Mod fan mission PK4s for downloading.		There will be at least one website available that accepts Dark Mod fan mission PK4s for downloading.


	== Updating Missions ==		== Updating Missions ==

Dragofer at 16:54, 3 November 2016

2016-11-03T16:54:56Z

← Older revision		Revision as of 16:54, 3 November 2016
Line 105:		Line 105:

	There will be at least one website available that accepts Dark Mod fan mission PK4s for downloading.		There will be at least one website available that accepts Dark Mod fan mission PK4s for downloading.


			== Updating Missions ==

			When preparing an update for a mission, open darkmod.txt and increase the mission's version number by one. Only integers will work.


	== See also ==		== See also ==

Nbohr1more: /* Adding custom Assets */

2016-08-22T15:06:06Z

Adding custom Assets

← Older revision		Revision as of 15:06, 22 August 2016
Line 85:		Line 85:
	Be aware that replacing files containing definitions (def, mtr, etc.) could potentially render your mission incompatible with future versions of TDM, so ''''try to avoid this where possible''''. Sometimes it is necessary, however.		Be aware that replacing files containing definitions (def, mtr, etc.) could potentially render your mission incompatible with future versions of TDM, so ''''try to avoid this where possible''''. Sometimes it is necessary, however.

	{{important\|headline=Warning\|text=Do not package '''~~DoomConfig~~.cfg''' or '''autoexec.cfg''' with your mission. Doing so will overwrite players' own config files, potentially cause their TDM installation to break!}}		{{important\|headline=Warning\|text=Do not package '''Darkmod.cfg''' or '''autoexec.cfg''' with your mission. Doing so will overwrite players' own config files, potentially cause their TDM installation to break!}}

	== Testing the PK4 ==		== Testing the PK4 ==