Hot Wheels Gymnasium Environment

By: Zack Beucler

HotWheelsGym is a gymnasium environment for the 2005 GBA game Hot Wheels Stunt Track Challenge.

Notable features

• Multiple Tracks: 10 tracks to race on.
• Two game modes: single where you race alone and multi where you race against 3 NPCs.

Installation

git clone https://github.com/zbeucler2018/HotWheelsGym.git
cd HotWheelsGym
pip install -e . # [train,dev]

Basic usage

import HotWheelsGym
from HotWheelsGym import HotWheelsEnv, Tracks, RaceModes

# only need to import the ROM once
HotWheelsGym.import_rom("path/to/rom.gba")

env = HotWheelsEnv(
  track=Tracks.Dino_Boneyard,
  mode=RaceModes.MULTI,
  laps=3
)

# OR

env = HotWheelsGym.make("HWSTC-dino_boneyard-multi-3")

Environment

Use the template

HWSTC-<track>-<mode>-<laps>

where:

• <track> is the name of the track
• <mode> is the game mode {single, multi}
• <laps> is the total amount of laps {1, 2, 3}

Track Varients

Name	Map
trex_valley
dino_boneyard
black_widows_nest
insect_hive
monsters_of_the_deep
whiteskull_cliffs
jungle_snakepit
gator_forest
satellite_mission
solar_strip
fire_mountain
volcano_battle

Game Mode Varients

Mode	Description
single	Single player. Race by yourself.
multi	Multi player. Race against 3 NPCs.

Information returned from the environment

• The info dict returned by the step function contains the following keys:

Key	Type	Description
boost	int	The current amount of boost the agent has. 980 is the max and will allow the agent to use the boost.
hit_wall	bool	True if the agent currently collided with a wall, False if not.
lap	int	The current lap the agent is on.
checkpoint	int	The checkpoint the agent is currently at on the track.
rank	int	The current rank of the agent in the race. multi mode only.
score	int	The current score of the agent.
speed	int	The agent's current (estimated) speed.

Checkpoints per lap

Track	Checkpoints per lap
trex_valley	316
dino_boneyard	342
black_widows_nest	395
insect_hive	380
monsters_of_the_deep	342
whiteskull_cliffs	340
jungle_snakepit	465
gator_forest	512
satellite_mission	376
solar_strip	325
fire_mountain	465
volcano_battle	495