commit shaders and fix/test other examples

Bam4d · Dec 24, 2023 · 83d0b69 · 83d0b69
1 parent 1dc4455
commit 83d0b69
Show file tree

Hide file tree

Showing 62 changed files with 104 additions and 115 deletions.
diff --git a/.gitignore b/.gitignore
@@ -61,7 +61,6 @@ tests/vendor/*
 !tests/vendor/CMakeLists.txt*
 
 # Vulkan
-*.spv
 *.ppm
 
 # Idea

diff --git a/compile_shaders.bat b/compile_shaders.bat
@@ -7,6 +7,12 @@ CALL :compile_shaders_in_dir .\tests\resources\observer\block\shaders\global_lig
 CALL :compile_shaders_in_dir .\tests\resources\observer\isometric\shaders\lighting
 CALL :compile_shaders_in_dir .\tests\resources\observer\sprite\shaders\health_bars
 
+CALL :compile_shaders_in_dir .\python\examples\Custom Shaders\Global Lighting\shaders
+CALL :compile_shaders_in_dir .\python\examples\Custom Shaders\Health Bars\shaders
+CALL :compile_shaders_in_dir .\python\examples\Custom Shaders\Object Lighting\shaders
+
+
+
 EXIT /B 0
 
 :compile_shaders_in_dir

diff --git a/compile_shaders.sh b/compile_shaders.sh
@@ -4,8 +4,8 @@ cd "$(dirname "$0")"
 
 compile_shaders_in_dir () {
   echo "Compiling shaders in $1"
-  $GLSLC_BIN $1/triangle-textured.frag -o $1/triangle-textured.frag.spv
-  $GLSLC_BIN $1/triangle-textured.vert -o $1/triangle-textured.vert.spv
+  $GLSLC_BIN "$1/triangle-textured.frag" -o "$1/triangle-textured.frag.spv"
+  $GLSLC_BIN "$1/triangle-textured.vert" -o "$1/triangle-textured.vert.spv"
 }
 
 compile_shaders_in_dir ./resources/shaders/default/block
@@ -14,3 +14,8 @@ compile_shaders_in_dir ./resources/shaders/default/isometric
 compile_shaders_in_dir ./tests/resources/observer/block/shaders/global_lighting
 compile_shaders_in_dir ./tests/resources/observer/isometric/shaders/lighting
 compile_shaders_in_dir ./tests/resources/observer/sprite/shaders/health_bars
+
+
+compile_shaders_in_dir "./python/examples/Custom Shaders/Global Lighting/shaders"
+compile_shaders_in_dir "./python/examples/Custom Shaders/Health Bars/shaders"
+compile_shaders_in_dir "./python/examples/Custom Shaders/Object Lighting/shaders"
diff --git a/docs/getting-started/action spaces/index.rst b/docs/getting-started/action spaces/index.rst
@@ -230,19 +230,6 @@ Lets say our RTS game has units that have an action ``move`` and an action ``gat
 
 .. code-block:: python
 
-  # env.step([
-  #   [ # List of actions for player 1
-  #     [x1, y1, action_type1, action_id1],
-  #     [x2, y2, action_type2, action_id2],
-  #     ...
-  #   ], 
-  #   [ # List of actions for player 2
-  #     [x1, y1, action_type1, action_id1],
-  #     [x2, y2, action_type2, action_id2],
-  #     ..
-  #   ],
-  # ])
-
   env.step([
     # Player 1
     [ 

diff --git a/docs/getting-started/observation spaces/index.rst b/docs/getting-started/observation spaces/index.rst
@@ -40,7 +40,7 @@ The observations for environments where a single avatar is being controlled are
 
   # obs = np.array([ ... ]) # Player observation
 
-  obs, reward, done, info = env.step( ... )
+  obs, reward, done, truncated, info = env.step( ... )
 
   # obs = np.array([ ... ]) # Player observation
 

diff --git a/python/examples/AStar Search/main.py b/python/examples/AStar Search/main.py
@@ -1,23 +1,18 @@
-from griddly import gd, gym
+from griddly import gd
+from griddly.gym import GymWrapper
 from griddly.util.render_tools import RenderToVideo
 from griddly.wrappers.render_wrapper import RenderWrapper
 
 if __name__ == "__main__":
-    # Uncommment to see normal actions (not rotated) being used
-
+    # Astar action space: 0: up, 1: down, 2: left, 3: right
     # env = GymWrapper('astar_opponent_environment.yaml',
     #                  player_observer_type=gd.ObserverType.VECTOR,
     #                  global_observer_type=gd.ObserverType.SPRITE_2D,
     #                  level=0)
 
-    # env = GymWrapper('astar_opponent_rotation_actions_environment.yaml',
-    #                  player_observer_type=gd.ObserverType.VECTOR,
-    #                  global_observer_type=gd.ObserverType.SPRITE_2D,
-    #                  level=0)
-
-    # Uncommment to see multiple spiders chasing!
-    env = gym(
-        "astar_opponent_rotation_actions_environment.yaml",
+    # Astar action space: 1: Rotate left, 2: Move forward, 3: Rotate right
+    env = GymWrapper(
+        "./astar_opponent_rotation_actions_environment.yaml",
         player_observer_type=gd.ObserverType.VECTOR,
         global_observer_type=gd.ObserverType.SPRITE_2D,
         level=1,

diff --git a/python/examples/Custom Shaders/Global Lighting/main.py b/python/examples/Custom Shaders/Global Lighting/main.py
@@ -1,9 +1,10 @@
-from griddly import gd, gym
+from griddly import gd
+from griddly.gym import GymWrapper
 from griddly.util.render_tools import RenderToFile, RenderToVideo
 from griddly.wrappers.render_wrapper import RenderWrapper
 
 if __name__ == "__main__":
-    env = gym(
+    env = GymWrapper(
         "global_lighting.yaml",
         player_observer_type=gd.ObserverType.SPRITE_2D,
         global_observer_type=gd.ObserverType.SPRITE_2D,

diff --git a/python/examples/Custom Shaders/Global Lighting/shaders/compile_shaders.sh b/python/examples/Custom Shaders/Global Lighting/shaders/compile_shaders.sh
diff --git a/python/examples/Custom Shaders/Global Lighting/shaders/triangle-textured.frag.spv b/python/examples/Custom Shaders/Global Lighting/shaders/triangle-textured.frag.spv
diff --git a/python/examples/Custom Shaders/Global Lighting/shaders/triangle-textured.vert.spv b/python/examples/Custom Shaders/Global Lighting/shaders/triangle-textured.vert.spv
diff --git a/python/examples/Custom Shaders/Health Bars/main.py b/python/examples/Custom Shaders/Health Bars/main.py
@@ -1,9 +1,10 @@
-from griddly import gd, gym
+from griddly import gd
+from griddly.gym import GymWrapper
 from griddly.util.render_tools import RenderToFile, RenderToVideo
 from griddly.wrappers.render_wrapper import RenderWrapper
 
 if __name__ == "__main__":
-    env = gym(
+    env = GymWrapper(
         "health_bars.yaml",
         player_observer_type=gd.ObserverType.SPRITE_2D,
         global_observer_type=gd.ObserverType.SPRITE_2D,

diff --git a/python/examples/Custom Shaders/Health Bars/reset_global.png b/python/examples/Custom Shaders/Health Bars/reset_global.png
diff --git a/python/examples/Custom Shaders/Health Bars/shaders/compile_shaders.sh b/python/examples/Custom Shaders/Health Bars/shaders/compile_shaders.sh
diff --git a/python/examples/Custom Shaders/Health Bars/shaders/triangle-textured.frag.spv b/python/examples/Custom Shaders/Health Bars/shaders/triangle-textured.frag.spv
diff --git a/python/examples/Custom Shaders/Health Bars/shaders/triangle-textured.vert.spv b/python/examples/Custom Shaders/Health Bars/shaders/triangle-textured.vert.spv
diff --git a/python/examples/Custom Shaders/Object Lighting/main.py b/python/examples/Custom Shaders/Object Lighting/main.py
@@ -1,9 +1,10 @@
-from griddly import gd, gym
+from griddly import gd
+from griddly.gym import GymWrapper
 from griddly.util.render_tools import RenderToFile, RenderToVideo
 from griddly.wrappers.render_wrapper import RenderWrapper
 
 if __name__ == "__main__":
-    env = gym(
+    env = GymWrapper(
         "object_lighting.yaml",
         player_observer_type=gd.ObserverType.SPRITE_2D,
         global_observer_type=gd.ObserverType.SPRITE_2D,

diff --git a/python/examples/Custom Shaders/Object Lighting/reset_global.png b/python/examples/Custom Shaders/Object Lighting/reset_global.png
diff --git a/python/examples/Custom Shaders/Object Lighting/reset_partial.png b/python/examples/Custom Shaders/Object Lighting/reset_partial.png
diff --git a/python/examples/Custom Shaders/Object Lighting/shaders/compile_shaders.sh b/python/examples/Custom Shaders/Object Lighting/shaders/compile_shaders.sh
diff --git a/python/examples/Custom Shaders/Object Lighting/shaders/triangle-textured.frag.spv b/python/examples/Custom Shaders/Object Lighting/shaders/triangle-textured.frag.spv
diff --git a/python/examples/Custom Shaders/Object Lighting/shaders/triangle-textured.vert.spv b/python/examples/Custom Shaders/Object Lighting/shaders/triangle-textured.vert.spv
diff --git a/python/examples/Custom Shaders/README.md b/python/examples/Custom Shaders/README.md
@@ -2,21 +2,20 @@
 
 In this directory are a few examples of how to make use of custom shaders to modify the standard pixel output for more complex environnments.
 
-
 ## Global Lighting
 
-We use the episode step timer `_steps` to create a day/night cycle! 
+We use the episode step timer `_steps` to create a day/night cycle!
 
 ![Global Lighting](Global%20Lighting/global_lighting.gif)
 
 ## Health Bars
 
-In this example we show health bars on individual units in a combat scenario. 
+In this example we show health bars on individual units in a combat scenario.
 
 ![Health Bars](Health%20Bars/health_bars.gif)
 
-## Object Lighting 
+## Object Lighting
 
 Add partial observability to agents by only lighting up the immediate area around the agent and the goal
 
-![Object Lighting](Object%20Lighting/object_lighting.gif)
+![Object Lighting](Object%20Lighting/object_lighting.gif)
diff --git a/python/examples/Level Design/custom_level_global.png b/python/examples/Level Design/custom_level_global.png
diff --git a/python/examples/Level Design/custom_level_string_player_1.png b/python/examples/Level Design/custom_level_string_player_1.png
diff --git a/python/examples/Level Design/custom_level_string_player_2.png b/python/examples/Level Design/custom_level_string_player_2.png
diff --git a/python/examples/Level Design/level_0_global.png b/python/examples/Level Design/level_0_global.png
diff --git a/python/examples/Level Design/level_1_global.png b/python/examples/Level Design/level_1_global.png
diff --git a/python/examples/Level Design/level_1_player_1.png b/python/examples/Level Design/level_1_player_1.png
diff --git a/python/examples/Level Design/level_1_player_2.png b/python/examples/Level Design/level_1_player_2.png
diff --git a/python/examples/Level Design/level_2_global.png b/python/examples/Level Design/level_2_global.png
diff --git a/python/examples/Level Design/level_2_player_1.png b/python/examples/Level Design/level_2_player_1.png
diff --git a/python/examples/Level Design/level_2_player_2.png b/python/examples/Level Design/level_2_player_2.png
diff --git a/python/examples/Level Design/main.py b/python/examples/Level Design/main.py
@@ -1,9 +1,10 @@
-from griddly import gd, gym
+from griddly import gd
+from griddly.gym import GymWrapper
 from griddly.util.render_tools import RenderToFile
 from griddly.wrappers.render_wrapper import RenderWrapper
 
 if __name__ == "__main__":
-    env = gym(
+    env = GymWrapper(
         "levels.yaml",
         player_observer_type=gd.ObserverType.BLOCK_2D,
         global_observer_type=gd.ObserverType.BLOCK_2D,
@@ -26,13 +27,13 @@
             image_renderer.render(obs, f"level_{i}_player_2.png")
 
     level_string = \
-""". c c c c c c . . c c c c c c . . c c . c c c c c c . . c c c c c c . . c c . . . . . . c c . . . . c c .
-c c . . . . . . . c c . . . c c . c c . c c . . . c c . c c . . . c c . c c . . . . . . . c c . . c c . .
-c c . . . c c c . c c c c c c . . c c . c c . . . c c . c c . . . c c . c c . . . . . . . . c c c c . . .
-c c . . . . c c . c c . . . c c . c c . c c . . . c c . c c . . . c c . c c . . . . . . . . . c c . . . .
-. c c c c c c . . c c . . . c c . c c . c c c c c c . . c c c c c c . . c c c c c c c . . . . c c . . . .
+""". c c c c c c . . c c c c c c . . c c . c1 c1 c1 c1 c1 c1 . . c2 c2 c2 c2 c2 c2 . . c c . . . . . . c c . . . . c c .
+c c . . . . . . . c c . . . c c . c c . c1 c1 .  .  . c1 c1 . c2 c2 .  .  . c2 c2 . c c . . . . . . . c c . . c c . .
+c c . . . c c c . c c c c c c . . c c . c1 c1 .  .  . c1 c1 . c2 c2 .  .  . c2 c2 . c c . . . . . . . . c c c c . . .
+c c . . . . c c . c c . . . c c . c c . c1 c1 .  .  . c1 c1 . c2 c2 .  .  . c2 c2 . c c . . . . . . . . . c c . . . .
+. c c c c c c . . c c . . . c c . c c . c1 c1 c1 c1 c1 c1 . . c2 c2 c2 c2 c2 c2 . . c c c c c c c . . . . c c . . . .
  """
-    env.reset(options={level_string: level_string})
+    env.reset(options={"level_string": level_string})
     obs = global_obs_render_wrapper.render()
     image_renderer.render(obs, "custom_level_global.png")
     obs = player_1_obs_render_wrapper.render()

diff --git a/python/examples/Procedural Generation/example_maze_13x13_1.png b/python/examples/Procedural Generation/example_maze_13x13_1.png
diff --git a/python/examples/Procedural Generation/example_maze_13x13_2.png b/python/examples/Procedural Generation/example_maze_13x13_2.png
diff --git a/python/examples/Procedural Generation/example_maze_13x13_3.png b/python/examples/Procedural Generation/example_maze_13x13_3.png
diff --git a/python/examples/Procedural Generation/example_maze_21x21_1.png b/python/examples/Procedural Generation/example_maze_21x21_1.png
diff --git a/python/examples/Procedural Generation/example_maze_21x21_2.png b/python/examples/Procedural Generation/example_maze_21x21_2.png
diff --git a/python/examples/Procedural Generation/example_maze_21x21_3.png b/python/examples/Procedural Generation/example_maze_21x21_3.png
diff --git a/python/examples/Procedural Generation/example_maze_45x45_1.png b/python/examples/Procedural Generation/example_maze_45x45_1.png
diff --git a/python/examples/Procedural Generation/example_maze_45x45_2.png b/python/examples/Procedural Generation/example_maze_45x45_2.png
diff --git a/python/examples/Procedural Generation/example_maze_45x45_3.png b/python/examples/Procedural Generation/example_maze_45x45_3.png
diff --git a/python/examples/Procedural Generation/main.py b/python/examples/Procedural Generation/main.py
@@ -1,16 +1,21 @@
-import gym
+from typing import Any, Dict
+
+import gymnasium as gym
 import numpy as np
+import numpy.typing as npt
 
-from griddly.util.rllib.environment.level_generator import LevelGenerator
+from griddly.gym import GymWrapper
+from griddly.util.render_tools import RenderToFile
+from griddly.wrappers.render_wrapper import RenderWrapper
 
 
-class LabyrinthLevelGenerator(LevelGenerator):
+class LabyrinthLevelGenerator:
     WALL = "w"
     AGENT = "A"
     GOAL = "x"
     EMPTY = "."
 
-    def __init__(self, config):
+    def __init__(self, config: Dict[str, Any]) -> None:
         """
         Initialize the LabyrinthLevelGenerator.
 
@@ -35,9 +40,8 @@ def __init__(self, config):
         env.reset(level_string=level_string)
         """
 
-        super().__init__(config)
-        self._width = config.get("width", 9)
-        self._height = config.get("height", 9)
+        self._width: int = config.get("width", 9)
+        self._height: int = config.get("height", 9)
         self._wall_density = config.get(
             "wall_density", 1
         )  # Adjust this value to control wall density
@@ -46,7 +50,7 @@ def __init__(self, config):
 
         self._num_goals = config.get("num_goals", 1)
 
-    def _generate_maze(self):
+    def _generate_maze(self) -> npt.NDArray:
         """
         Generate the maze grid.
 
@@ -64,7 +68,7 @@ def _generate_maze(self):
         )
 
         # Recursive Backtracking algorithm for generating maze paths
-        def recursive_backtracking(x, y):
+        def recursive_backtracking(x: int, y: int) -> None:
             maze[x, y] = LabyrinthLevelGenerator.EMPTY
 
             # Randomize the order of directions to explore
@@ -99,7 +103,7 @@ def recursive_backtracking(x, y):
 
         return maze
 
-    def _is_reachable(self, maze, x, y):
+    def _is_reachable(self, maze: npt.NDArray, x: int, y: int) -> bool:
         """
         Check if a tile is reachable from the agent's starting position using a flood-fill algorithm.
 
@@ -133,11 +137,16 @@ def _is_reachable(self, maze, x, y):
                 ):
                     stack.append((nx, ny))
 
-        return len(visited) == self._width * self._height - np.sum(
+        len_visited = len(visited)
+        not_walls: int = self._width * self._height - np.sum(
             maze == LabyrinthLevelGenerator.WALL
         )
 
-    def _place_goals(self, maze, agent_x, agent_y):
+        return len_visited == not_walls
+
+    def _place_goals(
+        self, maze: npt.NDArray, agent_x: int, agent_y: int
+    ) -> npt.NDArray:
         """
         Place the goals in the maze while ensuring they don't block the agent's access to all tiles.
 
@@ -167,7 +176,7 @@ def _place_goals(self, maze, agent_x, agent_y):
 
         return maze
 
-    def generate(self):
+    def generate(self) -> str:
         """
         Generate a new maze level.
 
@@ -204,11 +213,15 @@ def generate(self):
 
 
 if __name__ == "__main__":
-    import matplotlib.pyplot as plt
-
+    # Use the mechanics from the built in GDY-Labyrinth-v0 environment
     env = gym.make("GDY-Labyrinth-v0")
     sizes = ["45x45", "21x21", "13x13"]
 
+    assert isinstance(env, GymWrapper)
+
+    image_renderer = RenderToFile()
+    global_obs_render_wrapper = RenderWrapper(env, "global", "rgb_array")
+
     for size in sizes:
         for i in range(3):
             config = {
@@ -217,9 +230,7 @@ def generate(self):
             }
 
             level_generator = LabyrinthLevelGenerator(config)
-            env.reset(level_string=level_generator.generate())
+            env.reset(options={"level_string": level_generator.generate()})
 
-            obs = env.render(mode="rgb_array")
-            plt.figure()
-            plt.imshow(obs)
-            plt.savefig(f"example_maze_{size}_{i+1}.png")
+            obs = global_obs_render_wrapper.render()
+            image_renderer.render(obs, f"example_maze_{size}_{i+1}.png")
diff --git a/python/examples/Projectiles/main.py b/python/examples/Projectiles/main.py
@@ -1,9 +1,10 @@
-from griddly import gd, gym
+from griddly import gd
+from griddly.gym import GymWrapper
 from griddly.util.render_tools import RenderToVideo
 from griddly.wrappers.render_wrapper import RenderWrapper
 
 if __name__ == "__main__":
-    env = gym(
+    env = GymWrapper(
         "projectiles.yaml",
         player_observer_type=gd.ObserverType.ISOMETRIC,
         global_observer_type=gd.ObserverType.ISOMETRIC,

diff --git a/python/examples/Proximity/main.py b/python/examples/Proximity/main.py
@@ -1,9 +1,10 @@
-from griddly import gd, gym
+from griddly import gd
+from griddly.gym import GymWrapper
 from griddly.util.render_tools import RenderToVideo
 from griddly.wrappers.render_wrapper import RenderWrapper
 
 if __name__ == "__main__":
-    env = gym(
+    env = GymWrapper(
         "proximity.yaml",
         player_observer_type=gd.ObserverType.ISOMETRIC,
         global_observer_type=gd.ObserverType.ISOMETRIC,

diff --git a/python/examples/Stochasticity/main.py b/python/examples/Stochasticity/main.py
@@ -1,9 +1,10 @@
-from griddly import gd, gym
+from griddly import gd
+from griddly.gym import GymWrapper
 from griddly.util.render_tools import RenderToVideo
 from griddly.wrappers.render_wrapper import RenderWrapper
 
 if __name__ == "__main__":
-    env = gym(
+    env = GymWrapper(
         "stochasticity.yaml",
         player_observer_type=gd.ObserverType.SPRITE_2D,
         global_observer_type=gd.ObserverType.SPRITE_2D,
-Original file line number
+Diff line change
@@ Expand Up / @@ -61,7 +61,6 @@ tests/vendor/* @@
     !tests/vendor/CMakeLists.txt*
     # Vulkan
-    *.spv
     *.ppm
     # Idea
@@ Expand Down @@