Briefing

File location	f\briefing
Enabled by default?	yes
Enable/Disable in	init.sqf
Runs on	Client

The Briefing component automatically generates a text briefing appropriate to the player's faction.

Usage

Briefing template files are provided for each faction included in the F3 Platoons template. They are located in f/briefing and named according to their faction. Factions refer to the base faction of the unit; overriding the unit's faction using assignGear or using a different faction in their variable name makes no difference.

Since briefings are automatically enabled, all the missionmaker has to do is fill in the template.

Although it is possible to disable the Briefing component in init.sqf, this is not recommended and may result in a mission not being accepted for FA use.

Formatting

Some formatting tags can be used in the briefing text. The line break <br/> is an important one. You can also use

<marker name = 'mkr_variable_name'>text here</marker>

to create a marker link, which will move the map view to the appropriate marker when clicked. It's also possible to embed images, either included in your mission folder or from the vanilla Arma 3 assets, using

<img image = 'picture_filename.jpg'>

Mission tab

This briefing tab should concisely summarise the overall mission objective. It should be one or two lines, and it's a good idea to include marker links here when referring to objectives.

Situation tab

This tab is for giving a longer description of the mission's setting and background. People still have to read it, so don't make it too long - three or four short paragraphs is fine.

Execution tab

This tab should give more details on the specifics of how the mission should be accomplished. This includes information such as enemy strongpoints to avoid, exactly how many cars we have to steal, and so on. It includes the Movement Plan and Fire Support subheadings, which should describe our initial transport and any specific route we should take, and available fire support assets, respectively.

Administration tab

This tab is for miscellaneous information and technical warnings the commander should be aware of. If you need to describe a mission mechanic in detail, this is a good place for it.

Admin briefing

The f_briefing_admin.sqf file creates an extra tab which can only be seen by the logged-in host. This includes a section for tips you'd like the host to be aware of, as well as controls for the host to activate endings and Safe Start. Anything you put in the Missionmaker Tips section should probably be duplicated on the mission's FAMDB entry, as hosts don't always read this section.

Loadout, ORBAT notes, and Mission Conditions

The Briefing component also includes modules which automatically generate briefing tabs showing the player's initial loadout, the starting weather and environmental conditions, and the initial Order of Battle (ORBAT) for their side. These components function automatically and shouldn't really be touched.

Custom tabs

You can add additional briefing tabs to your mission, in the faction briefing files.

The start of a tab is marked by the following code:

_yourtabvariable = player createDiaryRecord ["diary", ["Your tab title","

and ended by this code:

"]];

Simply insert this code wherever you'd like it to appear in the order. Add it after "Situation" to appear at the top, or before "Administration" to appear at the bottom. Then, fill in the final set of quote marks with your tab contents. Remember to start with a line break.

Tips

When writing a briefing, remember that the briefing is not the plan - it's the information you'd like the commander to have, in order for them to make a plan. Read existing mission briefings for inspiration, and think about what you'd want to know as a commander. Make sure the briefing is written clearly and with readable formatting, so it can be easily understood.

When creating an Adversarial mission, or a mission that has multiple sides for any other reason, remember that a briefing should be created for every playable faction. (The F3 Template civilian reporter slots don't count - they don't need a briefing.)

It's good practice to create a briefing for Zeus in any mission intended to be played with a Zeus. Zeus can't see the players' briefing, so it's a good idea to tell them what the mission is, what the players are being told to do, and how you'd like them to handle the mission.