Skip to content

nicolafan/pyker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

57 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pyker

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

pyker1

Pyker is a Desktop Poker Texas Hold'Em game made with Python and Pygame! This is a hobby project still under development, and I intend to create more features to play this game.

Right now, the game has a very simple interface and it has a dummy AI which just makes choices for the bots at random. The idea is that in the future different ways to implement a Poker AI will be explored.

The implementation of the game rules should be finished, but it is not excluded (actually, it's probable) that some bugs are present! Poker presents a lot of edge cases that can be spotted only with accurate tests!

The code probably needs to be refactored and tested (especially the part concerning the interface).

You are free to fork this project to make something cool with it. Examples are:

  • Making your own interface.
  • Making it a multiplayer game.
  • Create your own AI.
  • And much more!

Feel free to open issues with the question tag if you have any doubts.

Thanks to Michael Myers for the beautiful 8-Bit poker deck, available on itch.io.

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

  • Python 3.10

Installation

Create a Python virtual environment and install the requirements using pip.

pip install -r requirements.txt

Usage

Global imports have been used in this project. To run it, execute:

python -m pyker.gui.interface

from the project root.

Roadmap

  • Add more unit tests
  • Refactor the game code
  • Refactor the interface code
  • Implement an AI

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Currently, I wish to work on the AI of the game, as an exercise, so I won't accept any PR regarding the AI (but things could change).

Interface improvements, tests, refactoring and documentation are welcome! If you wish open an issue and we could discuss about it. Maybe I will open new branches for the implementation of new features, but I also wait for your suggestions if you wish to help me with this project. Unfortunately, I cannot guarantee that in the future I will be very active, sicne this is just a little side project.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

You can run tests using pytest with the command:

python -m pytest

from the project root.

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Nicola Fanelli - [email protected]

Project Link: https://github.com/nicolafan/pyker

(back to top)