Мениджър на пакети Unity

Unity е платформа, която съществува от доста време и непрекъснато се развива. Въпреки това, когато работите в него с няколко проекта едновременно, все още можете да срещнете трудности при използването на общи източници (.cs), библиотеки (.dll) и други активи (изображения, звуци, модели, готови). В тази статия ще говорим за нашия опит с естествено решение на такъв проблем за Unity.

Споделени методи за разпространение на ресурси

Има повече от един начин за използване на споделени ресурси за различни проекти, но всеки подход има своите плюсове и минуси.

1. Дублиране - ние дублираме ресурси между проекти „на ръка“.

плюсове:

• Подходящ за всички видове ресурси.
• Няма проблеми със зависимостта.
• Няма проблеми с GUID на активи.

против:

• Гигантски хранилища.
• Няма възможност за версия.
• Трудност при проследяване на промените в споделените ресурси.
• Трудност при актуализиране на споделени ресурси.

2. Git подмодули — разпределение на споделени ресурси чрез външни подмодули.

плюсове:

• Можете да работите с източниците.
• Можете да разпределите активи.
• Няма проблеми със зависимостта.

против:

• Изисква се Git опит.
• Git не е много приятелски настроен към бинарните файлове - ще трябва да свържете LFS.
• Контрол на достъп до хранилища.
• Трудност при надграждане и понижаване на версии.
• Възможни са сблъсъци на GUID и няма ясно поведение от страна на Unity за разрешаването им.

3. NuGet - разпространение на споделени библиотеки чрез NuGet пакети.

плюсове:

• Удобна работа с проекти, които не зависят от Unity.
• Удобно управление на версии и разрешаване на зависимости.

против:

• Unity не може да работи с NuGet пакети извън кутията (в GitHub можете да намерите NuGet Package Manager за Unity, който коригира това, но има някои нюанси).
• Трудности при разпределението на други видове активи.

4. Unity Package Manager - разпространение на споделени ресурси чрез нативно решение за Unity.

плюсове:

• Роден интерфейс за работа с пакети.
• Защита срещу презаписване на .meta файлове в пакети поради конфликти на GUID.
• Възможност за версии.
• Възможност за разпространение на всички видове ресурси за Unity.

против:

• Все още могат да възникнат конфликти с GUID.
• Няма документация за изпълнение.

Последният метод има повече предимства, отколкото недостатъци. Сега обаче не е много популярен поради липсата на документация и затова ще се спрем подробно на него.

Мениджър на пакети Unity

Unity Package Manager (UPM) е инструмент за управление на пакети. Беше добавен в Unity 2018.1 и се използваше само за пакети, разработени от Unity Technologies. Въпреки това, започвайки с версия 2018.3, стана възможно добавянето на персонализирани пакети.

Интерфейс на Unity Package Manager

Пакетите не се озовават в източниците на проекта (директория с активи). Те са в отделна директория %projectFolder%/Library/PackageCache и не засягат проекта по никакъв начин, единственото им споменаване в изходния код е във файла packages/manifest.json.

Пакети във файловата система на проекта

Източници на пакети

UPM може да използва няколко източника на пакети:

1. Файлова система.

плюсове:

• Скорост на изпълнение.
• Не изисква инструменти на трети страни.

против:

• Трудности при управлението на версиите.
• Споделеният достъп до файловата система е необходим за всички, които работят с проекта.

2. Git хранилище.

плюсове:

• Всичко, от което се нуждаете, е Git хранилище.

против:

• Не можете да превключвате между версии през прозореца на UPM.
• Не работи с всички Git хранилища.

3. npm хранилище.

плюсове:

• Напълно поддържа UPM функционалност и се използва за разпространение на официални пакети на Unity.

против:

• В момента игнорира всички низови версии на пакети с изключение на "-preview".

По-долу ще разгледаме изпълнението на UPM + npm. Този пакет е удобен, защото ви позволява да работите с всякакъв тип ресурси и да управлявате версии на пакети, а също така напълно поддържа собствения UPM интерфейс.

Можете да го използвате като npm хранилище Вердачо. Има подробен документацияи са необходими само няколко команди, за да го стартирате.

Настройка на околната среда

Първо трябва да инсталирате node.js.

Създаване на пакет

За да създадете пакет, трябва да поставите файла package.json, който ще го опише, към директорията със съдържанието на този пакет. Трябва да направите следното:

Отидете в директорията на проекта, който искаме да направим пакет.

Изпълнете командата npm init и въведете необходимите стойности по време на диалоговия прозорец. За име посочете името в обратен домейн формат, например com.plarium.somepackage.
За да покажете удобно името на пакета, добавете свойството displayName към package.json и го попълнете.

Тъй като npm е js-ориентиран, файлът съдържа свойствата main и scripts, които не са ни необходими, които Unity не използва. По-добре е да ги премахнете, за да не претрупвате описанието на опаковката. Файлът трябва да изглежда така:

1. Отидете в директорията на проекта, който искаме да направим пакет.
2. Изпълнете командата npm init и въведете необходимите стойности по време на диалоговия прозорец. За име посочете името в обратен домейн формат, например com.plarium.somepackage.
3. За да покажете удобно името на пакета, добавете свойството displayName към package.json и го попълнете.
4. Тъй като npm е js-ориентиран, файлът съдържа свойствата main и scripts, които не са ни необходими, които Unity не използва. По-добре е да ги премахнете, за да не претрупвате описанието на опаковката. Файлът трябва да изглежда така:

   {
    "name": "com.plarium.somepackage",
    "displayName": "Some Package",
    "version": "1.0.0",
    "description": "Some Package Description",
    "keywords": [
      "Unity",
      "UPM"
    ],
    "author": "AUTHOR",
    "license": "UNLICENSED"
   }

5. Отворете Unity и генерирайте .meta файл за package.json (Unity не вижда активи без .meta файлове, пакетите за Unity се отварят само за четене).

Изпращане на пакет

За да изпратите пакета, трябва да изпълните командата: npm publish --registry *адрес до хранилища пакетов*.

Инсталиране и актуализиране на пакети чрез Unity Package Manager

За да добавите пакет към проект на Unity, трябва:

1. Добавяне към файла manifest.json информация за източника на пакетите. За да направите това, трябва да добавите свойството scopedRegistries и посочете обхватите и адреса на източника, където ще се търси конкретни обхвати.

   
   "scopedRegistries": [
      {
        "name": "Main",
        "url": "адрес до хранилища пакетов",
        "scopes": [
          "com.plarium"
        ]
      }
    ]
   

2. Отидете на Unity и отворете прозореца Package Manager (работата с персонализирани пакети не се различава от работата с вградени).
3. Изберете Всички пакети.
4. Намерете необходимия пакет и го добавете.

Работа с източници и отстраняване на грешки

За да бъдат свързани източниците към проекта, трябва да създадете Дефиниция на сглобяване за пакета.

Използването на пакети не ограничава опциите ви за отстраняване на грешки. Въпреки това, когато работите с пакети в Unity, не можете да отидете до IDE, като щракнете върху грешка в конзолата, ако грешката е възникнала в пакета. Това се дължи на факта, че Unity не вижда скриптовете като отделни файлове, тъй като при използване на дефиницията на асемблирането те се събират в библиотека и се включват в проекта. Когато работите с източници от проект, можете да кликнете върху IDE.

Скрипт в проект със свързан пакет:

Скрипт от пакета с работеща точка на прекъсване:

Спешни корекции на пакети

Пакетите Unity, добавени към проект, са само за четене, но могат да се редактират в кеша на пакетите. За да направите това ви трябва:

1. Отидете на пакета в кеша на пакетите.

   

2. Направете необходимите промени.
3. Актуализирайте версията във файла package.json.
4. Изпратете пакет npm publish --registry *адрес до хранилища пакетов*.
5. Актуализирайте версията на пакета до коригираната чрез UPM интерфейса.

Конфликти при импортиране на пакети

Следните GUID конфликти могат да възникнат при импортиране на пакети:

1. Пакет - пакет. Ако при импортиране на пакет се установи, че вече добавените пакети съдържат активи със същия GUID, активите със съвпадащи GUID от импортирания пакет няма да бъдат добавени към проекта.
2. Пакетът е проект. Ако при импортиране на пакет се установи, че проектът съдържа активи със съвпадащи GUID, тогава активите от пакета няма да бъдат добавени към проекта. Въпреки това активите, които зависят от тях, ще започнат да използват активи от проекта.

Прехвърляне на активи от проект към пакет

Ако прехвърлите актив от проект към пакет, докато Unity е отворен, неговата функционалност ще бъде запазена и връзките в зависимите активи ще започнат да използват актива от пакета.

Важно е: Когато копирате актив от проект в пакет, ще възникне конфликтът „Пакет - Проект“, описан в раздела по-горе.

Възможни решения на конфликти

1. Преназначаване на GUID с помощта на нашите собствени алгоритми при импортиране на всички активи за елиминиране на сблъсъци.
2. Добавяне на всички активи към един проект и след това разделянето им на пакети.
3. Създаване на база данни, съдържаща GUID на всички активи и извършване на валидиране при изпращане на пакети.

Заключение

UPM е ново решение за разпространение на споделени ресурси в Unity, което може да бъде достойна алтернатива на съществуващите методи. Препоръките, описани в статията, се основават на реални случаи. Надяваме се да ги намерите за полезни.

Източник: www.habr.com