<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",
"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/5b/22/bce7442af5e6961e5a7434e0aeb64eba17c6e1eff11fc45613d68d22ce60/AutoROM-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": "02e190b168a5dbc89a4e9b2206a99238f3ea3fc281052bb2dc236d4aa15e5e87",
"md5": "b082bc4fcf2e3d631a35594d5698e015",
"sha256": "e734fdad23dc8e48897de013803eba3c9e109e028d5463a4817346f7f669604f"
},
"downloads": -1,
"filename": "AutoROM-0.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b082bc4fcf2e3d631a35594d5698e015",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9435,
"upload_time": "2023-04-06T15:29:06",
"upload_time_iso_8601": "2023-04-06T15:29:06.995386Z",
"url": "https://files.pythonhosted.org/packages/02/e1/90b168a5dbc89a4e9b2206a99238f3ea3fc281052bb2dc236d4aa15e5e87/AutoROM-0.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5b22bce7442af5e6961e5a7434e0aeb64eba17c6e1eff11fc45613d68d22ce60",
"md5": "34c2af46ca9983a561a7d053865c069e",
"sha256": "6eff1f1b96a9d519577437f71d96a8d3b896238eca3433a8e69c5c92f6de3231"
},
"downloads": -1,
"filename": "AutoROM-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "34c2af46ca9983a561a7d053865c069e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9204,
"upload_time": "2023-04-06T15:29:10",
"upload_time_iso_8601": "2023-04-06T15:29:10.223467Z",
"url": "https://files.pythonhosted.org/packages/5b/22/bce7442af5e6961e5a7434e0aeb64eba17c6e1eff11fc45613d68d22ce60/AutoROM-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-06 15:29:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Farama-Foundation",
"github_project": "AutoROM",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "autorom"
}
JSON
