1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
/* *****************************************************************************
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License version 2
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* *****************************************************************************
* A.L.E (Arcade Learning Environment)
* Copyright (c) 2009-2013 by Yavar Naddaf, Joel Veness, Marc G. Bellemare and
* the Reinforcement Learning and Artificial Intelligence Laboratory
* Released under the GNU General Public License; see License.txt for details.
*
* Based on: Stella -- "An Atari 2600 VCS Emulator"
* Copyright (c) 1995-2007 by Bradford W. Mott and the Stella team
*
* *****************************************************************************
*/
#include "Adventure.hpp"
#include "../RomUtils.hpp"
namespace ale {
AdventureSettings::AdventureSettings() { reset(); }
/* create a new instance of the rom */
RomSettings* AdventureSettings::clone() const {
RomSettings* rval = new AdventureSettings();
*rval = *this;
return rval;
}
/* process the latest information from ALE */
void AdventureSettings::step(const System& system) {
int chalice_status = readRam(&system, 0xB9);
bool chalice_in_yellow_castle = chalice_status == 0x12;
if (chalice_in_yellow_castle) {
m_reward = 1;
}
int player_status = readRam(&system, 0xE0);
bool player_eaten = player_status == 2;
m_terminal = player_eaten || chalice_in_yellow_castle;
}
/* is end of game */
bool AdventureSettings::isTerminal() const { return m_terminal; }
/* get the most recently observed reward */
reward_t AdventureSettings::getReward() const { return m_reward; }
/* is an action part of the minimal set? */
bool AdventureSettings::isMinimal(const Action& a) const {
switch (a) {
case PLAYER_A_NOOP:
case PLAYER_A_FIRE:
case PLAYER_A_UP:
case PLAYER_A_RIGHT:
case PLAYER_A_LEFT:
case PLAYER_A_DOWN:
case PLAYER_A_UPRIGHT:
case PLAYER_A_UPLEFT:
case PLAYER_A_DOWNRIGHT:
case PLAYER_A_DOWNLEFT:
case PLAYER_A_UPFIRE:
case PLAYER_A_RIGHTFIRE:
case PLAYER_A_LEFTFIRE:
case PLAYER_A_DOWNFIRE:
case PLAYER_A_UPRIGHTFIRE:
case PLAYER_A_UPLEFTFIRE:
case PLAYER_A_DOWNRIGHTFIRE:
case PLAYER_A_DOWNLEFTFIRE:
return true;
default:
return false;
}
}
/* reset the state of the game */
void AdventureSettings::reset() {
m_reward = 0;
m_terminal = false;
}
/* saves the state of the rom settings */
void AdventureSettings::saveState(Serializer& ser) {
ser.putInt(m_reward);
ser.putBool(m_terminal);
}
// loads the state of the rom settings
void AdventureSettings::loadState(Deserializer& ser) {
m_reward = ser.getInt();
m_terminal = ser.getBool();
}
// Returns the supported modes for the game.
ModeVect AdventureSettings::getAvailableModes() {
return ModeVect() = {0, 1, 2};
}
// Set the game mode.
// The given mode must be one returned by the previous function.
// According to Wikipedia (https://en.wikipedia.org/wiki/Adventure_(Atari_2600))
// Adventure has 3 game modes:
// Level 1 is the easiest, as it uses a simplified room layout and doesn't
// include the White Castle, bat, Rhindle the red dragon, nor invisible mazes.
// Level 2 is the full version of the game, with the various objects appearing
// in set positions at the start of the game.
// Level 3 is similar to Level 2, but the location of the objects is
// randomized to provide a more challenging game. The randomiser uses the
// low byte of its internal frame counter at RAM address 0xE5 to seed the rng.
// Due to the way game modes are set below this will always be the same value
// at present so only 1/256 randomised configuration is available.
void AdventureSettings::setMode(
game_mode_t m, System& system,
std::unique_ptr<StellaEnvironmentWrapper> environment) {
if (m < 3) {
// Read the mode we are currently in.
unsigned char mode = (readRam(&system, 0xDD) >> 1) & 0x03;
// Press select until the correct mode is reached.
while (mode != m) {
environment->pressSelect(2);
// Adventure uses a debouncer so need to wait before the select
// take effect.
environment->act(PLAYER_A_NOOP, PLAYER_B_NOOP);
mode = (readRam(&system, 0xDD) >> 1) & 0x03;
}
// Reset the environment to apply changes.
environment->softReset();
} else {
throw std::runtime_error("This game mode is not supported.");
}
}
// Return the supported difficulty settings for the game.
// According to Wikipedia (https://en.wikipedia.org/wiki/Adventure_(Atari_2600))
// one difficulty switch controls controls the dragons' bite speed, and one
// causes them to flee when the player is wielding the sword.
DifficultyVect AdventureSettings::getAvailableDifficulties() {
return DifficultyVect() = {0, 1, 2, 3};
}
} // namespace ale