Extensions:Advent Calendars

From Lorekeeper Wiki
Jump to navigation Jump to search
Advent Calendars
Description Adds advent calendars that users can collect item(s) from once a day
Author(s) Mercury
Status Testing
Github extension/advent-calendars
Contains a Migration


This extension is built on develop.

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.

See Also