CO Briefing Template

From F2 EN
Jump to: navigation, search

Description

A major configuration task is to create the briefing for the mission. In ArmA2: Combined Operations the briefing is created using a combination of a script and an HTML file. F2 contains a set of template files that supports both coop and multi-side briefings.

Note: For additional guidance on using this component, see the Writing Briefings page.

Required files

All the code associated with this component is found in:

  • briefing.html
  • briefing.sqf
  • init.sqf
  • f\common\f_briefing_baf.sqf
  • f\common\f_briefing_cdf.sqf
  • f\common\f_briefing_civ_special.sqf
  • f\common\f_briefing_cz.sqf
  • f\common\f_briefing_ger.sqf
  • f\common\f_briefing_gue.sqf
  • f\common\f_briefing_ins.sqf
  • f\common\f_briefing_ru.sqf
  • f\common\f_briefing_tk.sqf
  • f\common\f_briefing_tk_civ.sqf
  • f\common\f_briefing_tk_gue.sqf
  • f\common\f_briefing_tk_ins.sqf
  • f\common\f_briefing_un.sqf
  • f\common\f_briefing_us.sqf
  • f\common\f_briefing_usmc.sqf

How to use

How the briefing is generated

The script briefing.sqf is executed at the start of the mission, on the server and every client machine (it is triggered by a line in the file init.sqf). In the F2 template the briefing.sqf file peforms a check to see what faction the player's slot belongs to, then calls the appropriate include file, which in turn generates the following sections of the briefing:

  • Notes
  • Tasks

Finally, the file briefing.html contains the debriefing texts which may be displayed at the end of the mission.

Default include files

By default the following include files are used for each faction:

FactionInclude File
British Armed Forcesf\common\f_briefing_baf.sqf
CDFf\common\f_briefing_cdf.sqf
ChDKZf\common\f_briefing_ins.sqf
Civilian (Takistani)f\common\f_briefing_tk_civ.sqf
Civilian (Special)f\common\f_briefing_civ_special.sqf
Czech Republicf\common\f_briefing_cz.sqf
Germanf\common\f_briefing_ger.sqf
NAPAf\common\f_briefing_gue.sqf
Russiaf\common\f_briefing_ru.sqf
Takistani Armyf\common\f_briefing_tk.sqf
Takistani Militiaf\common\f_briefing_tk_ins.sqf
Takistani Locals (Independent)f\common\f_briefing_tk_gue.sqf
UNf\common\f_briefing_un.sqf
US Armyf\common\f_briefing_us.sqf
US Marine Corpsf\common\f_briefing_usmc.sqf


This means every faction gets its own separate briefing for Notes and Tasks (although debriefings held in the file briefing.html are common to all factions).

How the Tasks section is generated

In the include file look for the code segment entitled:

// TASKS

The following commands used to create and control tasks (each is linked to the Bohemia Interactive Wiki):

By default the include files in F2 do not generate any tasks, but one commented-out example is included.

How the Notes section is generated

The Notes section is sub-divided into a number of sub-sections, each of which may include 2 or more text sub-headings:

Sub-sectionSub-headingsNotes
SITUATIONENEMY FORCESSize, activity, location, uniform, time seen and equipment
FRIENDLY FORCESHigher units (including mission and intent), adjacent units, supporting units and security
MISSIONWhat must be accomplised by the mission team, not how
EXECUTIONCOMMANDER'S INTENTA short summary of plan
MOVEMENT PLANMovement instructions
FIRE SUPPORT PLANFire support instructions
SPECIAL TASKSInstructions for specific units
ADMINISTRATIONInformation on administration and logistics
CREDITSMission credits
ORBATSee ORBAT Notes

Throughout the include file the sections which you should edit have been labelled:

*** Insert [specific information] here. ***

Replace the text starting and ending with *** using your own content (delete the *** as well).

Giving some or all factions the same briefing

If you want to give two or more factions the same briefing, simply enter your data into one of the include files (e.g. f_briefing_usmc.sqf). Then open the file briefing.sqf and, for each faction, change the line which calls the include file.

For example, if you wanted players in UN slots to see the same briefing as those in US slots, you would open the file briefing.sqf and look for the code segment entitled:

// BRIEFING: UN 

In the same code segment find the line below:

#include "f\common\f_briefing_un.sqf"

Change the line to read:

#include "f\common\f_briefing_us.sqf"

Editing debriefings

Open the file briefing.html. Throughout the file the sections which you should edit have been labelled:

*** Insert [specific information] here. ***

Replace the text starting and ending with *** using your own content (delete the *** as well).

Tips

Adding links to map markers

The following code will create a link that, when clicked, will automatically centre the map over the marker named mkrName (be sure to name the marker in the ArmA2 editor):

<marker name = 'mkrName'>Text</marker>

Formatting tips

The format of the briefing.html file is similar to HTML, although it is not exactly the same. Only a few HTML tags will work. For example, the following code will give a carriage return (new line):

<br>

The following code will give a blank line between paragraphs:

<br><br>

How to disable

Open the file init.sqf and look for the code segment entitled:

// F2 - CO Briefing

Edit the line below, adding // to the start:

[] execVM "briefing.sqf";

Credits

  • kevb0
  • Fer
  • Wolfenswan