Difference between revisions of "Extensions:Status Effects"

From Lorekeeper Wiki
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=the extension's name|desc=A short description|auth=Author(s)|status=status (such as WIP, testing, stable)|github={{Github|user=username|branch=branch}}|LKVer=What Lorekeeper version the ext is built on|migration=yes/no|package=yes/no}}
+
{{Extensioninfobox|title=Status Effects|desc=Adds support for character status effects.|auth=Mercury|status=Testing|github={{Github|user=itinerare|branch=extension/status-effects}}|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 support for status effects attached to characters, with configurable labels that can escalate depending on the severity (quantity) of the effect. This builds on expanded character rewards; status effects can be rewarded directly to characters or rolled on loot tables (when the loot table is being rolled for a character directly.)
 +
 +
Status effects have the following qualities:
 +
* Name
 +
* Image (Optional)
 +
* Description (Optional)
 +
* Varying severity labels (Optional)
 +
 +
Two item tags are included. One, the "cure" tag, removes a status effect from a character the user selects by a configured amount. Another, the "buff" tag, adds a configured amount of a status effect to a character the user selects.
 +
 +
=== Conditional Loot Table Rows ===
 +
Additionally, loot tables have the option of conditional rows which check for a quantity of a set status effect based on configured criteria. There is also the option to provide rows which are added to the table if no conditions are met. These are used exclusively when rolling a loot table directly for a character, as this allows checking for status effects on that specific character.
 +
 
== Installation ==
 
== Installation ==
 
<!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. -->
 
<!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. -->
 +
* Ensure character reward expansion is enabled in config/lorekeeper/extensions.php; adjust the default recipient if desired
 +
* Run <code>php artisan migrate</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! -->
 +
Create status effects, adjust loot tables, etc. as desired.
 +
 
== Usage ==
 
== Usage ==
 
<!-- Is there anything users should know about using your extension? -->
 
<!-- Is there anything users should know about using your extension? -->
 +
Ensure that any rolls which are intended to reward or be dependent on status effects are rolled for a specific character. Status effects will not be considered for or rewarded to users.
 +
 
== 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 12:19, 22 February 2022

Status Effects
Description Adds support for character status effects.
Author(s) Mercury
Status Testing
Github extension/status-effects
LK Version 2.0.0
Contains a Migration



Adds support for status effects attached to characters, with configurable labels that can escalate depending on the severity (quantity) of the effect. This builds on expanded character rewards; status effects can be rewarded directly to characters or rolled on loot tables (when the loot table is being rolled for a character directly.)

Status effects have the following qualities:

  • Name
  • Image (Optional)
  • Description (Optional)
  • Varying severity labels (Optional)

Two item tags are included. One, the "cure" tag, removes a status effect from a character the user selects by a configured amount. Another, the "buff" tag, adds a configured amount of a status effect to a character the user selects.

Conditional Loot Table Rows

Additionally, loot tables have the option of conditional rows which check for a quantity of a set status effect based on configured criteria. There is also the option to provide rows which are added to the table if no conditions are met. These are used exclusively when rolling a loot table directly for a character, as this allows checking for status effects on that specific character.

Installation

  • Ensure character reward expansion is enabled in config/lorekeeper/extensions.php; adjust the default recipient if desired
  • Run php artisan migrate and php artisan update-extension-tracker

Configuration

Create status effects, adjust loot tables, etc. as desired.

Usage

Ensure that any rolls which are intended to reward or be dependent on status effects are rolled for a specific character. Status effects will not be considered for or rewarded to users.

Troubleshooting

Find me in the Lorekeeper server!

Images

See Also