roadrunner-core

Connect MATLAB to RoadRunner and manage project, scene, and scenario lifecycles.

995|122|Updated Apr 3, 2026
One-click install
npx skills add https://github.com/matlab/matlab-agentic-toolkit --skill roadrunner-core
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: roadrunner-core
Source: https://github.com/matlab/matlab-agentic-toolkit/tree/main/skills-catalog/automotive/roadrunner-core
Command: npx skills add https://github.com/matlab/matlab-agentic-toolkit --skill roadrunner-core

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Working with RoadRunner from MATLAB requires correct path setup, connection handling, and careful lifecycle management of projects, scenes, and scenarios. This Skill gives an AI agent the exact, verified API patterns to initialize RoadRunner, avoid hallucinated function calls, and prevent data loss from unsaved changes or invalid handles.

Core Features & Use Cases

  • Connection & Initialization: Connect to a running RoadRunner instance or launch a new one with saved settings, including headless and custom-port modes.
  • Lifecycle Management: Create, open, save, and list RoadRunner projects, scenes (.rrscene), and scenarios (.rrscenario) with automatic handle invalidation.
  • World Settings & Status: Set world origin, scene center and extents, check project/scene/scenario status, and close RoadRunner safely.
  • Use Case: Ask your agent to open an existing RoadRunner project, create a new scene, set the world origin to specific coordinates, and save the scene under a new name — all executed through verified MATLAB API patterns.

Quick Start

Ask your agent to connect to RoadRunner and open your project by providing the installation folder and project path.

Frequently Asked Questions about roadrunner-core

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I connect MATLAB to RoadRunner programmatically?

Run the rrCoreInitialize script, which first tries roadrunner.connect() to attach to a running instance and otherwise launches RoadRunner using saved settings. If paths are not configured, provide the installFolder and projectPath variables and re-run initialization.

How do I create and save a RoadRunner scene from MATLAB?

After initializing rrApp, use the newScene pattern to create a scene and saveScene(rrApp, name) to save it. Relative paths resolve to the project's Scenes folder, and the .rrscene extension is appended automatically if omitted.

What MATLAB version is required for the RoadRunner API?

The roadrunner class and core project, scene, and scenario APIs require MATLAB R2022a or later. World settings operations such as changeWorldSettings require R2023b or later.

Can I run RoadRunner headless without a UI from MATLAB?

Yes, launch with roadrunner(ProjectFolder=..., NoDisplay=true) for fully headless batch or CI operation, or NoDesktop=true when graphics rendering is still needed. Custom API and cosimulation ports are set with the Ports argument.

Why is my RoadRunner scene blank after relaunching?

Closing RoadRunner with close(rrApp) terminates the process entirely, and on relaunch only the project is restored, not the scene. You must explicitly reopen the desired scene with openScene after reconnecting.

Does closing RoadRunner from MATLAB save my changes automatically?

No, close(rrApp) never prompts to save and terminates the RoadRunner process. Always save the scene and scenario explicitly before closing, and decide with the user whether to save in place, save as a new name, or discard changes.