Skip to main content

No project description provided

Project description

Status: Maintenance (expect bug fixes and minor updates)

Gym Retro

Gym Retro lets you turn classic video games into Gym environments for reinforcement learning and comes with integrations for ~1000 games. It uses various emulators that support the Libretro API, making it fairly easy to add new emulators.

Supported platforms:

  • Windows 7, 8, 10
  • macOS 10.13 (High Sierra), 10.14 (Mojave)
  • Linux (manylinux1)

Supported Pythons:

  • 3.6
  • 3.7
  • 3.8

Each game integration has files listing memory locations for in-game variables, reward functions based on those variables, episode end conditions, savestates at the beginning of levels and a file containing hashes of ROMs that work with these files.

Please note that ROMs are not included and you must obtain them yourself. Most ROM hashes are sourced from their respective No-Intro SHA-1 sums.


Documentation is available at

You should probably start with the Getting Started Guide.





Emulated Systems

  • Atari
    • Atari2600 (via Stella)
  • NEC
    • TurboGrafx-16/PC Engine (via Mednafen/Beetle PCE Fast)
  • Nintendo
    • Game Boy/Game Boy Color (via gambatte)
    • Game Boy Advance (via mGBA)
    • Nintendo Entertainment System (via FCEUmm)
    • Super Nintendo Entertainment System (via Snes9x)
  • Sega
    • GameGear (via Genesis Plus GX)
    • Genesis/Mega Drive (via Genesis Plus GX)
    • Master System (via Genesis Plus GX)

See for information on the licenses of the individual cores.

Included ROMs

The following non-commercial ROMs are included with Gym Retro for testing purposes:


Please cite using the following BibTeX entry:

  title={Gotta Learn Fast: A New Benchmark for Generalization in RL},
  author={Nichol, Alex and Pfau, Vicki and Hesse, Christopher and Klimov, Oleg and Schulman, John},
  journal={arXiv preprint arXiv:1804.03720},

Project details

Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

gym_retro-0.8.0-cp38-cp38-win_amd64.whl (152.0 MB view hashes)

Uploaded CPython 3.8 Windows x86-64

gym_retro-0.8.0-cp38-cp38-manylinux1_x86_64.whl (161.9 MB view hashes)

Uploaded CPython 3.8

gym_retro-0.8.0-cp38-cp38-macosx_10_13_x86_64.whl (146.1 MB view hashes)

Uploaded CPython 3.8 macOS 10.13+ x86-64

gym_retro-0.8.0-cp37-cp37m-win_amd64.whl (152.0 MB view hashes)

Uploaded CPython 3.7m Windows x86-64

gym_retro-0.8.0-cp37-cp37m-manylinux1_x86_64.whl (162.0 MB view hashes)

Uploaded CPython 3.7m

gym_retro-0.8.0-cp37-cp37m-macosx_10_13_x86_64.whl (146.1 MB view hashes)

Uploaded CPython 3.7m macOS 10.13+ x86-64

gym_retro-0.8.0-cp36-cp36m-win_amd64.whl (152.0 MB view hashes)

Uploaded CPython 3.6m Windows x86-64

gym_retro-0.8.0-cp36-cp36m-manylinux1_x86_64.whl (162.0 MB view hashes)

Uploaded CPython 3.6m

gym_retro-0.8.0-cp36-cp36m-macosx_10_13_x86_64.whl (146.1 MB view hashes)

Uploaded CPython 3.6m macOS 10.13+ x86-64

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