Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme update and manual_control #77

Merged
merged 3 commits into from
Dec 5, 2022
Merged

Readme update and manual_control #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
34afc7b
added instructions in manual_control
BolunDai0216 Dec 4, 2022
f2f0602
updated readme
BolunDai0216 Dec 4, 2022
cccced9
updated readme
BolunDai0216 Dec 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,18 +72,24 @@ This simulator was created as part of work done at [Mila](https://mila.quebec/).
## Installation

Requirements:
- Python 3.5+
- Python 3.7+
- Gymnasium
- NumPy
- Pyglet (OpenGL 3D graphics)
- GPU for 3D graphics acceleration (optional)

You can install all the dependencies with `pip3`:
You can install it from `PyPI` using (image broken do not use yet):

```console
python3 -m pip install miniworld
```
git clone https://github.com/maximecb/gym-miniworld.git
cd gym-miniworld
pip3 install -e .

You can also install from source:

```console
git clone https://github.com/Farama-Foundation/Miniworld.git
cd Miniworld
python3 -m pip install -e .
```

If you run into any problems, please take a look at the [troubleshooting guide](docs/troubleshooting.md).
Expand All @@ -107,7 +113,7 @@ There is also a script to run automated tests (`run_tests.py`) and a script to g
### Offscreen Rendering (Clusters and Colab)

When running MiniWorld on a cluster or in a Colab environment, you need to render to an offscreen display. You can
run `gym-miniword` offscreen by setting the environment variable `PYOPENGL_PLATFORM` to `egl` before running MiniWorld, e.g.
run `gym-miniworld` offscreen by setting the environment variable `PYOPENGL_PLATFORM` to `egl` before running MiniWorld, e.g.

```
PYOPENGL_PLATFORM=egl python3 your_script.py
Expand Down
6 changes: 6 additions & 0 deletions scripts/manual_control.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@
if args.domain_rand:
env.domain_rand = True

print("============")
print("Instructions")
print("============")
print("move: arrow keys\npickup: P\ndrop: D\ndone: ENTER\nquit: ESC")
print("============")

env.reset()

# Create the display window
Expand Down