MAMEToolkit 1.0.2

MAME RL算法训练工具包

关于

这个python库有潜力在几乎所有的街机游戏上训练你的强化学习算法。它目前在Linux系统上可用，并且可以作为mame的包装器。工具包允许您的算法逐步完成游戏，同时接收帧数据和用于跟踪游戏状态的内部内存地址值，以及发送与游戏交互的操作。

安装

您可以使用pip安装库，只需运行：

pip install MAMEToolkit

免责声明：我们无法为您提供任何游戏ROM。获取游戏rom进行仿真是用户的法律责任。此库只能用于非商业研究目的。

有一些免费的rom可在：[https://www.mamedev.org/roms/]

街头斗士随机代理演示

该工具包目前已应用于街头斗士iii第三次打击：为未来而战（日本990608，没有光盘），但可以修改为任何游戏可用的妈妈。下面演示如何为街头斗士环境编写随机代理。

importrandomfromMAMEToolkit.sf_environmentimportEnvironmentroms_path="roms/"# Replace this with the path to your ROMsenv=Environment("env1",roms_path)env.start()whileTrue:move_action=random.randint(0,8)attack_action=random.randint(0,9)frames,reward,round_done,stage_done,game_done=env.step(move_action,attack_action)ifgame_done:env.new_game()elifstage_done:env.next_stage()elifround_done:env.next_round()

工具包还支持hogwild培训：

frommultiprocessingimportProcessimportrandomfromMAMEToolkit.sf_environmentimportEnvironmentdefrun_env(worker_id,roms_path):env=Environment(f"env{worker_id}",roms_path)env.start()whileTrue:move_action=random.randint(0,8)attack_action=random.randint(0,9)frames,reward,round_done,stage_done,game_done=env.step(move_action,attack_action)ifgame_done:env.new_game()elifstage_done:env.next_stage()elifround_done:env.next_round()workers=8# Environments must be created outside of the threadsroms_path="roms/"# Replace this with the path to your ROMsthreads=[Process(target=run_env,args=(i,roms_path))foriinrange(workers)][thread.start()forthreadinthreads]

设置自己的游戏环境

游戏ID
要创建游戏的模拟，您必须首先拥有正在模拟的游戏的rom，并知道mame使用的游戏id，例如，对于这个版本的街头斗士，它是"sfii3n"。 您的游戏ID可以通过运行：

fromMAMEToolkit.emulatorimportsee_gamessee_games()

这将打开mame模拟器。你可以搜索游戏列表来找到你想要的。游戏的ID始终位于游戏标题末尾的括号中。

内存地址
使用工具包与仿真器本身进行交互并不需要太多时间，但是挑战来自于找到与所关心的内部状态相关联的内存地址值，以及使用环境类跟踪所述状态。 可以使用mame作弊调试器跟踪游戏的内部内存状态，该调试器允许您跟踪游戏的内存地址值随时间的变化。

作弊调试器可以使用以下命令运行：

fromMAMEToolkit.emulatorimportrun_cheat_debuggerroms_path="roms/"# Replace this with the path to your ROMsgame_id="sfiii3n"run_cheat_debugger(roms_path,game_id)

有关使用调试器的信息，请参阅本教程的内存转储部分[https://www.dorkbotpdx.org/blog/skinny/use_mames_debugger_to_reverse_engineer_and_extend_old_games]

一旦确定了要跟踪的内存地址，就可以使用：

fromMAMEToolkit.emulatorimportEmulatorfromMAMEToolkit.emulatorimportAddressroms_path="roms/"# Replace this with the path to your ROMsgame_id="sfiii3n"memory_addresses={"fighting":Address('0x0200EE44','u8'),"winsP1":Address('0x02011383','u8'),"winsP2":Address('0x02011385','u8'),"healthP1":Address('0x02068D0B','s8'),"healthP2":Address('0x020691A3','s8')}emulator=Emulator("env1",roms_path,"sfiii3n",memory_addresses)

这将立即启动仿真，并在工具包链接到仿真进程时停止仿真。

单步执行模拟器 链接工具包后，您可以使用step函数来单步执行仿真器：

data=emulator.step([])frame=data["frame"]is_fighting=data["fighting"]player1_wins=data["winsP1"]player2_wins=data["winsP2"]player1_health=data["healthP1"]player2_health=data["healthP2"]

step函数以numpy矩阵的形式返回帧数据，以及该时间步的所有内存地址整数值。

发送输入 要向模拟器发送操作，还需要确定游戏支持哪些输入端口和字段。例如，当街头斗士要插入硬币时，需要以下代码：

fromMAMEToolkit.emulatorimportActioninsert_coin=Action(':INPUTS','Coin 1')data=emulator.step([insert_coin])

要确定哪些端口可用，请使用list actions命令：

fromMAMEToolkit.emulatorimportlist_actionsroms_path="roms/"# Replace this with the path to your ROMsgame_id="sfiii3n"print(list_actions(roms_path,game_id))

哪个for street fighter返回列表，其中包含可用于向step函数发送操作的所有端口和字段：

pip install MAMEToolkit

pip install MAMEToolkit