link1107 / DonationExecutor

Плагин для ру-стримеров, генерирующий события на сервере Minecraft (Spigot/Paper) на основании донатов с "Donation Alerts"
GNU Affero General Public License v3.0
219 stars 22 forks source link

DonationExecutor - плагин для Minecraft 1.18+ (ядро "Paper")

GitHub license

Плагин, который, получая информацию о новых донатах с Donation Alerts, автоматически генерирует различные события на основании суммы доната.

Техподдержка в ВК (по вопросам, связанным с установкой или настройкой плагина)

Видео про этот плагин

Watch the video

Установка и использование

Как этим пользоваться?

  1. Вам понадобится сервер версии 1.18.1 (другие версии не тестировались) на ядре Paper.
  2. Скачайте плагин (jar-файл), закиньте его в папку сервера "/plugins".
  3. Запустите сервер, подождите полной загрузки, остановите сервер.
  4. Откройте появившийся конфигурационный файл DonationExecutor.yml в папке "/plugins/DonationExecutor".
  5. Заполните конфигурационный файл в соответствии с инструкциями в нем (особое внимание уделите токенам Donation Alerts, а также никнеймам стримеров). Сохраните изменения, закройте файл.
  6. Запустите сервер. В случае корректно заполненного конфиг-файла, все должно работать.
  7. Для использования команд плагина либо сделайте себя оператором сервера (пропишите "op <ВАШ_НИКНЕЙМ>" консоль сервера), либо добавьте себе разрешения, используя плагин управления пермишенами (например, LuckPerms) - de.donate, de.reload, de.filter (подробнее - ниже).
  8. Составьте список сумм и действий с кратким описанием и разместите его для зрителей в описании к стриму или на странице Donation Alerts.

Пример списка (можно разместить в описание под стримом или на странице донатов DonationAlerts):

🔴62 руб. - Насрать в свободные слоты инвентаря именным говном, но не более 10 стаков (на стаках с говном будет указано, что оно принадлежит вам, на основе вашего ника с DonationAlerts)
🔴62 руб. - Выбить активный стак предметов из рук (если в момент доната в руке ничего нет, то ничего не произойдет)
🔴66 руб. - Призвать Некоглая
🔴68 руб. - Дать леща (небольшой толчок вперед с уменьшением хп на 1 сердечко)
🔴71 руб. - Установить в игре ночь
🔴73 руб. - Установить в игре день
🔴82 руб. - Дать 4 куска хлеба
🔴101 руб. - Дать железный меч
🔴121 руб. - Призвать прирученного котейку (с вашим ником в качестве имени)
🔴132 руб. - Дать 4 алмаза (будут подписаны с указанием вашего имени из доната DonationAlerts)
🔴142 руб. - Наслать отряд НКВД из 3-х сотрудников
🔴151 руб. - Дать железный сет брони
🔴161 руб. - Дать сильного пинка под зад
🔴167 руб. - Призвать прирученного волка (с вашим ником в качестве имени)
🔴197 руб. - Заменяет 5 рандомных слотов в инвентаре на камни
🔴202 руб. - Заспавнить крипера за спиной (но если прямо за спиной будут блоки, крипер может в них застрять)
🔴231 руб. - Дать алмазный меч
🔴251 руб. - Обратить всех прирученных мною животных против хозяина (кошки просто перестанут быть прирученными, волки еще и начнут нападать, на остальных животных не влияет)
🔴501 руб. - Заспавнить гигантского Иосифа Сталина (преследует игроков и испепеляет все вокруг)
🔴551 руб. - Полностью восстанавливает здоровье
🔴601 руб. - Оставляет только лишь полсердечка здоровья
🔴231 руб. - Дать алмазный сет брони
🔴2001 руб. - Очень большой взрыв (радиус 15) с задержкой в 3 секунды со мной в центре этого взрыва (центр взрыва находится там, где я нахожусь в момент взрыва), а также последующий пожар на затронутых блоках.
🔴2011 руб. - Дать целый стак алмазов
НЕ ЗАБУДЬТЕ ИЗМЕНИТЬ ЦЕНЫ НА ВАШИ!

FAQ

Это плагин или мод?

Это плагин, его необходимо добавить только на сам сервер. Однако, для полной функциональности и работоспособности (например, отображение кастомных скинов на мобах) вам понадобится мод Optifine последней версии.

Могу ли я вручную сымитировать донат? (например, если донат не сработал автоматически, или я хочу протестировать донат)

Да. Донат можно протестировать командой "/de donate <сумма доната без копеек> <ник донатера (необязательно)>".

Какие еще доступны команды?

/de donate <СУММА> <ИМЯ> ## <СООБЩЕНИЕ_необязательно> - сымитировать донат
/de reload - перезагрузить настройки из конфига
/de filter ON|OFF - включить/выключить фильтр никнеймов
/de help - вывести список доступных команд

Могу ли я ограничить использование команд?

Да. В плагине имеются пермишены (разрешения) для использование каждой из команд: de.donate, de.reload, de.filter
Чтобы использовать команды, вам нужно либо добавить разрешения в плагин, управляющий разрешениями (например, luckperms), либо если вы не используете плагин разрешений, то можете сделать себя оператором сервера, прописав "op <ваш никнейм>" в консоль сервера. Чтобы разрешить другим игрокам использовать команды, вы можете либо добавить им разрешения в плагине, управляющем разрешениями, либо так же сделать их операторами сервера (но учтите, что в этом случае они получат возможность управления сервером).

Где я могу увидеть доступные настройки?

После первого запуска сервера с плагином, откройте конфигурационный файл DonationExecutor.yml в папке "/plugins/DonationExecutor".

Могу ли я изменить/дополнить этот код и использовать его в коммерческих целях?

Да, данный плагин распространяется по лицензии AGPL 3.0. Если вы являетесь стримером, и хотите, чтобы я специально для вас создал версию плагина с вашими уникальными событиями или фичами, можете связаться со мной по электронной почте - igortokach@gmail.com

Планируется ли дальнейшее развитие плагина и добавление новых событий или функций?

Да. Но так как это по большей части мое хобби, я буду обновлять плагин по мере моих возможностей и наличия свободного времени.

Почему все комментарии и описание на русском языке?

Плагин в данный отлавливает донаты только с Donation Alerts, которым пользуются в подавляющем большинстве русские стримеры. Также зрители моего видео об этом плагине на YouTube могут не знать английского языка, что сделает процесс ознакомления с кодом для них более сложным. Я знаю, что на гитхабе и в среде программистов общепринят английский язык, но в данной ситуации я не думаю, что это для кого-то будет критично.

Автор