Skip to content

Commit

Permalink
Fix: Refactored Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hoangsonww committed Mar 28, 2024
1 parent 8a87d01 commit b0786e3
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
# Flappy Bird Game in Swift

This project is a version of the popular mobile game Flappy Bird, developed using Swift and SpriteKit for iOS. The game aims to replicate the original's gameplay, featuring a bird that the player navigates between a series of obstacles by tapping the screen to make the bird fly. The goal is to achieve the highest possible score by avoiding the pipes.
Created by [Son Nguyen](https://github.com/hoangsonww) in 2024, this project is a whole new version of the popular mobile game Flappy Bird, developed using Swift and SpriteKit for iOS. The game aims to replicate the original's gameplay, featuring a bird that the player navigates between a series of obstacles by tapping the screen to make the bird fly. The goal is to achieve the highest possible score by avoiding the pipes.

## Features

- Classic Flappy Bird gameplay
- Score tracking with high score memory
- Simple tap control
- Endless game mode
- Endless game mode (for now)
- Sound effects and background music

## Requirements

- iOS 14.0+
- Xcode 12.0+
- Swift 5.3+
- SpriteKit Framework

## Installation

Expand All @@ -23,7 +24,7 @@ To run this game on your device, follow these steps:
1. Clone the repository to your local machine:

```
git clone https://github.com/hoangsonww/FlappyBirdGame.git
git clone https://github.com/hoangsonww/Flappy-Bird-Game.git
```

2. Open the project in Xcode:
Expand All @@ -32,13 +33,15 @@ git clone https://github.com/hoangsonww/FlappyBirdGame.git
open FlappyBirdGame.xcodeproj
```

3. Select your target device or simulator.
3. Select your target device or simulator. Ideally, use an iPhone with iOS 14.0 or later for the best experience.

4. Press `Cmd + R` to build and run the project on your selected device or simulator.

5. Play the game and enjoy! If you wish to display FPS and node count, press `Cmd + F` to toggle the debug information.

## User Interface

![Flappy Bird Game](img/ios-ui.png)
![Flappy Bird Game](../img/ios-ui.png)

## How to Play

Expand All @@ -61,12 +64,12 @@ To contribute to Flappy Bird Game Clone, follow these steps:

## License

Distributed under the MIT License. See `LICENSE.md` for more information.
This project is distributed under the MIT License. See [LICENSE](../LICENSE) for more information.

## Acknowledgements

- [Original Flappy Bird Game](https://en.wikipedia.org/wiki/Flappy_Bird)
- [SpriteKit Documentation](https://developer.apple.com/documentation/spritekit)
- [Swift Programming Language](https://swift.org/documentation/)

---
---

0 comments on commit b0786e3

Please sign in to comment.