build.ps1

<#
.SYNOPSIS
    Pulls in assets from the skyrim Data Folder to create the 7z Skyrim SE mod package.
.DESCRIPTION
    Pulls in assets from the skyrim Data Folder to create the 7z Skyrim SE mod package.
.PARAMETER ConfigFile
    The path to the buildConfig.json used to build this mod
.PARAMETER SkipReadme
    Skips generating the txt and bbcode readme from MD.
.EXAMPLE
    PS C:\> <example usage>
    Explanation of what the example does
.INPUTS
    None
.OUTPUTS
    None
.NOTES
    Copyright 2021 Mark E. Kraus
#>
[CmdletBinding()]
param (
    [Parameter(
        Position=0,
        ValueFromPipelineByPropertyName=$true)]
    [ValidateNotNullOrEmpty()]
    [string]
    $ConfigFile =
    $(
        if (![string]::IsNullOrWhitespace($PSScriptRoot)) {
            Join-Path $PSScriptRoot "buildConfig.json"
        }
        else {
            Join-Path $pwd.Path "buildConfig.json"
        }
    ),
    [Parameter()]
    [switch]
    $SkipReadme
)
$StartTime = [datetime]::UtcNow
Write-Host ("Build started {0} UTC" -f $StartTime)
Write-Host " "

$7zFiles = [System.Collections.Generic.List[string]]::New()
$BsaFiles = [System.Collections.Generic.List[string]]::New()

$BasePath = Split-Path $ConfigFile
Push-Location $BasePath

$FomodBasePath = Join-Path $BasePath "fomod"
$FomodInfoFile = Join-Path $FomodBasePath "info.xml"
$FomodModuleConfigFile = Join-Path $FomodBasePath "ModuleConfig.xml"

$Config = Get-Content -Path $ConfigFile | ConvertFrom-Json -Depth 10
$ModInfo = $Config.ModInfo
if([string]::IsNullOrWhiteSpace($Config.'$schema')) {
    Write-Error "config file is missing '`$schema'"
    exit 1
}
$Schema = (Invoke-WebRequest $Config.'$schema').Content
$SchemaIsValid = Get-Content -Path $ConfigFile -Raw | Test-Json -Schema $Schema
if(!$SchemaIsValid) {
    Write-Error "Invalid JSON Schema."
    exit 1
}

$SkyrimInstallPath = $Config.SkyrimSEInstallPath
$SkyrimDataPath = Join-Path $SkyrimInstallPath 'Data'
$SkyrimScriptPath = Join-Path $SkyrimDataPath 'scripts'
$SkyrimScriptSourcePath = Join-Path $SkyrimDataPath -ChildPath 'source' -AdditionalChildPath 'scripts'

$OutputScriptPath = Join-Path $BasePath 'scripts'
$OutputScriptSourcePath = Join-Path $BasePath -ChildPath 'source' -AdditionalChildPath 'scripts'

$ArchivePath = Join-Path $SkyrimInstallPath 'tools' 'archive','archive.exe'
$FuzExtractorPath = Join-Path $Config.UnfuzerPath "Fuz_extractor.exe"
$XWmaEncodePath = Join-Path $Config.UnfuzerPath "xWMAEncode.exe"
$XWmaEncodeCmd = Get-Command $XWmaEncodePath

$Plugin = $Config.Plugin
$PluginPath = Join-Path $SkyrimDataPath $Plugin
$BsaName = [System.IO.Path]::GetFileNameWithoutExtension($Plugin) + '.bsa'
$BsaPath = Join-Path $SkyrimDataPath $BsaName

$VoiceBasePath = Join-Path $SkyrimDataPath 'Sound' 'Voice',$Plugin
$MeshesBasePath = Join-Path $SkyrimDataPath 'Meshes'
$FaceGenMeshPath = Join-Path $SkyrimDataPath 'Meshes' 'Actors','character','FaceGenData','FaceGeom',$Plugin
$FaceGenTexturePath = Join-Path $SkyrimDataPath 'Textures' 'Actors','character','FaceGenData','FaceTint',$Plugin

$SkyrimSeqPath = Join-Path $SkyrimDataPath 'Seq'

Write-Host @"

BasePath:               $BasePath
OutputScriptPath:       $OutputScriptPath
OutputScriptSourcePath: $OutputScriptSourcePath
FomodBasePath:          $FomodBasePath
FomodInfoFile:          $FomodInfoFile
FomodModuleConfigFile:  $FomodModuleConfigFile
SkyrimInstallPath:      $SkyrimInstallPath
SkyrimDataPath:         $SkyrimDataPath
SkyrimScriptPath:       $SkyrimScriptPath
SkyrimScriptSourcePath: $SkyrimScriptSourcePath
SkyrimSeqPath:          $SkyrimSeqPath
ArchivePath:            $ArchivePath
MeshesBasePath:         $MeshesBasePath
VoiceBasePath:          $VoiceBasePath
FaceGenMeshPath:        $FaceGenMeshPath
FaceGenTexturePath:     $FaceGenTexturePath
FuzExtractorPath:       $FuzExtractorPath
XWmaEncodePath:         $XWmaEncodePath
PluginPath:             $PluginPath
BsaPath:                $BsaPath
BsaName:                $BsaName

"@

$null = New-Item -ItemType Directory -Path $OutputScriptPath -Force
$null = New-Item -ItemType Directory -Path $OutputScriptSourcePath -Force

$PluginXmlTemplate = @'

                        <plugin name="{0}">
                            <description>{1}</description>
                            <image path="{2}" />
                            <files>
                                <file source="{3}" destination="{3}" priority="0" />
                                <file source="{4}" destination="{4}" priority="0" />
                            </files>
                            <typeDescriptor>
                                <type name="Optional"/>
                            </typeDescriptor>
                        </plugin>
'@

$PluginPartXml = ""
if(Test-Path -Path $PluginPath){
    $7zFiles.Add($Plugin)
    Write-Host "Copying $PluginPath"
    Copy-Item -Path $PluginPath -Destination $BasePath -Force
    $PluginPartXml = $PluginPartXml + ($PluginXmlTemplate -f @(
        $Plugin
        $ModInfo.Description
        $ModInfo.Logo
        $Plugin
        $BsaName
    ))
}


$ScriptSourceXmlTemplate = @'

                                <file source="source\scripts\{0}" destination="source\scripts\{0}" priority="0" />
'@
$ScriptsXmlPart=""
foreach ($papyrusScript in $Config.Scripts) {
    $pexFile = $papyrusScript + ".pex"
    $pscFile = $papyrusScript + ".psc"
    $PapyrusScriptPath = Join-Path $SkyrimScriptPath $pexFile
    $PapyrusScriptSourcePath = Join-Path $SkyrimScriptSourcePath $pscFile
    if(Test-Path -Path $PapyrusScriptPath){
        $BsaFiles.Add("scripts\" + $pexFile)
        Write-Host "Copying $PapyrusScriptPath"
        Copy-Item -Path $PapyrusScriptPath -Destination $OutputScriptPath -Force
        $ScriptsXmlPart += $ScriptXmlTemplate -f $pexFile
    }
    else {
        Write-Error "Unable to find script '$PapyrusScriptPath'"
    }
    if(Test-Path -Path $PapyrusScriptSourcePath){
        $7zFiles.Add("source\scripts\" + $pscFile)
        Write-Host "Copying $PapyrusScriptSourcePath"
        Copy-Item -Path $PapyrusScriptSourcePath -Destination $OutputScriptSourcePath -Force
        $ScriptsXmlPart += $ScriptSourceXmlTemplate -f $pscFile
    }
    else {
        Write-Warning "Unable to find script source '$PapyrusScriptSourcePath'"
    }
}

$InfoXml = @'
<fomod>
    <Name>{0}</Name>
    <Author>{1}</Author>
    <Version>{2}</Version>
    <Website>{3}</Website>
    <Description>{4}</Description>
    <Groups>
        <element>{5}</element>
    </Groups>
</fomod>
'@ -f @(
    $ModInfo.Name
    $ModInfo.Author
    $ModInfo.Version
    $ModInfo.Website
    $ModInfo.Description
    $ModInfo.Category
)

$Null = New-Item -ItemType Directory -Path $FomodBasePath -Force
$InfoXml | Set-Content -Encoding utf8NoBOM -Path $FomodInfoFile



$ModuleConfigXML = @'
<!-- Created with build.ps1 by Mark E. Kraus --> 
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://qconsulting.ca/fo3/ModConfig5.0.xsd"> 
    <moduleName>{0}</moduleName> 
    <installSteps order="Explicit"> 
        <installStep name="Install"> 
            <optionalFileGroups order="Explicit"> 
                <group name="Main" type="SelectExactlyOne"> 
                    <plugins order="Explicit">{1}
                    </plugins> 
                </group> 
                <group name="Install Script Sources?" type="SelectExactlyOne"> 
                    <plugins order="Explicit"> 
                        <plugin name="No (Default)"> 
                            <description>Skips installing script sources.</description>
                            <image path="{2}" />
                            <files></files>
                        <typeDescriptor> 
                            <type name="Optional"/> 
                        </typeDescriptor> 
                        </plugin>
                        <plugin name="Yes (For Mod Developers)"> 
                            <description>Installs script sources.</description>
                            <image path="{2}" />
                            <files>{3}
                            </files>
                            <typeDescriptor> 
                                <type name="Optional"/> 
                            </typeDescriptor> 
                        </plugin> 
                    </plugins> 
                </group> 
            </optionalFileGroups> 
        </installStep> 
    </installSteps> 
</config>
'@ -f @(
    $ModInfo.Name
    $PluginPartXml
    $ModInfo.Logo
    $ScriptsXmlPart
)

Write-Host @'
Converting Fuzzing Voice and Lip Files...

'@
if(Test-Path $VoiceBasePath) {
    Push-Location $VoiceBasePath
    foreach ($WavFile in (Get-ChildItem -Recurse -Filter '*.wav')) {
        $DataRelativeVoiceFolder = [Io.Path]::GetRelativePath($SkyrimDataPath, $WavFile.Directory)
        $LocalVoiceFolder = [Io.Path]::Combine($BasePath, $DataRelativeVoiceFolder)
        Push-Location $WavFile.Directory
        Write-Host ([Io.Path]::GetRelativePath($VoiceBasePath, $WavFile))
        $XWmaFile = $WavFile.BaseName + '.xwm'
        $LipFile = $WavFile.BaseName + '.lip'
        $FuzFile = $WavFile.BaseName + '.fuz'
        $HashFile = $WavFile.BaseName + '.hash'
        $currentHash = (Get-FileHash $WavFile -Algorithm SHA256).Hash
        if ((Test-Path $HashFile) -and (Test-Path $FuzFile)) {
            $oldHash = Get-Content $HashFile -TotalCount 1
            if ($currentHash -eq $oldHash) {
                Write-Host "No change. Skipping..."
                Pop-Location
                continue
            }
        }
        else {
            $currentHash | Set-Content -Path $HashFile -Encoding utf8BOM -NoNewline
        }
        $null = New-Item -ItemType Directory -Path $LocalVoiceFolder -Force
        Copy-Item -Path $WavFile -Destination $LocalVoiceFolder -Force
        & $XWmaEncodeCmd $WavFile $XWmaFile
        if (Test-Path $LipFile) {
            Copy-Item -Path $LipFile -Destination $LocalVoiceFolder -Force
            & $FuzExtractorPath -i $FuzFile $XWmaFile /l
            # Remove-Item $LipFile -Force
        } else {
            & $FuzExtractorPath -i $FuzFile $XWmaFile
        }
        # Remove-Item $WavFile -Force
        Remove-Item $XWmaFile -Force
        Pop-Location
    }
    foreach ($FuzFile in ((Get-ChildItem -Recurse -Filter '*.fuz'))) {
        $RelPath = [Io.Path]::GetRelativePath($SkyrimDataPath, $FuzFile)
        $BsaFiles.Add($RelPath)
    }
    Pop-Location
}

$SeqFileName = [System.IO.Path]::GetFileNameWithoutExtension($Plugin) + '.seq'
$SeqFilePath = Join-Path $SkyrimSeqPath $SeqFileName
$SeqFilePathRel = "Seq\" + $SeqFileName
if (Test-Path $SeqFilePath) {
    $null = New-Item -ItemType Directory -Name "Seq" -Force
    Copy-Item $SeqFilePath -Destination "Seq" -Force
    $BsaFiles.Add($SeqFilePathRel)
}

if(Test-Path $FaceGenMeshPath) {
    $DataRelativeFaceGenMeshPath = [Io.Path]::GetRelativePath($SkyrimDataPath, $FaceGenMeshPath)
    $LocalFaceGenMeshPath = [Io.Path]::Combine($BasePath, $DataRelativeFaceGenMeshPath)
    $null = New-Item -ItemType Directory -Path $LocalFaceGenMeshPath -Force
    foreach ($FaceGenFile in (Get-ChildItem $FaceGenMeshPath)) {
        if ($FaceGenFile.Extension -imatch '\.tga' ) { continue }
        Copy-Item -Path $FaceGenFile.FullName -Destination $LocalFaceGenMeshPath -Force
        $RelPath = [Io.Path]::GetRelativePath($SkyrimDataPath, $FaceGenFile)
        $BsaFiles.Add($RelPath)
    }
}

if(Test-Path $FaceGenTexturePath) {
    $DataRelativeFaceGenTexturePath = [Io.Path]::GetRelativePath($SkyrimDataPath, $FaceGenTexturePath)
    $LocalFaceGenTexturePath = [Io.Path]::Combine($BasePath, $DataRelativeFaceGenTexturePath)
    $null = New-Item -ItemType Directory -Path $LocalFaceGenTexturePath -Force
    foreach ($FaceGenFile in (Get-ChildItem $FaceGenTexturePath)) {
        if ($FaceGenFile.Extension -imatch '\.tga' ) { continue }
        Copy-Item -Path $FaceGenFile.FullName -Destination $LocalFaceGenTexturePath -Force
        $RelPath = [Io.Path]::GetRelativePath($SkyrimDataPath, $FaceGenFile)
        $BsaFiles.Add($RelPath)
    }
}

foreach ($MeshFilePart in $Config.Meshes) {
    $MeshFileFull = Join-Path $MeshesBasePath $MeshFilePart
    if(Test-Path $MeshFileFull){
        $MeshFile = Get-Item $MeshFileFull
        $DataRelativeMeshPath = [Io.Path]::GetRelativePath($SkyrimDataPath, $MeshFile.Directory.FullName)
        $LocalMeshPath = [Io.Path]::Combine($BasePath, $DataRelativeMeshPath)
        $null = New-Item -ItemType Directory -Path $LocalMeshPath -Force
        $MeshFile | Copy-Item -Destination $LocalMeshPath -Force
        $RelPath = [Io.Path]::GetRelativePath($SkyrimDataPath, $MeshFile)
        $BsaFiles.Add($RelPath)
    }
}

Write-Host @"

Creating archive '$BsaName'...

BSA Files:
"@
foreach ($file in $BsaFiles) {
    Write-Host $file
}

Push-Location $SkyrimInstallPath
$BsaFilesFile = $Plugin + ".bsafiles.txt"
$BsaScriptFile = $Plugin + ".bsascript.txt"
$BsaFiles | Set-Content $BsaFilesFile -Encoding utf8NoBOM
@"
Log: Logs\Archives\MyModArchiveLog.txt
New Archive
Check: Misc
Check: Meshes
Check: Textures
Check: Menus
Check: Sounds
Check: Voices
Check: Compress Archive
Check: Retain File Names
Set File Group Root: Data\
Add File Group: $BsaFilesFile
Save Archive: Data\$BsaName
"@ | Set-Content $BsaScriptFile -Encoding utf8NoBOM
if (Test-Path $BsaPath) {
    "Backing up existing BSA..."
    Remove-Item -Path "$BsaPath.bak" -Force
    Rename-Item -Path $BsaPath -NewName "$BsaName.bak" -Force
}
Start-Process -Wait -FilePath $ArchivePath -ArgumentList $BsaScriptFile -WorkingDirectory $SkyrimInstallPath
Pop-Location
Copy-Item -Path $BsaPath -Destination $BasePath -Force
$7zFiles.Add($BsaName)



$ModuleConfigXML | Set-Content -Encoding utf8NoBOM -Path $FomodModuleConfigFile

# Get-ChildItem -Recurse $VoiceBasePath

$bbcode = [System.Text.StringBuilder]::New()
$inList = $false
if(!$SkipReadme){
    Copy-Item ".\README.md" "README.txt"
    $7zFiles.Add("README.txt")
    foreach ($Line in (Get-Content "README.md")) {
        if ($Line -match '^#[^#]') {
            $Line = $Line -replace '^# ','[size=6]'
            $Line = $Line + '[/size]'
        }
        elseif ($Line -match '^##[^#]') {
            $Line = $Line -replace '^## ','[size=5]'
            $Line = $Line + '[/size]'
        }
        elseif ($Line -match '^#') {
            $Line = $Line -replace '^#* ','[size=4]'
            $Line = $Line + '[/size]'
        }
        if ($inList -and $Line -notmatch '^\* ') {
            $inList = $false
            $null =  $bbcode.AppendLine('[/list]')
        }
        if (!$inList -and $Line -match '^\* ') {
            $inList = $true
            $null =  $bbcode.AppendLine('[list]')
        }
        if($inList -and $Line -match '^\* ') {
            $Line = $Line -replace '^\* ', '[*]'
        }
        $Line = $Line -replace '!\[[^)]*\)'
        $Line = $Line -replace '\[([^\]]*)\]\(([^)]*)\)', '[url=$2]$1[/url]'
        $Line = $Line -replace '`([^`]*)`', '[font=Courier New]$1[/font]'
        $null = $bbcode.AppendLine($Line)
    }
    $bbcode.ToString() | Set-Content -Encoding utf8NoBOM README.bbcode -NoNewline
}

if(Test-Path '3rd_Party_Notice.md'){
    $7zFiles.Add('3rd_Party_Notice.md')
}

if(Test-Path 'LICENSE'){
    $7zFiles.Add('LICENSE')
}

if(Test-Path $ModInfo.Logo){
    $7zFiles.Add($ModInfo.logo)
}
$7zFiles.Add("fomod\info.xml")
$7zFiles.Add("fomod\ModuleConfig.xml")

Write-Host ""
Write-Host "Archive files:"
foreach ($file in $7zFiles) {
    Write-Host $file
}

Remove-Item -Path $Config.PackageName -Force -ErrorAction SilentlyContinue 
7za.exe a -t7z $Config.PackageName $7zFiles

Pop-Location
$EndTime = [datetime]::UtcNow
$Elapsed = ($EndTime - $StartTime).TotalSeconds
Write-Host @"

Build ended $EndTime UTC
$Elapsed (s)
"@