Difference between revisions of "Extensions:Challenges"
Tag: 2017 source edit |
Tag: 2017 source edit |
||
| Line 9: | Line 9: | ||
* Name | * Name | ||
* Description (Optional) | * Description (Optional) | ||
| − | Users can register for currently-active challenges; this is done fully automatically. A site setting is included for the number of concurrent registrations a user can have. The user must then provide a URL and/or text to satisfy each prompt associated with the challenge. All prompts are available immediately and may be completed in any order, with no deadline. On completion of all prompts, the option is provided to submit the log via the standard submissions flow. Note that while user registrations are automatically processed, user logs are not automatically marked 'Old' on processing of any submissions related to them, and this must be done manually by processing staff (by reviewing and "Accepting" the log, entering staff comments if appropriate). | + | Users can register for currently-active challenges; this is done fully automatically. A site setting is included for the number of concurrent registrations a user can have. The user must then provide a URL and/or text to satisfy each prompt associated with the challenge. All prompts are available immediately and may be completed in any order, with no deadline. On completion of all prompts, the option is provided to submit the log via the standard submissions flow (a Prompt is created for this purpose as part of the setup process). Note that while user registrations are automatically processed, user logs are not automatically marked 'Old' on processing of any submissions related to them, and this must be done manually by processing staff (by reviewing and "Accepting" the log, entering staff comments if appropriate). |
== 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 | + | Pull the branch; run <code>php artisan migrate</code> and <code>php artisan setup-challenges</code>. |
| − | <code> | ||
| − | php artisan migrate | ||
| − | php artisan setup-challenges | ||
| − | </code> | ||
== Configuration == | == Configuration == | ||
<!-- Is any configuration necessary? Describe it here! --> | <!-- Is any configuration necessary? Describe it here! --> | ||
| + | * Create challenges as appropriate in the admin panel | ||
| + | * Customize the prompt created as part of the setup process | ||
== Usage == | == Usage == | ||
<!-- Is there anything users should know about using your extension? --> | <!-- Is there anything users should know about using your extension? --> | ||
| + | Users can register for challenges via /challenges | ||
== 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? --> | ||
== 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 13:32, 21 October 2021
| Description | Adds flexible, admin-defined "Challenges" for users to complete. |
|---|---|
| Author(s) | Mercury |
| Status | Testing |
| Github | extensions/challenges |
| LK Version | 2.0.0 |
| Contains a Migration | |
Allows for creation of "challenges", which are composed of a series of prompts (not to be confused with uppercase-P Prompts) for users to complete. Challenges themselves have the following properties:
- Name
- Description (Optional)
- Additional Rules (Optional)
- Is Active
And can have a variable number of prompts. Each prompt has the following properties:
- Name
- Description (Optional)
Users can register for currently-active challenges; this is done fully automatically. A site setting is included for the number of concurrent registrations a user can have. The user must then provide a URL and/or text to satisfy each prompt associated with the challenge. All prompts are available immediately and may be completed in any order, with no deadline. On completion of all prompts, the option is provided to submit the log via the standard submissions flow (a Prompt is created for this purpose as part of the setup process). Note that while user registrations are automatically processed, user logs are not automatically marked 'Old' on processing of any submissions related to them, and this must be done manually by processing staff (by reviewing and "Accepting" the log, entering staff comments if appropriate).
Installation
Pull the branch; run php artisan migrate and php artisan setup-challenges.
Configuration
- Create challenges as appropriate in the admin panel
- Customize the prompt created as part of the setup process
Usage
Users can register for challenges via /challenges
Troubleshooting
Find me in the Lorekeeper server!
