tic-tac-toe-simple

command module
v0.0.0-...-1782f4d Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 3, 2023 License: AGPL-3.0 Imports: 7 Imported by: 0

README

Tic-Tac-Toe Simple

CodeGame Version CGE Version

A simple implementation of tic-tac-toe for CodeGame.

This game is ideal for familiarizing yourself with CodeGame.

Known instances

  • games.code-game.org/tic-tac-toe-simple

Usage

# Run on default port 8080
tic-tac-toe-simple

# Specify a custom port
tic-tac-toe-simple --port=5000

## Specify a custom port through an environment variable
CG_PORT=5000 tic-tac-toe-simple
Running with Docker

Prerequisites:

# Download image
docker pull codegameproject/tic-tac-toe-simple:0.3

# Run container
docker run -d --restart on-failure -p <port-on-host-machine>:8080 --name tic-tac-toe-simple codegameproject/tic-tac-toe-simple:0.3

Event Flow

  1. You receive a start event when a second player joins, which includes your sign ('x' or 'o').
  2. You regularly receive a board event, which includes the current state of the board.
  3. You receive a turn event, which includes the next sign to be placed.
  4. When it is your turn you can send a mark event with the row and the columnn (zero based), which should be marked with your sign.
  5. When the game is complete you will receive a game_over event, which includes which player wins and which fields form the winning row. Otherwise go to 3.
  6. You will receive an invalid_action event when you try to do something that's not allowed like marking an already marked field.

Building

Prerequisites
  • Go 1.18+
git clone https://github.com/code-game-project/tic-tac-toe-simple.git
cd tic-tac-toe-simple
codegame build

License

Copyright (C) 2022-2023 Julian Hofmann

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL