Стартап Туториал | Создание плагинов | Spigot/CraftBukkit/Bukkit

CraftBukkit - глобальная серверная модификация, предоставляющая API для взаимодействия с игровым миром и созданная для упрощения создания плагинов к SMP-серверу.В августе 2014 года команду Bukkit покинули практически все разработчики, в том числе глава проекта EvilSeph.

Spigot - оптимизированная версия CraftBukkit со своими доработками и новыми возможностями и настройками, которая продолжила работу команды Bukkit.

Разработки, созданные для данного туториала, используют ядро Spigot.

+ Помощь в изучении Java

Начало:
Софт:
Среды разработки:
+ Eclipse (удобная, понятная среда розработки, отлично подходит для новичков)
+ IntelliJ IDEA (проффесиональная среда розработки, но ее интерфейс сложно изучить новичкам)
+ NetBeans (по моему мнению, самая худшая среда розработки среди этих трех, хотя и полностью русифицирована)
Программа для редактирования и создания конфигурационных файлов (конфигов крч):
+ Notepad++

В данном туториале для примера мы будем использовать Eclipse!

Создание проекта\пакетов\классов\
(Внимание! Те, кто умеет это делать, промотайте эту часть!)

Создание проекта:
1) Запускаем Eclipse
2) Нажимаем на кнопку File (в левой верхней части экрана) -> New -> Java project

Спойлер

3) В появившемся окне указываем имя проекта (в этом случае "RuBukkit") и ставим такие настройки:

Спойлер

4) Нажимаем Finish
ПРОЕКТ СОЗДАН!

Создание пакетов:
[INFO] Чтобы красиво оформить наш проект и разложить все по полочкам, мы создадим несколько пакетов(папок) внутри папки src. В нашем случае: ya.top.koder.plugin (Точками мы разделяем папки).
1) Нажимаем ПКМ по папке src
2) Нажимаем New -> Package

Спойлер

3) Создаем сами пакеты:

Спойлер

4) Нажимаем Finish
ПАКЕТЫ СОЗДАНЫ!

Так у нас получится 4 папки внутри папки src (папка ya, в ней папка top, в ней папка koder а в ней папка plugin, в которой уже будет находится наш главный класс).

Создание классов:
[INFO] Создадим главный класс (в нашем случае под названием Main) (оригинальность зашкаливает).
1) Нажимаем ПКМ по пакету plugin -> New -> Class

Спойлер

2) Указываем название и нажимаем Finish

Спойлер

КЛАСС СОЗДАН!

Стоп мотать! Теперь мы должны интегрировать библиотеки Spigot. Для этого нажимаем ПКМ по проекту и нажимаем Properties -> Java build pass, заходим во вкладку Libraries и нажимаем на кнопку Add external JARs и указываем место хранения ядра Spigot (Их можно скачать тут).

Спойлер

Стоп мотать! Теперь начинаем работать непосредственно внутри класса:

Созданный нами класс Main пока-что выглядит вот так:

Спойлер

Теперь мы должны сказать классу что он главный и что он наследует библиотеки Spigot'a (Он же сам не додумается, он же глупенький)

Чтобы класс унаследовал все методы библиотек Spigot, в строку public class Main должны дописать extends JavaPlugin. Это должно выглядить вот так:

Спойлер

Мы написали это, но нам высветилась ошибка,так как мы должны импортировать весь этот JavaPlugin.Для этого нажимаем на лампочку слева от этой строки и нажимаем это:

Спойлер

Теперь мы можем работать со всеми методами Spigot API.

Два самых важных метода - onEnable() и onDisable()(Не такой уж и важный), сейчас мы начнем с ними работать, а особенно с onEnable(), так как он весь код, написанный в нем, заставляет работать сразу после запуска сервера.
Вот так мы создаем эти два метода: public void onEnable() / public void onDisable()

void - тип возвращаемых данных. Поскольку этот метод ни чего не возвращает через return, то мы должны сообщить об этом системе. (Тип доступа может быть любым форматом возвращаемых данных, к примеру: int, boolean и даже String)

ЧТО МЫ МОЖЕМ ДЕЛАТЬ В МЕТОДЕ onEnable()?
- Много чего.Как минимум, мы можем начать работать с getLogger() (Также доступен в методе onDisable() ).
Для того чтобы узнать список того, что мы можем сделать в getLogger(), ставим после него точку. Вот так:

Спойлер

Но я хочу выделить среди них всех три функции (Всего тут не обьяснишь.Понимание всего приходит со временем):
1) getLogger().info("Text"); - (Информация) - выводит текст в кавычках в консоль.
2) getLogger().warning("Text"); (Предупреждение) - выводит текст в кавычках в консоль.
3) getLogger().severe("Text"); (Ошибка) - выводит текст в кавычках в консоль.

Также в методе onEnable() мы можем работать с getServer(). Чтобы узнать список всех его функций, как обычно, ставим после него точку.С помощью getServer() мы можем выполнить команду вместо игрока, зарегистрировать ивент, установить екзекутор для команды (указать отдельный класс, который будет обрабатывать указанную команду).

Первая часть туториала подходит к концу.В следующей части мы будем работать с ивентами (событиями\слушателями событий (Listener))

Работа с ивентами: (список Bukkit-ивентов тут и тут)

Регистрация ивента:

Для регистрации ивента мы будем использовать getServer(). Для регистрации ивента (например, событие при заходе игрока) мы должны написать это:
getServer().getPluginManager().registerEvents(this,this);
если хотим создать обработчик данного события в главном классе, а если мы хотим выделить для обработки этого ивента отдельный класс, то надо прописать это:
getServer().getPluginManager().registerEvents(newіНазваниеКлассаОтвечающегоЗаОбработкуДанногоИвента(),this);

Спойлер

После этого выведется ошибка о том, что класс не найден и скажет создать этот класс, на что мы и соглашаемся.
Отправляемся в этот класс.

Вписываем метод обработки этого ивента:

Спойлер

Импортируем все.

Что такое @EventHandler? (Это не пользователь, не чистит ссылку)

@EventHandler:

Спойлер: @EventHandler:

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

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

Окей, теперь, чтобы посмотреть все, что можно получить с этого ивента, пишем e и ставим точку.

Ну, давайте удалим сообщение о входе, сделав что-то похожее на плагин HideStream.
Для этого мы напишем e.setJoinMessage(); и установим туда null (ничего).

Код:

@EventHandler
public void on(PlayerJoinEvent e)
{
     e.setJoinMessage(null);
}

С ивентами все. В следующей части поговорим о командах.

Создание команд:

Ну вот и третья часть! Сегодня мы научимся создавать собственные команды.И это не так уж и сложно.Но сначала надо определиться, где мы будем обрабатывать команды.Как помните, во второй части туториала про ивенты, мы создавали отдельный класс-обработчик ивентов, а сегодня мы научимся создавать класс-обработчик команд.Но можно создать обработчик и в главном классе.Сегодня мы обсудим 2 способа.

Первый способ (В главном классе):

Для начала, мы должны добавить метод обработки команды. Этот метод называется onCommand.Также в нем должны находится такие аргументы (CommandSender, Command, String label и String [] args) (Не забываем все импортировать! Только Command импортируйте не как org.bukkit.Material а как org.bukkit.Command). Это должно выглядить примерно вот-так:

Спойлер

Если вы заметили, над самим методом висит какой-то @Override.Что это?

Спойлер: Override

Аннотация @Override информирует компилятор о том, что метод перегружает метод в суперклассе.

На практике возможны случаи, когда вызываемый метод наследуемого класса не может найти метод родительского класса либо из-за неправильного расставления модификаторов доступа, либо из-за неправильного расположения классов в пакетах.
Если не использовать аннотацию @Override, то "неправильная" программа скомпилируеются без ошибок, а сам проблемный участок кода станет нереально сложно найти. Использование аннотации @Override заставляет компилятор сразу проверять перегружает ли метод аналогичный в суперклассе.

Другими словами, аннотация @Override указывает, что далее мы собираемся переопределять метод базового класса.

Давайте сделаем команду, при вводе которой игроку выведется сообщение о его: имени, здоровьи, сытости. Назовем ее /maininfo.Вот что получается:

Спойлер

Сначала мы достаем класс игрока и и ставим ему имя p, кастуем его как Player и устанавливаем его sender'ом (отправителем команды).

Дальше мы делаем проверку, действительно ли отправитель команды - игрок? Если да, то даем возможность работать коду ниже.Ниже мы уже проверяем какую команду написал игрок, тоесть спрашиваем: Если(команда.ПолучитьНазваниеКоманды().выглядитТакСИгнорированиемРегистра("maininfo")). Если да, то получаем его имя, здоровье и сыстость.Потом отправляем сообщение игроку.
В конце мы ставим return true; (Вернуть? Да).

Это мы создали команду в главном классе.Теперь сделаем эту команду в отдельном классе.
2 способ (В отдельном классе)

Для начала мы отправляемся в метод onEnable().
Устанавливаем класс-обработчик с помощью getServer().
Это должно выглядить вот так:

Код:

getServer().getPluginCommand("названиеКоманды").setExecutor(new НазваниеКлассаОбрабатывающегоКоманду());

Спойлер

Далее нам выводиться ошибка, так как класс не найден.Нажимаем на лампочку и создаем его.В
появившемся окне указываем, что данный класс наследует CommandExecutor:

Спойлер

Нажимаем Finish.Как видим,программа уже создала метод за нас.Нам только надо внутри него написать то же, что и писали в главном классе.
Получается вот-так:

Спойлер

На этом и третья часть подходит к концу. В следующей части мы научимся создавать собвстенные GUI.

 

молодец!

 

Спасибо!

 

Поздравляю, ты "создал" еще N-ное количество "дивилаперов" которые будут писать свои недоплагины на дюп/секс/наркотики/и_прочую_зуйню.

 

*лайк*

 

Всегда найдут за что зацепиться...Из той информации, что сейчас здесь, эти "супир" плугины не сделаешь.И неужели все будут писать именно этот бред? Может, кому-то эти уроки действительно помогут на начальных этапах, и в будущем этот парень будет отличным кодером.

 

Эти уроки ни кому не нужны, потому что их уже целый вагон и маленькая тележка.
Твой урок бестолковый. Для такого он и правда сойдёт:

Много мусора для чайников. Хотя бы основы Java нужно выучить, прежде чем сажаться за написание плагинов. Про @EventHandler ничего так и не рассказал.
Давно есть туторы от профи, которые рассказывают все тонкости, чтобы люди могли сразу писать качественные плагины.

 

Ну, я посмотрю, будут просить продолжения, продолжу...Ну а если серьезно, супер программистом на Рубаките не станешь, но, можешь попрактиковаться на ранних этапах.А уже если хочешь быть профи, то изучай Java глубже и на специальных сайтах на подобие JavaRush и тп.

 

От кого, например?

 

JavaRush чтобы стать профи? Надеюсь это шутка.

К сожалению, не успел ознакомиться полностью с туториалом, но первое что бросилось в глаза это везде ошибка в слове "разработчик" (или имеются ввиду особенные вОлОгОдские рОзрОбОтчики?)

 

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

 

+1

Гавно.

Либо ты пишешь туториал, либо излагаешь свои эмоции. Вместе — никак.

Почему бы сразу не начать делать проект maven/gradle? Всё равно придётся на них перейти. А сразу начинать проще.

 

Я не русский, могут быть офографические ошибки[DOUBLEPOST=1490691819,1490691639][/DOUBLEPOST]

Спасибо))[DOUBLEPOST=1490692428][/DOUBLEPOST]

Ну, я по своему опыту сказал.Я не мог понять IntelliJ IDEA, а NetBeans мне просто не понравился по интерфейсу.Eclipse мне отлично подошел. Выбирать каждому свое, я для этого и оставил 3 ссылки.Мог бы оставить только Eclipse.

 

Не думаю, что для простого проекта нужены грабли или мавен. Когда у тебя из либ одно ведро. А вот когда нужно пол гитхаба выкачивать, другое дело.

 

Возможно, но у меня обычно и ядра-то под рукой нет =) Только его API где-то в глубинах ~/.m2/

Да и редко уже без большего числа либ получается обойтись, постоянно всякие Gson-ы и свои наработки тянутся.

Новичку может и да, проще так, но сложности в сразу понять maven не вижу =)

 

По-хорошему было бы неплохо написать плагин на gradle для bukkit плагинов. Как это сделано в Sponge

 

Крутотень!

Но есть пара замечаний.
1.Лучше не кидать скрины из Eclipse, а копировать все сразу на форум. Тогда и разобраться будет проще, просто напиши комментарии(слешами) к необходимым для пояснениям строкам, и в случае чего можно скопировать твой замечательный код к себе, чтобы попробовать, так сказать, на практике
2. Oшибка:

С нетерпением жду следующей части!

P.S.
При выводе в консоль русские символы мутируют в непонятные кракозябры. Это точно ошибка консоли, так как в логах все нормально. Как пофиксить, знаешь?

Спойлер: Картинки

Консолька:


Логи:

 

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

 

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

 

Нет, у меня самого такая проблема, но я не считаю это проблемой (пока-что), по этому не искал способов решения этой пробелмы.Хотя соглашусь, в логи постоянно смотреть неудобно.