Difference between revisions of "ORBAT Tool"

From ALiVE Wiki
Jump to: navigation, search
 
(26 intermediate revisions by one user not shown)
Line 1: Line 1:
 
ALiVE Order of Battle Creator is an in game tool that enables users to change the loadout of individual units, create and edit group configurations or build entirely new factions from scratch without having to learn the complexities of ArmA config editing.
 
ALiVE Order of Battle Creator is an in game tool that enables users to change the loadout of individual units, create and edit group configurations or build entirely new factions from scratch without having to learn the complexities of ArmA config editing.
 +
[[File:Concept.PNG|thumb|Design concept wireframe]]
 +
====Getting Started====
 +
#'''[[Key Concepts|Read and Understand the Key Concepts]]''' and important points about the ORBAT tool before continuing.
 +
#As a minimum you need to start the ArmA3 with @ALiVE and @CBA.
 +
#Open the editor on any map and place a playable unit and the ALiVE ORBAT Creator module.
 +
#Preview the game and the tool will start automatically.
 +
#The ORBAT Creator will detect any unit mods loaded.
 +
#If you close the tool by pressing the escape key, you can reopen the interface via the ALiVE interaction menu by selecting “ORBAT Creator”.
  
−
=Getting Started=
 
−
As a minimum you need to start the ArmA3 with @ALiVE and @CBA.  Open the editor on any map and place a playable unit and the ALiVE ORBAT Creator module.  Preview the game and the tool will start automatically.  The ORBAT Creator will detect any unit mods loaded.  If you close the tool by pressing the escape key, you can reopen the interface via the ALiVE interaction menu by selecting “ORBAT Creator”.
 
  
−
=Key Concepts=
+
====Using the ORBAT Creator====
−
#Existing Factions - Factions packed in a pbo (e.g. OPF_F, BLU_F as well as mods such as CUP Units).  The structure of their units and groups can be overridden using a config but they cannot be permanently changed.
+
The interface has 4 main elements accessed via the buttons in the top right.  Each editor can be used standalone or altogether to create an entirely unique faction with different units and groups.
−
#Faction Config - includes the details of the name and side of the faction. Faction config changes can be applied at the mission level.
+
−
#Group Config - contains details of unit and vehicle classnames.  Group configs can be defined at the mission level.
+
−
#Unit Config - Unit configs include details of all the equipment loaded on units and vehicles.  Unit Configs must be packed and run as an addon.  They cannot be applied at the mission level.
+
−
#Override - changes the makeup of an existing faction without actually replacing the faction itself.  For example, overriding CSAT groups to remove all the AA units.
+
−
#Inherit - using an existing unit or faction as a template for a new variation.
+
−
#Saving Custom Configs - ORBAT Creator cannot save data to disk, it can only export configs to the clipboard.  Be sure to Generate Configs and paste the results into a text editor before closing the mission session or you will lose your work.
+
−
#Loading Custom Configs - currently it is only possible to import existing factions that have been packed into a pbo and loaded as an addon at game start.
+
−
#Mission Level Config - Faction and Group changes that do not include custom unit loadouts can be applied in a mission by pasting the config into description.ext.  Players joining the mission only need the mods used to make the custom config.
+
−
#Game Level Config - Configs that are packed into a pbo and run as as an addon in the command line at game start (-mods=@CBA;@ALiVE;@mynewfaction).  Any players joining the server will need a copy of mynewfaction.pbo
+
  
−
{{note}} As a rule we strongly recommend creating a new faction and customising it rather than overriding existing factions.  It is very easy to create an inherited copy of an entire faction and it leads to fewer issues using it in the editor, not to mention if you want to share your faction config with other users.
+
*[[Faction Editor]] is for creating new factions and checking that all the faction’s groups are compatible with ALiVE.
  
−
=Interface=
+
*[[Unit Editor]] is used for creating new custom units and vehicles and editing their equipment loadout.
−
The interface has 4 main elements accessed via the buttons in the top right.  Each editor can be used standalone or altogether to create an entirely unique faction with different units and groups.
+
  
−
#[[Faction Editor]] is for creating new factions and checking that all the faction’s groups are compatible with ALiVE.
+
*[[Group Editor]] is for creating and editing group compositions.
−
#[[Unit Editor]] is used for creating new custom units and vehicles and editing their equipment loadout.
+
−
#[[Group Editor]] is for creating and editing group compositions.
+
−
#[[Generate Config]] does not open a separate screen.  It exports the config for the current editor to clipboard.  The Generate Faction Config button is special in that it will export a config for the whole Faction, including any custom Groups and Units.
+
  
−
{{note}} The ORBAT Creator cannot save data to disk, it can only export to clipboard.  Be sure to export your work and save it as a text file before closing the mission or you will lose your changes.
+
*[[Generate Config]] does not open a separate screen.  It exports the config for the current editor to clipboard.  The Generate Faction Config button is special in that it will export a config for the whole Faction, including any custom Groups and Units.
  
−
=FAQ & How To=
+
 
 +
====FAQ & How To====
 
[[Fequently Asked Questions|FAQ]]
 
[[Fequently Asked Questions|FAQ]]
  
 
[[Use Cases|Use Case Examples]]
 
[[Use Cases|Use Case Examples]]
 +
 +
[[Advanced Tutorial|Advanced Tutorial]]
 +
 +
[[Category: Factions]]

Latest revision as of 06:03, 8 April 2020

ALiVE Order of Battle Creator is an in game tool that enables users to change the loadout of individual units, create and edit group configurations or build entirely new factions from scratch without having to learn the complexities of ArmA config editing.

Design concept wireframe

Getting Started

  1. Read and Understand the Key Concepts and important points about the ORBAT tool before continuing.
  2. As a minimum you need to start the ArmA3 with @ALiVE and @CBA.
  3. Open the editor on any map and place a playable unit and the ALiVE ORBAT Creator module.
  4. Preview the game and the tool will start automatically.
  5. The ORBAT Creator will detect any unit mods loaded.
  6. If you close the tool by pressing the escape key, you can reopen the interface via the ALiVE interaction menu by selecting “ORBAT Creator”.


Using the ORBAT Creator

The interface has 4 main elements accessed via the buttons in the top right. Each editor can be used standalone or altogether to create an entirely unique faction with different units and groups.

  • Faction Editor is for creating new factions and checking that all the faction’s groups are compatible with ALiVE.
  • Unit Editor is used for creating new custom units and vehicles and editing their equipment loadout.
  • Group Editor is for creating and editing group compositions.
  • Generate Config does not open a separate screen. It exports the config for the current editor to clipboard. The Generate Faction Config button is special in that it will export a config for the whole Faction, including any custom Groups and Units.


FAQ & How To

FAQ

Use Case Examples

Advanced Tutorial

Retrieved from ‘http://alivemod.com/wiki/index.php?title=ORBAT_Tool&oldid=2593’