Allow in-line definitions of campaign factions.

A lot of campaigns want to define custom factions. This allows them to do so without us having to fill the built-in factions list with a bunch of campaign-specific factions. It also makes custom campaigns more portable as they don't need to also distribute the custom faction files.
2025-11-10 14:22:26 +00:00 · 2023-04-17 23:27:59 -07:00
parent dca256364a
commit 1ac36d03da
11 changed files with 288 additions and 197 deletions
--- a/resources/campaigns/operation_allied_sword.yaml
+++ b/resources/campaigns/operation_allied_sword.yaml
@@ -2,10 +2,181 @@
 name: Syria - Operation Allied Sword
 theater: Syria
 authors: Fuzzle
-recommended_player_faction: Israel-USN 2005 (Allied Sword)
-recommended_enemy_faction: Syria-Lebanon 2005 (Allied Sword)
-description: <p>In this fictional scenario, a US/Israeli coalition must push north from the Israeli border, through Syria and Lebanon to Aleppo.</p><p><strong>Backstory:</strong> A Syrian-Lebanese joint force (with Russian materiel support) has attacked Israel, attmepting to cross the northern border. With the arrival of a US carrier group, Israel prepares its counterattack. The US Navy will handle the Beirut region's coastal arena, while the IAF will push through Damascus and the inland mountain ranges.</p>
-version: "10.1"
+recommended_player_faction:
+  country: Combined Joint Task Forces Blue
+  name: Israel-USN 2005
+  authors: Fuzzle
+  description:
+    <p>A joint US Navy/Israeli modern faction for use with the Operation Allied
+    Sword scenario.</p>
+  locales:
+    - en_US
+  aircrafts:
+    - F-4E Phantom II
+    - F-15C Eagle
+    - F-15E Strike Eagle
+    - F-16CM Fighting Falcon (Block 50)
+    - F-14B Tomcat
+    - F/A-18C Hornet (Lot 20)
+    - AV-8B Harrier II Night Attack
+    - AH-1W SuperCobra
+    - AH-64D Apache Longbow
+    - AH-64D Apache Longbow (AI)
+    - S-3B Viking
+    - SH-60B Seahawk
+    - UH-1H Iroquois
+    - UH-60L
+  awacs:
+    - E-2C Hawkeye
+  tankers:
+    - KC-130
+    - S-3B Tanker
+  frontline_units:
+    - M113
+    - M1043 HMMWV (M2 HMG)
+    - M1045 HMMWV (BGM-71 TOW)
+    - Merkava Mk IV
+    - M163 Vulcan Air Defense System
+  artillery_units:
+    - M109A6 Paladin
+    - M270 Multiple Launch Rocket System
+  logistics_units:
+    - Truck M818 6x6
+  infantry_units:
+    - Infantry M4
+    - Infantry M249
+    - MANPADS Stinger
+  preset_groups:
+    - Hawk
+    - Patriot
+  naval_units:
+    - FFG Oliver Hazard Perry
+    - DDG Arleigh Burke IIa
+    - CG Ticonderoga
+    - LHA-1 Tarawa
+    - CVN-74 John C. Stennis
+  missiles: []
+  air_defense_units:
+    - SAM Hawk SR (AN/MPQ-50)
+    - M163 Vulcan Air Defense System
+    - M48 Chaparral
+  requirements: {}
+  carrier_names:
+    - CVN-71 Theodore Roosevelt
+    - CVN-72 Abraham Lincoln
+    - CVN-73 George Washington
+    - CVN-74 John C. Stennis
+    - CVN-75 Harry S. Truman
+  helicopter_carrier_names:
+    - LHA-1 Tarawa
+    - LHA-2 Saipan
+    - LHA-3 Belleau Wood
+    - LHA-4 Nassau
+    - LHA-5 Peleliu
+  has_jtac: true
+  jtac_unit: MQ-9 Reaper
+  doctrine: modern
+  liveries_overrides:
+    F-14B Tomcat:
+      - VF-142 Ghostriders
+    F/A-18C Hornet (Lot 20):
+      - VMFA-251 high visibility
+    AV-8B Harrier II Night Attack:
+      - VMAT-542
+    AH-1W SuperCobra:
+      - Marines
+    UH-1H Iroquois:
+      - US NAVY
+    UH-60L:
+      - Israeli Air Force
+  unrestricted_satnav: true
+recommended_enemy_faction:
+  country: Combined Joint Task Forces Red
+  name: Syria-Lebanon 2005 (Allied Sword)
+  authors: Fuzzle
+  description:
+    <p>Syria-Lebanon alliance in a modern setting with several imported Russian
+    assets. Designed for use with the Allied Sword scenario.</p>
+  aircrafts:
+    - MiG-23ML Flogger-G
+    - MiG-25RBT Foxbat-B
+    - MiG-29A Fulcrum-A
+    - Su-17M4 Fitter-K
+    - Su-24M Fencer-D
+    - Su-30 Flanker-C
+    - Su-34 Fullback
+    - L-39ZA Albatros
+    - Tu-22M3 Backfire-C
+    - Mi-24V Hind-E
+    - Mi-8MTV2 Hip
+    - SA 342M Gazelle
+    - SA 342L Gazelle
+    - IL-76MD
+  awacs:
+    - A-50
+  tankers:
+    - IL-78M
+  frontline_units:
+    - BMP-1
+    - BMP-2
+    - BTR-80
+    - BRDM-2
+    - MT-LB
+    - T-55A
+    - T-72B with Kontakt-1 ERA
+    - T-90A
+    - ZSU-57-2 'Sparka'
+  artillery_units:
+    - BM-21 Grad
+    - 2S1 Gvozdika
+  logistics_units:
+    - Truck Ural-375
+    - LUV UAZ-469 Jeep
+  infantry_units:
+    - Paratrooper AKS
+    - Infantry AK-74 Rus
+    - Paratrooper RPG-16
+    - MANPADS SA-18 Igla-S "Grouse"
+  preset_groups:
+    - SA-2/S-75
+    - SA-3/S-125
+    - SA-6
+    - SA-11
+    - SA-10/S-300PS
+    - Silkworm
+    - Cold-War-Flak
+    - Russian Navy
+  naval_units:
+    - Corvette 1124.4 Grish
+    - Corvette 1241.1 Molniya
+    - FAC La Combattante IIa
+    - Frigate 1135M Rezky
+  air_defense_units:
+    - SAM P19 "Flat Face" SR (SA-2/3)
+    - EWR 1L13
+    - EWR 55G6
+    - SAM SA-8 Osa "Gecko" TEL
+    - SA-9 Strela
+    - SA-13 Gopher (9K35 Strela-10M3)
+    - SA-19 Grison (2K22 Tunguska)
+    - ZSU-57-2 'Sparka'
+    - AAA ZU-23 Closed Emplacement
+    - ZU-23 on Ural-375
+    - ZSU-23-4 Shilka
+  missiles:
+    - SSM SS-1C Scud-B
+  helicopter_carrier_names: []
+  requirements: {}
+  carrier_names: []
+description:
+  <p>In this fictional scenario, a US/Israeli coalition must push north from the
+  Israeli border, through Syria and Lebanon to
+  Aleppo.</p><p><strong>Backstory:</strong> A Syrian-Lebanese joint force (with
+  Russian materiel support) has attacked Israel, attmepting to cross the
+  northern border. With the arrival of a US carrier group, Israel prepares its
+  counterattack. The US Navy will handle the Beirut region's coastal arena,
+  while the IAF will push through Damascus and the inland mountain ranges.</p>
+version: "10.6"
 miz: operation_allied_sword.miz
 performance: 2
 recommended_start_date: 2004-07-17
@@ -217,4 +388,4 @@ squadrons:
    - primary: Transport
      secondary: air-to-ground
      aircraft:
-        - Mi-8MTV2 Hip
+        - Mi-8MTV2 Hip
--- a/resources/factions/Israel-USN_2005_Allied_Sword.yaml
+++ b/resources/factions/Israel-USN_2005_Allied_Sword.yaml
@@ -1,88 +0,0 @@
---
-country: Combined Joint Task Forces Blue
-name: Israel-USN 2005 (Allied Sword)
-authors: Fuzzle
-description:
-  <p>A joint US Navy/Israeli modern faction for use with the Operation
-  Allied Sword scenario.</p>
-locales:
-  - en_US
-aircrafts:
-  - F-4E Phantom II
-  - F-15C Eagle
-  - F-15E Strike Eagle
-  - F-16CM Fighting Falcon (Block 50)
-  - F-14B Tomcat
-  - F/A-18C Hornet (Lot 20)
-  - AV-8B Harrier II Night Attack
-  - AH-1W SuperCobra
-  - AH-64D Apache Longbow
-  - AH-64D Apache Longbow (AI)
-  - S-3B Viking
-  - SH-60B Seahawk
-  - UH-1H Iroquois
-  - UH-60L
-awacs:
-  - E-2C Hawkeye
-tankers:
-  - KC-130
-  - S-3B Tanker
-frontline_units:
-  - M113
-  - M1043 HMMWV (M2 HMG)
-  - M1045 HMMWV (BGM-71 TOW)
-  - Merkava Mk IV
-  - M163 Vulcan Air Defense System
-artillery_units:
-  - M109A6 Paladin
-  - M270 Multiple Launch Rocket System
-logistics_units:
-  - Truck M818 6x6
-infantry_units:
-  - Infantry M4
-  - Infantry M249
-  - MANPADS Stinger
-preset_groups:
-  - Hawk
-  - Patriot
-naval_units:
-  - FFG Oliver Hazard Perry
-  - DDG Arleigh Burke IIa
-  - CG Ticonderoga
-  - LHA-1 Tarawa
-  - CVN-74 John C. Stennis
-missiles: []
-air_defense_units:
-  - SAM Hawk SR (AN/MPQ-50)
-  - M163 Vulcan Air Defense System
-  - M48 Chaparral
-requirements: {}
-carrier_names:
-  - CVN-71 Theodore Roosevelt
-  - CVN-72 Abraham Lincoln
-  - CVN-73 George Washington
-  - CVN-74 John C. Stennis
-  - CVN-75 Harry S. Truman
-helicopter_carrier_names:
-  - LHA-1 Tarawa
-  - LHA-2 Saipan
-  - LHA-3 Belleau Wood
-  - LHA-4 Nassau
-  - LHA-5 Peleliu
-has_jtac: true
-jtac_unit: MQ-9 Reaper
-doctrine: modern
-liveries_overrides:
-  F-14B Tomcat:
-    - VF-142 Ghostriders
-  F/A-18C Hornet (Lot 20):
-    - VMFA-251 high visibility
-  AV-8B Harrier II Night Attack:
-    - VMAT-542
-  AH-1W SuperCobra:
-    - Marines
-  UH-1H Iroquois:
-    - US NAVY
-  UH-60L:
-    - Israeli Air Force
-unrestricted_satnav: true
--- a/resources/factions/Syria-Lebanon_2005_Allied_Sword.yaml
+++ b/resources/factions/Syria-Lebanon_2005_Allied_Sword.yaml
@@ -1,78 +0,0 @@
---
-country: Combined Joint Task Forces Red
-name: Syria-Lebanon 2005 (Allied Sword)
-authors: Fuzzle
-description:
-  <p>Syria-Lebanon alliance in a modern setting with several imported Russian
-  assets. Designed for use with the Allied Sword scenario.</p>
-aircrafts:
-  - MiG-23ML Flogger-G
-  - MiG-25RBT Foxbat-B
-  - MiG-29A Fulcrum-A
-  - Su-17M4 Fitter-K
-  - Su-24M Fencer-D
-  - Su-30 Flanker-C
-  - Su-34 Fullback
-  - L-39ZA Albatros
-  - Tu-22M3 Backfire-C
-  - Mi-24V Hind-E
-  - Mi-8MTV2 Hip
-  - SA 342M Gazelle
-  - SA 342L Gazelle
-  - IL-76MD
-awacs:
-  - A-50
-tankers:
-  - IL-78M
-frontline_units:
-  - BMP-1
-  - BMP-2
-  - BTR-80
-  - BRDM-2
-  - MT-LB
-  - T-55A
-  - T-72B with Kontakt-1 ERA
-  - T-90A
-  - ZSU-57-2 'Sparka'
-artillery_units:
-  - BM-21 Grad
-  - 2S1 Gvozdika
-logistics_units:
-  - Truck Ural-375
-  - LUV UAZ-469 Jeep
-infantry_units:
-  - Paratrooper AKS
-  - Infantry AK-74 Rus
-  - Paratrooper RPG-16
-  - MANPADS SA-18 Igla-S "Grouse"
-preset_groups:
-  - SA-2/S-75
-  - SA-3/S-125
-  - SA-6
-  - SA-11
-  - SA-10/S-300PS
-  - Silkworm
-  - Cold-War-Flak
-  - Russian Navy
-naval_units:
-  - Corvette 1124.4 Grish
-  - Corvette 1241.1 Molniya
-  - FAC La Combattante IIa
-  - Frigate 1135M Rezky
-air_defense_units:
-  - SAM P19 "Flat Face" SR (SA-2/3)
-  - EWR 1L13
-  - EWR 55G6
-  - SAM SA-8 Osa "Gecko" TEL
-  - SA-9 Strela
-  - SA-13 Gopher (9K35 Strela-10M3)
-  - SA-19 Grison (2K22 Tunguska)
-  - ZSU-57-2 'Sparka'
-  - AAA ZU-23 Closed Emplacement
-  - ZU-23 on Ural-375
-  - ZSU-23-4 Shilka
-missiles:
-  - SSM SS-1C Scud-B
-helicopter_carrier_names: []
-requirements: {}
-carrier_names: []
--- a/resources/ui/templates/campaigntemplate_EN.j2
+++ b/resources/ui/templates/campaigntemplate_EN.j2
@@ -20,6 +20,6 @@ bugs.</p>
 {% endif %}

 <p><strong>Default factions:</strong></p>
-<p><span style="color:#82A466">{{campaign.recommended_player_faction}}</span> VS <span style="color:orange">&nbsp;{{campaign.recommended_enemy_faction}}</span></p>
+<p><span style="color:#82A466">{{campaign.recommended_player_faction.name}}</span> VS <span style="color:orange">&nbsp;{{campaign.recommended_enemy_faction.name}}</span></p>

 {{ campaign.description|safe }}
--- a/resources/ui/templates/campaigntemplate_FR.j2
+++ b/resources/ui/templates/campaigntemplate_FR.j2
@@ -1,7 +1,7 @@
 <strong>Auteur(s) : {{ campaign.authors }}</strong>

 <strong>Factions par défaut :</strong>
-<span style="color:#82A466">&nbsp;{{campaign.recommended_player_faction}}</span> VS <span style="color:orange">&nbsp;{{campaign.recommended_enemy_faction}}</span>
+<span style="color:#82A466">&nbsp;{{campaign.recommended_player_faction.name}}</span> VS <span style="color:orange">&nbsp;{{campaign.recommended_enemy_faction.name}}</span>
 <br/>

 {{ campaign.description|safe }}