ManagedBlam Support: New bitmap automatic compression and override settings, migrated janky ShaderGen code to MB

.github/workflows/dotnet-6.yml

@@ -34,7 +34,7 @@ jobs:
       uses: actions/upload-artifact@v2
       with:
         name: launcher
-        path: Launcher\bin\Release\net6.0-windows\win-x64\publish\
+        path: Launcher\bin\Release\x64\net6.0-windows\win-x64\publish\
 
   release:
     if: |

.github/workflows/dotnet-next.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: windows-latest
     strategy:
       matrix: # https://stackoverflow.com/a/68940067/16608030 hopefully this still works
-        dotnet: [ {version: '5.0.x', path: net5.0-windows}, {version: '6.0.x', path: net6.0-windows} ]
+        dotnet: [ {version: '6.0.x', path: net6.0-windows}, {version: '8.0.x', path: net8.0-windows}, {version: '9.0.x', path: net9.0-windows} ]
     env:
       DOTNET_CLI_TELEMETRY_OPTOUT : true
     steps:
@@ -37,6 +37,6 @@ jobs:
       uses: actions/upload-artifact@v2
       with:
         name: launcher
-        path: Launcher\bin\Release\${{ matrix.dotnet.path}}\win-x64\publish\
+        path: Launcher\bin\x64\Release\${{ matrix.dotnet.path}}\win-x64\publish\
 
 

.gitignore

@@ -1,9 +1,14 @@
-*/bin/*
+/Launcher/bin/*
 */obj/*
 *.vs/*
 *.zip
 *.exe
 *.dll
+!/OsoyoosMB/ref/ManagedBlam.dll
 !/packages/Resource.Embedder.2.1.1/tasks/net46/*.dll
 /icon_assets.7z
 /Launcher/Properties/launchSettings.json
+/OsoyoosMB/.vs/*
+/OsoyoosMB/OsoyoosMB/obj/*
+/OsoyoosMB/OsoyoosMB/bin/*
+/OsoyoosMB/OsoyoosMB/.vs/*

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2017 num0005
+Copyright (c) 2017 num0005  
 Copyright (c) 2022 Osoyoos Launcher Contributors
 
 Unless otherwise noted files in this repository are licensed under the terms of the MIT license (reproduced below).

Launcher/MainWindow.xaml

@@ -30,6 +30,11 @@
                 <x:Type TypeName="local:ThemeType"/>
             </ObjectDataProvider.MethodParameters>
         </ObjectDataProvider>
+        <ObjectDataProvider x:Key="BitmapCompressionTypeValues" MethodName="GetValues" ObjectType="{x:Type sys:Enum}">
+            <ObjectDataProvider.MethodParameters>
+                <x:Type TypeName="local:BitmapCompressionType"/>
+            </ObjectDataProvider.MethodParameters>
+        </ObjectDataProvider>
     </Window.Resources>
     <Grid Background="{DynamicResource WindowPrimaryColor}">
         <Grid.ColumnDefinitions>
@@ -521,6 +526,17 @@
                                                         <ComboBoxItem Content="Sprites"/>
                                                         <ComboBoxItem Content="Interface"/>
                                                     </ComboBox>
+                                                    <ComboBox Grid.Row="0" Grid.Column="1" x:Name="bitmap_compression_type" SelectedIndex="0" Visibility="{Binding SelectedIndex, Converter={StaticResource ProfiletoVisibility}, ConverterParameter=25, ElementName=toolkit_selection}" ToolTip="Set compression for imported images. Automatically forces &quot;pretty&quot; curve mode." Margin="0,0,208,8" Grid.RowSpan="2" ItemsSource="{Binding Source={StaticResource BitmapCompressionTypeValues}}"></ComboBox>
+                                                    <Label Grid.Column="1" x:Name="compression_type_label" HorizontalAlignment="Left" VerticalAlignment="Top" Foreground="{DynamicResource TextColor}" Visibility="{Binding SelectedIndex, Converter={StaticResource ProfiletoVisibility}, ConverterParameter=25, ElementName=toolkit_selection}" Content="Compression Type" Margin="195,0,89,0" RenderTransformOrigin="0.5,0.5">
+                                                        <Label.RenderTransform>
+                                                            <TransformGroup>
+                                                                <ScaleTransform ScaleX="1"/>
+                                                                <SkewTransform/>
+                                                                <RotateTransform/>
+                                                                <TranslateTransform/>
+                                                            </TransformGroup>
+                                                        </Label.RenderTransform>
+                                                    </Label>
                                                     <CheckBox Grid.Row="2" Grid.Column="1" x:Name="debug_plate" Content="Debug Plate" HorizontalAlignment="Left" VerticalAlignment="Center" Foreground="{DynamicResource TextColor}" Visibility="{Binding SelectedIndex, Converter={StaticResource ProfiletoVisibility}, ConverterParameter=1, ElementName=toolkit_selection}" ToolTip="Dump the plate for debugging (you likely don't need this)."/>
                                                 </Grid>
                                             </GroupBox>

Launcher/MainWindow.xaml.cs

@@ -16,6 +16,7 @@
 using System.Xml.Linq;
 using System.Threading;
 using System.Reflection;
+using System.Runtime.Serialization;
 
 namespace ToolkitLauncher
 {
@@ -414,6 +415,41 @@
         ui_music
     }
 
+    [TypeConverter(typeof(EnumDescriptionTypeConverter))]
+    public enum BitmapCompressionType
+    {
+        [Description("Default")]
+        [EnumMember(Value = "0")]
+        Default,
+        [Description("DXT5")]
+        [EnumMember(Value = "15")]
+        DXT5,
+        [Description("DXT1")]
+        [EnumMember(Value = "13")]
+        DXT1,
+        [Description("24-bit Color + 8-bit Alpha")]
+        [EnumMember(Value = "16")]
+        Color24BitAlpha8Bit,
+        [Description("Best Compressed Color")]
+        [EnumMember(Value = "1")]
+        BestCompressedColor,
+        [Description("Uncompressed")]
+        [EnumMember(Value = "2")]
+        Uncompressed
+    }
+
+    // Return the associated EnumMember string value given the selected value of the compression type above
+    public static class EnumExtensions
+    {
+        public static string GetEnumMemberValue(this Enum enumValue)
+        {
+            var fieldInfo = enumValue.GetType().GetField(enumValue.ToString());
+            var attribute = (EnumMemberAttribute)fieldInfo.GetCustomAttributes(typeof(EnumMemberAttribute), false)[0];
+
+            return attribute.Value;
+        }
+    }
+
     /// <summary>
     /// Interaction logic for MainWindow.xaml
     /// </summary>
@@ -1081,7 +1117,8 @@
         private async void CompileImage(object sender, RoutedEventArgs e)
         {
             string listEntry = BitmapCompile.bitmapType[bitmap_compile_type.SelectedIndex];
-            await toolkit.ImportBitmaps(compile_image_path.Text, listEntry, debug_plate.IsChecked is true);
+            BitmapCompressionType selectedComp = (BitmapCompressionType)bitmap_compression_type.SelectedItem; // Convert selected compression string to enum value
+            await toolkit.ImportBitmaps(compile_image_path.Text, listEntry, selectedComp.GetEnumMemberValue(), toolkit.GetDataDirectory(), debug_plate.IsChecked is true);
         }
 
         private async void PackageLevel(object sender, RoutedEventArgs e)
@@ -1883,7 +1920,7 @@
             }
         }
 
         private async Task ConvertFBX()
         {
             HRToolkit tool = toolkit as HRToolkit;
 
@@ -1919,7 +1956,7 @@
                                     if (!(bool)show_output.IsChecked)
                                         Thread.Sleep(250);
 
                                     tool.GR2FromFBX(f, getFilepath(f) + ".json", getFilepath(f) + ".gr2", (json_rebuild.IsChecked == true) ? "recreate_json" : "", (bool)show_output.IsChecked);
                                     count++;
                                 }
                             }
@@ -1946,7 +1983,7 @@
                                 if (!(bool)show_output.IsChecked)
                                     Thread.Sleep(250);
 
                                 tool.GR2FromFBX(f, getFilepath(f) + ".json", getFilepath(f) + ".gr2", (json_rebuild.IsChecked == true) ? "recreate_json" : "", (bool)show_output.IsChecked);
                                 count++;
                             }
                         }
@@ -1976,7 +2013,7 @@
                                 if (!(bool)show_output.IsChecked)
                                     Thread.Sleep(250);
 
                                 tool.GR2FromFBX(f, getFilepath(f) + ".json", getFilepath(f) + ".gr2", (json_rebuild.IsChecked == true) ? "recreate_json" : "", (bool)show_output.IsChecked);
                                 count++;
                             }
                         }
@@ -2053,7 +2090,7 @@
         }
 
         // Generate a Sidecar when the user has opted to create one for a model
         private async Task GenerateModelSidecar()
         {
             XDocument srcTree = new XDocument(
                 new XElement("Metadata", WriteHeader(),
@@ -2071,7 +2108,7 @@
                 MessageBox.Show("Sidecar Generated Successfully!");
         }
 
         private async Task GenerateStructureSidecar()
         {
             XDocument srcTree = new XDocument(
                 new XElement("Metadata", WriteHeader(),
@@ -2093,7 +2130,7 @@
                 MessageBox.Show("Sidecar Generated Successfully!");
         }
 
         private async Task GenerateDecoratorSidecar()
         {
             XDocument srcTree = new XDocument(
                 new XElement("Metadata", WriteHeader(),
@@ -2113,7 +2150,7 @@
                 MessageBox.Show("Sidecar Generated Successfully!");
         }
 
         private async Task GenerateParticleSidecar()
         {
             XDocument srcTree = new XDocument(
                 new XElement("Metadata", WriteHeader(),
@@ -2133,7 +2170,7 @@
                 MessageBox.Show("Sidecar Generated Successfully!");
         }
 
         private async Task GenerateCinematicSidecar()
         {
             XDocument srcTree = new XDocument(
                 new XElement("Metadata", WriteHeader(),
@@ -2172,7 +2209,7 @@
                         new XElement("OutputTagCollection",
                             new XElement("OutputTag", new XAttribute("Type", "cinematic_scene"), dataPath + "\\" + assetName))
                     ));
                 XElement co = null;
             }
 
             return null;

Launcher/ToolkitInterface/H1AToolkit.cs

@@ -170,7 +170,7 @@ public async Task JMSFromFBX(string fbxPath, string jmsPath, string geo_class)
         /// <param name="path"></param>
         /// <param name="type"></param>
         /// <returns></returns>
-        override public async Task ImportBitmaps(string path, string type, bool debug_plate)
+        override public async Task ImportBitmaps(string path, string type, string compression, string data_path, bool debug_plate)
         {
             await RunTool(ToolType.Tool, new List<string>() { "bitmaps", path, type, debug_plate.ToString() });
         }

Launcher/ToolkitInterface/H1Toolkit.cs

@@ -78,7 +78,7 @@ public override async Task ImportSound(string path, string platform, string bitr
             await RunTool(ToolType.Tool, new List<string>() { "sounds", path, platform, bitrate });
         }
 
-        override public async Task ImportBitmaps(string path, string type, bool debug_plate)
+        override public async Task ImportBitmaps(string path, string type, string compression, string data_path, bool debug_plate)
         {
             await RunTool(ToolType.Tool, new List<string>() { "bitmaps", path });
         }

Launcher/ToolkitInterface/H2AToolkit.cs

@@ -60,7 +60,7 @@ protected override string sapienWindowClass
             get => "Sapien";
         }
 
-        override public async Task ImportBitmaps(string path, string type, bool debug_plate)
+        override public async Task ImportBitmaps(string path, string type, string compression, string data_path, bool debug_plate)
         {
             await RunTool(ToolType.Tool, new() { "bitmaps", path, type, debug_plate.ToString() });
         }

Launcher/ToolkitInterface/H2Toolkit.cs

@@ -19,7 +19,7 @@ protected virtual string sapienWindowClass
             get => "Sapien";
         }
 
-        override public async Task ImportBitmaps(string path, string type, bool debug_plate)
+        override public async Task ImportBitmaps(string path, string type, string compression, string data_path, bool debug_plate)
         {
             string bitmaps_command = "bitmaps";
             if (Profile.CommunityTools || Profile.BuildType == build_type.release_mcc)

Launcher/ToolkitInterface/H3Toolkit.cs

@@ -23,9 +23,19 @@ protected string sapienWindowClass
             get => "Sapien";
         }
 
-        override public async Task ImportBitmaps(string path, string type, bool debug_plate)
+        override public async Task ImportBitmaps(string path, string type, string compression, string data_path, bool debug_plate)
         {
+            // First import
             await RunTool(ToolType.Tool, new List<string>() { debug_plate ? "bitmaps-debug" : "bitmaps", path });
+
+            // Call managedblam
+            bool MB_success = ManagedBlam.RunMBBitmaps(BaseDirectory, path, compression);
+
+            if (MB_success)
+            {
+                // Reimport bitmaps
+                await RunTool(ToolType.Tool, new List<string>() { debug_plate ? "bitmaps-debug" : "bitmaps", path });
+            }
         }
 
         override public async Task ImportUnicodeStrings(string path)

Launcher/ToolkitInterface/ToolkitBase.cs

@@ -121,7 +121,7 @@ public record ImportArgs(
         /// <param name="path">Directory containing the bitmaps</param>
         /// <param name="type">The type of bitmap to import it by</param>
         /// <param name="debug_plate">MCC H1A: Whether or not we dump plate data to the data folder for inspection</param>
-        public abstract Task ImportBitmaps(string path, string type, bool debug_plate = false);
+        public abstract Task ImportBitmaps(string path, string type, string compression, string data_path, bool debug_plate = false);
 
         /// <summary>
         /// How build cache will handle resources

Launcher/ToolkitLauncher.csproj

@@ -21,6 +21,7 @@
     <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
     <UseWindowsForms>true</UseWindowsForms>
     <UseWPF>true</UseWPF>
+	<Platforms>AnyCPU;x64;x86</Platforms>
   </PropertyGroup>
   <PropertyGroup>
     <ApplicationIcon>icon.ico</ApplicationIcon>

Launcher/Utility/ManagedBlam.cs

@@ -0,0 +1,51 @@
+using System;
+using System.Diagnostics;
+using System.IO;
+using System.Windows.Forms;
+
+namespace ToolkitLauncher.Utility
+{
+    public class ManagedBlam
+    {
+        public static bool RunMBBitmaps(string ek_path, string tag_path, string compression_type)
+        {
+            string exe_path = Path.Combine(ek_path, @"bin\OsoyoosMB.exe");
+
+            if (File.Exists(exe_path))
+            {
+                ProcessStartInfo startInfo = new ProcessStartInfo
+                {
+                    FileName = exe_path,
+                    Arguments = $"getbitmapdata \"{ek_path}\" \"{tag_path.TrimEnd('\\')}\" \"{compression_type}\"",
+                    UseShellExecute = false,
+                    RedirectStandardOutput = true,
+                    RedirectStandardError = true,
+                    CreateNoWindow = true
+                };
+
+                try
+                {
+                    // Start the process
+                    using (System.Diagnostics.Process process = System.Diagnostics.Process.Start(startInfo))
+                    {
+                        process.WaitForExit();
+                        return true;
+                    }
+                }
+                catch
+                {
+                    // Handle any errors that might occur
+                    MessageBox.Show("Unspecified ManagedBlam error.\nBitmaps have still been imported, but settings will not be applied.", "Error", MessageBoxButtons.OK, MessageBoxIcon.Error);
+                    return false;
+                }
+            }
+            else
+            {
+                // User likely hasnt put the second exe in the right place
+                MessageBox.Show($"Error: Cannot find \"{exe_path}\".\nMake sure the OsoyoosMB.exe is in your editing kit's \"bin\" folder.\nBitmaps have still been imported, but settings will not be applied.", "Error", MessageBoxButtons.OK, MessageBoxIcon.Error);
+                return false;
+            }
+
+        }
+    }
+}

OsoyoosMB/OsoyoosMB/App.config

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<configuration>
+    <startup> 
+        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8" />
+    </startup>
+</configuration>