From 410e40fd92dfeb401dcff43ea7e625a07c7088a6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Florian=20Schr=C3=B6der?=
<florian.schroeder@uni-bielefeld.de>
Date: Wed, 31 Jan 2024 23:29:27 +0100
Subject: [PATCH] Update 2 files
- /README.md
- /overcooked_simulator/__init__.py
---
README.md | 2 +-
overcooked_simulator/__init__.py | 15 +++++++--------
2 files changed, 8 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 3a51e9e6..7da169c9 100644
--- a/README.md
+++ b/README.md
@@ -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
diff --git a/overcooked_simulator/__init__.py b/overcooked_simulator/__init__.py
index 08bf9654..5d7acaea 100644
--- a/overcooked_simulator/__init__.py
+++ b/overcooked_simulator/__init__.py
@@ -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
--
GitLab