Datasets:
docs: update README with new structure
Browse files
README.md
CHANGED
|
@@ -13,157 +13,60 @@ size_categories:
|
|
| 13 |
|
| 14 |
# MultiAgent UE5 Content
|
| 15 |
|
| 16 |
-
|
| 17 |
|
| 18 |
-
##
|
| 19 |
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
|
| 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 |
-
|
| 53 |
|
| 54 |
```bash
|
| 55 |
-
|
| 56 |
-
cd /path/to/MultiAgent-Unreal
|
| 57 |
-
|
| 58 |
-
# 运行脚本
|
| 59 |
-
./scripts/setup_hf_content.sh
|
| 60 |
```
|
| 61 |
|
| 62 |
-
|
| 63 |
|
| 64 |
-
**示例路径:**
|
| 65 |
```
|
| 66 |
-
/
|
| 67 |
-
├──
|
| 68 |
-
|
| 69 |
-
├──
|
| 70 |
-
│
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 71 |
└── ...
|
| 72 |
```
|
| 73 |
|
| 74 |
-
##
|
| 75 |
-
|
| 76 |
-
```bash
|
| 77 |
-
# 进入项目根目录
|
| 78 |
-
cd /path/to/MultiAgent-Unreal
|
| 79 |
-
|
| 80 |
-
# 克隆到正确位置
|
| 81 |
-
git clone https://huggingface.co/datasets/WindyLab/MultiAgent-Content unreal_project/Content
|
| 82 |
-
|
| 83 |
-
# 进入 Content 目录
|
| 84 |
-
cd unreal_project/Content
|
| 85 |
-
|
| 86 |
-
# 配置 Git LFS
|
| 87 |
-
git lfs install
|
| 88 |
-
```
|
| 89 |
-
|
| 90 |
-
### 更新资源
|
| 91 |
|
| 92 |
-
|
|
|
|
| 93 |
|
| 94 |
```bash
|
| 95 |
-
|
| 96 |
-
|
| 97 |
-
|
| 98 |
-
|
| 99 |
-
# 方式 2: 手动更新
|
| 100 |
-
cd /path/to/MultiAgent-Unreal/unreal_project/Content
|
| 101 |
-
git pull
|
| 102 |
-
```
|
| 103 |
-
|
| 104 |
-
## ⚠️ 重要说明
|
| 105 |
-
|
| 106 |
-
**资源必须放置在以下路径才能正常工作:**
|
| 107 |
-
|
| 108 |
-
```
|
| 109 |
-
MultiAgent-Unreal/
|
| 110 |
-
└── unreal_project/
|
| 111 |
-
└── Content/ ← 资源必须在这里
|
| 112 |
-
├── Agent/
|
| 113 |
-
├── Map/
|
| 114 |
-
├── Robot/
|
| 115 |
-
└── ...
|
| 116 |
```
|
| 117 |
|
| 118 |
-
如果 Content 目录不在正确位置,UE5 项目将无法找到资源文件。
|
| 119 |
-
|
| 120 |
-
## 📋 前置要求
|
| 121 |
-
|
| 122 |
-
- **Git LFS**: 必须安装 Git LFS 才能下载大文件
|
| 123 |
-
```bash
|
| 124 |
-
# Ubuntu/Debian
|
| 125 |
-
sudo apt install git-lfs
|
| 126 |
-
|
| 127 |
-
# macOS
|
| 128 |
-
brew install git-lfs
|
| 129 |
-
```
|
| 130 |
-
|
| 131 |
-
- **磁盘空间**: 至少需要 15 GB 可用空间
|
| 132 |
-
|
| 133 |
-
- **Hugging Face 认证**: 如果仓库是私有的,需要先登录
|
| 134 |
-
```bash
|
| 135 |
-
pip install huggingface_hub
|
| 136 |
-
python3 -c "from huggingface_hub import login; login()"
|
| 137 |
-
```
|
| 138 |
-
|
| 139 |
-
## 🎮 包含的资源
|
| 140 |
-
|
| 141 |
-
### 机器人模型
|
| 142 |
-
- **无人机**: DJI Inspire 2, M300, Phantom 4, Spark
|
| 143 |
-
- **四足机器人**: Unitree Go1
|
| 144 |
-
- **地面车辆**: UGV
|
| 145 |
-
|
| 146 |
-
### 场景地图
|
| 147 |
-
- **科幻城市**: 现代化城市环境
|
| 148 |
-
- **森林**: 自然环境场景
|
| 149 |
-
- **仓库**: 室内工业场景
|
| 150 |
-
|
| 151 |
-
### 其他资源
|
| 152 |
-
- 充电站模型
|
| 153 |
-
- StateTree 配置
|
| 154 |
-
- 角色动画
|
| 155 |
-
- 材质和纹理
|
| 156 |
-
|
| 157 |
## 🔗 相关链接
|
| 158 |
|
| 159 |
-
- [MultiAgent-Unreal
|
| 160 |
-
-
|
| 161 |
-
-
|
| 162 |
-
|
| 163 |
-
## 📝 License
|
| 164 |
-
|
| 165 |
-
MIT License
|
| 166 |
-
|
| 167 |
-
## 🤝 贡献
|
| 168 |
-
|
| 169 |
-
如果需要更新资源,请参考项目文档中的 [HF_CONTENT_MANAGEMENT.md](https://github.com/WindyLab/MultiAgent-Unreal/blob/main/doc/HF_CONTENT_MANAGEMENT.md)
|
|
|
|
| 13 |
|
| 14 |
# MultiAgent UE5 Content
|
| 15 |
|
| 16 |
+
[MultiAgent-Unreal](https://github.com/WindyLab/MultiAgent-Unreal) 项目的配套 UE5 资产库。
|
| 17 |
|
| 18 |
+
### 快速克隆
|
| 19 |
|
| 20 |
+
```bash
|
| 21 |
+
# 安装 Git LFS
|
| 22 |
+
git lfs install
|
|
|
|
|
|
|
|
|
|
| 23 |
|
| 24 |
+
# 克隆到项目目录
|
| 25 |
+
cd unreal_project
|
| 26 |
+
git clone https://huggingface.co/datasets/WindyLab/MultiAgent-Content Content
|
| 27 |
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 28 |
|
| 29 |
+
**中国用户:**
|
| 30 |
|
| 31 |
```bash
|
| 32 |
+
git clone https://hf-mirror.com/datasets/WindyLab/MultiAgent-Content Content
|
|
|
|
|
|
|
|
|
|
|
|
|
| 33 |
```
|
| 34 |
|
| 35 |
+
## 📂 目录结构
|
| 36 |
|
|
|
|
| 37 |
```
|
| 38 |
+
Content/
|
| 39 |
+
├── Agent/ # 智能体配置
|
| 40 |
+
├── Characters/ # 角色模型/动画
|
| 41 |
+
├── Map/ # 仿真场景
|
| 42 |
+
│ ├── Downtown/ # 现代市中心
|
| 43 |
+
│ ├── Hong_Kong_Street/ # 香港街道
|
| 44 |
+
│ ├── SimpleCity/ # 简单城市
|
| 45 |
+
│ ├── Spruce_Forest/ # 森林场景
|
| 46 |
+
│ └── Warehouse/ # 仓库
|
| 47 |
+
├── Robot/ # 机器人模型
|
| 48 |
+
│ ├── dji_inspire2/ # 御 2
|
| 49 |
+
│ ├── go1/ # 宇树 Go1
|
| 50 |
+
│ ├── ugv1/ # 无人车
|
| 51 |
+
│ └── ...
|
| 52 |
+
├── Materials/ # 共享材质
|
| 53 |
└── ...
|
| 54 |
```
|
| 55 |
|
| 56 |
+
## 🤝 贡献指南
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 57 |
|
| 58 |
+
1. **更新资产**:在 UE5 编辑器中修改并保存。
|
| 59 |
+
2. **提交更改**:
|
| 60 |
|
| 61 |
```bash
|
| 62 |
+
cd unreal_project/Content
|
| 63 |
+
git add .
|
| 64 |
+
git commit -m "feat: 添加新模型"
|
| 65 |
+
git push
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 66 |
```
|
| 67 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 68 |
## 🔗 相关链接
|
| 69 |
|
| 70 |
+
- **主项目**: [GitHub - MultiAgent-Unreal](https://github.com/WindyLab/MultiAgent-Unreal)
|
| 71 |
+
- **文档**: [Project Documentation](https://github.com/WindyLab/MultiAgent-Unreal/tree/main/doc)
|
| 72 |
+
- **问题反馈**: [Issues](https://github.com/WindyLab/MultiAgent-Unreal/issues)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|