Add ci builds / improve local builds

.agents/workflows/build.md

@@ -0,0 +1,41 @@
+---
+description: Build the FSMP MCM Papyrus scripts using Caprica
+---
+
+# Build FSMP MCM
+
+Compiles the Papyrus source scripts (`.psc`) into compiled Papyrus executables (`.pex`) using the Caprica compiler. This project uses in-repo stubs for all dependencies, making it easy to build without external setup.
+
+## Prerequisites
+
+- **Caprica Compiler**: `Caprica/Caprica.exe` must be present. 
+  - If missing, download version 0.3.0a from [KrisV-777/Caprica Releases](https://github.com/KrisV-777/Caprica/releases/tag/0.3.0a).
+- **PowerShell**: Used to run the build script.
+
+## Build Command
+
+1. Run the compilation script from the repository root:
+
+```powershell
+# Default Release mode (uses stubs)
+./dev-scripts/compile.ps1
+
+# Dev mode (uses your real local scripts)
+./dev-scripts/compile.ps1 -Mode Dev
+```
+
+The compiled `.pex` files will be placed in the `Scripts/` directory.
+
+## Alternative: Papyrus Project (.ppj)
+
+You can also use the `skyrimse.ppj` file with any Papyrus project runner (like `Pypro` or `Caprica` directly if your version supports it).
+
+```powershell
+./Caprica/Caprica.exe skyrimse.ppj
+```
+
+## Notes
+
+- The build script uses the `--ignorecwd` flag to prevent Caprica from auto-adding the CWD to imports, avoiding namespace conflicts.
+- It also uses `--game skyrim` for Skyrim-specific compatibility.
+- Warning `W4007` about `loadConfigDone` being unused is expected and harmless.

.github/workflows/build.yml

@@ -0,0 +1,90 @@
+name: Build FSMP MCM
+
+on:
+  push:
+    branches: [main]
+    tags:
+      - 'v*.*.*'
+      - 'v*.*'
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    runs-on: windows-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Setup CI Dependencies
+        shell: powershell
+        run: ./dev-scripts/setup_ci.ps1
+
+      - name: Compile Papyrus Scripts
+        shell: powershell
+        run: |
+          $flagsFile = Resolve-Path "Dependencies/Stubs/BaseGame/TESV_Papyrus_Flags.flg"
+          $imports = @(
+            (Resolve-Path "Source/Scripts"),
+            (Resolve-Path "Dependencies/SkyUI-Community/source/scripts"),
+            (Resolve-Path "Dependencies/Stubs/BaseGame"),
+            (Resolve-Path "Dependencies/Stubs/SKSE"),
+            (Resolve-Path "Dependencies/Stubs/JContainers"),
+            (Resolve-Path "Dependencies/Stubs/PapyrusUtil"),
+            (Resolve-Path "Dependencies/Stubs/ConsoleUtil")
+          ) -join ";"
+          if (-not (Test-Path "Scripts")) { New-Item -ItemType Directory -Path "Scripts" }
+          Remove-Item "Scripts/*.pex" -ErrorAction SilentlyContinue
+          $output = Resolve-Path "Scripts"
+
+          # Compile FSMPM.psc
+          $fsmpm = Resolve-Path "Source/Scripts/FSMPM.psc"
+          & ./ci_tools/Caprica.exe --game skyrim --flags "$flagsFile" --import "$imports" --output "$output" --ignorecwd "$fsmpm"
+          if ($LASTEXITCODE -ne 0) { throw "FSMPM.psc compilation failed" }
+
+          # Compile FSMPMPlayerScript.psc
+          $player = Resolve-Path "Source/Scripts/FSMPMPlayerScript.psc"
+          & ./ci_tools/Caprica.exe --game skyrim --flags "$flagsFile" --import "$imports" --output "$output" --ignorecwd "$player"
+          if ($LASTEXITCODE -ne 0) { throw "FSMPMPlayerScript.psc compilation failed" }
+
+          Write-Host "All scripts compiled successfully."
+          Get-ChildItem Scripts/*.pex | ForEach-Object { Write-Host "  $($_.Name) - $($_.Length) bytes" }
+
+      - name: Package Distributable
+        shell: powershell
+        run: |
+          $buildDir = "Build/FSMPM - The FSMP MCM"
+          if (Test-Path "Build") { Remove-Item -Recurse -Force "Build" }
+          New-Item -ItemType Directory -Path "$buildDir/Scripts" -Force
+          New-Item -ItemType Directory -Path "$buildDir/SKSE/Plugins/hdtSkinnedMeshConfigs/configsPresets" -Force
+          New-Item -ItemType Directory -Path "$buildDir/Source/Scripts" -Force
+
+          Copy-Item "FSMPM - The FSMP MCM.esp" $buildDir/
+          Copy-Item Scripts/*.pex "$buildDir/Scripts/"
+          Copy-Item SKSE/Plugins/hdtSkinnedMeshConfigs/configs.xml "$buildDir/SKSE/Plugins/hdtSkinnedMeshConfigs/"
+          Copy-Item SKSE/Plugins/hdtSkinnedMeshConfigs/configsPresets/*.xml "$buildDir/SKSE/Plugins/hdtSkinnedMeshConfigs/configsPresets/"
+          Copy-Item Source/Scripts/*.psc "$buildDir/Source/Scripts/"
+
+          Compress-Archive -Path "$buildDir/*" -DestinationPath "Build/FSMP-MCM.zip" -Force
+          Write-Host "Distributable archive created: Build/FSMP-MCM.zip"
+
+      - name: Upload Build Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: FSMP-MCM
+          path: Build/FSMP-MCM.zip
+
+      - name: Publish GitHub Release
+        if: startsWith(github.ref, 'refs/tags/v')
+        uses: softprops/action-gh-release@v2
+        with:
+          files: Build/FSMP-MCM.zip
+          name: FSMP-MCM ${{ github.ref_name }}
+          draft: false
+          prerelease: false

.gitignore

@@ -0,0 +1,11 @@
+# Build artifacts
+Build/
+
+# Local configuration
+Caprica/Caprica.exe
+skyrimse.dev.ppj
+
+
+# OS generated files
+.DS_Store
+Thumbs.db

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "Dependencies/SkyUI-Community"]
+	path = Dependencies/SkyUI-Community
+	url = https://github.com/doodlum/SkyUI-Community.git

.vscode/tasks.json

@@ -2,17 +2,43 @@
     "version": "2.0.0",
     "tasks": [
         {
-            "type": "pyro",
-            "projectFile": "skyrimse.ppj",
-            "gamePath": "C:\\Games\\Nolvus\\Instances\\Nolvus Natural Lighting\\STOCK GAME\\",
-            "problemMatcher": [
-                "$PapyrusCompiler"
+            "label": "Build: Dev (Local Project)",
+            "type": "shell",
+            "command": "pwsh",
+            "args": [
+                "-ExecutionPolicy",
+                "Bypass",
+                "-File",
+                "${workspaceFolder}/dev-scripts/compile.ps1",
+                "Dev"
             ],
-            "label": "pyro: Compile Project (skyrimse.ppj)",
             "group": {
                 "kind": "build",
                 "isDefault": true
-            }
+            },
+            "presentation": {
+                "reveal": "always",
+                "panel": "new"
+            },
+            "problemMatcher": "$PapyrusCompiler"
+        },
+        {
+            "label": "Build: Release (CI Stubs)",
+            "type": "shell",
+            "command": "pwsh",
+            "args": [
+                "-ExecutionPolicy",
+                "Bypass",
+                "-File",
+                "${workspaceFolder}/dev-scripts/compile.ps1",
+                "Release"
+            ],
+            "group": "build",
+            "presentation": {
+                "reveal": "always",
+                "panel": "new"
+            },
+            "problemMatcher": "$PapyrusCompiler"
         }
     ]
 }

Dependencies/Stubs/BaseGame/Actor.psc

@@ -0,0 +1,8 @@
+; Minimal stub for CI builds
+Scriptname Actor extends ObjectReference Hidden
+
+Function AddToFaction(Faction akFaction) native
+Function RemoveFromFaction(Faction akFaction) native
+Function StopCombat() native
+Function EvaluatePackage() native
+Function Kill(Actor akKiller = None) native

Dependencies/Stubs/BaseGame/Alias.psc

@@ -0,0 +1,49 @@
+; Minimal stub for CI builds
+Scriptname Alias Hidden
+
+Quest Function GetOwningQuest() native
+bool Function RegisterForAnimationEvent(ObjectReference akSender, string asEventName) native
+Function RegisterForLOS(Actor akViewer, ObjectReference akTarget) native
+Function RegisterForSingleLOSGain(Actor akViewer, ObjectReference akTarget) native
+Function RegisterForSingleLOSLost(Actor akViewer, ObjectReference akTarget) native
+Function RegisterForSingleUpdate(float afInterval) native
+Function RegisterForUpdate(float afInterval) native
+Function RegisterForUpdateGameTime(float afInterval) native
+Function RegisterForSingleUpdateGameTime(float afInterval) native
+Function RegisterForSleep() native
+Function RegisterForTrackedStatsEvent() native
+Function StartObjectProfiling() native
+Function StopObjectProfiling() native
+Function UnregisterForLOS(Actor akViewer, ObjectReference akTarget) native
+Function UnregisterForAnimationEvent(ObjectReference akSender, string asEventName) native
+Function UnregisterForSleep() native
+Function UnregisterForTrackedStatsEvent() native
+Function UnregisterForUpdate() native
+Function UnregisterForUpdateGameTime() native
+
+Event OnAnimationEvent(ObjectReference akSource, string asEventName)
+EndEvent
+
+Event OnAnimationEventUnregistered(ObjectReference akSource, string asEventName)
+EndEvent
+
+Event OnGainLOS(Actor akViewer, ObjectReference akTarget)
+EndEvent
+
+Event OnLostLOS(Actor akViewer, ObjectReference akTarget)
+EndEvent
+
+Event OnSleepStart(float afSleepStartTime, float afDesiredSleepEndTime)
+EndEvent
+
+Event OnSleepStop(bool abInterrupted)
+EndEvent
+
+Event OnTrackedStatsEvent(string arStatName, int aiStatValue)
+EndEvent
+
+Event OnUpdate()
+EndEvent
+
+Event OnUpdateGameTime()
+EndEvent

Dependencies/Stubs/BaseGame/Debug.psc

@@ -0,0 +1,8 @@
+; Minimal stub for CI builds
+Scriptname Debug Hidden
+
+Function MessageBox(string asMessageBoxText) native global
+Function Notification(string asNotificationText) native global
+Function Trace(string asTextToPrint, int aiSeverity = 0) native global
+Function TraceStack(string asTextToPrint = "Tracing stack on request", int aiSeverity = 0) native global
+bool Function TraceUser(string asUserLog, string asTextToPrint, int aiSeverity = 0) native global

Dependencies/Stubs/BaseGame/Faction.psc

@@ -0,0 +1,2 @@
+; Minimal forward-declaration stub for CI builds
+Scriptname Faction extends Form Hidden

Dependencies/Stubs/BaseGame/Form.psc

@@ -0,0 +1,58 @@
+; Minimal stub for CI builds - provides the base Form class
+; This is an interface-only file for compilation purposes
+Scriptname Form Hidden
+
+Int Function GetFormID() native
+int Function GetGoldValue() native
+bool Function HasKeyword(Keyword akKeyword) native
+bool Function PlayerKnows() native
+bool Function RegisterForAnimationEvent(ObjectReference akSender, string asEventName) native
+Function RegisterForLOS(Actor akViewer, ObjectReference akTarget) native
+Function RegisterForSingleLOSGain(Actor akViewer, ObjectReference akTarget) native
+Function RegisterForSingleLOSLost(Actor akViewer, ObjectReference akTarget) native
+Function RegisterForSingleUpdate(float afInterval) native
+Function RegisterForSleep() native
+Function RegisterForTrackedStatsEvent() native
+Function RegisterForUpdate(float afInterval) native
+Function RegisterForUpdateGameTime(float afInterval) native
+Function RegisterForSingleUpdateGameTime(float afInterval) native
+Function StartObjectProfiling() native
+Function StopObjectProfiling() native
+Function UnregisterForAnimationEvent(ObjectReference akSender, string asEventName) native
+Function UnregisterForLOS(Actor akViewer, ObjectReference akTarget) native
+Function UnregisterForSleep() native
+Function UnregisterForTrackedStatsEvent() native
+Function UnregisterForUpdate() native
+Function UnregisterForUpdateGameTime() native
+
+; SKSE additions
+Function RegisterForModEvent(string eventName, string callbackName) native
+Function UnregisterForModEvent(string eventName) native
+Function SendModEvent(string eventName, string strArg = "", float numArg = 0.0) native
+
+Event OnAnimationEvent(ObjectReference akSource, string asEventName)
+EndEvent
+
+Event OnAnimationEventUnregistered(ObjectReference akSource, string asEventName)
+EndEvent
+
+Event OnGainLOS(Actor akViewer, ObjectReference akTarget)
+EndEvent
+
+Event OnLostLOS(Actor akViewer, ObjectReference akTarget)
+EndEvent
+
+Event OnSleepStart(float afSleepStartTime, float afDesiredSleepEndTime)
+EndEvent
+
+Event OnSleepStop(bool abInterrupted)
+EndEvent
+
+Event OnTrackedStatsEvent(string arStatName, int aiStatValue)
+EndEvent
+
+Event OnUpdate()
+EndEvent
+
+Event OnUpdateGameTime()
+EndEvent

Dependencies/Stubs/BaseGame/GlobalVariable.psc

@@ -0,0 +1,6 @@
+; Minimal forward-declaration stub for CI builds
+Scriptname GlobalVariable extends Form Hidden
+
+Function SetValue(float afNewValue) native
+float Function GetValue() native
+float Function Mod(float afHowMuch) native

Dependencies/Stubs/BaseGame/Keyword.psc

@@ -0,0 +1,2 @@
+; Minimal forward-declaration stub for CI builds
+Scriptname Keyword extends Form Hidden

Dependencies/Stubs/BaseGame/ObjectReference.psc

@@ -0,0 +1,15 @@
+; Minimal stub for CI builds
+Scriptname ObjectReference extends Form Hidden
+
+Function Disable(bool abFadOut = false) native
+Function DisableNoWait(bool abFadOut = false) native
+Function Enable(bool abFadIn = false) native
+Function EnableNoWait(bool abFadIn = false) native
+Function MoveTo(ObjectReference akTarget, float afXOffset = 0.0, float afYOffset = 0.0, float afZOffset = 0.0, bool abMatchRotation = true) native
+Function Reset() native
+
+Event OnActivate(ObjectReference akActionRef)
+EndEvent
+
+Event OnInit()
+EndEvent

Dependencies/Stubs/BaseGame/Quest.psc

@@ -0,0 +1,39 @@
+; Minimal stub for CI builds
+Scriptname Quest extends Form Hidden
+
+Function CompleteAllObjectives() native
+Function CompleteQuest() native
+Function FailAllObjectives() native
+Alias Function GetAlias(int aiAliasID) native
+int Function GetCurrentStageID() native
+bool Function IsActive() native
+bool Function IsCompleted() native
+bool Function IsObjectiveCompleted(int aiObjective) native
+bool Function IsObjectiveDisplayed(int aiObjective) native
+bool Function IsObjectiveFailed(int aiObjective) native
+bool Function IsRunning() native
+bool Function IsStageDone(int aiStage) native
+bool Function IsStarting() native
+bool Function IsStopping() native
+bool Function IsStopped() native
+Function Reset() native
+Function SetActive(bool abActive = true) native
+bool Function SetCurrentStageID(int aiStageID) native
+Function SetObjectiveCompleted(int aiObjective, bool abCompleted = true) native
+Function SetObjectiveDisplayed(int aiObjective, bool abDisplayed = true, bool abForce = false) native
+Function SetObjectiveFailed(int aiObjective, bool abFailed = true) native
+bool Function Start() native
+Function Stop() native
+bool Function UpdateCurrentInstanceGlobal(GlobalVariable aUpdateGlobal) native
+
+int Function GetStage()
+  return GetCurrentStageID()
+EndFunction
+
+bool Function GetStageDone(int aiStage)
+  return IsStageDone(aiStage)
+EndFunction
+
+bool Function SetStage(int aiStage)
+  return SetCurrentStageID(aiStage)
+EndFunction