Skip to content

Commit 2d6787e

Browse files
committed
More detailed simulation download instructions
This explicitly notes the relationship between the user-code and the simulation files. Fixes #397 Fixes srobo/competition-simulator#280
1 parent 0eb3b1d commit 2d6787e

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

simulator/index.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,19 @@ You will also need Python installed.
2828

2929
### Installing the simulation
3030

31-
1. [Download the simulation](https://github.com/srobo/competition-simulator/releases/download/sr2023.1/competition-simulator-sr2023.1.zip), and unzip it somewhere on your computer.
32-
2. Using the Webots IDE, open the `worlds/Arena.wbt` file.
31+
1. Create a directory, perhaps called `simulation` where you will store your robot code.
32+
2. [Download the simulation](https://github.com/srobo/competition-simulator/releases/download/sr2023.1/competition-simulator-sr2023.1.zip)
33+
and unzip it as a subdirectory of that directory:
34+
```
35+
simulation
36+
├── competition-simulator-<version>
37+
│ ├── ...
38+
│ └─ worlds
39+
│ └── Arena.wbt
40+
└── robot.py
41+
```
42+
If there is not an existing `robot.py` an example one will be created when the simulator first runs.
43+
3. Using the Webots IDE, open the `worlds/Arena.wbt` file.
3344

3445
You may receive a warning about your computer's GPU not being good enough, which can be ignored.
3546

0 commit comments

Comments
 (0)