def test_going_through_door():
P = Variable("P", "P")
room = Variable("room", "r")
kitchen = Variable("kitchen", "r")
state = State()
state.add_facts([
Proposition("at", [P, room]),
Proposition("north_of", [kitchen, room]),
Proposition("free", [kitchen, room]),
Proposition("free", [room, kitchen]),
Proposition("south_of", [room, kitchen])
])
options = ChainingOptions()
options.backward = True
options.max_depth = 3
options.subquests = True
options.create_variables = True
options.rules_per_depth = [
[KnowledgeBase.default().rules["take/c"], KnowledgeBase.default().rules["take/s"]],
KnowledgeBase.default().rules.get_matching("go.*"),
[KnowledgeBase.default().rules["open/d"]],
]
chains = list(get_chains(state, options))
assert len(chains) == 18
def test_get_objects_in_inventory():
P = Variable("P")
I = Variable("I")
room = Variable("room", "r")
obj = Variable("obj", "o")
# Closed chest.
facts = [Proposition("at", [P, room]), Proposition("in", [obj, I])]
world = World.from_facts(facts)
objects = world.get_objects_in_inventory()
assert obj in world.objects
assert obj in objects
def test_get_visible_objects_in():
P = Variable("P")
room = Variable("room", "r")
chest = Variable("chest", "c")
obj = Variable("obj", "o")
# Closed chest.
facts = [
Proposition("at", [P, room]),
Proposition("at", [chest, room]),
Proposition("in", [obj, chest]),
Proposition("closed", [chest])
]
world = World.from_facts(facts)
objects = world.get_visible_objects_in(world.player_room)
assert obj in world.objects
assert obj not in objects
# Open chest.
facts = [
Proposition("at", [P, room]),
Proposition("at", [chest, room]),
Proposition("in", [obj, chest]),
Proposition("open", [chest])
]
world = World.from_facts(facts)
objects = world.get_visible_objects_in(world.player_room)
assert obj in world.objects
assert obj in objects
def test_populate_with():
# setup
P = Variable('P')
I = Variable('I')
room = Variable('room', 'r')
facts = [Proposition('at', [P, room])]
world = World.from_facts(facts)
# test
obj = Variable('obj', 'o')
world.populate_with(objects=[obj])
assert obj in world.objects
assert (Proposition('at', [obj, room]) in world.facts
or Proposition('in', [obj, I]) in world.facts)
def check_state(state):
fail = Proposition("fail", [])
debug = Proposition("debug", [])
constraints = state.all_applicable_actions(
KnowledgeBase.default().constraints.values())
for constraint in constraints:
if state.is_applicable(constraint):
# Optimistically delay copying the state
copy = state.copy()
copy.apply(constraint)
if copy.is_fact(fail):
return False
return True
def add_fact(self, name: str, *entities: List["WorldEntity"]) -> None:
""" Adds a fact to this entity.
Args:
name: The name of the new fact.
*entities: A list of entities as arguments to the new fact.
"""
args = [entity.var for entity in entities]
self._facts.append(Proposition(name, args))
def new_fact(self, name: str, *entities: List["WorldEntity"]) -> None:
""" Create new fact.
Args:
name: The name of the new fact.
*entities: A list of entities as arguments to the new fact.
"""
args = [entity.var for entity in entities]
return Proposition(name, args)
def test_cannot_automatically_positioning_rooms():
P = Variable("P")
r0 = Variable("Room0", "r")
r1 = Variable("Room1", "r")
r2 = Variable("Room2", "r")
r3 = Variable("Room3", "r")
r4 = Variable("Room4", "r")
r5 = Variable("Room5", "r")
d = Variable("door", "d")
facts = [Proposition("at", [P, r0])]
facts.extend(connect(r0, 'north', r1))
facts.extend(connect(r0, 'east', r2))
facts.extend(connect(r0, 'south', r3))
facts.extend(connect(r0, 'west', r4))
world = World.from_facts(facts)
npt.assert_raises(NoFreeExitError, world.add_fact,
Proposition("link", [r0, d, r5]))
def test_automatically_positioning_rooms():
P = Variable("P")
r1 = Variable("Room1", "r")
r2 = Variable("Room2", "r")
d = Variable("door", "d")
facts = [Proposition("at", [P, r1])]
world = World.from_facts(facts)
assert len(world.rooms) == 1
assert len(world.find_room_by_id(r1.name).exits) == 0
world.add_fact(Proposition("link", [r1, d, r2]))
assert len(world.rooms) == 2
r1_entity = world.find_room_by_id(r1.name)
r2_entity = world.find_room_by_id(r2.name)
assert len(r1_entity.exits) == 1
assert len(r2_entity.exits) == 1
assert list(r1_entity.exits.keys())[0] == reverse_direction(
list(r2_entity.exits.keys())[0])
def check_state(self, state: State) -> bool:
"""Check that a state satisfies the constraints."""
fail = Proposition("fail", [])
constraints = state.all_applicable_actions(self.constraints)
for constraint in constraints:
copy = state.apply_on_copy(constraint)
if copy and copy.is_fact(fail):
return False
return True
def test_count(self):
rng = np.random.RandomState(1234)
types_counts = {t: rng.randint(2, 10) for t in self.types.variables}
state = State()
for t in self.types.variables:
v = Variable(get_new(t, types_counts), t)
state.add_fact(Proposition("dummy", [v]))
counts = self.types.count(state)
for t in self.types.variables:
assert counts[t] == types_counts[t], (counts[t], types_counts[t])
def facts(self) -> List[Proposition]:
""" Facts related to this path.
Returns:
The facts that make up this path.
"""
facts = []
facts.append(
Proposition("{}_of".format(self.src_exit),
[self.dest.var, self.src.var]))
facts.append(
Proposition("{}_of".format(self.dest_exit),
[self.src.var, self.dest.var]))
if self.door is None or self.door.has_property("open"):
facts.append(Proposition("free", [self.src.var, self.dest.var]))
facts.append(Proposition("free", [self.dest.var, self.src.var]))
if self.door is not None:
facts.extend(self.door.facts)
facts.append(
Proposition("link",
[self.src.var, self.door.var, self.dest.var]))
facts.append(
Proposition("link",
[self.dest.var, self.door.var, self.src.var]))
return facts
def test_logic_parsing():
P = Variable("P", "P")
kitchen = Variable("kitchen", "r")
egg = Variable("egg", "f")
assert Variable.parse("P") == P
assert Variable.parse("kitchen: r") == kitchen
at_kitchen = Proposition("at", [P, kitchen])
in_kitchen = Proposition("in", [egg, kitchen])
raw_egg = Proposition("raw", [egg])
cooked_egg = Proposition("cooked", [egg])
assert Proposition.parse("at(P, kitchen: r)") == at_kitchen
assert Signature.parse("at(P, r)") == at_kitchen.signature
cook_egg = Action("cook", [at_kitchen, in_kitchen, raw_egg], [at_kitchen, in_kitchen, cooked_egg])
assert Action.parse("cook :: $at(P, kitchen: r) & $in(egg: f, kitchen: r) & raw(egg: f) -> cooked(egg: f)") == cook_egg
P = Placeholder("P", "P")
r = Placeholder("r", "r")
d = Placeholder("d", "d")
rp = Placeholder("r'", "r")
assert Placeholder.parse("P") == P
assert Placeholder.parse("r") == r
assert Placeholder.parse("d") == d
assert Placeholder.parse("r'") == rp
at_r = Predicate("at", [P, r])
link = Predicate("link", [r, d, rp])
unlocked = Predicate("unlocked", [d])
at_rp = Predicate("at", [P, rp])
assert Predicate.parse("link(r, d, r')") == link
go = Rule("go", [at_r, link, unlocked], [link, unlocked, at_rp])
assert Rule.parse("go :: at(P, r) & $link(r, d, r') & $unlocked(d) -> at(P, r')") == go
# Make sure the types match in the whole expression
assert_raises(ValueError, Rule.parse, "take :: $at(P, r) & $in(c, r) & in(o: k, c) -> in(o, I)")
def connect(room1: Variable,
direction: str,
room2: Variable,
door: Optional[Variable] = None) -> List[Proposition]:
""" Generate predicates that connect two rooms.
Args:
room1: A room variable.
direction: Direction that we need to travel to go from
room1 to room2.
room2: A room variable.
door: The door separating the two rooms. If `None`, there is no
door between the rooms.
"""
r_direction = reverse_direction(direction) + "_of"
direction += "_of"
facts = [
Proposition(direction, [room2, room1]),
Proposition(r_direction, [room1, room2]),
Proposition("free", [room1, room2]),
Proposition("free", [room2, room1])
]
if door is not None:
facts += [
Proposition("link", [room1, door, room2]),
Proposition("link", [room2, door, room1])
]
return facts
def test_backward_chaining():
P = Variable("P", "P")
room = Variable("room", "r")
kitchen = Variable("kitchen", "r")
state = State([
Proposition("at", [P, room]),
Proposition("north_of", [kitchen, room]),
Proposition("south_of", [room, kitchen]),
])
options = ChainingOptions()
options.backward = True
options.max_depth = 2
options.subquests = True
options.create_variables = True
options.rules_per_depth = [
[KnowledgeBase.default().rules["take/c"], KnowledgeBase.default().rules["take/s"]],
[KnowledgeBase.default().rules["open/c"]],
]
options.restricted_types = {"d"}
chains = list(get_chains(state, options))
assert len(chains) == 3
options = ChainingOptions()
options.backward = True
options.max_depth = 3
options.subquests = True
options.create_variables = True
options.rules_per_depth = [
[KnowledgeBase.default().rules["put"]],
[KnowledgeBase.default().rules["go/north"]],
[KnowledgeBase.default().rules["take/c"]],
]
options.restricted_types = {"d"}
chains = list(get_chains(state, options))
assert len(chains) == 3
def get_failing_constraints(state):
fail = Proposition("fail", [])
failed_constraints = []
constraints = state.all_applicable_actions(
KnowledgeBase.default().constraints.values())
for constraint in constraints:
if state.is_applicable(constraint):
# Optimistically delay copying the state
copy = state.copy()
copy.apply(constraint)
if copy.is_fact(fail):
failed_constraints.append(constraint)
return failed_constraints
def set_player_room(self,
start_room: Union[None, WorldRoom,
str] = None) -> None:
if start_room is None:
if len(self.rooms) == 0:
start_room = WorldRoom("r_0", "r")
else:
start_room = self.rooms[0]
elif start_room in self._entities:
start_room = self._entities[start_room]
elif isinstance(start_room,
Variable) and start_room.name in self._entities:
start_room = self._entities[start_room.name]
else:
raise ValueError("Unknown room: {}".format(start_room))
self.add_fact(Proposition("at", [self.player, start_room]))
def set_conditions(self, conditions: Iterable[Proposition]) -> Action:
"""
Set the triggering conditions for this event.
Args:
conditions: Set of propositions which need to
be all true in order for this event
to get triggered.
Returns:
Action that can only be applied when all conditions are statisfied.
"""
if not conditions:
if len(self.actions) == 0:
raise UnderspecifiedEventError()
# The default winning conditions are the postconditions of the
# last action in the quest.
conditions = self.actions[-1].postconditions
variables = sorted(set([v for c in conditions for v in c.arguments]))
event = Proposition("event", arguments=variables)
self.condition = Action("trigger", preconditions=conditions,
postconditions=list(conditions) + [event])
return self.condition
def test_used_names_is_updated(verbose=False):
# Make generation throughout the framework reproducible.
g_rng.set_seed(1234)
# Generate a map that's shape in a cross with room0 in the middle.
P = Variable('P')
r = Variable('r_0', 'r')
k1 = Variable('k_1', 'k')
k2 = Variable('k_2', 'k')
c1 = Variable('c_1', 'c')
c2 = Variable('c_2', 'c')
facts = [
Proposition('at', [P, r]),
Proposition('at', [k1, r]),
Proposition('at', [k2, r]),
Proposition('at', [c1, r]),
Proposition('at', [c2, r]),
Proposition('match', [k1, c1]),
Proposition('match', [k2, c2])
]
world = World.from_facts(facts)
world.set_player_room() # Set start room to the middle one.
world.populate_room(10,
world.player_room) # Add objects to the starting room.
# Generate the world representation.
grammar = tw_textlabs.generator.make_grammar({},
rng=np.random.RandomState(42))
for k, v in grammar.grammar.items():
grammar.grammar[k] = v[:2] # Force reusing variables.
game = tw_textlabs.generator.make_game_with(world, [], grammar)
for entity_infos in game.infos.values():
if entity_infos.name is None:
continue
assert entity_infos.name in grammar.used_names
def populate_room(
self,
nb_objects: int,
room: Variable,
rng: Optional[RandomState] = None,
object_types_probs: Optional[Dict[str, float]] = None
) -> List[Proposition]:
rng = g_rng.next() if rng is None else rng
state = []
types_counts = KnowledgeBase.default().types.count(self.state)
inventory = Variable("I", "I")
objects_holder = [inventory, room]
locked_or_closed_objects = []
lockable_objects = []
for s in self.facts:
# Look for containers and supporters to put stuff in/on them.
if s.name == "at" and s.arguments[0].type in [
"c", "s"
] and s.arguments[1].name == room.name:
objects_holder.append(s.arguments[0])
# Look for containers and doors without a matching key.
if s.name == "at" and s.arguments[0].type in [
"c", "d"
] and s.arguments[1].name == room.name:
obj_propositions = [
p.name for p in self.facts
if s.arguments[0].name in p.names
]
if "match" not in obj_propositions and s.arguments[
0] not in lockable_objects:
lockable_objects.append(s.arguments[0])
if "locked" in obj_propositions or "closed" in obj_propositions:
locked_or_closed_objects.append(s.arguments[0])
object_id = 0
while object_id < nb_objects:
if len(locked_or_closed_objects) > 0:
# Prioritize adding key if there are locked or closed things in the room.
obj_type = "k"
else:
obj_type = KnowledgeBase.default().types.sample(
parent_type='t',
rng=rng,
exceptions=["d", "r"],
include_parent=False,
probs=object_types_probs)
if KnowledgeBase.default().types.is_descendant_of(obj_type, "o"):
obj_name = get_new(obj_type, types_counts)
obj = Variable(obj_name, obj_type)
allowed_objects_holder = list(objects_holder)
if obj_type == "k":
if len(locked_or_closed_objects) > 0:
# Look for a *locked* container or a door.
rng.shuffle(locked_or_closed_objects)
locked_or_closed_obj = locked_or_closed_objects.pop()
state.append(
Proposition("match", [obj, locked_or_closed_obj]))
lockable_objects.remove(locked_or_closed_obj)
# Do not place the key in its own matching container.
if locked_or_closed_obj in allowed_objects_holder:
allowed_objects_holder.remove(locked_or_closed_obj)
elif len(lockable_objects) > 0:
# Look for a container or a door.
rng.shuffle(lockable_objects)
lockable_obj = lockable_objects.pop()
state.append(Proposition("match", [obj, lockable_obj]))
else:
continue # Unuseful key is not allowed.
elif obj_type == "f":
# HACK: manually add the edible property to food items.
state.append(Proposition("edible", [obj]))
# Place the object somewhere.
obj_holder = rng.choice(allowed_objects_holder)
if KnowledgeBase.default().types.is_descendant_of(
obj_holder.type, "s"):
state.append(Proposition("on", [obj, obj_holder]))
elif KnowledgeBase.default().types.is_descendant_of(
obj_holder.type, "c"):
state.append(Proposition("in", [obj, obj_holder]))
elif KnowledgeBase.default().types.is_descendant_of(
obj_holder.type, "I"):
state.append(Proposition("in", [obj, obj_holder]))
elif KnowledgeBase.default().types.is_descendant_of(
obj_holder.type, "r"):
state.append(Proposition("at", [obj, obj_holder]))
else:
raise ValueError(
"Unknown type for object holder: {}".format(
obj_holder))
elif KnowledgeBase.default().types.is_descendant_of(obj_type, "s"):
supporter_name = get_new(obj_type, types_counts)
supporter = Variable(supporter_name, obj_type)
state.append(Proposition("at", [supporter, room]))
objects_holder.append(supporter)
elif KnowledgeBase.default().types.is_descendant_of(obj_type, "c"):
container_name = get_new(obj_type, types_counts)
container = Variable(container_name, obj_type)
state.append(Proposition("at", [container, room]))
objects_holder.append(container)
container_state = rng.choice(["open", "closed", "locked"])
state.append(Proposition(container_state, [container]))
lockable_objects.append(container)
if container_state in ["locked", "closed"]:
locked_or_closed_objects.append(container)
else:
raise ValueError("Unknown object type: {}".format(obj_type))
object_id += 1
self.add_facts(state)
return state
def build_state(door_state="open"):
# Set up a world with two rooms and a few objecs.
state = State([
Proposition("at", [P, bedroom]),
Proposition("south_of", [kitchen, bedroom]),
Proposition("north_of", [bedroom, kitchen]),
Proposition("link", [bedroom, wooden_door, kitchen]),
Proposition("link", [kitchen, wooden_door, bedroom]),
Proposition(door_state, [wooden_door]),
#
Proposition("in", [rusty_key, I]),
Proposition("match", [rusty_key, chest]),
Proposition("locked", [chest]),
Proposition("at", [chest, kitchen]),
Proposition("in", [small_key, chest]),
#
Proposition("match", [small_key, cabinet]),
Proposition("locked", [cabinet]),
Proposition("at", [cabinet, bedroom]),
Proposition("in", [robe, cabinet]),
])
return state
def get_win_conditions(self, chain: Chain) -> Collection[Proposition]:
"""
Given a chain of actions comprising a quest, return the set of propositions
which must hold in a winning state.
Parameters
----------
chain:
Chain of actions leading to goal state.
Returns
-------
win_conditions:
Set of propositions which must hold to end the quest succesfully.
"""
win_condition_type = self.options.win_condition
win_conditions = set()
final_state = chain.final_state
pg = ProcessGraph()
pg.from_tw_actions(chain.actions)
if win_condition_type in [WinConditionType.OPS, WinConditionType.ALL]:
# require all operations to have the correct inputs
processed_props = set([
prop for prop in final_state.facts if prop.name == 'processed'
])
component_props = set([
prop for prop in final_state.facts if prop.name == 'component'
])
win_conditions.update(processed_props)
win_conditions.update(component_props)
# require all operations to be set to correct type
op_type_props = set([
prop for prop in final_state.facts
if prop.name == 'tlq_op_type'
])
win_conditions.update(op_type_props)
# precedence propositions enforcing minimal ordering restraints between ops
tG = nx.algorithms.dag.transitive_closure(pg.G)
op_nodes = [
n for n in tG.nodes()
if KnowledgeBase.default().types.is_descendant_of(
n.var.type, ["op"])
]
op_sg = nx.algorithms.dag.transitive_reduction(
tG.subgraph(op_nodes))
for e in op_sg.edges():
op_1_node, op_2_node = e
prec_prop = Proposition('preceeds',
[op_1_node.var, op_2_node.var])
win_conditions.update({prec_prop})
if win_condition_type in [WinConditionType.ARGS, WinConditionType.ALL]:
# require all descriptions to be set correctly
desc_props = set([
prop for prop in final_state.facts if prop.name == 'describes'
])
win_conditions.update(desc_props)
# add post-conditions from last action
post_props = set(chain.actions[-1].postconditions)
win_conditions.update(post_props)
return Event(conditions=win_conditions)
def graph2state(G: networkx.Graph, rooms: Dict[str,
Variable]) -> List[Proposition]:
""" Convert Graph object to a list of `Proposition`.
Args:
G: Graph defining the structure of the world.
rooms: information about the rooms in the world.
"""
state = []
for src, dest in G.edges():
d = direction(src, dest)
d_r = direction(dest, src)
e = G[src][dest]
room_src = rooms[src]
room_dest = rooms[dest]
if e["has_door"]:
door = Variable(e['door_name'], "d")
pred1 = Proposition("{}_of".format(d), [room_dest, room_src])
pred2 = Proposition("{}_of".format(d_r), [room_src, room_dest])
state.append(Proposition(e["door_state"], [door]))
state.append(Proposition("link", [room_src, door, room_dest]))
state.append(Proposition("link", [room_dest, door, room_src]))
if e["door_state"] == "open":
state.append(Proposition("free", [room_dest, room_src]))
state.append(Proposition("free", [room_src, room_dest]))
else:
pred1 = Proposition("{}_of".format(d), [room_dest, room_src])
pred2 = Proposition("{}_of".format(d_r), [room_src, room_dest])
state.append(Proposition("free", [room_dest, room_src]))
state.append(Proposition("free", [room_src, room_dest]))
state.append(pred1)
state.append(pred2)
return state
def test_room_connections():
room0 = Variable("room0", "r")
room1 = Variable("room1", "r")
room2 = Variable("room2", "r")
# Only one connection can exist between two rooms.
# r1
# |
# r0 - r1
state = State([
Proposition("north_of", [room1, room0]),
Proposition("south_of", [room0, room1]),
Proposition("east_of", [room1, room0]),
Proposition("west_of", [room0, room1])
])
assert not check_state(state)
# Non Cartesian layout are allowed.
# r1
# |
# r0 - r2 - r1
state = State([
Proposition("north_of", [room1, room0]),
Proposition("south_of", [room0, room1]),
Proposition("east_of", [room2, room0]),
Proposition("west_of", [room0, room2]),
Proposition("east_of", [room1, room2]),
Proposition("west_of", [room2, room1])
])
assert check_state(state)
# A room cannot have more than 4 'link' propositions.
room3 = Variable("room3", "r")
room4 = Variable("room4", "r")
room5 = Variable("room5", "r")
door1 = Variable("door1", "d")
door2 = Variable("door2", "d")
door3 = Variable("door3", "d")
door4 = Variable("door4", "d")
door5 = Variable("door5", "d")
state = State([
Proposition("link", [room0, door1, room1]),
Proposition("link", [room0, door2, room2]),
Proposition("link", [room0, door3, room3]),
Proposition("link", [room0, door4, room4]),
Proposition("link", [room0, door5, room5])
])
assert not check_state(state)
def build_state(locked_door=False):
# Set up a world with two rooms and a few objecs.
P = Variable("P")
I = Variable("I")
bedroom = Variable("bedroom", "r")
kitchen = Variable("kitchen", "r")
rusty_key = Variable("rusty key", "k")
small_key = Variable("small key", "k")
wooden_door = Variable("wooden door", "d")
chest = Variable("chest", "c")
cabinet = Variable("cabinet", "c")
robe = Variable("robe", "o")
state = State([
Proposition("at", [P, bedroom]),
Proposition("south_of", [kitchen, bedroom]),
Proposition("north_of", [bedroom, kitchen]),
Proposition("link", [bedroom, wooden_door, kitchen]),
Proposition("link", [kitchen, wooden_door, bedroom]),
Proposition("locked" if locked_door else "closed", [wooden_door]),
Proposition("in", [rusty_key, I]),
Proposition("match", [rusty_key, chest]),
Proposition("locked", [chest]),
Proposition("at", [chest, kitchen]),
Proposition("in", [small_key, chest]),
Proposition("match", [small_key, cabinet]),
Proposition("locked", [cabinet]),
Proposition("at", [cabinet, bedroom]),
Proposition("in", [robe, cabinet]),
])
return state
def populate_room_with(
self,
objects: WorldObject,
room: WorldRoom,
rng: Optional[RandomState] = None) -> List[Proposition]:
rng = g_rng.next() if rng is None else rng
state = []
objects_holder = [room]
locked_or_closed_objects = []
lockable_objects = []
for s in self.facts:
# Look for containers and supporters to put stuff in/on them.
if s.name == "at" and s.arguments[0].type in [
"c", "s"
] and s.arguments[1].name == room.name:
objects_holder.append(s.arguments[0])
# Look for containers and doors without a matching key.
if s.name == "at" and s.arguments[0].type in [
"c", "d"
] and s.arguments[1].name == room.name:
obj_propositions = [
p.name for p in self.facts
if s.arguments[0].name in p.names
]
if "match" not in obj_propositions and s.arguments[
0] not in lockable_objects:
lockable_objects.append(s.arguments[0])
if "locked" in obj_propositions or "closed" in obj_propositions:
locked_or_closed_objects.append(s.arguments[0])
remaining_objects_id = list(range(len(objects)))
rng.shuffle(remaining_objects_id)
for idx in remaining_objects_id:
obj = objects[idx]
obj_type = obj.type
if KnowledgeBase.default().types.is_descendant_of(obj_type, "o"):
allowed_objects_holder = list(objects_holder)
# Place the object somewhere.
obj_holder = rng.choice(allowed_objects_holder)
if KnowledgeBase.default().types.is_descendant_of(
obj_holder.type, "s"):
state.append(Proposition("on", [obj, obj_holder]))
elif KnowledgeBase.default().types.is_descendant_of(
obj_holder.type, "c"):
state.append(Proposition("in", [obj, obj_holder]))
elif KnowledgeBase.default().types.is_descendant_of(
obj_holder.type, "r"):
state.append(Proposition("at", [obj, obj_holder]))
else:
raise ValueError(
"Unknown type for object holder: {}".format(
obj_holder))
elif KnowledgeBase.default().types.is_descendant_of(obj_type, "s"):
supporter = obj
state.append(Proposition("at", [supporter, room]))
objects_holder.append(supporter)
elif KnowledgeBase.default().types.is_descendant_of(obj_type, "c"):
container = obj
state.append(Proposition("at", [container, room]))
objects_holder.append(container)
container_state = rng.choice(["open", "closed", "locked"])
state.append(Proposition(container_state, [container]))
lockable_objects.append(container)
if container_state in ["locked", "closed"]:
locked_or_closed_objects.append(container)
else:
raise ValueError("Unknown object type: {}".format(obj_type))
self.add_facts(state)
return state
def test_constraints():
# Declare some variables.
P = Variable("P", "P")
I = Variable("I", "I")
bedroom = Variable("bedroom", "r")
kitchen = Variable("kitchen", "r")
rusty_key = Variable("rusty key", "k")
small_key = Variable("small key", "k")
wooden_door = Variable("wooden door", "d")
glass_door = Variable("glass door", "d")
chest = Variable("chest", "c")
cabinet = Variable("cabinet", "c")
counter = Variable("counter", "s")
robe = Variable("robe", "o")
# Make sure the number of basic constraints matches the number
# of constraints in constraints.txt
basic_constraints = [
k for k in KnowledgeBase.default().constraints.keys() if "-" not in k
]
# assert len(basic_constraints) == 32
# Doors can only have one state.
door_states = ["open", "closed", "locked"]
for door_state in door_states:
state = State([Proposition(door_state, [wooden_door])])
assert check_state(state)
for door_state2 in door_states:
if door_state == door_state2:
continue
state2 = state.copy()
state2.add_fact(Proposition(door_state2, [glass_door])) # New door
assert check_state(state2)
state2.add_fact(Proposition(door_state2, [wooden_door]))
assert not check_state(state2)
# Containers can only have one state.
container_states = ["open", "closed", "locked"]
for container_state in container_states:
state = State([Proposition(container_state, [chest])])
assert check_state(state)
for container_state2 in container_states:
if container_state == container_state2:
continue
state2 = state.copy()
state2.add_fact(Proposition(container_state2,
[cabinet])) # New container
assert check_state(state2)
state2.add_fact(Proposition(container_state2, [chest]))
assert not check_state(state2)
# A player/supporter/container can only be at one place.
for obj in [P, chest, counter]:
assert check_state(State([Proposition("at", [obj, kitchen])]))
assert check_state(State([Proposition("at", [obj, bedroom])]))
assert not check_state(
State([
Proposition("at", [obj, kitchen]),
Proposition("at", [obj, bedroom])
]))
# An object is either in the player's inventory, in a container or on a supporter
obj_locations = [
Proposition("in", [robe, I]),
Proposition("in", [robe, chest]),
Proposition("on", [robe, counter])
]
for obj_location in obj_locations:
assert check_state(State([obj_location]))
for obj_location2 in obj_locations:
if obj_location == obj_location2: break
assert not check_state(State([obj_location, obj_location2
])), "{}, {}".format(
obj_location, obj_location2)
# Only one key can match a container and vice-versa.
assert check_state(State([Proposition("match", [rusty_key, chest])]))
assert not check_state(
State([
Proposition("match", [small_key, chest]),
Proposition("match", [rusty_key, chest])
]))
assert not check_state(
State([
Proposition("match", [small_key, cabinet]),
Proposition("match", [small_key, chest])
]))
# Only one key can match a door and vice-versa.
assert check_state(State([Proposition("match", [rusty_key, chest])]))
assert not check_state(
State([
Proposition("match", [small_key, wooden_door]),
Proposition("match", [rusty_key, wooden_door])
]))
assert not check_state(
State([
Proposition("match", [small_key, glass_door]),
Proposition("match", [small_key, wooden_door])
]))
# A door can't be used to link more than two rooms.
door = Variable("door", "d")
room1 = Variable("room1", "r")
room2 = Variable("room2", "r")
room3 = Variable("room3", "r")
assert not check_state(
State([
Proposition("link", [room1, door, room2]),
Proposition("link", [room1, door, room3]),
]))
door1 = Variable("door1", "d")
door2 = Variable("door2", "d")
room1 = Variable("room1", "r")
room2 = Variable("room2", "r")
assert not check_state(
State([
Proposition("link", [room1, door1, room2]),
Proposition("link", [room1, door2, room2]),
]))
def test_make_world_with():
r1 = Variable("r_0", "r")
P = Variable('P')
world = make_world_with(rooms=[r1])
assert Proposition('at', [P, r1]) in world.facts
def make_game(mode: str, options: GameOptions) -> tw_textlabs.Game:
""" Make a Treasure Hunter game.
Arguments:
mode: Mode for the game where
* `'easy'`: rooms are all empty except where the two objects are
placed. Also, connections between rooms have no door.
* `'medium'`: adding closed doors and containers that might need
to be open in order to find the object.
* `'hard'`: adding locked doors and containers (necessary keys
will in the inventory) that might need to be unlocked (and open)
in order to find the object.
options:
For customizing the game generation (see
:py:class:`tw_textlabs.GameOptions <tw_textlabs.generator.game.GameOptions>`
for the list of available options).
Returns:
Generated game.
"""
kb = KnowledgeBase.default()
metadata = {} # Collect infos for reproducibility.
metadata["desc"] = "Treasure Hunter"
metadata["mode"] = mode
metadata["seeds"] = options.seeds
metadata["world_size"] = options.nb_rooms
metadata["quest_length"] = options.quest_length
rngs = options.rngs
rng_map = rngs['map']
rng_objects = rngs['objects']
rng_quest = rngs['quest']
rng_grammar = rngs['grammar']
modes = ["easy", "medium", "hard"]
if mode == "easy":
door_states = None
n_distractors = 0
elif mode == "medium":
door_states = ["open", "closed"]
n_distractors = 10
elif mode == "hard":
door_states = ["open", "closed", "locked"]
n_distractors = 20
# Generate map.
map_ = tw_textlabs.generator.make_map(n_rooms=options.nb_rooms, rng=rng_map,
possible_door_states=door_states)
assert len(map_.nodes()) == options.nb_rooms
world = World.from_map(map_)
# Randomly place the player.
starting_room = None
if len(world.rooms) > 1:
starting_room = rng_map.choice(world.rooms)
world.set_player_room(starting_room)
# Add object the player has to pick up.
types_counts = kb.types.count(world.state)
obj_type = kb.types.sample(parent_type='o', rng=rng_objects,
include_parent=True)
var_id = get_new(obj_type, types_counts)
right_obj = Variable(var_id, obj_type)
world.add_fact(Proposition("in", [right_obj, world.inventory]))
# Add containers and supporters to the world.
types_counts = kb.types.count(world.state)
objects = []
distractor_types = uniquify(['c', 's'] +
kb.types.descendants('c') +
kb.types.descendants('s'))
for i in range(n_distractors):
obj_type = rng_objects.choice(distractor_types)
var_id = get_new(obj_type, types_counts) # This update the types_counts.
objects.append(Variable(var_id, obj_type))
world.populate_with(objects, rng=rng_objects)
# Add object the player should not pick up.
types_counts = kb.types.count(world.state)
obj_type = kb.types.sample(parent_type='o', rng=rng_objects,
include_parent=True)
var_id = get_new(obj_type, types_counts)
wrong_obj = Variable(var_id, obj_type)
# Place it anywhere in the world.
world.populate_with([wrong_obj], rng=rng_objects)
# Generate a quest that finishes by taking something (i.e. the right
# object since it's the only one in the inventory).
options.chaining.rules_per_depth = [kb.rules.get_matching("take.*")]
options.chaining.backward = True
options.chaining.rng = rng_quest
#options.chaining.restricted_types = exceptions
#exceptions = ["r", "c", "s", "d"] if mode == "easy" else ["r"]
chain = tw_textlabs.generator.sample_quest(world.state, options.chaining)
# Add objects needed for the quest.
world.state = chain.initial_state
event = Event(chain.actions)
quest = Quest(win_events=[event],
fail_events=[Event(conditions={Proposition("in", [wrong_obj, world.inventory])})])
grammar = tw_textlabs.generator.make_grammar(options.grammar, rng=rng_grammar)
game = tw_textlabs.generator.make_game_with(world, [quest], grammar)
game.metadata = metadata
mode_choice = modes.index(mode)
uuid = "tw-treasure_hunter-{specs}-{grammar}-{seeds}"
uuid = uuid.format(specs=encode_seeds((mode_choice, options.nb_rooms, options.quest_length)),
grammar=options.grammar.uuid,
seeds=encode_seeds([options.seeds[k] for k in sorted(options.seeds)]))
game.metadata["uuid"] = uuid
return game
