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

IMPORTANT: We do not have official support for Windows. However, if you are on Windows and encounter a DLL import error, you may need to install OpenSSL v1.1.1S.

IMPORTANT: Libtorrent, which AutoROM uses, requires pip version >20.0 to be installed. On M1 macs, this may require updating your pip installation.

IMPORTANT: For now, an alternative solution to the above known issues is to use AutoROM v0.4.2, which uses a different source for where the ROMs are sourced from.

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.5.2.tar.gz (12.1 kB view hashes)

Uploaded Source

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