Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This is a simple basketball playbook made by pygame.

Functions of the playbook:

• Drawing lines with RGB colors
• Create multiple stages of a play
• Save as a JSON for the reason of convenience 😄
• Replay mode to review the plays 😛

(back to top)

Built With

• 
• 

(back to top)

Getting Started

Prerequisites

Just python and pygame !!

• Version

  Python >= 3.7
  Pygame >= 2.1
  

Installation

Git clone the project or download the whole ZIP file.

1. Git

   git clone https://github.com/GMfatcat/BA_playbook.git

2. Download the zip file with the bellow instruction

   1. Click <Code> (green button)
   2. Download ZIP
   

3. Run the project in the folder

   python main.py

(back to top)

Usage

Edit your play on the court

Functions of the playbook:

• Drawing lines with RGB colors
• Create multiple stages of a play
• Canvas Edit
• Replay mode to review the plays

Saving directory

game/save/YOUR_PLAY_NAME_CURRENT_TIME.json

(back to top)

Roadmap

• Replay Mode
• Portable saving (JSON)
• More scalable screen size
• Multi-language Support
  • English
  • Traditional Chinese

(back to top)

Contributing

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
3. Commit your Changes
4. Push to the Branch
5. Open a Pull Request

(back to top)

License

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

(back to top)

Contact

GMfatcat : github

(back to top)

Acknowledgments

I've included all of free image resources to kick things off!

• Court
• Player Icon
• Ball

(back to top)