Mission Export: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "{{ExternalLink|" to "{{Link|")
 
(29 intermediate revisions by 5 users not shown)
Line 1: Line 1:
Two export methods are available, both with certain pros and cons. However, '''Mission format''' is considered obsolete and lacks any support (e.g. newly introduced features are available only for '''Addon format''').
{{TOC|side}}
Two export methods are available, both with certain pros and cons.
 


== Mission Format ==
== Mission Format ==
Older export variant working since [[Arma: Cold War Assault]]. Mission [[PBO]] contains only mission folder itself and additional options are limited, e.g. you cannot have multiple missions in one fil and in case you need mission specific addon, it has to be created separately.


Multiplayer missions are sent by server to every connected user, occasionally leading to increased bandwidth.
Older export variant working since [[Arma: Cold War Assault]]. Mission [[PBO]] contains only mission folder itself and additional options are limited, e.g. you cannot have multiple missions in one file and in case you need mission specific addon, it has to be created separately.
 
Multiplayer missions are sent by server to every connected user, occasionally leading to increased bandwidth. It's recommended not to use any large files (pictures, sounds, ...) to prevent it.


File itself is always named in following format
File itself is always named in following format
  <span style="color:green"><mission name></span>.<span style="color:green"><world Name></span>.pbo
  {{Color|green|&lt;mission name&gt;}}.{{Color|green|&lt;world name&gt;}}.pbo
Examples:
Examples:
  TopGun.abel.pbo
  TopGun.abel.pbo
Line 14: Line 17:
World name matches the class in ''CfgWorlds''.pbo
World name matches the class in ''CfgWorlds''.pbo


=== Installation ===
Put missions/campaigns in following folders or in folders of the same names in [[Arma: Mod Folders|mod subfolders]].


=== Installation ===
Put missions/campaigns in following folders or in folders of the same names in [[Modfolders|mod subfolders]].
==== Singleplayer Missions ====
==== Singleplayer Missions ====
  <span style="color:green">%ROOT%</span>\Missions
  {{Color|green|%ROOT%}}\Missions
 
==== Multiplayer Missions ====
==== Multiplayer Missions ====
  <span style="color:green">%ROOT%</span>\MPMissions
  {{Color|green|%ROOT%}}\MPMissions
 
==== Campaigns ====
==== Campaigns ====
  <span style="color:green">%ROOT%</span>\Campaigns
  {{Color|green|%ROOT%}}\Campaigns


=== Export ===


=== Export ===
==== Ingame ====
==== Ingame ====
# When in mission editor, click on [[Mission_Editor#Save_As|Save]] button.
# When in mission editor, click on [[Mission_Editor#Save_As|Save]] button.
# Select 'Export to single-missions' or 'Export to multiplayer missions', depending on type of your mission
# Select 'Export to single-missions' or 'Export to multiplayer missions', depending on type of your mission
Mission [[PBO]] was created in Missions or MPMissions folder in the game's root.
Mission [[PBO]] was created in Missions or MPMissions folder in the game's root.
* You can publish the mission directly from Editor in [Arma 3] to {{Link|link= http://steamcommunity.com/workshop/browse?appid=107410|text= Steam Workshop}} . Click on the Steam icon and provide necessary data: name, description, tags and image.


==== External ====
#Pack [[Mission_Editor:_External#Mission_Folder|mission folder]] using [[BinPBO]] or other preferred packing tool.


==== External ====
#Pack [[Mission_Editor:_External#Mission_Folder|mission folder]] using [[BinPBO]] or other preffered packing tool.


{{ArgTitle|2|Addon Format||
{{GVI|arma1|1.00}}
{{GVI|arma2|1.00}}
{{GVI|arma2oa|1.50}}
{{GVI|arma3|0.50}}
{{GVI|tkoh|1.00}}}}


<br style="clear:both;">
[[:Category:ArmA: Armed Assault|{{arma1}}]] introduced mission export based on addon structure, giving designers more control of PBO structure.
== Addon Format ==
Missions or campaigns can be grouped in single PBO (like official missions) or with other supporting addons like new objects or functions.
{{Versions|
[[Image:arma_1.00.gif]]
[[Image:arma2_1.00.gif]]
[[Image:arma2oa_1.51.gif]]
[[Image:TKOH_1.00.gif]]
|-4}}
[[Armed Assault]] introduced mission export based on addon structure, giving designers more control of PBO structure. Missions or campaigns can be grouped in single PBO (like official missions) or with other supporting addons like new objects or functions.


Multiplayer missions has to be installed before the game is run.
Multiplayer missions has to be installed before the game is run. No file size limitations exists.


=== Installation ===
=== Installation ===
Put missions/campaigns in following folder or in folder of the same names in [[Modfolders|mod subfolders]].
<span style="color:green">%ROOT%</span>\Addons


Put missions/campaigns in following folder or in folder of the same names in [[Arma: Mod Folders|mod subfolders]].
{{Color|green|%ROOT%}}\Addons


=== Export ===
=== Export ===
[[File:BinPBO.jpg|thumb|BinPBO]]
[[File:BinPBO.jpg|thumb|BinPBO]]
<ol>
<ol>
<li>Create folder with name of the addon (example: ''MyMission'')</li>
<li>Create folder with name of the addon (example: ''MyMission'')</li>
<li>Copy [[Mission_Editor:_External#Mission_Folder|mission folder]] into the addon folder (example: ''MyMission\MissionFolder.World'')</li>
<li>Copy [[Mission_Editor:_External#Mission_Folder|mission folder]] into the addon folder (example: ''MyMission\MissionFolder.World'')</li>
<li>Create [[Config.cpp]] in addon folder with [[CfgMissions]] class (example: ''MyMission\config.cpp'')
<li>Create [[Config.cpp]] in addon folder with [[CfgPatches]] and [[CfgMissions]] classes (example: ''MyMission\config.cpp'')
<pre>class CfgMissions
<syntaxhighlight lang="cpp">
class CfgPatches
{
class MyAddonClass
{
units[] = {};
weapons[] = {};
requiredVersion = 1.0;
requiredAddons[] = {};
};
};
class CfgMissions
{
{
class Missions
class Missions
Line 68: Line 86:
};
};
};
};
};</pre></li>
};
<li>Pack addon folder using [[BinPBO]] or other preffered packing tool. It's recommended '''not''' to binarize it.</li>
</syntaxhighlight></li>
<li>Pack addon folder using [[BinPBO]] or other preferred packing tool. It's recommended '''not''' to binarize it.</li>
</ol>
</ol>


Line 75: Line 94:
== Format Comparison ==
== Format Comparison ==


{| class="wikitable" width="50%"
{| class="wikitable" style="text-align: center"
! Feature
! style="min-width: 20em" | Feature
! Mission Format
! Mission Format
! Addon Format
! Addon Format


|-
|-
| Ingame Export
| style="text-align: left" | Ingame Export
| style="text-align:center;"| {{task/}}
| {{Icon|checked}}
| style="text-align:center;"| {{task}}
| {{Icon|unchecked}}


|-
|-
| External Export
| style="text-align: left" | External Export
| style="text-align:center;"| {{task/}}
| {{Icon|checked}}
| style="text-align:center;"| {{task/}}
| {{Icon|checked}}


|-
|-
| Multiple missions in one file
| style="text-align: left" | Multiple missions in one file
| style="text-align:center;"| {{task}}
| {{Icon|unchecked}}
| style="text-align:center;"| {{task/}}
| {{Icon|checked}}


|-
|-
| Custom addon in mission file
| style="text-align: left" | Custom addon in mission file
| style="text-align:center;"| {{task}}
| {{Icon|unchecked}}
| style="text-align:center;"| {{task/}}
|{{Icon|checked}}


|-
|-
| [[Content Authorship]]
| style="text-align: left" | Localized mission name
| style="text-align:center;"| {{task}}
| {{Icon|unchecked}}
| style="text-align:center;"| {{task/}}
| {{Icon|checked}}


|-
|-
| Localized mission name
| style="text-align: left" | Designer controlled subfolders
| style="text-align:center;"| {{task}}
| {{Icon|unchecked}}
| style="text-align:center;"| {{task/}}
| {{Icon|checked}}


|-
|-
| Designer controlled subfolders
| style="text-align: left" | User controlled subfolders
| style="text-align:center;"| {{task}}
| {{Icon|checked}}
| style="text-align:center;"| {{task/}}
| {{Icon|unchecked}}


|-
|-
| User controlled subfolders
| style="text-align: left" | Ingame download of MP mission
| style="text-align:center;"| {{task/}}
| {{Icon|checked}}
| style="text-align:center;"| {{task}}
| {{Icon|unchecked}}
|}


|-
| Ingame download of mission
| style="text-align:center;"| {{task/}}
| style="text-align:center;"| {{task}}
|}


[[Category: Mission Editor]]
[[Category: 2D Editor]]
[[Category: Operation Flashpoint: Editing]]
[[Category: Operation Flashpoint: Missions]]
[[Category: ArmA: Mission Editing]]
[[Category: ArmA: Editing]]
[[Category: ArmA 2: Editing]]
[[Category: Take On Helicopters: Editing]]

Latest revision as of 16:22, 4 January 2023

Two export methods are available, both with certain pros and cons.


Mission Format

Older export variant working since Arma: Cold War Assault. Mission PBO contains only mission folder itself and additional options are limited, e.g. you cannot have multiple missions in one file and in case you need mission specific addon, it has to be created separately.

Multiplayer missions are sent by server to every connected user, occasionally leading to increased bandwidth. It's recommended not to use any large files (pictures, sounds, ...) to prevent it.

File itself is always named in following format

<mission name>.<world name>.pbo

Examples:

TopGun.abel.pbo
SpyGame.Chernarus.pbo
Domino.ProvingGrounds_PMC.pbo

World name matches the class in CfgWorlds.pbo

Installation

Put missions/campaigns in following folders or in folders of the same names in mod subfolders.

Singleplayer Missions

%ROOT%\Missions

Multiplayer Missions

%ROOT%\MPMissions

Campaigns

%ROOT%\Campaigns

Export

Ingame

  1. When in mission editor, click on Save button.
  2. Select 'Export to single-missions' or 'Export to multiplayer missions', depending on type of your mission

Mission PBO was created in Missions or MPMissions folder in the game's root.

  • You can publish the mission directly from Editor in [Arma 3] to Steam Workshop . Click on the Steam icon and provide necessary data: name, description, tags and image.

External

  1. Pack mission folder using BinPBO or other preferred packing tool.


Addon Format

Armed Assault introduced mission export based on addon structure, giving designers more control of PBO structure. Missions or campaigns can be grouped in single PBO (like official missions) or with other supporting addons like new objects or functions.

Multiplayer missions has to be installed before the game is run. No file size limitations exists.

Installation

Put missions/campaigns in following folder or in folder of the same names in mod subfolders.

%ROOT%\Addons

Export

BinPBO
  1. Create folder with name of the addon (example: MyMission)
  2. Copy mission folder into the addon folder (example: MyMission\MissionFolder.World)
  3. Create Config.cpp in addon folder with CfgPatches and CfgMissions classes (example: MyMission\config.cpp)
    class CfgPatches
    {
    	class MyAddonClass
    	{
    		units[] = {};
    		weapons[] = {};
    		requiredVersion = 1.0;
    		requiredAddons[] = {};
    	};
    };
    class CfgMissions
    {
    	class Missions
    	{
    		class MyMissionClass
    		{
    			directory = "MyMission\MissionFolder.World";
    		};
    	};
    };
    
  4. Pack addon folder using BinPBO or other preferred packing tool. It's recommended not to binarize it.


Format Comparison

Feature Mission Format Addon Format
Ingame Export Checked Unchecked
External Export Checked Checked
Multiple missions in one file Unchecked Checked
Custom addon in mission file Unchecked Checked
Localized mission name Unchecked Checked
Designer controlled subfolders Unchecked Checked
User controlled subfolders Checked Unchecked
Ingame download of MP mission Checked Unchecked