Mod.ini (old) - Revision history

Yarn: moved Mod.ini to Mod.ini (old): The current mod.ini documentation on this wiki is outdated and will be replaced with the one from wxLauncher's old Google Code wiki. This page is being renamed to serve as a backup, at least for now.

2016-01-04T07:13:30Z

moved Mod.ini to Mod.ini (old): The current mod.ini documentation on this wiki is outdated and will be replaced with the one from wxLauncher's old Google Code wiki. This page is being renamed to serve as a backup, at least for now.

← Older revision	Revision as of 07:13, 4 January 2016
(No difference)

Yarn at 06:58, 4 January 2016

2016-01-04T06:58:44Z

← Older revision		Revision as of 06:58, 4 January 2016
Line 18:		Line 18:
	*website = ''URL to the mod's website, if applicable'';		*website = ''URL to the mod's website, if applicable'';
	*forum = ''URL to the mod's forum, if applicable'';		*forum = ''URL to the mod's forum, if applicable'';
	*mantis = ''URL to the mod's bugtracker, if applicable'';		*mantis = ''URL to the mod's bugtracker, if applicable '''(no longer supported as of Launcher 5.5)''''';

	The mod bitmap is displayed in the Launcher, under the "MOD" tab, when the mod is selected.		The mod bitmap is displayed in the Launcher, under the "MOD" tab, when the mod is selected.
Line 36:		Line 36:

	Attributes:		Attributes:
	*flags = ''list of additional commandline flags'';		*flags = ''list of additional commandline flags '''(no longer supported as of Launcher 5.5)''''';

	==Examples==		==Examples==

IssMneur: /* Multimod */ Note how to add multiple mods to the list

2011-07-24T15:57:37Z

Multimod: Note how to add multiple mods to the list

← Older revision		Revision as of 15:57, 24 July 2011
Line 27:		Line 27:
	Attributes:		Attributes:
	*primarylist = ''list of mods'';		*primarylist = ''list of mods'';
	**These mods will override assets in the current mod. Primarylist is needed very rarely. Currently only [[Silent Threat: Reborn]] requires the use of primarylist.		**These mods will override assets in the current mod. Primarylist is needed very rarely. Currently only [[Silent Threat: Reborn]] requires the use of primarylist. Multiple mods are separated by commas.
	*secondarylist = ''list of mods'';		*secondarylist = ''list of mods'';
	**These mods will be added to the assets for the current mod, and may be overridden by data in the current mod.		**These mods will be added to the assets for the current mod, and may be overridden by data in the current mod. Multiple mods are separated by commas.

	===Settings===		===Settings===

Fisk: An example of a mod.ini for FSPort and some additional explanations.

2010-01-17T20:18:03Z

An example of a mod.ini for FSPort and some additional explanations.

← Older revision		Revision as of 20:18, 17 January 2010
Line 39:		Line 39:

	==Examples==		==Examples==
			Below are examples of different mod.inis in various situations.
	===MediaVPs 3.6.10===		===MediaVPs 3.6.10===
			The mod.ini provided with the MediaVPs doesn't use any other mods, as the MediaVPs are selected as a mod only when the player wants to play the regular FS2 campaign with better graphics. The mod.ini does, however, provide a Launcher image and links to Hard Light Productions.
	<pre>		<pre>
	[launcher]		[launcher]
Line 53:		Line 55:
	</pre>		</pre>
	===Derelict===		===Derelict===
			The [[Derelict]] mod.ini contains a reference to the MediaVPs, because many users want to play Derelict, and other mods, with better graphics provided by the MediaVPs. Also, the person who originally created the mod.ini deemed it necessary to include the -spec flag, though most people already have it turned on in their Launchers.
	<pre>		<pre>
	[launcher]		[launcher]
Line 66:		Line 69:
	[settings]		[settings]
	flags = -spec;		flags = -spec;
			</pre>

			===Cardinal Spear===
			[[Cardinal Spear]] is a mod that requires FSPort. Therefore, the secondarylist includes "fsport" in addition to "mediavps".
			<pre>
			[launcher]
			image255x112 = CardinalSpear.bmp;
			infotext = In the tenth year of our war against the Vasudans, humanity had attempted one last desperate strike to end the war outright - a spear in the dark. The Cardinal Fleet had been laid ruin, and the crew of the GTD Agamemnon was being hunted by a Vasudan general. It was too late for victory, but not too late for vengeance...;
			website = http://fsport.hard-light.net/;
			forum = http://www.hard-light.net/forums/index.php/board,39.0.html;

			[multimod]
			secondarylist = fsport,mediavps;
	</pre>		</pre>

	===Silent Threat: Reborn===		===Silent Threat: Reborn===
			Due to some design issues, Silent Threat: Reborn doesn't work correctly with the MediaVPs, if it is designated as the primary mod, with the other mods being of a secondary nature. The FSPort MediaVPs have to be read before ST:R for ST:R to function correctly. Therefore, "fsport-mediavps" is entered into the primarylist line.
	<pre>		<pre>
	[launcher]		[launcher]

Fisk: Grammar, conformation and the ST:R mod.ini.

2010-01-17T17:24:16Z

Grammar, conformation and the ST:R mod.ini.

← Older revision		Revision as of 17:24, 17 January 2010
Line 1:		Line 1:
	==Introduction==		==Introduction==
	Mod.ini defines the options for a given ~~Mod~~.		Mod.ini defines the options for a given mod.
	The core use for these is to allow a ~~Mod~~ to easily use assets from another mod, such as the MediaVPs.		The core use for these is to allow a mod to easily use assets from another mod, such as the MediaVPs.

	The file must be called "mod.ini" and be in the main folder of the mod.		The file must be called "mod.ini" and be in the main folder of the mod.
Line 10:		Line 10:
	===Launcher===		===Launcher===
	<pre>[launcher]</pre>		<pre>[launcher]</pre>
	Information about the ~~Mod~~, displayed in the Launcher.		Information about the mod, displayed in the Launcher.

	Attributes:		Attributes:
	*modname = ''Name of ~~Mod~~'';		*modname = ''Name of the mod'';
	*image255x112 = ''Mod bitmap.bmp'';		*image255x112 = ''Mod bitmap.bmp'';
	*infotext = ''Information about the ~~Mod~~'';		*infotext = ''Information about the mod'';
	*website = ''URL to ~~Mod~~ website, if applicable'';		*website = ''URL to the mod's website, if applicable'';
	*forum = ''URL to ~~a Mod~~ forum, if applicable'';		*forum = ''URL to the mod's forum, if applicable'';
	*mantis = ''URL to ~~a Mod~~ bugtracker, if applicable'';		*mantis = ''URL to the mod's bugtracker, if applicable'';

	The ~~Mod Bitmap~~ is displayed		The mod bitmap is displayed in the Launcher, under the "MOD" tab, when the mod is selected.
	===~~MultiMod~~===		===Multimod===
	<pre>[multimod]</pre>		<pre>[multimod]</pre>
	Defines ~~the~~ other mods ~~whose assets~~ are used ~~by this one~~.		Defines other mods that are used at the same time.

	Attributes:		Attributes:
	*primarylist = ''list of mods'';		*primarylist = ''list of mods'';
	**These mods will override assets in the current ~~Mod~~		**These mods will override assets in the current mod. Primarylist is needed very rarely. Currently only [[Silent Threat: Reborn]] requires the use of primarylist.
	*secondarylist = ''list of mods'';		*secondarylist = ''list of mods'';
	**These mods will be added to the assets for the current ~~Mod~~, and may be ~~overrided~~ by data in the current ~~Mod~~.		**These mods will be added to the assets for the current mod, and may be overridden by data in the current mod.

	===Settings===		===Settings===
Line 46:		Line 46:
	website = http://www.hard-light.net/;		website = http://www.hard-light.net/;
	forum = http://www.hard-light.net/forums;		forum = http://www.hard-light.net/forums;
	mantis = http://www.hard-light.net/mantis;		mantis = http://www.hard-light.net/mantis;

	[multimod]		[multimod]
	primarylist = ;		primarylist = ;
	secondarylist = ;		secondarylist = ;
	</pre>		</pre>
Line 61:		Line 61:

	[multimod]		[multimod]
	primarylist = ;		primarylist = ;
	secondarylist = mediavps;		secondarylist = mediavps;

	[settings]		[settings]
	flags = -spec;		flags = -spec;
			</pre>

			===Silent Threat: Reborn===
			<pre>
			[launcher]
			modname = Silent Threat: Reborn v1.0;
			image255x112 = fsport-str.bmp;
			infotext = As the Great War rages on, you've been commissioned by Galactic Terran Intelligence for special intelligence operations. Your objectives are to contain the Shivan onslaught and preserve the fragile Terran-Vasudan alliance. But a series of suspicious events cloud the GTI's spotless record. Is the GTI setting you up or are the Shivans spreading their evil rage?;
			website = http://fsport.hard-light.net/website/str/;
			forum = http://www.hard-light.net/forums/index.php/board,140.0.html;

			[multimod]
			primarylist = fsport-mediavps;
			secondarylist = fsport,mediavps;
	</pre>		</pre>

	[[Category:Modding]]		[[Category:Modding]]

Fisk: secondrylist and the comma before the mod folder name are so pre-Launcher 5.4.

2010-01-14T17:42:58Z

secondrylist and the comma before the mod folder name are so pre-Launcher 5.4.

← Older revision		Revision as of 17:42, 14 January 2010
Line 62:		Line 62:
	[multimod]		[multimod]
	primarylist = ;		primarylist = ;
	~~secondrylist~~ = ,mediavps;		secondarylist = mediavps;

	[settings]		[settings]

Tomo: /* Introduction */

2010-01-10T14:28:49Z

Introduction

← Older revision		Revision as of 14:28, 10 January 2010
Line 4:		Line 4:

	The file must be called "mod.ini" and be in the main folder of the mod.		The file must be called "mod.ini" and be in the main folder of the mod.
			It must be in ASCII text format (not Unicode) and use Windows-style end-of-line markers.
	::: '''''PLEASE NOTE''': '''Launcher v 5.4''' or later, '''must be used'''. Earlier versions had some bugs that would cause this explanation about mod.ini to fail.''		::: '''''PLEASE NOTE''': '''Launcher v 5.4''' or later, '''must be used'''. Earlier versions had some bugs that would cause this explanation about mod.ini to fail.''

Tomo: /* Introduction */

2010-01-10T14:19:23Z

Introduction

← Older revision		Revision as of 14:19, 10 January 2010
Line 4:		Line 4:

	The file must be called "mod.ini" and be in the main folder of the mod.		The file must be called "mod.ini" and be in the main folder of the mod.
			::: '''''PLEASE NOTE''': '''Launcher v 5.4''' or later, '''must be used'''. Earlier versions had some bugs that would cause this explanation about mod.ini to fail.''

	==Sections==		==Sections==

TopAce: categorized - just to make sure people will have a chance of finding it

2010-01-10T14:17:53Z

categorized - just to make sure people will have a chance of finding it

← Older revision		Revision as of 14:17, 10 January 2010
Line 65:		Line 65:
	flags = -spec;		flags = -spec;
	</pre>		</pre>

			[[Category:Modding]]

Tomo at 14:01, 10 January 2010

2010-01-10T14:01:46Z

← Older revision		Revision as of 14:01, 10 January 2010
Line 54:		Line 54:
	[launcher]		[launcher]
	image255x112 = Derelict.bmp;		image255x112 = Derelict.bmp;
	infotext = Five years have passed since the jump node to the Capella system was collapsed~~, sealing off a massive wave of Shivan Juggernaughts from pushing further into GTVA space~~. ~~The supernova and subsequent nebula hang like a growing scar throughout the GTVA as light from that event continues to spread across our worlds~~. You are to take a new tour of duty with the 212th Silver Scythes squadron in the Tau Sigma cluster, a remote group of systems beyond the Altair Jump Node. These are mining colonies, and while the GTVA presence is small, it is nontheless important.;		infotext = Five years have passed since the jump node to the Capella system was collapsed...;
	website = http://www.3dap.com/hlp/hosted/ce/;		website = http://www.3dap.com/hlp/hosted/ce/;
	forum = http://dynamic.gamespy.com/~freespace/forums/forumdisplay.php?s=83686deb4fd49b5f670f6d92203b257d&forumid=89;		forum = http://dynamic.gamespy.com/~freespace/forums/forumdisplay.php?s=83686deb4fd49b5f670f6d92203b257d&forumid=89;