battleshipjs

1.0.4 • Public • Published

Battleship.js

NPM

Sonarcloud Status Renovate contributions welcome semistandard ECMAScript license

A Battleship CLI game with customizations.

Features

  • Set the number of each 5 ship type.
  • Set the number of rows and columns in the board.
  • Play against computer or against another player in hotseat mode.
  • Choose which player plays first.
  • Choose whether to end attack turn even if player hits.
  • Set names of players.
  • Also randomly place your ships and attack opponent's ships.

Board

  • Empty: O
  • Boat (1 space): B
  • Frigate (2 spaces): F
  • Destroyer (3 spaces): D
  • Cruiser (4 spaces): C
  • Aircraft carrier (5 spaces): A
  • Miss: X
  • Hit: *

Installation

$ npm install battleshipjs

Usage

Flag Short Description Usage
--rows -r Set number of rows in the board -r 15
--cols -c Set number of cols in the board -c 20
--multiplayer -m Play against another player -m
--swap -s Swap player turns (Player2 plays first) -s
--end -e End attack turn even if player hits -e
--first -f Set name of first player -f berk
--second -n Set name of second player -n erol

Examples

Example Description
$ battleship Starts a new game with default settings
$ battleship -r 15 Starts a new game with 15 rows
$ battleship -c 20 Starts a new game with 20 cols
$ battleship -r 15 -c 20 Starts a new game with 15 rows and 20 cols
$ battleship -m Starts a new game in mutliplayer hotseat mode
$ battleship -s Starts a new game in which Player2 plays first
$ battleship -e Starts a new game which ends attack turn even if player hits
$ battleship -f berk Starts a new game with name of first player
$ battleship -n erol Starts a new game with name of second player
$ battleship -f berk -n erol Starts a new game with names of first and second players
$ battleship -m -f berk Starts a new game in multiplayer with name of first player

Contribution

Feel free to contribute according to the semistandard rules and latest ECMAScript Specification.

Distribution

You can distribute this software freely under GNU GPL v3.0.

Package Sidebar

Install

npm i battleshipjs

Weekly Downloads

0

Version

1.0.4

License

GPL-3.0-or-later

Unpacked Size

54.5 kB

Total Files

10

Last publish

Collaborators

  • berkerol