Enhance Error and Input Handling

README.md

@@ -1,5 +1,5 @@
-<div align="center">
-    <img src="logo.jpg" alt="Sendama 2d Game Engine" width="128" height="128" align="center">    
+<div align="center" style="margin: 32px">
+    <img src="logo.png" alt="Sendama 2d Game Engine" width="128" height="128" align="center">    
 </div>
 
 # Sendama &mdash; A 2D Game Engine for Terminal Based Games

composer.json

@@ -2,8 +2,8 @@
     "name": "sendamaphp/engine",
     "description": "A simple game engine for making terminal/console games. Lovingly written in pure PHP.",
     "require-dev": {
-        "pestphp/pest": "^2.34",
-        "phpstan/phpstan": "^1.10"
+        "phpstan/phpstan": "^1.10",
+        "pestphp/pest": "^4.3"
     },
     "license": "MIT",
     "autoload": {

src/Core/Rendering/SplashScreen.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace Sendama\Engine\Core\Rendering;
+
+use Sendama\Engine\Debug\Debug;
+use Exception;
+use Sendama\Engine\Core\Enumerations\SettingsKey;
+use Sendama\Engine\IO\Console\Console;
+use Sendama\Engine\IO\Console\Cursor;
+use Sendama\Engine\Util\Path;
+
+final class SplashScreen
+{
+    public function __construct(
+        private readonly Cursor $consoleCursor,
+        private readonly array $settings
+    )
+    {
+    }
+
+    public function show(): void
+    {
+        try {
+            Debug::info("Showing splash screen");
+            Console::setSize(MAX_SCREEN_WIDTH, MAX_SCREEN_HEIGHT);
+
+            // Check if a splash texture can be loaded
+            if (!file_exists($this->getSettings('splash_texture'))) {
+                Debug::warn("Splash screen texture not found: {$this->settings[SettingsKey::SPLASH_TEXTURE->value]}");
+                $this->settings[SettingsKey::SPLASH_TEXTURE->value] = Path::join(Path::getVendorAssetsDirectory(), DEFAULT_SPLASH_TEXTURE_PATH);
+            }
+
+            Debug::info("Loading splash screen texture");
+            $splashScreen = file_get_contents($this->getSettings('splash_texture'));
+            $splashScreenRows = explode("\n", $splashScreen);
+            $splashScreenWidth = 75;
+            $splashScreenHeight = 25;
+            $splashByLine = 'SendamaEngine ™';
+            $splashScreenRows[] = sprintf("%s%s", str_repeat(' ', $splashScreenWidth - 12), "powered by");
+            $splashScreenRows[] = sprintf("%s%s", str_repeat(' ', $splashScreenWidth - strlen($splashByLine)), $splashByLine);
+
+            $leftMargin = (MAX_SCREEN_WIDTH / 2) - ($splashScreenWidth / 2);
+            $topMargin = (MAX_SCREEN_HEIGHT / 2) - ($splashScreenHeight / 2);
+
+            Debug::info("Rendering splash screen texture");
+            foreach ($splashScreenRows as $rowIndex => $row) {
+                $this->consoleCursor->moveTo((int)$leftMargin, (int)($topMargin + $rowIndex));
+                Console::output()->write($row);
+            }
+
+            $duration = (int)($this->getSettings('splash_screen_duration') * 1000000);
+            usleep($duration);
+
+            Console::setSize($this->getSettings('screen_width'), $this->getSettings('screen_height'));
+            Console::clear();
+
+            Debug::info("Splash screen hidden");
+        } catch (Exception $exception) {
+            $this->handleException($exception);
+        }
+    }
+
+    private function getSettings(string $key)
+    {
+        return $this->settings[$key] ?? null;
+    }
+
+    private function handleException(Exception $exception): void
+    {
+        Debug::error("An error occurred while displaying the splash screen: " . $exception->getMessage());
+    }
+}

src/Core/Scenes/AbstractScene.php

@@ -174,7 +174,7 @@ public final function start(): void
   {
     Debug::info("Scene started: " . $this->name);
 
-    $this->createWordsSpace();
+    $this->createWorldSpace();
     $this->loadStaticEnvironment();
 
     foreach ($this->rootGameObjects as $gameObject) {
@@ -388,9 +388,9 @@ public function __unserialize(array $data): void
   }
 
   /**
-   * Creates the words space.
+   * Creates the world space.
    */
-  private function createWordsSpace(): void
+  private function createWorldSpace(): void
   {
     Debug::info('Creating world space for ' . $this->name);
     $width = $this->settings['screen_width'];

src/Core/Scenes/SceneManager.php

@@ -15,7 +15,10 @@
 use Sendama\Engine\Events\Enumerations\SceneEventType;
 use Sendama\Engine\Events\EventManager;
 use Sendama\Engine\Events\SceneEvent;
+use Sendama\Engine\Exceptions\IncorrectComponentTypeException;
 use Sendama\Engine\Exceptions\Scenes\SceneNotFoundException;
+use Sendama\Engine\Physics\Interfaces\ColliderInterface;
+use Sendama\Engine\Physics\Physics;
 
 /**
  * Class SceneManager. Manages the scenes of the game.
@@ -44,6 +47,7 @@ final class SceneManager implements SingletonInterface, CanStart, CanResume, Can
    * @var EventManager $eventManager The event manager.
    */
   protected EventManager $eventManager;
+  protected Physics $physics;
 
   /**
    * Constructs a SceneManager
@@ -52,6 +56,7 @@ private final function __construct()
   {
     $this->eventManager = EventManager::getInstance();
     $this->scenes = new ItemList(SceneInterface::class);
+    $this->physics = Physics::getInstance();
   }
 
   /**
@@ -290,6 +295,16 @@ public function getSettings(?string $key = null): mixed
    */
   public function load(): void
   {
+    $this->physics->init();
+    foreach ($this->activeSceneNode->getScene()->getRootGameObjects() as $gameObject) {
+      if ($collider = $gameObject->getComponent(ColliderInterface::class)) {
+        assert($collider instanceof ColliderInterface, new IncorrectComponentTypeException(
+          ColliderInterface::class,
+          get_class($collider)
+        ));
+        $this->physics->addCollider($collider);;
+      }
+    }
     $this->activeSceneNode->getScene()->load();
     $this->eventManager->dispatchEvent(new SceneEvent(SceneEventType::LOAD_END));
   }

src/Debug/Debug.php

@@ -4,14 +4,15 @@
 
 use RuntimeException;
 use Sendama\Engine\Debug\Enumerations\LogLevel;
+use Sendama\Engine\Exceptions\DebuggingException;
 use Sendama\Engine\Util\Path;
 
 /**
  * Class Debug. A class for logging debug messages.
  *
  * @package Sendama\Engine\Debug
  */
-class Debug
+final class Debug
 {
   /**
    * @var string|null $logDirectory The directory to write the log files to.
@@ -86,18 +87,18 @@ public static function log(
 
     if (!file_exists($filename)) {
       if (!is_writeable(self::getLogDirectory())) {
-        throw new RuntimeException("The directory, " . self::getLogDirectory() . ", is not writable.");
+        throw new DebuggingException("The directory, " . self::getLogDirectory() . ", is not writable.");
       }
 
       if (false === $file = fopen($filename, 'w')) {
-        throw new RuntimeException("Failed to create the debug log file.");
+        throw new DebuggingException("Failed to create the debug log file.");
       }
       fclose($file);
     }
 
     $message = sprintf("[%s] %s - %s", date('Y-m-d H:i:s'), $prefix, $message) . PHP_EOL;
     if (false === error_log($message, 3, $filename)) {
-      throw new RuntimeException("Failed to write to the debug log.");
+      throw new DebuggingException("Failed to write to the debug log.");
     }
   }
 
@@ -118,19 +119,19 @@ public static function error(string $message, string $prefix = '[ERROR]'): void
 
     if (!file_exists($filename)) {
       if (!is_writeable(self::getLogDirectory())) {
-        throw new RuntimeException("The directory, " . self::getLogDirectory() . ", is not writable.");
+        throw new DebuggingException("The directory, " . self::getLogDirectory() . ", is not writable.");
       }
 
       if (false === $file = fopen($filename, 'w')) {
-        throw new RuntimeException("Failed to create the error log file.");
+        throw new DebuggingException("Failed to create the error log file.");
       }
 
       fclose($file);
     }
 
     $message = sprintf("[%s] %s - %s", date('Y-m-d H:i:s'), $prefix, $message) . PHP_EOL;
     if (false === error_log($message, 3, $filename)) {
-      throw new RuntimeException("Failed to write to the debug log.");
+      throw new DebuggingException("Failed to write to the error log.");
     }
   }
 
@@ -155,4 +156,4 @@ public static function info(string $message, ?string $prefix = null): void
   {
     self::log($message, $prefix ?? '[INFO]', LogLevel::INFO);
   }
-}
+}

src/Exceptions/DebuggingException.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Sendama\Engine\Exceptions;
+
+use RuntimeException;
+
+final class DebuggingException extends RuntimeException
+{
+    public function __construct(string $message, int $code = 0, ?\Throwable $previous = null)
+    {
+        parent::__construct("DebuggingException: " . $message, $code, $previous);
+    }
+}

src/Exceptions/IOException.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Sendama\Engine\Exceptions;
+
+class IOException extends SendamaException
+{
+}

src/Game.php

@@ -155,6 +155,18 @@ public function __construct(private readonly string $name, private readonly int
     }
   }
 
+  /**
+   * Destruct the game engine.
+   */
+  public function __destruct()
+  {
+    Console::restoreSettings();
+
+    if ($lastError = error_get_last()) {
+      $this->handleError($lastError['type'], $lastError['message'], $lastError['file'], $lastError['line']);
+    }
+  }
+
   /**
    * @return void
    */
@@ -204,7 +216,6 @@ protected function configureErrorAndExceptionHandlers(): void
   private function handleException(Exception|Throwable|Error $exception): never
   {
     Debug::error($exception);
-//    Console::reset();
     $this->stop();
 
     if ($this->getSettings('debug')) {
@@ -221,6 +232,8 @@ private function handleException(Exception|Throwable|Error $exception): never
    */
   public function stop(): void
   {
+    Console::reset();
+
     Debug::info("Stopping game");
 
     // Disable non-blocking input mode
@@ -495,19 +508,6 @@ public static function quit(): void
     }
   }
 
-  /**
-   * Destruct the game engine.
-   */
-  public function __destruct()
-  {
-    Console::restoreSettings();
-    Console::reset();
-
-    if ($lastError = error_get_last()) {
-      $this->handleError($lastError['type'], $lastError['message'], $lastError['file'], $lastError['line']);
-    }
-  }
-
   /**
    * Run the game.
    *
@@ -525,6 +525,11 @@ public function run(): void
       while ($this->isRunning) {
         $this->handleInput();
         $this->update();
+
+        if (!$this->isRunning) {
+          break;
+        }
+
         $this->render();
 
         usleep($sleepTime);

src/IO/Console/Console.php

@@ -229,6 +229,7 @@ public static function saveSettings(): void
   public static function restoreSettings(): void
   {
     shell_exec('stty ' . self::$previousTerminalSettings);
+    Console::cursor()->enableBlinking();
   }
 
   /**

src/IO/Input.php

@@ -51,9 +51,9 @@ public static function areAllKeysPressed(array $keyCodes): bool
    * @param array<KeyCode> $keyCodes
    * @return bool Returns true if any key is pressed, false otherwise.
    */
-  public static function isAnyKeyPressed(array $keyCodes): bool
+  public static function isAnyKeyPressed(array $keyCodes, bool $ignoreCase = true): bool
   {
-    return InputManager::isAnyKeyPressed($keyCodes);
+    return InputManager::isAnyKeyPressed($keyCodes, $ignoreCase);
   }
 
   /**
@@ -99,4 +99,4 @@ public static function isButtonDown(string $buttonName): bool
   {
     return InputManager::isButtonDown($buttonName);
   }
-}
+}