Difference between revisions of "Extensions:Awards"
(Update to Develop branch and revise text.) Tag: 2017 source edit |
Tag: 2017 source edit |
||
| (11 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | ''' | + | This extension creates a separate '''"Awards"''' system for Lorekeeper based off the existing items/inventory system. Awards are stored in the '''"Awardcase"''' and also displayed on user profiles. Awards can be owned by both characters and users. |
| − | + | {{Extensioninfobox|title=Awards|desc=Adds a user "Awards" System to Lorekeeper|auth=[[user:Preimpression]]<br> [[user:Tgi]]<br> [[user:Newt]]|status=Stable|github={{Github|user=preimpression|branch=extension/awards}}|LKVer=2.1.1|migration=yes|package=no}}<br /> | |
| − | + | ==History of the Extension== | |
| − | |||
| − | |||
Before the development of Lorekeeper Version 2.0.0 began, the Awards extension was built by [[User:Tgi]]. It had been built and separated from an existing LK site which had numerous extensions, such as stacked inventories and item entry expansion. The separation wasn't complete, and led to plentiful bugs for those users who weren't using the extensions. | Before the development of Lorekeeper Version 2.0.0 began, the Awards extension was built by [[User:Tgi]]. It had been built and separated from an existing LK site which had numerous extensions, such as stacked inventories and item entry expansion. The separation wasn't complete, and led to plentiful bugs for those users who weren't using the extensions. | ||
| Line 11: | Line 9: | ||
[[User:Preimpression]] took it upon themself to complete the separation and rebase the extension back onto Vanilla Lorekeeper (that is, Lorekeeper V.1.0.0) to allow users who didn't have the remnant extensions to have Awards. It used the original code, which was in fact mostly a clone of extant Items code, and separated out most references to other extensions. | [[User:Preimpression]] took it upon themself to complete the separation and rebase the extension back onto Vanilla Lorekeeper (that is, Lorekeeper V.1.0.0) to allow users who didn't have the remnant extensions to have Awards. It used the original code, which was in fact mostly a clone of extant Items code, and separated out most references to other extensions. | ||
| − | Upon the development of V.2.0.0, extensions began moving over onto the Develop branch on the official | + | Upon the development of V.2.0.0, extensions began moving over onto the Develop branch on the official Lorekeeper github in preparation for the switch to V.2.0.0. At this time, [[User:Newt]] took initiative and converted the extension to the in-development version of 2.0.0. |
| + | |||
| + | In February of 2023, the extension absorbed Ne-wt's Award Progression mini-extension, which added achievement-like unlocks with optional rewards upon earning of an award. | ||
| + | |||
| + | In May of 2023, the extension was retrofitted with a terminology-swapping functionality using Laravel's localizations feature. | ||
==Installation== | ==Installation== | ||
Pull the branch and run the following commands in your console: | Pull the branch and run the following commands in your console: | ||
| + | |||
<code>php artisan migrate</code> - This adds the applicable database tables and columns. | <code>php artisan migrate</code> - This adds the applicable database tables and columns. | ||
| + | |||
<code>php artisan update-extension-tracker</code> - This adds the extension to your Credits page. | <code>php artisan update-extension-tracker</code> - This adds the extension to your Credits page. | ||
| Line 22: | Line 26: | ||
==Configuration== | ==Configuration== | ||
<!-- Is any configuration necessary? Describe it here! --> | <!-- Is any configuration necessary? Describe it here! --> | ||
| − | + | config/lorekeeper/extensions.php includes two settings that can be adjusted: User_featured and character_featured. These default to 1 and show on the character and user pages that quantity of "Featured" awards. | |
| − | Optional: if you'd like to change the names of your awards to something else (i.e. trophies, medals, stickers, etc) you can | + | Optional: if you'd like to change the names of your awards to something else (i.e. trophies, medals, stickers, etc) you can edit the file <source lang="php" enclose="none">resources/lang/en/awards.php</source> |
| − | < | ||
| − | < | + | For instance, where it currently says <source lang="php" enclose="none">['award' => 'award']</source>, you can change it to <source lang="php" enclose="none">['award' => 'badge']</source>. |
| + | |||
| + | Note that this will change the URLs on the public site but because of the order of processing, it does not affect configuration files, including notifications and the admin sidebar. '''Therefore, if you change those, you have to edit your notifications.php config file to adjust the links to the new terms.''' | ||
| − | |||
==Usage== | ==Usage== | ||
<!-- Is there anything users should know about using your extension? --> | <!-- Is there anything users should know about using your extension? --> | ||
| − | + | Awards are like items: you can make award categories, grant awards, and earn them through prompts and claims. | |
| − | |||
| − | |||
| − | |||
==Troubleshooting== | ==Troubleshooting== | ||
| Line 41: | Line 42: | ||
(To avoid this in the future, in '''Sourcetree''', review your staged files + click on the weird code + press "unstage lines". Saves you a lot of headache.) | (To avoid this in the future, in '''Sourcetree''', review your staged files + click on the weird code + press "unstage lines". Saves you a lot of headache.) | ||
| − | For any other issues, please create a ticket on the Lorekeeper discord and ping | + | For any other issues, please create a ticket on the Lorekeeper discord and ping Uri#6669.[[user:Tgi]] is no longer actively providing support for this extension. |
==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. --> | ||
Built using code from [[Extensions:Stacked Inventories]], [[Extensions:Submission Addons]], and [[Extensions:Item Entry Expansion]]. | Built using code from [[Extensions:Stacked Inventories]], [[Extensions:Submission Addons]], and [[Extensions:Item Entry Expansion]]. | ||
Latest revision as of 10:21, 16 May 2023
This extension creates a separate "Awards" system for Lorekeeper based off the existing items/inventory system. Awards are stored in the "Awardcase" and also displayed on user profiles. Awards can be owned by both characters and users.
| Description | Adds a user "Awards" System to Lorekeeper |
|---|---|
| Author(s) |
user:Preimpression user:Tgi user:Newt |
| Status | Stable |
| Github | extension/awards |
| LK Version | 2.1.1 |
| Contains a Migration | |
Contents
History of the Extension
Before the development of Lorekeeper Version 2.0.0 began, the Awards extension was built by User:Tgi. It had been built and separated from an existing LK site which had numerous extensions, such as stacked inventories and item entry expansion. The separation wasn't complete, and led to plentiful bugs for those users who weren't using the extensions.
User:Preimpression took it upon themself to complete the separation and rebase the extension back onto Vanilla Lorekeeper (that is, Lorekeeper V.1.0.0) to allow users who didn't have the remnant extensions to have Awards. It used the original code, which was in fact mostly a clone of extant Items code, and separated out most references to other extensions.
Upon the development of V.2.0.0, extensions began moving over onto the Develop branch on the official Lorekeeper github in preparation for the switch to V.2.0.0. At this time, User:Newt took initiative and converted the extension to the in-development version of 2.0.0.
In February of 2023, the extension absorbed Ne-wt's Award Progression mini-extension, which added achievement-like unlocks with optional rewards upon earning of an award.
In May of 2023, the extension was retrofitted with a terminology-swapping functionality using Laravel's localizations feature.
Installation
Pull the branch and run the following commands in your console:
php artisan migrate - This adds the applicable database tables and columns.
php artisan update-extension-tracker - This adds the extension to your Credits page.
It is recommended that you read Tutorial: Installing Extensions for MERGING and TROUBLESHOOTING before proceeding.
Configuration
config/lorekeeper/extensions.php includes two settings that can be adjusted: User_featured and character_featured. These default to 1 and show on the character and user pages that quantity of "Featured" awards.
Optional: if you'd like to change the names of your awards to something else (i.e. trophies, medals, stickers, etc) you can edit the file resources/lang/en/awards.php
For instance, where it currently says ['award' => 'award'], you can change it to ['award' => 'badge'].
Note that this will change the URLs on the public site but because of the order of processing, it does not affect configuration files, including notifications and the admin sidebar. Therefore, if you change those, you have to edit your notifications.php config file to adjust the links to the new terms.
Usage
Awards are like items: you can make award categories, grant awards, and earn them through prompts and claims.
Troubleshooting
After pulling, you may run into a bunch of conflicts. If anything seems broken, go into your files and check for <<<<<< HEAD. Git adds these in when there's conflicts or additions to existing files, and they can cause stuff to break. Edit them manually, save, and push, and everything should work great.
(To avoid this in the future, in Sourcetree, review your staged files + click on the weird code + press "unstage lines". Saves you a lot of headache.)
For any other issues, please create a ticket on the Lorekeeper discord and ping Uri#6669.user:Tgi is no longer actively providing support for this extension.
See Also
Built using code from Extensions:Stacked Inventories, Extensions:Submission Addons, and Extensions:Item Entry Expansion.
