show commit hash in info

Author: Vortex2Oblivion

assets/preload/data/defaultOptions.json

@@ -16,6 +16,10 @@
       "option": "versionDisplay",
       "value": true
     },
+    {
+      "option": "showCommitHash",
+      "value": true
+    },
     {
       "option": "uiSkin",
       "value": "default"

source/Main.hx

@@ -107,6 +107,10 @@ class Main extends Sprite {
 		display.infoDisplayed[3] = logsEnabled;
 	}
 
+	public static inline function toggleCommitHash(commitHashEnabled:Bool):Void {
+		display.infoDisplayed[4] = commitHashEnabled;
+	}
+
 	public static inline function changeFont(font:String):Void {
 		display.defaultTextFormat = new TextFormat(font, (font == "_sans" ? 12 : 14), display.textColor);
 	}

source/macros/GithubCommitHash.hx

@@ -0,0 +1,33 @@
+package macros;
+
+import haxe.macro.Context;
+import haxe.macro.Expr;
+import sys.io.Process;
+
+/**
+ * Macro class for getting the current git commit hash.
+ * @see https://code.haxe.org/category/macros/add-git-commit-hash-in-build.html
+ */
+class GithubCommitHash {
+	public static macro function getGitCommitHash():ExprOf<String> {
+		#if !display
+		var process:Process = new Process('git', ['rev-parse', 'HEAD']);
+		if (process.exitCode() != 0) {
+			var message:String = process.stderr.readAll().toString();
+			var pos:Position = Context.currentPos();
+			Context.error("Cannot execute `git rev-parse HEAD`. " + message, pos);
+		}
+
+		// read the output of the process
+		var commitHash:String = process.stdout.readLine();
+
+		// Generates a string expression
+		return macro $v{commitHash};
+		#else
+		// `#if display` is used for code completion. In this case returning an
+		// empty string is good enough; We don't want to call git on every hint.
+		var commitHash:String = "";
+		return macro $v{commitHash};
+		#end
+	}
+}

source/states/OptionsMenu.hx

@@ -96,7 +96,8 @@ class OptionsMenu extends MusicBeatState {
 				"infoDisplayFont"),
 			new BoolOption("FPS Counter", "fpsCounter"),
 			new BoolOption("Memory Counter", "memoryCounter"),
-			new BoolOption("Version Display", "versionDisplay")
+			new BoolOption("Version Display", "versionDisplay"),
+			new BoolOption("Commit Hash", "showCommitHash")
 		],
 		"Judgements" => [
 			new PageOption("Back", "Gameplay"),

source/states/TitleState.hx

@@ -170,6 +170,7 @@ class TitleState extends MusicBeatState {
 			Main.toggleVers(Options.getData("versionDisplay"));
 			Main.toggleLogs(Options.getData("developer"));
 			Main.changeFont(Options.getData("infoDisplayFont"));
+			Main.toggleCommitHash(Options.getData("showCommitHash"));
 
 			call("startIntroPost");
 		}
@@ -307,8 +308,6 @@ class TitleState extends MusicBeatState {
 				var http:Http = new Http("https://raw.githubusercontent.com/Vortex2Oblivion/LeatherEngine/main/version.txt");
 				http.onData = (data:String) -> {
 					data = 'v' + data;
-					trace(data);
-
 					if (CoolUtil.getCurrentVersion() != data) {
 						trace('Outdated Version Detected! ' + data.trim() + ' != ' + CoolUtil.getCurrentVersion(), WARNING);
 						Main.display.version += ' - UPDATE AVALIABLE (${data.trim()})';

source/ui/Option.hx

@@ -101,6 +101,8 @@ class BoolOption extends Option {
 				Main.toggleVers(optionChecked);
 			case "developer":
 				Main.toggleLogs(optionChecked);
+			case "showCommitHash":
+				Main.toggleCommitHash(optionChecked);
 		}
 	}
 }

source/ui/SimpleInfoDisplay.hx

@@ -1,11 +1,14 @@
 package ui;
 
+import macros.GithubCommitHash;
 import flixel.util.FlxStringUtil;
 import flixel.FlxG;
 import openfl.utils.Assets;
 import openfl.text.TextField;
 import openfl.text.TextFormat;
 import external.memory.Memory;
+import macros.GithubCommitHash;
+import haxe.macro.Compiler;
 
 /**
  * Shows basic info about the game.
@@ -35,7 +38,7 @@ class SimpleInfoDisplay extends TextField {
 		height = FlxG.height;
 	}
 
-	private function update():Void {
+	public function update():Void {
 		framerateTimer += FlxG.elapsed;
 
 		if (framerateTimer >= 1) {
@@ -59,16 +62,16 @@ class SimpleInfoDisplay extends TextField {
 
 			switch (i) {
 				case 0: // FPS
-					text += '${framerate}fps';
+					text += '${framerate}fps\n';
 				case 1: // Memory
-					text += '${FlxStringUtil.formatBytes(Memory.getCurrentUsage())} / ${FlxStringUtil.formatBytes(Memory.getPeakUsage())}';
+					text += '${FlxStringUtil.formatBytes(Memory.getCurrentUsage())} / ${FlxStringUtil.formatBytes(Memory.getPeakUsage())}\n';
 				case 2: // Version
-					text += version;
+					text += '$version\n';
 				case 3: // Console
-					text += '${Main.logsOverlay.logs.length} traced lines. F3 to view.';
+					text += Main.logsOverlay.logs.length > 0 ? '${Main.logsOverlay.logs.length} traced lines. F3 to view.\n' : '';
+				case 4:
+					text += 'Commit ${GithubCommitHash.getGitCommitHash().substring(0, 7)}';
 			}
-
-			text += '\n';
 		}
 	}
 }