Difference between revisions of "Extensions:Character Drops"
(Created page with "{{subst:Extension Page}}") Tag: 2017 source edit |
Tag: 2017 source edit |
||
| Line 1: | Line 1: | ||
| − | {{Extensioninfobox|title= | + | {{Extensioninfobox|title=Character Drops|desc=Configurable items from characters at set intervals|auth=Mercury|status=Testing|github={{Github|user=itinerare|branch=extension/character-drops}}|migration=yes|package=no}} |
<!-- Put a short summary of your extension here! --> | <!-- Put a short summary of your extension here! --> | ||
| + | '''This extension is built upon <u>develop</u>.''' | ||
| + | |||
| + | Adds the ability to set up "drops" of items attached to characters at set intervals. | ||
| + | |||
| + | ==== Admin Interface ==== | ||
| + | Drops are configured first per species (each species may only have one instance of drop data). From there, you can specify groups into which characters can be either randomly or deliberately sorted; random rolling can be weighted in the same vein as rewards from loot tables. You can also specify how often drops should occur, both in frequency (number) and interval (hour/day/month/year). Drops can also be toggled active/inactive. | ||
| + | |||
| + | Items may have either a range or a set quantity, and can be set at the species level for each group, and/or at the subtype level for each group. You can set one item for each of these-- so a character can produce a maximum of 2 types of items, though the quantity can be whatever you so desire. | ||
| + | |||
| + | Drop data may also be given a 'name', per species/drop data, that displays instead of 'drops' on the user interface. | ||
| + | ==== User Interface ==== | ||
| + | Characters of species with set drop data have a new section added to their sidebar (drops). They also have their group display in image information alongside their species if the species has more than one possible group. | ||
| + | |||
| + | The drop interface itself displays what item(s) the character can drop, how many they can drop (displaying either a range or static number as appropriate) and at what interval (per (frequency) (interval), omitting frequency if it is one-- i.e. 'per month' vs 'per 2 months'). It also displays how many batches of drops the character has available to collect, and when the next batch will become available (assuming the character can produce drops of some sort). | ||
| + | |||
| + | Dropped items are credited directly to the collecting user-- the character's owner's-- inventory with appropriate source (collected from (character)) and note (the timestamp for when the item(s) were collected). | ||
== 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 and run <code>php artisan migrate</code>, as well as <code>php artisan update-extension-tracker</code>. | ||
== Configuration == | == Configuration == | ||
<!-- Is any configuration necessary? Describe it here! --> | <!-- Is any configuration necessary? Describe it here! --> | ||
| + | Character drops can be configured via admin panel. | ||
== Usage == | == Usage == | ||
<!-- Is there anything users should know about using your extension? --> | <!-- Is there anything users should know about using your extension? --> | ||
== 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 if you encounter any 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 16:36, 10 December 2020
| Description | Configurable items from characters at set intervals |
|---|---|
| Author(s) | Mercury |
| Status | Testing |
| Github | extension/character-drops |
| LK Version | Unspecified |
| Contains a Migration | |
This extension is built upon develop.
Adds the ability to set up "drops" of items attached to characters at set intervals.
Contents
Admin Interface
Drops are configured first per species (each species may only have one instance of drop data). From there, you can specify groups into which characters can be either randomly or deliberately sorted; random rolling can be weighted in the same vein as rewards from loot tables. You can also specify how often drops should occur, both in frequency (number) and interval (hour/day/month/year). Drops can also be toggled active/inactive.
Items may have either a range or a set quantity, and can be set at the species level for each group, and/or at the subtype level for each group. You can set one item for each of these-- so a character can produce a maximum of 2 types of items, though the quantity can be whatever you so desire.
Drop data may also be given a 'name', per species/drop data, that displays instead of 'drops' on the user interface.
User Interface
Characters of species with set drop data have a new section added to their sidebar (drops). They also have their group display in image information alongside their species if the species has more than one possible group.
The drop interface itself displays what item(s) the character can drop, how many they can drop (displaying either a range or static number as appropriate) and at what interval (per (frequency) (interval), omitting frequency if it is one-- i.e. 'per month' vs 'per 2 months'). It also displays how many batches of drops the character has available to collect, and when the next batch will become available (assuming the character can produce drops of some sort).
Dropped items are credited directly to the collecting user-- the character's owner's-- inventory with appropriate source (collected from (character)) and note (the timestamp for when the item(s) were collected).
Installation
Pull the branch and run php artisan migrate, as well as php artisan update-extension-tracker.
Configuration
Character drops can be configured via admin panel.
Usage
Troubleshooting
Find me in the Lorekeeper server if you encounter any issues.
