From 656347f0a0d4606ca73fd173892a6055964868e5 Mon Sep 17 00:00:00 2001
From: F Robinson <freddy@protality.plus.com>
Date: Thu, 19 Sep 2024 10:49:35 +0100
Subject: [PATCH] Add basic types to README.md

---
 README.md | 126 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 124 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 9614c82..1099345 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,124 @@
-|Actions|Type|
-|-----------|--------|
\ No newline at end of file
+|Index|Type|
+|-----------|--------|
+|actions|`{ [action: string]: Action }`|
+|deployables|`{ [deployable: string]: Deployable }`|
+|characteristics|`{ [characteristic: string]: string }`|
+|factions|`{ [faction: string]: Faction }`|
+|items|`{ [item: string]: Item }`|
+|layers|`{ [layer: string]: Layer }`|
+|levels|`{ [level: string]: Level }`|
+|metadata|`Metadata`|
+|roles|`{ [role: string]: Role }`|
+|units|`{ [unit: string]: Unit }`|
+|vehicles|`{ [vehicle: string]: Vehicle }`|
+
+|Metadata|Type|
+|-----------|--------|
+|squad_version|`string`|
+|timestamp|`number`|
+
+|Action|Type|
+|-----------|--------|
+|name|`string`|
+|details|`string`|
+|type|`"TACTICAL" \| "STRATEGIC"`|
+|icon|`"icons/tactical/\*.png" \| "icons/strategic/\*.png"`|
+|duration|`{ enroute: number, active: number}`|
+|delay|`{ initial: number, respawn: number}`|
+
+
+|Deployable|Type|
+|-----------|--------|
+|name|`string`|
+|type|`string`|
+|icon|`"icons/radial/\*.png"`|
+
+|Faction|Type|
+|-----------|--------|
+|name|`string`|
+|short_name|`string`|
+|flag|`"icons/flags/\*.png"`|
+|badge|`"icons/badges/\*.png"`|
+|buddy_rally|`boolean`|
+|alliance|`string`|
+|theaters|`string[]`|
+|units|`string[]`|
+|roles|`{ [type: string]: { name: string, details: string, options: string[] } }`|
+
+|Item|Type|
+|-----------|--------|
+|name|`string`|
+|category|`string`|
+|image|`"items/\*.png"`|
+|icon|`"icons/item/\*.png"`|
+|info|`{ [field: string]: string }`|
+
+
+|LayerUnits|Type|
+|-----------|--------|
+|`[faction: string]`|`string[]`|
+
+|LayerTeam|Type|
+|-----------|--------|
+|tickets|`number`|
+|defaultUnit|`string`|
+|units|`LayerUnits \| null`|
+
+|LayerObjectiveLocation|Type|
+|-----------|--------|
+|name|`string`|
+|order|`number`|
+|location|`{ x: number, y: number, z: number }`|
+|minimap|`{ x: number, y: number }`|
+
+|Layer|Type|
+|-----------|--------|
+|name|`string`|
+|gamemode|`string`|
+|level|`string`|
+|size|`string`|
+|minimap|`"minimaps/\*.png"`|
+|minimap_corners|`{ min: { x: number, y: number }, max: { x: number, y: number } }`|
+|commander|`boolean`|
+|fob_radius|`{ name: string, exclusion: number, construction: number }`|
+|lighting|`string`|
+|units|`LayerUnits \| null`|
+|teams|`[LayerTeam, LayerTeam]`|
+|objective|`{ count: number, locations: LayerObjectiveLocation[] }`|
+
+|Level|Type|
+|-----------|--------|
+|name|`string`|
+|country|`string`|
+|minimap|`"minimaps/\*.png"`|
+|image|`"levels/\*.png"`|
+|thumbnail|`"levels/thumbnails/\*.png"`|
+
+|Role|Type|
+|-----------|--------|
+|type|`string`|
+|icon|`"icons/role/\*.png"`|
+|tags|`string[]`|
+|items|`string[]`|
+
+|Unit|Type|
+|-----------|--------|
+|name|`string`|
+|faction|`string`|
+|details|`string`|
+|badge|`"badges/\*.png"`|
+|type|`string`|
+|buddy_rally|`boolean`|
+|vehicle_commander_action|`boolean`|
+|characteristics|`string[]`|
+|actions|`string[]`|
+|vehicles|`{ [vehicle: string]: { count: number, delay: { initial: number, respawn: number } } }`|
+|deployables|`{ [deployable: string]: { limit: number \| null, cost: number } }`|
+
+|Vehicle|Type|
+|-----------|--------|
+|name|`string`|
+|type|`string`|
+|tags|`string[]`|
+|tickets|`number`|
+|icon|`"icons/map/\*.png"`|