Arma 3: Multiplayer Campaign Creation - Revision history

Hypoxic125: Changed picture to vanilla APEX example instead of after my own mod

2024-08-20T22:52:27Z

Changed picture to vanilla APEX example instead of after my own mod

← Older revision		Revision as of 00:52, 21 August 2024
Line 253:		Line 253:
	== MPCampaign Display ==		== MPCampaign Display ==

	[[File:arma3 ~~mpcampaigndisplay~~-example-filled.png\|frame\|right~~\|A filled out MPCampaignDisplay~~]]		[[File:arma3-mpcampaigndisplayapex-example-filled.png\|frame\|right]]

	'''Defining Values'''		'''Defining Values'''

Lou Montana: Fix picture

2023-06-10T14:12:11Z

Fix picture

← Older revision		Revision as of 16:12, 10 June 2023
Line 253:		Line 253:
	== MPCampaign Display ==		== MPCampaign Display ==

	[[File:mpcampaigndisplay example filled.png\|frame\|right\|A filled out MPCampaignDisplay]]		[[File:arma3 mpcampaigndisplay-example-filled.png\|frame\|right\|A filled out MPCampaignDisplay]]

	'''Defining Values'''		'''Defining Values'''

Lou Montana: Some wiki formatting

2023-06-10T14:01:49Z

Some wiki formatting

Show changes

Hypoxic125 at 22:32, 9 June 2023

2023-06-09T22:32:53Z

← Older revision		Revision as of 00:32, 10 June 2023
Line 21:		Line 21:

	The following settings need to be present in each mission's description.ext file		The following settings need to be present in each mission's description.ext file
	~~saving = 0;~~
	skipLobby = 1;		skipLobby = 1;

	These are important for the mission to flow from each mission in a multiplayer setting~~. Saving will change the campaign menu from a '''MPCampaignDisplay''', to instantly loading a single player version of the mission~~.		These are important for the mission to flow from each mission in a multiplayer setting.

	Avoid lobbies so that the missions can flow from one to the next without hangups. If <code>skipLobby</code> is disabled, mission01 is finished, the game will bring up mission01's lobby again and will only move to mission02's lobby upon hitting the ESC key.		Avoid lobbies so that the missions can flow from one to the next without hangups. If <code>skipLobby</code> is disabled, mission01 is finished, the game will bring up mission01's lobby again and will only move to mission02's lobby upon hitting the ESC key.

Hypoxic125: additional edits to creating missions section

2023-06-09T22:23:12Z

additional edits to creating missions section

← Older revision		Revision as of 00:23, 10 June 2023
Line 9:		Line 9:
	*Utilizes {{Link\|createMPCampaignDisplay\|MPCampaignDisplay}}		*Utilizes {{Link\|createMPCampaignDisplay\|MPCampaignDisplay}}
	*Missions can be selected in the hosted server mission selection menu		*Missions can be selected in the hosted server mission selection menu

			This article will cover setting up a multiplayer campaign back end similar to how the APEX campaign functions.

	== Creating the Missions ==		== Creating the Missions ==
Line 22:		Line 24:
	skipLobby = 1;		skipLobby = 1;

	These are important for the mission to flow from each mission in a multiplayer setting. Saving will change the campaign menu from a '''MPCampaignDisplay''', to instantly loading a single player version of the mission. Avoid lobbies so that the missions can flow from one to the next without hangups. If <code>skipLobby</code> is disabled, mission01 is finished, the game will bring up mission01's lobby again and will only move to mission02's lobby upon hitting the ESC key.		These are important for the mission to flow from each mission in a multiplayer setting. Saving will change the campaign menu from a '''MPCampaignDisplay''', to instantly loading a single player version of the mission.

			Avoid lobbies so that the missions can flow from one to the next without hangups. If <code>skipLobby</code> is disabled, mission01 is finished, the game will bring up mission01's lobby again and will only move to mission02's lobby upon hitting the ESC key.

			This means that missions should be structured with {{Link\|Description.ext#CfgRespawnInventory\|CfgRespawnInventory}} rather than using editor unit loadouts.

	== File Structure ==		== File Structure ==

Hypoxic125: updated with other important notes about mission descriptions

2023-06-09T22:18:49Z

updated with other important notes about mission descriptions

← Older revision		Revision as of 00:18, 10 June 2023
Line 16:		Line 16:
	Be sure you structure your missions with multiplayer {{Link\|Multiplayer_Scripting#Locality\|locality}} in mind from the start. It is much more time-consuming to convert a single-player mission into a multiplayer mission.		Be sure you structure your missions with multiplayer {{Link\|Multiplayer_Scripting#Locality\|locality}} in mind from the start. It is much more time-consuming to convert a single-player mission into a multiplayer mission.

			'''Mission Description.ext'''

	~~{{Feature\|important\|It is important that you disable saving~~ in ~~your~~ mission description.ext file. Saving will change the campaign menu, ~~not allowing~~ the ~~opening of MPCampaignDisplay~~. It will ~~instead become a single-player~~ only ~~menu~~.}}		The following settings need to be present in each mission's description.ext file
			saving = 0;
			skipLobby = 1;

			These are important for the mission to flow from each mission in a multiplayer setting. Saving will change the campaign menu from a '''MPCampaignDisplay''', to instantly loading a single player version of the mission. Avoid lobbies so that the missions can flow from one to the next without hangups. If <code>skipLobby</code> is disabled, mission01 is finished, the game will bring up mission01's lobby again and will only move to mission02's lobby upon hitting the ESC key.

	== File Structure ==		== File Structure ==
Line 77:		Line 82:
	{		{
	lives = -1; // Not important with/without "Tickets" respawn template.		lives = -1; // Not important with/without "Tickets" respawn template.
	~~noAward = 1;~~
	cutscene = "";		cutscene = "";

			lost = "";
			end1 = "";
			end2 = "";
			end3 = "";
			end4 = "";
			end5 = "";
			end6 = "";
	};		};

Line 106:		Line 118:
	class myMission01 : MissionDefault // Mission class - Inherits default settings from class MissionDefault above.		class myMission01 : MissionDefault // Mission class - Inherits default settings from class MissionDefault above.
	{		{
	~~end1~~ = "myMission02"; // Default ~~Ending~~ - "end1~~" call BIS_fnc_endMission will use this mission as next mission.~~		// Custom Endings - Defined in mission's CfgDebriefing
	~~myCustomEnd~~ = "~~myMission01~~"; // ~~Custom Ending~~ - ~~Defined in mission's class CfgDebriefing - Can be whatever you want.~~		myCustomEnd = "myMission02";
	~~lost~~ = "~~myMission01~~"; // ~~You~~ can ~~send the lobby back to current mission on loss using this. Can also be custom.~~
			// Default Endings - end1-6 inherited from MissionDefault class
			endDefault = "myMission02"; // defaults to when no other ending is defined - to prevent game crashing
			end1 = "myMission02"; // can override inherits from MissionDefault
			lost = "myMission01";

	template = "myMission01.worldName";		template = "myMission01.worldName";
	};		};
Line 114:		Line 131:
	class MyMission02 : MissionDefault		class MyMission02 : MissionDefault
	{		{
	~~end1~~ = "~~MyMission03~~";		endDefault = "myMission03";
	lost = "MyMission02";		lost = "MyMission02";
	template = "MyMission02.worldName";		template = "MyMission02.worldName";
Line 121:		Line 138:
	class MyMission03 : MissionDefault		class MyMission03 : MissionDefault
	{		{
	~~end1~~ = "";		endDefault = "";
	lost = "MyMission03";		lost = "MyMission03";
	template = "MyMission03.worldName";		template = "MyMission03.worldName";

Hypoxic125 at 21:16, 9 June 2023

2023-06-09T21:16:14Z

← Older revision		Revision as of 23:16, 9 June 2023
Line 192:		Line 192:
	{		{
	briefingName = "$STR_M01_MISSION_TITLE";		briefingName = "$STR_M01_MISSION_TITLE";
	directory = "\myModName\myCampaignAddon\campaign\missions\myMission01.worldName";		directory = "myModName\myCampaignAddon\campaign\missions\myMission01.worldName";
	};		};

Line 198:		Line 198:
	{		{
	briefingName = "$STR_M02_MISSION_TITLE";		briefingName = "$STR_M02_MISSION_TITLE";
	directory = "\myModName\myCampaignAddon\campaign\missions\myMission02.worldName";		directory = "myModName\myCampaignAddon\campaign\missions\myMission02.worldName";
	};		};

Line 204:		Line 204:
	{		{
	briefingName = "$STR_M03_MISSION_TITLE";		briefingName = "$STR_M03_MISSION_TITLE";
	directory = "\myModName\myCampaignAddon\campaign\missions\myMission03.worldName";		directory = "myModName\myCampaignAddon\campaign\missions\myMission03.worldName";
	};		};
	};		};
Line 210:		Line 210:
	};		};
	</syntaxhighlight>		</syntaxhighlight>
			{{Feature\|informative\|Directory must not contain a leading <code>\</code>}}

	== The MPCampaign Display ==		== The MPCampaign Display ==

Hypoxic125: corrected CfgMissions.Campaigns.MyCampaign.directory file path

2023-06-09T21:13:51Z

corrected CfgMissions.Campaigns.MyCampaign.directory file path

← Older revision		Revision as of 23:13, 9 June 2023
Line 180:		Line 180:
	class MyCampaign		class MyCampaign
	{		{
	directory = "\myModName\myCampaignAddon\campaign";		directory = "myModName\myCampaignAddon\campaign";
	};		};
	};		};

Hypoxic125: Initial page creation

2023-06-09T18:35:29Z

Initial page creation

New page

{{GVI|arma3|2.10}}
== Creating A Multiplayer Campaign ==

A multiplayer campaign is a series of interconnected missions that follow a sequential order, creating a storyline that groups of players can enjoy together.

Key things that a multiplayer campaign will include:
*Interconnected sequential missions
*Centralized location of common mission files to save on storage space
*Utilizes {{Link|createMPCampaignDisplay|MPCampaignDisplay}}
*Missions can be selected in the hosted server mission selection menu

== Creating the Missions ==

If new to creating missions, it is advised that you ignore concerns about disk space and make each mission independent of the campaign mod. When you get more comfortable with how the file structure works, and have more confidence in your code, you can then move on to centralizing common files. Debugging missions within the mod structure is much more annoying, especially if your code is more prone to bugs/errors.

Be sure you structure your missions with multiplayer {{Link|Multiplayer_Scripting#Locality|locality}} in mind from the start. It is much more time-consuming to convert a single-player mission into a multiplayer mission.

{{Feature|important|It is important that you disable saving in your mission description.ext file. Saving will change the campaign menu, not allowing the opening of MPCampaignDisplay. It will instead become a single-player only menu.}}

== File Structure ==

Now that you have your missions created, we can move on to the mod's file structure.

'''myModName'''
|--addons
|--myCampaignAddon
|--campaign
| |--missions
| | |--myMission01.worldName
| | |--myMission02.worldName
| | |--myMission03.worldName
| |--description.ext
|--data
|--functions
|--$PBOPREFIX$
|--config.cpp

Red highlights indicate required files/folders

Green highlights indicate optional organization files/folders for shared campaign files

== PBO Prefix ==
$PBOPREFIX$ is a file that sits in the root folder of an addon. If your mod contains multiple addons, you will need multiple $PBOPREFIX$ files. $PBOPREFIX$ is a namespace definition that tells the game the file path to navigate to your addon.

Examples of possible $PBOPREFIX$:
myModName\myCampaignAddon <--- Used for this guide
z\myModName\myCampaignAddon

Please refer to the documentation on the addon packer of your choice.

[https://github.com/BrettMayson/HEMTT HEMTT] (Recommended): For repository-based mods

[https://github.com/winseros/pboman3 PBOMan3]

{{Link|Addon_Builder|Arma 3 - Addon Builder}}

== Campaign Description.ext ==

Location: "\myModName\addons\myCampaignAddon\campaign\description.ext"

The campaign description file will dictate how the missions are structured within the campaign menus. Unlike a single-player campaign, we are going to be ignoring the mission flow aspect of the campaign description file so that the multiplayer campaign menu functions correctly.

<syntaxhighlight lang="cpp">
/* --------------------------------------------------
Defining Templates for Inheriting Later
-------------------------------------------------- */

// Setting up no endings, cutscenes, or rewards (stuff for single-player campaigns).

class NoEndings // For use in chapter class and class MissionDefault.
{
endDefault = "";
};

class MissionDefault : NoEndings // For use in individual mission classes.
{
lives = -1; // Not important with/without "Tickets" respawn template.
noAward = 1;
cutscene = "";
};

/* --------------------------------------------------
Actual Campaign Class
-------------------------------------------------- */

class Campaign // Contained inside CfgMissions - Holds other campaign classes such as "Apex", "Bootcamp", "EastWind".
{
firstBattle = "Missions"; // This will point to class Missions below which contains no information on purpose
// so that the mp campaign menu will load all missions.
// If info is given, no MPCampaignDisplay will be created.
name = "$STR_CAMPAIGN_TITLE";
briefingName = "$STR_CAMPAIGN_TITLE";
author = "Hypoxic";
overviewPicture = "\myModName\myCampaignAddon\data\img\myCampaignOverviewPicture.jpg";
overviewText = "$STR_CAMPAIGN_DESCRIPTION";
disableMP = 0; // Set to 0

class MyCampaign : NoEndings // Chapter class - Typically only use one chapter when dealing with MP Campaigns.
{
firstMission = "myMission01";
name = "$STR_CAMPAIGN_TITLE";
cutscene = "";
end1 = "";

class myMission01 : MissionDefault // Mission class - Inherits default settings from class MissionDefault above.
{
end1 = "myMission02"; // Default Ending - "end1" call BIS_fnc_endMission will use this mission as next mission.
myCustomEnd = "myMission01"; // Custom Ending - Defined in mission's class CfgDebriefing - Can be whatever you want.
lost = "myMission01"; // You can send the lobby back to current mission on loss using this. Can also be custom.
template = "myMission01.worldName";
};

class MyMission02 : MissionDefault
{
end1 = "MyMission03";
lost = "MyMission02";
template = "MyMission02.worldName";
};

class MyMission03 : MissionDefault
{
end1 = "";
lost = "MyMission03";
template = "MyMission03.worldName";
};
};

class Missions // This is essentially a class with empty values. Used to invoke MPCampaignDisplay - See firstBattle above.
{
name = "$STR_CAMPAIGN_TITLE";
cutscene = "";
firstMission = "";
end1 = "";
end2 = "";
end3 = "";
end4 = "";
end5 = "";
end6 = "";
lost = "";
};
};
</syntaxhighlight>

{{Feature|warning|An error in Description.ext WILL crash your game!}}

== Config.cpp ==

Config.cpp will contain all of the top-level classes we want our mod to modify in-game. In our campaign's case, this will mainly be CfgPatches and CfgMissions

'''CfgPatches'''
<syntaxhighlight lang="cpp">
class CfgPatches
{
class MyCampaign
{
name = "MyCampaign - A Campaign That Campaigns";
author = "Hypoxic";
url = "https://arepublixchickentendersubsonsale.com/";

requiredVersion = 2.10;
requiredAddons[] = { // Insert addons that your mod/campaign requires
"A3_Functions_F"
};
units[] = {};
weapons[] = {};
};
};
</syntaxhighlight>
If your campaign addon contains units/weapons/etc, add them to units[] and weapons[], just like you would with a normal mod.

'''CfgMissions'''
<syntaxhighlight lang="cpp">
class CfgMissions
{
class Campaigns
{
class MyCampaign
{
directory = "\myModName\myCampaignAddon\campaign";
};
};
class MPMissions
{
class MyCampaign // Campaign class from above
{
briefingName = "$STR_CAMPAIGN_TITLE";

class MyMission01
{
briefingName = "$STR_M01_MISSION_TITLE";
directory = "\myModName\myCampaignAddon\campaign\missions\myMission01.worldName";
};

class MyMission02
{
briefingName = "$STR_M02_MISSION_TITLE";
directory = "\myModName\myCampaignAddon\campaign\missions\myMission02.worldName";
};

class MyMission03
{
briefingName = "$STR_M03_MISSION_TITLE";
directory = "\myModName\myCampaignAddon\campaign\missions\myMission03.worldName";
};
};
};
};
</syntaxhighlight>

== The MPCampaign Display ==

[[File:mpcampaigndisplay example filled.png|frame|right|A filled out MPCampaignDisplay]]

'''Defining Values'''

# '''Campaign Name''' - Defined In Either:
## CfgMissions.MPMissions.MyCampaign.briefingName
## Campaign description.ext: Campaign.briefingName
# '''Mission Name''' - Defined In Either:
## CfgMissions.MPMissions.MyMission01.briefingName
## Mission description.ext: briefingName
# '''See #2'''
# '''Author''' - Defined In:
## Campaign description.ext: Campaign.author
# '''Mission Overview Picture''' - Defined In:
## Mission description.ext: overviewPicture
# '''Mission Overview Text''' - Defined In:
## Mission description.ext: overviewText

{{Feature|important|Important: Although child classes will precede their parents, its best to be consistent with your naming}}

[[Category:Arma_3:_Editing]]