Merge branch 'develop' of https://gitea.iceberg-gaming.com/17th-Ranger-Battalion-ORG/MissionTemplate into develop

.gitea/workflows/on-release.yaml

@@ -16,13 +16,14 @@ jobs:
           echo "sha: ${{ gitea.sha }}"
           echo "api_url: ${{ gitea.api_url }}"
           echo "workflow: ${{ gitea.workflow }}"
+
       - name: Publish remote issue
         run: |
           $headers = @{
             "accept" = "application/json"
             "Authorization" = "token ${{ secrets.RUNNER_ISSUE_TOKEN }}"
           }
-          $response = Invoke-RestMethod -Uri "${{ gitea.api_url }}/repos17th-Ranger-Battalion-ORG/MissionsForZGM/issues" -Method Post -Headers $headers -ContentType "application/json" -Body "{`"title`": `"publish-release`"}"
+          $response = Invoke-RestMethod -Uri "${{ gitea.api_url }}/repos/17th-Ranger-Battalion-ORG/MissionsForZGM/issues" -Method Post -Headers $headers -ContentType "application/json" -Body "{`"title`": `"publish-release`"}"
 
   CreateRelease:
     name: Publish cleaned template
@@ -56,10 +57,11 @@ jobs:
       
       - name: Create archive
         run: |
+          cd release
           $revision = git rev-parse --short=10 HEAD
-          cd MissionTemplate
           $tag = git describe --abbrev=0 --tags
-          Compress-Archive MissionFramework mission-maker-template-v$tag-$revision.zip
+          cd ..
+          Compress-Archive MissionTemplate mission-maker-template-v$tag-$revision.zip
 
       - name: Add archive to release
         uses: https://gitea.com/actions/gitea-release-action@v1.3.0

CHANGELOG.md

@@ -4,6 +4,20 @@ 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).
 
+## [4.1.0] - 2024-03-01
+
+### Added
+
+- Added ability for mission maker to use custom leaflets
+- Added ability for mission maker to define points of interested to be automatically added as MicroDAGR waypoints
+- Added `missionGroup` variable in `description.ext` for backend grouping of mission
+- Added custom script support via `CfgFunctions`
+- Added 5 second invulnerability on ejection of air vehicle when parachute equipped
+
+### Changed
+
+- Track unconsciousness time
+
 ## [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.

README.md

@@ -2,11 +2,10 @@
 
 The only file which should be pre-existing in your mission folder is `mission.sqm`, once freshly saved from Arma 3's EDEN Editor.
 
-Download the latest mission template zip from the [latest release](https://17th-gs.iceberg-gaming.com:5443/hizumi/MissionTemplate/releases/latest) and copy its contents to the folder where your mission file lives.
+Download the latest mission template zip from the [latest release](https://gitea.iceberg-gaming.com/17th-Ranger-Battalion-ORG/MissionTemplate/releases/latest) and copy its contents to the folder where your mission file lives.
 
 Once copied, the final structure should appear similar to the following:
-```markdown
-├── aaFrameworkUtils/
+```
 ├── defines/
 ├── framework/
 ├── images/
@@ -14,13 +13,17 @@ Once copied, the final structure should appear similar to the following:
 ├── sounds/
 ├── textures/
 ├── CHANGELOG.md
+├── custom_leaflets.hpp
+├── custom_scripts.hpp
+├── CHANGELOG.md
 ├── description.ext
-├── mission_settings.hpp
 ├── mission.jpg
 ├── mission.sqm
+├── mission_settings.hpp
+├── README.md
 ```
 
-> **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.*
+> **Note:** If you're building a mission for use and not actively developing code, you should download the `mission-maker-template` zip file which is a cleaned version of this framework. The `aaFrameworkUtils` and `framework\x` directories in the source tree are for the purposes of development and would only 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.
 
@@ -38,13 +41,21 @@ Almost none of the template files should be edited in anyway as they have been f
 
 The contents of this file must be edited to reflect the naming of your mission for display purposes. All variables are self-documented inside the file to clearly identify the purpose of each piece of required text
 
-The contents of the lower half of the file are where the mission maker is able to add/replace/modify the built in `#ace-fortify` preset
+The contents of the lower half of the file contain templated declaration blocks where the mission maker can define custom waypoints to be automatically added to the ACE MicroDAGR, and define/edit the custom built in `#ace-fortify` preset.
 
 ## mission.jpg
 
 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
 
+## custom_leaflets.hpp
+
+This file contains the temeplate block for declaring custom leaflets to be used within missions.
+
+## custom_scripts.hpp
+
+This file contains an accessbile `CfgFunctions` declaration block for custom functions which require setup in this manner.
+
 ## defines/
 
 This directory contains the definition files use by the framework in various places. *Contents should not be edited*
@@ -124,3 +135,4 @@ This directory contains a number of hpp files used to define constants throughou
   - Provides an ACE3 interaction menu that allows players to attach and remove flags from vehicles.
   - Flags are defined in `defines/VehicleFlags.hpp`.
 
+c