Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wanyingng/blackjack
A command-line interface (CLI) implementation of the classic casino card game, Blackjack.
https://github.com/wanyingng/blackjack
ascii-art blackjack cli-app comparing-card-game console-application object-oriented-design object-oriented-programming pyfiglet pytest python3 random text-based-game uml-diagram
Last synced: 28 days ago
JSON representation
A command-line interface (CLI) implementation of the classic casino card game, Blackjack.
- Host: GitHub
- URL: https://github.com/wanyingng/blackjack
- Owner: wanyingng
- Created: 2024-02-04T03:48:15.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-04-08T14:00:23.000Z (9 months ago)
- Last Synced: 2024-10-17T22:39:51.136Z (2 months ago)
- Topics: ascii-art, blackjack, cli-app, comparing-card-game, console-application, object-oriented-design, object-oriented-programming, pyfiglet, pytest, python3, random, text-based-game, uml-diagram
- Language: Python
- Homepage:
- Size: 178 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
Blackjack Game ♠
A command-line interface (CLI) implementation of the classic casino card game, Blackjack.
Try your luck by fighting against a computer dealer 💻 today and strive to get a hand closest to 21 without busting!
Explore the docs »
Table of Contents
## About The Project
### Project Structure
### `main.py`
This file contains the main entry point of the game. It initializes the game components, such as the player, dealer, and game engine, and starts the game loop.
### `blackjack/`
This directory contains the Python package for the Blackjack game.
#### `baseplayer.py`
Defines the `BasePlayer` abstract class, which serves as the base class for both the player and dealer classes. It contains common functionalities and attributes shared between players and the dealer.
#### `player.py`
Contains the `Player` class, which represents the human player in the game. It handles player actions such as placing bets, hitting, standing, and managing the player's balance.
#### `dealer.py`
Defines the `Dealer` class, representing the game's computer dealer. It manages the dealer's actions during the game, such as hitting until reaching a certain threshold (the dealer's hand totals 17 or more) and revealing the face-down card.
#### `card.py`
Contains the `Card` class, which represents a playing card in the game. It defines the properties of a card, such as its suit, rank, and value.
#### `deck.py`
Defines the `Deck` class, representing a deck of playing cards used in the game. It manages the creation, shuffling, and dealing of cards.
#### `hand.py`
Contains the `Hand` class, which represents a player's/dealer's hand of cards. It manages the cards in the hand, computes the hand's total value, and handles adding new cards to the hand.
#### `game.py`
Defines the `Game` class, which manages the core logic of the Blackjack game. It orchestrates the interactions between the player, dealer, and deck, and determines the outcome of each round.
#### `banner.py`
Contains the `display_banner` function, which displays the ASCII art welcome message and game rules at the start of the game.
### `tests/`
This directory contains the essential test cases for the Blackjack game to execute correctly.
Running test cases using pytest
### Technical Design
Use Case Diagram
Class Diagram
Activity Diagram
## Design Choices
- **Modular Structure**: The project is structured as a Python package (`blackjack/`) with each component (player, dealer, game logic, etc) in separate modules. This promotes code organization and reusability. Programming is much easier as the data and the code that manipulates that data are located in the same place, reducing complexity for users of that module. Based on the Single Responsibility Principle, a separate module `banner` was created to handle printing the welcome message and game rules.
- **Object-Oriented Design**: Object-oriented programming (OOP) is a style of programming that focuses on using objects to design and build applications. In this project, the game components (player, dealer, cards, etc) are implemented as classes with well-defined attributes and responsibilities. This allows for easy extensibility and maintenance. The code is focused, succinct, and understandable to humans. Following closely with the D.R.Y. or "Don't Repeat Yourself" principle, repeated, common, or shared characteristics between two or more classes (Player and Dealer) are factored out into another class (BasePlayer). Modifications to the software are thereby easier to apply and maintain, as any changes to the code common to both subclasses need only be made once in the superclass, resulting in less code and repetition overall.
- **CLI Interface**: The game is implemented as a command-line interface, making it portable (run effectively in different computing environments with minimal changes) and easy to play without the need for graphical user interfaces. ASCII art is used to create a simple graphic of the playing cards on the CLI.
- **Future Considerations**: Further improvements in code quality will focus on the design principle of Encapsulation, where critical data and functions of the object are restricted to only within the object. This creates protection from unexpected direct changes to that data. Thus, preserving data integrity through the use of specific methods to access those attributes.
A snapshot of the interface, showing the ASCII art representation of the playing cards
## Getting Started
To get a local copy up and running, follow these simple example steps.
### Installation
1. Clone the repo
```sh
git clone https://github.com/xlepotato/Blackjack.git
```
2. Install all the required dependencies
```sh
pip install -r requirements.txt
```
3. Run the application by executing the following command in the directory where main.py resides in
```sh
python main.py
```
## Usage
The video below is a walkthrough of the Blackjack CLI Game.
https://github.com/xlepotato/Blackjack/assets/22700895/0c8c3f3f-1ced-4f05-a980-2c6e22c07a40
## Acknowledgments
* [Harvard University, CS50P 2024](https://cs50.harvard.edu/python/2022/)
[contributors-shield]: https://img.shields.io/github/contributors/xlepotato/Blackjack.svg?style=for-the-badge
[contributors-url]: https://github.com/xlepotato/Blackjack/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/xlepotato/Blackjack.svg?style=for-the-badge
[forks-url]: https://github.com/xlepotato/Blackjack/network/members
[stars-shield]: https://img.shields.io/github/stars/xlepotato/Blackjack.svg?style=for-the-badge
[stars-url]: https://github.com/xlepotato/Blackjack/stargazers
[issues-shield]: https://img.shields.io/github/issues/xlepotato/Blackjack.svg?style=for-the-badge
[issues-url]: https://github.com/xlepotato/Blackjack/issues
[license-shield]: https://img.shields.io/github/license/xlepotato/Blackjack.svg?style=for-the-badge
[license-url]: https://github.com/xlepotato/Blackjack/blob/main/LICENSE