An open API service indexing awesome lists of open source software.

https://github.com/bellmano/flappyascii

Flappy ASCII - ASCII-based Flappy Bird game
https://github.com/bellmano/flappyascii

css flappyascii flappybird github-pages html javascript website

Last synced: 2 months ago
JSON representation

Flappy ASCII - ASCII-based Flappy Bird game

Awesome Lists containing this project

README

          

# :bird: Flappy ASCII

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=bellmano_FlappyASCII&metric=coverage)](https://sonarcloud.io/summary/overall?id=bellmano_FlappyASCII)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=bellmano_FlappyASCII&metric=security_rating)](https://sonarcloud.io/summary/overall?id=bellmano_FlappyASCII)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=bellmano_FlappyASCII&metric=sqale_rating)](https://sonarcloud.io/summary/overall?id=bellmano_FlappyASCII)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=bellmano_FlappyASCII&metric=reliability_rating)](https://sonarcloud.io/summary/overall?id=bellmano_FlappyASCII)
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=bellmano_FlappyASCII&metric=bugs)](https://sonarcloud.io/summary/overall?id=bellmano_FlappyASCII)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=bellmano_FlappyASCII&metric=vulnerabilities)](https://sonarcloud.io/summary/overall?id=bellmano_FlappyASCII)
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=bellmano_FlappyASCII&metric=code_smells)](https://sonarcloud.io/summary/overall?id=bellmano_FlappyASCII)

A simple Flappy Bird game rendered entirely with ASCII characters. This project transforms the classic mobile game into a retro DOS-style experience, using only text characters to create the bird, pipes, and environment. The game features both dark and light modes, persistent high scores, and responsive design.

## :video_game: How to Play

- Press **SPACE** to make the bird flap its wings and fly upwards
- The bird automatically falls due to gravity
- Navigate through the gaps between pipes to score points
- Each successful pipe passage increases your score
- If the bird hits a pipe or the ground, the game ends
- Press **R** to restart after game over
- Try to beat your high score, which persists between sessions

## :trophy: GIF from the gameplay

This game is designed to be easily hosted on GitHub Pages. Click [here](https://bellmano.github.io/FlappyASCII) to play the game!

## :test_tube: Running Tests

To run the tests and view coverage:

1. Install the required dev dependency:
```powershell
npm install
```
2. Run the test coverage script:
```powershell
npm run test:coverage
```

This will execute the tests and generate a coverage report.

## :heart: Acknowledgments

This project was inspired by the original Flappy Bird game created by Dong Nguyen. The ASCII rendering approach pays homage to classic DOS-era games while bringing the addictive gameplay of Flappy Bird to a new format.

Enjoy this retro-style version of the classic Flappy Bird game!

## :handshake: Contributing

Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.

## :mega: Issues or Suggestions
Any issues or suggestions, please [create an issue on Github](https://github.com/bellmano/FlappyASCII/issues).

## :coffee: Buy me a coffee
Donations are welcome to appreciate my work and to keep this project alive, but isn't required at all.