状态: 维护中（预计进行错误修复和小版本更新）

Gym Retro

Gym Retro 可以将经典电子游戏转换为适用于强化学习的 Gym 环境，并支持约 1000 款游戏的集成。它使用支持 Libretro API 的多种模拟器，因此添加新模拟器相对容易。

支持的平台：

• Windows 7、8、10
• macOS 10.13（High Sierra）、10.14（Mojave）
• Linux（manylinux1）

CPU 需具备 SSSE3 或更高指令集

支持的 Python 版本：

• 3.6
• 3.7
• 3.8

每款游戏的集成都包含用于记录游戏内变量的内存地址文件、基于这些变量的奖励函数、回合结束条件、关卡开始时的存档点，以及与这些文件兼容的 ROM 哈希值列表。

请注意，ROM 文件不随软件一起提供，您需要自行获取。大多数 ROM 哈希值来源于各自的 No-Intro SHA-1 校验和。

文档

文档可在 https://retro.readthedocs.io/en/latest/ 查阅。

建议从入门指南开始阅读。

贡献

请参阅 CONTRIBUTING.md

更改日志

请参阅 CHANGES.md

模拟系统

• Atari
  • Atari2600（通过 Stella 模拟）
• NEC
  • TurboGrafx-16/PC Engine（通过 Mednafen/Beetle PCE Fast 模拟）
• Nintendo
  • Game Boy/Game Boy Color（通过 gambatte 模拟）
  • Game Boy Advance（通过 mGBA 模拟）
  • 任天堂娱乐系统（通过 FCEUmm 模拟）
  • 超级任天堂娱乐系统（通过 Snes9x 模拟）
• Sega
  • GameGear（通过 Genesis Plus GX 模拟）
  • Genesis/Mega Drive（通过 Genesis Plus GX 模拟）
  • Master System（通过 Genesis Plus GX 模拟）

有关各个核心许可证的信息，请参阅 LICENSES.md。

包含的 ROM

以下非商业 ROM 随 Gym Retro 一同提供，用于测试目的：

• Anthrox 的 [the 128 sine-dot]（http://www.pouet.net/prod.php?which=2762）
• Ben Ryves 的 [Sega Tween]（https://pdroms.de/files/gamegear/sega-tween）
• Blind IO 的 [Happy 10!]（http://www.pouet.net/prod.php?which=52716）
• Chris Covell 的 [512-Colour Test Demo]（https://pdroms.de/files/pcengine/512-colour-test-demo）
• Dekadence 的 [Dekadrive]（http://www.pouet.net/prod.php?which=67142）
• Derek Ledbetter 的 [Automaton]（https://pdroms.de/files/atari2600/automaton-minigame-compo-2003）
• dox 的 [Fire]（http://privat.bahnhof.se/wb800787/gb/demo/64/）
• dr88 的 [FamiCON intro]（http://www.pouet.net/prod.php?which=53497）
• Electrokinesis 的 [Airstriker]（https://pdroms.de/genesis/airstriker-v1-50-genesis-game）
• Vantage 的 [Lost Marbles]（https://pdroms.de/files/gameboyadvance/lost-marbles）

引用

请使用以下 BibTeX 条目进行引用：

@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}
}

Gym Retro 快速上手指南

Gym Retro 是一个将经典电子游戏转化为 Gym 环境的工具库，专为强化学习设计。它内置了约 1000 款游戏的集成，支持多种通过 Libretro API 运行的模拟器。

注意：本项目目前处于维护模式（仅修复 Bug 和 minor 更新）。本文档不包含 ROM 文件，您需要自行获取合法的游戏 ROM。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

系统要求

• 操作系统:
  • Windows 7, 8, 10
  • macOS 10.13 (High Sierra) 或 10.14 (Mojave)
  • Linux (manylinux1)
• CPU: 必须支持 SSSE3 指令集或更高版本。

Python 版本

支持以下 Python 版本：

• 3.6
• 3.7
• 3.8

前置依赖

建议先安装基础的 Gym 库（虽然 gym-retro 通常会处理依赖，但显式安装更稳妥）：

pip install gym

安装步骤

推荐使用 pip 进行安装。国内开发者若遇到网络问题，可使用清华或阿里镜像源加速。

标准安装

pip install gym-retro

使用国内镜像源加速（推荐）

pip install gym-retro -i https://pypi.tuna.tsinghua.edu.cn/simple

基本使用

安装完成后，您可以立即加载支持的游戏并开始训练。以下是最简单的使用示例，展示如何创建一个环境并运行随机动作。

代码示例

import retro

# 1. 创建环境
# 参数格式通常为：Game-ConsoleRegion
env = retro.make(game='Airstriker-Genesis')

# 2. 重置环境
obs = env.reset()

# 3. 运行一个简单的循环
done = False
while not done:
    # 生成随机动作
    action = env.action_space.sample()
    
    # 执行动作
    obs, reward, done, info = env.step(action)
    
    # 渲染画面（可选，需要本地显示支持）
    env.render()

env.close()

关键说明

• 游戏名称: retro.make() 中的游戏字符串需严格匹配内置支持列表（如 Airstriker-Genesis）。
• ROM 文件: 首次运行特定游戏时，程序会提示缺少 ROM。您需将对应的 ROM 文件放置在指定目录（通常由 retro.data.get_game_path() 指示），且 ROM 的 SHA-1 哈希值需与库中记录的匹配（大多基于 No-Intro 数据库）。
• 文档: 更多高级用法（如自定义奖励函数、内存地址监控）请参阅官方文档：https://retro.readthedocs.io/en/latest/getting_started.html