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.

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.

# Conflicts:
#	cooperative_cuisine/state_representation.py

Better management of when keyboard or controller button to continue is pressed. Updated thank you screen.

This update adds several darker shades of gray (from GRAY2 to GRAY9) to the game_colors file. These additions provide more color options for game elements, ensuring a better visual experience for users. The color values have been moved for improved organization and readability.

Added HTML color preview comments for each color constant in the game file. This should provide better visualization during code read-throughs, aiding in understanding and debugging process. Replaced generic color name in the blue color preview with the specific hex value.

In the cooperative_cuisine/__init__.py, the action_type in the action object is updated to PICK_UP_DROP from its previous value PUT. This change accommodates a need for more specific player actions.

Improved the clarity and precision of language used in the CHANGELOG.md file. Specifically, this includes modifying ambiguous sentences and rectifying grammatically incorrect sentences to enhance overall readability.

The PAUSED variable, which was unused, has been removed from the codebase to improve readability. Docstrings were added to multiple existing methods and instance variables in the environment.py file for better understanding of their functionalities. This change will make it easier for developers to understand the purpose and usage of the various methods and variables, ultimately smoothing the development process.

The ActionType.PUT has been replaced with ActionType.PICK_UP_DROP across all instances in the codebase. This change aligns the action name with its actual function, making the action more intuitive and the code easier to understand. This update also includes minor modifications in comments and function arguments to reflect the new action name.

Merge branch '102-too-large-number-of-selected-players-does-not-break-the-gui-and-environment' into 'main'

Resolve "Too large number of selected players does not break the gui and environment"

Closes #102

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

Merge remote-tracking branch 'origin/main' into 102-too-large-number-of-selected-players-does-not-break-the-gui-and-environment

# Conflicts:
#	cooperative_cuisine/study_server.py