Added what the player was holding to POST_COUNTER_PICK_UP

Updated Args in docstrings.

Added type hints and docstrings throughout the project, notably in the effects, orders, study server, and game server modules. These additions provide better understanding and ease in navigating through the codebase. Minor code reorganization and syntax optimization were also performed.

The code now contains a new hook named "additional_state_update" and accommodates accepting additional state content. This functionality is used to better manage player readiness states in the game_server module and includes updates to the get_state and get_json_state methods in the environment module. New changes also impact the environment configuration files.

Several sections of the codebase have been refactored for maintainability. The 'ORDERS' module has witnessed some cleanups and adjustments in the 'create_init_orders' method. Hooks and associated comments were added in the 'hooks' module for better understanding of code functionality. The 'pygame_2d_vis' script's documentation was also improved for clarity.

The main changes include enhancing methods in cooperative_cuisine/hooks.py, cooperative_cuisine/counters.py, and cooperative_cuisine/environment.py, and updating hooks. These changes greatly improve the handling of hooks and calls, provide explicit arguments for actions, and add more comprehensive documentation. This leads to better logging and debugging, higher code readability, and improved overall code structure in the cooperative_cuisine backend.

This commit refactors the setup of recorders and hooks in several configuration files. It simplifies the YAML structure, renames "extra_setup_functions" to "hook_callbacks", and replaces "log_path" with "record_path". This makes the configurations cleaner and more intuitive. The update also removes the "func" and "kwargs" in the extra setup functions. Now only hooks are registered. This change should not affect functionality, because until now only hooks were registered as extra setup functions.

Various changes have been made in the codebase to improve readability and maintainability. Type hints have been added to the functions and variables for better understanding of the datatypes. Refactoring of some code segments has also been done to make the code more concise and readable. The 'EffectType', 'ItemType' enumerations have been enriched with docstrings for better understanding of the enums. Certain classes have been updated to better follow the single responsibility principle.

The version in setup.py has been updated from 0.1.0 to 1.0.0. Additionally, the callback for sink interaction has been removed from hooks.py. The release date of version 1.0.0 has also been confirmed in the CHANGELOG.

This commit adds detailed docstrings for various methods and classes in the 'cooperative_cuisine' module for enhanced code understanding. Also includes minor changes to the .gitlab-ci.yml and pygame_2d_vis/__init__.py files and adds an image in the docs markdown file. Code readability and maintainability improved with these changes.

Enhanced overall code clarity by adding and revising detailed comments, docstrings, and typespecs in various Python modules. Significant changes include refining functionality of effect management in 'effects.py', modifications to use of 'numpy' arrays and functions in 'movement.py', as well as adjustments to handling hooks. Additionally, minor updates in 'configs/study/level1/level1_config.yaml' and 'counter_factory.py' were made.

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.

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.

The code now includes a new hook called 'drop_off_on_cooking_equipment'. This hook is used to track and score instances of players dropping off items on the cooking equipment in the Overcooked game simulator. This enhancement will allow for more detailed game simulations and scoring capabilities.

The updates have introduced an in-game information messages feature, allowing messages to be delivered to players during gameplay. This could be used to notify about certain events or conditions such as new fires or fire spreading. The updates also included the necessary hooks and message levels, which are 'Normal', 'Warning', and 'Success'. Furthermore, these messages can be displayed in the game's GUI.

The scoring system and order management have been significantly updated. The score calculation has been moved out from 'OrderManager' to external 'ScoreViaHooks' class which works via hooks. The order management updates include separating scoring from orders and removing unused functions. Changes in the configuration file and other related files updated to accommodate these modifications.

This update introduces comprehensive hook management, improved environment setup functions, and a new class for logging and recording simulations. The enhanced hook management ensures better callback registration and tracing of specific simulation events. Extra setup functions allow more flexibility in setting parameters from the environment config. The new logging and recording class makes it easier to capture simulation data in a structured format for analysis. Various minor fixes and code refactoring are also included.

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.