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

Logo

Введение

Добро пожаловать! Это официальная документация к RPGInventory.

RPGInventory — это плагин для Minecraft серверов на базе Bukkit.

Содержание

Использование

В данном разделе содержится вся информация, необходимая для того, чтобы начать использование плагина.

Использование плагина

В этом разделе содержатся статьи, в которых описывается установка и примеры использования плагина. Если хотите больше узнать о возможностях плагина, это то, что Вы ищете.

Содержание
Установка плагина

TODO

Интеграции

TODO

Настройка

Раздел, посвящённый тонкой настройке плагина. Здесь Вы найдёте все, что касается настройки питомцев, предметов, инвентаря и прочего.

Настройка плагина

В этом разделе описано всё, что касается настройки предметов.

Содержание
Инвентарь

Раздел, посвящённый настройке инвентаря. Тут Вы найдёте инструкции по настойке слотов, расширений крафта и других функций, относящихся к инвентарю.

Слоты инвентаря

В этом разделе описано всё, что касается настройки слотов инвентаря.

Содержание
Расположение слотов

TODO

Предметы

Раздел, в котором описано, как создавать новые предметы и как их кастомизировать.

Предметы

В этом разделе описано всё, что касается настройки предметов.

Содержание
Рюкзаки

TODO

Питомцы

Раздел о питомцах. Здесь Вы найдёте инструкции по созданию и настройке питомцев, а также еды для них.

Питомцы

В этом разделе описано всё, что касается настройки питомцев.

Содержание
Создание питомца

TODO

Еда питомцев

TODO

Участие в разработке

Если хотите помочь в разработке RPGInventory, просмотрите данный раздел. Сделаем RPGInventory лучше!

Участие в разработке

TODO

О плагине

Основная информация о плагине. Рекомендуется к прочтению.

О проекте

В этом разделе описываются цели и задачи RPGInventory, а также даются ответы на часто задаваемые вопросы. Настоятельно рекомендуется прочесть этот раздел для ознакомления с плагином.

Содержание
Введение
Что такое RPGInventory?

Изначальная цель RPGInventory - кастомизировать инвентарь без использования модов. Но со временем он перерос в нечто большее.

RPGInventory стал гибким инструментом, который позволит Вам изменить инвентарь на свой вкус. Делаете сервер со средневековыми битвами и штурмами замков? Вам неверняка понадобятся слоты для перчаток или кольчуги. Создаёте атмосферу постапокалипсиса с кучей зомби? Конечно же понадобится слот для бронежилета и патронов.

Вы сможете добавить слоты для новых видов брони, амулетов, колец, добавить предметы, которые смогут использовать только определенные классы и уровни. Сможете добавить питомцев и ездовых животных, которые будут обладать различными свойствами. Плагин может работать совместно с другими RPG плагинами.

Где скачать RPGInventory?

RPG Inventroy является Open Source проектом и Вы можете собрать его сами из исходников. Но если Вы хотите получить не только плагин, но и поддержку от автора и своевременные обновления, а также поддержать самого автора, то можете приобрести его на SpigotMC.

Как это работает

Всем известно, что с помощью плагинов нельзя создавать новые графические интерфейсы или изменять существующие (если у Вас, конечно, не Spout) и для этого нужны моды. Но зачастую возникают ситуации, когда нет возможности использовать моды.

Но что тогда делать, если хочется изменить инвентарь? Например, добавить слот для перчаток или колец.

И так как возможности добавить собственный GUI нет, возникло две главные задачи:

  1. Найти существующий GUI, который можно изменить;
  2. Добавить свои текстуры в клиент.

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

Осталось решить вторую задачу. И тут на помощь нам пришли разработчики Minecraft. В версии 1.9 добавили возможность изменения текстур предметов по их прочности, что дало возможность добавления в игру при помощи серверного ресурс-пака более чем 5000 новых текстур. Получается, что мы берём и закладываем неиспользуемые слоты серой текстурой, а на место используемых слотов ставим текстуру пиктограммы слота, чтобы было понятно, что в этот слот кладётся.

Как было до MC 1.9

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

Примечание

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

Как тогда использовали плагин, если невозможно было использовать с ним сундуки? Было лишь два варианта:

  1. Использовать плагин без пользовательских текстур, закрывая слоты существующими текстурами;
  2. Или использовать плагин с текстурами, но интерфейсы всех сундуков переделывать в интерфейс раздатчиков, у которых менять текстуру (в этом случае портились раздатчики, но это лучше, чем сундуки).

Как Вы понимаете, с выходом 1.9 многое в плагине было переделано и это одна из причин, по которой поддержка версий 1.7.10-1.8.х прекращена.

Возможности
Инвентарь
Изменение слотов

С помощью плагина Вы можете добавлять, удалять и изменять слоты инвентаря и их расположение. Вы можете сделать сколько угодно слотов и расположить их как угодно в соответствии с Расположение слотов.

Кроме того, свойства слотов полностью настраиваемы. Вы можете сделать слоты-кнопки, слоты для определённых предметов или слоты, которые нужно покупать за внутриигровую валюту.

Подробнее: Слоты инвентаря

Система блокировки стандартных слотов

Помимо изменения свойств слотов созданных Вами, Вы можете блокировать стандартные слоты с последующей разблокировкой их за внутриигровую валюту или при достижении определённого уровня.

Подробнее: Блокировка стандартных слотов

Изменение сетки крафта

Вы можете изменить размер сетки крафта, которая открывается из инвентаря. Кроме того, сетка крафта может изменяться в зависимости от того является ли игрок мастером или подмастерье.

Подробнее: Сетка крафта

Слот для элитр

Плагин добавляет слот для элитр. Это позволяет одновременно носить броню и элитры.

Предметы
Создание новых предметов

При помощи RPGInventory Вы можете добавить новые предметы, которые будут обладать нужными свойствами и иметь заданную текстуру. Предметы могут давать игроку дополнительные разрешения пока надеты, могут выполнять команды при нажатии на правую или левую кнопку мыши, давать дополнительные статы и т.д.

Подробнее: Предметы

Рюкзаки

Плагин добавляет в игру рюкзаки. Содержимое такого рюкзака привязано к нему и при потере или передаче рюкзака передастся вместе с ним.

Вы можете создавать рюкзаки разных размеров и с разными текстурами - всё это настраивается.

Подробнее: Рюкзаки

Питомцы
Создание питомцев

Вы можете создавать питомцев. Это могут быть компаньоны или ездовые животные. Они могут принимать различный облик и иметь разные характеристики.

Подробнее: Питомцы

Еда для питомцев

Питомцы могут восстанавливать здоровье, употребляя еду, которую Вы тоже можете создать.

Подробнее: Еда питомцев

Прочее
Совместимость с другими RPG плагинами

RPGInventory совместим с наиболее популярными RPG плагинами (SKILLAPI, BATTLELEVELS, SKILLS, HEROES, RAC, RPGPL...).

Подробнее: Интеграции

Загрузка пакета ресурсов

Есть возможность принудительной загрузки ресурс-пака.

Никаких команд

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

Улучшенная система боя

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

Подробнее: Система боя

Часто задаваемые вопросы
Что такое RPGInventory?

RPGInventory - это плагин для серверов Minecraft на основе Bukkit. Он добавляет возможность изменять GUI инвентаря. Подробнее о плагине можно прочитать на этой странице.

Что можно сделать при помощи RPGInventroy помимо изменения инвентаря?

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

Требуются ли модификации клиента для работы RPGInventory?

Нет. RPGInventory — это серверный плагин и требует установки только на сервер.

Как плагин изменяет GUI?

Устанавливается серверный ресурс-пак и при помощи добавленных текстур формируется GUI. Более подробно о том как это делается, можно прочитать на странице Как это работает.

Плагин не испортит GUI сундука?

Нет. Начиная с версии 1.9 в Minecraft добавлена функция, которая позволяет добавлять в игру огромное количество текстур без замены используемых.

Можно использовать плагин без ресурс-пака?

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

Лицензия

RPGInventory является свободным проектом и распространяется по лицензии GNU GPL 3.0+. Это копилефтная лицензия, что означает, что при изменении, копировании или распространении RPGInventory, Вы обязаны сохранять лицензию.

GNU GPL направлена на максимальную открытость проекта и обеспечивает четыре важнейших свободы:

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

Вы можете беспрепятственно распространять RPGInventory в том виде, в котором он был опубликован, но перед изменением исходного кода Вы обязаны ознакомиться с текстом лицензии, чтобы знать о своих правах и обязанностях.

Более подробную информацию о лицензии можно найти здесь: https://choosealicense.com/licenses/gpl-3.0/.