MultiAgent-Content / README.md
MiangChen's picture
Add detailed path instructions with examples
4820f26 verified
|
raw
history blame
4.17 kB
metadata
license: mit
tags:
  - unreal-engine
  - ue5
  - game-assets
  - robotics
  - multi-agent
  - simulation
size_categories:
  - 1G<n<10G

MultiAgent UE5 Content

UE5 项目资源文件,用于多机器人仿真系统 MultiAgent-Unreal

📦 资源信息

  • 文件数: 2,116 个文件
  • 总大小: ~10 GB(使用 Git LFS)
  • UAsset 文件: 1,936+
  • UMap 文件: 12+

📂 目录结构

Content/
├── Agent/              # Agent 相关资源
├── Characters/         # 角色模型和动画
├── charge/            # 充电站资源
├── Cursor/            # 光标资源
├── Map/               # 地图场景
│   ├── LS_Scifi_ModernCity/    # 科幻现代城市
│   ├── Spruce_Forest/          # 云杉森林
│   └── Warehouse/              # 仓库场景
├── Robot/             # 机器人模型
│   ├── dji_inspire2/  # DJI Inspire 2 无人机
│   ├── dji_m300/      # DJI M300 无人机
│   ├── dji_phantom4/  # DJI Phantom 4 无人机
│   ├── dji_spark/     # DJI Spark 无人机
│   ├── go1/           # Unitree Go1 四足机器人
│   └── ugv1/          # 地面无人车
├── StarterContent/    # UE5 起始内容
└── StateTree/         # StateTree 资源

🚀 使用方法

方法 1: 使用项目脚本(推荐)

在项目根目录运行(假设你的项目文件夹名为 MultiAgent-Unreal):

# 进入项目根目录
cd /path/to/MultiAgent-Unreal

# 运行脚本
./scripts/setup_hf_content.sh

这会自动将 Content 克隆到正确的位置:unreal_project/Content/

示例路径:

/home/user/MultiAgent-Unreal/          ← 在这里运行脚本
├── scripts/
│   └── setup_hf_content.sh            ← 执行这个脚本
├── unreal_project/
│   └── Content/                       ← 资源会被克隆到这里
└── ...

方法 2: 手动克隆

# 进入项目根目录
cd /path/to/MultiAgent-Unreal

# 克隆到正确位置
git clone https://huggingface.co/datasets/WindyLab/MultiAgent-Content unreal_project/Content

# 进入 Content 目录
cd unreal_project/Content

# 配置 Git LFS
git lfs install

更新资源

如果已经克隆过,只需拉取最新更改:

# 方式 1: 使用脚本
cd /path/to/MultiAgent-Unreal
./scripts/setup_hf_content.sh

# 方式 2: 手动更新
cd /path/to/MultiAgent-Unreal/unreal_project/Content
git pull

⚠️ 重要说明

资源必须放置在以下路径才能正常工作:

MultiAgent-Unreal/
└── unreal_project/
    └── Content/        ← 资源必须在这里
        ├── Agent/
        ├── Map/
        ├── Robot/
        └── ...

如果 Content 目录不在正确位置,UE5 项目将无法找到资源文件。

📋 前置要求

  • Git LFS: 必须安装 Git LFS 才能下载大文件

    # Ubuntu/Debian
    sudo apt install git-lfs
    
    # macOS
    brew install git-lfs
    
  • 磁盘空间: 至少需要 15 GB 可用空间

  • Hugging Face 认证: 如果仓库是私有的,需要先登录

    pip install huggingface_hub
    python3 -c "from huggingface_hub import login; login()"
    

🎮 包含的资源

机器人模型

  • 无人机: DJI Inspire 2, M300, Phantom 4, Spark
  • 四足机器人: Unitree Go1
  • 地面车辆: UGV

场景地图

  • 科幻城市: 现代化城市环境
  • 森林: 自然环境场景
  • 仓库: 室内工业场景

其他资源

  • 充电站模型
  • StateTree 配置
  • 角色动画
  • 材质和纹理

🔗 相关链接

📝 License

MIT License

🤝 贡献

如果需要更新资源,请参考项目文档中的 HF_CONTENT_MANAGEMENT.md