Difference between revisions of "Extensions:Breeding Permissions"
(Created page with "{{subst:Extension Page}}") Tag: 2017 source edit |
Tag: 2017 source edit |
||
| Line 1: | Line 1: | ||
| − | {{Extensioninfobox|title= | + | {{Extensioninfobox|title=Breeding Permissions|desc=Adds breeding permission creation and granting to characters.|auth=Mercury|status=Testing|github={{Github|user=itinerare|branch=extension/breeding-permissions}}|LKVer=2.0.0|migration=yes|package=no}} |
<!-- Put a short summary of your extension here! --> | <!-- Put a short summary of your extension here! --> | ||
| + | Adds breeding permissions to characters. Breeding permissions are associated with individual characters and can be created/granted to other on-site users, transferred after being granted, and marked as having been used by admins. | ||
| + | |||
| + | Breeding permissions have the following properties: | ||
| + | * Recipient | ||
| + | * Type (Full/Split) | ||
| + | * Notes (Optional) | ||
| + | |||
| + | They also have associated logs and logging, which are displayed alongside the breeding permission itself. Logs are made for creation, transfer (by the recipient or by an admin (forced transfer)), and the permission being marked as used. | ||
| + | |||
| + | Notifications are also sent in these instances: | ||
| + | * Granting a breeding permission notifies the user to whom it is granted. | ||
| + | * Transferring a breeding permission notifies the recipient. | ||
| + | * Force-transferring a breeding permission notifies the prior owner and recipient. | ||
| + | * Marking a breeding permission as having been used notifies both the character's owner and the breeding permission's recipient. | ||
| + | |||
| + | Breeding permissions have a cap that is handled via Lorekeeper's [[Currencies|currency]] system. A command is included to handle setup in this regard, including granting all extant characters (at the time the command is run) the configured currency for the purpose as well as setting up automatic granting on character creation. An item tag is also included that can be used to grant a configurable amount of the currency to a character selected by the user. | ||
| + | |||
| + | Breeding permissions can be viewed: | ||
| + | * On the character to whom they belong's page | ||
| + | * For logged-in users, their owned breeding permissions are listed at /breeding-permissions | ||
| + | * Users' owned breeding permissions are visible via their profile | ||
| + | |||
== 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 <code>php artisan migrate</code>, <code>php artisan add-breeding-permission-currency</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! --> | ||
| + | Configuration is largely handled via the included command, but the relevant settings can be adjusted via the site settings admin panel as well. | ||
== Usage == | == Usage == | ||
<!-- Is there anything users should know about using your extension? --> | <!-- Is there anything users should know about using your extension? --> | ||
| + | Users can generate/grant breeding permissions from their characters' pages, view their own via /breeding-permissions, and view others' via their profiles. | ||
== 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! | ||
== 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 11:50, 5 November 2021
| Description | Adds breeding permission creation and granting to characters. |
|---|---|
| Author(s) | Mercury |
| Status | Testing |
| Github | extension/breeding-permissions |
| LK Version | 2.0.0 |
| Contains a Migration | |
Adds breeding permissions to characters. Breeding permissions are associated with individual characters and can be created/granted to other on-site users, transferred after being granted, and marked as having been used by admins.
Breeding permissions have the following properties:
- Recipient
- Type (Full/Split)
- Notes (Optional)
They also have associated logs and logging, which are displayed alongside the breeding permission itself. Logs are made for creation, transfer (by the recipient or by an admin (forced transfer)), and the permission being marked as used.
Notifications are also sent in these instances:
- Granting a breeding permission notifies the user to whom it is granted.
- Transferring a breeding permission notifies the recipient.
- Force-transferring a breeding permission notifies the prior owner and recipient.
- Marking a breeding permission as having been used notifies both the character's owner and the breeding permission's recipient.
Breeding permissions have a cap that is handled via Lorekeeper's currency system. A command is included to handle setup in this regard, including granting all extant characters (at the time the command is run) the configured currency for the purpose as well as setting up automatic granting on character creation. An item tag is also included that can be used to grant a configurable amount of the currency to a character selected by the user.
Breeding permissions can be viewed:
- On the character to whom they belong's page
- For logged-in users, their owned breeding permissions are listed at /breeding-permissions
- Users' owned breeding permissions are visible via their profile
Installation
Pull the branch; run php artisan migrate, php artisan add-breeding-permission-currency, and php artisan update-extension-tracker.
Configuration
Configuration is largely handled via the included command, but the relevant settings can be adjusted via the site settings admin panel as well.
Usage
Users can generate/grant breeding permissions from their characters' pages, view their own via /breeding-permissions, and view others' via their profiles.
Troubleshooting
Find me in the Lorekeeper discord!
