Documentation - Add all missing README entries (#38)

* change German loadout version nunmbers in Readme file * fix deu logistics file template * add deu logistic file template documentation entry * fix typo * add download buttons to norwegian README file * add polish loadout documentation * fix small error in Polish loadout README file * update Ukrainian loadout documentation * fix broken links * add Russian AI loadout documentation * add Russian loadout documentation * minor fixes in role variables * add unaffiliated loadout documentation * General - Removed old, unused loadouts * General - Small role variable fix * General - Add United States README file entries
clustermod · Feb 22, 2024 · 10579d6 · 10579d6
1 parent 70dc72d
commit 10579d6
Show file tree

Hide file tree

Showing 20 changed files with 663 additions and 746 deletions.
diff --git a/loadouts/germany/loadouts/README.md b/loadouts/germany/loadouts/README.md
@@ -8,7 +8,7 @@
 
 **Modpack Version:** `unknown`
 
-**Template Version:** `unknown`
+**Template Version:** `1.3`
 
 **Roles:** 
 - `RFL` Rifleman
@@ -40,7 +40,7 @@ None
 
 **File:** `deu_2024_jäger_flecktarn_v5.sqf`
 
-**Modpack Version:** `[V5]`
+**Modpack Version:** `cc_core_v5`
 
 **Template Version:** `1.3`
 
@@ -76,7 +76,7 @@ This loadout is depicting a modern German light infantry unit. They are called [
 
 **Modpack Version:** `unknown`
 
-**Template Version:** `unknown`
+**Template Version:** `1.3`
 
 **Roles:** 
 - `RFL` Rifleman
@@ -85,7 +85,7 @@ This loadout is depicting a modern German light infantry unit. They are called [
 - `MED` Medic
 - `MMG` Medium Machinegunner
 - `AR` Autorifleman
-- ``HAT` Anti-Tank, Heavy
+- `HAT` Anti-Tank, Heavy
 - `GRD` Grenadier
 
 **Description:**
@@ -110,7 +110,7 @@ None
 
 **Modpack Version:** `unknown`
 
-**Template Version:** `unknown`
+**Template Version:** `1.3`
 
 **Roles:** 
 - `RFL` Rifleman
@@ -143,7 +143,7 @@ None
 
 **Modpack Version:** `unknown`
 
-**Template Version:** `unknown`
+**Template Version:** `1.3`
 
 **Roles:** 
 - `RFL` Rifleman
@@ -175,7 +175,7 @@ None
 
 **Modpack Version:** `unknown`
 
-**Template Version:** `unknown`
+**Template Version:** `1.3`
 
 **Roles:** 
 - `RFL` Rifleman
@@ -207,7 +207,7 @@ None
 
 **Modpack Version:** `unknown`
 
-**Template Version:** `unknown`
+**Template Version:** `1.3`
 
 **Roles:** 
 - `RFL` Rifleman
@@ -251,7 +251,7 @@ None
 
 **Modpack Version:** `unknown`
 
-**Template Version:** `unknown`
+**Template Version:** `1.3`
 
 **Roles:** 
 - `RFL` Rifleman
@@ -285,7 +285,7 @@ None
 
 **Modpack Version:** `unknown`
 
-**Template Version:** `unknown`
+**Template Version:** `1.3`
 
 **Roles:** 
 - `RFL` Rifleman
@@ -323,7 +323,7 @@ None
 
 **Modpack Version:** `unknown`
 
-**Template Version:** `unknown`
+**Template Version:** `1.3`
 
 **Roles:** 
 - `RFL` Rifleman
@@ -357,7 +357,7 @@ None
 
 **Modpack Version:** `unknown`
 
-**Template Version:** `unknown`
+**Template Version:** `1.3`
 
 **Roles:** 
 - `RFL` Rifleman
@@ -388,7 +388,7 @@ None
 
 **Modpack Version:** `unknown`
 
-**Template Version:** `unknown`
+**Template Version:** `1.3`
 
 **Roles:** 
 - `RFL` Rifleman
@@ -425,7 +425,7 @@ None
 
 **Modpack Version:** `unknown`
 
-**Template Version:** `unknown`
+**Template Version:** `1.3`
 
 **Roles:** 
 - `CRW` Crewman
@@ -451,7 +451,7 @@ None
 
 **Modpack Version:** `unknown`
 
-**Template Version:** `unknown`
+**Template Version:** `1.3`
 
 **Roles:** 
 - `RFL` Rifleman
@@ -524,7 +524,7 @@ None
 
 **File:** `deu_2023_pzgren_flecktarn_v5.sqf`, `deu_2023_pzgren_tropentarn_v5.sqf`
 
-**Modpack Version:** `[V5]`
+**Modpack Version:** `cc_core_v5`
 
 **Template Version:** `1.3`
 
@@ -564,7 +564,7 @@ None
 
 **Modpack Version:** `unknown`
 
-**Template Version:** `unknown`
+**Template Version:** `1.3`
 
 **Roles:** 
 - `RFL` Rifleman
@@ -601,7 +601,7 @@ None
 
 **Modpack Version:** `unknown`
 
-**Template Version:** `unknown`
+**Template Version:** `1.3`
 
 **Roles:** 
 - `RFL` Rifleman

diff --git a/loadouts/germany/logistics/README.md b/loadouts/germany/logistics/README.md
@@ -4,7 +4,7 @@
 
 **File:** `deu_2024_jäger_logistics_flecktarn_v5.sqf`
 
-**Modpack Version:** `[V5]`
+**Modpack Version:** `cc_core_v5`
 
 **Template Version:** `1.3`
 
@@ -25,4 +25,35 @@ Logistics file for assosiated file. Has CC Orbat item amounts in the crates.
 
 <a href="https://github.com/clustermod/HCMF3-Loadouts/blob/addloadouts/master/germany/loadouts/deu_2024_jäger_flecktarn_v5.sqf">
   <img alt="Static Badge" src="https://img.shields.io/badge/File-Download_(CTRL_%2B_S)-orange?style=flat-square">
+</a>
+
+## Logistics file template, German Armed Forces
+
+**File:** `deu_bundeswehr_logistics_template.sqf`
+
+**Modpack Version:** `cc_core_v5`
+
+**Template Version:** `1.3`
+
+**Crates:** 
+- `Fireteam Crate` 
+- `Medical Crate` 
+- `Explosives Crate`
+- `LAT Crate`
+- `Mortar Crate`
+- `Engineer Crate`
+- `Large Crate`
+
+**Description:**
+<!-- Description -->
+Logistics file with crates added by the BW3 Bundeswehr mod. Has CC Orbat item amounts in the crates, items need adjusting to each loadout/unit portrayed.
+
+**Country:** Germany
+
+
+**Associated Files:**
+None
+
+<a href="https://github.com/clustermod/HCMF3-Loadouts/blob/addloadouts/master/germany/loadouts/deu_bundeswehr_logistics_template.sqf">
+  <img alt="Static Badge" src="https://img.shields.io/badge/File-Download_(CTRL_%2B_S)-orange?style=flat-square">
 </a>
diff --git a/loadouts/germany/logistics/deu_bundeswehr_logistics_template.sqf b/loadouts/germany/logistics/deu_bundeswehr_logistics_template.sqf
@@ -13,10 +13,12 @@
     ["Fireteam", {
         _available = 2;
         _class = "BWA3_Box_Ammo";
-        _weapons = [];
-        _magazines = [];
-        _grenades = [];
-        _items = [];
+         _weapons = [];
+        /* Change Values in between the qoutes to object classnames. */
+        _magazines = [["<Main Weapon magazines>", 50], ["<Automatic Weapon Magazines>",10], ["<LAT Launchers>",2 ], ["<GPs for UGLs>",15], ["<Flares>",10]];
+        /* Change Values in between the qoutes to object classnames. */
+        _grenades = [["<Throwable grenades>", 15]];
+        _items = [["ACE_fieldDressing", 12],  ["ACE_morphine", 12], ["ACE_canteen", 6]];
         _cargo = [];
     }],
 
@@ -34,43 +36,14 @@
         _available = 0;
         _class = "BWA3_Box_Explosives";
         _weapons = [];
-        _magazines = [];
-        _grenades = [];
-        _items = [];
-        _cargo = [];
-    }],
-
-    ["MMG", {
-        _available = 0;
-        _class = "BWA3_Box_Ammo";
-        _weapons = [];
-        _magazines = [];
-        _grenades = [];
-        _items = [];
-        _cargo = [];
-    }],
-
-    ["HMG", {
-        _available = 0;
-        _class = "BWA3_Box_Ammo";
-        _weapons = [];
-        _magazines = [];
-        _grenades = [];
-        _items = [];
-        _cargo = [];
-    }],
-
-    ["MAT", {
-        _available = 0;
-        _class = "BWA3_Box_Launchers";
-        _weapons = [];
-        _magazines = [];
+        /* Change Values in between the qoutes to object classnames. */
+        _magazines = [["<Explosives<", 10]];
         _grenades = [];
         _items = [];
         _cargo = [];
     }],
-    
-    ["HAT", {
+
+    ["LAT", {
         _available = 0;
         _class = "BWA3_Box_Launchers";
         _weapons = [];
@@ -79,7 +52,7 @@
         _items = [];
         _cargo = [];
     }],
-    
+
     ["Mortar", {
         _available = 0;
         _class = "BWA3_box_120mm_Mo_Combo";

diff --git a/loadouts/norway/loadouts/README.md b/loadouts/norway/loadouts/README.md
@@ -21,11 +21,9 @@ A norwegian tanker crew.
 
 **Year**: 2018
 
-<table>
-  <tr>
-    <td><a download href="https://github.com/clustermod/Harks-CMF3-Loadouts/raw/master/loadouts/norway/loadouts/nor_2018_tankcrew_woodland.sqf">Download File (CTRL + S)</a></td>
-  </tr>
-</table>
+<a href="https://github.com/clustermod/HCMF3-Loadouts/blob/master/loadouts/norway/loadouts/nor_2018_tankcrew_woodland.sqf">
+  <img alt="Static Badge" src="https://img.shields.io/badge/File-Download_(CTRL_%2B_S)-orange?style=flat-square">
+</a>
 
 ---
 
@@ -60,11 +58,9 @@ A norwegian semi-sof team.
 
 **Camo:** M98 (N-Kamo, Woodland)
 
-<table>
-  <tr>
-    <td><a download href="https://github.com/clustermod/Harks-CMF3-Loadouts/raw/master/loadouts/norway/loadouts/nor_2018_telemarken-battalion_woodland.sqf">Download File (CTRL + S)</a></td>
-  </tr>
-</table>
+<a href="https://github.com/clustermod/HCMF3-Loadouts/blob/master/loadouts/norway/loadouts/nor_2018_telemarken-battalion_woodland.sqf">
+  <img alt="Static Badge" src="https://img.shields.io/badge/File-Download_(CTRL_%2B_S)-orange?style=flat-square">
+</a>
 
 ---
 
@@ -99,11 +95,9 @@ A norwegian sof team in multicam.
 
 **Camo:** Multicam
 
-<table>
-  <tr>
-    <td><a download href="https://github.com/clustermod/Harks-CMF3-Loadouts/raw/master/loadouts/norway/loadouts/nor_2020_fsk_multicam.sqf">Download File (CTRL + S)</a></td>
-  </tr>
-</table>
+<a href="https://github.com/clustermod/HCMF3-Loadouts/blob/master/loadouts/norway/loadouts/nor_2020_fsk_multicam.sqf">
+  <img alt="Static Badge" src="https://img.shields.io/badge/File-Download_(CTRL_%2B_S)-orange?style=flat-square">
+</a>
 
 ---
 
@@ -132,10 +126,8 @@ A norwegian marine sof team.
 
 **Camo:** Black / Grey and Multicam
 
-<table>
-  <tr>
-    <td><a download href="https://github.com/clustermod/Harks-CMF3-Loadouts/raw/master/loadouts/norway/loadouts/nor_2022_marinejeger.sqf">Download File (CTRL + S)</a></td>
-  </tr>
-</table>
+<a href="https://github.com/clustermod/HCMF3-Loadouts/blob/master/loadouts/norway/loadouts/nor_2022_marinejeger.sqf">
+  <img alt="Static Badge" src="https://img.shields.io/badge/File-Download_(CTRL_%2B_S)-orange?style=flat-square">
+</a>
 
 ---
diff --git a/loadouts/poland/loadouts/README.md b/loadouts/poland/loadouts/README.md
@@ -1 +1,34 @@
-# Loadouts
+# Loadouts
+
+## 2018 GROM, Poland 
+**file:** `pol_2018_grom_multicam.sqf`
+
+**Modpack Version:** `??`
+
+**Template Version:** `1.3`
+
+**Roles:** 
+- `RFL` Rifleman
+- `SL` Squad Leader
+- `FTL` Fireteam Leader
+- `MED` Medic
+- `AR` Autorifleman
+- `GRD` Grenadier
+- `LAT` Anti-Tank, Light
+- `MAT` Anti-Tank, Medium
+- `HAT` Anti-Tank, Heavy
+- `ENG` Engineer
+
+**Description:**
+
+A polish SOF team.
+
+**Contry:** Poland
+
+**Year**: 2018
+
+**Camo:** Multicam
+
+<a href="https://github.com/clustermod/HCMF3-Loadouts/blob/master/loadouts/poland/loadouts/pol_2018_grom_multicam.sqf">
+  <img alt="Static Badge" src="https://img.shields.io/badge/File-Download_(CTRL_%2B_S)-orange?style=flat-square">
+</a>