feat: random maze mode to MazeEscape (#86)

* ✨ Add random maze mode to MazeEscape

* fix: syntaxerrors with merge

---------

Co-authored-by: Seniru Pasan Indira <[email protected]>

Author: Gin5567

MazeEscape/Hero.js

@@ -1,12 +1,22 @@
 const symbols = require('./maps').symbols;
 
 class Hero {
-
     constructor(map) {
-        this.x = 0;
-        this.y = 0;
         this.map = map;
         this.won = false;
+
+        // find the player position
+        for (let y = 0; y < map.length; y++) {
+            for (let x = 0; x < map[y].length; x++) {
+                if (map[y][x] === "♟") {
+                    this.x = x;
+                    this.y = y;
+                    return;
+                }
+            }
+        }
+
+        throw new Error("Player ♟ not found in map.");
     }
 
     moveUp() {
@@ -31,6 +41,7 @@ class Hero {
     }
 
     moveRight() {
+        //console.log(`[DEBUG] Trying to move RIGHT from (${this.x}, ${this.y})`);
         if (this.canGo(this.x + 1, this.y)) {
             this.leave();
             this.goto(this.x + 1, this.y);
@@ -51,11 +62,11 @@ class Hero {
     }
 
     canGo(x, y) {
-        return this.map[y] && (this.map[y][x] == " " || this.map[y][x] == symbols.door);
+        return this.map[y] && (this.map[y][x] === " " || this.map[y][x] === symbols.door);
     }
 
     isWinningPosition(x, y) {
-        return this.map[y][x] == symbols.door;
+        return this.map[y][x] === symbols.door;
     }
 
     hasWon() {
@@ -64,11 +75,21 @@ class Hero {
 
     nextMap(map) {
         this.map = map;
-        this.x = 0;
-        this.y = 0;
         this.won = false;
-    }
 
+        // find the new position of ♟
+        for (let y = 0; y < map.length; y++) {
+            for (let x = 0; x < map[y].length; x++) {
+                if (map[y][x] === "♟") {
+                    this.x = x;
+                    this.y = y;
+                    return;
+                }
+            }
+        }
+
+        throw new Error("Player ♟ not found in new map.");
+    }
 }
 
 module.exports = Hero;

MazeEscape/README.md

@@ -25,6 +25,16 @@ You have to follow these steps in order to play this game
 
 <hr>
 
+### 🌀 New Feature: Random Maze Mode (2025/05/14)
+
+We've added a brand new **Random Maze Mode**!
+
+When starting game, you can press **2** to enter this mode. In this mode, the game will generate a random maze for you to escape from. Each time you play, you'll face a different maze layout, making the game even more challenging and exciting.
+
+But if you prefer the classic experience, you can still choose the **1** option to play the original maze.
+
+No more predictable maps — enjoy endless variety!
+
 ## Contributing
 
 Want to contribute this game? Great! Here are some ways that you can help us with this.

MazeEscape/generateRandomMap.js

@@ -0,0 +1,50 @@
+function generateRandomMaze(width, height) {
+    // initialize the maze with walls
+    const maze = Array.from({ length: height }, () => Array(width).fill("▉"));
+
+    // DFS carving algorithm
+    function carve(x, y) {
+        maze[y][x] = " ";
+        const dirs = [
+            [0, -2], [2, 0], [0, 2], [-2, 0]
+        ].sort(() => Math.random() - 0.5);
+
+        for (const [dx, dy] of dirs) {
+            const nx = x + dx, ny = y + dy;
+            if (ny > 0 && ny < height - 1 && nx > 0 && nx < width - 1 && maze[ny][nx] === "▉") {
+                maze[y + dy / 2][x + dx / 2] = " ";
+                carve(nx, ny);
+            }
+        }
+    }
+
+    // start carving from (1, 1)
+    carve(1, 1);
+
+    // BFS
+    const visited = Array.from({ length: height }, () => Array(width).fill(false));
+    const queue = [[1, 1]];
+    visited[1][1] = true;
+    let farthest = [1, 1];
+
+    while (queue.length) {
+        const [x, y] = queue.shift();
+        farthest = [x, y];
+        for (const [dx, dy] of [[0,1], [1,0], [-1,0], [0,-1]]) {
+            const nx = x + dx, ny = y + dy;
+            if (maze[ny]?.[nx] === " " && !visited[ny][nx]) {
+                visited[ny][nx] = true;
+                queue.push([nx, ny]);
+            }
+        }
+    }
+
+    // place the hero and the goal
+    maze[1][1] = "♟";
+    const [fx, fy] = farthest;
+    maze[fy][fx] = "▣";
+
+    return maze;
+}
+
+module.exports = { generateRandomMaze };

MazeEscape/index.js

@@ -2,80 +2,96 @@ const readline = require('readline');
 const esc = require('ansi-escapes');
 const { maps, symbols } = require('./maps.json');
 const Hero = require('./Hero');
+const { generateRandomMaze } = require('./generateRandomMap');
 
 let round = 0;
-let map = maps[round];
-let hero = new Hero(map);
+let map = null;
+let hero = null;
 let gameStart = false;
+let useRandom = false;
 let moveCount = 0;
 let totalMoves = 0;
 
 readline.emitKeypressEvents(process.stdin);
 process.stdin.setRawMode(true);
 
 process.stdin.on('keypress', (str, key) => {
-    if (key.name == 'z' && key.ctrl) {
+    if (!gameStart) {
+        if (key.name === '1') {
+            useRandom = false;
+            startGame();
+        } else if (key.name === '2') {
+            useRandom = true;
+            startGame();
+        }
+        return;
+    }
+
+    if (key.name === 'q' || (key.name === 'z' && key.ctrl)) {
+        console.log("Thank you for playing!");
         console.log(esc.cursorShow);
         process.exit(0);
-    } else if (!gameStart) {
-        gameStart = true;
-        welcome();
-    } else if (hero.hasWon()) {
-        if (round + 1 < maps.length) {
+    }
+
+    if (hero.hasWon()) {
+        if (!useRandom && round + 1 < maps.length) {
             round++;
             map = maps[round];
             hero.nextMap(map);
-            moveCount = 0;
+        } else if (useRandom) {
+            console.log(clr("🎉 Congratulations! You escaped the maze!", "green"));
+            console.log(esc.cursorShow);
+            process.exit(0);
         } else {
-            console.log(clr("Congratulations! You've completed all the maps", "green"));
-            console.log(clr("Your number of moves is " + totalMoves,"blue"));
+            console.log(clr("🎉 Congratulations! You've completed all the maps", "green"));
+            console.log(clr("Your number of moves is " + totalMoves, "blue"));
+            console.log(esc.cursorShow);
             process.exit(0);
         }
-    } else if (key.name === 'q') {
-        console.log("Thank you for playing!");
-	console.log(esc.cursorShow);
-        process.exit(0);
-    }  else {
-        if (gameStart) {
-            switch (key.name) {
-                case "up":
-                    hero.moveUp();
-                    moveCount++;
-                    totalMoves++;
-                    break;
-                case "down":
-                    hero.moveDown();
-                    moveCount++;
-                    totalMoves++;
-                    break;
-                case "left":
-                    hero.moveLeft();
-                    moveCount++;
-                    totalMoves++;
-                    break;
-                case "right":
-                    hero.moveRight();
-                    moveCount++;
-                    totalMoves++;
-                    break;
-            }
-        }
-    } 
+        draw();
+        return;
+    }
+
+    switch (key.name) {
+        case "up":
+            hero.moveUp(); break;
+        case "down":
+            hero.moveDown(); break;
+        case "left":
+            hero.moveLeft(); break;
+        case "right":
+            hero.moveRight(); break;
+        default:
+            return;
+    }
+
+    moveCount++;
+    totalMoves++;
     draw();
 });
 
+function startGame() {
+    if (useRandom) {
+        map = generateRandomMaze(15, 15);
+    } else {
+        map = maps[round];
+    }
+    hero = new Hero(map);
+    gameStart = true;
+    welcome();
+    draw();
+}
+
 function draw() {
     let res = "    " + (symbols.wall + " ").repeat(map[0].length) + "\n";
     for (let row of map) {
         res += "  " + symbols.wall + " ";
-        for (let col of row) {
-            res += col + " ";
-        }
-        res += symbols.wall + '\n';
+        for (let col of row) res += col + " ";
+        res += symbols.wall + "\n";
     }
     res += "    " + (symbols.wall + " ").repeat(map[0].length) + "\n";
     res = res.replace("♟", clr("♟", "yellow")).replace(/▣/g, clr("▣", "green"));
-    
+
     res += `\n${clr("Moves:", "blue")} ${moveCount}\n`;
     res += `${clr("Total Moves:", "blue")} ${totalMoves}\n`;
 
@@ -87,36 +103,34 @@ function draw() {
 }
 
 function welcome() {
-
     const logo = `
          __  __    __    ____  ____    ____  ___   ___    __    ____  ____
         (  \\/  )  /__\\  (_   )( ___)  ( ___)/ __) / __)  /__\\  (  _ \\( ___)
          )    (  /(__)\\  / /_  )__)    )__) \\__ \\( (__  /(__)\\  )___/ )__)
-        (_/\\/\\_)(__)(__)(____)(____)  (____)(___/ \\___)(__)(__)(__)  (____) !!!
-
+        (_/\\/\\_)(__)(__)(____)(____)  (____)(___/ \\___)(__)(__)(__)  (____)
     `;
     print(`
-
     Welcome to
     ${clr(logo, 'yellow')}
-
     Maze escape game for Salif's CLI game collection.
 
     ${clr('Help', 'green')}
      - This is you: ♟
      - This is your goal: ▣
 
-       Move your character using arrow keys and reach your goal while avoiding walls.
+     Move your character using arrow keys and reach your goal while avoiding walls.
 
-    ${clr('Press any key to continue...', 'cian')}
+    ${clr('Select game mode:', 'blue')}
+     ${clr('1.', 'cian')} Play with existing maps (from maps.json)
+     ${clr('2.', 'cian')} Play with random maze (increasing size)
 
+    ${clr('Press 1 or 2 to start...', 'yellow')}
     `);
 }
 
-/*Salif's coloring function*/
 function clr(text, color) {
     const code = { red: 91, green: 92, blue: 34, cian: 96, yellow: 93 }[color];
-    if (code) return "\x1b[" + code + "m" + text + "\x1b[0m";
+    return code ? `\x1b[${code}m${text}\x1b[0m` : text;
 }
 
 function print(str, hide = true) {

MazeEscape/package-lock.json

@@ -15,6 +15,7 @@
 	"author": "Seniru Pasan",
 	"license": "Apache-2.0",
 	"dependencies": {
-		"ansi-escapes": "^4.2.1"
+		"ansi-escapes": "^4.2.1",
+		"maze-escape": "file:"
 	}
-}
+}