Перейти к основному содержимому

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

Публикация — это не просто загрузка jar. Годный релиз также требует метаданных, инструкций и быстрой финальной проверки.

Где вы находитесь

Шаг 4 из 4: превратите ваш локальный плагин в релиз, который смогут установить другие люди.

Предыдущий шаг: Запуск и отладка плагина

Чек-лист перед релизом​

Перед публикацией подтвердите всё следующее:

  • Версия в pom.xml совпадает с версией в plugin.yml
  • Плагин загружается на чистом локальном сервере
  • Отладочные логи и временный тестовый код удалены
  • Ваш README объясняет установку, использование и зависимости
  • Обязательные плагины чётко перечислены, если вы используете depend
  • Проверенная версия Nukkit-MOT или API указана там, где её увидят пользователи

Сборка релизного jar​

Сгенерируйте свежий артефакт:

mvn clean package

Публикуйте jar из target/ или из настроенной выходной папки plugins/, если вы включили автоматическое копирование на предыдущей странице.

Подготовка страницы проекта​

Даже простая страница плагина должна отвечать на эти вопросы:

  • Что делает плагин
  • С какой сборкой или API Nukkit-MOT он тестировался
  • Как пользователи его устанавливают
  • Предоставляет ли он команды, права или файлы конфигурации
  • Есть ли известные ограничения или несовместимости

Минимальная структура README работает хорошо:

README.md
# HelloWorldPlugin

## Overview
Short description of the plugin.

## Installation
Place the jar into `plugins/` and restart the server.

## Commands
List commands here if the plugin has any.

## Permissions
List permissions here if the plugin has any.

## Compatibility
Tested with Nukkit-MOT MOT-SNAPSHOT.

Выбор места публикации​

К распространённым каналам релиза относятся:

  • GitHub Releases: загрузите jar и напишите примечания к релизу
  • Форумы сообщества Nukkit-MOT: добавьте краткое представление, при необходимости скриншоты и шаги установки
  • Форумы, связанные с Cloudburst / Nukkit: полезны, если вы хотите охватить больше пользователей
  • Китайские сообщества, такие как MineBBS: полезны, если ваша аудитория в основном говорит по-китайски

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

Предлагаемый шаблон примечаний к релизу​

## HelloWorldPlugin 1.0.0

- Tested with: Nukkit-MOT MOT-SNAPSHOT
- Requires: no extra dependencies
- Installation: place the jar into `plugins/` and restart the server
- Features:
  - Logs a startup message
- Known issues:
  - None

Финальная проверка перед публичным релизом​

Выполните последнюю проверку на чистом сервере:

  • Удалите старый jar плагина
  • Скопируйте новый релизный jar в plugins/
  • Запустите сервер
  • Выполните plugins или pl
  • Убедитесь, что версия и имя плагина указаны верно

Если всё работает, ваш первый публичный релиз плагина готов.

Дальнейшие шаги​

После завершения первого релиза самыми полезными темами для продолжения обычно являются: