metagrid 0.1.3__tar.gz

metagrid-0.1.3/.gitignore

@@ -0,0 +1,11 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+*.py[cod]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv

metagrid-0.1.3/LICENSE

@@ -0,0 +1,16 @@
+License
+=======
+
+Copyright 2025 Matthieu Marchand
+
+Metagrid is licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

metagrid-0.1.3/NOTICE

@@ -0,0 +1,5 @@
+metagrid
+Copyright (c) 2025 Matthieu Marchand
+
+This product includes software developed by third parties.
+See THIRD_PARTY_LICENSES for details.

metagrid-0.1.3/PKG-INFO

@@ -0,0 +1,55 @@
+Metadata-Version: 2.4
+Name: metagrid
+Version: 0.1.3
+Summary: Metagrid is a simple game engine for 2D Grid Games
+Author-email: Matthieu Marchand <matthieu.marchand@gmail.com>
+License: License
+        =======
+        
+        Copyright 2025 Matthieu Marchand
+        
+        Metagrid is licensed under the Apache License, Version 2.0 (the "License");
+        you may not use this file except in compliance with the License.
+        You may obtain a copy of the License at
+        
+            http://www.apache.org/licenses/LICENSE-2.0
+        
+        Unless required by applicable law or agreed to in writing, software
+        distributed under the License is distributed on an "AS IS" BASIS,
+        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+        See the License for the specific language governing permissions and
+        limitations under the License.
+License-File: LICENSE
+License-File: NOTICE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Requires-Dist: arcade>=3.3.0
+Requires-Dist: pillow>=11
+Description-Content-Type: text/markdown
+
+# Metagrid
+
+
+## Description
+
+Metagrid is a Python library for creating simple 2D grid games.
+
+A grid cell can be:
+
+- Plain colored
+- An image
+- A character
+
+## Installation
+
+You can install Metagrid using pip:
+
+```shell
+pip install metagrid

metagrid-0.1.3/README.md

@@ -0,0 +1,19 @@
+# Metagrid
+
+
+## Description
+
+Metagrid is a Python library for creating simple 2D grid games.
+
+A grid cell can be:
+
+- Plain colored
+- An image
+- A character
+
+## Installation
+
+You can install Metagrid using pip:
+
+```shell
+pip install metagrid

metagrid-0.1.3/THIRD_PARTY_LICENSES/arcade.MIT.txt

@@ -0,0 +1,14 @@
+License
+=======
+
+Copyright (c) 2025 Paul Vincent Craven
+
+The Arcade library is licensed under the `MIT License`_.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+.. _MIT License: https://tldrlegal.com/license/mit-license

metagrid-0.1.3/THIRD_PARTY_LICENSES/pillow.MIT.txt

@@ -0,0 +1,33 @@
+License
+=======
+
+The Python Imaging Library (PIL) is
+
+    Copyright © 1997-2011 by Secret Labs AB
+    Copyright © 1995-2011 by Fredrik Lundh and contributors
+
+Pillow is the friendly PIL fork. It is
+
+    Copyright © 2010 by Jeffrey A. Clark and contributors
+
+Like PIL, Pillow is licensed under the open source MIT-CMU License:
+
+By obtaining, using, and/or copying this software and/or its associated
+documentation, you agree that you have read, understood, and will comply
+with the following terms and conditions:
+
+Permission to use, copy, modify and distribute this software and its
+documentation for any purpose and without fee is hereby granted,
+provided that the above copyright notice appears in all copies, and that
+both that copyright notice and this permission notice appear in supporting
+documentation, and that the name of Secret Labs AB or the author not be
+used in advertising or publicity pertaining to distribution of the software
+without specific, written prior permission.
+
+SECRET LABS AB AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
+SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS.
+IN NO EVENT SHALL SECRET LABS AB OR THE AUTHOR BE LIABLE FOR ANY SPECIAL,
+INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

metagrid-0.1.3/pyproject.toml

@@ -0,0 +1,62 @@
+[build-system]
+requires = ["hatchling>=1.25", "hatch-vcs>=0.4"]
+build-backend = "hatchling.build"
+
+[project]
+name = "metagrid"
+dynamic = ["version"]
+description = "Metagrid is a simple game engine for 2D Grid Games"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { file = "LICENSE" }
+authors = [{ name = "Matthieu Marchand", email = "matthieu.marchand@gmail.com" }]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+]
+
+dependencies = [
+    "arcade>=3.3.0",
+    "pillow>=11"
+]
+
+
+#[project.urls]
+#Homepage = "https://github.com/toncompte/grox"
+#Repository = "https://github.com/toncompte/grox"
+#Issues = "https://github.com/toncompte/grox/issues"
+#Changelog = "https://github.com/toncompte/grox/blob/main/CHANGELOG.md"
+
+
+[dependency-groups]
+dev = [
+    "pytest>=8.3",
+    "ruff>=0.6",
+    "mypy>=1.11",
+    "twine>=6.2.0",
+]
+
+[tool.uv]
+default-groups = ["dev"]
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/metagrid"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "src/metagrid",  # ← Changé de "src/boxy" à "src/metagrid"
+  "README.md",
+  "LICENSE",
+  "NOTICE",
+  "THIRD_PARTY_LICENSES/**",
+  "CHANGELOG.md",
+]

metagrid-0.1.3/src/metagrid/CrafterFactory.py

@@ -0,0 +1,21 @@
+# pyright: reportImportCycles=false
+from typing import Callable, Literal
+from . import backends
+
+BackendName = Literal["arcade"]
+
+class CrafterFactory:
+
+    @staticmethod
+    def create(backend: BackendName, nrows: int,
+            ncols: int, cell_size: int, margin: int, init: Callable[[], None]) -> backends.AbstractCrafter:
+        """
+        Crée une instance de moteur de grille selon le backend choisi.
+
+        Retourne une instance du crafter choisi (ArcadeCrafter est le seul backend supporté pour l'instant).
+        """
+        if backend == "arcade":
+            from .backends.arcade_impl import ArcadeCrafter
+            return ArcadeCrafter(nrows, ncols, cell_size, margin, init)
+        else:
+            raise ValueError(f"Backend inconnu : {backend!r}")  # pyright: ignore[reportUnreachable]

metagrid-0.1.3/src/metagrid/__init__.py

@@ -0,0 +1,15 @@
+try:
+    from importlib.metadata import version
+    __version__ = version("metagrid")
+except Exception:
+    __version__ = "0.0.0"
+
+
+from typing import Callable
+from .backends import AbstractCrafter
+from .CrafterFactory import CrafterFactory
+
+def create(nb_lignes: int, nb_colonnes: int, cell_size: int, margin: int, init: Callable[[], None]) -> AbstractCrafter:
+    return CrafterFactory.create("arcade", nb_lignes, nb_colonnes, cell_size, margin, init)
+
+__all__ = ["create"]

metagrid-0.1.3/src/metagrid/backends/__init__.py

@@ -0,0 +1,5 @@
+
+from .abstract import AbstractCrafter
+
+
+__all__ = ["AbstractCrafter"]

metagrid-0.1.3/src/metagrid/backends/abstract.py

@@ -0,0 +1,73 @@
+from typing import Callable
+from abc import ABCMeta, abstractmethod
+
+class AbstractCrafter(metaclass = ABCMeta):
+    """
+    Abstracting the functionalities independently of its implementation
+    """
+
+    def __init__(self, nb_lignes: int, nb_colonnes: int, cell_size: int, margin: int, init: Callable[[], None]):
+        """
+        Initialisation du jeu.
+        """
+        self.margin: int = margin        # grid line with (px)
+        self.nrows: int = nb_lignes      # Number of rows
+        self.ncols: int = nb_colonnes    # Number of columns
+        self.cell_size: int = cell_size  # Cell size
+        self.fps: int = 60               # FPS, defaults to 60
+        self.frame_no: int = 0           # Holds the number of frame since start
+        self.init: Callable[[], None] = init
+
+
+
+    @abstractmethod
+    def start(self, fn_click: Callable[[int, int], None] | None,
+                    fn_key: Callable[[str], None] | None,
+                    fn_draw: Callable[[], None],
+                    fn_update: Callable[[], None]):
+        """
+        Start the engine, declaring callbacks
+        """
+        self.fn_click: Callable[[int, int], None] | None = fn_click
+        self.fn_key: Callable[[str], None] | None= fn_key
+        self.fn_draw: Callable[[], None] | None = fn_draw
+        self.fn_update: Callable[[], None] | None = fn_update
+        ...
+
+
+    @abstractmethod
+    def exit(self):
+        """Permet de fermer l'application"""
+        ...
+
+    @abstractmethod
+    def set_cell_color(self, i: int, j: int, couleur: str):
+        """permet decolorier une case de la grille"""
+        ...
+
+    @abstractmethod
+    def set_cell_image(self, i: int, j: int, image: str):
+        """permet decolorier une case de la grille"""
+        ...
+
+    @abstractmethod
+    def set_cell_char(self, i: int, j: int, char: str, color: str):
+        """sets a cell to a character"""
+        assert len(char) < 2
+        ...
+
+
+    @abstractmethod
+    def load_image(self, name: str, path: str):
+        """Loads the image stored at `path` under the `name` key in the engine's textures cache"""
+        ...
+
+    @abstractmethod
+    def show_init_dialog(self, texte1: str, texte2: str):
+        """shows a screen with text1 and text2 right under.
+        Click on the screen to dismiss it then run the init callback"""
+        ...
+
+    @abstractmethod
+    def play_sound(self, path: str):
+        ...

metagrid-0.1.3/src/metagrid/backends/arcade_impl.py

@@ -0,0 +1,239 @@
+from arcade.sound import Sound
+from arcade.application import View
+from arcade.application import Window
+from arcade.sprite.colored import SpriteSolidColor
+from arcade.texture.texture import Texture
+from typing_extensions import override
+
+
+from arcade.types import Color, RGBOrA255
+from .abstract import AbstractCrafter
+from typing import Callable
+from PIL import Image
+import arcade
+import logging
+import re
+
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.INFO)
+
+
+def _hex_to_rgb(hex_color: str) -> RGBOrA255:
+    assert bool(re.fullmatch(r"#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})", hex_color)), f"Bad color format for #RRGGBB/#RRGGBBAA: {hex_color}"
+
+    hex_color = hex_color.lstrip("#")
+    if len(hex_color) == 6:
+        return tuple[int, int, int](int(hex_color[i:i+2], 16) for i in (0, 2, 4)) #type: ignore
+    elif len(hex_color) == 8:
+        return tuple[int, int, int, int](int(hex_color[i:i+2], 16) for i in (0, 2, 4, 6)) #type: ignore
+    else:
+        raise ValueError("Invalid hex color format")
+
+class ArcadeCrafter(AbstractCrafter):
+    def __init__(self, nb_lignes: int, nb_colonnes: int, cell_size: int, margin: int, init: Callable[[], None]):
+        super().__init__(nb_lignes, nb_colonnes, cell_size, margin, init)
+        WINDOW_WIDTH = (self.cell_size + self.margin) * self.ncols + self.margin
+        WINDOW_HEIGHT = (self.cell_size + self.margin) * self.nrows + self.margin
+        WINDOW_TITLE = ""
+
+        self.window: Window = arcade.Window(WINDOW_WIDTH, WINDOW_HEIGHT, WINDOW_TITLE)
+        self.view: GameView = GameView(self)
+        self.frame_no: int = 0
+
+    @override
+    def start(self, fn_click: Callable[[int, int], None] | None,
+                    fn_key: Callable[[str], None] | None,
+                    fn_draw: Callable[[], None],
+                    fn_update: Callable[[], None]):
+        """Cette fonction permet de démarrer l'affichage
+        d'une grille de taille nb_lign x nb_colonnes.
+        la fonction chargée de la gestion du clic est la fonction fn_click
+        """
+        super().start(fn_click, fn_key, fn_draw, fn_update)
+
+        self.window.show_view(self.view)
+
+        arcade.run()
+
+
+    @override
+    def exit(self):
+        pass
+
+    @override
+    def set_cell_color(self, i: int, j: int, couleur: str):
+        """permet de colorier une case de la grille"""
+        if i >= self.nrows or j >= self.ncols:
+            return
+        i = self.nrows - 1 - i
+
+        # TODO improve by not recreating each time
+        empty_image = Image.new("RGBA", (self.cell_size, self.cell_size), (255, 255, 255, 255))
+        empty_texture = arcade.Texture(name="vide", image=empty_image)
+
+        self.view.grid_sprites[i][j].texture = empty_texture
+        self.view.grid_sprites[i][j].color = _hex_to_rgb(couleur)
+
+    @override
+    def set_cell_image(self, i: int, j: int, image: str):
+        """Color cell i,j with image in cache"""
+        if i >= self.nrows or j >= self.ncols:
+            return
+        i = self.nrows - 1 - i
+        self.view.grid_sprites[i][j].color = _hex_to_rgb("#FFFFFFFF")
+        self.view.grid_sprites[i][j].texture = self.view.textures[image]
+
+    @override
+    def set_cell_char(self, i: int, j: int, char: str, color: str):
+        super().set_cell_char(i, j, char, color)
+        if 0 <= i < self.nrows and 0 <= j < self.ncols:
+            i_flipped = self.nrows - 1 - i
+            sprite = self.view.grid_sprites[i_flipped][j]
+
+            if char:
+                # Create or update the Text
+                if self.view.grid_chars[i][j] is None:
+                    self.view.grid_chars[i][j] = arcade.Text(
+                        text=char,
+                        x=sprite.center_x,
+                        y=sprite.center_y,
+                        color=_hex_to_rgb(color),
+                        font_size=48,
+                        anchor_x="center",
+                        anchor_y="center"
+                    )
+                elif self.view.grid_chars[i][j].text != char: #type: ignore  # pyright: ignore[reportOptionalMemberAccess]
+                    self.view.grid_chars[i][j].text = char #type: ignore  # pyright: ignore[reportOptionalMemberAccess]
+            else:
+                # Clear the character
+                self.view.grid_chars[i][j] = None
+
+    @override
+    def load_image(self, name: str, path: str):
+        self.view.textures[name] = arcade.load_texture(path)
+        self.view.textures[name].width = self.cell_size
+        self.view.textures[name].height = self.cell_size
+
+    @override
+    def show_init_dialog(self, texte1: str, texte2: str):
+        print("Not implemented yet")
+
+    @override
+    def play_sound(self, path: str):
+        son: Sound = arcade.load_sound(path)
+        _ = son.play()
+
+
+
+class GameView(arcade.View):
+    """
+    Main application class.
+    """
+
+    def __init__(self, crafter: ArcadeCrafter):
+        """
+        Set up the application.
+        """
+        super().__init__()
+        self.crafter: ArcadeCrafter = crafter
+        # Set the background color of the window
+        self.background_color: Color = arcade.color.BLACK
+
+        self.textures: dict[str, arcade.Texture] = dict[str, Texture]()
+        # 1d list of all sprites in the two-dimensional sprite list
+        self.grid_sprite_list: arcade.SpriteList[arcade.Sprite] = arcade.SpriteList()
+
+        # 2d grid hat holds references to the spritelist
+        self.grid_sprites: list[list[arcade.Sprite]] = []
+
+        # 2d grid that holds Texts to be drawn on top of sprites
+        self.grid_chars: list[list[arcade.Text|None]] = [[None for _ in range(crafter.ncols)] for _ in range(crafter.nrows)]
+
+        # Create a list of solidcolor sprites to represent each cell
+        for row in range(self.crafter.nrows):
+            self.grid_sprites.append([])
+            for column in range(self.crafter.ncols):
+                x = column * (self.crafter.cell_size + self.crafter.margin) + (self.crafter.cell_size / 2 + self.crafter.margin)
+                y = row * (self.crafter.cell_size + self.crafter.margin) + (self.crafter.cell_size / 2 + self.crafter.margin)
+                sprite: SpriteSolidColor = arcade.SpriteSolidColor(self.crafter.cell_size, self.crafter.cell_size, color=arcade.color.WHITE)
+                sprite.center_x = x
+                sprite.center_y = y
+                self.grid_sprite_list.append(sprite)
+                self.grid_sprites[row].append(sprite)
+
+    @override
+    def on_update(self, delta_time: float) -> bool | None:
+        logger.debug(f"on_update({delta_time})")
+        self.crafter.frame_no += 1 #! Incrémentation du frame_no
+        #print("test")
+        _ = super().on_update(delta_time)
+        if self.crafter.fn_update:
+            self.crafter.fn_update()
+
+    @override
+    def on_key_press(self, symbol: int, modifiers: int) -> bool | None:
+        logger.debug(f"on_key_press({symbol}, {modifiers})")
+        _ = super().on_key_press(symbol, modifiers)
+        #print(symbol, chr(symbol), modifiers)
+        if self.crafter.fn_key:
+            self.crafter.fn_key(chr(symbol))
+#            self.immediate_update()
+
+    @override
+    def on_draw(self):
+        """
+        Render the screen.
+        """
+        if self.crafter.fn_draw:
+            self.crafter.fn_draw()
+        self.clear()
+        self.grid_sprite_list.draw()
+        #print(self.grid_chars)
+        for i in range(self.crafter.nrows):
+            for j in range(self.crafter.ncols):
+                text_obj = self.grid_chars[i][j]
+                if text_obj:
+                    text_obj.draw()
+
+    @override
+    def on_mouse_press(self, x: int, y: int, button: int, modifiers: int):
+        """
+        Called when the user presses a mouse button.
+        """
+        logger.debug(f"on_mouse_press({x},{y},{button},{modifiers})")
+        column = int(x // (self.crafter.cell_size + self.crafter.margin))
+        row = self.crafter.nrows - 1 - int(y // (self.crafter.cell_size + self.crafter.margin))
+        logger.debug(f"Grid coordinates: ({row}, {column})")
+        if self.crafter.fn_click:
+            self.crafter.fn_click(row, column)
+            #self.immediate_update()
+
+"""
+    def immediate_update(self):
+        self.on_update(0)
+        self.window.set_update_rate(0)
+        self.on_draw()
+        self.window.flip()
+        self.window.set_update_rate(1/self.crafter.fps)
+"""
+
+class InformationView(arcade.View):
+
+    def __init__(self, view: arcade.View, background_color: str) -> None:
+        self.window: Window = view.window
+        self.view: View = view
+
+        super().__init__(self.window, _hex_to_rgb(background_color) if background_color else None)
+
+    @override
+    def on_draw(self):
+        self.clear()
+        arcade.draw_text("Instructions Screen", self.window.width / 2, self.window.height / 2,
+                         arcade.color.BLACK, font_size=50, anchor_x="center")
+        arcade.draw_text("Click to advance", self.window.width / 2 , self.window.height / 2 - 75,
+                         arcade.color.GRAY, font_size=20, anchor_x="center")
+
+    @override
+    def on_mouse_press(self, x: int, y: int, button: int, modifiers: int):
+        game_view = self.view
+        self.window.show_view(game_view)