8000 Version 2 ReadMe · rsnazario/capstone-js-phaser-rpg@d8491f1 · GitHub
[go: up one dir, main page]
Skip to content

Commit d8491f1

Browse files
rsnazariorsnazario
authored
Version 2 ReadMe
1 parent cdd484c commit d8491f1

File tree

1 file changed

+23
-9
lines changed

1 file changed

+23
-9
lines changed

‎README.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
# capstone-js-phaser-rpg
22
A RPG Turn Based Game Build Using the Phaser Framework
33

4+
## Content
5+
* [Live Demo](#online-version)
6+
* [Screenshots](#screenshots)
7+
* [Features](#features)
8+
* [Built With](#built-with)
9+
* [Getting Start](#getting-start)
10+
* [Tests](#testing)
11+
* [Overview](#game-overview)
12+
* [Contributing](#contributing)
13+
* [Acknowledgments](#acknowledgments)
14+
* [Authors](#authors)
15+
416
## Screenshots
517

618
![](docs/mainscreen.png)
@@ -12,15 +24,7 @@ A RPG Turn Based Game Build Using the Phaser Framework
1224
## Online Version
1325
[Live Demo ](https://agitated-rosalind-b151a5.netlify.app/)
1426

15-
## Content
1627

17-
* [Features](#features)
18-
* [Built With](#built-with)
19-
* [Getting Start](#getting-start)
20-
* [Overview](#overview)
21-
* [Contributing](#contributing)
22-
* [Acknowledgments](#acknowledgments)
23-
* [Authors](#authors)
2428

2529
## Features
2630

@@ -67,7 +71,17 @@ npm install
6771
````
6872
Now, you can just open your *Visual Studio Code* and click on `Go Live` if you have the `Live Server` extension installed properly. If it requires to select a folder to set as origin, make sure you choose `Dist` folder.
6973

70-
### Overview
74+
## Testing
75+
76+
After doing the `npm install`, all the the webpack depencies will be installed and with it will come the Jest Library.<br>
77+
The test for this project is only applicable to functions that are not related to Phaser Framework, which leaves us with the task of testing the API connection only.<br>
78+
Running the tests requires a simple use of the npm script, which triggers the Jest tool:
79+
```js
80+
npm test
81+
```
82+
83+
84+
### Game Overview
7185
The goal of the game is to kill as much dragons as possible while playing this Turn Based Role Playing Game. It starts with two heroes against 4 types of dragons.<br>
7286
The heroes are the Warrior (HP: 130 ATK: 12) and the Mage(HP: 80 ATK: 22). The dragons follows the same 'rule': the more the hp status, the less the damage inflicted.<br>
7387
Once you encounter the enemies, the two enemy dragons will be randomly generated. Each Dragon defeated counts as +10 on your score!<br>

0 commit comments

Comments
 (0)
0