Update doc slightly

Reviewed-on: #46
Co-authored-by: dutchie031 <timrorije@gmail.com>

.docs/web/index.html

@@ -21,6 +21,9 @@
     <main>
         <div class="reference-container">
             <div class="side-nav">
+                
+                <div id="beta-box-div"></div>
+                
                 <h4>Quick Links</h4>
                 <ul>
                     <li><a href="/pages/tutorials.html" class="side-nav-h2">Tutorials</a></li>
@@ -59,6 +62,13 @@
     <footer>
         <p>&copy; 2025 Spearhead Project</p>
     </footer>
+
+    <script>
+        if (true || window.location.hostname.toLowerCase() == 'beta.spearhead.rocks') {
+            betaHtml = '<note-box type="warning" title="Beta Version">You are looking at docs that are released with the beta version.</note-box>';
+        }
+        document.getElementById('beta-box-div').innerHTML = betaHtml || '';
+    </script>
 </body>
 
 </html>

.docs/web/js/components/sidebar.js

@@ -168,8 +168,14 @@ class Sidebar extends HTMLElement {
     }
 
     render() {
+        var betaHtml = '';
+        if (window.location.hostname.toLowerCase() == 'beta.spearhead.rocks') {
+            betaHtml = '<note-box type="warning" title="Beta Version">You are looking at docs that are released with the beta version.</note-box>';
+        }
+        
         this.innerHTML = `
             <div class="side-nav">
+                ${betaHtml}
                 <h4 class="side-nav-title"></h4>
                 <ul>
                     <!-- Navigation items will be populated automatically -->

.docs/web/pages/reference.html

@@ -253,6 +253,13 @@
                     To make an airbase buildable add a text box inside of the trigger zone and name it: <code-inline>buildable_[freeform]</code-inline> <br/>
                     Then in the text box type amount of kilo's you want to be transfered before the logistisc mission is complete. <br/>
                     
+                    <br>
+                    To add a custom briefing for a buildable zone, include a text box inside the trigger zone and name it: <code-inline>supplybriefing_[freeform]</code-inline>. 
+                    <code-inline>{{coords}}</code-inline> is highly recommended so the players can easily find their landing zone.<br>
+                    Additionally, the amount of kilos required and delivered are always shown on the bottom, as well as a note to not land in the construction zone.
+                    <br/>
+
+
                     <br>
                     The base or zone will slowly build up with each crate giving both a nice view of it happening AND it's good for performance as there's not a big addition of objects at once. <br/>
                     Right now a crate takes 15 seconds to unpack per 500kg. Meaning 2 crates of 1000kg will be faster than 1 crate of 2000kg. <br/>

.gitea/workflows/update-docs.yml

@@ -120,7 +120,7 @@ jobs:
       - name: Run Helm upgrade/install spearhead-docs (develop)
         if: github.ref_name == 'develop'
         run: |
-          helm upgrade --install spearhead-docs .helm \
+          helm upgrade --install spearhead-docs-beta .helm \
             --namespace spearhead-docs \
             --create-namespace \
             -f .helm/values.yaml \

src/classes/spearhead_db.lua

@@ -58,6 +58,7 @@ local CustomDrawing = require("classes.stageClasses.drawings.CustomDrawing")
 ---@class BlueSamData
 ---@field groups Array<string>
 ---@field buildingKilos number?
+---@field briefing string?
 
 ---@class MissionZoneData
 ---@field ZoneName string
@@ -74,6 +75,7 @@ local CustomDrawing = require("classes.stageClasses.drawings.CustomDrawing")
 ---@field padNames Array<string>
 ---@field buildingKilos number?
 ---@field supplyHubNames Array<string>
+---@field briefing string?
 
 ---@class Database
 ---@field private _tables DatabaseTables
@@ -614,6 +616,27 @@ function Database:loadBlueSamUnits()
                     local number = tonumber(kvPair.value)
                     if number and number > 0 then
                         samData.buildingKilos = number
+
+                        if env.mission.drawings and env.mission.drawings.layers then
+                            for i, layer in pairs(env.mission.drawings.layers) do
+                                if string.lower(layer.name) == "author" then
+                                    for key, layer_object in pairs(layer.objects) do
+
+                                        local vec2 = { x = layer_object.mapX, y = layer_object.mapY }
+                                        if triggerZone and Util.is2dPointInZone(vec2, triggerZone) then
+                                            if layer_object.name and Util.startswith(layer_object.name, "supplybriefing_", true) then
+                                                local description = layer_object.text
+                                                if description and description ~= "" then
+                                                    samData.briefing = description
+                                                end
+                                            end
+                                        end
+                                    end
+                                end
+                            end
+                        end
+                    else 
+                        MissionEditorWarnings.Add("Buildable number for " .. blueSamZone .. " is invalid")
                     end
                 end
             end
@@ -748,7 +771,31 @@ function Database:loadFarpData()
                     local number = tonumber(kvPair.value)
                     if number and number > 0 then
                         farpzoneData.buildingKilos = number
+
+                        -- check briefings
+                        if env.mission.drawings and env.mission.drawings.layers then
+                            for i, layer in pairs(env.mission.drawings.layers) do
+                                if string.lower(layer.name) == "author" then
+                                    for key, layer_object in pairs(layer.objects) do
+
+                                        local vec2 = { x = layer_object.mapX, y = layer_object.mapY }
+                                        if triggerZone and Util.is2dPointInZone(vec2, triggerZone) then
+                                            if layer_object.name and Util.startswith(layer_object.name, "supplybriefing_", true) then
+                                                local description = layer_object.text
+                                                if description and description ~= "" then
+                                                    farpzoneData.briefing = description
+                                                end
+                                            end
+                                        end
+                                    end
+                                end
+                            end
+                        end
+                    else
+                        MissionEditorWarnings.Add("Buildable number for " .. farpZone .. " is invalid.")
                     end
+
+                    
                 end
             end
         end

src/classes/stageClasses/SpecialZones/BlueSam.lua

@@ -89,7 +89,7 @@ function BlueSam.New(database, logger, zoneName, spawnManager)
 
     local zone = DcsUtil.getZoneByName(zoneName)
     if zone then
-        BuildableZone.New(self, zone, self._buildableCrateKilos or 0, "SAM_CRATE", self._blueGroups, logger, database)
+        BuildableZone.New(self, zone, self._buildableCrateKilos or 0, "SAM_CRATE", self._blueGroups, logger, database, blueSamData.briefing)
     end
 
     return self

src/classes/stageClasses/SpecialZones/FarpZone.lua

@@ -64,7 +64,7 @@ function FarpZone.New(database, logger, zoneName, spawnManager)
         local zone = DcsUtil.getZoneByName(zoneName)
         if zone then
             self._logger:debug("Creating Buildable zone: " .. zoneName .. " with " .. (farpData.buildingKilos or "nil") .. " kilos")
-            BuildableZone.New(self, zone, farpData.buildingKilos or 0, "FARP_CRATE",  self._groups, logger, database)
+            BuildableZone.New(self, zone, farpData.buildingKilos or 0, "FARP_CRATE",  self._groups, logger, database, farpData.briefing)
         end
     end
     self:Deactivate()

src/classes/stageClasses/SpecialZones/abstract/BuildableZone.lua

@@ -20,7 +20,8 @@ BuildableZone.__index = BuildableZone
 ---@param database Database
 ---@param crateType SupplyType
 ---@param logger Logger
-function BuildableZone:New(targetZone, kilosRequired, crateType,  buildableGroups, logger, database)
+---@param briefing string?
+function BuildableZone:New(targetZone, kilosRequired, crateType,  buildableGroups, logger, database, briefing)
     self._targetZone = targetZone
     self._requiredKilos = kilosRequired or 0
     self._buildableGroups = buildableGroups or {}
@@ -69,7 +70,7 @@ function BuildableZone:New(targetZone, kilosRequired, crateType,  buildableGroup
 
     local noLandingZone = self:GetNoLandingZone()
     if kilosRequired and kilosRequired > 0 then
-        self._buildableMission = BuildableMission.new(database, logger, targetZone, noLandingZone, kilosRequired, crateType)
+        self._buildableMission = BuildableMission.new(database, logger, targetZone, noLandingZone, kilosRequired, crateType, briefing)
         self._buildableMission:AddOnCrateDroppedOfListener(self)
     else
         self._buildableMission = nil

src/classes/stageClasses/missions/BuildableMission.lua

@@ -21,9 +21,18 @@ local DrawingHelper = require("classes.stageClasses.drawings.helper.DrawingHelpe
 ---@field private _dropOffZone SpearheadTriggerZone?
 ---@field private _noLandingZoneDrawing CustomDrawing?
 ---@field private _dropOffZoneDrawing CustomDrawing?
+---@field private _briefing string?
 local BuildableMission = {}
 BuildableMission.__index = BuildableMission
 
+
+local function getDefaultBriefing(siteType, coords)
+    return "We've dispatched forward units to find a proper spot for a new " .. siteType .. "." ..
+        "\nYou will need to drop off supplies so they can start building." ..
+        "\nThe coords are: " .. coords ..
+        "\n\n"
+end
+
 ---@class OnCrateDroppedListener 
 ---@field OnCrateDroppedOff fun(self:OnCrateDroppedListener, mission:BuildableMission, kilos:number)
 
@@ -33,7 +42,8 @@ BuildableMission.__index = BuildableMission
 ---@param requiredCrateType SupplyType
 ---@param noLandingZone SpearheadTriggerZone?
 ---@param logger Logger
-function BuildableMission.new(database, logger, targetZone, noLandingZone, requiredKilos, requiredCrateType)
+---@param briefing string?
+function BuildableMission.new(database, logger, targetZone, noLandingZone, requiredKilos, requiredCrateType, briefing)
 
     setmetatable(BuildableMission, Mission)
 
@@ -43,6 +53,7 @@ function BuildableMission.new(database, logger, targetZone, noLandingZone, requi
     self._database = database
     self._requiredKilos = requiredKilos
     self._droppedKilos = 0
+    self._briefing = briefing
 
     self._noLandingZone = noLandingZone
 
@@ -64,7 +75,13 @@ function BuildableMission.new(database, logger, targetZone, noLandingZone, requi
     end
 
     self.code = tostring(database:GetNewMissionCode())
-    self.name = "Resupply"
+    
+    local splitTargetZoneName = Util.split_string(targetZone.name, "_")
+    if splitTargetZoneName and #splitTargetZoneName[3] then
+        self.name = splitTargetZoneName[3]
+    else
+        self.name = "Resupply"
+    end
 
     local type = "site"
     if requiredCrateType == "SAM_CRATE" then
@@ -81,7 +98,6 @@ function BuildableMission.new(database, logger, targetZone, noLandingZone, requi
     self._supplyUnitsTracker = SupplyUnitsTracker.getOrCreate()
     self._state = "NEW"
 
-
     self.location = targetZone.location
 
     self.missionType = "LOGISTICS"
@@ -116,11 +132,16 @@ function BuildableMission:ShowBriefing(groupID)
         siteType = "airbase"
     end
 
+    local briefingPart = self._briefing
+    if briefingPart then
+        briefingPart = Util.replaceString(briefingPart, "{{coords}}", coords)
+    else
+        briefingPart = getDefaultBriefing(siteType, coords)
+    end
+
     local briefing = "Mission [" .. self.code .. "] " .. self.name .. 
         "\n \n" ..
-        "We've dispatched forward units to find a proper spot for a new " .. siteType .. "." ..
-        "\nYou will need to drop off supplies so they can start building." ..
-        "\nThe coords are: " .. coords ..
+        briefingPart ..
         "\n\n" ..
         "\nKilos still required: " .. self._requiredKilos - self._droppedKilos ..
         "\n\n" ..