Skip to content

Commit

Permalink
feat(overcooked): Basic README
Browse files Browse the repository at this point in the history
  • Loading branch information
tobiges committed Sep 5, 2024
1 parent c7941eb commit 26bbfe1
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions jaxmarl/environments/overcooked_v2/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# OvercookedV2

OvercookedV2 is an extended version of the original Overcooked environment. It introduces meaningful partial observability and increased stochasticity to enable more complex coordination challenges.

## Key Features

- Configurable agent view radius
- Multiple ingredients and recipes
- Asymmetric information through recipe indicators
- Randomized starting positions and directions
- Grounded communication via button recipe indicators
- Flexible layout creation

## Custom Layouts

Create custom layouts using ASCII strings:

```python
layout = """
WWPWW
0A A1
L R
WBWXW
"""
recipes = [[0,0,1], [0,1,1]]
custom_layout = Layout.from_string(layout, possible_recipes=recipes)
```

## Pre-configured Layouts

See `layouts.py` for a variety of pre-configured layouts:

- Adaptations of original Overcooked layouts
- Extended Cat-Dog problem layouts
- Test-time coordination challenge layouts

## Observations

Observations are structured as a width x height x num_channels tensor, with partial observability based on the configured view radius.

## Rewards

- 20 points for correct deliveries
- Optional -20 points for incorrect deliveries
- Shaped rewards for actions aligned with the current recipe

## Visualization and Interactive Play

- JIT-compiled rendering pipeline for efficient episode visualization
- Interactive mode for playing alongside trained policies

0 comments on commit 26bbfe1

Please sign in to comment.