Partial documentation for new campaign modding in 2.3.

2.3-Campaign-Design.md

@@ -0,0 +1,57 @@
+In DCS Liberation 2.3 campaign modding has been redesigned so that the campaign is designed in the mission editor, as a single miz file per mission.
+
+## Descriptor file
+
+As before, the campaign uses a JSON file to describe some metadata. To create a new campaign, add a JSON file (such as `mycampaign.json`) to `resources\campaigns`.
+
+This json file should contain a json object, with the following parameters :
+
+* `name`: The name of the campaign that will be shown in the New Game wizard.
+* `theater`: The map for the campaign (either: `Caucasus`, `Persian Gulf`, `Nevada`, `Normandy`, `Syria` or `The Channel`).
+* `authors`: The authors of the campaign that will be shown in the New Game wizard.
+* `description`: A description of the campaign that will be shown in the New Game wizard.
+* `miz`: The name of the miz file (in the same `resources\campaigns` directory) that describes the campaign.
+
+## Designing campaigns in the mission editor
+
+When creating a campaign it may be easiest to start with an existing campaign in the same theater and modify it to suit your needs. If starting from scratch, ensure that Combined Joint Task Forces Blue and Combined Joint Task Forces Red are assigned to the blue and red coalitions respectively, as these will be used to define many of the campaigns properties.
+
+### Control points
+
+Control points are the spawn locations and (in most cases) the capturable positions in the campaign.
+
+#### Airbase control
+
+To make an airbase that starts controlled by blue, assign the airbase to the blue coalition in the mission editor. To make an airbase that starts controlled by red, assign the airbase to red.
+
+#### Carriers and LHAs
+
+To create a carrier, place a CVN-74 where you want it to be in the campaign. The carrier will be red if it belongs to CJTF Red and blue if it belongs to CJTF Blue.
+
+To create an LHA, follow the same process but place an LHA-1.
+
+Note that the presence of the carrier or LHA in the game will depend on the player's options and the faction's navy.
+
+#### Off-map spawns
+
+To create a point where aircraft from other theaters can be spawned into the mission in-air, place an F-15C. As with carriers and LHAs, use CJTF Red or Blue to assign the point to either faction.
+
+The altitude of the unit is not currently relevant, as the spawn altitude of units in Liberation depends on the faction's doctrine and the unit type.
+
+#### Importance
+
+Control points can be assigned an "importance", which determines the proportion of their forces that the AI commander will assign to the control point. This value is set using the `Periodicity` property of the control point's warehouse. This applies to airbases, carriers, and LHAs, but not to off-map spawns.
+
+30 is the default in the editor and leaving it at 30 will cause it to have its default priority in the campaign (1.2).
+
+Custom priorities may be set by changing the periodicity to a value between 10 and 14 (inclusive), with 14 being the most important and 10 being the least important. This value will be divided by 10 to fit the game's importance range of 1.0 to 1.4, so a value of 12 will also set the default importance of 1.2.
+
+#### Campaign inversion
+
+Inverting the campaign allows the player to play the campaign in reverse (starting from the North instead of the South, for example). This doesn't simply swap all of the control points, but swaps a number of control points as defined by the mission designer so that the player doesn't begin the campaign with most of the control points already captured.
+
+To specify that a control point should be owned by the player when the campaign is inverted, set the "unlimited aircraft" property of the warehouse. This applies to airbases, carriers, and LHAs. Off-map spawns will always be inverted. (TODO: Not currently, fix that)
+
+### Front lines
+
+Front lines are defined by placing a CJTF Blue M-113 at an airfield and defining a route to the connected control point. The front line will follow the _waypoints_ of the vehicle group (not the path, so using on-road waypoints will not cause the front line to follow roads automatically), so waypoints should be placed at each location that the front line should turn to avoid terrain. The route should end near the airfield that the front line connects to. The beginning and ending waypoints will automatically snap to the nearest airfields when the campaign is generated.