Skip to content

Commit d3365ba

Browse files
Update README.md
1 parent 31dbdc5 commit d3365ba

1 file changed

Lines changed: 109 additions & 11 deletions

File tree

README.md

Lines changed: 109 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,137 @@
1-
# 🧱 Breakout Game
1+
# 🧱 HuskyHawks Breakout Game
2+
3+
A classic **Breakout-style arcade game** built in **C++** using **SFML** and **CMake**. This game features neon retro graphics, smooth animations, and multiple screens including a title with menu, gameplay controls, credits and quit.
4+
5+
![Menu Screenshot](GameScreenshots/menu.png)
6+
---
27

3-
A classic **Breakout-style arcade game** built in **C++** using **SFML** and **CMake**.
48

59
This project recreates the retro brick-breaker experience where the player controls a paddle to bounce a ball and destroy bricks. The objective is to clear all bricks without letting the ball fall below the paddle.
610

7-
---
11+
12+
![Game Play Screenshot](GameScreenshots/SampleGamePlay.png)
13+
814

915
## 🎮 Gameplay
1016

11-
- Move the paddle left and right to keep the ball in play.
17+
- Move the paddle left and right (with the left and right arrow keys) to keep the ball in play.
1218
- The ball bounces off walls, the paddle, and bricks.
1319
- Bricks disappear when hit.
1420
- The player wins when all bricks are destroyed.
1521
- The player loses when the ball falls below the paddle.
1622

17-
---
1823

19-
## 🛠️ Tech Stack
24+
25+
## ✨ Features
26+
27+
- Title screen with glow effects and neon accents.
28+
- Menu with **Play, Control, Credits, and Quit** options.
29+
- Ball and paddle movement with collision detection.
30+
- Smooth frame movement using deltaTime.
31+
32+
33+
34+
## 🕹️ Controls
35+
36+
**In Menu:**
37+
- 'Up' / 'Down' arrows: Move Selection
38+
- 'Enter' key: Select Menu Option
39+
40+
**During Gameplay:**
41+
- 'Left' arrow: Moves paddle to the left
42+
- 'Right' arrow: Moves paddle to the right
43+
44+
45+
46+
## 💻 Tech Stack
2047

2148
- **Language:** C++ (C++17)
2249
- **Graphics Library:** SFML (Simple and Fast Multimedia Library)
2350
- **Build System:** CMake
2451
- **Design Approach:** Object-Oriented Programming
2552

26-
---
2753

2854
## ⚙️ Requirements
2955

3056
Before building the project, ensure you have:
3157

32-
- A C++17 compatible compiler (g++, clang++, or MSVC)
58+
- A C++17 (or higher) compatible compiler (g++, clang++, etc.)
3359
- CMake (3.16 or newer recommended)
34-
- SFML installed on your system
60+
- SFML installed on your system (2.5+)
3561

36-
---
3762

3863
## 📦 Installing SFML
3964

40-
(INCLUDE INFO HERE)
65+
This project requires **SFML (Simple and Fast Multimedia Library)** and **CMake** to compile and run.
66+
67+
### macOS
68+
69+
Follow the official installation instructions:
70+
71+
- CMake: https://cmake.org/download/
72+
- SFML: https://www.sfml-dev.org/download.php
73+
74+
Alternatively, if you use Homebrew:
75+
76+
```bash
77+
brew install sfml cmake
78+
```
79+
80+
### Ubuntu / Linux
81+
82+
Update packages and install dependencies:
83+
84+
```bash
85+
sudo apt update
86+
sudo apt install libsfml-dev cmake
87+
```
88+
89+
### Windows
90+
91+
1. Download **CMake**: https://cmake.org/download/
92+
93+
2. Download **SFML**: https://www.sfml-dev.org/download.php
94+
95+
3. Install CMake and make sure **"Add CMake to PATH"** is selected.
96+
97+
4. Extract the SFML folder and ensure CMake can locate it when building the project.
98+
99+
100+
## 🔨Building the Project
101+
102+
From the root directory of the repository:
103+
104+
```bash
105+
mkdir build
106+
cd build
107+
cmake ..
108+
make
109+
```
110+
111+
---
112+
## 🚀 Running the Game
113+
114+
After building the project, go to the `build` directory:
115+
116+
```bash
117+
cd build
118+
```
119+
120+
List the files to find the generated executable:
121+
122+
```bash
123+
ls
124+
```
125+
126+
Run the executable shown in the output. For example:
127+
128+
```bash
129+
./main
130+
```
131+
132+
**Note that this is unique to your machine, so we use CMake to make builds of the same program in different environments.**
133+
134+
---
41135

42136

43137
## 👥 Team
@@ -48,6 +142,10 @@ Before building the project, ensure you have:
48142
- David Hochberg
49143
- Miles Vollmer
50144

145+
## 🎉 Acknowledgements
146+
147+
Special thanks to **SFML** for providing the graphics library used to build this game.
148+
51149

52150

53151

0 commit comments

Comments
 (0)