🧑‍💻Setup

Install the package

First and foremost you need to add the package to Unity. In Unity navigate to Windows > Package Manager. Then in the top left click the "+" symbol, and select "Add package from git URL".

You will need Git installed if not already.

Next, copy the following URL into the text box that appeared.

https://github.com/maraudical/StatusEffectsFramework-Unity.git

Import Samples (Optional)

If you haven't used the framework before, it is highly recommended to import the samples as they will give you a good idea of how to implement custom effects and create an effect UI. You can add them through the package manager in the samples tab of the Status Effect Framework package.

Edit Settings (Optional)

It isn't required to edit the settings, however it may be useful to add your own groups to effects. You can find the settings at Edit > Project Settings > Status Effect Settings.

Good to know: Make sure to check out Status Effect Settings for more info.

Creating Your First Status Effect

You can create your own custom StatusEffectData by right clicking the project file browser, and navigating to Create > Status Effect Framework > Status Effect Data. There are many settings you can tweak, but the main three you should change are the Comparable Name, Base Value, and the Effects list. Go ahead and add your first effect.

You will need to create your first StatusName and ComparableName. Navigate to Create > Status Effect Framework > Status Name > Float and Create > Status Effect Framework > Comparable Name. You can change the StatusName to be whatever you want, just know that it will only affect a StatusVariable with the same StatusName.

Once they are created, add them into the StatusEffectData. Additionally you can tweak the value modifier depending on what the effect is.

Good to know: Make sure to check out Value Modifier for more info.

It is important to use the base value for something, it doesn't need to be in an Effect (it could be used in a Module) but it should be used somewhere. The value is used to calculate non-stacking behavior so to make our first effect use the base value you can select the checkbox next to Float Value.

How to Add Status Effects To Your Classes

Obviously you don't want to completely rewrite your current entities or characters or whatever they may be just to implement simple status effects. All you need to do is replace all variables that need to be effected by status effects with a StatusVariable! Next just add in the StatusManager on the GameObject. In the Start() or Awake() method you can link the StatusVariables to that StatusManager and it's ready to use status effects!

Here is an example where in your class you can add any StatusVariables that need to be effected by StatusEffects, add in their StatusNames (Create>Status Effect Framework>Status Name) and you're good to go! You can tweak the base value to your liking too.

// Dont forget to use the StatusEffect namespace!
// Example variables
public StatusFloat maxHealth;
public StatusInt coinMultiplier;
public StatusBool stunned;

private void Start()
{
    //Add this to your Start() or Awake() method
    
    // Obtain the StatusManager, this doesn't need to be on the
    // same GameObject but you need to get the reference for whatever 
    // you want to store this class's status effects.
    StatusManager statusManager = GetComponent<StatusManager>();
    maxHealth.SetManager(statusManager);
    coinMultiplier.SetManager(statusManager);
    stunned.SetManager(statusManager);
}

All you need to do to add or remove StatusEffects is call the add and remove methods from the StatusManager. That's it!

Important Information/Links

Again it is recommended to check out the samples, as they show a rough idea of how to get started. If you want more customized effects you may also want to check out Modules.

If you encounter any issues or would like to make a pull request feel free to do so I am open to feedback!

You can also reach out to me on Discord if you have any questions.