DisplayLib - Minecraft UI Library с Lua API

Возможности

Быстрый старт

1. Установка

2. Первый запуск

plugins/DisplayLib/
 screens/
 main_menu.yml # Главное меню
 branch1.yml # Простой экран без Lua
 scripts/
 main_menu.lua # Скрипт главного меню

3. Тестирование

/displaylib open main_menu # Открыть главное меню
/displaylib list # Список экранов
/displaylib close # Закрыть экран
/displaylib reload # Перезагрузить (для админов)

Структура проекта

YAML экраны (screens/)

id: main_menu
background:
 color: [0, 0, 0]
 alpha: 160
 scale: [10.0, 4.0, 1.0]
 text: " "
scripts:
 file: "main_menu.lua"
widgets:
 - id: btn_start
 type: ITEM_BUTTON
 material: COMPASS
 position: [-0.42, 0.30, 0.0]
 scale: [0.15, 0.15, 0.000001]
 tooltip: "Начать игру"
 onClick:
 action: RUN_SCRIPT
 function: "btn_start_click"

Lua скрипты (scripts/)

function on_open()
 player.message("Добро пожаловать, " .. player.name() .. "!")
 
 local visits = storage.get("visits", 0) + 1
 storage.set("visits", visits)
 
 log.info("Экран открыт для " .. player.name())
end
function btn_start_click()
 player.sound("ui.button.click")
 screen.switch("game_menu")
end
function on_close()
 player.message("До свидания!")
end

Lua API

player - игрок

player.name() -- имя игрока
player.op() -- права оператора
player.gamemode() -- текущий режим игры
player.gamemode("creative") -- установить режим
player.message("текст") -- сообщение в чат
player.message("текст", "#ff0000") -- с цветом
player.sound("ui.button.click") -- звук
player.health() -- здоровье (0-20)
player.health(20) -- установить здоровье
player.command("tp ~ ~10 ~") -- выполнить команду

screen - экран

screen.id() -- ID экрана
screen.close() -- закрыть экран
screen.switch("other_screen") -- переключиться
screen.widget("widget_id") -- получить виджет
-- Persistent data (живет пока экран открыт)
screen.data("key") -- получить
screen.data("key", value) -- установить
screen.data("key", nil) -- удалить

widget - виджет (в функциях клика)

-- Текст (только TEXT_BUTTON)
widget.text() -- получить текст
widget.text("новый текст") -- установить текст
widget.hoveredText("при наведении")
-- Состояние
widget.visible() -- видимость
widget.visible(false) -- скрыть
widget.enabled() -- активность
widget.enabled(false) -- отключить
-- Tooltip
widget.tooltip() -- получить подсказку
widget.tooltip("новая подсказка") -- установить
-- Цвет фона (только TEXT_BUTTON)
widget.bgColor(40, 40, 40) -- RGB
widget.bgAlpha(150) -- прозрачность 0-255

storage - хранение данных

storage.get("key") -- получить
storage.get("key", 0) -- с дефолтным значением
storage.set("key", value) -- установить
storage.has("key") -- проверить наличие
storage.remove("key") -- удалить
storage.clear() -- очистить все

timer - таймеры

-- Выполнить один раз через N тиков
timer.after(20, function()
 screen.close()
end)
-- Повторять каждые N тиков
local t = timer.repeat(10, function()
 -- анимация
end)
timer.cancel(t)
-- Повторить N раз
timer.times(5, 10, function(i) -- каждые 5 тиков, 5 раз
 widget.text("Осталось: " .. (5 - i))
end)

log - логирование

log.info("информация")
log.warn("предупреждение")
log.error("ошибка")

Типы виджетов

TEXT_BUTTON - текстовая кнопка

- id: label_title
 type: TEXT_BUTTON
 text: "Заголовок"
 hoveredText: "Заголовок (наведение)"
 position: [0.0, 0.85, 0.0]
 scale: [0.5, 0.5, 0.5]
 tolerance: [0.08, 0.04]
 backgroundColor: [40, 40, 40]
 backgroundAlpha: 150
 hoveredBackgroundColor: [60, 60, 60]
 hoveredBackgroundAlpha: 180
 onClick:
 action: NONE

ITEM_BUTTON - кнопка с предметом

- id: btn_settings
 type: ITEM_BUTTON
 material: COMPASS
 position: [-0.42, 0.30, 0.0]
 scale: [0.15, 0.15, 0.000001]
 tolerance: [0.06, 0.06]
 tooltip: "Настройки"
 glowOnHover: true
 glowColor: [255, 255, 0]
 onClick:
 action: SWITCH_SCREEN
 target: settings

Действия onClick

Система координат

 Y+
 | 
 -X ----+---- +X (смотришь на экран)
 |
 Y-

Команды

Разработка

Hot Reload

Отладка

Структура файлов

plugins/DisplayLib/
 screens/ # YAML описания экранов
 main_menu.yml
 settings.yml
 ...
 scripts/ # Lua скрипты
 main_menu.lua
 settings.lua
 shared/ # Общие функции
 utils.lua

Примеры

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

Лицензия