docs: Move blender-addon.md to blender-addon/README.md

This commit is contained in:
Arthur Golubtsov
2019-12-26 03:37:59 +03:00
parent 443b5ac2de
commit a32de98d68
3 changed files with 31 additions and 56 deletions

View File

@@ -1,25 +1,33 @@
# blender-csv-animation
A Blender extension that export paths of objects in blender animation to a csv files
# Аддон для экспорта анимации из Blender
## CSV file format
First row is the animation filename.
Every next row of the file contains following information about an object:
- frame number,
- x coordinate,
- y coordinate,
- z coordinate,
- rotaion around z-axis angle (yaw for copter),
- rgb.
Аддон для Blender предназначен для преобразования анимации полёта коптеров, нарисованной в Blender, в полётные пути для каждого коптера анимации, с учётом цвета объектов в каждый момент времени.
## How to use it
Clone or download this repository
```bash
git clone https://github.com/artem30801/CleverSwarm.git
```
Open Blender and install the addon:
1) Open User Prerences windows using main menu or shortcut (Ctrl + Alt + U): Files - User Preferences
2) Under Add-ons tab click Install Add-on from File...
3) Choose addon.py file from the directory of this repository
4) Enable the Add-on
## Установка и настройка
Use [official docs](https://docs.blender.org/manual/en/latest/preferences/addons.html) for getting additional information
* Скачайте и установите согласно инструкциям последнюю версию Blender 2.81 с [оффициального сайта](https://www.blender.org/download/).
* Откройте Blender, в верхнем меню выберите `Edit > Preferences`. В открывшемся окне настроек в боковой панели выберите пункт `Add-ons`. Нажмите на кнопку `Install...` в верхнем правом углу окна. В диалоговом окне откройте путь к папке с аддоном [clever-show/blender-addon](../../blender-addon/) и выберите файл `addon.py`. Нажмите `Install Add-on from file...`. Аддон установлен.
* После установки аддона поставьте "галочку" напротив аддона `Import-Export: Export > CSV Drone Swarm Animation Exporter` для активации аддона.
Аддон активирован и готов к работе. Выполнение этих операций не понадобится при дальнейших запусках Blender.
## Экпорт при помощи аддона
Для вызова диалогового окна экспорта нажмите в верхнем меню `File > Export > CSV Drone Swarm Animation Exporter`. В открывшемся окне экспорта необходимо выбрать целевой путь экспорта и название папки, которую создаст аддон в процессе экспорта. В боковом меню доступна панель параметров экспорта:
* `Use name filter for objects` - чекбокс, определяет, будет ли использован фильтр объектов при сохранении их путей. При отключении этого параметра будут экспортированы пути всех видимых объектов.
* `Name identifier` - фильтр имён объектов. Если активен чекбокс `Use name filter for objects`, будут сохранены только пути объектов, содержащих данное значение в названии.
* `Show detailed animation warnings` - чекбокс, определяет, будут ли показаны предупреждения по превышению скоростей и расстояний в анимации.
* `Speed limit` - при нарушении указанного ограничения по скорости передвижения дронов будут выведены предупреждения.
* `Distance limit` - при нарушении указанной минимальной дистанции между дронами будут выведены предупреждения.
После настройки нужных параметров нажмите кнопку `Export Drone Swarm animation`. В указанную папку экспортируются анимации указанных объектов из проекта Blender в формате `.csv`.
## Деактивация и удаление
Для деактивации аддона уберите "галочку" напротив имени аддона, как описано [выше](#установка-и-настройка).
Для получения дополнительных сведений нажмите знак стрелочки слева от поля активации. В развернувшемся блоке так же есть кнопки:
* `Documentation` - ведет на страницу документации аддона
* `Report a bug` - ведет на страницу issues репозитория clever-show
* `Remove` - удаляет аддон (перед установкой новой версии рекомендуется удалить старую)

View File

@@ -16,7 +16,7 @@ bl_info = {
"location": "File > Export > CSV Drone Swarm Animation Exporter (.csv)",
"description": "Export > CSV Drone Swarm Animation Exporter (.csv)",
"warning": "",
"wiki_url": "https://github.com/CopterExpress/clever-show/blob/master/docs/ru/blender-addon.md",
"wiki_url": "https://github.com/CopterExpress/clever-show/blob/master/blender-addon/README.md",
"tracker_url": "https://github.com/CopterExpress/clever-show/issues",
"category": "Import-Export"
}

View File

@@ -1,33 +0,0 @@
# Аддон для экспорта анимации из Blender
Аддон для Blender предназначен для преобразования анимации полёта коптеров, нарисованной в Blender, в полётные пути для каждого коптера анимации, с учётом цвета объектов в каждый момент времени.
## Установка и настройка
* Скачайте и установите согласно инструкциям последнюю версию Blender 2.81 с [оффициального сайта](https://www.blender.org/download/).
* Откройте Blender, в верхнем меню выберите `Edit > Preferences`. В открывшемся окне настроек в боковой панели выберите пункт `Add-ons`. Нажмите на кнопку `Install...` в верхнем правом углу окна. В диалоговом окне откройте путь к папке с аддоном [clever-show/blender-addon](../../blender-addon/) и выберите файл `addon.py`. Нажмите `Install Add-on from file...`. Аддон установлен.
* После установки аддона поставьте "галочку" напротив аддона `Import-Export: Export > CSV Drone Swarm Animation Exporter` для активации аддона.
Аддон активирован и готов к работе. Выполнение этих операций не понадобится при дальнейших запусках Blender.
## Экпорт при помощи аддона
Для вызова диалогового окна экспорта нажмите в верхнем меню `File > Export > CSV Drone Swarm Animation Exporter`. В открывшемся окне экспорта необходимо выбрать целевой путь экспорта и название папки, которую создаст аддон в процессе экспорта. В боковом меню доступна панель параметров экспорта:
* `Use name filter for objects` - чекбокс, определяет, будет ли использован фильтр объектов при сохранении их путей. При отключении этого параметра будут экспортированы пути всех видимых объектов.
* `Name identifier` - фильтр имён объектов. Если активен чекбокс `Use name filter for objects`, будут сохранены только пути объектов, содержащих данное значение в названии.
* `Show detailed animation warnings` - чекбокс, определяет, будут ли показаны предупреждения по превышению скоростей и расстояний в анимации.
* `Speed limit` - при нарушении указанного ограничения по скорости передвижения дронов будут выведены предупреждения.
* `Distance limit` - при нарушении указанной минимальной дистанции между дронами будут выведены предупреждения.
После настройки нужных параметров нажмите кнопку `Export Drone Swarm animation`. В указанную папку экспортируются анимации указанных объектов из проекта Blender в формате `.csv`.
## Деактивация и удаление
Для деактивации аддона уберите "галочку" напротив имени аддона, как описано [выше](#установка-и-настройка).
Для получения дополнительных сведений нажмите знак стрелочки слева от поля активации. В развернувшемся блоке так же есть кнопки:
* `Documentation` - ведет на страницу документации аддона
* `Report a bug` - ведет на страницу issues репозитория clever-show
* `Remove` - удаляет аддон (перед установкой новой версии рекомендуется удалить старую)