- /README.md
- /overcooked_simulator/__init__.py

The changes made are focused on improving the readability of code comments and clarifying the purpose of sections within the 'overcooked_simulator'. Formatting changes were made to separate headers for better readability and the meaning of certain terms, like 'extra_repr' in 'game_items.py', was clarified further.

This commit improves the readability of project documentation in `overcooked_simulator/__init__.py` file. Specifically, it separates the text about direct integration into separate lines for clarity and tidies up the example YAML configuration, consistently indenting the different sections of the content.

The changes include improving the wording in readme files, from 'Python 3.10 or higher' to 'Python 3

Documentation has been updated to provide better clarity on the layout and equipment configuration. The README file now includes information on defining counter mappings in the Environment config. The code examples in comments within the counters.py file have also been reformatted and updated, specifically those related to defining equipment types and dispenser characters. The additional change includes an expanded section in the __init__.py file on environment and item configuration.

The code changes include renaming the 'category' field from "Cooking Equipment" to "ItemCookingEquipment" in sample_state.json. The documentation has also been updated with more detailed explanations on how the system works, including how to install and use it. A few function signatures were changed and additional explanation comments were included in the counters.py and utils.py files for better code clarity.

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.