|
2 | 2 |
|
3 | 3 | ## Aim
|
4 | 4 |
|
5 |
| -The main aim of the project you want to achieve. |
| 5 | +The main aim of the project is to create a 'Connect Four' game using the python's PyGame library. |
6 | 6 |
|
7 | 7 | ## Purpose
|
8 | 8 |
|
9 |
| -What's the purpose of this project |
| 9 | +The purpose of this project is to give the user a gaming experience of playing the original Connect Four game. |
10 | 10 |
|
11 | 11 | ## Short description of package/script
|
12 | 12 |
|
13 |
| -- If package, list of functionalities/scripts it can perform |
14 |
| -- If standalone script, short description of script explaining what it achieves. |
15 |
| -- List out the libraries imported. |
| 13 | +This is a very basic version of the famous game 'Connect Four' which is a two player 2D game. To play this game we need two players, one players plays with the red dots and the other player plays with the yellow dots. Each player takes turn to drop the dots in the 6x7 grid. The one who connects the four colored dots in either horizontal, vertical or diagonal line together first wins the game. |
16 | 14 |
|
| 15 | +The project is developed using python3 and python's PyGame library. |
17 | 16 |
|
18 | 17 | ## Workflow of the Project
|
19 | 18 |
|
20 |
| -Add the workflow of the project point by point to get good understanding of the program |
| 19 | +- We have installed and used the 'numpy' module to develop the logic of the game. |
| 20 | +- We have installed and used the 'pygame' module to give graphics to our game. |
| 21 | +- Just run the script through the terminal. |
21 | 22 |
|
22 | 23 |
|
23 | 24 | ## Setup instructions
|
24 | 25 |
|
25 |
| -Explain how to setup and run your package/script in user's system |
26 |
| - |
27 |
| - |
28 |
| -## Detailed explanation of script, if needed |
29 |
| - |
30 |
| -If code is not explainable using comments, use this sections to explain your script |
| 26 | +- You should have 'numpy' module in your system. If you don't have just install it through the terminal using the following command |
| 27 | + ```sh |
| 28 | + pip install numpy |
| 29 | + ``` |
| 30 | + - You should have 'pygame' module in your system. If you don't have just install it through the terminal using the following command |
| 31 | + ```sh |
| 32 | + pip install pygame |
| 33 | + ``` |
| 34 | + - Finally to run this script in the background of your computer, open the terminal and type-in the below mentioned command |
| 35 | + ```sh |
| 36 | + python connect_four.py |
| 37 | + ``` |
31 | 38 |
|
32 | 39 |
|
33 | 40 | ## Compilation Steps
|
34 | 41 |
|
35 |
| -Briefly show the compilation steps of the project |
| 42 | +- Open the python script code in any of your ide. |
| 43 | +- Follow the above mentioned Setup Instructions. |
| 44 | +- Debug and Run your code |
36 | 45 |
|
37 | 46 |
|
38 | 47 | ## Output
|
39 | 48 |
|
40 |
| -Display images/gifs/videos of output/result of your script so that users can visualize it |
| 49 | +<img src="Images/Screenshot%20(370).png" width = "720" height = "480"> |
41 | 50 |
|
42 | 51 |
|
43 | 52 | ## Author(s)
|
44 | 53 |
|
45 |
| -Name(s) of author(s) |
| 54 | +Name of author : [Dhruv Mehta](https://github.com/Dhruv-194) |
46 | 55 |
|
47 | 56 |
|
48 |
| -## Disclaimers, if any |
49 | 57 |
|
50 |
| -Use this section to mention if any particular disclaimer is required |
|
0 commit comments