Chinese smoke deflectors

.gitignore

@@ -398,3 +398,9 @@ FodyWeavers.xsd
 
 # .nfs files are created when an open file is removed but is still being accessed
 .nfs*
+
+# ======================================================
+
+*.unitypackage
+assetbundles/*.manifest
+assetbundles/assetbundles

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Derail Valley Modding
+Copyright (c) 2023 ÆUGH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,7 +1,11 @@
-<h1>Dumb S282 Tweaks</h1>
+# S282 Tweaks
-<p>This is stupid</p>
 
-## License
+Smoke deflectors and a streamlined boiler for the S282.
-<p>
+
-	Source code is distributed under the MIT license.
+todo screenshot
-</p>
+
+## Credits
+
+AEUGH: Streamlined boiler, Witte & Wagner smoke deflectors, code  
+Tostiman: code  
+Cypress: Chinese smoke deflectors  

dumb282tweaks/CarPatch.cs

@@ -10,8 +10,11 @@ namespace dumb282tweaks;
 class CarPatch {
 	static void Postfix(ref TrainCar __instance)
 	{
-		if(__instance != null && __instance.carType == TrainCarType.LocoSteamHeavy)
+		if (__instance == null || __instance.carType != TrainCarType.LocoSteamHeavy)
 		{
+			return;
+		}
+
 		string bodyPath = "LocoS282A_Body/Static_LOD0/s282_locomotive_body";
 		Transform s282Body = __instance.transform.Find(bodyPath);
 		if (s282Body == null)
@@ -23,11 +26,12 @@ class CarPatch {
 		Material s282Mat = s282Body.GetComponent<MeshRenderer>().material;
 
 		// Smoke Deflector
-			switch(Main.Settings.smokeDeflectorType) {
+		Log($"Applying {MySettings.smokeDeflectorType.ToString()}");
-				case Settings.SmokeDeflectorType.Witte:
-					Log("witte");
 
-					GameObject witteSmokeDeflector = Object.Instantiate(witteSmokeDeflectorsLoad, __instance.transform);
+		switch(MySettings.smokeDeflectorType) {
+			case Settings.SmokeDeflectorType.Witte:
+			{
+				GameObject witteSmokeDeflector = Object.Instantiate(witteSmokeDeflectorsPrefab, __instance.transform);
 				witteSmokeDeflector.transform.localPosition = new Vector3(0.0f, 2.1f, 5f);
 				witteSmokeDeflector.transform.localRotation = Quaternion.identity;
 
@@ -37,10 +41,10 @@ class CarPatch {
 				}
 
 				break;
+			}
 			case Settings.SmokeDeflectorType.Wagner:
-					Log("witten't");
+			{
-
+				GameObject wagnerSmokeDeflector = Object.Instantiate(wagnerSmokeDeflectorsPrefab, __instance.transform);
-					GameObject wagnerSmokeDeflector = Object.Instantiate(wagnerSmokeDeflectorsLoad, __instance.transform);
 				wagnerSmokeDeflector.transform.localPosition = new Vector3(0.0f, 2.1f, 5f);
 				wagnerSmokeDeflector.transform.localRotation = Quaternion.identity;
 
@@ -51,12 +55,18 @@ class CarPatch {
 
 				break;
 			}
+			case Settings.SmokeDeflectorType.Chinese:
+				ApplyChineseSmokeDeflector(ref __instance, s282Body);
+				break;
+		}
 
 		// Boiler
-			switch (Main.Settings.boilerType)
+		Log($"Applying {MySettings.boilerType.ToString()}");
+
+		switch (MySettings.boilerType)
 		{
 			case Settings.BoilerType.Streamlined:
-					GameObject streamlinedBoiler = Object.Instantiate(streamlinedBoilerLoad, __instance.transform);
+				GameObject streamlinedBoiler = Object.Instantiate(streamlinedBoilerPrefab, __instance.transform);
 				streamlinedBoiler.transform.localPosition = new Vector3(0.0f, 2.15f, 5.1f);
 				streamlinedBoiler.transform.localRotation = Quaternion.identity;
 
@@ -68,5 +78,30 @@ class CarPatch {
 				break;
 		}
 	}
+
+	private static void ApplyChineseSmokeDeflector(ref TrainCar locomotive, Transform body)
+	{
+		//hide smoke box door
+		var smokeboxDoorPath = "LocoS282A_Body/Static_LOD0/s282_locomotive_smokebox_door";
+		Transform smokeBoxDoor = locomotive.transform.Find(smokeboxDoorPath);
+		if (smokeBoxDoor == null)
+		{
+			Error($"Couldn't find S282 smoke box door on '{locomotive.transform.gameObject.name}' -> {smokeboxDoorPath}");
+			return;
+		}
+		smokeBoxDoor.gameObject.SetActive(false);
+
+		//show deflector and stuff
+		GameObject chineseSmokeDeflector = Object.Instantiate(chineseSmokeDeflectorsPrefab, body);
+		chineseSmokeDeflector.transform.localPosition = smokeBoxDoor.localPosition;
+
+		//todo apply S282 material?
+		// foreach (var aMeshRenderer in chineseSmokeDeflector.GetComponentsInChildren<MeshRenderer>())
+		// {
+		// 	if (aMeshRenderer.material.name == "S282") //todo
+		// 	{
+		// 		aMeshRenderer.material = s282Mat;
+		// 	}
+		// }
 	}
 }

dumb282tweaks/Main.cs

@@ -4,99 +4,72 @@ using System.Reflection;
 using HarmonyLib;
 using UnityModManagerNet;
 using UnityEngine;
-using System.Diagnostics.CodeAnalysis;
 
-namespace dumb282tweaks;
+namespace dumb282tweaks
+{
+	[EnableReloading]
+	public static class Main
+	{
+		public static UnityModManager.ModEntry MyModEntry { get; private set; }
+		public static Settings MySettings { get; private set; }
 
-public static class Main {
+		public static GameObject wagnerSmokeDeflectorsPrefab;
-	// Variables
+		public static GameObject witteSmokeDeflectorsPrefab;
-	public static UnityModManager.ModEntry Instance { get; private set; }
+		public static GameObject chineseSmokeDeflectorsPrefab;
-	public static dumb282tweaksSettings Settings { get; private set; }
 
-	// public static readonly string[] cabTypeTexts = new[] {
+		public static GameObject streamlinedBoilerPrefab;
-	// 	"Default",
-	// 	"German"
-	// };
-	public static readonly string[] smokeDeflectorTypeTexts = new[] {
-		"None",
-		"Witte",
-		"Wagner"
-	};
-	public static readonly string[] boilerTypeTexts = new[] {
-		"Default",
-		"Streamlined"
-	};
-	// public static readonly string[] smokeStackTypeTexts = new[] {
-	// 	"Default",
-	// 	"Short",
-	// };
 
-	public static GameObject wagnerSmokeDeflectorsLoad;
+		private static bool Load(UnityModManager.ModEntry modEntry)
-	public static GameObject witteSmokeDeflectorsLoad;
+		{
-	public static GameObject streamlinedBoilerLoad;
+			Harmony harmony = null;
 
-	// Load
+			try
-	private static bool Load(UnityModManager.ModEntry modEntry) {
+			{
-		Harmony? harmony = null;
+				MyModEntry = modEntry;
+				MySettings = UnityModManager.ModSettings.Load<Settings>(MyModEntry);
 
-		try {
+				MyModEntry.OnGUI = entry => MySettings.Draw(entry);
-			Instance = modEntry;
+				MyModEntry.OnSaveGUI = entry => MySettings.Save(entry);
-			Settings = UnityModManager.ModSettings.Load<dumb282tweaksSettings>(Instance);
 
-			Instance.OnGUI = OnGUI;
+				string assetPath = Path.Combine(MyModEntry.Path, "assetbundles\\");
-			Instance.OnSaveGUI = OnSaveGUI;
 
-			harmony = new Harmony(Instance.Info.Id);
+				wagnerSmokeDeflectorsPrefab = AssetBundle.LoadFromFile(Path.Combine(assetPath, "wagnersmokedeflectors"))
+					.LoadAsset<GameObject>("Assets/WagnerSmokeDeflectors.prefab");
+				witteSmokeDeflectorsPrefab = AssetBundle.LoadFromFile(Path.Combine(assetPath, "wittesmokedeflectors"))
+					.LoadAsset<GameObject>("Assets/WitteSmokeDeflectors.prefab");
+				chineseSmokeDeflectorsPrefab = AssetBundle.LoadFromFile(Path.Combine(assetPath, "chinesesmokedeflectors"))
+					.LoadAsset<GameObject>("Assets/Prefab/LocoS282A_Smokebox.prefab");
+
+				streamlinedBoilerPrefab = AssetBundle.LoadFromFile(Path.Combine(assetPath, "streamline"))
+					.LoadAsset<GameObject>("Assets/Streamline.prefab");
+
+				harmony = new Harmony(MyModEntry.Info.Id);
 				harmony.PatchAll(Assembly.GetExecutingAssembly());
-
+			}
-			string assetPath = Path.Combine(Instance.Path, "assets\\");
+			catch (Exception ex)
-
+			{
-			wagnerSmokeDeflectorsLoad = AssetBundle.LoadFromFile(Path.Combine(assetPath, "wagnersmokedeflectors")).LoadAsset<GameObject>("Assets/WagnerSmokeDeflectors.prefab");
+				MyModEntry.Logger.LogException($"Failed to load {MyModEntry.Info.DisplayName}:", ex);
-			witteSmokeDeflectorsLoad = AssetBundle.LoadFromFile(Path.Combine(assetPath, "wittesmokedeflectors")).LoadAsset<GameObject>("Assets/WitteSmokeDeflectors.prefab");
+				harmony?.UnpatchAll(MyModEntry.Info.Id);
-			streamlinedBoilerLoad = AssetBundle.LoadFromFile(Path.Combine(assetPath, "streamline")).LoadAsset<GameObject>("Assets/Streamline.prefab");
-
-		} catch(Exception ex) {
-			Instance.Logger.LogException($"Failed to load {Instance.Info.DisplayName}:", ex);
-			harmony?.UnpatchAll(Instance.Info.Id);
 				return false;
 			}
 
 			return true;
 		}
 
-	// GUI Rendering
-	static void OnGUI(UnityModManager.ModEntry modEntry) {
-		GUILayout.BeginVertical();
-
-		GUILayout.Label("These settings are applied on train spawn, meaning rejoining the game will refresh all 282 locos to the settings specified here, but if you don't unload the train it will keep whatever settings were there previously. This is a temporary solution until I have a proper GUI implemented.");
-		GUILayout.Label("Also, reloading a save will currently break things and the tweaks won't load. This isn't good.");
-
-		GUILayout.Space(2f);
-
-		//todo this is not implemented
-		// GUILayout.Label("Cab Type");
-		// Settings.cabType = (Settings.CabType) GUILayout.SelectionGrid((int) Settings.cabType, cabTypeTexts, 1, "toggle");
-
-		GUILayout.Label("Smoke Deflector Type");
-		Settings.smokeDeflectorType = (Settings.SmokeDeflectorType) GUILayout.SelectionGrid((int) Settings.smokeDeflectorType, smokeDeflectorTypeTexts, 1, "toggle");
-
-		GUILayout.Label("Boiler Type");
-		Settings.boilerType = (Settings.BoilerType) GUILayout.SelectionGrid((int) Settings.boilerType, boilerTypeTexts, 1, "toggle");
-
-		GUILayout.EndVertical();
-	}
-	static void OnSaveGUI(UnityModManager.ModEntry modEntry) {
-		Settings.Save(modEntry);
-	}
-
 		// Logger Commands
-	public static void Log(string message) {
+		public static void Log(string message)
-		Instance.Logger.Log(message);
+		{
+			MyModEntry.Logger.Log(message);
 		}
-	public static void Warning(string message) {
+
-		Instance.Logger.Warning(message);
+		public static void Warning(string message)
+		{
+			MyModEntry.Logger.Warning(message);
+		}
+
+		public static void Error(string message)
+		{
+			MyModEntry.Logger.Error(message);
 		}
-	public static void Error(string message) {
-		Instance.Logger.Error(message);
 	}
 }

dumb282tweaks/Settings.cs

@@ -1,39 +1,69 @@
+using System;
 using System.ComponentModel;
+using UnityEngine;
 using UnityModManagerNet;
-using static dumb282tweaks.Settings;
 
-namespace dumb282tweaks;
+namespace dumb282tweaks
+{
 
-public static class Settings {
+	public class Settings : UnityModManager.ModSettings
-	public enum CabType {
+	{
-		[Description("Default 282 Cab")]
+		// public enum CabType
-		Default,
+		// {
-		[Description("German Cab")]
+		// 	[Description("Default 282 Cab")] Default,
-		German
+		// 	[Description("German Cab")] German
+		// }
+
+		public enum BoilerType
+		{
+			[Description("Default Boiler")] Default,
+			[Description("Streamlined Boiler")] Streamlined,
 		}
-	public enum BoilerType {
+
-		[Description("Default Boiler")]
+		public enum SmokeDeflectorType
-		Default,
+		{
-		[Description("Streamlined Boiler")]
+			[Description("No smoke deflectors")]
-		Streamlined,
-	}
-	public enum SmokeDeflectorType {
-		[Description("No Smoke Deflectors")]
 			None,
-		[Description("Witte Smoke Deflectors")]
-		Witte,
-		[Description("Wagner Smoke Deflectors")]
-		Wagner,
-	}
-}
 
-public class dumb282tweaksSettings : UnityModManager.ModSettings {
+			[Description("Witte smoke deflectors")]
+			Witte,
+
+			[Description("Wagner smoke deflectors")]
+			Wagner,
+
+			[Description("Chinese smoke deflectors and more")]
+			Chinese,
+		}
+
 		// public CabType cabType = CabType.Default;
 		public SmokeDeflectorType smokeDeflectorType = SmokeDeflectorType.Wagner;
 		public BoilerType boilerType = BoilerType.Default;
 
-	public override void Save(UnityModManager.ModEntry modEntry) {
+		public void Draw(UnityModManager.ModEntry modEntry)
+		{
+			GUILayout.BeginVertical();
+
+			GUILayout.Label("These settings are applied on train spawn, meaning rejoining the game will refresh all 282 locos to the settings specified here, but if you don't unload the train it will keep whatever settings were there previously. This is a temporary solution until I have a proper GUI implemented.");
+			GUILayout.Label("Also, reloading a save will currently break things and the tweaks won't load. This isn't good.");
+
+			GUILayout.Space(2f);
+
+			//todo this is not implemented
+			// GUILayout.Label("Cab Type");
+			// Settings.cabType = (Settings.CabType) GUILayout.SelectionGrid((int) Settings.cabType, cabTypeTexts, 1, "toggle");
+
+			GUILayout.Label("Smoke Deflector Type");
+			smokeDeflectorType = (SmokeDeflectorType) GUILayout.SelectionGrid((int) smokeDeflectorType, Enum.GetNames(typeof(SmokeDeflectorType)), 1, "toggle");
+
+			GUILayout.Label("Boiler Type");
+			boilerType = (BoilerType) GUILayout.SelectionGrid((int) boilerType, Enum.GetNames(typeof(BoilerType)), 1, "toggle");
+
+			GUILayout.EndVertical();
+		}
+
+		public override void Save(UnityModManager.ModEntry modEntry)
+		{
 			Save(this, modEntry);
 		}
+	}
 }
-

package.ps1

@@ -4,7 +4,7 @@ param (
 )
 
 Set-Location "$PSScriptRoot"
-$FilesToInclude = "info.json","build/*","LICENSE","assets"
+$FilesToInclude = "info.json","build/*","LICENSE","assetbundles"
 
 $modInfo = Get-Content -Raw -Path "info.json" | ConvertFrom-Json
 $modId = $modInfo.Id
@@ -20,7 +20,7 @@ $ZipOutDir = "$ZipWorkDir/$modId"
 
 New-Item "$ZipOutDir" -ItemType Directory -Force
 Copy-Item -Force -Path $FilesToInclude -Destination "$ZipOutDir"
-Copy-Item -Force -Path "assets/*" -Destination "$ZipOutDir/assets"
+Copy-Item -Force -Path "assetbundles/*" -Destination "$ZipOutDir/assetbundles"
 
 if (!$NoArchive)
 {