Merge branch 'develop' of https://iceberg-gaming.com:5443/hizumi/MissionTemplate into develop

README.md

@@ -78,4 +78,49 @@ All modules are broken apart as such in /framework. Client and server inits are
 
 Pay attention to framework/script_mod.hpp prior to deployment of releases, as the debug settings within will determine what is logged during prod missions.
 
-CfgFunctions is sensitive to the folder/script_component.hpp of each module.
+CfgFunctions is sensitive to the folder/script_component.hpp of each module.
+
+### `defines` Directory
+
+This directory contains a number of hpp files used to define constants throughout the framework. These should ONLY be edited by or with the supervision of a developer to reflect format battalion-wide changes.
+
+- `ApprovedAssets.hpp`: Contains subclasses for approved aerial assets with their assigned callsigns. Used primarily in `fbcb2_assets`.
+- `BattalionInfo.hpp`: Used for representing Battalion structure, element callsigns, and radio frequency assignments. Used primarily in `fbcb2_main`.
+- `DisallowedEquipment.hpp`: Contains flagged item classnames by category that players may not use, or may use only in specific roles. Used to monitor and enforce equipment restrictions.
+- `SignalColors.hpp`: Contains smoke/flare/chemlight colors and what they represent in the field. Used primarily in `fbcb2_main` for the Signal Colors diary record.
+- `SupplyCrates.hpp`: Contains the types, contents, and metadata for all supply crate types in the `resupply` module.
+- `VehicleFlags.hpp`: Defines system information, flag categories, and flag options used to populate ACE3 interaction menus for vehicles. Used by the `vehicleFlags` module.
+
+
+### Modules List
+
+*Within `framework`:*
+
+- `ambience`:
+  - Adds ambient flak capabilities.
+- `client`:
+  - Contains core client-side event handlers and actions that don't fit into other modules.
+- `common`:
+  - Contains common functions and variables used by multiple modules.
+- `fbcb2_main`:
+  - Contains the main FBCB2 functionality and initialization code. Populates the briefing/diary with mission information.
+- `fbcb2_assets`:
+  - A subcomponent of `fbcb2_main`. Used to gather, display, and manage diary records as intel for assets near known bases.
+- `init`:
+  - Contains core initialization functions. Both server and client inits across all modules are managed here.
+- `mapcopy`:
+  - Gives players the ability to copy each other's maps.
+- `performance`:
+  - Contains functionality for monitoring and logging performance data.
+- `reinsert`:
+  - Provides a reinsertion queue system for players and pilots to maximize efficiency of the reinsertion process.
+- `resupply`:
+  - Provides a Zeus module and standalone function to spawn pre-equipped supply crates onto the battlefield.
+  - Supply crate definitions are stored in `defines/SupplyCrates.hpp`.
+  - Optionally, allows players to spawn supply crates from arsenal boxes.
+- `triageIcons`:
+  - For those with medical permissions (`ace_medical`), provides a configurable 3D icon over unconscious units indicating their current ACE Triage Card status.
+- `vehicleFlags`:
+  - Provides an ACE3 interaction menu that allows players to attach and remove flags from vehicles.
+  - Flags are defined in `defines/VehicleFlags.hpp`.
+