refactor(dungeons): GameDungeon hierarchy and clean ravengard layout api

Introduces GameDungeon as the shared base of both generators, renames
SkyBlockDungeon to CatacombsDungeon extending it, and rebuilds the
ravengard side as RavengardDungeon extending the same base. Directions
and rotations become enums with the rotation math on them, the catalog
moves to lombok accessors with serialized name mappings instead of
hand-rolled getters over cryptic fields, and the layout, alignment and
render code drops the abbreviated locals for descriptive names
throughout.

Author: Swofty-Developments

…net/swofty/dungeons/SkyBlockDungeon.java …et/swofty/dungeons/CatacombsDungeon.javadungeons/src/main/java/net/swofty/dungeons/SkyBlockDungeon.java renamed to dungeons/src/main/java/net/swofty/dungeons/CatacombsDungeon.java dungeons/src/main/java/net/swofty/dungeons/SkyBlockDungeon.java renamed to dungeons/src/main/java/net/swofty/dungeons/CatacombsDungeon.java

@@ -9,11 +9,16 @@
 import java.util.Map;
 import java.util.concurrent.CountDownLatch;
 
-public class SkyBlockDungeon {
+public class CatacombsDungeon extends GameDungeon {
+    @Override
+    public int getRoomCount() {
+        return rooms.size();
+    }
+
     private Map<Map.Entry<Integer, Integer>, DungeonRoom> rooms = new HashMap<>();
     private List<DungeonDoor> doors = new ArrayList<>();
 
-    public SkyBlockDungeon setRoom(int x, int y, DungeonRoom room) {
+    public CatacombsDungeon setRoom(int x, int y, DungeonRoom room) {
         rooms.put(Map.entry(x, y), room);
         return this;
     }

dungeons/src/main/java/net/swofty/dungeons/DungeonUtilities.java

@@ -14,7 +14,7 @@ public static Stream<Map.Entry<Integer, Integer>> loopOverDungeonRooms(DungeonsD
                 .map(i -> Map.entry(i % data.getWidth(), i / data.getHeight()));
     }
 
-    public static List<int[]> getFreeNeighbours(int x, int y, SkyBlockDungeon dungeon, DungeonsData data) {
+    public static List<int[]> getFreeNeighbours(int x, int y, CatacombsDungeon dungeon, DungeonsData data) {
         List<int[]> freeNeighbours = new ArrayList<>();
         if (x > 0 && dungeon.getRoom(x - 1, y).getStage() == 0) freeNeighbours.add(new int[]{x - 1, y});
         if (y > 0 && dungeon.getRoom(x, y - 1).getStage() == 0) freeNeighbours.add(new int[]{x, y - 1});
@@ -25,7 +25,7 @@ public static List<int[]> getFreeNeighbours(int x, int y, SkyBlockDungeon dungeo
         return freeNeighbours;
     }
 
-    public static List<int[]> getAdjacentBaseRooms(int x, int y, SkyBlockDungeon dungeon, DungeonsData data) {
+    public static List<int[]> getAdjacentBaseRooms(int x, int y, CatacombsDungeon dungeon, DungeonsData data) {
         List<int[]> neighbours = new ArrayList<>();
         if (x > 0 && dungeon.getRoom(x - 1, y).getRoomType() == DungeonRoomType.BASE)
             neighbours.add(new int[]{x - 1, y});
@@ -105,7 +105,7 @@ private static List<int[]> reconstructPath(Map<String, int[]> cameFrom, int star
         return path;
     }
 
-    public static void asyncPrintDungeon(SkyBlockDungeon dungeon) {
+    public static void asyncPrintDungeon(CatacombsDungeon dungeon) {
         Thread.startVirtualThread(() -> {
             System.out.println(dungeon);
         });

dungeons/src/main/java/net/swofty/dungeons/DungeonsTest.java

@@ -8,7 +8,7 @@ static void main(String[] args) {
                 .with(DungeonRoomType.MINI_BOSS, new DungeonsData.RoomData(1, 1));
 
         GeneratorService generatorService = DungeonsAPI.getGeneratorService(data);
-        SkyBlockDungeon dungeon = generatorService.generate().join();
+        CatacombsDungeon dungeon = generatorService.generate().join();
 
         System.out.println("Generated dungeon: \n" + dungeon);
         System.out.println(System.currentTimeMillis() - generatorService.getGenerationStartTime());

dungeons/src/main/java/net/swofty/dungeons/GameDungeon.java

@@ -0,0 +1,8 @@
+package net.swofty.dungeons;
+
+public abstract class GameDungeon {
+    public abstract int getRoomCount();
+
+    @Override
+    public abstract String toString();
+}

dungeons/src/main/java/net/swofty/dungeons/GeneratorService.java

@@ -15,12 +15,12 @@ public class GeneratorService {
     private final DungeonsData data;
     @Getter
     private GenerationStage currentStage = GenerationStage.INITIALIZATION;
-    private CompletableFuture<SkyBlockDungeon> generationFuture;
+    private CompletableFuture<CatacombsDungeon> generationFuture;
     @Getter
     private long generationStartTime;
 
-    public CompletableFuture<SkyBlockDungeon> generate() {
-        CompletableFuture<SkyBlockDungeon> future = new CompletableFuture<>();
+    public CompletableFuture<CatacombsDungeon> generate() {
+        CompletableFuture<CatacombsDungeon> future = new CompletableFuture<>();
         generationFuture = future;
         generationStartTime = System.currentTimeMillis();
 
@@ -58,29 +58,29 @@ public CompletableFuture<SkyBlockDungeon> generate() {
                 return new int[]{fairyX, fairyY};
             });
 
-            SkyBlockDungeon dungeon = new SkyBlockDungeon();
+            CatacombsDungeon dungeon = new CatacombsDungeon();
             DungeonUtilities.loopOverDungeonRooms(data).forEach(values -> {
                 int width = values.getKey();
                 int height = values.getValue();
 
-                dungeon.setRoom(width, height, SkyBlockDungeon.DungeonRoom.ofBase());
+                dungeon.setRoom(width, height, CatacombsDungeon.DungeonRoom.ofBase());
             });
 
             final int[] fairyPositions = {0, 0};
             // Not async, we need this done before generating the critical path
             fairyPosition.thenAccept(fairyPos -> {
                 fairyPositions[0] = fairyPos[0];
                 fairyPositions[1] = fairyPos[1];
-                dungeon.setRoom(fairyPositions[0], fairyPositions[1], new SkyBlockDungeon.DungeonRoom(DungeonRoomType.FAIRY));
+                dungeon.setRoom(fairyPositions[0], fairyPositions[1], new CatacombsDungeon.DungeonRoom(DungeonRoomType.FAIRY));
             });
 
             // We can use the entranceAndExits future to get the entrance and exit points
             entranceAndExits.thenAcceptAsync(entranceAndExit -> {
                 int entranceX = entranceAndExit[0];
                 int exitX = entranceAndExit[1];
 
-                dungeon.setRoom(entranceX, 0, new SkyBlockDungeon.DungeonRoom(DungeonRoomType.ENTRANCE));
-                dungeon.setRoom(exitX, data.getHeight() - 1, new SkyBlockDungeon.DungeonRoom(DungeonRoomType.EXIT));
+                dungeon.setRoom(entranceX, 0, new CatacombsDungeon.DungeonRoom(DungeonRoomType.ENTRANCE));
+                dungeon.setRoom(exitX, data.getHeight() - 1, new CatacombsDungeon.DungeonRoom(DungeonRoomType.EXIT));
 
                 // Move to critical path generation
                 currentStage = GenerationStage.CRITICAL_PATH;
@@ -178,12 +178,12 @@ public CompletableFuture<SkyBlockDungeon> generate() {
                 // add a chance to connect them with a door
                 for (int y = 0; y < data.getHeight(); y++) {
                     for (int x = 0; x < data.getWidth(); x++) {
-                        SkyBlockDungeon.DungeonRoom room = dungeon.getRoom(x, y);
+                        CatacombsDungeon.DungeonRoom room = dungeon.getRoom(x, y);
                         if (room.getRoomType() != DungeonRoomType.BASE) continue; // Skip if room already has a type
 
                         List<int[]> adjacentBases = DungeonUtilities.getAdjacentBaseRooms(x, y, dungeon, data);
                         for (int[] adjacent : adjacentBases) {
-                            SkyBlockDungeon.DungeonRoom adjacentRoom = dungeon.getRoom(adjacent[0], adjacent[1]);
+                            CatacombsDungeon.DungeonRoom adjacentRoom = dungeon.getRoom(adjacent[0], adjacent[1]);
                             if (adjacentRoom.getRoomType() != DungeonRoomType.BASE) continue; // Skip if adjacent room already has a type
                             if (adjacentRoom.getStage() != room.getStage()) continue; // Skip if adjacent room is not the same stage
 
@@ -201,7 +201,7 @@ public CompletableFuture<SkyBlockDungeon> generate() {
         return future;
     }
 
-    public void assignRoomsAsync(Map<DungeonRoomType, Integer> roomAmounts, SkyBlockDungeon dungeon) {
+    public void assignRoomsAsync(Map<DungeonRoomType, Integer> roomAmounts, CatacombsDungeon dungeon) {
         ExecutorService executor = Executors.newFixedThreadPool(Runtime.getRuntime().availableProcessors());
 
         List<CompletableFuture<Void>> futures = new ArrayList<>();
@@ -212,7 +212,7 @@ public void assignRoomsAsync(Map<DungeonRoomType, Integer> roomAmounts, SkyBlock
                 while (roomsAssigned.get() < amount) {
                     for (int y = 0; y < data.getHeight(); y++) {
                         for (int x = 0; x < data.getWidth(); x++) {
-                            SkyBlockDungeon.DungeonRoom room = dungeon.getRoom(x, y);
+                            CatacombsDungeon.DungeonRoom room = dungeon.getRoom(x, y);
                             if (room.getRoomType() != DungeonRoomType.BASE) continue; // Skip if room already has a type
                             if (room.isCritical()) continue; // Skip if room is critical
 
@@ -252,14 +252,14 @@ public void assignRoomsAsync(Map<DungeonRoomType, Integer> roomAmounts, SkyBlock
         executor.shutdown(); // Don't forget to shut down the executor
     }
 
-    public void assignCorridors(SkyBlockDungeon dungeon) {
+    public void assignCorridors(CatacombsDungeon dungeon) {
         Random random = new Random();
         int corridorID = 1;
         boolean[][] visited = new boolean[data.getWidth()][data.getHeight()]; // Track visited rooms
 
         for (int y = 0; y < data.getHeight(); y++) {
             for (int x = 0; x < data.getWidth(); x++) {
-                SkyBlockDungeon.DungeonRoom initialRoom = dungeon.getRoom(x, y);
+                CatacombsDungeon.DungeonRoom initialRoom = dungeon.getRoom(x, y);
                 if (!visited[x][y] && initialRoom.getRoomType() == DungeonRoomType.BASE) {
                     List<int[]> potentialCorridorSet = new ArrayList<>();
                     Queue<int[]> queue = new LinkedList<>();
@@ -273,14 +273,14 @@ public void assignCorridors(SkyBlockDungeon dungeon) {
                         if (visited[curX][curY]) continue;
                         visited[curX][curY] = true;
 
-                        SkyBlockDungeon.DungeonRoom currentRoom = dungeon.getRoom(curX, curY);
+                        CatacombsDungeon.DungeonRoom currentRoom = dungeon.getRoom(curX, curY);
                         if (currentRoom.getRoomType() == DungeonRoomType.BASE && currentRoom.getStage() == currentStage) {
                             potentialCorridorSet.add(current);
 
                             // Check adjacent base rooms of the same stage for potential inclusion
                             List<int[]> adjacents = DungeonUtilities.getAdjacentBaseRooms(curX, curY, dungeon, data);
                             for (int[] adj : adjacents) {
-                                SkyBlockDungeon.DungeonRoom adjRoom = dungeon.getRoom(adj[0], adj[1]);
+                                CatacombsDungeon.DungeonRoom adjRoom = dungeon.getRoom(adj[0], adj[1]);
                                 if (!visited[adj[0]][adj[1]] && adjRoom.getStage() == currentStage && random.nextBoolean()) {
                                     queue.offer(adj);
                                 }
@@ -291,7 +291,7 @@ public void assignCorridors(SkyBlockDungeon dungeon) {
                     // Validate and assign corridor ID only if the set connects two or more rooms
                     if (potentialCorridorSet.size() > 1) {
                         for (int[] coords : potentialCorridorSet) {
-                            SkyBlockDungeon.DungeonRoom room = dungeon.getRoom(coords[0], coords[1]);
+                            CatacombsDungeon.DungeonRoom room = dungeon.getRoom(coords[0], coords[1]);
                             room.setCorridorNumber(corridorID); // Assign corridor ID
                             dungeon.setRoom(coords[0], coords[1], room);
                         }

dungeons/src/main/java/net/swofty/dungeons/catacombs/CatacombsAPI.java

@@ -3,7 +3,7 @@
 import lombok.AccessLevel;
 import lombok.NoArgsConstructor;
 import net.swofty.dungeons.GeneratorService;
-import net.swofty.dungeons.SkyBlockDungeon;
+import net.swofty.dungeons.CatacombsDungeon;
 import net.swofty.dungeons.catacombs.classes.DungeonClassDefinition;
 import net.swofty.dungeons.catacombs.classes.DungeonClassRegistry;
 import net.swofty.dungeons.catacombs.classes.DungeonClassType;
@@ -85,7 +85,7 @@ public static GeneratorService generator(CatacombsFloorDefinition definition) {
         return CatacombsGenerator.generator(definition);
     }
 
-    public static DungeonMapRenderResult renderMap(SkyBlockDungeon dungeon, Path outputPath) throws IOException {
+    public static DungeonMapRenderResult renderMap(CatacombsDungeon dungeon, Path outputPath) throws IOException {
         return MAP_RENDERER.renderPng(dungeon, outputPath);
     }
 

dungeons/src/main/java/net/swofty/dungeons/catacombs/instance/CatacombsInstance.java

@@ -1,6 +1,6 @@
 package net.swofty.dungeons.catacombs.instance;
 
-import net.swofty.dungeons.SkyBlockDungeon;
+import net.swofty.dungeons.CatacombsDungeon;
 import net.swofty.dungeons.catacombs.CatacombsFloorDefinition;
 import net.swofty.dungeons.catacombs.boss.state.BossFightController;
 import net.swofty.dungeons.catacombs.kit.DungeonClassKit;
@@ -13,7 +13,7 @@
 public record CatacombsInstance(
         UUID id,
         CatacombsFloorDefinition floor,
-        SkyBlockDungeon dungeon,
+        CatacombsDungeon dungeon,
         CatacombsRunState runState,
         BossFightController bossFight,
         Map<UUID, DungeonClassKit> kits,

dungeons/src/main/java/net/swofty/dungeons/catacombs/instance/CatacombsInstanceService.java

@@ -1,7 +1,7 @@
 package net.swofty.dungeons.catacombs.instance;
 
 import net.swofty.dungeons.DungeonRoomType;
-import net.swofty.dungeons.SkyBlockDungeon;
+import net.swofty.dungeons.CatacombsDungeon;
 import net.swofty.dungeons.catacombs.CatacombsAPI;
 import net.swofty.dungeons.catacombs.CatacombsFloorDefinition;
 import net.swofty.dungeons.catacombs.boss.state.BossFightController;
@@ -22,7 +22,7 @@ public final class CatacombsInstanceService {
     public CatacombsInstance create(CatacombsFloorDefinition floor,
                                     Map<UUID, DungeonClassKit> kits,
                                     Path mapOutput) throws IOException {
-        SkyBlockDungeon dungeon = CatacombsAPI.generator(floor).generate().join();
+        CatacombsDungeon dungeon = CatacombsAPI.generator(floor).generate().join();
         Map<Integer, DungeonRoomEncounter> encounters = encounters(floor, dungeon);
         CatacombsRunState runState = CatacombsRunState.start(new CatacombsRunConfig(
                 floor,
@@ -39,10 +39,10 @@ public CatacombsInstance create(CatacombsFloorDefinition floor,
                 new BossFightController(floor.boss()), kits, encounters, renderedMap);
     }
 
-    private Map<Integer, DungeonRoomEncounter> encounters(CatacombsFloorDefinition floor, SkyBlockDungeon dungeon) {
+    private Map<Integer, DungeonRoomEncounter> encounters(CatacombsFloorDefinition floor, CatacombsDungeon dungeon) {
         Map<Integer, DungeonRoomEncounter> encounters = new HashMap<>();
         int roomId = 0;
-        for (SkyBlockDungeon.DungeonRoom room : dungeon.getRooms().values()) {
+        for (CatacombsDungeon.DungeonRoom room : dungeon.getRooms().values()) {
             List<DungeonMobDefinition> mobs = switch (room.getRoomType()) {
                 case MINI_BOSS -> CatacombsAPI.mobs(floor.floor(), DungeonMobRole.MINIBOSS).stream().limit(1).toList();
                 case PUZZLE -> CatacombsAPI.mobs(floor.floor(), DungeonMobRole.PUZZLE).stream().limit(1).toList();
@@ -61,7 +61,7 @@ private Map<Integer, DungeonRoomEncounter> encounters(CatacombsFloorDefinition f
         return encounters;
     }
 
-    private int estimateSecrets(CatacombsFloorDefinition floor, SkyBlockDungeon dungeon) {
+    private int estimateSecrets(CatacombsFloorDefinition floor, CatacombsDungeon dungeon) {
         int baseRooms = (int) dungeon.getRooms().values().stream()
                 .filter(room -> room.getRoomType() == DungeonRoomType.BASE)
                 .count();

dungeons/src/main/java/net/swofty/dungeons/catacombs/map/DungeonMapRenderer.java

@@ -1,6 +1,6 @@
 package net.swofty.dungeons.catacombs.map;
 
-import net.swofty.dungeons.SkyBlockDungeon;
+import net.swofty.dungeons.CatacombsDungeon;
 
 import javax.imageio.ImageIO;
 import java.awt.BasicStroke;
@@ -18,7 +18,7 @@ public final class DungeonMapRenderer {
     private static final int GAP = 14;
     private static final int PADDING = 24;
 
-    public DungeonMapRenderResult renderPng(SkyBlockDungeon dungeon, Path outputPath) throws IOException {
+    public DungeonMapRenderResult renderPng(CatacombsDungeon dungeon, Path outputPath) throws IOException {
         int maxX = dungeon.getRooms().keySet().stream().mapToInt(Map.Entry::getKey).max().orElse(0);
         int maxY = dungeon.getRooms().keySet().stream().mapToInt(Map.Entry::getValue).max().orElse(0);
         int width = PADDING * 2 + (maxX + 1) * TILE + maxX * GAP;
@@ -30,7 +30,7 @@ public DungeonMapRenderResult renderPng(SkyBlockDungeon dungeon, Path outputPath
         graphics.fillRect(0, 0, width, height);
         graphics.setStroke(new BasicStroke(6, BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND));
         graphics.setColor(new Color(0xD9C7A7));
-        for (SkyBlockDungeon.DungeonDoor door : dungeon.getDoorConnections()) {
+        for (CatacombsDungeon.DungeonDoor door : dungeon.getDoorConnections()) {
             int x1 = center(door.x1());
             int y1 = center(door.y1());
             int x2 = center(door.x2());

dungeons/src/main/java/net/swofty/dungeons/ravengard/Direction.java

@@ -0,0 +1,22 @@
+package net.swofty.dungeons.ravengard;
+
+import com.google.gson.annotations.SerializedName;
+
+public enum Direction {
+    @SerializedName("north") NORTH,
+    @SerializedName("east") EAST,
+    @SerializedName("south") SOUTH,
+    @SerializedName("west") WEST;
+
+    public Direction getOpposite() {
+        return values()[(ordinal() + 2) % 4];
+    }
+
+    public Direction rotated(Rotation rotation) {
+        return values()[(ordinal() + rotation.getQuarterTurns()) % 4];
+    }
+
+    public boolean isHorizontalAxis() {
+        return this == EAST || this == WEST;
+    }
+}