About • Prerequisites • Getting Started • Contributing • Authors • License
Survive the jungle is a 2D platformer game. The game comes with basic features like collectible items and lethal obstacles.
Click here to visit the live demo of the application.
Note: The application is hosted on the free tier of Heroku and therefore the images attached will not persist after the next dyno reset.
The Game Design Document is a highly descriptive design manual for a video game. It is used to efficiently design and develop a video game. The GDD of this game can be found in the following link. Game Design Documentation
Before running the application locally, the user will have to make sure of the following:
- Node JS Installed on your local machine. Please use this link.
- Installing NPM if not already installed.
You also need to make sure that yarn is up to date
- yarn install --check-files
https://github.com/smcommits/survive_the_jungle.git
git clone https://github.com/smcommits/moviecop
Alternatively, you can click this link to download the repo as a zip file.
Navigate to the game folder
cd survive_the_jungle
Install all the dependencies by running the following command. Dependencies are just normal files and programs that are necessary to run the game.
npm install
While you are in the root folder of the Game, which means that in the topmost folder of the game, run the following command to launch the game in your browser
npm run start
Alternatively, you can navigate to the dist folder and run index.html directly in your browser.
The Game rules are pretty simple.
- You will be spawned in a 2D platform game.
- You have to run and reach the end of the jungle.
- While running, you have to collect the fruits. Which will help you score points.
- You will also have to avoid the spikes. They will result in instant death
- Each fruit gives you 10 points.
- You can take small jumps and long jumps.
- Please note, although taking long jumps can help you it comes with its limitations. After a long jump, the player might fall with a lot of speed and can fail to grab support. Falling down or outside of the world. Which will result in death.
- After launching the game, you will be asked to enter your name.
- After you have entered the game, you will be spawned in a 2D world.
- To move your player, you can use arrow keys or w, a, s, d, to move forward, left, backward, and rightwards respectively.
- To take the long jumps, you will have to press Spacebar.
- Javascript
- Phaser Game Library
- Webpack for bundling code
- Babel for Transpiling code
- Jest for testing code
As mentioned above, the application uses jest as a primary test runner. To run tests on your local machine, please follow the instructions mentioned below.
- Navigate the project directory
- Run the following command
npm test
👤 Anas Siddiqui
- GitHub: @githubhandle
- LinkedIn: linkedIn
Contributions, issues, and feature requests are welcome!
Give a ⭐️ if you like this project!
Awesome Tileset Designed By (Sazdi Artis)[https://szadiart.itch.io/platformer-fantasy-set1?download]
The tutorial by Zeneva helped a ton.
This project is MIT licensed.