stevedunn / pacman-typescript

API Endpoints for stevedunn/pacman-typescript

The stevedunn/pacman-typescript codebase utilizes a structured routing mechanism to manage various game states and actions. This documentation focuses on understanding the defined routes within the application, highlighting relevant code segments that illustrate their implementations.

Main Routes

The routing in the project is primarily managed in the src/routes.ts file. The routes are defined clearly, enabling smooth transitions between various views and functionalities of the Pacman game.

Game Initialization Route

The primary route for initializing the game can be seen in the following code snippet:

app.get("/start", (req, res) => {

// Initialize the game state

game.initialize();

res.send("Game started");

});

This route responds to HTTP GET requests at the /start path, triggering the game initialization process.

Game State Route

Another crucial route within the application is the one that fetches the current game state:

app.get("/state", (req, res) => {

res.json(game.getState());

});

This route listens for incoming requests at /state and returns the current state of the game in JSON format, allowing client applications to update the game interface accordingly.

Move Route

To facilitate player movement, the code defines a route that updates the player’s position:

app.post("/move", (req, res) => {

const { direction } = req.body;



if (game.movePlayer(direction)) {

res.send("Player moved");

} else {

res.status(400).send("Invalid move");

}

});

This POST request at /move expects a body parameter direction and updates the player’s position based on the provided direction. It validates moves and responds accordingly.

Lives Route

To track player lives, a route is provided to retrieve the current number of lives available:

app.get("/lives", (req, res) => {

res.json({ lives: game.getLives() });

});

The route at /lives returns a JSON object containing the number of lives remaining for the player, facilitating UI updates related to player status.

Game Over Route

The application features a game over route which can be invoked when the game ends:

app.post("/gameover", (req, res) => {

game.reset();

res.send("Game over. Resetting game state.");

});

At the /gameover route, a POST request triggers a reset of the game state, making it ready for a new session.

Summary of Defined Routes

  1. GET /start: Initializes the game state.
  2. GET /state: Fetches the current game state.
  3. POST /move: Updates player position based on the specified direction.
  4. GET /lives: Retrieves the number of lives remaining.
  5. POST /gameover: Resets the game state when the game is over.

These routes provide a comprehensive overview of how the stevedunn/pacman-typescript application handles game flow and state management, enabling a seamless gaming experience.