Skip to main content

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]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

AutoROM.accept-rom-license-0.6.1.tar.gz (434.7 kB view details)

Uploaded Source

File details

Details for the file AutoROM.accept-rom-license-0.6.1.tar.gz.

File metadata

File hashes

Hashes for AutoROM.accept-rom-license-0.6.1.tar.gz
Algorithm Hash digest
SHA256 0c905a708d634a076f686802f672817d3585259ce3be0bde8713a4fb59e3159e
MD5 ea2008bc9e1328019be1173ecc00cb69
BLAKE2b-256 a167cc207fe30615001ce713e58dd975124985dc6f7e5ac1141f8bb342ebf3fe

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page