Difference between revisions of "Extensions:Event Tools"
Jump to navigation
Jump to search
Tag: 2017 source edit |
Tag: 2017 source edit |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{Extensioninfobox|title=Event Tools|desc=Adds some small tools for running events.|auth=Mercury|status=Testing|github={{Github|user=itinerare|branch=extension\event-tools}}|migration=no|package=no}} | + | {{Extensioninfobox|title=Event Tools|desc=Adds some small tools for running events.|auth=Mercury|status=Testing|github={{Github|user=itinerare|branch=extension\event-tools}}|LKVer=2.0.0|migration=no|package=no}} |
<!-- Put a short summary of your extension here! --> | <!-- Put a short summary of your extension here! --> | ||
Adds some relatively lightweight tools for doing some fun stuff with extensions. As-is, it's built with the philosophy of doing as much as possible while not adding too much (for instance, it doesn't include migrations). | Adds some relatively lightweight tools for doing some fun stuff with extensions. As-is, it's built with the philosophy of doing as much as possible while not adding too much (for instance, it doesn't include migrations). | ||
| Line 7: | Line 7: | ||
* Event currency (id) | * Event currency (id) | ||
* Whether or not to track event currency earnings globally (in addition to tracking per user as usual) | * Whether or not to track event currency earnings globally (in addition to tracking per user as usual) | ||
| − | * A global goal for event "score" | + | * A global goal for event "score", which can be disabled by setting it to 0 |
Admin-side: | Admin-side: | ||
* An event point tracking page displaying current event currency, and information about the current global total and progress toward the goal | * An event point tracking page displaying current event currency, and information about the current global total and progress toward the goal | ||
* This includes a progress bar-- code for an inverted progress bar (drains instead of fills, in the vein of an HP bar) is stored in the view, commented out | * This includes a progress bar-- code for an inverted progress bar (drains instead of fills, in the vein of an HP bar) is stored in the view, commented out | ||
* It also includes a an option to clear/zero-out all users' current event currency amount, in lieu of deleting + remaking the event currency. (In the vein of deleting an item, currency, etc. this is tucked within a confirmation modal, so no worries about clicking it accidentally to disastrous results.) Deleting currencies currently owned by users is consequently disabled, since it offers an alternate solution to the problem allowing that was endeavoring to solve. | * It also includes a an option to clear/zero-out all users' current event currency amount, in lieu of deleting + remaking the event currency. (In the vein of deleting an item, currency, etc. this is tucked within a confirmation modal, so no worries about clicking it accidentally to disastrous results.) Deleting currencies currently owned by users is consequently disabled, since it offers an alternate solution to the problem allowing that was endeavoring to solve. | ||
| − | * Global tracking of event points. This is done by, when global tracking is enabled and a user would receive event currency through any means, also crediting it to the admin user specified via the admin_user site setting-- since the admin user should not be any given user's personal account/not a participant in any event. (This does not apply if the admin user acquires event currency directly, however, so that they are not double-credited.) | + | * Global tracking of event points. This is done by, when global tracking is enabled and a user would receive event currency through any means, also crediting it to the admin user specified via the admin_user site setting-- since the admin user should not be any given user's personal account/not a participant in any event. (This does not apply if the admin user acquires event currency directly, however, so that they are not double-credited.) Note that no automation is attached to reaching the set goal/any thresholds. Any rewards, etc. will need to be distributed through different means. |
| + | * A text page for substitution into the user-facing event tracking page, for detailing an event with global point tracking. | ||
| + | User-facing: | ||
| + | * An event tracking page, viewable when global point tracking is enabled, which displays the contents of the above page as well as listing the current event currency, global point total, and progress toward the goal if any (including progress bar; similarly, there is a commented-out inverse progress bar in the view). | ||
== Installation == | == Installation == | ||
| Line 26: | Line 29: | ||
<!-- 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 discord if you have issues. | Find me in the Lorekeeper discord if you have issues. | ||
| + | == Images == | ||
| + | <!-- Do you have any images to show what it looks like in action? --> | ||
| + | * [https://www.itinerare.net/gallery/pieces/12.Lorekeeper-Ext-%E2%97%88-Event-Tools?source=projects/pages/lorekeeper&page=1 Writeup with images on my site] | ||
| + | * [https://i.imgur.com/ZeLW4yx.png Site Settings] | ||
| + | * [https://i.imgur.com/HJkPIHG.png Event Currency (Grants)] | ||
== 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:41, 29 August 2021
| Description | Adds some small tools for running events. |
|---|---|
| Author(s) | Mercury |
| Status | Testing |
| Github | extension\event-tools |
| LK Version | 2.0.0 |
Adds some relatively lightweight tools for doing some fun stuff with extensions. As-is, it's built with the philosophy of doing as much as possible while not adding too much (for instance, it doesn't include migrations).
Features
Additional site settings for:
- Event currency (id)
- Whether or not to track event currency earnings globally (in addition to tracking per user as usual)
- A global goal for event "score", which can be disabled by setting it to 0
Admin-side:
- An event point tracking page displaying current event currency, and information about the current global total and progress toward the goal
- This includes a progress bar-- code for an inverted progress bar (drains instead of fills, in the vein of an HP bar) is stored in the view, commented out
- It also includes a an option to clear/zero-out all users' current event currency amount, in lieu of deleting + remaking the event currency. (In the vein of deleting an item, currency, etc. this is tucked within a confirmation modal, so no worries about clicking it accidentally to disastrous results.) Deleting currencies currently owned by users is consequently disabled, since it offers an alternate solution to the problem allowing that was endeavoring to solve.
- Global tracking of event points. This is done by, when global tracking is enabled and a user would receive event currency through any means, also crediting it to the admin user specified via the admin_user site setting-- since the admin user should not be any given user's personal account/not a participant in any event. (This does not apply if the admin user acquires event currency directly, however, so that they are not double-credited.) Note that no automation is attached to reaching the set goal/any thresholds. Any rewards, etc. will need to be distributed through different means.
- A text page for substitution into the user-facing event tracking page, for detailing an event with global point tracking.
User-facing:
- An event tracking page, viewable when global point tracking is enabled, which displays the contents of the above page as well as listing the current event currency, global point total, and progress toward the goal if any (including progress bar; similarly, there is a commented-out inverse progress bar in the view).
Installation
After pulling the extension, run php artisan add-site-settings, php artisan add-text-pages, and php artisan update-extension-tracker.
Configuration
Adjust settings in the site settings admin panel as necessary.
Usage
When running an event using a global point total, make sure to link your users to the event point tracking page!
Troubleshooting
Find me in the Lorekeeper discord if you have issues.
