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.

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

The setup.py file has been modified to require a more up-to-date version of the pydantic package. It has been updated from version 2.5.3 to 2.6.3.

The comments in various class definitions and methods across the code were reorganized to provide better clarity and readability. The handling of server default values has been centralized in utils.py for cleaner code and easier modifications in the future.

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'.