This project is a Python implementation of the classic Battleship game. The plan is to enhance it with a graphical interface using Pygame.
In this implementation of Battleship, players set up their ships on a grid and then take turns guessing the locations of their opponent's ships. The goal is to sink all of the opponent's ships before they sink all of yours. This version brings an interactive console-based interface to life, enhanced with colorful output thanks to the Colorama library, making the gameplay experience more engaging and visually appealing.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
What things you need to install the software and how to install them:
- Python (3.x or higher recommended)
- Pip (Python package manager)
A step-by-step series of examples that tell you how to get a development environment running:
-
Clone the repository:
git clone https://github.com/Nebulaleaf/PyGame_Battleship.git
-
Navigate to the project directory:
cd PyGame_Battleship -
Create a virtual environment:
- On Windows:
python -m venv venv venv\Scripts\activate
- On macOS and Linux:
python3 -m venv venv source venv/bin/activate
- On Windows:
-
Install the required packages:
pip install -r requirements.txt
-
Run the application:
python src/main.py
The project is structured as follows:
assets/: Assets related to the project.docs/: Documentation related to the project.src/: Contains the actual implementation of PyGame aswell as sandbox files.original_code/: Contains the original code of the previous version (https://github.com/smue-smue/PyLadies_Battleship)
tests/: Test scripts for the game.venv/: Virtual environment for managing dependencies.
- Sandra - smue-smue
- Alexandra - Nebulaleaf
This project is licensed under the MIT License - see the LICENSE.md file for details