merge imgui branch to internal merge (#1100)

* basic setup for imgui

* try to fix workflows

* same fix for mac and linux workflows

* forgot about the debug builds

* in game console using imgui, console commands, wip state and object inspector tools

* forgot to revert this

* use existing console bind to open imgui console, disable opening native console with bind for now

* add recursive option to Character.getList, to include ones in folders for input text suggestions and to fix the character editor command not working with folders

* debug option for disabling imgui multi viewports, disabled by default on linux due to issues

* better way of handling autopause when imgui window is open, add temp f4 bind to open wip inspector and fix debug draw coordinates when multi viewport is disabled

* compile fix for hscript config after foxlite was added

* inspector progress, cleaned up ui, foxlite support, flxobject physics and flxtext properties

* reorganize inspector code, split up properties and gizmo into different classes, wip 2d gizmo thats mostly functional, early setup for 3d gizmo

* dummy commit to update foxlite on action builds

* keybind option for inspector, finished up 2d gizmo

* switch lime branch back to cne branch

* flxtext properties compile fix and set default window pos/size on inspector windows

* hopefully fix imgui autopause issues

---------

Co-authored-by: Ralty <78720179+Raltyro@users.noreply.github.com>

Author: TheZoroForce240

.github/workflows/linux.yml

@@ -44,6 +44,7 @@ jobs:
           sudo apt-get install libvlc-dev libvlccore-dev
       - name: Installing/Updating libraries
         run: |
+          haxelib --global update haxelib
           haxe -cp commandline -D analyzer-optimize --run Main setup -si
       - name: Building the game
         run: |
@@ -127,6 +128,7 @@ jobs:
           sudo apt-get install libvlc-dev libvlccore-dev
       - name: Installing/Updating libraries
         run: |
+          haxelib --global update haxelib
           haxe -cp commandline -D analyzer-optimize --run Main setup -si
       - name: Building the game
         run: |

.github/workflows/macos.yml

@@ -35,6 +35,7 @@ jobs:
           brew trust aws/tap
           arch -x86_64 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
           arch -x86_64 /usr/local/bin/brew install zlib
+          haxelib --global update haxelib
           haxe -cp commandline -D analyzer-optimize --run Main setup -si
       - name: Building the game
         run: |
@@ -103,6 +104,7 @@ jobs:
         run: |
           brew trust aws/tap
           brew install zlib
+          haxelib --global update haxelib
           haxe -cp commandline -D analyzer-optimize --run Main setup -si
       - name: Building the game
         run: |
@@ -218,6 +220,7 @@ jobs:
           brew trust aws/tap
           arch -x86_64 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
           arch -x86_64 /usr/local/bin/brew install zlib
+          haxelib --global update haxelib
           haxe -cp commandline -D analyzer-optimize --run Main setup -si
       - name: Building the game
         run: |
@@ -285,6 +288,7 @@ jobs:
         run: |
           brew trust aws/tap
           brew install zlib
+          haxelib --global update haxelib
           haxe -cp commandline -D analyzer-optimize --run Main setup -si
       - name: Building the game
         run: |

.github/workflows/windows.yml

@@ -32,6 +32,7 @@ jobs:
       #       export/release/windows/obj/
       - name: Installing/Updating libraries
         run: |
+          haxelib --global update haxelib
           haxe -cp commandline -D analyzer-optimize --run Main setup -si --no-vscheck
       - name: Building the game
         run: |
@@ -104,6 +105,7 @@ jobs:
       #       export/debug/windows/obj/
       - name: Installing/Updating libraries
         run: |
+          haxelib --global update haxelib
           haxe -cp commandline -D analyzer-optimize --run Main setup -si --no-vscheck
       - name: Building the game
         run: |

assets/data/editors/layouts/stage/characterEditScreen.xml

@@ -95,7 +95,7 @@
 			import funkin.game.Character;
 
 			var curCharBox = new UIAutoCompleteTextBox(col(2), charTypeY, char.curCharacter, 145, 32);
-			curCharBox.suggestItems = Character.getList(false);
+			curCharBox.suggestItems = Character.getList(false, false, null, true);
 			self.add(curCharBox);
 		 </exec>
 	</section>

assets/languages/en/Options.xml

@@ -61,6 +61,7 @@
 			<str id="devMenus">Developer Menus</str>
 			<str id="openConsole">Open Console</str>
 			<str id="reloadState">Reload State</str>
+			<str id="openInspector">Open Inspector</str>
 		</group>
 	</group>
 
@@ -233,6 +234,9 @@
 
 		<str id="legacyMemoryCounter-name">Legacy Memory Counter</str>
 		<str id="legacyMemoryCounter-desc">If checked, the memory counter will show the Haxe GC memory usage and its peak (the original behavior) instead of the working set memory seen in Task Manager.</str>
+
+		<str id="imguiMultiViewport-name">ImGui Multi Viewport</str>
+		<str id="imguiMultiViewport-desc">If checked, ImGui windows can be dragged out of the main viewport, disabled by default on Linux due to common bugs and issues.</str>
 	</group>
 
 </language>

project.xml

@@ -237,6 +237,7 @@
 	<haxedef name="openfl_pool_events"/>
 	<haxedef name="openfl-enable-handle-error"/>
 	<haxedef name="openfl_no_custom_render_event"/>
+	<haxedef name="IMGUI_ENABLED" if="lime-imgui" />
 
 	<haxedef name="HXCPP_M32" if="32bit"/>
 	<haxedef name="HXCPP_DEBUG_LINK" if="debug"/>

source/funkin/backend/system/Controls.hx

@@ -31,6 +31,7 @@ enum Control
 	DEV_ACCESS;
 	DEV_CONSOLE;
 	DEV_RELOAD;
+	DEV_INSPECTOR;
 }
 
 enum KeyboardScheme
@@ -185,6 +186,12 @@ class Controls extends FlxActionSet
 	@:pressed("dev-reload") public var DEV_RELOAD_HOLD(get, set): Bool;
 	@:justReleased("dev-reload") public var DEV_RELOAD_R(get, set): Bool;
 
+	@:devModeOnly
+	@:gamepad([])
+	@:justPressed("dev-inspector") public var DEV_INSPECTOR(get, set): Bool;
+	@:pressed("dev-inspector") public var DEV_INSPECTOR_HOLD(get, set): Bool;
+	@:justReleased("dev-inspector") public var DEV_INSPECTOR_R(get, set): Bool;
+
 	@:allow(funkin.backend.utils.ControlsUtil)
 	var byName:Map<String, FlxActionDigital> = [];
 

source/funkin/backend/system/FunkinGame.hx

@@ -3,9 +3,11 @@ package funkin.backend.system;
 import flixel.FlxGame;
 import flixel.FlxG;
 import openfl.events.KeyboardEvent;
+import openfl.events.Event;
 
 class FunkinGame extends FlxGame {
 	var skipNextTickUpdate:Bool = false;
+	var manualPause:Bool = false; //fake autopause
 
 	#if desktop
 	var fullscreenListener:KeyboardEvent->Void;
@@ -34,6 +36,39 @@ class FunkinGame extends FlxGame {
 
 	override function __enterFrame(deltaTime:Float) {
 		if (skipNextTickUpdate != (skipNextTickUpdate = false)) ticks = getTicks();
+		if (manualPause) {
+			var prevAutoPause = FlxG.autoPause;
+			FlxG.autoPause = true;
+			super.__enterFrame(deltaTime);
+			FlxG.autoPause = prevAutoPause;
+			draw();
+			return;
+		}
 		super.__enterFrame(deltaTime);
 	}
+
+
+	override public function onFocus(_):Void {
+		if (manualPause) return;
+		super.onFocus(_);
+	}
+
+	override public function onFocusLost(event:Event):Void {
+		if (manualPause) return;
+		super.onFocusLost(event);
+	}
+
+	public function toggleManualPause() {
+		var prevAutoPause = FlxG.autoPause;
+		FlxG.autoPause = true;
+
+		if (!manualPause) {
+			onFocusLost(null);
+			manualPause = true;
+		} else {
+			manualPause = false;
+			onFocus(null);
+		}
+		FlxG.autoPause = prevAutoPause;
+	}
 }

source/funkin/backend/system/Logs.hx

@@ -2,25 +2,34 @@ package funkin.backend.system;
 
 import flixel.system.debug.log.LogStyle;
 import flixel.system.frontEnds.LogFrontEnd;
+import funkin.backend.system.console.ConsoleUI;
 import funkin.backend.utils.NativeAPI.ConsoleColor;
 import funkin.backend.utils.NativeAPI;
 import haxe.Log;
 
 final class Logs {
 	private static var __showing:Bool = false;
 
+	public static final LOG_WARNING_TEXT =     '   WARNING   ';
+	public static final LOG_ERROR_TEXT =       '    ERROR    ';
+	public static final LOG_TRACE_TEXT =       '    TRACE    ';
+	public static final LOG_VERBOSE_TEXT =     '   VERBOSE   ';
+	public static final LOG_SUCCESS_TEXT =     '   SUCCESS   ';
+	public static final LOG_FAILURE_TEXT =     '   FAILURE   ';
+	public static final LOG_INFORMATION_TEXT = ' INFORMATION ';
+
 	public static var nativeTrace = Log.trace;
 	public static function init() {
 		Log.trace = function(v:Dynamic, ?infos:Null<haxe.PosInfos>) {
 			var data = [
-				logText('${infos.fileName}:${infos.lineNumber}: ', CYAN),
-				logText(Std.string(v))
+				logText('${infos.fileName}:${infos.lineNumber}: ', CYAN, TRACE),
+				logText(Std.string(v), LIGHTGRAY, TRACE)
 			];
 
 			if (infos.customParams != null) {
 				for (i in infos.customParams) {
 					data.push(
-						logText("," + Std.string(i))
+						logText("," + Std.string(i), LIGHTGRAY, TRACE)
 					);
 				}
 			}
@@ -77,30 +86,31 @@ final class Logs {
 	public static function prepareColoredTrace(text:Array<LogText>, level:Level = INFO) {
 		var time = Date.now();
 		var superCoolText = [
-			logText('[  '),
-			logText('${Std.string(time.getHours()).addZeros(2)}:${Std.string(time.getMinutes()).addZeros(2)}:${Std.string(time.getSeconds()).addZeros(2)}', DARKMAGENTA),
-			logText('  |'),
+			logText('[  ', LIGHTGRAY, level),
+			logText('${Std.string(time.getHours()).addZeros(2)}:${Std.string(time.getMinutes()).addZeros(2)}:${Std.string(time.getSeconds()).addZeros(2)}', DARKMAGENTA, level),
+			logText('  |', LIGHTGRAY, level),
 			switch (level)
 			{
-				case WARNING:	logText('   WARNING   ', DARKYELLOW);
-				case ERROR:		logText('    ERROR    ', DARKRED);
-				case TRACE:		logText('    TRACE    ', GRAY);
-				case VERBOSE:	logText('   VERBOSE   ', DARKMAGENTA);
-				case SUCCESS:	logText('   SUCCESS   ', GREEN);
-				case FAILURE:	logText('   FAILURE   ', RED);
-				default:		logText(' INFORMATION ', CYAN);
+				case WARNING:	logText(LOG_WARNING_TEXT, DARKYELLOW, level);
+				case ERROR:		logText(LOG_ERROR_TEXT, DARKRED, level);
+				case TRACE:		logText(LOG_TRACE_TEXT, GRAY, level);
+				case VERBOSE:	logText(LOG_VERBOSE_TEXT, DARKMAGENTA, level);
+				case SUCCESS:	logText(LOG_SUCCESS_TEXT, GREEN, level);
+				case FAILURE:	logText(LOG_FAILURE_TEXT, RED, level);
+				default:		logText(LOG_INFORMATION_TEXT, CYAN, level);
 			},
-			logText('] ')
+			logText('] ', LIGHTGRAY, level)
 		];
 		for(k=>e in superCoolText)
 			text.insert(k, e);
 		return text;
 	}
 
-	public static function logText(text:String, color:ConsoleColor = LIGHTGRAY):LogText {
+	public static function logText(text:String, color:ConsoleColor = LIGHTGRAY, level:Level = INFO):LogText {
 		return {
 			text: text,
-			color: color
+			color: color,
+			level: level
 		};
 	}
 
@@ -129,19 +139,24 @@ final class Logs {
 		@:privateAccess
 		nativeTrace([for(t in text) t.text].join(""));
 		#end
+
+		#if IMGUI_ENABLED
+		@:privateAccess
+		ConsoleUI.instance.addToConsole(text);
+		#end
 	}
 
 	public inline static function traceColored(text:Array<LogText>, level:Level = INFO)
 		__showInConsole(prepareColoredTrace(text, level));
 
 	public static function trace(text:String, level:Level = INFO, color:ConsoleColor = LIGHTGRAY, ?prefix:String) {
-		var text = [logText(text, color)];
-		if(prefix != null) text.insert(0, getPrefix(prefix));
+		var text = [logText(text, color, level)];
+		if(prefix != null) text.insert(0, getPrefix(prefix, level));
 		traceColored(text, level);
 	}
 
-	public inline static function getPrefix(prefix:String)
-		return logText('[${prefix}] ', BLUE);
+	public inline static function getPrefix(prefix:String, level:Level = INFO)
+		return logText('[${prefix}] ', BLUE, level);
 
 	public inline static function infos(text:String, color:ConsoleColor = LIGHTGRAY, ?prefix:String)
 		Logs.trace(text, INFO, color, prefix);
@@ -169,4 +184,5 @@ enum abstract Level(Int) {
 typedef LogText = {
 	var text:String;
 	var color:ConsoleColor;
+	var level:Level;
 }