Skip to content

Commit 2c74381

Browse files
authored
Merge pull request #573 from srobo/sr2024-add-back-virtual-comp
Add back virtual competition documentation for SR2024
2 parents 985e355 + a1ceed3 commit 2c74381

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The information is spread across multiple sections:
1111

1212
- The [kit](/docs/kit/) section will give you an overview of the physical kit that is provided to your team, how to connect to each board and what features they have.
1313
- The [programming](/docs/programming/) section talks through how to write code that interacts with all the boards.
14-
- The [simulator](/docs/simulator/) section explains how to use the simulator for testing your code and exploring strategies.
14+
- The [simulator](/docs/simulator/) section explains how to use the simulator for testing your code, exploring strategies as well as preparing for the virtual competition.
1515
- The [rules](/docs/rules/) section is important as it talks through the aim of this year's game and what task you are trying to achieve.
1616
- [Tutorials](/docs/tutorials/) are a series of guides that will help you get started.
1717

simulator/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Simulator
77

88
![Image of the SR2024 arena rendered within the simulated environment]({{ site.baseurl }}/images/content/simulator/sr2024-arena.png)
99

10-
The simulator is a useful development tool, it allows you to become familiar with our API and to get started coding straight away even if you have yet to construct your robot.
10+
The simulator is used for the virtual competition and is a useful development tool, it allows you to become familiar with our API and to get started coding straight away even if you have yet to construct your robot.
1111
It could also be used to test out game strategies before applying them in real life.
1212

1313
## Programming

simulator/using_the_simulator.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,10 @@ If you run the simulation without a `robot.py` file in place, the simulation wil
7575
In order for your simulated robot to pick up changes to your code you need to save the files you are working on and then reload the simulation.
7676
This will also reset the state of the simulated world, allowing your robot to start afresh.
7777

78+
<div class="warning">
79+
Only your controller code will be present in the competition environment.
80+
</div>
81+
7882
### Running multiple robots
7983

8084
To test how your robot behaves in each starting zone of the arena, you can copy your robot's code to run in each corner.

0 commit comments

Comments
 (0)