Metadata-Version: 2.1
Name: flappy-bird-env
Version: 0.1.5
Summary: Flappy Bird as a Farama Gymnasium environment.
Author-email: Roberto Schiavone <hello@robertoschiavone.io>
Maintainer-email: Roberto Schiavone <hello@robertoschiavone.io>
License: MIT License
        
        Copyright (c) 2023 Roberto Schiavone
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: homepage, https://github.com/robertoschiavone/flappy-bird-env
Project-URL: documentation, https://github.com/robertoschiavone/flappy-bird-env
Project-URL: repository, https://github.com/robertoschiavone/flappy-bird-env.git
Project-URL: changelog, https://github.com/robertoschiavone/flappy-bird-env/releases
Keywords: flappy-bird,gymnasium,reinforcement-learning
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE

# Flappy Bird Env

<p align="center">
    <img src="https://raw.githubusercontent.com/robertoschiavone/flappy-bird-env/main/flappy-bird.gif"
        alt="flappy bird"/>
</p>

<table>
    <tbody>
        <tr>
            <td>Action Space</td>
            <td>Discrete(2)</td>
        </tr>
        <tr>
            <td>Observation Shape</td>
            <td>(800, 576, 3)</td>
        </tr>
        <tr>
            <td>Observation High</td>
            <td>255</td>
        </tr>
        <tr>
            <td>Observation Low</td>
            <td>0</td>
        </tr>
        <tr>
            <td>Import</td>
            <td>import flappy_bird_env  # noqa<br/>gymnasium.make("FlappyBird-v0")</td>
        </tr>
    </tbody>
</table>

## 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
