victorzw895/magic-maze

Digital Magic Maze

A digital version of a board game called Magic Maze

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

![Product Name Screen Shot][product-screenshot]

During covid I had decided to build one of my favorite cooperative board games that is a very simple but also very exciting game to play with up to 8 players.

Magic Maze Rules

• It is a cooperative game, so you win together or lose together.
• In order to win, you need to work together with the rest of the players to move the 4 different colored pawns around the board, to:
  1. Explore and expand the board by adding new tiles
  2. Find each pawn's corresponding weapon of their color. And collect all 4 at the same time.
  3. Escape through the corresponding exit of their color.
• The game makes it hard to achieve these goals, by:
  1. Being a silent game where no one is allowed to speak to communicate directions.
  2. Although there may be up to 8 players and only 4 pawns. Every players gets a specific direction in which they game move each pawn and/or abilities. Meaning if you want to move a pawn NORTH, but you dont have that direction assigned to you, you will have to rely on the player with the corresponding direction to make that move.
  3. There is a time limit!

(back to top)

Built With

• 
• [![Material UI][mui.com]][MUI-url]
• [![Firebase][firebase.google.com]][Firebase-url]

(back to top)

Getting Started

In order to run the project locally. Just clone run npm install and npm start

Prerequisites

• node v14
• Firebase project instance with the following /.env config

  // firebase config

  REACT_APP_FIREBASE_API_KEY={FIREBASE_API_KEY}
  REACT_APP_FIREBASE_PROJECT_ID={magic-maze-game}
  REACT_APP_FIREBASE_SENDER_ID={SENDER_ID}
  REACT_APP_FIREBASE_APP_ID=1:{APP_ID}

Installation

1. Clone the repo

   git clone https://github.com/victorzw895/magic-maze.git

2. Install NPM packages

   npm install

(back to top)

Roadmap

• Feature 1
• Feature 2
• Feature 3
  • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Project Link: https://github.com/victorzw895/magic-maze

(back to top)

Acknowledgments

Sand clock icons created by Icon mania - Flaticon

(back to top)