# xxo
[](https://circleci.com/gh/EssenceOfChaos/xxo)
A tic-tac-toe game engine written in Elixir.
This is an MVP. My intention is to build a working product and then improve upon it on each iteration.
## Version 1
The first version will consist of a single player mode.
## Version 2
The second version of the game will add a two-player mode. Users will gain the ability to play against a choosen or random opponent.
## Version 3
The third version of the game will include an option for choosing the difficulty level of the computer. A single player will choose between `easy`, `average`, and `hard` modes.
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `xxo` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:xxo, "~> 1.0.0"}
]
end
```
The Documentation can be found at [https://hexdocs.pm/xxo](https://hexdocs.pm/xxo).
---
`Xxo` is a game engine for tic-tac-toe. While it is possible to play the game entirely from the command line the recommended method of play is using [xxo_ui](https://github.com/EssenceOfChaos/xxo_ui), a [Phoenix](https://phoenixframework.org/) application that provides a user-friendly front-end.
## After Installation
Start a new game by calling `Xxo.new_game("name")`, where "name" is the name of the player initiating the game. This call will return `{:ok, pid}`, where `pid` is the process id of the game. You can verify the game has started successfully by calling `Xxo.GameSupervisor.children()`, which will return the details of the current games under supervision.
Retrieve the current state of the game by calling `Xxo.GameServer.get_state("name")`, passing in the same name that was used to start the game. This will return a struct that includes the following:
```elixir
%Xxo.Game{
action_on: "mia",
board: %{
{0, 0} => " ",
{0, 1} => "x",
{0, 2} => " ",
{1, 0} => " ",
{1, 1} => " ",
{1, 2} => " ",
{2, 0} => " ",
{2, 1} => " ",
{2, 2} => " "
},
finished: false,
game_name: "mia",
winner: nil
}
```
Here is an example game played with version 1:
```elixir
Erlang/OTP 21 [erts-10.3.4] [source] [64-bit] [smp:4:4] [ds:4:4:10] [async-threads:1] [hipe] [dtrace]
Interactive Elixir (1.8.1) - press Ctrl+C to exit (type h() ENTER for help)
iex(1)> Xxo.new_game("mia")
17:31:10.564 [info] Process created... Game name: mia
{:ok, #PID<0.188.0>}
iex(2)> GameServer.player_move("mia", "o", {0, 0})
17:31:19.574 [info] Player o has made a move. Check game status
{:ok,
%Xxo.Game{
action_on: "computer",
board: %{
{0, 0} => "o",
{0, 1} => " ",
{0, 2} => " ",
{1, 0} => " ",
{1, 1} => " ",
{1, 2} => " ",
{2, 0} => " ",
{2, 1} => " ",
{2, 2} => " "
},
finished: false,
game_name: "mia",
winner: nil
}}
iex(3)> GameServer.computer_move("mia", "x")
17:31:33.904 [info] Player x has made a move. Check game status
{:ok,
%Xxo.Game{
action_on: "computer",
board: %{
{0, 0} => "o",
{0, 1} => " ",
{0, 2} => " ",
{1, 0} => " ",
{1, 1} => " ",
{1, 2} => " ",
{2, 0} => " ",
{2, 1} => "x",
{2, 2} => " "
},
finished: false,
game_name: "mia",
winner: nil
}}
iex(4)> GameServer.player_move("mia", "o", {1, 1})
{:ok,
%Xxo.Game{
action_on: "computer",
board: %{
{0, 0} => "o",
{0, 1} => " ",
{0, 2} => " ",
{1, 0} => " ",
{1, 1} => "o",
{1, 2} => " ",
{2, 0} => " ",
{2, 1} => "x",
{2, 2} => " "
},
finished: false,
game_name: "mia",
winner: nil
}}
iex(5)>
17:31:47.127 [info] Player o has made a move. Check game status
GameServer.computer_move("mia", "x")
17:32:38.338 [info] Player x has made a move. Check game status
{:ok,
%Xxo.Game{
action_on: "computer",
board: %{
{0, 0} => "o",
{0, 1} => " ",
{0, 2} => " ",
{1, 0} => " ",
{1, 1} => "o",
{1, 2} => " ",
{2, 0} => "x",
{2, 1} => "x",
{2, 2} => " "
},
finished: false,
game_name: "mia",
winner: nil
}}
iex(6)> GameServer.player_move("mia", "o", {2, 2})
17:33:01.246 [info] Player o has made a move. Check game status
{:game_over, "Player o Wins!"}
```
