Skip to main content

Flappy Bird as a Farama Gymnasium environment.

Project description

Flappy Bird Env

flappy bird

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

pip install flappy-bird-env

Usage

  1. Play it by running
python -m flappy_bird_env

Press space to flap the wings.

  1. Import it to train your RL model
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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flappy-bird-env-0.1.6.tar.gz (20.3 kB view hashes)

Uploaded Source

Built Distribution

flappy_bird_env-0.1.6-py3-none-any.whl (22.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page