Publishing Plugins

В этом разделе вы узнаете, как подготовить и опубликовать свои плагины для Wudgine, чтобы другие разработчики могли их использовать.

Подготовка плагина к публикации

Перед публикацией плагина необходимо выполнить несколько важных шагов:

1. Проверка структуры плагина

Убедитесь, что ваш плагин имеет правильную структуру:

MyPlugin/
├── CMakeLists.txt          # Файл сборки
├── plugin.json             # Манифест плагина
├── README.md               # Документация
├── LICENSE                 # Лицензия
├── src/                    # Исходный код
│   ├── MyPlugin.h
│   └── MyPlugin.cpp
└── resources/              # Ресурсы (если есть)
    ├── shaders/
    ├── textures/
    └── icons/

2. Проверка манифеста

Убедитесь, что файл plugin.json содержит всю необходимую информацию:

{
  "name": "MyPlugin",
  "version": "1.0.0",
  "author": "Ваше имя",
  "description": "Краткое описание плагина",
  "engineVersion": "1.0.0",
  "dependencies": ["OtherPlugin"],
  "entryPoint": "MyPlugin",
  "website": "https://example.com/my-plugin",
  "repository": "https://github.com/username/my-plugin",
  "tags": ["utility", "rendering", "tools"]
}

3. Создание документации

Создайте подробную документацию в файле README.md:

# MyPlugin

Краткое описание плагина и его возможностей.

## Возможности

- Функция 1
- Функция 2
- Функция 3

## Установка

1. Скопируйте папку плагина в директорию `plugins` вашего проекта Wudgine
2. Включите плагин в настройках проекта

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

```cpp
// Пример использования плагина

Настройки

Описание доступных настроек плагина.

Зависимости

OtherPlugin v1.0.0 или выше

Лицензия

MIT License


### 4. Выбор лицензии

Выберите подходящую лицензию для вашего плагина:

- **MIT License** — простая и либеральная лицензия, позволяющая использовать код в коммерческих проектах
- **GPL** — требует, чтобы производные работы также распространялись под GPL
- **Apache License 2.0** — разрешает использование в коммерческих проектах с сохранением авторских прав
- **BSD License** — минимальные ограничения на использование кода

Создайте файл `LICENSE` с текстом выбранной лицензии.

### 5. Тестирование

Перед публикацией тщательно протестируйте плагин:

- Проверьте работу плагина в разных версиях Wudgine
- Убедитесь, что плагин корректно инициализируется и завершает работу
- Проверьте совместимость с другими плагинами
- Протестируйте на разных платформах (Windows, macOS, Linux)

### 6. Версионирование

Используйте [семантическое версионирование](https://semver.org/):

- **MAJOR** — несовместимые изменения API
- **MINOR** — добавление функциональности с обратной совместимостью
- **PATCH** — исправления ошибок с обратной совместимостью

Например: `1.2.3`, где `1` — мажорная версия, `2` — минорная версия, `3` — патч.

## Публикация в репозитории плагинов Wudgine

Wudgine предоставляет официальный репозиторий плагинов, где разработчики могут публиковать свои плагины:

### 1. Регистрация в репозитории

1. Создайте аккаунт на [портале разработчиков Wudgine](https://developer.wudgine.com)
2. Перейдите в раздел "Мои плагины"
3. Нажмите кнопку "Добавить плагин"

### 2. Заполнение информации о плагине

Заполните форму с информацией о плагине:

- **Название плагина** — должно совпадать с полем `name` в манифесте
- **Версия** — должна совпадать с полем `version` в манифесте
- **Описание** — краткое описание плагина
- **Категория** — выберите подходящую категорию
- **Теги** — добавьте теги для улучшения поиска
- **Скриншоты** — добавьте скриншоты плагина в действии
- **Ссылка на репозиторий** — GitHub, GitLab или другой репозиторий с исходным кодом
- **Ссылка на документацию** — если есть отдельная документация
- **Лицензия** — выберите лицензию из списка

### 3. Загрузка плагина

Существует два способа загрузки плагина:

#### Вариант 1: Загрузка архива

1. Создайте ZIP-архив с содержимым вашего плагина
2. Загрузите архив через форму на портале разработчиков

#### Вариант 2: Интеграция с GitHub

1. Подключите свой аккаунт GitHub к порталу разработчиков
2. Выберите репозиторий с плагином
3. Настройте автоматическую публикацию при создании релиза

### 4. Проверка плагина

После загрузки плагин проходит автоматическую проверку:

- Проверка структуры плагина
- Проверка манифеста
- Компиляция плагина
- Базовое тестирование

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

### 5. Публикация

После успешной проверки плагин будет опубликован в репозитории и станет доступен другим разработчикам.

## Публикация на GitHub

Альтернативный способ распространения плагина — публикация на GitHub:

### 1. Создание репозитория

1. Создайте новый репозиторий на GitHub
2. Загрузите файлы плагина в репозиторий
3. Добавьте файл `README.md` с описанием плагина
4. Добавьте файл `LICENSE` с текстом лицензии

### 2. Настройка релизов

1. Создайте новый релиз на GitHub
2. Укажите версию плагина в формате `v1.0.0`
3. Добавьте описание изменений в релизе
4. Прикрепите ZIP-архив с плагином к релизу

### 3. Использование GitHub Pages

Для создания документации можно использовать GitHub Pages:

1. Создайте ветку `gh-pages` в репозитории
2. Добавьте файлы документации в формате Markdown или HTML
3. Настройте GitHub Pages в настройках репозитория

## Обновление плагина

При выпуске новой версии плагина:

1. Обновите версию в файле `plugin.json`
2. Обновите документацию с описанием изменений
3. Создайте новый релиз на GitHub
4. Загрузите новую версию в репозиторий плагинов Wudgine

## Лучшие практики

### Совместимость

- Указывайте минимальную версию Wudgine, с которой совместим плагин
- Поддерживайте обратную совместимость при обновлении плагина
- Если необходимы несовместимые изменения, увеличивайте мажорную версию

### Зависимости

- Минимизируйте количество зависимостей
- Указывайте все зависимости в манифесте
- Проверяйте наличие зависимостей при инициализации плагина

### Документация

- Подробно документируйте API плагина
- Добавляйте примеры использования
- Создайте руководство по началу работы
- Документируйте все настройки плагина

### Обратная связь

- Укажите способы связи для сообщения об ошибках
- Создайте систему отслеживания проблем (например, GitHub Issues)
- Оперативно отвечайте на вопросы пользователей

## Монетизация плагинов

Существует несколько способов монетизации плагинов:

### 1. Платные плагины

Вы можете продавать плагины через:

- Официальный магазин плагинов Wudgine
- Собственный веб-сайт
- Маркетплейсы для разработчиков игр

### 2. Freemium-модель

- Базовая версия плагина бесплатна
- Расширенные функции доступны за плату

### 3. Подписка

- Доступ к плагину по подписке
- Регулярные обновления и поддержка

### 4. Поддержка и услуги

- Бесплатный плагин
- Платная техническая поддержка и консультации

## Продвижение плагина

Для привлечения пользователей:

- Создайте демонстрационное видео
- Напишите статью о плагине
- Поделитесь плагином в сообществах разработчиков
- Создайте демо-проект, демонстрирующий возможности плагина

## Что дальше?

Теперь, когда вы знаете, как публиковать плагины, вы можете:

- Изучить [продвинутые темы](/advanced-topics/overview) для более глубокого понимания Wudgine
- Присоединиться к [сообществу разработчиков Wudgine](https://community.wudgine.com) для обмена опытом

::alert{type="success"}
Публикация плагинов — отличный способ поделиться своими разработками с сообществом и получить обратную связь для дальнейшего улучшения.
::

Plugin Examples

Overview

Documentation