Struct SimulationService 

pub struct SimulationService { /* private fields */ }

Simulation service for managing Godot simulations

Examples

use mecha10_cli::services::SimulationService;
use std::path::Path;

let service = SimulationService::new();

// Validate Godot installation
service.validate_godot()?;

// Generate simulation
service.generate(
    Path::new("mecha10.json"),
    Path::new("simulation/godot"),
    5, // max environments
    0  // min score
)?;

// Run simulation
service.run(
    "rover-robot",
    "warehouse",
    false // not headless
)?;

Implementations

impl SimulationService

pub fn new() -> Self

Create a new simulation service with default paths

pub fn with_base_path(base_path: impl Into<PathBuf>) -> Self

Create a simulation service with custom base path

Arguments

• base_path - Base directory for simulation output

pub fn validate_godot(&self) -> Result<GodotInfo>

Validate Godot installation

Checks if Godot 4.x is installed and accessible.

Errors

Returns an error if Godot is not found or version is incorrect.

pub fn generate( &self, config_path: &Path, output_path: &Path, max_envs: usize, min_score: i32, ) -> Result<GenerationResult>

Generate simulation scenes from project configuration

Arguments

• config_path - Path to mecha10.json
• output_path - Output directory for simulation files
• max_envs - Maximum number of environments to generate
• min_score - Minimum compatibility score (0-100)

pub fn generate_robot( &self, config_path: &Path, output_path: &Path, ) -> Result<()>

Generate only the robot scene

Arguments

• config_path - Path to mecha10.json
• output_path - Output path for robot.tscn

pub fn list_environments( &self, config_path: &Path, verbose: bool, ) -> Result<Vec<EnvironmentInfo>>

List available environments

Arguments

• config_path - Path to mecha10.json
• verbose - Show detailed information

pub fn validate_config(&self, config_path: &Path) -> Result<ValidationResult>

Validate project configuration for simulation

Arguments

• config_path - Path to mecha10.json

pub fn run(&self, robot_name: &str, env_id: &str, headless: bool) -> Result<()>

Run a simulation in Godot

Arguments

• robot_name - Name of the robot
• env_id - Environment ID
• headless - Run without UI

pub fn is_setup(&self) -> bool

Check if simulation is properly set up

pub fn base_path(&self) -> &Path

Get the base path for simulations

pub fn resolve_model_path(&self, model_ref: &str) -> Result<PathBuf>

Resolve a model path from package namespace or plain name

Supports multiple formats:

• Package namespace: “@mecha10/simulation-models/rover”
• Plain name: “rover”

Resolution order:

1. Framework (monorepo): packages/simulation/models/{name}/
2. Project-local: simulation/models/{name}/

Arguments

• model_ref - Model reference (package namespace or plain name)

Returns

Absolute path to the model directory, or error if not found

pub fn resolve_environment_path(&self, env_ref: &str) -> Result<PathBuf>

Resolve an environment path from package namespace or plain name

Supports multiple formats:

• Package namespace: “@mecha10/simulation-environments/basic_arena”
• Plain name: “basic_arena”

Resolution order:

1. Project-local: simulation/environments/{name}/ (project customizations take precedence)
2. Framework (monorepo): packages/simulation/environments/{name}/

Arguments

• env_ref - Environment reference (package namespace or plain name)

Returns

Absolute path to the environment directory, or error if not found

Trait Implementations

impl Default for SimulationService

fn default() -> Self

Returns the “default value” for a type.