From Lorekeeper Wiki
Revision as of 15:01, 4 December 2022 by Moif (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Description Adds the ability to wrap items or MYO in "giftwrap" such that they can be unwrapped after.
Author(s) moif
Status stable
Github AW0005/lorekeeper-extensions/extension/giftwrap-tag
LK Version 2.0.0

About the Extension

This extension adds two new item tags "Giftwrap" and "Giftwrapped". The "Giftwrap" tag needs to be associated via the edit panel for it, to a "Giftwrapped" tagged item. Then when a "Giftwrap" item is used to wrap an item, myo, or currency from a user's inventory it generates the "Giftwrapped" item that was specified.


  1. Pull and deal with conflicts
  2. `php artisan optimize`


  1. Set up an item tagged "Giftwrapped" - this will be the "filled" or "wrapped" version of an item
  2. Set up an item tagged "Giftwrap" and associate the "Giftwrapped" item to it"
  3. Sell or grant the "Giftwrap" item to your users as you see fit!

It also optionally includes some commented out code in "app/Services/Item/GiftwrapService.php" and "resources/views/inventory/_giftwrap.blade.php" that can be un-commented to allow the wrapping of characters as well.


Use with Other Extensions

Donation Shop

The donation shop by default overwrites the data for items, which would overwrite the item wrapped information. To make sure that information isn't lost you'll want to go to app/Services/ShopManager.php and look for public function collectDonation.

Replace this line:

// Give the user the item            
if(!(new InventoryManager)->creditItem(null, $user, 'Collected from Donation Shop', [
                'data' => 'Collected from Donation Shop by '.$user->displayName,
                'notes' => null,
], $stock->item, 1)) throw new \Exception("Failed to collect item.");

With this:

// Give the user the item            
if(!(new InventoryManager)->creditItem(null, $user, 'Collected from Donation Shop',$stock->stack->data + [
                'data' => 'Collected from Donation Shop by '.$user->displayName,
                'notes' => isset($stock->stack->data['notes']) ? $stock->stack->data['notes'] : null,
], $stock->item, 1)) throw new \Exception("Failed to collect item.");

When you do this copy, make sure that the phrasing 'Collected From Donation Shop' matches what you already have in your code!! It plays into other Donation Shop logic, so you want to make sure you keep that the same.

See Also

Feel free to ping moif in the LK discord if you have questions!