Работа над проектами

Проект в XOD группирует несколько патчей вместе и формирует единый сохраняемый / совместно используемый объект.

Обычно вы создаете проект XOD для реального проекта, что бы это ни значило. Это может быть выставка цифрового искусства для какого-то предстоящего мероприятия, программа для обучения студентов или единичный эксперимент. Один проект может быть нацелен на несколько физических устройств, если они являются частями целого.

Чтобы быть более точным, XOD не устанавливает никаких технических ограничений на то, что проект должен содержать или не содержать. Это чисто организационный объект.

Как создать проект #

Запустить новый проект в XOD IDE так же просто, как нажать “File → New Project” в главном меню.

Новый проект начинается с одного патча main, который не имеет специального значения. Вы можете переименовать или удалить его сразу, если хотите.

Сохранение проекта #

XOD хранит проекты локально на вашем компьютере в файле или файлах. В этом смысле он похож на множество других классических приложений: вы можете сохранять, сохранять, открывать, перемещать, копировать или удалять файлы проектов на своем ПК или на разных машинах.

Тонкое отличие от других приложений заключается в том, что хотя XOD IDE может выглядеть как редактор нескольких документов (вы открываете патчи на вкладках), операция сохранения является атомарной и сохраняет / обновляет каждую часть проекта за один раз. Такое поведение необходимо для предотвращения несогласованности ссылок на ноды и поддержки двух возможных вариантов хранения, описанных ниже.

Архив .xodball #

По умолчанию для сохранения проекта используется так называемый xodball, формат, в котором весь проект собирается в один файл с .xodball расширением.

Когда у вас есть xodball, вы можете сделать с ним то же самое, что и с файлом офисного документа: отправить его кому-то по электронной почте, поместить его в Dropbox, чтобы поделиться им с другим ПК или дублировать его, чтобы сделать быстрый резервное копирование.

Для профи Под капотом xodball - красиво напечатанный JSON-документ, который описывает все патчи, ноды, ссылки и другие объекты, содержащиеся в проекте.

Многофайловые проекты #

Режим с несколькими файлами может быть более подходящим для продвинутых xoders, которым требуется мелкомасштабный контроль над файлами проекта, эффективная совместная работа и контроль версий с помощью традиционного VCS, такого как Git.

Чтобы сохранить проект в нескольких файлах, выберите этот параметр в диалоговом окне сохранения (Windows, Linux) или уберите .xodball расширение при сохранении (macOS).

Обратите внимание, что проекты с несколькими файлами поддерживаются только в настольной версии IDE. Браузерная версия всегда работает с xodballs из-за отсутствия системных разрешений.

Пример схемы проекта с двумя патчами, сохраненными в нескольких файлах:

/path/to/project-directory
 dc-motors Папка для патча
patch.xodp JSON описание патча
README.md Детальное описание нод
wiring_motorz.png Произвольный медиафайл, указанный в README.md
servo Папка для другого патча
patch.cpp Интерпритация C ++ для патч-ноды
patch.xodp JSON описание патча
project.xod Информация о проекте: имя, версия, лицензия и т.д.

Открытие проекта #

Чтобы открыть проект, сделанный вами или загруженный, нажмите “File → Open Project” в XOD IDE и укажите его .xodball или project.xod файл.

Примечание: Вы также можете дважды щелкнуть файл в вашем браузере файлов ОС. Однако ассоциации файлов устанавливаются только при установке настольной XOD IDE на MacOS или Windows в системной папке (т.е. на C:\Program Files\).

В отличие от многих других систем разработки, когда вы открываете проект, XOD пытается разрешить любые отсутствующие зависимости и несоответствия. Это означает, что для продолжения проекта, сделанного кем-либо на любой машине, достаточно просто открыть проект в среде IDE.

Примечание XOD еще не завершен, и поэтому есть два недостатка, которые вы, в конце концов, должны отметить.
  • Если проект открыт и ссылается на библиотеку, которую вы еще не установили, вы увидите красные ноды, линки и мертвые линки. Через несколько секунд он вернется в нормальное состояние, когда XOD автоматически установит необходимые библиотеки из облака.

  • Может случиться так, что библиотека, от которой зависит проект, в последнее время внедрила некоторые обратно-несовместимые изменения, и вы останетесь с некоторыми мертвыми линками. В этом случае вам придется вручную установить проблемную библиотеку.

Found a typo or mistake? Want to improve the text? Edit this page on GitHub and open a pull request. If you have a complex proposal or you want to discuss the content, feel free to start a new thread on XOD forum.