Gonnect Max

A modern, cross-platform Tic-Tac-Toe game written in Go using Ebitengine.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Gonnect Max is a robust implementation of the classic Tic-Tac-Toe game, engineered with Go and the Ebitengine 2D game library. It showcases how to build a scalable, cross-platform game with a responsive UI, AI opponents, and WebAssembly support for browser-based play.

Key features:

• Cross-Platform: Runs natively on desktop (Linux, Windows, macOS) and in the browser via WebAssembly.
• AI Opponents: Challenge yourself against AI algorithms (Minimax implementation).
• Responsive UI: Window resizing support with a layout that adapts to dimensions.
• Clean Architecture: Structured codebase separating game logic, UI, and screen management.

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

• Go 1.25 or higher

  # Verify your go version
  go version

Installation

1. Clone the repo

   git clone https://github.com/swaiku/TicTacGo.git

2. Navigate to the project directory

   cd TicTacGo

3. Install dependencies

   go mod tidy

4. Run the game

   go run .

Building for WebAssembly

To build the game for the web:

1. Run the build script:

   ./scripts/build_wasm.sh

2. Serve the dist directory using a local web server (e.g., python or go-based server).

(back to top)

Usage

Once the game is launched:

1. Main Menu: You have three options, Quick Local that allow you to play again another player, Quick vs AI that allow you to play against an hard AI and Customize that allow you to change settings like board size or number and type of player.
2. Gameplay: Basically a tic tac toe really customizable.
3. Objective: Align marks in a row, column, or diagonal to win.

(back to top)

Roadmap

• Basic Game Logic
• UI Implementation (Ebitengine)
  • more generalized ui system
• AI Opponent (Minimax)
  • implements more AI for more diffculties
• WebAssembly Support
• Network Multiplayer using libp2p

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Project Link: https://github.com/swaiku/TicTacGo

(back to top)

Acknowledgments

• Ebitengine - A dead simple 2D game library for Go.
• Best-README-Template

This project has been developped in collaboration with ZePyLaw 🤍

(back to top)