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 'player_config' dictionary is replaced with the PlayerConfig class to provide type-checking and improve readability. This change is applied across different files in the 'cooperative_cuisine' module. Additionally, this commit improves type hints for several variables and parameters to assist with code interpretation and potential error prevention.

Docstrings across classes and functions in different modules have been adjusted for consistency, specifically in how Return and Raise explanations are formatted. This makes the code more readable and uniform. Additionally, the environment name in 'environment.py' has been updated from "overcooked_sim" to "cooperative_cuisine_1".

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.

Resolve "record relevent game events with hooks"

Closes #109

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

Resolve "More tests"

Closes #110

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

The refactoring involved creating a new function to handle game server requests for cleaner and more concise code. Changes were also made to the formatting of commit messages for better readability. Invalid game environment configurations are now dealt with accordingly to prevent game errors. Several updates were made to the tests to ensure they accurately measure the performance and functionality of the game.

# Conflicts:
#	cooperative_cuisine/items.py

Added docstrings to constructors of several classes in various modules to improve code readability and maintainability. Also, explicit type hints were provided for the fields in these classes aiding in better understanding of the data types used across the codebase.

Implemented multiple code adjustments across various Python modules, including renaming variables for clarity and improving data type definition. Added comprehensive docstrings to all functions and classes to enhance code readability and maintainability. Corrected a bug in debug parameter where it incorrectly employed args.debug, replacing it with args.do_study for correct implementation.

This change replaces the --debug argument in the utilities file with --do-study, changing its default to True. Moreover, the new argument disables additional debug/admin elements.

Resolve "Study instructions"

Closes #106

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

# Conflicts:
#	cooperative_cuisine/counters.py

The code has been refactored to clarify the functionality of various components and improve type hinting. Documentation for methods has been expanded. The return types of to_dict methods in several classes have been changed to return CounterState. The Counter class now correctly handles cases where an Item or Iterable[Item] is occupied. An unnecessary Boolean attribute, all_players_ready, has been commented out. Manual normalization of orientation vectors has been introduced.

The classes across several files have been modified to improve clarity, provide better comments, and refine attribute representations. This commit involves refactoring the item, effect, and player classes to include more detailed descriptions and user-friendly outputs. The change also simplifies some methods and eliminates redundancies for cleaner and more efficient code.