battleship

An API for playing the game Battleship.

Battleship is a guessing game played by two players. When a ship is sunk, you announce "You sank my battleship" (or 3-size, etc.)

See the test.js for usage.

Game

Create game.

• Board(width, height)
  • x tiles: (0 .. width-1)
  • y tiles: (0 .. height - 1)

TODO

• [x] Create a basic API for a normal game.
  • [x] Create a new board
  • [x] Place ships on a board id
  • [x] Start a game with a board (validate the board)
  • [x] Hit an (x, y)
    • [x] Hit, Miss, Sunk(boat)
• [x] Create a UI for the API.
  • See https://github.com/grant/battleship-web
• [ ] Make the game scale to hundreds of square tiles and thousands of ships of various lengths.

Inspiration

Inspired by an interview question.

• http://www.datagenetics.com/blog/december32011/
• https://battleship-game.org/

Tests

Run tests:

yarn
npm test -- --watch