407 lines
10 KiB
PowerShell
407 lines
10 KiB
PowerShell
####### The starting point for the script is the bottom #######
|
|
|
|
###############################################################
|
|
########################## FUNCTIONS ##########################
|
|
###############################################################
|
|
function All-Command
|
|
{
|
|
If (!(Test-Path "*.sln"))
|
|
{
|
|
return
|
|
}
|
|
|
|
if ((CheckForDotnet) -eq 1)
|
|
{
|
|
return
|
|
}
|
|
|
|
dotnet build /p:Configuration=Release /nologo
|
|
if ($lastexitcode -ne 0)
|
|
{
|
|
Write-Host "Build failed. If just the development tools failed to build, try installing Visual Studio. You may also still be able to run the game." -ForegroundColor Red
|
|
}
|
|
else
|
|
{
|
|
Write-Host "Build succeeded." -ForegroundColor Green
|
|
}
|
|
}
|
|
|
|
function Clean-Command
|
|
{
|
|
If (!(Test-Path "*.sln"))
|
|
{
|
|
return
|
|
}
|
|
|
|
if ((CheckForDotnet) -eq 1)
|
|
{
|
|
return
|
|
}
|
|
|
|
dotnet clean /nologo
|
|
rm *.dll
|
|
rm mods/*/*.dll
|
|
rm *.dll.config
|
|
rm *.pdb
|
|
rm mods/*/*.pdb
|
|
rm *.exe
|
|
rm ./*/bin -r
|
|
rm ./*/obj -r
|
|
|
|
rm $env:ENGINE_DIRECTORY/*.dll
|
|
rm $env:ENGINE_DIRECTORY/mods/*/*.dll
|
|
rm env:ENGINE_DIRECTORY/*.config
|
|
rm env:ENGINE_DIRECTORY/*.pdb
|
|
rm mods/*/*.pdb
|
|
rm env:ENGINE_DIRECTORY/*.exe
|
|
rm env:ENGINE_DIRECTORY/*/bin -r
|
|
rm env:ENGINE_DIRECTORY/*/obj -r
|
|
if (Test-Path env:ENGINE_DIRECTORY/thirdparty/download/)
|
|
{
|
|
rmdir env:ENGINE_DIRECTORY/thirdparty/download -Recurse -Force
|
|
}
|
|
|
|
Write-Host "Clean complete." -ForegroundColor Green
|
|
}
|
|
|
|
function Version-Command
|
|
{
|
|
if ($command.Length -gt 1)
|
|
{
|
|
$version = $command[1]
|
|
}
|
|
elseif (Get-Command 'git' -ErrorAction SilentlyContinue)
|
|
{
|
|
$gitRepo = git rev-parse --is-inside-work-tree
|
|
if ($gitRepo)
|
|
{
|
|
$version = git name-rev --name-only --tags --no-undefined HEAD 2>$null
|
|
if ($version -eq $null)
|
|
{
|
|
$version = "git-" + (git rev-parse --short HEAD)
|
|
}
|
|
}
|
|
else
|
|
{
|
|
Write-Host "Not a git repository. The version will remain unchanged." -ForegroundColor Red
|
|
}
|
|
}
|
|
else
|
|
{
|
|
Write-Host "Unable to locate Git. The version will remain unchanged." -ForegroundColor Red
|
|
}
|
|
|
|
if ($version -ne $null)
|
|
{
|
|
$mod = "mods/" + $modID + "/mod.yaml"
|
|
$replacement = (gc $mod) -Replace "Version:.*", ("Version: {0}" -f $version)
|
|
sc $mod $replacement
|
|
|
|
$prefix = $(gc $mod) | Where { $_.ToString().EndsWith(": User") }
|
|
if ($prefix -and $prefix.LastIndexOf("/") -ne -1)
|
|
{
|
|
$prefix = $prefix.Substring(0, $prefix.LastIndexOf("/"))
|
|
}
|
|
$replacement = (gc $mod) -Replace ".*: User", ("{0}/{1}: User" -f $prefix, $version)
|
|
sc $mod $replacement
|
|
|
|
Write-Host ("Version strings set to '{0}'." -f $version)
|
|
}
|
|
}
|
|
|
|
function Test-Command
|
|
{
|
|
if ((CheckForUtility) -eq 1)
|
|
{
|
|
return
|
|
}
|
|
|
|
Write-Host "Testing $modID mod MiniYAML..." -ForegroundColor Cyan
|
|
Invoke-Expression "$utilityPath $modID --check-yaml"
|
|
}
|
|
|
|
function Check-Command
|
|
{
|
|
If (!(Test-Path "*.sln"))
|
|
{
|
|
Write-Host "No custom solution file found. Skipping static code checks." -ForegroundColor Cyan
|
|
return
|
|
}
|
|
|
|
Write-Host "Compiling in debug configuration..." -ForegroundColor Cyan
|
|
dotnet build /p:Configuration=Debug /nologo
|
|
if ($lastexitcode -ne 0)
|
|
{
|
|
Write-Host "Build failed." -ForegroundColor Red
|
|
}
|
|
|
|
if ((CheckForUtility) -eq 0)
|
|
{
|
|
Write-Host "Checking for explicit interface violations..." -ForegroundColor Cyan
|
|
Invoke-Expression "$utilityPath $modID --check-explicit-interfaces"
|
|
|
|
Write-Host "Checking for incorrect conditional trait interface overrides..." -ForegroundColor Cyan
|
|
Invoke-Expression "$utilityPath $modID --check-conditional-trait-interface-overrides"
|
|
}
|
|
}
|
|
|
|
function Check-Scripts-Command
|
|
{
|
|
if ((Get-Command "luac.exe" -ErrorAction SilentlyContinue) -ne $null)
|
|
{
|
|
Write-Host "Testing Lua scripts..." -ForegroundColor Cyan
|
|
foreach ($script in ls "mods/*/maps/*/*.lua")
|
|
{
|
|
luac -p $script
|
|
}
|
|
Write-Host "Check completed!" -ForegroundColor Green
|
|
}
|
|
else
|
|
{
|
|
Write-Host "luac.exe could not be found. Please install Lua." -ForegroundColor Red
|
|
}
|
|
}
|
|
|
|
function Docs-Command
|
|
{
|
|
if ((CheckForUtility) -eq 1)
|
|
{
|
|
return
|
|
}
|
|
|
|
./make.ps1 version
|
|
Invoke-Expression "$utilityPath $modID --docs | Out-File -Encoding 'UTF8' DOCUMENTATION.md"
|
|
Invoke-Expression "$utilityPath $modID --weapon-docs | Out-File -Encoding "UTF8" WEAPONS.md"
|
|
Invoke-Expression "$utilityPath $modID --lua-docs | Out-File -Encoding 'UTF8' Lua-API.md"
|
|
echo "Docs generated." -ForegroundColor Green
|
|
}
|
|
|
|
function CheckForUtility
|
|
{
|
|
if (Test-Path OpenRA.Utility.exe)
|
|
{
|
|
return 0
|
|
}
|
|
|
|
Write-Host "OpenRA.Utility.exe could not be found. Build the project first using the `"all`" command." -ForegroundColor Red
|
|
return 1
|
|
}
|
|
|
|
function CheckForDotnet
|
|
{
|
|
if ((Get-Command "dotnet" -ErrorAction SilentlyContinue) -eq $null)
|
|
{
|
|
Write-Host "The 'dotnet' tool is required to compile OpenRA. Please install the .NET Core SDK or Visual Studio and try again. https://dotnet.microsoft.com/download" -ForegroundColor Red
|
|
return 1
|
|
}
|
|
|
|
return 0
|
|
}
|
|
|
|
function WaitForInput
|
|
{
|
|
echo "Press enter to continue."
|
|
while ($true)
|
|
{
|
|
if ([System.Console]::KeyAvailable)
|
|
{
|
|
exit
|
|
}
|
|
Start-Sleep -Milliseconds 50
|
|
}
|
|
}
|
|
|
|
function ReadConfigLine($line, $name)
|
|
{
|
|
$prefix = $name + '='
|
|
if ($line.StartsWith($prefix))
|
|
{
|
|
[Environment]::SetEnvironmentVariable($name, $line.Replace($prefix, '').Replace('"', ''))
|
|
}
|
|
}
|
|
|
|
function ParseConfigFile($fileName)
|
|
{
|
|
$names = @("MOD_ID", "ENGINE_VERSION", "AUTOMATIC_ENGINE_MANAGEMENT", "AUTOMATIC_ENGINE_SOURCE",
|
|
"AUTOMATIC_ENGINE_EXTRACT_DIRECTORY", "AUTOMATIC_ENGINE_TEMP_ARCHIVE_NAME", "ENGINE_DIRECTORY")
|
|
|
|
$reader = [System.IO.File]::OpenText($fileName)
|
|
while($null -ne ($line = $reader.ReadLine()))
|
|
{
|
|
foreach ($name in $names)
|
|
{
|
|
ReadConfigLine $line $name
|
|
}
|
|
}
|
|
|
|
$missing = @()
|
|
foreach ($name in $names)
|
|
{
|
|
if (!([System.Environment]::GetEnvironmentVariable($name)))
|
|
{
|
|
$missing += $name
|
|
}
|
|
}
|
|
|
|
if ($missing)
|
|
{
|
|
echo "Required mod.config variables are missing:"
|
|
foreach ($m in $missing)
|
|
{
|
|
echo " $m"
|
|
}
|
|
echo "Repair your mod.config (or user.config) and try again."
|
|
WaitForInput
|
|
exit
|
|
}
|
|
}
|
|
|
|
###############################################################
|
|
############################ Main #############################
|
|
###############################################################
|
|
if ($PSVersionTable.PSVersion.Major -clt 3)
|
|
{
|
|
echo "The makefile requires PowerShell version 3 or higher."
|
|
echo "Please download and install the latest Windows Management Framework version from Microsoft."
|
|
WaitForInput
|
|
}
|
|
|
|
if ($args.Length -eq 0)
|
|
{
|
|
echo "Command list:"
|
|
echo ""
|
|
echo " all Builds the game, its development tools and the mod dlls."
|
|
echo " version Sets the version strings for all mods to the latest"
|
|
echo " version for the current Git branch."
|
|
echo " clean Removes all built and copied files."
|
|
echo " from the mods and the engine directories."
|
|
echo " test Tests the mod's MiniYAML for errors."
|
|
echo " check Checks .cs files for StyleCop violations."
|
|
echo " check-scripts Checks .lua files for syntax errors."
|
|
echo " docs Generates the trait and Lua API documentation."
|
|
echo ""
|
|
$command = (Read-Host "Enter command").Split(' ', 2)
|
|
}
|
|
else
|
|
{
|
|
$command = $args
|
|
}
|
|
|
|
# Load the environment variables from the config file
|
|
# and get the mod ID from the local environment variable
|
|
ParseConfigFile "mod.config"
|
|
|
|
if (Test-Path "user.config")
|
|
{
|
|
ParseConfigFile "user.config"
|
|
}
|
|
|
|
$modID = $env:MOD_ID
|
|
|
|
$env:MOD_SEARCH_PATHS = (Get-Item -Path ".\" -Verbose).FullName + "\mods,./mods"
|
|
|
|
# Run the same command on the engine's make file
|
|
if ($command -eq "all" -or $command -eq "clean")
|
|
{
|
|
$templateDir = $pwd.Path
|
|
$versionFile = $env:ENGINE_DIRECTORY + "/VERSION"
|
|
$currentEngine = ""
|
|
if (Test-Path $versionFile)
|
|
{
|
|
$currentEngine = [System.IO.File]::OpenText($versionFile).ReadLine()
|
|
}
|
|
|
|
if ($currentEngine -ne "" -and $currentEngine -eq $env:ENGINE_VERSION)
|
|
{
|
|
cd $env:ENGINE_DIRECTORY
|
|
Invoke-Expression ".\make.cmd $command"
|
|
echo ""
|
|
cd $templateDir
|
|
}
|
|
elseif ($env:AUTOMATIC_ENGINE_MANAGEMENT -ne "True")
|
|
{
|
|
echo "Automatic engine management is disabled."
|
|
echo "Please manually update the engine to version $env:ENGINE_VERSION."
|
|
WaitForInput
|
|
}
|
|
else
|
|
{
|
|
echo "OpenRA engine version $env:ENGINE_VERSION is required."
|
|
|
|
if (Test-Path $env:ENGINE_DIRECTORY)
|
|
{
|
|
if ($currentEngine -ne "")
|
|
{
|
|
echo "Deleting engine version $currentEngine."
|
|
}
|
|
else
|
|
{
|
|
echo "Deleting existing engine (unknown version)."
|
|
}
|
|
|
|
rm $env:ENGINE_DIRECTORY -r
|
|
}
|
|
|
|
echo "Downloading engine..."
|
|
|
|
if (Test-Path $env:AUTOMATIC_ENGINE_EXTRACT_DIRECTORY)
|
|
{
|
|
rm $env:AUTOMATIC_ENGINE_EXTRACT_DIRECTORY -r
|
|
}
|
|
|
|
$url = $env:AUTOMATIC_ENGINE_SOURCE
|
|
$url = $url.Replace("$", "").Replace("{ENGINE_VERSION}", $env:ENGINE_VERSION)
|
|
|
|
mkdir $env:AUTOMATIC_ENGINE_EXTRACT_DIRECTORY > $null
|
|
$dlPath = Join-Path $pwd (Split-Path -leaf $env:AUTOMATIC_ENGINE_EXTRACT_DIRECTORY)
|
|
$dlPath = Join-Path $dlPath (Split-Path -leaf $env:AUTOMATIC_ENGINE_TEMP_ARCHIVE_NAME)
|
|
|
|
$client = new-object System.Net.WebClient
|
|
[Net.ServicePointManager]::SecurityProtocol = 'Tls12'
|
|
$client.DownloadFile($url, $dlPath)
|
|
|
|
Add-Type -assembly "system.io.compression.filesystem"
|
|
[io.compression.zipfile]::ExtractToDirectory($dlPath, $env:AUTOMATIC_ENGINE_EXTRACT_DIRECTORY)
|
|
rm $dlPath
|
|
|
|
$extractedDir = Get-ChildItem $env:AUTOMATIC_ENGINE_EXTRACT_DIRECTORY -Recurse | ?{ $_.PSIsContainer } | Select-Object -First 1
|
|
Move-Item $extractedDir.FullName -Destination $templateDir
|
|
Rename-Item $extractedDir.Name (Split-Path -leaf $env:ENGINE_DIRECTORY)
|
|
|
|
rm $env:AUTOMATIC_ENGINE_EXTRACT_DIRECTORY -r
|
|
|
|
cd $env:ENGINE_DIRECTORY
|
|
Invoke-Expression ".\make.cmd version $env:ENGINE_VERSION"
|
|
Invoke-Expression ".\make.cmd $command"
|
|
echo ""
|
|
cd $templateDir
|
|
}
|
|
}
|
|
|
|
$utilityPath = $env:ENGINE_DIRECTORY + "/OpenRA.Utility.exe"
|
|
$styleCheckPath = $env:ENGINE_DIRECTORY + "/OpenRA.StyleCheck.exe"
|
|
|
|
$execute = $command
|
|
if ($command.Length -gt 1)
|
|
{
|
|
$execute = $command[0]
|
|
}
|
|
|
|
switch ($execute)
|
|
{
|
|
"all" { All-Command }
|
|
"version" { Version-Command }
|
|
"clean" { Clean-Command }
|
|
"test" { Test-Command }
|
|
"check" { Check-Command }
|
|
"check-scripts" { Check-Scripts-Command }
|
|
"docs" { Docs-Command }
|
|
Default { echo ("Invalid command '{0}'" -f $command) }
|
|
}
|
|
|
|
# In case the script was called without any parameters we keep the window open
|
|
if ($args.Length -eq 0)
|
|
{
|
|
WaitForInput
|
|
}
|