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

Add back virtual competition documentation for SR2024 #573

Merged
merged 2 commits into from
Nov 9, 2023
Merged

Add back virtual competition documentation for SR2024 #573

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
21e738a
Revert "Remove an indirect mention of the virtual competition"
prophile Nov 9, 2023
a1ceed3
Revert "Remove mentions of the virtual competition"
prophile Nov 9, 2023
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
2 changes: 1 addition & 1 deletion index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The information is spread across multiple sections:

- 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.
- The [programming](/docs/programming/) section talks through how to write code that interacts with all the boards.
- The [simulator](/docs/simulator/) section explains how to use the simulator for testing your code and exploring strategies.
- 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.
- 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.
- [Tutorials](/docs/tutorials/) are a series of guides that will help you get started.

Expand Down
2 changes: 1 addition & 1 deletion simulator/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: Simulator

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

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.
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.
It could also be used to test out game strategies before applying them in real life.

## Programming
Expand Down
4 changes: 4 additions & 0 deletions simulator/using_the_simulator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,10 @@ If you run the simulation without a `robot.py` file in place, the simulation wil
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.
This will also reset the state of the simulated world, allowing your robot to start afresh.

<div class="warning">
Only your controller code will be present in the competition environment.
</div>

### Running multiple robots

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.
Expand Down