Real-time online multiplayer battleship TUI game for the AP Computer Science Principles 2021 Performance Task written in Dart. Most of the code is uncommented but somewhat self-documenting.

• Battleship
  • Table of Contents
  • Architecture
  • Requirements
  • Building and running
    • Directly
    • Concatenation
      • Watch mode
      • Google Docs mode
    • Compilation
  • Usage

This project contains both the game client and the centralized game server. The server is responsible for keeping track of the game state and coordinating the clients for each game.

Clients communicate with the server using HTTPS (for general API stuff) and WebSockets (for gameplay).

Game data (boards, ships, cells, etc.) are serialized to strings when sent over the network.

• Dart >=2.17.0

Run the battleship.dart file in the bin directory.

dart run bin/battleship.dart

Concatenate bin/battleship.dart and all of its dependencies into a single file.

make concat

The result will be at build/main.dart.

Re-concatenate the files every time a file changes.

make watch

Concatenating in Google Docs mode will place an extra space at the beginning of each line for easy copy-paste.

make gdocs

Compile the game into an executable.

make dist

The executable will be at build/battleship.

battleship

• Prints a help message.

battleship [--ascii] client [server_address]

• Run the battleship game client, connecting to the server at the given origin (hostname:port; yes, port is required), or localhost:8080 if no origin is given.
• If --ascii is specified, the game will use ASCII art instead of Unicode characters, which might not be supported by all terminals or fonts.

battleship server [address]

• Start a battleship game server, listening on the given hostname and port, or localhost:8080 if no address is given.