# GymNESium
GymNESium is a NES Gymnasium environment based on the [cynes](https://github.com/Youlixx/cynes) emulator.
# Installation
The preferred installation of `GymNESium` is from `pip`:
```shell
pip install gymnesium
```
# Usage
Import the module
```
from gymnesium import NESEnv
```
The step function is stubbed and should be implemented in your environment. For an example of this see: [MTPO-RL]()
# Disclaimer
**This project is provided for educational purposes only. It is not
affiliated with and has not been approved by Nintendo.**
Raw data
{
"_id": null,
"home_page": "https://github.com/Hal609/GymNESium",
"name": "gymnesium",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "NES Emulator OpenAI-Gym Gymnasium Reinforcement-Learning-Environment",
"author": "Hal Kolb",
"author_email": "hal@kolb.co.uk",
"download_url": null,
"platform": null,
"description": "# GymNESium\n\nGymNESium is a NES Gymnasium environment based on the [cynes](https://github.com/Youlixx/cynes) emulator.\n\n# Installation\n\nThe preferred installation of `GymNESium` is from `pip`:\n\n```shell\npip install gymnesium\n```\n\n# Usage\n\nImport the module\n```\nfrom gymnesium import NESEnv\n```\nThe step function is stubbed and should be implemented in your environment. For an example of this see: [MTPO-RL]()\n\n# Disclaimer\n\n**This project is provided for educational purposes only. It is not\naffiliated with and has not been approved by Nintendo.**\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An NES Gymnasium Environment",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/Hal609/GymNESium"
},
"split_keywords": [
"nes",
"emulator",
"openai-gym",
"gymnasium",
"reinforcement-learning-environment"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f37c60c60d49de549f3eb9eb89b6b69eaae46712442cc87f67d279d6b2fcbb34",
"md5": "58847b10b04e8b945cc31e3d6c590205",
"sha256": "490990550a4b4ab6b9b7c19a284139c5a40bed6248ffb2105cb91d374f1fc803"
},
"downloads": -1,
"filename": "gymnesium-0.1.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "58847b10b04e8b945cc31e3d6c590205",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 6224,
"upload_time": "2025-01-07T13:54:22",
"upload_time_iso_8601": "2025-01-07T13:54:22.903385Z",
"url": "https://files.pythonhosted.org/packages/f3/7c/60c60d49de549f3eb9eb89b6b69eaae46712442cc87f67d279d6b2fcbb34/gymnesium-0.1.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-07 13:54:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Hal609",
"github_project": "GymNESium",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "numpy",
"specs": [
[
">=",
"1.18.5"
]
]
},
{
"name": "cynes",
"specs": [
[
">=",
"0.1.0"
]
]
},
{
"name": "gymnasium",
"specs": [
[
">=",
"1.0.0"
]
]
}
],
"lcname": "gymnesium"
}
JSON
