Env update

[jyan1999]

Description

This is the PR for the overcooked-demo env update. Overcooked-demo is currently a directory under the main overcooked_ai repo.

The setup for overcooked_ai hasn't changed since most of the demo setup happens in docker.

To spin up a server, run overcooked-demo-up from the command line after setting up overcooked_ai. You don't have to be inside overcooked_ai.

There are 3 newly added options in the interface, which are all self-explanatory.

One thing to note is that if we set ticks-per-ai-action to anything larger than 1, the game will be blocked as it will be in a deadlocked state.

I will add a corresponding document update once the design (i.e. fps rate and potentially other things) is decided.

Fixes # (issue)

Type of change

• [ ] Bug fix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [x] Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [x] This change requires a documentation update

Checklist:

• [x] I have commented my code, particularly in hard-to-understand areas
• [x] I have made corresponding changes to the documentation
• [x] My changes generate no new warnings
• [x] I have added tests that prove my fix is effective or that my feature works

[codecov[bot]]

Codecov Report

Merging #110 (a059382) into master (2398fb4) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #110   +/-   ##
=======================================
  Coverage   82.15%   82.15%           
=======================================
  Files          16       16           
  Lines        3709     3709           
=======================================
  Hits         3047     3047           
  Misses        662      662           

Impacted Files	Coverage Δ
overcooked_ai_py/agents/agent.py	69.06% <0.00%> (ø)
overcooked_ai_py/planning/planners.py	84.89% <0.00%> (ø)
overcooked_ai_py/mdp/overcooked_mdp.py	92.34% <0.00%> (ø)

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more