fix(core, shader, sprite, tilemap, engine, scene_manager): Update to v1.6.1

- docs(changelog): Update changelog for v1.6.1; add important bug fix details

- refactor(core): Improve type hints and imports across core modules

- style(shader, sprite, tilemap): Simplify import statements in shader, sprite, and tilemap modules

- fix(engine, scene_manager): Enhance type hints for engine instantiation and destruction methods

Author: NiklasDerEchte

docs/conf.py

@@ -11,7 +11,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'GameCore'
-copyright = '2024, Niklas Wockenfuß'
+copyright = '2025, Niklas Wockenfuß'
 author = 'Niklas Wockenfuß'
 
 # -- General configuration ---------------------------------------------------

docs/reference/changelog.rst

@@ -4,6 +4,17 @@ Changelog
 v1.6
 ^^^^
 
+v1.6 - v1.6.1
+---------------
+
+**Changed**
+
+- Import cycle changed in core. No adjustments are necessary here.
+
+**Fixes**
+
+- Important Bug Fix in ``Core.Instantiate()``. Engine was not returned
+
 v1.5.4 - v1.6
 ---------------
 

game_core/src/core/__init__.py

@@ -2,5 +2,5 @@
 
 from .coroutine import Coroutine
 from .engine import Engine
-from .scene_manager import SceneManager, SurfaceStack, Scene
+from .scene_manager import SceneManager, SurfaceStack, Scene, scene
 from .surface_stack import SurfaceStack, SurfaceStackElement

game_core/src/core/core.py

@@ -3,9 +3,9 @@
 import pygame
 import string
 
+from pygame import Surface
 from .engine import Engine
-from .surface_stack import SurfaceStack, SurfaceStackElement
-from .scene_manager import SceneManager, Scene, scene
+from .scene_manager import SceneManager
 
 class Core:
     """
@@ -206,7 +206,7 @@ def create_layer_surface(self, name=None, width=0, height=0, x=0, y=0, render_la
 
         return self.get_layer_surface(name)
 
-    def create_surface(self, size=None):
+    def create_surface(self, size=None) -> Surface:
         """
         Creates a new surface with specified dimensions.
 
@@ -235,7 +235,7 @@ def draw_surface(self, surface, position=None):
             position = (0, 0)
         self.window.blit(surface, position)
 
-    def instantiate(self, engine, **kwargs):
+    def instantiate(self, engine, **kwargs) -> Engine:
         """
         Creates and initializes a new instance of an engine class at runtime.
         This method is particularly suitable for creating **prefabs**, which are reusable templates as engines.
@@ -252,7 +252,7 @@ def instantiate(self, engine, **kwargs):
         return None
 
 
-    def destroy(self, engine):
+    def destroy(self, engine: Engine):
         """
         Destroys an engine instance and removes it from the list of active engines.
 

game_core/src/core/engine.py

@@ -1,7 +1,11 @@
+from typing import TYPE_CHECKING
 import inspect
 
 from .coroutine import Coroutine
 
+if TYPE_CHECKING:
+    from core import Core
+
 class Engine:
     """
      Represents a game engine responsible for managing coroutines and state machines.
@@ -15,7 +19,7 @@ class Engine:
      :var state_machines: List of state machines managed by the engine.
      :type state_machines: list
      """
-    def __init__(self, core):
+    def __init__(self, core: 'Core'):
         """
         Initializes the Engine.
 

game_core/src/core/scene_manager.py

@@ -35,7 +35,7 @@ def get_surface_stack(self) -> SurfaceStack:
         """
         return self._surface_stack
 
-    def instantiate_engine(self, engine, **kwargs):
+    def instantiate_engine(self, engine: Engine, **kwargs) -> Engine:
         """
         Adds an engine instance to the scene.
 
@@ -54,10 +54,11 @@ def instantiate_engine(self, engine, **kwargs):
                 e._is_started = True
             self._engines.append(e)
             self._engines = sorted(self._engines, key=lambda x: x.priority_layer, reverse=False)
+            return e
         else:
             raise TypeError("value must be an instance of Engine")
 
-    def destroy_engine(self, engine):
+    def destroy_engine(self, engine: Engine):
         """
         Destroys an engine instance and removes it from the list of active engines.
 

game_core/src/shader.py

@@ -2,7 +2,7 @@
 import math
 import random
 import pygame.draw
-from .core.core import *
+from .core import *
 
 class FogPrefab(Engine):
     def awake(self):

game_core/src/sprite.py

@@ -1,4 +1,4 @@
-from .core.core import *
+from .core import *
 import os
 
 ####################

game_core/src/tilemap.py

@@ -1,5 +1,5 @@
 import pytmx
-from .core.core import *
+from .core import *
 
 class TileMap:
     def __init__(self, filename):

setup.py

@@ -13,7 +13,7 @@ def parse_requirements(filename):
 
 setup(
     name="GameCore",
-    version="1.5.2",
+    version="1.6.1",
     description="GameCore is a nice runtime structure for pygame ",
     long_description=open("README.md", encoding="utf-8").read(),
     long_description_content_type="text/markdown",