cli-inquirer-game
v1.0.1
Published
Welcome to the Text-Based Adventure Game npm package!
Downloads
2
Readme
Text-Based Adventure Game
Welcome to the Text-Based Adventure Game npm package!
This npm package provides a simple text-based adventure game implemented in TypeScript. Players can engage in dynamic encounters with enemies, make decisions through interactive gameplay, and manage their character's health throughout the game.
Installation
To install the package, simply run the following npm command:
npm install cli-inquirer-game
Usage
To use the game, import the package in your TypeScript code:
import inquirer from "inquirer";
import { startGame } from "text-based-adventure-game";
startGame(inquirer);
This will start the game and prompt the player to make choices using the provided inquirer
instance.
Contributing
Contributions are welcome! If you'd like to contribute to this project, please follow these steps:
- Fork the repository
- Create a new branch (
git checkout -b feature
) - Make your changes
- Commit your changes (
git commit -am 'Add feature'
) - Push to the branch (
git push origin feature
) - Create a new Pull Request