diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 1393e88..1435204 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -7,7 +7,7 @@ on: - main jobs: - pushdoc: + buildandpush: name: push_file runs-on: ubuntu-latest env: @@ -38,9 +38,10 @@ jobs: - name: mkdir run: mkdir -p ./$repo/Spearhead - run: npm i markdown-to-html-cli -g - - run: markdown-to-html --title 'Spearhead' --dark-mode auto --keywords "dcs,spearhead,tdcs,mission,campaign,tactical dcs,tactical" --no-dark-mode --markdown-style-theme dark --source ./spearhead/docs/$sourcefileA.md --output ./$repo/Spearhead/$sourcefileA.html - - run: markdown-to-html --title 'Spearhead' --dark-mode auto --keywords "dcs,spearhead,tdcs,mission,campaign,tactical dcs,tactical" --no-dark-mode --markdown-style-theme dark --source ./spearhead/docs/$sourcefileB.md --output ./$repo/Spearhead/$sourcefileB.html - - run: cp -a ./spearhead/docs/img/. ./$repo/Spearhead/img/ + - run: markdown-to-html --title 'Spearhead' --dark-mode auto --keywords "dcs,spearhead,tdcs,mission,campaign,tactical dcs,tactical" --no-dark-mode --markdown-style-theme dark --source ./spearhead/_docs/$sourcefileA.md --output ./$repo/Spearhead/$sourcefileA.html + - run: markdown-to-html --title 'Spearhead' --dark-mode auto --keywords "dcs,spearhead,tdcs,mission,campaign,tactical dcs,tactical" --no-dark-mode --markdown-style-theme dark --source ./spearhead/_docs/$sourcefileB.md --output ./$repo/Spearhead/$sourcefileB.html + - run: python3 ./spearhead/SpearheadCompile.py "./spearhead" "./$repo/Spearhead/spearhead.lua" + - run: cp -a ./spearhead/_docs/img/. ./$repo/Spearhead/img/ - name: ls run: ls working-directory: ./dutchie032.github.io diff --git a/SpearheadCompile.py b/SpearheadCompile.py index 384fb46..e93cc4e 100644 --- a/SpearheadCompile.py +++ b/SpearheadCompile.py @@ -2,29 +2,26 @@ import os import sys import glob - -def CreateReadme(): - print("TODO") - -def compileClasses(root): - for subFolder in [ "capClasses", "stageClasses"]: - path = os.path.join(root, subFolder) - for name in glob.glob(f"{path}/*.lua"): - with open(path, 'r') as file: - +def compileClasses(classesPath): + resultString = "" + for name in glob.glob(f"{classesPath}/**/*.lua"): + with open(name, 'r') as file: + resutlString += file.read() + return resultString def compile(root, target): + classes = compileClasses(root) compiled = "" - for filename in Order: - path = os.path.join(root, filename) - with open(path,'r') as file: - fileContents = file.read() - compiled += fileContents - print(path) + compiled += classes + + mainFileName = os.path.join(root, "main.lua") + with open(mainFileName, 'r') as mainFile: + string = mainFile.read() + compiled += string with open(target, "w") as targetFile: targetFile.write(compiled) - + if __name__ == "__main__" : args = sys.argv[1:] diff --git a/docs/GetStarted.md b/_docs/GetStarted.md similarity index 85% rename from docs/GetStarted.md rename to _docs/GetStarted.md index 033a12d..7013450 100644 --- a/docs/GetStarted.md +++ b/_docs/GetStarted.md @@ -67,8 +67,16 @@ If no CAP route is present the unit will fly a route generated differently per z If you want to create you own CAP Routes you can!
For this example I created 2 CAP routes inside of the 2 `_1_` stages.
-As you can see below there's a nice quick you can exploit. As long as the `X` of the zone is inside of the the `CAPROUTE` will be used! +As you can see below there's a nice feature you can exploit. As long as the `X` of the zone is inside of the the `CAPROUTE` will be used for that stage! ![CAP Routes Image](./img/cap_routes.png) -## Setting up the missions \ No newline at end of file + +Now all you need to do is start the mission (single player works just fine) and see the AI fly around.
+Tip: Speeding up the simulation speed to 10x or 15x can help you see how the AI will fly and how it will behave.
+ +Well, nice, we're don setting up the initial CAP effort.
+If you want to change values for the CAP routes please read about how to configure it here: [Cap Config](./Reference.html#cap-config) + +## Setting up the Missions + diff --git a/docs/Reference.md b/_docs/Reference.md similarity index 99% rename from docs/Reference.md rename to _docs/Reference.md index fc93fa9..b468aa2 100644 --- a/docs/Reference.md +++ b/_docs/Reference.md @@ -124,6 +124,13 @@ If a zone is empty it will not be briefed, activated or count towards completion ### CAP + +#### CAP Config: + +--[[ + TODO: CAP CONFIG +]] + Naming: CAP\_\<"A" | B"\>\_\ ##### CAP Group Config: ``` diff --git a/docs/img/cap_routes.png b/_docs/img/cap_routes.png similarity index 100% rename from docs/img/cap_routes.png rename to _docs/img/cap_routes.png diff --git a/docs/img/starting_stages.png b/_docs/img/starting_stages.png similarity index 100% rename from docs/img/starting_stages.png rename to _docs/img/starting_stages.png diff --git a/capClasses/CapAirbase.lua b/classes/capClasses/CapAirbase.lua similarity index 100% rename from capClasses/CapAirbase.lua rename to classes/capClasses/CapAirbase.lua diff --git a/capClasses/CapGroup.lua b/classes/capClasses/CapGroup.lua similarity index 100% rename from capClasses/CapGroup.lua rename to classes/capClasses/CapGroup.lua diff --git a/capClasses/GlobalCapManager.lua b/classes/capClasses/GlobalCapManager.lua similarity index 100% rename from capClasses/GlobalCapManager.lua rename to classes/capClasses/GlobalCapManager.lua diff --git a/spearhead_base.lua b/classes/spearhead_base.lua similarity index 100% rename from spearhead_base.lua rename to classes/spearhead_base.lua diff --git a/spearhead_db.lua b/classes/spearhead_db.lua similarity index 100% rename from spearhead_db.lua rename to classes/spearhead_db.lua diff --git a/stageClasses/GlobalStageManager.lua b/classes/stageClasses/GlobalStageManager.lua similarity index 100% rename from stageClasses/GlobalStageManager.lua rename to classes/stageClasses/GlobalStageManager.lua diff --git a/stageClasses/Mission.lua b/classes/stageClasses/Mission.lua similarity index 100% rename from stageClasses/Mission.lua rename to classes/stageClasses/Mission.lua diff --git a/stageClasses/Stage.lua b/classes/stageClasses/Stage.lua similarity index 100% rename from stageClasses/Stage.lua rename to classes/stageClasses/Stage.lua diff --git a/spearhead.lua b/main.lua similarity index 100% rename from spearhead.lua rename to main.lua