README.md

⏳ Tim-E-Scape ⌛

Our game for gamedev.js jam 2023
(Theme : TIME)

Table of Contents

• Getting Started
• Running the Game
• Built With
• Authors
• License

Getting Started

These instructions will help you get a copy of the project up and running on your local machine for development and testing purposes. If you do not want to build from source you can skip to Running the Game

Prerequisites

• Node.js (version 19.8.1 or higher)
• npm (version 8.19.2 or higher)

Installing (Build from source)

1. Clone the repository to your local machine:

git clone https://github.com/BitBrigade/gamedevjs-2023

2. Install the required dependencies:

npm install && npm i -g http-server

Running the Game (Play wihtout Build)

• Without Building:

  You can play the game online by visiting the following link:

https://bitbrigade.github.io/Tim-E-Scape/

• Building from source:

  • Start the local development server:

  # inside the cloned repository (Tim-E-Scape)
  http-server ./

  • Open your web browser and navigate to http://localhost:8081 (replace 8081 with whatever port number you get)

  • You should now see the game's index.html page displayed in your browser.

Built With

• Phaser - Game development framework for HTML5 games
• Node.js - JavaScript runtime environment for server-side development
• Express - Web application framework for Node.js

Authors

• Amit - github.com/amitsuthar69
• Harshil - github.com/Harshil-08
• Rishabh - github.com/Rishabh672003
• Sumit - github.com/sumitst05

License

This project is licensed under the GNU General Public License - see the LICENSE file for details.