1.0.0 • Published 1 year ago

saifi-developer-adventure-game v1.0.0

Weekly downloads
-
License
ISC
Repository
-
Last release
1 year ago

Adventure Game

Welcome to the Adventure Game! This is a text-based adventure game developed in TypeScript and Node.js. In this game, you can choose to fight either Spiderman or an Alien, with interactive prompts and health mechanics.

Features

  • Interactive prompts for user input using inquirer
  • Colorful console messages using chalk
  • Health management system
  • Random actions for the opponent
  • Option to play again after the game ends

Getting Started

Prerequisites

  • Node.js (>= 14.x)
  • npm (>= 6.x)

Installation

  1. Clone the repository:
git clone https://github.com/Riaz-Hussain-Saifi/Adventure-Game.git
cd Adventure-Game
  1. Install dependencies:
npm install

Running the Game

To start the game, run the following command:

npm start

Usage

  1. When the game starts, you will be greeted with a welcome message.
  2. Enter your name when prompted.
  3. Choose whether to fight Spiderman or an Alien.
  4. During the fight, select your actions (Attack or Run) when prompted.
  5. The game will manage health points and determine the winner.
  6. After the game ends, you can choose to play again or exit.

Example

? Enter your name: John
John, Welcome to the game!

? Do you want to fight Spiderman or Alien? Spiderman

John vs Spiderman

? Please select your action! (Use arrow keys)
> Attack
  Run

NPM Package

This game is also available as an NPM package. You can install it globally and run the game using the following commands:

npm install -g saifi-developer-adventure-game
saifi-developer-adventure-game

NPM Package Link

Contributing

Contributions are welcome! Please feel free to submit a Pull Request or open an Issue on GitHub.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Author

  • Riaz Hussain Saifi

Repository

GitHub Repository

### Explanation:
- **Title and Introduction**: Provides a brief description of the game.
- **Features**: Lists the main features of the game.
- **Getting Started**: Includes prerequisites, installation instructions, and how to run the game.
- **Usage**: Describes how to play the game, with an example.
- **NPM Package**: Instructions for installing and running the game using the [NPM Package](https://www.npmjs.com/package/saifi-developer-adventure-game).
- **Contributing**: Information on how to contribute to the project.
- **License**: Mentions the [LICENSE](LICENSE) for the project.
- **Author**: Provides the author's name [Riaz Hussain](https://github.com/Riaz-Hussain-Saifi).
- **Repository**: Provides a link to the [GitHub Repository](https://github.com/Riaz-Hussain-Saifi/Adventure-Game).
1.0.0

1 year ago