Metadata-Version: 2.1
Name: hanggman
Version: 1.0.0
Summary: A terminal based classical word guessing game.
Home-page: https://github.com/a-good-omen/hangman-remastered
Author: a-good-omen
Author-email: student.rohn@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# hangman-remastered

A terminal based version of the popular word guessing game Hangman. Remastered version of the previously published Hangman game. Includes added features, lore, animations and more.

> Efforts have been made to meticulously remove erros and bugs from the code. However, if you were to find any bugs or see parts of the code that could be improvised feel free to open a pull request or comment in discussions.

## Requirements

- [X] Python
#### Python Installation Guide  
___Step 1: Download Python___
Go [here](https://www.python.org/downloads/) to download the latest version of Python. Choose your operating system and click on "Download".  
> Python is usually pre-installed on Linux systems. If not, you can install it using package manager.

___Step 2: Install Python___
- Windows: Run the installed `.exe` file.
- MacOS: Open the `.pkg` file you installed.
- Linux: Use the package manager.

During installation make sure to also install `pip` by checking
- [X] Add python to PATH

## How to Install

To install the game you can download the files from the github repository.

The __easiest__ way however, is to use `pip` .

- Open terminal and run `pip install hanggman`.
- Once installed you can run the game by simply typing `hangman` or `python -m hangman`.

## ++ Features

- Better animations and gameplay.
<p align=center>
  <img alt='intro' src="https://github.com/user-attachments/assets/385c7838-d88e-4255-957d-bf4504a72b3c">
</p>

- Players can now save their progress allowing them to continue where they left off.
<p align=center>
  <img alt='account' src="https://github.com/user-attachments/assets/6fc9e6a2-b5ae-4ba6-86b7-f7c52a417bfc">
</p>

- Added game modes, local leaderboard and cleaner UI.
<p align=center>
  <img alt='menu' src="https://github.com/user-attachments/assets/7e9b97ca-f81b-4400-a06f-3d44671c8038">

- Added User Profile management.
<p align=center>
  <img alt='profile' src="https://github.com/user-attachments/assets/d01dad41-1a1d-42b4-9673-af496e9e89be">
</p>

**and there's more...**

> [!CAUTION]
> Give inputs only when prompted to ensure intended working.

> [!TIP]
> Read the game guide (help) while you can to understand how everything works.
