polltery / node-cli-game-example Goto Github PK

add JSDoc based comments on methods in battle-engine.js.

When player moves to east and fights a monster, sometimes the previous tile where the player came from is not updated to "safe". This might need more testing to see what exactly is going wrong.

Write E2E tests for the CLI application.
Some reference: https://medium.com/@zorrodg/integration-tests-on-node-js-cli-part-2-testing-interaction-user-input-6f345d4b713a

Right now app.js is crowded with different functions, we need to move these functions into separate modules as stated below.

• map-engine.js: (fixed in e7fc2f6)
  • displayMap
  • createMapFromArray
  • getFullDirection
  • displayPosition
  • getMovementOptions
  • obtainMovementOptionInfo
  • displayMovementOptions
  • getObjectFromCurrentPosition
  • movePlayerTowards
  • updateNextAndPreviousMapTilesAfterPlayerMovement
  • updateNextAndPreviousMapTiles

• utils.js: (fixed in 86fecee)
  • create2dArray

• battle-engine.js:
  • encounter
  • postBossEncounter
  • updateTile
  • postBattleEncounter

Map does not reflect the correct position after player starts moving.

When the player fights a monster and losses, nothing really happens. They are simply stuck in the battle until they defeat the enemy. We need to add an enhancement so that when player losses a battle, they must also lose power equal to the monster power they fought, this will make the game a bit challenging and later on we can introduce items such as potions for the players to make use of.

For all the cards in the lib we don't have a type property. Instead we have a for-loop in the main file that automatically assigns the type. We need to move these loops into a separate function in utils.js.

The current code must be moved into a function.

// Add type because they are going to be merged in the map
for(var i = 0; i < monsters.length; i++){
    monsters[i].type = "monster";
}
for(var i = 0; i < bosses.length; i++){
    bosses[i].type = "boss";
}
for(var i = 0; i < specials.length; i++){
    specials[i].type = "special";
}
for(var i = 0; i < friends.length; i++){
    friends[i].type = "friend";
}

If the player encounters a friend tile, add them to the player party.

Right now when a player is at the edge of the map (e.g. position 0,0) they are not supposed to move out of the map. For example below, the player is not given the option to move north, however they can still decide to move north, and if they do.. the game crashes.

TURN : 1
MAP VIEW
 *  *  *  * 
 *  *  *  * 
 *  *  *  * 
 *  *  *  * 
you are at 0,0
Here are your movement options..
S(South) : unknown
E(East) : unknown
SE(South-East) : unknown

We can fix this either by placing a check after player input or by using RegExp objects for prompt pattern.

    prompt.get({
        description : 'Please enter a movement option',
        type : 'string',
        pattern : customRegex,
        message : 'Please choose an appropriate movement option',
        require : true,
        before : val => val.toUpperCase()

Currently if we increase the map size in config.js then the monsters/bosses/friends are not distributed across the map correctly, check mapEngine.createMapFromArray function as it only takes the size of the combination of monster/bosses/friends and not the map size. There is also another problem where the map size is smaller than the combination of monster/bosses/friends, this issue will cause few key tiles to be left out. We need to come up with a new way to lay the map tiles.

After the players select the number of players, allow them to choose a map size by manually inputting mapHeight and mapWidth, default will be under config.js.

Game crashes when heading south after fighting Imlerith, this usually happens when the freePass reward is over i.e. after the player moves 3 tiles.

• undefined output as you can see in the attached image
• I tried S, E, SE, and after any of them, I see a message like You choose SE (South-East) and will exit the process immidetly.

Currently the project uses prompt for text inputs which is not very reliable at the moment. We should look into to replacing all input methods to use Inquire.

Currently all the methods under map-engine.js look quite complicated without the documentation. It would be nice to have some JSDoc documentation to get a good idea of what each function does.

After the player finishes the game by finding Ciri, show score (i.e. no. of turns) and stats (if any) to the player.

Right now the game expects everything in capital letters when choosing direction. for example, to move north the player must input N. We can update this so that the players have an option to enter either n or N.

Game crashes when no movement input is given by the player.

prompt: Please enter a movement option:  
readline.js:1084
            throw err;
            ^

RangeError: Maximum call stack size exceeded
    at String.substring (<anonymous>)
...

We need to add a prompt before the game starts that will allow the players to choose the difficulty. The following difficulties will be allowed..

1. (E) EASY : Player gets 25 POWER at the start
2. (M) MEDIUM : Player gets 15 POWER at the start
3. (H) HARD : Player gets 10 POWER at the start