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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file flappy-bird-env-0.1.6.tar.gz.

File metadata

  • Download URL: flappy-bird-env-0.1.6.tar.gz
  • Upload date:
  • Size: 20.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for flappy-bird-env-0.1.6.tar.gz
Algorithm Hash digest
SHA256 b521619e1979bdc4e60c83d4e78674d2372dbfe2def8879cd1598cf1aefde098
MD5 219cf192393ed19a609487ecff8c442d
BLAKE2b-256 d2a932775fffb721e5116f2914bc3bb39cbb12d4ed894086eff1f89454e5a826

See more details on using hashes here.

File details

Details for the file flappy_bird_env-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for flappy_bird_env-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 bd63856526dfe7af1a0308e6f5307d4827a2f47161454b3a29750dc2f421b185
MD5 f3c59b3fd704308abde0fc1330c4099c
BLAKE2b-256 1b4e5d28fdd768c48e7b99469ea058b7bf8e7dcc5e8f4a2bd1d435b786b508d0

See more details on using hashes here.

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