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

Hidens

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

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

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

[+] <- Помощь в изучении Java;
[+] <- Сборка ссылок на обучающие материалы
[+] <- Документация Spigot API;

Софт для начала работы:
Среда разработки:
  1. IntelliJ IDEA [+]
  2. Eclipse [+]
  3. NetBeans [+]
Для нормального запуска этих программ у Вас должен быть установлен JDK (Java Development Kit) и JRE (Java Runtime Environment)!

Редактирование файлов (.yml, .json, etc...):
1) Notepad++ [+]

Проект, созданный для данного туториала, был разработан в СР Eclipse.

Основы:
Java - обьектно-ориентированный язык программирования (вся программа - связь разных обьектов. Это как организм, в котором каждый орган отвечает за свою функцию для нормального функционирования всего организма. Органы могут сотрудничать, обмениваться информацией и тп).
Его приемущества:
1) Инкапсуляция:
Теория: позволяет устанавливать доступ к обьекту и информации в нем с помощью модификаторов доступа.
Пример: у Вас есть 3 сейфа с информацией. Первый - приватный (пароль знаете только Вы), второй - обычный (пароль знают Ваши родственники и соседи), третий - публичный (пароля нет).

2) Наследование:
Теория: позволяет наследовать свойства, методы и поля родительского обьекта.
Пример: У Вас есть обьект Car (автомобиль), и обьект BMW, который наследует обьект Car.

3) Полиморфизм (углубленно о наследовании):
Теория: позволяет обьекту использовать методы производного класса, который не существует на момент создания базового.
Пример: Что может хранить класс Car? Например, название марки автомобиля, кол-во сидений и тп. Допустим, кол-во сидений = 4. А что, если мы делаем 2-местный автомобиль? Мы наследуем класс Car и имеем возможность изменить для себя кол-во сидений для нашего авто.

Основные типы данных:
1) Текстовый тип:
char - символ (16-разрядное беззнаковое целое, представляющее собой символ UTF-16 (буквы и цифры)).
String - строка (может хранить в себе любые символы, главное, чтобы кодировка подошла).
2) Целочисленный тип:
byte - 8-разрядное целое число.
short - 16-разрядное целое число.
int - 32-разрядное целое число.
long - 64-разрядное целое число.
3) Дробный тип:
float - 32-разрядное число в формате IEEE 754 с плавающей точкой.
double - 64-разрядное число в формате IEEE 754 с плавающей точкой.
4) Логический тип:
boolean - хранит значение true или false.

Переменные - ячейки памяти, которые хранят в себе определенный обьект (тип данных).

Модификаторы доступа в Java:
private - приватный (как мы помним, пароль знаем только мы).
(модификатор не указывается) - обычный (как мы помним, пароль знают только наши родственники и соседи).
protected - защищенный (пароль знают только наши дети и мы сами).
public - публичный (пароля нет).

НАЧАЛО РАБОТЫ:
Создание проекта в среде разработки
Eclipse:
  1. Запускаем Eclipse.
  2. Нажимаем на кнопку File (в левой верхней части экрана) -> New -> Java project.
85

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

4) Нажимаем Finish.
Проект создан!

Создание пакетов:
  1. В созданном обьекте нажимаем ПКМ по папке src.
  2. Нажимаем New -> Package.
87

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

4) Нажимаем Finish.
Пакеты созданы.
Мы создали в папке src папку org, в ней папку rb и в ней папку guide.
Для чего нужны пакеты? Представьте, что у Вас есть один большой ящик (Ваша программа) и в нем 4 маленьких ящика. В первом - яблоки, во втором - персики, в третьем - гранаты, в четвертом - ананасы. Для чего нам нужны эти коробки? Правильно, чтобы все фрукты не находились в одной коробке.
Но в Java пакеты не только используются для сортировки. Они берут участие в инкапсуляции. Помните Обычныймодификатор доступа? Вот вся информация с модификатором Обычный будет доступна всем обьектам в этом пакете. Тоесть, у яблок своя тусовка, и никакие персики и другие фрукты туда не полезут.

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

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

Класс создан!

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

91

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

Для того, чтобы наш проект считался плагином, нам нужно унаследовать класс JavaPlugin (этот класс находится в самом ядре Spigot).
Для того, чтобы унаследовать этот класс, нам нужно в строку public class Main дописать extends JavaPlugin.
Хорошо. Или нехорошо? Что за красная лампочка??? Eclipse нам говорит, что мы не импортировали класс JavaPlugin. Нажимаем на лампочку и импортируем.

93

Теперь мы имеем доступ к protected и public полям и методам. Чтобы Java знала наверняка, что мы используем метод из родительского класса (JavaPlugin), мы скажем это, используя аннотацию @Override. Какой метод мы возьмем из родительского класса? onEnable(), так как он запускает весь наш проект. Само ядро будет знать, что это плагин, и начнет получать всю нужную информацию. Если мы уберем extends JavaPlugin и метод onEnable(), то когда добавим плагин в папку plugins, он вообще не загрузится, и его вообще не будет в списке плагинов.
94

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

Как узнать все методы, к которым мы имеем доступ? Пишем this и ставим точку. Нам программа вывела все доступные методы и поля из класса JavaPlugin.

Что будем делать? Ну давайте выведем при запуске плагина, что он включился.
Для этого заходим в метод onEnable(){ } и между { и } пишем нашу команду. Она выглядит так: this.getLogger().info("ПЛУГИН РАБОТАИТ!");
Что мы сделали, введя эту команду? Мы получили класс Logger, в которого есть метод info(...), который и запустили.

Плагин написан. Теперь мы должны создать файл plugin.yml. Нажимаем ПКМ по проекту. В окне нажимаем New -> File и вводим plugin.yml.
В нем мы должны ввести такие значения:
Код:
name: RBGuide # Имя плагина
main: org.rb.guide.Main # Путь к главному классу (тому, который наследует JavaPlugin)
author: MasterCapeXD # Автор плагина
version: 0.1 # Версия плагина
description: super plugin # Описание плагина
Теперь мы можем скомпилировать плагин. Нажимаем ПКМ по проекту, в окне нажимаем Export... -> Java -> JARfile -> Next и вводим путь к папке, где хотим сохранить файл.

Доп. информация:
Кроме метода onEnable() в JavaPlugin есть еще 2 метода - onLoad() и onDisable().

Весь класс Main:
PHP:
package org.rb.guide;

import org.bukkit.plugin.java.JavaPlugin;

public class Main extends JavaPlugin
{
    @Override
    public void onEnable()
    {
        this.getLogger().info("ПЛУГИН РАБОТАИТ!");
    }
}
Сам проект тут.

1 часть подошла к концу. В следующем мы продолжим добавлять функционала в плагин.
 
Сверху