Super Mario Bros. for OpenAI Gym
Project description
gym-super-mario-bros
An OpenAI Gym environment for Super Mario Bros. & Super Mario Bros. 2 (Lost Levels) on The Nintendo Entertainment System (NES).
Installation
The preferred installation of gym-super-mario-bros
is from pip
:
pip install gym-super-mario-bros
NES Emulator
gym-super-mario-bros
uses FCEUX to emulate NES games.
Make sure it's installed and in your $PATH
.
Unix
sudo apt-get install fceux
Mac
brew install fceux
Usage
Python
You must import gym_super_mario_bros
before trying to make an environment. This is
because gym environments are registered at runtime.
import gym_super_mario_bros
env = gym_super_mario_bros.make('SuperMarioBros-v0')
done = True
for step in range(5000):
if done:
state = env.reset()
state, reward, done, info = env.step(env.action_space.sample())
env.close()
NOTE: gym_super_mario_bros.make
is just an alias to gym.make
for
convenience.
Command Line
gym_super_mario_bros
feature a command line interface for playing
environments using either the keyboard, or uniform random movement.
gym_super_mario_bros -e <the environment ID to play> -m <`human` or `random`>
NOTE: by default, -e
is set to SuperMarioBros-v0
and -m
is set to
human
.
Environments
These environments allow 3 attempts (lives) to make it through the 32 levels of the game. The environments only send reward-able game-play frames to agents; No cut-scenes, loading screens, etc. are sent from the NES emulator to an agent nor can an agent perform actions during these occurrences. If a cut-scene is not able to be skipped by hacking the NES's RAM, the environment will lock the Python process until the emulator is ready for the next action.
Environment | Game | Frameskip | ROM | Screenshot |
---|---|---|---|---|
SuperMarioBros-v0 |
SMB | 4 | standard | |
SuperMarioBros-v1 |
SMB | 4 | downsample | |
SuperMarioBros-v2 |
SMB | 4 | pixel | |
SuperMarioBros-v3 |
SMB | 4 | rectangle | |
SuperMarioBrosNoFrameskip-v0 |
SMB | 1 | standard | |
SuperMarioBrosNoFrameskip-v1 |
SMB | 1 | downsample | |
SuperMarioBrosNoFrameskip-v2 |
SMB | 1 | pixel | |
SuperMarioBrosNoFrameskip-v3 |
SMB | 1 | rectangle | |
SuperMarioBros2-v0 |
SMB2 | 4 | standard | |
SuperMarioBros2-v1 |
SMB2 | 4 | downsample | |
SuperMarioBros2NoFrameskip-v0 |
SMB2 | 1 | standard | |
SuperMarioBros2NoFrameskip-v1 |
SMB2 | 1 | downsample |
Individual Levels
These environments allow a single attempt (life) to make it through a single level of the game.
Use the template
SuperMarioBros-<world>-<level>-v<version>
where:
<world>
is a number in {1, 2, 3, 4, 5, 6, 7, 8} indicating the world<level>
is a number in {1, 2, 3, 4} indicating the level within a world<version>
is a number in {0, 1, 2, 3} specifying the ROM mode to use- 0: standard ROM
- 1: downsampled ROM
- 2: pixel ROM
- 3: rectangle ROM
NoFrameskip
can be added before the first hyphen to disable frame skip
For example, to play 4-2 on the downsampled ROM, you would use the environment
id SuperMarioBros-4-2-v1
. To disable frame skip you would use
SuperMarioBrosNoFrameskip-4-2-v1
.
Citation
Please cite gym-super-mario-bros
if you use it in your research.
@misc{gym-super-mario-bros,
author = {Christian Kauten},
title = {{S}uper {M}ario {B}ros for {O}pen{AI} {G}ym},
year = {2018},
publisher = {GitHub},
howpublished = {\url{https://github.com/Kautenja/gym-super-mario-bros}},
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for gym_super_mario_bros-2.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3bb2b420b30cfde331f726a4159fee56cb2b8d17df95a4bcb12938bec8642bcf |
|
MD5 | 9651dbf8233e57954aa7d701f515a8e0 |
|
BLAKE2b-256 | 3d3217088c458ff96239c984b51f95773aa46fd6af15fc97bb7f15ce6613c16d |
Hashes for gym_super_mario_bros-2.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3522624d643589448a6702890e39c8beb20d357776f3cc52713426737cdc87d9 |
|
MD5 | 9edc1282a2b49f7dc84e49c579c49b44 |
|
BLAKE2b-256 | 51582329c3b65d5d753203bb2b07127847b3fc6c2ba094595eba5a49dacd2b7b |