<p align="center">
<img src="https://raw.githubusercontent.com/Farama-Foundation/AutoROM/master/autorom-text.png" width="500px"/>
</p>
AutoROM automatically installs Atari ROM files for ALE-Py (which Gymnasium Depends on) and multi-agent-ALE (which PettingZoo depends on, but will replaced by ALE-Py in the future).
AutoROM automatically downloads the needed Atari ROMs from ROM hosting websites into the ALE-Py folder and Multi-Agent-ALE-py folder in a very simple manner:
```
pip install autorom
AutoROM
```
To specify a specific installation directory for your ROMs, use the `--install-dir` command line flag.
```
AutoROM --install-dir /path/to/install
```
This will install ROMs at "/path/to/install/ROM/".
Furthermore, you can accept the license agreement from the command-line with:
```
AutoROM --accept-license
```
OR when you are installing the Python package by specifying the extra `accept-rom-license`:
```
pip install "autorom[accept-rom-license]"
```
This command would download the ROMs during installation and make them immediately discoverable to `ale-py`.
## Packaging
AutoROM requires that you package it as a source distribution. We have a special script to build all our source distributions, i.e., `./scripts/build-dist.sh`. The resulting source distributions will be located in `dist/`. You can directly install this with `pip` even including the extra `accept-rom-license`. For example,
```
pip install --find-links dist/ --no-cache-dir AutoROM[accept-rom-license]
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Farama-Foundation/AutoROM",
"name": "AutoROM.accept-rom-license",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Reinforcement Learning,game,RL,AI,gym",
"author": "Farama Foundation",
"author_email": "contact@farama.org",
"download_url": "https://files.pythonhosted.org/packages/a1/67/cc207fe30615001ce713e58dd975124985dc6f7e5ac1141f8bb342ebf3fe/AutoROM.accept-rom-license-0.6.1.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/Farama-Foundation/AutoROM/master/autorom-text.png\" width=\"500px\"/>\n</p>\n\n\nAutoROM automatically installs Atari ROM files for ALE-Py (which Gymnasium Depends on) and multi-agent-ALE (which PettingZoo depends on, but will replaced by ALE-Py in the future).\n\nAutoROM automatically downloads the needed Atari ROMs from ROM hosting websites into the ALE-Py folder and Multi-Agent-ALE-py folder in a very simple manner:\n```\npip install autorom\nAutoROM\n```\n\nTo specify a specific installation directory for your ROMs, use the `--install-dir` command line flag.\n```\nAutoROM --install-dir /path/to/install\n```\nThis will install ROMs at \"/path/to/install/ROM/\".\n\nFurthermore, you can accept the license agreement from the command-line with:\n```\nAutoROM --accept-license\n```\nOR when you are installing the Python package by specifying the extra `accept-rom-license`:\n```\npip install \"autorom[accept-rom-license]\"\n```\nThis command would download the ROMs during installation and make them immediately discoverable to `ale-py`.\n\n## Packaging\n\nAutoROM requires that you package it as a source distribution. We have a special script to build all our source distributions, i.e., `./scripts/build-dist.sh`. The resulting source distributions will be located in `dist/`. You can directly install this with `pip` even including the extra `accept-rom-license`. For example,\n\n```\npip install --find-links dist/ --no-cache-dir AutoROM[accept-rom-license]\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Automated installation of Atari ROMs for Gym/ALE-Py",
"version": "0.6.1",
"split_keywords": [
"reinforcement learning",
"game",
"rl",
"ai",
"gym"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a167cc207fe30615001ce713e58dd975124985dc6f7e5ac1141f8bb342ebf3fe",
"md5": "ea2008bc9e1328019be1173ecc00cb69",
"sha256": "0c905a708d634a076f686802f672817d3585259ce3be0bde8713a4fb59e3159e"
},
"downloads": -1,
"filename": "AutoROM.accept-rom-license-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "ea2008bc9e1328019be1173ecc00cb69",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 434689,
"upload_time": "2023-04-06T15:29:13",
"upload_time_iso_8601": "2023-04-06T15:29:13.295017Z",
"url": "https://files.pythonhosted.org/packages/a1/67/cc207fe30615001ce713e58dd975124985dc6f7e5ac1141f8bb342ebf3fe/AutoROM.accept-rom-license-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-06 15:29:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Farama-Foundation",
"github_project": "AutoROM",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "autorom.accept-rom-license"
}
JSON
