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

Статус
Закрыто для дальнейших ответов.

_MasterCapeXD_

Активный участник
Пользователь
Баллы
76
Ник в Minecraft
_MasterCapeXD_
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.
bandicam 2018-02-04 14-56-42-829.jpg
3) В появившемся окне указываем имя проекта (в этом случае "RuBukkitGuide") и ставим такие настройки:
bandicam 2018-02-04 14-57-00-100.jpg
4) Нажимаем Finish.
Проект создан!

Создание пакетов:
1) В созданном обьекте нажимаем ПКМ по папке src.
2) Нажимаем New -> Package.
bandicam 2018-02-04 14-57-39-652.jpg
3) Создаем сами пакеты:
bandicam 2018-02-04 14-57-50-349.jpg
4) Нажимаем Finish.
Пакеты созданы.
Мы создали в папке src папку org, в ней папку rb и в ней папку guide.
Для чего нужны пакеты? Представьте, что у Вас есть один большой ящик (Ваша программа) и в нем 4 маленьких ящика. В первом - яблоки, во втором - персики, в третьем - гранаты, в четвертом - ананасы. Для чего нам нужны эти коробки? Правильно, чтобы все фрукты не находились в одной коробке.
Но в Java пакеты не только используются для сортировки. Они берут участие в инкапсуляции. Помните Обычный модификатор доступа? Вот вся информация с модификатором Обычный будет доступна всем обьектам в этом пакете. Тоесть, у яблок своя тусовка, и никакие персики и другие фрукты туда не полезут.

Создание класса:
Создадим теперь наш главный класс, который запустит весь наш плагин, назовем его Main.
1) Нажимаем ПКМ по пакету guide -> New -> Class.
[Screen]bandicam 2018-02-04 14-58-12-337.jpg
2) Указываем название и нажимаем Finish.
bandicam 2018-02-04 14-58-30-056.jpg
Класс создан!

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

Начинаем кодить!
Созданный нами класс Main пока-что выглядит вот так:
bandicam 2018-02-04 15-00-33-878.jpg

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

bandicam 2018-02-04 15-01-36-742.jpg

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

bandicam 2018-02-04 15-04-20-383.jpg

Что такое 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 -> JAR file -> 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 часть подошла к концу. В следующем мы продолжим добавлять функционала в плагин.
 
Последнее редактирование:
В любой книге о java - коллекции. Там максимум 80 страниц.
Если люди не могут осилить статью хабра на ~10к символов, то о каких 80 стр может идти речь? Для таких людей это как войну и мир прочитать
 
JavaScript:
    @Override
    public boolean onCommand(CommandSender sender, Command cmd, String label, String[] args) {
            Player p = (Player) sender;
            if(sender instanceof Player)
            {
                if(cmd.getName().equalsIgnoreCase("lab"))
                {
                   
                    Location loc = p.getLocation();
                    loc.setZ(-20);
                    loc.setX(472);
                    p.setCompassTarget(loc);
                   
                }
     }
     return true;
    }

}
При вводе пишет тип команды нету
 
JavaScript:
    @Override
    public boolean onCommand(CommandSender sender, Command cmd, String label, String[] args) {
            Player p = (Player) sender;
            if(sender instanceof Player)
            {
                if(cmd.getName().equalsIgnoreCase("lab"))
                {
                  
                    Location loc = p.getLocation();
                    loc.setZ(-20);
                    loc.setX(472);
                    p.setCompassTarget(loc);
                  
                }
     }
     return true;
    }

}
При вводе пишет тип команды нету
В plugin.yml команду добавил?
 
В plugin.yml команду добавил?
Делал всё по этому гайду http://rubukkit.org/threads/tutoria...pigot-craftbukkit-bukkit.133861/#post-1438006 ,а в нём об этом даже не писалось . Спасибо что помогли
В plugin.yml команду добавил?
Вот так ?
JavaScript:
commands:
lab:
 
@_MasterCapeXD_, отлично сделал. Только вот помести все скриншоты под спойлеры.
 
в строку public class Main должны дописать extends JavaPlugin.
Я объяснить зачем начинающим "Дивилоперам" не хочешь ?
Учить интерфейсам надо изучая java и писать плагины уже с каким то базовым набором знаний.
 
Придёт же начинающий "Дивилопер" который не знает основ и будет задавать эти вопросы... И да такие люди всегда будут появляться на рб... Хотя бы сократить бы их количество.
Это форум Bukkit, и глубоко затрагивать именно классы/методы Java здесь нет смысла, для этого есть другие сайты. А тут больше по созданию плагинов на платформе Bukkit/Spigot
@_MasterCapeXD_, отлично сделал. Только вот помести все скриншоты под спойлеры.
Спасибо)
 
Имхо годная инструкция.

Другое дело, что всё портят некоторые "профи", которые, судя по всему, пришли тупо за едой (ибо у меня начал жиром протекать монитор), оставляя вроде как "канстрюгдивнуу гредеку", а годным контентом для многохромосомчатых (на подобии меня) в её резонность её саму не снабдили. Не надо так, кхем.
 
Давно не было продолжения данного туториала, ну и ладно, уже есть)
Сегодня мы научимся создавать собственные GUI!


Мы сделаем так, чтобы гуишка открывалась при вводе команды, так мы и вспомним прошлую часть.
Наш GUI будет менюшкой с двумя иконками - Да и Нет, при нажатии на Да игрок получит ссылку на этот туториал, а при нажатии нет, в чат выведет сообщение:
Вы отказались от получения ссылки.


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

Для начала создадим класс GUIBuilder, и в нем метод addIcon(), чтобы этот метод создавал предметы, которые мы будем устанавливать в GUI. Создавать класс мы уже умеем, так что приступим сразу к коду:
Java:
package ya.top.koder.plugin;

import java.util.List;

import org.bukkit.Material;
import org.*********ventory.ItemStack;
import org.*********ventory.meta.ItemMeta;

public class GUIBuilder
{
   
    public static ItemStack addIcon(Material material, String displayname, List<String> lore)
    {
        ItemStack item = new ItemStack(material);
        ItemMeta meta = item.getItemMeta();
        meta.setDisplayName(displayname);
        meta.setLore(lore);
       
        item.setItemMeta(meta);
       
        return item;
       
    }

}

Мы создали метод addIcon, который использует три аргумента, Предмет material, Строку имени, и список строк - lore (описание предмета). Наш метод возвращает тип ItemStack. В самом теле метода мы создаем экземпляр класса ItemStack, с предметом material (укажем мы предмет уже когда начнем устанавливать предметы в инвентарь), потом мы достаем ItemMeta из нашего предмета item. Когда мы получили мету предмета, мы изменяем ее, устанавливая кастомное имя и описание предмета. После всех этих махинаций мы уже измененную мету вставляем в предмет, после чего возвращаем сам предмет, который уже был обработан методом.

Теперь создадим наш GUI, для начала мы должны создать команду.
В классе Main мы регистрируем команду, устанавливаем обработчик команд и создаем сам класс:
Класс Main:
Java:
package ya.top.koder.plugin;

import org.bukkit.command.Command;
import org.bukkit.command.CommandSender;
import org.bukkit.entity.Player;
import org.bukkit.plugin.java.JavaPlugin;

public class Main extends JavaPlugin
{
   
    public void onEnable()
    {
       
        getLogger().info("Norm");
        getLogger().warning("Not Norm");
        getLogger().severe("Bad");
       
        getServer().getPluginManager().registerEvents(new Join(), this);
        getServer().getPluginCommand("maininfo").setExecutor(new myCommand());
        getServer().getPluginCommand("geturl").setExecutor(new GURLCmd());           
       
    }

Класс GURLCmd:
Java:
package ya.top.koder.plugin;

import java.util.List;

import org.bukkit.Bukkit;
import org.bukkit.Material;
import org.bukkit.command.Command;
import org.bukkit.command.CommandExecutor;
import org.bukkit.command.CommandSender;
import org.bukkit.entity.Player;
import org.*********ventory.Inventory;

public class GURLCmd implements CommandExecutor {
   

    //Создаем список строк для установки описания
   
    //Для иконки Да
    private List<String> lore1;
    //Для иконки Нет
    private List<String> lore2;

    @Override
    public boolean onCommand(CommandSender sender, Command cmd, String label, String[] args)
    {
        if(sender instanceof Player)
        {
            Player player = (Player) sender;
           
            if(cmd.getName().equalsIgnoreCase("geturl"))
            {
                Inventory inv = Bukkit.createInventory(null, 9, "§eПолучить ссылку?");
               
                lore1.add("§eПодтвердить получение ссылки");
                lore2.add("§eОтказаться от получения ссылки");
               
                //Устанавливаем предметы в инвентарь (первый слот начинается от нуля)
                inv.setItem(2, GUIBuilder.addIcon(Material.EMERALD_BLOCK, "§aДа", lore1));
                inv.setItem(6, GUIBuilder.addIcon(Material.REDSTONE_BLOCK, "§cНет", lore2));
               
                //Открываем инвентарь
                player.openInventory(inv);
            }
        }
       
        return true;
    }

}

Тут все понятно по комментариям. Надеюсь)
Ну, разве что, как вы видите, мы обратились к классу GUIBuilder и достали из него метод addIcon, и туда установили свои значения.

Теперь мы должны запретить игроку перетаскивать предметы из инвентаря, для этого мы регистрируем ивент)

Класс Main:
Java:
package ya.top.koder.plugin;

import org.bukkit.command.Command;
import org.bukkit.command.CommandSender;
import org.bukkit.entity.Player;
import org.bukkit.plugin.java.JavaPlugin;

public class Main extends JavaPlugin
{
   
    public void onEnable()
    {
       
        getLogger().info("Norm");
        getLogger().warning("Not Norm");
        getLogger().severe("Bad");
       
        getServer().getPluginManager().registerEvents(new Join(), this);
        getServer().getPluginManager().registerEvents(new Click(), this);
        getServer().getPluginCommand("maininfo").setExecutor(new myCommand());
        getServer().getPluginCommand("geturl").setExecutor(new GURLCmd());           
       
    }

Класс Click:
JavaScript:
package ya.top.koder.plugin;

import org.bukkit.Material;
import org.bukkit.entity.Player;
import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import org.bukkit.event.inventory.InventoryClickEvent;

public class Click implements Listener
{
   
    @EventHandler
    public void on(InventoryClickEvent e)
    {
       
        //Проверяем инвентарь
        if(e.getInventory().getTitle().equals("§eПолучить ссылку?"))
        {
            //Если он, то отменяем ивент
            e.setCancelled(true);
           
            //Если игрок кликнул по иконке Да, то:
            if((e.getCurrentItem().getType() == Material.EMERALD_BLOCK) && (e.getCurrentItem().getItemMeta().getDisplayName().equals("§aДа")))
            {
                //Проверяем, есть ли это игрок
                if(e.getWhoClicked() instanceof Player)
                {
                    //Если да, устанавливаем игрока как того, кто кликнул и отправляем сообщение
                    Player p = (Player) e.getWhoClicked();
                    p.sendMessage("§6http://rubukkit.org/threads/tutorial-sozdanie-plaginov-spigot-craftbukkit-bukkit.133861/page-3");
                }
            //Или если игрок кликнул по иконке Нет, то:
            } else if((e.getCurrentItem().getType() == Material.REDSTONE_BLOCK) && (e.getCurrentItem().getItemMeta().getDisplayName().equals("§cНет")))
            {
                //Проверяем, есть ли это игрок
                if(e.getWhoClicked() instanceof Player)
                {
                    //Если да, устанавливаем игрока как того, кто кликнул и отправляем сообщение
                    Player p = (Player) e.getWhoClicked();
                    p.sendMessage("§cВы отказались от получения ссылки.");
                }
            }
        }
    }

}

После всего этого не забываем вписать команду в plugin.yml:
Код:
name: RuBukkit
description: Tutorial
author: MasterCapeXD
version: 1.0
main: ya.top.koder.plugin.Main
commands:
  maininfo:
    description: Main info of player
  geturl:
    description: get url of this thread

На этом вроде все. 4 часть туториала подошла к концу.
 
Мда
Вообще в этом смысла я не вижу, и соглашусь с @Mr_RoboMan, не умеешь пользоватся документацией и не знаешь английский хоть чуть - чуть -- лучше даже и не начинать
А если по коду, то так не проще?
Material type = e.getCurremtItem().getType();
p.sendMessage(type == блаблабла1 ? "1" : "2");
Думаю суть этого "сложного" кода понятна.
Дальше.
Создать инвентарь один раз, и итем стак тоже один раз, и использовать private static видимо уже не в моде.
Так же не нужна проверка на имя команды, если команда одна или же, если команды в отдельных классах
 
Последнее редактирование:
Создать инвентарь один раз, и итем стак тоже один раз, и использовать private static видимо уже не в моде.
Насчет этого - не понял, что ты имеешь в виду? Чем тебе не нравится метод addIcon()?
А инвентарь и так только в команде создается, больше нигде не используется
 
Почему обязательно шутка? Хороший сайт, доступно объясняют. Ещё и практики кучу.
Я не пишу, что ничему там нельзя научиться, но профессионалом там не стать. Чтобы стать профессионалом надо не одну книжку прочитать и опыта набираться несколько лет. (КЭП)
 
Почему обязательно шутка? Хороший сайт, доступно объясняют. Ещё и практики кучу.
После самообучения (!) я смотрю на JavaRush, как на отходы жизнедеятельности. Не знаю, кого они могут чему научить...
 
Статус
Закрыто для дальнейших ответов.
Назад
Верх Низ