The pytest command in .gitlab-ci.yml has been updated to include code coverage measurements. The "coverage" Python package was added in setup.py under test requirements. Also, small updates were made in tests to reflect changes in the module imports and object comparisons.

Resolve "player id in hooks and in all relevant methods"

Closes #100

See merge request scs/cocosy/overcooked-simulator!69

Meal configurations in the level 1 configuration file are updated, swapping out the previous meals with new ones. Player name has been added as a parameter to the pick_up and drop_off methods in player.py and counters.py. This allows for better tracking of the actions of individual players, which can be useful in cooperative environments where player accountability is imperative. Additionally, served meals now also log the serving player's name, providing additional context during gameplay and post-game analysis.

Updated instructions on how to start the game and study servers, and run PyGame GUI individually. Now, these can be initiated with specific arguments. Enhanced the data descriptions by adding additional documentation for Study Config and for generating images/videos from recordings. Also, revised the base models and TypedDicts within state representation.

Resolve "File, dir renaming"

Closes #71

See merge request scs/cocosy/overcooked-simulator!67

The installation instructions in README.md and __init__.py have been updated to reflect the change in directory name from 'cooperative_cuisine' to 'overcooked-simulator'. This update ensures the correct directory is specified for the 'cd' command post cloning of the repository.

The project title in the README.md file was incorrect. This commit updates it from "Cooperative Cuisine Simulator" to the correct title, "Cooperative Cuisine Environment".

The README title has been adjusted to use proper title case. "cooperative_cuisine Simulator" has been corrected to "Cooperative Cuisine Simulator" for better readability and consistency with standard title formatting.

The package name 'overcooked-environment' mentioned in the installation instructions has been updated to 'cooperative_cuisine'. This change has been reflected in both the README.md and __init__.py files to ensure that users install the correct package named 'cooperative_cuisine' from the given repository.

This commit updates all references from Overcooked Simulator to Cooperative Cuisine across various titles, descriptions, URL and documentation in the code. Also added an undo dispenser pickup option to level configuration files and changed default server URL to localhost.

The 'order.py' module has been renamed to 'orders.py' for consistency and clarity. All references to this file within the code base, including import statements and comments, have been updated to reflect this change. A safer and more coherent codebase enhances readability and maintainability.

All configurations, scripts, and yaml files previously held in "game_content" are now placed in the "configs" directory for logical organization and better visibility. All references within the code that previously pointed to "game_content" have been updated to reflect the new "configs" path.

The import statements in the README and __init__.py needed adjustments due to renaming of 'overcooked_environment' to 'environment'. This commit updates the relevant parts in the documentation to prevent any confusion for users of the 'cooperative_cuisine' package.

Renamed `overcooked_gui.py` to `gui.py` in multiple files across the project including README.md, study_server.py, __main__.py, and __init__.py. This modification will ensure consistency in referencing the graphic interface script.

The "gui_2d_vis" directory has been renamed to "pygame_2d_vis". All references to "gui_2d_vis" in imports and file paths throughout the code have been updated to the new name. The renaming is clearer about the visualization library used and aligns with project conventions for directory naming.

All instances of 'overcooked_simulator' have been replaced with 'cooperative_cuisine'. This includes changes in file paths, imports, and script names. The necessary adjustments to reflect this rename have also been made in the documentation, setup files, test scripts, and CI/CD configuration.

Resolve "Documentation"

Closes #92

See merge request scs/cocosy/overcooked-simulator!58

Resolve "Game Flow"

Closes #91

See merge request scs/cocosy/overcooked-simulator!62

# Conflicts:
#	setup.py

Resolve "Tutorial graph for meal recipes"

See merge request scs/cocosy/overcooked-simulator!64

# Conflicts:
#	overcooked_simulator/game_content/study/level1/level1_config.yaml
#	overcooked_simulator/game_content/study/study_config.yaml
#	overcooked_simulator/gui_2d_vis/overcooked_gui.py
#	overcooked_simulator/study_server.py

The code for the drop-off condition within the Overcooked simulator's counters module has been updated. The updated condition now checks not only if the item can be combined or matches the dispensing item's name but also checks if the undo dispenser pickup flag is true.

The commit introduces an option that allows dispensers in the Overcooked simulator to undo pickups of items in case of errors. This new setting, `undo_dispenser_pickup`, is now included in the `game` section of the environment configuration. Both the counter factory and dispenser have been updated to accommodate these changes.

This commit introduces thorough in-line documentation for different modules in the Overcooked simulator's code. This includes adding descriptions for classes, methods, and attributes across multiple files like recording.py, info_msg.py, hooks.py, effect_manager.py, etc. Additionally, explanations and examples of hooks have been provided where relevant. The overall readability and maintainability of the code is expected to improve with this change.