Editing a mission in a text editor - Revision history

TopAce: /* Repairing broken missions */ this just happened to me, so I'm adding here as an example too

2020-12-12T12:25:24Z

Repairing broken missions: this just happened to me, so I'm adding here as an example too

← Older revision		Revision as of 12:25, 12 December 2020
Line 103:		Line 103:

	Scroll down your mission and see if there are big empty spaces anywhere. If you find any, remove them. Do not remove anything else but enters and spaces.		Scroll down your mission and see if there are big empty spaces anywhere. If you find any, remove them. Do not remove anything else but enters and spaces.

			During copy/pasting text data, you might accidentally remove/forget to add (, ), or " characters and break the mission.

	Under the most desperate of circumstances, retrieve an older version by renaming the mission's .bak file to .fs2, or seek the help of a more experienced [[FREDder]].		Under the most desperate of circumstances, retrieve an older version by renaming the mission's .bak file to .fs2, or seek the help of a more experienced [[FREDder]].

TopAce: Notepad++

2020-11-29T12:37:06Z

Notepad++

← Older revision		Revision as of 12:37, 29 November 2020
Line 2:		Line 2:

	This article will use "WordPad" instead of "any conventional text editor" for the sake of simplicity. Wherever the word ''WordPad'' occurs, it is interchangeable with the text editor you prefer using. The single most important thing to consider is your program of choice's ability to save in a pure text format.		This article will use "WordPad" instead of "any conventional text editor" for the sake of simplicity. Wherever the word ''WordPad'' occurs, it is interchangeable with the text editor you prefer using. The single most important thing to consider is your program of choice's ability to save in a pure text format.

			The most popular text editor in the community is [https://notepad-plus-plus.org/downloads/ Notepad++].

	==Precautions==		==Precautions==

TopAce: working with Notepad and FRED simultaneously

2020-11-29T12:32:52Z

working with Notepad and FRED simultaneously

← Older revision		Revision as of 12:32, 29 November 2020
Line 104:		Line 104:
	Under the most desperate of circumstances, retrieve an older version by renaming the mission's .bak file to .fs2, or seek the help of a more experienced [[FREDder]].		Under the most desperate of circumstances, retrieve an older version by renaming the mission's .bak file to .fs2, or seek the help of a more experienced [[FREDder]].

			==Working with Notepad(++) and FRED simultaneously==
			You can have your mission open in Notepad++ and FRED at the same time without risking any edit conflicts between the two. There are only two scenarios that you must learn to handle.

			Since Notepad is an auxiliary tool, the scenario you will encounter is this: You are in FRED and realize you're better off doing some edits in your text editor. Say, you need to make a long list for your [[when-argument]]. Save the mission, refresh your Notepad's .fs2 file, make the changes, save. Notepad++ is one of the more advanced plain text editors out there that lets you refresh your opened files in a matter of a click because the program is sophsticated enough to detect if the one of its opened files changes. Usually, a confirmation window will come up asking whether you want to refresh your file. Click yes. If it's not there, simply open another tab, then get back to your mission's tab, and the window will pop up.

			Once you've made sure both Notepad and FRED have the same version of the mission loaded, make your edits in Notepad and save. Alt-Tab to FRED, move your camera around a little bit, then click File --> Revert (no hotkey) and wait until your camera jumps back to its original position. You needn't move the camera, it's just a convenient way to recognize when your reload is complete.

			Continue your FREDding as normal. If you need the text editor again, jump back to step one.

			The pitfalls are the usual. While editing the text data, you may spawn some errors that FRED would not let you make or an error message would pop up on save. For example, you remove a mission event/message/waypoint that you thought was unused but wasn't. You can then use either your text editor's Find tool to track down all the references to it or follow where the error messages in FRED point to and fix them one by one.

			'''Long story short:''' Save your mission, reopen/refresh your .fs2 in your text editor, make the changes, save, get back to FRED, click File --> Revert.

	[[Category:FRED Tips]]		[[Category:FRED Tips]]

TopAce: /* Miscellaneous mass importing of data */ formatting

2020-07-01T07:17:44Z

Miscellaneous mass importing of data: formatting

← Older revision		Revision as of 07:17, 1 July 2020
Line 82:		Line 82:

	Usually, these are the parts of the missions' data files you'll be interested in:		Usually, these are the parts of the missions' data files you'll be interested in:
	*#Variables		*<nowiki>#Variables</nowiki>
	*#Objects		*<nowiki>#Objects</nowiki>
	*#Wings		*<nowiki>#Wings</nowiki>
	*#Events		*<nowiki>#Events</nowiki>
	*#Goals		*<nowiki>#Goals</nowiki>
	*#Waypoints		*<nowiki>#Waypoints</nowiki>
	*#Messages		*<nowiki>#Messages</nowiki>

	====Note on variables====		====Note on variables====

TopAce: /* Uses */ new section about mass importing and notes on importing variables

2020-07-01T07:16:08Z

Uses: new section about mass importing and notes on importing variables

← Older revision		Revision as of 07:16, 1 July 2020
Line 77:		Line 77:

	In case of emergency or desperation, give up using Special Hits. Start by canceling all the Special Hits in FRED, save, and open the mission in WordPad. Delete all the outdated variables that used to belong to the old Special Hits values (if they are still there). Set all the values again and test.		In case of emergency or desperation, give up using Special Hits. Start by canceling all the Special Hits in FRED, save, and open the mission in WordPad. Delete all the outdated variables that used to belong to the old Special Hits values (if they are still there). Set all the values again and test.

			===Miscellaneous mass importing of data===
			You can copy/paste any data, such as objects, mission events, or messages, from one mission to another. For example, you created a test mission specifically to test a complex scenario that would otherwise take place later in the main mission, and you decided you are now satisfied with the scenario, and you want to apply those changes to the main mission. There are lots of things missing from the main mission simply because you built that scenario in your test mission. The time has come to add those missing data batches by batches to the main mission file by meticuluosly copy/pasting everything from the test mission to the main mission.

			Usually, these are the parts of the missions' data files you'll be interested in:
			*#Variables
			*#Objects
			*#Wings
			*#Events
			*#Goals
			*#Waypoints
			*#Messages

			====Note on variables====
			Be very careful with copy/pasting variables. The number IDs (indexes) of your variables are critical and your variables must be numbered according to the alphabetical order of their names. It is more than likely that your variable "turret-count" is number 10 in your test mission, but is number 3 in the main. You cannot simply edit the variable's index number to 10 and be done with it, otherwise the game will not be able to load your mission because its file is now damaged. You can copy/paste your variables one by one in alphabetical order first, then changing their numbers second.

			This method is quite volatile and prone to human error. The most reliable way is to add the variables to the main mission in FRED's Mission Event Editor. Once you have all the variables you need, you can safely copy/paste the mission events that refer to those variables.

	==Repairing broken missions==		==Repairing broken missions==

TopAce: note on file format (just in case)

2013-02-07T10:52:45Z

note on file format (just in case)

← Older revision		Revision as of 10:52, 7 February 2013
Line 1:		Line 1:
	Mission data files (.fs2) in FreeSpace are completely text-based, and can be opened and modified easily with a '''conventional text editor'''.		Mission data files (.fs2) in FreeSpace are completely text-based, and can be opened and modified easily with a '''conventional text editor'''.

	This article will use "WordPad" instead of "any conventional text editor" for the sake of simplicity. Wherever the word ''WordPad'' occurs, it is interchangeable with the text editor you prefer using.		This article will use "WordPad" instead of "any conventional text editor" for the sake of simplicity. Wherever the word ''WordPad'' occurs, it is interchangeable with the text editor you prefer using. The single most important thing to consider is your program of choice's ability to save in a pure text format.

	==Precautions==		==Precautions==

TopAce: /* Fixing Special Hits */ note on builds

2013-02-07T10:48:24Z

Fixing Special Hits: note on builds

← Older revision		Revision as of 10:48, 7 February 2013
Line 62:		Line 62:
	Also, it is impossible to set the number of stars in the background equal to zero using FRED alone. You must use Notepad to do this. Make sure you do this if you are using a skybox as the normal retail stars will look quite ugly on top of it.		Also, it is impossible to set the number of stars in the background equal to zero using FRED alone. You must use Notepad to do this. Make sure you do this if you are using a skybox as the normal retail stars will look quite ugly on top of it.

	===Fixing Special Hits===		===Fixing Special Hits (Retail FS, and very old FSO)===
	FRED has a peculiar way of storing and accessing custom hitpoints (set in the Special Hits window). Instead of storing it in the ship's entry, custom hitpoints are in reality variables that are assigned an identification number. As the mission starts using more and more variables, these identification numbers might get mixed up. This might result in a ''Colossus''-size vessel having 500 hitpoints and a Myrmidon 2,500,000. An entry looks like this:		FRED has a peculiar way of storing and accessing custom hitpoints (set in the Special Hits window). Instead of storing it in the ship's entry, custom hitpoints are in reality variables that are assigned an identification number. As the mission starts using more and more variables, these identification numbers might get mixed up. This might result in a ''Colossus''-size vessel having 500 hitpoints and a Myrmidon 2,500,000. An entry looks like this:

TopAce at 14:00, 28 December 2008

2008-12-28T14:00:00Z

← Older revision		Revision as of 14:00, 28 December 2008
Line 40:		Line 40:

	===Proofreading===		===Proofreading===
	:''For more information, see [[~~Tips for spellchecking~~ a mission#Quick revision with WordPad\|this]].''		:''For more information, see [[Spellchecking a mission#Quick revision with WordPad\|this]].''

	Changing all text-based data like briefings, messages, or ship names belong here. Making these changes can be done in FRED, but you have to account for the unpredictable crash factor. Using WordPad for this purpose is a more convenient way for some community members. You can quickly and easily change all your messages if you want to without needing to open your Mission Event Edit window and modify one message at a given time.		Changing all text-based data like briefings, messages, or ship names belong here. Making these changes can be done in FRED, but you have to account for the unpredictable crash factor. Using WordPad for this purpose is a more convenient way for some community members. You can quickly and easily change all your messages if you want to without needing to open your Mission Event Edit window and modify one message at a given time.

Mustang19: small changes

2008-12-23T13:18:56Z

small changes

← Older revision		Revision as of 13:18, 23 December 2008
Line 24:		Line 24:
	The most frequent (and possibly most obvious) disadvantage is that, in inexperienced or inattentive hands, a mission's code can be broken easily. In contrast to the crashes FRED produces, these crashes are triggered by human hands in all cases. Sometimes you accidentally remove a $ mark or add a semicolon (;) into a text. The more experienced you are, the more likely you are able to pinpoint the bit responsible for breaking the code, and mend it. It is imperative that you try to run the mission you altered to see if the very least FreeSpace can load it safely.		The most frequent (and possibly most obvious) disadvantage is that, in inexperienced or inattentive hands, a mission's code can be broken easily. In contrast to the crashes FRED produces, these crashes are triggered by human hands in all cases. Sometimes you accidentally remove a $ mark or add a semicolon (;) into a text. The more experienced you are, the more likely you are able to pinpoint the bit responsible for breaking the code, and mend it. It is imperative that you try to run the mission you altered to see if the very least FreeSpace can load it safely.

	Another disadvantage is that you cannot edit everything you wish, due to the code in which FS missions are stored. There are several bitfields (like for Player Orders) that are only a series of numbers.		Another disadvantage is that you cannot edit everything you wish, due to the code in which FS missions are stored. There are several bitfields (like for Player Orders and Mission Flags, eg Red Alert status) that are only a series of numbers.

	==Uses==		==Uses==
Line 59:		Line 59:

	You can also import Command and Mission Briefings this way without much of a risk. Other parts of the mission are more risky, because if they refer to ships or Events that are not in your destination mission, they will produce an error message.		You can also import Command and Mission Briefings this way without much of a risk. Other parts of the mission are more risky, because if they refer to ships or Events that are not in your destination mission, they will produce an error message.

			Also, it is impossible to set the number of stars in the background equal to zero using FRED alone. You must use Notepad to do this. Make sure you do this if you are using a skybox as the normal retail stars will look quite ugly on top of it.

	===Fixing Special Hits===		===Fixing Special Hits===
Line 84:		Line 86:

	Under the most desperate of circumstances, retrieve an older version by renaming the mission's .bak file to .fs2, or seek the help of a more experienced [[FREDder]].		Under the most desperate of circumstances, retrieve an older version by renaming the mission's .bak file to .fs2, or seek the help of a more experienced [[FREDder]].


	[[Category:FRED Tips]]		[[Category:FRED Tips]]

TopAce: /* Uses */ New section

2008-10-06T20:35:31Z

Uses: New section

← Older revision		Revision as of 20:35, 6 October 2008
Line 59:		Line 59:

	You can also import Command and Mission Briefings this way without much of a risk. Other parts of the mission are more risky, because if they refer to ships or Events that are not in your destination mission, they will produce an error message.		You can also import Command and Mission Briefings this way without much of a risk. Other parts of the mission are more risky, because if they refer to ships or Events that are not in your destination mission, they will produce an error message.

			===Fixing Special Hits===
			FRED has a peculiar way of storing and accessing custom hitpoints (set in the Special Hits window). Instead of storing it in the ship's entry, custom hitpoints are in reality variables that are assigned an identification number. As the mission starts using more and more variables, these identification numbers might get mixed up. This might result in a ''Colossus''-size vessel having 500 hitpoints and a Myrmidon 2,500,000. An entry looks like this:

			92 "GVD Hedret" "0" "block"
			93 "GVD Hedret" "200000" "block"

			The first value (92) is the amount of shield the ship is set to have. Even if this is a Hatshepsut destroyer that has no shields, FRED requires both the shield and the hitpoint value (93). The heart of the problem is this line from the ship's entry:

			+Special Hitpoint index: 94

			This line is near the bottom of the ship's entry. This value isn't what it should be. 94 and 95 belong to another ship (a bomber), that has 1100 shields and 700 hitpoints. This results in the GVD ''Hedret'' having 700 hitpoints altogether. The solution is simple.

			Replace the wrong value with the right one, and test. Give the shield's value, because otherwise the engine will look for the next value to determine the ship's custom hitpoint. It's very likely that it is 0 again. Now that you're at it, make sure that there are no other such inconsistencies. Jump to the Variables section (Search "$Variables") and check each ship one by one. Save, but don't touch FRED yet. Test the mission and see if it works. It may not work still, but keep trying.

			In case of emergency or desperation, give up using Special Hits. Start by canceling all the Special Hits in FRED, save, and open the mission in WordPad. Delete all the outdated variables that used to belong to the old Special Hits values (if they are still there). Set all the values again and test.

	==Repairing broken missions==		==Repairing broken missions==