Resolves #142

Author: LeftofZen

Dat/FileParsing/SawyerStreamWriter.cs

@@ -98,13 +98,13 @@ public static void ExportMusicAsWave(string filename, RiffWavHeader header, byte
 			}
 		}
 
-		public static void Save(string filename, string objName, SourceGame sourceGame, ILocoObject locoObject, ILogger logger)
+		public static void Save(string filename, string objName, SourceGame sourceGame, ILocoObject locoObject, ILogger logger, bool allowWritingAsVanilla)
 		{
 			ArgumentNullException.ThrowIfNull(locoObject);
 
 			logger.Info($"Writing \"{objName}\" to {filename}");
 
-			var objBytes = WriteLocoObject(objName, sourceGame, logger, locoObject);
+			var objBytes = WriteLocoObject(objName, sourceGame, logger, locoObject, allowWritingAsVanilla);
 
 			try
 			{
@@ -123,10 +123,10 @@ public static void Save(string filename, string objName, SourceGame sourceGame,
 			logger.Info($"{objName} successfully saved to {filename}");
 		}
 
-		public static ReadOnlySpan<byte> WriteLocoObject(string objName, SourceGame sourceGame, ILogger logger, ILocoObject obj)
-		 => WriteLocoObjectStream(objName, sourceGame, logger, obj).ToArray();
+		public static ReadOnlySpan<byte> WriteLocoObject(string objName, SourceGame sourceGame, ILogger logger, ILocoObject obj, bool allowWritingAsVanilla)
+		 => WriteLocoObjectStream(objName, sourceGame, logger, obj, allowWritingAsVanilla).ToArray();
 
-		public static MemoryStream WriteLocoObjectStream(string objName, SourceGame sourceGame, ILogger logger, ILocoObject obj)
+		public static MemoryStream WriteLocoObjectStream(string objName, SourceGame sourceGame, ILogger logger, ILocoObject obj, bool allowWritingAsVanilla)
 		{
 			using var objStream = new MemoryStream();
 
@@ -173,7 +173,7 @@ public static MemoryStream WriteLocoObjectStream(string objName, SourceGame sour
 
 			var s5Header = new S5Header(objName, 0)
 			{
-				SourceGame = sourceGame == SourceGame.Vanilla ? SourceGame.Custom : sourceGame, // do not allow users to write "Vanilla" to objects
+				SourceGame = sourceGame == SourceGame.Vanilla ? (allowWritingAsVanilla ? SourceGame.Vanilla : SourceGame.Custom) : sourceGame,
 				ObjectType = attr!.ObjectType
 			};
 

Gui/EditorSettings.cs

@@ -28,7 +28,7 @@ public HashSet<string> ObjDataDirectories
 			set => objDataDirectories = value;
 		}
 		HashSet<string> objDataDirectories;
-
+		public bool AllowSavingAsVanillaObject { get; set; }
 		public bool AutoObjectDiscoveryAndUpload { get; set; }
 
 		public bool UseHttps { get; set; }

Gui/ViewModels/DatTypes/DatObjectEditorViewModel.cs

@@ -185,7 +185,8 @@ void SaveCore(string filename)
 				S5HeaderViewModel?.Name ?? CurrentObject.DatFileInfo.S5Header.Name,
 				S5HeaderViewModel?.SourceGame ?? CurrentObject.DatFileInfo.S5Header.SourceGame,
 				CurrentObject.LocoObject,
-				Logger);
+				Logger,
+				Model.Settings.AllowSavingAsVanillaObject);
 		}
 
 		(IList<TreeNode> treeView, Dictionary<string, (int, int)> annotationIdentifiers) AnnotateFile(string path, ILogger logger, bool isG1 = false)

Gui/ViewModels/EditorSettingsWindowViewModel.cs

@@ -17,6 +17,7 @@ public EditorSettingsWindowViewModel(EditorSettings settings)
 		{
 			_Settings = settings;
 
+			AllowSavingAsVanillaObject = settings.AllowSavingAsVanillaObject;
 			AutoObjectDiscoveryAndUpload = settings.AutoObjectDiscoveryAndUpload;
 			UseHttps = settings.UseHttps;
 			ServerAddressHttp = settings.ServerAddressHttp;
@@ -28,6 +29,7 @@ public EditorSettingsWindowViewModel(EditorSettings settings)
 
 		public void Commit()
 		{
+			_Settings.AllowSavingAsVanillaObject = AllowSavingAsVanillaObject;
 			_Settings.AutoObjectDiscoveryAndUpload = AutoObjectDiscoveryAndUpload;
 			_Settings.UseHttps = UseHttps;
 			_Settings.ServerAddressHttp = ServerAddressHttp;
@@ -37,6 +39,9 @@ public void Commit()
 			_Settings.ObjDataDirectories = ObjDataDirectories.ToHashSet();
 		}
 
+		[Reactive, Category("Misc"), DisplayName("Allow saving as vanilla object"), Description("If enabled, the editor will allow saving objects with \"Vanilla\" flag set. If disabled, the object will be forcefully saved as \"Custom\" instead.")]
+		public bool AllowSavingAsVanillaObject { get; set; }
+
 		#region Object Folders
 
 		[Reactive, PathBrowsable(PathBrowsableType.Directory), Category("Object Folders"), DisplayName("Downloads"), Description("The folder to store downloaded objects")]
@@ -48,13 +53,13 @@ public void Commit()
 		[Reactive, Category("Object Folders"), DisplayName("ObjectData folders"), Description("The list of all ObjectData folders.")]
 		public BindingList<string> ObjDataDirectories { get; set; }
 
-		[Reactive, Category("Object Service"), DisplayName("Automatic object discovery and upload"), Description("If enabled, the editor will scan the current object directory for objects and check if there are any that are not known to the object service. If any new objects are discovered they will be automatically uploaded to the service.")]
-		public bool AutoObjectDiscoveryAndUpload { get; set; }
-
 		#endregion
 
 		#region Object Service
 
+		[Reactive, Category("Object Service"), DisplayName("Automatic object discovery and upload"), Description("If enabled, the editor will scan the current object directory for objects and check if there are any that are not known to the object service. If any new objects are discovered they will be automatically uploaded to the service.")]
+		public bool AutoObjectDiscoveryAndUpload { get; set; }
+
 		[Reactive, ConditionTarget, Category("Object Service"), DisplayName("Use HTTPS"), Description("Will use the HTTPS address instead of the HTTP address for Object Service connections.")]
 		public bool UseHttps { get; set; }
 

Tests/LoadSaveTests.cs

@@ -59,12 +59,12 @@ static void LoadSaveGenericTest<T>(string filename, Action<ILocoObject, T> asser
 
 			var logger = new Logger();
 			var objectName = filename.Split('.')[0];
-			var bytes1 = SawyerStreamWriter.WriteLocoObject(objectName, SourceGame.Vanilla, logger, obj1);
+			var bytes1 = SawyerStreamWriter.WriteLocoObject(objectName, SourceGame.Vanilla, logger, obj1, false);
 
 			var (obj2, struc2) = LoadObject<T>(bytes1);
 			assertFunc(obj2, struc2);
 
-			var bytes2 = SawyerStreamWriter.WriteLocoObject(objectName, SourceGame.Vanilla, logger, obj2);
+			var bytes2 = SawyerStreamWriter.WriteLocoObject(objectName, SourceGame.Vanilla, logger, obj2, false);
 
 			// we could just simply compare byte arrays and be done, but i wanted something that makes it easier to diagnose problems