- Description of the Game
- How to Install
- How to Play
- Documentation
- How the Code Could be Extended
- License
- Authors and their Contributions
Are you tired of not having anything to play? Too many terrible games on the market? Too poor to afford anything in this microtransaction-rich environment? Maybe you're bored of playing connect 4? (don't worry, we get it!)
In that case, allow us to introduce our game, connect five. Traditionally called Gomuku, Connect Five is a game where players take turns putting markers on a 15x15 grid. In this version, one player uses the 'X' character, while the other player uses the 'O' character. The goal of the game is to form an unbroken line of five chips in any direction. These directions are vertically, horizontally, or diaonally.
This is what the 15x15 board looks like in the console.
The user will input their move by entering the coordinate when given the row and column prompt.
This is what it looks like after a valid move is entered. The next player's turn is then prompted.
This is an example of a completed game where the (x) player won by getting 5 in a row from (0,2) to (4,6).
The game declares a winner!
Besides you think we usually play the ConnectFive with a paper and pen, my group creates a system for playing this game on your laptop or desktop. If you have experience with the Connect Four, the way of playing this game is similar to it. The board of this game is similar to Go board and its size is 15×15 board. There are many empty intersections between rows and columns where you can fill these pieces. The winner who can come up with 5 tokens in any directions and you have to think how to block the opponent (avoid the opponent fill 4 tokens first). There are 2 people playing in this game, one will be Black(0) and one will be White(X). The White(X) always goes first.
The game can be installed by cloning the repository available at the link:
https://github.com/weboski/connect_five
STEP 1:
Clone the repository from the link given above.
STEP 2:
Download the ZIP file and extract its contents.
STEP 3:
Run the game with the ConnectFiveController.py file. A Python interpreter needs to be installed to run the game. The preferred version is Python 3.8.
We decided to design the code for our game using the Model, View, Controller Model (MVC). To follow this model, the game code is divided into three classes; ConnectFiveController, ConnectFiveBoard, and ConnectFive. The ConnectFiveController handles player input and updates the ConnectFive class (the Controller component of the MVC model). The ConnectFive handles all the game logic and updates the ConnectFiveBoard based on them. (the Model component of MVC). Finally, the ConnectFiveBoard outputs all information to the console for the player to consult and make moves from (the View component of MVC).
Do you think you have an idea that can improve upon our design? Then go for it. If you are unsure of what to do, here are some suggestions: -Implement Pygame, so that it can be played using buttons that the use clicks using their mouse -Also incorporate a theme and/or animation -Implement an AI that can play against the player -Could also choose an AI that makes a random move or even a strategic move -Undo function; allows a user to replay their last move
My contributions to the code consist of the ConnectFiveBoard.py file along with the methods and classes inside. Inside the file, there is a board class. Within the class itself, there are methods that check valid positions on the board, a constructor that creates the object itself, a method to get the string representation, as well as getter/setter methods. Additionally, the file has internal methods to convert the coordinates on the grid from letters to numbers, and vice versa. In the readme file, the contribution is the part of the file that describes the game and out implementation of it. Note for marking: Early on, I forgot to change the name/email of my desktop before making commits, etc... As a result, some of the commits have the name, "Buildtools." This refers to Michael Kwan, as modifying git version history is considered frowned upon.
Most of my contribution to the project code took place in the ConnectFive class. The methods I implemented handle the most important aspects of the game logic; uniformChips(), hasMove(), and checkWinner(). The uniformChips() and checkWinner() methods handle checking for a player winning (player forms an unbroken line of 5 chips )while hasMove() returns whether there are any possible moves available on the board. Another method I implemented is the getCount() method which counts how many chips of the inputted player type are on the board. Outside of implementing methods, I added and modified documentation for the class so team members understand what each method is responsible for. Another contribution included fixing a bug that prevented our game from detecting a player winning. For the README document I completed the Documentation section which is a high-level description of the code structure.
My contribution to the project is mainly the ConnectFiveController.py file. I worked on the ConnectFiveController class, which is responsible for the user interaction interface. The ConnectFiveController class accepts user input and sends updates to the model. This class formed the 'Controller' aspect of the MVC model. I worked on methods like 'player_turn', 'return_board', 'check_move'. These methods are helper methods for the most important method ('play') in the class . I worked on the method 'play' as well, which is responsible for sending the user input to the Model and makes appropriate changes (for example displaying which player's turn it is, the winner etc.) that need to be rendered to the console. I also documented the methods in the ConnectFiveController class. I documented the 'How To Install' section in the README.md file. This sections gives clear instructions to a user about installing the game, getting the required configurations and then successfully running the game.
My contribution to the project is the ConnectFive.py file. This class follows the 'Model' aspect of the MVC model which receives all requests from the Controller and sends updates to the ConnectFiveBoard(View). The methods I implement the structure of this class and handle some important methods of this game including: init(), otherplayer(), hasMove(), isGameOver(), getCount() and move(). The move() method is to place token in the position given and the hasMove() use to check an available spot on the board. I have created the isGameOver() to stop the game when the winner exists or there are no empty space on the board and otherplayer() is to return the next player in this game. Furthermore, I discussed with Jacob to implement and fix bugs in the ConnectFive file. In the README.md, I have responsibility to add some description in the "How to play" part which helps to guide player about this game. Besides that, I forgot to change the name/email of my desktop before making commits
My contribution to the project started in the ConnectFiveController class. I worked on the initial outline of the class and the design of how it will interact with the other classes using the MVC model. This design was similar to the Othello controller classes from CSC207. Some of the methods I implemented included the init method, 'play' and 'get_move'. In terms of debugging, I managed to figure out the source of a bug that made any move be displayed incorrectly on the board. In the other classes, I helped in finding bugs for edge cases as well as communicating how the code should work to allow my team to work with the input my class delivers. For example, the get_move method will automatically convert the letters into numbers so when the game class uses the input, it can assume that its not a letter. In the README file, I organized the outline of the file pertaining to the handout and the design of other READMEs. I showed my team how they can directly edit the README on GitHub. I created the screenshot, license, and navigation sections.
The MIT License (MIT)
Copyright © 2019 Connect_Five
You can find a copy of the License at https://mit-license.org/
License for them is in Public Domain