Создание аддона

Эта страница описывает азы создания дополнения для Scratch Addons. Перед началом, просим Вас прочитать азы дополнений отключить любые другие исполняющиеся копии Scratch Addons во избежание конфликтов.

Требования

Scratch Addons не требует никакого программного обеспечения кроме текстового редактора и браузера на основе Chromium (121+), но мы также очень рекомендуем установку инструмента Git, браузера Firefox (121+) и редактора Visual Studio Code.

Установка

Чтобы установить расширение для разработки, смотрите Установка из открытого исходного кода.

Создание папки дополнения

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

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

• a11y
• data-category-tweaks
• featured-dangos
• fix-buttons
• forum-time-zones
• image-uploader
• redirect-mobile-forums
• scratchstats
• tutorials-button

Откройте файл addons.json в папке addons, вставьте новый ID дополнения над линией // NEW ADDONS ABOVE THIS ↑↑ ближе к концу файла, потом создайте под-папку с тем же именем.

Манифест дополнения

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

Манифесты дополнений располагаются в папке каждого дополнения и называются addon.json. Вот минимальный манифест дополнения:

{
  "name": "My addon",
  "description": "TODO",
  "tags": ["community"]
}

Для большей информации о том, что может быть объявлено в манифесте, исследуйте документацию Манифестов Дополнений.

Дополнение пока что ничего не делает, но оно должно появиться в всплывающем окне и на странице настроек после перезагрузки расширения.

Пользовательские сценарии и пользовательские стили

Пользовательские сценарии и пользовательские стили — то, на чём работает дополнение. Пользовательские сценарии исполняют код JavaScript и пользовательские стили инъецируют стили CSS. Дополнения могут иметь комбинацию и пользовательских стилей, и пользовательских сценариев.

Пользовательские сценарии имеют доступ к интерфейсам addon, чтобы сделать задачи, связанные со Scratch, как например извлечение текущего пользователя, прощею

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

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

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

Посмотрите документацию addon.settings по доступе к пользовательским выборам из пользовательских сценариев и пользовательских стилей.

До пожертвования

Если вы хотите отправить ваше дополнение на GitHub репозиторий Scratch Addons для возможности его добавления к библиотеке дополнений, убедитесь, что дополнение работет как задумано и что оно не ломает другие дополнения. У манифеста дополнения должно быть хорошее имя и описание, versionAdded должно быть установлено на следующюю версию расширения, а также дополнение не должно быть включённым по умолчанию. Дополнения должны поддерживать динамическое включение и выключение, но это не строго обязательно. Удостоверьтесь в понятности кода, даже бесполезные комментарии лучше их отсутствия.

Отправка запроса на объединение

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

Если Ваше дополнение не готово, или Вам нужна с чем-то помощь, то создайте черновой запрос на объединение.

Имейте в виду, что мы можем попросить вас сделать поправки, и что процесс проверки может быть медленным, но мы наверно подтвердим Ваше дополнение, пока оно минимально подходящее и предназначеное для Scratch.