Документация по JS-плагинам для BDEngine

Раздел в процессе написания и будет часто обновляться.

Важно: стабильным и официально поддерживаемым считается только API из window.editorAPI.

Объект window.editor доступен для изучения и экспериментов, но его структура может меняться без предупреждения и не гарантируется совместимость между версиями.

Структура JS-плагина

Описание

Типичный плагин состоит из двух частей:

  1. Шапка с метаданными в формате комментариев UserScript.

  2. Код плагина, как правило обёрнутый в IIFE (немедленно вызываемую функцию), чтобы не засорять глобальную область видимости.

Шапка плагина (Метаданные)

Пример:

// ==UserScript==
// @name         Test plugin
// @namespace    example-illystray
// @description  A test plugin that does nothing
// @logo_url     https://bdecdn.com/icon/icon-192x192.png
// @author       illystray
// ==/UserScript==

Обязательные поля:

@name - Человекочитаемое имя плагина. Отображается в интерфейсе.

@namespace - Уникальный идентификатор плагина. По нему определяется обновление/замена.

Необязательные поля:

@description - Краткое описание того, что делает плагин.

@logo_url - URL логотипа/иконки плагина. Изображение или SVG.

@author - Имя/ник автора.

Точка входа плагина

Рекомендуемый шаблон:

(() => {
    const log = (...args) => console.log('[Plugin name]', ...args);

    // Your code here
})();
  • Использование IIFE помогает изолировать переменные плагина.
  • Внутри функции вы можете использовать объекты window.editor и window.editorAPI.
Sign up to create and share content. Sign up
Студия
Сообщения
Войти
Обзор