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.

Added 'generated' to .gitignore, updated pdoc footer text in .gitlab-ci.yml, and included interaction state for player in player.py. The player interaction with the counter is now being tracked and a new comment was added for the progress method. This will enhance player's tracking and usage in the game environment.

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.

Changed the pdoc execution command in the .gitlab-ci.yml to fix the link in the footer text. Adjustments were also made to the layout of the game in the basic.layout and __init__.py files, along with the game, player, and effect configurations. The player speed was reduced, the ability to undo dispenser pickup was added, and the effect

The provided modifications involve an update to the .gitlab-ci.yml file to include a footer text in the project documentation. There's also an additional point added to the CHANGELOG.md file under the 'study participants' section for clarity. Furthermore, the README.md has been slightly restructured to explicitly mention the availability of extensive project details in the documentation.

Updated the pdoc command in .gitlab-ci.yml file to correct the hyphen usage in the "footer_text" flag. The CHANGELOG.md is significantly expanded to provide a more detailed and organized account of changes with version releases, following the guidelines from keepachangelog.com.

The CI configuration file and several Python scripts were updated for better adherence to best practices. The CI now includes a footer in the pdoc document generation step. Moreover, variable names and import paths were updated to be more explicit and clear. Some paths in the scripts were also generalized. In addition, the json.dumps function was used to print the create_json_schema function's output in a prettier format. Lastly, minor modifications were made to the README and comments for better clarity and understanding.

Added a favicon parameter to the pdoc command in the .gitlab-ci.yml file. This results in the favicon being specified during the documentation generation process. This change should improve the importance of the favicon when the documentation is viewed in a browser tab.

A missing comma was discovered and corrected in the game_port argument on the study_server.py file. This could potentially prevent syntax errors and bugs that might result from incomplete statements and ensure smoother execution of the function.

The argument names in the main function calls within study_server.py and game_server.py were updated for clarity. These changes better reflect their function within these scripts, making the code easier to understand and maintain. The modifications primarily involve changing 'url' and 'port' to 'game_url' and 'game_port', and 'port' to 'study_port'.

The updates address issues with empty meal lists during order creation. When no meals are available, no orders will be created, returning empty lists instead. Furthermore, the mandatory meal assertion in the environment's validate_environment method has been commented out. The meal list in the level1 config has been updated to only include 'Burger'.

Modified url_and_port_arguments to follow cli args standards in cooperative_cuisine/utils.py, changing '-study' to '-s' and '-game' to '-g'. Adjusted the placement of 'player' argument in the methods in cooperative_cuisine/counters.py. Also, refactored the method _do_single_tool_interaction to be a static method.

Resolve "Refactoring Environment class + file"

Closes #101

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

The 'recipes.py' module is renamed to 'validation.py' and the 'RecipeValidation' class is renamed to 'Validation'. The code is refactored to use f-strings for better readability. Graph generation has also been improved by simplifying the way edges are added and returning information as a dictionary. An unnecessary png file generation has been removed. Changes have been made where these classes are imported and used.

# Conflicts:
#	cooperative_cuisine/configs/study/study_config.yaml
#	cooperative_cuisine/environment.py

The specific layout configuration in cooperative_cuisine has been modified. A certain object or layout component (represented by 'O') was removed. Additionally, the string on the last line has been slightly adjusted.

Resolve "Sprites update"

Closes #99

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

Resolve "Recipe Graph, item validation, recipe vis - Maybe with images"

Closes #74

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

The game **items** description has been moved down the list for better organization and readability in cooperative_cuisine/__init__.py file. This change doesn't affect the functionality but improves the structure of the documentation.

The module 'game_items' was renamed to 'items'. Every reference to this module across different source code files was consequently updated to reflect this change.

The EffectManager class along with related effects have been moved to a newly created effects.py module. Also, instead of importing from cooperative_cuisine.effect_manager, the rest of the code now imports from cooperative_cuisine.effects. This is mainly to improve the project structure and to clarify the code organization, and avoid circular import issues.

Action, ActionType, and InterActionData classes have been moved from the environment module into a separate file named action.py. All imports have been adjusted to reflect this change. This provides a clearer structure and improves modularity in the code, as all action related classes and enums are now organized in a single module.

The 'all_players_ready' field was moved from 'state_representation.py' to 'game_server.py'. Instead of being part of the initial state of the game, it's now part of the server environment, making it easier to keep track of the readiness of all players. Additionally, the game configuration in 'study_config.yaml' was updated to accommodate one player instead of two and no bots.

The player addition test has been updated to check for error handling. Now, it checks if adding a player with an already existing name raises a ValueError, instead of testing for a restriction in player count.

Made updates across multiple files targeting the usage and setting of configuration files. Several path settings have been altered, and the logic in the study server has been revised. Changes were also made in the file imports and other operations related to configurations and paths. Additionally, a validation check is added to warn if a player with the same name already exists in the environment.