anantdark / hangman Goto Github PK

View Code? Open in Web Editor NEW

3.0 1.0 7.0 286 KB

A simple terminal based hangman game written in python.

License: MIT License

Python 100.00%

hacktoberfest hangman hangman-game hangman-in-python python python3 hacktoberfest2022

hangman's Introduction

hangman

A simple game with easy rules, written purely in python.

GUI and CLI versions available.

About the Game

HangMan is an interactive real world game. The game chooses an entirely random word,and the user tries to guess it by suggesting letters untill the hangman figure is completed.

GUI	CLI

RULES

Number of Dashes represent the length of the word.
At each correct guess the letter is placed at its original position in the word.
User loses if the HangMan is completed.

Modules used-

pygame
rich
nltk

Use pip install -r requirements.txt to install the modules automatically.

Running the game

~~Currently the program is not packaged into exe or any other format, so you have to run the python file directly.~~
~~New contributers can implement packaging the game into an executable.~~

Recent Releases contain executable file for Linux.

For Linux

Run the executable.
- You can download the latest executable file from releases
- Make the file executable
```
sudo chmod +x filename
```
- Run the file ./filename
Run with python interpreter.
- Install requisite modules(see modules section).
- Navigate to either GUI/CLI folder and run python3 hangman.py

For Window

Dude use Linux 😉

There is no exe file for windows users. 🤐: (PRs Welcome)
Just replace python3 with python in the above steps.

Hacktoberfest2022

It is back again the time of the year to celebrate Hacktoberfest. This repository contains coding exercises that you can easily solve with basic knowledge in programming.

What is Hacktoberfest?

Every year in October, an open source event called Hacktoberfest inspires individuals all over the world to actively engage in and contribute to open source projects that are hosted on GitHub and GitLab. By taking part in this event, you may receive a free GitHub swag pack. You must submit 4 pull requests in order to receive that awesome swag pack.

Follow these step -:

Complete the registartion over https://hacktoberfest.com/
Rule are - https://hacktoberfest.com/participation/
Fork this repository.
The copy of main repository is on your PC/Desktop .

You can send your pull request to this repository.

Enjoy Hacking. All the best.

Want to contribute?

We welcome any contribution big/small, but do note that we are against plagiarism and low code quality.

For instance, avoid submitting a PR fixing a issue with spacing or a minor change, this hampers the spirit of hacktoberfest.

Take a look through some of our issues you can resolve, or create your own issue https://github.com/anantdark/hangman/issues

Our Top Contributors

hangman's People

Contributors

Stargazers

Watchers

Forkers

droid31 haidao0923 ambushneupane leinadsened kirkland-signature jsvigneshkanna enderboy2

hangman's Issues

Create requirements.txt

Generate a requirements.txt enumerating all the used modules

Ask to play multiple times and keep score for the time.

Both GUI and CLI implementations exit after running once, the games should give the option to continue and also maintain a scoreboard at the end.

CI pipeline failing

Need help with the failing github workflow.
https://github.com/anantdark/hangman/actions/runs/3217182733

The test cases aren't written so writing them would be the first step.
This is my first time with Github Actions, so help is appreciated.

Merge gui and cli

Currently if the user has to run the game in GUI/CLI mode, he has to run the respective python file in the folder.
Create a "master" python program which after running gives the option to select from GUI/CLI Interface.
The respective python code(GUI/CLI) shall be executed as per the selected option.

Try not to shift the existing file structure.
Try not to rename the existing files.

Hangman android app

We have hangman GUI and CLI for Windows and Linux.
We can also have an android app hangman-app.
Any more platforms left. 😜

Should have player accounts

Discussed in #19

^{Originally posted by anantdark October 11, 2022}
We can implement various player accounts
The player accounts will be logging in with their password.
Accounts will have saved history of scores.

GUI VERSION

Gui Version of hangman game

Package the game

Create an executable (exe, deb, appimage, whl) file to play the game.

Unify wordlist

Currently hangman-cli and hangman-gui handle their wordlist separately with different word lists and word generator modules.
We can unify that into a single module using a single wordlist.

Show the word's meaning

After the game has ended, either in lose or win. The user should get the meaning of the word alongside the word.
We can implement it in two ways.

Change the wordlist to store words and their meanings and show them accordingly.
Change the code and let the user add the meaning of the word after the game, eventually the wordlist will be full with word meanings.

Hangman-GUI needs a logo

The GUI application shows the default logo of pygame on the taskbar, need to replace that with a custom logo, also need the logo on the application window.

Refactor Readme.md

Rewrite readme.md as a stylised welcome page.
Can take notes from any of the top forked/starred repos.

Improve CLI

The CLI needs to be improved.
Some suggestions include

welcome page
clear screen after every guess
many more...