Zyke ResourcesDocumentation
StatusGuides

Guides

Some guides to help you navigate the resource.

#Dedicated Pages

Take note that there are dedicated pages for longer guides, you can find them here:

#Passive Drain

This is a guide for changing the passive drain, or "amount lowered over time".

  1. Navigate into the status you want to change, ex. zyke_status/statuses/drunk/config.lua.
  2. In here you will find the drain setting. For the normal statuses, all you have to do is change the drain value in the base configuration.
    1. The value you put in here will be removed every second. Example: if we set it to 0.005 , it takes 200 seconds to drain 1%, which is ~320 minutes/~5h for 100%. If you set it to 1.0, it will take 100 seconds to drain 100%.
    2. TECHNICAL: If your drain value is set to more than 0.1, it will count as "high priority" & update more frequently, this allows us both slow and rapid drains without performance implications or a sluggish experience.

If you are adjusting a status with multiple dynamic statuses, like our "high" status, you can tweak each status independently.

The base configuration will cover all sub-statuses that don't have explicit configurations made. If you do define a sub-status, the drain value within it will be prioritized. If you are confused about sub-statuses, you can see an example in the default high config.

#Editing Effects (Thresholds)

All of our effects within zyke_status are based on thresholds. When a status is modified, we dispatch a check to see if we should run a loop to keep managing an effect based on your status levels. These thresholds declaring if an effect should be ran are very simple to modify.

  1. Navigate into the status you want to change, ex. zyke_status/statuses/drunk/config.lua.
  2. In here you will find the effect attribute.
    • If you quickly want to remove all of it, simply set effect = {}.
    • You can add/remove/edit these thresholds as you wish, as long as you are using respected values.
      • We automatically re-order the thresholds during runtime in case of any misalignments.
    • You can find respected values in zyke_status/effect_manager/effects. As I am writing this, we are currently in the middle of a re-write of the script, so specifics will come later. Values are easy to figure out if you know what you are doing.