maze-gitb 1.0.2

A maze game that required users to think inside the box to win

Getting Inside The Box

This game was developed by the team Benevolent Bonobos, during the Summer Code Jam 2021 held by Python Discord.

Teams that participated in the code jam had to create a TUI based on the theme Think Inside the Box.

Contents

• How To Play
• Requirements
• Installation
• Screenshots
• Future Improvements
• About Us

How To Play

1. There are 6 options in start menu:
   • Start: Play the normal levels.
   • Infinite: Never ending gameplay.
   • Tutorial: How to play.
   • Credits
   • Leaderboard
   • Quit
2. Use arrow keys to move.
3. On starting, a glimpse of the whole maze will be shown. After it disappears, the game will start.
4. Player has to reach & with minimum collisions with the walls and in minimum time.
5. Boxes:
   • The place to stop and think.
   • Will show the part of the maze associated with the box.
   • Time slows down here.
6. Echolocation:
   • Press e to make a noise.
   • An echo will come from the direction in which player last moved.
   • The echo will get stronger the nearer the player is to the wall.
7. Persistence:
   • It acts as a score for a player.
   • Higher is better.
   • It will decrease with time.
   • It will decrease more and more with each collision.
   • Since time slows down in a box, persistence will decrease slower inside the box.
   • It is visible in the top right corner.
8. In the top left corner, the number of collisions made in the current level is visible.
9. On pressing q, the game will be paused. There will be an option to play again or quit.
10. In normal mode, a player can play 9 levels.
11. In infinite mode, a player will have to press q for quitting.
12. After completing all normal levels, a player, if they want, can put their name in the leaderboard which stores their score.

Requirements

• Python 3.8.6 or greater
• A stereo headset (for echolocation)
• The terminal window should be sufficiently large (At least 50 x 15 characters in width and height). You should not resize the terminal during the game.

Installation

Windows

pip install maze-gitb

Linux

pip3 install maze-gitb

Contribution

1. Clone the repository

git clone https://github.com/Anand1310/summer-code-jam-2021.git
cd summer-code-jam-2021

2. Install required dependencies

Windows

pip install -r dev-requirements.txt

Linux

apt-get install openal-soft
pip3 install -r dev-requirements.txt

3. Run the game

Windows

python main.py

Linux

python3 main.py

Note:
The player should visit the tutorial for a hands-on understanding of the game.

Screenshots

Future Improvements

• Reveal the map with animation at the start of the level.
• Allow player to move during echo.
• Fix bug: Hitting leaderboard in the main menu exits game. (This can be fixed with this change, we shall update the repo once the code jam finishes.)
• Fix bug: Game background music does not start on tutorial. (This can also be fixed by this commit.)
• Add Main menu option in pause menu. (This will do it)

About Us

• Anand
• Pritam Dey
• Himi
• Olivia
• StoneSteel
• Jason Ho