Setting up a campaign file - Revision history

Goober5000: /* Mission options */ add Debriefing Persona Index

2024-09-09T01:07:23Z

Mission options: add Debriefing Persona Index

← Older revision		Revision as of 01:07, 9 September 2024
Line 28:		Line 28:
	*''Briefing cutscene'': You will not need these unless you want a cutscene be played before your mission.		*''Briefing cutscene'': You will not need these unless you want a cutscene be played before your mission.
	*''Main hall name'' (previously ''Main hall index'') is the identifier of the main hall to use when the player is at the selected mission. In current versions of FSO, this can be a name or a number; in older versions of FSO, this had to be a number; and in retail, this was a checkbox. When the ''FreeSpace 1'' or ''FreeSpace 2'' campaigns are loaded, 0 represents the ''Galatea'' (''FreeSpace 1'') or the ''Aquitaine'' (''FreeSpace 2''), and 1 represents the ''Bastion'' (''FreeSpace 1'') or the ''Psamtik'' (''FreeSpace 2'').		*''Main hall name'' (previously ''Main hall index'') is the identifier of the main hall to use when the player is at the selected mission. In current versions of FSO, this can be a name or a number; in older versions of FSO, this had to be a number; and in retail, this was a checkbox. When the ''FreeSpace 1'' or ''FreeSpace 2'' campaigns are loaded, 0 represents the ''Galatea'' (''FreeSpace 1'') or the ''Aquitaine'' (''FreeSpace 2''), and 1 represents the ''Bastion'' (''FreeSpace 1'') or the ''Psamtik'' (''FreeSpace 2'').
			*''Debriefing persona index'': The number prefix to be used for the automatic, or persona-based, debriefing messages. For example, badge_a.wav is the file for the Ace debriefing message. In FS2, the debriefing persona index for the 70th Blue Lions missions is 9, so 9_badge_a.wav will be used in these missions. 9 is also the default debriefing persona index used when the campaign does not specify one.

	===Branches===		===Branches===

Goober5000: /* Mission options */ update Main Hall Name

2024-09-09T00:44:33Z

Mission options: update Main Hall Name

← Older revision		Revision as of 00:44, 9 September 2024
Line 27:		Line 27:
	These options are by default grayed out. You can edit these options if you click on a mission that you already inserted into the right-side window.		These options are by default grayed out. You can edit these options if you click on a mission that you already inserted into the right-side window.
	*''Briefing cutscene'': You will not need these unless you want a cutscene be played before your mission.		*''Briefing cutscene'': You will not need these unless you want a cutscene be played before your mission.
	*''Main hall index'' ~~can be 0 or 1. If it's 0, then if~~ the player is at the selected mission, ~~the Main Hall will~~ be ~~that~~ of the ''Galatea'' (''FreeSpace 1'') or the ''Aquitaine'' (''FreeSpace 2'')~~. If it's~~ 1~~, then the Main Hall will be that of~~ the ''Bastion'' (''FreeSpace 1'') or the ''Psamtik'' (''FreeSpace 2'').		*''Main hall name'' (previously ''Main hall index'') is the identifier of the main hall to use when the player is at the selected mission. In current versions of FSO, this can be a name or a number; in older versions of FSO, this had to be a number; and in retail, this was a checkbox. When the ''FreeSpace 1'' or ''FreeSpace 2'' campaigns are loaded, 0 represents the ''Galatea'' (''FreeSpace 1'') or the ''Aquitaine'' (''FreeSpace 2''), and 1 represents the ''Bastion'' (''FreeSpace 1'') or the ''Psamtik'' (''FreeSpace 2'').

	===Branches===		===Branches===

Niffiwan: /* The right-side window */ bah; lrn2template

2016-02-21T04:01:33Z

The right-side window: bah; lrn2template

← Older revision		Revision as of 04:01, 21 February 2016
Line 65:		Line 65:
	*''End of Campaign'': Used to order the game to end the campaign.		*''End of Campaign'': Used to order the game to end the campaign.

	{note: For training missions, the conditions for advancing to the next mission must be set using goals and not events! The reason is that the Skip Training button marks all goals as complete and all events as failed. If the next-mission-condition is an event, it'll always end up false and thus the next mission will not be selected correctly. Well, technically I guess you could use events as long as if, when they're marked false, the player will advance to the next mission...}		{{note \| For training missions, the conditions for advancing to the next mission must be set using goals and not events! The reason is that the Skip Training button marks all goals as complete and all events as failed. If the next-mission-condition is an event, it'll always end up false and thus the next mission will not be selected correctly. Well, technically I guess you could use events as long as if, when they're marked false, the player will advance to the next mission...}}


	If you take a look at the Branches section (to the left), you will see that it now says: "Branch to xx" and, if you clicked on Add a Repeat Link, "Repeat mission." If you expand them, you will see that you can set up a SEXP tree there. This SEXP tree will tell under what conditions will the player be able to proceed in the campaign or forced to replay the mission. One of these trees must be set to ''[[true]]''. This "true" link must also be the last in the list, otherwise your campaign won't run. In the example (look at the picture), the conditions to proceed in the campaign are set, and the repeat link is set to ''true''. If you want to set the conditions under which the player is forced to replay the mission, your "Branch to xx" must be set to true. Neither method is superior to or more advisable than the other. It's a matter of preference. If there are two conflicting set of conditions, the one that is higher in the list will take place. (This is why the "true" tree must be last to eliminate the logical possibility that nothing would return a true value).		If you take a look at the Branches section (to the left), you will see that it now says: "Branch to xx" and, if you clicked on Add a Repeat Link, "Repeat mission." If you expand them, you will see that you can set up a SEXP tree there. This SEXP tree will tell under what conditions will the player be able to proceed in the campaign or forced to replay the mission. One of these trees must be set to ''[[true]]''. This "true" link must also be the last in the list, otherwise your campaign won't run. In the example (look at the picture), the conditions to proceed in the campaign are set, and the repeat link is set to ''true''. If you want to set the conditions under which the player is forced to replay the mission, your "Branch to xx" must be set to true. Neither method is superior to or more advisable than the other. It's a matter of preference. If there are two conflicting set of conditions, the one that is higher in the list will take place. (This is why the "true" tree must be last to eliminate the logical possibility that nothing would return a true value).

Niffiwan: little gotcha about training mission completion conditions & the "Skip Training" button

2016-02-21T03:57:31Z

little gotcha about training mission completion conditions & the "Skip Training" button

← Older revision		Revision as of 03:57, 21 February 2016
Line 22:		Line 22:
	*''Campaign type'' can be single player, multiplayer cooperative, and multiplayer team. If you set your campaign to be single player, it will appear in the Campaign Room. If it's multiplayer, it will appear under the multiplayer campaigns tab in the Campaign Host window.		*''Campaign type'' can be single player, multiplayer cooperative, and multiplayer team. If you set your campaign to be single player, it will appear in the Campaign Room. If it's multiplayer, it will appear under the multiplayer campaigns tab in the Campaign Host window.
	*''Campaign description'' is the campaign's short description in the Campaign Room.		*''Campaign description'' is the campaign's short description in the Campaign Room.


	===Mission options===		===Mission options===
Line 63:		Line 64:
	*''Add a Repeat Link'': Defines that under what conditions the player will be forced to replay the mission. From a gameplay perspective, every mission requires this. Otherwise the player can simply jump out at the end of the mission and proceed in the campaign.		*''Add a Repeat Link'': Defines that under what conditions the player will be forced to replay the mission. From a gameplay perspective, every mission requires this. Otherwise the player can simply jump out at the end of the mission and proceed in the campaign.
	*''End of Campaign'': Used to order the game to end the campaign.		*''End of Campaign'': Used to order the game to end the campaign.

			{note: For training missions, the conditions for advancing to the next mission must be set using goals and not events! The reason is that the Skip Training button marks all goals as complete and all events as failed. If the next-mission-condition is an event, it'll always end up false and thus the next mission will not be selected correctly. Well, technically I guess you could use events as long as if, when they're marked false, the player will advance to the next mission...}

	If you take a look at the Branches section (to the left), you will see that it now says: "Branch to xx" and, if you clicked on Add a Repeat Link, "Repeat mission." If you expand them, you will see that you can set up a SEXP tree there. This SEXP tree will tell under what conditions will the player be able to proceed in the campaign or forced to replay the mission. One of these trees must be set to ''[[true]]''. This "true" link must also be the last in the list, otherwise your campaign won't run. In the example (look at the picture), the conditions to proceed in the campaign are set, and the repeat link is set to ''true''. If you want to set the conditions under which the player is forced to replay the mission, your "Branch to xx" must be set to true. Neither method is superior to or more advisable than the other. It's a matter of preference. If there are two conflicting set of conditions, the one that is higher in the list will take place. (This is why the "true" tree must be last to eliminate the logical possibility that nothing would return a true value).		If you take a look at the Branches section (to the left), you will see that it now says: "Branch to xx" and, if you clicked on Add a Repeat Link, "Repeat mission." If you expand them, you will see that you can set up a SEXP tree there. This SEXP tree will tell under what conditions will the player be able to proceed in the campaign or forced to replay the mission. One of these trees must be set to ''[[true]]''. This "true" link must also be the last in the list, otherwise your campaign won't run. In the example (look at the picture), the conditions to proceed in the campaign are set, and the repeat link is set to ''true''. If you want to set the conditions under which the player is forced to replay the mission, your "Branch to xx" must be set to true. Neither method is superior to or more advisable than the other. It's a matter of preference. If there are two conflicting set of conditions, the one that is higher in the list will take place. (This is why the "true" tree must be last to eliminate the logical possibility that nothing would return a true value).

TopAce: It's not Shift-C in FSO anymore

2013-02-10T10:12:16Z

It's not Shift-C in FSO anymore

← Older revision		Revision as of 10:12, 10 February 2013
Line 1:		Line 1:
	In ''FreeSpace'', '''campaigns''' are stored in text-based *.fc2 files. Setting up a campaign can be done in two ways: in FRED's Campaign Editor (SHIFT-C in retail, and in ~~most—but not all—~~FreeSpace Open builds) or in a conventional text editor like Notepad.		In ''FreeSpace'', '''campaigns''' are stored in text-based *.fc2 files. Setting up a campaign can be done in two ways: in FRED's Campaign Editor (SHIFT-C in retail, and in very old FreeSpace Open builds) or in a conventional text editor like Notepad.

	This article will be about the '''Campaign Editor'''.		This article will be about the '''Campaign Editor'''.

	==Prerequisites==		==Prerequisites==
	Before you start setting up your campaign, make sure that you have all the missions that you want to be in your campaign. Gradually adding new and new missions to a campaign file is not recommended ~~in FreeSpace~~.		Before you start setting up your campaign, make sure that you have all the missions that you want to be in your campaign. Gradually adding new and new missions to a campaign file is not recommended for beginners.

	If you plan to include new, ~~nonretail~~ ships in your campaign, make sure that they are in the table files already. Gradually attaching new and new user-made ships or weapons works on the same principle as adding new missions.		If you plan to include new, non-retail ships in your campaign, make sure that they are in the table files already. Gradually attaching new and new user-made ships or weapons works on the same principle as adding new missions.

	Your missions and table files don't have to be final. You can modify both the mission and table files unpunished. ''FreeSpace'' campaign files only refer to missions and table entries, the contents of these files are unimportant ~~when talking about campaigns~~. However, if you rename anything, revise the campaign file, as it must reflect the most recent file names. Revising the campaign file in such a way is recommended in a text editor. See [[Editing a mission in a text editor]].		Your missions and table files don't have to be final. You can modify both the mission and table files unpunished. ''FreeSpace'' campaign files only refer to missions and table entries, the contents of these files are unimportant as far as the campaign files are concerned. However, if you rename anything, revise the campaign file, as it must reflect the most recent file names. Revising the campaign file in such a way is recommended in a text editor. See [[Editing a mission in a text editor]].

	==The Campaign Editor==		==The Campaign Editor==

TopAce: /* The Campaign Editor */

2011-04-04T09:17:07Z

The Campaign Editor

← Older revision		Revision as of 09:17, 4 April 2011
Line 11:		Line 11:

	==The Campaign Editor==		==The Campaign Editor==
	The Campaign Editor is accessed by pressing SHIFT-C in [[Portal:FRED\|FRED]].		The Campaign Editor is accessed through the Editors tab, or (in [[retail]]) by pressing SHIFT-C in [[Portal:FRED\|FRED]].

	Here is a list of what windows you see, and some explanations on what you can do with them:		Here is a list of what windows you see, and some explanations on what you can do with them:

	===Available missions===		===Available missions===
	This is a list of all the missions that are within your missions folder. You can take missions from this window and put them into the right-side window by highlighting the mission you want, holding CTRL and clicking on the part of the campaign tree you want the mission in. If the missions that you are looking for aren't in this window, make sure you have the ~~[[FRED Command Line Reference\|-~~mod~~]] parameter set right~~ and your missions are indeed in ~~the~~ data/missions folder ~~of the current mod~~. If you put a mission into the right-side window, it will disappear from this list. If you remove a mission from the campaign's mission list, it will reappear in the Available Missions window.		This is a list of all the missions that are within your missions folder. You can take missions from this window and put them into the right-side window by highlighting the mission you want, holding CTRL and clicking on the part of the campaign tree you want the mission in. If the missions that you are looking for aren't in this window, make sure you have the appropriate mod selected in the Launcher and your missions are indeed in mymod/data/missions folder. If you put a mission into the right-side window, it will disappear from this list. If you remove a mission from the campaign's mission list, it will reappear in the Available Missions window.

	===Campaign name, type, description===		===Campaign name, type, description===
	*''Campaign name'' is the name of the campaign~~. It's this name that will appear~~ in the Campaign Room.		*''Campaign name'' is the name of the campaign in the Campaign Room.
	*''Campaign type''' can be single player, multiplayer cooperative, and multiplayer team. If you set your campaign to be single player, it will appear in the Campaign Room. If it's multiplayer, it will appear under the multiplayer campaigns tab in the Campaign Host window.		*''Campaign type'' can be single player, multiplayer cooperative, and multiplayer team. If you set your campaign to be single player, it will appear in the Campaign Room. If it's multiplayer, it will appear under the multiplayer campaigns tab in the Campaign Host window.
	*''Campaign description'' is the campaign's description ~~that will appear~~ in the Campaign Room.		*''Campaign description'' is the campaign's short description in the Campaign Room.

	===Mission options===		===Mission options===
Line 64:		Line 64:
	*''End of Campaign'': Used to order the game to end the campaign.		*''End of Campaign'': Used to order the game to end the campaign.

	If you take a look at the Branches section (to the left), you will see that it now says: "Branch to xx" and, if you clicked on Add a Repeat Link, "Repeat mission." If you expand them, you will see that you can set up a SEXP tree there. This SEXP tree will tell under what conditions will the player be able to proceed in the campaign or forced to replay the mission. One of these trees must be set to [[true]]. This "true" link must also be the last in the list, otherwise your campaign won't run. In the example (look at the picture), the conditions to proceed in the campaign are set, and the repeat link is set to true. If you want to set the conditions under which the player is forced to replay the mission, your "Branch to xx" must be set to true. Neither method is superior to or more advisable than the other. It's a matter or preference. If there are two conflicting set of conditions, the one that is higher in the list will take place (~~this~~ is why the "true" tree must be last).		If you take a look at the Branches section (to the left), you will see that it now says: "Branch to xx" and, if you clicked on Add a Repeat Link, "Repeat mission." If you expand them, you will see that you can set up a SEXP tree there. This SEXP tree will tell under what conditions will the player be able to proceed in the campaign or forced to replay the mission. One of these trees must be set to ''[[true]]''. This "true" link must also be the last in the list, otherwise your campaign won't run. In the example (look at the picture), the conditions to proceed in the campaign are set, and the repeat link is set to ''true''. If you want to set the conditions under which the player is forced to replay the mission, your "Branch to xx" must be set to true. Neither method is superior to or more advisable than the other. It's a matter of preference. If there are two conflicting set of conditions, the one that is higher in the list will take place. (This is why the "true" tree must be last to eliminate the logical possibility that nothing would return a true value).

	==Editing in a text editor==		==Editing in a text editor==

CommanderDJ: /* Available missions */

2010-10-05T05:46:47Z

Available missions

← Older revision		Revision as of 05:46, 5 October 2010
Line 16:		Line 16:

	===Available missions===		===Available missions===
	This is a list of all the missions that are within your missions folder. You can take missions from this window and put them into the right-side window by highlighting the mission you want, holding CTRL and clicking on the part of the campaign tree you want the mission in. If ~~that~~ missions that you are looking for aren't in this window, make sure you have the [[FRED Command Line Reference\|-mod]] parameter set right and your missions are indeed in the data/missions folder. If you ~~drag~~ a mission to the right-side window, it will disappear from this list. If you remove a mission from the campaign's mission list, it will ~~reapper~~ in the Available ~~missions~~ window.		This is a list of all the missions that are within your missions folder. You can take missions from this window and put them into the right-side window by highlighting the mission you want, holding CTRL and clicking on the part of the campaign tree you want the mission in. If the missions that you are looking for aren't in this window, make sure you have the [[FRED Command Line Reference\|-mod]] parameter set right and your missions are indeed in the data/missions folder of the current mod. If you put a mission into the right-side window, it will disappear from this list. If you remove a mission from the campaign's mission list, it will reappear in the Available Missions window.

	===Campaign name, type, description===		===Campaign name, type, description===

CommanderDJ: /* Available missions */

2010-10-05T05:45:58Z

Available missions

← Older revision		Revision as of 05:45, 5 October 2010
Line 16:		Line 16:

	===Available missions===		===Available missions===
	This is a list of all the missions that are within your missions folder. You can ~~drag the~~ missions from this window to the right-side window. If that missions that you are looking for aren't in this window, make sure you have the [[FRED Command Line Reference\|-mod]] parameter set right and your missions are indeed in the data/missions folder. If you drag a mission to the right-side window, it will disappear from this list. If you remove a mission from the campaign's mission list, it will reapper in the Available missions window.		This is a list of all the missions that are within your missions folder. You can take missions from this window and put them into the right-side window by highlighting the mission you want, holding CTRL and clicking on the part of the campaign tree you want the mission in. If that missions that you are looking for aren't in this window, make sure you have the [[FRED Command Line Reference\|-mod]] parameter set right and your missions are indeed in the data/missions folder. If you drag a mission to the right-side window, it will disappear from this list. If you remove a mission from the campaign's mission list, it will reapper in the Available missions window.

	===Campaign name, type, description===		===Campaign name, type, description===

TopAce: /* Mission loop description, brief anim, brief voice */

2008-12-24T12:01:52Z

Mission loop description, brief anim, brief voice

← Older revision		Revision as of 12:01, 24 December 2008
Line 38:		Line 38:
	[[Image:CampaignEditLoop.JPG\|thumb\|right\|Campaign loop example]]		[[Image:CampaignEditLoop.JPG\|thumb\|right\|Campaign loop example]]

	Loop missions are like the [[Special Operations Command\|SOC]] ~~one~~ in the Main FreeSpace 2 Campaign. The player can choose whether or not he wishes to complete some bonus missions or proceed with the main branch.		Loop missions are like the [[Special Operations Command\|SOC]] ones in the Main FreeSpace 2 Campaign. The player can choose whether or not he wishes to complete some bonus missions or proceed with the main branch.

	In order to gain access to the mission loop options, you must select the mission in the right-side window that ''precedes'' your loop mission and select a branch that activates your loop. To do that, you must have at least two other missions connected to the mission that you select.		In order to gain access to the mission loop options, you must select the mission in the right-side window that ''precedes'' your loop mission and select a branch that activates your loop. To do that, you must have at least two other missions connected to the mission that you select.

TopAce: /* Available missions */

2008-12-21T14:08:18Z

Available missions

← Older revision		Revision as of 14:08, 21 December 2008
Line 16:		Line 16:

	===Available missions===		===Available missions===
	This is a list of all the missions that are within your missions folder. You can drag the missions from this window to the right-side window. If that missions that you are looking for aren't in this window, make sure you have the -mod parameter set right and your missions are indeed in the data/missions folder. If you drag a mission to the right-side window, it will disappear from this list. If you remove a mission from the campaign's mission list, it will reapper in the Available missions window.		This is a list of all the missions that are within your missions folder. You can drag the missions from this window to the right-side window. If that missions that you are looking for aren't in this window, make sure you have the [[FRED Command Line Reference\|-mod]] parameter set right and your missions are indeed in the data/missions folder. If you drag a mission to the right-side window, it will disappear from this list. If you remove a mission from the campaign's mission list, it will reapper in the Available missions window.

	===Campaign name, type, description===		===Campaign name, type, description===