Automated installation of Atari ROMs for Gym/ALE-Py
Project description
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]
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file AutoROM-0.6.1.tar.gz.
File metadata
- Download URL: AutoROM-0.6.1.tar.gz
- Upload date:
- Size: 9.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6eff1f1b96a9d519577437f71d96a8d3b896238eca3433a8e69c5c92f6de3231 |
|
| MD5 | 34c2af46ca9983a561a7d053865c069e |
|
| BLAKE2b-256 | 5b22bce7442af5e6961e5a7434e0aeb64eba17c6e1eff11fc45613d68d22ce60 |
Provenance
File details
Details for the file AutoROM-0.6.1-py3-none-any.whl.
File metadata
- Download URL: AutoROM-0.6.1-py3-none-any.whl
- Upload date:
- Size: 9.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e734fdad23dc8e48897de013803eba3c9e109e028d5463a4817346f7f669604f |
|
| MD5 | b082bc4fcf2e3d631a35594d5698e015 |
|
| BLAKE2b-256 | 02e190b168a5dbc89a4e9b2206a99238f3ea3fc281052bb2dc236d4aa15e5e87 |
