Silent-Watcher / cli-word-guessing-game

a simple word guessing game 🕹. Leave a star before you leave ⭐

CLI Word Guessing Game

CLI Word Guessing Game is a command-line interface (CLI) application written in Node.js. It is a simple word guessing game where players have to guess a random word letter by letter within a certain number of attempts. The game provides an enjoyable and interactive way to improve vocabulary and word recognition skills.

Table of Contents

• Features
• preview
• Prerequisites
• Installation
• usage
• Configuration
• Acknowledgements
• Contributing
• Contact
• License
• Conclusion

Features

• Randomly selects a word from a pre-defined list
• Allows players to guess letters of the word
• Tracks the number of attempts and displays the remaining attempts
• Provides feedback on correct and incorrect guesses
• Ends the game when the word is guessed correctly or when the number of attempts is exhausted
• Supports a variety of customization options, such as changing the word list or the number of attempts

Preview

Prerequisites

In order to run this project, you will need to have the following installed on your computer:

• nodejs
• yarn | npm

Installation

To install the application, follow these steps:

1. Clone the repository to your local machine:

git clone https://github.com/Silent-Watcher/cli-word-guessing-game

2. Navigate to the project directory in your terminal.

  cd cli_word_guessing_game

3. Run yarn to install the necessary packages.

  yarn

usage

To start the game, run the following command:

 node .

or you can run this project directly from npm :

  npx cli_word_guessing_game

Configuration

The game allows you to customize certain aspects by modifying the config.js file.

• WORD_LIST: The list of words from which a random word is selected. You can modify this list and add your own words.
• MAX_ATTEMPTS: The maximum number of attempts allowed to guess the word.

Acknowledgements

The CLI Word Guessing Game was inspired by classic word guessing games and developed by Silent-Watcher.

Contributing

Contributions to this project are welcome. If you encounter any issues or have suggestions for improvement, please open an issue on the GitHub repository.

Before contributing, please review the contribution guidelines.

Contact

For additional information or inquiries, you can reach out to the project maintainer:

• Name: Silent-Watcher
• Email: [e-mail]

Feel free to contact the maintainer for any questions or feedback regarding the project.

License

MIT

This project is licensed under the MIT License. You are free to modify, distribute, and use the code for personal and commercial purposes. See the LICENSE file for details.

Conclusion

The CLI Word Guessing Game is a fun and educational project that challenges players to guess a word letter by letter. It provides an interactive command-line interface and allows customization to enhance the gaming experience. With its simplicity and entertainment value, this game can be enjoyed by users of all ages.