Skip to content

marcpaulo15/super-tic-tac-toe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Super Tic-Tac-Toe Game

The aim of this project is to develop the Python code to play the Super Tic Tac Toe Game. It uses the Pygame module, and allows the players to customize the game. The figure below shows a screenshot of an ongoing game.

Run the /scripts/game_runner.py and give it a try! :)

Game Rules

This board game is composed of nine Tic-Tac-Toe boards arranged in a 3x3 grid. Players take turns playing on the smaller boards until one of them wins on the larger board. The players will interact with the game through the computer mouse and a simple but beautiful interface (created using pygame) that will display the big board and the game’s information and instructions.

Before going into greater detail with regard to the Super Tic-Tac-Toe game logic, let us first explain how the common Tic-Tac-Toe game works. There are two players who take turns marking the spaces in a 3x3 grid with (typically) X and O. The first player who succeeds in placing three of their marks in horizontal, vertical, or diagonal row is the winner.

If played optimally by both players, the Tic-Tac-Toe game always ends in a draw. So, in order to make the game more challenging, several variations have been created. The focus of this project is on the Super Tic-Tac-Toe variation. Here we have a 3x3 grid of local boards and the larger 3x3 board is referred to as the global board. If a move is played so that it is to win a local board by the rules of normal tic-tac-toe, then the entire local board is marked as a victory for the player in the global board. If there is a local draw, that local board is emptied so it can be played again.

The game starts with X (or O) playing wherever they want in any of the 81 empty spots. This move "sends" their opponent to its relative location. For example, if X played in the top right square of their local board, then O needs to play next in any one of the nine available spots in the local board at the top right of the global board. The clearest way to understand this idea is playing the game!

Super Tic-Tac-Toe is significantly more complex than most other variations of Tic-Tac-Toe, as there is no clear strategy to play it. This is because of its complicated game branching. Even though every move must be played in a local board, the players must take into account the global board in several ways (anticipating the next move, visualizing the game tree, and winning in the global board).

Code

The code has been organized following the Object-Oriented Programming (OOP) paradigm. The logic of the game is split into five classes that can be found in the /classes directory. Each class implements a different concept and might use or depend on other classes. Each module has its main function with a short demo on how the module works. Feel free to run each file as many times as you need to fully understand how it is used.

When diving into the code for the very first time, it is strongly recommended to start from the bottom with the basic TicTacToeCell until you reach the more complex GameHandler.

The following figure shows the hierarchy and dependencies between classes. In the next paragraphs, each module will be explained in more detail.

  • TicTacToeCell: implements the behaviour of a Cell in a Tic-Tac-Toe board. The state of a cell can be unfilled (not chosen yet), available (if it is unfilled and is allowed to be chosen by the active player in current turn), or filled by either player1 or player2 (the player marking the cell is said to be the "winner" of the cell). The update method allows to change the cell state. The draw method displays a {width}x{width} square whose content depends on the cell state.

  • TicTacToeBasicBoard: implements the basic functionalities that both local and global boards share in a Super Tic-Tac-Toe game. It serves as a Parent Class for the TicTacToeBoard and SuperTicTacToeBoard classes. The main method here is winner, which returns the winner of the game (if any) or whether the game is a draw. The winner method is implemented following a simple recursive approach which is based on the fact that a cell is to a local board as a local board is to a global board. This way we can call this method from the global board and trigger that same method through different layers of the game’s logic: global board -> local boards -> cells.

  • TicTacToeBoard: implements the behaviour of a local board in a Super Tic-Tac-Toe game (equivalent to the main board in a common Tic-Tac-Toe game). It inherits some functionalities from its parent class TicTacToeBasicBoard. The board attribute in a local board is composed of nine TicTacToeCell instances arranged in a 3x3 grid. The update method allows to update the availability of the local board or the winner (marker) of a given cell. When a local board has a winner, from a global board perspective it is regarded as a (big) cell, not a local board anymore. The draw method displays all the cells in the local board. But if there is a local winner, it plays the role of a Cell.

  • SuperTicTacToeBoard: implements the behaviour of a global board in a Super Tic-Tac-Toe game. It inherits some functionalities from its parent class TicTacToeBasicBoard. The board attribute in a global board is composed of nine TicTacToeBoard instances arranged in a 3x3 grid. The update method allows to update the availability of a given local board, or the winner of a given cell. The draw method displays all the local boards in the global board.

  • GameHandler: implements the main flow of the game. There are four main methods: process_events to capture mouse clicks, run_logic to process the turns taken by the players, draw to display the game elements (board + game information + new_game button). Finally, the run method gathers the previous three methods and runs the main loop.

  • config: json file that allows the players to customize their game without having to change anything in the code. A more detailed explanation about the customization process can be found in a subsequent section.

Running The Game

In the /scripts directory there is a file named game_runner.py. Run this file in order to play the game. Basically, it initializes a GameHandler instance and calls its run method. The same behaviour (running the game) is obtained when running the main function in the /classes/game_handler.py file.

Here is an example of a game won by Player O:

Here is an example of a game that ends in a draw:

Customizing Your Game

In the /config directory there is the configuration file named config.json. This file contains the parameters of the game that the users are allowed to customize. Remember to make sure that the values you use make sense! (for instance, that the board width is lower than the dimensions of the screen).

The colors are in RGB format and the values of each component range from 0 to 255. Almost every color and length can be personalized, even the images for player1 and player2! Place your favourite audios and images inside the /audio and /images folders respectively, and update the configuration file to select them.

For instance, have a look at this awesome cat-vs-dog setting. Feel free to try different combinations to find out which one is your favourite :)

Future Work

Here you have some suggestions:

  • Implement an Intelligent Agent to enable the human-vs-machine mode. Different sources suggest relying on Monte Carlo Tree Search heuristics.
  • Improve the User-Interface in order to add more functionalities and enhance the user experience.
  • Enable an easier and higher-level way to custom the game. In other words, replace the config.json file with a more user-friendly approach.
  • Implement other variations of the TicTacToeGame! Using (parts of) this project as a reference. One simple an easy suggestion: Tic-Tac-Ku (same rules as Super Tic-Tac-Toe, but here a player wins the game by winning at least five local boards.)

Releases

No releases published

Packages

No packages published

Languages