Skip to content
Snippets Groups Projects
Commit 7f8f3d02 authored by Florian Schröder's avatar Florian Schröder
Browse files

Update import statements in documentation

The import statements in the README and __init__.py needed adjustments due to renaming of 'overcooked_environment' to 'environment'. This commit updates the relevant parts in the documentation to prevent any confusion for users of the 'cooperative_cuisine' package.
parent dbe35530
No related branches found
No related tags found
1 merge request!67Resolve "File, dir renaming"
Pipeline #47414 passed
...@@ -59,7 +59,7 @@ pip install overcooked-environment@git+https://gitlab.ub.uni-bielefeld.de/scs/co ...@@ -59,7 +59,7 @@ pip install overcooked-environment@git+https://gitlab.ub.uni-bielefeld.de/scs/co
#### Run #### Run
You can now use the environment and/or simulator in your python code. Just by importing You can now use the environment and/or simulator in your python code. Just by importing
it `import overcooked_environment` it `import cooperative_cuisine`
## Configuration ## Configuration
......
...@@ -94,7 +94,7 @@ import json ...@@ -94,7 +94,7 @@ import json
import dataclasses import dataclasses
from websockets import connect from websockets import connect
from cooperative_cuisine.overcooked_environment import Action, ActionType, InterActionData from cooperative_cuisine.environment import Action, ActionType, InterActionData
from cooperative_cuisine.utils import custom_asdict_factory from cooperative_cuisine.utils import custom_asdict_factory
...@@ -154,14 +154,14 @@ requests.post( ...@@ -154,14 +154,14 @@ requests.post(
``` ```
## Direct integration into your code ## Direct integration into your code
You can use the `cooperative_cuisine.overcooked_environment.Environment` class You can use the `cooperative_cuisine.environment.Environment` class
and call the `step`, `get_json_state`, and `perform_action` methods directly. and call the `step`, `get_json_state`, and `perform_action` methods directly.
```python ```python
from datetime import timedelta from datetime import timedelta
from cooperative_cuisine import ROOT_DIR from cooperative_cuisine import ROOT_DIR
from cooperative_cuisine.overcooked_environment import Action, Environment from cooperative_cuisine.environment import Action, Environment
env = Environment( env = Environment(
env_config=ROOT_DIR / "game_content" / "environment_config.yaml", env_config=ROOT_DIR / "game_content" / "environment_config.yaml",
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment