Darker main theme, remove visual UI artifacts, fix translations, fixed many issues with credits and more (#189)

Author: valkyrienyanko

Framework/Autoloads/AudioManager.cs

@@ -24,14 +24,9 @@ public class AudioManager : IDisposable
     /// </summary>
     public AudioManager(Autoloads autoloads)
     {
-        _autoloads = autoloads;
-        _options = Game.Options.GetOptions();
-
-        _musicPlayer = new AudioStreamPlayer();
-        autoloads.AddChild(_musicPlayer);
-
-        _sfxPool = new GodotNodePool<AudioStreamPlayer2D>(autoloads, 
-            () => new AudioStreamPlayer2D());
+        SetupFields(autoloads);
+        SetupSfxPool();
+        SetupMusicPlayer();
     }
 
     /// <summary>
@@ -116,6 +111,24 @@ public void SetSFXVolume(float volume)
         }
     }
 
+    private void SetupFields(Autoloads autoloads)
+    {
+        _autoloads = autoloads;
+        _options = Game.Options.GetOptions();
+    }
+
+    private void SetupSfxPool()
+    {
+        _sfxPool = new GodotNodePool<AudioStreamPlayer2D>(_autoloads,
+            () => new AudioStreamPlayer2D());
+    }
+
+    private void SetupMusicPlayer()
+    {
+        _musicPlayer = new AudioStreamPlayer();
+        _autoloads.AddChild(_musicPlayer);
+    }
+
     /// <summary>
     /// Generates a random pitch between min and max, avoiding values too similar to the previous sound.
     /// </summary>

Framework/Autoloads/Autoloads.cs

@@ -42,7 +42,7 @@ public partial class Autoloads : Node
     public override void _EnterTree()
     {
         if (Instance != null)
-            throw new InvalidOperationException("Global has been initialized already");
+            throw new InvalidOperationException($"{nameof(Autoloads)} has been initialized already");
 
         Instance = this;
         ComponentManager = GetNode<ComponentManager>("ComponentManager");

Framework/Autoloads/SceneManager.cs

@@ -15,30 +15,21 @@ public class SceneManager
 
     public const int DefaultSceneFadeDuration = 2;
 
+    public Node CurrentScene => _currentScene;
+
     private MenuScenes _menuScenes;
     private SceneTree _tree;
     private Autoloads _autoloads;
     private Node _currentScene;
 
     public SceneManager(Autoloads autoloads, MenuScenes scenes)
     {
-        _autoloads = autoloads;
-        _menuScenes = scenes;
-        _tree = autoloads.GetTree();
-
-        Window root = _tree.Root;
-
-        _currentScene = root.GetChild(root.GetChildCount() - 1);
+        SetupFields(autoloads, scenes);
 
         // Gradually fade out all SFX whenever the scene is changed
         PreSceneChanged += OnPreSceneChanged;
     }
 
-    public Node GetCurrentScene()
-    {
-        return _currentScene;
-    }
-
     public void Dispose()
     {
         PreSceneChanged -= OnPreSceneChanged;
@@ -111,6 +102,17 @@ public void DeferredSwitchScene(string rawName, Variant transTypeVariant)
         }
     }
 
+    private void SetupFields(Autoloads autoloads, MenuScenes scenes)
+    {
+        _autoloads = autoloads;
+        _menuScenes = scenes;
+        _tree = autoloads.GetTree();
+
+        Window root = _tree.Root;
+
+        _currentScene = root.GetChild(root.GetChildCount() - 1);
+    }
+
     private void OnPreSceneChanged(string scene) => Game.Audio.FadeOutSFX();
 
     private void ChangeScene(string scenePath, TransType transType)

Framework/Game.cs

@@ -1,11 +1,49 @@
 using __TEMPLATE__.Debugging;
 using __TEMPLATE__.UI;
 using __TEMPLATE__.UI.Console;
+using System;
 
 namespace __TEMPLATE__;
 
 public static class Game
 {
+#if DEBUG
+    /// <summary>
+    /// Check if the autoloads singleton is not null. If it is null then show an error explaining
+    /// that the developer cannot access the autoloads singleton just yet and it needs time to
+    /// setup.
+    /// </summary>
+    private static T IsAutoloadsSetup<T>(Func<Autoloads, T> getPropertyFrom, string propertyName) where T : class
+    {
+        Autoloads autoloads = Autoloads.Instance;
+
+        if (autoloads == null)
+        {
+            string errMsg = $"Game.{propertyName} was accessed before _EnterTree or _Ready.";
+
+#if NETCODE_ENABLED
+            // Show a friendly optional error message if netcode is enabled.
+            // Since Autoloads is null we can make our own temporary Logger.
+            Logger logger = new();
+            logger.LogDebug(errMsg + " (see exception in errors for stack trace)");
+            logger.Update();
+#endif
+            throw new InvalidOperationException(errMsg);
+        }
+
+        return getPropertyFrom(autoloads)!; // Assumes the field may be null, but we are not checking it here
+    }
+
+    public static MetricsOverlay Metrics => IsAutoloadsSetup(a => a.MetricsOverlay, nameof(Metrics));
+    public static OptionsManager Options => IsAutoloadsSetup(a => a.OptionsManager, nameof(Options));
+    public static AudioManager Audio => IsAutoloadsSetup(a => a.AudioManager, nameof(Audio));
+    public static SceneManager Scene => IsAutoloadsSetup(a => a.SceneManager, nameof(Scene));
+    public static GameConsole Console => IsAutoloadsSetup(a => a.GameConsole, nameof(Console));
+    public static Profiler Profiler => IsAutoloadsSetup(a => a.Profiler, nameof(Profiler));
+    public static Services Services => IsAutoloadsSetup(a => a.Services, nameof(Services));
+    public static Logger Logger => IsAutoloadsSetup(a => a.Logger, nameof(Logger));
+#else
+    // The games release will not have the slow debugging checks
     public static MetricsOverlay Metrics  => Autoloads.Instance.MetricsOverlay;
     public static OptionsManager Options  => Autoloads.Instance.OptionsManager;
     public static AudioManager   Audio    => Autoloads.Instance.AudioManager;
@@ -14,4 +52,5 @@ public static class Game
     public static Profiler       Profiler => Autoloads.Instance.Profiler;
     public static Services       Services => Autoloads.Instance.Services;
     public static Logger         Logger   => Autoloads.Instance.Logger;
-}
+#endif
+        }

Framework/Localisation/text.csv

@@ -52,9 +52,9 @@ DIFFICULTY,Difficulty,Difficulté,困難
 ANTIALIASING,Antialiasing,Anticrénelage,アンチエイリアシング
 MODS,Mods,Mods,Mods
 RESOLUTION,Resolution,Résolution,解像度
-MOUSE\_SENSITIVITY,Mouse Sensitivity,Sensibilité de la souris,マウス感度
+MOUSE_SENSITIVITY,Mouse Sensitivity,Sensibilité de la souris,マウス感度
 GLOW,Glow,Lueur,グロー
-AMBIENT\_OCCLUSION,Ambient Occlusion,Oclusion ambiante,アンビエントオクルージョン
-INDIRECT\_LIGHTING,Indirect Lighting,Éclairage indirect,間接照明
+AMBIENT_OCCLUSION,Ambient Occlusion,Oclusion ambiante,アンビエントオクルージョン
+INDIRECT_LIGHTING,Indirect Lighting,Éclairage indirect,間接照明
 REFLECTIONS,Reflections,Reflets,反射
-RESTART,Restart,Redémarrer,再起動
+RESTART,Restart,Redémarrer,再起動

Framework/Scenes/MainMenuNav.cs

@@ -6,10 +6,11 @@ public partial class MainMenuNav : Node
 {
     [Export] private PackedScene _gameScene;
 
-    private SceneManager _scene = Game.Scene;
+    private SceneManager _scene;
 
     public override void _Ready()
     {
+        _scene = Game.Scene;
         GetNode<Button>("Play").GrabFocus();
     }