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

Update 2 files

- /README.md
- /overcooked_simulator/__init__.py
parent c5bc8943
No related branches found
No related tags found
No related merge requests found
Pipeline #45216 passed
......@@ -10,7 +10,7 @@ The real-time overcooked simulation for a cognitive cooperative system.
You have two options to install the environment. Either clone it and install it locally or install it in your
site-packages.
You need a Python 3.10 or greater environment. Either conda or PyEnv.
You need a Python 3.10 or newer environment. Either conda or PyEnv.
### Local Editable Installation
......
......@@ -5,7 +5,7 @@ This is the documentation of the Overcooked Simulator.
# About the package
The package contains an environment for cooperation between players/agents. A PyGameGUI visualizes the game to
human or visual agents in 2D. A 3D web-enabled version (for example for online studies, currently under development)
human or virtual agents in 2D. A 3D web-enabled version (for example for online studies, currently under development)
can be found [here](https://gitlab.ub.uni-bielefeld.de/scs/cocosy/godot-overcooked-3d-visualization).
# Background / Literature
......@@ -21,7 +21,7 @@ like a "real" cooperative / human partner.
# Installation
You need a Python **3.10** or greater environment.
You need a Python **3.10** or newer environment.
```bash
pip install overcooked-environment@git+https://gitlab.ub.uni-bielefeld.de/scs/cocosy/overcooked-simulator@main
```
......@@ -33,8 +33,8 @@ pip install -e .
```
# Usage / Examples
Our overcooked simulator is designed for real time interaction but also with reinforcement
learning in mind (gymnasium environment). It focuses on configurability, extensibility and appealing visualization
Our overcooked simulator is designed for real time interaction but also for reinforcement
learning (gymnasium environment) with time independent step function calls. It focuses on configurability, extensibility and appealing visualization
options.
## Human Player
......@@ -44,7 +44,7 @@ Run it via the command line (in your pyenv/conda environment):
overcooked-sim --url "localhost" --port 8000
```
*The arguments are the defaults. Therefore, they are optional.*
*The arguments shown are the defaults.*
You can also start the **Game Server** and the **PyGame GUI** individually in different terminals.
......@@ -82,14 +82,13 @@ create_env = CreateEnvironmentConfig(
layout_config=layout,
).model_dump(mode="json")
env_info = requests.post("http://localhost:8000/manage/create_env", json=create_env)
if env_info.status_code == 403:
raise ValueError(f"Forbidden Request: {env_info.json()['detail']}")
env_info: CreateEnvResult = env_info.json()
env_info = requests.post("http://localhost:8000/manage/create_env", json=create_env)
```
Connect for each player a websocket (threaded or async).
Connect each player via a websocket (threaded or async).
```python
import json
import dataclasses
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment