Metadata-Version: 2.1
Name: gym-minecraft-pygame
Version: 0.1.0
Summary: Gym Minecraft environment using Pygame
Home-page: https://github.com/whitemech/gym-minecraft-pygame.git
Author: Marco Favorito, Luca Iocchi
License: Apache License 2.0
Keywords: environment,agent,rl,openaigym,openai-gym,gym,minecraft
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: gym
Requires-Dist: pygame
Requires-Dist: numpy

# gym-minecraft-pygame

[![PyPI](https://img.shields.io/pypi/v/gym-minecraft-pygame)](https://pypi.org/project/gym-minecraft-pygame/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/gym-minecraft-pygame)
[![](https://img.shields.io/pypi/l/gym-minecraft-pygame)](https://github.com/whitemech/gym-minecraft-pygame/blob/master/LICENSE)
![PyPI - Downloads](https://img.shields.io/pypi/dm/gym-minecraft-pygame)
![CI](https://github.com/whitemech/gym-minecraft-pygame/workflows/CI/badge.svg)
[![codecov](https://codecov.io/gh/whitemech/gym-minecraft-pygame/branch/master/graph/badge.svg)](https://codecov.io/gh/whitemech/gym-minecraft-pygame)


OpenaAI Gym Minecraft-like environment implemented with Pygame

## Links

- GitHub: [https://github.com/whitemech/gym-minecraft-pygame](https://github.com/whitemech/gym-minecraft-pygame)
- PyPI: [https://pypi.org/project/gym-minecraft-pygame/](https://pypi.org/project/gym-minecraft-pygame/)
- Documentation: [https://whitemech.github.io/gym-minecraft-pygame](https://whitemech.github.io/gym-minecraft-pygame)
- Changelog: [https://whitemech.github.io/gym-minecraft-pygame/history/](https://whitemech.github.io/gym-minecraft-pygame/history/)
- Issue Tracker:[https://github.com/whitemech/gym-minecraft-pygame/issues](https://github.com/whitemech/gym-minecraft-pygame/issues)
- Download: [https://pypi.org/project/gym-minecraft-pygame/#files](https://pypi.org/project/gym-minecraft-pygame/#files)


## Install

Install with `pip`:

    pip install gym-minecraft-pygame

Or, install from source:

    git clone https://github.com/whitemech/gym-minecraft-pygame.git
    cd gym-minecraft-pygame
    pip install .

## Development

- clone the repo:
```bash
git clone https://github.com/whitemech/gym-minecraft-pygame.git
cd gym-minecraft-pygame
```

- Create/activate the virtual environment:
```bash
pipenv shell --python=python3.7
```

- Install development dependencies:
```bash
pipenv install --dev
```

## Tests

Run the tests with `tox`:
```bash
tox
```

## Credits

The code is largely inspired by [RLGames](https://github.com/iocchi/RLGames.git)


