Datasets:
Update README with correct Content path instructions
Browse files
README.md
ADDED
|
@@ -0,0 +1,153 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: mit
|
| 3 |
+
tags:
|
| 4 |
+
- unreal-engine
|
| 5 |
+
- ue5
|
| 6 |
+
- game-assets
|
| 7 |
+
- robotics
|
| 8 |
+
- multi-agent
|
| 9 |
+
- simulation
|
| 10 |
+
size_categories:
|
| 11 |
+
- 1G<n<10G
|
| 12 |
+
---
|
| 13 |
+
|
| 14 |
+
# MultiAgent UE5 Content
|
| 15 |
+
|
| 16 |
+
UE5 项目资源文件,用于多机器人仿真系统 [MultiAgent-Unreal](https://github.com/WindyLab/MultiAgent-Unreal)。
|
| 17 |
+
|
| 18 |
+
## 📦 资源信息
|
| 19 |
+
|
| 20 |
+
- **文件数**: 2,116 个文件
|
| 21 |
+
- **总大小**: ~10 GB(使用 Git LFS)
|
| 22 |
+
- **UAsset 文件**: 1,936+
|
| 23 |
+
- **UMap 文件**: 12+
|
| 24 |
+
|
| 25 |
+
## 📂 目录结构
|
| 26 |
+
|
| 27 |
+
```
|
| 28 |
+
Content/
|
| 29 |
+
├── Agent/ # Agent 相关资源
|
| 30 |
+
├── Characters/ # 角色模型和动画
|
| 31 |
+
├── charge/ # 充电站资源
|
| 32 |
+
├── Cursor/ # 光标资源
|
| 33 |
+
├── Map/ # 地图场景
|
| 34 |
+
│ ├── LS_Scifi_ModernCity/ # 科幻现代城市
|
| 35 |
+
│ ├── Spruce_Forest/ # 云杉森林
|
| 36 |
+
│ └── Warehouse/ # 仓库场景
|
| 37 |
+
├── Robot/ # 机器人模型
|
| 38 |
+
│ ├── dji_inspire2/ # DJI Inspire 2 无人机
|
| 39 |
+
│ ├── dji_m300/ # DJI M300 无人机
|
| 40 |
+
│ ├── dji_phantom4/ # DJI Phantom 4 无人机
|
| 41 |
+
│ ├── dji_spark/ # DJI Spark 无人机
|
| 42 |
+
│ ├── go1/ # Unitree Go1 四足机器人
|
| 43 |
+
│ └── ugv1/ # 地面无人车
|
| 44 |
+
├── StarterContent/ # UE5 起始内容
|
| 45 |
+
└── StateTree/ # StateTree 资源
|
| 46 |
+
```
|
| 47 |
+
|
| 48 |
+
## 🚀 使用方法
|
| 49 |
+
|
| 50 |
+
### 方法 1: 使用项目脚本(推荐)
|
| 51 |
+
|
| 52 |
+
在 MultiAgent-Unreal 项目根目录运行:
|
| 53 |
+
|
| 54 |
+
```bash
|
| 55 |
+
./scripts/setup_hf_content.sh
|
| 56 |
+
```
|
| 57 |
+
|
| 58 |
+
这会自动将 Content 克隆到正确的位置:`unreal_project/Content/`
|
| 59 |
+
|
| 60 |
+
### 方法 2: 手动克隆
|
| 61 |
+
|
| 62 |
+
```bash
|
| 63 |
+
# 克隆到项目目录
|
| 64 |
+
git clone https://huggingface.co/datasets/WindyLab/MultiAgent-Content unreal_project/Content
|
| 65 |
+
|
| 66 |
+
# 进入目录
|
| 67 |
+
cd unreal_project/Content
|
| 68 |
+
|
| 69 |
+
# 配置 Git LFS
|
| 70 |
+
git lfs install
|
| 71 |
+
```
|
| 72 |
+
|
| 73 |
+
### 更新资源
|
| 74 |
+
|
| 75 |
+
如果已经克隆过,只需拉取最新更改:
|
| 76 |
+
|
| 77 |
+
```bash
|
| 78 |
+
cd unreal_project/Content
|
| 79 |
+
git pull
|
| 80 |
+
```
|
| 81 |
+
|
| 82 |
+
或者运行:
|
| 83 |
+
|
| 84 |
+
```bash
|
| 85 |
+
./scripts/setup_hf_content.sh
|
| 86 |
+
```
|
| 87 |
+
|
| 88 |
+
## ⚠️ 重要说明
|
| 89 |
+
|
| 90 |
+
**资源必须放置在以下路径才能正常工作:**
|
| 91 |
+
|
| 92 |
+
```
|
| 93 |
+
MultiAgent-Unreal/
|
| 94 |
+
└── unreal_project/
|
| 95 |
+
└── Content/ ← 资源必须在这里
|
| 96 |
+
├── Agent/
|
| 97 |
+
├── Map/
|
| 98 |
+
├── Robot/
|
| 99 |
+
└── ...
|
| 100 |
+
```
|
| 101 |
+
|
| 102 |
+
如果 Content 目录不在正确位置,UE5 项目将无法找到资源文件。
|
| 103 |
+
|
| 104 |
+
## 📋 前置要求
|
| 105 |
+
|
| 106 |
+
- **Git LFS**: 必须安装 Git LFS 才能下载大文件
|
| 107 |
+
```bash
|
| 108 |
+
# Ubuntu/Debian
|
| 109 |
+
sudo apt install git-lfs
|
| 110 |
+
|
| 111 |
+
# macOS
|
| 112 |
+
brew install git-lfs
|
| 113 |
+
```
|
| 114 |
+
|
| 115 |
+
- **磁盘空间**: 至少需要 15 GB 可用空间
|
| 116 |
+
|
| 117 |
+
- **Hugging Face 认证**: 如果仓库是私有的,需要先登录
|
| 118 |
+
```bash
|
| 119 |
+
pip install huggingface_hub
|
| 120 |
+
python3 -c "from huggingface_hub import login; login()"
|
| 121 |
+
```
|
| 122 |
+
|
| 123 |
+
## 🎮 包含的资源
|
| 124 |
+
|
| 125 |
+
### 机器人模型
|
| 126 |
+
- **无人机**: DJI Inspire 2, M300, Phantom 4, Spark
|
| 127 |
+
- **四足机器人**: Unitree Go1
|
| 128 |
+
- **地面车辆**: UGV
|
| 129 |
+
|
| 130 |
+
### 场景地图
|
| 131 |
+
- **科幻城市**: 现代化城市环境
|
| 132 |
+
- **森林**: 自然环境场景
|
| 133 |
+
- **仓库**: 室内工业场景
|
| 134 |
+
|
| 135 |
+
### 其他资源
|
| 136 |
+
- 充电站模型
|
| 137 |
+
- StateTree 配置
|
| 138 |
+
- 角色动画
|
| 139 |
+
- 材质和纹理
|
| 140 |
+
|
| 141 |
+
## 🔗 相关链接
|
| 142 |
+
|
| 143 |
+
- [MultiAgent-Unreal 项目](https://github.com/WindyLab/MultiAgent-Unreal)
|
| 144 |
+
- [文档](https://github.com/WindyLab/MultiAgent-Unreal/tree/main/doc)
|
| 145 |
+
- [问题反馈](https://github.com/WindyLab/MultiAgent-Unreal/issues)
|
| 146 |
+
|
| 147 |
+
## 📝 License
|
| 148 |
+
|
| 149 |
+
MIT License
|
| 150 |
+
|
| 151 |
+
## 🤝 贡献
|
| 152 |
+
|
| 153 |
+
如果需要更新资源,请参考项目文档中的 [HF_CONTENT_MANAGEMENT.md](https://github.com/WindyLab/MultiAgent-Unreal/blob/main/doc/HF_CONTENT_MANAGEMENT.md)
|