FSO Installer Text Files - Revision history

Goober5000: /* PATCH */ clarification

2017-09-19T18:11:13Z

PATCH: clarification

← Older revision		Revision as of 18:11, 19 September 2017
Line 165:		Line 165:
	<pre>java -jar FreeSpaceOpenInstaller.jar patch [old file] [diff file]</pre>		<pre>java -jar FreeSpaceOpenInstaller.jar patch [old file] [diff file]</pre>

	If any of the parameters are not supplied, the Installer will prompt you for them using standard GUI dialogs.		If any of the "diff" or "patch" command-line parameters are not supplied, the Installer will prompt you for them using standard GUI dialogs.

	===NOTE===		===NOTE===

Goober5000: add PATCH token

2017-09-19T18:09:55Z

add PATCH token

@@ Line 135: / Line 135: @@
     awesomemod_1\awesomegraphics.vp
     A49767C6CD9D9A5AB157F9FF75A4D5FA
 ===NOTE===

Goober5000: add features that are implemented but not yet released

2015-02-12T04:50:23Z

add features that are implemented but not yet released

← Older revision		Revision as of 04:50, 12 February 2015
Line 10:		Line 10:
	<pre>java -jar FreeSpaceOpenInstaller.jar validate [file]</pre>		<pre>java -jar FreeSpaceOpenInstaller.jar validate [file]</pre>

	You can specify the file to validate on the command line, or you can omit the file and the Installer will prompt you using a standard GUI file dialog.		You can specify the file to validate on the command line, or you can omit the file and the Installer will prompt you using a standard GUI file dialog. You can also specify "test" instead of "validate" and the Installer will launch a special session that loads the mod repository from your file.

	==Text File Specifications==		==Text File Specifications==
Line 165:		Line 165:
	*Takes no parameters.		*Takes no parameters.
	*Must follow the last parameter specified in a [[#DEPENDENCIES\|DEPENDENCIES]].		*Must follow the last parameter specified in a [[#DEPENDENCIES\|DEPENDENCIES]].

			===FLAGS===
			*Takes unlimited parameters, though only recognized flags are stored and duplicate flags are only stored once.
			*The last parameter must be followed by an [[#ENDFLAGS\|ENDFLAGS]].
			*Contains flags for the mod that allow tweaking of installation behavior. These are listed below. (Currently only one flag is implemented.)
			*Flags are not case-sensitive. Internally they are converted to upper-case before being stored.
			*'''EXCLUDE-FROM-COMPLETE-INSTALLATION''': Prevents a mod from being selected when the "Complete" installation option is chosen. This is for mods that shouldn't be installed without the user's explicit intent, such as language packs.
			'''Example'''
			FLAGS
			EXCLUDE-FROM-COMPLETE-INSTALLATION
			ENDFLAGS

			===ENDFLAGS===
			*Takes no parameters.
			*Must follow the last parameter specified in a [[#FLAGS\|FLAGS]].

	===VERSION===		===VERSION===

Goober5000: /* DEPENDENCIES */

2014-06-09T07:00:23Z

DEPENDENCIES

← Older revision		Revision as of 07:00, 9 June 2014
Line 153:		Line 153:
	*The last parameter must be followed by an [[#ENDDEPENDENCIES\|ENDDEPENDENCIES]].		*The last parameter must be followed by an [[#ENDDEPENDENCIES\|ENDDEPENDENCIES]].
	*Contains prerequisites for the mod that are outside of the direct mod tree. (Mods that are in a tree already require all of their ancestor mods.)		*Contains prerequisites for the mod that are outside of the direct mod tree. (Mods that are in a tree already require all of their ancestor mods.)
	*Each parameter should be the fully-qualified tree path of another mod. A tree path is constructed by concatenating mod names in order from parent to child, with a dot ~~(.)~~ between each mod name.		*Each parameter should be the fully-qualified tree path of another mod. A tree path is constructed by concatenating mod names in order from parent to child, with a dot or period between each mod name.
	*Make sure you double-check your tree path! If the installer cannot find a dependency, it assumes all mirrors for that dependency have failed and suggests that the user not install the mod.		*Make sure you double-check your tree path! If the installer cannot find a dependency, it assumes all mirrors for that dependency have failed and suggests that the user not install the mod.
	'''Example'''		'''Example'''

Goober5000: /* DEPENDENCIES */ clarification

2014-06-09T06:59:49Z

DEPENDENCIES: clarification

← Older revision		Revision as of 06:59, 9 June 2014
Line 153:		Line 153:
	*The last parameter must be followed by an [[#ENDDEPENDENCIES\|ENDDEPENDENCIES]].		*The last parameter must be followed by an [[#ENDDEPENDENCIES\|ENDDEPENDENCIES]].
	*Contains prerequisites for the mod that are outside of the direct mod tree. (Mods that are in a tree already require all of their ancestor mods.)		*Contains prerequisites for the mod that are outside of the direct mod tree. (Mods that are in a tree already require all of their ancestor mods.)
	*Each parameter should be the fully-qualified tree path of another mod. A tree path is constructed by concatenating ~~each~~ mod ~~name~~ in order from parent to child.		*Each parameter should be the fully-qualified tree path of another mod. A tree path is constructed by concatenating mod names in order from parent to child, with a dot (.) between each mod name.
	*Make sure you double-check your tree path! If the installer cannot find a dependency, it assumes all mirrors for that dependency have failed and suggests that the user not install the mod.		*Make sure you double-check your tree path! If the installer cannot find a dependency, it assumes all mirrors for that dependency have failed and suggests that the user not install the mod.
	'''Example'''		'''Example'''

Goober5000: add DEPENDENCIES

2014-06-08T01:40:41Z

add DEPENDENCIES

@@ Line 148: / Line 148: @@
 *Takes no parameters.
 *Must follow the last parameter specified in a [[#NOTE|NOTE]].
 ===VERSION===

Goober5000: reorder the entries to what is internal to FSOInstaller

2014-06-08T01:32:17Z

reorder the entries to what is internal to FSOInstaller

← Older revision		Revision as of 01:32, 8 June 2014
Line 32:		Line 32:
	NAME		NAME
	Awesome Mod		Awesome Mod

	===DESC===		===DESC===
	*Takes unlimited parameters.		*Takes unlimited parameters.
Line 40:		Line 41:
	This mod is so awesome that it will make you weep blood.		This mod is so awesome that it will make you weep blood.
	ENDDESC		ENDDESC

	===ENDDESC===		===ENDDESC===
	*Takes no parameters.		*Takes no parameters.
	*Must follow the last parameter specified in a [[#DESC\|DESC]].		*Must follow the last parameter specified in a [[#DESC\|DESC]].
	~~===NOTE===~~
	*Takes unlimited parameters.
	*The last parameter must be followed by an [[#ENDNOTE\|ENDNOTE]].
	*Is displayed to the user in the post-installation section of the installer.
	~~'''Example'''~~
	~~NOTE~~
	~~This mod requires FSO 3.6.54~~
	~~ENDNOTE~~

	~~===ENDNOTE===~~
	*Takes no parameters.
	*Must follow the last parameter specified in a [[#NOTE\|NOTE]].
	===FOLDER===		===FOLDER===
	*Takes one parameter.		*Takes one parameter.
Line 65:		Line 56:
	FOLDER		FOLDER
	awesomemod_1		awesomemod_1

			===DELETE===
			*Takes one parameter.
			*Deletes a file.
			*Files listed must be listed in subfolders as necessary relating to the [[#FOLDER\|FOLDER]] parameter specified.
			*Is the name of the file to delete.
			'''Example:''' If the [[#FOLDER\|FOLDER]] is \
			DELETE
			awesomemod_1\awesomeOLDgraphics.vp

			===RENAME===
			*Takes two parameters.
			*Allows renaming or moving of files.
			*The first parameter is the file to be renamed or moved.
			*The second parameter is the destination location and filename.
			*Only works if the destination file doesn't already exist.
			*Files listed must be listed in subfolders as necessary relating to the [[#FOLDER\|FOLDER]] parameter specified.
			'''Example:''' If the [[#FOLDER\|FOLDER]] is \
			RENAME
			awesomemod_1\awesomegraphics.vp
			awesomemod_1\awesomeOLDgraphics.vp

			===COPY===
			*Takes two parameters.
			*Allows copying files from one place to another.
			*The first parameter is the file to be copied.
			*The second parameter is the destination location and filename.
			*Only works if the destination file doesn't already exist.
			*Files listed must be listed in subfolders as necessary relating to the [[#FOLDER\|FOLDER]] parameter specified.
			'''Example:''' If the [[#FOLDER\|FOLDER]] is \
			COPY
			awesomemod_1\awesomegraphics.vp
			awesomemod_1\awesomeOLDgraphics.vp

	===URL===		===URL===
Line 76:		Line 100:
	URL		URL
	http://www.games.com/Freespace2/AwesomeModMirror		http://www.games.com/Freespace2/AwesomeModMirror

	===MULTIURL===		===MULTIURL===
	*Takes unlimited parameters.		*Takes unlimited parameters.
Line 95:		Line 120:
	*Takes no parameters.		*Takes no parameters.
	*Must follow the last parameter specified in a [[#MULTIURL\|MULTIURL]].		*Must follow the last parameter specified in a [[#MULTIURL\|MULTIURL]].
	~~===VERSION===~~
	*Takes one parameter.
	*Is a string that represents the version of the files in that section.
	**If this parameter is changed, the installer will flag that section as outdated.

	~~===END===~~
	*Takes no parameters.
	*Must include this command for every [[#NAME\|NAME]] command.
	*Signifies the end of a section.
	===HASH===		===HASH===
	*Takes three parameters.		*Takes three parameters.
Line 119:		Line 136:
	A49767C6CD9D9A5AB157F9FF75A4D5FA		A49767C6CD9D9A5AB157F9FF75A4D5FA

	===~~RENAME~~===		===NOTE===
	*Takes ~~two~~ parameters.		*Takes unlimited parameters.
	*Allows renaming or moving of files.		*The last parameter must be followed by an [[#ENDNOTE\|ENDNOTE]].
	*The first parameter is the file to be renamed or moved.		*Is displayed to the user in the post-installation section of the installer.
	*The ~~second~~ parameter ~~is the destination location and filename.~~		'''Example'''
	*Only works if the destination file doesn't already exist.		NOTE
	*Files listed must be ~~listed in subfolders as necessary relating to the~~ [[#~~FOLDER~~\|~~FOLDER~~]] ~~parameter specified~~.		This mod requires FSO 3.6.54
	'''Example:''' ~~If the [[#FOLDER\|FOLDER]] is \~~		ENDNOTE
	~~RENAME~~
	~~awesomemod_1\awesomegraphics~~.vp
	~~awesomemod_1\awesomeOLDgraphics.vp~~

	===~~COPY~~===		===ENDNOTE===
	*Takes ~~two~~ parameters.		*Takes no parameters.
	*~~Allows copying files from one place to another.~~		*Must follow the last parameter specified in a [[#NOTE\|NOTE]].
	*The first parameter is the ~~file to be copied.~~
	*The second parameter ~~is the destination location and filename.~~
	*Only works if the destination file doesn't already exist.
	*Files listed must be listed in ~~subfolders as necessary relating to the [[#FOLDER\|FOLDER]] parameter specified.~~
	~~'''Example:''' If the~~ [[#~~FOLDER~~\|~~FOLDER~~]] ~~is \~~
	~~COPY~~
	~~awesomemod_1\awesomegraphics.vp~~
	~~awesomemod_1\awesomeOLDgraphics~~.vp

	===~~DELETE~~===		===VERSION===
	*Takes one parameter.		*Takes one parameter.
	*~~Deletes~~ a ~~file~~.		*Is a string that represents the version of the files in that section.
	*~~Files listed must be listed in subfolders~~ as ~~necessary relating to the [[#FOLDER\|FOLDER]] parameter specified~~.		**If this parameter is changed, the installer will flag that section as outdated.
	*~~Is the name of the file to delete~~.
	~~'''Example:''' If the~~ [[#~~FOLDER~~\|~~FOLDER~~]] ~~is \~~		===END===
	~~DELETE~~		*Takes no parameters.
	~~awesomemod_1\awesomeOLDgraphics~~.vp		*Must include this command for every [[#NAME\|NAME]] command.
			*Signifies the end of a section.

	==Example Install.txt File==		==Example Install.txt File==

Goober5000: /* Quick Steps */ minor changes

2014-05-11T03:09:28Z

Quick Steps: minor changes

← Older revision		Revision as of 03:09, 11 May 2014
Line 8:		Line 8:

	You can use the FreeSpace Open Installer itself to validate the text file for any syntactical errors. Just run the following command at the command prompt, and select the text file with the dialog that appears:		You can use the FreeSpace Open Installer itself to validate the text file for any syntactical errors. Just run the following command at the command prompt, and select the text file with the dialog that appears:
	<pre>java -jar FreeSpaceOpenInstaller.jar validate</pre>		<pre>java -jar FreeSpaceOpenInstaller.jar validate [file]</pre>

			You can specify the file to validate on the command line, or you can omit the file and the Installer will prompt you using a standard GUI file dialog.

	==Text File Specifications==		==Text File Specifications==

Goober5000: add /* COPY */ section

2014-02-18T05:21:21Z

add COPY: section

@@ Line 128: / Line 128: @@
     awesomemod_1\awesomegraphics.vp
     awesomemod_1\awesomeOLDgraphics.vp
 ===DELETE===
 *Takes one parameter.

Goober5000: /* Example Install.txt File */ fix formatting

2014-02-02T00:00:13Z

Example Install.txt File: fix formatting

← Older revision		Revision as of 00:00, 2 February 2014
Line 143:		Line 143:
	This mod requires MediaVPs 3.6.12!		This mod requires MediaVPs 3.6.12!

	The day is August 3, 2335. Thirteen months have passed since the Lucifer was destroyed, mysteriously locking the Sol system away. It's barely been two months since the Hades superdestroyer was destroyed in orbit of Deneb, and the rogue GTI reduced to silence. There are many wounds to lick for the GTA, as the weakened fleet struggles to maintain order in its systems. Although the cease-fire treaty with their new Vasudan allies is still holding, the PVE is still busy dealing with the terrorist HoL faction.		The day is August 3, 2335. Thirteen months have passed since the Lucifer was destroyed, mysteriously locking the Sol system away. It's barely been two months since the Hades
			superdestroyer was destroyed in orbit of Deneb, and the rogue GTI reduced to silence. There are many wounds to lick for the GTA, as the weakened fleet struggles to maintain order
			in its systems. Although the cease-fire treaty with their new Vasudan allies is still holding, the PVE is still busy dealing with the terrorist HoL faction.

	Now is our chance to get past them. We no longer need to so carefully hide. Now we can make our deal with the devil.		Now is our chance to get past them. We no longer need to so carefully hide. Now we can make our deal with the devil.