From 4b247b6ca6629fce96552fd4346794ee348186b4 Mon Sep 17 00:00:00 2001 From: RndName Date: Wed, 23 Mar 2022 17:26:23 +0100 Subject: [PATCH] Mention the layout orientation and the new fill property --- Layouts.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Layouts.md b/Layouts.md index 8043ff6..ef3ee0b 100644 --- a/Layouts.md +++ b/Layouts.md @@ -53,6 +53,8 @@ The miz file is used to define the positioning and orientation of the different *Important*: Every different unit type has to be in a separate Group for the template to work. You can not add units of different types to the same group. They can get merged back together during generation by setting the group property. In the example below both groups `AAA Site 0` and `AAA Site 1` have the group = 1 which means that they will be in the same dcs group during generation. +*Important*: Liberation expects every template to be designed with an orientation of heading 0 (North) in mind. The complete GroundObject will during the campaign generation process be rotated to match the orientation defined by the campaign designer. If the layout was not created with an orientation of heading 0 the later generated GroundObject will likely be misaligned and not work properly. + TODO max amount of possible units is defined from the miz. Example if later the group should have 6 units than there have to be 6 defined in the miz. ![template_miz_example.png](/dcs-liberation/dcs_liberation/blob/develop/doc/layouts/layout_miz_example.png) @@ -83,7 +85,8 @@ Every unit type has to be defined as a sub group as following: | Property | Type | Required | Description | Example | |--------------|------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------| | name | (str) | Yes | The group name used in the .miz. Must match exactly! | | -| optional | (bool, default: False) | No | Defines wether the template can be used without this group if the faction has no access to the unit type or the user wants to disable this group | | +| optional | (bool, default: false) | No | Defines wether the layout can be used without this group if the faction has no access to the unit type or the user wants to disable this group | | +| fill | (bool, default: true) | No | If the group is optional the layout is used from a PresetGroup this property tells the system if it should use any possible faction accessible unit to fill up this slot if no capable one was defined in the preset yaml. | | | unit_count | (list of int) | No | Amount of units to be generated for this group. Can be fixed or a range where it will be picked randomly | | | unit_types | (list dcs unit types) | No | Specific unit_types for ground units. Complete list from pydcs: [Vehicles.py](https://github.com/pydcs/dcs/blob/master/dcs/vehicles.py). This list is extended by all supported mods! | | | unit_classes | (list unit classes) | No | Unit_classes of supported units. Defined in [UnitClass](/dcs-liberation/dcs_liberation/blob/develop/game/data/units.py) | |