:ledger: Index

• About
• Features
• Usage
  • Installation
  • Commands
• File Structure
• Community
  • Contribution
  • Branches
• Guideline
• Resources
• Gallery
• Credit/Acknowledgment
• License
• Hall Of Fame

:beginner: About

Connect Four is a two-player connection game in which the players first choose a color and then take turns dropping one colored disc from the top into a seven-column, six-row vertically suspended grid. The pieces fall straight down, occupying the lowest available space within the column. The objective of the game is to be the first to form a horizontal, vertical, or diagonal line of four of one's own discs.

:page_facing_up: Features

• 2 player interactive game
• Supports undo operation
• Supports interactive game sounds
• Ability to play with computer AI (in development phase)
• Multiplayer on local network using sockets (in development phase)
• Ability to customize game theme (in development phase)
• Cross platform Linux, Windows, Mac (in development phase)

:zap: Usage

To use this project.

:electric_plug: Installation

• Install dependencies & export environment variables.

$ sudo -H pip3 install -r requirements.txt

:package: Commands

• Start project using

  $ python3 game.py

:file_folder: File Structure

• Add a file structure here with the basic details about files, below is current file structure.

.
├── assets.py
├── CODE_OF_CONDUCT.md
├── config.py
├── _config.yml
├── connect_game.py
├── events.py
├── game_board.py
├── game_data.py
├── game.py
├── game_renderer.py
├── images
│   ├── blackball91px.png
│   ├── game.svg
│   ├── logo
│   │   ├── c4.gif
│   │   ├── connect4.gif
│   │   └── connect4.png
│   ├── redball90px.png
│   ├── screenshots
│   │   ├── 1.png
│   │   └── 2.gif
│   └── yellowball90px.png
├── LICENSE
├── README.md
├── requirements.txt
├── restart.sh
└── sounds
    ├── disc_drop_1.wav
    ├── disc_drop_2.wav
    └── event.ogg

4 directories, 26 files

• Dependency Graph

:exclamation: Guideline

• Code Style

black

In order to maintain the code style consistency across entire project I use a code formatter. I kindly suggest you to do the same whenever you push commits to this project.

The python code formatter I chose is called Black. It is a great tool and it can be installed quickly by running

sudo -H pip3 install black

or

python3.6 -m pip install black

It requires Python 3.6.0+ to run.

• Usage

black {source_file_or_directory}

For more details and available options, please check their psf/black.

isort

I also use isort, it is a Python utility / library to sort imports alphabetically, and automatically separated into sections. It provides a command line utility which can be installed using.

sudo -H pip3 install isort

• Usage

isort {source_file}.py

For more details and available options, please check their timothycrosley/isort.

• Close Issues

Close issues using keywords: how to ?

:cherry_blossom: Community

:fire: Contribution

Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project.

1. Report a bug
   If you think you have encountered a new issue, and I should know about it, feel free to report it here and I will take care of it.

2. Create a pull request
   It can't get better then this, your pull request will be appreciated by the community. You can get started by picking up any open issues from here and make a pull request.

   If you are new to open-source, make sure to check read more about it here and learn more about creating a pull request here.

   :cactus: Branches

• No other permanent branches should be created in the main repository, you can create feature branches but they should get merged with the master.

:page_facing_up: Resources

• PyGame Documentation : Pygame is a cross-platform set of Python modules designed for writing video games. It includes computer graphics and sound libraries designed to be used with the Python programming language.

:camera: Gallery

Start Game Window

Game Play

Game Play GIF

Restart or Quit as the Game ends.

:star2: Credit/Acknowledgment

:lock: License

:sparkles: Hall Of Fame