summaryrefslogtreecommitdiff
path: root/build
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2021-12-02 20:48:00 -0500
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2021-12-02 20:48:00 -0500
commitbf5a9b87627b04523c7885b503e85ca2021c63a3 (patch)
tree7dd0d2ab294dbce7711006a28400df1f6512d192 /build
parentc10685b03574e967c1bf48aafc814f60196812ec (diff)
downloadSMAPI-bf5a9b87627b04523c7885b503e85ca2021c63a3.tar.gz
SMAPI-bf5a9b87627b04523c7885b503e85ca2021c63a3.tar.bz2
SMAPI-bf5a9b87627b04523c7885b503e85ca2021c63a3.zip
switch to scripted release package process
Diffstat (limited to 'build')
-rw-r--r--build/common.targets3
-rwxr-xr-xbuild/prepare-install-package.sh201
-rw-r--r--build/prepare-install-package.targets130
3 files changed, 203 insertions, 131 deletions
diff --git a/build/common.targets b/build/common.targets
index 578076a9..c9a54763 100644
--- a/build/common.targets
+++ b/build/common.targets
@@ -8,6 +8,7 @@
<!--set platform-->
<DefineConstants Condition="$(OS) == 'Windows_NT'">$(DefineConstants);SMAPI_FOR_WINDOWS</DefineConstants>
+ <CopyToGameFolder>true</CopyToGameFolder>
</PropertyGroup>
<!--find game folder-->
@@ -19,7 +20,7 @@
</Target>
<!-- copy files into game directory and enable debugging -->
- <Target Name="CopySmapiFiles" AfterTargets="AfterBuild">
+ <Target Name="CopySmapiFiles" AfterTargets="AfterBuild" Condition="'$(CopyToGameFolder)' == 'true'">
<CallTarget Targets="CopySMAPI;CopyDefaultMods" />
</Target>
<Target Name="CopySMAPI" Condition="'$(MSBuildProjectName)' == 'SMAPI'">
diff --git a/build/prepare-install-package.sh b/build/prepare-install-package.sh
new file mode 100755
index 00000000..c16fcd5f
--- /dev/null
+++ b/build/prepare-install-package.sh
@@ -0,0 +1,201 @@
+#!/bin/bash
+
+##########
+## Constants
+##########
+gamePath="/home/pathoschild/Stardew Valley"
+bundleModNames=("ConsoleCommands" "ErrorHandler" "SaveBackup")
+buildConfig="Release"
+folders=("unix" "windows")
+declare -A runtimes=(["unix"]="linux-x64" ["windows"]="win-x64")
+declare -A msBuildPlatformNames=(["unix"]="Unix" ["windows"]="Windows_NT")
+
+
+##########
+## Move to SMAPI root
+##########
+cd "`dirname "$0"`/.."
+
+
+##########
+## Clear old build files
+##########
+echo "Clearing old builds..."
+echo "-----------------------"
+for path in */**/bin */**/obj; do
+ rm -rf $path
+done
+rm -rf "bin"
+echo ""
+
+##########
+## Compile files
+##########
+for folder in ${folders[@]}; do
+ runtime=${runtimes[$folder]}
+ msbuildPlatformName=${msBuildPlatformNames[$folder]}
+
+ # SMAPI
+ echo "Compiling SMAPI for $folder..."
+ echo "------------------"
+ dotnet publish src/SMAPI --configuration $buildConfig -v minimal --runtime "$runtime" -p:OS="$msbuildPlatformName" -p:GamePath="$gamePath" -p:CopyToGameFolder="false"
+ echo ""
+ echo ""
+
+ echo "Compiling installer for $folder..."
+ echo "----------------------"
+ dotnet publish src/SMAPI.Installer --configuration $buildConfig -v minimal --runtime "$runtime" -p:OS="$msbuildPlatformName" -p:GamePath="$gamePath" -p:CopyToGameFolder="false"
+ echo ""
+ echo ""
+
+ for modName in ${bundleModNames[@]}; do
+ echo "Compiling $modName for $folder..."
+ echo "----------------------------------"
+ dotnet publish src/SMAPI.Mods.$modName --configuration $buildConfig -v minimal --runtime "$runtime" -p:OS="$msbuildPlatformName" -p:GamePath="$gamePath" -p:CopyToGameFolder="false"
+ echo ""
+ echo ""
+ done
+done
+
+
+##########
+## Prepare install package
+##########
+echo "Preparing install package..."
+echo "----------------------------"
+
+# init paths
+installAssets="src/SMAPI.Installer/assets"
+packagePath="bin/SMAPI installer"
+packageDevPath="bin/SMAPI installer for developers"
+
+# init structure
+for folder in ${folders[@]}; do
+ mkdir "$packagePath/internal/$folder/bundle/smapi-internal" --parents
+done
+
+# copy base installer files
+cp "$installAssets/unix-install.sh" "$packagePath/install on Linux.sh"
+cp "$installAssets/unix-install.sh" "$packagePath/install on macOS.command"
+cp "$installAssets/windows-install.bat" "$packagePath/install on Windows.bat"
+cp "$installAssets/README.txt" "$packagePath/README.txt"
+
+# copy per-platform files
+for folder in ${folders[@]}; do
+ runtime=${runtimes[$folder]}
+
+ # get paths
+ installBin="src/SMAPI.Installer/bin/$buildConfig/$runtime"
+ smapiBin="src/SMAPI/bin/$buildConfig/$runtime"
+ internalPath="$packagePath/internal/$folder"
+ bundlePath="$internalPath/bundle"
+
+ # runtime config for installer
+ cp "$installBin/SMAPI.Installer.runtimeconfig.json" "$internalPath/SMAPI.Installer.runtimeconfig.json"
+
+ # runtime config for SMAPI
+ cp "$installAssets/runtimeconfig.$folder.json" "$bundlePath/StardewModdingAPI.runtimeconfig.json"
+
+ # installer DLL
+ cp "$installBin/SMAPI.Installer.dll" "$internalPath/SMAPI.Installer.dll"
+ if [ $folder == "windows" ]; then
+ cp "$installAssets/windows-exe-config.xml" "$packagePath/internal/windows/install.exe.config"
+ fi
+
+ # bundle root files
+ for name in "StardewModdingAPI" "StardewModdingAPI.dll" "StardewModdingAPI.pdb" "StardewModdingAPI.xml" "steam_appid.txt"; do
+ if [ $name == "StardewModdingAPI" ] && [ $folder == "windows" ]; then
+ name="$name.exe"
+ fi
+
+ cp "$smapiBin/$name" "$bundlePath/$name"
+ done
+
+ # bundle i18n
+ cp -r "$smapiBin/i18n" "$bundlePath/smapi-internal"
+
+ # bundle smapi-internal
+ for name in "0Harmony.dll" "0Harmony.xml" "Mono.Cecil.dll" "Mono.Cecil.Mdb.dll" "Mono.Cecil.Pdb.dll" "MonoMod.Common.dll" "Newtonsoft.Json.dll" "TMXTile.dll" "SMAPI.Toolkit.dll" "SMAPI.Toolkit.pdb" "SMAPI.Toolkit.xml" "SMAPI.Toolkit.CoreInterfaces.dll" "SMAPI.Toolkit.CoreInterfaces.pdb" "SMAPI.Toolkit.CoreInterfaces.xml"; do
+ cp "$smapiBin/$name" "$bundlePath/smapi-internal/$name"
+ done
+
+ cp "$smapiBin/SMAPI.config.json" "$bundlePath/smapi-internal/config.json"
+ cp "$smapiBin/SMAPI.metadata.json" "$bundlePath/smapi-internal/metadata.json"
+ if [ $folder == "unix" ]; then
+ cp "$installAssets/unix-launcher.sh" "$bundlePath/unix-launcher.sh"
+ cp "$smapiBin/System.Runtime.Caching.dll" "$bundlePath/smapi-internal/System.Runtime.Caching.dll"
+ else
+ cp "$installAssets/windows-exe-config.xml" "$bundlePath/StardewModdingAPI.exe.config"
+ fi
+
+ # copy .NET dependencies
+ cp "$smapiBin/System.Configuration.ConfigurationManager.dll" "$bundlePath/smapi-internal/System.Configuration.ConfigurationManager.dll"
+ cp "$smapiBin/System.Runtime.Caching.dll" "$bundlePath/smapi-internal/System.Runtime.Caching.dll"
+ cp "$smapiBin/System.Security.Permissions.dll" "$bundlePath/smapi-internal/System.Security.Permissions.dll"
+ if [ $folder == "windows" ]; then
+ cp "$smapiBin/System.Management.dll" "$bundlePath/smapi-internal/System.Management.dll"
+ fi
+
+ # copy bundled mods
+ for modName in ${bundleModNames[@]}; do
+ fromPath="src/SMAPI.Mods.$modName/bin/$buildConfig/$runtime"
+ targetPath="$bundlePath/Mods/$modName"
+
+ mkdir "$targetPath" --parents
+
+ cp "$fromPath/$modName.dll" "$targetPath/$modName.dll"
+ cp "$fromPath/$modName.pdb" "$targetPath/$modName.pdb"
+ cp "$fromPath/manifest.json" "$targetPath/manifest.json"
+ if [ -d "$fromPath/i18n" ]; then
+ cp -r "$fromPath/i18n" "$targetPath"
+ fi
+ done
+done
+
+# mark scripts executable
+for path in "install on Linux.sh" "install on macOS.command" "bundle/unix-launcher.sh"; do
+ if [ -f "$packagePath/$path" ]; then
+ chmod 755 "$packagePath/$path"
+ fi
+done
+
+# split into main + for-dev folders
+cp -r "$packagePath" "$packageDevPath"
+for folder in ${folders[@]}; do
+ # disable developer mode in main package
+ sed --in-place --expression="s/\"DeveloperMode\": true/\"DeveloperMode\": false/" "$packagePath/internal/$folder/bundle/smapi-internal/config.json"
+
+ # convert bundle folder into final 'install.dat' files
+ for path in "$packagePath/internal/$folder" "$packageDevPath/internal/$folder"; do
+ pushd "$path/bundle" > /dev/null
+ zip "install.dat" * --recurse-paths --quiet
+ popd > /dev/null
+ mv "$path/bundle/install.dat" "$path/install.dat"
+ rm -rf "$path/bundle"
+ done
+done
+
+
+##########
+## Create release zips
+##########
+# get version number
+version="$1"
+if [ $# -eq 0 ]; then
+ echo "SMAPI release version (like '4.0.0'):"
+ read version
+fi
+
+# rename folders
+mv "$packagePath" "bin/SMAPI $version installer"
+mv "$packageDevPath" "bin/SMAPI $version installer for developers"
+
+
+# package files
+pushd bin > /dev/null
+zip -9 "SMAPI $version installer.zip" "SMAPI $version installer" --recurse-paths --quiet
+zip -9 "SMAPI $version installer for developers.zip" "SMAPI $version installer for developers" --recurse-paths --quiet
+popd > /dev/null
+
+echo ""
+echo "Done! Package created in $(pwd)/bin"
diff --git a/build/prepare-install-package.targets b/build/prepare-install-package.targets
deleted file mode 100644
index ef5624ad..00000000
--- a/build/prepare-install-package.targets
+++ /dev/null
@@ -1,130 +0,0 @@
-<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
- <!--
-
- This build task is run from the installer project after all projects have been compiled, and
- creates the build package in the bin\Packages folder.
-
- -->
- <Target Name="PrepareInstaller" AfterTargets="AfterBuild">
- <PropertyGroup>
- <PlatformName>windows</PlatformName>
- <PlatformName Condition="$(OS) != 'Windows_NT'">unix</PlatformName>
-
- <BuildRootPath>$(SolutionDir)</BuildRootPath>
- <OutRootPath>$(SolutionDir)\..\bin</OutRootPath>
-
- <SmapiBin>$(BuildRootPath)\SMAPI\bin\$(Configuration)</SmapiBin>
- <ToolkitBin>$(BuildRootPath)\SMAPI.Toolkit\bin\$(Configuration)\net5.0</ToolkitBin>
- <ConsoleCommandsBin>$(BuildRootPath)\SMAPI.Mods.ConsoleCommands\bin\$(Configuration)</ConsoleCommandsBin>
- <ErrorHandlerBin>$(BuildRootPath)\SMAPI.Mods.ErrorHandler\bin\$(Configuration)</ErrorHandlerBin>
- <SaveBackupBin>$(BuildRootPath)\SMAPI.Mods.SaveBackup\bin\$(Configuration)</SaveBackupBin>
-
- <PackagePath>$(OutRootPath)\SMAPI installer</PackagePath>
- <PackageDevPath>$(OutRootPath)\SMAPI installer for developers</PackageDevPath>
- </PropertyGroup>
- <ItemGroup>
- <TranslationFiles Include="$(SmapiBin)\i18n\*.json" />
- <ErrorHandlerTranslationFiles Include="$(ErrorHandlerBin)\i18n\*.json" />
- </ItemGroup>
-
- <!-- reset package directory -->
- <RemoveDir Directories="$(PackagePath)" />
- <RemoveDir Directories="$(PackageDevPath)" />
-
- <!-- copy installer files -->
- <Copy SourceFiles="$(TargetDir)\assets\unix-install.sh" DestinationFiles="$(PackagePath)\install on Linux.sh" />
- <Copy SourceFiles="$(TargetDir)\assets\unix-install.sh" DestinationFiles="$(PackagePath)\install on macOS.command" />
- <Copy SourceFiles="$(TargetDir)\assets\windows-install.bat" DestinationFiles="$(PackagePath)\install on Windows.bat" />
- <Copy SourceFiles="$(TargetDir)\assets\README.txt" DestinationFolder="$(PackagePath)" />
- <Copy SourceFiles="$(TargetDir)\assets\windows-exe-config.xml" DestinationFiles="$(PackagePath)\internal\$(PlatformName)\install.exe.config" Condition="$(PlatformName) == 'windows'" />
- <Copy SourceFiles="$(TargetDir)\$(TargetName).dll" DestinationFolder="$(PackagePath)\internal\$(PlatformName)" />
- <Copy SourceFiles="$(TargetDir)\$(TargetName).runtimeconfig.json" DestinationFolder="$(PackagePath)\internal\$(PlatformName)" />
-
- <!--copy bundle files-->
- <Copy SourceFiles="$(TargetDir)\assets\runtimeconfig.$(PlatformName).json" DestinationFiles="$(PackagePath)\bundle\StardewModdingAPI.runtimeconfig.json" />
- <Copy SourceFiles="$(SmapiBin)\StardewModdingAPI.dll" DestinationFolder="$(PackagePath)\bundle" />
- <Copy SourceFiles="$(SmapiBin)\StardewModdingAPI.exe" DestinationFolder="$(PackagePath)\bundle" Condition="$(PlatformName) == 'windows'" />
- <Copy SourceFiles="$(SmapiBin)\StardewModdingAPI" DestinationFolder="$(PackagePath)\bundle" Condition="$(PlatformName) != 'windows'" />
- <Copy SourceFiles="$(SmapiBin)\StardewModdingAPI.pdb" DestinationFolder="$(PackagePath)\bundle" />
- <Copy SourceFiles="$(SmapiBin)\StardewModdingAPI.xml" DestinationFolder="$(PackagePath)\bundle" />
- <Copy SourceFiles="$(SmapiBin)\steam_appid.txt" DestinationFolder="$(PackagePath)\bundle" />
- <Copy SourceFiles="$(SmapiBin)\0Harmony.dll" DestinationFolder="$(PackagePath)\bundle\smapi-internal" />
- <Copy SourceFiles="$(SmapiBin)\0Harmony.xml" DestinationFolder="$(PackagePath)\bundle\smapi-internal" />
- <Copy SourceFiles="$(SmapiBin)\Mono.Cecil.dll" DestinationFolder="$(PackagePath)\bundle\smapi-internal" />
- <Copy SourceFiles="$(SmapiBin)\Mono.Cecil.Mdb.dll" DestinationFolder="$(PackagePath)\bundle\smapi-internal" />
- <Copy SourceFiles="$(SmapiBin)\Mono.Cecil.Pdb.dll" DestinationFolder="$(PackagePath)\bundle\smapi-internal" />
- <Copy SourceFiles="$(SmapiBin)\MonoMod.Common.dll" DestinationFolder="$(PackagePath)\bundle\smapi-internal" />
- <Copy SourceFiles="$(SmapiBin)\Newtonsoft.Json.dll" DestinationFolder="$(PackagePath)\bundle\smapi-internal" />
- <Copy SourceFiles="$(SmapiBin)\TMXTile.dll" DestinationFolder="$(PackagePath)\bundle\smapi-internal" />
- <Copy SourceFiles="$(SmapiBin)\SMAPI.config.json" DestinationFiles="$(PackagePath)\bundle\smapi-internal\config.json" />
- <Copy SourceFiles="$(SmapiBin)\SMAPI.metadata.json" DestinationFiles="$(PackagePath)\bundle\smapi-internal\metadata.json" />
- <Copy SourceFiles="$(ToolkitBin)\SMAPI.Toolkit.dll" DestinationFolder="$(PackagePath)\bundle\smapi-internal" />
- <Copy SourceFiles="$(ToolkitBin)\SMAPI.Toolkit.pdb" DestinationFolder="$(PackagePath)\bundle\smapi-internal" />
- <Copy SourceFiles="$(ToolkitBin)\SMAPI.Toolkit.xml" DestinationFolder="$(PackagePath)\bundle\smapi-internal" />
- <Copy SourceFiles="$(ToolkitBin)\SMAPI.Toolkit.CoreInterfaces.dll" DestinationFolder="$(PackagePath)\bundle\smapi-internal" />
- <Copy SourceFiles="$(ToolkitBin)\SMAPI.Toolkit.CoreInterfaces.pdb" DestinationFolder="$(PackagePath)\bundle\smapi-internal" />
- <Copy SourceFiles="$(ToolkitBin)\SMAPI.Toolkit.CoreInterfaces.xml" DestinationFolder="$(PackagePath)\bundle\smapi-internal" />
- <Copy SourceFiles="@(TranslationFiles)" DestinationFolder="$(PackagePath)\bundle\smapi-internal\i18n" />
- <Copy Condition="$(PlatformName) == 'unix'" SourceFiles="$(TargetDir)\assets\unix-launcher.sh" DestinationFolder="$(PackagePath)\bundle" />
- <Copy Condition="$(PlatformName) == 'unix'" SourceFiles="$(SmapiBin)\System.Runtime.Caching.dll" DestinationFolder="$(PackagePath)\bundle\smapi-internal" />
- <Copy Condition="$(PlatformName) == 'windows'" SourceFiles="$(TargetDir)\assets\windows-exe-config.xml" DestinationFiles="$(PackagePath)\bundle\StardewModdingAPI.exe.config" />
-
- <!-- copy .NET dependencies -->
- <Copy SourceFiles="$(SmapiBin)\System.Configuration.ConfigurationManager.dll" DestinationFolder="$(PackagePath)\bundle\smapi-internal" />
- <Copy SourceFiles="$(SmapiBin)\System.Management.dll" DestinationFolder="$(PackagePath)\bundle\smapi-internal" Condition="$(PlatformName) == 'windows'" />
- <Copy SourceFiles="$(SmapiBin)\System.Runtime.Caching.dll" DestinationFolder="$(PackagePath)\bundle\smapi-internal" />
- <Copy SourceFiles="$(SmapiBin)\System.Security.Permissions.dll" DestinationFolder="$(PackagePath)\bundle\smapi-internal" />
-
- <!--copy bundled mods-->
- <Copy SourceFiles="$(ConsoleCommandsBin)\ConsoleCommands.dll" DestinationFolder="$(PackagePath)\bundle\Mods\ConsoleCommands" />
- <Copy SourceFiles="$(ConsoleCommandsBin)\ConsoleCommands.pdb" DestinationFolder="$(PackagePath)\bundle\Mods\ConsoleCommands" />
- <Copy SourceFiles="$(ConsoleCommandsBin)\manifest.json" DestinationFolder="$(PackagePath)\bundle\Mods\ConsoleCommands" />
- <Copy SourceFiles="$(ErrorHandlerBin)\ErrorHandler.dll" DestinationFolder="$(PackagePath)\bundle\Mods\ErrorHandler" />
- <Copy SourceFiles="$(ErrorHandlerBin)\ErrorHandler.pdb" DestinationFolder="$(PackagePath)\bundle\Mods\ErrorHandler" />
- <Copy SourceFiles="$(ErrorHandlerBin)\manifest.json" DestinationFolder="$(PackagePath)\bundle\Mods\ErrorHandler" />
- <Copy SourceFiles="@(ErrorHandlerTranslationFiles)" DestinationFolder="$(PackagePath)\bundle\Mods\ErrorHandler\i18n" />
- <Copy SourceFiles="$(SaveBackupBin)\SaveBackup.dll" DestinationFolder="$(PackagePath)\bundle\Mods\SaveBackup" />
- <Copy SourceFiles="$(SaveBackupBin)\SaveBackup.pdb" DestinationFolder="$(PackagePath)\bundle\Mods\SaveBackup" />
- <Copy SourceFiles="$(SaveBackupBin)\manifest.json" DestinationFolder="$(PackagePath)\bundle\Mods\SaveBackup" />
-
- <!-- fix Linux/macOS permissions -->
- <Exec Condition="$(PlatformName) == 'unix'" Command="chmod 755 &quot;$(PackagePath)/install on Linux.sh&quot;" />
- <Exec Condition="$(PlatformName) == 'unix'" Command="chmod 755 &quot;$(PackagePath)/install on macOS.command&quot;" />
- <Exec Condition="$(PlatformName) == 'unix'" Command="chmod 755 &quot;$(PackagePath)/bundle/unix-launcher.sh&quot;" />
-
- <!-- finalise 'for developers' installer -->
- <ItemGroup>
- <PackageFiles Include="$(PackagePath)\**\*.*" />
- </ItemGroup>
- <Copy SourceFiles="@(PackageFiles)" DestinationFolder="$(PackageDevPath)\%(RecursiveDir)" />
- <ZipDirectory SourceDirectory="$(PackageDevPath)\bundle" DestinationFile="$(PackageDevPath)\internal\$(PlatformName)\install.dat" />
- <RemoveDir Directories="$(PackageDevPath)\bundle" />
-
- <!-- finalise normal installer -->
- <ReplaceFileText FilePath="$(PackagePath)\bundle\smapi-internal\config.json" Search="&quot;DeveloperMode&quot;: true" Replace="&quot;DeveloperMode&quot;: false" />
- <ZipDirectory SourceDirectory="$(PackagePath)\bundle" DestinationFile="$(PackagePath)\internal\$(PlatformName)\install.dat" />
- <RemoveDir Directories="$(PackagePath)\bundle" />
- </Target>
-
- <!-- Replace text in a file based on a regex pattern. Derived from https://stackoverflow.com/a/22571621/262123. -->
- <UsingTask TaskName="ReplaceFileText" TaskFactory="RoslynCodeTaskFactory" AssemblyFile="$(MSBuildToolsPath)\Microsoft.Build.Tasks.Core.dll">
- <ParameterGroup>
- <FilePath ParameterType="System.String" Required="true" />
- <Search ParameterType="System.String" Required="true" />
- <Replace ParameterType="System.String" Required="true" />
- </ParameterGroup>
- <Task>
- <Using Namespace="System" />
- <Using Namespace="System.IO" />
- <Using Namespace="System.Text.RegularExpressions" />
- <Code Type="Fragment" Language="cs">
- <![CDATA[
- File.WriteAllText(
- FilePath,
- Regex.Replace(File.ReadAllText(FilePath), Search, Replace)
- );
- ]]>
- </Code>
- </Task>
- </UsingTask>
-</Project>