Tutorial

Getting Started with
aira Beta 1.7

Set up your environment, run the simulation, and submit your first result to the leaderboard — no prior AI experience needed.

01

Fork the Repository

Forking creates your own copy on GitHub where you can save progress and experiment freely.

Open the repository and click the Fork button in the top-right corner.

Open virtual-robot-race on GitHub →

Then clone your fork to your local machine:

bash
git clone https://github.com/YOUR_NAME/virtual-robot-race.git
cd virtual-robot-race
02

Set Up Your Environment

Run the setup script to install all Python dependencies automatically.

On Windows, double-click or run from Command Prompt / PowerShell:

cmd
setup_env.bat

Or manually with pip:

bash
pip install -r requirements.txt
Python 3.12 or later is recommended (3.13 also works).
03

Set Your Race Name

Your race name links your results to the leaderboard. It must match your aira display name exactly.

Open config.txt in the repository root and set your name:

ini
# config.txt
NAME=YourAiraName          # ← A-Z, a-z, 0-9, underscore, max 16 chars
COMPETITION_NAME=Tutorial  # use Tutorial for practice
RACE_FLAG=0                # keep 0 for practice runs
Your aira display name must match NAME= exactly. Set it in your dashboard before racing.
Set your display name in Dashboard →
04

Launch the Simulator

Run a single command — Unity launches automatically and the race begins.

Run main.py from your terminal:

bash
python main.py
Unity launches automatically. You do not need to start it manually.
05

Modify & Experiment

The default mode is rule-based. Edit the algorithm and see how it changes your robot's behaviour.

Your main algorithm file is here:

text
Robot1/rule_based_algorithms/driver_model.py

Switch control modes in config.txt:

ini
R1_MODE_NUM=3   # 1=keyboard  2=csv  3=rule_based  4=ai
Read the full lesson docs →
06

Submit to the Leaderboard

When you're ready to compete, flip the race flag — your result will be posted automatically.

In config.txt, set:

ini
RACE_FLAG=1   # results will be posted after the run

After the race finishes, your score is sent automatically. Check the leaderboard on the top page.

View active competitions →
Rankings

Tutorial Leaderboard

All submissions — newest first.

LOADING...

Ready to compete?

Join an active competition and put your algorithm to the test.

View Competitions →