battleship

README

#BattleShips

• Battleship is a game played between 2 players. Each player will be initialised with an M * M grid with S number of the ships placed at specified positions on the grid.

• One battleship occupies a single position on the Grid.

• Objective of the game is to destroy opponent's ships. Each player will be given T number of missiles.

• Based on hits/misses of a missile on the opponent, either of the player might be vistorious or the game might end as a draw.

##Installation

go get -u github.com/vedhavyas/battleship/cmd/battleship/...
cd $GOPATH/bin
./battleship --help

##Input Program requires an Input file and an Output file.

###Input File Input file should be of the following format

1. GridSize (0<M<10)
2. Number of ships for each player
3. Player 1 ship positions, should be of format x1,y1:x2,y2:x3,y3:x4,y4
4. Player 2 ship positions, should be of format x1,y1:x2,y2:x3,y3:x4,y4
5. Total number of missiles for each player (0<T<100)
6. Player 1 Moves, should be of format x1,y1:x2,y2:x3,y3:x4,y4
7. Player 2 Moves, should be of format x1,y1:x2,y2:x3,y3:x4,y4

Since it was not specifically mentioned in the problem as to how the coordinate system of the board works. Hence, we are assuming that (0,0) lies in the top left corner and (m,m) in bottom right. Final depiction of the board looks as follows

     (0,0) (0,1) (0,2)
(1,0)  _     _     _
(2,0)  _     _     _

###Output file Program requires an output file to write the result back to the file. If file does not exist, one will be created. If file exists, then the data is overwritten

##Output Programs sample output in the Output File will look as follows.

Player1
O O _ _ _
_ B O _ _
B _ _ X _
_ _ _ _ B
_ _ _ X _

Player2
_ X _ _ _
_ _ _ _ _
_ _ _ X _
B O _ _ B
_ X _ O _

P1: 3
P2: 2
Player1 wins

• O - represents a missed hit by the opponent
• B - represents a safe/un-hit ship of the player
• X - represents a confirmed hit by the opponent
• _ - represnets an empty location

Documentation

Index

• type GameResult
  • func PlayGame(gameData []string) (gameResult GameResult, err error)

Types

type GameResult

type GameResult struct {
	Player1Board string
	Player2Board string
	Player1Hits  int
	Player2Hits  int
	Result       string
}

GameResult holds the results of the game Player{1/2}Board is the representation of the board of the player Player{1/2}Hits is the total hits of a player on his opponent

func PlayGame

func PlayGame(gameData []string) (gameResult GameResult, err error)

PlayGame initiates the battleship game between two players gameData is the players raw data of format Grid Size - 5 Total Ships - 5 Player1 Ship Positions - 1:1,2:0,2:3,3:4,4:3 Player2 Ship Positions - 0:1,2:3,3:0,3:4,4:1 Total Missiles for each player - 5 Player1 moves on Player2 - 0:1,4:3,2:3,3:1,4:1 Player2 moves on Player1 - 0:1,0:0,1:2,2:3,4:3