# Islands Text Client
[](https://travis-ci.org/RaymondLoranger/islands_text_client)
Text client for the Game of Islands.
It’s a game for two players, and each player has a board, which consists of a
grid of one hundred coordinates. The grid is labeled with the numbers 1 through
10 across the top for the columns and down the left side for the rows. We name
individual coordinates with this row-column combination.
The players cannot see each other’s boards.
The players have matching sets of islands of various shapes and sizes, which
they place on their own boards. The players can move the islands around as
much as they like until they say that they are set. After that, the islands must
stay where they are for the rest of the game.
Once both players have set their islands, they take turns guessing coordinates
on their opponent’s board, trying to find the islands. For every correct guess,
we plant a palm tree on the island at that coordinate. When all the coordinates
for an island have palm trees, the island is forested.
The first player to forest all of her opponent’s islands is the winner.
##### Inspired by the book [Functional Web Development](https://pragprog.com/book/lhelph/functional-web-development-with-elixir-otp-and-phoenix) by Lance Halvorsen.</br>Also inspired by the course [Elixir for Programmers](https://codestool.coding-gnome.com/courses/elixir-for-programmers) by Dave Thomas.
## Usage
To play the Game of Islands, clone `islands_engine` from GitHub and compile it:
- git clone https://github.com/RaymondLoranger/islands_engine
- cd islands_engine
- mix deps.get
- mix compile
Then, clone `islands_text_client` from GitHub and compile it:
- git clone https://github.com/RaymondLoranger/islands_text_client
- cd islands_text_client
- mix deps.get
- mix compile
You would then run the engine in node `:islands@<hostname>` specifying short name **islands**:
- cd islands_engine
- iex --sname **islands** -S mix
- :observer.start() # optional to observe the game(s) being played
Player1 starts the game from a different node using any short name (here **_game1_player1_**):
- cd islands_text_client
- iex --sname **_game1_player1_** -S mix
- Islands.TextClient.start("**_player1_name_**")
Player2 joins the game from yet another node using any short name (here **_game1_player2_**):
- cd islands_text_client
- iex --sname **_game1_player2_** -S mix
- Islands.TextClient.join("**_player1_name_**", "**_player2_name_**")
Any number of games can be played simultaneously in this fashion.
## Example of a game's events in sequence
We start the Islands Engine using short name **islands** (required):
## 
Player1 starts the game using short name **_game1_player1_** (for example):
## 
## 
Player2 joins the game using short name **_game1_player2_** (for example):
## 
## 
A feedback will notify player1 that an opponent has joined the game:
## 
Each player must then position the 5 islands on the board (in any order):
## 
## 
## 
## 
Eventually, each player declares the 5 islands "set":
## 
## 
## 
Then, starting with player1, each player must make a guess **in turn**:
## 
A feedback will show what the opponent's guess was:
## 
## 
## 
## 
## 
Etcetera until one player wins and the other loses...
