Load BGM name/descriptions from game script

Author: drojf

Assets.Scripts.Core.Buriko/BurikoScriptFile.cs

@@ -2731,16 +2731,22 @@ public BurikoVariable OperationMODAddSEset()
 			return BurikoVariable.Null;
 		}
 
+		/// <summary>
+		/// Note: Tabs are not supported for descriptions and will be stripped out.
+		/// This is so that you can write multiple line strings in the game script without tabs appearing in the output.
+		/// </summary>
 		public BurikoVariable OperationMODAddAudioset()
 		{
 			SetOperationType("MODAddAudioSet");
 			string nameEN = ReadVariable().StringValue();
+			string descriptionEN = ReadVariable().StringValue();
 			string nameJP = ReadVariable().StringValue();
+			string descriptionJP = ReadVariable().StringValue();
 			int altBGM = ReadVariable().IntValue();
 			int altBGMflow = ReadVariable().IntValue();
 			int altSE = ReadVariable().IntValue();
 			int altSEFlow = ReadVariable().IntValue();
-			MODAudioSet.Instance.AddAudioSet(new AudioSet(nameEN, nameJP, altBGM, altBGMflow, altSE, altSEFlow));
+			MODAudioSet.Instance.AddAudioSet(new AudioSet(nameEN, nameJP, MODUtility.StripTabs(descriptionEN), MODUtility.StripTabs(descriptionJP), altBGM, altBGMflow, altSE, altSEFlow));
 
 			return BurikoVariable.Null;
 		}

BGICompiler.Compiler/OperationHandler.cs

@@ -177,7 +177,7 @@ public void FillParamValues()
 			paramLookup.Add("ModFadeOutBGM", new OpType(BurikoOperations.ModFadeOutBGM, "iibi"));
 			paramLookup.Add("ModAddBGMset", new OpType(BurikoOperations.ModAddBGMset, "sss"));
 			paramLookup.Add("ModAddSEset", new OpType(BurikoOperations.ModAddSEset, "sss"));
-			paramLookup.Add("ModAddAudioset", new OpType(BurikoOperations.ModAddAudioset, "ssiiii"));
+			paramLookup.Add("ModAddAudioset", new OpType(BurikoOperations.ModAddAudioset, "ssssiiii"));
 			paramLookup.Add("ModGenericCall", new OpType(BurikoOperations.ModGenericCall, "ss"));
 		}
 

MOD.Scripts.Core.Audio/MODAudioSet.cs

@@ -11,20 +11,27 @@ class AudioSet
 	{
 		public readonly string nameEN;
 		public readonly string nameJP;
+		public readonly string descriptionEN;
+		public readonly string descriptionJP;
 		public readonly int altBGM;
 		public readonly int altBGMFlow;
 		public readonly int altSE;
 		public readonly int altSEFlow;
 
-		public AudioSet(string nameEN, string nameJP, int altBGM, int altBGMFlow, int altSE, int altSEFlow)
+		public AudioSet(string nameEN, string nameJP, string descriptionEN, string descriptionJP, int altBGM, int altBGMFlow, int altSE, int altSEFlow)
 		{
 			this.nameEN = nameEN;
 			this.nameJP = nameJP;
+			this.descriptionEN = descriptionEN;
+			this.descriptionJP = descriptionJP;
 			this.altBGM = altBGM;
 			this.altBGMFlow = altBGMFlow;
 			this.altSE = altSE;
 			this.altSEFlow = altSEFlow;
 		}
+
+		public string Name(bool getJapanese) => getJapanese ? nameJP : nameEN;
+		public string Description(bool getJapanese) => getJapanese ? descriptionJP : descriptionEN;
 	}
 
 	class MODAudioSet
@@ -86,6 +93,8 @@ public string GetAudioSetNameFromZeroIndexed(int zeroBasedIndex)
 			return zeroBasedIndex < audioSets.Count ? audioSets[zeroBasedIndex].nameEN : $"Unknown BGM/SE {zeroBasedIndex}";
 		}
 
+		public List<AudioSet> GetAudioSets() => audioSets;
+
 		public string GetBGMFlowName(int altBGMFlow)
 		{
 			return altBGMFlow < bgmFlowNames.Count ? bgmFlowNames[altBGMFlow] : $"Unknown BGM/SE {altBGMFlow}";

MOD.Scripts.Core/MODUtility.cs

@@ -106,4 +106,6 @@ public static Platform GetPlatform()
 				return Platform.Windows;
 		}
 	}
+
+	public static string StripTabs(string s) => s.Replace("\t", "");
 }

MOD.Scripts.UI/MODMenuAudioOptions.cs

@@ -1,6 +1,7 @@
 using MOD.Scripts.Core.Audio;
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using System.Text;
 using UnityEngine;
 
@@ -17,12 +18,18 @@ public MODMenuAudioOptions(MODMenuCommon c, MODStyleManager styleManager)
 			this.c = c;
 			hasBGMSEOptions = MODActions.HasMusicToggle();
 
-			this.radioBGMSESet = new MODRadio("Choose BGM/SE (Hotkey: 2)", new GUIContent[]
+			this.radioBGMSESet = new MODRadio("Choose BGM/SE (Hotkey: 2)", new GUIContent[] { }, styleManager);
+		}
+
+		public void OnBeforeMenuVisible()
+		{
+			if (this.radioBGMSESet.GetContents().Length == 0)
 			{
-				new GUIContent("New BGM/SE", "Use the new BGM/SE introduced by MangaGamer in the April 2019 update."),
-				new GUIContent("Original BGM/SE", "Use the original BGM/SE from the Japanese version of the game. This option was previously known as 'BGM/SE fix'.\n\n" +
-				"Note that this not only changes which audio files are played, but also when BGM starts to play/stops playing, in certain cases."),
-			}, styleManager);
+				bool japanese = c.GetGlobal("GLanguage") == 0;
+				this.radioBGMSESet.SetContents(
+					MODAudioSet.Instance.GetAudioSets().Select(x => new GUIContent(x.Name(japanese), x.Description(japanese))).ToArray()
+				);
+			}
 		}
 
 		public void OnGUI()

MOD.Scripts.UI/MODMenuAudioSetup.cs

@@ -18,7 +18,10 @@ public MODMenuAudioSetup(MODMenu modMenu, MODMenuCommon c, MODMenuAudioOptions a
 			this.audioOptions = audioOptions;
 		}
 
-		public void OnBeforeMenuVisible()	{}
+		public void OnBeforeMenuVisible()
+		{
+			audioOptions.OnBeforeMenuVisible();
+		}
 
 		public void OnGUI()
 		{

MOD.Scripts.UI/MODMenuNormal.cs

@@ -227,6 +227,7 @@ public void OnBeforeMenuVisible() {
 			this.radioArtSet.SetContents(descriptions);
 
 			resolutionMenu.OnBeforeMenuVisible();
+			audioOptionsMenu.OnBeforeMenuVisible();
 		}
 
 		private void OnGUIRestoreSettings(MODMenuCommon w)

MOD.Scripts.UI/MODRadio.cs

@@ -34,6 +34,12 @@ public MODRadio(string label, GUIContent[] radioContents, MODStyleManager styleM
 		public int? OnGUIFragment(int displayedRadio)
 		{
 			GUILayout.Label(this.label, styleManager.Group.label);
+
+			if(radioContents.Length == 0)
+			{
+				GUILayout.Label("MODRadio Error: this radio has no options!", styleManager.Group.label);
+			}
+
 			int i = GUILayout.SelectionGrid(displayedRadio, radioContents, itemsPerRow, styleManager.Group.modMenuSelectionGrid);
 			if (i != displayedRadio)
 			{
@@ -48,5 +54,7 @@ public void SetContents(GUIContent[] content)
 		{
 			this.radioContents = content;
 		}
+
+		public GUIContent[] GetContents() => this.radioContents;
 	}
 }