Air-Lingjing README

The project's README from github.com/seanlxh/Air-Lingjing. As one markdown file: README.md.

🌐 LingJing Embodied Intelligence

An open simulation stack for LLM-driven embodied agents in large 3D environments.

English 简体中文

LingJing combines a FastAPI/LangGraph backend, runnable embodied-agent cases, and a Cesium-powered Unreal Engine 5.5 plugin in one repository. The backend handles task orchestration, LLM/VLM calls, Gym-style environment loops, engine communication, and data recording. The Unreal plugin provides the 3D world integration, heterogeneous equipment actors, cameras, UI, image capture, and telemetry.

Large Unreal assets are distributed separately through Hugging Face. This repository contains source code, configuration templates, tests, and compact example data only.

🗺️ Platform Overview

LingJing platform overview

LingJing connects heterogeneous simulators, geospatial assets, model services, and embodied agents through a shared urban physics environment. Each simulation step closes the perceive-think-act-communicate loop and records outputs for evaluation and visualization. Open the high-resolution PDF.

🧩 Runtime Framework

LingJing agent and simulation framework

The runtime separates agent policy, shared infrastructure, adjudication, command routing, evaluation, and simulation engines. This keeps policies independent from engine-specific protocols while preserving per-agent observations, message history, acknowledgements, and replayable trajectories. Open the high-resolution PDF.

✨ Highlights

Repository Layout

LingJing-Embodied-Intelligence/
├── backend/
│   ├── app/                 # FastAPI application and runtime modules
│   ├── examples/            # Runnable cases and UE reference client
│   ├── tests/               # API, environment, and realtime tests
│   ├── scripts/             # Deployment and maintenance helpers
│   └── .env.example         # Safe configuration template
├── unreal/
│   └── EmbodyIntelligence/  # Unreal Engine 5.5 runtime plugin
├── docs/                    # README figures and high-resolution PDFs
├── ASSETS.md                # Hugging Face asset instructions
└── README.zh-CN.md          # Chinese documentation

🚀 Backend Quick Start

Requirements: Python 3.10 or newer.

cd backend
python -m venv .venv
source .venv/bin/activate
pip install -r requirements-dev.txt
cp .env.example .env

Set your own provider values in .env:

AI_BASE_URL=https://api.example.com/v1
AI_API_KEY=replace-with-your-api-key
AI_CHAT_MODEL=replace-with-your-chat-model
AI_ANALYSIS_MODEL=replace-with-your-vision-model
AI_API_STYLE=openai
INTERNAL_AI_TOKEN=replace-with-a-long-random-token

Start the service:

uvicorn app.main:app --reload --host 0.0.0.0 --port 9909

Verify it:

curl http://127.0.0.1:9909/health

Run the end-to-end mock demo without Unreal Engine or an API key:

python examples/scenario_demo.py

🧠 Runnable Cases

Directory Scenario
examples/full_case/ Multi-drone urban delivery and centralized baseline
examples/fire_rescue/ UAV reconnaissance with UGV firefighting
examples/singledrone_fire/ Closed-loop visual fire search
examples/singledog/ Robot-dog visual navigation
examples/deliverytask/ Heterogeneous delivery and route inspection
examples/bridge/ Bridge inspection from top-down and front views
examples/multicars/ Multi-vehicle dispatch and route-cost analysis
examples/uavdog/ UAV-assisted robot-dog navigation
examples/multiagentstasks/ Mixed equipment scenario dispatch
examples/ue_client/ Python reference implementation of an engine client

See backend/examples/README.md for commands and runtime requirements.

🏙️ Unreal Engine Setup

Requirements:

Install the plugin at:

<HostProject>/Plugins/EmbodyIntelligence/

Download the asset repository:

Coming soon / 即将上传

Install the downloaded asset package in its two mount locations:

<HostProject>/Plugins/EmbodyIntelligence/Content/  # PluginContent
<HostProject>/Content/                            # HostContent

Program assets use the /EmbodyIntelligence/... plugin mount, while scene assets use the /Game/ArtRes/... host-project mount. See ASSETS.md and unreal/EmbodyIntelligence/README.md.

The plugin defaults to:

ws://127.0.0.1:9909/ws/LJ-ENGINE/image

For a remote backend, update WEBSOCKET_URL in Source/ue5project/Core/DataManager.cpp before building.

🧪 Validation

cd backend
python -m pytest -q
python -m ruff check app examples tests

The Unreal plugin must be compiled in Unreal Engine 5.5.4 with Cesium enabled. Generated Binaries/, Intermediate/, logs, databases, uploads, and result folders are intentionally excluded from Git.

Security

GitHub Metadata

Suggested description:

Open embodied-intelligence simulation stack with a FastAPI/LangGraph multi-agent backend, reproducible urban task cases, and a Cesium-powered Unreal Engine 5.5 plugin.

Suggested topics: embodied-ai, multi-agent, unreal-engine, ue5, cesium, simulation, robotics, langgraph, fastapi, digital-twin.

License

No license is selected in this release package. Add a LICENSE file only after confirming the redistribution terms for the source code and all Unreal/Hugging Face assets.

Air-Lingjing (seanlxh/Air-Lingjing)

Searching Database…

这是什么?LingJing 是一套面向大范围 3D 环境中 LLM 驱动的具身智能体的开放仿真技术栈:包含一个 FastAPI/LangGraph 后端,外加一个基于 Cesium 的 Unreal Engine 5.5 插件,并附带可运行的示例案例。
它是一个应用,还是由几部分组成?一个仓库里包含两部分:后端负责任务编排、LLM/VLM 调用、Gym 风格的环境循环、引擎通信和数据记录;Unreal 插件则提供 3D 世界、Actor、相机和遥测数据。大型资源文件需要单独从 Hugging Face 下载。
怎么把它跑起来?后端需要 Python 3.10+:在 .env 中填写你的模型服务商配置,启动服务并在 Swagger UI 中验证。要跑完整的 3D 环境栈,还需要把插件安装到带 Cesium 的 Unreal Engine 5.5.4 中,并从 Hugging Face 下载对应的资源包。
试用的话需要 API 密钥或 Unreal Engine 吗?开始试用时两者都不需要:一个端到端的 mock 演示不用 Unreal Engine 也不用 API 密钥就能跑。要用真实模型的话,支持 OpenAI 兼容和 Anthropic 兼容的服务商,都在 .env 里配置。
Unreal 那边有什么坑?插件只能在启用 Cesium 的 Unreal Engine 5.5.4 中编译。资源文件挂载在两个位置(程序在 /EmbodyIntelligence/... 下,场景在 /Game/ArtRes/... 下),如果后端是远程的,需要在构建前修改 DataManager.cpp 里的 WEBSOCKETURL。
能在自己的项目里复用吗?请注意这个发布包没有选定许可证,因此再分发的条款尚未确定。README 说明只有先确认好源代码以及所有 Unreal/Hugging Face 资源的条款后,才能添加 LICENSE 文件。
开箱就能跑哪些场景?backend/examples/ 下有十个可运行的案例:多无人机城市配送、无人机侦察加无人车消防、闭环视觉火点搜索、机器狗视觉导航、异构配送与路线巡检、桥梁巡检、多车辆调度、无人机辅助机器狗导航、混合装备调度,以及一个 Python 参考引擎客户端。
仿真世界里有哪些智能体?一个基于 Cesium 的城市环境,里面有无人机、车辆、机器狗、舰船以及任务 Actor。每个仿真步都会完成感知—思考—行动—通信的闭环,并记录输出,用于评估和可视化。
多个智能体之间怎么协同?通过集中式、星型和广播这几种协同模式。运行时会保存每个智能体的观测、消息历史和确认信息,并生成可回放的轨迹用于评估。
后端是怎么和 Unreal Engine 通信的?通过 HTTP、WebSocket 和 UDP。后端服务会暴露引擎会话,你可以在启动完整的 Unreal 客户端之前先检查连通性。
Creator
seanlxh
Size
10.5 MB
Stars
194
Updated
CommitAug 14
Age
2mo
Commits · 90 Days