README.md

MaGame

MaGame is a package currently involving two maze games: Mappy and Pac-man. In the game Mappy, a mouse cop is searching for the criminal cat in the maze, while in the other game Pac-man, the character is trying to eat all dots in the maze.

Once you installed the package with the pip command, you may follow steps below to run the game. Step 1: import the game and mazes from the MaGame package

from magame import mappy    # Import the Mappy game
from magame import pacman   # Import the Pac-man game
from magame import mazes    # Import the pre-defined mazes

The variable mazes is a tuple, containing four nested lists representing the mazes, where:

• Maze wall is indicated by "1".
• Open path is indicated by "0".
• The target in the Mappy game is indicated by "-1". It is treated as "0" in the Pac-man game.

One example is given below, and you may create your own maze following the same format.

mazes[0]

[[0, 0, 0, 1, 1, 0, 0, 0, 1, 1],
 [0, 0, 1, 0, 1, 0, 0, 0, 0, 1],
 [1, 0, 1, 0, 1, 0, 0, 1, 0, 0],
 [1, 0, 0, 0, 1, 0, 0, 1, 0, 0],
 [1, 1, 0, 1, 1, 1, 0, 1, 1, 0],
 [0, 1, 0, 0, 1, 0, 0, 1, 0, 0],
 [0, 1, 0, 1, 1, 0, 1, 1, 1, 0],
 [0, 1, 0, 1, 0, 0, 1, 0, 0, 0],
 [0, 0, 0, 1, 0, 1, 1, 0, 1, 1],
 [1, 1, 0, 0, 0, 1, 0, 0, -1, 1]]

Step 2: create your own function that determines the movement in the maze

The user-defined function must follow the format below.

def maze_move(maze, position, memory):

    """
    Your code here
    """

    return move, memory

The input arguments of the function are:

• maze as a nested list representing the maze.
• position is a tuple with two integers: v_index and h_index. The first integer v_index indicates the vertical index, and the second integer h_index indicates the horizontal index, as shown by the picture below.
• memory can be any data type. Users may use it to keep a track of all previous steps or previous moves. The initial value of memory is given as None.

The outputs are:

• move is a tuple with two integers: v_move and h_move. It is used to indicate how the character moves in the maze, as shown by the following picture.
• memory is the updated memory, such as all previous steps or previous moves of the character in the maze.

The function receives the maze information, the current position in the maze, and previous step, moves, or other forms of memory; then decide the next move and update the memory.

Step 3: apply your function to play the game

The game can be played by simply calling the play() function of the mappy or pacman

mappy.play(maze, maze_move)
pacman.play(maze, maze_move)

There are two input arguments for the play() function:

• maze is the nested list as the maze information.
• maze_move is the name of the function you created. It can be any valid Python function name.

If your function works correctly, you will find the character moving in the maze.