Mission Creation for MSFS - Revision history

BASys: Replaced Applicable-FSVersion for MSFS with MSFS2020, added MSFS2024

2024-05-25T17:28:02Z

Replaced Applicable-FSVersion for MSFS with MSFS2020, added MSFS2024

← Older revision		Revision as of 12:28, 25 May 2024
Line 4:		Line 4:

	{{Infobox-Applicable-FSVersion		{{Infobox-Applicable-FSVersion
	\| ~~MSFS~~ = true		\| MSFS2024 = unknown
			\| MSFS2020 = true
	\| FSXI = false		\| FSXI = false
	\| P3D5 = false		\| P3D5 = false

Mr LiamT: Updated for the newest version of the simulator and the SimpleMission sample project. Improved structure and writing style.

2023-05-21T10:41:18Z

Updated for the newest version of the simulator and the SimpleMission sample project. Improved structure and writing style.

Show changes

Mr LiamT: Added/expanded chapter on mission coding

2022-03-03T11:43:03Z

Added/expanded chapter on mission coding

Show changes

Mr LiamT: Added references to the SimpleMission sample project. Expanded explanation for mission coding and compiling.

2021-11-24T21:27:55Z

Added references to the SimpleMission sample project. Expanded explanation for mission coding and compiling.

← Older revision		Revision as of 16:27, 24 November 2021
Line 67:		Line 67:

	=== Create a mission project ===		=== Create a mission project ===
	You ~~have~~ to create a mission project with the MSFS devmode. You can enable the devmode in <code>General Settings>Developers</code>.		==== Using the SimpleMission sample project ====
			You can als use the SimpleMission sample project. [https://flightsim.to/file/23934/mission-creation-resources Download it] and complete [[SimpleMission_(MSFS)#Step_1:_Download_the_SimpleMission_project\|step 1 and 2 of the guide]].

			==== Manual ====
			You can create a mission project with the MSFS devmode. You can enable the devmode in <code>General Settings>Developers</code>.

	To create a new mission project, click <code>[DevMode] > New project > Select location and name > select custom > Add a display title, package name, and select content type MISSION > Set the asset type to Mission and name it MissionName-Mission > create</code>.		To create a new mission project, click <code>[DevMode] > New project > Select location and name > select custom > Add a display title, package name, and select content type MISSION > Set the asset type to Mission and name it MissionName-Mission > create</code>.
Line 80:		Line 84:
	Load the flightplan and select the desired starting location in the worldmap. Now choose the aircraft, livery, fuel, payload, and atc options. Then choose the time, weather preset, and the multiplayer and traffic settings. Load the flight. Set up the aircraft how you want it (lights, switches, autopilot, etc.). You can customize the weather and save it as a preset. Lastly, locate the plane exactly where you want it, with the correct speed and trim settings. Then click <code>ESC</code> to pause the game and then <code>SPACE</code> to save the flight as a <code>.FLT</code>. Move the flight file and flightplan to the mission project.		Load the flightplan and select the desired starting location in the worldmap. Now choose the aircraft, livery, fuel, payload, and atc options. Then choose the time, weather preset, and the multiplayer and traffic settings. Load the flight. Set up the aircraft how you want it (lights, switches, autopilot, etc.). You can customize the weather and save it as a preset. Lastly, locate the plane exactly where you want it, with the correct speed and trim settings. Then click <code>ESC</code> to pause the game and then <code>SPACE</code> to save the flight as a <code>.FLT</code>. Move the flight file and flightplan to the mission project.

	You will need to [[Flight_file_(MSFS)#Creating_your_flight_file\|manually edit the .FLT]] to choose the assistance preset, mission category, traffic, briefing and loading screen.		You will need to [[Flight_file_(MSFS)#Creating_your_flight_file\|manually edit the .FLT]] to choose the assistance preset, mission category, traffic, briefing and loading screen. You can use the .FLT in the [https://flightsim.to/file/23934/mission-creation-resources SimpleMission project] as a reference.

	===== Add pictures =====		===== Add pictures =====
	Lastly, you will have to add pictures for the mission thumbnail, and the loading, briefing, and ending screens. The names for the loading an briefing pictures are defined in the [[Flight_file_(MSFS)#Creating_your_flight_file\|.FLT file]]. The thumbnail will need to be named: <code>Activity_Widget.jpg</code> and the endscreen picture will need to be named: <code>rewardscreen.jpg</code>.		Lastly, you will have to add pictures for the mission thumbnail, and the loading, briefing, and ending screens. The names for the loading an briefing pictures are defined in the [[Flight_file_(MSFS)#Creating_your_flight_file\|.FLT file]]. The thumbnail will need to be named: <code>Activity_Widget.jpg</code> and the endscreen picture will need to be named: <code>rewardscreen.jpg</code>. You can use the pictures in the [https://flightsim.to/file/23934/mission-creation-resources SimpleMission project] as a reference.

	==== [[Weather definitions (MSFS)\|Define custom weather]] ====		==== [[Weather definitions (MSFS)\|Define custom weather]] ====
	You can customize the weather with the weather panel during flight. Save it as a new preset. You can find the .WPR file in <code>\AppData\Roaming\Microsoft Flight Simulator\Weather\Presets\</code>. Move it next to the .flt file and rename it to <code>Weather.WPR</code>. You can fine-tune the weather by editing the .WPR file in Notepad++.		You can customize the weather with the weather panel during flight. Save it as a new preset. You can find the .WPR file in <code>\AppData\Roaming\Microsoft Flight Simulator\Weather\Presets\</code>. Move it next to the .flt file and rename it to <code>Weather.WPR</code>. You can fine-tune the weather by editing the .WPR file in Notepad++. You can use the .WPR in the [https://flightsim.to/file/23934/mission-creation-resources SimpleMission project] as a reference.


	=== Set up a [[:Category:MSFS Mission Script\|mission script]] ===		=== Set up a [[:Category:MSFS Mission Script\|mission script]] ===
			==== Using the SimpleMission sample project ====
			The SimpleMission sample project contains an .xml you can use as a starting point. [https://flightsim.to/file/23934/mission-creation-resources Download it] and complete [[SimpleMission_(MSFS)#Step_3:_Open_the_project_folder\|step 3 of the guide]].

			==== Manual ====
	The [[:Category:MSFS Mission Script\|mission script]] defines everything that happens after spawn.		The [[:Category:MSFS Mission Script\|mission script]] defines everything that happens after spawn.

	There are some basic parts to each mission that you will have to define first.		There are some basic parts to each mission that you will have to define first.

	==== [[MSFS_Mission_Script_-_Mission_objects#Defining_the_mission_type\|Mission type]] ====		===== [[MSFS_Mission_Script_-_Mission_objects#Defining_the_mission_type\|Mission type]] =====
	There are [[MSFS_Mission_Script_-_Mission_objects#List_of_Mission_Types\|different mission types]] to choose from. You need to add one of them to your script, to enable the mission ending. The mission will end when all active objectives have been completed. Each objective in the mission is connected with a corresponding goal, the state of which can be <code>Pending, Completed, Failed,</code> and <code>Aborted</code>. If all active objectives are marked as completed, the mission will end in success.		There are [[MSFS_Mission_Script_-_Mission_objects#List_of_Mission_Types\|different mission types]] to choose from. You need to add one of them to your script, to enable the mission ending. The mission will end when all active objectives have been completed. Each objective in the mission is connected with a corresponding goal, the state of which can be <code>Pending, Completed, Failed,</code> and <code>Aborted</code>. If all active objectives are marked as completed, the mission will end in success.

	==== [[MSFS_Mission_Script_-_Flow_states\|Flowstates]] ====		===== [[MSFS_Mission_Script_-_Flow_states\|Flowstates]] =====
	MSFS introduced [[MSFS_Mission_Script_-_Flow_states#Flow_states\|flowstates]], which determine the flight state, and [[MSFS_Mission_Script_-_Flow_states#Flow_events\|flowevents]], which control sim-level actions (e.g., pausing the sim, show startup info, disabling the ATC panel).		MSFS introduced [[MSFS_Mission_Script_-_Flow_states#Flow_states\|flowstates]], which determine the flight state, and [[MSFS_Mission_Script_-_Flow_states#Flow_events\|flowevents]], which control sim-level actions (e.g., pausing the sim, show startup info, disabling the ATC panel).

Line 118:		Line 126:
	You can use calculators for more advanced logic in your mission. It can take in multiple variables and trigger different actions based on a logic. You can also use this to calculate a mission score and probably many more applications which you can explore.		You can use calculators for more advanced logic in your mission. It can take in multiple variables and trigger different actions based on a logic. You can also use this to calculate a mission score and probably many more applications which you can explore.

	~~===== For a complete overview, see [[:Category:MSFS_Mission_Script#Building_blocks\|MSFS Script]] =====~~

			<u>'''For a complete overview of elements, see [[:Category:MSFS_Mission_Script#Building_blocks\|MSFS Script]]'''</u>

			==== Testing and editing mission ====
			To test the mission, build the project and copy the contents of the <code>ProjectFolder\Packages\</code> folder to the <code>Community</code> folder.

			Keep DevMode enabled and make sure <code>Options > World Objects</code> is enabled, to see the areas.

			You can start the mission by going to the home screen, then select <code>Activities > Custom Content > Your mission</code>.

			With the script editor open you can see if the objects are loaded in the mission. If the names are white, they are loaded, but if they are red it means they are not loaded. While working on your mission, you can update the objects by clicking <code>Script Editor > Game > Update</code>.

			With the Developer Camera enabled you can double click on the objects in the script editor and the camera will go to their location.

			Go to <code>Script Editor > View > Gizmo</code> to get a gizmo with which you can move objects that have a [[World_position_(MSFS)\|world position]].

			==== Debugging mission ====
			The MSFS script editor isn't good at debugging your mission, so you will have to test the mission and try to create it in a standardized way.

			It is good practice to have all triggers except the first disabled, so they can't be triggered before they're supposed to. You should use [[Object Activation Action\|ObjectActivationActions]] to enable triggers at the appropriate time. You can use the script editor to look for breaks in your mission logic. All objects that aren't referenced by another object are marked with a white dot:

			[[File:Script_editor_example.png\|300px]]

	~~=== Compiling~~ the ~~mission ===~~		For actions this means they will never execute. For triggers this means they will either be active from the beginning or they will always be disabled.

			==== Compiling the mission ====
			To compile the mission for export, click <code>Clean All</code>, then <code>Build All</code>, Make sure there are no errors in the console from the building process. Then click <code>Build & Export</code>, ensure the mission package is checkmarked, choose <code>Community Publishing</code>, and select the Export Directory.


	{{Template:Navbox-Mission-Creation-MSFS}}		{{Template:Navbox-Mission-Creation-MSFS}}

Mr LiamT: Describe the process

2021-11-22T13:54:01Z

Describe the process

@@ Line 36: / Line 36: @@
 == Process ==
 === Decide on flight conditions ===
+Next, you will have to configure the flight conditions. To start, you can create a [[flightplan (MSFS)|flight plan]] in the worldmap or with [[Little Navmap]]. This flight plan will be shown to the player when the mission starts, so it shouldn't spoil the unexpected parts of the flight (e.g., an emergency).
-=== Turn your story into a mission ===
+=== Set up a [[:Category:MSFS Mission Script|mission script]] ===
+The [[:Category:MSFS Mission Script|mission script]] defines everything that happens after spawn.
 === Coding your mission ===
+Now you will turn your mission diagram from step 3 into a mission script. For this you can use the Devmode and the script editor.
 {{Template:Navbox-Mission-Creation-MSFS}}

Mr LiamT: Created page explaining the mission creation process for msfs

2021-11-14T23:12:26Z

Created page explaining the mission creation process for msfs

New page

[[Category:Missions]]

{{:Ambox-Content-WIP}}

{{Infobox-Applicable-FSVersion
| MSFS = true
| FSXI = false
| P3D5 = false
| P3D4 = false
| P3D3 = false
| P3D2 = false
| P3D = false
| FSW = false
| FSXSE = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| XP11 = false
| XP10 = false
| XP9 = false
}}

== Overview ==
Creating a mission is a complex task involving a diverse use of tools & skills. Getting your first mission going is likely to cause you some headaches.

Still here? Good. Once you ''do'' have that first one running, the sky's your limit. That basic set of rules and files that make up a mission are always the same so once you've got those sorted, it's just a case of coming up with an idea and writing it.

At it's simplest, a mission is just a scripted set of events that tell some kind of story. It may be dramatic - mountain rescue, failing aircraft, poor weather. It could just as easily be a simple flight from A to B with you pointing out areas of interest along the way, or a completely abstract challenge like finding out how many times you can touch-and-go in a 747 in five minutes.

Technically speaking, there are two main classes of 'things' in a mission; Actions and Triggers. An Action makes something happen, and a Trigger checks to see if something's happened and calls an Action if it has. By stringing together Actions and Triggers, you tell your story.

You'll also need to prepare the conditions of your flight; what will be the plane, time, location, route, and weather of your mission? Are there other planes flying around or parked on the airport? And how much assistance will you give the player?

Lastly, your mission will need sound files for the mission speech and some text and images for the briefing, loading, and ending screens.

== Process ==

=== Come up with a basic storyline ===
a

=== Decide on flight conditions ===
b

=== Turn your story into a mission ===
c

=== Set up a mission script ===
d

=== Coding your mission ===
e

{{Template:Navbox-Mission-Creation-MSFS}}