Experimental BladeTalisman 1.0

EN:

BladeTalisman is a plugin for Nukkit servers that introduces customizable talismans with various effects. Talismans can be held in the off-hand (second hand), applying effects to the player such as increased health, speed, armor, and more. The plugin allows server administrators to create unique talismans via a configuration file, customizing their appearance and effects.
Key Features:

• Customizable talismans with various effects (health, speed, armor, etc.).
• Support for HEX colors (e.g., &#cc0000) and standard Minecraft color codes via & for names and descriptions.
• Option to enable/disable an enchantment glow effect for each talisman.
• Talismans only work when held in the off-hand.
• Effects are automatically removed when the talisman is removed from the off-hand or the player leaves the server.
• All talismans use the minecraft:totem_of_undying material.

Instructions for Use

1. Installing the Plugin:
   • Place the BladeTalisman.jar file into the plugins folder of your Nukkit server.
   • Restart the server to load the plugin.
2. Configuring Talismans:
   • After the first launch, a config.yml file will be created in the plugins/BladeTalisman folder.
   • Open config.yml in a text editor and configure the talismans as desired (see the "Creating Talismans" section for details).
3. Using Talismans:
   • Give a talisman to a player using the command: /givetali <player_name> <talisman_id>.
     • Example: /givetali Steve lord_talisman will give the player Steve a talisman with the ID lord_talisman.
   • The player must place the talisman in their off-hand (the shield slot in the inventory).
   • The talisman’s effects (e.g., +4 health, +2 armor) will apply automatically.
   • If the talisman is removed from the off-hand, the effects will be removed.

Creating Talismans
Talismans are configured in the config.yml file located in the plugins/BladeTalisman folder. Each talisman has a unique ID and the following parameters:

• name: The name of the talisman (supports color codes via & and HEX colors via &#).
• material: The material of the talisman (always minecraft:totem_of_undying).
• lore: The description of the talisman, specified as a list of strings (each line starts with -).
• attributes: The effects of the talisman (e.g., health, speed, armor).
• enchanted: Enable/disable the enchantment glow effect (true or false).

Parameter Explanation:

• name: The talisman’s name, displayed in-game. For example, &4[★] &5&lLord Talisman creates a name with a red star symbol and bold purple text.
• lore: The talisman’s description, shown in the item tooltip. Each line is specified with -.
• attributes: Effects applied when the talisman is in the off-hand:
  • health: Increases maximum health (in units, 1 heart = 2 units).
  • speed: Increases movement speed (in percentage).
  • armor: Reduces incoming damage (1 armor unit = ~4% damage reduction).
  • Other effects (attack_damage, toughness, etc.) are not yet implemented but can be added in the future.
• enchanted: If true, the talisman will have a visual enchantment glow.

Adding a New Talisman:

1. Open config.yml.
2. Add a new block under the talismans section with a unique ID (e.g., my_talisman).
3. Configure the parameters (name, lore, attributes, enchanted).
4. Save the file and restart the server or use a plugin reload command (if supported).

RU:

BladeTalisman — это плагин для серверов Nukkit, который добавляет в игру талисманы с настраиваемыми эффектами. Талисманы можно держать во второй руке (офф-хенде), и они будут применять различные эффекты к игроку, такие как увеличение здоровья, скорости, брони и другие. Плагин позволяет администраторам сервера создавать уникальные талисманы через файл конфигурации, настраивая их внешний вид и эффекты.
Основные особенности:

• Талисманы с настраиваемыми эффектами (здоровье, скорость, броня и т.д.).
• Поддержка HEX-цветов (например, &#cc0000) и стандартных цветовых кодов Minecraft через & для названий и описаний.
• Возможность включить/отключить визуальный эффект зачарования для каждого талисмана.
• Талисманы работают только во второй руке (офф-хенде).
• Эффекты автоматически снимаются, когда талисман убирается из офф-хенда или игрок покидает сервер.
• Все талисманы используют материал minecraft:totem_of_undying.

Инструкция по использованию

1. Установка плагина:
   • Поместите файл BladeTalisman.jar в папку plugins вашего сервера Nukkit.
   • Перезапустите сервер, чтобы плагин загрузился.
2. Настройка талисманов:
   • После первого запуска плагина в папке plugins/BladeTalisman появится файл config.yml.
   • Откройте config.yml в текстовом редакторе и настройте талисманы (подробности в разделе "Создание талисманов").
3. Использование талисманов:
   • Выдайте талисман игроку с помощью команды: /givetali <имя_игрока> <ID_талисмана>.
     • Например: /givetali Steve lord_talisman выдаст игроку Steve талисман с ID lord_talisman.
   • Игрок должен поместить талисман во вторую руку (офф-хенд, слот для щита в инвентаре).
   • Эффекты талисмана (например, +4 здоровья, +2 брони) применятся автоматически.
   • Если убрать талисман из офф-хенда, эффекты снимутся.

Создание талисманов
Талисманы настраиваются в файле config.yml, который находится в папке plugins/BladeTalisman. Каждый талисман имеет уникальный ID и следующие параметры:

• name: Название талисмана (поддерживает цветовые коды через & и HEX-цвета через &#).
• material: Материал талисмана (всегда minecraft:totem_of_undying).
• lore: Описание талисмана, задается списком строк (каждая строка начинается с -).
• attributes: Эффекты талисмана (например, health, speed, armor).
• enchanted: Включение/выключение эффекта зачарования (true или false).

Пример талисмана в config.yml:

Объяснение параметров:

• name: Название талисмана, отображается в игре. Например, &4[★] &5&lТалисман Лорда создаст название с красным символом звезды и жирным фиолетовым текстом.
• lore: Описание талисмана, отображается в подсказке предмета. Каждая строка задается через -.
• attributes: Эффекты, которые применяются, когда талисман в офф-хенде:
  • health: Увеличивает максимальное здоровье (в единицах, 1 сердце = 2 единицы).
  • speed: Увеличивает скорость передвижения (в процентах).
  • armor: Уменьшает получаемый урон (1 единица брони = ~4% уменьшения урона).
  • Другие эффекты (attack_damage, toughness и т.д.) пока не реализованы, но могут быть добавлены в будущем.
• enchanted: Если true, талисман будет иметь визуальный эффект зачарования.

Добавление нового талисмана:

1. Откройте config.yml.
2. Добавьте новый блок в раздел talismans с уникальным ID (например, my_talisman).
3. Настройте параметры (name, lore, attributes, enchanted).
4. Сохраните файл и перезапустите сервер или используйте команду перезагрузки плагина (если поддерживается).