🎉 Ensure gym.make work for all common HCraft envs (#32)

Author: MathisFederico

src/hcraft/examples/__init__.py

@@ -20,11 +20,11 @@
 import hcraft.examples.recursive as recursive
 import hcraft.examples.tower as tower
 
-from hcraft.examples.minecraft.env import MineHcraftEnv
+from hcraft.examples.minecraft import MineHcraftEnv, MINEHCRAFT_GYM_ENVS
 from hcraft.examples.random_simple import RandomHcraftEnv
 from hcraft.examples.recursive import LightRecursiveHcraftEnv, RecursiveHcraftEnv
 from hcraft.examples.tower import TowerHcraftEnv
-from hcraft.examples.minicraft import MINICRAFT_ENVS
+from hcraft.examples.minicraft import MINICRAFT_ENVS, MINICRAFT_GYM_ENVS
 
 EXAMPLE_ENVS = [
     MineHcraftEnv,
@@ -35,6 +35,15 @@
     # RandomHcraftEnv,
 ]
 
+HCRAFT_GYM_ENVS = [
+    *MINEHCRAFT_GYM_ENVS,
+    *MINICRAFT_GYM_ENVS,
+    "TowerHcraft-v1",
+    "RecursiveHcraft-v1",
+    "LightRecursiveHcraft-v1",
+]
+
+
 __all__ = [
     "minecraft",
     "minicraft",

src/hcraft/examples/minecraft/__init__.py

@@ -12,6 +12,8 @@
 from hcraft.purpose import Purpose, RewardShaping, platinium_purpose
 from hcraft.task import GetItemTask
 
+MINEHCRAFT_GYM_ENVS = []
+
 # gym is an optional dependency
 try:
     import gym
@@ -24,13 +26,15 @@
         entry_point=ENV_PATH,
         kwargs={"purpose": None},
     )
+    MINEHCRAFT_GYM_ENVS.append("MineHcraft-NoReward-v1")
 
     # Get all items, place all zones_items and go everywhere
     gym.register(
         id="MineHcraft-v1",
         entry_point=ENV_PATH,
         kwargs={"purpose": platinium_purpose(MineHcraftEnv().world)},
     )
+    MINEHCRAFT_GYM_ENVS.append("MineHcraft-v1")
 
     def _to_camel_case(name: str):
         return "".join([subname.capitalize() for subname in name.split("_")])
@@ -50,13 +54,15 @@ def _register_minehcraft_single_item(
         )
         if name is None:
             name = _to_camel_case(item.name)
+        gym_name = f"MineHcraft-{name}-v{version}"
         gym.register(
-            id=f"MineHcraft-{name}-v{version}",
+            id=gym_name,
             entry_point=ENV_PATH,
             kwargs={"purpose": purpose},
         )
+        MINEHCRAFT_GYM_ENVS.append(gym_name)
 
-    _register_minehcraft_single_item(items.DIRT)
+    _register_minehcraft_single_item(items.WOOD)
     _register_minehcraft_single_item(items.COBBLESTONE, name="Stone")
     _register_minehcraft_single_item(items.IRON_INGOT, name="Iron")
     _register_minehcraft_single_item(items.DIAMOND)

src/hcraft/examples/minicraft/__init__.py

@@ -1,34 +1,56 @@
-from hcraft.examples.minicraft.empty import MiniCraftEmpty
-from hcraft.examples.minicraft.fourrooms import MiniCraftFourRooms
-from hcraft.examples.minicraft.multiroom import MiniCraftMultiRoom
-from hcraft.examples.minicraft.crossing import MiniCraftCrossing
-from hcraft.examples.minicraft.doorkey import MiniCraftDoorKey
-from hcraft.examples.minicraft.unlock import MiniCraftUnlock
-from hcraft.examples.minicraft.unlockpickup import MiniCraftUnlockPickup
-from hcraft.examples.minicraft.unlockpickupblocked import MiniCraftBlockedUnlockPickup
-from hcraft.examples.minicraft.keycorridor import MiniCraftKeyCorridor
+import inspect
+from pathlib import Path
+
+from hcraft.examples.minicraft.empty import MiniHCraftEmpty
+from hcraft.examples.minicraft.fourrooms import MiniHCraftFourRooms
+from hcraft.examples.minicraft.multiroom import MiniHCraftMultiRoom
+from hcraft.examples.minicraft.crossing import MiniHCraftCrossing
+from hcraft.examples.minicraft.doorkey import MiniHCraftDoorKey
+from hcraft.examples.minicraft.unlock import MiniHCraftUnlock
+from hcraft.examples.minicraft.unlockpickup import MiniHCraftUnlockPickup
+from hcraft.examples.minicraft.unlockpickupblocked import MiniHCraftBlockedUnlockPickup
+from hcraft.examples.minicraft.keycorridor import MiniHCraftKeyCorridor
 
 
 MINICRAFT_ENVS = [
-    MiniCraftEmpty,
-    MiniCraftFourRooms,
-    MiniCraftMultiRoom,
-    MiniCraftCrossing,
-    MiniCraftDoorKey,
-    MiniCraftUnlock,
-    MiniCraftUnlockPickup,
-    MiniCraftBlockedUnlockPickup,
-    MiniCraftKeyCorridor,
+    MiniHCraftEmpty,
+    MiniHCraftFourRooms,
+    MiniHCraftMultiRoom,
+    MiniHCraftCrossing,
+    MiniHCraftDoorKey,
+    MiniHCraftUnlock,
+    MiniHCraftUnlockPickup,
+    MiniHCraftBlockedUnlockPickup,
+    MiniHCraftKeyCorridor,
 ]
 
 __all__ = [
-    "MiniCraftEmpty",
-    "MiniCraftFourRooms",
-    "MiniCraftMultiRoom",
-    "MiniCraftCrossing",
-    "MiniCraftDoorKey",
-    "MiniCraftUnlock",
-    "MiniCraftUnlockPickup",
-    "MiniCraftBlockedUnlockPickup",
-    "MiniCraftKeyCorridor",
+    "MiniHCraftEmpty",
+    "MiniHCraftFourRooms",
+    "MiniHCraftMultiRoom",
+    "MiniHCraftCrossing",
+    "MiniHCraftDoorKey",
+    "MiniHCraftUnlock",
+    "MiniHCraftUnlockPickup",
+    "MiniHCraftBlockedUnlockPickup",
+    "MiniHCraftKeyCorridor",
 ]
+
+MINICRAFT_GYM_ENVS = []
+
+try:
+    import gym
+
+    ENV_PATH = "hcraft.examples.minicraft"
+
+    for env_class in MINICRAFT_ENVS:
+        env_name = env_class().name
+        submodule = Path(inspect.getfile(env_class)).name.split(".")[0]
+        env_path = f"{ENV_PATH}.{submodule}:{env_class.__name__}"
+        gym_name = f"{env_name}-v1"
+        gym.register(id=gym_name, entry_point=env_path)
+        MINICRAFT_GYM_ENVS.append(gym_name)
+
+
+except ImportError:
+    pass

src/hcraft/examples/minicraft/crossing.py

@@ -9,7 +9,7 @@
 from hcraft.examples.minicraft.minicraft import MiniCraftEnv
 
 
-class MiniCraftCrossing(MiniCraftEnv):
+class MiniHCraftCrossing(MiniCraftEnv):
     MINICRAFT_NAME = "Crossing"
     __doc__ = MiniCraftEnv.description(MINICRAFT_NAME)
 

src/hcraft/examples/minicraft/doorkey.py

@@ -9,7 +9,7 @@
 from hcraft.examples.minicraft.minicraft import MiniCraftEnv
 
 
-class MiniCraftDoorKey(MiniCraftEnv):
+class MiniHCraftDoorKey(MiniCraftEnv):
     MINICRAFT_NAME = "DoorKey"
     __doc__ = MiniCraftEnv.description(MINICRAFT_NAME)
 

src/hcraft/examples/minicraft/empty.py

@@ -9,7 +9,7 @@
 from hcraft.examples.minicraft.minicraft import MiniCraftEnv
 
 
-class MiniCraftEmpty(MiniCraftEnv):
+class MiniHCraftEmpty(MiniCraftEnv):
     MINICRAFT_NAME = "Empty"
     __doc__ = MiniCraftEnv.description(MINICRAFT_NAME)
 

src/hcraft/examples/minicraft/fourrooms.py

@@ -10,7 +10,7 @@
 from hcraft.examples.minicraft.minicraft import MiniCraftEnv
 
 
-class MiniCraftFourRooms(MiniCraftEnv):
+class MiniHCraftFourRooms(MiniCraftEnv):
     MINICRAFT_NAME = "FourRooms"
     __doc__ = MiniCraftEnv.description(MINICRAFT_NAME)
 

src/hcraft/examples/minicraft/keycorridor.py

@@ -9,7 +9,7 @@
 from hcraft.examples.minicraft.minicraft import MiniCraftEnv
 
 
-class MiniCraftKeyCorridor(MiniCraftEnv):
+class MiniHCraftKeyCorridor(MiniCraftEnv):
     MINICRAFT_NAME = "KeyCorridor"
     __doc__ = MiniCraftEnv.description(MINICRAFT_NAME)
 

src/hcraft/examples/minicraft/minicraft.py

@@ -40,7 +40,7 @@ def __init__(
             start_zones_items=start_zones_items,
         )
         world.resources_path = os.path.join(os.path.dirname(__file__), "resources")
-        super().__init__(world, name=f"MiniCraft{self.minicraft_name}", **kwargs)
+        super().__init__(world, name=f"MiniHCraft{self.minicraft_name}", **kwargs)
 
     @abstractmethod
     def build_transformations(self) -> List[Transformation]:

src/hcraft/examples/minicraft/multiroom.py

@@ -9,7 +9,7 @@
 from hcraft.examples.minicraft.minicraft import MiniCraftEnv
 
 
-class MiniCraftMultiRoom(MiniCraftEnv):
+class MiniHCraftMultiRoom(MiniCraftEnv):
     MINICRAFT_NAME = "MultiRoom"
     __doc__ = MiniCraftEnv.description(MINICRAFT_NAME)