Skip to content

README.md

Latest commit

 

History

History
220 lines (169 loc) · 7.65 KB

README.md

File metadata and controls

220 lines (169 loc) · 7.65 KB

Tic-Tac-Toe

Back to JavaCraft

A two-player Tic-Tac-Toe desktop game with a Swing GUI, a configurable AI opponent, and customisable player symbols.

Stack: Java, Swing

Contents

  1. Quick Start
  2. Architecture
  3. Game Flow
  4. Components
  5. AI Strategy
  6. Configuration
  7. Image Customisation
  8. Tests

1. Quick Start

Build and run

mvn -pl tic-tac-toe package
java -jar tic-tac-toe/target/tic-tac-toe.jar

2. Architecture

Back to top

MVC pattern: Controller mediates between the Swing view and the pure-Java model. The model has zero Swing dependencies and is fully unit-testable.

flowchart TD
    Main["Main\n(entry point)"]

    subgraph view ["View (Swing)"]
        GUI["GUI\n(main JFrame)"]
        Options["Options\n(settings dialog)"]
        ImageOptions["ImageOptions\n(symbol picker)"]
        About["About\n(info dialog)"]
    end

    subgraph model ["Model"]
        TicTacToe["TicTacToe\n(game instance)"]
        GameField["GameField\n(3×3 board)"]
        AI["ArtificialIntelligence\n(AI brain)"]
        P1["Player — human"]
        P2["Player — human / computer"]
        GameSettings["GameSettings\n(singleton)"]
    end

    Main --> GUI
    Main --> Controller["Controller\n(orchestrator)"]
    GUI --> Options
    GUI --> ImageOptions
    GUI --> About
    Controller -->|"new game"| TicTacToe
    Controller --> GameSettings
    TicTacToe --> GameField
    TicTacToe --> AI
    TicTacToe --> P1
    TicTacToe --> P2
    AI --> GameField
    GUI -->|"cell click"| Controller
    Controller -->|"show result / lock cells"| GUI
Loading

3. Game Flow

Back to top

sequenceDiagram
    participant User
    participant GUI
    participant Controller
    participant TicTacToe
    participant GameField
    participant AI

    User->>GUI: click cell (1–9)
    GUI->>Controller: action(cellType)
    Controller->>Controller: isGameOver() → false
    Controller->>TicTacToe: makeHumanMove(button)
    TicTacToe->>GameField: setPlayer(currentPlayer, button)
    Controller->>TicTacToe: getWinner()
    GameField-->>Controller: null (no winner yet)
    Controller->>TicTacToe: makeComputerMove()
    TicTacToe->>AI: computerBrain()
    AI->>AI: win → defend → random
    AI-->>TicTacToe: nextMove (cell 1–9)
    TicTacToe->>GameField: setPlayer(computer, nextMove)
    Controller->>TicTacToe: getWinner()
    GameField-->>Controller: winner / null

    alt winner found or draw
        Controller->>GUI: showWinner(name) / showDraw()
        Controller->>GUI: lockAllCells()
    end
Loading

The board is a 3×3 array of Player references (null = empty). Cells are numbered 1–9 left-to-right, top-to-bottom. Win detection checks all 8 combinations (3 rows, 3 columns, 2 diagonals) using reference equality on Player instances.

4. Components

Back to top

Model

Class Role
TicTacToe Game instance — wires together two Players, the GameField, and the AI; exposes makeHumanMove() and makeComputerMove()
GameField 3×3 Player array; setPlayer(player, cell) places a move, getWinner() checks all 8 winning lines
ArtificialIntelligence Stateful AI brain
Player Name + isComputer flag
GameSettings Singleton — tracks whose turn it is, whether the second player is a computer, and whether the current game is odd-numbered (controls first-move alternation)

View

Class Role
GUI Main JFrame — 3×3 grid of Cell buttons, menu bar (New Game / Options / Image / About), win/draw dialogs
Cell JButton subclass with isAlreadyPressed flag and a 1–9 type index
Options Settings dialog — player names, human vs. computer toggle, first-move preference
ImageOptions Symbol picker — 14 icon choices per player (see Image Customisation)
About Info dialog — game version (1.0.0) and JVM / OS details

Controller

Class Role
Controller Orchestrates the full game loop: validates move legality, calls model, checks result, triggers next computer move, relays outcome back to the view
Main Entry point — creates GUI singleton and Controller, wires them together

5. AI Strategy

Back to top

The AI evaluates three priorities in order each turn:

  1. Winning move — if the computer can complete a three-in-a-row on this turn, it takes it.
  2. Defensive move — if the human can complete a three-in-a-row on the next turn, it blocks it.
  3. Random move — prefers the centre cell (5); if taken, picks a random valid empty cell.

For steps 1 and 2 the AI scans diagonals first, then columns, then rows. The first incomplete two-in-a-line (two of the target player + one empty) wins the scan.

6. Configuration

Back to top

The Options dialog (menu → Options) controls three settings:

Setting Default Options
Player 1 name Player 1 Any string
Player 2 name Player 2 Any string
Second player type Computer Human / Computer
First move Alternating Always Player 1 / Always Player 2 / Alternating

When Alternating is selected, GameSettings.isOddGame flips after each completed game so the loser of the previous game goes first in the next.

7. Image Customisation

Back to top

The Image menu lets each player pick their symbol icon. 14 options are available:

# Image file
0 DefaultCrossOne.png / DefaultNoughtOne.png (default)
1 DefaultCrossTwo.png / DefaultNoughtTwo.png
2 Browser-Chrome.png
3 Browser-Firefox.png
4 Browser-Opera.png
5 Finder.png
6 Globe.png
7 Limewire.png
8 Netscape.png
9 Radiation.png
10 Sun.png
11 Vista.png
… (selection auto-updates the cell icons live)

All images live in src/main/resources/img/ and are bundled inside the JAR.

8. Tests

Back to top

Run all tests:

mvn -pl tic-tac-toe test

Coverage summary

Module Tests Line coverage
tic-tac-toe 45 65.7%

Tip

Model and Controller packages are at 100 %. The overall figure is pulled down by Swing view classes (GUI, Cell, About, Options, ImageOptions) which cannot be exercised in a headless test environment.