Использование плагинов

Включение плагинов

По этой причине выполнение плагинов по умолчанию отключено для каждого проекта. Для включения плагинов перейдите в Views > Plugins и установите флажок «Enable plugins for this project».

Включайте плагины только для тех проектов, которым вы доверяете. Если вы переместите или переименуете свой проект, вам нужно будет снова включить плагины.

Установка плагинов

Существует два способа установки плагинов: через зависимости вашего проекта или как файлы в папке plugins. После установки откройте Views > Plugins, чтобы включать или отключать их для каждого проекта.

Через NPM

Вы можете установить плагины с помощью node package manager (NPM). Установите плагин с помощью следующей команды:

1npm i --save-dev @wonderlandengine/not-a-real-plugin

Замените @wonderlandengine/not-a-real-plugin на любой плагин, который вы хотите установить. Выполнение этой команды создаст новую запись в разделе devDependencies вашего файла package.json.

Плагин появится в представлении Plugins.

Управление плагинами

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

Откройте Views > Plugins, чтобы видеть все доступные плагины и управлять ими:

Включайте плагины для текущего проекта, установив флажок вверху «Enable plugins for this project».
Используйте вкладки для переключения между «Editor Scope» (плагины, расширяющие сам редактор) и «Project Scope» (плагины, установленные вашим проектом через devDependencies или папку plugins).
Переключайте отдельные плагины вкл/выкл с помощью флажков. Изменения вступают в силу немедленно; некоторые плагины могут попросить вас перезагрузить проект.

Разработка

Создавать плагины легко. У вас есть три доступных метода:

Скрипт плагина

Один скрипт, который может использовать общие зависимости с вашим основным проектом package.json. Мы рекомендуем устанавливать любые зависимости, связанные с плагинами, как devDependencies (используя --save-dev).

Вы можете создать новый плагин, создав папку plugins в корне вашего проекта, затем щелкните правой кнопкой мыши > New Plugin.

Убедитесь, что в корне проекта установлен пакет @wonderlandengine/editor-api:

1npm i --save-dev @wonderlandengine/editor-api

Директория плагина

Аналогично Скрипту плагина, сначала создайте подпапку plugins, но затем создайте еще одну подпапку, которую назовите по имени вашего плагина.

В этой папке вы можете создать новый файл package.json (например, с помощью npm init).

Убедитесь, что в этой директории установлен пакет @wonderlandengine/editor-api:

1npm i --save @wonderlandengine/editor-api

Обратите внимание, используйте --save вместо --save-dev, так как вы устанавливаете не в проект Wonderland Engine, а в отдельный проект плагина.

Пакет плагина

Если вы хотите поделиться и распространять свой плагин, можно использовать npm init в отдельной папке и указать точки входа плагина в ключе "wonderlandengine" вашего package.json:

 1{
 2    // ...
 3    "wonderlandengine": {
 4        "plugins": [
 5            {
 6                "name": "My Plugin A",
 7                "main": "src/plugin-a.mjs"
 8            },
 9            {
10                "name": "My Plugin B",
11                "main": "src/plugin-b.mjs"
12            }
13        ]
14    },
15    // ...
16}

Убедитесь, что в этой директории установлен пакет @wonderlandengine/editor-api:

1npm i --save-peer @wonderlandengine/editor-api

Чтобы использовать этот локальный плагин в вашем проекте, npm i --save-dev <path-to-the-directory>, или публикуйте его, когда он готов, и устанавливайте через пакет, см. Установка.