Bump version

.github/workflows/build_nupkg.yml

@@ -0,0 +1,43 @@
+name: Nuget Pack
+
+on:
+  push:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: 8.0.x
+        
+    - name: Restore dependencies
+      run: dotnet restore
+      
+    - name: Pack
+      run: dotnet pack
+
+    - name: Upload build
+      uses: actions/upload-artifact@v4
+      with:
+        name: 'Nuget Package'
+        path: 'bin/Release/*.nupkg'
+
+    - name: Upload to rolling
+      uses: ncipollo/release-action@v1.14.0
+      with:
+        allowUpdates: True
+        artifacts: 'bin/Release/*.nupkg'
+        body: 'Last built commit: ${{ github.sha }}'
+        name: 'Rolling Release'
+        prerelease: True
+        replacesArtifacts: True
+        tag: "rolling"
+        updateOnlyUnreleased: True

.github/workflows/check_pr.yml

@@ -0,0 +1,17 @@
+name: Build PR
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: 8.0.x
+      
+    - name: Build
+      run: dotnet build

CrossModel/ArchiveDotOrg.Serializer.cs

@@ -10,7 +10,7 @@ namespace SabreTools.Serialization.CrossModel
         {
             if (item == null)
                 return null;
-            
+
             var metadataFile = new Models.Metadata.MetadataFile
             {
                 [Models.Metadata.MetadataFile.HeaderKey] = ConvertHeaderToInternalModel(item),
@@ -45,10 +45,12 @@ namespace SabreTools.Serialization.CrossModel
         /// </summary>
         private static Models.Metadata.Machine ConvertMachineToInternalModel(Models.ArchiveDotOrg.File? item)
         {
-            var machine = new Models.Metadata.Machine
-            {
-                [Models.Metadata.Machine.RomKey] = ConvertToInternalModel(item),
-            };
+            var machine = new Models.Metadata.Machine();
+
+            var rom = ConvertToInternalModel(item);
+            if (rom != null)
+                machine[Models.Metadata.Machine.RomKey] = new Models.Metadata.Rom[] { rom };
+
             return machine;
         }
 

CrossModel/Listrom.Serializer.cs

@@ -81,6 +81,7 @@ namespace SabreTools.Serialization.CrossModel
             {
                 var disk = new Models.Metadata.Disk
                 {
+                    [Models.Metadata.DatItem.TypeKey] = "disk",
                     [Models.Metadata.Disk.NameKey] = item.Name,
                     [Models.Metadata.Disk.MD5Key] = item.MD5,
                     [Models.Metadata.Disk.SHA1Key] = item.SHA1,
@@ -97,6 +98,7 @@ namespace SabreTools.Serialization.CrossModel
             {
                 var rom = new Models.Metadata.Rom
                 {
+                    [Models.Metadata.DatItem.TypeKey] = "rom",
                     [Models.Metadata.Rom.NameKey] = item.Name,
                     [Models.Metadata.Rom.SizeKey] = item.Size,
                     [Models.Metadata.Rom.CRCKey] = item.CRC,

CrossModel/Listxml.Deserializer.cs

@@ -308,7 +308,7 @@ namespace SabreTools.Serialization.CrossModel
             {
                 Name = item.ReadString(Models.Metadata.Chip.NameKey),
                 Tag = item.ReadString(Models.Metadata.Chip.TagKey),
-                Type = item.ReadString(Models.Metadata.Chip.TypeKey),
+                Type = item.ReadString(Models.Metadata.Chip.ChipTypeKey),
                 SoundOnly = item.ReadString(Models.Metadata.Chip.SoundOnlyKey),
                 Clock = item.ReadString(Models.Metadata.Chip.ClockKey),
             };
@@ -407,7 +407,7 @@ namespace SabreTools.Serialization.CrossModel
         {
             var control = new Control
             {
-                Type = item.ReadString(Models.Metadata.Control.TypeKey),
+                Type = item.ReadString(Models.Metadata.Control.ControlTypeKey),
                 Player = item.ReadString(Models.Metadata.Control.PlayerKey),
                 Buttons = item.ReadString(Models.Metadata.Control.ButtonsKey),
                 ReqButtons = item.ReadString(Models.Metadata.Control.ReqButtonsKey),
@@ -430,7 +430,7 @@ namespace SabreTools.Serialization.CrossModel
         {
             var device = new Device
             {
-                Type = item.ReadString(Models.Metadata.Device.TypeKey),
+                Type = item.ReadString(Models.Metadata.Device.DeviceTypeKey),
                 Tag = item.ReadString(Models.Metadata.Device.TagKey),
                 FixedImage = item.ReadString(Models.Metadata.Device.FixedImageKey),
                 Mandatory = item.ReadString(Models.Metadata.Device.MandatoryKey),
@@ -563,7 +563,7 @@ namespace SabreTools.Serialization.CrossModel
             var display = new Display
             {
                 Tag = item.ReadString(Models.Metadata.Display.TagKey),
-                Type = item.ReadString(Models.Metadata.Display.TypeKey),
+                Type = item.ReadString(Models.Metadata.Display.DisplayTypeKey),
                 Rotate = item.ReadString(Models.Metadata.Display.RotateKey),
                 FlipX = item.ReadString(Models.Metadata.Display.FlipXKey),
                 Width = item.ReadString(Models.Metadata.Display.WidthKey),
@@ -621,7 +621,7 @@ namespace SabreTools.Serialization.CrossModel
         {
             var feature = new Feature
             {
-                Type = item.ReadString(Models.Metadata.Feature.TypeKey),
+                Type = item.ReadString(Models.Metadata.Feature.FeatureTypeKey),
                 Status = item.ReadString(Models.Metadata.Feature.StatusKey),
                 Overall = item.ReadString(Models.Metadata.Feature.OverallKey),
             };

CrossModel/Listxml.Serializer.cs

@@ -264,7 +264,7 @@ namespace SabreTools.Serialization.CrossModel
             {
                 [Models.Metadata.Chip.NameKey] = item.Name,
                 [Models.Metadata.Chip.TagKey] = item.Tag,
-                [Models.Metadata.Chip.TypeKey] = item.Type,
+                [Models.Metadata.Chip.ChipTypeKey] = item.Type,
                 [Models.Metadata.Chip.SoundOnlyKey] = item.SoundOnly,
                 [Models.Metadata.Chip.ClockKey] = item.Clock,
             };
@@ -359,7 +359,7 @@ namespace SabreTools.Serialization.CrossModel
         {
             var control = new Models.Metadata.Control
             {
-                [Models.Metadata.Control.TypeKey] = item.Type,
+                [Models.Metadata.Control.ControlTypeKey] = item.Type,
                 [Models.Metadata.Control.PlayerKey] = item.Player,
                 [Models.Metadata.Control.ButtonsKey] = item.Buttons,
                 [Models.Metadata.Control.ReqButtonsKey] = item.ReqButtons,
@@ -382,7 +382,7 @@ namespace SabreTools.Serialization.CrossModel
         {
             var device = new Models.Metadata.Device
             {
-                [Models.Metadata.Device.TypeKey] = item.Type,
+                [Models.Metadata.Device.DeviceTypeKey] = item.Type,
                 [Models.Metadata.Device.TagKey] = item.Tag,
                 [Models.Metadata.Device.FixedImageKey] = item.FixedImage,
                 [Models.Metadata.Device.MandatoryKey] = item.Mandatory,
@@ -509,7 +509,7 @@ namespace SabreTools.Serialization.CrossModel
             var display = new Models.Metadata.Display
             {
                 [Models.Metadata.Display.TagKey] = item.Tag,
-                [Models.Metadata.Display.TypeKey] = item.Type,
+                [Models.Metadata.Display.DisplayTypeKey] = item.Type,
                 [Models.Metadata.Display.RotateKey] = item.Rotate,
                 [Models.Metadata.Display.FlipXKey] = item.FlipX,
                 [Models.Metadata.Display.WidthKey] = item.Width,
@@ -567,7 +567,7 @@ namespace SabreTools.Serialization.CrossModel
         {
             var feature = new Models.Metadata.Feature
             {
-                [Models.Metadata.Feature.TypeKey] = item.Type,
+                [Models.Metadata.Feature.FeatureTypeKey] = item.Type,
                 [Models.Metadata.Feature.StatusKey] = item.Status,
                 [Models.Metadata.Feature.OverallKey] = item.Overall,
             };

CrossModel/OpenMSX.Deserializer.cs

@@ -100,7 +100,7 @@ namespace SabreTools.Serialization.CrossModel
             var megaRom = new MegaRom
             {
                 Start = item.ReadString(Models.Metadata.Rom.StartKey),
-                Type = item.ReadString(Models.Metadata.Rom.TypeKey),
+                Type = item.ReadString(Models.Metadata.Rom.OpenMSXType),
                 Hash = item.ReadString(Models.Metadata.Rom.SHA1Key),
                 Remark = item.ReadString(Models.Metadata.Rom.RemarkKey),
             };
@@ -128,7 +128,7 @@ namespace SabreTools.Serialization.CrossModel
             var rom = new Rom
             {
                 Start = item.ReadString(Models.Metadata.Rom.StartKey),
-                Type = item.ReadString(Models.Metadata.Rom.TypeKey),
+                Type = item.ReadString(Models.Metadata.Rom.OpenMSXType),
                 Hash = item.ReadString(Models.Metadata.Rom.SHA1Key),
                 Remark = item.ReadString(Models.Metadata.Rom.RemarkKey),
             };
@@ -143,7 +143,7 @@ namespace SabreTools.Serialization.CrossModel
             var sccPlusCart = new SCCPlusCart
             {
                 Start = item.ReadString(Models.Metadata.Rom.StartKey),
-                Type = item.ReadString(Models.Metadata.Rom.TypeKey),
+                Type = item.ReadString(Models.Metadata.Rom.OpenMSXType),
                 Hash = item.ReadString(Models.Metadata.Rom.SHA1Key),
                 Remark = item.ReadString(Models.Metadata.Rom.RemarkKey),
             };

CrossModel/OpenMSX.Serializer.cs

@@ -118,7 +118,7 @@ namespace SabreTools.Serialization.CrossModel
             var rom = new Models.Metadata.Rom
             {
                 [Models.Metadata.Rom.StartKey] = item.Start,
-                [Models.Metadata.Rom.TypeKey] = item.Type,
+                [Models.Metadata.Rom.OpenMSXType] = item.Type,
                 [Models.Metadata.Rom.SHA1Key] = item.Hash,
                 [Models.Metadata.Rom.RemarkKey] = item.Remark,
             };

CrossModel/SeparatedValue.Deserializer.cs

@@ -21,7 +21,7 @@ namespace SabreTools.Serialization.CrossModel
             {
                 metadataFile.Row = machines
                     .Where(m => m != null)
-                    .SelectMany(ConvertMachineFromInternalModel)
+                    .SelectMany(m => ConvertMachineFromInternalModel(m, header))
                     .ToArray();
             }
 
@@ -43,7 +43,7 @@ namespace SabreTools.Serialization.CrossModel
         /// <summary>
         /// Convert from <cref="Models.Metadata.Machine"/> to an array of <cref="Models.SeparatedValue.Row"/>
         /// </summary>
-        private static Row[] ConvertMachineFromInternalModel(Models.Metadata.Machine item)
+        private static Row[] ConvertMachineFromInternalModel(Models.Metadata.Machine item, Models.Metadata.Header? header)
         {
             var rowItems = new List<Row>();
 
@@ -52,7 +52,7 @@ namespace SabreTools.Serialization.CrossModel
             {
                 rowItems.AddRange(roms
                     .Where(r => r != null)
-                    .Select(rom => ConvertFromInternalModel(rom, item)));
+                    .Select(rom => ConvertFromInternalModel(rom, item, header)));
             }
 
             var disks = item.Read<Models.Metadata.Disk[]>(Models.Metadata.Machine.DiskKey);
@@ -60,7 +60,7 @@ namespace SabreTools.Serialization.CrossModel
             {
                 rowItems.AddRange(disks
                     .Where(d => d != null)
-                    .Select(disk => ConvertFromInternalModel(disk, item)));
+                    .Select(disk => ConvertFromInternalModel(disk, item, header)));
             }
 
             var media = item.Read<Models.Metadata.Media[]>(Models.Metadata.Machine.MediaKey);
@@ -68,7 +68,7 @@ namespace SabreTools.Serialization.CrossModel
             {
                 rowItems.AddRange(media
                     .Where(m => m != null)
-                    .Select(medium => ConvertFromInternalModel(medium, item)));
+                    .Select(medium => ConvertFromInternalModel(medium, item, header)));
             }
 
             return rowItems.ToArray();
@@ -77,16 +77,26 @@ namespace SabreTools.Serialization.CrossModel
         /// <summary>
         /// Convert from <cref="Models.Metadata.Disk"/> to <cref="Models.SeparatedValue.Row"/>
         /// </summary>
-        private static Row ConvertFromInternalModel(Models.Metadata.Disk item, Models.Metadata.Machine parent)
+        private static Row ConvertFromInternalModel(Models.Metadata.Disk item, Models.Metadata.Machine parent, Models.Metadata.Header? header)
         {
             var row = new Row
             {
+                FileName = header?.ReadString("FILENAME"), // TODO: Make this an actual key to retrieve
+                InternalName = header?.ReadString(Models.Metadata.Header.NameKey),
+                Description = header?.ReadString(Models.Metadata.Header.DescriptionKey),
                 GameName = parent.ReadString(Models.Metadata.Machine.NameKey),
-                Description = parent.ReadString(Models.Metadata.Machine.DescriptionKey),
+                GameDescription = parent.ReadString(Models.Metadata.Machine.DescriptionKey),
                 Type = "disk",
+                RomName = null,
                 DiskName = item.ReadString(Models.Metadata.Disk.NameKey),
+                Size = null,
+                CRC = null,
                 MD5 = item.ReadString(Models.Metadata.Disk.MD5Key),
                 SHA1 = item.ReadString(Models.Metadata.Disk.SHA1Key),
+                SHA256 = null,
+                SHA384 = null,
+                SHA512 = null,
+                SpamSum = null,
                 Status = item.ReadString(Models.Metadata.Disk.StatusKey),
             };
             return row;
@@ -95,17 +105,25 @@ namespace SabreTools.Serialization.CrossModel
         /// <summary>
         /// Convert from <cref="Models.Metadata.Media"/> to <cref="Models.SeparatedValue.Row"/>
         /// </summary>
-        private static Row ConvertFromInternalModel(Models.Metadata.Media item, Models.Metadata.Machine parent)
+        private static Row ConvertFromInternalModel(Models.Metadata.Media item, Models.Metadata.Machine parent, Models.Metadata.Header? header)
         {
             var row = new Row
             {
+                FileName = header?.ReadString("FILENAME"), // TODO: Make this an actual key to retrieve
+                InternalName = header?.ReadString(Models.Metadata.Header.NameKey),
+                Description = header?.ReadString(Models.Metadata.Header.DescriptionKey),
                 GameName = parent.ReadString(Models.Metadata.Machine.NameKey),
-                Description = parent.ReadString(Models.Metadata.Machine.DescriptionKey),
+                GameDescription = parent.ReadString(Models.Metadata.Machine.DescriptionKey),
                 Type = "media",
+                RomName = null,
                 DiskName = item.ReadString(Models.Metadata.Media.NameKey),
+                Size = null,
+                CRC = null,
                 MD5 = item.ReadString(Models.Metadata.Media.MD5Key),
                 SHA1 = item.ReadString(Models.Metadata.Media.SHA1Key),
                 SHA256 = item.ReadString(Models.Metadata.Media.SHA256Key),
+                SHA384 = null,
+                SHA512 = null,
                 SpamSum = item.ReadString(Models.Metadata.Media.SpamSumKey),
             };
             return row;
@@ -114,14 +132,18 @@ namespace SabreTools.Serialization.CrossModel
         /// <summary>
         /// Convert from <cref="Models.Metadata.Rom"/> to <cref="Models.SeparatedValue.Row"/>
         /// </summary>
-        private static Row ConvertFromInternalModel(Models.Metadata.Rom item, Models.Metadata.Machine parent)
+        private static Row ConvertFromInternalModel(Models.Metadata.Rom item, Models.Metadata.Machine parent, Models.Metadata.Header? header)
         {
             var row = new Row
             {
-                GameName = parent?.ReadString(Models.Metadata.Machine.NameKey),
-                Description = parent?.ReadString(Models.Metadata.Machine.DescriptionKey),
+                FileName = header?.ReadString("FILENAME"), // TODO: Make this an actual key to retrieve
+                InternalName = header?.ReadString(Models.Metadata.Header.NameKey),
+                Description = header?.ReadString(Models.Metadata.Header.DescriptionKey),
+                GameName = parent.ReadString(Models.Metadata.Machine.NameKey),
+                GameDescription = parent.ReadString(Models.Metadata.Machine.DescriptionKey),
                 Type = "rom",
                 RomName = item.ReadString(Models.Metadata.Rom.NameKey),
+                DiskName = null,
                 Size = item.ReadString(Models.Metadata.Rom.SizeKey),
                 CRC = item.ReadString(Models.Metadata.Rom.CRCKey),
                 MD5 = item.ReadString(Models.Metadata.Rom.MD5Key),

Files/Logiqx.Serializer.cs

@@ -5,7 +5,7 @@ namespace SabreTools.Serialization.Files
     public partial class Logiqx : XmlFile<Datafile>
     {
         /// <inheritdoc cref="Serialize(Datafile, string, string?, string?, string?, string?)" />
-        public bool SerializeToFileWithDocType(Datafile obj, string path)
+        public bool SerializeToFileWithDocType(Datafile? obj, string path)
             => Serialize(obj, path, Serialization.Logiqx.DocTypeName, Serialization.Logiqx.DocTypePubId, Serialization.Logiqx.DocTypeSysId, Serialization.Logiqx.DocTypeSysId);
     }
 }

Files/OpenMSX.Serializer.cs

@@ -5,7 +5,7 @@ namespace SabreTools.Serialization.Files
     public partial class OpenMSX : XmlFile<SoftwareDb>
     {
         /// <inheritdoc cref="Serialize(SoftwareDb, string, string?, string?, string?, string?)" />
-        public bool SerializeToFileWithDocType(SoftwareDb obj, string path)
+        public bool SerializeToFileWithDocType(SoftwareDb? obj, string path)
             => Serialize(obj, path, Serialization.OpenMSX.DocTypeName, Serialization.OpenMSX.DocTypePubId, Serialization.OpenMSX.DocTypeSysId, Serialization.OpenMSX.DocTypeSysId);
     }
 }

Files/SoftwareList.Serializer.cs

@@ -3,7 +3,7 @@ namespace SabreTools.Serialization.Files
     public partial class SoftwareList : XmlFile<Models.SoftwareList.SoftwareList>
     {
         /// <inheritdoc cref="SerializeToFile(Models.SoftwareList.SoftwareList, string, string?, string?, string?, string?)" />
-        public bool SerializeToFileWithDocType(Models.SoftwareList.SoftwareList obj, string path)
+        public bool SerializeToFileWithDocType(Models.SoftwareList.SoftwareList? obj, string path)
             => Serialize(obj, path, Serialization.SoftawreList.DocTypeName, Serialization.SoftawreList.DocTypePubId, Serialization.SoftawreList.DocTypeSysId, Serialization.SoftawreList.DocTypeSysId);
     }
 }

SabreTools.Serialization.csproj

@@ -8,7 +8,7 @@
     <LangVersion>latest</LangVersion>
     <Nullable>enable</Nullable>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-    <Version>1.3.2</Version>
+    <Version>1.4.0</Version>
 
     <!-- Package Properties -->
     <Authors>Matt Nadareski</Authors>
@@ -27,8 +27,8 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="SabreTools.IO" Version="1.3.0" />
-    <PackageReference Include="SabreTools.Models" Version="1.3.0" />
+    <PackageReference Include="SabreTools.IO" Version="1.3.2" />
+    <PackageReference Include="SabreTools.Models" Version="1.4.0" />
   </ItemGroup>
 
 </Project>

Streams/AttractMode.Serializer.cs

@@ -28,6 +28,7 @@ namespace SabreTools.Serialization.Streams
             // TODO: Include flag to write out long or short header
             // Write the short header
             writer.WriteString(Serialization.AttractMode.HeaderWithoutRomname); // TODO: Convert to array of values
+            writer.WriteLine();
 
             // Write out the rows, if they exist
             WriteRows(obj.Row, writer);

Streams/RomCenter.Serializer.cs

@@ -48,15 +48,22 @@ namespace SabreTools.Serialization.Streams
             if (credits == null)
                 return;
 
-            writer.WriteSection("credits");
+            writer.WriteSection("CREDITS");
 
-            writer.WriteKeyValuePair("author", credits.Author);
-            writer.WriteKeyValuePair("version", credits.Version);
-            writer.WriteKeyValuePair("email", credits.Email);
-            writer.WriteKeyValuePair("homepage", credits.Homepage);
-            writer.WriteKeyValuePair("url", credits.Url);
-            writer.WriteKeyValuePair("date", credits.Date);
-            writer.WriteKeyValuePair("comment", credits.Comment);
+            if (credits.Author != null)
+                writer.WriteKeyValuePair("Author", credits.Author);
+            if (credits.Version != null)
+                writer.WriteKeyValuePair("Version", credits.Version);
+            if (credits.Email != null)
+                writer.WriteKeyValuePair("Email", credits.Email);
+            if (credits.Homepage != null)
+                writer.WriteKeyValuePair("Homepage", credits.Homepage);
+            if (credits.Url != null)
+                writer.WriteKeyValuePair("Url", credits.Url);
+            if (credits.Date != null)
+                writer.WriteKeyValuePair("Date", credits.Date);
+            if (credits.Comment != null)
+                writer.WriteKeyValuePair("Comment", credits.Comment);
             writer.WriteLine();
 
             writer.Flush();
@@ -73,12 +80,16 @@ namespace SabreTools.Serialization.Streams
             if (dat == null)
                 return;
 
-            writer.WriteSection("dat");
+            writer.WriteSection("DAT");
 
-            writer.WriteKeyValuePair("version", dat.Version);
-            writer.WriteKeyValuePair("plugin", dat.Plugin);
-            writer.WriteKeyValuePair("split", dat.Split);
-            writer.WriteKeyValuePair("merge", dat.Merge);
+            if (dat.Version != null)
+                writer.WriteKeyValuePair("Version", dat.Version);
+            if (dat.Plugin != null)
+                writer.WriteKeyValuePair("Plugin", dat.Plugin);
+            if (dat.Split != null)
+                writer.WriteKeyValuePair("Split", dat.Split);
+            if (dat.Merge != null)
+                writer.WriteKeyValuePair("Merge", dat.Merge);
             writer.WriteLine();
 
             writer.Flush();
@@ -95,10 +106,12 @@ namespace SabreTools.Serialization.Streams
             if (emulator == null)
                 return;
 
-            writer.WriteSection("emulator");
+            writer.WriteSection("EMULATOR");
 
-            writer.WriteKeyValuePair("refname", emulator.RefName);
-            writer.WriteKeyValuePair("version", emulator.Version);
+            if (emulator.RefName != null)
+                writer.WriteKeyValuePair("refname", emulator.RefName);
+            if (emulator.Version != null)
+                writer.WriteKeyValuePair("version", emulator.Version);
             writer.WriteLine();
 
             writer.Flush();
@@ -115,7 +128,7 @@ namespace SabreTools.Serialization.Streams
             if (games?.Rom == null || !games.Rom.Any())
                 return;
 
-            writer.WriteSection("games");
+            writer.WriteSection("GAMES");
 
             foreach (var rom in games.Rom)
             {