diff --git a/README.md b/README.md index e266fce58b7a96956c513e436c9cd7a6eaa62986..3178ef82b4e671f6d05d1b8cd1f82a0ab4a877f4 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,51 @@ The real-time overcooked simulation for a cognitive cooperative system +**The name ist still work in progress and we will probably change it.** + +## Installation +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 higher environment. Either conda or PyEnv. + +### Local Editable Installation +In your `repo`, `PyCharmProjects`` or similiar directory with the correct environment active: +```bash +git clone https://gitlab.ub.uni-bielefeld.de/scs/cocosy/overcooked-simulator.git +cd overcooked_simulator +pip install -e . +``` + +#### Run +You can use it in your Python code or run the main.py from the command line: +```bash +python3 overcooked_simulator/main.py +``` + +### Library Installation +The correct environment needs to be active: +```bash +pip install overcooked-environment@git+https://gitlab.ub.uni-bielefeld.de/scs/cocosy/overcooked-simulator@main +``` + +#### Run +You can now use the environment and/or simulator in your python code. Just by importing it `import overcooked-environment` + +## Configuration +The environment configuration is currently done with 3 config files + GUI configuration. + +### Item Config +The item config defines which ingredients, cooking equipment and meals can exist and how meals and processed ingredients can be cooked/created. + +### Layout Config +You can define the layout of the kitchen via a layout file. The position of counters are based on a grid system, even when the playere do not move grid steps but continous steps. Each character defines a different type of counter. + +### Environment Config +The environment config defines how a level/environment is defined. Here, the available plates, meals, order and player configraation is done. + +### PyGame Visualization Config +Here the visualisation for all objects is defined. Reference the images or define a list of base shapes that represent the counters, ingrredients, meals and players. + + ## Troubleshooting ```cannot open shared object file: No such file or directory (search paths /usr/lib/x86_64-linux-gnu/dri:\$${ORIGIN}/dri:/usr/lib/dri, suffix _dri)``` @@ -11,4 +56,4 @@ if you have a conda environment: ```bash conda install -c conda-forge libstdcxx-ng -``` \ No newline at end of file +```