0.6.0.103 - [Enhance] TJA Command and some Fixes (#913)

- [Feat] New TJA header `.FORCEGAUGE:`, which forces the gauge type for the player-side
- [Feat] New TJA header `.BOOMRULE:`, which specifies the gauge penalty of the BOOM judgement for the player-side
- [Feat] Multi-value `SCENEPRESET:` (separated by comma (`,`)) for TJA and box.def to randomly use one of specified scenes
- [Feat] Add new branch condition rules and ranges (based on (#807))
- [Feat] Rotate barlines according to scroll direction like in TaikoJiro2
- [Feat] Support reading `inf` and `infinity` (case-insensitive) in TJA as `Infinity`
- [Enhance] TJA `#BRANCHSTART:` Allow omitting comma (,) between multi-letter condition type and value, and reject unknown type or range
- [Enhance] Make the following header per-player-side: `GAME:`, `HIDDENBRANCH:`, `SIDE:`, `LIFE:`, `TOWERTYPE:`, `DANTICK:`, `DANTICKCOLOR:` (specifying them before the first `COURSE:` sets the default value of all difficulties)
- [Enhance] Make TJA NOTESDESIGNER headers per-player-side and respect difficulty number if defined before the first `COURSE:` in TJA
- [Enhance] Adjust gameplay stack order to be debug texts > fading-in/out > lyrics > training UI > OBJ > notes > background and training bar (from top layer to bottom layer)
- [Enhance] Make log more complete (Allow logging to file before reading Config.ini, log exception in some empty catches, set up inner exceptions in nested throws)
- [Fix] Big note branch score was not tracked
- [Fix] Game crashed when the played OBJ command contains non-registered obj name
- [Fix] Eased value for OBJ command was truncated to int
- [Fix] Not all OBJ/CAM command states were reset properly on retry
- [Fix] CAM commands failed to apply to the main screen
- [Fix] `#BORDERCOLOR` command had no effects
- [Fix] Lyrics and OBJs could not hide when retry or rewind
- [Fix] OBJ & CAM commands did not respect play speed
- [Fix] `#SUDDEN` move offset had no effects
- [Fix] `#ENABLEDORON` & `#DISABLEDORON` were not per-player and did not reset after retrying gameplay
- [Fix] `#SUDDEN` could not hide SENote and `#ENABLE`/`DISABLEDORON`, `#SUDDEN`, note hidden upon hit, & balloon appear during popping interfered with each other
- [Fix] TJA `#SCROLL` could not parse number containing Infinity successfully
- [Fix] TJA `#SUDDEN` could not handle Infinity values
- [Fix] `#DELAY Infinity` crashed the game
- [Fix] Could not select difficulties with `LEVEL:Infinity` or negative value (needs hard reloading song list)
- [Fix] `LEVEL:10.45` displayed as 10+, `LEVEL:12.95` as 12(-) (for examples) due to unintended rounding
- [Fix] COURSE-scope headers ignored the default scope before the first `COURSE:`, broken some charts made for TaikoJiro
- [Fix] Invalid commands starting with `#BRANCHSTART` made the difficulty treated as branched chart
- [Fix] Pre-COURSE LEVEL: broke difficulty available test (#625) (needs hard reloading)
- [Fix] Per-player-side headers beyond selected player-side chart not ignored, broke per-player-side BALLOON and other headers
- [Fix] Displayed puchi/character coin multiplier did not include rarity multiplier in Heya
- [Optimize] Stop processing finished or truncated OBJ/CAM commands
- [Chore] Decompose `EBranchConditionType` into `Exam.Type`, `EBranchCondBig`, & `Exam.Range`
- [Chore] Simplify CAM command handling during gameplay
- [Chore] Fix `CLang.GetExamName()` matched exam type by raw int and would break if Exam.Type changes

Author: IepIweidieng

FDK/src/01.Framework/Core/Game.cs

@@ -19,6 +19,7 @@
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
+using System.Diagnostics;
 using System.Reflection;
 using System.Runtime.InteropServices;
 using FDK;
@@ -246,6 +247,16 @@ public unsafe void GetScreenShotAsync(Action<SKBitmap> action) {
 
 	public static Matrix4X4<float> Camera;
 
+	private static Color4 _borderColor = new Color4(0f, 0f, 0f, 1f);
+	public static Color4 BorderColor {
+		get => _borderColor;
+		set {
+			if (value != _borderColor)
+				Gl.ClearColor(BorderColor.Red, BorderColor.Green, BorderColor.Blue, BorderColor.Alpha);
+			_borderColor = value;
+		}
+	}
+
 	public static float ScreenAspect {
 		get {
 			return (float)GameWindowSize.Width / GameWindowSize.Height;
@@ -274,6 +285,13 @@ private RawImage GetIconData(string fileName) {
 	/// Initializes a new instance of the <see cref="Game"/> class.
 	/// </summary>
 	protected Game(string iconFileName, params string[] args) {
+		try {
+			this.InitializeLog();
+		} catch (Exception ex) {
+			Console.WriteLine(ex.ToString());
+			Console.WriteLine("Error initializing log.");
+		}
+
 		strIconFileName = iconFileName;
 		parameters = args;
 
@@ -304,17 +322,18 @@ protected Game(string iconFileName, params string[] args) {
 		if ((OperatingSystem.IsLinux() && Environment.GetEnvironmentVariable("XDG_SESSION_TYPE") == "wayland" && windowing_override != "glfw")
 		|| windowing_override == "sdl") {
 			Silk.NET.Windowing.Sdl.SdlWindowing.Use();
-			Console.WriteLine("SDL selected for Windowing");
+			Trace.TraceInformation("SDL selected for Windowing");
 		} else {
 			Silk.NET.Windowing.Glfw.GlfwWindowing.Use();
-			Console.WriteLine("GLFW selected for Windowing");
+			Trace.TraceInformation("GLFW selected for Windowing");
 		}
 
 		try {
 			Window_ = Window.Create(options);
 		}
-		catch {
-			Console.WriteLine("The window failed to be created.\nYou can attempt to fix this by overriding the default windowing.\nTry launching OpenTaiko with args, using '-w glfw' to force GLFW or '-w sdl' to force SDL.");
+		catch (Exception ex) {
+			Trace.TraceError(ex.ToString());
+			Trace.TraceError("The window failed to be created.\nYou can attempt to fix this by overriding the default windowing.\nTry launching OpenTaiko with args, using '-w glfw' to force GLFW or '-w sdl' to force SDL.");
 			throw;
         }
 
@@ -393,6 +412,10 @@ protected virtual void Configuration() {
 
 	}
 
+	protected virtual void InitializeLog() {
+
+	}
+
 	protected virtual void Initialize() {
 
 	}
@@ -492,6 +515,7 @@ public void Window_Update(double deltaTime) {
 
 	public void Window_Render(double deltaTime) {
 		Camera = Matrix4X4<float>.Identity;
+		Gl.ClearColor(BorderColor.Red, BorderColor.Green, BorderColor.Blue, BorderColor.Alpha);
 
 		if (AsyncActions.Count > 0) {
 			AsyncActions[0]?.Invoke();

FDK/src/02.Input/CInputManager.cs

@@ -39,7 +39,9 @@ public void Initialize(IWindow window, bool useBufferedInput, bool bUseMidiIn, f
 		try {
 			cinputkeyboard = new CInputKeyboard(Context.Keyboards[0]);
 			cinputmouse = new CInputMouse(Context.Mice[0]);
-		} catch {
+		} catch (Exception ex) {
+			Trace.TraceWarning(ex.ToString());
+			Trace.TraceWarning("Error adding keyboard and mouse.");
 		}
 		if (cinputkeyboard != null) {
 			this.InputDevices.Add(cinputkeyboard);
@@ -63,14 +65,18 @@ public void Initialize(IWindow window, bool useBufferedInput, bool bUseMidiIn, f
 				this.InputDevices.Add(new CInputMIDI(midiIn, i));
 			}
 		} catch (Exception e) {
-			Trace.TraceError(e.ToString());
+			Trace.TraceWarning(e.ToString());
+			Trace.TraceWarning("Error adding MIDI input devices.");
 		}
 		#endregion
 		Trace.TraceInformation("Found {0} Input Device{1}", InputDevices.Count, InputDevices.Count != 1 ? "s:" : ":");
 		for (int i = 0; i < InputDevices.Count; i++) {
 			try {
 				Trace.TraceInformation("Input Device #" + i + " (" + InputDevices[i].CurrentType.ToString() + " - " + InputDevices[i].Name + ")");
-			} catch { }
+			} catch (Exception ex) {
+				Trace.TraceWarning(ex.ToString());
+				Trace.TraceWarning("Error logging input devices.");
+			}
 		}
 
 		Game.InitImGuiController(window, Context);
@@ -157,6 +163,8 @@ public void Polling() {
 					device.Polling();
 				} catch (Exception e)                                      // #24016 2011.1.6 yyagi: catch exception for unplugging USB joystick, and remove the device object from the polling items.
 				{
+					Trace.TraceWarning($"Error polling input device {i}.");
+					Trace.TraceWarning(e.ToString());
 					//this.InputDevices.Remove(device);
 					//device.Dispose();
 					//Trace.TraceError("tポーリング時に対象deviceが抜かれており例外発生。同deviceをポーリング対象からRemoveしました。");

FDK/src/04.Graphics/CTexture.cs

@@ -386,9 +386,9 @@ public CTexture(int n幅, int n高さ)
 			this.sz画像サイズ = new Size(n幅, n高さ);
 			this.szTextureSize = this.t指定されたサイズを超えない最適なテクスチャサイズを返す(this.sz画像サイズ);
 			this.rc全画像 = new Rectangle(0, 0, this.sz画像サイズ.Width, this.sz画像サイズ.Height);
-		} catch {
+		} catch (Exception ex) {
 			this.Dispose();
-			throw new CTextureCreateFailedException(string.Format("テクスチャの生成に失敗しました。\n({0}x{1}, {2})", n幅, n高さ));
+			throw new CTextureCreateFailedException(string.Format("テクスチャの生成に失敗しました。\n({0}x{1}, {2})", n幅, n高さ), innerException: ex);
 		}
 	}
 
@@ -485,10 +485,10 @@ public void MakeTexture(SKBitmap bitmap, bool b黒を透過する) {
 			this.sz画像サイズ = new Size(bitmap.Width, bitmap.Height);
 			this.rc全画像 = new Rectangle(0, 0, this.sz画像サイズ.Width, this.sz画像サイズ.Height);
 			this.szTextureSize = this.t指定されたサイズを超えない最適なテクスチャサイズを返す(this.sz画像サイズ);
-		} catch {
+		} catch (Exception ex) {
 			this.Dispose();
 			// throw new CTextureCreateFailedException( string.Format( "テクスチャの生成に失敗しました。\n{0}", strファイル名 ) );
-			throw new CTextureCreateFailedException(string.Format("テクスチャの生成に失敗しました。\n"));
+			throw new CTextureCreateFailedException(string.Format("テクスチャの生成に失敗しました。\n"), innerException: ex);
 		}
 	}
 

OpenTaiko/src/Common/CConfigIni.cs

@@ -217,7 +217,7 @@ public CTimingZones(int gz, int oz, int bz) {
 
 	public bool bTight;
 	public bool bIncludeSubfoldersOnRandomSelect;
-	public bool bOutputLogs;
+	public bool bOutputLogs; // For ensuring complete log messages, output is enabled before reading Config.ini
 	public bool bDisplayDebugInfo;
 	public bool bEnableVSync;
 	public bool bFullScreen;

OpenTaiko/src/Common/CSystemError.cs

@@ -20,7 +20,7 @@ public enum Errno {
 		ENO_SONGLISTINITFAILED = 5
 	};
 
-	public void LoadError(Errno errno) {
+	public void LoadError(Errno errno, Exception? exception = null, string? message = null) {
 		GameCrashed = true;
 
 		// Head with the error code
@@ -30,36 +30,48 @@ public void LoadError(Errno errno) {
 		switch (errno) {
 			default:
 			case Errno.ENO_UNKNOWN: {
+					if (!string.IsNullOrEmpty(message))
+						ErrorMessage += message;
 					ErrorMessage += "Please try restarting OpenTaiko.";
 					break;
 				}
 			case Errno.ENO_NOAUDIODEVICE: {
 					ErrorMessage += "No audio device was found.\n";
+					if (!string.IsNullOrEmpty(message))
+						ErrorMessage += "Additional message: " + message;
 					ErrorMessage += "Please ensure that you have an active audio output display on your machine.\n";
 					ErrorMessage += "Additionally, check if your speakers or headset are not turned off.\n";
 					ErrorMessage += "If this does not resolve the issue, please try the troubleshooting feature on your OS.";
 					break;
 				}
 			case Errno.ENO_SKINNOTFOUND: {
 					ErrorMessage += "No compatible skin was found.\n";
+					if (!string.IsNullOrEmpty(message))
+						ErrorMessage += "Additional message: " + message;
 					ErrorMessage += "Please ensure that you have a compatible skin within your System folder.\n";
 					ErrorMessage += "If you have not installed a skin, please do so through the OpenTaiko Hub (Skins tab).\n";
 					ErrorMessage += "If this does not resolve the issue, please try updating your skins through the OpenTaiko Hub.\n";
 					break;
 				}
 			case Errno.ENO_PADINITFAILED: {
 					ErrorMessage += "The pad initialisation failed.\n";
+					if (!string.IsNullOrEmpty(message))
+						ErrorMessage += "Additional message: " + message;
 					ErrorMessage += "Please try the troubleshooting feature on your OS.";
 					break;
 				}
 			case Errno.ENO_INPUTINITFAILED: {
 					ErrorMessage += "The input device initialisation failed.\n";
+					if (!string.IsNullOrEmpty(message))
+						ErrorMessage += "Additional message: " + message;
 					ErrorMessage += "Please ensure that you are not using a faulty input device when launching the game.\n";
 					ErrorMessage += "If the device seems to work on other tasks, please try the troubleshooting feature on your OS.";
 					break;
 				}
 			case Errno.ENO_SONGLISTINITFAILED: {
 					ErrorMessage += "The song list initialisation failed.\n";
+					if (!string.IsNullOrEmpty(message))
+						ErrorMessage += "Additional message: " + message;
 					ErrorMessage += "Please try removing the songlist.db file within your OpenTaiko folder.";
 					break;
 				}
@@ -68,6 +80,9 @@ public void LoadError(Errno errno) {
 
 		// Append a call to contact if necessary
 		ErrorMessage += "\nIf the error persists, please contact us through the links provided on the OpenTaiko Hub.";
+
+		if (exception != null)
+			ErrorMessage += "\n\nException: " + exception.ToString();
 	}
 
 	// Constructor

OpenTaiko/src/Common/Easing.cs

@@ -3,12 +3,12 @@
 namespace OpenTaiko;
 
 static class Easing {
-	public static int EaseIn(CCounter counter, float startPoint, float endPoint, CalcType type) {
+	public static float EaseIn(CCounter counter, float startPoint, float endPoint, CalcType type) {
 		double CounterValue = counter.CurrentValue / (double)(int)counter.EndValue;
 		return EaseIn(CounterValue, startPoint, endPoint, type);
 	}
 
-	public static int EaseIn(double CounterValue, float startPoint, float endPoint, CalcType type) {
+	public static float EaseIn(double CounterValue, float startPoint, float endPoint, CalcType type) {
 		float Sa = endPoint - startPoint;
 		double Value = 0;
 
@@ -42,15 +42,15 @@ public static int EaseIn(double CounterValue, float startPoint, float endPoint,
 				break;
 		}
 
-		return (int)Value;
-	}
-
-	public static int EaseOut(CCounter counter, float startPoint, float endPoint, CalcType type) {
+		return (float)Value;
+	}
+
+	public static float EaseOut(CCounter counter, float startPoint, float endPoint, CalcType type) {
 		double CounterValue = counter.CurrentValue / (double)(int)counter.EndValue;
 		return EaseOut(CounterValue, startPoint, endPoint, type);
 	}
 
-	public static int EaseOut(double CounterValue, float startPoint, float endPoint, CalcType type) {
+	public static float EaseOut(double CounterValue, float startPoint, float endPoint, CalcType type) {
 		float Sa = endPoint - startPoint;
 		double Value = 0;
 
@@ -89,7 +89,7 @@ public static int EaseOut(double CounterValue, float startPoint, float endPoint,
 				break;
 		}
 
-		return (int)Value;
+		return (float)Value;
 	}
 
 	public static float EaseInOut(CCounter counter, float startPoint, float endPoint, CalcType type) {