prepare v4.0.0 release

CHANGELOG.md

@@ -4,7 +4,32 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project badly attempts [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [3.2] - 2024-02-01
+## [4.0.0] - 2024-02-07
+
+ Version 4 marks a massive rewrite due in whole to @IndigoFox by updating the internals of the framework into CBA macros and functions.
+
+### Added
+
+- Added ability for FBCB2 Assets to locate themselves on player local map
+- Added various framework utitily functions
+- Added ability for mission maker to allow spawning of resupply boxes from arsenal boxes
+- Added CBA settings for resupply box spawning
+
+### Changed
+
+- Documented purpose of `missionSeries` parameter in `mission_settings.hpp`
+- Moved internal functions into new framework directory structure
+- Moved FBCB2 internal data structure into multiple defintion files
+- Moved resupply boxes internal data structures into their own definiton file
+- Moved player inventory internal data structure into its own defintion file
+- Moved vehicle flags internal data structure into its own defitinion file
+- Use player's preferred ACE color settings for medical triage icons
+
+### Deleted
+
+- Leftover resupply box code from before version 3.2.0 update
+
+## [3.2.0] - 2024-02-01
 
 ### Added
 
@@ -62,7 +87,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Lowered garbage collection times and range for dead bodies
 
 
-## [3.0] - 2023-05-03
+## [3.0.0] - 2023-05-03
 
 ### Added
 
@@ -79,7 +104,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - Remove `CfgRemoteExec` from `description.ext` as it has been deprecated as of Arma v1.54
 
-## [2.2] - 2023-04-23
+## [2.2.0] - 2023-04-23
 
 ### Added
 
@@ -93,7 +118,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - Force `sideChat` CBA setting to 'disabled' on mission start by default
 
-## [2.1] - 2023-04-12
+## [2.1.0] - 2023-04-12
 
 ### Added
 
@@ -103,7 +128,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Allow `#admin` to enable or disable `sideChat` via CBA setting on a per mission file basis. 
 `Escape -> Configure -> Addon Options -> Server -> 17th Battalion -> Enable Side Chat`
 
-## [2.0] -2023-04-12
+## [2.0.0] -2023-04-12
 
 ### Added
 
@@ -113,7 +138,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - mission.jpg to correct dimensions and optimize
 
-## [1.9] - 2023-03-07
+## [1.9.0] - 2023-03-07
 
 ### Added
 

README.md

@@ -20,7 +20,7 @@ Once copied, the final structure should appear similar to the following:
 ├── mission.sqm
 ```
 
-If you're building a mission for use in an op, please delete "aaFrameworkUtils" and "framework\x". These are for the purposes of development and add size bloat to the mission download when players connect to your mission.
+> **Note:** If you're building a mission for use and not actively developing code, the `aaFrameworkUtils` and `framework\x` directories **should be deleted**. *These are for the purposes of development and add size bloat to the mission download when players connect to your mission.*
 
 After the requisite configuration file edits have been made, your mission is ready to be packed into a pbo for deployment.
 
@@ -45,6 +45,14 @@ The contents of the lower half of the file are where the mission maker is able t
 This file will be displayed the client mission loading screen.
 File should remain small *(under 300KiB)* and should optimally be `1024px by 512px` in resolution
 
+## defines/
+
+This directory contains the definition files use by the framework in various places. *Contents should not be edited*
+
+## framework/
+
+This directory contains the code for the mission framework. **Contents must not be edited.**
+
 ## images/
 
 This directory is for organizational purposes for any images you wish to use in your mission
@@ -63,7 +71,8 @@ This directory is for organizational purposes for any custom scripts you wish to
 
 This directory is for organizational purposes for textures files used by mission scripts.
 
-## DEV NOTES
+
+# Development Notes
 
 All modules are broken apart as such in /framework. Client and server inits are managed in /framework/init.
 

framework/script_version.hpp

@@ -1,4 +1,4 @@
-#define MAJOR 3
-#define MINOR 2
-#define PATCHLVL 1
+#define MAJOR 4
+#define MINOR 0
+#define PATCHLVL 0
 #define BUILD 0