Improve performance, fix bugs, organize assets, update documentation (#184)

* Suppress GC.SuppressFinalize warnings

* Merge in commits from GodotUtils

* Add ComponentManager node to Autoloads.tscn

* Rename Global.cs to Autoloads.cs

* Convert OptionsManager to Component

* Move menu UI assets back to GodotUtils

* GodotUtils scripts under GodotUtils namespace

* Remove [SceneTree] from all scripts

* Replace .ToArray() with [..XYZ]

* Convert more scripts to be components

* Assumptions and Performance in ComponentManager

* Move Icon.svg to res://Framework

* Move Autoloads.tscn to GodotUtils

* Organize highlights in readme

* Uncomment LogWarning()'s in extension collections

* Set ComponentManager to be Pausable

* Autoload components no longer extend Component

* Add MenuScenes Resource to scripts

* Fix circular dependency resource errors

* Set game scene to res://Level.tscn

* Majority of options scripts no longer extend Node

* Duplicate InputEvent to prevent Godot disposing it

* Decouple Commands from GodotUtils

Author: valkyrienyanko

.editorconfig

@@ -43,6 +43,9 @@ dotnet_diagnostic.IDE0044.severity = none
 # Stop warning about user defined suppressions
 dotnet_diagnostic.IDE0079.severity = none
 
+# Stop GC.SuppressFinalize(this) warnings
+dotnet_diagnostic.CA1816.severity = none
+
 # Do not simplify XYZ.ToArray() to [.. XYZ] (I do not understand it)
 dotnet_diagnostic.IDE0305.severity = none
 

Framework/Scenes/Commands.cs Framework/Commands.csFramework/Scenes/Commands.cs renamed to Framework/Commands.cs

@@ -1,16 +1,17 @@
+using Godot;
 using GodotUtils;
 using GodotUtils.UI.Console;
 using System.Collections.Generic;
 using System.Linq;
 
 namespace __TEMPLATE__.UI;
 
-public class Commands
+public partial class Commands : Node
 {
-    public static void RegisterAll()
+    public override void _Ready()
     {
-        GameConsole.RegisterCommand("help",  CommandHelp);
-        GameConsole.RegisterCommand("quit",  CommandQuit).WithAliases("exit");
+        GameConsole.RegisterCommand("help", CommandHelp);
+        GameConsole.RegisterCommand("quit", CommandQuit).WithAliases("exit");
         GameConsole.RegisterCommand("debug", CommandDebug);
     }
 
@@ -22,7 +23,7 @@ private static void CommandHelp(string[] args)
 
     private async static void CommandQuit(string[] args)
     {
-        await Global.Instance.QuitAndCleanup();
+        await Autoloads.Instance.QuitAndCleanup();
     }
 
     private static void CommandDebug(string[] args)

Framework/Scenes/Commands.cs.uid Framework/Commands.cs.uidFramework/Scenes/Commands.cs.uid renamed to Framework/Commands.cs.uid

@@ -5,6 +5,8 @@ namespace __TEMPLATE__.UI;
 
 public partial class MainMenuNav : Node
 {
+    [Export] private PackedScene _gameScene;
+
     public override void _Ready()
     {
         GetNode<Button>("Play").GrabFocus();
@@ -13,30 +15,30 @@ public override void _Ready()
     private void _OnPlayPressed()
     {
         //AudioManager.PlayMusic(Music.Level1, false);
-        SceneManager.SwitchScene(Scene.Game);
+        SceneManager.SwitchScene(_gameScene);
     }
 
     private void _OnModsPressed()
     {
         //AudioManager.PlayMusic(Music.Level4);
-        SceneManager.SwitchScene(Scene.ModLoader);
+        SceneManager.SwitchScene(SceneManager.Instance.MenuScenes.ModLoader);
     }
 
     private void _OnOptionsPressed()
     {
         //AudioManager.PlayMusic(Music.Level4);
-        SceneManager.SwitchScene(Scene.Options);
+        SceneManager.SwitchScene(SceneManager.Instance.MenuScenes.Options);
     }
 
     private void _OnCreditsPressed()
     {
         //AudioManager.PlayMusic(Music.Level4);
-        SceneManager.SwitchScene(Scene.Credits);
+        SceneManager.SwitchScene(SceneManager.Instance.MenuScenes.Credits);
     }
 
     private async void _OnQuitPressed()
     {
-        await Global.Instance.QuitAndCleanup();
+        await Autoloads.Instance.QuitAndCleanup();
     }
 
     private void _OnDiscordPressed()

Framework/GodotUtils

@@ -0,0 +1,9 @@
+using Godot;
+
+namespace __TEMPLATE__.UI;
+
+[GlobalClass]
+public partial class Scenes : Node
+{
+    [Export] public PackedScene Game { get; private set; }
+}

Icon.svg Framework/Icon.svgIcon.svg renamed to Framework/Icon.svg

@@ -0,0 +1 @@
+uid://dhjdrl43yn46w