Skip to main content

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 files for AutoROM.accept-rom-license 0.6.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for AutoROM.accept-rom-license 0.6.1
File Size Uploaded
AutoROM.accept-rom-license-0.6.1.tar.gz 434.7 kB Details

Release files / AutoROM.accept-rom-license-0.6.1.tar.gz

Download URL AutoROM.accept-rom-license-0.6.1.tar.gz
Size 434.7 kB
Tags Source
SHA-256 checksum
How to use checksums
0c905a708d634a076f686802f672817d3585259ce3be0bde8713a4fb59e3159e
BLAKE2b-256 checksum
How to use checksums
a167cc207fe30615001ce713e58dd975124985dc6f7e5ac1141f8bb342ebf3fe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.6

Release history Release notifications | RSS feed

This release

0.6.1 This release

1 release file

0.6.0

1 release file

0.5.5

1 release file

0.5.4

1 release file

0.5.3

1 release file

0.5.2

1 release file

0.5.1

1 release file

0.5.0

1 release file

0.4.2

1 release file

0.4.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page