# Conflicts:
#	overcooked_simulator/overcooked_environment.py

Resolve "Burnt Meals and Ingredients"

Closes #82

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

# Conflicts:
#	overcooked_simulator/gui_2d_vis/drawing.py

Resolve "Fire Fire Everywhere "

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

Resolve "Determine Counter Facing Direction"

Closes #68

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

# Conflicts:
#	overcooked_simulator/counters.py
#	overcooked_simulator/gui_2d_vis/drawing.py

# Conflicts:
#	overcooked_simulator/counters.py
#	overcooked_simulator/gui_2d_vis/drawing.py
#	overcooked_simulator/gui_2d_vis/visualization.yaml
#	overcooked_simulator/overcooked_environment.py

The append call to the progressing_counters list in tests/test_start.py has been removed. This was deemed unnecessary because there was no subsequent use or reference to this call in the entire codebase, improving the code cleanliness and readability.

Added the definition and interactions for game effects and tools. The effect type was introduced to influence the player's interactive abilities or alter item's attributes. The tool type extends the player's interactive abilities. It also includes the part related to fire and fire extinguisher for more realistic simulation.

The random module is replaced with random instance across multiple classes within 'overcooked_simulator' to make the randomness in the Overcooked simulator controllable. The 'random' instance is initialised with a seed in 'overcooked_environment' and then passed to the classes that require randomness. This improves reproducibility of experiments, as the randomness can be controlled by the seed value.

A `waste_progress` attribute has been added to track the progress of burnt items. Changes also include the visualization of burnt items in greyscale and additional definitions for various types of burnt meals in Overcooked Simulator. This update enhances both the gameplay and its realism, indicating when an item is overcooked or burnt.

The code for calculating the progress bar's position within the grid in gui_2d_vis/drawing.py has been clarified. Instead of directly manipulating the `pos` variable, a new `bar_pos` variable has been introduced. This revision enhances readability and maintains the integrity of the `pos` value.

Resolve "Hooks"

Closes #78

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

The dummy callbacks previously used for testing in the file 'overcooked_environment.py' have been removed. This has been done to avoid redundancy and ensure cleaner code. The comments referencing these callbacks have been updated accordingly.

The refactoring moves the redundant callback registrations from `overcooked_environment.py` to a dedicated function, `add_dummy_callbacks`, in `hooks.py`. This restructure streamlines the code and improves readability by reducing clutter in the Overcooked Environment initialization method.

This commit introduces specific event hooks for key game moments within the overcooked simulator. These include events like serving a non-ordered meal, starting to use the sink, completing an order, and using the trashcan. Callbacks were registered for these hooks to provide real-time feedback such as messages. Also, a typo in POST_PERFORM_ACTION parameter was corrected.

Added a Hooks class to monitor events related to player actions, item interactions, and state changes in the game environment. A hook triggers a corresponding event when a specific action takes place, such as a player picking up an item or a game state changing. This feature will make debugging easier and provide valuable insights during gameplay.

Resolve "Type hint class for environment config"

Closes #75

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

The EnvironmentConfig and OrderConfig classes, previously defined in the utils.py file, were moved to their respective modules overcooked_environment.py and order.py. This change creates a central location for configuration and reduces unnecessary dependencies in the utils.py file.

# Conflicts:
#	overcooked_simulator/utils.py

- /README.md
- /overcooked_simulator/__init__.py

The changes made are focused on improving the readability of code comments and clarifying the purpose of sections within the 'overcooked_simulator'. Formatting changes were made to separate headers for better readability and the meaning of certain terms, like 'extra_repr' in 'game_items.py', was clarified further.

This commit improves the readability of project documentation in `overcooked_simulator/__init__.py` file. Specifically, it separates the text about direct integration into separate lines for clarity and tidies up the example YAML configuration, consistently indenting the different sections of the content.

The changes include improving the wording in readme files, from 'Python 3.10 or higher' to 'Python 3

Documentation has been updated to provide better clarity on the layout and equipment configuration. The README file now includes information on defining counter mappings in the Environment config. The code examples in comments within the counters.py file have also been reformatted and updated, specifically those related to defining equipment types and dispenser characters. The additional change includes an expanded section in the __init__.py file on environment and item configuration.

The code changes include renaming the 'category' field from "Cooking Equipment" to "ItemCookingEquipment" in sample_state.json. The documentation has also been updated with more detailed explanations on how the system works, including how to install and use it. A few function signatures were changed and additional explanation comments were included in the counters.py and utils.py files for better code clarity.