[1/2] Customers #35

lsuyean · 2024-07-17T07:02:55Z

Overview

In this PR, I implement Gamemodes and Customers into Robotouille.

Previously, stepping in the environment was controlled using the step() function within the State class. However, this was problematic because it was controlling more than just updates to the state, especially with new modules like Movement. Now, there is a new module called GameMode that controls all modules within Robotouille.

The GameMode class also lets Robotouille have win conditions. In this PR, I implement a basic gamemode called `Classic' where the player must serve a number of customers within a certain amount of time.

Changes Made

Customers

Added new assets for customers, the customer table, and customer spawn
- Customer spawn asset is temporary, is currently a screenshot of the floor tiling. Should be replaced by a transparent asset in the future so that it does not render in game.
Implemented Customer class which keeps track about information about the customers and steps them in the environment
Edited domain.py and domain_builder.py to now keep track of npc_actions, all actions that the npc can do as defined in the domain
Edited movement.py to also move customers
Edited state.py to keep track of customers and customer_actions
Added recipes.json where recipes can be specified
Edited robotouille.json to include Customer type, predicates, and actions
Edited builder.py and object_enmus.py to include Customer type
Added new environments customer.json and multi_customer.json to test customers
Edited renderer.py, canvas.py, robotouille_env.py and robotouille_config.json to render customers

GameMode

Implemented GameMode class that serves as the overall control of the game, keeps track of win conditions, and steps all the modules in the game
Implemented Classic subclass where a player must satisfy all recipes before a given time
Moved stepping logic of the Movement class from state.py to classic.py
Edited all environments to now also specify the gamemode
Added a new file env_utils.py to prevent circular imports when creating the GameMode and Customers
Edited robotouille_simulator.py to pass pygame.time into the gamemode class
Gamemode now also contains all information that was previously stored as class variables in the Player, Station, and Customer class

Changes to Containers

Added new actions for stacking in robotouille.json so that containers can now be picked up and placed with items on it
Added new inputs for new stacking actions in input.json
Edited canvas.py to properly render containers and items stacked on containers

Changes to Robotouille Domain

Implemented a new predicate based deletion effect, where for a predicate and one argument, all objects where the predicate is true for that argument is deleted

Test Coverage

Tested with all environments

Next Steps

Find a nicer solution for customers leaving the game (should reach the edge of the environment)

Screenshots

…s for container to robotouille.py, made new env json

…ng still buggy regarding stacking predicates

…ete yet

chalo2000

thank you for the immense effort on this! I've left a couple of comments and have requested changes just so I can take another look at your responses and minor changes.

chalo2000 · 2024-12-06T19:42:05Z

backend/customer.py

+    order to them. 
+    """
+
+    customers = {}


turn these into instance variables so we don't have networking issues

chalo2000 · 2024-12-06T19:43:57Z

backend/domain.py

                raise ValueError(f"Predicate {pred.name} has invalid types.")

-        for action in self.actions:
+        for action in action_def:


combine for loop into 1 more for loop

for action_def in [action_def, npc_action_def]: ...

edited accordingly

chalo2000 · 2024-12-06T19:45:57Z

backend/gamemode.py

@@ -0,0 +1,52 @@
+from backend.customer import Customer
+class GameMode(object):


for future, you can import ABC class to make abstract class. look at this reference

used ABC for Gamemode and SpecialEffect

chalo2000 · 2024-12-06T19:47:32Z

backend/movement/movement.py

-        player_destinations = [data.path[-1] for name, data in Movement.metadata.items() if data.path and name != player.name]
+        player_customer_locations = [p.pos for p in Player.players.values() if p != player]
+        player_customer_locations += [c.pos for c in Customer.customers.values() if c != customer and c.in_game]
+        # player_customer_destinations = [data.path[-1] for name, data in Movement.metadata.items() if data.path and name != player.name and name != customer.name]


chalo2000 · 2024-12-06T19:49:09Z

backend/movement/movement.py

+        player_customer_locations += [c.pos for c in Customer.customers.values() if c != customer and c.in_game]
+        # player_customer_destinations = [data.path[-1] for name, data in Movement.metadata.items() if data.path and name != player.name and name != customer.name]
+        player_customer_destinations = []
+        for name, data in Movement.metadata.items():


this is unclear, comment more and make it clearer

chalo2000 · 2024-12-07T06:09:23Z

renderer/canvas.py

        """
        if direction == (0, 1):
-            return self.config["player"]["robot"]["back"]
+            return self.config[type]["robot"]["back"]


so ['customer']['robot'][...] is a customer asset? customer isn't a robot. regardless we are hardcoding the "robot" asset anyways; either make this clearer that we are hardcoding by removing ["robot"] and renaming assets or put a TODO to fix this.

Changed the function to take in a name argument

chalo2000 · 2024-12-07T06:10:50Z

renderer/canvas.py



-    def _get_player_sprite(self, direction):
+    def _get_player_or_customer_image_name(self, direction, type):


looking throughout the codebase and repeatedly seeing player_or_customer is tiring. it would be good for us to rename this to some catch all like character (customer is a non-playable character while player is a playable character).

replaced with character

chalo2000 · 2024-12-07T07:07:08Z

renderer/configuration/robotouille_config.json

    },

+    "customer": {
+        "robot": {


may as well remove the "robot" key for the time being until we have different assets to make this hardcoding more evident.

changed it to girl so that the choose_character_image_name() function can take in a name

chalo2000 · 2024-12-07T07:09:36Z

robotouille/env.py

 from domain.domain_builder import build_domain
-from utils.robotouille_utils import trim_item_ID
+from backend.gamemodes.classic import Classic
+from .env_utils import build_identity_predicates, build_location_predicates, build_stacking_predicates, build_goal


thank you for organizing this better. we'll eventually want to reintegrate PDDL and since these are used by builder.py it's good to keep them in one place and switch between creating PDDL predicates or our State predicates.

chalo2000 · 2024-12-07T07:09:56Z

robotouille/env.py

+        animate (bool): Whether or not to animate the movement of the players.
+
+    Returns:
+        gamemode(GameMode): The gamemmode of the environment


space between gamemode (GameMode) and misspelled gamemode.

added space and fixed typo

chalo2000

Leaving additional comment after testing the customer environments.

chalo2000 · 2024-12-07T07:21:36Z

environments/env_generator/examples/multi_customer.json

+    "goal": [
+        {
+            "predicate": "iscookable",
+            "args": ["lettuce"],


I also just played through these and realized the goal is unrealizable. What is the plan for checking that these environments are done?

My bad, did this to make it easier to debug. Edited the goals accordingly to close when all customers have finished eating.

chalo2000

Awesome! Customers seems to be working and everything has been refactored into GameMode classes. Let's make an issue for game optimizations since the multi-customer seems to be slow and we additionally make one for environments with large goals (could both be tackled in the same PR). other optimizations we need are fast environment copying to automate the tests w/ BFS/DFS but this could be left for another PR.

chalo2000 · 2025-05-02T07:56:01Z

backend/customer.py

+        # If the customer needs to enter the game, perform the customer_enter action
+        # and add the customer to the queue
+        elif not self.has_left_queue and self not in gamemode.customer_queue \
+            and time.get_ticks() >= self.enter_time:


a bit concerned with this comparison time.get_ticks() >= self.enter_time - time.get_ticks() may return a value that is comparable to self.enter_time but using @Henrygao19's menu flow these times would likely not be comparable, including if the game is reset, if the clock is not instantiated at the beginning of the game. this clock dependency could easily cause bugs in the future if the clock is instantiated differently so would be good to store a countdown that will always be relative to self.enter_time

replaced time and clock arguments in the step functions for movement and customers with dt, and keep track of time_passed in customers

chalo2000 · 2025-05-02T07:58:59Z

backend/gamemodes/classic.py

+        Args:
+            clock (pygame.time): The time object.
+
+        Modifies:


Side Effects:

chalo2000 · 2025-05-02T08:02:10Z

backend/gamemodes/classic.py

+            new_state (State): The successor state.
+            done (bool): True if the goal is reached, False otherwise.
+        """
+


couple together the related bits of logic and have comments to describe the high level flow

# Step Customers ... # Step State ... # Step Movement ... # Check win condition ...

also why does the Movement update come after the State update? it feels like the State stepping should be the last thing done before checking win condition. does it make a difference at all?

added comments, replaced order of step functions

chalo2000 · 2025-05-02T08:03:18Z

backend/movement/movement.py

+        Station.build_stations(environment_json, gamemode)
+
+        # (Dict[str, MetaData]) The player movement data, with the key being the player name
+        self.metadata = {}


i imagine this was done to fix the networking issues with class / instance variables.

Yep, that's correct

chalo2000 · 2025-05-02T08:07:14Z

backend/movement/movement.py

-        possible_destinations = self._get_possible_destinations(player_obj, destination_pos)
+        state = gamemode.get_state()
+
+        if gamemode.players.get(character.name) is not None:


character_obj = gamemode.players.get(character.name, gamemode.customers[character.name])

chalo2000 · 2025-05-02T08:09:01Z

backend/movement/movement.py

            return
        # Get the path to the destination
-        path = self._get_player_path(player_obj, possible_destinations)
+        path = self._get_path(obj, possible_destinations, gamemode)


get_character_path. would be helpful to still have a descriptor like before (previously _get_player_path)

chalo2000 · 2025-05-02T08:15:28Z

domain/robotouille.json

            }
        },
+        {
+            "name": "isgirl",


our customer asset is female but I would prefer to have a gender neutral predicate (iscustomer) since there are no plans for gender-specific interactions. easier to code 😎

replaced girl with customer

chalo2000 · 2025-05-02T08:21:32Z

renderer/canvas.py

-        self._draw_item(surface, obs)
-        self._draw_container(surface, obs)
+        self._draw_player(surface, gamemode)
+        self.draw_customer(surface, gamemode)


underscore in front for private functions.

chalo2000 · 2025-05-02T08:26:20Z

robotouille/env.py

+        gamemode = Classic(state, domain_json, environment_json, recipe_json)
+        gamemode.movement = Movement(layout, animate, environment_json, gamemode)
+        return gamemode
+    return None


Instead of returning None, add an assert that the name is inside a list containing just "classic" for now. the game should crash if the gamemode isn't set properly.

lsuyean added 3 commits July 17, 2024 00:01

basic implementation of gamemode and customer class, added new action…

216919f

…s for container to robotouille.py, made new env json

Initial implementation of customers, gamemode, and rendering. Renderi…

3f589df

…ng still buggy regarding stacking predicates

temp commit

8f52fbe

chalo2000 force-pushed the main branch from 0f9a050 to 8fcc19b Compare September 20, 2024 21:24

lsuyean and others added 7 commits October 26, 2024 00:23

Merge branch 'main' into customers

35a8c6b

finished first draft of customers

6ed8ba6

added customer asset and started debugging rendering issue, not compl…

a127e0b

…ete yet

fixed rendering issues

ff06f32

added multiple customers, made customers spawn and despawn

36cb38d

removed unnecessary code

7ae9b7d

fixed environments and state bug

9cb76b3

lsuyean requested a review from chalo2000 November 10, 2024 21:17

lsuyean changed the title ~~Customers~~ [1/2] Customers Nov 16, 2024

lsuyean added 2 commits November 29, 2024 18:51

finished customers

0810f1e

removed class variables, made improvements to movement module

03f7842

chalo2000 requested changes Dec 7, 2024

View reviewed changes

chalo2000 reviewed Dec 7, 2024

View reviewed changes

edited based on comments

5132b29

lsuyean requested a review from chalo2000 December 10, 2024 05:29

lsuyean and others added 3 commits April 15, 2025 22:39

Merge branch 'main' into customers

efba12f

fixed bugs

d66763a

initial implementation of backend profile, customer, lobby

fefc707

chalo2000 requested changes May 2, 2025

View reviewed changes

lsuyean and others added 5 commits May 6, 2025 15:35

addressed some comments

f3f1701

Merge branch 'main' into customers

658387a

fixed movement bug

475b9f9

finished addressing comments

126f3f8

added a get_active_orders method to classic

d5dddc5

lsuyean requested a review from chalo2000 May 10, 2025 20:14

		@@ -0,0 +1,52 @@
		from backend.customer import Customer
		class GameMode(object):



		def _get_player_sprite(self, direction):
		def _get_player_or_customer_image_name(self, direction, type):

[1/2] Customers #35

Are you sure you want to change the base?

[1/2] Customers #35

Uh oh!

Conversation

lsuyean commented Jul 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Changes Made

Test Coverage

Next Steps

Screenshots

Uh oh!

chalo2000 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chalo2000 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lsuyean Dec 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chalo2000 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lsuyean commented Jul 17, 2024 •

edited

Loading

lsuyean Dec 10, 2024 •

edited

Loading