Spriggit Windows Installer

.github/workflows/ci-publish.yml

@@ -131,6 +131,9 @@ jobs:
     - name: Pack CLI
       if: ${{ success() && !github.event.release.prerelease && github.event_name == 'release' }}
       run: dotnet publish "Spriggit.CLI/Spriggit.CLI.csproj" --configuration Release -r win-x64 -p:PublishSingleFile=True --self-contained True
+    - name: Pack Windows Installer
+      if: ${{ success() && !github.event.release.prerelease && github.event_name == 'release' }}
+      run: dotnet publish "Spriggit.Installer.Windows/Spriggit.Installer.Windows.csproj" --configuration Release -r win-x64
     - name: Archive GUI
       if: ${{ success() && !github.event.release.prerelease && github.event_name == 'release' }}
       run: |
@@ -164,6 +167,13 @@ jobs:
         file: SpriggitCLI.zip
         repo_token: ${{ secrets.GITHUB_TOKEN }}
         tag: ${{ github.event.release.tag_name }}
+    - name: Publish Windows Installer to Github
+      if: ${{ success() && !github.event.release.prerelease && github.event_name == 'release' }}
+      uses: svenstaro/upload-release-action@v2
+      with:
+        file: Spriggit.Installer.msi
+        repo_token: ${{ secrets.GITHUB_TOKEN }}
+        tag: ${{ github.event.release.tag_name }}
     - name: Print Packages
       run: |
         ls out/*.nupkg

Directory.Packages.props

@@ -97,6 +97,7 @@
       <Version>1.4.4</Version>
     </PackageVersion>
     <PackageVersion Include="TestableIO.System.IO.Abstractions.Wrappers" Version="22.0.15" />
+    <PackageVersion Include="WixToolset.UI.wixext" Version="6.0.1" />
     <PackageVersion Include="xunit">
       <Version>2.9.3</Version>
     </PackageVersion>

Spriggit.Installer.Windows/CLIComponents.wxs

@@ -0,0 +1,21 @@
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
+  <Fragment>
+    <ComponentGroup Id="CLI" Directory="INSTALLFOLDER">
+      <Component Id="SpriggitCLIExe" Guid="{F5D80F8A-8356-46AE-B764-BC3D618C0C83}">
+          <RegistryValue Root="HKCU" Key="Software\Spriggit" Name="Installed" Type="string" Value="[INSTALLFOLDER]" KeyPath="yes" />
+          <File Source="win-x64\publish\Spriggit.CLI.exe" />
+          <File Source="win-x64\publish\Spriggit.CLI.Lib.pdb" />
+          <File Source="win-x64\publish\Spriggit.CLI.Lib.xml" />
+          <File Source="win-x64\publish\Spriggit.CLI.pdb" />
+          <File Source="win-x64\publish\Spriggit.CLI.xml" />
+          <File Source="win-x64\publish\Spriggit.Core.pdb" />
+          <File Source="win-x64\publish\Spriggit.Core.xml" />
+          <File Source="win-x64\publish\Spriggit.Engine.pdb" />
+          <File Source="win-x64\publish\Spriggit.Engine.xml" />
+          <File Source="win-x64\publish\NuGet.props" />
+          <File Source="win-x64\publish\NuGet.targets" />
+          <File Source="win-x64\publish\git2-3f4182d.dll" />
+      </Component>
+    </ComponentGroup>
+  </Fragment>
+</Wix>

Spriggit.Installer.Windows/Folders.wxs

@@ -0,0 +1,17 @@
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
+    <Fragment>
+        <StandardDirectory Id="LocalAppDataFolder">
+            <Directory Id="INSTALLFOLDER" Name="!(bind.Property.ProductName)" />
+        </StandardDirectory>
+
+        <StandardDirectory Id="ProgramMenuFolder">
+            <Directory Id="SPRIGGITSTARTMENUFOLDER" Name="Spriggit" />
+        </StandardDirectory>
+
+        <Component Id="RemoveFilesComponent" Directory="INSTALLFOLDER" Guid="{79117B80-84BC-4615-8207-FD077DC67ECD}">
+            <RegistryValue Root="HKCU" Key="Software\Mutagen Modding\Spriggit" Name="Installed" Type="integer" Value="1" KeyPath="true" />
+            <RemoveFile Id="RemoveInstallFolder" Directory="INSTALLFOLDER" On="uninstall" Name="*" />
+            <RemoveFolder Id="RemoveInstallFolderDir" Directory="INSTALLFOLDER" On="uninstall" />
+        </Component>
+    </Fragment>
+</Wix>

Spriggit.Installer.Windows/Package.en-us.wxl

@@ -0,0 +1,17 @@
+<WixLocalization xmlns="http://wixtoolset.org/schemas/v4/wxl" Culture="en-US">
+
+    <String Id="DowngradeError" Value="A newer version of [ProductName] is already installed." />
+
+    <!-- Path Options Dialog Strings -->
+    <String Id="PathOptionsTitle" Value="Environment Variables" />
+    <String Id="PathOptionsDescription" Value="Configure how Spriggit integrates with your system environment." />
+    <String Id="AddToPathCheckBox" Value="Add Spriggit to the user PATH" />
+    <String Id="PathExplanation" Value="This allows you to run 'Spriggit.CLI.exe' commands from any command prompt or terminal window." />
+    <String Id="CLIFeatureTitle" Value="Command Line" />
+    <String Id="CLIFeatureDescription" Value="Contains the command line version of Spriggit. The CLI is fully featured but must be used from a command prompt." />
+    <String Id="PathFeatureTitle" Value="Add to PATH" />
+    <String Id="PathFeatureDescription" Value="Adds Spriggit to the system PATH environment variable, allowing you to run commands from any location." />
+    <String Id="UIFeatureTitle" Value="Graphical User Interface" />
+    <String Id="UIFeatureDescription" Value="Contains the Spriggit Graphical User Interface, useful for those who like a UI as opposed to command line." />
+
+</WixLocalization>

Spriggit.Installer.Windows/Package.wxs

@@ -0,0 +1,31 @@
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs"
+    xmlns:ui="http://wixtoolset.org/schemas/v4/wxs/ui"
+>
+    <Package Id="SpriggitInstaller" Name="Spriggit" Manufacturer="Mutagen Modding" Version="0.38.6" Scope="perUser">
+        <Property Id="ApplicationFolderName" Value="Spriggit" />
+        <Property Id="WixAppFolder" Value="Spriggit" />
+        <Property Id="SuppressICEs" Value="ICE91" />
+        <WixVariable Id="WixUILicenseRtf" Value="$(var.ProjectDir)..\LICENSE.rtf" />
+        <WixVariable Id="WixUIDialogBmp" Value="$(var.ProjectDir)..\SpriggitDialog.png" />
+
+        <MajorUpgrade DowngradeErrorMessage="!(loc.DowngradeError)" />
+        <MediaTemplate EmbedCab="true" />
+
+        <ui:WixUI
+                Id="WixUI_FeatureTree"
+                InstallDirectory="INSTALLFOLDER"
+        />
+
+        <Feature Id="Main" Description="!(loc.CLIFeatureDescription)" Title="!(loc.CLIFeatureTitle)" ConfigurableDirectory="INSTALLFOLDER" AllowAbsent="false">
+            <ComponentGroupRef Id="CLI" Primary="true" />
+            <ComponentRef Id="RemoveFilesComponent" />
+            <Feature Id="AddToPath" Description="!(loc.PathFeatureDescription)" Title="!(loc.PathFeatureTitle)">
+                <ComponentGroupRef Id="PathEnvironment" Primary="true" />
+            </Feature>
+        </Feature>
+        <Feature Id="UI" Description="!(loc.UIFeatureDescription)" Title="!(loc.UIFeatureTitle)" ConfigurableDirectory="INSTALLFOLDER">
+            <ComponentGroupRef Id="UI" Primary="false" />
+            <ComponentRef Id="SpriggitShortcut" />
+        </Feature>
+    </Package>
+</Wix>

Spriggit.Installer.Windows/PathComponent.wxs

@@ -0,0 +1,11 @@
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
+  <Fragment>
+    <ComponentGroup Id="PathEnvironment" Directory="INSTALLFOLDER">
+      <Component Id="PathEnvironmentComponent" Guid="{A31D9A82-9E0A-423F-ADFA-6831046B2184}">
+        <Environment Id="PATH" Name="PATH" Value="[INSTALLFOLDER]" Permanent="no" Part="last" Action="set" System="no" />
+
+        <RegistryValue Root="HKCU" Key="Software\Mutagen Modding\Spriggit" Name="PathAdded" Type="string" Value="[INSTALLFOLDER]" KeyPath="yes" />
+      </Component>
+    </ComponentGroup>
+  </Fragment>
+</Wix>

Spriggit.Installer.Windows/Spriggit.Installer.Windows.wixproj

@@ -0,0 +1,25 @@
+<Project Sdk="WixToolset.Sdk/6.0.1">
+  <ItemGroup>
+    <ProjectReference Include="..\Spriggit.CLI\Spriggit.CLI.csproj">
+      <SetProperty>CopyLocalLockFileAssemblies=true</SetProperty>
+    </ProjectReference>
+    <ProjectReference Include="..\Spriggit.UI\Spriggit.UI.csproj">
+      <Name>Spriggit.UI</Name>
+      <Project>{3d0f2999-8e79-4cac-9804-971efc6eda21}</Project>
+      <Private>True</Private>
+      <DoNotHarvest>True</DoNotHarvest>
+      <RefProjectOutputGroups>Binaries;Content;Satellites</RefProjectOutputGroups>
+      <RefTargetDir>INSTALLFOLDER</RefTargetDir>
+    </ProjectReference>
+  </ItemGroup>
+  <ItemGroup>
+    <PackageReference Include="WixToolset.UI.wixext" />
+  </ItemGroup>
+    <PropertyGroup>
+        <SuppressIces>ICE91,ICE69,ICE90</SuppressIces>
+        <Configurations>Debug;Release</Configurations>
+        <Platforms>AnyCPU</Platforms>
+    </PropertyGroup>
+
+    <Target Name="Pack"></Target>
+</Project>

Spriggit.Installer.Windows/UIComponents.wxs

@@ -0,0 +1,25 @@
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
+    <Fragment>
+        <ComponentGroup Id="UI" Directory="INSTALLFOLDER">
+            <Component Id="SpriggitUIExe" Guid="{6E169807-104A-4D7F-A29B-486BFC1E6E39}">
+                <RegistryValue Root="HKCU" Key="Software\Mutagen Modding\Spriggit" Name="UIInstalled" Type="string" Value="[INSTALLFOLDER]" KeyPath="yes" />
+                <File Id="Spriggit.exe" Source="win-x64\publish\Spriggit.exe" />
+                <File Source="win-x64\publish\D3DCompiler_47_cor3.dll" />
+                <File Source="win-x64\publish\PenImc_cor3.dll" />
+                <File Source="win-x64\publish\PresentationNative_cor3.dll" />
+                <File Source="win-x64\publish\Spriggit.pdb" />
+                <File Source="win-x64\publish\Spriggit.xml" />
+                <File Source="win-x64\publish\vcruntime140_cor3.dll" />
+                <File Source="win-x64\publish\wpfgfx_cor3.dll" />
+            </Component>
+        </ComponentGroup>
+
+        <DirectoryRef Id="SPRIGGITSTARTMENUFOLDER">
+            <Component Id="SpriggitShortcut" Guid="{9223DFBC-8AE7-44A5-AB99-80FE7CC1A778}">
+                <Shortcut Id="SpriggitStartMenuShortcut" Name="Spriggit" Target="[#Spriggit.exe]" WorkingDirectory="INSTALLFOLDER" />
+                <RegistryValue Root="HKCU" Key="Software\Mutagen Modding\Spriggit" Name="UIStartMenuShortcut" Type="string" Value="[SPRIGGITSTARTMENUFOLDER]" KeyPath="true" />
+                <RemoveFolder On="uninstall" Id="CleanUpSpriggitShortcut" Directory="SPRIGGITSTARTMENUFOLDER" />
+            </Component>
+        </DirectoryRef>
+    </Fragment>
+</Wix>

Spriggit.sln

@@ -47,6 +47,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Spriggit.Tests.Windows", "S
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Spriggit.TranslationPackages", "Translation Packages\Spriggit.TranslationPackages\Spriggit.TranslationPackages.csproj", "{666126D1-1689-43AF-9946-14F83A833B72}"
 EndProject
+Project("{B7DD6F7E-DEF8-4E67-B5B7-07EF123DB6F0}") = "Spriggit.Installer.Windows", "Spriggit.Installer.Windows\Spriggit.Installer.Windows.wixproj", "{DCCAAC61-F98D-465D-A36F-62BFE520DB72}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -117,6 +119,10 @@ Global
 		{666126D1-1689-43AF-9946-14F83A833B72}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{666126D1-1689-43AF-9946-14F83A833B72}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{666126D1-1689-43AF-9946-14F83A833B72}.Release|Any CPU.Build.0 = Release|Any CPU
+		{DCCAAC61-F98D-465D-A36F-62BFE520DB72}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{DCCAAC61-F98D-465D-A36F-62BFE520DB72}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{DCCAAC61-F98D-465D-A36F-62BFE520DB72}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{DCCAAC61-F98D-465D-A36F-62BFE520DB72}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE