Status: Maintenance (expect bug fixes and minor updates)
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:
Supported Pythons:
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 https://retro.readthedocs.io/en/latest/
You should probably start with the Getting Started Guide.
See LICENSES.md for information on the licenses of the individual cores.
The following non-commercial ROMs are included with Gym Retro for testing purposes:
Please cite using the following BibTeX entry:
@article{nichol2018retro,
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},
year={2018}
}
FAQs
Unknown package
We found that gym-retro demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.