From ea34dec2f2368c11dfcca6d5ed31c22a9e609493 Mon Sep 17 00:00:00 2001 From: Sung Hong Date: Wed, 16 Oct 2024 18:27:53 -0400 Subject: [PATCH] Improved README with installation, gameplay, and controls --- README.md | 45 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 44 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b1d7ec2..7fe94bf 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,45 @@ # PygameForBeginners -A simple 2D python game designed to teach you the pygame module. + +PygameForBeginners is a simple two-player spaceship combat game built using the Pygame library. Players control spaceships, shoot bullets, and aim to deplete the opponent's health. The first to reach zero health loses. + +## Table of Contents +- [Installation](#installation) +- [Gameplay](#gameplay) +- [Controls](#controls) +- [Contributing](#contributing) + +## Installation + +1. **Clone the repository**: + git clone https://github.com/techwithtim/PygameForBeginners.git + +2. **Navigate to the project directory**: + cd PygameForBeginners + +3. **Install dependencies**: You need Python 3.x and Pygame installed. If you don’t have Pygame, install it using pip: + pip install pygame + +4. **Run the game**: Execute the main game file to start the game: + python main.py + +## Gameplay +PygameForBeginners is a two-player game where each player controls a spaceship. The goal is to shoot bullets and reduce the opponent's health to zero. Players can move their spaceships around the screen and shoot bullets to hit the opposing spaceship. + +## Controls + +**Yellow Spaceship**: +Move left: A +Move right: D +Move up: W +Move down: S +Shoot: Left Control + +**Red Spaceship**: +Move left: Left Arrow +Move right: Right Arrow +Move up: Up Arrow +Move down: Down Arrow +Shoot: Right Control + +## Contributing +Contributions are welcome! Feel free to suggest improvements or submit a pull request if you'd like to add features or fix bugs. \ No newline at end of file