The updates include adding docstrings and type hinting to several classes and methods in multiple Python files. This commit also includes fixes for inconsistent code formatting and minor bugs. The docstrings provide essential details about the classes and methods, improving readability and understanding for other developers. Furthermore, the added type hinting will enable better IDE assistance, static analysis, and clarity on expected input and output types. Lastly, the code formatting fixes and bug fixes enhance the overall code quality and maintainability.

An argparse has been added to the overcooked simulator script for better configuration of the command line interface. This allows the user to input the state file, visualization configuration and output filename when executing the script. As a result, the need to manually update these parameters in the script has been mitigated.

Resolve "Create only an image for a json state"

Closes #73

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

Added sample json file for testing (could change/break in future), added saving images created from states.

Resolve "Finalize coordinate system"

Closes #76

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

The argument parser and related function calls have been moved from the `__main__` function in the Overcooked Simulator to the `main` function. This change streamlines the function calls and improves code readability and management. Furthermore, it ensures that essential configurations are in place before the game server and GUI are initiated.

Resolve "Drawing order of counters and things on top"

Closes #48

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

Resolve "Counter Factory"

Closes #61

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

Resolve "Trashcan usage can affect the score"

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

Refactored the way layout file paths are stored and accessed within the Overcooked simulator GUI. Now, layout file paths are stored in a dictionary which allows for more efficient and flexible usage when setting up the environment. The drop-down menu now initializes with 'basic.layout' as the default option, if it exists, otherwise a random layout is chosen.

# Conflicts:
#	overcooked_simulator/game_server.py

# Conflicts:
#	overcooked_simulator/game_server.py

The commit incorporates the state changes for the 'reset_button' in different scenarios in the overcooked_gui.py file. The reset button is now configured to either show or hide during particular instances of the game, enhancing the user interaction by providing clearer game state transitions.

The instructions for starting the Overcooked game server and GUI have been updated. They now include manager_ids as extra arguments, which are necessary for proper setup. This changelog is reflected in the __init__.py file of the overcooked_simulator directory.

The README.md file has been updated with revised instructions on initiating game server and GUI, specifically the inclusion of manager_ids as arguments. The argument type for manager_ids in utils.py is also altered from list to string. Exception handling in overcooked_gui.py has been improved to explicitly throw a value error when encountering forbidden requests.

An optional argument for the list of manager IDs was added across the Overcooked simulator. These IDs are now used for authorization purposes when creating environments. Unauthorized attempts now return HTTP error 403. This helps enhance security and control over environment management in the simulation.

This update introduces a penalty computation for items that the player puts into the trash in the Overcooked simulator. A new function has been added onto the Order class to calculate this penalty, and the Trashcan class has been updated to use this new function whenever an item is dropped off. This change helps to further emulate real gameplay mechanics.

This commit provides a significant overhaul of various aspects within the overcooked_simulator's 2D visualization and GUI components. The changes include adjusting the game window and grid size, simplifying the drawing methods by removing redundancy, and enhancing the theme configuration for the GUI. This makes the code cleaner and easier to maintain, besides improving the visual style of the GUI.

The `overcooked_environment.py` file has been significantly refactored to streamline handling of counter setup. Post counter setup responsibilities have been shifted to the `CounterFactory` class. A utility function, `get_closest`, has been introduced in `utils.py` to determine the closest counter and is used in multiple classes. Minor updates are also made across several other classes for optimization and clarity. The 'other' score in `environment_config.yaml` has been changed from 0 to 20.

The commit refines the way the 'progress' method is called on counters in the overcooked simulator. Utilizing Python's introspection functions, the update identifies the relevant counter classes dynamically on setup, and stores them. Simplified calls to these relevant counters are then performed during steps in the simulation. Additionally, the code now checks the superclass with the built-in 'issubclass' function to create counters.

The print statements that are outputting the kitchen height in the overcooked_environment.py file, the command line arguments in the __main__.py file, and a redundant check in the counter_factory.py file have been removed. This is in an effort to declutter the console output and streamline the code.

The code changes include addition of in-line comments and docstrings, which clarify the purpose and functionality of various elements in the overcooked_environment and counter_factory modules. Several new comments explain the use of certain variables and functions, and additional explanations are offered for existing sections. This is part of an ongoing effort to improve the maintainability and readability of the codebase.

This commit simplifies the overcooked environment by refactoring the way counters are created and managed. A new CounterFactory class is introduced, offloading logic from the environment class. In addition, the symbol to character mapping and other environment-related configurations are moved to a separate YAML file. The .gitignore file is also updated to ignore the 'playground' directory. Making these changes enhances code maintainability and readability.