Skip to content
pnFolderPublic

About

Общая библиотека для плагинов экосистемы PrivateNull

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

pnLibrary

Общая библиотека плагинов pnFolder для Bukkit/Paper/Folia, BungeeCord и Velocity: одна установка на сервер, общий рантайм для всех плагинов студии.

Что даёт плагинам:

  • Обновления. Каталог релизов, каналы (stable, rc, beta, alpha, dev), проверка SHA-256, подготовка к перезапуску, резервные копии и откат, история с автором каждого действия, пауза до 7 дней.
  • Диагностика. Журнал событий /pn events со стеком вызовов и сводкой ошибок при входе администратора, «чёрный ящик» с удалением секретов, зашифрованный отчёт /pn debug для поддержки.
  • Метрики. bStats и FastStats через один интерфейс, с уважением настройки отключения bStats.
  • Инструменты для плагинов. Команды без plugin.yml (на Paper ещё и через Brigadier), задачи (включая Folia), события, конфигурации, плейсхолдеры, кулдауны, сообщения на Adventure, валюта (Vault/PlayerPoints), меню и предметы для Bukkit.

Поддерживаются серверы с 1.8 и Java 8; Velocity требует Java 17.

Установка на сервер

Положите pnLibrary-<версия>-universal.jar в plugins/ — один файл работает на Bukkit, BungeeCord и Velocity. Если у сервера нет доступа к репозиториям при старте, возьмите pnLibrary-<версия>-universal-full.jar.

Команды (Bukkit):

Команда Что делает
/pn или /pn updates каталог плагинов и обновлений
/pn updates info <плагин> карточка плагина
/pn updates settings <плагин> канал, автозагрузка, пауза
/pn updates history история обновлений
/pn updates backups резервные наборы для отката
/pn check, /pn update <плагин> проверить, подготовить обновление
/pn gui меню: плагины, обновления, история, откаты
/pn status состояние сервера и плагинов
/pn events журнал событий: ошибки, предупреждения, повторы, стек вызовов
/pninfo версия pnLibrary и платформа, для обращения в поддержку
/pn money управление валютами плагинов
/pn stats почасовая статистика ошибок, задач и событий
/pn placeholders [test <адрес>] список и проверка плейсхолдеров
/pn bus, /pn tasks шина событий, задачи плагинов
/pn servers, /pn support серверы сети, обращение в поддержку
/pn debug [all|плагин] отчёт для поддержки

На BungeeCord и Velocity команда называется /pnproxy (коротко /pnp): каталог обновлений, events, bus, tasks, stats, placeholders, debug, servers и groups (группы серверов есть только на прокси). Все команды обновлений и права описаны в docs/updates.md.

Остальные права (по умолчанию у операторов):

Право Что разрешает
pnlibrary.admin всё управление pnLibrary
pnlibrary.events.view /pn events и сводку ошибок при входе
pnlibrary.stats /pn stats и страница статистики в меню
pnlibrary.placeholders /pn placeholders: список и проверка плейсхолдеров
pnlibrary.debug /pn debug
pnlibrary.tasks /pn tasks
pnlibrary.events.bus /pn bus
pnlibrary.groups /pnproxy groups
pnlibrary.servers /pn servers
pnlibrary.currency.list список валют в /pn money

Права обновлений (pnlibrary.updates.*) описаны в docs/updates.md.

Подключение к плагину

dependencies {
    compileOnly("io.github.pnfolder:pnlibrary-api:<версия>")
    // для Bukkit-специфичных возможностей (меню, предметы, визуальные сущности)
    compileOnly("io.github.pnfolder:pnlibrary-bukkit-api:<версия>")
}

В plugin.yml плагина: depend: [pnLibrary].

Какие модули подключать и как собрать библиотеку локально, не публикуя, описано в integration/README.md.

val library = PnLibraryProvider.get()
val registration = library.plugins.register(this)
val context = registration.registerModule("main")   // ModuleContext: tasks, events, configs, placeholders, updates
val bukkit = library.platform<BukkitPlatform>()   // меню, предметы, визуальные сущности

API состоит из интерфейсов, моделей и небольших служебных помощников (билдеры, ключи, сериализаторы); реализация живёт в рантайме. Плагин никогда не зависит от классов core, а публичный API защищён проверкой бинарной совместимости.

Сборка

./gradlew build                          # все модули, тесты, проверка API
./gradlew :distribution:shadowUniversal  # distribution/build/libs/pnLibrary-<версия>-universal.jar

Кроме лёгкого universal (Kotlin и Adventure скачиваются при старте) есть universal-full (shadowUniversalFull): всё внутри, ничего не скачивается. Он лежит в релизе GitHub как ручная загрузка и в каталог обновлений не входит. Платформенные сборки: shadowBukkit, shadowBungee, shadowVelocity.

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

About

Общая библиотека для плагинов экосистемы PrivateNull

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages