Skip to content

Latest commit

 

History

History
52 lines (38 loc) · 1.54 KB

README.md

File metadata and controls

52 lines (38 loc) · 1.54 KB
Raw

SheepMaBoat

                             v  ~.      v
                    v           /|
                               / |          v
                        v     /__|__
                            \--------/
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`~~~~~~'~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Description

SheepMaBoat is a TCP two players game application. It's a twin of the Battleship game.
The app use the SheepMaBoat protocol, you can find the information about it here.

Building the app

The app use maven so in order to build and package the app use this command.

# Download the dependencies
./mvnw dependency:resolve

# Package the application
./mvnw package

Running the app

Download the .jar file into the lastest release and run the command explained under this text. You can also download the source code and build the code with Maven but make sure to have included all dependencies.

Launch the game server

The port's value is by default 11111

java -jar <path-to-jar> server -a <address> -p <port>

# Example
java -jar SheepMaBoat-v1.0.jar server --address 127.0.0.1

Launch a player(client)

java -jar <path-to-jar> client -a <address> -p <port>

# Example
java -jar SheepMaBoat-v1.0.jar client --address 127.0.0.1 --port 11111

Description

  • -a, --address <IP address>: IP address to connect.
  • -p, --port <port>: Port to connect.