RDNWiki: DOWScar/Tutorials/Advanced/CampaignFile ...

RDN Wiki Home | Page Index | Recent Changes | Recently Commented | Users | Registration | Login:  Password:  

Campaign File Documentation


Contents

Introduction

The campaign (*.camp) file is used in the game to piece together separate missions into one coherent campaign. The campaign file determines the order that missions are played in, the briefings that are associated with a mission, and so on. This document will provide a quick overview of the campaign file.

File Format


The Campaign file typically contains three variables, and one table: the ModName, Name and MissionVideoFolder variables, and the Missions table.
The Name and ModName variables must be present in your campaign file and describe both the name of the campaign that is displayed in game, as well as the “mod” that the map is designed for.


The Name variable determines the name of the campaign that will appear in the campaign selection screen. For example, if we wanted to call our campaign “My Eldar Campaign”, we’d have the following:


Name = "My Eldar Campaign"

Following this we need to define the ModName variable, which should in almost all instances be set to “w40k”. Note that without this variable, the game will not display your campaign on the campaign selection screen.


ModName = "w40k"

The final variable is the MissionVideoFolder variable, which determines the name of the sub-folder in the /Wh40k/Movies/ folder where our campaign’s briefing movies are retrieved from. Note that this variable needs to be defined, as if it is not your campaign will not appear in the campaign selection screen.


Finally comes the description of the missions. The missions in a campaign are defined in the Missions table. Our single mission can be defined as follows.


Missions =
{

	 {
	 name = "My Mission Name",
	          mission_file = "MyMission",
	          skiptonextmission = 0,
	          mission_audio = "MyMission-Audio",
	          mission_music = "ambient_ingame_01",
	          mission_music_volume = 75,
	          mission_description = "description displayed on top of screen",
	          mission_facts = 
	         {
	             "Paragraph1.",
	             "Paragraph2.",
	         }
	  },
}

Note that the Paragraph1 and Paragraph2 text need to be on a single line and contain no formatting.


The above should be fairly self-explanatory. Our mission is defined by a set of variables that determine what sounds get played, what makes up the mission and so forth. Here’s the actual meaning of each of the variables:


Links


SCAR
Wiki Home

End of Page


Referring pages: DOWScar
DOWScar/Tutorials
DOWScar/Tutorials/Advanced

There are no files on this page. [Display files/form]
There is no comment on this page. [Display comments/form]