Плагины
Плагины добавляют в Studio новые инструменты. Здесь — как их найти и установить и как решить, каким из них доверять.
Плагин может добавить панель, генерировать сцены, обрабатывать ресурсы или добавить вашим объектам новый вид компонента. Он работает прямо в редакторе, ничего пересобирать не нужно.
Ещё плагин может принести свой код в опубликованный проект: то, что движется само, новые триггеры и шаги для событий и свой раздел в Настройках проекта.
Хотите сделать свой? Читайте Как написать плагин.
Панель «Плагины»
В панели две вкладки:
- Мои загрузки — всё ваше в одном списке: папки плагинов, над которыми вы работаете, плагины, которые вы опубликовали, и плагины, которые вы установили. Здесь можно создать плагин, открыть папку, перечитать её с диска, опубликовать плагин или снять с публикации и удалить его.
- Хаб креаторов — плагины, которыми делятся все. Их можно искать, фильтровать по тегам, смотреть скриншоты, автора, рейтинг, число установок и добавлений в избранное. Ваши и установленные плагины показываются выше.
Когда вы вводите запрос в поиск, обе вкладки сливаются в один список, и ваши плагины идут первыми.
Установите плагин
Установка добавляет плагин только в ваш редактор. Его иконка появится в вашей панели инструментов.
Чтобы плагин был у всей команды, нажмите Добавить в проект. Тогда он появится у всех, кто открывает этот проект. Так стоит делать с инструментами, которыми пользуется вся команда, — например, с проверкой стиля или общим генератором сцен.
Плагины с кодом для опубликованного проекта
Некоторые плагины работают и в опубликованном проекте, у всех, кто его открывает. Этот код работает только в проектах, в которые плагин добавлен.
Когда вы добавляете такой плагин в проект, проект сохраняет эту версию его кода. Предпросмотр, плейтесты и публикации запускают её, даже когда автор опубликовал новую. Когда есть код новее, у плагина появляется пометка есть обновление. Нажмите Обновить в проекте, чтобы перевести проект на него.
Если вы автор плагина и добавили его сами, проект запускает каждую версию, которую вы сохраняете. Опубликованный проект запускает код, с которым его опубликовали, до следующей публикации.
Снятые с публикации плагины
Когда автор нажимает Снять с публикации, плагин удаляется из библиотеки. Он пропадает из редактора у всех и из всех проектов, куда его добавили. Его оценки и добавления в избранное тоже удаляются.
Доверие и проверка
Плагин может читать и менять вашу сцену и ресурсы. Поэтому, когда вы впервые открываете чужой плагин, Studio просит подтверждения. Отметьте Больше не спрашивать об этом плагине, чтобы ответ запомнился.
Устанавливайте плагины так же, как расширения браузера: только те, которым есть причины доверять.
Плагин перечисляет нужные ему права в манифесте, но Studio не ограничивает его ими. Любой плагин может добраться до всего проекта, что бы в нём ни было перечислено.
Проверенные плагины
Значок Проверен означает, что кто-то прочитал код именно этой версии плагина. Это не оценка того, насколько плагин хорош.
Когда автор публикует новый код, плагин снова ждёт проверки (статус pending), пока его не
проверят ещё раз. Если поменять описание, теги или скриншоты, значок остаётся: они не выполняются.
Проверка может ещё и отключить часть запросов. Каждый настраивается отдельно:
| Настройка | Что отключает |
|---|---|
open | подтверждение при открытии панели плагина |
autorun | запрос перед запуском частей, которые стартуют сами, — см. ниже |
warnings | предупреждения о том, что мы не проверяем код плагинов |
Плагин может быть проверен и без всех этих настроек. Тогда у него есть значок, но все запросы остаются. Прочитать код и отключить запросы — два отдельных решения.
Панель работает, только когда вы её открываете. А свой компонент
или слой поверх области просмотра запускается каждый раз, когда кто-то открывает проект. Поэтому
autorun — отдельная настройка.
Части, которые запускаются сами, работают только у плагина, которому доверяют в вашем браузере:
- у плагина, который вы открыли из папки на своём компьютере;
- у плагина, который вы уже разрешили: нажали Разрешить или выбрали Больше не спрашивать об этом плагине, когда открывали его;
- у плагина, проверка которого включает
autorun.
У любого другого плагина они ждут. Свой компонент вместо запуска показывает заметку с кнопкой Разрешить. Слой остаётся скрытым. Когда плагину есть что показать, небольшая полоса попросит разрешить его. Ответ хранится только в этом браузере, поэтому другой браузер спросит снова.
Он работает у всех, кто открывает проект, как собственные скрипты проекта, поэтому решение за команду принимает тот, кто добавляет плагин. Вот почему версия фиксируется при добавлении: новый код попадает в проект, только когда кто-то нажмёт Обновить в проекте.
Статус проверки плагина — один из none, pending, verified, rejected или revoked. Если
проверку отозвали, ваш выбор Больше не спрашивать об этом плагине тоже сбрасывается: вы
соглашались на другой код.
Оценки и платные плагины
Плагин можно оценить один раз, от одной до пяти звёзд.
Автор выбирает, кто может установить плагин:
| Доступ | Кто может установить |
|---|---|
| Бесплатно | все |
| Премиум | пользователи платного тарифа |
| Только подписчикам | те, у кого есть платная подписка на публичный профиль автора |
В проекте учитывается подписка организации проекта. Ваши собственные плагины доступны вам всегда.
Код в проекте у плагина с доступом Только подписчикам попадает ко всем, кто открывает опубликованный проект, и любой может прочитать его в браузере. Подписка решает, кто может добавить плагин в проект, обновить его и опубликовать проект с ним.
Когда подписка заканчивается, проект с таким плагином больше нельзя опубликовать заново: продлите подписку или уберите плагин. Уже опубликованный проект продолжает работать.
Что понадобится
- Чтобы пользоваться плагинами из библиотеки: любой браузер.
- Чтобы собирать плагины из папки на компьютере: браузер на основе Chromium, например Chrome или Edge.
Дальше: Как написать плагин — соберите и опубликуйте свой.