Quick Start

Prerequisites

Before installing, check the following prerequisites:

• Python 3.13 or later

• pip

Installing the Package

To install the package, run the following command:

pip install rcrscore@git+https://github.com/adf-python/rcrs-core-python@v0.2.3
pip install git+https://github.com/adf-python/adf-core-python.git

Creating a New Agent

To create a new agent, run the following command:

adf-core-python

When you run it, an interactive prompt like the following will appear:

Your agent team name: my-agent
Creating a new agent team with name: my-agent

After you enter the values, a template for the agent will be created in the current directory.

.
└── my-agent
    ├── config
    │   ├── development.json
    │   ├── launcher.yaml
    │   └── module.yaml
    ├── main.py
    └── src
        └── my-agent
            ├── __init__.py
            └── module
                ├── __init__.py
                └── complex
                    ├── __init__.py
                    ├── sample_human_detector.py
                    ├── sample_road_detector.py
                    └── sample_search.py

Running the Agent

To run the agent, start the simulation server and run the following command:

python main.py

The agent will start running and communication with the simulation server will begin.