moved files and added compile script

.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/$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: 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: 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

SpearheadCompile.py

@@ -2,25 +2,22 @@ import os
 import sys
 import glob
 
-
+def compileClasses(classesPath):
-def CreateReadme(): 
+    resultString = ""
-    print("TODO")
+    for name in glob.glob(f"{classesPath}/**/*.lua"):
-
+        with open(name, 'r') as file:
-def compileClasses(root):
+            resutlString += file.read()
-    for subFolder in  [ "capClasses", "stageClasses"]:
+    return resultString
-        path = os.path.join(root, subFolder)
-        for name in glob.glob(f"{path}/*.lua"):
-            with open(path, 'r') as file:
-                
 
 def compile(root, target):
+    classes = compileClasses(root)
     compiled = ""
-    for filename in Order:
+    compiled += classes
-        path = os.path.join(root, filename)
+    
-        with open(path,'r') as file:
+    mainFileName = os.path.join(root, "main.lua")
-            fileContents = file.read()
+    with open(mainFileName, 'r') as mainFile: 
-            compiled += fileContents
+        string = mainFile.read()
-        print(path)
+        compiled += string
 
     with open(target, "w") as targetFile:
         targetFile.write(compiled)

_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! <br/>
 For this example I created 2 CAP routes inside of the 2 `_1_` stages. <br/>
 
-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
+
+Now all you need to do is start the mission (single player works just fine) and see the AI fly around. <br/>
+Tip: Speeding up the simulation speed to 10x or 15x can help you see how the AI will fly and how it will behave. <br/>
+
+Well, nice, we're don setting up the initial CAP effort. <br/>
+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
+

_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"\>\<Config\>_\<Free form name\>
 ##### CAP Group Config:
 ```