HP Dementors Scape is a shooter game inspired by the Harry Potter saga by J.K. Rowling. The game is browser-based, designed on Phaser 3, and it uses a collection of amazing art by various designers (Please refer to the Acknowledgment section for more information). The objective of the game is to score the highest possible score while defeating the evil Death Eaters and Dementors on your way. The main character can cast two different spells; Expecto Patronum and Confundus.
For developing the game, I used JavaScript and Phaser 3 along with Express to host it on Heroku. I implemented an API provided by Microverse to host the scoring database so that the highest scores will always be available for new users to try to beat! The API implementation required the use of promises and Async functions. I also used Classes and Modules to integrate everything in an industry-standard code style while implementing JavaScript, HTML, and CSS best practices.
- A key => Move left.
- W key => Move up.
- D key => Move right.
- S key => Move down.
- J key => Confundus Charm.
- I key => Patronus Charm.
| DAYS | OBJECTIVE | DESCRIPTION | OUTCOME | STATUS |
|---|---|---|---|---|
| Day 1 | Learn Phaser 3 module | I coded along with three different tutorials, three different games to deeply understand the syntax and functionality of the Phaser 3 module. | I understood and learned the basics of the phaser library so that I could code my first game. | ☑ |
| Day 2 | Game Design | I designed the workflow for the next few days to be able to achieve all the requirements on time. I designed the basic structure and flow of the game. I gathered all the Sprites, the music theme, and images that I needed for the development of the project. I decided which scenes I would implement and created the template for the project. | By the end of the day, I had a functional template that used Webpack to start implementing the scenes for my game. I had the workflow for the next few days and the game concept. | ☑ |
| Day 3 | Game Development | I created the game itself using all the phaser tools and knowledge acquired during the last couple of days. I decided to let out some of the original ideas for the project since the creation of it was not trivial, and it required a lot of resourcefulness to be able to overcome all the blockers along the way. I implemented the scoring system using the provided API. | By the end of the day, I had a fully working game that ran on my local environment. I still had some styling to do, but in general, I had a working project. | ☑ |
| Day 4 | Testing, Styling, and Deployment | I added the final design details to the game, like background images and personalized logo. I refactored my code to be able to test it using Jest. I made the tests for the modules I created to add functionality to the Phaser module. Finally, I deployed the app to Heroku. | By the end of the day, I had a complete project that was accessible everywhere through Heroku hosting. The code was following industry standards for styling and modularity. I created tests for the methods I coded and implemented, and everything was up and running. | ☑ |
| Day 5 | Documentation and request for review | I added the README.md file, and made a final round of testing. I tested the code functionality to make sure it is working on Heroku as well as on the local environment. I used Jest for testing my code again, and request the review. | By the end of the day, I had completed the project with the requirements, and submitted a request for review.. | 🖋 |
- JavaScript
- Phaser 3
- HTML5
- CSS
- Webpack
- Github
- Jest
- Babel
- Eslint
- Stylelint
- Express
- Heroku
To get started with the app, please follow these steps:
-
Navigate to the folder where you would like to save the game.
-
Open your terminal by right-clicking, and opening the command line of your choice.
-
Clone the repo by typing:
$ git clone [email protected]:lmaldonadoch/shooter-game.git
- Access the newly created folder by typing:
$ cd shooter-game
- Install the necessary dependencies:
npm install
- Bundle the resources and run the code locally:
$ npm run dev
- Open http://localhost:5000/ on your browser.
Now you are all set to start fighting gainst the dark wizard's forces. Will yo be able to get at the top of the leaderboarrd? Enjoy!
Tests were made to test the two modules added to make the Phaser library communicate to the API through the file api.js located in the path ./src/objects/, and to provide it with the ability to create a Local Storage for the scoring system through the file localStorage.js in the same directory.
If you would like to run the tests yourself, please on the root directory run:
$ npm run test
- Node. If you do not have Node installed in your local machine, please refer to the Official Documentation
- Basic command line knowledge.
👤 Luis Angel Maldonado
- Github: @lmaldonadoch
- Twitter: @LuisAngelMCh
- LinkedIn: lmaldonadoch
- Make the Death Eaters shooting smarter instead of high speed.
- Make the Death Eaters killable only after disarming them with a different spell.
- Limit the speed at which the main character can cast spells to increase difficulty.
- Create more scenes and a final boss on each scene.
Feel free to check the issues page.
Give a ⭐️ if you like this project!
- Project requested by Microverse Program.
- Game based on the very successful Harry Potter franchise. All rights reserved to J.K. Rowling and Co. The use of her property is solely for educational purposes.
- The main characters Sprites and Death Eaters Sprites were made by the very talented artist AetherWings. Please go ahead and take a look at his work!
- The music theme is "A misty Winter Morning" composed, performed, mixed and mastered by Viktor Kraus. Please visit his channel and support if possible!
- The battling/menu background and Dementor characterization were uploaded anonymously, but big thank you to the amazing artists who made this possible.