readme.txt

# No Hero (COMP4451 Spring 2020-2021)

No Hero is a 2D dungeon RPG, built with [Phaser 3](https://phaser.io/) in JavaScript.  
This game is being deployed at <https://kit-p.github.io/COMP4451-NoHero/index.html>. Check it out!

## Author

Group 22  
PANG, Kit (20606678) ([Kit-p](https://github.com/Kit-p)) <kpangaa@connect.ust.hk>

## Guide

### Play on browser (Recommended)

Visit <https://kit-p.github.io/COMP4451-NoHero/index.html> to play this game!  
If the game does not load properly, make sure you have turned off any form of ad-blocking or tracker-blocking.

### How to run the game locally

1. Make sure you have NodeJS and NPM installed
2. Clone this repository
3. Open a terminal inside the local repository root
4. Run `npm install`
5. Run `npm start` and wait for the terminal output a compile successful message
6. Open a browser and go to `http://localhost:8080`
7. The game should be up and running. Have fun!

### How to play the game (Controls)

> `WASD`: movement keys
>
> `Space Bar`: dashing / sprinting
>
> `Q`: switch character if there are more than one available
>
> `R`: restart the current level
>
> `Mouse Primary Button`: fire projectile

## Credit

### tilesets and sprites

-   source: <https://0x72.itch.io/dungeontileset-ii>  
    author: [0x72](https://0x72.itch.io/)

-   source: <https://kvsr.itch.io/fx084>  
    author: [NYKNCK](https://kvsr.itch.io/)

-   source: <https://rustybulletgames.itch.io/colored-explosions-asset-pack>  
    author: [RustyBulletGames](https://rustybulletgames.itch.io/)

-   source: <https://wenrexa.itch.io/laser2020>  
    author: [Wenrexa](https://wenrexa.itch.io/)

### audio and sound effects

-   source: <https://soundsbydane.itch.io/8-bit-sound-pack>  
    author: [SoundsByDane](https://soundsbydane.itch.io/)

-   source: <https://edwardcufaude.itch.io/soundfxpack1>  
    author: [edwardcufaude](https://edwardcufaude.itch.io/)

-   source: <https://timbeek.itch.io/free-retro-boss-music>  
    author: [Tim Beek](https://timbeek.itch.io/)

-   source: <https://obsydianx.itch.io/interface-sfx-pack-1>  
    author: [ObsydianX](https://obsydianx.itch.io/)