changelogs update

Author: ImperaZim

changelogs/1.3.md

@@ -948,46 +948,114 @@ It is not compatible with plugins written for version 1.3.0 or lower, and plugin
   ```
   No need to manually write item-checking conditions - simply provide the item class and callback.
 
-**Key Features:**  
-- No manual condition checks required  
-- Direct access to `Player` and `PlayerInventory` in callbacks
-
 
 ## Vendor 
 
 ### `imperazim\vendor\customies\item`
 
 ### Core Mechanics
-- `StackedByDataComponent`: Controls item stacking behavior for variants with different aux values
-- `ShouldDespawnComponent`: Toggles item despawn mechanics for floating entities
-- `ShooterComponent`: Enables projectile launching (requires `UseModifiersComponent`)
-- `RecordComponent`: Adds music playback functionality to items
-- `ItemTaskComponent`: Creates a new ItemTaskComponent to define a task that checks for specific items in a player's inventory.
+- **`StackedByDataComponent`**: Controls item stacking behavior for variants with different aux values.  
+  **Example:**
+  ```php
+  $item->addComponent(new StackedByDataComponent(true)); // Allows stacking of items with different aux values
+  ```
+
+- **`ShouldDespawnComponent`**: Toggles item despawn mechanics for floating entities.  
+  **Example:**
+  ```php
+  $item->addComponent(new ShouldDespawnComponent(false)); // Prevents the item from despawning
+  ```
+
+- **`ShooterComponent`**: Enables projectile launching (requires `UseModifiersComponent`).  
+  **Example:**
+  ```php
+  $item->addComponent(new ShooterComponent("arrow", ...view component)); // Shoots arrows with a speed of 1.5
+  ```
+
+- **`RecordComponent`**: Adds music playback functionality to items.  
+  **Example:**
+  ```php
+  $item->addComponent(new RecordComponent(1, 60, "record.song")); // Plays a specific music record
+  ```
+
+- **`ItemTaskComponent`**: Creates a new ItemTaskComponent to define a task that checks for specific items in a player's inventory.  
+  **Example:**
+  ```php
+  $item->addComponent(new ItemTaskComponent(
+    DiamondSword::class,
+    function(Player $player, Item $item): void {
+      $player->sendMessage("You are holding a Diamond Sword!");
+    },
+    ItemTaskComponent::FILTER_HAND
+  ));
+  ```
 
 ### Visual & Interaction
-- `HoverTextColorComponent`: Sets custom color for item name hover text
-- `GlintComponent`: Toggles enchantment glow effect
-- `InteractButtonComponent`: Configures touch control interaction button (supports custom text)
-- `LiquidClippedComponent`: Defines liquid block interaction behavior
+- **`HoverTextColorComponent`**: Sets custom color for item name hover text.  
+  **Example:**
+  ```php
+  $item->addComponent(new HoverTextColorComponent("color")); // Sets hover text color to red. See: https://minecraft.wiki/w/Formatting_codes#Color_codes
+  ```
+
+- **`GlintComponent`**: Toggles enchantment glow effect.  
+  **Example:**
+  ```php
+  $item->addComponent(new GlintComponent(true)); // Adds an enchantment glow to the item
+  ```
+
+- **`InteractButtonComponent`**: Configures touch control interaction button (supports custom text).  
+  **Example:**
+  ```php
+  $item->addComponent(new InteractButtonComponent("Use Item")); // Displays "Use Item" on the interact button
+  ```
+
+- **`LiquidClippedComponent`**: Defines liquid block interaction behavior.  
+  **Example:**
+  ```php
+  $item->addComponent(new LiquidClippedComponent(true)); // Allows interaction with liquid blocks
+  ```
 
 ### Item Customization
-- `DyeableComponent`: Enables cauldron-based dyeing (requires `dyed` texture definition)
-- `EnchantableSlotComponent`: Restricts applicable enchantment types (e.g., bow-only enchants)
-- `EnchantableValueComponent`: Sets base enchantment strength
+- **`DyeableComponent`**: Enables cauldron-based dyeing (requires `dyed` texture definition).  
+  **Example:**
+  ```php
+  $item->addComponent(new DyeableComponent("#hex")); // Allows the item to be dyed in a cauldron
+  ```
+
+- **`EnchantableSlotComponent`**: Restricts applicable enchantment types (e.g., bow-only enchants).  
+  **Example:**
+  ```php
+  $item->addComponent(new EnchantableSlotComponent(self::SLOT_NAME)); // Allows only slot_name enchantments
+  ```
+
+- **`EnchantableValueComponent`**: Sets base enchantment strength.  
+  **Example:**
+  ```php
+  $item->addComponent(new EnchantableValueComponent(10)); // Sets base enchantment strength to 10
+  ```
 
 ### Combat & Durability
-- `DamageComponent`: Increases attack damage (positive values only)
-- `DamageAbsorptionComponent`: Reduces incoming damage when equipped as armor (requires durability)
+- **`DamageComponent`**: Increases attack damage (positive values only).  
+  **Example:**
+  ```php
+  $item->addComponent(new DamageComponent(5)); // Adds 5 extra damage to the item
+  ```
+
+- **`DamageAbsorptionComponent`**: Reduces incoming damage when equipped as armor (requires durability).  
+  **Example:**
+  ```php
+  $item->addComponent(new DamageAbsorptionComponent(3)); // Absorbs 3 points of damage
+  ```
 
 ### Specialized Systems
-- `BundleInteractionComponent`: Enables bundle storage mechanics (requires `storage_item` component)
-- `UseModifiersComponent`: Configures item usage timing for food/throwable/shooter items
-``` 
-
-**Key Improvements:**  
-- Structured hierarchy with clear section separation  
-- Component grouping by functional category  
-- Consistent formatting for code blocks and component names  
-- Concise yet descriptive explanations  
-- Explicit dependency warnings  
-- Removed redundant technical jargon
+- **`BundleInteractionComponent`**: Enables bundle storage mechanics (requires `storage_item` component).  
+  **Example:**
+  ```php
+  $item->addComponent(new BundleInteractionComponent(4)); // Enables Bundle Interactions with 4 slots
+  ```
+
+- **`UseModifiersComponent`**: Configures item usage timing for food/throwable/shooter items.  
+  **Example:**
+  ```php
+  $item->addComponent(new UseModifiersComponent(1.0, 1.5)); // Sets item usage modifiers +1.0 with duration to 1.5 seconds
+  ```