TriForMine/battleship

This is a variation of the classic battleship game where you can move your ships and when you miss a ship, a mine is placed on the board.

Battleship Game in C

Welcome to the Battleship Game in C! In this version of the classic battleship game, players take turns guessing the location of each other's ships on a grid. When a player misses a ship, a mine is placed on the board. The game ends when all of one player's ships have been sunk. Players can move their ships and attack their opponent's ships on each turn. The game also includes three types of AI that players can compete against.

In addition, the game now features online multiplayer, using a game server written in Rust. The server only handles turn-by-turn broadcast of actions to the other player, and does not check for cheats or incorrect commands.

Gameplay

In Battleship, players take turns guessing the location of each other's ships on a grid. The size of the grid can be customized at the start of the game.

Each player places their ships on the board and then takes turns guessing the location of the opponent's ships. If a player hits a ship, the turn ends and the opponent gets to go. If a player misses a ship, a mine is placed on the board. If a player hits a mine, the turn ends and the opponent gets to go.

The game ends when all of one player's ships have been sunk. On each turn, a player can either move one of their ships or attack an opponent's ship. If two ships collide on the same space, both ships will be damaged and their movements will be cancelled. If a ship moves onto a mine, it will be damaged. The game ends when one player has no ships left.

Rules

• Players take turns playing the game.
• If a player misses a shot, they will place a mine on the board.
• If a ship moves onto a mine, it will be damaged.
• If two ships collide on the same space, both ships will be damaged and their movements will be cancelled.
• On each turn, a player can either move one of their ships or attack an opponent's ship.
• The game ends when one player has no ships left.

AI

The game includes 3 types of AI:

Random AI

This AI fires at random coordinates each turn.

Hunt and Target

This AI fires in a grid form, and when there is a hit, fires on the adjacent cell until the ship is sunk.

Probability Targeting

This AI calculates at every turn where the highest probability for a ship to be is, and fires at that point. When in hunting mode, it will calculate all the possibilities for the hit ship to be placed and eliminate it quickly. This AI is the most difficult to beat.

Installation

To install and run the game, you have two options:

1. Clone the repository to your local machine and compile the source code using the Makefile.
2. Download a release from the releases page and run the game.

Option 1: Install using the Makefile

1. Clone the repository to your local machine:

git clone https://github.com/TriForMine/battleship.git

2. Navigate to the directory where you cloned the repository:

cd battleship

3. Compile the source code using the Makefile:

make release

To build the game with the debug mode, use make debug instead. This will show a map of the probabilities for the probability targeting mode.

4. Run the game:

• Interactive Mode

./build/battleship -i

• STDIN Format

cat test/format0.txt | ./build/battleship

• File Argument

./build/battleship -f test/format0.txt

Option 2: Install using CMake and Ninja

1. Clone the repository to your local machine:

git clone https://github.com/TriForMine/battleship.git

2. Navigate to the directory where you cloned the repository:

cd battleship

3. Compile the source code using CMake and Ninja:

cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -S . -B build
cmake --build build

To build the game with the debug mode, use cmake -DDEBUG=1 -G Ninja -DCMAKE_BUILD_TYPE=Release -S . -B build instead. This will show a map of the probabilities for the probability targeting AI.

4. Run the game:

• Interactive Mode

./build/battleship -i

• STDIN Format

cat test/format0.txt | ./build/battleship

• File Argument

./build/battleship -f test/format0.txt

Server

To build and run the server for the Battleship game, you have several options:

1. Using Makefile: You can use the command make server in the root directory of the project to build the server. Once the build is complete, you can run the server using ./build/server

2. Downloading from GitHub Releases: You can download a pre-built binary of the server from the GitHub releases page and run it on your machine.

3. Building from source with Cargo: To build the server from source, navigate to the server directory and run cargo build --release. This will build the server in release mode and you can find the binary in the target/release folder. You can run the server by executing ./target/release/server.

NOTE: Make sure you have rust and cargo installed before trying to build the server with cargo or the Makefile, otherwise the command will not work.

Contributions

We welcome contributions to the project! If you would like to contribute, please follow these steps:

1. Read the CONTRIBUTING.md file for guidelines on contributing to the project.
2. Fork the repository.
3. Create a new branch for your changes.
4. Make your changes.
5. Commit your changes and push them to your fork.
6. Create a pull request to merge your changes into the main branch.

We will review your pull request and provide feedback as needed. Thank you for considering contributing to the project!

License

This project is licensed under the Apache-2.0 license. See the LICENSE file for more information.