Difference between revisions of "Extensions:Donation Shop"

From Lorekeeper Wiki
Jump to navigation Jump to search
(Created page with "{{subst:Extension Page}}")
Tag: 2017 source edit
 
Tag: 2017 source edit
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Extensioninfobox|title=the extension's name|desc=A short description|auth=Author(s)|status=status (such as WIP, testing, stable)|github={{Github|user=username|branch=branch}}|migration=yes/no|package=yes/no}}
+
{{Extensioninfobox|title=Donation Shop|desc=Adds a "shop" that users can both donate items to and collect from.|auth=Mercury|status=Testing|github={{Github|user=itinerare|branch=extension/donation-shop}}|LKVer=2.0.0|migration=yes|package=no}}
 
<!-- Put a short summary of your extension here! -->
 
<!-- Put a short summary of your extension here! -->
 +
Adds a donation "shop" to the shops panel which users can donate items to from their inventory. Users may then collect these items from the shop at no cost. Items maintain the source/notes that they had prior; in this sense, it is akin to users gifting items back and forth, but with the advantage of all the actual logistics being automated.
 +
 +
What items may be donated can be configured via config file. The options are to allow all items (with of course the exception of anything non-transferrable) to be donated, to allow only items of certain categories to be donated (configured in item category creation/editing), to allow only items with the included "donateable" item tag to be donated, or a combination of the last two. There is also a cooldown timer for users collecting items from the shop, the duration of which is also configurable.
 
== Installation ==
 
== Installation ==
 
<!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. -->
 
<!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. -->
 +
Pull the branch; run <code>php artisan migrate</code>, <code>php artisan add-donation-shop</code>, and <code>php artisan update-extension-tracker</code>.
 
== Configuration ==
 
== Configuration ==
 
<!-- Is any configuration necessary? Describe it here! -->
 
<!-- Is any configuration necessary? Describe it here! -->
 +
* Configure basic settings as desired in config/lorekeeper/settings, under "Shops".
 +
* Upload an image for the shop in the site images admin panel
 +
* Customize the text for the shop in the pages admin panel
 
== Usage ==
 
== Usage ==
 
<!-- Is there anything users should know about using your extension? -->
 
<!-- Is there anything users should know about using your extension? -->
 +
Not in particular! It is built to more or less run itself.
 
== Troubleshooting ==
 
== Troubleshooting ==
 
<!-- Are there known issues or errors that require user action? Who should they contact, and where, for support? -->
 
<!-- Are there known issues or errors that require user action? Who should they contact, and where, for support? -->
 +
Find me in the Lorekeeper server!
 
== Images ==
 
== Images ==
 
<!-- Do you have any images to show what it looks like in action? -->
 
<!-- Do you have any images to show what it looks like in action? -->
 +
* [https://www.itinerare.net/gallery/pieces/62.Donation-Shop?source=projects/pages/lorekeeper Writeup with images on my site]
 
== See Also ==
 
== See Also ==
 
<!-- Any relevant other pages. You may consider linking to related extensions, for instance. -->
 
<!-- Any relevant other pages. You may consider linking to related extensions, for instance. -->
 

Latest revision as of 06:39, 29 August 2021

Donation Shop
Description Adds a "shop" that users can both donate items to and collect from.
Author(s) Mercury
Status Testing
Github extension/donation-shop
LK Version 2.0.0
Contains a Migration


Adds a donation "shop" to the shops panel which users can donate items to from their inventory. Users may then collect these items from the shop at no cost. Items maintain the source/notes that they had prior; in this sense, it is akin to users gifting items back and forth, but with the advantage of all the actual logistics being automated.

What items may be donated can be configured via config file. The options are to allow all items (with of course the exception of anything non-transferrable) to be donated, to allow only items of certain categories to be donated (configured in item category creation/editing), to allow only items with the included "donateable" item tag to be donated, or a combination of the last two. There is also a cooldown timer for users collecting items from the shop, the duration of which is also configurable.

Installation

Pull the branch; run php artisan migrate, php artisan add-donation-shop, and php artisan update-extension-tracker.

Configuration

  • Configure basic settings as desired in config/lorekeeper/settings, under "Shops".
  • Upload an image for the shop in the site images admin panel
  • Customize the text for the shop in the pages admin panel

Usage

Not in particular! It is built to more or less run itself.

Troubleshooting

Find me in the Lorekeeper server!

Images

See Also