Struct ProjectTemplateService 

pub struct ProjectTemplateService { /* private fields */ }

Service for generating project template files

Examples

use mecha10_cli::services::ProjectTemplateService;

let service = ProjectTemplateService::new();

// Generate all project files
service.create_readme(&project_path, "my-robot").await?;
service.create_cargo_toml(&project_path, "my-robot", false).await?;

Implementations

impl ProjectTemplateService

pub fn new() -> Self

Create a new ProjectTemplateService

pub async fn create_readme(&self, path: &Path, project_name: &str) -> Result<()>

Create README.md for the project

pub async fn create_gitignore(&self, path: &Path) -> Result<()>

Create .gitignore for the project

pub async fn create_cargo_config( &self, path: &Path, framework_path: &str, ) -> Result<()>

Create .cargo/config.toml for framework development

This patches all mecha10-* dependencies to use local paths instead of crates.io. Requires a framework_path pointing to the mecha10-monorepo root.

pub async fn create_cargo_toml( &self, path: &Path, project_name: &str, dev: bool, ) -> Result<()>

Create Cargo.toml for the project

Arguments

• path - Project root path
• project_name - Name of the project
• dev - Whether this is for framework development (affects dependency resolution)

pub async fn create_main_rs( &self, path: &Path, project_name: &str, ) -> Result<()>

Create src/main.rs for the project

pub async fn create_build_rs(&self, path: &Path) -> Result<()>

Create build.rs for the project

This build script generates:

1. node_registry.rs - Node dispatcher based on mecha10.json
2. embedded.rs - Embedded asset accessors

pub async fn create_embedded_structure(&self, path: &Path) -> Result<()>

Create embedded directory structure

pub async fn create_env_example( &self, path: &Path, project_name: &str, framework_path: Option<String>, ) -> Result<()>

Create .env.example for the project

Arguments

• path - Project root path
• project_name - Name of the project
• framework_path - Optional framework path for development mode

pub async fn create_rustfmt_toml(&self, path: &Path) -> Result<()>

Create rustfmt.toml for the project

pub async fn create_docker_compose( &self, path: &Path, project_name: &str, ) -> Result<()>

Create docker-compose.yml for the project

Generates a Docker Compose file with Redis and optional PostgreSQL services for local development and deployment.

Arguments

• path - Project root path
• project_name - Name of the project (used for container naming)

pub async fn create_package_json( &self, path: &Path, project_name: &str, ) -> Result<()>

Create package.json for npm dependencies

Includes @mecha10/simulation-models and @mecha10/simulation-environments dependencies. Resolution happens at runtime via MECHA10_FRAMEWORK_PATH env var:

• If set: Uses local monorepo packages
• If not set: Uses node_modules/@mecha10/* (requires npm install)

Arguments

• path - Project root path
• project_name - Name of the project

pub async fn create_requirements_txt(&self, path: &Path) -> Result<()>

Create requirements.txt for Python dependencies

Includes Python packages needed for AI nodes (onnx, onnxruntime). Install with: mecha10 setup or pip install -r requirements.txt

Arguments

• path - Project root path

pub async fn create_mecha10_json( &self, path: &Path, project_name: &str, template: &Option<String>, ) -> Result<()>

Create mecha10.json configuration file

Generates the main project configuration file with robot identity, simulation settings, nodes, services, and Docker configuration.

Arguments

• path - Project root directory
• project_name - Name of the project
• template - Robot template (rover, humanoid, etc.)

pub async fn create_simulation_model_json(&self, path: &Path) -> Result<()>

Create simulation/models/model.json

Generates the rover robot physical model configuration for Godot simulation from embedded template.

Arguments

• path - Project root directory

pub async fn create_simulation_environment_json( &self, path: &Path, ) -> Result<()>

Create simulation/environments/basic_arena/environment.json

Generates the basic arena environment configuration for Godot simulation from embedded template.

Arguments

• path - Project root directory

Trait Implementations

impl Default for ProjectTemplateService

fn default() -> Self

Returns the “default value” for a type.