Project/Game created by Steven Jack Chung
Project created using Leaderboard API and Phaser 3
- 🌳 About Endless Forest
- 📐 About The Project
- 📝 Game Instructions
- ⚒️ Built With Phaser 3
- 🖥️ Setup
- ✍️ Make Your Own Changes
- 📜 Acknowledgements and Credits
- 👤 Author
- 🤝 Contributing
- ⭐ Show your support
Endless Forest is a platform game based on an endless runner genre. You may have heard about Temple Run, Subway Surfer, and other similar games. Although Endless Forest is a 2D game, it falls in a similar genre with those games.
The story behind Endless Forest is about a Knight walking peacefully, but little did he know, he entered the Endless Forest. Filled with obstacles and monsters, the knight tries to survive by dodging the obstacles and killing the monsters.
The more time survived the highest score.
I implemented a leaderboard showing the Top 5 Ranking High Scores and the rank and score of the current player.
Endless Forest is a Phaser 3 project with ES6 support via Babel 7 and Webpack 4 that includes hot-reloading for development and production-ready builds.
This has been updated for Phaser 3.50.0 version and above.
For the Knight to be able to survive you need to dodge obstacles and kills monsters.
To Jump over obstacles you can use these following keys
⌨️ 'W' or 'SPACEBAR'
To Attack monsters you can use these following keys
⌨️ 'A' or 🖱️ 'LEFT MOUSE BUTTON'
To Drop faster (like Subway Surfer) you can use these following keys
⌨️ 'S' or 🖱️ 'RIGHT MOUSE BUTTON'
Other
The ENTER key is used for basic interaction within the game. These basic interaction includes skip boot scene, start game, submit leaderboard nickname, skip credits scene, etc.
🕹️ Phaser 3
Internet Browser (Chrome, Firefox, Opera, etc)
Git for version control.
Node.js is required to install dependencies and run scripts via npm.
After installing the tools required, go ahead and clone this repository by using Git commands.
git clone https://github.com/jcy2704/endless-forest.git
Or you can also download this repository and access it with navigation commands.
cd /path/to/repository/endless-forrest
To be able to run the game smoothly you need to install Node dependencies by typing the following command on your terminal
npm install
Now you are good to go!
Now that you've installed the repository correctly. Go ahead and test it out by running the following command on the terminal
npm start
This command will open a localhost:8080 server where it will be running the game until you close the server by using the key combo CTRL + C on the terminal.
And there you are running the game.
Enjoy!
| Command | Description |
|---|---|
npm install |
Install project dependencies |
npm start |
Build project and open web server running project |
npm run build |
Builds code bundle with production settings (minification, uglification, etc..) |
After cloning the repo, run npm install from your project directory. Then, you can start the local development server by running npm start.
After starting the development server with npm start, you can edit any files in the src folder and webpack will automatically recompile and reload your server (available at http://localhost:8080 by default).
After you run the npm run build command, your code will be built into a single bundle located at dist/bundle.min.js along with any other assets you project depended.
Pixel Art Forest Background by Edermunizz
Rogue Knight by Kronovi-
Super Dialogue Audio Pack (death) by Dillon Becker. This work is licensed under CC BY 4.0
Game Over SFX obtained from Zapsplat
Intro: VGMA Challenge (July 12th Challenge) by Abstraction
Game: A Mystical Journey by FATAL EXIT. Licensed under CC BY 4.0.
Ending: III. Finale: Slowly by Dee Yan-Key. This work is licensed under CC BY-NC-SA 4.0
Arcadia by Alex Wan. This work is licensed under CC BY 4.0
👤 Steven Jack Chung
- GitHub: @jcy2704
- Twitter: @yiak_
- LinkedIn: Steven Jack Chung
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
Give a ⭐️ if you like this project!