From 2b678e41e6f47a1b15eb942f2556eb861ff7dbfc Mon Sep 17 00:00:00 2001 From: Leushina Date: Thu, 25 Jun 2026 13:58:15 +0300 Subject: [PATCH] update guide --- README.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 93fc67f..f1aed6f 100644 --- a/README.md +++ b/README.md @@ -38,10 +38,18 @@ git clone --recurse-submodules https://git.robofob.ru/sirius/sirius_unity_sim.gi git submodule init git submodule update ``` -2. Скачиваем модели мира [Industrial_Zone_Modular_Pack](https://disk.yandex.ru/d/leNWr7JXhXlNJQ) и разархивируем ее в папку `Assets`. Должна получится струткура `Assets/Industrial_Zone_Modular_Pack` -3. В UnityHub добавляем проект `Add new project` и выбираем папку `sirius_unity_sim`. -4. Открываем проект и ждем процесса компиляции проекта. Unity не сможет скомпилировать некоторые скрипты и из-за этого предложит перейти в режим `Safe Mode`. Соглашаемся. -5. После открытия программы устанавливаемя дополнительные пакеты для организации свзяи ROS+Unity: +1. Скачиваем модели мира [Industrial_Zone_Modular_Pack](https://disk.yandex.ru/d/leNWr7JXhXlNJQ), [AllSkyFree](https://disk.yandex.ru/d/WjRCJTkRmQfaCQ), [Vefects](https://disk.yandex.ru/d/pohMh5mcrlVngA) и разархивируем их в папку `Assets`. Должна получится струткура: +``` +Assets/ +├─ AllSkyFree/ +├─ Industrial_Zone_Modular_Pack/ +├─ Vefects +└─ ... +``` +1. В UnityHub добавляем проект `Add new project` и выбираем папку `sirius_unity_sim`. +2. Открываем проект и ждем процесса компиляции проекта. Unity не сможет скомпилировать некоторые скрипты и из-за этого предложит перейти в режим `Safe Mode`. Соглашаемся. +> Если по каким-то причинам все скомпилилось удачно, то это значит, что у вас уже есть недостающие библиотеки. Переходите к п.5 +3. После открытия программы устанавливаемя дополнительные пакеты для организации свзяи ROS+Unity: - Через меню `Window > Package manager` выбрать раздел `Unity Registry` и установить библиотеку `Mathematics`,`Burst` - Через интерфейс "+" выбрать `Add package from git URL...` и ввести прикрепленные ниже ссылки - [ROS-TCP-Connector](https://github.com/Unity-Technologies/ROS-TCP-Connector) - перессылка сообещинй из ROS в Unity и обратно @@ -50,7 +58,8 @@ git submodule update `https://github.com/Unity-Technologies/ROS-TCP-Connector.git?path=/com.unity.robotics.visualizations` - [URDF-Importer](https://github.com/Unity-Technologies/URDF-Importer) `https://github.com/Unity-Technologies/URDF-Importer.git?path=/com.unity.robotics.urdf-importer#v0.5.2` -6. Если не все ошибки были исправленны, то выходим из режима `Safe Mode > Exit Safe Mode`. Во вкладке `Robotics > ROS Settings` переключаем на протокол `ROS2` и ждем компиляции проекта. После компиляции оставшихся скриптов не должно возникнуть никаких критических ошибок. +1. Если Unity самостоятельно не вышел из безопасного режима, то выходим вручную `Safe Mode > Exit Safe Mode`. +2. Во вкладке `Robotics > ROS Settings` переключаем на протокол `ROS2` и ждем компиляции проекта. После компиляции оставшихся скриптов не должно возникнуть никаких критических ошибок. # 4. ROS2: установка дополнительных пакетов Рабочим воркспейсом будем считать `~/sirius_ws`. @@ -73,7 +82,7 @@ colcon build --symlink-install ros2 run ros_tcp_endpoint default_server_endpoint --ros-args -p ROS_IP:=127.0.0.1 ``` 2. Отрыть проект `sirius_sim` и в файлах проекта (вкладка `Project` в нижней части экрана) открыть сцену `main.unity`, которая распологается в папке `Assets/Scenes`. -3. В Unity запускаем симуляцию нажав кнопку `Play` (внешний вид: ▶) на панели инструментов (чуть выше окна просмотра сцены `Scene` / игрового окна `Game`). В верхнем левом углу игрового окна будет отображаться плашка с указанием IP-адреса и индикацией состояния подключения (внешний вид: ⇄): если стрелки красного цвета - соединения нет, если синего - есть. Ошибки работы симуляции будут выводиться в собственную консоль Unity. Для прекращения работы симуляции повторно нажмите кнопку `Play`. +3. В Unity запускаем симуляцию нажав кнопку `Play` (внешний вид: ▶) на панели инструментов (чуть выше окна просмотра сцены `Scene` / игрового окна `Game`). В верхнем левом углу игрового окна будет отображаться плашка с указанием IP-адреса и индикацией состояния подключения (внешний вид: ⇄): если стрелки красного цвета - соединения нет, если синего - есть, жетлого - есть соединение, но с проблемами (игнорируем). Ошибки работы симуляции будут выводиться в собственную консоль Unity. Для прекращения работы симуляции повторно нажмите кнопку `Play`. > Во время симуляции можно изменять параметры скриптов, положение объектов и другие элементы, но после ее завершения все изменения автоматически откатятся к начальному состоянию. ## 🚨 Известные проблемы и их решения