Develop (#16)

* Initial Methods for SpearheadAPI * Added Spearhead API * Added Spearhead API * fixed compile for api * Added notes for API in beta * Added notes for API in beta * Added Menu to all doc pages * Added Menu to all doc pages * added it for real * added it for real * fixed develop * fixed develop * fixed develop * wip * wip * updated * work in progress * work in progress * added empty docs page * wip * removed SAR files from persistence branch * Added Blue Sams as seperate class * added initial persistance * added initial persistance * added initial persistance * added initial persistance * added initial persistance * added menu to persistence markdown * added menu to persistence markdown * added menu to persistence markdown * docs update * wip * wip * Refactor of Stage classes. * wip * wip * wip * reworked bluesam and stagebase * Added waiting stage functionality * updated docs * wip * wip * wip * updated * wip * wip * wip * refactored without issues, needs testing --------- Co-authored-by: Dutchie <54616262+dutchie032@users.noreply.github.com> Co-authored-by: dutchie032 <dutchie032> Co-authored-by: ex61wi <tim.rorije@ing.com>
2025-04-22 14:39:22 +02:00
parent 9c6a5ed217
commit ff392e0e7e
37 changed files with 4494 additions and 1732 deletions
@@ -1,28 +1,47 @@


-local basePath = "C:\\Repos\\DCS\\Spearhead\\classes\\"

-assert(loadfile(basePath .. "config.lua"))()
+--assert(loadfile("C:\\Repos\\DCS\\Spearhead\\dev\\dev_classes.lua"))()

-assert(loadfile(basePath .. "spearhead_base.lua"))()
-assert(loadfile(basePath .. "spearhead_routeutil.lua"))()
-assert(loadfile(basePath .. "spearhead_events.lua"))()
-assert(loadfile(basePath .. "spearhead_db.lua"))()
+local basePath = "C:\\Repos\\DCS\\Spearhead\\"
+local classPath = basePath .. "classes\\"

-assert(loadfile(basePath .. "fleetClasses\\FleetGroup.lua"))()
-assert(loadfile(basePath .. "fleetClasses\\GlobalFleetManager.lua"))()
+assert(loadfile(classPath .. "spearhead_base.lua"))()
+assert(loadfile(classPath .. "spearhead_routeutil.lua"))()
+assert(loadfile(classPath .. "spearhead_events.lua"))()
+assert(loadfile(classPath .. "spearhead_db.lua"))()

-assert(loadfile(basePath .. "configuration\\CapConfig.lua"))()
-assert(loadfile(basePath .. "configuration\\StageConfig.lua"))()
+assert(loadfile(classPath .. "fleetClasses\\FleetGroup.lua"))()
+assert(loadfile(classPath .. "fleetClasses\\GlobalFleetManager.lua"))()

-assert(loadfile(basePath .. "stageClasses\\GlobalStageManager.lua"))()
-assert(loadfile(basePath .. "stageClasses\\Mission.lua"))()
-assert(loadfile(basePath .. "stageClasses\\Stage.lua"))()
+assert(loadfile(classPath .. "configuration\\CapConfig.lua"))()
+assert(loadfile(classPath .. "configuration\\StageConfig.lua"))()

-assert(loadfile(basePath .. "capClasses\\CapGroup.lua"))()
-assert(loadfile(basePath .. "capClasses\\GlobalCapManager.lua"))()
-assert(loadfile(basePath .. "capClasses\\CapAirbase.lua"))()
+assert(loadfile(classPath .. "stageClasses\\GlobalStageManager.lua"))()
+assert(loadfile(classPath .. "stageClasses\\Missions\\Mission.lua"))()
+
+assert(loadfile(classPath .. "stageClasses\\Stages\\BaseStage\\Stage.lua"))()
+assert(loadfile(classPath .. "stageClasses\\Stages\\PrimaryStage.lua"))()
+assert(loadfile(classPath .. "stageClasses\\Stages\\ExtraStage.lua"))()
+assert(loadfile(classPath .. "stageClasses\\Stages\\WaitingStage.lua"))()
+
+
+assert(loadfile(classPath .. "stageClasses\\Groups\\SpearheadGroup.lua"))()
+
+assert(loadfile(classPath .. "stageClasses\\helpers\\MissionCommandsHelper.lua"))()
+
+assert(loadfile(classPath .. "stageClasses\\SpecialZones\\StageBase.lua"))()
+assert(loadfile(classPath .. "stageClasses\\SpecialZones\\BlueSam.lua"))()
+
+assert(loadfile(classPath .. "capClasses\\CapGroup.lua"))()
+assert(loadfile(classPath .. "capClasses\\GlobalCapManager.lua"))()
+assert(loadfile(classPath .. "capClasses\\CapAirbase.lua"))()
+
+assert(loadfile(classPath .. "persistence\\Persistence.lua"))()

 -- Startup: 

-assert(loadfile(basePath .. "main.lua"))()
+
+
+assert(loadfile(basePath .. "main.lua"))()
+
@@ -0,0 +1,76 @@
+
+SpearheadConfig = {
+
+    CapConfig = {
+        --quickly enable of disable the entire CAP Logic 
+        --(you can also just rename all units to not be named "CAP_")
+        enabled = true, -- default true
+        
+        --min ground speed for CAP aircraft during patrol
+        -- unit: knots
+        minSpeed = 400, -- default 400
+
+        --max speed for CAP aircraft during patrol
+        -- unit: knots
+        maxSpeed = 500, -- default 500
+
+        --minAlt for aircraft on patrol
+        -- unit: feet
+        minAlt = 18000, -- default 18000
+
+        --maxAlt for aircraft on patrol
+        -- unit: feet
+        maxAlt = 28000, -- default 28000
+
+        --Delay for aircraft from touchdown to off the chocks.
+        -- unit: seconds
+        rearmDelay = 600, -- default 600
+
+        --Delay for aircraft from death to takeoff.
+        --When the seconds remaining is the same at the rearmDelay it will be spawned on the ramp and follow the rearm logic.
+        -- !! Can not be lower than rearmDelay
+        -- unit: seconds
+        deathDelay = 1800, -- default 1800
+    },
+    StageConfig = {
+        
+        -- management of stages and its missions. 
+        -- This is not related to CAP managers which will continue to work even if stage management is disabled
+        enabled = true, -- default true
+
+        --Will draw the active and the next stage 
+        drawStages = true, -- default true
+
+        --AutoStages will continue to the next stage automatically on completion of the missions within the stage. 
+        -- If you want to make it so the next stage triggers only when you want to disable it here and manually implement the actions needed.
+        --[[
+            TODO: Add manual stage transition documentation
+        ]]
+        autoStages = true, --default true
+
+        --Maximum missions per stage (includes all types of missions)
+        maxMissionStage = 10,
+
+        --Stage starting number
+        startingStage = 1,
+
+        ---DEBUG logging. Consider keeping this disabled
+        debugEnabled = true
+    },
+    Persistence = {
+        --- io and lfs cannot be sanitized in the MissionScripting.lua
+        
+        --- enables or disables the persistence logic in spearhead
+        enabled = false,
+
+        --- sets the directory where the persistence file is stored
+        --- if nil then lfs.writedir() will be used. 
+        --- which will 
+        directory = nil ,
+
+        --- the filename of the persistence file. Should end with .json for convention, but any text extension should do.
+        fileName = "Spearhead_Persistence.json"
+
+    }
+}
+