Giter Club home page Giter Club logo

ankit-matth / maze-escape Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 2.44 MB

I have created this game using p5.js library. To make it more interesting, I integrated sound effects using p5.sound.js (an addon provided by p5.js). Additionally, I also utilized development tools like ESLint, Prettier, and Husky to guarantee code quality and adherence to best practices.

Home Page: https://ankit-matth.github.io/maze-escape/

JavaScript 76.17% HTML 8.82% CSS 10.65% Shell 4.35%
css eslint html husky javascript p5js p5sound prettier

maze-escape's Introduction

Maze Escape - Navigate the rat to food!

I developed this game where the objective is to guide a rat through a challenging, randomly generated maze to reach its food. By utilizing the p5.js library, I optimized the rendering of graphics, enhancing overall interactivity. To elevate the user experience, I incorporated audio/sound effects using p5.sound.js, aiming for both visual appeal and engagement. In addition, I also utilized development tools such as ESLint (used for identifying and fixing coding mistakes, and for maintaining code quality), Prettier (used for clean and consistent code formatting), and Husky (used for automatically applying linting and formatting before each commit by utilizing pre-commit hook and lint-staged) to ensure code quality and adherence to best practices. This project showcases my proficiency in javascript, p5.js, Object-Oriented Programming (OOPs), and familiarity with various development tools for robust web project development.

Quick Demo

mazeEscapeScreenRecording.mp4

Technologies Used

  1. HTML, CSS, JavaScript
  2. p5.js and p5.sound.js
  3. Dev Tools: ESLint, Prettier, Husky

I employed various built-in functions such as setup(), draw(), keyPressed(), loadSound(), play(), stop(), etc. provided by p5.js and p5.sound.js to develop this game and integrate audio into it. In the game, players have the task of guiding a rat to its food source using arrow keys or on-screen buttons. The game offers three difficulty levels - "Easy," "Medium," and "Hard" - giving players the choice of their preferred challenge level. To enhance the gaming experience, two buttons, "Hint" (providing guidance on the path from the rat to the food) and "Solve" (automatically guiding the rat through the maze to reach the food), introduce interactive elements and strategic options for players to explore and enjoy.

Getting Started

Note: Make sure Node.js(npm) is installed before proceeding.

Follow the steps below to install and run the project on your local machine.

1. Clone this repository:

git clone https://github.com/Ankit-Matth/maze-escape

2. Go to the project directory:

cd maze-escape

3. Install dependencies:

npm install

4. Start development server:

npm start

5. Visit http://127.0.0.1:3000/ to see the magic.

Additionally

For formatting (Prettier):

npm run format

For linting (ESLint):

npm run lint

maze-escape's People

Contributors

ankit-matth avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.