Difference between revisions of "Extensions:Event Tools"
Jump to navigation
Jump to search
(Created page with "{{subst:Extension Page}}") Tag: 2017 source edit |
Tag: 2017 source edit |
||
| Line 1: | Line 1: | ||
| − | {{Extensioninfobox|title= | + | {{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}} |
<!-- 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). | ||
| + | |||
| + | === 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" | ||
| + | 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.) | ||
| + | |||
== Installation == | == Installation == | ||
<!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. --> | <!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. --> | ||
| + | After pulling the extension, run <code>php artisan add-site-settings</code>, <code>php artisan add-text-pages</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! --> | ||
| + | Adjust settings in the site settings admin panel as necessary. | ||
== Usage == | == Usage == | ||
<!-- Is there anything users should know about using your extension? --> | <!-- Is there anything users should know about using your extension? --> | ||
| + | When running an event using a global point total, make sure to link your users to the event point tracking page! | ||
== 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 discord if you have issues. | ||
== 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. --> | ||
| − | |||
Revision as of 21:22, 22 January 2021
| Description | Adds some small tools for running events. |
|---|---|
| Author(s) | Mercury |
| Status | Testing |
| Github | extension\event-tools |
| LK Version | Unspecified |
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"
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.)
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.
