跳到主要内容

初始化模块仓库

xrobot_init_mod 用于拉取并同步项目依赖的模块仓库。它同时支持本地配置文件和远程配置文件，并会递归解析依赖关系，保证依赖树和版本约束一致。

基本用法​

1. 初次运行（自动生成配置文件模板）​

如果当前没有配置文件（如 Modules/modules.yaml），第一次运行会自动生成模板。

$ xrobot_init_mod
[WARN] Configuration file not found, creating template: Modules/modules.yaml
[INFO] Please edit the configuration file and rerun this script.

按模板补上模块列表，例如：

modules:
  - xrobot-org/BlinkLED
  - xrobot-org/MySensor@master

再次运行后就会自动拉取所有模块仓库：

$ xrobot_init_mod
[INFO] Cloning new module: BlinkLED
[INFO] Cloning new module: MySensor
[SUCCESS] All modules and their dependencies processed.

2. 指定本地配置文件​

指定本地配置文件时，使用 --config：

$ xrobot_init_mod --config Modules/modules.yaml
[INFO] Updating module: BlinkLED
[SUCCESS] All modules and their dependencies processed.

3. 指定远程配置文件​

远程配置文件（如 GitHub Raw 地址）也可以直接传 URL：

$ xrobot_init_mod --config https://raw.githubusercontent.com/<user>/<repo>/<branch>/modules.yaml
[INFO] Cloning new module: BlinkLED
[SUCCESS] All modules and their dependencies processed.

4. 自定义仓库源（可选）​

XRobot 支持通过 sources.yaml 配置多个模块源和镜像。
需要指定自定义 sources 文件时，可以使用 --sources：

$ xrobot_init_mod --config Modules/modules.yaml --sources Modules/sources.yaml

sources.yaml 支持聚合多个 index.yaml 源（如官方/私有镜像），典型格式如下：

sources:
- url: https://xrobot-org.github.io/xrobot-modules/index.yaml
  priority: 0
...

递归依赖解析与版本一致性​

  • 工具会自动递归解析所有依赖模块（依赖信息写在各模块头文件 MANIFEST 区块中），确保依赖树完整且版本一致。
  • 若同一模块被不同模块依赖但指定了不同版本，工具会报错提示依赖冲突，需你手动统一依赖版本。

CMake 集成​

自动同步的所有模块会被下载到 Modules/ 目录。
需通过设置 XROBOT_MODULES_DIR 变量，让 LibXR 自动发现并加载模块。

# 添加 XRobot Modules
set(XROBOT_MODULES_DIR "${CMAKE_CURRENT_SOURCE_DIR}/Modules")

别忘了把LibXR也包含进来！

# 一个简单的例子
project(xrobot_mod_test CXX)
set(CMAKE_CXX_STANDARD 17)
add_executable(xr_test main.cpp)

# 在add_subdirectory之前
set(XROBOT_MODULES_DIR ${CMAKE_CURRENT_SOURCE_DIR}/Modules/)
add_subdirectory(libxr)

target_include_directories(xr_test PUBLIC $<TARGET_PROPERTY:xr,INTERFACE_INCLUDE_DIRECTORIES> ${CMAKE_SOURCE_DIR}/User)
target_link_libraries(xr_test PUBLIC xr)