Skip to content

richardalbee/5_card_draw

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

VideoPoker-5CardRedraw

A pythonic creation of a 5 card redraw video poker.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contact
  5. Acknowledgments

About The Project

Five-card Draw is a playable Python poker application. This project served as a hands-on Python learning experience in 2021. On my journey, I learned about creating graphical user interfaces in Python, pythonic best practices, CI/CD workflows, PyPi deployments, and much more. The beautiful learning opportunity this project provided was balancing desired learning opportunities and refining 5 Card Draw into a polished application. This project archived with the last remaining features involved in further polishing the UI/UX experience, adding sound, and cashing out player credits. If I were to start over, I'd rank poker hands with a semantic system over an integer score.

(back to top)

Features

  • 5 Card Redraw
    • Modular Hand Ranking and Scoring
    • Player Hand and Deck creation
    • Playable GUI interface
    • Bank text file
  • PyPi Installs
  • Pep 8 Standards
  • GitHub CI/CD Pipelines

(back to top)

Getting Started

The following is an guide for running 5 card redraw poker locally.

Prerequisites

  1. Python 3.10.8 or Newer

Installation

Local Repo Install:
Summary: The developer install is for those who want to contribute to or clone VideoPoker-5CardRedraw.

  1. Clone the repo (or use Github Desktop)
    git clone https://github.com/ralbee1/5_card_draw.git
  2. Open the CLI and navigate the current working directory to where you cloned VideoPoker-5CardDraw
  3. Install the Pip Package from the CLI, copy and run this command:
    py -m pip install -e .


User Install
1. Automatic User Install from the Command line via PyPi. ```sh pip install five-card-draw ```

(back to top)

Usage / How to Play

If your python files open with Python by default then from the commmand line run:

poker_start.py;

Troubleshooting:

  • "'poker_start.py' is not recognized as an internal or external command, operable program or batch file."
    • Your terminal needs to be able to find the file. For windows, you need to ensure your python "script" folder is in your path variable For example: C:\Users{username}\AppData\Roaming\Python{pythonversion}\Scripts You may also navigate to where the pip was installed and run poker_start.py with python manually.

How to Play:

  • The game is played by aiming to make the best poker hand possible. The top of the interface shows the hand ranking and the payouts sorted by how many credits you bet per round, 1 thru 5. To begin, click DEAL. You hold cards with the intent of keeping them and drawing new cards to try to improve your hand ranking. After drawing new cards, your hand is automatically scored and profits paid out. You may then click "DEAL" and start over.

(back to top)

Contact

Acknowledgments

  • This variant of poker was inspired by Super Double Double as found in Las Vegas Casinos.

(back to top)