Difference between revisions of "Extensions:Advent Calendars"
(Created page with "{{subst:Extension Page}}") Tag: 2017 source edit |
Tag: 2017 source edit |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{Extensioninfobox|title= | + | {{Extensioninfobox|title=Advent Calendars|desc=Adds advent calendars that users can collect item(s) from once a day|auth=Mercury|status=Stable|github={{Github|user=itinerare|branch=extension/advent-calendars}}|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 the ability to set up advent calendars of any given duration and associate an item prize with each day that users can collect. A bonus prize awarded to users that collect the prize for every day can also be set. Advent calendars can have a name and display name set, as well as an optional summary. A start and end time are required; from this the duration (in days) is calculated and fields are provided to set prizes per day. Each day may have an item of any given quantity assigned; to extend beyond this, the use of the box item tag, present in base Lorekeeper, is recommended. | ||
| + | |||
| + | Similar to [[Extensions:Scavenger Hunts]]-- which this is essentially based on, though rather modified and wholly independent from that extension-- the URL of the user-facing page is provided, as well as HTML for a link to it. Logs are also provided, though they are for each individual instance of a prize being claimed, as there may be any number of days and thus prizes to claim. To account for this, the logs can be sorted. They are also paginated. | ||
| + | |||
| + | On the user end of things, the advent calendar page displays the status of the advent calendar. It is not visible until the scheduled start time, but is visible forever afterward. If the advent is active, it displays the current day's prize (if any), and provides a button for the user to collect it (and to log that the user has done so). The prizes that the user has claimed thus far are also displayed. | ||
== 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 and run <code>php artisan migrate</code>, as well as <code>php artisan update-extension-tracker</code>. | ||
== Configuration == | == Configuration == | ||
<!-- Is any configuration necessary? Describe it here! --> | <!-- Is any configuration necessary? Describe it here! --> | ||
| + | Advent calendars can be created from the associated admin panel. | ||
== Usage == | == Usage == | ||
<!-- Is there anything users should know about using your extension? --> | <!-- Is there anything users should know about using your extension? --> | ||
== 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 if you encounter any issues. | ||
| + | == Images == | ||
| + | * [https://www.itinerare.net/gallery/pieces/11.Lorekeeper-Ext-%E2%97%88-Advent-Calendars?source=projects/pages/lorekeeper&page=1 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:31, 29 August 2021
| Description | Adds advent calendars that users can collect item(s) from once a day |
|---|---|
| Author(s) | Mercury |
| Status | Stable |
| Github | extension/advent-calendars |
| LK Version | 2.0.0 |
| Contains a Migration | |
Adds the ability to set up advent calendars of any given duration and associate an item prize with each day that users can collect. A bonus prize awarded to users that collect the prize for every day can also be set. Advent calendars can have a name and display name set, as well as an optional summary. A start and end time are required; from this the duration (in days) is calculated and fields are provided to set prizes per day. Each day may have an item of any given quantity assigned; to extend beyond this, the use of the box item tag, present in base Lorekeeper, is recommended.
Similar to Extensions:Scavenger Hunts-- which this is essentially based on, though rather modified and wholly independent from that extension-- the URL of the user-facing page is provided, as well as HTML for a link to it. Logs are also provided, though they are for each individual instance of a prize being claimed, as there may be any number of days and thus prizes to claim. To account for this, the logs can be sorted. They are also paginated.
On the user end of things, the advent calendar page displays the status of the advent calendar. It is not visible until the scheduled start time, but is visible forever afterward. If the advent is active, it displays the current day's prize (if any), and provides a button for the user to collect it (and to log that the user has done so). The prizes that the user has claimed thus far are also displayed.
Installation
Pull the branch and run php artisan migrate, as well as php artisan update-extension-tracker.
Configuration
Advent calendars can be created from the associated admin panel.
Usage
Troubleshooting
Find me in the Lorekeeper server if you encounter any issues.
