-
Notifications
You must be signed in to change notification settings - Fork 377
Improved README with installation, gameplay, and controls #27
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
SungHong96
wants to merge
1
commit into
techwithtim:main
Choose a base branch
from
SungHong96:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For MacOs users, they should change the key