Metadata-Version: 2.1
Name: boxing_gym
Version: 0.1.11
Summary: An Mike Tyson's Punch Out!! Gymnasium Environment
Home-page: https://github.com/Hal609/BoxingGym
Author: Hal Kolb
Author-email: hal@kolb.co.uk
License: MIT
Keywords: NES Emulator OpenAI-Gym Gymnasium Punch-Out Reinforcement-Learning-Environment
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Emulators
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: numpy>=1.18.5
Requires-Dist: gymnasium>=1.0.0
Requires-Dist: opencv-python>=4.10.0.84
Requires-Dist: gymnesium>=0.1.1

# Boxing Gym

boxing_gym is a Mike Tyson's Punch Out!! Gymnasium environment using [GymNESium](https://github.com/Hal609/GymNESium).

# Installation

The preferred installation of `boxing_gym` is from `pip`:

```shell
pip install boxing_gym
```

# Usage

Import the module
```
from boxing_gym import make_env
```

Create the environment
```
env = make_env()
```

Step the environment
```
env.step_async(action)
observation_, reward, done_, trun_, info = env.step_wait()
```

For a full example see: [MTPO-RL](https://github.com/Hal609/GymNESium)

# Disclaimer

**This project is provided for educational purposes only. It is not
affiliated with and has not been approved by Nintendo.**
