https://github.com/robertoschiavone/flappy-bird-env
Flappy Bird as a Farama Gymnasium environment.
https://github.com/robertoschiavone/flappy-bird-env
flappy-bird gymnasium reinforcement-learning
Last synced: 24 days ago
JSON representation
Flappy Bird as a Farama Gymnasium environment.
- Host: GitHub
- URL: https://github.com/robertoschiavone/flappy-bird-env
- Owner: robertoschiavone
- License: mit
- Created: 2023-02-27T16:29:01.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-01T12:02:35.000Z (about 2 years ago)
- Last Synced: 2024-08-09T10:39:14.107Z (about 1 year ago)
- Topics: flappy-bird, gymnasium, reinforcement-learning
- Language: Python
- Homepage:
- Size: 2.45 MB
- Stars: 20
- Watchers: 1
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flappy Bird Env
Action Space
Discrete(2)
Observation Shape
(800, 576, 3)
Observation High
255
Observation Low
0
Import
import flappy_bird_env # noqa
gymnasium.make("FlappyBird-v0")
## Description
Flappy Bird as a Farama Gymnasium environment.
### Installation
```bash
pip install flappy-bird-env
```
### Usage
1. Play it by running
```bash
python -m flappy_bird_env
```
Press `space` to flap the wings.
2. Import it to train your RL model
```python
import flappy_bird_env # noqa
env = gymnasium.make("FlappyBird-v0")
```
The package relies on ```import``` side-effects to register the environment
name so, even though the package is never explicitly used, its import is
necessary to access the environment.
## Action Space
Flappy Bird has the action space `Discrete(2)`.
| Value | Meaning |
|-------|------------|
| 0 | NOOP |
| 1 | flap wings |
## Observation Space
The observation will be the RGB image that is displayed to a human player with
observation space `Box(low=0, high=255, shape=(800, 576, 3), dtype=np.uint8)`.
### Rewards
You get `+1` every time you pass a pipe, otherwise `+0.001` for each frame where you
don't collide against the top and bottom bounds, or against a pipe.
## Version History
- v0: initial version release